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