| <!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>AbstractRememberMeManager xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/mgt/AbstractRememberMeManager.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.mgt; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.RememberMeAuthenticationToken; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.AesCipherService; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.CipherService; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.DefaultSerializer; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.Serializer; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.SubjectContext; |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource; |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="36" href="#36">36</a> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * Abstract implementation of the {@code RememberMeManager} interface that handles</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * {@link #setSerializer(org.apache.shiro.io.Serializer) serialization} and</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * {@link #setCipherService encryption} of the remembered user identity.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The remembered identity storage location and details are left to subclasses.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <h2>Default encryption key</h2></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * This implementation uses an {@link AesCipherService AesCipherService} for strong encryption by default. It also</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * uses a default generated symmetric key to both encrypt and decrypt data. As AES is a symmetric cipher, the same</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@code key} is used to both encrypt and decrypt data, BUT NOTE:</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Because Shiro is an open-source project, if anyone knew that you were using Shiro's default</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * {@code key}, they could download/view the source, and with enough effort, reconstruct the {@code key}</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * and decode encrypted data at will.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Of course, this key is only really used to encrypt the remembered {@code PrincipalCollection} which is typically</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * a user id or username. So if you do not consider that sensitive information, and you think the default key still</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * makes things 'sufficiently difficult', then you can ignore this issue.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * However, if you do feel this constitutes sensitive information, it is recommended that you provide your own</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * {@code key} via the {@link #setCipherKey setCipherKey} method to a key known only to your application,</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * guaranteeing that no third party can decrypt your data. You can generate your own key by calling the</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * {@code CipherService}'s {@link org.apache.shiro.crypto.AesCipherService#generateNewKey() generateNewKey} method</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * and using that result as the {@link #setCipherKey cipherKey} configuration attribute.</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html">AbstractRememberMeManager</a> implements <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> { |
| <a name="65" href="#65">65</a> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * private inner log instance.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(AbstractRememberMeManager.<strong class="jxr_keyword">class</strong>); |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * The following Base64 string was generated by auto-generating an AES Key:</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * AesCipherService aes = new AesCipherService();</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * byte[] key = aes.generateNewKey().getEncoded();</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * String base64 = Base64.encodeToString(key);</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * The value of 'base64' was copied-n-pasted here:</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] DEFAULT_CIPHER_KEY_BYTES = Base64.decode(<span class="jxr_string">"kPH+bIxk5D2deZiIxcaaaA=="</span>); |
| <a name="81" href="#81">81</a> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * Serializer to use for converting PrincipalCollection instances to/from byte arrays</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">private</strong> Serializer<PrincipalCollection> serializer; |
| <a name="86" href="#86">86</a> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * Cipher to use for encrypting/decrypting serialized byte arrays for added security</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/shiro/crypto/CipherService.html">CipherService</a> cipherService; |
| <a name="91" href="#91">91</a> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Cipher encryption key to use with the Cipher when encrypting data</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">private</strong> byte[] encryptionCipherKey; |
| <a name="96" href="#96">96</a> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Cipher decryption key to use with the Cipher when decrypting data</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> byte[] decryptionCipherKey; |
| <a name="101" href="#101">101</a> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Default constructor that initializes a {@link DefaultSerializer} as the {@link #getSerializer() serializer} and</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * an {@link AesCipherService} as the {@link #getCipherService() cipherService}.</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/mgt/AbstractRememberMeManager.html">AbstractRememberMeManager</a>() { |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">this</strong>.serializer = <strong class="jxr_keyword">new</strong> DefaultSerializer<PrincipalCollection>(); |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">this</strong>.cipherService = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/crypto/AesCipherService.html">AesCipherService</a>(); |
| <a name="109" href="#109">109</a> setCipherKey(DEFAULT_CIPHER_KEY_BYTES); |
| <a name="110" href="#110">110</a> } |
| <a name="111" href="#111">111</a> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Returns the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances for</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * persistent remember me storage.</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setSerializer} method, the default instance is a</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.io.DefaultSerializer}.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @return the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances for</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * persistent remember me storage.</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> Serializer<PrincipalCollection> getSerializer() { |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">return</strong> serializer; |
| <a name="124" href="#124">124</a> } |
| <a name="125" href="#125">125</a> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Sets the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances for</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * persistent remember me storage.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * Unless overridden by this method, the default instance is a {@link DefaultSerializer}.</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 serializer the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * for persistent remember me storage.</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="135" href="#135">135</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSerializer(Serializer<PrincipalCollection> serializer) { |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">this</strong>.serializer = serializer; |
| <a name="137" href="#137">137</a> } |
| <a name="138" href="#138">138</a> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * Returns the {@code CipherService} to use for encrypting and decrypting serialized identity data to prevent easy</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * inspection of Subject identity data.</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setCipherService} method, the default instance is an {@link AesCipherService}.</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @return the {@code Cipher} to use for encrypting and decrypting serialized identity data to prevent easy</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * inspection of Subject identity data</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/crypto/CipherService.html">CipherService</a> getCipherService() { |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">return</strong> cipherService; |
| <a name="150" href="#150">150</a> } |
| <a name="151" href="#151">151</a> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * Sets the {@code CipherService} to use for encrypting and decrypting serialized identity data to prevent easy</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * inspection of Subject identity data.</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * If the CipherService is a symmetric CipherService (using the same key for both encryption and decryption), you</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * should set your key via the {@link #setCipherKey(byte[])} method.</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * If the CipherService is an asymmetric CipherService (different keys for encryption and decryption, such as</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * public/private key pairs), you should set your encryption and decryption key via the respective</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * {@link #setEncryptionCipherKey(byte[])} and {@link #setDecryptionCipherKey(byte[])} methods.</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * <b>N.B.</b> Unless overridden by this method, the default CipherService instance is an</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * {@link AesCipherService}. This {@code RememberMeManager} implementation already has a configured symmetric key</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * to use for encryption and decryption, but it is recommended to provide your own for added security. See the</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * class-level JavaDoc for more information and why it might be good to provide your own.</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @param cipherService the {@code CipherService} to use for encrypting and decrypting serialized identity data to</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * prevent easy inspection of Subject identity data.</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCipherService(<a href="../../../../org/apache/shiro/crypto/CipherService.html">CipherService</a> cipherService) { |
| <a name="172" href="#172">172</a> <strong class="jxr_keyword">this</strong>.cipherService = cipherService; |
| <a name="173" href="#173">173</a> } |
| <a name="174" href="#174">174</a> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * Returns the cipher key to use for encryption operations.</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @return the cipher key to use for encryption operations.</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="181" href="#181">181</a> <strong class="jxr_keyword">public</strong> byte[] getEncryptionCipherKey() { |
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong> encryptionCipherKey; |
| <a name="183" href="#183">183</a> } |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * Sets the encryption key to use for encryption operations.</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @param encryptionCipherKey the encryption key to use for encryption operations.</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="191" href="#191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncryptionCipherKey(byte[] encryptionCipherKey) { |
| <a name="192" href="#192">192</a> <strong class="jxr_keyword">this</strong>.encryptionCipherKey = encryptionCipherKey; |
| <a name="193" href="#193">193</a> } |
| <a name="194" href="#194">194</a> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * Returns the decryption cipher key to use for decryption operations.</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * @return the cipher key to use for decryption operations.</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="201" href="#201">201</a> <strong class="jxr_keyword">public</strong> byte[] getDecryptionCipherKey() { |
| <a name="202" href="#202">202</a> <strong class="jxr_keyword">return</strong> decryptionCipherKey; |
| <a name="203" href="#203">203</a> } |
| <a name="204" href="#204">204</a> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * Sets the decryption key to use for decryption operations.</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * @param decryptionCipherKey the decryption key to use for decryption operations.</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDecryptionCipherKey(byte[] decryptionCipherKey) { |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">this</strong>.decryptionCipherKey = decryptionCipherKey; |
| <a name="213" href="#213">213</a> } |
| <a name="214" href="#214">214</a> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * Convenience method that returns the cipher key to use for <em>both</em> encryption and decryption.</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * <b>N.B.</b> This method can only be called if the underlying {@link #getCipherService() cipherService} is a symmetric</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * CipherService which by definition uses the same key for both encryption and decryption. If using an asymmetric</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * CipherService public/private key pair, you cannot use this method, and should instead use the</em> |
| <a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * {@link #getEncryptionCipherKey()} and {@link #getDecryptionCipherKey()} methods individually.</em> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * The default {@link AesCipherService} instance is a symmetric cipher service, so this method can be used if you are</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * using the default.</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @return the symmetric cipher key used for both encryption and decryption.</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="228" href="#228">228</a> <strong class="jxr_keyword">public</strong> byte[] getCipherKey() { |
| <a name="229" href="#229">229</a> <em class="jxr_comment">//Since this method should only be used with symmetric ciphers</em> |
| <a name="230" href="#230">230</a> <em class="jxr_comment">//(where the enc and dec keys are the same), either is fine, just return one of them:</em> |
| <a name="231" href="#231">231</a> <strong class="jxr_keyword">return</strong> getEncryptionCipherKey(); |
| <a name="232" href="#232">232</a> } |
| <a name="233" href="#233">233</a> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * Convenience method that sets the cipher key to use for <em>both</em> encryption and decryption.</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * <b>N.B.</b> This method can only be called if the underlying {@link #getCipherService() cipherService} is a</em> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * symmetric CipherService?which by definition uses the same key for both encryption and decryption. If using an</em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * asymmetric CipherService?(such as a public/private key pair), you cannot use this method, and should instead use</em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * the {@link #setEncryptionCipherKey(byte[])} and {@link #setDecryptionCipherKey(byte[])} methods individually.</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * The default {@link AesCipherService} instance is a symmetric CipherService, so this method can be used if you</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * are using the default.</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @param cipherKey the symmetric cipher key to use for both encryption and decryption.</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="247" href="#247">247</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCipherKey(byte[] cipherKey) { |
| <a name="248" href="#248">248</a> <em class="jxr_comment">//Since this method should only be used in symmetric ciphers</em> |
| <a name="249" href="#249">249</a> <em class="jxr_comment">//(where the enc and dec keys are the same), set it on both:</em> |
| <a name="250" href="#250">250</a> setEncryptionCipherKey(cipherKey); |
| <a name="251" href="#251">251</a> setDecryptionCipherKey(cipherKey); |
| <a name="252" href="#252">252</a> } |
| <a name="253" href="#253">253</a> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * Forgets (removes) any remembered identity data for the specified {@link Subject} instance.</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * @param subject the subject instance for which identity data should be forgotten from the underlying persistence</em> |
| <a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * mechanism.</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="260" href="#260">260</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> forgetIdentity(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject); |
| <a name="261" href="#261">261</a> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Determines whether or not remember me services should be performed for the specified token. This method returns</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * {@code true} iff:</em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * <li>The token is not {@code null} and</li></em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * <li>The token is an {@code instanceof} {@link RememberMeAuthenticationToken} and</li></em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * <li>{@code token}.{@link org.apache.shiro.authc.RememberMeAuthenticationToken#isRememberMe() isRememberMe()} is</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * {@code true}</li></em> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @param token the authentication token submitted during the successful authentication attempt.</em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * @return true if remember me services should be performed as a result of the successful authentication attempt.</em> |
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="275" href="#275">275</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isRememberMe(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="276" href="#276">276</a> <strong class="jxr_keyword">return</strong> token != <strong class="jxr_keyword">null</strong> && (token instanceof RememberMeAuthenticationToken) && |
| <a name="277" href="#277">277</a> ((<a href="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html">RememberMeAuthenticationToken</a>) token).isRememberMe(); |
| <a name="278" href="#278">278</a> } |
| <a name="279" href="#279">279</a> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * Reacts to the successful login attempt by first always {@link #forgetIdentity(Subject) forgetting} any previously</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * stored identity. Then if the {@code token}</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * {@link #isRememberMe(org.apache.shiro.authc.AuthenticationToken) is a RememberMe} token, the associated identity</em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * will be {@link #rememberIdentity(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) remembered}</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * for later retrieval during a new user session.</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * @param token the token that resulted in a successful authentication attempt.</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * @param info the authentication info resulting from the successful authentication attempt.</em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="291" href="#291">291</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onSuccessfulLogin(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, <a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="292" href="#292">292</a> <em class="jxr_comment">//always clear any previous identity:</em> |
| <a name="293" href="#293">293</a> forgetIdentity(subject); |
| <a name="294" href="#294">294</a> |
| <a name="295" href="#295">295</a> <em class="jxr_comment">//now save the new identity:</em> |
| <a name="296" href="#296">296</a> <strong class="jxr_keyword">if</strong> (isRememberMe(token)) { |
| <a name="297" href="#297">297</a> rememberIdentity(subject, token, info); |
| <a name="298" href="#298">298</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="299" href="#299">299</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="300" href="#300">300</a> log.debug(<span class="jxr_string">"AuthenticationToken did not indicate RememberMe is requested. "</span> + |
| <a name="301" href="#301">301</a> <span class="jxr_string">"RememberMe functionality will not be executed for corresponding account."</span>); |
| <a name="302" href="#302">302</a> } |
| <a name="303" href="#303">303</a> } |
| <a name="304" href="#304">304</a> } |
| <a name="305" href="#305">305</a> |
| <a name="306" href="#306">306</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * Remembers a subject-unique identity for retrieval later. This implementation first</em> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * {@link #getIdentityToRemember resolves} the exact</em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * {@link PrincipalCollection principals} to remember. It then remembers the principals by calling</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * {@link #rememberIdentity(org.apache.shiro.subject.Subject, org.apache.shiro.subject.PrincipalCollection)}.</em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * This implementation ignores the {@link AuthenticationToken} argument, but it is available to subclasses if</em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * necessary for custom logic.</em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * @param token the token that resulted in a successful authentication attempt.</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @param authcInfo the authentication info resulting from the successful authentication attempt.</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="319" href="#319">319</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> rememberIdentity(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, <a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> authcInfo) { |
| <a name="320" href="#320">320</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals = getIdentityToRemember(subject, authcInfo); |
| <a name="321" href="#321">321</a> rememberIdentity(subject, principals); |
| <a name="322" href="#322">322</a> } |
| <a name="323" href="#323">323</a> |
| <a name="324" href="#324">324</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * Returns {@code info}.{@link org.apache.shiro.authc.AuthenticationInfo#getPrincipals() getPrincipals()} and</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * ignores the {@link Subject} argument.</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @param info the authentication info resulting from the successful authentication attempt.</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @return the {@code PrincipalCollection} to remember.</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="332" href="#332">332</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getIdentityToRemember(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="333" href="#333">333</a> <strong class="jxr_keyword">return</strong> info.getPrincipals(); |
| <a name="334" href="#334">334</a> } |
| <a name="335" href="#335">335</a> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * Remembers the specified account principals by first</em> |
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * {@link #convertPrincipalsToBytes(org.apache.shiro.subject.PrincipalCollection) converting} them to a byte</em> |
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * array and then {@link #rememberSerializedIdentity(org.apache.shiro.subject.Subject, byte[]) remembers} that</em> |
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * byte array.</em> |
| <a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em> |
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> * @param accountPrincipals the principals to remember for retrieval later.</em> |
| <a name="344" href="#344">344</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="345" href="#345">345</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> rememberIdentity(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> accountPrincipals) { |
| <a name="346" href="#346">346</a> byte[] bytes = convertPrincipalsToBytes(accountPrincipals); |
| <a name="347" href="#347">347</a> rememberSerializedIdentity(subject, bytes); |
| <a name="348" href="#348">348</a> } |
| <a name="349" href="#349">349</a> |
| <a name="350" href="#350">350</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * Converts the given principal collection the byte array that will be persisted to be 'remembered' later.</em> |
| <a name="352" href="#352">352</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="353" href="#353">353</a> <em class="jxr_javadoccomment"> * This implementation first {@link #serialize(org.apache.shiro.subject.PrincipalCollection) serializes} the</em> |
| <a name="354" href="#354">354</a> <em class="jxr_javadoccomment"> * principals to a byte array and then {@link #encrypt(byte[]) encrypts} that byte array.</em> |
| <a name="355" href="#355">355</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> * @param principals the {@code PrincipalCollection} to convert to a byte array</em> |
| <a name="357" href="#357">357</a> <em class="jxr_javadoccomment"> * @return the representative byte array to be persisted for remember me functionality.</em> |
| <a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="359" href="#359">359</a> <strong class="jxr_keyword">protected</strong> byte[] convertPrincipalsToBytes(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="360" href="#360">360</a> byte[] bytes = serialize(principals); |
| <a name="361" href="#361">361</a> <strong class="jxr_keyword">if</strong> (getCipherService() != <strong class="jxr_keyword">null</strong>) { |
| <a name="362" href="#362">362</a> bytes = encrypt(bytes); |
| <a name="363" href="#363">363</a> } |
| <a name="364" href="#364">364</a> <strong class="jxr_keyword">return</strong> bytes; |
| <a name="365" href="#365">365</a> } |
| <a name="366" href="#366">366</a> |
| <a name="367" href="#367">367</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> * Persists the identity bytes to a persistent store for retrieval later via the</em> |
| <a name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * {@link #getRememberedSerializedIdentity(SubjectContext)} method.</em> |
| <a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * @param subject the Subject for which the identity is being serialized.</em> |
| <a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * @param serialized the serialized bytes to be persisted.</em> |
| <a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="374" href="#374">374</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> rememberSerializedIdentity(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, byte[] serialized); |
| <a name="375" href="#375">375</a> |
| <a name="376" href="#376">376</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> * Implements the interface method by first {@link #getRememberedSerializedIdentity(SubjectContext) acquiring}</em> |
| <a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * the remembered serialized byte array. Then it {@link #convertBytesToPrincipals(byte[], SubjectContext) converts}</em> |
| <a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * them and returns the re-constituted {@link PrincipalCollection}. If no remembered principals could be</em> |
| <a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * obtained, {@code null} is returned.</em> |
| <a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * If any exceptions are thrown, the {@link #onRememberedPrincipalFailure(RuntimeException, SubjectContext)} method</em> |
| <a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * is called to allow any necessary post-processing (such as immediately removing any previously remembered</em> |
| <a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> * values for safety).</em> |
| <a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="386" href="#386">386</a> <em class="jxr_javadoccomment"> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em> |
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance.</em> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * @return the remembered principals or {@code null} if none could be acquired.</em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="390" href="#390">390</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getRememberedPrincipals(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext) { |
| <a name="391" href="#391">391</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals = <strong class="jxr_keyword">null</strong>; |
| <a name="392" href="#392">392</a> <strong class="jxr_keyword">try</strong> { |
| <a name="393" href="#393">393</a> byte[] bytes = getRememberedSerializedIdentity(subjectContext); |
| <a name="394" href="#394">394</a> <em class="jxr_comment">//SHIRO-138 - only call convertBytesToPrincipals if bytes exist:</em> |
| <a name="395" href="#395">395</a> <strong class="jxr_keyword">if</strong> (bytes != <strong class="jxr_keyword">null</strong> && bytes.length > 0) { |
| <a name="396" href="#396">396</a> principals = convertBytesToPrincipals(bytes, subjectContext); |
| <a name="397" href="#397">397</a> } |
| <a name="398" href="#398">398</a> } <strong class="jxr_keyword">catch</strong> (RuntimeException re) { |
| <a name="399" href="#399">399</a> principals = onRememberedPrincipalFailure(re, subjectContext); |
| <a name="400" href="#400">400</a> } |
| <a name="401" href="#401">401</a> |
| <a name="402" href="#402">402</a> <strong class="jxr_keyword">return</strong> principals; |
| <a name="403" href="#403">403</a> } |
| <a name="404" href="#404">404</a> |
| <a name="405" href="#405">405</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * Based on the given subject context data, retrieves the previously persisted serialized identity, or</em> |
| <a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * {@code null} if there is no available data. The context map is usually populated by a {@link Subject.Builder}</em> |
| <a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * implementation. See the {@link SubjectFactory} class constants for Shiro's known map keys.</em> |
| <a name="409" href="#409">409</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em> |
| <a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance. To be used to assist with data</em> |
| <a name="412" href="#412">412</a> <em class="jxr_javadoccomment"> * lookup.</em> |
| <a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * @return the previously persisted serialized identity, or {@code null} if there is no available data for the</em> |
| <a name="414" href="#414">414</a> <em class="jxr_javadoccomment"> * Subject.</em> |
| <a name="415" href="#415">415</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="416" href="#416">416</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> byte[] getRememberedSerializedIdentity(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext); |
| <a name="417" href="#417">417</a> |
| <a name="418" href="#418">418</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> * If a {@link #getCipherService() cipherService} is available, it will be used to first decrypt the byte array.</em> |
| <a name="420" href="#420">420</a> <em class="jxr_javadoccomment"> * Then the bytes are then {@link #deserialize(byte[]) deserialized} and then returned.</em> |
| <a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to decrypt if necessary and then deserialize.</em> |
| <a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em> |
| <a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance.</em> |
| <a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * @return the de-serialized and possibly decrypted principals</em> |
| <a name="426" href="#426">426</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="427" href="#427">427</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> convertBytesToPrincipals(byte[] bytes, <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext) { |
| <a name="428" href="#428">428</a> <strong class="jxr_keyword">if</strong> (getCipherService() != <strong class="jxr_keyword">null</strong>) { |
| <a name="429" href="#429">429</a> bytes = decrypt(bytes); |
| <a name="430" href="#430">430</a> } |
| <a name="431" href="#431">431</a> <strong class="jxr_keyword">return</strong> deserialize(bytes); |
| <a name="432" href="#432">432</a> } |
| <a name="433" href="#433">433</a> |
| <a name="434" href="#434">434</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> * Called when an exception is thrown while trying to retrieve principals. The default implementation logs a</em> |
| <a name="436" href="#436">436</a> <em class="jxr_javadoccomment"> * debug message and forgets ('unremembers') the problem identity by calling</em> |
| <a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> * {@link #forgetIdentity(SubjectContext) forgetIdentity(context)} and then immediately re-throws the</em> |
| <a name="438" href="#438">438</a> <em class="jxr_javadoccomment"> * exception to allow the calling component to react accordingly.</em> |
| <a name="439" href="#439">439</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> * This method implementation never returns an</em> |
| <a name="441" href="#441">441</a> <em class="jxr_javadoccomment"> * object - it always rethrows, but can be overridden by subclasses for custom handling behavior.</em> |
| <a name="442" href="#442">442</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="443" href="#443">443</a> <em class="jxr_javadoccomment"> * This most commonly would be called when an encryption key is updated and old principals are retrieved that have</em> |
| <a name="444" href="#444">444</a> <em class="jxr_javadoccomment"> * been encrypted with the previous key.</em> |
| <a name="445" href="#445">445</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="446" href="#446">446</a> <em class="jxr_javadoccomment"> * @param e the exception that was thrown.</em> |
| <a name="447" href="#447">447</a> <em class="jxr_javadoccomment"> * @param context the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em> |
| <a name="448" href="#448">448</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance.</em> |
| <a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * @return nothing - the original {@code RuntimeException} is propagated in all cases.</em> |
| <a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="451" href="#451">451</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> onRememberedPrincipalFailure(RuntimeException e, <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) { |
| <a name="452" href="#452">452</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="453" href="#453">453</a> log.debug(<span class="jxr_string">"There was a failure while trying to retrieve remembered principals. This could be due to a "</span> + |
| <a name="454" href="#454">454</a> <span class="jxr_string">"configuration problem or corrupted principals. This could also be due to a recently "</span> + |
| <a name="455" href="#455">455</a> <span class="jxr_string">"changed encryption key. The remembered identity will be forgotten and not used for this "</span> + |
| <a name="456" href="#456">456</a> <span class="jxr_string">"request."</span>, e); |
| <a name="457" href="#457">457</a> } |
| <a name="458" href="#458">458</a> forgetIdentity(context); |
| <a name="459" href="#459">459</a> <em class="jxr_comment">//propagate - security manager implementation will handle and warn appropriately</em> |
| <a name="460" href="#460">460</a> <strong class="jxr_keyword">throw</strong> e; |
| <a name="461" href="#461">461</a> } |
| <a name="462" href="#462">462</a> |
| <a name="463" href="#463">463</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="464" href="#464">464</a> <em class="jxr_javadoccomment"> * Encrypts the byte array by using the configured {@link #getCipherService() cipherService}.</em> |
| <a name="465" href="#465">465</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="466" href="#466">466</a> <em class="jxr_javadoccomment"> * @param serialized the serialized object byte array to be encrypted</em> |
| <a name="467" href="#467">467</a> <em class="jxr_javadoccomment"> * @return an encrypted byte array returned by the configured {@link #getCipherService () cipher}.</em> |
| <a name="468" href="#468">468</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="469" href="#469">469</a> <strong class="jxr_keyword">protected</strong> byte[] encrypt(byte[] serialized) { |
| <a name="470" href="#470">470</a> byte[] value = serialized; |
| <a name="471" href="#471">471</a> <a href="../../../../org/apache/shiro/crypto/CipherService.html">CipherService</a> cipherService = getCipherService(); |
| <a name="472" href="#472">472</a> <strong class="jxr_keyword">if</strong> (cipherService != <strong class="jxr_keyword">null</strong>) { |
| <a name="473" href="#473">473</a> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> byteSource = cipherService.encrypt(serialized, getEncryptionCipherKey()); |
| <a name="474" href="#474">474</a> value = byteSource.getBytes(); |
| <a name="475" href="#475">475</a> } |
| <a name="476" href="#476">476</a> <strong class="jxr_keyword">return</strong> value; |
| <a name="477" href="#477">477</a> } |
| <a name="478" href="#478">478</a> |
| <a name="479" href="#479">479</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="480" href="#480">480</a> <em class="jxr_javadoccomment"> * Decrypts the byte array using the configured {@link #getCipherService() cipherService}.</em> |
| <a name="481" href="#481">481</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="482" href="#482">482</a> <em class="jxr_javadoccomment"> * @param encrypted the encrypted byte array to decrypt</em> |
| <a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * @return the decrypted byte array returned by the configured {@link #getCipherService () cipher}.</em> |
| <a name="484" href="#484">484</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="485" href="#485">485</a> <strong class="jxr_keyword">protected</strong> byte[] decrypt(byte[] encrypted) { |
| <a name="486" href="#486">486</a> byte[] serialized = encrypted; |
| <a name="487" href="#487">487</a> <a href="../../../../org/apache/shiro/crypto/CipherService.html">CipherService</a> cipherService = getCipherService(); |
| <a name="488" href="#488">488</a> <strong class="jxr_keyword">if</strong> (cipherService != <strong class="jxr_keyword">null</strong>) { |
| <a name="489" href="#489">489</a> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> byteSource = cipherService.decrypt(encrypted, getDecryptionCipherKey()); |
| <a name="490" href="#490">490</a> serialized = byteSource.getBytes(); |
| <a name="491" href="#491">491</a> } |
| <a name="492" href="#492">492</a> <strong class="jxr_keyword">return</strong> serialized; |
| <a name="493" href="#493">493</a> } |
| <a name="494" href="#494">494</a> |
| <a name="495" href="#495">495</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="496" href="#496">496</a> <em class="jxr_javadoccomment"> * Serializes the given {@code principals} by serializing them to a byte array by using the</em> |
| <a name="497" href="#497">497</a> <em class="jxr_javadoccomment"> * {@link #getSerializer() serializer}'s {@link Serializer#serialize(Object) serialize} method.</em> |
| <a name="498" href="#498">498</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="499" href="#499">499</a> <em class="jxr_javadoccomment"> * @param principals the principal collection to serialize to a byte array</em> |
| <a name="500" href="#500">500</a> <em class="jxr_javadoccomment"> * @return the serialized principal collection in the form of a byte array</em> |
| <a name="501" href="#501">501</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="502" href="#502">502</a> <strong class="jxr_keyword">protected</strong> byte[] serialize(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="503" href="#503">503</a> <strong class="jxr_keyword">return</strong> getSerializer().serialize(principals); |
| <a name="504" href="#504">504</a> } |
| <a name="505" href="#505">505</a> |
| <a name="506" href="#506">506</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="507" href="#507">507</a> <em class="jxr_javadoccomment"> * De-serializes the given byte array by using the {@link #getSerializer() serializer}'s</em> |
| <a name="508" href="#508">508</a> <em class="jxr_javadoccomment"> * {@link Serializer#deserialize deserialize} method.</em> |
| <a name="509" href="#509">509</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="510" href="#510">510</a> <em class="jxr_javadoccomment"> * @param serializedIdentity the previously serialized {@code PrincipalCollection} as a byte array</em> |
| <a name="511" href="#511">511</a> <em class="jxr_javadoccomment"> * @return the de-serialized (reconstituted) {@code PrincipalCollection}</em> |
| <a name="512" href="#512">512</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="513" href="#513">513</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> deserialize(byte[] serializedIdentity) { |
| <a name="514" href="#514">514</a> <strong class="jxr_keyword">return</strong> getSerializer().deserialize(serializedIdentity); |
| <a name="515" href="#515">515</a> } |
| <a name="516" href="#516">516</a> |
| <a name="517" href="#517">517</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="518" href="#518">518</a> <em class="jxr_javadoccomment"> * Reacts to a failed login by immediately {@link #forgetIdentity(org.apache.shiro.subject.Subject) forgetting} any</em> |
| <a name="519" href="#519">519</a> <em class="jxr_javadoccomment"> * previously remembered identity. This is an additional security feature to prevent any remenant identity data</em> |
| <a name="520" href="#520">520</a> <em class="jxr_javadoccomment"> * from being retained in case the authentication attempt is not being executed by the expected user.</em> |
| <a name="521" href="#521">521</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="522" href="#522">522</a> <em class="jxr_javadoccomment"> * @param subject the subject which executed the failed login attempt</em> |
| <a name="523" href="#523">523</a> <em class="jxr_javadoccomment"> * @param token the authentication token resulting in a failed login attempt - ignored by this implementation</em> |
| <a name="524" href="#524">524</a> <em class="jxr_javadoccomment"> * @param ae the exception thrown as a result of the failed login attempt - ignored by this implementation</em> |
| <a name="525" href="#525">525</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="526" href="#526">526</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onFailedLogin(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, <a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a> ae) { |
| <a name="527" href="#527">527</a> forgetIdentity(subject); |
| <a name="528" href="#528">528</a> } |
| <a name="529" href="#529">529</a> |
| <a name="530" href="#530">530</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="531" href="#531">531</a> <em class="jxr_javadoccomment"> * Reacts to a subject logging out of the application and immediately</em> |
| <a name="532" href="#532">532</a> <em class="jxr_javadoccomment"> * {@link #forgetIdentity(org.apache.shiro.subject.Subject) forgets} any previously stored identity and returns.</em> |
| <a name="533" href="#533">533</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="534" href="#534">534</a> <em class="jxr_javadoccomment"> * @param subject the subject logging out.</em> |
| <a name="535" href="#535">535</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="536" href="#536">536</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onLogout(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="537" href="#537">537</a> forgetIdentity(subject); |
| <a name="538" href="#538">538</a> } |
| <a name="539" href="#539">539</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
