| <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.codec.CodecSupport;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.slf4j.Logger;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.slf4j.LoggerFactory;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> import java.util.Arrays;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <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> * Simple CredentialsMatcher implementation. Supports direct (plain) comparison for credentials of type<a name="line.31"></a> |
| <FONT color="green">032</FONT> * byte[], char[], and Strings, and if the arguments do not match these types, then reverts back to simple<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <code>Object.equals</code> comparison.<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <p/><a name="line.34"></a> |
| <FONT color="green">035</FONT> * <p>Hashing comparisons (the most common technique used in secure applications) are not supported by this class, but<a name="line.35"></a> |
| <FONT color="green">036</FONT> * instead by the {@link org.apache.shiro.authc.credential.HashedCredentialsMatcher HashedCredentialsMatcher}.<a name="line.36"></a> |
| <FONT color="green">037</FONT> *<a name="line.37"></a> |
| <FONT color="green">038</FONT> * @see org.apache.shiro.authc.credential.HashedCredentialsMatcher<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @since 0.9<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> public class SimpleCredentialsMatcher extends CodecSupport implements CredentialsMatcher {<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> private static final Logger log = LoggerFactory.getLogger(SimpleCredentialsMatcher.class);<a name="line.43"></a> |
| <FONT color="green">044</FONT> <a name="line.44"></a> |
| <FONT color="green">045</FONT> /**<a name="line.45"></a> |
| <FONT color="green">046</FONT> * Returns the {@code token}'s credentials.<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <p/><a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p>This default implementation merely returns<a name="line.48"></a> |
| <FONT color="green">049</FONT> * {@link AuthenticationToken#getCredentials() authenticationToken.getCredentials()} and exists as a template hook<a name="line.49"></a> |
| <FONT color="green">050</FONT> * if subclasses wish to obtain the credentials in a different way or convert them to a different format before<a name="line.50"></a> |
| <FONT color="green">051</FONT> * returning.<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @param token the {@code AuthenticationToken} submitted during the authentication attempt.<a name="line.53"></a> |
| <FONT color="green">054</FONT> * @return the {@code token}'s associated credentials.<a name="line.54"></a> |
| <FONT color="green">055</FONT> */<a name="line.55"></a> |
| <FONT color="green">056</FONT> protected Object getCredentials(AuthenticationToken token) {<a name="line.56"></a> |
| <FONT color="green">057</FONT> return token.getCredentials();<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> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * Returns the {@code account}'s credentials.<a name="line.61"></a> |
| <FONT color="green">062</FONT> * <p/><a name="line.62"></a> |
| <FONT color="green">063</FONT> * <p>This default implementation merely returns<a name="line.63"></a> |
| <FONT color="green">064</FONT> * {@link AuthenticationInfo#getCredentials() account.getCredentials()} and exists as a template hook if subclasses<a name="line.64"></a> |
| <FONT color="green">065</FONT> * wish to obtain the credentials in a different way or convert them to a different format before<a name="line.65"></a> |
| <FONT color="green">066</FONT> * returning.<a name="line.66"></a> |
| <FONT color="green">067</FONT> *<a name="line.67"></a> |
| <FONT color="green">068</FONT> * @param info the {@code AuthenticationInfo} stored in the data store to be compared against the submitted authentication<a name="line.68"></a> |
| <FONT color="green">069</FONT> * token's credentials.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @return the {@code account}'s associated credentials.<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> protected Object getCredentials(AuthenticationInfo info) {<a name="line.72"></a> |
| <FONT color="green">073</FONT> return info.getCredentials();<a name="line.73"></a> |
| <FONT color="green">074</FONT> }<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> /**<a name="line.76"></a> |
| <FONT color="green">077</FONT> * Returns {@code true} if the {@code tokenCredentials} argument is logically equal to the<a name="line.77"></a> |
| <FONT color="green">078</FONT> * {@code accountCredentials} argument.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * <p/><a name="line.79"></a> |
| <FONT color="green">080</FONT> * <p>If both arguments are either a byte array (byte[]), char array (char[]) or String, they will be both be<a name="line.80"></a> |
| <FONT color="green">081</FONT> * converted to raw byte arrays via the {@link #toBytes toBytes} method first, and then resulting byte arrays<a name="line.81"></a> |
| <FONT color="green">082</FONT> * are compared via {@link Arrays#equals(byte[], byte[]) Arrays.equals(byte[],byte[])}.</p><a name="line.82"></a> |
| <FONT color="green">083</FONT> * <p/><a name="line.83"></a> |
| <FONT color="green">084</FONT> * <p>If either argument cannot be converted to a byte array as described, a simple Object <code>equals</code><a name="line.84"></a> |
| <FONT color="green">085</FONT> * comparison is made.</p><a name="line.85"></a> |
| <FONT color="green">086</FONT> * <p/><a name="line.86"></a> |
| <FONT color="green">087</FONT> * <p>Subclasses should override this method for more explicit equality checks.<a name="line.87"></a> |
| <FONT color="green">088</FONT> *<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @param tokenCredentials the {@code AuthenticationToken}'s associated credentials.<a name="line.89"></a> |
| <FONT color="green">090</FONT> * @param accountCredentials the {@code AuthenticationInfo}'s stored credentials.<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @return {@code true} if the {@code tokenCredentials} are equal to the {@code accountCredentials}.<a name="line.91"></a> |
| <FONT color="green">092</FONT> */<a name="line.92"></a> |
| <FONT color="green">093</FONT> protected boolean equals(Object tokenCredentials, Object accountCredentials) {<a name="line.93"></a> |
| <FONT color="green">094</FONT> if (log.isDebugEnabled()) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> log.debug("Performing credentials equality check for tokenCredentials of type [" +<a name="line.95"></a> |
| <FONT color="green">096</FONT> tokenCredentials.getClass().getName() + " and accountCredentials of type [" +<a name="line.96"></a> |
| <FONT color="green">097</FONT> accountCredentials.getClass().getName() + "]");<a name="line.97"></a> |
| <FONT color="green">098</FONT> }<a name="line.98"></a> |
| <FONT color="green">099</FONT> if (isByteSource(tokenCredentials) && isByteSource(accountCredentials)) {<a name="line.99"></a> |
| <FONT color="green">100</FONT> if (log.isDebugEnabled()) {<a name="line.100"></a> |
| <FONT color="green">101</FONT> log.debug("Both credentials arguments can be easily converted to byte arrays. Performing " +<a name="line.101"></a> |
| <FONT color="green">102</FONT> "array equals comparison");<a name="line.102"></a> |
| <FONT color="green">103</FONT> }<a name="line.103"></a> |
| <FONT color="green">104</FONT> byte[] tokenBytes = toBytes(tokenCredentials);<a name="line.104"></a> |
| <FONT color="green">105</FONT> byte[] accountBytes = toBytes(accountCredentials);<a name="line.105"></a> |
| <FONT color="green">106</FONT> return Arrays.equals(tokenBytes, accountBytes);<a name="line.106"></a> |
| <FONT color="green">107</FONT> } else {<a name="line.107"></a> |
| <FONT color="green">108</FONT> return accountCredentials.equals(tokenCredentials);<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> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> /**<a name="line.112"></a> |
| <FONT color="green">113</FONT> * This implementation acquires the {@code token}'s credentials<a name="line.113"></a> |
| <FONT color="green">114</FONT> * (via {@link #getCredentials(AuthenticationToken) getCredentials(token)})<a name="line.114"></a> |
| <FONT color="green">115</FONT> * and then the {@code account}'s credentials<a name="line.115"></a> |
| <FONT color="green">116</FONT> * (via {@link #getCredentials(org.apache.shiro.authc.AuthenticationInfo) getCredentials(account)}) and then passes both of<a name="line.116"></a> |
| <FONT color="green">117</FONT> * them to the {@link #equals(Object,Object) equals(tokenCredentials, accountCredentials)} method for equality<a name="line.117"></a> |
| <FONT color="green">118</FONT> * comparison.<a name="line.118"></a> |
| <FONT color="green">119</FONT> *<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @param token the {@code AuthenticationToken} submitted during the authentication attempt.<a name="line.120"></a> |
| <FONT color="green">121</FONT> * @param info the {@code AuthenticationInfo} stored in the system matching the token principal.<a name="line.121"></a> |
| <FONT color="green">122</FONT> * @return {@code true} if the provided token credentials are equal to the stored account credentials,<a name="line.122"></a> |
| <FONT color="green">123</FONT> * {@code false} otherwise<a name="line.123"></a> |
| <FONT color="green">124</FONT> */<a name="line.124"></a> |
| <FONT color="green">125</FONT> public boolean doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info) {<a name="line.125"></a> |
| <FONT color="green">126</FONT> Object tokenCredentials = getCredentials(token);<a name="line.126"></a> |
| <FONT color="green">127</FONT> Object accountCredentials = getCredentials(info);<a name="line.127"></a> |
| <FONT color="green">128</FONT> return equals(tokenCredentials, accountCredentials);<a name="line.128"></a> |
| <FONT color="green">129</FONT> }<a name="line.129"></a> |
| <FONT color="green">130</FONT> <a name="line.130"></a> |
| <FONT color="green">131</FONT> }<a name="line.131"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
