| <!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.crypto.hash.DefaultHashService;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.crypto.hash.Hash;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.crypto.hash.HashRequest;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.crypto.hash.HashService;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.crypto.hash.format.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.util.ByteSource;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.slf4j.LoggerFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Default implementation of the {@link PasswordService} interface that relies on an internal<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * {@link HashService}, {@link HashFormat}, and {@link HashFormatFactory} to function:<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <h2>Hashing Passwords</h2><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <h2>Comparing Passwords</h2><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * All hashing operations are performed by the internal {@link #getHashService() hashService}. After the hash<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * is computed, it is formatted into a String value via the internal {@link #getHashFormat() hashFormat}.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @since 1.2<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public class DefaultPasswordService implements HashingPasswordService {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> public static final String DEFAULT_HASH_ALGORITHM = "SHA-256";<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static final int DEFAULT_HASH_ITERATIONS = 500000; //500,000<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private static final Logger log = LoggerFactory.getLogger(DefaultPasswordService.class);<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> private HashService hashService;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private HashFormat hashFormat;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private HashFormatFactory hashFormatFactory;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private volatile boolean hashFormatWarned; //used to avoid excessive log noise<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public DefaultPasswordService() {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> this.hashFormatWarned = false;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> DefaultHashService hashService = new DefaultHashService();<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> hashService.setHashAlgorithmName(DEFAULT_HASH_ALGORITHM);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> hashService.setHashIterations(DEFAULT_HASH_ITERATIONS);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> hashService.setGeneratePublicSalt(true); //always want generated salts for user passwords to be most secure<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> this.hashService = hashService;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> this.hashFormat = new Shiro1CryptFormat();<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> this.hashFormatFactory = new DefaultHashFormatFactory();<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public String encryptPassword(Object plaintext) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> Hash hash = hashPassword(plaintext);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> checkHashFormatDurability();<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> return this.hashFormat.format(hash);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public Hash hashPassword(Object plaintext) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> ByteSource plaintextBytes = createByteSource(plaintext);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> if (plaintextBytes == null || plaintextBytes.isEmpty()) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return null;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> HashRequest request = createHashRequest(plaintextBytes);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return hashService.computeHash(request);<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> public boolean passwordsMatch(Object plaintext, Hash saved) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> ByteSource plaintextBytes = createByteSource(plaintext);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> if (saved == null || saved.isEmpty()) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> return plaintextBytes == null || plaintextBytes.isEmpty();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> } else {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> if (plaintextBytes == null || plaintextBytes.isEmpty()) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> return false;<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><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> HashRequest request = buildHashRequest(plaintextBytes, saved);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> Hash computed = this.hashService.computeHash(request);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> return saved.equals(computed);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> protected void checkHashFormatDurability() {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (!this.hashFormatWarned) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> HashFormat format = this.hashFormat;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> if (!(format instanceof ParsableHashFormat) && log.isWarnEnabled()) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> String msg = "The configured hashFormat instance [" + format.getClass().getName() + "] is not a " +<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> ParsableHashFormat.class.getName() + " implementation. This is " +<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> "required if you wish to support backwards compatibility for saved password checking (almost " +<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> "always desirable). Without a " + ParsableHashFormat.class.getSimpleName() + " instance, " +<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> "any hashService configuration changes will break previously hashed/saved passwords.";<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> log.warn(msg);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> this.hashFormatWarned = true;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<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> protected HashRequest createHashRequest(ByteSource plaintext) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return new HashRequest.Builder().setSource(plaintext).build();<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> protected ByteSource createByteSource(Object o) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> return ByteSource.Util.bytes(o);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public boolean passwordsMatch(Object submittedPlaintext, String saved) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> ByteSource plaintextBytes = createByteSource(submittedPlaintext);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> if (saved == null || saved.length() == 0) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return plaintextBytes == null || plaintextBytes.isEmpty();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> } else {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> if (plaintextBytes == null || plaintextBytes.isEmpty()) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> return false;<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> }<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> //First check to see if we can reconstitute the original hash - this allows us to<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> //perform password hash comparisons even for previously saved passwords that don't<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> //match the current HashService configuration values. This is a very nice feature<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> //for password comparisons because it ensures backwards compatibility even after<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> //configuration changes.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> HashFormat discoveredFormat = this.hashFormatFactory.getInstance(saved);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> if (discoveredFormat != null && discoveredFormat instanceof ParsableHashFormat) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> ParsableHashFormat parsableHashFormat = (ParsableHashFormat)discoveredFormat;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> Hash savedHash = parsableHashFormat.parse(saved);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return passwordsMatch(submittedPlaintext, savedHash);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> //If we're at this point in the method's execution, We couldn't reconstitute the original hash.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> //So, we need to hash the submittedPlaintext using current HashService configuration and then<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> //compare the formatted output with the saved string. This will correctly compare passwords,<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> //but does not allow changing the HashService configuration without breaking previously saved<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> //passwords:<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> //The saved text value can't be reconstituted into a Hash instance. We need to format the<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> //submittedPlaintext and then compare this formatted value with the saved value:<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> HashRequest request = createHashRequest(plaintextBytes);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> Hash computed = this.hashService.computeHash(request);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> String formatted = this.hashFormat.format(computed);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return saved.equals(formatted);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> protected HashRequest buildHashRequest(ByteSource plaintext, Hash saved) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> //keep everything from the saved hash except for the source:<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return new HashRequest.Builder().setSource(plaintext)<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> //now use the existing saved data:<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> .setAlgorithmName(saved.getAlgorithmName())<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> .setSalt(saved.getSalt())<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> .setIterations(saved.getIterations())<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> .build();<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public HashService getHashService() {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return hashService;<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> public void setHashService(HashService hashService) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> this.hashService = hashService;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> }<a name="line.183"></a> |
| <span class="sourceLineNo">184</span><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> public HashFormat getHashFormat() {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> return hashFormat;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> }<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> public void setHashFormat(HashFormat hashFormat) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> this.hashFormat = hashFormat;<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> public HashFormatFactory getHashFormatFactory() {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return hashFormatFactory;<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> public void setHashFormatFactory(HashFormatFactory hashFormatFactory) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> this.hashFormatFactory = hashFormatFactory;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span>}<a name="line.200"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
