blob: b9406600e5901bca9d75a8d9df8bc38a081c362a [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"></a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.integration.HttpUtils;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.integration.filter.authentication.HttpAuthenticationException;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.commons.codec.binary.Base64;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.commons.lang3.StringUtils;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.Logger;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.springframework.context.annotation.Scope;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.springframework.stereotype.Service;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">import java.util.Properties;</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34">/**</a>
<span class="sourceLineNo">035</span><a id="line.35"> * HttpDigestHeader</a>
<span class="sourceLineNo">036</span><a id="line.36"> *</a>
<span class="sourceLineNo">037</span><a id="line.37"> * @author &lt;a href="mailto:joakim@erdfelt.com"&gt;Joakim Erdfelt&lt;/a&gt;</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> */</a>
<span class="sourceLineNo">040</span><a id="line.40">@Service( "httpClientHeader" )</a>
<span class="sourceLineNo">041</span><a id="line.41">@Scope( "prototype" )</a>
<span class="sourceLineNo">042</span><a id="line.42">public class HttpDigestHeader</a>
<span class="sourceLineNo">043</span><a id="line.43">{</a>
<span class="sourceLineNo">044</span><a id="line.44"> private Logger log = LoggerFactory.getLogger( HttpDigestHeader.class );</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> public String username;</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> public String realm;</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50"> public String nonce;</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> public String uri;</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54"> public String response;</a>
<span class="sourceLineNo">055</span><a id="line.55"></a>
<span class="sourceLineNo">056</span><a id="line.56"> public String qop;</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> public String nc;</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> public String cnonce;</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> public void parseClientHeader( String rawHeader, String expectedRealm, String digestKey )</a>
<span class="sourceLineNo">063</span><a id="line.63"> throws HttpAuthenticationException</a>
<span class="sourceLineNo">064</span><a id="line.64"> {</a>
<span class="sourceLineNo">065</span><a id="line.65"> Properties authHeaderProps = HttpUtils.complexHeaderToProperties( rawHeader, ",", "=" );</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> username = authHeaderProps.getProperty( "username" );</a>
<span class="sourceLineNo">068</span><a id="line.68"> realm = authHeaderProps.getProperty( "realm" );</a>
<span class="sourceLineNo">069</span><a id="line.69"> nonce = authHeaderProps.getProperty( "nonce" );</a>
<span class="sourceLineNo">070</span><a id="line.70"> uri = authHeaderProps.getProperty( "uri" );</a>
<span class="sourceLineNo">071</span><a id="line.71"> response = authHeaderProps.getProperty( "response" );</a>
<span class="sourceLineNo">072</span><a id="line.72"> qop = authHeaderProps.getProperty( "qop" );</a>
<span class="sourceLineNo">073</span><a id="line.73"> nc = authHeaderProps.getProperty( "nc" );</a>
<span class="sourceLineNo">074</span><a id="line.74"> cnonce = authHeaderProps.getProperty( "cnonce" );</a>
<span class="sourceLineNo">075</span><a id="line.75"></a>
<span class="sourceLineNo">076</span><a id="line.76"> // [RFC 2067] Validate all required values</a>
<span class="sourceLineNo">077</span><a id="line.77"> if ( StringUtils.isEmpty( username ) || StringUtils.isEmpty( realm ) || StringUtils.isEmpty( nonce )</a>
<span class="sourceLineNo">078</span><a id="line.78"> || StringUtils.isEmpty( uri ) || StringUtils.isEmpty( response ) )</a>
<span class="sourceLineNo">079</span><a id="line.79"> {</a>
<span class="sourceLineNo">080</span><a id="line.80"> log.debug( "Missing mandatory fields: Raw Digest Header : [{}]", rawHeader );</a>
<span class="sourceLineNo">081</span><a id="line.81"></a>
<span class="sourceLineNo">082</span><a id="line.82"> throw new HttpAuthenticationException( "Missing mandatory digest fields per RFC2069." );</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"> // [RFC 2617] Validate realm.</a>
<span class="sourceLineNo">086</span><a id="line.86"> if ( !StringUtils.equals( expectedRealm, realm ) )</a>
<span class="sourceLineNo">087</span><a id="line.87"> {</a>
<span class="sourceLineNo">088</span><a id="line.88"> log.debug( "Realm name is invalid: expected [{}] but got [{}]", expectedRealm, realm );</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> throw new HttpAuthenticationException( "Response realm does not match expected realm." );</a>
<span class="sourceLineNo">091</span><a id="line.91"> }</a>
<span class="sourceLineNo">092</span><a id="line.92"></a>
<span class="sourceLineNo">093</span><a id="line.93"> // [RFC 2617] Validate "auth" qop</a>
<span class="sourceLineNo">094</span><a id="line.94"> if ( StringUtils.equals( "auth", qop ) )</a>
<span class="sourceLineNo">095</span><a id="line.95"> {</a>
<span class="sourceLineNo">096</span><a id="line.96"> if ( StringUtils.isEmpty( nc ) || StringUtils.isEmpty( cnonce ) )</a>
<span class="sourceLineNo">097</span><a id="line.97"> {</a>
<span class="sourceLineNo">098</span><a id="line.98"> log.debug( "Missing mandatory qop fields: nc [{}] cnonce [{}]", nc, cnonce );</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> throw new HttpAuthenticationException( "Missing mandatory qop digest fields per RFC2617." );</a>
<span class="sourceLineNo">101</span><a id="line.101"> }</a>
<span class="sourceLineNo">102</span><a id="line.102"> }</a>
<span class="sourceLineNo">103</span><a id="line.103"></a>
<span class="sourceLineNo">104</span><a id="line.104"> // [RFC 2617] Validate nonce</a>
<span class="sourceLineNo">105</span><a id="line.105"> if ( !Base64.isBase64( nonce.getBytes() ) )</a>
<span class="sourceLineNo">106</span><a id="line.106"> {</a>
<span class="sourceLineNo">107</span><a id="line.107"> log.debug( "Nonce is not encoded in Base64: nonce [{}]", nonce );</a>
<span class="sourceLineNo">108</span><a id="line.108"></a>
<span class="sourceLineNo">109</span><a id="line.109"> throw new HttpAuthenticationException( "Response nonce is not encoded in Base64." );</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"></a>
<span class="sourceLineNo">112</span><a id="line.112"> // Decode nonce</a>
<span class="sourceLineNo">113</span><a id="line.113"> String decodedNonce = new String( Base64.decodeBase64( nonce.getBytes() ) );</a>
<span class="sourceLineNo">114</span><a id="line.114"> String nonceTokens[] = StringUtils.split( decodedNonce, ":" );</a>
<span class="sourceLineNo">115</span><a id="line.115"></a>
<span class="sourceLineNo">116</span><a id="line.116"> // Validate nonce format</a>
<span class="sourceLineNo">117</span><a id="line.117"> if ( nonceTokens.length != 2 )</a>
<span class="sourceLineNo">118</span><a id="line.118"> {</a>
<span class="sourceLineNo">119</span><a id="line.119"> log.debug( "Nonce format expected [2] elements, but got [{}] instead. Decoded nonce [{}]",</a>
<span class="sourceLineNo">120</span><a id="line.120"> nonceTokens.length, decodedNonce );</a>
<span class="sourceLineNo">121</span><a id="line.121"></a>
<span class="sourceLineNo">122</span><a id="line.122"> throw new HttpAuthenticationException(</a>
<span class="sourceLineNo">123</span><a id="line.123"> "Nonce format is invalid. " + "Received an unexpected number of sub elements." );</a>
<span class="sourceLineNo">124</span><a id="line.124"> }</a>
<span class="sourceLineNo">125</span><a id="line.125"></a>
<span class="sourceLineNo">126</span><a id="line.126"> // Extract nonce timestamp</a>
<span class="sourceLineNo">127</span><a id="line.127"> long nonceTimestamp = 0;</a>
<span class="sourceLineNo">128</span><a id="line.128"></a>
<span class="sourceLineNo">129</span><a id="line.129"> try</a>
<span class="sourceLineNo">130</span><a id="line.130"> {</a>
<span class="sourceLineNo">131</span><a id="line.131"> nonceTimestamp = Long.parseLong( nonceTokens[0] );</a>
<span class="sourceLineNo">132</span><a id="line.132"> }</a>
<span class="sourceLineNo">133</span><a id="line.133"> catch ( NumberFormatException e )</a>
<span class="sourceLineNo">134</span><a id="line.134"> {</a>
<span class="sourceLineNo">135</span><a id="line.135"> throw new HttpAuthenticationException( "Unexpected nonce timestamp." );</a>
<span class="sourceLineNo">136</span><a id="line.136"> }</a>
<span class="sourceLineNo">137</span><a id="line.137"></a>
<span class="sourceLineNo">138</span><a id="line.138"> // Extract nonce signature</a>
<span class="sourceLineNo">139</span><a id="line.139"> String expectedSignature = Digest.md5Hex( nonceTimestamp + ":" + digestKey );</a>
<span class="sourceLineNo">140</span><a id="line.140"></a>
<span class="sourceLineNo">141</span><a id="line.141"> if ( !StringUtils.equals( expectedSignature, nonceTokens[1] ) )</a>
<span class="sourceLineNo">142</span><a id="line.142"> {</a>
<span class="sourceLineNo">143</span><a id="line.143"> log.error( "Nonce parameter has been compromised." );</a>
<span class="sourceLineNo">144</span><a id="line.144"></a>
<span class="sourceLineNo">145</span><a id="line.145"> throw new HttpAuthenticationException( "Nonce parameter has been compromised." );</a>
<span class="sourceLineNo">146</span><a id="line.146"> }</a>
<span class="sourceLineNo">147</span><a id="line.147"> }</a>
<span class="sourceLineNo">148</span><a id="line.148">}</a>
</pre>
</div>
</main>
</body>
</html>