| <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.ByteSource;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.util.StringUtils;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.slf4j.Logger;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.slf4j.LoggerFactory;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> import javax.crypto.CipherInputStream;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import javax.crypto.spec.IvParameterSpec;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import javax.crypto.spec.SecretKeySpec;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import java.io.IOException;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import java.io.InputStream;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import java.io.OutputStream;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.security.Key;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import java.security.SecureRandom;<a name="line.33"></a> |
| <FONT color="green">034</FONT> import java.security.spec.AlgorithmParameterSpec;<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> /**<a name="line.36"></a> |
| <FONT color="green">037</FONT> * Abstract {@code CipherService} implementation utilizing Java's JCA APIs.<a name="line.37"></a> |
| <FONT color="green">038</FONT> * <h2>Auto-generated Initialization Vectors</h2><a name="line.38"></a> |
| <FONT color="green">039</FONT> * Shiro does something by default for all of its {@code CipherService} implementations that the JCA<a name="line.39"></a> |
| <FONT color="green">040</FONT> * {@link javax.crypto.Cipher Cipher} does not do: by default,<a name="line.40"></a> |
| <FONT color="green">041</FONT> * <a href="http://en.wikipedia.org/wiki/Initialization_vector">initialization vector</a>s are automatically randomly<a name="line.41"></a> |
| <FONT color="green">042</FONT> * generated and prepended to encrypted data before returning from the {@code encrypt} methods. That is, the returned<a name="line.42"></a> |
| <FONT color="green">043</FONT> * byte array or {@code OutputStream} is actually a concatenation of an initialization vector byte array plus the actual<a name="line.43"></a> |
| <FONT color="green">044</FONT> * encrypted data byte array. The {@code decrypt} methods in turn know to read this prepended initialization vector<a name="line.44"></a> |
| <FONT color="green">045</FONT> * before decrypting the real data that follows.<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <p/><a name="line.46"></a> |
| <FONT color="green">047</FONT> * This is highly desirable because initialization vectors guarantee that, for a key and any plaintext, the encrypted<a name="line.47"></a> |
| <FONT color="green">048</FONT> * output will always be different <em>even if you call {@code encrypt} multiple times with the exact same arguments</em>.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * This is essential in cryptography to ensure that data patterns cannot be identified across multiple input sources<a name="line.49"></a> |
| <FONT color="green">050</FONT> * that are the same or similar.<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <p/><a name="line.51"></a> |
| <FONT color="green">052</FONT> * You can turn off this behavior by setting the<a name="line.52"></a> |
| <FONT color="green">053</FONT> * {@link #setGenerateInitializationVectors(boolean) generateInitializationVectors} property to {@code false}, but it<a name="line.53"></a> |
| <FONT color="green">054</FONT> * is highly recommended that you do not do this unless you have a very good reason to do so, since you would be losing<a name="line.54"></a> |
| <FONT color="green">055</FONT> * a critical security feature.<a name="line.55"></a> |
| <FONT color="green">056</FONT> * <h3>Initialization Vector Size</h3><a name="line.56"></a> |
| <FONT color="green">057</FONT> * This implementation defaults the {@link #setInitializationVectorSize(int) initializationVectorSize} attribute to<a name="line.57"></a> |
| <FONT color="green">058</FONT> * {@code 128} bits, a fairly common size. Initialization vector sizes are very algorithm specific however, so subclass<a name="line.58"></a> |
| <FONT color="green">059</FONT> * implementations will often override this value in their constructor if necessary.<a name="line.59"></a> |
| <FONT color="green">060</FONT> * <p/><a name="line.60"></a> |
| <FONT color="green">061</FONT> * Also note that {@code initializationVectorSize} values are specified in the number of<a name="line.61"></a> |
| <FONT color="green">062</FONT> * bits (not bytes!) to match common references in most cryptography documentation. In practice though, initialization<a name="line.62"></a> |
| <FONT color="green">063</FONT> * vectors are always specified as a byte array, so ensure that if you set this property, that the value is a multiple<a name="line.63"></a> |
| <FONT color="green">064</FONT> * of {@code 8} to ensure that the IV can be correctly represented as a byte array (the<a name="line.64"></a> |
| <FONT color="green">065</FONT> * {@link #setInitializationVectorSize(int) setInitializationVectorSize} mutator method enforces this).<a name="line.65"></a> |
| <FONT color="green">066</FONT> *<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @since 1.0<a name="line.67"></a> |
| <FONT color="green">068</FONT> */<a name="line.68"></a> |
| <FONT color="green">069</FONT> public abstract class JcaCipherService implements CipherService {<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> /**<a name="line.71"></a> |
| <FONT color="green">072</FONT> * Internal private log instance.<a name="line.72"></a> |
| <FONT color="green">073</FONT> */<a name="line.73"></a> |
| <FONT color="green">074</FONT> private static final Logger log = LoggerFactory.getLogger(JcaCipherService.class);<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> /**<a name="line.76"></a> |
| <FONT color="green">077</FONT> * Default key size (in bits) for generated keys.<a name="line.77"></a> |
| <FONT color="green">078</FONT> */<a name="line.78"></a> |
| <FONT color="green">079</FONT> private static final int DEFAULT_KEY_SIZE = 128;<a name="line.79"></a> |
| <FONT color="green">080</FONT> <a name="line.80"></a> |
| <FONT color="green">081</FONT> /**<a name="line.81"></a> |
| <FONT color="green">082</FONT> * Default size of the internal buffer (in bytes) used to transfer data between streams during stream operations<a name="line.82"></a> |
| <FONT color="green">083</FONT> */<a name="line.83"></a> |
| <FONT color="green">084</FONT> private static final int DEFAULT_STREAMING_BUFFER_SIZE = 512;<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> private static final int BITS_PER_BYTE = 8;<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /**<a name="line.88"></a> |
| <FONT color="green">089</FONT> * Default SecureRandom algorithm name to use when acquiring the SecureRandom instance.<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> private static final String RANDOM_NUM_GENERATOR_ALGORITHM_NAME = "SHA1PRNG";<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> /**<a name="line.93"></a> |
| <FONT color="green">094</FONT> * The name of the cipher algorithm to use for all encryption, decryption, and key operations<a name="line.94"></a> |
| <FONT color="green">095</FONT> */<a name="line.95"></a> |
| <FONT color="green">096</FONT> private String algorithmName;<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * The size in bits (not bytes) of generated cipher keys<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> private int keySize;<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> /**<a name="line.103"></a> |
| <FONT color="green">104</FONT> * The size of the internal buffer (in bytes) used to transfer data from one stream to another during stream operations<a name="line.104"></a> |
| <FONT color="green">105</FONT> */<a name="line.105"></a> |
| <FONT color="green">106</FONT> private int streamingBufferSize;<a name="line.106"></a> |
| <FONT color="green">107</FONT> <a name="line.107"></a> |
| <FONT color="green">108</FONT> private boolean generateInitializationVectors;<a name="line.108"></a> |
| <FONT color="green">109</FONT> private int initializationVectorSize;<a name="line.109"></a> |
| <FONT color="green">110</FONT> <a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> private SecureRandom secureRandom;<a name="line.112"></a> |
| <FONT color="green">113</FONT> <a name="line.113"></a> |
| <FONT color="green">114</FONT> /**<a name="line.114"></a> |
| <FONT color="green">115</FONT> * Creates a new {@code JcaCipherService} instance which will use the specified cipher {@code algorithmName}<a name="line.115"></a> |
| <FONT color="green">116</FONT> * for all encryption, decryption, and key operations. Also, the following defaults are set:<a name="line.116"></a> |
| <FONT color="green">117</FONT> * <ul><a name="line.117"></a> |
| <FONT color="green">118</FONT> * <li>{@link #setKeySize keySize} = 128 bits</li><a name="line.118"></a> |
| <FONT color="green">119</FONT> * <li>{@link #setInitializationVectorSize(int) initializationVectorSize} = 128 bits</li><a name="line.119"></a> |
| <FONT color="green">120</FONT> * <li>{@link #setStreamingBufferSize(int) streamingBufferSize} = 512 bytes</li><a name="line.120"></a> |
| <FONT color="green">121</FONT> * </ul><a name="line.121"></a> |
| <FONT color="green">122</FONT> *<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @param algorithmName the name of the cipher algorithm to use for all encryption, decryption, and key operations<a name="line.123"></a> |
| <FONT color="green">124</FONT> */<a name="line.124"></a> |
| <FONT color="green">125</FONT> protected JcaCipherService(String algorithmName) {<a name="line.125"></a> |
| <FONT color="green">126</FONT> if (!StringUtils.hasText(algorithmName)) {<a name="line.126"></a> |
| <FONT color="green">127</FONT> throw new IllegalArgumentException("algorithmName argument cannot be null or empty.");<a name="line.127"></a> |
| <FONT color="green">128</FONT> }<a name="line.128"></a> |
| <FONT color="green">129</FONT> this.algorithmName = algorithmName;<a name="line.129"></a> |
| <FONT color="green">130</FONT> this.keySize = DEFAULT_KEY_SIZE;<a name="line.130"></a> |
| <FONT color="green">131</FONT> this.initializationVectorSize = DEFAULT_KEY_SIZE; //default to same size as the key size (a common algorithm practice)<a name="line.131"></a> |
| <FONT color="green">132</FONT> this.streamingBufferSize = DEFAULT_STREAMING_BUFFER_SIZE;<a name="line.132"></a> |
| <FONT color="green">133</FONT> this.generateInitializationVectors = true;<a name="line.133"></a> |
| <FONT color="green">134</FONT> }<a name="line.134"></a> |
| <FONT color="green">135</FONT> <a name="line.135"></a> |
| <FONT color="green">136</FONT> /**<a name="line.136"></a> |
| <FONT color="green">137</FONT> * Returns the cipher algorithm name that will be used for all encryption, decryption, and key operations (for<a name="line.137"></a> |
| <FONT color="green">138</FONT> * example, 'AES', 'Blowfish', 'RSA', 'DSA', 'TripleDES', etc).<a name="line.138"></a> |
| <FONT color="green">139</FONT> *<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @return the cipher algorithm name that will be used for all encryption, decryption, and key operations<a name="line.140"></a> |
| <FONT color="green">141</FONT> */<a name="line.141"></a> |
| <FONT color="green">142</FONT> public String getAlgorithmName() {<a name="line.142"></a> |
| <FONT color="green">143</FONT> return algorithmName;<a name="line.143"></a> |
| <FONT color="green">144</FONT> }<a name="line.144"></a> |
| <FONT color="green">145</FONT> <a name="line.145"></a> |
| <FONT color="green">146</FONT> /**<a name="line.146"></a> |
| <FONT color="green">147</FONT> * Returns the size in bits (not bytes) of generated cipher keys.<a name="line.147"></a> |
| <FONT color="green">148</FONT> *<a name="line.148"></a> |
| <FONT color="green">149</FONT> * @return the size in bits (not bytes) of generated cipher keys.<a name="line.149"></a> |
| <FONT color="green">150</FONT> */<a name="line.150"></a> |
| <FONT color="green">151</FONT> public int getKeySize() {<a name="line.151"></a> |
| <FONT color="green">152</FONT> return keySize;<a name="line.152"></a> |
| <FONT color="green">153</FONT> }<a name="line.153"></a> |
| <FONT color="green">154</FONT> <a name="line.154"></a> |
| <FONT color="green">155</FONT> /**<a name="line.155"></a> |
| <FONT color="green">156</FONT> * Sets the size in bits (not bytes) of generated cipher keys.<a name="line.156"></a> |
| <FONT color="green">157</FONT> *<a name="line.157"></a> |
| <FONT color="green">158</FONT> * @param keySize the size in bits (not bytes) of generated cipher keys.<a name="line.158"></a> |
| <FONT color="green">159</FONT> */<a name="line.159"></a> |
| <FONT color="green">160</FONT> public void setKeySize(int keySize) {<a name="line.160"></a> |
| <FONT color="green">161</FONT> this.keySize = keySize;<a name="line.161"></a> |
| <FONT color="green">162</FONT> }<a name="line.162"></a> |
| <FONT color="green">163</FONT> <a name="line.163"></a> |
| <FONT color="green">164</FONT> public boolean isGenerateInitializationVectors() {<a name="line.164"></a> |
| <FONT color="green">165</FONT> return generateInitializationVectors;<a name="line.165"></a> |
| <FONT color="green">166</FONT> }<a name="line.166"></a> |
| <FONT color="green">167</FONT> <a name="line.167"></a> |
| <FONT color="green">168</FONT> public void setGenerateInitializationVectors(boolean generateInitializationVectors) {<a name="line.168"></a> |
| <FONT color="green">169</FONT> this.generateInitializationVectors = generateInitializationVectors;<a name="line.169"></a> |
| <FONT color="green">170</FONT> }<a name="line.170"></a> |
| <FONT color="green">171</FONT> <a name="line.171"></a> |
| <FONT color="green">172</FONT> /**<a name="line.172"></a> |
| <FONT color="green">173</FONT> * Returns the algorithm-specific size in bits of generated initialization vectors.<a name="line.173"></a> |
| <FONT color="green">174</FONT> *<a name="line.174"></a> |
| <FONT color="green">175</FONT> * @return the algorithm-specific size in bits of generated initialization vectors.<a name="line.175"></a> |
| <FONT color="green">176</FONT> */<a name="line.176"></a> |
| <FONT color="green">177</FONT> public int getInitializationVectorSize() {<a name="line.177"></a> |
| <FONT color="green">178</FONT> return initializationVectorSize;<a name="line.178"></a> |
| <FONT color="green">179</FONT> }<a name="line.179"></a> |
| <FONT color="green">180</FONT> <a name="line.180"></a> |
| <FONT color="green">181</FONT> /**<a name="line.181"></a> |
| <FONT color="green">182</FONT> * Sets the algorithm-specific initialization vector size in bits (not bytes!) to be used when generating<a name="line.182"></a> |
| <FONT color="green">183</FONT> * initialization vectors. The value must be a multiple of {@code 8} to ensure that the IV can be represented<a name="line.183"></a> |
| <FONT color="green">184</FONT> * as a byte array.<a name="line.184"></a> |
| <FONT color="green">185</FONT> *<a name="line.185"></a> |
| <FONT color="green">186</FONT> * @param initializationVectorSize the size in bits (not bytes) of generated initialization vectors.<a name="line.186"></a> |
| <FONT color="green">187</FONT> * @throws IllegalArgumentException if the size is not a multiple of {@code 8}.<a name="line.187"></a> |
| <FONT color="green">188</FONT> */<a name="line.188"></a> |
| <FONT color="green">189</FONT> public void setInitializationVectorSize(int initializationVectorSize) throws IllegalArgumentException {<a name="line.189"></a> |
| <FONT color="green">190</FONT> if (initializationVectorSize % BITS_PER_BYTE != 0) {<a name="line.190"></a> |
| <FONT color="green">191</FONT> String msg = "Initialization vector sizes are specified in bits, but must be a multiple of 8 so they " +<a name="line.191"></a> |
| <FONT color="green">192</FONT> "can be easily represented as a byte array.";<a name="line.192"></a> |
| <FONT color="green">193</FONT> throw new IllegalArgumentException(msg);<a name="line.193"></a> |
| <FONT color="green">194</FONT> }<a name="line.194"></a> |
| <FONT color="green">195</FONT> this.initializationVectorSize = initializationVectorSize;<a name="line.195"></a> |
| <FONT color="green">196</FONT> }<a name="line.196"></a> |
| <FONT color="green">197</FONT> <a name="line.197"></a> |
| <FONT color="green">198</FONT> protected boolean isGenerateInitializationVectors(boolean streaming) {<a name="line.198"></a> |
| <FONT color="green">199</FONT> return isGenerateInitializationVectors();<a name="line.199"></a> |
| <FONT color="green">200</FONT> }<a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> /**<a name="line.202"></a> |
| <FONT color="green">203</FONT> * Returns the size in bytes of the internal buffer used to transfer data from one stream to another during stream<a name="line.203"></a> |
| <FONT color="green">204</FONT> * operations ({@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])} and<a name="line.204"></a> |
| <FONT color="green">205</FONT> * {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])}).<a name="line.205"></a> |
| <FONT color="green">206</FONT> * <p/><a name="line.206"></a> |
| <FONT color="green">207</FONT> * Default size is {@code 512} bytes.<a name="line.207"></a> |
| <FONT color="green">208</FONT> *<a name="line.208"></a> |
| <FONT color="green">209</FONT> * @return the size of the internal buffer used to transfer data from one stream to another during stream<a name="line.209"></a> |
| <FONT color="green">210</FONT> * operations<a name="line.210"></a> |
| <FONT color="green">211</FONT> */<a name="line.211"></a> |
| <FONT color="green">212</FONT> public int getStreamingBufferSize() {<a name="line.212"></a> |
| <FONT color="green">213</FONT> return streamingBufferSize;<a name="line.213"></a> |
| <FONT color="green">214</FONT> }<a name="line.214"></a> |
| <FONT color="green">215</FONT> <a name="line.215"></a> |
| <FONT color="green">216</FONT> /**<a name="line.216"></a> |
| <FONT color="green">217</FONT> * Sets the size in bytes of the internal buffer used to transfer data from one stream to another during stream<a name="line.217"></a> |
| <FONT color="green">218</FONT> * operations ({@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])} and<a name="line.218"></a> |
| <FONT color="green">219</FONT> * {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])}).<a name="line.219"></a> |
| <FONT color="green">220</FONT> * <p/><a name="line.220"></a> |
| <FONT color="green">221</FONT> * Default size is {@code 512} bytes.<a name="line.221"></a> |
| <FONT color="green">222</FONT> *<a name="line.222"></a> |
| <FONT color="green">223</FONT> * @param streamingBufferSize the size of the internal buffer used to transfer data from one stream to another<a name="line.223"></a> |
| <FONT color="green">224</FONT> * during stream operations<a name="line.224"></a> |
| <FONT color="green">225</FONT> */<a name="line.225"></a> |
| <FONT color="green">226</FONT> public void setStreamingBufferSize(int streamingBufferSize) {<a name="line.226"></a> |
| <FONT color="green">227</FONT> this.streamingBufferSize = streamingBufferSize;<a name="line.227"></a> |
| <FONT color="green">228</FONT> }<a name="line.228"></a> |
| <FONT color="green">229</FONT> <a name="line.229"></a> |
| <FONT color="green">230</FONT> /**<a name="line.230"></a> |
| <FONT color="green">231</FONT> * Returns a source of randomness for encryption operations. If one is not configured, and the underlying<a name="line.231"></a> |
| <FONT color="green">232</FONT> * algorithm needs one, the JDK {@code SHA1PRNG} instance will be used by default.<a name="line.232"></a> |
| <FONT color="green">233</FONT> *<a name="line.233"></a> |
| <FONT color="green">234</FONT> * @return a source of randomness for encryption operations. If one is not configured, and the underlying<a name="line.234"></a> |
| <FONT color="green">235</FONT> * algorithm needs one, the JDK {@code SHA1PRNG} instance will be used by default.<a name="line.235"></a> |
| <FONT color="green">236</FONT> */<a name="line.236"></a> |
| <FONT color="green">237</FONT> public SecureRandom getSecureRandom() {<a name="line.237"></a> |
| <FONT color="green">238</FONT> return secureRandom;<a name="line.238"></a> |
| <FONT color="green">239</FONT> }<a name="line.239"></a> |
| <FONT color="green">240</FONT> <a name="line.240"></a> |
| <FONT color="green">241</FONT> /**<a name="line.241"></a> |
| <FONT color="green">242</FONT> * Sets a source of randomness for encryption operations. If one is not configured, and the underlying<a name="line.242"></a> |
| <FONT color="green">243</FONT> * algorithm needs one, the JDK {@code SHA1PRNG} instance will be used by default.<a name="line.243"></a> |
| <FONT color="green">244</FONT> *<a name="line.244"></a> |
| <FONT color="green">245</FONT> * @param secureRandom a source of randomness for encryption operations. If one is not configured, and the<a name="line.245"></a> |
| <FONT color="green">246</FONT> * underlying algorithm needs one, the JDK {@code SHA1PRNG} instance will be used by default.<a name="line.246"></a> |
| <FONT color="green">247</FONT> */<a name="line.247"></a> |
| <FONT color="green">248</FONT> public void setSecureRandom(SecureRandom secureRandom) {<a name="line.248"></a> |
| <FONT color="green">249</FONT> this.secureRandom = secureRandom;<a name="line.249"></a> |
| <FONT color="green">250</FONT> }<a name="line.250"></a> |
| <FONT color="green">251</FONT> <a name="line.251"></a> |
| <FONT color="green">252</FONT> protected static SecureRandom getDefaultSecureRandom() {<a name="line.252"></a> |
| <FONT color="green">253</FONT> try {<a name="line.253"></a> |
| <FONT color="green">254</FONT> return java.security.SecureRandom.getInstance(RANDOM_NUM_GENERATOR_ALGORITHM_NAME);<a name="line.254"></a> |
| <FONT color="green">255</FONT> } catch (java.security.NoSuchAlgorithmException e) {<a name="line.255"></a> |
| <FONT color="green">256</FONT> log.debug("The SecureRandom SHA1PRNG algorithm is not available on the current platform. Using the " +<a name="line.256"></a> |
| <FONT color="green">257</FONT> "platform's default SecureRandom algorithm.", e);<a name="line.257"></a> |
| <FONT color="green">258</FONT> return new java.security.SecureRandom();<a name="line.258"></a> |
| <FONT color="green">259</FONT> }<a name="line.259"></a> |
| <FONT color="green">260</FONT> }<a name="line.260"></a> |
| <FONT color="green">261</FONT> <a name="line.261"></a> |
| <FONT color="green">262</FONT> protected SecureRandom ensureSecureRandom() {<a name="line.262"></a> |
| <FONT color="green">263</FONT> SecureRandom random = getSecureRandom();<a name="line.263"></a> |
| <FONT color="green">264</FONT> if (random == null) {<a name="line.264"></a> |
| <FONT color="green">265</FONT> random = getDefaultSecureRandom();<a name="line.265"></a> |
| <FONT color="green">266</FONT> }<a name="line.266"></a> |
| <FONT color="green">267</FONT> return random;<a name="line.267"></a> |
| <FONT color="green">268</FONT> }<a name="line.268"></a> |
| <FONT color="green">269</FONT> <a name="line.269"></a> |
| <FONT color="green">270</FONT> /**<a name="line.270"></a> |
| <FONT color="green">271</FONT> * Returns the transformation string to use with the {@link javax.crypto.Cipher#getInstance} invocation when<a name="line.271"></a> |
| <FONT color="green">272</FONT> * creating a new {@code Cipher} instance. This default implementation always returns<a name="line.272"></a> |
| <FONT color="green">273</FONT> * {@link #getAlgorithmName() getAlgorithmName()}. Block cipher implementations will want to override this method<a name="line.273"></a> |
| <FONT color="green">274</FONT> * to support appending cipher operation modes and padding schemes.<a name="line.274"></a> |
| <FONT color="green">275</FONT> *<a name="line.275"></a> |
| <FONT color="green">276</FONT> * @param streaming if the transformation string is going to be used for a Cipher for stream-based encryption or not.<a name="line.276"></a> |
| <FONT color="green">277</FONT> * @return the transformation string to use with the {@link javax.crypto.Cipher#getInstance} invocation when<a name="line.277"></a> |
| <FONT color="green">278</FONT> * creating a new {@code Cipher} instance.<a name="line.278"></a> |
| <FONT color="green">279</FONT> */<a name="line.279"></a> |
| <FONT color="green">280</FONT> protected String getTransformationString(boolean streaming) {<a name="line.280"></a> |
| <FONT color="green">281</FONT> return getAlgorithmName();<a name="line.281"></a> |
| <FONT color="green">282</FONT> }<a name="line.282"></a> |
| <FONT color="green">283</FONT> <a name="line.283"></a> |
| <FONT color="green">284</FONT> protected byte[] generateInitializationVector(boolean streaming) {<a name="line.284"></a> |
| <FONT color="green">285</FONT> int size = getInitializationVectorSize();<a name="line.285"></a> |
| <FONT color="green">286</FONT> if (size <= 0) {<a name="line.286"></a> |
| <FONT color="green">287</FONT> String msg = "initializationVectorSize property must be greater than zero. This number is " +<a name="line.287"></a> |
| <FONT color="green">288</FONT> "typically set in the " + CipherService.class.getSimpleName() + " subclass constructor. " +<a name="line.288"></a> |
| <FONT color="green">289</FONT> "Also check your configuration to ensure that if you are setting a value, it is positive.";<a name="line.289"></a> |
| <FONT color="green">290</FONT> throw new IllegalStateException(msg);<a name="line.290"></a> |
| <FONT color="green">291</FONT> }<a name="line.291"></a> |
| <FONT color="green">292</FONT> if (size % BITS_PER_BYTE != 0) {<a name="line.292"></a> |
| <FONT color="green">293</FONT> String msg = "initializationVectorSize property must be a multiple of 8 to represent as a byte array.";<a name="line.293"></a> |
| <FONT color="green">294</FONT> throw new IllegalStateException(msg);<a name="line.294"></a> |
| <FONT color="green">295</FONT> }<a name="line.295"></a> |
| <FONT color="green">296</FONT> int sizeInBytes = size / BITS_PER_BYTE;<a name="line.296"></a> |
| <FONT color="green">297</FONT> byte[] ivBytes = new byte[sizeInBytes];<a name="line.297"></a> |
| <FONT color="green">298</FONT> SecureRandom random = ensureSecureRandom();<a name="line.298"></a> |
| <FONT color="green">299</FONT> random.nextBytes(ivBytes);<a name="line.299"></a> |
| <FONT color="green">300</FONT> return ivBytes;<a name="line.300"></a> |
| <FONT color="green">301</FONT> }<a name="line.301"></a> |
| <FONT color="green">302</FONT> <a name="line.302"></a> |
| <FONT color="green">303</FONT> public ByteSource encrypt(byte[] plaintext, byte[] key) {<a name="line.303"></a> |
| <FONT color="green">304</FONT> byte[] ivBytes = null;<a name="line.304"></a> |
| <FONT color="green">305</FONT> boolean generate = isGenerateInitializationVectors(false);<a name="line.305"></a> |
| <FONT color="green">306</FONT> if (generate) {<a name="line.306"></a> |
| <FONT color="green">307</FONT> ivBytes = generateInitializationVector(false);<a name="line.307"></a> |
| <FONT color="green">308</FONT> if (ivBytes == null || ivBytes.length == 0) {<a name="line.308"></a> |
| <FONT color="green">309</FONT> throw new IllegalStateException("Initialization vector generation is enabled - generated vector" +<a name="line.309"></a> |
| <FONT color="green">310</FONT> "cannot be null or empty.");<a name="line.310"></a> |
| <FONT color="green">311</FONT> }<a name="line.311"></a> |
| <FONT color="green">312</FONT> }<a name="line.312"></a> |
| <FONT color="green">313</FONT> return encrypt(plaintext, key, ivBytes, generate);<a name="line.313"></a> |
| <FONT color="green">314</FONT> }<a name="line.314"></a> |
| <FONT color="green">315</FONT> <a name="line.315"></a> |
| <FONT color="green">316</FONT> private ByteSource encrypt(byte[] plaintext, byte[] key, byte[] iv, boolean prependIv) throws CryptoException {<a name="line.316"></a> |
| <FONT color="green">317</FONT> <a name="line.317"></a> |
| <FONT color="green">318</FONT> final int MODE = javax.crypto.Cipher.ENCRYPT_MODE;<a name="line.318"></a> |
| <FONT color="green">319</FONT> <a name="line.319"></a> |
| <FONT color="green">320</FONT> byte[] output;<a name="line.320"></a> |
| <FONT color="green">321</FONT> <a name="line.321"></a> |
| <FONT color="green">322</FONT> if (prependIv && iv != null && iv.length > 0) {<a name="line.322"></a> |
| <FONT color="green">323</FONT> <a name="line.323"></a> |
| <FONT color="green">324</FONT> byte[] encrypted = crypt(plaintext, key, iv, MODE);<a name="line.324"></a> |
| <FONT color="green">325</FONT> <a name="line.325"></a> |
| <FONT color="green">326</FONT> output = new byte[iv.length + encrypted.length];<a name="line.326"></a> |
| <FONT color="green">327</FONT> <a name="line.327"></a> |
| <FONT color="green">328</FONT> //now copy the iv bytes + encrypted bytes into one output array:<a name="line.328"></a> |
| <FONT color="green">329</FONT> <a name="line.329"></a> |
| <FONT color="green">330</FONT> // iv bytes:<a name="line.330"></a> |
| <FONT color="green">331</FONT> System.arraycopy(iv, 0, output, 0, iv.length);<a name="line.331"></a> |
| <FONT color="green">332</FONT> <a name="line.332"></a> |
| <FONT color="green">333</FONT> // + encrypted bytes:<a name="line.333"></a> |
| <FONT color="green">334</FONT> System.arraycopy(encrypted, 0, output, iv.length, encrypted.length);<a name="line.334"></a> |
| <FONT color="green">335</FONT> } else {<a name="line.335"></a> |
| <FONT color="green">336</FONT> output = crypt(plaintext, key, iv, MODE);<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> if (log.isTraceEnabled()) {<a name="line.339"></a> |
| <FONT color="green">340</FONT> log.trace("Incoming plaintext of size " + (plaintext != null ? plaintext.length : 0) + ". Ciphertext " +<a name="line.340"></a> |
| <FONT color="green">341</FONT> "byte array is size " + (output != null ? output.length : 0));<a name="line.341"></a> |
| <FONT color="green">342</FONT> }<a name="line.342"></a> |
| <FONT color="green">343</FONT> <a name="line.343"></a> |
| <FONT color="green">344</FONT> return ByteSource.Util.bytes(output);<a name="line.344"></a> |
| <FONT color="green">345</FONT> }<a name="line.345"></a> |
| <FONT color="green">346</FONT> <a name="line.346"></a> |
| <FONT color="green">347</FONT> public ByteSource decrypt(byte[] ciphertext, byte[] key) throws CryptoException {<a name="line.347"></a> |
| <FONT color="green">348</FONT> <a name="line.348"></a> |
| <FONT color="green">349</FONT> byte[] encrypted = ciphertext;<a name="line.349"></a> |
| <FONT color="green">350</FONT> <a name="line.350"></a> |
| <FONT color="green">351</FONT> //No IV, check if we need to read the IV from the stream:<a name="line.351"></a> |
| <FONT color="green">352</FONT> byte[] iv = null;<a name="line.352"></a> |
| <FONT color="green">353</FONT> <a name="line.353"></a> |
| <FONT color="green">354</FONT> if (isGenerateInitializationVectors(false)) {<a name="line.354"></a> |
| <FONT color="green">355</FONT> try {<a name="line.355"></a> |
| <FONT color="green">356</FONT> //We are generating IVs, so the ciphertext argument array is not actually 100% cipher text. Instead, it<a name="line.356"></a> |
| <FONT color="green">357</FONT> //is:<a name="line.357"></a> |
| <FONT color="green">358</FONT> // - the first N bytes is the initialization vector, where N equals the value of the<a name="line.358"></a> |
| <FONT color="green">359</FONT> // 'initializationVectorSize' attribute.<a name="line.359"></a> |
| <FONT color="green">360</FONT> // - the remaining bytes in the method argument (arg.length - N) is the real cipher text.<a name="line.360"></a> |
| <FONT color="green">361</FONT> <a name="line.361"></a> |
| <FONT color="green">362</FONT> //So we need to chunk the method argument into its constituent parts to find the IV and then use<a name="line.362"></a> |
| <FONT color="green">363</FONT> //the IV to decrypt the real ciphertext:<a name="line.363"></a> |
| <FONT color="green">364</FONT> <a name="line.364"></a> |
| <FONT color="green">365</FONT> int ivSize = getInitializationVectorSize();<a name="line.365"></a> |
| <FONT color="green">366</FONT> int ivByteSize = ivSize / BITS_PER_BYTE;<a name="line.366"></a> |
| <FONT color="green">367</FONT> <a name="line.367"></a> |
| <FONT color="green">368</FONT> //now we know how large the iv is, so extract the iv bytes:<a name="line.368"></a> |
| <FONT color="green">369</FONT> iv = new byte[ivByteSize];<a name="line.369"></a> |
| <FONT color="green">370</FONT> System.arraycopy(ciphertext, 0, iv, 0, ivByteSize);<a name="line.370"></a> |
| <FONT color="green">371</FONT> <a name="line.371"></a> |
| <FONT color="green">372</FONT> //remaining data is the actual encrypted ciphertext. Isolate it:<a name="line.372"></a> |
| <FONT color="green">373</FONT> int encryptedSize = ciphertext.length - ivByteSize;<a name="line.373"></a> |
| <FONT color="green">374</FONT> encrypted = new byte[encryptedSize];<a name="line.374"></a> |
| <FONT color="green">375</FONT> System.arraycopy(ciphertext, ivByteSize, encrypted, 0, encryptedSize);<a name="line.375"></a> |
| <FONT color="green">376</FONT> } catch (Exception e) {<a name="line.376"></a> |
| <FONT color="green">377</FONT> String msg = "Unable to correctly extract the Initialization Vector or ciphertext.";<a name="line.377"></a> |
| <FONT color="green">378</FONT> throw new CryptoException(msg, e);<a name="line.378"></a> |
| <FONT color="green">379</FONT> }<a name="line.379"></a> |
| <FONT color="green">380</FONT> }<a name="line.380"></a> |
| <FONT color="green">381</FONT> <a name="line.381"></a> |
| <FONT color="green">382</FONT> return decrypt(encrypted, key, iv);<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> private ByteSource decrypt(byte[] ciphertext, byte[] key, byte[] iv) throws CryptoException {<a name="line.385"></a> |
| <FONT color="green">386</FONT> if (log.isTraceEnabled()) {<a name="line.386"></a> |
| <FONT color="green">387</FONT> log.trace("Attempting to decrypt incoming byte array of length " +<a name="line.387"></a> |
| <FONT color="green">388</FONT> (ciphertext != null ? ciphertext.length : 0));<a name="line.388"></a> |
| <FONT color="green">389</FONT> }<a name="line.389"></a> |
| <FONT color="green">390</FONT> byte[] decrypted = crypt(ciphertext, key, iv, javax.crypto.Cipher.DECRYPT_MODE);<a name="line.390"></a> |
| <FONT color="green">391</FONT> return decrypted == null ? null : ByteSource.Util.bytes(decrypted);<a name="line.391"></a> |
| <FONT color="green">392</FONT> }<a name="line.392"></a> |
| <FONT color="green">393</FONT> <a name="line.393"></a> |
| <FONT color="green">394</FONT> /**<a name="line.394"></a> |
| <FONT color="green">395</FONT> * Returns a new {@link javax.crypto.Cipher Cipher} instance to use for encryption/decryption operations. The<a name="line.395"></a> |
| <FONT color="green">396</FONT> * Cipher's {@code transformationString} for the {@code Cipher}.{@link javax.crypto.Cipher#getInstance getInstance}<a name="line.396"></a> |
| <FONT color="green">397</FONT> * call is obtaind via the {@link #getTransformationString(boolean) getTransformationString} method.<a name="line.397"></a> |
| <FONT color="green">398</FONT> *<a name="line.398"></a> |
| <FONT color="green">399</FONT> * @param streaming {@code true} if the cipher instance will be used as a stream cipher, {@code false} if it will be<a name="line.399"></a> |
| <FONT color="green">400</FONT> * used as a block cipher.<a name="line.400"></a> |
| <FONT color="green">401</FONT> * @return a new JDK {@code Cipher} instance.<a name="line.401"></a> |
| <FONT color="green">402</FONT> * @throws CryptoException if a new Cipher instance cannot be constructed based on the<a name="line.402"></a> |
| <FONT color="green">403</FONT> * {@link #getTransformationString(boolean) getTransformationString} value.<a name="line.403"></a> |
| <FONT color="green">404</FONT> */<a name="line.404"></a> |
| <FONT color="green">405</FONT> private javax.crypto.Cipher newCipherInstance(boolean streaming) throws CryptoException {<a name="line.405"></a> |
| <FONT color="green">406</FONT> String transformationString = getTransformationString(streaming);<a name="line.406"></a> |
| <FONT color="green">407</FONT> try {<a name="line.407"></a> |
| <FONT color="green">408</FONT> return javax.crypto.Cipher.getInstance(transformationString);<a name="line.408"></a> |
| <FONT color="green">409</FONT> } catch (Exception e) {<a name="line.409"></a> |
| <FONT color="green">410</FONT> String msg = "Unable to acquire a Java JCA Cipher instance using " +<a name="line.410"></a> |
| <FONT color="green">411</FONT> javax.crypto.Cipher.class.getName() + ".getInstance( \"" + transformationString + "\" ). " +<a name="line.411"></a> |
| <FONT color="green">412</FONT> getAlgorithmName() + " under this configuration is required for the " +<a name="line.412"></a> |
| <FONT color="green">413</FONT> getClass().getName() + " instance to function.";<a name="line.413"></a> |
| <FONT color="green">414</FONT> throw new CryptoException(msg, e);<a name="line.414"></a> |
| <FONT color="green">415</FONT> }<a name="line.415"></a> |
| <FONT color="green">416</FONT> }<a name="line.416"></a> |
| <FONT color="green">417</FONT> <a name="line.417"></a> |
| <FONT color="green">418</FONT> /**<a name="line.418"></a> |
| <FONT color="green">419</FONT> * Functions as follows:<a name="line.419"></a> |
| <FONT color="green">420</FONT> * <ol><a name="line.420"></a> |
| <FONT color="green">421</FONT> * <li>Creates a {@link #newCipherInstance(boolean) new JDK cipher instance}</li><a name="line.421"></a> |
| <FONT color="green">422</FONT> * <li>Converts the specified key bytes into an {@link #getAlgorithmName() algorithm}-compatible JDK<a name="line.422"></a> |
| <FONT color="green">423</FONT> * {@link Key key} instance</li><a name="line.423"></a> |
| <FONT color="green">424</FONT> * <li>{@link #init(javax.crypto.Cipher, int, java.security.Key, AlgorithmParameterSpec, SecureRandom) Initializes}<a name="line.424"></a> |
| <FONT color="green">425</FONT> * the JDK cipher instance with the JDK key</li><a name="line.425"></a> |
| <FONT color="green">426</FONT> * <li>Calls the {@link #crypt(javax.crypto.Cipher, byte[]) crypt(cipher,bytes)} method to either encrypt or<a name="line.426"></a> |
| <FONT color="green">427</FONT> * decrypt the data based on the specified Cipher behavior mode<a name="line.427"></a> |
| <FONT color="green">428</FONT> * ({@link javax.crypto.Cipher#ENCRYPT_MODE Cipher.ENCRYPT_MODE} or<a name="line.428"></a> |
| <FONT color="green">429</FONT> * {@link javax.crypto.Cipher#DECRYPT_MODE Cipher.DECRYPT_MODE})</li><a name="line.429"></a> |
| <FONT color="green">430</FONT> * </ol><a name="line.430"></a> |
| <FONT color="green">431</FONT> *<a name="line.431"></a> |
| <FONT color="green">432</FONT> * @param bytes the bytes to crypt<a name="line.432"></a> |
| <FONT color="green">433</FONT> * @param key the key to use to perform the encryption or decryption.<a name="line.433"></a> |
| <FONT color="green">434</FONT> * @param iv the initialization vector to use for the crypt operation (optional, may be {@code null}).<a name="line.434"></a> |
| <FONT color="green">435</FONT> * @param mode the JDK Cipher behavior mode (Cipher.ENCRYPT_MODE or Cipher.DECRYPT_MODE).<a name="line.435"></a> |
| <FONT color="green">436</FONT> * @return the resulting crypted byte array<a name="line.436"></a> |
| <FONT color="green">437</FONT> * @throws IllegalArgumentException if {@code bytes} are null or empty.<a name="line.437"></a> |
| <FONT color="green">438</FONT> * @throws CryptoException if Cipher initialization or the crypt operation fails<a name="line.438"></a> |
| <FONT color="green">439</FONT> */<a name="line.439"></a> |
| <FONT color="green">440</FONT> private byte[] crypt(byte[] bytes, byte[] key, byte[] iv, int mode) throws IllegalArgumentException, CryptoException {<a name="line.440"></a> |
| <FONT color="green">441</FONT> if (key == null || key.length == 0) {<a name="line.441"></a> |
| <FONT color="green">442</FONT> throw new IllegalArgumentException("key argument cannot be null or empty.");<a name="line.442"></a> |
| <FONT color="green">443</FONT> }<a name="line.443"></a> |
| <FONT color="green">444</FONT> javax.crypto.Cipher cipher = initNewCipher(mode, key, iv, false);<a name="line.444"></a> |
| <FONT color="green">445</FONT> return crypt(cipher, bytes);<a name="line.445"></a> |
| <FONT color="green">446</FONT> }<a name="line.446"></a> |
| <FONT color="green">447</FONT> <a name="line.447"></a> |
| <FONT color="green">448</FONT> /**<a name="line.448"></a> |
| <FONT color="green">449</FONT> * Calls the {@link javax.crypto.Cipher#doFinal(byte[]) doFinal(bytes)} method, propagating any exception that<a name="line.449"></a> |
| <FONT color="green">450</FONT> * might arise in an {@link CryptoException}<a name="line.450"></a> |
| <FONT color="green">451</FONT> *<a name="line.451"></a> |
| <FONT color="green">452</FONT> * @param cipher the JDK Cipher to finalize (perform the actual cryption)<a name="line.452"></a> |
| <FONT color="green">453</FONT> * @param bytes the bytes to crypt<a name="line.453"></a> |
| <FONT color="green">454</FONT> * @return the resulting crypted byte array.<a name="line.454"></a> |
| <FONT color="green">455</FONT> * @throws CryptoException if there is an illegal block size or bad padding<a name="line.455"></a> |
| <FONT color="green">456</FONT> */<a name="line.456"></a> |
| <FONT color="green">457</FONT> private byte[] crypt(javax.crypto.Cipher cipher, byte[] bytes) throws CryptoException {<a name="line.457"></a> |
| <FONT color="green">458</FONT> try {<a name="line.458"></a> |
| <FONT color="green">459</FONT> return cipher.doFinal(bytes);<a name="line.459"></a> |
| <FONT color="green">460</FONT> } catch (Exception e) {<a name="line.460"></a> |
| <FONT color="green">461</FONT> String msg = "Unable to execute 'doFinal' with cipher instance [" + cipher + "].";<a name="line.461"></a> |
| <FONT color="green">462</FONT> throw new CryptoException(msg, e);<a name="line.462"></a> |
| <FONT color="green">463</FONT> }<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> /**<a name="line.466"></a> |
| <FONT color="green">467</FONT> * Initializes the JDK Cipher with the specified mode and key. This is primarily a utility method to catch any<a name="line.467"></a> |
| <FONT color="green">468</FONT> * potential {@link java.security.InvalidKeyException InvalidKeyException} that might arise.<a name="line.468"></a> |
| <FONT color="green">469</FONT> *<a name="line.469"></a> |
| <FONT color="green">470</FONT> * @param cipher the JDK Cipher to {@link javax.crypto.Cipher#init(int, java.security.Key) init}.<a name="line.470"></a> |
| <FONT color="green">471</FONT> * @param mode the Cipher mode<a name="line.471"></a> |
| <FONT color="green">472</FONT> * @param key the Cipher's Key<a name="line.472"></a> |
| <FONT color="green">473</FONT> * @param spec the JDK AlgorithmParameterSpec for cipher initialization (optional, may be null).<a name="line.473"></a> |
| <FONT color="green">474</FONT> * @param random the SecureRandom to use for cipher initialization (optional, may be null).<a name="line.474"></a> |
| <FONT color="green">475</FONT> * @throws CryptoException if the key is invalid<a name="line.475"></a> |
| <FONT color="green">476</FONT> */<a name="line.476"></a> |
| <FONT color="green">477</FONT> private void init(javax.crypto.Cipher cipher, int mode, java.security.Key key,<a name="line.477"></a> |
| <FONT color="green">478</FONT> AlgorithmParameterSpec spec, SecureRandom random) throws CryptoException {<a name="line.478"></a> |
| <FONT color="green">479</FONT> try {<a name="line.479"></a> |
| <FONT color="green">480</FONT> if (random != null) {<a name="line.480"></a> |
| <FONT color="green">481</FONT> if (spec != null) {<a name="line.481"></a> |
| <FONT color="green">482</FONT> cipher.init(mode, key, spec, random);<a name="line.482"></a> |
| <FONT color="green">483</FONT> } else {<a name="line.483"></a> |
| <FONT color="green">484</FONT> cipher.init(mode, key, random);<a name="line.484"></a> |
| <FONT color="green">485</FONT> }<a name="line.485"></a> |
| <FONT color="green">486</FONT> } else {<a name="line.486"></a> |
| <FONT color="green">487</FONT> if (spec != null) {<a name="line.487"></a> |
| <FONT color="green">488</FONT> cipher.init(mode, key, spec);<a name="line.488"></a> |
| <FONT color="green">489</FONT> } else {<a name="line.489"></a> |
| <FONT color="green">490</FONT> cipher.init(mode, key);<a name="line.490"></a> |
| <FONT color="green">491</FONT> }<a name="line.491"></a> |
| <FONT color="green">492</FONT> }<a name="line.492"></a> |
| <FONT color="green">493</FONT> } catch (Exception e) {<a name="line.493"></a> |
| <FONT color="green">494</FONT> String msg = "Unable to init cipher instance.";<a name="line.494"></a> |
| <FONT color="green">495</FONT> throw new CryptoException(msg, e);<a name="line.495"></a> |
| <FONT color="green">496</FONT> }<a name="line.496"></a> |
| <FONT color="green">497</FONT> }<a name="line.497"></a> |
| <FONT color="green">498</FONT> <a name="line.498"></a> |
| <FONT color="green">499</FONT> <a name="line.499"></a> |
| <FONT color="green">500</FONT> public void encrypt(InputStream in, OutputStream out, byte[] key) throws CryptoException {<a name="line.500"></a> |
| <FONT color="green">501</FONT> byte[] iv = null;<a name="line.501"></a> |
| <FONT color="green">502</FONT> boolean generate = isGenerateInitializationVectors(true);<a name="line.502"></a> |
| <FONT color="green">503</FONT> if (generate) {<a name="line.503"></a> |
| <FONT color="green">504</FONT> iv = generateInitializationVector(true);<a name="line.504"></a> |
| <FONT color="green">505</FONT> if (iv == null || iv.length == 0) {<a name="line.505"></a> |
| <FONT color="green">506</FONT> throw new IllegalStateException("Initialization vector generation is enabled - generated vector" +<a name="line.506"></a> |
| <FONT color="green">507</FONT> "cannot be null or empty.");<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> encrypt(in, out, key, iv, generate);<a name="line.510"></a> |
| <FONT color="green">511</FONT> }<a name="line.511"></a> |
| <FONT color="green">512</FONT> <a name="line.512"></a> |
| <FONT color="green">513</FONT> private void encrypt(InputStream in, OutputStream out, byte[] key, byte[] iv, boolean prependIv) throws CryptoException {<a name="line.513"></a> |
| <FONT color="green">514</FONT> if (prependIv && iv != null && iv.length > 0) {<a name="line.514"></a> |
| <FONT color="green">515</FONT> try {<a name="line.515"></a> |
| <FONT color="green">516</FONT> //first write the IV:<a name="line.516"></a> |
| <FONT color="green">517</FONT> out.write(iv);<a name="line.517"></a> |
| <FONT color="green">518</FONT> } catch (IOException e) {<a name="line.518"></a> |
| <FONT color="green">519</FONT> throw new CryptoException(e);<a name="line.519"></a> |
| <FONT color="green">520</FONT> }<a name="line.520"></a> |
| <FONT color="green">521</FONT> }<a name="line.521"></a> |
| <FONT color="green">522</FONT> <a name="line.522"></a> |
| <FONT color="green">523</FONT> crypt(in, out, key, iv, javax.crypto.Cipher.ENCRYPT_MODE);<a name="line.523"></a> |
| <FONT color="green">524</FONT> }<a name="line.524"></a> |
| <FONT color="green">525</FONT> <a name="line.525"></a> |
| <FONT color="green">526</FONT> public void decrypt(InputStream in, OutputStream out, byte[] key) throws CryptoException {<a name="line.526"></a> |
| <FONT color="green">527</FONT> decrypt(in, out, key, isGenerateInitializationVectors(true));<a name="line.527"></a> |
| <FONT color="green">528</FONT> }<a name="line.528"></a> |
| <FONT color="green">529</FONT> <a name="line.529"></a> |
| <FONT color="green">530</FONT> private void decrypt(InputStream in, OutputStream out, byte[] key, boolean ivPrepended) throws CryptoException {<a name="line.530"></a> |
| <FONT color="green">531</FONT> <a name="line.531"></a> |
| <FONT color="green">532</FONT> byte[] iv = null;<a name="line.532"></a> |
| <FONT color="green">533</FONT> //No Initialization Vector provided as a method argument - check if we need to read the IV from the stream:<a name="line.533"></a> |
| <FONT color="green">534</FONT> if (ivPrepended) {<a name="line.534"></a> |
| <FONT color="green">535</FONT> //we are generating IVs, so we need to read the previously-generated IV from the stream before<a name="line.535"></a> |
| <FONT color="green">536</FONT> //we decrypt the rest of the stream (we need the IV to decrypt):<a name="line.536"></a> |
| <FONT color="green">537</FONT> int ivSize = getInitializationVectorSize();<a name="line.537"></a> |
| <FONT color="green">538</FONT> int ivByteSize = ivSize / BITS_PER_BYTE;<a name="line.538"></a> |
| <FONT color="green">539</FONT> iv = new byte[ivByteSize];<a name="line.539"></a> |
| <FONT color="green">540</FONT> int read;<a name="line.540"></a> |
| <FONT color="green">541</FONT> <a name="line.541"></a> |
| <FONT color="green">542</FONT> try {<a name="line.542"></a> |
| <FONT color="green">543</FONT> read = in.read(iv);<a name="line.543"></a> |
| <FONT color="green">544</FONT> } catch (IOException e) {<a name="line.544"></a> |
| <FONT color="green">545</FONT> String msg = "Unable to correctly read the Initialization Vector from the input stream.";<a name="line.545"></a> |
| <FONT color="green">546</FONT> throw new CryptoException(msg, e);<a name="line.546"></a> |
| <FONT color="green">547</FONT> }<a name="line.547"></a> |
| <FONT color="green">548</FONT> <a name="line.548"></a> |
| <FONT color="green">549</FONT> if (read != ivByteSize) {<a name="line.549"></a> |
| <FONT color="green">550</FONT> throw new CryptoException("Unable to read initialization vector bytes from the InputStream. " +<a name="line.550"></a> |
| <FONT color="green">551</FONT> "This is required when initialization vectors are autogenerated during an encryption " +<a name="line.551"></a> |
| <FONT color="green">552</FONT> "operation.");<a name="line.552"></a> |
| <FONT color="green">553</FONT> }<a name="line.553"></a> |
| <FONT color="green">554</FONT> }<a name="line.554"></a> |
| <FONT color="green">555</FONT> <a name="line.555"></a> |
| <FONT color="green">556</FONT> decrypt(in, out, key, iv);<a name="line.556"></a> |
| <FONT color="green">557</FONT> }<a name="line.557"></a> |
| <FONT color="green">558</FONT> <a name="line.558"></a> |
| <FONT color="green">559</FONT> private void decrypt(InputStream in, OutputStream out, byte[] decryptionKey, byte[] iv) throws CryptoException {<a name="line.559"></a> |
| <FONT color="green">560</FONT> crypt(in, out, decryptionKey, iv, javax.crypto.Cipher.DECRYPT_MODE);<a name="line.560"></a> |
| <FONT color="green">561</FONT> }<a name="line.561"></a> |
| <FONT color="green">562</FONT> <a name="line.562"></a> |
| <FONT color="green">563</FONT> private void crypt(InputStream in, OutputStream out, byte[] keyBytes, byte[] iv, int cryptMode) throws CryptoException {<a name="line.563"></a> |
| <FONT color="green">564</FONT> if (in == null) {<a name="line.564"></a> |
| <FONT color="green">565</FONT> throw new NullPointerException("InputStream argument cannot be null.");<a name="line.565"></a> |
| <FONT color="green">566</FONT> }<a name="line.566"></a> |
| <FONT color="green">567</FONT> if (out == null) {<a name="line.567"></a> |
| <FONT color="green">568</FONT> throw new NullPointerException("OutputStream argument cannot be null.");<a name="line.568"></a> |
| <FONT color="green">569</FONT> }<a name="line.569"></a> |
| <FONT color="green">570</FONT> <a name="line.570"></a> |
| <FONT color="green">571</FONT> javax.crypto.Cipher cipher = initNewCipher(cryptMode, keyBytes, iv, true);<a name="line.571"></a> |
| <FONT color="green">572</FONT> <a name="line.572"></a> |
| <FONT color="green">573</FONT> CipherInputStream cis = new CipherInputStream(in, cipher);<a name="line.573"></a> |
| <FONT color="green">574</FONT> <a name="line.574"></a> |
| <FONT color="green">575</FONT> int bufSize = getStreamingBufferSize();<a name="line.575"></a> |
| <FONT color="green">576</FONT> byte[] buffer = new byte[bufSize];<a name="line.576"></a> |
| <FONT color="green">577</FONT> <a name="line.577"></a> |
| <FONT color="green">578</FONT> int bytesRead;<a name="line.578"></a> |
| <FONT color="green">579</FONT> try {<a name="line.579"></a> |
| <FONT color="green">580</FONT> while ((bytesRead = cis.read(buffer)) != -1) {<a name="line.580"></a> |
| <FONT color="green">581</FONT> out.write(buffer, 0, bytesRead);<a name="line.581"></a> |
| <FONT color="green">582</FONT> }<a name="line.582"></a> |
| <FONT color="green">583</FONT> } catch (IOException e) {<a name="line.583"></a> |
| <FONT color="green">584</FONT> throw new CryptoException(e);<a name="line.584"></a> |
| <FONT color="green">585</FONT> }<a name="line.585"></a> |
| <FONT color="green">586</FONT> }<a name="line.586"></a> |
| <FONT color="green">587</FONT> <a name="line.587"></a> |
| <FONT color="green">588</FONT> private javax.crypto.Cipher initNewCipher(int jcaCipherMode, byte[] key, byte[] iv, boolean streaming)<a name="line.588"></a> |
| <FONT color="green">589</FONT> throws CryptoException {<a name="line.589"></a> |
| <FONT color="green">590</FONT> <a name="line.590"></a> |
| <FONT color="green">591</FONT> javax.crypto.Cipher cipher = newCipherInstance(streaming);<a name="line.591"></a> |
| <FONT color="green">592</FONT> java.security.Key jdkKey = new SecretKeySpec(key, getAlgorithmName());<a name="line.592"></a> |
| <FONT color="green">593</FONT> IvParameterSpec ivSpec = null;<a name="line.593"></a> |
| <FONT color="green">594</FONT> if (iv != null && iv.length > 0) {<a name="line.594"></a> |
| <FONT color="green">595</FONT> ivSpec = new IvParameterSpec(iv);<a name="line.595"></a> |
| <FONT color="green">596</FONT> }<a name="line.596"></a> |
| <FONT color="green">597</FONT> <a name="line.597"></a> |
| <FONT color="green">598</FONT> init(cipher, jcaCipherMode, jdkKey, ivSpec, getSecureRandom());<a name="line.598"></a> |
| <FONT color="green">599</FONT> <a name="line.599"></a> |
| <FONT color="green">600</FONT> return cipher;<a name="line.600"></a> |
| <FONT color="green">601</FONT> }<a name="line.601"></a> |
| <FONT color="green">602</FONT> }<a name="line.602"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
