| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.authc.credential;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.crypto.hash.DefaultHashService;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.crypto.hash.Hash;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.crypto.hash.HashRequest;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.crypto.hash.HashService;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.crypto.hash.format.*;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.util.ByteSource;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.slf4j.Logger;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.slf4j.LoggerFactory;<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> /**<a name="line.30"></a> |
| <FONT color="green">031</FONT> * Default implementation of the {@link PasswordService} interface that relies on an internal<a name="line.31"></a> |
| <FONT color="green">032</FONT> * {@link HashService}, {@link HashFormat}, and {@link HashFormatFactory} to function:<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <h2>Hashing Passwords</h2><a name="line.33"></a> |
| <FONT color="green">034</FONT> *<a name="line.34"></a> |
| <FONT color="green">035</FONT> * <h2>Comparing Passwords</h2><a name="line.35"></a> |
| <FONT color="green">036</FONT> * All hashing operations are performed by the internal {@link #getHashService() hashService}. After the hash<a name="line.36"></a> |
| <FONT color="green">037</FONT> * is computed, it is formatted into a String value via the internal {@link #getHashFormat() hashFormat}.<a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @since 1.2<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> public class DefaultPasswordService implements HashingPasswordService {<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> public static final String DEFAULT_HASH_ALGORITHM = "SHA-256";<a name="line.43"></a> |
| <FONT color="green">044</FONT> public static final int DEFAULT_HASH_ITERATIONS = 500000; //500,000<a name="line.44"></a> |
| <FONT color="green">045</FONT> <a name="line.45"></a> |
| <FONT color="green">046</FONT> private static final Logger log = LoggerFactory.getLogger(DefaultPasswordService.class);<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> private HashService hashService;<a name="line.48"></a> |
| <FONT color="green">049</FONT> private HashFormat hashFormat;<a name="line.49"></a> |
| <FONT color="green">050</FONT> private HashFormatFactory hashFormatFactory;<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> private volatile boolean hashFormatWarned; //used to avoid excessive log noise<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> public DefaultPasswordService() {<a name="line.54"></a> |
| <FONT color="green">055</FONT> this.hashFormatWarned = false;<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> DefaultHashService hashService = new DefaultHashService();<a name="line.57"></a> |
| <FONT color="green">058</FONT> hashService.setHashAlgorithmName(DEFAULT_HASH_ALGORITHM);<a name="line.58"></a> |
| <FONT color="green">059</FONT> hashService.setHashIterations(DEFAULT_HASH_ITERATIONS);<a name="line.59"></a> |
| <FONT color="green">060</FONT> hashService.setGeneratePublicSalt(true); //always want generated salts for user passwords to be most secure<a name="line.60"></a> |
| <FONT color="green">061</FONT> this.hashService = hashService;<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> this.hashFormat = new Shiro1CryptFormat();<a name="line.63"></a> |
| <FONT color="green">064</FONT> this.hashFormatFactory = new DefaultHashFormatFactory();<a name="line.64"></a> |
| <FONT color="green">065</FONT> }<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> public String encryptPassword(Object plaintext) {<a name="line.67"></a> |
| <FONT color="green">068</FONT> Hash hash = hashPassword(plaintext);<a name="line.68"></a> |
| <FONT color="green">069</FONT> checkHashFormatDurability();<a name="line.69"></a> |
| <FONT color="green">070</FONT> return this.hashFormat.format(hash);<a name="line.70"></a> |
| <FONT color="green">071</FONT> }<a name="line.71"></a> |
| <FONT color="green">072</FONT> <a name="line.72"></a> |
| <FONT color="green">073</FONT> public Hash hashPassword(Object plaintext) {<a name="line.73"></a> |
| <FONT color="green">074</FONT> ByteSource plaintextBytes = createByteSource(plaintext);<a name="line.74"></a> |
| <FONT color="green">075</FONT> if (plaintextBytes == null || plaintextBytes.isEmpty()) {<a name="line.75"></a> |
| <FONT color="green">076</FONT> return null;<a name="line.76"></a> |
| <FONT color="green">077</FONT> }<a name="line.77"></a> |
| <FONT color="green">078</FONT> HashRequest request = createHashRequest(plaintextBytes);<a name="line.78"></a> |
| <FONT color="green">079</FONT> return hashService.computeHash(request);<a name="line.79"></a> |
| <FONT color="green">080</FONT> }<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> public boolean passwordsMatch(Object plaintext, Hash saved) {<a name="line.82"></a> |
| <FONT color="green">083</FONT> ByteSource plaintextBytes = createByteSource(plaintext);<a name="line.83"></a> |
| <FONT color="green">084</FONT> <a name="line.84"></a> |
| <FONT color="green">085</FONT> if (saved == null || saved.isEmpty()) {<a name="line.85"></a> |
| <FONT color="green">086</FONT> return plaintextBytes == null || plaintextBytes.isEmpty();<a name="line.86"></a> |
| <FONT color="green">087</FONT> } else {<a name="line.87"></a> |
| <FONT color="green">088</FONT> if (plaintextBytes == null || plaintextBytes.isEmpty()) {<a name="line.88"></a> |
| <FONT color="green">089</FONT> return false;<a name="line.89"></a> |
| <FONT color="green">090</FONT> }<a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> HashRequest request = buildHashRequest(plaintextBytes, saved);<a name="line.93"></a> |
| <FONT color="green">094</FONT> <a name="line.94"></a> |
| <FONT color="green">095</FONT> Hash computed = this.hashService.computeHash(request);<a name="line.95"></a> |
| <FONT color="green">096</FONT> <a name="line.96"></a> |
| <FONT color="green">097</FONT> return saved.equals(computed);<a name="line.97"></a> |
| <FONT color="green">098</FONT> }<a name="line.98"></a> |
| <FONT color="green">099</FONT> <a name="line.99"></a> |
| <FONT color="green">100</FONT> protected void checkHashFormatDurability() {<a name="line.100"></a> |
| <FONT color="green">101</FONT> <a name="line.101"></a> |
| <FONT color="green">102</FONT> if (!this.hashFormatWarned) {<a name="line.102"></a> |
| <FONT color="green">103</FONT> <a name="line.103"></a> |
| <FONT color="green">104</FONT> HashFormat format = this.hashFormat;<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> if (!(format instanceof ParsableHashFormat) && log.isWarnEnabled()) {<a name="line.106"></a> |
| <FONT color="green">107</FONT> String msg = "The configured hashFormat instance [" + format.getClass().getName() + "] is not a " +<a name="line.107"></a> |
| <FONT color="green">108</FONT> ParsableHashFormat.class.getName() + " implementation. This is " +<a name="line.108"></a> |
| <FONT color="green">109</FONT> "required if you wish to support backwards compatibility for saved password checking (almost " +<a name="line.109"></a> |
| <FONT color="green">110</FONT> "always desirable). Without a " + ParsableHashFormat.class.getSimpleName() + " instance, " +<a name="line.110"></a> |
| <FONT color="green">111</FONT> "any hashService configuration changes will break previously hashed/saved passwords.";<a name="line.111"></a> |
| <FONT color="green">112</FONT> log.warn(msg);<a name="line.112"></a> |
| <FONT color="green">113</FONT> this.hashFormatWarned = true;<a name="line.113"></a> |
| <FONT color="green">114</FONT> }<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> }<a name="line.116"></a> |
| <FONT color="green">117</FONT> <a name="line.117"></a> |
| <FONT color="green">118</FONT> protected HashRequest createHashRequest(ByteSource plaintext) {<a name="line.118"></a> |
| <FONT color="green">119</FONT> return new HashRequest.Builder().setSource(plaintext).build();<a name="line.119"></a> |
| <FONT color="green">120</FONT> }<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> protected ByteSource createByteSource(Object o) {<a name="line.122"></a> |
| <FONT color="green">123</FONT> return ByteSource.Util.bytes(o);<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> <a name="line.125"></a> |
| <FONT color="green">126</FONT> public boolean passwordsMatch(Object submittedPlaintext, String saved) {<a name="line.126"></a> |
| <FONT color="green">127</FONT> ByteSource plaintextBytes = createByteSource(submittedPlaintext);<a name="line.127"></a> |
| <FONT color="green">128</FONT> <a name="line.128"></a> |
| <FONT color="green">129</FONT> if (saved == null || saved.length() == 0) {<a name="line.129"></a> |
| <FONT color="green">130</FONT> return plaintextBytes == null || plaintextBytes.isEmpty();<a name="line.130"></a> |
| <FONT color="green">131</FONT> } else {<a name="line.131"></a> |
| <FONT color="green">132</FONT> if (plaintextBytes == null || plaintextBytes.isEmpty()) {<a name="line.132"></a> |
| <FONT color="green">133</FONT> return false;<a name="line.133"></a> |
| <FONT color="green">134</FONT> }<a name="line.134"></a> |
| <FONT color="green">135</FONT> }<a name="line.135"></a> |
| <FONT color="green">136</FONT> <a name="line.136"></a> |
| <FONT color="green">137</FONT> //First check to see if we can reconstitute the original hash - this allows us to<a name="line.137"></a> |
| <FONT color="green">138</FONT> //perform password hash comparisons even for previously saved passwords that don't<a name="line.138"></a> |
| <FONT color="green">139</FONT> //match the current HashService configuration values. This is a very nice feature<a name="line.139"></a> |
| <FONT color="green">140</FONT> //for password comparisons because it ensures backwards compatibility even after<a name="line.140"></a> |
| <FONT color="green">141</FONT> //configuration changes.<a name="line.141"></a> |
| <FONT color="green">142</FONT> HashFormat discoveredFormat = this.hashFormatFactory.getInstance(saved);<a name="line.142"></a> |
| <FONT color="green">143</FONT> <a name="line.143"></a> |
| <FONT color="green">144</FONT> if (discoveredFormat != null && discoveredFormat instanceof ParsableHashFormat) {<a name="line.144"></a> |
| <FONT color="green">145</FONT> <a name="line.145"></a> |
| <FONT color="green">146</FONT> ParsableHashFormat parsableHashFormat = (ParsableHashFormat)discoveredFormat;<a name="line.146"></a> |
| <FONT color="green">147</FONT> Hash savedHash = parsableHashFormat.parse(saved);<a name="line.147"></a> |
| <FONT color="green">148</FONT> <a name="line.148"></a> |
| <FONT color="green">149</FONT> return passwordsMatch(submittedPlaintext, savedHash);<a name="line.149"></a> |
| <FONT color="green">150</FONT> }<a name="line.150"></a> |
| <FONT color="green">151</FONT> <a name="line.151"></a> |
| <FONT color="green">152</FONT> //If we're at this point in the method's execution, We couldn't reconstitute the original hash.<a name="line.152"></a> |
| <FONT color="green">153</FONT> //So, we need to hash the submittedPlaintext using current HashService configuration and then<a name="line.153"></a> |
| <FONT color="green">154</FONT> //compare the formatted output with the saved string. This will correctly compare passwords,<a name="line.154"></a> |
| <FONT color="green">155</FONT> //but does not allow changing the HashService configuration without breaking previously saved<a name="line.155"></a> |
| <FONT color="green">156</FONT> //passwords:<a name="line.156"></a> |
| <FONT color="green">157</FONT> <a name="line.157"></a> |
| <FONT color="green">158</FONT> //The saved text value can't be reconstituted into a Hash instance. We need to format the<a name="line.158"></a> |
| <FONT color="green">159</FONT> //submittedPlaintext and then compare this formatted value with the saved value:<a name="line.159"></a> |
| <FONT color="green">160</FONT> HashRequest request = createHashRequest(plaintextBytes);<a name="line.160"></a> |
| <FONT color="green">161</FONT> Hash computed = this.hashService.computeHash(request);<a name="line.161"></a> |
| <FONT color="green">162</FONT> String formatted = this.hashFormat.format(computed);<a name="line.162"></a> |
| <FONT color="green">163</FONT> <a name="line.163"></a> |
| <FONT color="green">164</FONT> return saved.equals(formatted);<a name="line.164"></a> |
| <FONT color="green">165</FONT> }<a name="line.165"></a> |
| <FONT color="green">166</FONT> <a name="line.166"></a> |
| <FONT color="green">167</FONT> protected HashRequest buildHashRequest(ByteSource plaintext, Hash saved) {<a name="line.167"></a> |
| <FONT color="green">168</FONT> //keep everything from the saved hash except for the source:<a name="line.168"></a> |
| <FONT color="green">169</FONT> return new HashRequest.Builder().setSource(plaintext)<a name="line.169"></a> |
| <FONT color="green">170</FONT> //now use the existing saved data:<a name="line.170"></a> |
| <FONT color="green">171</FONT> .setAlgorithmName(saved.getAlgorithmName())<a name="line.171"></a> |
| <FONT color="green">172</FONT> .setSalt(saved.getSalt())<a name="line.172"></a> |
| <FONT color="green">173</FONT> .setIterations(saved.getIterations())<a name="line.173"></a> |
| <FONT color="green">174</FONT> .build();<a name="line.174"></a> |
| <FONT color="green">175</FONT> }<a name="line.175"></a> |
| <FONT color="green">176</FONT> <a name="line.176"></a> |
| <FONT color="green">177</FONT> public HashService getHashService() {<a name="line.177"></a> |
| <FONT color="green">178</FONT> return hashService;<a name="line.178"></a> |
| <FONT color="green">179</FONT> }<a name="line.179"></a> |
| <FONT color="green">180</FONT> <a name="line.180"></a> |
| <FONT color="green">181</FONT> public void setHashService(HashService hashService) {<a name="line.181"></a> |
| <FONT color="green">182</FONT> this.hashService = hashService;<a name="line.182"></a> |
| <FONT color="green">183</FONT> }<a name="line.183"></a> |
| <FONT color="green">184</FONT> <a name="line.184"></a> |
| <FONT color="green">185</FONT> public HashFormat getHashFormat() {<a name="line.185"></a> |
| <FONT color="green">186</FONT> return hashFormat;<a name="line.186"></a> |
| <FONT color="green">187</FONT> }<a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> public void setHashFormat(HashFormat hashFormat) {<a name="line.189"></a> |
| <FONT color="green">190</FONT> this.hashFormat = hashFormat;<a name="line.190"></a> |
| <FONT color="green">191</FONT> }<a name="line.191"></a> |
| <FONT color="green">192</FONT> <a name="line.192"></a> |
| <FONT color="green">193</FONT> public HashFormatFactory getHashFormatFactory() {<a name="line.193"></a> |
| <FONT color="green">194</FONT> return hashFormatFactory;<a name="line.194"></a> |
| <FONT color="green">195</FONT> }<a name="line.195"></a> |
| <FONT color="green">196</FONT> <a name="line.196"></a> |
| <FONT color="green">197</FONT> public void setHashFormatFactory(HashFormatFactory hashFormatFactory) {<a name="line.197"></a> |
| <FONT color="green">198</FONT> this.hashFormatFactory = hashFormatFactory;<a name="line.198"></a> |
| <FONT color="green">199</FONT> }<a name="line.199"></a> |
| <FONT color="green">200</FONT> }<a name="line.200"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
