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