Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.0 / shiro-core / xref / org / apache / shiro / mgt / AbstractRememberMeManager.html
blob: df376b96605fd703def41e7f23cf154cfa09186e [file] [log] [blame]
<!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=UTF-8" />
<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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.mgt;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.RememberMeAuthenticationToken;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.AesCipherService;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.CipherService;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.DefaultSerializer;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.Serializer;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.SubjectContext;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L36" href="#L36">36</a>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Abstract implementation of the {@code RememberMeManager} interface that handles</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * {@link #setSerializer(org.apache.shiro.io.Serializer) serialization} and</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * {@link #setCipherService encryption} of the remembered user identity.</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * The remembered identity storage location and details are left to subclasses.</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Default encryption key&lt;/h2&gt;</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * This implementation uses an {@link AesCipherService AesCipherService} for strong encryption by default. It also</em>
<a class="jxr_linenumber" name="L45" href="#L45">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 class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * {@code key} is used to both encrypt and decrypt data, BUT NOTE:</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L48" href="#L48">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 class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * {@code key}, they could download/view the source, and with enough effort, reconstruct the {@code key}</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * and decode encrypted data at will.</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L52" href="#L52">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 class="jxr_linenumber" name="L53" href="#L53">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 class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * makes things 'sufficiently difficult', then you can ignore this issue.</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L56" href="#L56">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 class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * {@code key} via the {@link #setCipherKey setCipherKey} method to a key known only to your application,</em>
<a class="jxr_linenumber" name="L58" href="#L58">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 class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * {@code CipherService}'s {@link org.apache.shiro.crypto.AesCipherService#generateNewKey() generateNewKey} method</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * and using that result as the {@link #setCipherKey cipherKey} configuration attribute.</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractRememberMeManager" href="../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#AbstractRememberMeManager">AbstractRememberMeManager</a> <strong class="jxr_keyword">implements</strong> <a name="RememberMeManager" href="../../../../org/apache/shiro/mgt/RememberMeManager.html#RememberMeManager">RememberMeManager</a> {
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * private inner log instance.</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L69" href="#L69">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 class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * Serializer to use for converting PrincipalCollection instances to/from byte arrays</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> Serializer&lt;PrincipalCollection&gt; serializer;
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Cipher to use for encrypting/decrypting serialized byte arrays for added security</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> CipherService cipherService;
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Cipher encryption key to use with the Cipher when encrypting data</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> byte[] encryptionCipherKey;
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * Cipher decryption key to use with the Cipher when decrypting data</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> byte[] decryptionCipherKey;
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Default constructor that initializes a {@link DefaultSerializer} as the {@link #getSerializer() serializer} and</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * an {@link AesCipherService} as the {@link #getCipherService() cipherService}.</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> <a name="AbstractRememberMeManager" href="../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#AbstractRememberMeManager">AbstractRememberMeManager</a>() {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>.serializer = <strong class="jxr_keyword">new</strong> DefaultSerializer&lt;PrincipalCollection&gt;();
<a class="jxr_linenumber" name="L97" href="#L97">97</a> AesCipherService cipherService = <strong class="jxr_keyword">new</strong> AesCipherService();
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">this</strong>.cipherService = cipherService;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> setCipherKey(cipherService.generateNewKey().getEncoded());
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Returns the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances for</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * persistent remember me storage.</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setSerializer} method, the default instance is a</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.io.DefaultSerializer}.</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @return the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances for</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * persistent remember me storage.</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> Serializer&lt;PrincipalCollection&gt; getSerializer() {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> serializer;
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Sets the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances for</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * persistent remember me storage.</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Unless overridden by this method, the default instance is a {@link DefaultSerializer}.</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @param serializer the {@code Serializer} used to serialize and deserialize {@link PrincipalCollection} instances</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * for persistent remember me storage.</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSerializer(Serializer&lt;PrincipalCollection&gt; serializer) {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">this</strong>.serializer = serializer;
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Returns the {@code CipherService} to use for encrypting and decrypting serialized identity data to prevent easy</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * inspection of Subject identity data.</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setCipherService} method, the default instance is an {@link AesCipherService}.</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @return the {@code Cipher} to use for encrypting and decrypting serialized identity data to prevent easy</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * inspection of Subject identity data</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">public</strong> CipherService getCipherService() {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">return</strong> cipherService;
<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
<a class="jxr_linenumber" name="L141" href="#L141">141</a>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * Sets the {@code CipherService} to use for encrypting and decrypting serialized identity data to prevent easy</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * inspection of Subject identity data.</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * If the CipherService is a symmetric CipherService (using the same key for both encryption and decryption), you</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * should set your key via the {@link #setCipherKey(byte[])} method.</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * If the CipherService is an asymmetric CipherService (different keys for encryption and decryption, such as</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * public/private key pairs), you should set your encryption and decryption key via the respective</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * {@link #setEncryptionCipherKey(byte[])} and {@link #setDecryptionCipherKey(byte[])} methods.</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * &lt;b&gt;N.B.&lt;/b&gt; Unless overridden by this method, the default CipherService instance is an</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * {@link AesCipherService}. This {@code RememberMeManager} implementation already has a configured symmetric key</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</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 class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * class-level JavaDoc for more information and why it might be good to provide your own.</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @param cipherService the {@code CipherService} to use for encrypting and decrypting serialized identity data to</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * prevent easy inspection of Subject identity data.</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCipherService(CipherService cipherService) {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">this</strong>.cipherService = cipherService;
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * Returns the cipher key to use for encryption operations.</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @return the cipher key to use for encryption operations.</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">public</strong> byte[] getEncryptionCipherKey() {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">return</strong> encryptionCipherKey;
<a class="jxr_linenumber" name="L173" href="#L173">173</a> }
<a class="jxr_linenumber" name="L174" href="#L174">174</a>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * Sets the encryption key to use for encryption operations.</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param encryptionCipherKey the encryption key to use for encryption operations.</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncryptionCipherKey(byte[] encryptionCipherKey) {
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">this</strong>.encryptionCipherKey = encryptionCipherKey;
<a class="jxr_linenumber" name="L183" href="#L183">183</a> }
<a class="jxr_linenumber" name="L184" href="#L184">184</a>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * Returns the decryption cipher key to use for decryption operations.</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @return the cipher key to use for decryption operations.</em>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">public</strong> byte[] getDecryptionCipherKey() {
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">return</strong> decryptionCipherKey;
<a class="jxr_linenumber" name="L193" href="#L193">193</a> }
<a class="jxr_linenumber" name="L194" href="#L194">194</a>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * Sets the decryption key to use for decryption operations.</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @param decryptionCipherKey the decryption key to use for decryption operations.</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @see #setCipherService for a description of the various {@code get/set*Key} methods.</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDecryptionCipherKey(byte[] decryptionCipherKey) {
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">this</strong>.decryptionCipherKey = decryptionCipherKey;
<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
<a class="jxr_linenumber" name="L204" href="#L204">204</a>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * Convenience method that returns the cipher key to use for &lt;em&gt;both&lt;/em&gt; encryption and decryption.</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * &lt;b&gt;N.B.&lt;/b&gt; This method can only be called if the underlying {@link #getCipherService() cipherService} is a symmetric</em>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * CipherService which by definition uses the same key for both encryption and decryption. If using an asymmetric</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * CipherService public/private key pair, you cannot use this method, and should instead use the</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * {@link #getEncryptionCipherKey()} and {@link #getDecryptionCipherKey()} methods individually.</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</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 class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * using the default.</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @return the symmetric cipher key used for both encryption and decryption.</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">public</strong> byte[] getCipherKey() {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_comment">//Since this method should only be used with symmetric ciphers</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">//(where the enc and dec keys are the same), either is fine, just return one of them:</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">return</strong> getEncryptionCipherKey();
<a class="jxr_linenumber" name="L222" href="#L222">222</a> }
<a class="jxr_linenumber" name="L223" href="#L223">223</a>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * Convenience method that sets the cipher key to use for &lt;em&gt;both&lt;/em&gt; encryption and decryption.</em>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * &lt;b&gt;N.B.&lt;/b&gt; This method can only be called if the underlying {@link #getCipherService() cipherService} is a</em>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * symmetric CipherService?which by definition uses the same key for both encryption and decryption. If using an</em>
<a class="jxr_linenumber" name="L229" href="#L229">229</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 class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * the {@link #setEncryptionCipherKey(byte[])} and {@link #setDecryptionCipherKey(byte[])} methods individually.</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * The default {@link AesCipherService} instance is a symmetric CipherService, so this method can be used if you</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * are using the default.</em>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @param cipherKey the symmetric cipher key to use for both encryption and decryption.</em>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCipherKey(byte[] cipherKey) {
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_comment">//Since this method should only be used in symmetric ciphers</em>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_comment">//(where the enc and dec keys are the same), set it on both:</em>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> setEncryptionCipherKey(cipherKey);
<a class="jxr_linenumber" name="L241" href="#L241">241</a> setDecryptionCipherKey(cipherKey);
<a class="jxr_linenumber" name="L242" href="#L242">242</a> }
<a class="jxr_linenumber" name="L243" href="#L243">243</a>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * Forgets (removes) any remembered identity data for the specified {@link Subject} instance.</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @param subject the subject instance for which identity data should be forgotten from the underlying persistence</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * mechanism.</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> forgetIdentity(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject);
<a class="jxr_linenumber" name="L251" href="#L251">251</a>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * Determines whether or not remember me services should be performed for the specified token. This method returns</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * {@code true} iff:</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The token is not {@code null} and&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The token is an {@code instanceof} {@link RememberMeAuthenticationToken} and&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * &lt;li&gt;{@code token}.{@link org.apache.shiro.authc.RememberMeAuthenticationToken#isRememberMe() isRememberMe()} is</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * {@code true}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * @param token the authentication token submitted during the successful authentication attempt.</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @return true if remember me services should be performed as a result of the successful authentication attempt.</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isRememberMe(<a name="AuthenticationToken" href="../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token) {
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">return</strong> token != <strong class="jxr_keyword">null</strong> &amp;&amp; (token instanceof <a name="RememberMeAuthenticationToken" href="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html#RememberMeAuthenticationToken">RememberMeAuthenticationToken</a>) &amp;&amp;
<a class="jxr_linenumber" name="L267" href="#L267">267</a> ((<a name="RememberMeAuthenticationToken" href="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html#RememberMeAuthenticationToken">RememberMeAuthenticationToken</a>) token).isRememberMe();
<a class="jxr_linenumber" name="L268" href="#L268">268</a> }
<a class="jxr_linenumber" name="L269" href="#L269">269</a>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * Reacts to the successful login attempt by first always {@link #forgetIdentity(Subject) forgetting} any previously</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * stored identity. Then if the {@code token}</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * {@link #isRememberMe(org.apache.shiro.authc.AuthenticationToken) is a RememberMe} token, the associated identity</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</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 class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * for later retrieval during a new user session.</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @param token the token that resulted in a successful authentication attempt.</em>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @param info the authentication info resulting from the successful authentication attempt.</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onSuccessfulLogin(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject, <a name="AuthenticationToken" href="../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="AuthenticationInfo" href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info) {
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_comment">//always clear any previous identity:</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> forgetIdentity(subject);
<a class="jxr_linenumber" name="L284" href="#L284">284</a>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_comment">//now save the new identity:</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">if</strong> (isRememberMe(token)) {
<a class="jxr_linenumber" name="L287" href="#L287">287</a> rememberIdentity(subject, token, info);
<a class="jxr_linenumber" name="L288" href="#L288">288</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> log.debug(<span class="jxr_string">"AuthenticationToken did not indicate RememberMe is requested. "</span> +
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <span class="jxr_string">"RememberMe functionality will not be executed for corresponding account."</span>);
<a class="jxr_linenumber" name="L292" href="#L292">292</a> }
<a class="jxr_linenumber" name="L293" href="#L293">293</a> }
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
<a class="jxr_linenumber" name="L295" href="#L295">295</a>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * Remembers a subject-unique identity for retrieval later. This implementation first</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * {@link #getIdentityToRemember resolves} the exact</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * {@link PrincipalCollection principals} to remember. It then remembers the principals by calling</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * {@link #rememberIdentity(org.apache.shiro.subject.Subject, org.apache.shiro.subject.PrincipalCollection)}.</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * This implementation ignores the {@link AuthenticationToken} argument, but it is available to subclasses if</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * necessary for custom logic.</em>
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * @param token the token that resulted in a successful authentication attempt.</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * @param authcInfo the authentication info resulting from the successful authentication attempt.</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> rememberIdentity(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject, <a name="AuthenticationToken" href="../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="AuthenticationInfo" href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> authcInfo) {
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principals = getIdentityToRemember(subject, authcInfo);
<a class="jxr_linenumber" name="L311" href="#L311">311</a> rememberIdentity(subject, principals);
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * Returns {@code info}.{@link org.apache.shiro.authc.AuthenticationInfo#getPrincipals() getPrincipals()} and</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * ignores the {@link Subject} argument.</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @param info the authentication info resulting from the successful authentication attempt.</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @return the {@code PrincipalCollection} to remember.</em>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">protected</strong> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> getIdentityToRemember(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject, <a name="AuthenticationInfo" href="../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info) {
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">return</strong> info.getPrincipals();
<a class="jxr_linenumber" name="L324" href="#L324">324</a> }
<a class="jxr_linenumber" name="L325" href="#L325">325</a>
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * Remembers the specified account principals by first</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * {@link #convertPrincipalsToBytes(org.apache.shiro.subject.PrincipalCollection) converting} them to a byte</em>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * array and then {@link #rememberSerializedIdentity(org.apache.shiro.subject.Subject, byte[]) remembers} that</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * byte array.</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * @param subject the subject for which the principals are being remembered.</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * @param accountPrincipals the principals to remember for retrieval later.</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> rememberIdentity(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject, <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> accountPrincipals) {
<a class="jxr_linenumber" name="L336" href="#L336">336</a> byte[] bytes = convertPrincipalsToBytes(accountPrincipals);
<a class="jxr_linenumber" name="L337" href="#L337">337</a> rememberSerializedIdentity(subject, bytes);
<a class="jxr_linenumber" name="L338" href="#L338">338</a> }
<a class="jxr_linenumber" name="L339" href="#L339">339</a>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * Converts the given principal collection the byte array that will be persisted to be 'remembered' later.</em>
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * This implementation first {@link #serialize(org.apache.shiro.subject.PrincipalCollection) serializes} the</em>
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * principals to a byte array and then {@link #encrypt(byte[]) encrypts} that byte array.</em>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @param principals the {@code PrincipalCollection} to convert to a byte array</em>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * @return the representative byte array to be persisted for remember me functionality.</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">protected</strong> byte[] convertPrincipalsToBytes(<a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principals) {
<a class="jxr_linenumber" name="L350" href="#L350">350</a> byte[] bytes = serialize(principals);
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">if</strong> (getCipherService() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L352" href="#L352">352</a> bytes = encrypt(bytes);
<a class="jxr_linenumber" name="L353" href="#L353">353</a> }
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> bytes;
<a class="jxr_linenumber" name="L355" href="#L355">355</a> }
<a class="jxr_linenumber" name="L356" href="#L356">356</a>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * Persists the identity bytes to a persistent store for retrieval later via the</em>
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * {@link #getRememberedSerializedIdentity(SubjectContext)} method.</em>
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * @param subject the Subject for which the identity is being serialized.</em>
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * @param serialized the serialized bytes to be persisted.</em>
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> rememberSerializedIdentity(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject, byte[] serialized);
<a class="jxr_linenumber" name="L365" href="#L365">365</a>
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * Implements the interface method by first {@link #getRememberedSerializedIdentity(SubjectContext) acquiring}</em>
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * the remembered serialized byte array. Then it {@link #convertBytesToPrincipals(byte[], SubjectContext) converts}</em>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * them and returns the re-constituted {@link PrincipalCollection}. If no remembered principals could be</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * obtained, {@code null} is returned.</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * If any exceptions are thrown, the {@link #onRememberedPrincipalFailure(RuntimeException, SubjectContext)} method</em>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * is called to allow any necessary post-processing (such as immediately removing any previously remembered</em>
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * values for safety).</em>
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em>
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance.</em>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * @return the remembered principals or {@code null} if none could be acquired.</em>
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">public</strong> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> getRememberedPrincipals(<a name="SubjectContext" href="../../../../org/apache/shiro/subject/SubjectContext.html#SubjectContext">SubjectContext</a> subjectContext) {
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principals = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L383" href="#L383">383</a> byte[] bytes = getRememberedSerializedIdentity(subjectContext);
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_comment">//SHIRO-138 - only call convertBytesToPrincipals if bytes exist:</em>
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">if</strong> (bytes != <strong class="jxr_keyword">null</strong> &amp;&amp; bytes.length &gt; 0) {
<a class="jxr_linenumber" name="L386" href="#L386">386</a> principals = convertBytesToPrincipals(bytes, subjectContext);
<a class="jxr_linenumber" name="L387" href="#L387">387</a> }
<a class="jxr_linenumber" name="L388" href="#L388">388</a> } <strong class="jxr_keyword">catch</strong> (RuntimeException re) {
<a class="jxr_linenumber" name="L389" href="#L389">389</a> principals = onRememberedPrincipalFailure(re, subjectContext);
<a class="jxr_linenumber" name="L390" href="#L390">390</a> }
<a class="jxr_linenumber" name="L391" href="#L391">391</a>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">return</strong> principals;
<a class="jxr_linenumber" name="L393" href="#L393">393</a> }
<a class="jxr_linenumber" name="L394" href="#L394">394</a>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * Based on the given subject context data, retrieves the previously persisted serialized identity, or</em>
<a class="jxr_linenumber" name="L397" href="#L397">397</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 class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * implementation. See the {@link SubjectFactory} class constants for Shiro's known map keys.</em>
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em>
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance. To be used to assist with data</em>
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * lookup.</em>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * @return the previously persisted serialized identity, or {@code null} if there is no available data for the</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * Subject.</em>
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> byte[] getRememberedSerializedIdentity(<a name="SubjectContext" href="../../../../org/apache/shiro/subject/SubjectContext.html#SubjectContext">SubjectContext</a> subjectContext);
<a class="jxr_linenumber" name="L407" href="#L407">407</a>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * If a {@link #getCipherService() cipherService} is available, it will be used to first decrypt the byte array.</em>
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * Then the bytes are then {@link #deserialize(byte[]) deserialized} and then returned.</em>
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to decrypt if necessary and then deserialize.</em>
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em>
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance.</em>
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * @return the de-serialized and possibly decrypted principals</em>
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">protected</strong> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> convertBytesToPrincipals(byte[] bytes, <a name="SubjectContext" href="../../../../org/apache/shiro/subject/SubjectContext.html#SubjectContext">SubjectContext</a> subjectContext) {
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">if</strong> (getCipherService() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L419" href="#L419">419</a> bytes = decrypt(bytes);
<a class="jxr_linenumber" name="L420" href="#L420">420</a> }
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">return</strong> deserialize(bytes);
<a class="jxr_linenumber" name="L422" href="#L422">422</a> }
<a class="jxr_linenumber" name="L423" href="#L423">423</a>
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> * Called when an exception is thrown while trying to retrieve principals. The default implementation logs a</em>
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> * warning message and forgets ('unremembers') the problem identity by calling</em>
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * {@link #forgetIdentity(SubjectContext) forgetIdentity(context)} and then immediately re-throws the</em>
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * exception to allow the calling component to react accordingly.</em>
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * This method implementation never returns an</em>
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * object - it always rethrows, but can be overridden by subclasses for custom handling behavior.</em>
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L433" href="#L433">433</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 class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * been encrypted with the previous key.</em>
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * @param e the exception that was thrown.</em>
<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * @param context the contextual data, usually provided by a {@link Subject.Builder} implementation, that</em>
<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> * is being used to construct a {@link Subject} instance.</em>
<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * @return nothing - the original {@code RuntimeException} is propagated in all cases.</em>
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong class="jxr_keyword">protected</strong> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> onRememberedPrincipalFailure(RuntimeException e, <a name="SubjectContext" href="../../../../org/apache/shiro/subject/SubjectContext.html#SubjectContext">SubjectContext</a> context) {
<a class="jxr_linenumber" name="L442" href="#L442">442</a>
<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a class="jxr_linenumber" name="L444" href="#L444">444</a> String message = <span class="jxr_string">"There was a failure while trying to retrieve remembered principals. This could be due to a "</span> +
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <span class="jxr_string">"configuration problem or corrupted principals. This could also be due to a recently "</span> +
<a class="jxr_linenumber" name="L446" href="#L446">446</a> <span class="jxr_string">"changed encryption key, if you are using a shiro.ini file, this property would be "</span> +
<a class="jxr_linenumber" name="L447" href="#L447">447</a> <span class="jxr_string">"'securityManager.rememberMeManager.cipherKey' see: http://shiro.apache.org/web.html#Web-RememberMeServices. "</span> +
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <span class="jxr_string">"The remembered identity will be forgotten and not used for this request."</span>;
<a class="jxr_linenumber" name="L449" href="#L449">449</a> log.warn(message);
<a class="jxr_linenumber" name="L450" href="#L450">450</a> }
<a class="jxr_linenumber" name="L451" href="#L451">451</a> forgetIdentity(context);
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_comment">//propagate - security manager implementation will handle and warn appropriately</em>
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">throw</strong> e;
<a class="jxr_linenumber" name="L454" href="#L454">454</a> }
<a class="jxr_linenumber" name="L455" href="#L455">455</a>
<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment"> * Encrypts the byte array by using the configured {@link #getCipherService() cipherService}.</em>
<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L459" href="#L459">459</a> <em class="jxr_javadoccomment"> * @param serialized the serialized object byte array to be encrypted</em>
<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment"> * @return an encrypted byte array returned by the configured {@link #getCipherService () cipher}.</em>
<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L462" href="#L462">462</a> <strong class="jxr_keyword">protected</strong> byte[] encrypt(byte[] serialized) {
<a class="jxr_linenumber" name="L463" href="#L463">463</a> byte[] value = serialized;
<a class="jxr_linenumber" name="L464" href="#L464">464</a> CipherService cipherService = getCipherService();
<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">if</strong> (cipherService != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L466" href="#L466">466</a> ByteSource byteSource = cipherService.encrypt(serialized, getEncryptionCipherKey());
<a class="jxr_linenumber" name="L467" href="#L467">467</a> value = byteSource.getBytes();
<a class="jxr_linenumber" name="L468" href="#L468">468</a> }
<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">return</strong> value;
<a class="jxr_linenumber" name="L470" href="#L470">470</a> }
<a class="jxr_linenumber" name="L471" href="#L471">471</a>
<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_javadoccomment"> * Decrypts the byte array using the configured {@link #getCipherService() cipherService}.</em>
<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment"> * @param encrypted the encrypted byte array to decrypt</em>
<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * @return the decrypted byte array returned by the configured {@link #getCipherService () cipher}.</em>
<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L478" href="#L478">478</a> <strong class="jxr_keyword">protected</strong> byte[] decrypt(byte[] encrypted) {
<a class="jxr_linenumber" name="L479" href="#L479">479</a> byte[] serialized = encrypted;
<a class="jxr_linenumber" name="L480" href="#L480">480</a> CipherService cipherService = getCipherService();
<a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">if</strong> (cipherService != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L482" href="#L482">482</a> ByteSource byteSource = cipherService.decrypt(encrypted, getDecryptionCipherKey());
<a class="jxr_linenumber" name="L483" href="#L483">483</a> serialized = byteSource.getBytes();
<a class="jxr_linenumber" name="L484" href="#L484">484</a> }
<a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">return</strong> serialized;
<a class="jxr_linenumber" name="L486" href="#L486">486</a> }
<a class="jxr_linenumber" name="L487" href="#L487">487</a>
<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> * Serializes the given {@code principals} by serializing them to a byte array by using the</em>
<a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment"> * {@link #getSerializer() serializer}'s {@link Serializer#serialize(Object) serialize} method.</em>
<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment"> * @param principals the principal collection to serialize to a byte array</em>
<a class="jxr_linenumber" name="L493" href="#L493">493</a> <em class="jxr_javadoccomment"> * @return the serialized principal collection in the form of a byte array</em>
<a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">protected</strong> byte[] serialize(<a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principals) {
<a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">return</strong> getSerializer().serialize(principals);
<a class="jxr_linenumber" name="L497" href="#L497">497</a> }
<a class="jxr_linenumber" name="L498" href="#L498">498</a>
<a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L500" href="#L500">500</a> <em class="jxr_javadoccomment"> * De-serializes the given byte array by using the {@link #getSerializer() serializer}'s</em>
<a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_javadoccomment"> * {@link Serializer#deserialize deserialize} method.</em>
<a class="jxr_linenumber" name="L502" href="#L502">502</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L503" href="#L503">503</a> <em class="jxr_javadoccomment"> * @param serializedIdentity the previously serialized {@code PrincipalCollection} as a byte array</em>
<a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment"> * @return the de-serialized (reconstituted) {@code PrincipalCollection}</em>
<a class="jxr_linenumber" name="L505" href="#L505">505</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L506" href="#L506">506</a> <strong class="jxr_keyword">protected</strong> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> deserialize(byte[] serializedIdentity) {
<a class="jxr_linenumber" name="L507" href="#L507">507</a> <strong class="jxr_keyword">return</strong> getSerializer().deserialize(serializedIdentity);
<a class="jxr_linenumber" name="L508" href="#L508">508</a> }
<a class="jxr_linenumber" name="L509" href="#L509">509</a>
<a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> * Reacts to a failed login by immediately {@link #forgetIdentity(org.apache.shiro.subject.Subject) forgetting} any</em>
<a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment"> * previously remembered identity. This is an additional security feature to prevent any remenant identity data</em>
<a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * from being retained in case the authentication attempt is not being executed by the expected user.</em>
<a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L515" href="#L515">515</a> <em class="jxr_javadoccomment"> * @param subject the subject which executed the failed login attempt</em>
<a class="jxr_linenumber" name="L516" href="#L516">516</a> <em class="jxr_javadoccomment"> * @param token the authentication token resulting in a failed login attempt - ignored by this implementation</em>
<a class="jxr_linenumber" name="L517" href="#L517">517</a> <em class="jxr_javadoccomment"> * @param ae the exception thrown as a result of the failed login attempt - ignored by this implementation</em>
<a class="jxr_linenumber" name="L518" href="#L518">518</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L519" href="#L519">519</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onFailedLogin(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject, <a name="AuthenticationToken" href="../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="AuthenticationException" href="../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> ae) {
<a class="jxr_linenumber" name="L520" href="#L520">520</a> forgetIdentity(subject);
<a class="jxr_linenumber" name="L521" href="#L521">521</a> }
<a class="jxr_linenumber" name="L522" href="#L522">522</a>
<a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment"> * Reacts to a subject logging out of the application and immediately</em>
<a class="jxr_linenumber" name="L525" href="#L525">525</a> <em class="jxr_javadoccomment"> * {@link #forgetIdentity(org.apache.shiro.subject.Subject) forgets} any previously stored identity and returns.</em>
<a class="jxr_linenumber" name="L526" href="#L526">526</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L527" href="#L527">527</a> <em class="jxr_javadoccomment"> * @param subject the subject logging out.</em>
<a class="jxr_linenumber" name="L528" href="#L528">528</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L529" href="#L529">529</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onLogout(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) {
<a class="jxr_linenumber" name="L530" href="#L530">530</a> forgetIdentity(subject);
<a class="jxr_linenumber" name="L531" href="#L531">531</a> }
<a class="jxr_linenumber" name="L532" href="#L532">532</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>