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