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