| <!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>HashedCredentialsMatcher xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authc/credential/HashedCredentialsMatcher.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.authc.credential; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.SaltedAuthenticationInfo; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Hex; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.AbstractHash; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.Hash; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.SimpleHash; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="30" href="#30">30</a> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * A {@code HashedCredentialMatcher} provides support for hashing of supplied {@code AuthenticationToken} credentials</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * before being compared to those in the {@code AuthenticationInfo} from the data store.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Credential hashing is one of the most common security techniques when safeguarding a user's private credentials</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * (passwords, keys, etc). Most developers never want to store their users' credentials in plain form, viewable by</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * anyone, so they often hash the users' credentials before they are saved in the data store.</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * This class (and its subclasses) function as follows:</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <li>Hash the {@code AuthenticationToken} credentials supplied by the user during their login.</li></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <li>Compare this hashed value directly with the {@code AuthenticationInfo} credentials stored in the system</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * (the stored account credentials are expected to already be in hashed form).</li></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <li>If these two values are {@link #equals(Object, Object) equal}, the submitted credentials match, otherwise</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * they do not.</li></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <h2>Salting and Multiple Hash Iterations</h2></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Because simple hashing is usually not good enough for secure applications, this class also supports 'salting'</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * and multiple hash iterations. Please read this excellent</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.owasp.org/index.php/Hashing_Java" target="alexandria_uri">http://www.owasp.org/index.php/Hashing_Java</a>" _target="blank">Hashing Java article</a> to learn about</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * salting and multiple iterations and why you might want to use them. (Note of sections 5</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * &quot;Why add salt?&quot; and 6 "Hardening against the attacker's attack"). We should also note here that all of</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Shiro's Hash implementations (for example, {@link org.apache.shiro.crypto.hash.Md5Hash Md5Hash},</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.crypto.hash.Sha1Hash Sha1Hash}, etc) support salting and multiple hash iterations via</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * overloaded constructors.</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * <h4>Real World Case Study</h4></em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * In April 2010, some public Atlassian Jira and Confluence</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * installations (Apache Software Foundation, Codehaus, etc) were the target of account attacks and user accounts</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * were compromised. The reason? Jira and Confluence at the time did not salt user passwords and attackers were</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * able to use dictionary attacks to compromise user accounts (Atlassian has since</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://blogs.atlassian.com/news/2010/04/oh_man_what_a_day_an_update_on_our_security_breach.html" target="alexandria_uri">http://blogs.atlassian.com/news/2010/04/oh_man_what_a_day_an_update_on_our_security_breach.html</a>"></em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * fixed the problem</a> of course).</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"> * The lesson?</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"> * <b>ALWAYS, ALWAYS, ALWAYS SALT USER PASSWORDS!</b></em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <h3>Salting</h3></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Prior to Shiro 1.1, salts could be obtained based on the end-user submitted</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken AuthenticationToken} via the now-deprecated</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * {@link #getSalt(org.apache.shiro.authc.AuthenticationToken) getSalt(AuthenticationToken)} method. This however</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * could constitute a security hole since ideally salts should never be obtained based on what a user can submit.</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * User-submitted salt mechanisms are <em>much</em> more susceptible to dictionary attacks and <b>SHOULD NOT</b> be</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * used in secure systems. Instead salts should ideally be a secure randomly-generated number that is generated when</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * the user account is created. The secure number should never be disseminated to the user and always kept private</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * by the application.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * <h4>Shiro 1.1</h4></em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * As of Shiro 1.1, it is expected that any salt used to hash the submitted credentials will be obtained from the</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * stored account information (represented as an {@link AuthenticationInfo AuthenticationInfo} instance). This is much</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * more secure because the salt value remains private to the application (Shiro will never store this value).</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * To enable this, {@code Realm}s should return {@link SaltedAuthenticationInfo SaltedAuthenticationInfo} instances</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * during authentication. {@code HashedCredentialsMatcher} implementations will then use the provided</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.SaltedAuthenticationInfo#getCredentialsSalt credentialsSalt} for hashing. To avoid</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * security risks,</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <b>it is highly recommended that any existing {@code Realm} implementations that support hashed credentials are</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * updated to return {@link SaltedAuthenticationInfo SaltedAuthenticationInfo} instances as soon as possible</b>.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <h4>Shiro 1.0 Backwards Compatibility</h4></em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Because of the identified security risk, {@code Realm} implementations that support credentials hashing should</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * be updated to return {@link SaltedAuthenticationInfo SaltedAuthenticationInfo} instances as</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * soon as possible.</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * If this is not possible for some reason, this class will retain 1.0 backwards-compatible behavior of obtaining</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * the salt via the now-deprecated {@link #getSalt(AuthenticationToken) getSalt(AuthenticationToken)} method. This</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * method will only be invoked if a {@code Realm} <em>does not</em> return</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * {@link SaltedAuthenticationInfo SaltedAutenticationInfo} instances and {@link #isHashSalted() hashSalted} is</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * {@code true}.</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * But please note that the {@link #isHashSalted() hashSalted} property and the</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * {@link #getSalt(AuthenticationToken) getSalt(AuthenticationToken)} methods will be removed before the Shiro 2.0</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * release.</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * <h3>Multiple Hash Iterations</h3></em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * If you hash your users' credentials multiple times before persisting to the data store, you will also need to</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * set this class's {@link #setHashIterations(int) hashIterations} property. See the</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.owasp.org/index.php/Hashing_Java" target="alexandria_uri">http://www.owasp.org/index.php/Hashing_Java</a>" _target="blank">Hashing Java article</a>'s</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.owasp.org/index.php/Hashing_Java" target="alexandria_uri">http://www.owasp.org/index.php/Hashing_Java</a>#Hardening_against_the_attacker.27s_attack"></em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * &quot;Hardening against the attacker's attack&quot;</a> section to learn more about why you might want to use</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * multiple hash iterations.</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * <h2>MD5 &amp; SHA-1 Notice</h2></em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/MD5" target="alexandria_uri">http://en.wikipedia.org/wiki/MD5</a>">MD5</a> and</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://en.wikipedia.org/wiki/SHA_hash_functions" target="alexandria_uri">http://en.wikipedia.org/wiki/SHA_hash_functions</a>">SHA-1</a> algorithms are now known to be vulnerable to</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * compromise and/or collisions (read the linked pages for more). While most applications are ok with either of these</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * two, if your application mandates high security, use the SHA-256 (or higher) hashing algorithms and their</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * supporting {@code CredentialsMatcher} implementations.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.crypto.hash.Md5Hash</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.crypto.hash.Sha1Hash</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.crypto.hash.Sha256Hash</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html">HashedCredentialsMatcher</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html">SimpleCredentialsMatcher</a> { |
| <a name="121" href="#121">121</a> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">private</strong> String hashAlgorithm; |
| <a name="126" href="#126">126</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> hashIterations; |
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> hashSalted; |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> storedCredentialsHexEncoded; |
| <a name="129" href="#129">129</a> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * JavaBeans-compatibile no-arg constructor intended for use in IoC/Dependency Injection environments. If you</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * use this constructor, you <em>MUST</em> also additionally set the</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * {@link #setHashAlgorithmName(String) hashAlgorithmName} property.</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="135" href="#135">135</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html">HashedCredentialsMatcher</a>() { |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">this</strong>.hashAlgorithm = <strong class="jxr_keyword">null</strong>; |
| <a name="137" href="#137">137</a> <strong class="jxr_keyword">this</strong>.hashSalted = false; |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.hashIterations = 1; |
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">this</strong>.storedCredentialsHexEncoded = <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//false means Base64-encoded</em> |
| <a name="140" href="#140">140</a> } |
| <a name="141" href="#141">141</a> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Creates an instance using the specified {@link #getHashAlgorithmName() hashAlgorithmName} to hash submitted</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * credentials.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @param hashAlgorithmName the {@code Hash} {@link org.apache.shiro.crypto.hash.Hash#getAlgorithmName() algorithmName}</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * to use when performing hashes for credentials matching.</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcher.html">HashedCredentialsMatcher</a>(String hashAlgorithmName) { |
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">this</strong>(); |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(hashAlgorithmName) ) { |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"hashAlgorithmName cannot be null or empty."</span>); |
| <a name="153" href="#153">153</a> } |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">this</strong>.hashAlgorithm = hashAlgorithmName; |
| <a name="155" href="#155">155</a> } |
| <a name="156" href="#156">156</a> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Returns the {@code Hash} {@link org.apache.shiro.crypto.hash.Hash#getAlgorithmName() algorithmName} to use</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * when performing hashes for credentials matching.</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @return the {@code Hash} {@link org.apache.shiro.crypto.hash.Hash#getAlgorithmName() algorithmName} to use</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * when performing hashes for credentials matching.</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">public</strong> String getHashAlgorithmName() { |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> hashAlgorithm; |
| <a name="167" href="#167">167</a> } |
| <a name="168" href="#168">168</a> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * Sets the {@code Hash} {@link org.apache.shiro.crypto.hash.Hash#getAlgorithmName() algorithmName} to use</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * when performing hashes for credentials matching.</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * @param hashAlgorithmName the {@code Hash} {@link org.apache.shiro.crypto.hash.Hash#getAlgorithmName() algorithmName}</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * to use when performing hashes for credentials matching.</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHashAlgorithmName(String hashAlgorithmName) { |
| <a name="178" href="#178">178</a> <strong class="jxr_keyword">this</strong>.hashAlgorithm = hashAlgorithmName; |
| <a name="179" href="#179">179</a> } |
| <a name="180" href="#180">180</a> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the system's stored credential hash is Hex encoded, {@code false} if it</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * is Base64 encoded.</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * Default value is {@code true} for convenience - all of Shiro's {@link Hash Hash#toString()}</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * implementations return Hex encoded values by default, making this class's use with those implementations</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * easier.</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @return {@code true} if the system's stored credential hash is Hex encoded, {@code false} if it</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * is Base64 encoded. Default is {@code true}</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="192" href="#192">192</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStoredCredentialsHexEncoded() { |
| <a name="193" href="#193">193</a> <strong class="jxr_keyword">return</strong> storedCredentialsHexEncoded; |
| <a name="194" href="#194">194</a> } |
| <a name="195" href="#195">195</a> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * Sets the indicator if this system's stored credential hash is Hex encoded or not.</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * A value of {@code true} will cause this class to decode the system credential from Hex, a</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * value of {@code false} will cause this class to decode the system credential from Base64.</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * Unless overridden via this method, the default value is {@code true} for convenience - all of Shiro's</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * {@link Hash Hash#toString()} implementations return Hex encoded values by default, making this class's use with</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * those implementations easier.</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @param storedCredentialsHexEncoded the indicator if this system's stored credential hash is Hex</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * encoded or not ('not' automatically implying it is Base64 encoded).</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="209" href="#209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStoredCredentialsHexEncoded(<strong class="jxr_keyword">boolean</strong> storedCredentialsHexEncoded) { |
| <a name="210" href="#210">210</a> <strong class="jxr_keyword">this</strong>.storedCredentialsHexEncoded = storedCredentialsHexEncoded; |
| <a name="211" href="#211">211</a> } |
| <a name="212" href="#212">212</a> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * Returns {@code true} if a submitted {@code AuthenticationToken}'s credentials should be salted when hashing,</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * {@code false} if it should not be salted.</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * If enabled, the salt used will be obtained via the {@link #getSalt(AuthenticationToken) getSalt} method.</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * The default value is {@code false}.</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @return {@code true} if a submitted {@code AuthenticationToken}'s credentials should be salted when hashing,</em> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * {@code false} if it should not be salted.</em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @deprecated since Shiro 1.1. Hash salting is now expected to be based on if the {@link AuthenticationInfo}</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * returned from the {@code Realm} is a {@link SaltedAuthenticationInfo} instance and its</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.SaltedAuthenticationInfo#getCredentialsSalt() getCredentialsSalt()} method returns a non-null value.</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * This method and the 1.0 behavior still exists for backwards compatibility if the {@code Realm} does not return</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * {@code SaltedAuthenticationInfo} instances, but <b>it is highly recommended that {@code Realm} implementations</em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * that support hashed credentials start returning {@link SaltedAuthenticationInfo SaltedAuthenticationInfo}</em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * instances as soon as possible</b>.</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * This is because salts should always be obtained from the stored account information and</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for</em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user</em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * are almost impossible to break. This method will be removed in Shiro 2.0.</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="236" href="#236">236</a> @Deprecated |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isHashSalted() { |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">return</strong> hashSalted; |
| <a name="239" href="#239">239</a> } |
| <a name="240" href="#240">240</a> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * Sets whether or not to salt a submitted {@code AuthenticationToken}'s credentials when hashing.</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * If enabled, the salt used will be obtained via the {@link #getSalt(org.apache.shiro.authc.AuthenticationToken) getCredentialsSalt} method.</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * The default value is {@code false}.</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * @param hashSalted whether or not to salt a submitted {@code AuthenticationToken}'s credentials when hashing.</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * @deprecated since Shiro 1.1. Hash salting is now expected to be based on if the {@link AuthenticationInfo}</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * returned from the {@code Realm} is a {@link SaltedAuthenticationInfo} instance and its</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.SaltedAuthenticationInfo#getCredentialsSalt() getCredentialsSalt()} method returns a non-null value.</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * This method and the 1.0 behavior still exists for backwards compatibility if the {@code Realm} does not return</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * {@code SaltedAuthenticationInfo} instances, but <b>it is highly recommended that {@code Realm} implementations</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * that support hashed credentials start returning {@link SaltedAuthenticationInfo SaltedAuthenticationInfo}</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * instances as soon as possible</b>.</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * This is because salts should always be obtained from the stored account information and</em> |
| <a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user</em> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * are almost impossible to break. This method will be removed in Shiro 2.0.</em> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="262" href="#262">262</a> @Deprecated |
| <a name="263" href="#263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHashSalted(<strong class="jxr_keyword">boolean</strong> hashSalted) { |
| <a name="264" href="#264">264</a> <strong class="jxr_keyword">this</strong>.hashSalted = hashSalted; |
| <a name="265" href="#265">265</a> } |
| <a name="266" href="#266">266</a> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * Returns the number of times a submitted {@code AuthenticationToken}'s credentials will be hashed before</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * comparing to the credentials stored in the system.</em> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * Unless overridden, the default value is {@code 1}, meaning a normal hash execution will occur.</em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * @return the number of times a submitted {@code AuthenticationToken}'s credentials will be hashed before</em> |
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * comparing to the credentials stored in the system.</em> |
| <a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="276" href="#276">276</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getHashIterations() { |
| <a name="277" href="#277">277</a> <strong class="jxr_keyword">return</strong> hashIterations; |
| <a name="278" href="#278">278</a> } |
| <a name="279" href="#279">279</a> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * Sets the number of times a submitted {@code AuthenticationToken}'s credentials will be hashed before comparing</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * to the credentials stored in the system.</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * Unless overridden, the default value is {@code 1}, meaning a normal single hash execution will occur.</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * If this argument is less than 1 (i.e. 0 or negative), the default value of 1 is applied. There must always be</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * at least 1 hash iteration (otherwise there would be no hash).</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * @param hashIterations the number of times to hash a submitted {@code AuthenticationToken}'s credentials.</em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> */</em> |
| <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> hashIterations) { |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">if</strong> (hashIterations < 1) { |
| <a name="293" href="#293">293</a> <strong class="jxr_keyword">this</strong>.hashIterations = 1; |
| <a name="294" href="#294">294</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="295" href="#295">295</a> <strong class="jxr_keyword">this</strong>.hashIterations = hashIterations; |
| <a name="296" href="#296">296</a> } |
| <a name="297" href="#297">297</a> } |
| <a name="298" href="#298">298</a> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * Returns a salt value used to hash the token's credentials.</em> |
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * This default implementation merely returns {@code token.getPrincipal()}, effectively using the user's</em> |
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> * identity (username, user id, etc) as the salt, a most common technique. If you wish to provide the</em> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * authentication token's salt another way, you may override this method.</em> |
| <a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * @param token the AuthenticationToken submitted during the authentication attempt.</em> |
| <a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * @return a salt value to use to hash the authentication token's credentials.</em> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * @deprecated since Shiro 1.1. Hash salting is now expected to be based on if the {@link AuthenticationInfo}</em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * returned from the {@code Realm} is a {@link SaltedAuthenticationInfo} instance and its</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.SaltedAuthenticationInfo#getCredentialsSalt() getCredentialsSalt()} method returns a non-null value.</em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * This method and the 1.0 behavior still exists for backwards compatibility if the {@code Realm} does not return</em> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * {@code SaltedAuthenticationInfo} instances, but <b>it is highly recommended that {@code Realm} implementations</em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * that support hashed credentials start returning {@link SaltedAuthenticationInfo SaltedAuthenticationInfo}</em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * instances as soon as possible</b>.<p/></em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * This is because salts should always be obtained from the stored account information and</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * are almost impossible to break. This method will be removed in Shiro 2.0.</em> |
| <a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="320" href="#320">320</a> @Deprecated |
| <a name="321" href="#321">321</a> <strong class="jxr_keyword">protected</strong> Object getSalt(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="322" href="#322">322</a> <strong class="jxr_keyword">return</strong> token.getPrincipal(); |
| <a name="323" href="#323">323</a> } |
| <a name="324" href="#324">324</a> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * Returns a {@link Hash Hash} instance representing the already-hashed AuthenticationInfo credentials stored in the system.</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * This method reconstructs a {@link Hash Hash} instance based on a {@code info.getCredentials} call,</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * but it does <em>not</em> hash that value - it is expected that method call will return an already-hashed value.</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * This implementation's reconstruction effort functions as follows:</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> * <li>Convert {@code account.getCredentials()} to a byte array via the {@link #toBytes toBytes} method.</em> |
| <a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * <li>If {@code account.getCredentials()} was originally a String or char[] before {@code toBytes} was</em> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * called, check for encoding:</em> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * <li>If {@link #storedCredentialsHexEncoded storedCredentialsHexEncoded}, Hex decode that byte array, otherwise</em> |
| <a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * Base64 decode the byte array</li></em> |
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * <li>Set the byte[] array directly on the {@code Hash} implementation and return it.</li></em> |
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * @param info the AuthenticationInfo from which to retrieve the credentials which assumed to be in already-hashed form.</em> |
| <a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * @return a {@link Hash Hash} instance representing the given AuthenticationInfo's stored credentials.</em> |
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="344" href="#344">344</a> <strong class="jxr_keyword">protected</strong> Object getCredentials(<a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="345" href="#345">345</a> Object credentials = info.getCredentials(); |
| <a name="346" href="#346">346</a> |
| <a name="347" href="#347">347</a> byte[] storedBytes = toBytes(credentials); |
| <a name="348" href="#348">348</a> |
| <a name="349" href="#349">349</a> <strong class="jxr_keyword">if</strong> (credentials instanceof String || credentials instanceof <strong class="jxr_keyword">char</strong>[]) { |
| <a name="350" href="#350">350</a> <em class="jxr_comment">//account.credentials were a char[] or String, so</em> |
| <a name="351" href="#351">351</a> <em class="jxr_comment">//we need to do text decoding first:</em> |
| <a name="352" href="#352">352</a> <strong class="jxr_keyword">if</strong> (isStoredCredentialsHexEncoded()) { |
| <a name="353" href="#353">353</a> storedBytes = Hex.decode(storedBytes); |
| <a name="354" href="#354">354</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="355" href="#355">355</a> storedBytes = Base64.decode(storedBytes); |
| <a name="356" href="#356">356</a> } |
| <a name="357" href="#357">357</a> } |
| <a name="358" href="#358">358</a> <a href="../../../../../org/apache/shiro/crypto/hash/AbstractHash.html">AbstractHash</a> hash = newHashInstance(); |
| <a name="359" href="#359">359</a> hash.setBytes(storedBytes); |
| <a name="360" href="#360">360</a> <strong class="jxr_keyword">return</strong> hash; |
| <a name="361" href="#361">361</a> } |
| <a name="362" href="#362">362</a> |
| <a name="363" href="#363">363</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> * This implementation first hashes the {@code token}'s credentials, potentially using a</em> |
| <a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * {@code salt} if the {@code info} argument is a</em> |
| <a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.SaltedAuthenticationInfo SaltedAuthenticationInfo}. It then compares the hash</em> |
| <a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * against the {@code AuthenticationInfo}'s</em> |
| <a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> * {@link #getCredentials(org.apache.shiro.authc.AuthenticationInfo) already-hashed credentials}. This method</em> |
| <a name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * returns {@code true} if those two values are {@link #equals(Object, Object) equal}, {@code false} otherwise.</em> |
| <a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * @param token the {@code AuthenticationToken} submitted during the authentication attempt.</em> |
| <a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * @param info the {@code AuthenticationInfo} stored in the system matching the token principal</em> |
| <a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * @return {@code true} if the provided token credentials hash match to the stored account credentials hash,</em> |
| <a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * {@code false} otherwise</em> |
| <a name="375" href="#375">375</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="376" href="#376">376</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="377" href="#377">377</a> @Override |
| <a name="378" href="#378">378</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doCredentialsMatch(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="379" href="#379">379</a> Object tokenHashedCredentials = hashProvidedCredentials(token, info); |
| <a name="380" href="#380">380</a> Object accountCredentials = getCredentials(info); |
| <a name="381" href="#381">381</a> <strong class="jxr_keyword">return</strong> equals(tokenHashedCredentials, accountCredentials); |
| <a name="382" href="#382">382</a> } |
| <a name="383" href="#383">383</a> |
| <a name="384" href="#384">384</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> * Hash the provided {@code token}'s credentials using the salt stored with the account if the</em> |
| <a name="386" href="#386">386</a> <em class="jxr_javadoccomment"> * {@code info} instance is an {@code instanceof} {@link SaltedAuthenticationInfo SaltedAuthenticationInfo} (see</em> |
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * the class-level JavaDoc for why this is the preferred approach).</em> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * If the {@code info} instance is <em>not</em></em> |
| <a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * an {@code instanceof} {@code SaltedAuthenticationInfo}, the logic will fall back to Shiro 1.0</em> |
| <a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> * backwards-compatible logic: it will first check to see {@link #isHashSalted() isHashSalted} and if so, will try</em> |
| <a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> * to acquire the salt from {@link #getSalt(AuthenticationToken) getSalt(AuthenticationToken)}. See the class-level</em> |
| <a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * JavaDoc for why this is not recommended. This 'fallback' logic exists only for backwards-compatibility.</em> |
| <a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * {@code Realm}s should be updated as soon as possible to return {@code SaltedAuthenticationInfo} instances</em> |
| <a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * if account credentials salting is enabled (highly recommended for password-based systems).</em> |
| <a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * @param token the submitted authentication token from which its credentials will be hashed</em> |
| <a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * @param info the stored account data, potentially used to acquire a salt</em> |
| <a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> * @return the token credentials hash</em> |
| <a name="400" href="#400">400</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="401" href="#401">401</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="402" href="#402">402</a> <strong class="jxr_keyword">protected</strong> Object hashProvidedCredentials(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="403" href="#403">403</a> Object salt = <strong class="jxr_keyword">null</strong>; |
| <a name="404" href="#404">404</a> <strong class="jxr_keyword">if</strong> (info instanceof SaltedAuthenticationInfo) { |
| <a name="405" href="#405">405</a> salt = ((SaltedAuthenticationInfo) info).getCredentialsSalt(); |
| <a name="406" href="#406">406</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="407" href="#407">407</a> <em class="jxr_comment">//retain 1.0 backwards compatibility:</em> |
| <a name="408" href="#408">408</a> <strong class="jxr_keyword">if</strong> (isHashSalted()) { |
| <a name="409" href="#409">409</a> salt = getSalt(token); |
| <a name="410" href="#410">410</a> } |
| <a name="411" href="#411">411</a> } |
| <a name="412" href="#412">412</a> <strong class="jxr_keyword">return</strong> hashProvidedCredentials(token.getCredentials(), salt, getHashIterations()); |
| <a name="413" href="#413">413</a> } |
| <a name="414" href="#414">414</a> |
| <a name="415" href="#415">415</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * Returns the {@link #getHashAlgorithmName() hashAlgorithmName} property, but will throw an</em> |
| <a name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * {@link IllegalStateException} if it has not been set.</em> |
| <a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> * @return the required {@link #getHashAlgorithmName() hashAlgorithmName} property</em> |
| <a name="420" href="#420">420</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if the property has not been set prior to calling this method.</em> |
| <a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="423" href="#423">423</a> <strong class="jxr_keyword">private</strong> String assertHashAlgorithmName() <strong class="jxr_keyword">throws</strong> IllegalStateException { |
| <a name="424" href="#424">424</a> String hashAlgorithmName = getHashAlgorithmName(); |
| <a name="425" href="#425">425</a> <strong class="jxr_keyword">if</strong> (hashAlgorithmName == <strong class="jxr_keyword">null</strong>) { |
| <a name="426" href="#426">426</a> String msg = <span class="jxr_string">"Required 'hashAlgorithmName' property has not been set. This is required to execute "</span> + |
| <a name="427" href="#427">427</a> <span class="jxr_string">"the hashing algorithm."</span>; |
| <a name="428" href="#428">428</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="429" href="#429">429</a> } |
| <a name="430" href="#430">430</a> <strong class="jxr_keyword">return</strong> hashAlgorithmName; |
| <a name="431" href="#431">431</a> } |
| <a name="432" href="#432">432</a> |
| <a name="433" href="#433">433</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="434" href="#434">434</a> <em class="jxr_javadoccomment"> * Hashes the provided credentials a total of {@code hashIterations} times, using the given salt. The hash</em> |
| <a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> * implementation/algorithm used is based on the {@link #getHashAlgorithmName() hashAlgorithmName} property.</em> |
| <a name="436" href="#436">436</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> * @param credentials the submitted authentication token's credentials to hash</em> |
| <a name="438" href="#438">438</a> <em class="jxr_javadoccomment"> * @param salt the value to salt the hash, or {@code null} if a salt will not be used.</em> |
| <a name="439" href="#439">439</a> <em class="jxr_javadoccomment"> * @param hashIterations the number of times to hash the credentials. At least one hash will always occur though,</em> |
| <a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> * even if this argument is 0 or negative.</em> |
| <a name="441" href="#441">441</a> <em class="jxr_javadoccomment"> * @return the hashed value of the provided credentials, according to the specified salt and hash iterations.</em> |
| <a name="442" href="#442">442</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="443" href="#443">443</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html">Hash</a> hashProvidedCredentials(Object credentials, Object salt, <strong class="jxr_keyword">int</strong> hashIterations) { |
| <a name="444" href="#444">444</a> String hashAlgorithmName = assertHashAlgorithmName(); |
| <a name="445" href="#445">445</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(hashAlgorithmName, credentials, salt, hashIterations); |
| <a name="446" href="#446">446</a> } |
| <a name="447" href="#447">447</a> |
| <a name="448" href="#448">448</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * Returns a new, <em>uninitialized</em> instance, without its byte array set. Used as a utility method in the</em> |
| <a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * {@link SimpleCredentialsMatcher#getCredentials(org.apache.shiro.authc.AuthenticationInfo) getCredentials(AuthenticationInfo)} implementation.</em> |
| <a name="451" href="#451">451</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="452" href="#452">452</a> <em class="jxr_javadoccomment"> * @return a new, <em>uninitialized</em> instance, without its byte array set.</em> |
| <a name="453" href="#453">453</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="454" href="#454">454</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/crypto/hash/AbstractHash.html">AbstractHash</a> newHashInstance() { |
| <a name="455" href="#455">455</a> String hashAlgorithmName = assertHashAlgorithmName(); |
| <a name="456" href="#456">456</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(hashAlgorithmName); |
| <a name="457" href="#457">457</a> } |
| <a name="458" href="#458">458</a> |
| <a name="459" href="#459">459</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
