| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.authc.credential;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.util.ByteSource;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>/**<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * A {@code PasswordService} supports common use cases when using passwords as a credentials mechanism.<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * <p/><a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * Most importantly, implementations of this interface are expected to employ best-practices to ensure that<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * passwords remain as safe as possible in application environments.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <h2>Usage</h2><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * A {@code PasswordService} is used at two different times during an application's lifecycle:<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <ul><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <li>When creating a user account or resetting their password</li><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <li>When a user logs in, when passwords must be compared</li><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * </ul><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <h3>Account Creation or Password Reset</h3><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * 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> |
| <span class="sourceLineNo">036</span> * 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> |
| <span class="sourceLineNo">037</span> * {@link #encryptPassword(Object)} method to create the safer value. For<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * example:<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <pre><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * String submittedPlaintextPassword = ...<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * String encryptedValue = passwordService.encryptPassword(submittedPlaintextPassword);<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * ...<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * userAccount.setPassword(encryptedValue);<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * userAccount.save(); //create or update to your data store<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * </pre><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Be sure to save this encrypted password in your data store and never the original/raw submitted password.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <h3>Login Password Comparison</h3><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Shiro performs the comparison during login automatically. Along with your {@code PasswordService}, you just<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * have to configure a {@link PasswordMatcher} on a realm that has password-based accounts. During a login attempt,<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * shiro will use the {@code PasswordMatcher} and the {@code PasswordService} to automatically compare submitted<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * passwords.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p/><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * For example, if using Shiro's INI, here is how you might configure the PasswordMatcher and PasswordService:<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <pre><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * [main]<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * ...<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * passwordService = org.apache.shiro.authc.credential.DefaultPasswordService<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * # configure the passwordService to use the settings you desire<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * ...<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * passwordMatcher = org.apache.shiro.authc.credential.PasswordMatcher<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * passwordMatcher.passwordService = $passwordService<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * ...<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * # Finally, set the matcher on a realm that requires password matching for account authentication:<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * myRealm = ...<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * myRealm.credentialsMatcher = $passwordMatcher<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * </pre><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> *<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @see DefaultPasswordService<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @see PasswordMatcher<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @since 1.2<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span>public interface PasswordService {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Converts the specified plaintext password (usually acquired from your application's 'new user' or 'password reset'<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * workflow) into a formatted string safe for storage. The returned string can be safely saved with the<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * corresponding user account record (e.g. as a 'password' attribute).<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <p/><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * It is expected that the String returned from this method will be presented to the<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * {@link #passwordsMatch(Object, String) passwordsMatch(plaintext,encrypted)} method when performing a<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * password comparison check.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <h3>Usage</h3><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * The input argument type can be any 'byte backed' {@code Object} - almost always either a<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * String or character array representing passwords (character arrays are often a safer way to represent passwords<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * as they can be cleared/nulled-out after use. Any argument type supported by<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * {@link ByteSource.Util#isCompatible(Object)} is valid.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p/><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * For example:<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <pre><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * String rawPassword = ...<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * String encryptedValue = passwordService.encryptPassword(rawPassword);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * </pre><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * or, identically:<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <pre><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * char[] rawPasswordChars = ...<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * String encryptedValue = passwordService.encryptPassword(rawPasswordChars);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * </pre><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * <p/><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * The resulting {@code encryptedValue} should be stored with the account to be retrieved later during a<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * login attempt. For example:<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <pre><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * String encryptedValue = passwordService.encryptPassword(rawPassword);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * ...<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * userAccount.setPassword(encryptedValue);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * userAccount.save(); //create or update to your data store<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * </pre><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param plaintextPassword the raw password as 'byte-backed' object (String, character array, {@link ByteSource},<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * etc) usually acquired from your application's 'new user' or 'password reset' workflow.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @return the encrypted password, formatted for storage.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @throws IllegalArgumentException if the argument cannot be easily converted to bytes as defined by<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * {@link ByteSource.Util#isCompatible(Object)}.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @see ByteSource.Util#isCompatible(Object)<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> String encryptPassword(Object plaintextPassword) throws IllegalArgumentException;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * Returns {@code true} if the {@code submittedPlaintext} password matches the existing {@code saved} password,<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * {@code false} otherwise.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * <h3>Usage</h3><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * The {@code submittedPlaintext} argument type can be any 'byte backed' {@code Object} - almost always either a<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * String or character array representing passwords (character arrays are often a safer way to represent passwords<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * as they can be cleared/nulled-out after use. Any argument type supported by<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * {@link ByteSource.Util#isCompatible(Object)} is valid.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <p/><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * For example:<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * <pre><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * String submittedPassword = ...<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * passwordService.passwordsMatch(submittedPassword, encryptedPassword);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * </pre><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * or similarly:<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <pre><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * char[] submittedPasswordCharacters = ...<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * passwordService.passwordsMatch(submittedPasswordCharacters, encryptedPassword);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * </pre><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> *<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param submittedPlaintext a raw/plaintext password submitted by an end user/Subject.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param encrypted the previously encrypted password known to be associated with an account.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * This value is expected to have been previously generated from the<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * {@link #encryptPassword(Object) encryptPassword} method (typically<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * when the account is created or the account's password is reset).<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @return {@code true} if the {@code submittedPlaintext} password matches the existing {@code saved} password,<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * {@code false} otherwise.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @see ByteSource.Util#isCompatible(Object)<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> */<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> boolean passwordsMatch(Object submittedPlaintext, String encrypted);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span>}<a name="line.147"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
