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