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