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