| <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.authc.AuthenticationInfo;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.crypto.hash.Hash;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> /**<a name="line.25"></a> |
| <FONT color="green">026</FONT> * A {@link CredentialsMatcher} that employs best-practices comparisons for hashed text passwords.<a name="line.26"></a> |
| <FONT color="green">027</FONT> * <p/><a name="line.27"></a> |
| <FONT color="green">028</FONT> * This implementation delegates to an internal {@link PasswordService} to perform the actual password<a name="line.28"></a> |
| <FONT color="green">029</FONT> * comparison. This class is essentially a bridge between the generic CredentialsMatcher interface and the<a name="line.29"></a> |
| <FONT color="green">030</FONT> * more specific {@code PasswordService} component.<a name="line.30"></a> |
| <FONT color="green">031</FONT> *<a name="line.31"></a> |
| <FONT color="green">032</FONT> * @since 1.2<a name="line.32"></a> |
| <FONT color="green">033</FONT> */<a name="line.33"></a> |
| <FONT color="green">034</FONT> public class PasswordMatcher implements CredentialsMatcher {<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> private PasswordService passwordService;<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> public PasswordMatcher() {<a name="line.38"></a> |
| <FONT color="green">039</FONT> this.passwordService = new DefaultPasswordService();<a name="line.39"></a> |
| <FONT color="green">040</FONT> }<a name="line.40"></a> |
| <FONT color="green">041</FONT> <a name="line.41"></a> |
| <FONT color="green">042</FONT> public boolean doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info) {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> PasswordService service = ensurePasswordService();<a name="line.44"></a> |
| <FONT color="green">045</FONT> <a name="line.45"></a> |
| <FONT color="green">046</FONT> Object submittedPassword = getSubmittedPassword(token);<a name="line.46"></a> |
| <FONT color="green">047</FONT> Object storedCredentials = getStoredPassword(info);<a name="line.47"></a> |
| <FONT color="green">048</FONT> assertStoredCredentialsType(storedCredentials);<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> if (storedCredentials instanceof Hash) {<a name="line.50"></a> |
| <FONT color="green">051</FONT> Hash hashedPassword = (Hash)storedCredentials;<a name="line.51"></a> |
| <FONT color="green">052</FONT> HashingPasswordService hashingService = assertHashingPasswordService(service);<a name="line.52"></a> |
| <FONT color="green">053</FONT> return hashingService.passwordsMatch(submittedPassword, hashedPassword);<a name="line.53"></a> |
| <FONT color="green">054</FONT> }<a name="line.54"></a> |
| <FONT color="green">055</FONT> //otherwise they are a String (asserted in the 'assertStoredCredentialsType' method call above):<a name="line.55"></a> |
| <FONT color="green">056</FONT> String formatted = (String)storedCredentials;<a name="line.56"></a> |
| <FONT color="green">057</FONT> return passwordService.passwordsMatch(submittedPassword, formatted);<a name="line.57"></a> |
| <FONT color="green">058</FONT> }<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> private HashingPasswordService assertHashingPasswordService(PasswordService service) {<a name="line.60"></a> |
| <FONT color="green">061</FONT> if (service instanceof HashingPasswordService) {<a name="line.61"></a> |
| <FONT color="green">062</FONT> return (HashingPasswordService) service;<a name="line.62"></a> |
| <FONT color="green">063</FONT> }<a name="line.63"></a> |
| <FONT color="green">064</FONT> String msg = "AuthenticationInfo's stored credentials are a Hash instance, but the " +<a name="line.64"></a> |
| <FONT color="green">065</FONT> "configured passwordService is not a " +<a name="line.65"></a> |
| <FONT color="green">066</FONT> HashingPasswordService.class.getName() + " instance. This is required to perform Hash " +<a name="line.66"></a> |
| <FONT color="green">067</FONT> "object password comparisons.";<a name="line.67"></a> |
| <FONT color="green">068</FONT> throw new IllegalStateException(msg);<a name="line.68"></a> |
| <FONT color="green">069</FONT> }<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> private PasswordService ensurePasswordService() {<a name="line.71"></a> |
| <FONT color="green">072</FONT> PasswordService service = getPasswordService();<a name="line.72"></a> |
| <FONT color="green">073</FONT> if (service == null) {<a name="line.73"></a> |
| <FONT color="green">074</FONT> String msg = "Required PasswordService has not been configured.";<a name="line.74"></a> |
| <FONT color="green">075</FONT> throw new IllegalStateException(msg);<a name="line.75"></a> |
| <FONT color="green">076</FONT> }<a name="line.76"></a> |
| <FONT color="green">077</FONT> return service;<a name="line.77"></a> |
| <FONT color="green">078</FONT> }<a name="line.78"></a> |
| <FONT color="green">079</FONT> <a name="line.79"></a> |
| <FONT color="green">080</FONT> protected Object getSubmittedPassword(AuthenticationToken token) {<a name="line.80"></a> |
| <FONT color="green">081</FONT> return token != null ? token.getCredentials() : null;<a name="line.81"></a> |
| <FONT color="green">082</FONT> }<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> private void assertStoredCredentialsType(Object credentials) {<a name="line.84"></a> |
| <FONT color="green">085</FONT> if (credentials instanceof String || credentials instanceof Hash) {<a name="line.85"></a> |
| <FONT color="green">086</FONT> return;<a name="line.86"></a> |
| <FONT color="green">087</FONT> }<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> String msg = "Stored account credentials are expected to be either a " +<a name="line.89"></a> |
| <FONT color="green">090</FONT> Hash.class.getName() + " instance or a formatted hash String.";<a name="line.90"></a> |
| <FONT color="green">091</FONT> throw new IllegalArgumentException(msg);<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> protected Object getStoredPassword(AuthenticationInfo storedAccountInfo) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> Object stored = storedAccountInfo != null ? storedAccountInfo.getCredentials() : null;<a name="line.95"></a> |
| <FONT color="green">096</FONT> //fix for https://issues.apache.org/jira/browse/SHIRO-363<a name="line.96"></a> |
| <FONT color="green">097</FONT> if (stored instanceof char[]) {<a name="line.97"></a> |
| <FONT color="green">098</FONT> stored = new String((char[])stored);<a name="line.98"></a> |
| <FONT color="green">099</FONT> }<a name="line.99"></a> |
| <FONT color="green">100</FONT> return stored;<a name="line.100"></a> |
| <FONT color="green">101</FONT> }<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> public PasswordService getPasswordService() {<a name="line.103"></a> |
| <FONT color="green">104</FONT> return passwordService;<a name="line.104"></a> |
| <FONT color="green">105</FONT> }<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> public void setPasswordService(PasswordService passwordService) {<a name="line.107"></a> |
| <FONT color="green">108</FONT> this.passwordService = passwordService;<a name="line.108"></a> |
| <FONT color="green">109</FONT> }<a name="line.109"></a> |
| <FONT color="green">110</FONT> }<a name="line.110"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
