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