blob: df996ef130a04a046dcab147a1aa21828c2ff8f1 [file] [log] [blame]
<!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.digest;</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.AuthenticationException;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.authentication.AuthenticationResult;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.authentication.TokenBasedAuthenticationDataSource;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.integration.filter.authentication.HttpAuthenticationException;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.integration.filter.authentication.HttpAuthenticator;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.policy.AccountLockedException;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.policy.MustChangePasswordException;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.users.User;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.users.UserManager;</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.apache.commons.codec.binary.Base64;</a>
<span class="sourceLineNo">034</span><a id="line.34">import org.apache.commons.lang3.StringUtils;</a>
<span class="sourceLineNo">035</span><a id="line.35">import org.springframework.stereotype.Service;</a>
<span class="sourceLineNo">036</span><a id="line.36"></a>
<span class="sourceLineNo">037</span><a id="line.37">import javax.inject.Inject;</a>
<span class="sourceLineNo">038</span><a id="line.38">import javax.inject.Named;</a>
<span class="sourceLineNo">039</span><a id="line.39">import javax.servlet.http.HttpServletRequest;</a>
<span class="sourceLineNo">040</span><a id="line.40">import javax.servlet.http.HttpServletResponse;</a>
<span class="sourceLineNo">041</span><a id="line.41">import javax.servlet.http.HttpSession;</a>
<span class="sourceLineNo">042</span><a id="line.42">import java.io.IOException;</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44">/**</a>
<span class="sourceLineNo">045</span><a id="line.45"> * HttpDigestAuthentication methods for working with &lt;a href="http://www.faqs.org/rfcs/rfc2617.html"&gt;RFC 2617 HTTP Authentication&lt;/a&gt;.</a>
<span class="sourceLineNo">046</span><a id="line.46"> *</a>
<span class="sourceLineNo">047</span><a id="line.47"> * @author &lt;a href="mailto:joakim@erdfelt.com"&gt;Joakim Erdfelt&lt;/a&gt;</a>
<span class="sourceLineNo">048</span><a id="line.48"> */</a>
<span class="sourceLineNo">049</span><a id="line.49">@Service("httpAuthenticator#digest")</a>
<span class="sourceLineNo">050</span><a id="line.50">public class HttpDigestAuthentication</a>
<span class="sourceLineNo">051</span><a id="line.51"> extends HttpAuthenticator</a>
<span class="sourceLineNo">052</span><a id="line.52">{</a>
<span class="sourceLineNo">053</span><a id="line.53"> @Inject</a>
<span class="sourceLineNo">054</span><a id="line.54"> @Named(value = "userManager#default")</a>
<span class="sourceLineNo">055</span><a id="line.55"> private UserManager userManager;</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> /**</a>
<span class="sourceLineNo">058</span><a id="line.58"> *</a>
<span class="sourceLineNo">059</span><a id="line.59"> */</a>
<span class="sourceLineNo">060</span><a id="line.60"> private int nonceLifetimeSeconds = 300;</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> /**</a>
<span class="sourceLineNo">063</span><a id="line.63"> * NOTE: Must be alphanumeric.</a>
<span class="sourceLineNo">064</span><a id="line.64"> */</a>
<span class="sourceLineNo">065</span><a id="line.65"> private String digestKey = "OrycteropusAfer";</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> private String realm;</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> public String getId()</a>
<span class="sourceLineNo">070</span><a id="line.70"> {</a>
<span class="sourceLineNo">071</span><a id="line.71"> return HttpDigestAuthentication.class.getName();</a>
<span class="sourceLineNo">072</span><a id="line.72"> }</a>
<span class="sourceLineNo">073</span><a id="line.73"></a>
<span class="sourceLineNo">074</span><a id="line.74"> public AuthenticationResult getAuthenticationResult( HttpServletRequest request, HttpServletResponse response )</a>
<span class="sourceLineNo">075</span><a id="line.75"> throws AuthenticationException, AccountLockedException, MustChangePasswordException</a>
<span class="sourceLineNo">076</span><a id="line.76"> {</a>
<span class="sourceLineNo">077</span><a id="line.77"> HttpSession httpSession = request.getSession( true );</a>
<span class="sourceLineNo">078</span><a id="line.78"> if ( isAlreadyAuthenticated( httpSession ) )</a>
<span class="sourceLineNo">079</span><a id="line.79"> {</a>
<span class="sourceLineNo">080</span><a id="line.80"> return getSecuritySession( httpSession ).getAuthenticationResult();</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"></a>
<span class="sourceLineNo">083</span><a id="line.83"> TokenBasedAuthenticationDataSource authDataSource = new TokenBasedAuthenticationDataSource();</a>
<span class="sourceLineNo">084</span><a id="line.84"> String authHeader = request.getHeader( "Authorization" );</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> // in tomcat this is : authorization=Basic YWRtaW46TWFuYWdlMDc=</a>
<span class="sourceLineNo">087</span><a id="line.87"> if ( authHeader == null )</a>
<span class="sourceLineNo">088</span><a id="line.88"> {</a>
<span class="sourceLineNo">089</span><a id="line.89"> authHeader = request.getHeader( "authorization" );</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"> if ( ( authHeader != null ) &amp;&amp; authHeader.startsWith( "Digest " ) )</a>
<span class="sourceLineNo">093</span><a id="line.93"> {</a>
<span class="sourceLineNo">094</span><a id="line.94"> String rawDigestHeader = authHeader.substring( 7 );</a>
<span class="sourceLineNo">095</span><a id="line.95"></a>
<span class="sourceLineNo">096</span><a id="line.96"> HttpDigestHeader digestHeader = new HttpDigestHeader();</a>
<span class="sourceLineNo">097</span><a id="line.97"> digestHeader.parseClientHeader( rawDigestHeader, getRealm(), digestKey );</a>
<span class="sourceLineNo">098</span><a id="line.98"></a>
<span class="sourceLineNo">099</span><a id="line.99"> // Lookup password for presented username</a>
<span class="sourceLineNo">100</span><a id="line.100"> User user = findUser( digestHeader.username );</a>
<span class="sourceLineNo">101</span><a id="line.101"> authDataSource.setPrincipal( user.getUsername() );</a>
<span class="sourceLineNo">102</span><a id="line.102"></a>
<span class="sourceLineNo">103</span><a id="line.103"> String serverSideHash = generateDigestHash( digestHeader, user.getPassword(), request.getMethod() );</a>
<span class="sourceLineNo">104</span><a id="line.104"></a>
<span class="sourceLineNo">105</span><a id="line.105"> if ( !StringUtils.equals( serverSideHash, digestHeader.response ) )</a>
<span class="sourceLineNo">106</span><a id="line.106"> {</a>
<span class="sourceLineNo">107</span><a id="line.107"> throw new HttpAuthenticationException( "Digest response was invalid." );</a>
<span class="sourceLineNo">108</span><a id="line.108"> }</a>
<span class="sourceLineNo">109</span><a id="line.109"> }</a>
<span class="sourceLineNo">110</span><a id="line.110"></a>
<span class="sourceLineNo">111</span><a id="line.111"> return super.authenticate( authDataSource, httpSession );</a>
<span class="sourceLineNo">112</span><a id="line.112"> }</a>
<span class="sourceLineNo">113</span><a id="line.113"></a>
<span class="sourceLineNo">114</span><a id="line.114"> public User findUser( String username )</a>
<span class="sourceLineNo">115</span><a id="line.115"> throws HttpAuthenticationException</a>
<span class="sourceLineNo">116</span><a id="line.116"> {</a>
<span class="sourceLineNo">117</span><a id="line.117"> try</a>
<span class="sourceLineNo">118</span><a id="line.118"> {</a>
<span class="sourceLineNo">119</span><a id="line.119"> return userManager.findUser( username );</a>
<span class="sourceLineNo">120</span><a id="line.120"> }</a>
<span class="sourceLineNo">121</span><a id="line.121"> catch ( UserNotFoundException e )</a>
<span class="sourceLineNo">122</span><a id="line.122"> {</a>
<span class="sourceLineNo">123</span><a id="line.123"> String msg = "Unable to find primary user '" + username + "'.";</a>
<span class="sourceLineNo">124</span><a id="line.124"> log.error( msg, e );</a>
<span class="sourceLineNo">125</span><a id="line.125"> throw new HttpAuthenticationException( msg, e );</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</a>
<span class="sourceLineNo">127</span><a id="line.127"> catch ( UserManagerException e )</a>
<span class="sourceLineNo">128</span><a id="line.128"> {</a>
<span class="sourceLineNo">129</span><a id="line.129"> log.error( "issue find user {}, message: {}", username, e.getMessage(), e );</a>
<span class="sourceLineNo">130</span><a id="line.130"> throw new HttpAuthenticationException( "issue find user " + username + ", message: " + e.getMessage(), e );</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"></a>
<span class="sourceLineNo">134</span><a id="line.134"> /**</a>
<span class="sourceLineNo">135</span><a id="line.135"> * Issue HTTP Digest Authentication Challenge</a>
<span class="sourceLineNo">136</span><a id="line.136"> *</a>
<span class="sourceLineNo">137</span><a id="line.137"> * @param request the request to use.</a>
<span class="sourceLineNo">138</span><a id="line.138"> * @param response the response to use.</a>
<span class="sourceLineNo">139</span><a id="line.139"> * @param realmName the realm name to state.</a>
<span class="sourceLineNo">140</span><a id="line.140"> * @param exception the exception to base the message off of.</a>
<span class="sourceLineNo">141</span><a id="line.141"> * @throws IOException if there was a problem with the {@link HttpServletResponse#sendError(int, String)} call.</a>
<span class="sourceLineNo">142</span><a id="line.142"> */</a>
<span class="sourceLineNo">143</span><a id="line.143"> public void challenge( HttpServletRequest request, HttpServletResponse response, String realmName,</a>
<span class="sourceLineNo">144</span><a id="line.144"> AuthenticationException exception )</a>
<span class="sourceLineNo">145</span><a id="line.145"> throws IOException</a>
<span class="sourceLineNo">146</span><a id="line.146"> {</a>
<span class="sourceLineNo">147</span><a id="line.147"> // The Challenge Header</a>
<span class="sourceLineNo">148</span><a id="line.148"> StringBuilder authHeader = new StringBuilder();</a>
<span class="sourceLineNo">149</span><a id="line.149"> authHeader.append( "Digest " );</a>
<span class="sourceLineNo">150</span><a id="line.150"> // [REQUIRED] The name to appear in the dialog box to the user.</a>
<span class="sourceLineNo">151</span><a id="line.151"> authHeader.append( "realm=\"" ).append( realmName ).append( "\"" );</a>
<span class="sourceLineNo">152</span><a id="line.152"> // [OPTIONAL] We do not use the optional 'domain' header.</a>
<span class="sourceLineNo">153</span><a id="line.153"> // authHeader.append( "domain=\"" ).append( domain ).append( "\"" );</a>
<span class="sourceLineNo">154</span><a id="line.154"> // [REQUIRED] Nonce specification.</a>
<span class="sourceLineNo">155</span><a id="line.155"> authHeader.append( ", nonce=\"" );</a>
<span class="sourceLineNo">156</span><a id="line.156"> long timestamp = System.currentTimeMillis() + ( nonceLifetimeSeconds * 1000 );</a>
<span class="sourceLineNo">157</span><a id="line.157"> // Not using ETag from RFC 2617 intentionally.</a>
<span class="sourceLineNo">158</span><a id="line.158"> String hraw = String.valueOf( timestamp ) + ":" + digestKey;</a>
<span class="sourceLineNo">159</span><a id="line.159"> String rawnonce = String.valueOf( timestamp ) + ":" + Digest.md5Hex( hraw );</a>
<span class="sourceLineNo">160</span><a id="line.160"> authHeader.append( Base64.encodeBase64( rawnonce.getBytes() ) );</a>
<span class="sourceLineNo">161</span><a id="line.161"> authHeader.append( "\"" );</a>
<span class="sourceLineNo">162</span><a id="line.162"> // [REQUIRED] The RFC 2617 Quality of Protection.</a>
<span class="sourceLineNo">163</span><a id="line.163"> // MSIE Appears to only support 'auth'</a>
<span class="sourceLineNo">164</span><a id="line.164"> // Do not use 'opaque' here. (Your MSIE users will have issues)</a>
<span class="sourceLineNo">165</span><a id="line.165"> authHeader.append( ", qop=\"auth\"" );</a>
<span class="sourceLineNo">166</span><a id="line.166"> // [BROKEN] since we force the 'auth' qop we cannot use the opaque option.</a>
<span class="sourceLineNo">167</span><a id="line.167"> // authHeader.append( ", opaque=\"").append(opaqueString).append("\"");</a>
<span class="sourceLineNo">168</span><a id="line.168"></a>
<span class="sourceLineNo">169</span><a id="line.169"> // [OPTIONAL] Use of the stale option is reserved for expired nonce strings.</a>
<span class="sourceLineNo">170</span><a id="line.170"> if ( exception instanceof NonceExpirationException )</a>
<span class="sourceLineNo">171</span><a id="line.171"> {</a>
<span class="sourceLineNo">172</span><a id="line.172"> authHeader.append( ", stale=\"true\"" );</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"> // [OPTIONAL] We do not use the optional Algorithm header.</a>
<span class="sourceLineNo">176</span><a id="line.176"> // authHeader.append( ", algorithm=\"MD5\"");</a>
<span class="sourceLineNo">177</span><a id="line.177"></a>
<span class="sourceLineNo">178</span><a id="line.178"> response.addHeader( "WWW-Authenticate", authHeader.toString() );</a>
<span class="sourceLineNo">179</span><a id="line.179"> response.sendError( HttpServletResponse.SC_UNAUTHORIZED, exception.getMessage() );</a>
<span class="sourceLineNo">180</span><a id="line.180"> }</a>
<span class="sourceLineNo">181</span><a id="line.181"></a>
<span class="sourceLineNo">182</span><a id="line.182"> private String generateDigestHash( HttpDigestHeader digestHeader, String password, String httpMethod )</a>
<span class="sourceLineNo">183</span><a id="line.183"> {</a>
<span class="sourceLineNo">184</span><a id="line.184"> String a1 = Digest.md5Hex( digestHeader.username + ":" + realm + ":" + password );</a>
<span class="sourceLineNo">185</span><a id="line.185"> String a2 = Digest.md5Hex( httpMethod + ":" + digestHeader.uri );</a>
<span class="sourceLineNo">186</span><a id="line.186"></a>
<span class="sourceLineNo">187</span><a id="line.187"> String digest;</a>
<span class="sourceLineNo">188</span><a id="line.188"></a>
<span class="sourceLineNo">189</span><a id="line.189"> if ( StringUtils.isEmpty( digestHeader.qop ) )</a>
<span class="sourceLineNo">190</span><a id="line.190"> {</a>
<span class="sourceLineNo">191</span><a id="line.191"> digest = a1 + ":" + digestHeader.nonce + ":" + a2;</a>
<span class="sourceLineNo">192</span><a id="line.192"> }</a>
<span class="sourceLineNo">193</span><a id="line.193"> else if ( StringUtils.equals( "auth", digestHeader.qop ) )</a>
<span class="sourceLineNo">194</span><a id="line.194"> {</a>
<span class="sourceLineNo">195</span><a id="line.195"> digest = a1 + ":" + digestHeader.nonce + ":" + digestHeader.nc + ":" + digestHeader.cnonce + ":"</a>
<span class="sourceLineNo">196</span><a id="line.196"> + digestHeader.qop + ":" + a2;</a>
<span class="sourceLineNo">197</span><a id="line.197"> }</a>
<span class="sourceLineNo">198</span><a id="line.198"> else</a>
<span class="sourceLineNo">199</span><a id="line.199"> {</a>
<span class="sourceLineNo">200</span><a id="line.200"> throw new IllegalStateException(</a>
<span class="sourceLineNo">201</span><a id="line.201"> "Http Digest Parameter [qop] with value of [" + digestHeader.qop + "] is unsupported." );</a>
<span class="sourceLineNo">202</span><a id="line.202"> }</a>
<span class="sourceLineNo">203</span><a id="line.203"></a>
<span class="sourceLineNo">204</span><a id="line.204"> return Digest.md5Hex( digest );</a>
<span class="sourceLineNo">205</span><a id="line.205"> }</a>
<span class="sourceLineNo">206</span><a id="line.206"></a>
<span class="sourceLineNo">207</span><a id="line.207"> public String getRealm()</a>
<span class="sourceLineNo">208</span><a id="line.208"> {</a>
<span class="sourceLineNo">209</span><a id="line.209"> return realm;</a>
<span class="sourceLineNo">210</span><a id="line.210"> }</a>
<span class="sourceLineNo">211</span><a id="line.211"></a>
<span class="sourceLineNo">212</span><a id="line.212"> public void setRealm( String realm )</a>
<span class="sourceLineNo">213</span><a id="line.213"> {</a>
<span class="sourceLineNo">214</span><a id="line.214"> this.realm = realm;</a>
<span class="sourceLineNo">215</span><a id="line.215"> }</a>
<span class="sourceLineNo">216</span><a id="line.216"></a>
<span class="sourceLineNo">217</span><a id="line.217">}</a>
</pre>
</div>
</main>
</body>
</html>