| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.crypto;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.util.StringUtils;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>/**<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * Base abstract class for block cipher algorithms.<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> *<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <h2>Usage</h2><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Note that this class exists mostly to simplify algorithm-specific subclasses. Unless you understand the concepts of<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * cipher modes of operation, block sizes, and padding schemes, and you want direct control of these things, you should<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * typically not uses instances of this class directly. Instead, algorithm-specific subclasses, such as<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * {@link AesCipherService}, {@link BlowfishCipherService}, and others are usually better suited for regular use.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p/><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * However, if you have the need to create a custom block cipher service where no sufficient algorithm-specific subclass<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * exists in Shiro, this class would be very useful.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <h2>Configuration</h2><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Block ciphers can accept configuration parameters that direct how they operate. These parameters concatenated<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * together in a single String comprise what the JDK JCA documentation calls a<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <a href="http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#trans">transformation<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * string</a>. We think that it is better for Shiro to construct this transformation string automatically based on its<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * constituent parts instead of having the end-user construct the string manually, which may be error prone or<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * confusing. To that end, Shiro {@link DefaultBlockCipherService}s have attributes that can be set individually in<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * a type-safe manner based on your configuration needs, and Shiro will build the transformation string for you.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p/><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * The following sections typically document the configuration options for block (byte array)<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * {@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])} method invocations. Streaming configuration<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * for those same attributes are done via mirrored {@code streaming}* attributes, and their purpose is identical, but<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * they're only used during streaming {@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])} and<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])} methods. See the &quot;Streaming&quot;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * section below for more.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <h3>Block Size</h3><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * The block size specifies the number of bits (not bytes) that the cipher operates on when performing an operation.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * It can be specified explicitly via the {@link #setBlockSize blockSize} attribute. If not set, the JCA Provider<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * default will be used based on the cipher algorithm. Block sizes are usually very algorithm specific, so set this<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * value only if you know you don't want the JCA Provider's default for the desired algorithm. For example, the<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * AES algorithm's Rijndael implementation <em>only</em> supports a 128 bit block size and will not work with any other<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * size.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <p/><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Also note that the {@link #setInitializationVectorSize initializationVectorSize} is usually the same as the<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * {@link #setBlockSize blockSize} in block ciphers. If you change either attribute, you should ensure that the other<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * attribute is correct for the target cipher algorithm.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> *<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <h3>Operation Mode</h3><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * You may set the block cipher's<a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation">mode of<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * operation</a> via the {@link #setMode(OperationMode) mode} attribute, which accepts a type-safe<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * {@link OperationMode OperationMode} enum instance. This type safety helps avoid typos when specifying the mode and<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * guarantees that the mode name will be recognized by the underlying JCA Provider.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <p/><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <b>*</b>If no operation mode is specified, Shiro defaults all of its block {@code CipherService} instances to the<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * {@link OperationMode#CBC CBC} mode, specifically to support auto-generation of initialization vectors during<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * encryption. This is different than the JDK's default {@link OperationMode#ECB ECB} mode because {@code ECB} does<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * not support initialization vectors, which are necessary for strong encryption. See the<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * {@link org.apache.shiro.crypto.JcaCipherService JcaCipherService parent class} class JavaDoc for an extensive<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * explanation on why we do this and why we do not use the Sun {@code ECB} default. You also might also want read<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * the <a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29">Wikipedia<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * section on ECB<a/> and look at the encrypted image to see an example of why {@code ECB} should not be used in<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * security-sensitive environments.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <p/><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * In the rare case that you need to override the default with a mode not represented<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * by the {@link OperationMode} enum, you may specify the raw mode name string that will be recognized by your JCA<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * provider via the {@link #setModeName modeName} attribute. Because this is not type-safe, it is recommended only to<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * use this attribute if the {@link OperationMode} enum does not represent your desired mode.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <p/><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <b>NOTE:</b> If you change the mode to one that does not support initialization vectors (such as<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * {@link OperationMode#ECB ECB} or {@link OperationMode#NONE NONE}), you <em>must</em> turn off auto-generated<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * initialization vectors by setting {@link #setGenerateInitializationVectors(boolean) generateInitializationVectors}<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * to {@code false}. Abandoning initialization vectors significantly weakens encryption, so think twice before<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * disabling this feature.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <h3>Padding Scheme</h3><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Because block ciphers process messages in fixed-length blocks, if the final block in a message is not equal to the<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * block length, <a href="http://en.wikipedia.org/wiki/Padding_(cryptography)">padding</a> is applied to match that<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * size to maintain the total length of the message. This is good because it protects data patterns from being<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * identified - when all chunks look the same length, it is much harder to infer what that data might be.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * <p/><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * You may set a padding scheme via the {@link #setPaddingScheme(PaddingScheme) paddingScheme} attribute, which<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * accepts a type-safe {@link PaddingScheme PaddingScheme} enum instance. Like the {@link OperationMode} enum,<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * this enum offers type safety to help avoid typos and guarantees that the mode will be recongized by the underlying<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * JCA provider.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <p/><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <b>*</b>If no padding scheme is specified, this class defaults to the {@link PaddingScheme#PKCS5} scheme, specifically<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * to be compliant with the default behavior of auto-generating initialization vectors during encryption (see the<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * {@link org.apache.shiro.crypto.JcaCipherService JcaCipherService parent class} class JavaDoc for why).<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * <p/><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * In the rare case that you need to override the default with a scheme not represented by the {@link PaddingScheme}<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * enum, you may specify the raw padding scheme name string that will be recognized by your JCA provider via the<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * {@link #setPaddingScheme paddingSchemeName} attribute. Because this is not type-safe, it is recommended only to<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * use this attribute if the {@link PaddingScheme} enum does not represent your desired scheme.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <h2>Streaming</h2><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Most people don't think of using block ciphers as stream ciphers, since their name implies working<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * with block data (i.e. byte arrays) only. However, block ciphers can be turned into byte-oriented stream ciphers by<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * using an appropriate {@link OperationMode operation mode} with a {@link #getStreamingBlockSize() streaming block size}<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * of 8 bits. This is why the {@link CipherService} interface provides both block and streaming operations.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * <p/><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Because this streaming 8-bit block size rarely changes across block-cipher algorithms, default values have been set<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * for all three streaming configuration parameters. The defaults are:<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * <ul><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <li>{@link #setStreamingBlockSize(int) streamingBlockSize} = {@code 8} (bits)</li><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * <li>{@link #setStreamingMode streamingMode} = {@link OperationMode#CBC CBC}</li><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <li>{@link #setStreamingPaddingScheme(PaddingScheme) streamingPaddingScheme} = {@link PaddingScheme#PKCS5 PKCS5}</li><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * </ul><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * <p/><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * These attributes have the same meaning as the {@code mode}, {@code blockSize}, and {@code paddingScheme} attributes<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * described above, but they are applied during streaming method invocations only ({@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])}<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * and {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])}).<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> *<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @see BlowfishCipherService<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @see AesCipherService<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @see <a href="http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation">Wikipedia: Block Cipher Modes of Operation</a><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @since 1.0<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span>public class DefaultBlockCipherService extends AbstractSymmetricCipherService {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> private static final int DEFAULT_BLOCK_SIZE = 0;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> private static final String TRANSFORMATION_STRING_DELIMITER = "/";<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> private static final int DEFAULT_STREAMING_BLOCK_SIZE = 8; //8 bits (1 byte)<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> private String modeName;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> private int blockSize; //size in bits (not bytes) - i.e. a blockSize of 8 equals 1 byte. negative or zero value = use system default<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> private String paddingSchemeName;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> private String streamingModeName;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> private int streamingBlockSize;<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> private String streamingPaddingSchemeName;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> private String transformationString; //cached value - rebuilt whenever any of its constituent parts change<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> private String streamingTransformationString; //cached value - rebuilt whenever any of its constituent parts change<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Creates a new {@link DefaultBlockCipherService} using the specified block cipher {@code algorithmName}. Per this<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * class's JavaDoc, this constructor also sets the following defaults:<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * <ul><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <li>{@code streamingMode} = {@link OperationMode#CBC CBC}</li><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * <li>{@code streamingPaddingScheme} = {@link PaddingScheme#NONE none}</li><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * <li>{@code streamingBlockSize} = 8</li><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * </ul><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * All other attributes are null/unset, indicating the JCA Provider defaults will be used.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> *<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param algorithmName the block cipher algorithm to use when encrypting and decrypting<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public DefaultBlockCipherService(String algorithmName) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> super(algorithmName);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> this.modeName = OperationMode.CBC.name();<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> this.paddingSchemeName = PaddingScheme.PKCS5.getTransformationName();<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> this.blockSize = DEFAULT_BLOCK_SIZE; //0 = use the JCA provider's default<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> this.streamingModeName = OperationMode.CBC.name();<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> this.streamingPaddingSchemeName = PaddingScheme.PKCS5.getTransformationName();<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> this.streamingBlockSize = DEFAULT_STREAMING_BLOCK_SIZE;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> /**<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * Returns the cipher operation mode name (as a String) to be used when constructing<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * {@link javax.crypto.Cipher Cipher} transformation string or {@code null} if the JCA Provider default mode for<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * <p/><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * {@link #getStreamingModeName() streamingModeName} attribute is used when the block cipher is used for<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * streaming operations.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * <p/><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * The default value is {@code null} to retain the JCA Provider default.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> *<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return the cipher operation mode name (as a String) to be used when constructing the<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider default<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * mode for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> */<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> public String getModeName() {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> return modeName;<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> }<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * Sets the cipher operation mode name to be used when constructing the<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * {@link javax.crypto.Cipher Cipher} transformation string. A {@code null} value indicates that the JCA Provider<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * <p/><a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * {@link #getStreamingModeName() streamingModeName} attribute is used when the block cipher is used for<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * streaming operations.<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * <p/><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * The default value is {@code null} to retain the JCA Provider default.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * <p/><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * <b>NOTE:</b> most standard mode names are represented by the {@link OperationMode OperationMode} enum. That enum<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * should be used with the {@link #setMode mode} attribute when possible to retain type-safety and reduce the<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * possibility of errors. This method is better used if the {@link OperationMode} enum does not represent the<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * necessary mode.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> *<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @param modeName the cipher operation mode name to be used when constructing<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * @see #setMode<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> */<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> public void setModeName(String modeName) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> this.modeName = modeName;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> //clear out the transformation string so the next invocation will rebuild it with the new mode:<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> this.transformationString = null;<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> /**<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * Sets the cipher operation mode of operation to be used when constructing the<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * {@link javax.crypto.Cipher Cipher} transformation string. A {@code null} value indicates that the JCA Provider<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * <p/><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * {@link #setStreamingMode streamingMode} attribute is used when the block cipher is used for<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * streaming operations.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * <p/><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * If the {@link OperationMode} enum cannot represent your desired mode, you can set the name explicitly<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * via the {@link #setModeName modeName} attribute directly. However, because {@link OperationMode} represents all<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * standard JDK mode names already, ensure that your underlying JCA Provider supports the non-standard name first.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> *<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @param mode the cipher operation mode to be used when constructing<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> */<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> public void setMode(OperationMode mode) {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> setModeName(mode.name());<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> }<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> /**<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * Returns the cipher algorithm padding scheme name (as a String) to be used when constructing<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * {@link javax.crypto.Cipher Cipher} transformation string or {@code null} if the JCA Provider default mode for<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * <p/><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * {@link #getStreamingPaddingSchemeName() streamingPaddingSchemeName} attribute is used when the block cipher is<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * used for streaming operations.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * <p/><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * The default value is {@code null} to retain the JCA Provider default.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> *<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @return the padding scheme name (as a String) to be used when constructing the<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider default<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * padding scheme for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> */<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> public String getPaddingSchemeName() {<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> return paddingSchemeName;<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> }<a name="line.264"></a> |
| <span class="sourceLineNo">265</span><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> /**<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * Sets the padding scheme name to be used when constructing the<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider default mode for<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * <p/><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * {@link #getStreamingPaddingSchemeName() streamingPaddingSchemeName} attribute is used when the block cipher is<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * used for streaming operations.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * <p/><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * The default value is {@code null} to retain the JCA Provider default.<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * <p/><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * <b>NOTE:</b> most standard padding schemes are represented by the {@link PaddingScheme PaddingScheme} enum.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * That enum should be used with the {@link #setPaddingScheme paddingScheme} attribute when possible to retain<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * type-safety and reduce the possibility of errors. Calling this method however is suitable if the<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * {@code PaddingScheme} enum does not represent the desired scheme.<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> *<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @param paddingSchemeName the padding scheme name to be used when constructing<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * Provider default padding scheme for the specified {@link #getAlgorithmName() algorithm}<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * should be used.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @see #setPaddingScheme<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> */<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> public void setPaddingSchemeName(String paddingSchemeName) {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> this.paddingSchemeName = paddingSchemeName;<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> //clear out the transformation string so the next invocation will rebuild it with the new padding scheme:<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> this.transformationString = null;<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> /**<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * Sets the padding scheme to be used when constructing the<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * {@link javax.crypto.Cipher Cipher} transformation string. A {@code null} value indicates that the JCA Provider<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * default padding scheme for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * <p/><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * {@link #setStreamingPaddingScheme streamingPaddingScheme} attribute is used when the block cipher is used for<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * streaming operations.<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * <p/><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * If the {@link PaddingScheme PaddingScheme} enum does represent your desired scheme, you can set the name explicitly<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * via the {@link #setPaddingSchemeName paddingSchemeName} attribute directly. However, because<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * {@code PaddingScheme} represents all standard JDK scheme names already, ensure that your underlying JCA Provider<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * supports the non-standard name first.<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> *<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * @param paddingScheme the padding scheme to be used when constructing<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * default padding scheme for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> */<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> public void setPaddingScheme(PaddingScheme paddingScheme) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> setPaddingSchemeName(paddingScheme.getTransformationName());<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> /**<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * Returns the block cipher's block size to be used when constructing<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * {@link javax.crypto.Cipher Cipher} transformation string or {@code 0} if the JCA Provider default block size<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * <p/><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * {@link #getStreamingBlockSize() streamingBlockSize} attribute is used when the block cipher is used for<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * streaming operations.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * <p/><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * The default value is {@code 0} which retains the JCA Provider default.<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> *<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * @return the block cipher block size to be used when constructing the<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code 0} if the JCA Provider default<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * block size for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> */<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> public int getBlockSize() {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return blockSize;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> }<a name="line.336"></a> |
| <span class="sourceLineNo">337</span><a name="line.337"></a> |
| <span class="sourceLineNo">338</span> /**<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * Sets the block cipher's block size to be used when constructing<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * {@link javax.crypto.Cipher Cipher} transformation string. {@code 0} indicates that the JCA Provider default<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * block size for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * <p/><a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * {@link #getStreamingBlockSize() streamingBlockSize} attribute is used when the block cipher is used for<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * streaming operations.<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * <p/><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * The default value is {@code 0} which retains the JCA Provider default.<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * <p/><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * <b>NOTE:</b> block cipher block sizes are very algorithm-specific. If you change this value, ensure that it<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * will work with the specified {@link #getAlgorithmName() algorithm}.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> *<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @param blockSize the block cipher block size to be used when constructing the<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code 0} if the JCA Provider<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * default block size for the specified {@link #getAlgorithmName() algorithm} should be used.<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> */<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> public void setBlockSize(int blockSize) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> this.blockSize = Math.max(DEFAULT_BLOCK_SIZE, blockSize);<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> //clear out the transformation string so the next invocation will rebuild it with the new block size:<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> this.transformationString = null;<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> /**<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * Same purpose as the {@link #getModeName modeName} attribute, but is used instead only for for streaming<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * operations ({@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])} and<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])}).<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * <p/><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * Note that unlike the {@link #getModeName modeName} attribute, the default value of this attribute is not<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * {@code null} - it is {@link OperationMode#CBC CBC} for reasons described in the class-level JavaDoc in the<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * {@code Streaming} section.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> *<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * @return the transformation string mode name to be used for streaming operations only.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> */<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> public String getStreamingModeName() {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> return streamingModeName;<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> private boolean isModeStreamingCompatible(String modeName) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> return modeName != null &&<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> !modeName.equalsIgnoreCase(OperationMode.ECB.name()) &&<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> !modeName.equalsIgnoreCase(OperationMode.NONE.name());<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> }<a name="line.382"></a> |
| <span class="sourceLineNo">383</span><a name="line.383"></a> |
| <span class="sourceLineNo">384</span> /**<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * Sets the transformation string mode name to be used for streaming operations only. The default value is<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * {@link OperationMode#CBC CBC} for reasons described in the class-level JavaDoc in the {@code Streaming} section.<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> *<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * @param streamingModeName transformation string mode name to be used for streaming operations only<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> */<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> public void setStreamingModeName(String streamingModeName) {<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> if (!isModeStreamingCompatible(streamingModeName)) {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> String msg = "mode [" + streamingModeName + "] is not a valid operation mode for block cipher streaming.";<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> throw new IllegalArgumentException(msg);<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> this.streamingModeName = streamingModeName;<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> //clear out the streaming transformation string so the next invocation will rebuild it with the new mode:<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> this.streamingTransformationString = null;<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> }<a name="line.398"></a> |
| <span class="sourceLineNo">399</span><a name="line.399"></a> |
| <span class="sourceLineNo">400</span> /**<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * Sets the transformation string mode to be used for streaming operations only. The default value is<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * {@link OperationMode#CBC CBC} for reasons described in the class-level JavaDoc in the {@code Streaming} section.<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> *<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * @param mode the transformation string mode to be used for streaming operations only<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> */<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> public void setStreamingMode(OperationMode mode) {<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> setStreamingModeName(mode.name());<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> }<a name="line.408"></a> |
| <span class="sourceLineNo">409</span><a name="line.409"></a> |
| <span class="sourceLineNo">410</span> public String getStreamingPaddingSchemeName() {<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> return streamingPaddingSchemeName;<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> }<a name="line.412"></a> |
| <span class="sourceLineNo">413</span><a name="line.413"></a> |
| <span class="sourceLineNo">414</span> public void setStreamingPaddingSchemeName(String streamingPaddingSchemeName) {<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> this.streamingPaddingSchemeName = streamingPaddingSchemeName;<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> //clear out the streaming transformation string so the next invocation will rebuild it with the new scheme:<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> this.streamingTransformationString = null;<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> }<a name="line.418"></a> |
| <span class="sourceLineNo">419</span><a name="line.419"></a> |
| <span class="sourceLineNo">420</span> public void setStreamingPaddingScheme(PaddingScheme scheme) {<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> setStreamingPaddingSchemeName(scheme.getTransformationName());<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> }<a name="line.422"></a> |
| <span class="sourceLineNo">423</span><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> public int getStreamingBlockSize() {<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> return streamingBlockSize;<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> }<a name="line.426"></a> |
| <span class="sourceLineNo">427</span><a name="line.427"></a> |
| <span class="sourceLineNo">428</span> public void setStreamingBlockSize(int streamingBlockSize) {<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> this.streamingBlockSize = Math.max(DEFAULT_BLOCK_SIZE, streamingBlockSize);<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> //clear out the streaming transformation string so the next invocation will rebuild it with the new block size:<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> this.streamingTransformationString = null;<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> }<a name="line.432"></a> |
| <span class="sourceLineNo">433</span><a name="line.433"></a> |
| <span class="sourceLineNo">434</span> /**<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * Returns the transformation string to use with the {@link javax.crypto.Cipher#getInstance} call. If<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> * {@code streaming} is {@code true}, a block-cipher transformation string compatible with streaming operations will<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * be constructed and cached for re-use later (see the class-level JavaDoc for more on using block ciphers<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * for streaming). If {@code streaming} is {@code false} a normal block-cipher transformation string will<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * be constructed and cached for later re-use.<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> *<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> * @param streaming if the transformation string is going to be used for a Cipher performing stream-based encryption or not.<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * @return the transformation string<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> */<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> protected String getTransformationString(boolean streaming) {<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> if (streaming) {<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> if (this.streamingTransformationString == null) {<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> this.streamingTransformationString = buildStreamingTransformationString();<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> }<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> return this.streamingTransformationString;<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> } else {<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> if (this.transformationString == null) {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> this.transformationString = buildTransformationString();<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> }<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> return this.transformationString;<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> }<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> }<a name="line.456"></a> |
| <span class="sourceLineNo">457</span><a name="line.457"></a> |
| <span class="sourceLineNo">458</span> private String buildTransformationString() {<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> return buildTransformationString(getModeName(), getPaddingSchemeName(), getBlockSize());<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span><a name="line.461"></a> |
| <span class="sourceLineNo">462</span> private String buildStreamingTransformationString() {<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> return buildTransformationString(getStreamingModeName(), getStreamingPaddingSchemeName(), 0);<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> }<a name="line.464"></a> |
| <span class="sourceLineNo">465</span><a name="line.465"></a> |
| <span class="sourceLineNo">466</span> private String buildTransformationString(String modeName, String paddingSchemeName, int blockSize) {<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> StringBuilder sb = new StringBuilder(getAlgorithmName());<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> if (StringUtils.hasText(modeName)) {<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> sb.append(TRANSFORMATION_STRING_DELIMITER).append(modeName);<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> }<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> if (blockSize > 0) {<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> sb.append(blockSize);<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> }<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> if (StringUtils.hasText(paddingSchemeName)) {<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> sb.append(TRANSFORMATION_STRING_DELIMITER).append(paddingSchemeName);<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> }<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> return sb.toString();<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> }<a name="line.478"></a> |
| <span class="sourceLineNo">479</span><a name="line.479"></a> |
| <span class="sourceLineNo">480</span> /**<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * Returns {@code true} if the specified cipher operation mode name supports initialization vectors,<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> * {@code false} otherwise.<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> *<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> * @param modeName the raw text name of the mode of operation<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> * @return {@code true} if the specified cipher operation mode name supports initialization vectors,<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * {@code false} otherwise.<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> */<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> private boolean isModeInitializationVectorCompatible(String modeName) {<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> return modeName != null &&<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> !modeName.equalsIgnoreCase(OperationMode.ECB.name()) &&<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> !modeName.equalsIgnoreCase(OperationMode.NONE.name());<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> }<a name="line.492"></a> |
| <span class="sourceLineNo">493</span><a name="line.493"></a> |
| <span class="sourceLineNo">494</span> /**<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * Overrides the parent implementation to ensure initialization vectors are always generated if streaming is<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * enabled (block ciphers <em>must</em> use initialization vectors if they are to be used as a stream cipher). If<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * not being used as a stream cipher, then the value is computed based on whether or not the currently configured<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * {@link #getModeName modeName} is compatible with initialization vectors as well as the result of the configured<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * {@link #setGenerateInitializationVectors(boolean) generateInitializationVectors} value.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> *<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * @param streaming whether or not streaming is being performed<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * @return {@code true} if streaming or a value computed based on if the currently configured mode is compatible<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * with initialization vectors.<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> */<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> @Override<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> protected boolean isGenerateInitializationVectors(boolean streaming) {<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> return streaming || super.isGenerateInitializationVectors() && isModeInitializationVectorCompatible(getModeName());<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> }<a name="line.508"></a> |
| <span class="sourceLineNo">509</span><a name="line.509"></a> |
| <span class="sourceLineNo">510</span> @Override<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> protected byte[] generateInitializationVector(boolean streaming) {<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> if (streaming) {<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> String streamingModeName = getStreamingModeName();<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> if (!isModeInitializationVectorCompatible(streamingModeName)) {<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> String msg = "streamingMode attribute value [" + streamingModeName + "] does not support " +<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> "Initialization Vectors. Ensure the streamingMode value represents an operation mode " +<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> "that is compatible with initialization vectors.";<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> throw new IllegalStateException(msg);<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> }<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> } else {<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> String modeName = getModeName();<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> if (!isModeInitializationVectorCompatible(modeName)) {<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> String msg = "mode attribute value [" + modeName + "] does not support " +<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> "Initialization Vectors. Ensure the mode value represents an operation mode " +<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> "that is compatible with initialization vectors.";<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> throw new IllegalStateException(msg);<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> }<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> }<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> return super.generateInitializationVector(streaming);<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> }<a name="line.530"></a> |
| <span class="sourceLineNo">531</span>}<a name="line.531"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
| |
