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