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