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