| <!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.realm;<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.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.authc.credential.AllowAllCredentialsMatcher;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.authc.credential.CredentialsMatcher;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.authc.credential.SimpleCredentialsMatcher;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.cache.Cache;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.cache.CacheManager;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.util.CollectionUtils;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.shiro.util.Initializable;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.slf4j.Logger;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.slf4j.LoggerFactory;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * A top-level abstract implementation of the <tt>Realm</tt> interface that only implements authentication support<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * (log-in) operations and leaves authorization (access control) behavior to subclasses.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <h2>Authentication Caching</h2><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * For applications that perform frequent repeated authentication of the same accounts (e.g. as is often done in<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * REST or Soap applications that authenticate on every request), it might be prudent to enable authentication<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * caching to alleviate constant load on any back-end data sources.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p/><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * This feature is disabled by default to retain backwards-compatibility with Shiro 1.1 and earlier. It may be<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * enabled by setting {@link #setAuthenticationCachingEnabled(boolean) authenticationCachingEnabled} = {@code true}<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * (and configuring Shiro with a {@link CacheManager} of course), but <b>NOTE:</b><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p/><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <b>ONLY enable authentication caching if either of the following is true for your realm implementation:</b><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <ul><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <li>The {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) doGetAuthenticationInfo}<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * implementation returns {@code AuthenticationInfo} instances where the<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * {@link org.apache.shiro.authc.AuthenticationInfo#getCredentials() credentials} are securely obfuscated and NOT<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * plaintext (raw) credentials. For example,<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * if your realm references accounts with passwords, that the {@code AuthenticationInfo}'s<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * {@link org.apache.shiro.authc.AuthenticationInfo#getCredentials() credentials} are safely hashed and salted or otherwise<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * fully encrypted.<br/><br/></li><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <li>The {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) doGetAuthenticationInfo}<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * implementation returns {@code AuthenticationInfo} instances where the<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * {@link org.apache.shiro.authc.AuthenticationInfo#getCredentials() credentials} are plaintext (raw) <b>AND</b> the<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * cache region storing the {@code AuthenticationInfo} instances WILL NOT overflow to disk and WILL NOT transmit cache<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * entries over an unprotected (non TLS/SSL) network (as might be the case with a networked/distributed enterprise cache).<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * This should be the case even in private/trusted/corporate networks.</li><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * </ul><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <p/><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * These points are very important because if authentication caching is enabled, this abstract class implementation<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * will place AuthenticationInfo instances returned from the subclass implementations directly into the cache, for<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * example:<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <pre><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * cache.put(cacheKey, subclassAuthenticationInfoInstance);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * </pre><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <p/><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * Enabling authentication caching is ONLY safe to do if the above two scenarios apply. It is NOT safe to enable under<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * any other scenario.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * <p/><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * When possible, always represent and store credentials in a safe form (hash+salt or encrypted) to eliminate plaintext<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * visibility.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * <h3>Authentication Cache Invalidation on Logout</h3><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * If authentication caching is enabled, this implementation will attempt to evict (remove) cached authentication data<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * for an account during logout. This can only occur if the<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)} and<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)} methods return the exact same value.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <p/><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * The default implementations of these methods expect that the<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * {@link org.apache.shiro.authc.AuthenticationToken#getPrincipal()} (what the user submits during login) and<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * {@link #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection) getAvailablePrincipal} (what is returned<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * by the realm after account lookup) return<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * the same exact value. For example, the user submitted username is also the primary account identifier.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <p/><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * However, if your application uses, say, a username for end-user login, but returns a primary key ID as the<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * primary principal after authentication, then you will need to override either<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken) getAuthenticationCacheKey(token)} or<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection) getAuthenticationCacheKey(principals)}<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * (or both) to ensure that the same cache key can be used for either object.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <p/><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * This guarantees that the same cache key used to cache the data during authentication (derived from the<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * {@code AuthenticationToken}) will be used to remove the cached data during logout (derived from the<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * {@code PrincipalCollection}).<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * <h4>Unmatching Cache Key Values</h4><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * If the return values from {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)} and<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)} are not identical, cached<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * authentication data removal is at the mercy of your cache provider settings. For example, often cache<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * implementations will evict cache entries based on a timeToIdle or timeToLive (TTL) value.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <p/><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * If this lazy eviction capability of the cache product is not sufficient and you want discrete behavior<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * (highly recommended for authentication data), ensure that the return values from those two methods are identical in<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * the subclass implementation.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @since 0.2<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span>public abstract class AuthenticatingRealm extends CachingRealm implements Initializable {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> //TODO - complete JavaDoc<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> private static final Logger log = LoggerFactory.getLogger(AuthenticatingRealm.class);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> private static final AtomicInteger INSTANCE_COUNT = new AtomicInteger();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * The default suffix appended to the realm name used for caching authentication data.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> *<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @since 1.2<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> private static final String DEFAULT_AUTHORIZATION_CACHE_SUFFIX = ".authenticationCache";<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Credentials matcher used to determine if the provided credentials match the credentials stored in the data store.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> private CredentialsMatcher credentialsMatcher;<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> private Cache<Object, AuthenticationInfo> authenticationCache;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> private boolean authenticationCachingEnabled;<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> private String authenticationCacheName;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> /**<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * The class that this realm supports for authentication tokens. This is used by the<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * default implementation of the {@link Realm#supports(org.apache.shiro.authc.AuthenticationToken)} method to<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * determine whether or not the given authentication token is supported by this realm.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> private Class<? extends AuthenticationToken> authenticationTokenClass;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /*-------------------------------------------<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> | C O N S T R U C T O R S |<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> ============================================*/<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> public AuthenticatingRealm() {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> this(null, new SimpleCredentialsMatcher());<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> public AuthenticatingRealm(CacheManager cacheManager) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> this(cacheManager, new SimpleCredentialsMatcher());<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public AuthenticatingRealm(CredentialsMatcher matcher) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> this(null, matcher);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public AuthenticatingRealm(CacheManager cacheManager, CredentialsMatcher matcher) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> authenticationTokenClass = UsernamePasswordToken.class;<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> //retain backwards compatibility for Shiro 1.1 and earlier. Setting to true by default will probably cause<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> //unexpected results for existing applications:<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> this.authenticationCachingEnabled = false;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> int instanceNumber = INSTANCE_COUNT.getAndIncrement();<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> this.authenticationCacheName = getClass().getName() + DEFAULT_AUTHORIZATION_CACHE_SUFFIX;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> if (instanceNumber > 0) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> this.authenticationCacheName = this.authenticationCacheName + "." + instanceNumber;<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> if (cacheManager != null) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> setCacheManager(cacheManager);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (matcher != null) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> setCredentialsMatcher(matcher);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> /*--------------------------------------------<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> | A C C E S S O R S / M O D I F I E R S |<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> ============================================*/<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> /**<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * Returns the <code>CredentialsMatcher</code> used during an authentication attempt to verify submitted<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * credentials with those stored in the system.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <p/><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * <p>Unless overridden by the {@link #setCredentialsMatcher setCredentialsMatcher} method, the default<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * value is a {@link org.apache.shiro.authc.credential.SimpleCredentialsMatcher SimpleCredentialsMatcher} instance.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> *<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @return the <code>CredentialsMatcher</code> used during an authentication attempt to verify submitted<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * credentials with those stored in the system.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> */<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> public CredentialsMatcher getCredentialsMatcher() {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return credentialsMatcher;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> /**<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * Sets the CrendialsMatcher used during an authentication attempt to verify submitted credentials with those<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * stored in the system. The implementation of this matcher can be switched via configuration to<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * support any number of schemes, including plain text comparisons, hashing comparisons, and others.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * <p/><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * <p>Unless overridden by this method, the default value is a<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * {@link org.apache.shiro.authc.credential.SimpleCredentialsMatcher} instance.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> *<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * @param credentialsMatcher the matcher to use.<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> */<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> public void setCredentialsMatcher(CredentialsMatcher credentialsMatcher) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> this.credentialsMatcher = credentialsMatcher;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> /**<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * Returns the authenticationToken class supported by this realm.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * <p/><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * <p>The default value is <tt>{@link org.apache.shiro.authc.UsernamePasswordToken UsernamePasswordToken.class}</tt>, since<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * about 90% of realms use username/password authentication, regardless of their protocol (e.g. over jdbc, ldap,<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * kerberos, http, etc).<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * <p/><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * <p>If subclasses haven't already overridden the {@link Realm#supports Realm.supports(AuthenticationToken)} method,<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * they must {@link #setAuthenticationTokenClass(Class) set a new class} if they won't support<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * <tt>UsernamePasswordToken</tt> authentication token submissions.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> *<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @return the authenticationToken class supported by this realm.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @see #setAuthenticationTokenClass<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> */<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> public Class getAuthenticationTokenClass() {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> return authenticationTokenClass;<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> /**<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Sets the authenticationToken class supported by this realm.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * <p/><a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * <p>Unless overridden by this method, the default value is<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * {@link org.apache.shiro.authc.UsernamePasswordToken UsernamePasswordToken.class} to support the majority of applications.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> *<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @param authenticationTokenClass the class of authentication token instances supported by this realm.<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @see #getAuthenticationTokenClass getAuthenticationTokenClass() for more explanation.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> */<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> public void setAuthenticationTokenClass(Class<? extends AuthenticationToken> authenticationTokenClass) {<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> this.authenticationTokenClass = authenticationTokenClass;<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> }<a name="line.240"></a> |
| <span class="sourceLineNo">241</span><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> /**<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * Sets an explicit {@link Cache} instance to use for authentication caching. If not set and authentication<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * caching is {@link #isAuthenticationCachingEnabled() enabled}, any available<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * {@link #getCacheManager() cacheManager} will be used to acquire the cache instance if available.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * <p/><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * <b>WARNING:</b> Only set this property if safe caching conditions apply, as documented at the top<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * of this page in the class-level JavaDoc.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> *<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @param authenticationCache an explicit {@link Cache} instance to use for authentication caching or<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * {@code null} if the cache should possibly be obtained another way.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * @see #isAuthenticationCachingEnabled()<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * @since 1.2<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> */<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> public void setAuthenticationCache(Cache<Object, AuthenticationInfo> authenticationCache) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> this.authenticationCache = authenticationCache;<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> /**<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * Returns a {@link Cache} instance to use for authentication caching, or {@code null} if no cache has been<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * set.<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> *<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * @return a {@link Cache} instance to use for authentication caching, or {@code null} if no cache has been<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * set.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @see #setAuthenticationCache(org.apache.shiro.cache.Cache)<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @see #isAuthenticationCachingEnabled()<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @since 1.2<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> */<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> public Cache<Object, AuthenticationInfo> getAuthenticationCache() {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> return this.authenticationCache;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> /**<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * Returns the name of a {@link Cache} to lookup from any available {@link #getCacheManager() cacheManager} if<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * a cache is not explicitly configured via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * <p/><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * This name will only be used to look up a cache if authentication caching is<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * {@link #isAuthenticationCachingEnabled() enabled}.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * <p/><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * <b>WARNING:</b> Only set this property if safe caching conditions apply, as documented at the top<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * of this page in the class-level JavaDoc.<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> *<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @return the name of a {@link Cache} to lookup from any available {@link #getCacheManager() cacheManager} if<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * a cache is not explicitly configured via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * @see #isAuthenticationCachingEnabled()<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @since 1.2<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> */<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> public String getAuthenticationCacheName() {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> return this.authenticationCacheName;<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span><a name="line.291"></a> |
| <span class="sourceLineNo">292</span> /**<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * Sets the name of a {@link Cache} to lookup from any available {@link #getCacheManager() cacheManager} if<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * a cache is not explicitly configured via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * <p/><a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * This name will only be used to look up a cache if authentication caching is<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * {@link #isAuthenticationCachingEnabled() enabled}.<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> *<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @param authenticationCacheName the name of a {@link Cache} to lookup from any available<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * {@link #getCacheManager() cacheManager} if a cache is not explicitly configured<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * @see #isAuthenticationCachingEnabled()<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * @since 1.2<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> */<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> public void setAuthenticationCacheName(String authenticationCacheName) {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> this.authenticationCacheName = authenticationCacheName;<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> /**<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * Returns {@code true} if authentication caching should be utilized if a {@link CacheManager} has been<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * <p/><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * The default value is {@code true}.<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> *<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * @return {@code true} if authentication caching should be utilized, {@code false} otherwise.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> */<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> public boolean isAuthenticationCachingEnabled() {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> return this.authenticationCachingEnabled && isCachingEnabled();<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> }<a name="line.319"></a> |
| <span class="sourceLineNo">320</span><a name="line.320"></a> |
| <span class="sourceLineNo">321</span> /**<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * Sets whether or not authentication caching should be utilized if a {@link CacheManager} has been<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * <p/><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * The default value is {@code false} to retain backwards compatibility with Shiro 1.1 and earlier.<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * <p/><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * <b>WARNING:</b> Only set this property to {@code true} if safe caching conditions apply, as documented at the top<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * of this page in the class-level JavaDoc.<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> *<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * @param authenticationCachingEnabled the value to set<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> */<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> public void setAuthenticationCachingEnabled(boolean authenticationCachingEnabled) {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> this.authenticationCachingEnabled = authenticationCachingEnabled;<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> if (authenticationCachingEnabled) {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> setCachingEnabled(true);<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public void setName(String name) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> super.setName(name);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> String authcCacheName = this.authenticationCacheName;<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> if (authcCacheName != null && authcCacheName.startsWith(getClass().getName())) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> //get rid of the default heuristically-created cache name. Create a more meaningful one<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> //based on the application-unique Realm name:<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> this.authenticationCacheName = name + DEFAULT_AUTHORIZATION_CACHE_SUFFIX;<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span><a name="line.350"></a> |
| <span class="sourceLineNo">351</span> /*--------------------------------------------<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> | M E T H O D S |<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> ============================================*/<a name="line.353"></a> |
| <span class="sourceLineNo">354</span><a name="line.354"></a> |
| <span class="sourceLineNo">355</span> /**<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * Convenience implementation that returns<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * <tt>getAuthenticationTokenClass().isAssignableFrom( token.getClass() );</tt>. Can be overridden<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * by subclasses for more complex token checking.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * <p>Most configurations will only need to set a different class via<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * {@link #setAuthenticationTokenClass}, as opposed to overriding this method.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> *<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @param token the token being submitted for authentication.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * @return true if this authentication realm can process the submitted token instance of the class, false otherwise.<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> */<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> public boolean supports(AuthenticationToken token) {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> return token != null && getAuthenticationTokenClass().isAssignableFrom(token.getClass());<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span><a name="line.368"></a> |
| <span class="sourceLineNo">369</span> /**<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * Initializes this realm and potentially enables an authentication cache, depending on configuration. Based on<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * the availability of an authentication cache, this class functions as follows:<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * <ol><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * <li>If the {@link #setAuthenticationCache cache} property has been set, it will be<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * used to cache the AuthenticationInfo objects returned from {@link #getAuthenticationInfo}<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * method invocations.<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * All future calls to {@link #getAuthenticationInfo} will attempt to use this cache first<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * to alleviate any potentially unnecessary calls to an underlying data store.</li><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * <li>If the {@link #setAuthenticationCache cache} property has <b>not</b> been set,<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * the {@link #setCacheManager cacheManager} property will be checked.<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * If a {@code cacheManager} has been set, it will be used to eagerly acquire an authentication<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * {@code cache}, and this cache which will be used as specified in #1.</li><a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * <li>If neither the {@link #setAuthenticationCache (org.apache.shiro.cache.Cache) authenticationCache}<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * or {@link #setCacheManager(org.apache.shiro.cache.CacheManager) cacheManager}<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * properties are set, caching will not be utilized and authentication look-ups will be delegated to<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * subclass implementations for each authentication attempt.</li><a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * </ol><a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * <p/><a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * This method finishes by calling {@link #onInit()} is to allow subclasses to perform any init behavior desired.<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> *<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * @since 1.2<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> */<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> public final void init() {<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> //trigger obtaining the authorization cache if possible<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> getAvailableAuthenticationCache();<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> onInit();<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> }<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> /**<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * Template method for subclasses to implement any initialization logic. Called from<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * {@link #init()}.<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> *<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * @since 1.2<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> */<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> protected void onInit() {<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> /**<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * This implementation attempts to acquire an authentication cache if one is not already configured.<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> *<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @since 1.2<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> */<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> protected void afterCacheManagerSet() {<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> //trigger obtaining the authorization cache if possible<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> getAvailableAuthenticationCache();<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span><a name="line.416"></a> |
| <span class="sourceLineNo">417</span> /**<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * Returns any available {@link Cache} instance to use for authentication caching. This functions as follows:<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * <ol><a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * <li>If an {@link #setAuthenticationCache(org.apache.shiro.cache.Cache) authenticationCache} has been explicitly<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * configured (it is not null), it is returned.</li><a name="line.421"></a> |
| <span class="sourceLineNo">422</span> * <li>If there is no {@link #getAuthenticationCache() authenticationCache} configured:<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> * <ol><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * <li>If authentication caching is {@link #isAuthenticationCachingEnabled() enabled}, any available<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * {@link #getCacheManager() cacheManager} will be consulted to obtain an available authentication cache.<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * </li><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * <li>If authentication caching is disabled, this implementation does nothing.</li><a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * </ol><a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * </li><a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * </ol><a name="line.430"></a> |
| <span class="sourceLineNo">431</span> *<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * @return any available {@link Cache} instance to use for authentication caching.<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> */<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> private Cache<Object, AuthenticationInfo> getAvailableAuthenticationCache() {<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> Cache<Object, AuthenticationInfo> cache = getAuthenticationCache();<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> boolean authcCachingEnabled = isAuthenticationCachingEnabled();<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> if (cache == null && authcCachingEnabled) {<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> cache = getAuthenticationCacheLazy();<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> }<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> return cache;<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> }<a name="line.441"></a> |
| <span class="sourceLineNo">442</span><a name="line.442"></a> |
| <span class="sourceLineNo">443</span> /**<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * Checks to see if the authenticationCache class attribute is null, and if so, attempts to acquire one from<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * any configured {@link #getCacheManager() cacheManager}. If one is acquired, it is set as the class attribute.<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * The class attribute is then returned.<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> *<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * @return an available cache instance to be used for authentication caching or {@code null} if one is not available.<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * @since 1.2<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> */<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> private Cache<Object, AuthenticationInfo> getAuthenticationCacheLazy() {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span><a name="line.452"></a> |
| <span class="sourceLineNo">453</span> if (this.authenticationCache == null) {<a name="line.453"></a> |
| <span class="sourceLineNo">454</span><a name="line.454"></a> |
| <span class="sourceLineNo">455</span> log.trace("No authenticationCache instance set. Checking for a cacheManager...");<a name="line.455"></a> |
| <span class="sourceLineNo">456</span><a name="line.456"></a> |
| <span class="sourceLineNo">457</span> CacheManager cacheManager = getCacheManager();<a name="line.457"></a> |
| <span class="sourceLineNo">458</span><a name="line.458"></a> |
| <span class="sourceLineNo">459</span> if (cacheManager != null) {<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> String cacheName = getAuthenticationCacheName();<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> log.debug("CacheManager [{}] configured. Building authentication cache '{}'", cacheManager, cacheName);<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> this.authenticationCache = cacheManager.getCache(cacheName);<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> }<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> }<a name="line.464"></a> |
| <span class="sourceLineNo">465</span><a name="line.465"></a> |
| <span class="sourceLineNo">466</span> return this.authenticationCache;<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> }<a name="line.467"></a> |
| <span class="sourceLineNo">468</span><a name="line.468"></a> |
| <span class="sourceLineNo">469</span> /**<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> * Returns any cached AuthenticationInfo corresponding to the specified token or {@code null} if there currently<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> * isn't any cached data.<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> *<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * @param token the token submitted during the authentication attempt.<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * @return any cached AuthenticationInfo corresponding to the specified token or {@code null} if there currently<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * isn't any cached data.<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * @since 1.2<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> */<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> private AuthenticationInfo getCachedAuthenticationInfo(AuthenticationToken token) {<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> AuthenticationInfo info = null;<a name="line.479"></a> |
| <span class="sourceLineNo">480</span><a name="line.480"></a> |
| <span class="sourceLineNo">481</span> Cache<Object, AuthenticationInfo> cache = getAvailableAuthenticationCache();<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> if (cache != null && token != null) {<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> log.trace("Attempting to retrieve the AuthenticationInfo from cache.");<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> Object key = getAuthenticationCacheKey(token);<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> info = cache.get(key);<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> if (info == null) {<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> log.trace("No AuthorizationInfo found in cache for key [{}]", key);<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> } else {<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> log.trace("Found cached AuthorizationInfo for key [{}]", key);<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> }<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> }<a name="line.491"></a> |
| <span class="sourceLineNo">492</span><a name="line.492"></a> |
| <span class="sourceLineNo">493</span> return info;<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> }<a name="line.494"></a> |
| <span class="sourceLineNo">495</span><a name="line.495"></a> |
| <span class="sourceLineNo">496</span> /**<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * Caches the specified info if authentication caching<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * {@link #isAuthenticationCachingEnabled(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) isEnabled}<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * for the specific token/info pair and a cache instance is available to be used.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> *<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * @param token the authentication token submitted which resulted in a successful authentication attempt.<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * @param info the AuthenticationInfo to cache as a result of the successful authentication attempt.<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * @since 1.2<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> */<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> private void cacheAuthenticationInfoIfPossible(AuthenticationToken token, AuthenticationInfo info) {<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> if (!isAuthenticationCachingEnabled(token, info)) {<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> log.debug("AuthenticationInfo caching is disabled for info [{}]. Submitted token: [{}].", info, token);<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> //return quietly, caching is disabled for this token/info pair:<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> return;<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> }<a name="line.510"></a> |
| <span class="sourceLineNo">511</span><a name="line.511"></a> |
| <span class="sourceLineNo">512</span> Cache<Object, AuthenticationInfo> cache = getAvailableAuthenticationCache();<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> if (cache != null) {<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> Object key = getAuthenticationCacheKey(token);<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> cache.put(key, info);<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> log.trace("Cached AuthenticationInfo for continued authentication. key=[{}], value=[{}].", key, info);<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> }<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> }<a name="line.518"></a> |
| <span class="sourceLineNo">519</span><a name="line.519"></a> |
| <span class="sourceLineNo">520</span> /**<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * Returns {@code true} if authentication caching should be utilized based on the specified<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * {@link AuthenticationToken} and/or {@link AuthenticationInfo}, {@code false} otherwise.<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> * <p/><a name="line.523"></a> |
| <span class="sourceLineNo">524</span> * The default implementation simply delegates to {@link #isAuthenticationCachingEnabled()}, the general-case<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * authentication caching setting. Subclasses can override this to turn on or off caching at runtime<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> * based on the specific submitted runtime values.<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> *<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> * @param token the submitted authentication token<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * @param info the {@code AuthenticationInfo} acquired from data source lookup via<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> * {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)}<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * @return {@code true} if authentication caching should be utilized based on the specified<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * {@link AuthenticationToken} and/or {@link AuthenticationInfo}, {@code false} otherwise.<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * @since 1.2<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> */<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> protected boolean isAuthenticationCachingEnabled(AuthenticationToken token, AuthenticationInfo info) {<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> return isAuthenticationCachingEnabled();<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> }<a name="line.537"></a> |
| <span class="sourceLineNo">538</span><a name="line.538"></a> |
| <span class="sourceLineNo">539</span> /**<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * This implementation functions as follows:<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> * <ol><a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * <li>It attempts to acquire any cached {@link AuthenticationInfo} corresponding to the specified<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> * {@link AuthenticationToken} argument. If a cached value is found, it will be used for credentials matching,<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * alleviating the need to perform any lookups with a data source.</li><a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * <li>If there is no cached {@link AuthenticationInfo} found, delegate to the<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> * {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} method to perform the actual<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * lookup. If authentication caching is enabled and possible, any returned info object will be<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> * {@link #cacheAuthenticationInfoIfPossible(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) cached}<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * to be used in future authentication attempts.</li><a name="line.549"></a> |
| <span class="sourceLineNo">550</span> * <li>If an AuthenticationInfo instance is not found in the cache or by lookup, {@code null} is returned to<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> * indicate an account cannot be found.</li><a name="line.551"></a> |
| <span class="sourceLineNo">552</span> * <li>If an AuthenticationInfo instance is found (either cached or via lookup), ensure the submitted<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> * AuthenticationToken's credentials match the expected {@code AuthenticationInfo}'s credentials using the<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> * {@link #getCredentialsMatcher() credentialsMatcher}. This means that credentials are always verified<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> * for an authentication attempt.</li><a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * </ol><a name="line.556"></a> |
| <span class="sourceLineNo">557</span> *<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * @param token the submitted account principal and credentials.<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> * @return the AuthenticationInfo corresponding to the given {@code token}, or {@code null} if no<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * AuthenticationInfo could be found.<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> * @throws AuthenticationException if authentication failed.<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> */<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> public final AuthenticationInfo getAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {<a name="line.563"></a> |
| <span class="sourceLineNo">564</span><a name="line.564"></a> |
| <span class="sourceLineNo">565</span> AuthenticationInfo info = getCachedAuthenticationInfo(token);<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> if (info == null) {<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> //otherwise not cached, perform the lookup:<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> info = doGetAuthenticationInfo(token);<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> log.debug("Looked up AuthenticationInfo [{}] from doGetAuthenticationInfo", info);<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> if (token != null && info != null) {<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> cacheAuthenticationInfoIfPossible(token, info);<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> }<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> } else {<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> log.debug("Using cached authentication info [{}] to perform credentials matching.", info);<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> }<a name="line.575"></a> |
| <span class="sourceLineNo">576</span><a name="line.576"></a> |
| <span class="sourceLineNo">577</span> if (info != null) {<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> assertCredentialsMatch(token, info);<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> } else {<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> log.debug("No AuthenticationInfo found for submitted AuthenticationToken [{}]. Returning null.", token);<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> }<a name="line.581"></a> |
| <span class="sourceLineNo">582</span><a name="line.582"></a> |
| <span class="sourceLineNo">583</span> return info;<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> }<a name="line.584"></a> |
| <span class="sourceLineNo">585</span><a name="line.585"></a> |
| <span class="sourceLineNo">586</span> /**<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * Asserts that the submitted {@code AuthenticationToken}'s credentials match the stored account<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * {@code AuthenticationInfo}'s credentials, and if not, throws an {@link AuthenticationException}.<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> *<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * @param token the submitted authentication token<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * @param info the AuthenticationInfo corresponding to the given {@code token}<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> * @throws AuthenticationException if the token's credentials do not match the stored account credentials.<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> */<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> protected void assertCredentialsMatch(AuthenticationToken token, AuthenticationInfo info) throws AuthenticationException {<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> CredentialsMatcher cm = getCredentialsMatcher();<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> if (cm != null) {<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> if (!cm.doCredentialsMatch(token, info)) {<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> //not successful - throw an exception to indicate this:<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> String msg = "Submitted credentials for token [" + token + "] did not match the expected credentials.";<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> throw new IncorrectCredentialsException(msg);<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> }<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> } else {<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> throw new AuthenticationException("A CredentialsMatcher must be configured in order to verify " +<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> "credentials during authentication. If you do not wish for credentials to be examined, you " +<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> "can configure an " + AllowAllCredentialsMatcher.class.getName() + " instance.");<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> }<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> }<a name="line.607"></a> |
| <span class="sourceLineNo">608</span><a name="line.608"></a> |
| <span class="sourceLineNo">609</span> /**<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> * Returns the key under which {@link AuthenticationInfo} instances are cached if authentication caching is enabled.<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> * This implementation defaults to returning the token's<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> * {@link org.apache.shiro.authc.AuthenticationToken#getPrincipal() principal}, which is usually a username in<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> * most applications.<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * <h3>Cache Invalidation on Logout</h3><a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * <b>NOTE:</b> If you want to be able to invalidate an account's cached {@code AuthenticationInfo} on logout, you<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> * must ensure the {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)} method returns<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> * the same value as this method.<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> *<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> * @param token the authentication token for which any successful authentication will be cached.<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> * @return the cache key to use to cache the associated {@link AuthenticationInfo} after a successful authentication.<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> * @since 1.2<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> */<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> protected Object getAuthenticationCacheKey(AuthenticationToken token) {<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> return token != null ? token.getPrincipal() : null;<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> }<a name="line.625"></a> |
| <span class="sourceLineNo">626</span><a name="line.626"></a> |
| <span class="sourceLineNo">627</span> /**<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> * Returns the key under which {@link AuthenticationInfo} instances are cached if authentication caching is enabled.<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> * This implementation delegates to<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> * {@link #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection)}, which returns the primary principal<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> * associated with this particular Realm.<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> * <h3>Cache Invalidation on Logout</h3><a name="line.632"></a> |
| <span class="sourceLineNo">633</span> * <b>NOTE:</b> If you want to be able to invalidate an account's cached {@code AuthenticationInfo} on logout, you<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * must ensure that this method returns the same value as the<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)} method!<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> *<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> * @param principals the principals of the account for which to set or remove cached {@code AuthenticationInfo}.<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * @return the cache key to use when looking up cached {@link AuthenticationInfo} instances.<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * @since 1.2<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> */<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> protected Object getAuthenticationCacheKey(PrincipalCollection principals) {<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> return getAvailablePrincipal(principals);<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> }<a name="line.643"></a> |
| <span class="sourceLineNo">644</span><a name="line.644"></a> |
| <span class="sourceLineNo">645</span> /**<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * This implementation clears out any cached authentication data by calling<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> * {@link #clearCachedAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection)}.<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * If overriding in a subclass, be sure to call {@code super.doClearCache} to ensure this behavior is maintained.<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> *<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * @param principals principals the principals of the account for which to clear any cached data.<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> * @since 1.2<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> */<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> @Override<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> protected void doClearCache(PrincipalCollection principals) {<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> super.doClearCache(principals);<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> clearCachedAuthenticationInfo(principals);<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> }<a name="line.657"></a> |
| <span class="sourceLineNo">658</span><a name="line.658"></a> |
| <span class="sourceLineNo">659</span> /**<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * Clears out the AuthenticationInfo cache entry for the specified account.<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * <p/><a name="line.661"></a> |
| <span class="sourceLineNo">662</span> * This method is provided as a convenience to subclasses so they can invalidate a cache entry when they<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> * change an account's authentication data (e.g. reset password) during runtime. Because an account's<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> * AuthenticationInfo can be cached, there needs to be a way to invalidate the cache for only that account so that<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> * subsequent authentication operations don't used the (old) cached value if account data changes.<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> * <p/><a name="line.666"></a> |
| <span class="sourceLineNo">667</span> * After this method is called, the next authentication for that same account will result in a call to<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) doGetAuthenticationInfo}, and the<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * resulting return value will be cached before being returned so it can be reused for later authentications.<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * <p/><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> * If you wish to clear out all associated cached data (and not just authentication data), use the<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * {@link #clearCache(org.apache.shiro.subject.PrincipalCollection)} method instead (which will in turn call this<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * method by default).<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> *<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> * @param principals the principals of the account for which to clear the cached AuthorizationInfo.<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> * @see #clearCache(org.apache.shiro.subject.PrincipalCollection)<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> * @since 1.2<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> */<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> protected void clearCachedAuthenticationInfo(PrincipalCollection principals) {<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> if (!CollectionUtils.isEmpty(principals)) {<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> Cache<Object, AuthenticationInfo> cache = getAvailableAuthenticationCache();<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> //cache instance will be non-null if caching is enabled:<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> if (cache != null) {<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> Object key = getAuthenticationCacheKey(principals);<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> cache.remove(key);<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> }<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> }<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> }<a name="line.688"></a> |
| <span class="sourceLineNo">689</span><a name="line.689"></a> |
| <span class="sourceLineNo">690</span> /**<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * authentication token.<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * <p/><a name="line.693"></a> |
| <span class="sourceLineNo">694</span> * For most datasources, this means just 'pulling' authentication data for an associated subject/user and nothing<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> * more and letting Shiro do the rest. But in some systems, this method could actually perform EIS specific<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> * log-in logic in addition to just retrieving data - it is up to the Realm implementation.<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> * <p/><a name="line.697"></a> |
| <span class="sourceLineNo">698</span> * A {@code null} return value means that no account could be associated with the specified token.<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> *<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> * @param token the authentication token containing the user's principal and credentials.<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> * @return an {@link AuthenticationInfo} object containing account data resulting from the<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> * authentication ONLY if the lookup is successful (i.e. account exists and is valid, etc.)<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * @throws AuthenticationException if there is an error acquiring data or performing<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> * realm-specific authentication logic for the specified <tt>token</tt><a name="line.704"></a> |
| <span class="sourceLineNo">705</span> */<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> protected abstract AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException;<a name="line.706"></a> |
| <span class="sourceLineNo">707</span><a name="line.707"></a> |
| <span class="sourceLineNo">708</span>}<a name="line.708"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
