| <!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.integration.filter.authentication;</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"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.authentication.AuthenticationDataSource;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.authentication.AuthenticationException;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.authentication.AuthenticationResult;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.policy.AccountLockedException;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.policy.MustChangePasswordException;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.system.SecuritySession;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.system.SecuritySystem;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.system.SecuritySystemConstants;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.users.User;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.users.UserManagerException;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.users.UserNotFoundException;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">035</span><a id="line.35"></a> |
| <span class="sourceLineNo">036</span><a id="line.36">import javax.inject.Inject;</a> |
| <span class="sourceLineNo">037</span><a id="line.37">import javax.servlet.http.HttpServletRequest;</a> |
| <span class="sourceLineNo">038</span><a id="line.38">import javax.servlet.http.HttpServletResponse;</a> |
| <span class="sourceLineNo">039</span><a id="line.39">import javax.servlet.http.HttpSession;</a> |
| <span class="sourceLineNo">040</span><a id="line.40">import java.io.IOException;</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"> * HttpAuthenticator</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> *</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47">public abstract class HttpAuthenticator</a> |
| <span class="sourceLineNo">048</span><a id="line.48">{</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> protected Logger log = LoggerFactory.getLogger( getClass() );</a> |
| <span class="sourceLineNo">050</span><a id="line.50"></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> @Inject</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> protected SecuritySystem securitySystem;</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> /**</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * The Public Face of the Authenticator.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> *</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @throws MustChangePasswordException</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * @throws AccountLockedException</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> */</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> public AuthenticationResult authenticate( AuthenticationDataSource ds, HttpSession httpSession )</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> throws AuthenticationException, AccountLockedException, MustChangePasswordException</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> {</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> try</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> {</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> SecuritySession securitySession = securitySystem.authenticate( ds );</a> |
| <span class="sourceLineNo">066</span><a id="line.66"></a> |
| <span class="sourceLineNo">067</span><a id="line.67"> setSecuritySession( securitySession, httpSession );</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> return securitySession.getAuthenticationResult().user( securitySession.getUser() );</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> }</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> catch ( AuthenticationException e )</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> {</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> String msg = "Unable to authenticate user: " + ds;</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> log.info( msg, e );</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> throw new HttpAuthenticationException( msg, e );</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> }</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> catch ( UserNotFoundException e )</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> {</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> log.info( "Login attempt against unknown user: {}", ds );</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> throw new HttpAuthenticationException( "User name or password invalid." );</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> }</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> catch ( UserManagerException e )</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> {</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> log.info( "UserManagerException: {}", e.getMessage() );</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> throw new HttpAuthenticationException( e.getMessage(), e );</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> }</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> }</a> |
| <span class="sourceLineNo">088</span><a id="line.88"></a> |
| <span class="sourceLineNo">089</span><a id="line.89"> /**</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * Entry point for a Filter.</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> *</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * @param request</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> * @param response</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * @throws AuthenticationException</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> */</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> public void authenticate( HttpServletRequest request, HttpServletResponse response )</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> throws AuthenticationException</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> {</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> try</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> {</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> AuthenticationResult result = getAuthenticationResult( request, response );</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> if ( ( result == null ) || ( !result.isAuthenticated() ) )</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> {</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> throw new HttpAuthenticationException( "You are not authenticated." );</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> }</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> catch ( AccountLockedException e )</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> {</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> throw new HttpAuthenticationException( "Your account is locked.", e );</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> }</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> catch ( MustChangePasswordException e )</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> {</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> throw new HttpAuthenticationException( "You must change your password.", e );</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> }</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"></a> |
| <span class="sourceLineNo">119</span><a id="line.119"> /**</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * Issue a Challenge Response back to the HTTP Client.</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> *</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @param request</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * @param response</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * @param realmName</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * @param exception</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * @throws IOException</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> */</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> public abstract void challenge( HttpServletRequest request, HttpServletResponse response, String realmName,</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> AuthenticationException exception )</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> throws IOException;</a> |
| <span class="sourceLineNo">131</span><a id="line.131"></a> |
| <span class="sourceLineNo">132</span><a id="line.132"> /**</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * Parse the incoming request and return an AuthenticationResult.</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> *</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * @param request</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * @param response</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * @return null if no http auth credentials, or the actual authentication result based on the credentials.</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @throws AuthenticationException</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * @throws MustChangePasswordException</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * @throws AccountLockedException</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> */</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> public abstract AuthenticationResult getAuthenticationResult( HttpServletRequest request,</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> HttpServletResponse response )</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> throws AuthenticationException, AccountLockedException, MustChangePasswordException;</a> |
| <span class="sourceLineNo">145</span><a id="line.145"></a> |
| <span class="sourceLineNo">146</span><a id="line.146"></a> |
| <span class="sourceLineNo">147</span><a id="line.147"> public User getSessionUser( HttpSession httpSession )</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> {</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> return (User) httpSession.getAttribute( SecuritySession.USERKEY );</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> }</a> |
| <span class="sourceLineNo">151</span><a id="line.151"></a> |
| <span class="sourceLineNo">152</span><a id="line.152"> public boolean isAlreadyAuthenticated( HttpSession httpSession )</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> {</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> User user = getSessionUser( httpSession );</a> |
| <span class="sourceLineNo">155</span><a id="line.155"></a> |
| <span class="sourceLineNo">156</span><a id="line.156"> return ( ( user != null ) && !user.isLocked() && !user.isPasswordChangeRequired() );</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> }</a> |
| <span class="sourceLineNo">158</span><a id="line.158"></a> |
| <span class="sourceLineNo">159</span><a id="line.159"> public SecuritySession getSecuritySession( HttpSession httpSession )</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> {</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> SecuritySession securitySession = (SecuritySession) httpSession.getAttribute( SecuritySession.SESSION_KEY );</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> if ( securitySession != null )</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> {</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> return securitySession;</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> }</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> return (SecuritySession) httpSession.getAttribute( SecuritySystemConstants.SECURITY_SESSION_KEY );</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"></a> |
| <span class="sourceLineNo">170</span><a id="line.170"></a> |
| <span class="sourceLineNo">171</span><a id="line.171"> public void setSecuritySession( SecuritySession session, HttpSession httpSession )</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> {</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> httpSession.setAttribute( SecuritySession.SESSION_KEY, session );</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> httpSession.setAttribute( SecuritySession.USERKEY, session.getUser() );</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> }</a> |
| <span class="sourceLineNo">176</span><a id="line.176"></a> |
| <span class="sourceLineNo">177</span><a id="line.177"> public void setSessionUser( User user, HttpSession httpSession )</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> {</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> httpSession.setAttribute( SecuritySession.SESSION_KEY, null );</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> httpSession.setAttribute( SecuritySession.USERKEY, user );</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> }</a> |
| <span class="sourceLineNo">182</span><a id="line.182"></a> |
| <span class="sourceLineNo">183</span><a id="line.183"></a> |
| <span class="sourceLineNo">184</span><a id="line.184">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
