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