| <!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=UTF-8" /> |
| <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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.crypto; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * Base abstract class for block cipher algorithms.</em> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * <h2>Usage</h2></em> |
| <a class="jxr_linenumber" name="L27" href="#L27">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 class="jxr_linenumber" name="L28" href="#L28">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 class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * typically not uses instances of this class directly. Instead, algorithm-specific subclasses, such as</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * {@link AesCipherService}, {@link BlowfishCipherService}, and others are usually better suited for regular use.</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L32" href="#L32">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 class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * exists in Shiro, this class would be very useful.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <h2>Configuration</h2></em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Block ciphers can accept configuration parameters that direct how they operate. These parameters concatenated</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * together in a single String comprise what the JDK JCA documentation calls a</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <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">transformation</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * string</a>. We think that it is better for Shiro to construct this transformation string automatically based on its</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">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 class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * confusing. To that end, Shiro {@link DefaultBlockCipherService}s have attributes that can be set individually in</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">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 class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * The following sections typically document the configuration options for block (byte array)</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * {@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])} method invocations. Streaming configuration</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">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 class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * they're only used during streaming {@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])} and</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])} methods. See the &quot;Streaming&quot;</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * section below for more.</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <h3>Block Size</h3></em> |
| <a class="jxr_linenumber" name="L52" href="#L52">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 class="jxr_linenumber" name="L53" href="#L53">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 class="jxr_linenumber" name="L54" href="#L54">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 class="jxr_linenumber" name="L55" href="#L55">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 class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * AES algorithm's Rijndael implementation <em>only</em> supports a 128 bit block size and will not work with any other</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * size.</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * Also note that the {@link #setInitializationVectorSize initializationVectorSize} is usually the same as the</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">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 class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * attribute is correct for the target cipher algorithm.</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <h3>Operation Mode</h3></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * You may set the block cipher's<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>">mode of</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * operation</a> via the {@link #setMode(OperationMode) mode} attribute, which accepts a type-safe</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * {@link OperationMode OperationMode} enum instance. This type safety helps avoid typos when specifying the mode and</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * guarantees that the mode name will be recognized by the underlying JCA Provider.</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * <b>*</b>If no operation mode is specified, Shiro defaults all of its block {@code CipherService} instances to the</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * {@link OperationMode#CBC CBC} mode, specifically to support auto-generation of initialization vectors during</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">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 class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * not support initialization vectors, which are necessary for strong encryption. See the</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.crypto.JcaCipherService JcaCipherService parent class} class JavaDoc for an extensive</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">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 class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * the <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">Wikipedia</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * section on ECB<a/> and look at the encrypted image to see an example of why {@code ECB} should not be used in</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * security-sensitive environments.</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * In the rare case that you need to override the default with a mode not represented</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">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 class="jxr_linenumber" name="L81" href="#L81">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 class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * use this attribute if the {@link OperationMode} enum does not represent your desired mode.</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> If you change the mode to one that does not support initialization vectors (such as</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * {@link OperationMode#ECB ECB} or {@link OperationMode#NONE NONE}), you <em>must</em> turn off auto-generated</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * initialization vectors by setting {@link #setGenerateInitializationVectors(boolean) generateInitializationVectors}</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * to {@code false}. Abandoning initialization vectors significantly weakens encryption, so think twice before</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * disabling this feature.</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * <h3>Padding Scheme</h3></em> |
| <a class="jxr_linenumber" name="L91" href="#L91">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 class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * block length, <a href="<a href="http://en.wikipedia.org/wiki/Padding_(cryptography)" target="alexandria_uri">http://en.wikipedia.org/wiki/Padding_(cryptography)</a>">padding</a> is applied to match that</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">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 class="jxr_linenumber" name="L94" href="#L94">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 class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * You may set a padding scheme via the {@link #setPaddingScheme(PaddingScheme) paddingScheme} attribute, which</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * accepts a type-safe {@link PaddingScheme PaddingScheme} enum instance. Like the {@link OperationMode} enum,</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">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 class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * JCA provider.</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <b>*</b>If no padding scheme is specified, this class defaults to the {@link PaddingScheme#PKCS5} scheme, specifically</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * to be compliant with the default behavior of auto-generating initialization vectors during encryption (see the</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.crypto.JcaCipherService JcaCipherService parent class} class JavaDoc for why).</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L105" href="#L105">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 class="jxr_linenumber" name="L106" href="#L106">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 class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * {@link #setPaddingScheme paddingSchemeName} attribute. Because this is not type-safe, it is recommended only to</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * use this attribute if the {@link PaddingScheme} enum does not represent your desired scheme.</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * <h2>Streaming</h2></em> |
| <a class="jxr_linenumber" name="L111" href="#L111">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 class="jxr_linenumber" name="L112" href="#L112">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 class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * using an appropriate {@link OperationMode operation mode} with a {@link #getStreamingBlockSize() streaming block size}</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * of 8 bits. This is why the {@link CipherService} interface provides both block and streaming operations.</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L116" href="#L116">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 class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * for all three streaming configuration parameters. The defaults are:</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * <li>{@link #setStreamingBlockSize(int) streamingBlockSize} = {@code 8} (bits)</li></em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * <li>{@link #setStreamingMode streamingMode} = {@link OperationMode#CBC CBC}</li></em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <li>{@link #setStreamingPaddingScheme(PaddingScheme) streamingPaddingScheme} = {@link PaddingScheme#PKCS5 PKCS5}</li></em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * These attributes have the same meaning as the {@code mode}, {@code blockSize}, and {@code paddingScheme} attributes</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">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 class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * and {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])}).</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @see BlowfishCipherService</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @see AesCipherService</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @see <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>">Wikipedia: Block Cipher Modes of Operation</a></em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="DefaultBlockCipherService" href="../../../../org/apache/shiro/crypto/DefaultBlockCipherService.html#DefaultBlockCipherService">DefaultBlockCipherService</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractSymmetricCipherService" href="../../../../org/apache/shiro/crypto/AbstractSymmetricCipherService.html#AbstractSymmetricCipherService">AbstractSymmetricCipherService</a> { |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> |
| <a class="jxr_linenumber" name="L135" href="#L135">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 class="jxr_linenumber" name="L136" href="#L136">136</a> |
| <a class="jxr_linenumber" name="L137" href="#L137">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 class="jxr_linenumber" name="L138" href="#L138">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 class="jxr_linenumber" name="L139" href="#L139">139</a> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">private</strong> String modeName; |
| <a class="jxr_linenumber" name="L141" href="#L141">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 class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">private</strong> String paddingSchemeName; |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> String streamingModeName; |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> streamingBlockSize; |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">private</strong> String streamingPaddingSchemeName; |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> |
| <a class="jxr_linenumber" name="L148" href="#L148">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 class="jxr_linenumber" name="L149" href="#L149">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 class="jxr_linenumber" name="L150" href="#L150">150</a> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Creates a new {@link DefaultBlockCipherService} using the specified block cipher {@code algorithmName}. Per this</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * class's JavaDoc, this constructor also sets the following defaults:</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * <li>{@code streamingMode} = {@link OperationMode#CBC CBC}</li></em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * <li>{@code streamingPaddingScheme} = {@link PaddingScheme#NONE none}</li></em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * <li>{@code streamingBlockSize} = 8</li></em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * All other attributes are null/unset, indicating the JCA Provider defaults will be used.</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @param algorithmName the block cipher algorithm to use when encrypting and decrypting</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <a name="DefaultBlockCipherService" href="../../../../org/apache/shiro/crypto/DefaultBlockCipherService.html#DefaultBlockCipherService">DefaultBlockCipherService</a>(String algorithmName) { |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">super</strong>(algorithmName); |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">this</strong>.modeName = OperationMode.CBC.name(); |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">this</strong>.paddingSchemeName = PaddingScheme.PKCS5.getTransformationName(); |
| <a class="jxr_linenumber" name="L169" href="#L169">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 class="jxr_linenumber" name="L170" href="#L170">170</a> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">this</strong>.streamingModeName = OperationMode.CBC.name(); |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">this</strong>.streamingPaddingSchemeName = PaddingScheme.PKCS5.getTransformationName(); |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">this</strong>.streamingBlockSize = DEFAULT_STREAMING_BLOCK_SIZE; |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> } |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * Returns the cipher operation mode name (as a String) to be used when constructing</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">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 class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * {@link #getStreamingModeName() streamingModeName} attribute is used when the block cipher is used for</em> |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * streaming operations.</em> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * The default value is {@code null} to retain the JCA Provider default.</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @return the cipher operation mode name (as a String) to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider default</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * mode for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">public</strong> String getModeName() { |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">return</strong> modeName; |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> } |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * Sets the cipher operation mode name to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string. A {@code null} value indicates that the JCA Provider</em> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * {@link #getStreamingModeName() streamingModeName} attribute is used when the block cipher is used for</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * streaming operations.</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * The default value is {@code null} to retain the JCA Provider default.</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> most standard mode names are represented by the {@link OperationMode OperationMode} enum. That enum</em> |
| <a class="jxr_linenumber" name="L209" href="#L209">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 class="jxr_linenumber" name="L210" href="#L210">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 class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * necessary mode.</em> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @param modeName the cipher operation mode name to be used when constructing</em> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider</em> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @see #setMode</em> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setModeName(String modeName) { |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">this</strong>.modeName = modeName; |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">//clear out the transformation string so the next invocation will rebuild it with the new mode:</em> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">this</strong>.transformationString = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> } |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * Sets the cipher operation mode of operation to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string. A {@code null} value indicates that the JCA Provider</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * {@link #setStreamingMode streamingMode} attribute is used when the block cipher is used for</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * streaming operations.</em> |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * If the {@link OperationMode} enum cannot represent your desired mode, you can set the name explicitly</em> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * via the {@link #setModeName modeName} attribute directly. However, because {@link OperationMode} represents all</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">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 class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @param mode the cipher operation mode to be used when constructing</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * default mode for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMode(<a name="OperationMode" href="../../../../org/apache/shiro/crypto/OperationMode.html#OperationMode">OperationMode</a> mode) { |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> setModeName(mode.name()); |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> } |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * Returns the cipher algorithm padding scheme name (as a String) to be used when constructing</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">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 class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * {@link #getStreamingPaddingSchemeName() streamingPaddingSchemeName} attribute is used when the block cipher is</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * used for streaming operations.</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * The default value is {@code null} to retain the JCA Provider default.</em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @return the padding scheme name (as a String) to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider default</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * padding scheme for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">public</strong> String getPaddingSchemeName() { |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">return</strong> paddingSchemeName; |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> } |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Sets the padding scheme name to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L268" href="#L268">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 class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * {@link #getStreamingPaddingSchemeName() streamingPaddingSchemeName} attribute is used when the block cipher is</em> |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * used for streaming operations.</em> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * The default value is {@code null} to retain the JCA Provider default.</em> |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> most standard padding schemes are represented by the {@link PaddingScheme PaddingScheme} enum.</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * That enum should be used with the {@link #setPaddingScheme paddingScheme} attribute when possible to retain</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * type-safety and reduce the possibility of errors. Calling this method however is suitable if the</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * {@code PaddingScheme} enum does not represent the desired scheme.</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * @param paddingSchemeName the padding scheme name to be used when constructing</em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA</em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * Provider default padding scheme for the specified {@link #getAlgorithmName() algorithm}</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * should be used.</em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @see #setPaddingScheme</em> |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPaddingSchemeName(String paddingSchemeName) { |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">this</strong>.paddingSchemeName = paddingSchemeName; |
| <a class="jxr_linenumber" name="L291" href="#L291">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 class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">this</strong>.transformationString = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> } |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * Sets the padding scheme to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string. A {@code null} value indicates that the JCA Provider</em> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * default padding scheme for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * {@link #setStreamingPaddingScheme streamingPaddingScheme} attribute is used when the block cipher is used for</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * streaming operations.</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L305" href="#L305">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 class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * via the {@link #setPaddingSchemeName paddingSchemeName} attribute directly. However, because</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * {@code PaddingScheme} represents all standard JDK scheme names already, ensure that your underlying JCA Provider</em> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * supports the non-standard name first.</em> |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * @param paddingScheme the padding scheme to be used when constructing</em> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code null} if the JCA Provider</em> |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * default padding scheme for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPaddingScheme(<a name="PaddingScheme" href="../../../../org/apache/shiro/crypto/PaddingScheme.html#PaddingScheme">PaddingScheme</a> paddingScheme) { |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> setPaddingSchemeName(paddingScheme.getTransformationName()); |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> } |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * Returns the block cipher's block size to be used when constructing</em> |
| <a class="jxr_linenumber" name="L320" href="#L320">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 class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * {@link #getStreamingBlockSize() streamingBlockSize} attribute is used when the block cipher is used for</em> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * streaming operations.</em> |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * The default value is {@code 0} which retains the JCA Provider default.</em> |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @return the block cipher block size to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code 0} if the JCA Provider default</em> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * block size for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBlockSize() { |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">return</strong> blockSize; |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> } |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * Sets the block cipher's block size to be used when constructing</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string. {@code 0} indicates that the JCA Provider default</em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * block size for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * This attribute is used <em>only</em> when constructing the transformation string for block (byte array)</em> |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(byte[], byte[])} and {@link #decrypt(byte[], byte[])}). The</em> |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * {@link #getStreamingBlockSize() streamingBlockSize} attribute is used when the block cipher is used for</em> |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * streaming operations.</em> |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * The default value is {@code 0} which retains the JCA Provider default.</em> |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> block cipher block sizes are very algorithm-specific. If you change this value, ensure that it</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * will work with the specified {@link #getAlgorithmName() algorithm}.</em> |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * @param blockSize the block cipher block size to be used when constructing the</em> |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.Cipher Cipher} transformation string, or {@code 0} if the JCA Provider</em> |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * default block size for the specified {@link #getAlgorithmName() algorithm} should be used.</em> |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBlockSize(<strong class="jxr_keyword">int</strong> blockSize) { |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">this</strong>.blockSize = Math.max(DEFAULT_BLOCK_SIZE, blockSize); |
| <a class="jxr_linenumber" name="L359" href="#L359">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 class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">this</strong>.transformationString = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> } |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> * Same purpose as the {@link #getModeName modeName} attribute, but is used instead only for for streaming</em> |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * operations ({@link #encrypt(java.io.InputStream, java.io.OutputStream, byte[])} and</em> |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * {@link #decrypt(java.io.InputStream, java.io.OutputStream, byte[])}).</em> |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * Note that unlike the {@link #getModeName modeName} attribute, the default value of this attribute is not</em> |
| <a class="jxr_linenumber" name="L369" href="#L369">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 class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * {@code Streaming} section.</em> |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * @return the transformation string mode name to be used for streaming operations only.</em> |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">public</strong> String getStreamingModeName() { |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">return</strong> streamingModeName; |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> } |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isModeStreamingCompatible(String modeName) { |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">return</strong> modeName != <strong class="jxr_keyword">null</strong> && |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> !modeName.equalsIgnoreCase(OperationMode.ECB.name()) && |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> !modeName.equalsIgnoreCase(OperationMode.NONE.name()); |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> } |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L385" href="#L385">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 class="jxr_linenumber" name="L386" href="#L386">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 class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @param streamingModeName transformation string mode name to be used for streaming operations only</em> |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStreamingModeName(String streamingModeName) { |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">if</strong> (!isModeStreamingCompatible(streamingModeName)) { |
| <a class="jxr_linenumber" name="L392" href="#L392">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 class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg); |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> } |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">this</strong>.streamingModeName = streamingModeName; |
| <a class="jxr_linenumber" name="L396" href="#L396">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 class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">this</strong>.streamingTransformationString = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> } |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * Sets the transformation string mode to be used for streaming operations only. The default value is</em> |
| <a class="jxr_linenumber" name="L402" href="#L402">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 class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * @param mode the transformation string mode to be used for streaming operations only</em> |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStreamingMode(<a name="OperationMode" href="../../../../org/apache/shiro/crypto/OperationMode.html#OperationMode">OperationMode</a> mode) { |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> setStreamingModeName(mode.name()); |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> } |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">public</strong> String getStreamingPaddingSchemeName() { |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">return</strong> streamingPaddingSchemeName; |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> } |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStreamingPaddingSchemeName(String streamingPaddingSchemeName) { |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">this</strong>.streamingPaddingSchemeName = streamingPaddingSchemeName; |
| <a class="jxr_linenumber" name="L416" href="#L416">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 class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">this</strong>.streamingTransformationString = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> } |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStreamingPaddingScheme(<a name="PaddingScheme" href="../../../../org/apache/shiro/crypto/PaddingScheme.html#PaddingScheme">PaddingScheme</a> scheme) { |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> setStreamingPaddingSchemeName(scheme.getTransformationName()); |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> } |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getStreamingBlockSize() { |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">return</strong> streamingBlockSize; |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> } |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStreamingBlockSize(<strong class="jxr_keyword">int</strong> streamingBlockSize) { |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">this</strong>.streamingBlockSize = Math.max(DEFAULT_BLOCK_SIZE, streamingBlockSize); |
| <a class="jxr_linenumber" name="L430" href="#L430">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 class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">this</strong>.streamingTransformationString = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> } |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * Returns the transformation string to use with the {@link javax.crypto.Cipher#getInstance} call. If</em> |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * {@code streaming} is {@code true}, a block-cipher transformation string compatible with streaming operations will</em> |
| <a class="jxr_linenumber" name="L437" href="#L437">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 class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> * for streaming). If {@code streaming} is {@code false} a normal block-cipher transformation string will</em> |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * be constructed and cached for later re-use.</em> |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L441" href="#L441">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 class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * @return the transformation string</em> |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">protected</strong> String getTransformationString(<strong class="jxr_keyword">boolean</strong> streaming) { |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">if</strong> (streaming) { |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.streamingTransformationString == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">this</strong>.streamingTransformationString = buildStreamingTransformationString(); |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> } |
| <a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.streamingTransformationString; |
| <a class="jxr_linenumber" name="L450" href="#L450">450</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.transformationString == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">this</strong>.transformationString = buildTransformationString(); |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> } |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.transformationString; |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> } |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> } |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> |
| <a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">private</strong> String buildTransformationString() { |
| <a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">return</strong> buildTransformationString(getModeName(), getPaddingSchemeName(), getBlockSize()); |
| <a class="jxr_linenumber" name="L460" href="#L460">460</a> } |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> <strong class="jxr_keyword">private</strong> String buildStreamingTransformationString() { |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong class="jxr_keyword">return</strong> buildTransformationString(getStreamingModeName(), getStreamingPaddingSchemeName(), 0); |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> } |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">private</strong> String buildTransformationString(String modeName, String paddingSchemeName, <strong class="jxr_keyword">int</strong> blockSize) { |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(getAlgorithmName()); |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(modeName)) { |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> sb.append(TRANSFORMATION_STRING_DELIMITER).append(modeName); |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> } |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">if</strong> (blockSize > 0) { |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> sb.append(blockSize); |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> } |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(paddingSchemeName)) { |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> sb.append(TRANSFORMATION_STRING_DELIMITER).append(paddingSchemeName); |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> } |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> <strong class="jxr_keyword">return</strong> sb.toString(); |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> } |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the specified cipher operation mode name supports initialization vectors,</em> |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> * @param modeName the raw text name of the mode of operation</em> |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> <em class="jxr_javadoccomment"> * @return {@code true} if the specified cipher operation mode name supports initialization vectors,</em> |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isModeInitializationVectorCompatible(String modeName) { |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">return</strong> modeName != <strong class="jxr_keyword">null</strong> && |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> !modeName.equalsIgnoreCase(OperationMode.ECB.name()) && |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> !modeName.equalsIgnoreCase(OperationMode.NONE.name()); |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> } |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> <em class="jxr_javadoccomment"> * Overrides the parent implementation to ensure initialization vectors are always generated if streaming is</em> |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> <em class="jxr_javadoccomment"> * enabled (block ciphers <em>must</em> use initialization vectors if they are to be used as a stream cipher). If</em> |
| <a class="jxr_linenumber" name="L497" href="#L497">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 class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> * {@link #getModeName modeName} is compatible with initialization vectors as well as the result of the configured</em> |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> * {@link #setGenerateInitializationVectors(boolean) generateInitializationVectors} value.</em> |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_javadoccomment"> * @param streaming whether or not streaming is being performed</em> |
| <a class="jxr_linenumber" name="L502" href="#L502">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 class="jxr_linenumber" name="L503" href="#L503">503</a> <em class="jxr_javadoccomment"> * with initialization vectors.</em> |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L505" href="#L505">505</a> @Override |
| <a class="jxr_linenumber" name="L506" href="#L506">506</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isGenerateInitializationVectors(<strong class="jxr_keyword">boolean</strong> streaming) { |
| <a class="jxr_linenumber" name="L507" href="#L507">507</a> <strong class="jxr_keyword">return</strong> streaming || <strong class="jxr_keyword">super</strong>.isGenerateInitializationVectors() && isModeInitializationVectorCompatible(getModeName()); |
| <a class="jxr_linenumber" name="L508" href="#L508">508</a> } |
| <a class="jxr_linenumber" name="L509" href="#L509">509</a> |
| <a class="jxr_linenumber" name="L510" href="#L510">510</a> @Override |
| <a class="jxr_linenumber" name="L511" href="#L511">511</a> <strong class="jxr_keyword">protected</strong> byte[] generateInitializationVector(<strong class="jxr_keyword">boolean</strong> streaming) { |
| <a class="jxr_linenumber" name="L512" href="#L512">512</a> <strong class="jxr_keyword">if</strong> (streaming) { |
| <a class="jxr_linenumber" name="L513" href="#L513">513</a> String streamingModeName = getStreamingModeName(); |
| <a class="jxr_linenumber" name="L514" href="#L514">514</a> <strong class="jxr_keyword">if</strong> (!isModeInitializationVectorCompatible(streamingModeName)) { |
| <a class="jxr_linenumber" name="L515" href="#L515">515</a> String msg = <span class="jxr_string">"streamingMode attribute value ["</span> + streamingModeName + <span class="jxr_string">"] does not support "</span> + |
| <a class="jxr_linenumber" name="L516" href="#L516">516</a> <span class="jxr_string">"Initialization Vectors. Ensure the streamingMode value represents an operation mode "</span> + |
| <a class="jxr_linenumber" name="L517" href="#L517">517</a> <span class="jxr_string">"that is compatible with initialization vectors."</span>; |
| <a class="jxr_linenumber" name="L518" href="#L518">518</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a class="jxr_linenumber" name="L519" href="#L519">519</a> } |
| <a class="jxr_linenumber" name="L520" href="#L520">520</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L521" href="#L521">521</a> String modeName = getModeName(); |
| <a class="jxr_linenumber" name="L522" href="#L522">522</a> <strong class="jxr_keyword">if</strong> (!isModeInitializationVectorCompatible(modeName)) { |
| <a class="jxr_linenumber" name="L523" href="#L523">523</a> String msg = <span class="jxr_string">"mode attribute value ["</span> + modeName + <span class="jxr_string">"] does not support "</span> + |
| <a class="jxr_linenumber" name="L524" href="#L524">524</a> <span class="jxr_string">"Initialization Vectors. Ensure the mode value represents an operation mode "</span> + |
| <a class="jxr_linenumber" name="L525" href="#L525">525</a> <span class="jxr_string">"that is compatible with initialization vectors."</span>; |
| <a class="jxr_linenumber" name="L526" href="#L526">526</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a class="jxr_linenumber" name="L527" href="#L527">527</a> } |
| <a class="jxr_linenumber" name="L528" href="#L528">528</a> } |
| <a class="jxr_linenumber" name="L529" href="#L529">529</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.generateInitializationVector(streaming); |
| <a class="jxr_linenumber" name="L530" href="#L530">530</a> } |
| <a class="jxr_linenumber" name="L531" href="#L531">531</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
