blob: 4691e24771b852347a95b9e1ccb2635154406650 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.crypto;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">/**</a>
<span class="sourceLineNo">022</span><a id="line.22"> * A cipher &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation"&gt;mode of operation&lt;/a&gt;</a>
<span class="sourceLineNo">023</span><a id="line.23"> * directs a cipher algorithm how to convert data during the encryption or decryption process. This enum represents</a>
<span class="sourceLineNo">024</span><a id="line.24"> * all JDK-standard Cipher operation mode names as defined in</a>
<span class="sourceLineNo">025</span><a id="line.25"> * &lt;a href="http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html"&gt;JDK Security Standard</a>
<span class="sourceLineNo">026</span><a id="line.26"> * Names&lt;/a&gt;, as well as a few more that are well-known and supported by other JCA Providers.</a>
<span class="sourceLineNo">027</span><a id="line.27"> * &lt;p/&gt;</a>
<span class="sourceLineNo">028</span><a id="line.28"> * This {@code enum} exists to provide Shiro end-users type-safety when declaring an operation mode. This helps reduce</a>
<span class="sourceLineNo">029</span><a id="line.29"> * error by providing a compile-time mechanism to specify a mode and guarantees a valid name that will be</a>
<span class="sourceLineNo">030</span><a id="line.30"> * recognized by an underlying JCA Provider.</a>
<span class="sourceLineNo">031</span><a id="line.31"> * &lt;h2&gt;Standard or Non-Standard?&lt;/h2&gt;</a>
<span class="sourceLineNo">032</span><a id="line.32"> * All modes listed specify whether they are a JDK standard mode or a non-standard mode. Standard modes are included</a>
<span class="sourceLineNo">033</span><a id="line.33"> * in all JDK distributions. Non-standard modes can</a>
<span class="sourceLineNo">034</span><a id="line.34"> * sometimes result in better performance or more secure output, but may not be available on the target JDK</a>
<span class="sourceLineNo">035</span><a id="line.35"> * platform and rely on an external JCA Provider to be installed. Some providers</a>
<span class="sourceLineNo">036</span><a id="line.36"> * (like &lt;a href="http://www.bouncycastle.org"&gt;Bouncy Castle&lt;/a&gt;) may support these modes however.</a>
<span class="sourceLineNo">037</span><a id="line.37"> *</a>
<span class="sourceLineNo">038</span><a id="line.38"> * @see &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation"&gt;Block Cipher Modes of Operation&lt;a/&gt;</a>
<span class="sourceLineNo">039</span><a id="line.39"> * @since 1.0</a>
<span class="sourceLineNo">040</span><a id="line.40"> */</a>
<span class="sourceLineNo">041</span><a id="line.41">public enum OperationMode {</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> /**</a>
<span class="sourceLineNo">044</span><a id="line.44"> * &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29"&gt;</a>
<span class="sourceLineNo">045</span><a id="line.45"> * Cipher-block Chaining&lt;/a&gt; mode, defined in &lt;a href="http://csrc.nist.gov/publications/fips/index.html"&gt;FIPS</a>
<span class="sourceLineNo">046</span><a id="line.46"> * PUB 81&lt;/a&gt;.</a>
<span class="sourceLineNo">047</span><a id="line.47"> * &lt;p/&gt;</a>
<span class="sourceLineNo">048</span><a id="line.48"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">049</span><a id="line.49"> */</a>
<span class="sourceLineNo">050</span><a id="line.50"> CBC,</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> /**</a>
<span class="sourceLineNo">053</span><a id="line.53"> * &lt;a href="http://en.wikipedia.org/wiki/CCM_mode"&gt;Counter with CBC-MAC&lt;/a&gt; mode&lt;b&gt;*&lt;/b&gt; - for block ciphers with</a>
<span class="sourceLineNo">054</span><a id="line.54"> * 128 bit block-size only. See &lt;a href="http://www.ietf.org/rfc/rfc3610.txt"&gt;RFC 3610&lt;/a&gt; for AES Ciphers.</a>
<span class="sourceLineNo">055</span><a id="line.55"> * This mode has essentially been replaced by the more-capable {@link #EAX EAX} mode.</a>
<span class="sourceLineNo">056</span><a id="line.56"> * &lt;p/&gt;</a>
<span class="sourceLineNo">057</span><a id="line.57"> * &lt;b&gt;*THIS IS A NON-STANDARD MODE&lt;/b&gt;. It is not guaranteed to be supported across JDK installations. You must</a>
<span class="sourceLineNo">058</span><a id="line.58"> * ensure you have a JCA Provider that can support this cipher operation mode.</a>
<span class="sourceLineNo">059</span><a id="line.59"> * &lt;a href="http://www.bouncycastle.org"&gt;Bouncy Castle&lt;/a&gt; &lt;em&gt;may&lt;/em&gt; be one such provider.</a>
<span class="sourceLineNo">060</span><a id="line.60"> */</a>
<span class="sourceLineNo">061</span><a id="line.61"> CCM,</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> /**</a>
<span class="sourceLineNo">064</span><a id="line.64"> * &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29"&gt;Cipher</a>
<span class="sourceLineNo">065</span><a id="line.65"> * Feedback&lt;a/&gt; mode, defined in &lt;a href="http://csrc.nist.gov/publications/fips/index.html"&gt;FIPS PUB 81&lt;/a&gt;.</a>
<span class="sourceLineNo">066</span><a id="line.66"> * &lt;p/&gt;</a>
<span class="sourceLineNo">067</span><a id="line.67"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">068</span><a id="line.68"> */</a>
<span class="sourceLineNo">069</span><a id="line.69"> CFB,</a>
<span class="sourceLineNo">070</span><a id="line.70"></a>
<span class="sourceLineNo">071</span><a id="line.71"> /**</a>
<span class="sourceLineNo">072</span><a id="line.72"> * &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29"&gt;Counter Mode&lt;/a&gt;, aka</a>
<span class="sourceLineNo">073</span><a id="line.73"> * Integer Counter Mode (ICM) and Segmented Integer Counter (SIC). Counter is a simplification of {@link #OFB OFB}</a>
<span class="sourceLineNo">074</span><a id="line.74"> * and updates the input block as a counter.</a>
<span class="sourceLineNo">075</span><a id="line.75"> * &lt;p/&gt;</a>
<span class="sourceLineNo">076</span><a id="line.76"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">077</span><a id="line.77"> */</a>
<span class="sourceLineNo">078</span><a id="line.78"> CTR,</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> /**</a>
<span class="sourceLineNo">081</span><a id="line.81"> * &lt;a href="http://en.wikipedia.org/wiki/EAX_mode"&gt;EAX Mode&lt;/a&gt;&lt;b&gt;*&lt;/b&gt;. This is a patent-free but less-effecient</a>
<span class="sourceLineNo">082</span><a id="line.82"> * alternative to {@link #OCB OCB} and has capabilities beyond what {@link #CCM CCM} can provide.</a>
<span class="sourceLineNo">083</span><a id="line.83"> * &lt;p/&gt;</a>
<span class="sourceLineNo">084</span><a id="line.84"> * &lt;b&gt;*THIS IS A NON-STANDARD MODE&lt;/b&gt;. It is not guaranteed to be supported across JDK installations. You must</a>
<span class="sourceLineNo">085</span><a id="line.85"> * ensure you have a JCA Provider that can support this cipher operation mode.</a>
<span class="sourceLineNo">086</span><a id="line.86"> * &lt;a href="http://www.bouncycastle.org"&gt;Bouncy Castle&lt;/a&gt; &lt;em&gt;may&lt;/em&gt; be one such provider.</a>
<span class="sourceLineNo">087</span><a id="line.87"> */</a>
<span class="sourceLineNo">088</span><a id="line.88"> EAX,</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> /**</a>
<span class="sourceLineNo">091</span><a id="line.91"> * &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29"&gt;Electronic</a>
<span class="sourceLineNo">092</span><a id="line.92"> * Codebook&lt;/a&gt; mode, defined in &lt;a href="http://csrc.nist.gov/publications/fips/index.html"&gt;FIPS PUB 81&lt;/a&gt;.</a>
<span class="sourceLineNo">093</span><a id="line.93"> * ECB is the only mode that does &lt;em&gt;not&lt;/em&gt; require an Initialization Vector, but because of this, can be seen</a>
<span class="sourceLineNo">094</span><a id="line.94"> * as less secure than operation modes that require an IV.</a>
<span class="sourceLineNo">095</span><a id="line.95"> * &lt;p/&gt;</a>
<span class="sourceLineNo">096</span><a id="line.96"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">097</span><a id="line.97"> */</a>
<span class="sourceLineNo">098</span><a id="line.98"> ECB,</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> /**</a>
<span class="sourceLineNo">101</span><a id="line.101"> * &lt;a href="http://en.wikipedia.org/wiki/GCM_mode"&gt;Galois/Counter&lt;/a&gt; mode&lt;b&gt;*&lt;/b&gt; - for block ciphers with 128</a>
<span class="sourceLineNo">102</span><a id="line.102"> * bit block-size only.</a>
<span class="sourceLineNo">103</span><a id="line.103"> * &lt;p/&gt;</a>
<span class="sourceLineNo">104</span><a id="line.104"> * &lt;b&gt;*THIS IS A NON-STANDARD MODE&lt;/b&gt;. It is not guaranteed to be supported across JDK installations. You must</a>
<span class="sourceLineNo">105</span><a id="line.105"> * ensure you have a JCA Provider that can support this cipher operation mode.</a>
<span class="sourceLineNo">106</span><a id="line.106"> * &lt;a href="http://www.bouncycastle.org"&gt;Bouncy Castle&lt;/a&gt; &lt;em&gt;may&lt;/em&gt; be one such provider.</a>
<span class="sourceLineNo">107</span><a id="line.107"> */</a>
<span class="sourceLineNo">108</span><a id="line.108"> GCM,</a>
<span class="sourceLineNo">109</span><a id="line.109"></a>
<span class="sourceLineNo">110</span><a id="line.110"> /**</a>
<span class="sourceLineNo">111</span><a id="line.111"> * No mode.</a>
<span class="sourceLineNo">112</span><a id="line.112"> * &lt;p/&gt;</a>
<span class="sourceLineNo">113</span><a id="line.113"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">114</span><a id="line.114"> */</a>
<span class="sourceLineNo">115</span><a id="line.115"> NONE,</a>
<span class="sourceLineNo">116</span><a id="line.116"></a>
<span class="sourceLineNo">117</span><a id="line.117"> /**</a>
<span class="sourceLineNo">118</span><a id="line.118"> * &lt;a href="http://en.wikipedia.org/wiki/OCB_mode"&gt;Offset Codebook&lt;/a&gt; mode&lt;b&gt;*&lt;/b&gt;. Parallel mode that provides</a>
<span class="sourceLineNo">119</span><a id="line.119"> * both message privacy and authenticity in a single pass. This is a very efficient mode, but is patent-encumbered.</a>
<span class="sourceLineNo">120</span><a id="line.120"> * A less-efficient (two pass) alternative is available by using {@link #EAX EAX} mode.</a>
<span class="sourceLineNo">121</span><a id="line.121"> * &lt;p/&gt;</a>
<span class="sourceLineNo">122</span><a id="line.122"> * &lt;b&gt;*THIS IS A NON-STANDARD MODE&lt;/b&gt;. It is not guaranteed to be supported across JDK installations. You must</a>
<span class="sourceLineNo">123</span><a id="line.123"> * ensure you have a JCA Provider that can support this cipher operation mode.</a>
<span class="sourceLineNo">124</span><a id="line.124"> * &lt;a href="http://www.bouncycastle.org"&gt;Bouncy Castle&lt;/a&gt; &lt;em&gt;may&lt;/em&gt; be one such provider.</a>
<span class="sourceLineNo">125</span><a id="line.125"> */</a>
<span class="sourceLineNo">126</span><a id="line.126"> OCB,</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> /**</a>
<span class="sourceLineNo">129</span><a id="line.129"> * &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29"&gt;Output</a>
<span class="sourceLineNo">130</span><a id="line.130"> * Feedback&lt;/a&gt; mode, defined in &lt;a href="http://csrc.nist.gov/publications/fips/index.html"&gt;FIPS PUB 81&lt;/a&gt;.</a>
<span class="sourceLineNo">131</span><a id="line.131"> * &lt;p/&gt;</a>
<span class="sourceLineNo">132</span><a id="line.132"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">133</span><a id="line.133"> */</a>
<span class="sourceLineNo">134</span><a id="line.134"> OFB,</a>
<span class="sourceLineNo">135</span><a id="line.135"></a>
<span class="sourceLineNo">136</span><a id="line.136"> /**</a>
<span class="sourceLineNo">137</span><a id="line.137"> * &lt;a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Propagating_cipher-block_chaining_.28PCBC.29"&gt;</a>
<span class="sourceLineNo">138</span><a id="line.138"> * Propagating Cipher Block Chaining&lt;/a&gt; mode, defined in &lt;a href="http://web.mit.edu/kerberos/"&gt;Kerberos version 4&lt;a/&gt;.</a>
<span class="sourceLineNo">139</span><a id="line.139"> * &lt;p/&gt;</a>
<span class="sourceLineNo">140</span><a id="line.140"> * This is a standard JDK operation mode and should be supported by all JDK environments.</a>
<span class="sourceLineNo">141</span><a id="line.141"> */</a>
<span class="sourceLineNo">142</span><a id="line.142"> PCBC</a>
<span class="sourceLineNo">143</span><a id="line.143">}</a>
</pre>
</div>
</main>
</body>
</html>