| <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.credential;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.util.ByteSource;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> /**<a name="line.23"></a> |
| <FONT color="green">024</FONT> * A {@code PasswordService} supports common use cases when using passwords as a credentials mechanism.<a name="line.24"></a> |
| <FONT color="green">025</FONT> * <p/><a name="line.25"></a> |
| <FONT color="green">026</FONT> * Most importantly, implementations of this interface are expected to employ best-practices to ensure that<a name="line.26"></a> |
| <FONT color="green">027</FONT> * passwords remain as safe as possible in application environments.<a name="line.27"></a> |
| <FONT color="green">028</FONT> * <h2>Usage</h2><a name="line.28"></a> |
| <FONT color="green">029</FONT> * A {@code PasswordService} is used at two different times during an application's lifecycle:<a name="line.29"></a> |
| <FONT color="green">030</FONT> * <ul><a name="line.30"></a> |
| <FONT color="green">031</FONT> * <li>When creating a user account or resetting their password</li><a name="line.31"></a> |
| <FONT color="green">032</FONT> * <li>When a user logs in, when passwords must be compared</li><a name="line.32"></a> |
| <FONT color="green">033</FONT> * </ul><a name="line.33"></a> |
| <FONT color="green">034</FONT> * <h3>Account Creation or Password Reset</h3><a name="line.34"></a> |
| <FONT color="green">035</FONT> * Whenever you create a new user account or reset that account's password, we must translate the end-user submitted<a name="line.35"></a> |
| <FONT color="green">036</FONT> * raw/plaintext password value to a string format that is much safer to store. You do that by calling the<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@link #encryptPassword(Object)} method to create the safer value. For<a name="line.37"></a> |
| <FONT color="green">038</FONT> * example:<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <pre><a name="line.39"></a> |
| <FONT color="green">040</FONT> * String submittedPlaintextPassword = ...<a name="line.40"></a> |
| <FONT color="green">041</FONT> * String encryptedValue = passwordService.encryptPassword(submittedPlaintextPassword);<a name="line.41"></a> |
| <FONT color="green">042</FONT> * ...<a name="line.42"></a> |
| <FONT color="green">043</FONT> * userAccount.setPassword(encryptedValue);<a name="line.43"></a> |
| <FONT color="green">044</FONT> * userAccount.save(); //create or update to your data store<a name="line.44"></a> |
| <FONT color="green">045</FONT> * </pre><a name="line.45"></a> |
| <FONT color="green">046</FONT> * Be sure to save this encrypted password in your data store and never the original/raw submitted password.<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <h3>Login Password Comparison</h3><a name="line.47"></a> |
| <FONT color="green">048</FONT> * Shiro performs the comparison during login automatically. Along with your {@code PasswordService}, you just<a name="line.48"></a> |
| <FONT color="green">049</FONT> * have to configure a {@link PasswordMatcher} on a realm that has password-based accounts. During a login attempt,<a name="line.49"></a> |
| <FONT color="green">050</FONT> * shiro will use the {@code PasswordMatcher} and the {@code PasswordService} to automatically compare submitted<a name="line.50"></a> |
| <FONT color="green">051</FONT> * passwords.<a name="line.51"></a> |
| <FONT color="green">052</FONT> * <p/><a name="line.52"></a> |
| <FONT color="green">053</FONT> * For example, if using Shiro's INI, here is how you might configure the PasswordMatcher and PasswordService:<a name="line.53"></a> |
| <FONT color="green">054</FONT> * <pre><a name="line.54"></a> |
| <FONT color="green">055</FONT> * [main]<a name="line.55"></a> |
| <FONT color="green">056</FONT> * ...<a name="line.56"></a> |
| <FONT color="green">057</FONT> * passwordService = org.apache.shiro.authc.credential.DefaultPasswordService<a name="line.57"></a> |
| <FONT color="green">058</FONT> * # configure the passwordService to use the settings you desire<a name="line.58"></a> |
| <FONT color="green">059</FONT> * ...<a name="line.59"></a> |
| <FONT color="green">060</FONT> * passwordMatcher = org.apache.shiro.authc.credential.PasswordMatcher<a name="line.60"></a> |
| <FONT color="green">061</FONT> * passwordMatcher.passwordService = $passwordService<a name="line.61"></a> |
| <FONT color="green">062</FONT> * ...<a name="line.62"></a> |
| <FONT color="green">063</FONT> * # Finally, set the matcher on a realm that requires password matching for account authentication:<a name="line.63"></a> |
| <FONT color="green">064</FONT> * myRealm = ...<a name="line.64"></a> |
| <FONT color="green">065</FONT> * myRealm.credentialsMatcher = $passwordMatcher<a name="line.65"></a> |
| <FONT color="green">066</FONT> * </pre><a name="line.66"></a> |
| <FONT color="green">067</FONT> *<a name="line.67"></a> |
| <FONT color="green">068</FONT> * @see DefaultPasswordService<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @see PasswordMatcher<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @since 1.2<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> public interface PasswordService {<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> /**<a name="line.74"></a> |
| <FONT color="green">075</FONT> * Converts the specified plaintext password (usually acquired from your application's 'new user' or 'password reset'<a name="line.75"></a> |
| <FONT color="green">076</FONT> * workflow) into a formatted string safe for storage. The returned string can be safely saved with the<a name="line.76"></a> |
| <FONT color="green">077</FONT> * corresponding user account record (e.g. as a 'password' attribute).<a name="line.77"></a> |
| <FONT color="green">078</FONT> * <p/><a name="line.78"></a> |
| <FONT color="green">079</FONT> * It is expected that the String returned from this method will be presented to the<a name="line.79"></a> |
| <FONT color="green">080</FONT> * {@link #passwordsMatch(Object, String) passwordsMatch(plaintext,encrypted)} method when performing a<a name="line.80"></a> |
| <FONT color="green">081</FONT> * password comparison check.<a name="line.81"></a> |
| <FONT color="green">082</FONT> * <h3>Usage</h3><a name="line.82"></a> |
| <FONT color="green">083</FONT> * The input argument type can be any 'byte backed' {@code Object} - almost always either a<a name="line.83"></a> |
| <FONT color="green">084</FONT> * String or character array representing passwords (character arrays are often a safer way to represent passwords<a name="line.84"></a> |
| <FONT color="green">085</FONT> * as they can be cleared/nulled-out after use. Any argument type supported by<a name="line.85"></a> |
| <FONT color="green">086</FONT> * {@link ByteSource.Util#isCompatible(Object)} is valid.<a name="line.86"></a> |
| <FONT color="green">087</FONT> * <p/><a name="line.87"></a> |
| <FONT color="green">088</FONT> * For example:<a name="line.88"></a> |
| <FONT color="green">089</FONT> * <pre><a name="line.89"></a> |
| <FONT color="green">090</FONT> * String rawPassword = ...<a name="line.90"></a> |
| <FONT color="green">091</FONT> * String encryptedValue = passwordService.encryptPassword(rawPassword);<a name="line.91"></a> |
| <FONT color="green">092</FONT> * </pre><a name="line.92"></a> |
| <FONT color="green">093</FONT> * or, identically:<a name="line.93"></a> |
| <FONT color="green">094</FONT> * <pre><a name="line.94"></a> |
| <FONT color="green">095</FONT> * char[] rawPasswordChars = ...<a name="line.95"></a> |
| <FONT color="green">096</FONT> * String encryptedValue = passwordService.encryptPassword(rawPasswordChars);<a name="line.96"></a> |
| <FONT color="green">097</FONT> * </pre><a name="line.97"></a> |
| <FONT color="green">098</FONT> * <p/><a name="line.98"></a> |
| <FONT color="green">099</FONT> * The resulting {@code encryptedValue} should be stored with the account to be retrieved later during a<a name="line.99"></a> |
| <FONT color="green">100</FONT> * login attempt. For example:<a name="line.100"></a> |
| <FONT color="green">101</FONT> * <pre><a name="line.101"></a> |
| <FONT color="green">102</FONT> * String encryptedValue = passwordService.encryptPassword(rawPassword);<a name="line.102"></a> |
| <FONT color="green">103</FONT> * ...<a name="line.103"></a> |
| <FONT color="green">104</FONT> * userAccount.setPassword(encryptedValue);<a name="line.104"></a> |
| <FONT color="green">105</FONT> * userAccount.save(); //create or update to your data store<a name="line.105"></a> |
| <FONT color="green">106</FONT> * </pre><a name="line.106"></a> |
| <FONT color="green">107</FONT> *<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @param plaintextPassword the raw password as 'byte-backed' object (String, character array, {@link ByteSource},<a name="line.108"></a> |
| <FONT color="green">109</FONT> * etc) usually acquired from your application's 'new user' or 'password reset' workflow.<a name="line.109"></a> |
| <FONT color="green">110</FONT> * @return the encrypted password, formatted for storage.<a name="line.110"></a> |
| <FONT color="green">111</FONT> * @throws IllegalArgumentException if the argument cannot be easily converted to bytes as defined by<a name="line.111"></a> |
| <FONT color="green">112</FONT> * {@link ByteSource.Util#isCompatible(Object)}.<a name="line.112"></a> |
| <FONT color="green">113</FONT> * @see ByteSource.Util#isCompatible(Object)<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> String encryptPassword(Object plaintextPassword) throws IllegalArgumentException;<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> /**<a name="line.117"></a> |
| <FONT color="green">118</FONT> * Returns {@code true} if the {@code submittedPlaintext} password matches the existing {@code saved} password,<a name="line.118"></a> |
| <FONT color="green">119</FONT> * {@code false} otherwise.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * <h3>Usage</h3><a name="line.120"></a> |
| <FONT color="green">121</FONT> * The {@code submittedPlaintext} argument type can be any 'byte backed' {@code Object} - almost always either a<a name="line.121"></a> |
| <FONT color="green">122</FONT> * String or character array representing passwords (character arrays are often a safer way to represent passwords<a name="line.122"></a> |
| <FONT color="green">123</FONT> * as they can be cleared/nulled-out after use. Any argument type supported by<a name="line.123"></a> |
| <FONT color="green">124</FONT> * {@link ByteSource.Util#isCompatible(Object)} is valid.<a name="line.124"></a> |
| <FONT color="green">125</FONT> * <p/><a name="line.125"></a> |
| <FONT color="green">126</FONT> * For example:<a name="line.126"></a> |
| <FONT color="green">127</FONT> * <pre><a name="line.127"></a> |
| <FONT color="green">128</FONT> * String submittedPassword = ...<a name="line.128"></a> |
| <FONT color="green">129</FONT> * passwordService.passwordsMatch(submittedPassword, encryptedPassword);<a name="line.129"></a> |
| <FONT color="green">130</FONT> * </pre><a name="line.130"></a> |
| <FONT color="green">131</FONT> * or similarly:<a name="line.131"></a> |
| <FONT color="green">132</FONT> * <pre><a name="line.132"></a> |
| <FONT color="green">133</FONT> * char[] submittedPasswordCharacters = ...<a name="line.133"></a> |
| <FONT color="green">134</FONT> * passwordService.passwordsMatch(submittedPasswordCharacters, encryptedPassword);<a name="line.134"></a> |
| <FONT color="green">135</FONT> * </pre><a name="line.135"></a> |
| <FONT color="green">136</FONT> *<a name="line.136"></a> |
| <FONT color="green">137</FONT> * @param submittedPlaintext a raw/plaintext password submitted by an end user/Subject.<a name="line.137"></a> |
| <FONT color="green">138</FONT> * @param encrypted the previously encrypted password known to be associated with an account.<a name="line.138"></a> |
| <FONT color="green">139</FONT> * This value is expected to have been previously generated from the<a name="line.139"></a> |
| <FONT color="green">140</FONT> * {@link #encryptPassword(Object) encryptPassword} method (typically<a name="line.140"></a> |
| <FONT color="green">141</FONT> * when the account is created or the account's password is reset).<a name="line.141"></a> |
| <FONT color="green">142</FONT> * @return {@code true} if the {@code submittedPlaintext} password matches the existing {@code saved} password,<a name="line.142"></a> |
| <FONT color="green">143</FONT> * {@code false} otherwise.<a name="line.143"></a> |
| <FONT color="green">144</FONT> * @see ByteSource.Util#isCompatible(Object)<a name="line.144"></a> |
| <FONT color="green">145</FONT> */<a name="line.145"></a> |
| <FONT color="green">146</FONT> boolean passwordsMatch(Object submittedPlaintext, String encrypted);<a name="line.146"></a> |
| <FONT color="green">147</FONT> }<a name="line.147"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |