| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>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 name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.crypto; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource; |
| <a name="22" href="#22">22</a> |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * A {@code CipherService} uses a cryptographic algorithm called a</em> |
| <a name="28" href="#28">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 name="29" href="#29">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 name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * a {@code key} as well. {@code CipherService}s can perform both encryption and decryption.</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <h2>Cipher Basics</h2></em> |
| <a name="32" href="#32">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 name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * as (or trivially similar to) the {@code Key} used to decrypt it.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="35" href="#35">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 name="36" href="#36">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 name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="38" href="#38">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 name="39" href="#39">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 name="40" href="#40">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 name="41" href="#41">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 name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * intercept the key and therefore use it to decrypt a message.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * This asymmetric key technology was created as a</em> |
| <a name="45" href="#45">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 name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * data shared between two parties, the same Key must also be shared and may be compromised.</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">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 name="49" href="#49">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 name="50" href="#50">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 name="51" href="#51">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 name="52" href="#52">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 name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * is never shared with anyone.</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * <h2>{@code CipherService}s vs JDK {@link javax.crypto.Cipher Cipher}s</h2></em> |
| <a name="55" href="#55">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 name="56" href="#56">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 name="57" href="#57">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 name="58" href="#58">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 name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * {@code CipherService}s:</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <li><b>Stateless Methods</b> - {@code CipherService} method calls do not retain state between method invocations.</em> |
| <a name="62" href="#62">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 name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * and its state themselves.</li></em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <li><b>Thread Safety</b> - {@code CipherService} instances are thread-safe inherently because no state is</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * retained across method invocations. JDK {@code Cipher} instances retain state and cannot be used by multiple</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * threads concurrently.</li></em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <li><b>Single Operation</b> - {@code CipherService} method calls are single operation methods: encryption or</em> |
| <a name="68" href="#68">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 name="69" href="#69">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 name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * contrast, JDK {@code Cipher} instances can support encrypting/decrypting data in chunks over time (because it</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * retains state), but this often introduces API clutter and confusion for most application developers.</li></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * <li><b>Type Safe</b> - There are {@code CipherService} implementations for different Cipher algorithms</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * ({@code AesCipherService}, {@code BlowfishCipherService}, etc). There is only one JDK {@code Cipher} class to</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * represent all cipher algorithms/instances.</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * <li><b>Simple Construction</b> - Because {@code CipherService} instances are type-safe, instantiating and using</em> |
| <a name="76" href="#76">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 name="77" href="#77">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 name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * the instance should be created. The String arguments themselves are somewhat cryptic and hard to</em> |
| <a name="79" href="#79">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 name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * if you want.</li></em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @see BlowfishCipherService</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @see AesCipherService</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/crypto/CipherService.html">CipherService</a> { |
| <a name="88" href="#88">88</a> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Decrypts encrypted data via the specified cipher key and returns the original (pre-encrypted) data.</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Note that the key must be in a format understood by the CipherService implementation.</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @param encrypted the previously encrypted data to decrypt</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @param decryptionKey the cipher key used during decryption.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @return a byte source representing the original form of the specified encrypted data.</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is an error during decryption</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="98" href="#98">98</a> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> decrypt(byte[] encrypted, byte[] decryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a name="99" href="#99">99</a> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Receives encrypted data from the given {@code InputStream}, decrypts it, and sends the resulting decrypted data</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * to the given {@code OutputStream}.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="104" href="#104">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 name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * do so when they are finished with the streams. For example:</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * InputStream in = ...</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * OutputStream out = ...</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * cipherService.decrypt(in, out, decryptionKey);</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * } finally {</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * if (in != null) {</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * in.close();</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe1) { ... log, trigger event, etc }</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * if (out != null) {</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * out.close();</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe2) { ... log, trigger event, etc }</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @param in the stream supplying the data to decrypt</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param out the stream to send the decrypted data</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param decryptionKey the cipher key to use for decryption</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is any problem during decryption.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">void</strong> decrypt(InputStream in, OutputStream out, byte[] decryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a name="131" href="#131">131</a> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="133" href="#133">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 name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * the {@code CipherService} implementation.</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @param raw the data to encrypt</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @param encryptionKey the cipher key used during encryption.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @return a byte source with the encrypted representation of the specified raw data.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is an error during encryption</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="141" href="#141">141</a> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> encrypt(byte[] raw, byte[] encryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a name="142" href="#142">142</a> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="144" href="#144">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 name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * given {@code OutputStream}.</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="147" href="#147">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 name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * do so when they are finished with the streams. For example:</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * InputStream in = ...</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * OutputStream out = ...</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * cipherService.encrypt(in, out, encryptionKey);</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * } finally {</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * if (in != null) {</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * in.close();</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe1) { ... log, trigger event, etc }</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * if (out != null) {</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * out.close();</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * } catch (IOException ioe2) { ... log, trigger event, etc }</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @param in the stream supplying the data to encrypt</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * @param out the stream to send the encrypted data</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param encryptionKey the cipher key to use for encryption</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @throws CryptoException if there is any problem during encryption.</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="173" href="#173">173</a> <strong class="jxr_keyword">void</strong> encrypt(InputStream in, OutputStream out, byte[] encryptionKey) <strong class="jxr_keyword">throws</strong> CryptoException; |
| <a name="174" href="#174">174</a> |
| <a name="175" href="#175">175</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
