| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <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>package org.apache.archiva.redback.policy;<a name="line.1"></a> |
| <span class="sourceLineNo">002</span><a name="line.2"></a> |
| <span class="sourceLineNo">003</span>/*<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * Copyright 2001-2006 The Apache Software Foundation.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * you may not use this file except in compliance with the License.<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * 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, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>/**<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> * <p><a name="line.20"></a> |
| <span class="sourceLineNo">021</span> * Interface for performing authentication operations on a password.<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * </p><a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * <a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <p>Javadoc about encoding and salts copied from Acegi Security.</p><a name="line.24"></a> |
| <span class="sourceLineNo">025</span> *<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * @author colin sampaleanu<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> *<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public interface PasswordEncoder<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>{<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Sets the system wide salt to use in the encoder.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * </p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * The specified salt will potentially be used by the implementation to "salt" the initial value before<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * encoding. A salt is usually a user-specific value which is added to the password before the digest is computed.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * This means that computation of digests for common dictionary words will be different than those in the backend<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * store, because the dictionary word digests will not reflect the addition of the salt. If a per-user salt is<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * used (rather than a system-wide salt), it also means users with the same password will have different digest<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * encoded passwords in the backend store.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * </p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param salt the salt to use as a default for the encoder.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> void setSystemSalt( Object salt );<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Encodes the specified raw password with an implementation specific algorithm, using the system wide salt.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <p><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * This will generally be a one-way message digest such as MD5 or SHA, but may also be a plaintext<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * variant which does no encoding at all, but rather returns the same password it was fed. The latter is useful to<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * plug in when the original password must be stored as-is.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * </p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @param rawPass the password to encode<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @return encoded password<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> String encodePassword( String rawPass );<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> <a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Encodes the specified raw password with an implementation specific algorithm, using user specific salt.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * </p><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * This will generally be a one-way message digest such as MD5 or SHA, but may also be a plaintext<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * variant which does no encoding at all, but rather returns the same password it was fed. The latter is useful to<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * plug in when the original password must be stored as-is.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * </p><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <p><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * The specified salt will potentially be used by the implementation to "salt" the initial value before<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * encoding. A salt is usually a user-specific value which is added to the password before the digest is computed.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * This means that computation of digests for common dictionary words will be different than those in the backend<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * store, because the dictionary word digests will not reflect the addition of the salt. If a per-user salt is<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * used (rather than a system-wide salt), it also means users with the same password will have different digest<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * encoded passwords in the backend store.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * </p><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param rawPass the password to encode<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param salt optionally used by the implementation to "salt" the raw password before encoding. <a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * A <code>null</code> value is legal.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return encoded password<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> String encodePassword( String rawPass, Object salt );<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> <a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * <p><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Validates a specified "raw" password against an encoded password, using the system wide salt.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * </p><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <p><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * The encoded password should have previously been generated by {@link #encodePassword(String)}. <a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * This method will encode the <code>rawPass</code> (using the system wide <code>salt</code>), and then<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * compared it with the presented <code>encPass</code>.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * </p><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <p><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * For an explanation of salts, please refer to {@link #setSystemSalt(Object)}.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * </p><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> *<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param encPass a pre-encoded password<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param rawPass a raw password to encode and compare against the pre-encoded password<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @return true if the password is valid , false otherwise<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> boolean isPasswordValid( String encPass, String rawPass );<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> <a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <p><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Validates a specified "raw" password against an encoded password, using a user specific salt.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * </p><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * <a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * <p><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * The encoded password should have previously been generated by {@link #encodePassword(String,<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * Object)}. This method will encode the <code>rawPass</code> (using the optional <code>salt</code>), and then<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * compared it with the presented <code>encPass</code>.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * </p><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * <a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * <p><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * For a discussion of salts, please refer to {@link #encodePassword(String, Object)}.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * </p><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> *<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param encPass a pre-encoded password<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @param rawPass a raw password to encode and compare against the pre-encoded password<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param salt optionally used by the implementation to "salt" the raw password before encoding. A<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <code>null</code> value is legal.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> *<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @return true if the password is valid , false otherwise<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> boolean isPasswordValid( String encPass, String rawPass, Object salt );<a name="line.140"></a> |
| <span class="sourceLineNo">141</span>}<a name="line.141"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
