| <!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>CipherService xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/crypto/CipherService.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.ByteSource; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * A {@code CipherService} uses a cryptographic algorithm called a</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/Cipher" target="alexandria_uri">http://en.wikipedia.org/wiki/Cipher</a>">Cipher</a> to convert an original input source using a {@code key} to</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * an uninterpretable format. The resulting encrypted output is only able to be converted back to original form with</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * a {@code key} as well. {@code CipherService}s can perform both encryption and decryption.</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <h2>Cipher Basics</h2></em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * For what is known as <em>Symmetric</em> {@code Cipher}s, the {@code Key} used to encrypt the source is the same</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * as (or trivially similar to) the {@code Key} used to decrypt it.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * For <em>Asymmetric</em> {@code Cipher}s, the encryption {@code Key} is not the same as the decryption {@code Key}.</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * The most common type of Asymmetric Ciphers are based on what is called public/private key pairs:</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * A <em>private</em> key is known only to a single party, and as its name implies, is supposed be kept very private</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * and secure. A <em>public</em> key that is associated with the private key can be disseminated freely to anyone.</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Then data encrypted by the public key can only be decrypted by the private key and vice versa, but neither party</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * need share their private key with anyone else. By not sharing a private key, you can guarantee no 3rd party can</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * intercept the key and therefore use it to decrypt a message.</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"> * This asymmetric key technology was created as a</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * more secure alternative to symmetric ciphers that sometimes suffer from man-in-the-middle attacks since, for</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * data shared between two parties, the same Key must also be shared and may be compromised.</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Note that a symmetric cipher is perfectly fine to use if you just want to encode data in a format no one else</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * can understand and you never give away the key. Shiro uses a symmetric cipher when creating certain</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * HTTP Cookies for example - because it is often undesirable to have user's identity stored in a plain-text cookie,</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * that identity can be converted via a symmetric cipher. Since the the same exact Shiro application will receive</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * the cookie, it can decrypt it via the same {@code Key} and there is no potential for discovery since that Key</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * is never shared with anyone.</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * <h2>{@code CipherService}s vs JDK {@link javax.crypto.Cipher Cipher}s</h2></em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Shiro {@code CipherService}s essentially do the same things as JDK {@link javax.crypto.Cipher Cipher}s, but in</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * simpler and easier-to-use ways for most application developers. When thinking about encrypting and decrypting data</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * in an application, most app developers want what a {@code CipherService} provides, rather than having to manage the</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * lower-level intricacies of the JDK's {@code Cipher} API. Here are a few reasons why most people prefer</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * {@code CipherService}s:</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * <li><b>Stateless Methods</b> - {@code CipherService} method calls do not retain state between method invocations.</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * JDK {@code Cipher} instances do retain state across invocations, requiring its end-users to manage the instance</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * and its state themselves.</li></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * <li><b>Thread Safety</b> - {@code CipherService} instances are thread-safe inherently because no state is</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * retained across method invocations. JDK {@code Cipher} instances retain state and cannot be used by multiple</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * threads concurrently.</li></em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * <li><b>Single Operation</b> - {@code CipherService} method calls are single operation methods: encryption or</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * decryption in their entirety are done as a single method call. This is ideal for the large majority of developer</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * needs where you have something unencrypted and just want it decrypted (or vice versa) in a single method call. In</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * contrast, JDK {@code Cipher} instances can support encrypting/decrypting data in chunks over time (because it</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * retains state), but this often introduces API clutter and confusion for most application developers.</li></em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <li><b>Type Safe</b> - There are {@code CipherService} implementations for different Cipher algorithms</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * ({@code AesCipherService}, {@code BlowfishCipherService}, etc). There is only one JDK {@code Cipher} class to</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * represent all cipher algorithms/instances.</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <li><b>Simple Construction</b> - Because {@code CipherService} instances are type-safe, instantiating and using</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * one is often as simple as calling the default constructor, for example, <code>new AesCipherService();</code>. The</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * JDK {@code Cipher} class however requires using a procedural factory method with String arguments to indicate how</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * the instance should be created. The String arguments themselves are somewhat cryptic and hard to</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * understand unless you're a security expert. Shiro hides these details from you, but allows you to configure them</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * if you want.</li></em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @see BlowfishCipherService</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @see AesCipherService</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="CipherService" href="../../../../org/apache/shiro/crypto/CipherService.html#CipherService">CipherService</a> { |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> |
| <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"> * Decrypts encrypted data via the specified cipher key and returns the original (pre-encrypted) data.</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Note that the key must be in a format understood by the CipherService implementation.</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param encrypted the previously encrypted data to decrypt</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param decryptionKey the cipher key used during decryption.</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @return a byte source representing the original form of the specified encrypted data.</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is an error during decryption</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> ByteSource decrypt(byte[] encrypted, byte[] decryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Receives encrypted data from the given {@code InputStream}, decrypts it, and sends the resulting decrypted data</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * to the given {@code OutputStream}.</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> This method <em>does NOT</em> flush or close either stream prior to returning - the caller must</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * do so when they are finished with the streams. For example:</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * InputStream in = ...</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * OutputStream out = ...</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * cipherService.decrypt(in, out, decryptionKey);</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * } finally {</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * if (in != null) {</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * in.close();</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe1) { ... log, trigger event, etc }</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * if (out != null) {</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * out.close();</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe2) { ... log, trigger event, etc }</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param in the stream supplying the data to decrypt</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param out the stream to send the decrypted data</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @param decryptionKey the cipher key to use for decryption</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is any problem during decryption.</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">void</strong> decrypt(InputStream in, OutputStream out, byte[] decryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> |
| <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> <em class="jxr_javadoccomment"> * Encrypts data via the specified cipher key. Note that the key must be in a format understood by</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * the {@code CipherService} implementation.</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @param raw the data to encrypt</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @param encryptionKey the cipher key used during encryption.</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @return a byte source with the encrypted representation of the specified raw data.</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is an error during encryption</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> ByteSource encrypt(byte[] raw, byte[] encryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Receives the data from the given {@code InputStream}, encrypts it, and sends the resulting encrypted data to the</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * given {@code OutputStream}.</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> This method <em>does NOT</em> flush or close either stream prior to returning - the caller must</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * do so when they are finished with the streams. For example:</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * InputStream in = ...</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * OutputStream out = ...</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * cipherService.encrypt(in, out, encryptionKey);</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * } finally {</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * if (in != null) {</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * in.close();</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe1) { ... log, trigger event, etc }</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * if (out != null) {</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * out.close();</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe2) { ... log, trigger event, etc }</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @param in the stream supplying the data to encrypt</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @param out the stream to send the encrypted data</em> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @param encryptionKey the cipher key to use for encryption</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is any problem during encryption.</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">void</strong> encrypt(InputStream in, OutputStream out, byte[] encryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
