| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>OperationMode xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/crypto/OperationMode.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.crypto; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * A cipher <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>">mode of operation</a></em> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * directs a cipher algorithm how to convert data during the encryption or decryption process. This enum represents</em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * all JDK-standard Cipher operation mode names as defined in</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html" target="alexandria_uri">http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html</a>">JDK Security Standard</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * Names</a>, as well as a few more that are well-known and supported by other JCA Providers.</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * This {@code enum} exists to provide Shiro end-users type-safety when declaring an operation mode. This helps reduce</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * error by providing a compile-time mechanism to specify a mode and guarantees a valid name that will be</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * recognized by an underlying JCA Provider.</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <h2>Standard or Non-Standard?</h2></em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * All modes listed specify whether they are a JDK standard mode or a non-standard mode. Standard modes are included</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * in all JDK distributions. Non-standard modes can</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * sometimes result in better performance or more secure output, but may not be available on the target JDK</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * platform and rely on an external JCA Provider to be installed. Some providers</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * (like <a href="<a href="http://www.bouncycastle.org" target="alexandria_uri">http://www.bouncycastle.org</a>">Bouncy Castle</a>) may support these modes however.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>">Block Cipher Modes of Operation<a/></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../org/apache/shiro/crypto/OperationMode.html">OperationMode</a> { |
| <a name="42" href="#42">42</a> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>#Cipher-block_chaining_.28CBC.29"></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Cipher-block Chaining</a> mode, defined in <a href="<a href="http://csrc.nist.gov/publications/fips/index.html" target="alexandria_uri">http://csrc.nist.gov/publications/fips/index.html</a>">FIPS</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * PUB 81</a>.</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="50" href="#50">50</a> CBC, |
| <a name="51" href="#51">51</a> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/CCM_mode" target="alexandria_uri">http://en.wikipedia.org/wiki/CCM_mode</a>">Counter with CBC-MAC</a> mode<b>*</b> - for block ciphers with</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * 128 bit block-size only. See <a href="<a href="http://www.ietf.org/rfc/rfc3610.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc3610.txt</a>">RFC 3610</a> for AES Ciphers.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * This mode has essentially been replaced by the more-capable {@link #EAX EAX} mode.</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <b>*THIS IS A NON-STANDARD MODE</b>. It is not guaranteed to be supported across JDK installations. You must</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * ensure you have a JCA Provider that can support this cipher operation mode.</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.bouncycastle.org" target="alexandria_uri">http://www.bouncycastle.org</a>">Bouncy Castle</a> <em>may</em> be one such provider.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="61" href="#61">61</a> CCM, |
| <a name="62" href="#62">62</a> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>#Cipher_feedback_.28CFB.29">Cipher</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Feedback<a/> mode, defined in <a href="<a href="http://csrc.nist.gov/publications/fips/index.html" target="alexandria_uri">http://csrc.nist.gov/publications/fips/index.html</a>">FIPS PUB 81</a>.</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="69" href="#69">69</a> CFB, |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>#Counter_.28CTR.29">Counter Mode</a>, aka</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Integer Counter Mode (ICM) and Segmented Integer Counter (SIC). Counter is a simplification of {@link #OFB OFB}</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * and updates the input block as a counter.</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="78" href="#78">78</a> CTR, |
| <a name="79" href="#79">79</a> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/EAX_mode" target="alexandria_uri">http://en.wikipedia.org/wiki/EAX_mode</a>">EAX Mode</a><b>*</b>. This is a patent-free but less-effecient</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * alternative to {@link #OCB OCB} and has capabilities beyond what {@link #CCM CCM} can provide.</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <b>*THIS IS A NON-STANDARD MODE</b>. It is not guaranteed to be supported across JDK installations. You must</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * ensure you have a JCA Provider that can support this cipher operation mode.</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.bouncycastle.org" target="alexandria_uri">http://www.bouncycastle.org</a>">Bouncy Castle</a> <em>may</em> be one such provider.</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="88" href="#88">88</a> EAX, |
| <a name="89" href="#89">89</a> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>#Electronic_codebook_.28ECB.29">Electronic</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Codebook</a> mode, defined in <a href="<a href="http://csrc.nist.gov/publications/fips/index.html" target="alexandria_uri">http://csrc.nist.gov/publications/fips/index.html</a>">FIPS PUB 81</a>.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * ECB is the only mode that does <em>not</em> require an Initialization Vector, but because of this, can be seen</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * as less secure than operation modes that require an IV.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="98" href="#98">98</a> ECB, |
| <a name="99" href="#99">99</a> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/GCM_mode" target="alexandria_uri">http://en.wikipedia.org/wiki/GCM_mode</a>">Galois/Counter</a> mode<b>*</b> - for block ciphers with 128</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * bit block-size only.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * <b>*THIS IS A NON-STANDARD MODE</b>. It is not guaranteed to be supported across JDK installations. You must</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * ensure you have a JCA Provider that can support this cipher operation mode.</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.bouncycastle.org" target="alexandria_uri">http://www.bouncycastle.org</a>">Bouncy Castle</a> <em>may</em> be one such provider.</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="108" href="#108">108</a> GCM, |
| <a name="109" href="#109">109</a> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * No mode.</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="115" href="#115">115</a> NONE, |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/OCB_mode" target="alexandria_uri">http://en.wikipedia.org/wiki/OCB_mode</a>">Offset Codebook</a> mode<b>*</b>. Parallel mode that provides</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * both message privacy and authenticity in a single pass. This is a very efficient mode, but is patent-encumbered.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * A less-efficient (two pass) alternative is available by using {@link #EAX EAX} mode.</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * <b>*THIS IS A NON-STANDARD MODE</b>. It is not guaranteed to be supported across JDK installations. You must</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * ensure you have a JCA Provider that can support this cipher operation mode.</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.bouncycastle.org" target="alexandria_uri">http://www.bouncycastle.org</a>">Bouncy Castle</a> <em>may</em> be one such provider.</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="126" href="#126">126</a> OCB, |
| <a name="127" href="#127">127</a> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>#Output_feedback_.28OFB.29">Output</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * Feedback</a> mode, defined in <a href="<a href="http://csrc.nist.gov/publications/fips/index.html" target="alexandria_uri">http://csrc.nist.gov/publications/fips/index.html</a>">FIPS PUB 81</a>.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="134" href="#134">134</a> OFB, |
| <a name="135" href="#135">135</a> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation" target="alexandria_uri">http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation</a>#Propagating_cipher-block_chaining_.28PCBC.29"></em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Propagating Cipher Block Chaining</a> mode, defined in <a href="<a href="http://web.mit.edu/kerberos/" target="alexandria_uri">http://web.mit.edu/kerberos/</a>">Kerberos version 4<a/>.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * This is a standard JDK operation mode and should be supported by all JDK environments.</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="142" href="#142">142</a> PCBC |
| <a name="143" href="#143">143</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
