| <!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.web.mgt;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.codec.Base64;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.mgt.AbstractRememberMeManager;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.subject.Subject;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.subject.SubjectContext;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.web.servlet.Cookie;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.web.servlet.ShiroHttpServletRequest;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.web.servlet.SimpleCookie;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.web.subject.WebSubject;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.shiro.web.subject.WebSubjectContext;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.shiro.web.util.WebUtils;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.slf4j.Logger;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.slf4j.LoggerFactory;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import javax.servlet.ServletRequest;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import javax.servlet.http.HttpServletRequest;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import javax.servlet.http.HttpServletResponse;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span>/**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Remembers a Subject's identity by saving the Subject's {@link Subject#getPrincipals() principals} to a {@link Cookie}<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * for later retrieval.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p/><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Cookie attributes (path, domain, maxAge, etc) may be set on this class's default<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * {@link #getCookie() cookie} attribute, which acts as a template to use to set all properties of outgoing cookies<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * created by this implementation.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <p/><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * The default cookie has the following attribute values set:<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <table><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <tr><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <th>Attribute Name</th><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <th>Value</th><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </tr><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <tr><td>{@link Cookie#getName() name}</td><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <td>{@code rememberMe}</td><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * </tr><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <tr><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <td>{@link Cookie#getPath() path}</td><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <td>{@code /}</td><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * </tr><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <tr><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <td>{@link Cookie#getMaxAge() maxAge}</td><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <td>{@link Cookie#ONE_YEAR Cookie.ONE_YEAR}</td><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * </tr><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * </table><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p/><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Note that because this class subclasses the {@link AbstractRememberMeManager} which already provides serialization<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * and encryption logic, this class utilizes both for added security before setting the cookie value.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @since 1.0<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span>public class CookieRememberMeManager extends AbstractRememberMeManager {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> //TODO - complete JavaDoc<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private static transient final Logger log = LoggerFactory.getLogger(CookieRememberMeManager.class);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * The default name of the underlying rememberMe cookie which is {@code rememberMe}.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public static final String DEFAULT_REMEMBER_ME_COOKIE_NAME = "rememberMe";<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private Cookie cookie;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Constructs a new {@code CookieRememberMeManager} with a default {@code rememberMe} cookie template.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> public CookieRememberMeManager() {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> Cookie cookie = new SimpleCookie(DEFAULT_REMEMBER_ME_COOKIE_NAME);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> cookie.setHttpOnly(true);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> //One year should be long enough - most sites won't object to requiring a user to log in if they haven't visited<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> //in a year:<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> cookie.setMaxAge(Cookie.ONE_YEAR);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.cookie = cookie;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * this {@code RememberMeManager}. Outgoing cookies will match this one except for the<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * {@link Cookie#getValue() value} attribute, which is necessarily set dynamically at runtime.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <p/><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Please see the class-level JavaDoc for the default cookie's attribute values.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * this {@code RememberMeManager}.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public Cookie getCookie() {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return cookie;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<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> * Sets the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * this {@code RememberMeManager}. Outgoing cookies will match this one except for the<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * {@link Cookie#getValue() value} attribute, which is necessarily set dynamically at runtime.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <p/><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Please see the class-level JavaDoc for the default cookie's attribute values.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> *<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param cookie the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * by this {@code RememberMeManager}.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public void setCookie(Cookie cookie) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> this.cookie = cookie;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<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> * Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * <p/><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * The {@code subject} instance is expected to be a {@link WebSubject} instance with an HTTP Request/Response pair<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * so an HTTP cookie can be set on the outgoing response. If it is not a {@code WebSubject} or that<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * {@code WebSubject} does not have an HTTP Request/Response pair, this implementation does nothing.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> *<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param subject the Subject for which the identity is being serialized.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param serialized the serialized bytes to be persisted.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> protected void rememberSerializedIdentity(Subject subject, byte[] serialized) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> if (!WebUtils.isHttp(subject)) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> if (log.isDebugEnabled()) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> String msg = "Subject argument is not an HTTP-aware instance. This is required to obtain a servlet " +<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> "request and response in order to set the rememberMe cookie. Returning immediately and " +<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> "ignoring rememberMe operation.";<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> log.debug(msg);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> HttpServletRequest request = WebUtils.getHttpRequest(subject);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> HttpServletResponse response = WebUtils.getHttpResponse(subject);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> //base 64 encode it and store as a cookie:<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> String base64 = Base64.encodeToString(serialized);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> Cookie template = getCookie(); //the class attribute is really a template for the outgoing cookies<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> Cookie cookie = new SimpleCookie(template);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> cookie.setValue(base64);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> cookie.saveTo(request, response);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> private boolean isIdentityRemoved(WebSubjectContext subjectContext) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> ServletRequest request = subjectContext.resolveServletRequest();<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> if (request != null) {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> Boolean removed = (Boolean) request.getAttribute(ShiroHttpServletRequest.IDENTITY_REMOVED_KEY);<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return removed != null && removed;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return false;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><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> * Returns a previously serialized identity byte array or {@code null} if the byte array could not be acquired.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * This implementation retrieves an HTTP cookie, Base64-decodes the cookie value, and returns the resulting byte<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * array.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * <p/><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * The {@code SubjectContext} instance is expected to be a {@link WebSubjectContext} instance with an HTTP<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * Request/Response pair so an HTTP cookie can be retrieved from the incoming request. If it is not a<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * {@code WebSubjectContext} or that {@code WebSubjectContext} does not have an HTTP Request/Response pair, this<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * implementation returns {@code null}.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> *<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * is being used to construct a {@link Subject} instance. To be used to assist with data<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * lookup.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @return a previously serialized identity byte array or {@code null} if the byte array could not be acquired.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> */<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> protected byte[] getRememberedSerializedIdentity(SubjectContext subjectContext) {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> if (!WebUtils.isHttp(subjectContext)) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> if (log.isDebugEnabled()) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> String msg = "SubjectContext argument is not an HTTP-aware instance. This is required to obtain a " +<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> "servlet request and response in order to retrieve the rememberMe cookie. Returning " +<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> "immediately and ignoring rememberMe operation.";<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> log.debug(msg);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return null;<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> WebSubjectContext wsc = (WebSubjectContext) subjectContext;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> if (isIdentityRemoved(wsc)) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> return null;<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> HttpServletRequest request = WebUtils.getHttpRequest(wsc);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> HttpServletResponse response = WebUtils.getHttpResponse(wsc);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> String base64 = getCookie().readValue(request, response);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> // Browsers do not always remove cookies immediately (SHIRO-183)<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> // ignore cookies that are scheduled for removal<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> if (Cookie.DELETED_COOKIE_VALUE.equals(base64)) return null;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> if (base64 != null) {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> base64 = ensurePadding(base64);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> if (log.isTraceEnabled()) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> log.trace("Acquired Base64 encoded identity [" + base64 + "]");<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> byte[] decoded = Base64.decode(base64);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> if (log.isTraceEnabled()) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> log.trace("Base64 decoded byte array length: " + (decoded != null ? decoded.length : 0) + " bytes.");<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return decoded;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> } else {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> //no cookie set - new site visitor?<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> return null;<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> }<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> /**<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * Sometimes a user agent will send the rememberMe cookie value without padding,<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * most likely because {@code =} is a separator in the cookie header.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * <p/><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Contributed by Luis Arias. Thanks Luis!<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> *<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @param base64 the base64 encoded String that may need to be padded<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @return the base64 String padded if necessary.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> */<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> private String ensurePadding(String base64) {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> int length = base64.length();<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> if (length % 4 != 0) {<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> StringBuilder sb = new StringBuilder(base64);<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> for (int i = 0; i < length % 4; ++i) {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> sb.append('=');<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> base64 = sb.toString();<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> }<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> return base64;<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> /**<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * Removes the 'rememberMe' cookie from the associated {@link WebSubject}'s request/response pair.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * <p/><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * The {@code subject} instance is expected to be a {@link WebSubject} instance with an HTTP Request/Response pair.<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * If it is not a {@code WebSubject} or that {@code WebSubject} does not have an HTTP Request/Response pair, this<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * implementation does nothing.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> *<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * @param subject the subject instance for which identity data should be forgotten from the underlying persistence<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> */<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> protected void forgetIdentity(Subject subject) {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> if (WebUtils.isHttp(subject)) {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> HttpServletRequest request = WebUtils.getHttpRequest(subject);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> HttpServletResponse response = WebUtils.getHttpResponse(subject);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> forgetIdentity(request, response);<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> /**<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * Removes the 'rememberMe' cookie from the associated {@link WebSubjectContext}'s request/response pair.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * <p/><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * The {@code SubjectContext} instance is expected to be a {@link WebSubjectContext} instance with an HTTP<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * Request/Response pair. If it is not a {@code WebSubjectContext} or that {@code WebSubjectContext} does not<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * have an HTTP Request/Response pair, this implementation does nothing.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> *<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> */<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> public void forgetIdentity(SubjectContext subjectContext) {<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> if (WebUtils.isHttp(subjectContext)) {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> HttpServletRequest request = WebUtils.getHttpRequest(subjectContext);<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> HttpServletResponse response = WebUtils.getHttpResponse(subjectContext);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> forgetIdentity(request, response);<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Removes the rememberMe cookie from the given request/response pair.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> *<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @param request the incoming HTTP servlet request<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * @param response the outgoing HTTP servlet response<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> */<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> private void forgetIdentity(HttpServletRequest request, HttpServletResponse response) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> getCookie().removeFrom(request, response);<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |