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