| <!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>HashService xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/crypto/hash/HashService.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.hash; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * A {@code HashService} hashes input sources utilizing a particular hashing strategy.</em> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * A {@code HashService} sits at a higher architectural level than Shiro's simple {@link Hash} classes: it allows</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * for salting and iteration-related strategies to be configured and internalized in a</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * single component that can be re-used in multiple places in the application.</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * For example, for the most secure hashes, it is highly recommended to use a randomly generated salt, potentially</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * paired with an configuration-specific private salt, in addition to using multiple hash iterations.</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * While one can do this easily enough using Shiro's {@link Hash} implementations directly, this direct approach could</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * quickly lead to copy-and-paste behavior. For example, consider this logic which might need to repeated in an</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * application:</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * int numHashIterations = ...</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * ByteSource privateSalt = ...</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * ByteSource randomSalt = {@link org.apache.shiro.crypto.RandomNumberGenerator randomNumberGenerator}.nextBytes();</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * ByteSource combined = combine(privateSalt, randomSalt);</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * Hash hash = Sha512Hash(source, combined, numHashIterations);</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * save(hash);</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * In this example, often only the input source will change during runtime, while the hashing strategy (how salts</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * are generated or acquired, how many hash iterations will be performed, etc) usually remain consistent. A HashService</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * internalizes this logic so the above becomes simply this:</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * HashRequest request = new HashRequest.Builder().source(source).build();</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Hash result = hashService.hash(request);</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * save(result);</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html">HashService</a> { |
| <a name="54" href="#54">54</a> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Computes a hash based on the given request.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <h3>Salt Notice</h3></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * If a salt accompanies the return value</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * (i.e. <code>returnedHash.{@link org.apache.shiro.crypto.hash.Hash#getSalt() getSalt()} != null</code>), this</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * same exact salt <b><em>MUST</em></b> be presented back to the {@code HashService} if hash</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * comparison/verification will be performed at a later time (for example, for password hash or file checksum</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * comparison).</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * For additional security, the {@code HashService}'s internal implementation may use more complex salting</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * strategies than what would be achieved by computing a {@code Hash} manually.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * In summary, if a {@link HashService} returns a salt in a returned Hash, it is expected that the same salt</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * will be provided to the same {@code HashService} instance.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param request the request to process</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return the hashed data</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @see Hash#getSalt()</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="76" href="#76">76</a> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html">Hash</a> computeHash(<a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html">HashRequest</a> request); |
| <a name="77" href="#77">77</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
