| <!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">import org.apache.archiva.redback.users.User;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import java.util.List;</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"> * User Security Policy Settings.</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> *</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> *</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * TODO roll password management into it's own object.</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> */</a> |
| <span class="sourceLineNo">029</span><a id="line.29">public interface UserSecurityPolicy</a> |
| <span class="sourceLineNo">030</span><a id="line.30">{</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> /**</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * Get identifying string for the User Security Policy implementation.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * @return the id for the security policy implementation.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> */</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> String getId();</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> // ----------------------------------------------------------------------</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> // Password Management</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> // ----------------------------------------------------------------------</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /**</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * Gets the password encoder to use.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> *</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @return the PasswordEncoder implementation to use.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> PasswordEncoder getPasswordEncoder();</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * Add a Specific Rule to the Password Rules List.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> *</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * @param rule the rule to add.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> */</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> void addPasswordRule( PasswordRule rule );</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> /**</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * Get the Password Rules List.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> *</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @return the list of {@link PasswordRule} objects.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> */</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> List<PasswordRule> getPasswordRules();</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> /**</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * Set the Password Rules List.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> *</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * @param rules the list of {@link PasswordRule} objects.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> */</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> void setPasswordRules( List<PasswordRule> rules );</a> |
| <span class="sourceLineNo">069</span><a id="line.69"></a> |
| <span class="sourceLineNo">070</span><a id="line.70"> /**</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * Gets the count of Previous Passwords that should be tracked.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> *</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @return the count of previous passwords to track.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> int getPreviousPasswordsCount();</a> |
| <span class="sourceLineNo">076</span><a id="line.76"></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> /**</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * Sets the count of previous passwords that should be tracked.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> *</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * @param count the count of previous passwords to track.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> */</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> void setPreviousPasswordsCount( int count );</a> |
| <span class="sourceLineNo">083</span><a id="line.83"></a> |
| <span class="sourceLineNo">084</span><a id="line.84"> /**</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * Gets the count of login attempts to allow.</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> *</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * @return the count of login attempts to allow.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> */</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> int getLoginAttemptCount();</a> |
| <span class="sourceLineNo">090</span><a id="line.90"></a> |
| <span class="sourceLineNo">091</span><a id="line.91"> /**</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * Sets the count of login attempts to allow.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> *</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * @param count the count of login attempts to allow.</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> */</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> void setLoginAttemptCount( int count );</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> /**</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * Get the Validation Settings.</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> *</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * @return the validation settings.</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> */</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> UserValidationSettings getUserValidationSettings();</a> |
| <span class="sourceLineNo">104</span><a id="line.104"></a> |
| <span class="sourceLineNo">105</span><a id="line.105"> /**</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * Set the Validation Settings.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> *</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @param settings the settings.</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> */</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> void setUserValidationSettings( UserValidationSettings settings );</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> /**</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * Get the Single Sign On Settings.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> *</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * @return the single sign on settings.</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> */</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> CookieSettings getSignonCookieSettings();</a> |
| <span class="sourceLineNo">118</span><a id="line.118"></a> |
| <span class="sourceLineNo">119</span><a id="line.119"> /**</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * Get the Remember Me Settings.</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> *</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @return the remember me settings.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> */</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> CookieSettings getRememberMeCookieSettings();</a> |
| <span class="sourceLineNo">125</span><a id="line.125"></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> /**</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * Enable the policies or not.</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> *</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * Useful in code when application startup or application init is being performed.</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> *</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @param enabled true if enabled.</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> */</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> void setEnabled( boolean enabled );</a> |
| <span class="sourceLineNo">134</span><a id="line.134"></a> |
| <span class="sourceLineNo">135</span><a id="line.135"> /**</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * Determines if the policies are enabled or not.</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> *</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @return true if enabled.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> */</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> boolean isEnabled();</a> |
| <span class="sourceLineNo">141</span><a id="line.141"></a> |
| <span class="sourceLineNo">142</span><a id="line.142"> /**</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * Sets the policy of how long a password will be valid until it expires.</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> *</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * @param passwordExpiry the number of days until a password expires. (or -1 to disable)</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> */</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> void setPasswordExpirationDays( int passwordExpiry );</a> |
| <span class="sourceLineNo">148</span><a id="line.148"></a> |
| <span class="sourceLineNo">149</span><a id="line.149"> /**</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * Gets the policy of how long a password will be valid until it expires.</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> *</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @return the number of days until a password expires. (or -1 for disabled)</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> */</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> int getPasswordExpirationDays();</a> |
| <span class="sourceLineNo">155</span><a id="line.155"></a> |
| <span class="sourceLineNo">156</span><a id="line.156"> /**</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> * Gets a list of accounts which should never be locked by security policy</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * @return accounts that should never be locked</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> */</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> List<String> getUnlockableAccounts();</a> |
| <span class="sourceLineNo">161</span><a id="line.161"></a> |
| <span class="sourceLineNo">162</span><a id="line.162"> /**</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> * Sets a list of accounts which should never be locked by security policy</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> * @param unlockableAccounts</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> */</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> void setUnlockableAccounts(List<String> unlockableAccounts);</a> |
| <span class="sourceLineNo">167</span><a id="line.167"></a> |
| <span class="sourceLineNo">168</span><a id="line.168"> /**</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> * Extension Point - Change the password of a user.</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> *</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> * This method does not check if a user is allowed to change his/her password.</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> * Any kind of authorization checks for password change allowed on guest or</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> * anonymous users needs to occur before calling this method.</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> *</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * This method does not persist the newly changed user password.</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * That will require a call to {@link org.apache.archiva.redback.users.UserManager#updateUser(User)}.</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> *</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * @param user the user password to validate, remember, and encode.</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * @throws PasswordRuleViolationException if the new password violates the password rules</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> */</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> void extensionChangePassword( User user )</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> throws PasswordRuleViolationException;</a> |
| <span class="sourceLineNo">183</span><a id="line.183"></a> |
| <span class="sourceLineNo">184</span><a id="line.184"> void extensionChangePassword( User user, boolean passwordChangeRequired )</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> throws PasswordRuleViolationException;</a> |
| <span class="sourceLineNo">186</span><a id="line.186"></a> |
| <span class="sourceLineNo">187</span><a id="line.187"> /**</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> * Extension Point - Test User for Password Expiration.</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> *</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> * @param user the user to test password expiration against.</a> |
| <span class="sourceLineNo">191</span><a id="line.191"> * @throws MustChangePasswordException if the password has expired</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> */</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> void extensionPasswordExpiration( User user )</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> throws MustChangePasswordException;</a> |
| <span class="sourceLineNo">195</span><a id="line.195"></a> |
| <span class="sourceLineNo">196</span><a id="line.196"> /**</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * Extension Point - Test if user has excessive logins</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> *</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * @param user the user to test excessive logins against.</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> * @throws org.apache.archiva.redback.policy.AccountLockedException if the number of logins was exceeded</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> */</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> void extensionExcessiveLoginAttempts( User user )</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> throws AccountLockedException;</a> |
| <span class="sourceLineNo">204</span><a id="line.204"></a> |
| <span class="sourceLineNo">205</span><a id="line.205"> /**</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> * Validate the incoming {@link User#getPassword()} against the specified</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> * PasswordRules.</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> *</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> * @param user the user to validate.</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> * @throws PasswordRuleViolationException if the password is not valid</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> */</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> void validatePassword( User user )</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> throws PasswordRuleViolationException;</a> |
| <span class="sourceLineNo">214</span><a id="line.214">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
