| <!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>DefaultHashService xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/crypto/hash/DefaultHashService.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> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.RandomNumberGenerator; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.SecureRandomNumberGenerator; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * Default implementation of the {@link HashService} interface, supporting a customizable hash algorithm name,</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * secure-random salt generation, multiple hash iterations and an optional internal</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * {@link #setPrivateSalt(ByteSource) privateSalt}.</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * <h2>Hash Algorithm</h2></em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * You may specify a hash algorithm via the {@link #setHashAlgorithmName(String)} property. Any algorithm name</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * understood by the JDK</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * {@link java.security.MessageDigest#getInstance(String) MessageDigest.getInstance(String algorithmName)} method</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * will work. The default is {@code SHA-512}.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <h2>Random Salts</h2></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * When a salt is not specified in a request, this implementation generates secure random salts via its</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@link #setRandomNumberGenerator(org.apache.shiro.crypto.RandomNumberGenerator) randomNumberGenerator} property.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Random salts (and potentially combined with the internal {@link #getPrivateSalt() privateSalt}) is a very strong</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * salting strategy, as salts should ideally never be based on known/guessable data. The default instance is a</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * {@link SecureRandomNumberGenerator}.</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <h2>Hash Iterations</h2></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Secure hashing strategies often employ multiple hash iterations to slow down the hashing process. This technique</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * is usually used for password hashing, since the longer it takes to compute a password hash, the longer it would</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * take for an attacker to compromise a password. This</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.katasoft.com/blog/2011/04/04/strong-password-hashing-apache-shiro" target="alexandria_uri">http://www.katasoft.com/blog/2011/04/04/strong-password-hashing-apache-shiro</a>">Katasoft blog article</a></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * explains in greater detail why this is useful, as well as information on how many iterations is 'enough'.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * You may set the number of hash iterations via the {@link #setHashIterations(int)} property. The default is</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * {@code 1}, but should be increased significantly if the {@code HashService} is intended to be used for password</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * hashing. See the linked blog article for more info.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <h2>Private Salt</h2></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * If using this implementation as part of a password hashing strategy, it might be desirable to configure a</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * {@link #setPrivateSalt(ByteSource) private salt}:</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * A hash and the salt used to compute it are often stored together. If an attacker is ever able to access</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * the hash (e.g. during password cracking) and it has the full salt value, the attacker has all of the input necessary</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * to try to brute-force crack the hash (source + complete salt).</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * However, if part of the salt is not available to the attacker (because it is not stored with the hash), it is</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <em>much</em> harder to crack the hash value since the attacker does not have the complete inputs necessary.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * The {@link #getPrivateSalt() privateSalt} property exists to satisfy this private-and-not-shared part of the salt.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * If you configure this attribute, you can obtain this additional very important safety feature.</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <b>*</b>By default, the {@link #getPrivateSalt() privateSalt} is null, since a sensible default cannot be used that</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * isn't easily compromised (because Shiro is an open-source project and any default could be easily seen and used).</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/crypto/hash/DefaultHashService.html">DefaultHashService</a> implements <a href="../../../../../org/apache/shiro/crypto/hash/ConfigurableHashService.html">ConfigurableHashService</a> { |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * The RandomNumberGenerator to use to randomly generate the public part of the hash salt.</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/crypto/RandomNumberGenerator.html">RandomNumberGenerator</a> rng; |
| <a name="75" href="#75">75</a> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * The MessageDigest name of the hash algorithm to use for computing hashes.</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">private</strong> String algorithmName; |
| <a name="80" href="#80">80</a> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * The 'private' part of the hash salt.</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt; |
| <a name="85" href="#85">85</a> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * The number of hash iterations to perform when computing hashes.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iterations; |
| <a name="90" href="#90">90</a> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Whether or not to generate public salts if a request does not provide one.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> generatePublicSalt; |
| <a name="95" href="#95">95</a> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Constructs a new {@code DefaultHashService} instance with the following defaults:</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * <li>{@link #setHashAlgorithmName(String) hashAlgorithmName} = {@code SHA-512}</li></em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * <li>{@link #setHashIterations(int) hashIterations} = {@code 1}</li></em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * <li>{@link #setRandomNumberGenerator(org.apache.shiro.crypto.RandomNumberGenerator) randomNumberGenerator} =</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * new {@link SecureRandomNumberGenerator}()</li></em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * <li>{@link #setGeneratePublicSalt(boolean) generatePublicSalt} = {@code false}</li></em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * If this hashService will be used for password hashing it is recommended to set the</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * {@link #setPrivateSalt(ByteSource) privateSalt} and significantly increase the number of</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * {@link #setHashIterations(int) hashIterations}. See the class-level JavaDoc for more information.</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/hash/DefaultHashService.html">DefaultHashService</a>() { |
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">this</strong>.algorithmName = <span class="jxr_string">"SHA-512"</span>; |
| <a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.iterations = 1; |
| <a name="113" href="#113">113</a> <strong class="jxr_keyword">this</strong>.generatePublicSalt = false; |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">this</strong>.rng = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/crypto/SecureRandomNumberGenerator.html">SecureRandomNumberGenerator</a>(); |
| <a name="115" href="#115">115</a> } |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Computes and responds with a hash based on the specified request.</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * This implementation functions as follows:</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * <li>If the request's {@link org.apache.shiro.crypto.hash.HashRequest#getSalt() salt} is null:</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * A salt will be generated and used to compute the hash. The salt is generated as follows:</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * <li>Use the {@link #getRandomNumberGenerator() randomNumberGenerator} to generate a new random number.</li></em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * <li>{@link #combine(ByteSource, ByteSource) combine} this random salt with any configured</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * {@link #getPrivateSalt() privateSalt}</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * <li>Use the combined value as the salt used during hash computation</li></em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * <li></em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * If the request salt is not null:</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * This indicates that the hash computation is for comparison purposes (of a</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * previously computed hash). The request salt will be {@link #combine(ByteSource, ByteSource) combined} with any</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * configured {@link #getPrivateSalt() privateSalt} and used as the complete salt during hash computation.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * The returned {@code Hash}'s {@link Hash#getSalt() salt} property</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * will contain <em>only</em> the 'public' part of the salt and <em>NOT</em> the privateSalt. See the class-level</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * JavaDoc explanation for more info.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param request the request to process</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @return the response containing the result of the hash computation, as well as any hash salt used that should be</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * exposed to the caller.</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <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="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (request == <strong class="jxr_keyword">null</strong> || request.getSource() == <strong class="jxr_keyword">null</strong> || request.getSource().isEmpty()) { |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="153" href="#153">153</a> } |
| <a name="154" href="#154">154</a> |
| <a name="155" href="#155">155</a> String algorithmName = getAlgorithmName(request); |
| <a name="156" href="#156">156</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> source = request.getSource(); |
| <a name="157" href="#157">157</a> <strong class="jxr_keyword">int</strong> iterations = getIterations(request); |
| <a name="158" href="#158">158</a> |
| <a name="159" href="#159">159</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> publicSalt = getPublicSalt(request); |
| <a name="160" href="#160">160</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt = getPrivateSalt(); |
| <a name="161" href="#161">161</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> salt = combine(privateSalt, publicSalt); |
| <a name="162" href="#162">162</a> |
| <a name="163" href="#163">163</a> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html">Hash</a> computed = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(algorithmName, source, salt, iterations); |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a> result = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(algorithmName); |
| <a name="166" href="#166">166</a> result.setBytes(computed.getBytes()); |
| <a name="167" href="#167">167</a> result.setIterations(iterations); |
| <a name="168" href="#168">168</a> <em class="jxr_comment">//Only expose the public salt - not the real/combined salt that might have been used:</em> |
| <a name="169" href="#169">169</a> result.setSalt(publicSalt); |
| <a name="170" href="#170">170</a> |
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">return</strong> result; |
| <a name="172" href="#172">172</a> } |
| <a name="173" href="#173">173</a> |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">protected</strong> String getAlgorithmName(<a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html">HashRequest</a> request) { |
| <a name="175" href="#175">175</a> String name = request.getAlgorithmName(); |
| <a name="176" href="#176">176</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) { |
| <a name="177" href="#177">177</a> name = getHashAlgorithmName(); |
| <a name="178" href="#178">178</a> } |
| <a name="179" href="#179">179</a> <strong class="jxr_keyword">return</strong> name; |
| <a name="180" href="#180">180</a> } |
| <a name="181" href="#181">181</a> |
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getIterations(<a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html">HashRequest</a> request) { |
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">int</strong> iterations = Math.max(0, request.getIterations()); |
| <a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (iterations < 1) { |
| <a name="185" href="#185">185</a> iterations = Math.max(1, getHashIterations()); |
| <a name="186" href="#186">186</a> } |
| <a name="187" href="#187">187</a> <strong class="jxr_keyword">return</strong> iterations; |
| <a name="188" href="#188">188</a> } |
| <a name="189" href="#189">189</a> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * Returns the public salt that should be used to compute a hash based on the specified request or</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * {@code null} if no public salt should be used.</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * This implementation functions as follows:</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * <li>If the request salt is not null and non-empty, this will be used, return it.</li></em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * <li>If the request salt is null or empty:</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * <li>If a private salt has been set <em>OR</em> {@link #isGeneratePublicSalt()} is {@code true},</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * auto generate a random public salt via the configured</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * {@link #getRandomNumberGenerator() randomNumberGenerator}.</li></em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * <li>If a private salt has not been configured and {@link #isGeneratePublicSalt()} is {@code false},</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * do nothing - return {@code null} to indicate a salt should not be used during hash computation.</li></em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * @param request request the request to process</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @return the public salt that should be used to compute a hash based on the specified request or</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * {@code null} if no public salt should be used.</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> getPublicSalt(<a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html">HashRequest</a> request) { |
| <a name="213" href="#213">213</a> |
| <a name="214" href="#214">214</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> publicSalt = request.getSalt(); |
| <a name="215" href="#215">215</a> |
| <a name="216" href="#216">216</a> <strong class="jxr_keyword">if</strong> (publicSalt != <strong class="jxr_keyword">null</strong> && !publicSalt.isEmpty()) { |
| <a name="217" href="#217">217</a> <em class="jxr_comment">//a public salt was explicitly requested to be used - go ahead and use it:</em> |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">return</strong> publicSalt; |
| <a name="219" href="#219">219</a> } |
| <a name="220" href="#220">220</a> |
| <a name="221" href="#221">221</a> publicSalt = <strong class="jxr_keyword">null</strong>; |
| <a name="222" href="#222">222</a> |
| <a name="223" href="#223">223</a> <em class="jxr_comment">//check to see if we need to generate one:</em> |
| <a name="224" href="#224">224</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt = getPrivateSalt(); |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">boolean</strong> privateSaltExists = privateSalt != <strong class="jxr_keyword">null</strong> && !privateSalt.isEmpty(); |
| <a name="226" href="#226">226</a> |
| <a name="227" href="#227">227</a> <em class="jxr_comment">//If a private salt exists, we must generate a public salt to protect the integrity of the private salt.</em> |
| <a name="228" href="#228">228</a> <em class="jxr_comment">//Or generate it if the instance is explicitly configured to do so:</em> |
| <a name="229" href="#229">229</a> <strong class="jxr_keyword">if</strong> (privateSaltExists || isGeneratePublicSalt()) { |
| <a name="230" href="#230">230</a> publicSalt = getRandomNumberGenerator().nextBytes(); |
| <a name="231" href="#231">231</a> } |
| <a name="232" href="#232">232</a> |
| <a name="233" href="#233">233</a> <strong class="jxr_keyword">return</strong> publicSalt; |
| <a name="234" href="#234">234</a> } |
| <a name="235" href="#235">235</a> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * Combines the specified 'private' salt bytes with the specified additional extra bytes to use as the</em> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * total salt during hash computation. {@code privateSaltBytes} will be {@code null} }if no private salt has been</em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * configured.</em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * @param privateSalt the (possibly {@code null}) 'private' salt to combine with the specified extra bytes</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * @param publicSalt the extra bytes to use in addition to the given private salt.</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * @return a combination of the specified private salt bytes and extra bytes that will be used as the total</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * salt during hash computation.</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="246" href="#246">246</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> combine(<a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt, <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> publicSalt) { |
| <a name="247" href="#247">247</a> |
| <a name="248" href="#248">248</a> byte[] privateSaltBytes = privateSalt != <strong class="jxr_keyword">null</strong> ? privateSalt.getBytes() : <strong class="jxr_keyword">null</strong>; |
| <a name="249" href="#249">249</a> <strong class="jxr_keyword">int</strong> privateSaltLength = privateSaltBytes != <strong class="jxr_keyword">null</strong> ? privateSaltBytes.length : 0; |
| <a name="250" href="#250">250</a> |
| <a name="251" href="#251">251</a> byte[] publicSaltBytes = publicSalt != <strong class="jxr_keyword">null</strong> ? publicSalt.getBytes() : <strong class="jxr_keyword">null</strong>; |
| <a name="252" href="#252">252</a> <strong class="jxr_keyword">int</strong> extraBytesLength = publicSaltBytes != <strong class="jxr_keyword">null</strong> ? publicSaltBytes.length : 0; |
| <a name="253" href="#253">253</a> |
| <a name="254" href="#254">254</a> <strong class="jxr_keyword">int</strong> length = privateSaltLength + extraBytesLength; |
| <a name="255" href="#255">255</a> |
| <a name="256" href="#256">256</a> <strong class="jxr_keyword">if</strong> (length <= 0) { |
| <a name="257" href="#257">257</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="258" href="#258">258</a> } |
| <a name="259" href="#259">259</a> |
| <a name="260" href="#260">260</a> byte[] combined = <strong class="jxr_keyword">new</strong> byte[length]; |
| <a name="261" href="#261">261</a> |
| <a name="262" href="#262">262</a> <strong class="jxr_keyword">int</strong> i = 0; |
| <a name="263" href="#263">263</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < privateSaltLength; j++) { |
| <a name="264" href="#264">264</a> assert privateSaltBytes != <strong class="jxr_keyword">null</strong>; |
| <a name="265" href="#265">265</a> combined[i++] = privateSaltBytes[j]; |
| <a name="266" href="#266">266</a> } |
| <a name="267" href="#267">267</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < extraBytesLength; j++) { |
| <a name="268" href="#268">268</a> assert publicSaltBytes != <strong class="jxr_keyword">null</strong>; |
| <a name="269" href="#269">269</a> combined[i++] = publicSaltBytes[j]; |
| <a name="270" href="#270">270</a> } |
| <a name="271" href="#271">271</a> |
| <a name="272" href="#272">272</a> <strong class="jxr_keyword">return</strong> ByteSource.Util.bytes(combined); |
| <a name="273" href="#273">273</a> } |
| <a name="274" href="#274">274</a> |
| <a name="275" href="#275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHashAlgorithmName(String name) { |
| <a name="276" href="#276">276</a> <strong class="jxr_keyword">this</strong>.algorithmName = name; |
| <a name="277" href="#277">277</a> } |
| <a name="278" href="#278">278</a> |
| <a name="279" href="#279">279</a> <strong class="jxr_keyword">public</strong> String getHashAlgorithmName() { |
| <a name="280" href="#280">280</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.algorithmName; |
| <a name="281" href="#281">281</a> } |
| <a name="282" href="#282">282</a> |
| <a name="283" href="#283">283</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPrivateSalt(<a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt) { |
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">this</strong>.privateSalt = privateSalt; |
| <a name="285" href="#285">285</a> } |
| <a name="286" href="#286">286</a> |
| <a name="287" href="#287">287</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> getPrivateSalt() { |
| <a name="288" href="#288">288</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.privateSalt; |
| <a name="289" href="#289">289</a> } |
| <a name="290" href="#290">290</a> |
| <a name="291" href="#291">291</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHashIterations(<strong class="jxr_keyword">int</strong> count) { |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">this</strong>.iterations = count; |
| <a name="293" href="#293">293</a> } |
| <a name="294" href="#294">294</a> |
| <a name="295" href="#295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getHashIterations() { |
| <a name="296" href="#296">296</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.iterations; |
| <a name="297" href="#297">297</a> } |
| <a name="298" href="#298">298</a> |
| <a name="299" href="#299">299</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRandomNumberGenerator(<a href="../../../../../org/apache/shiro/crypto/RandomNumberGenerator.html">RandomNumberGenerator</a> rng) { |
| <a name="300" href="#300">300</a> <strong class="jxr_keyword">this</strong>.rng = rng; |
| <a name="301" href="#301">301</a> } |
| <a name="302" href="#302">302</a> |
| <a name="303" href="#303">303</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/RandomNumberGenerator.html">RandomNumberGenerator</a> getRandomNumberGenerator() { |
| <a name="304" href="#304">304</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.rng; |
| <a name="305" href="#305">305</a> } |
| <a name="306" href="#306">306</a> |
| <a name="307" href="#307">307</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * Returns {@code true} if a public salt should be randomly generated and used to compute a hash if a</em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * {@link HashRequest} does not specify a salt, {@code false} otherwise.</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * The default value is {@code false} but should definitely be set to {@code true} if the</em> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * {@code HashService} instance is being used for password hashing.</em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> this property only has an effect if a {@link #getPrivateSalt() privateSalt} is NOT configured. If a</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * private salt has been configured and a request does not provide a salt, a random salt will always be generated</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * to protect the integrity of the private salt (without a public salt, the private salt would be exposed as-is,</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * which is undesirable).</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * @return {@code true} if a public salt should be randomly generated and used to compute a hash if a</em> |
| <a name="320" href="#320">320</a> <em class="jxr_javadoccomment"> * {@link HashRequest} does not specify a salt, {@code false} otherwise.</em> |
| <a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="322" href="#322">322</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isGeneratePublicSalt() { |
| <a name="323" href="#323">323</a> <strong class="jxr_keyword">return</strong> generatePublicSalt; |
| <a name="324" href="#324">324</a> } |
| <a name="325" href="#325">325</a> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * Sets whether or not a public salt should be randomly generated and used to compute a hash if a</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * {@link HashRequest} does not specify a salt.</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * The default value is {@code false} but should definitely be set to {@code true} if the</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * {@code HashService} instance is being used for password hashing.</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> this property only has an effect if a {@link #getPrivateSalt() privateSalt} is NOT configured. If a</em> |
| <a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * private salt has been configured and a request does not provide a salt, a random salt will always be generated</em> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * to protect the integrity of the private salt (without a public salt, the private salt would be exposed as-is,</em> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * which is undesirable).</em> |
| <a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * @param generatePublicSalt whether or not a public salt should be randomly generated and used to compute a hash</em> |
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * if a {@link HashRequest} does not specify a salt.</em> |
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="341" href="#341">341</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setGeneratePublicSalt(<strong class="jxr_keyword">boolean</strong> generatePublicSalt) { |
| <a name="342" href="#342">342</a> <strong class="jxr_keyword">this</strong>.generatePublicSalt = generatePublicSalt; |
| <a name="343" href="#343">343</a> } |
| <a name="344" href="#344">344</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
