| <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.authc;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> /**<a name="line.21"></a> |
| <FONT color="green">022</FONT> * <p>A simple username/password authentication token to support the most widely-used authentication mechanism. This<a name="line.22"></a> |
| <FONT color="green">023</FONT> * class also implements the {@link RememberMeAuthenticationToken RememberMeAuthenticationToken} interface to support<a name="line.23"></a> |
| <FONT color="green">024</FONT> * &quot;Remember Me&quot; services across user sessions as well as the<a name="line.24"></a> |
| <FONT color="green">025</FONT> * {@link org.apache.shiro.authc.HostAuthenticationToken HostAuthenticationToken} interface to retain the host name<a name="line.25"></a> |
| <FONT color="green">026</FONT> * or IP address location from where the authentication attempt is occuring.</p><a name="line.26"></a> |
| <FONT color="green">027</FONT> * <p/><a name="line.27"></a> |
| <FONT color="green">028</FONT> * <p>&quot;Remember Me&quot; authentications are disabled by default, but if the application developer wishes to allow<a name="line.28"></a> |
| <FONT color="green">029</FONT> * it for a login attempt, all that is necessary is to call {@link #setRememberMe setRememberMe(true)}. If the underlying<a name="line.29"></a> |
| <FONT color="green">030</FONT> * <tt>SecurityManager</tt> implementation also supports <tt>RememberMe</tt> services, the user's identity will be<a name="line.30"></a> |
| <FONT color="green">031</FONT> * remembered across sessions.<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <p/><a name="line.32"></a> |
| <FONT color="green">033</FONT> * <p>Note that this class stores a password as a char[] instead of a String<a name="line.33"></a> |
| <FONT color="green">034</FONT> * (which may seem more logical). This is because Strings are immutable and their<a name="line.34"></a> |
| <FONT color="green">035</FONT> * internal value cannot be overwritten - meaning even a nulled String instance might be accessible in memory at a later<a name="line.35"></a> |
| <FONT color="green">036</FONT> * time (e.g. memory dump). This is not good for sensitive information such as passwords. For more information, see the<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <a href="http://java.sun.com/j2se/1.5.0/docs/guide/security/jce/JCERefGuide.html#PBEEx"><a name="line.37"></a> |
| <FONT color="green">038</FONT> * Java Cryptography Extension Reference Guide</a>.</p><a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p/><a name="line.39"></a> |
| <FONT color="green">040</FONT> * <p>To avoid this possibility of later memory access, the application developer should always call<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link #clear() clear()} after using the token to perform a login attempt.</p><a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * @since 0.1<a name="line.43"></a> |
| <FONT color="green">044</FONT> */<a name="line.44"></a> |
| <FONT color="green">045</FONT> public class UsernamePasswordToken implements HostAuthenticationToken, RememberMeAuthenticationToken {<a name="line.45"></a> |
| <FONT color="green">046</FONT> <a name="line.46"></a> |
| <FONT color="green">047</FONT> /*--------------------------------------------<a name="line.47"></a> |
| <FONT color="green">048</FONT> | C O N S T A N T S |<a name="line.48"></a> |
| <FONT color="green">049</FONT> ============================================*/<a name="line.49"></a> |
| <FONT color="green">050</FONT> <a name="line.50"></a> |
| <FONT color="green">051</FONT> /*--------------------------------------------<a name="line.51"></a> |
| <FONT color="green">052</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.52"></a> |
| <FONT color="green">053</FONT> ============================================*/<a name="line.53"></a> |
| <FONT color="green">054</FONT> /**<a name="line.54"></a> |
| <FONT color="green">055</FONT> * The username<a name="line.55"></a> |
| <FONT color="green">056</FONT> */<a name="line.56"></a> |
| <FONT color="green">057</FONT> private String username;<a name="line.57"></a> |
| <FONT color="green">058</FONT> <a name="line.58"></a> |
| <FONT color="green">059</FONT> /**<a name="line.59"></a> |
| <FONT color="green">060</FONT> * The password, in char[] format<a name="line.60"></a> |
| <FONT color="green">061</FONT> */<a name="line.61"></a> |
| <FONT color="green">062</FONT> private char[] password;<a name="line.62"></a> |
| <FONT color="green">063</FONT> <a name="line.63"></a> |
| <FONT color="green">064</FONT> /**<a name="line.64"></a> |
| <FONT color="green">065</FONT> * Whether or not 'rememberMe' should be enabled for the corresponding login attempt;<a name="line.65"></a> |
| <FONT color="green">066</FONT> * default is <code>false</code><a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> private boolean rememberMe = false;<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> /**<a name="line.70"></a> |
| <FONT color="green">071</FONT> * The location from where the login attempt occurs, or <code>null</code> if not known or explicitly<a name="line.71"></a> |
| <FONT color="green">072</FONT> * omitted.<a name="line.72"></a> |
| <FONT color="green">073</FONT> */<a name="line.73"></a> |
| <FONT color="green">074</FONT> private String host;<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> /*--------------------------------------------<a name="line.76"></a> |
| <FONT color="green">077</FONT> | C O N S T R U C T O R S |<a name="line.77"></a> |
| <FONT color="green">078</FONT> ============================================*/<a name="line.78"></a> |
| <FONT color="green">079</FONT> <a name="line.79"></a> |
| <FONT color="green">080</FONT> /**<a name="line.80"></a> |
| <FONT color="green">081</FONT> * JavaBeans compatible no-arg constructor.<a name="line.81"></a> |
| <FONT color="green">082</FONT> */<a name="line.82"></a> |
| <FONT color="green">083</FONT> public UsernamePasswordToken() {<a name="line.83"></a> |
| <FONT color="green">084</FONT> }<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> /**<a name="line.86"></a> |
| <FONT color="green">087</FONT> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted<a name="line.87"></a> |
| <FONT color="green">088</FONT> * during an authentication attempt, with a <tt>null</tt> {@link #getHost() host} and a<a name="line.88"></a> |
| <FONT color="green">089</FONT> * <tt>rememberMe</tt> default of <tt>false</tt>.<a name="line.89"></a> |
| <FONT color="green">090</FONT> *<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @param username the username submitted for authentication<a name="line.91"></a> |
| <FONT color="green">092</FONT> * @param password the password character array submitted for authentication<a name="line.92"></a> |
| <FONT color="green">093</FONT> */<a name="line.93"></a> |
| <FONT color="green">094</FONT> public UsernamePasswordToken(final String username, final char[] password) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> this(username, password, false, null);<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> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted<a name="line.99"></a> |
| <FONT color="green">100</FONT> * during an authentication attempt, with a <tt>null</tt> {@link #getHost() host} and<a name="line.100"></a> |
| <FONT color="green">101</FONT> * a <tt>rememberMe</tt> default of <tt>false</tt><a name="line.101"></a> |
| <FONT color="green">102</FONT> * <p/><a name="line.102"></a> |
| <FONT color="green">103</FONT> * <p>This is a convience constructor and maintains the password internally via a character<a name="line.103"></a> |
| <FONT color="green">104</FONT> * array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String<a name="line.104"></a> |
| <FONT color="green">105</FONT> * in your code could have possible security implications as noted in the class JavaDoc.</p><a name="line.105"></a> |
| <FONT color="green">106</FONT> *<a name="line.106"></a> |
| <FONT color="green">107</FONT> * @param username the username submitted for authentication<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @param password the password string submitted for authentication<a name="line.108"></a> |
| <FONT color="green">109</FONT> */<a name="line.109"></a> |
| <FONT color="green">110</FONT> public UsernamePasswordToken(final String username, final String password) {<a name="line.110"></a> |
| <FONT color="green">111</FONT> this(username, password != null ? password.toCharArray() : null, false, null);<a name="line.111"></a> |
| <FONT color="green">112</FONT> }<a name="line.112"></a> |
| <FONT color="green">113</FONT> <a name="line.113"></a> |
| <FONT color="green">114</FONT> /**<a name="line.114"></a> |
| <FONT color="green">115</FONT> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the<a name="line.115"></a> |
| <FONT color="green">116</FONT> * inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt><a name="line.116"></a> |
| <FONT color="green">117</FONT> *<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @param username the username submitted for authentication<a name="line.118"></a> |
| <FONT color="green">119</FONT> * @param password the password string submitted for authentication<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @param host the host name or IP string from where the attempt is occuring<a name="line.120"></a> |
| <FONT color="green">121</FONT> * @since 0.2<a name="line.121"></a> |
| <FONT color="green">122</FONT> */<a name="line.122"></a> |
| <FONT color="green">123</FONT> public UsernamePasswordToken(final String username, final char[] password, final String host) {<a name="line.123"></a> |
| <FONT color="green">124</FONT> this(username, password, false, host);<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> /**<a name="line.127"></a> |
| <FONT color="green">128</FONT> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the<a name="line.128"></a> |
| <FONT color="green">129</FONT> * inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt><a name="line.129"></a> |
| <FONT color="green">130</FONT> * <p/><a name="line.130"></a> |
| <FONT color="green">131</FONT> * <p>This is a convience constructor and maintains the password internally via a character<a name="line.131"></a> |
| <FONT color="green">132</FONT> * array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String<a name="line.132"></a> |
| <FONT color="green">133</FONT> * in your code could have possible security implications as noted in the class JavaDoc.</p><a name="line.133"></a> |
| <FONT color="green">134</FONT> *<a name="line.134"></a> |
| <FONT color="green">135</FONT> * @param username the username submitted for authentication<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @param password the password string submitted for authentication<a name="line.136"></a> |
| <FONT color="green">137</FONT> * @param host the host name or IP string from where the attempt is occuring<a name="line.137"></a> |
| <FONT color="green">138</FONT> * @since 1.0<a name="line.138"></a> |
| <FONT color="green">139</FONT> */<a name="line.139"></a> |
| <FONT color="green">140</FONT> public UsernamePasswordToken(final String username, final String password, final String host) {<a name="line.140"></a> |
| <FONT color="green">141</FONT> this(username, password != null ? password.toCharArray() : null, false, host);<a name="line.141"></a> |
| <FONT color="green">142</FONT> }<a name="line.142"></a> |
| <FONT color="green">143</FONT> <a name="line.143"></a> |
| <FONT color="green">144</FONT> /**<a name="line.144"></a> |
| <FONT color="green">145</FONT> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user<a name="line.145"></a> |
| <FONT color="green">146</FONT> * wishes their identity to be remembered across sessions.<a name="line.146"></a> |
| <FONT color="green">147</FONT> *<a name="line.147"></a> |
| <FONT color="green">148</FONT> * @param username the username submitted for authentication<a name="line.148"></a> |
| <FONT color="green">149</FONT> * @param password the password string submitted for authentication<a name="line.149"></a> |
| <FONT color="green">150</FONT> * @param rememberMe if the user wishes their identity to be remembered across sessions<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @since 0.9<a name="line.151"></a> |
| <FONT color="green">152</FONT> */<a name="line.152"></a> |
| <FONT color="green">153</FONT> public UsernamePasswordToken(final String username, final char[] password, final boolean rememberMe) {<a name="line.153"></a> |
| <FONT color="green">154</FONT> this(username, password, rememberMe, null);<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> /**<a name="line.157"></a> |
| <FONT color="green">158</FONT> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user<a name="line.158"></a> |
| <FONT color="green">159</FONT> * wishes their identity to be remembered across sessions.<a name="line.159"></a> |
| <FONT color="green">160</FONT> * <p/><a name="line.160"></a> |
| <FONT color="green">161</FONT> * <p>This is a convience constructor and maintains the password internally via a character<a name="line.161"></a> |
| <FONT color="green">162</FONT> * array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String<a name="line.162"></a> |
| <FONT color="green">163</FONT> * in your code could have possible security implications as noted in the class JavaDoc.</p><a name="line.163"></a> |
| <FONT color="green">164</FONT> *<a name="line.164"></a> |
| <FONT color="green">165</FONT> * @param username the username submitted for authentication<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @param password the password string submitted for authentication<a name="line.166"></a> |
| <FONT color="green">167</FONT> * @param rememberMe if the user wishes their identity to be remembered across sessions<a name="line.167"></a> |
| <FONT color="green">168</FONT> * @since 0.9<a name="line.168"></a> |
| <FONT color="green">169</FONT> */<a name="line.169"></a> |
| <FONT color="green">170</FONT> public UsernamePasswordToken(final String username, final String password, final boolean rememberMe) {<a name="line.170"></a> |
| <FONT color="green">171</FONT> this(username, password != null ? password.toCharArray() : null, rememberMe, null);<a name="line.171"></a> |
| <FONT color="green">172</FONT> }<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> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user<a name="line.175"></a> |
| <FONT color="green">176</FONT> * wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is ocurring.<a name="line.176"></a> |
| <FONT color="green">177</FONT> *<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @param username the username submitted for authentication<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @param password the password character array submitted for authentication<a name="line.179"></a> |
| <FONT color="green">180</FONT> * @param rememberMe if the user wishes their identity to be remembered across sessions<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @param host the host name or IP string from where the attempt is occuring<a name="line.181"></a> |
| <FONT color="green">182</FONT> * @since 1.0<a name="line.182"></a> |
| <FONT color="green">183</FONT> */<a name="line.183"></a> |
| <FONT color="green">184</FONT> public UsernamePasswordToken(final String username, final char[] password,<a name="line.184"></a> |
| <FONT color="green">185</FONT> final boolean rememberMe, final String host) {<a name="line.185"></a> |
| <FONT color="green">186</FONT> <a name="line.186"></a> |
| <FONT color="green">187</FONT> this.username = username;<a name="line.187"></a> |
| <FONT color="green">188</FONT> this.password = password;<a name="line.188"></a> |
| <FONT color="green">189</FONT> this.rememberMe = rememberMe;<a name="line.189"></a> |
| <FONT color="green">190</FONT> this.host = host;<a name="line.190"></a> |
| <FONT color="green">191</FONT> }<a name="line.191"></a> |
| <FONT color="green">192</FONT> <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> * Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user<a name="line.195"></a> |
| <FONT color="green">196</FONT> * wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is ocurring.<a name="line.196"></a> |
| <FONT color="green">197</FONT> * <p/><a name="line.197"></a> |
| <FONT color="green">198</FONT> * <p>This is a convience constructor and maintains the password internally via a character<a name="line.198"></a> |
| <FONT color="green">199</FONT> * array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String<a name="line.199"></a> |
| <FONT color="green">200</FONT> * in your code could have possible security implications as noted in the class JavaDoc.</p><a name="line.200"></a> |
| <FONT color="green">201</FONT> *<a name="line.201"></a> |
| <FONT color="green">202</FONT> * @param username the username submitted for authentication<a name="line.202"></a> |
| <FONT color="green">203</FONT> * @param password the password string submitted for authentication<a name="line.203"></a> |
| <FONT color="green">204</FONT> * @param rememberMe if the user wishes their identity to be remembered across sessions<a name="line.204"></a> |
| <FONT color="green">205</FONT> * @param host the host name or IP string from where the attempt is occuring<a name="line.205"></a> |
| <FONT color="green">206</FONT> * @since 1.0<a name="line.206"></a> |
| <FONT color="green">207</FONT> */<a name="line.207"></a> |
| <FONT color="green">208</FONT> public UsernamePasswordToken(final String username, final String password,<a name="line.208"></a> |
| <FONT color="green">209</FONT> final boolean rememberMe, final String host) {<a name="line.209"></a> |
| <FONT color="green">210</FONT> this(username, password != null ? password.toCharArray() : null, rememberMe, host);<a name="line.210"></a> |
| <FONT color="green">211</FONT> }<a name="line.211"></a> |
| <FONT color="green">212</FONT> <a name="line.212"></a> |
| <FONT color="green">213</FONT> /*--------------------------------------------<a name="line.213"></a> |
| <FONT color="green">214</FONT> | A C C E S S O R S / M O D I F I E R S |<a name="line.214"></a> |
| <FONT color="green">215</FONT> ============================================*/<a name="line.215"></a> |
| <FONT color="green">216</FONT> <a name="line.216"></a> |
| <FONT color="green">217</FONT> /**<a name="line.217"></a> |
| <FONT color="green">218</FONT> * Returns the username submitted during an authentication attempt.<a name="line.218"></a> |
| <FONT color="green">219</FONT> *<a name="line.219"></a> |
| <FONT color="green">220</FONT> * @return the username submitted during an authentication attempt.<a name="line.220"></a> |
| <FONT color="green">221</FONT> */<a name="line.221"></a> |
| <FONT color="green">222</FONT> public String getUsername() {<a name="line.222"></a> |
| <FONT color="green">223</FONT> return username;<a name="line.223"></a> |
| <FONT color="green">224</FONT> }<a name="line.224"></a> |
| <FONT color="green">225</FONT> <a name="line.225"></a> |
| <FONT color="green">226</FONT> /**<a name="line.226"></a> |
| <FONT color="green">227</FONT> * Sets the username for submission during an authentication attempt.<a name="line.227"></a> |
| <FONT color="green">228</FONT> *<a name="line.228"></a> |
| <FONT color="green">229</FONT> * @param username the username to be used for submission during an authentication attempt.<a name="line.229"></a> |
| <FONT color="green">230</FONT> */<a name="line.230"></a> |
| <FONT color="green">231</FONT> public void setUsername(String username) {<a name="line.231"></a> |
| <FONT color="green">232</FONT> this.username = username;<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> <a name="line.235"></a> |
| <FONT color="green">236</FONT> /**<a name="line.236"></a> |
| <FONT color="green">237</FONT> * Returns the password submitted during an authentication attempt as a character array.<a name="line.237"></a> |
| <FONT color="green">238</FONT> *<a name="line.238"></a> |
| <FONT color="green">239</FONT> * @return the password submitted during an authentication attempt as a character array.<a name="line.239"></a> |
| <FONT color="green">240</FONT> */<a name="line.240"></a> |
| <FONT color="green">241</FONT> public char[] getPassword() {<a name="line.241"></a> |
| <FONT color="green">242</FONT> return password;<a name="line.242"></a> |
| <FONT color="green">243</FONT> }<a name="line.243"></a> |
| <FONT color="green">244</FONT> <a name="line.244"></a> |
| <FONT color="green">245</FONT> /**<a name="line.245"></a> |
| <FONT color="green">246</FONT> * Sets the password for submission during an authentication attempt.<a name="line.246"></a> |
| <FONT color="green">247</FONT> *<a name="line.247"></a> |
| <FONT color="green">248</FONT> * @param password the password to be used for submission during an authentication attemp.<a name="line.248"></a> |
| <FONT color="green">249</FONT> */<a name="line.249"></a> |
| <FONT color="green">250</FONT> public void setPassword(char[] password) {<a name="line.250"></a> |
| <FONT color="green">251</FONT> this.password = password;<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> * Simply returns {@link #getUsername() getUsername()}.<a name="line.255"></a> |
| <FONT color="green">256</FONT> *<a name="line.256"></a> |
| <FONT color="green">257</FONT> * @return the {@link #getUsername() username}.<a name="line.257"></a> |
| <FONT color="green">258</FONT> * @see org.apache.shiro.authc.AuthenticationToken#getPrincipal()<a name="line.258"></a> |
| <FONT color="green">259</FONT> */<a name="line.259"></a> |
| <FONT color="green">260</FONT> public Object getPrincipal() {<a name="line.260"></a> |
| <FONT color="green">261</FONT> return getUsername();<a name="line.261"></a> |
| <FONT color="green">262</FONT> }<a name="line.262"></a> |
| <FONT color="green">263</FONT> <a name="line.263"></a> |
| <FONT color="green">264</FONT> /**<a name="line.264"></a> |
| <FONT color="green">265</FONT> * Returns the {@link #getPassword() password} char array.<a name="line.265"></a> |
| <FONT color="green">266</FONT> *<a name="line.266"></a> |
| <FONT color="green">267</FONT> * @return the {@link #getPassword() password} char array.<a name="line.267"></a> |
| <FONT color="green">268</FONT> * @see org.apache.shiro.authc.AuthenticationToken#getCredentials()<a name="line.268"></a> |
| <FONT color="green">269</FONT> */<a name="line.269"></a> |
| <FONT color="green">270</FONT> public Object getCredentials() {<a name="line.270"></a> |
| <FONT color="green">271</FONT> return getPassword();<a name="line.271"></a> |
| <FONT color="green">272</FONT> }<a name="line.272"></a> |
| <FONT color="green">273</FONT> <a name="line.273"></a> |
| <FONT color="green">274</FONT> /**<a name="line.274"></a> |
| <FONT color="green">275</FONT> * Returns the host name or IP string from where the authentication attempt occurs. May be <tt>null</tt> if the<a name="line.275"></a> |
| <FONT color="green">276</FONT> * host name/IP is unknown or explicitly omitted. It is up to the Authenticator implementation processing this<a name="line.276"></a> |
| <FONT color="green">277</FONT> * token if an authentication attempt without a host is valid or not.<a name="line.277"></a> |
| <FONT color="green">278</FONT> * <p/><a name="line.278"></a> |
| <FONT color="green">279</FONT> * <p>(Shiro's default Authenticator allows <tt>null</tt> hosts to support localhost and proxy server environments).</p><a name="line.279"></a> |
| <FONT color="green">280</FONT> *<a name="line.280"></a> |
| <FONT color="green">281</FONT> * @return the host from where the authentication attempt occurs, or <tt>null</tt> if it is unknown or<a name="line.281"></a> |
| <FONT color="green">282</FONT> * explicitly omitted.<a name="line.282"></a> |
| <FONT color="green">283</FONT> * @since 1.0<a name="line.283"></a> |
| <FONT color="green">284</FONT> */<a name="line.284"></a> |
| <FONT color="green">285</FONT> public String getHost() {<a name="line.285"></a> |
| <FONT color="green">286</FONT> return host;<a name="line.286"></a> |
| <FONT color="green">287</FONT> }<a name="line.287"></a> |
| <FONT color="green">288</FONT> <a name="line.288"></a> |
| <FONT color="green">289</FONT> /**<a name="line.289"></a> |
| <FONT color="green">290</FONT> * Sets the host name or IP string from where the authentication attempt occurs. It is up to the Authenticator<a name="line.290"></a> |
| <FONT color="green">291</FONT> * implementation processing this token if an authentication attempt without a host is valid or not.<a name="line.291"></a> |
| <FONT color="green">292</FONT> * <p/><a name="line.292"></a> |
| <FONT color="green">293</FONT> * <p>(Shiro's default Authenticator<a name="line.293"></a> |
| <FONT color="green">294</FONT> * allows <tt>null</tt> hosts to allow localhost and proxy server environments).</p><a name="line.294"></a> |
| <FONT color="green">295</FONT> *<a name="line.295"></a> |
| <FONT color="green">296</FONT> * @param host the host name or IP string from where the attempt is occuring<a name="line.296"></a> |
| <FONT color="green">297</FONT> * @since 1.0<a name="line.297"></a> |
| <FONT color="green">298</FONT> */<a name="line.298"></a> |
| <FONT color="green">299</FONT> public void setHost(String host) {<a name="line.299"></a> |
| <FONT color="green">300</FONT> this.host = host;<a name="line.300"></a> |
| <FONT color="green">301</FONT> }<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> * Returns <tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered<a name="line.304"></a> |
| <FONT color="green">305</FONT> * across sessions, <tt>false</tt> otherwise. Unless overridden, this value is <tt>false</tt> by default.<a name="line.305"></a> |
| <FONT color="green">306</FONT> *<a name="line.306"></a> |
| <FONT color="green">307</FONT> * @return <tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered<a name="line.307"></a> |
| <FONT color="green">308</FONT> * across sessions, <tt>false</tt> otherwise (<tt>false</tt> by default).<a name="line.308"></a> |
| <FONT color="green">309</FONT> * @since 0.9<a name="line.309"></a> |
| <FONT color="green">310</FONT> */<a name="line.310"></a> |
| <FONT color="green">311</FONT> public boolean isRememberMe() {<a name="line.311"></a> |
| <FONT color="green">312</FONT> return rememberMe;<a name="line.312"></a> |
| <FONT color="green">313</FONT> }<a name="line.313"></a> |
| <FONT color="green">314</FONT> <a name="line.314"></a> |
| <FONT color="green">315</FONT> /**<a name="line.315"></a> |
| <FONT color="green">316</FONT> * Sets if the submitting user wishes their identity (pricipal(s)) to be remembered across sessions. Unless<a name="line.316"></a> |
| <FONT color="green">317</FONT> * overridden, the default value is <tt>false</tt>, indicating <em>not</em> to be remembered across sessions.<a name="line.317"></a> |
| <FONT color="green">318</FONT> *<a name="line.318"></a> |
| <FONT color="green">319</FONT> * @param rememberMe value inidicating if the user wishes their identity (principal(s)) to be remembered across<a name="line.319"></a> |
| <FONT color="green">320</FONT> * sessions.<a name="line.320"></a> |
| <FONT color="green">321</FONT> * @since 0.9<a name="line.321"></a> |
| <FONT color="green">322</FONT> */<a name="line.322"></a> |
| <FONT color="green">323</FONT> public void setRememberMe(boolean rememberMe) {<a name="line.323"></a> |
| <FONT color="green">324</FONT> this.rememberMe = rememberMe;<a name="line.324"></a> |
| <FONT color="green">325</FONT> }<a name="line.325"></a> |
| <FONT color="green">326</FONT> <a name="line.326"></a> |
| <FONT color="green">327</FONT> /*--------------------------------------------<a name="line.327"></a> |
| <FONT color="green">328</FONT> | M E T H O D S |<a name="line.328"></a> |
| <FONT color="green">329</FONT> ============================================*/<a name="line.329"></a> |
| <FONT color="green">330</FONT> <a name="line.330"></a> |
| <FONT color="green">331</FONT> /**<a name="line.331"></a> |
| <FONT color="green">332</FONT> * Clears out (nulls) the username, password, rememberMe, and inetAddress. The password bytes are explicitly set to<a name="line.332"></a> |
| <FONT color="green">333</FONT> * <tt>0x00</tt> before nulling to eliminate the possibility of memory access at a later time.<a name="line.333"></a> |
| <FONT color="green">334</FONT> */<a name="line.334"></a> |
| <FONT color="green">335</FONT> public void clear() {<a name="line.335"></a> |
| <FONT color="green">336</FONT> this.username = null;<a name="line.336"></a> |
| <FONT color="green">337</FONT> this.host = null;<a name="line.337"></a> |
| <FONT color="green">338</FONT> this.rememberMe = false;<a name="line.338"></a> |
| <FONT color="green">339</FONT> <a name="line.339"></a> |
| <FONT color="green">340</FONT> if (this.password != null) {<a name="line.340"></a> |
| <FONT color="green">341</FONT> for (int i = 0; i < password.length; i++) {<a name="line.341"></a> |
| <FONT color="green">342</FONT> this.password[i] = 0x00;<a name="line.342"></a> |
| <FONT color="green">343</FONT> }<a name="line.343"></a> |
| <FONT color="green">344</FONT> this.password = null;<a name="line.344"></a> |
| <FONT color="green">345</FONT> }<a name="line.345"></a> |
| <FONT color="green">346</FONT> <a name="line.346"></a> |
| <FONT color="green">347</FONT> }<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> * Returns the String representation. It does not include the password in the resulting<a name="line.350"></a> |
| <FONT color="green">351</FONT> * string for security reasons to prevent accidentially printing out a password<a name="line.351"></a> |
| <FONT color="green">352</FONT> * that might be widely viewable).<a name="line.352"></a> |
| <FONT color="green">353</FONT> *<a name="line.353"></a> |
| <FONT color="green">354</FONT> * @return the String representation of the <tt>UsernamePasswordToken</tt>, omitting<a name="line.354"></a> |
| <FONT color="green">355</FONT> * the password.<a name="line.355"></a> |
| <FONT color="green">356</FONT> */<a name="line.356"></a> |
| <FONT color="green">357</FONT> public String toString() {<a name="line.357"></a> |
| <FONT color="green">358</FONT> StringBuilder sb = new StringBuilder();<a name="line.358"></a> |
| <FONT color="green">359</FONT> sb.append(getClass().getName());<a name="line.359"></a> |
| <FONT color="green">360</FONT> sb.append(" - ");<a name="line.360"></a> |
| <FONT color="green">361</FONT> sb.append(username);<a name="line.361"></a> |
| <FONT color="green">362</FONT> sb.append(", rememberMe=").append(rememberMe);<a name="line.362"></a> |
| <FONT color="green">363</FONT> if (host != null) {<a name="line.363"></a> |
| <FONT color="green">364</FONT> sb.append(" (").append(host).append(")");<a name="line.364"></a> |
| <FONT color="green">365</FONT> }<a name="line.365"></a> |
| <FONT color="green">366</FONT> return sb.toString();<a name="line.366"></a> |
| <FONT color="green">367</FONT> }<a name="line.367"></a> |
| <FONT color="green">368</FONT> <a name="line.368"></a> |
| <FONT color="green">369</FONT> }<a name="line.369"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
