| <!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>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 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." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</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.hash; |
| <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.crypto.RandomNumberGenerator; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.SecureRandomNumberGenerator; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Default implementation of the {@link HashService} interface, supporting a customizable hash algorithm name,</em> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * secure-random salt generation, multiple hash iterations and an optional internal</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * {@link #setPrivateSalt(ByteSource) privateSalt}.</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * <h2>Hash Algorithm</h2></em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * You may specify a hash algorithm via the {@link #setHashAlgorithmName(String)} property. Any algorithm name</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * understood by the JDK</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * {@link java.security.MessageDigest#getInstance(String) MessageDigest.getInstance(String algorithmName)} method</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * will work. The default is {@code SHA-512}.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <h2>Random Salts</h2></em> |
| <a class="jxr_linenumber" name="L35" href="#L35">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 class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * {@link #setRandomNumberGenerator(org.apache.shiro.crypto.RandomNumberGenerator) randomNumberGenerator} property.</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * Random salts (and potentially combined with the internal {@link #getPrivateSalt() privateSalt}) is a very strong</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">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 class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * {@link SecureRandomNumberGenerator}.</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <h2>Hash Iterations</h2></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Secure hashing strategies often employ multiple hash iterations to slow down the hashing process. This technique</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">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 class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * take for an attacker to compromise a password. This</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.stormpath.com/blog/strong-password-hashing-apache-shiro" target="alexandria_uri">http://www.stormpath.com/blog/strong-password-hashing-apache-shiro</a>">blog article</a></em> |
| <a class="jxr_linenumber" name="L45" href="#L45">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 class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L47" href="#L47">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 class="jxr_linenumber" name="L48" href="#L48">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 class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * hashing. See the linked blog article for more info.</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <h2>Private Salt</h2></em> |
| <a class="jxr_linenumber" name="L51" href="#L51">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 class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * {@link #setPrivateSalt(ByteSource) private salt}:</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L54" href="#L54">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 class="jxr_linenumber" name="L55" href="#L55">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 class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * to try to brute-force crack the hash (source + complete salt).</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L58" href="#L58">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 class="jxr_linenumber" name="L59" href="#L59">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 class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">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 class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * If you configure this attribute, you can obtain this additional very important safety feature.</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">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 class="jxr_linenumber" name="L65" href="#L65">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 class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">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> <strong class="jxr_keyword">implements</strong> <a href="../../../../../org/apache/shiro/crypto/hash/ConfigurableHashService.html">ConfigurableHashService</a> { |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * The RandomNumberGenerator to use to randomly generate the public part of the hash salt.</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/crypto/RandomNumberGenerator.html">RandomNumberGenerator</a> rng; |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * The MessageDigest name of the hash algorithm to use for computing hashes.</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> String algorithmName; |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * The 'private' part of the hash salt.</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> |
| <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> <em class="jxr_javadoccomment"> * The number of hash iterations to perform when computing hashes.</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iterations; |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Whether or not to generate public salts if a request does not provide one.</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> generatePublicSalt; |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Constructs a new {@code DefaultHashService} instance with the following defaults:</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <li>{@link #setHashAlgorithmName(String) hashAlgorithmName} = {@code SHA-512}</li></em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <li>{@link #setHashIterations(int) hashIterations} = {@code 1}</li></em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <li>{@link #setRandomNumberGenerator(org.apache.shiro.crypto.RandomNumberGenerator) randomNumberGenerator} =</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * new {@link SecureRandomNumberGenerator}()</li></em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <li>{@link #setGeneratePublicSalt(boolean) generatePublicSalt} = {@code false}</li></em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * If this hashService will be used for password hashing it is recommended to set the</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * {@link #setPrivateSalt(ByteSource) privateSalt} and significantly increase the number of</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * {@link #setHashIterations(int) hashIterations}. See the class-level JavaDoc for more information.</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/hash/DefaultHashService.html">DefaultHashService</a>() { |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">this</strong>.algorithmName = <span class="jxr_string">"SHA-512"</span>; |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">this</strong>.iterations = 1; |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">this</strong>.generatePublicSalt = false; |
| <a class="jxr_linenumber" name="L114" href="#L114">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 class="jxr_linenumber" name="L115" href="#L115">115</a> } |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Computes and responds with a hash based on the specified request.</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * This implementation functions as follows:</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * <li>If the request's {@link org.apache.shiro.crypto.hash.HashRequest#getSalt() salt} is null:</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * A salt will be generated and used to compute the hash. The salt is generated as follows:</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * <li>Use the {@link #getRandomNumberGenerator() randomNumberGenerator} to generate a new random number.</li></em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * <li>{@link #combine(ByteSource, ByteSource) combine} this random salt with any configured</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * {@link #getPrivateSalt() privateSalt}</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * <li>Use the combined value as the salt used during hash computation</li></em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * <li></em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * If the request salt is not null:</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * This indicates that the hash computation is for comparison purposes (of a</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * previously computed hash). The request salt will be {@link #combine(ByteSource, ByteSource) combined} with any</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * configured {@link #getPrivateSalt() privateSalt} and used as the complete salt during hash computation.</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * The returned {@code Hash}'s {@link Hash#getSalt() salt} property</em> |
| <a class="jxr_linenumber" name="L143" href="#L143">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 class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * JavaDoc explanation for more info.</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param request the request to process</em> |
| <a class="jxr_linenumber" name="L147" href="#L147">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 class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * exposed to the caller.</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">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 class="jxr_linenumber" name="L151" href="#L151">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 class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> } |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> String algorithmName = getAlgorithmName(request); |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> source = request.getSource(); |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">int</strong> iterations = getIterations(request); |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> publicSalt = getPublicSalt(request); |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt = getPrivateSalt(); |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> salt = combine(privateSalt, publicSalt); |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> |
| <a class="jxr_linenumber" name="L163" href="#L163">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 class="jxr_linenumber" name="L164" href="#L164">164</a> |
| <a class="jxr_linenumber" name="L165" href="#L165">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 class="jxr_linenumber" name="L166" href="#L166">166</a> result.setBytes(computed.getBytes()); |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> result.setIterations(iterations); |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_comment">//Only expose the public salt - not the real/combined salt that might have been used:</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> result.setSalt(publicSalt); |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">return</strong> result; |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> } |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">protected</strong> String getAlgorithmName(<a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html">HashRequest</a> request) { |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> String name = request.getAlgorithmName(); |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> name = getHashAlgorithmName(); |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> } |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">return</strong> name; |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> } |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> |
| <a class="jxr_linenumber" name="L182" href="#L182">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 class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">int</strong> iterations = Math.max(0, request.getIterations()); |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">if</strong> (iterations < 1) { |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> iterations = Math.max(1, getHashIterations()); |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> } |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">return</strong> iterations; |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> } |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">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 class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * {@code null} if no public salt should be used.</em> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * This implementation functions as follows:</em> |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L196" href="#L196">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 class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * <li>If the request salt is null or empty:</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * <li>If a private salt has been set <em>OR</em> {@link #isGeneratePublicSalt()} is {@code true},</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * auto generate a random public salt via the configured</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * {@link #getRandomNumberGenerator() randomNumberGenerator}.</li></em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * <li>If a private salt has not been configured and {@link #isGeneratePublicSalt()} is {@code false},</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">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 class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * @param request request the request to process</em> |
| <a class="jxr_linenumber" name="L209" href="#L209">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 class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * {@code null} if no public salt should be used.</em> |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L212" href="#L212">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 class="jxr_linenumber" name="L213" href="#L213">213</a> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> publicSalt = request.getSalt(); |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">if</strong> (publicSalt != <strong class="jxr_keyword">null</strong> && !publicSalt.isEmpty()) { |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_comment">//a public salt was explicitly requested to be used - go ahead and use it:</em> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">return</strong> publicSalt; |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> } |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> publicSalt = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_comment">//check to see if we need to generate one:</em> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> privateSalt = getPrivateSalt(); |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">boolean</strong> privateSaltExists = privateSalt != <strong class="jxr_keyword">null</strong> && !privateSalt.isEmpty(); |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> |
| <a class="jxr_linenumber" name="L227" href="#L227">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 class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_comment">//Or generate it if the instance is explicitly configured to do so:</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">if</strong> (privateSaltExists || isGeneratePublicSalt()) { |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> publicSalt = getRandomNumberGenerator().nextBytes(); |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> } |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">return</strong> publicSalt; |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> } |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * Combines the specified 'private' salt bytes with the specified additional extra bytes to use as the</em> |
| <a class="jxr_linenumber" name="L238" href="#L238">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 class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * configured.</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * @param privateSalt the (possibly {@code null}) 'private' salt to combine with the specified extra bytes</em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @param publicSalt the extra bytes to use in addition to the given private salt.</em> |
| <a class="jxr_linenumber" name="L243" href="#L243">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 class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * salt during hash computation.</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">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 class="jxr_linenumber" name="L247" href="#L247">247</a> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> byte[] privateSaltBytes = privateSalt != <strong class="jxr_keyword">null</strong> ? privateSalt.getBytes() : <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">int</strong> privateSaltLength = privateSaltBytes != <strong class="jxr_keyword">null</strong> ? privateSaltBytes.length : 0; |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> byte[] publicSaltBytes = publicSalt != <strong class="jxr_keyword">null</strong> ? publicSalt.getBytes() : <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">int</strong> extraBytesLength = publicSaltBytes != <strong class="jxr_keyword">null</strong> ? publicSaltBytes.length : 0; |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">int</strong> length = privateSaltLength + extraBytesLength; |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (length <= 0) { |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> } |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> byte[] combined = <strong class="jxr_keyword">new</strong> byte[length]; |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">int</strong> i = 0; |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < privateSaltLength; j++) { |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> assert privateSaltBytes != <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> combined[i++] = privateSaltBytes[j]; |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> } |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < extraBytesLength; j++) { |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> assert publicSaltBytes != <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> combined[i++] = publicSaltBytes[j]; |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> } |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">return</strong> ByteSource.Util.bytes(combined); |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> } |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHashAlgorithmName(String name) { |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">this</strong>.algorithmName = name; |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> } |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">public</strong> String getHashAlgorithmName() { |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.algorithmName; |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> } |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> |
| <a class="jxr_linenumber" name="L283" href="#L283">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 class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">this</strong>.privateSalt = privateSalt; |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> } |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> getPrivateSalt() { |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.privateSalt; |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> } |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHashIterations(<strong class="jxr_keyword">int</strong> count) { |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">this</strong>.iterations = count; |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> } |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getHashIterations() { |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.iterations; |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> } |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> |
| <a class="jxr_linenumber" name="L299" href="#L299">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 class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">this</strong>.rng = rng; |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> } |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/RandomNumberGenerator.html">RandomNumberGenerator</a> getRandomNumberGenerator() { |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.rng; |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> } |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L308" href="#L308">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 class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * {@link HashRequest} does not specify a salt, {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * The default value is {@code false} but should definitely be set to {@code true} if the</em> |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * {@code HashService} instance is being used for password hashing.</em> |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L314" href="#L314">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 class="jxr_linenumber" name="L315" href="#L315">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 class="jxr_linenumber" name="L316" href="#L316">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 class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * which is undesirable).</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @return {@code true} if a public salt should be randomly generated and used to compute a hash if a</em> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * {@link HashRequest} does not specify a salt, {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isGeneratePublicSalt() { |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">return</strong> generatePublicSalt; |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> } |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L327" href="#L327">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 class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * {@link HashRequest} does not specify a salt.</em> |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * The default value is {@code false} but should definitely be set to {@code true} if the</em> |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * {@code HashService} instance is being used for password hashing.</em> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L333" href="#L333">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 class="jxr_linenumber" name="L334" href="#L334">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 class="jxr_linenumber" name="L335" href="#L335">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 class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * which is undesirable).</em> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L338" href="#L338">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 class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * if a {@link HashRequest} does not specify a salt.</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setGeneratePublicSalt(<strong class="jxr_keyword">boolean</strong> generatePublicSalt) { |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">this</strong>.generatePublicSalt = generatePublicSalt; |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> } |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
