| <!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 {@code CipherPaddingScheme} represents well-known</a> |
| <span class="sourceLineNo">023</span><a id="line.23"> * <a href="http://en.wikipedia.org/wiki/Padding_(cryptography)">padding schemes</a> supported by JPA providers in a</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * type-safe manner.</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * <p/></a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * When encrypted data is transferred, it is usually desirable to ensure that all 'chunks' transferred are a fixed-length:</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * different length blocks might give cryptanalysts clues about what the data might be, among other reasons. Of course</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * not all data will convert to neat fixed-length blocks, so padding schemes are used to 'fill in' (pad) any remaining</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * space with unintelligible data.</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * <p/></a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * Padding schemes can be used in both asymmetric key ciphers as well as symmetric key ciphers (e.g. block ciphers).</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * Block-ciphers especially regularly use padding schemes as they are based on the notion of fixed-length block sizes.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * @see <a href="http://en.wikipedia.org/wiki/Padding_(cryptography)">Wikipedia: Cryptographic Padding</a></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @since 1.0</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> */</a> |
| <span class="sourceLineNo">037</span><a id="line.37">public enum PaddingScheme {</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> /**</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * No padding. Useful when the block size is 8 bits for block cipher streaming operations. (Because</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * a byte is the most primitive block size, there is nothing to pad).</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> */</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> NONE("NoPadding"),</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> /**</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * Padding scheme as defined in the W3C's &quot;XML Encryption Syntax and Processing&quot; document,</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <a href="http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block">Section 5.2 - Block Encryption Algorithms</a>.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> */</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> ISO10126("ISO10126Padding"),</a> |
| <span class="sourceLineNo">050</span><a id="line.50"></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> /**</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Optimal Asymmetric Encryption Padding defined in RSA's <a href="http://en.wikipedia.org/wiki/PKCS1">PKSC#1</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * standard</a> (aka <a href="http://tools.ietf.org/html/rfc3447">RFC 3447</a>).</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * <p/></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * <b>NOTE:</b> using this padding requires initializing {@link javax.crypto.Cipher Cipher} instances with a</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object which provides the 1) message digest and</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * 2) mask generation function to use for the scheme.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * <h3>Convenient Alternatives</h3></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * While using this scheme enables you full customization of the message digest + mask generation function</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * combination, it does require the extra burden of providing your own {@code OAEPParameterSpec} object. This is</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * often unnecessary, because most combinations are fairly standard. These common combinations are pre-defined</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * in this enum in the {@code OAEP}* variants.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * <p/></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * If you find that these common combinations still do not meet your needs, then you will need to</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * specify your own message digest and mask generation function, either as an {@code OAEPParameterSpec} object</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * during Cipher initialization or, maybe more easily, in the scheme name directly. If you want to use scheme name</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * approach, the name format is specified in the</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * <a href="http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html">Standard Names</a></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * document in the <code>Cipher Algorithm Padding</code> section.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> *</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @see #OAEPWithMd5AndMgf1</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @see #OAEPWithSha1AndMgf1</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @see #OAEPWithSha256AndMgf1</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * @see #OAEPWithSha384AndMgf1</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @see #OAEPWithSha512AndMgf1</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> */</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> OAEP("OAEPPadding"),</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * Optimal Asymmetric Encryption Padding with {@code MD5} message digest and {@code MGF1} mask generation function.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * <p/></a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> */</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> OAEPWithMd5AndMgf1("OAEPWithMD5AndMGF1Padding"),</a> |
| <span class="sourceLineNo">088</span><a id="line.88"></a> |
| <span class="sourceLineNo">089</span><a id="line.89"> /**</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * Optimal Asymmetric Encryption Padding with {@code SHA-1} message digest and {@code MGF1} mask generation function.</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * <p/></a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> */</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> OAEPWithSha1AndMgf1("OAEPWithSHA-1AndMGF1Padding"),</a> |
| <span class="sourceLineNo">098</span><a id="line.98"></a> |
| <span class="sourceLineNo">099</span><a id="line.99"> /**</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * Optimal Asymmetric Encryption Padding with {@code SHA-256} message digest and {@code MGF1} mask generation function.</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * <p/></a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> */</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> OAEPWithSha256AndMgf1("OAEPWithSHA-256AndMGF1Padding"),</a> |
| <span class="sourceLineNo">108</span><a id="line.108"></a> |
| <span class="sourceLineNo">109</span><a id="line.109"> /**</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * Optimal Asymmetric Encryption Padding with {@code SHA-384} message digest and {@code MGF1} mask generation function.</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * <p/></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> */</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> OAEPWithSha384AndMgf1("OAEPWithSHA-384AndMGF1Padding"),</a> |
| <span class="sourceLineNo">118</span><a id="line.118"></a> |
| <span class="sourceLineNo">119</span><a id="line.119"> /**</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * Optimal Asymmetric Encryption Padding with {@code SHA-512} message digest and {@code MGF1} mask generation function.</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * <p/></a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> */</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> OAEPWithSha512AndMgf1("OAEPWithSHA-512AndMGF1Padding"),</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> /**</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * Padding scheme used with the {@code RSA} algorithm defined in RSA's</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * <a href="http://en.wikipedia.org/wiki/PKCS1">PKSC#1 standard</a> (aka</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * <a href="http://tools.ietf.org/html/rfc3447">RFC 3447</a>).</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> */</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> PKCS1("PKCS1Padding"),</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"> * Padding scheme defined in RSA's <a href="http://www.rsa.com/rsalabs/node.asp?id=2127">Password-Based</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * Cryptography Standard</a>.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> */</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> PKCS5("PKCS5Padding"),</a> |
| <span class="sourceLineNo">141</span><a id="line.141"></a> |
| <span class="sourceLineNo">142</span><a id="line.142"> /**</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * Padding scheme defined in the <a href="http://www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt">SSL</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * 3.0 specification</a>, section <code>5.2.3.2 (CBC block cipher)</code>.</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> */</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> SSL3("SSL3Padding");</a> |
| <span class="sourceLineNo">147</span><a id="line.147"></a> |
| <span class="sourceLineNo">148</span><a id="line.148"> private final String transformationName;</a> |
| <span class="sourceLineNo">149</span><a id="line.149"></a> |
| <span class="sourceLineNo">150</span><a id="line.150"> private PaddingScheme(String transformationName) {</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> this.transformationName = transformationName;</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> }</a> |
| <span class="sourceLineNo">153</span><a id="line.153"></a> |
| <span class="sourceLineNo">154</span><a id="line.154"> /**</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> * Returns the actual string name to use when building the {@link javax.crypto.Cipher Cipher}</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> * {@code transformation string}.</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> *</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * @return the actual string name to use when building the {@link javax.crypto.Cipher Cipher}</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * {@code transformation string}.</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * @see javax.crypto.Cipher#getInstance(String)</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> */</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> public String getTransformationName() {</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> return this.transformationName;</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> }</a> |
| <span class="sourceLineNo">165</span><a id="line.165">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
