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