blob: f983ab9cb1be2cf211cf1bb4d55578bf92cfbc81 [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.rest.services.interceptors;</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.AuthenticationResult;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.authorization.AuthorizationException;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.authorization.AuthorizationResult;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.integration.filter.authentication.basic.HttpBasicAuthentication;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.rest.services.RedbackAuthenticationThreadLocal;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.rest.services.RedbackRequestInformation;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.system.SecuritySession;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.system.SecuritySystem;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.users.User;</a>
<span class="sourceLineNo">032</span><a id="line.32">import org.apache.commons.lang3.StringUtils;</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">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.annotation.Priority;</a>
<span class="sourceLineNo">038</span><a id="line.38">import javax.inject.Inject;</a>
<span class="sourceLineNo">039</span><a id="line.39">import javax.inject.Named;</a>
<span class="sourceLineNo">040</span><a id="line.40">import javax.servlet.http.HttpServletRequest;</a>
<span class="sourceLineNo">041</span><a id="line.41">import javax.ws.rs.container.ContainerRequestContext;</a>
<span class="sourceLineNo">042</span><a id="line.42">import javax.ws.rs.container.ContainerRequestFilter;</a>
<span class="sourceLineNo">043</span><a id="line.43">import javax.ws.rs.container.ResourceInfo;</a>
<span class="sourceLineNo">044</span><a id="line.44">import javax.ws.rs.core.Context;</a>
<span class="sourceLineNo">045</span><a id="line.45">import javax.ws.rs.core.Response;</a>
<span class="sourceLineNo">046</span><a id="line.46">import javax.ws.rs.core.UriInfo;</a>
<span class="sourceLineNo">047</span><a id="line.47">import javax.ws.rs.ext.Provider;</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"> * @author Olivier Lamy</a>
<span class="sourceLineNo">051</span><a id="line.51"> * @since 1.3</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53">@Service( "permissionInterceptor#rest" )</a>
<span class="sourceLineNo">054</span><a id="line.54">@Provider</a>
<span class="sourceLineNo">055</span><a id="line.55">@Priority( Priorities.AUTHORIZATION )</a>
<span class="sourceLineNo">056</span><a id="line.56">public class PermissionsInterceptor</a>
<span class="sourceLineNo">057</span><a id="line.57"> extends AbstractInterceptor</a>
<span class="sourceLineNo">058</span><a id="line.58"> implements ContainerRequestFilter</a>
<span class="sourceLineNo">059</span><a id="line.59">{</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> @Inject</a>
<span class="sourceLineNo">062</span><a id="line.62"> @Named( value = "securitySystem" )</a>
<span class="sourceLineNo">063</span><a id="line.63"> private SecuritySystem securitySystem;</a>
<span class="sourceLineNo">064</span><a id="line.64"></a>
<span class="sourceLineNo">065</span><a id="line.65"> @Inject</a>
<span class="sourceLineNo">066</span><a id="line.66"> @Named( value = "httpAuthenticator#basic" )</a>
<span class="sourceLineNo">067</span><a id="line.67"> private HttpBasicAuthentication httpAuthenticator;</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> private static final String DEFAULT_AUTHENTICATION_REALM = "archiva";</a>
<span class="sourceLineNo">070</span><a id="line.70"> private String authenticationRealm = DEFAULT_AUTHENTICATION_REALM;</a>
<span class="sourceLineNo">071</span><a id="line.71"></a>
<span class="sourceLineNo">072</span><a id="line.72"> @Context</a>
<span class="sourceLineNo">073</span><a id="line.73"> private ResourceInfo resourceInfo;</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75"> private static final Logger log = LoggerFactory.getLogger( PermissionsInterceptor.class );</a>
<span class="sourceLineNo">076</span><a id="line.76"></a>
<span class="sourceLineNo">077</span><a id="line.77"> @Override</a>
<span class="sourceLineNo">078</span><a id="line.78"> public void filter( ContainerRequestContext containerRequestContext )</a>
<span class="sourceLineNo">079</span><a id="line.79"> {</a>
<span class="sourceLineNo">080</span><a id="line.80"> log.debug( "Filtering request" );</a>
<span class="sourceLineNo">081</span><a id="line.81"> final String requestPath = containerRequestContext.getUriInfo( ).getPath( );</a>
<span class="sourceLineNo">082</span><a id="line.82"> if (ignoreAuth( requestPath )) {</a>
<span class="sourceLineNo">083</span><a id="line.83"> return;</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> RedbackAuthorization redbackAuthorization = getRedbackAuthorization( resourceInfo );</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> if ( redbackAuthorization != null )</a>
<span class="sourceLineNo">089</span><a id="line.89"> {</a>
<span class="sourceLineNo">090</span><a id="line.90"> if ( redbackAuthorization.noRestriction() )</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> log.debug( "redbackAuthorization.noRestriction() so skip permission check" );</a>
<span class="sourceLineNo">093</span><a id="line.93"> // we are fine this services is marked as non restrictive access</a>
<span class="sourceLineNo">094</span><a id="line.94"> return;</a>
<span class="sourceLineNo">095</span><a id="line.95"> }</a>
<span class="sourceLineNo">096</span><a id="line.96"> String[] permissions = redbackAuthorization.permissions();</a>
<span class="sourceLineNo">097</span><a id="line.97"> HttpServletRequest request = getHttpServletRequest( );</a>
<span class="sourceLineNo">098</span><a id="line.98"> //olamy: no value is an array with an empty String</a>
<span class="sourceLineNo">099</span><a id="line.99"> if ( permissions != null &amp;&amp; permissions.length &gt; 0 //</a>
<span class="sourceLineNo">100</span><a id="line.100"> &amp;&amp; !( permissions.length == 1 &amp;&amp; StringUtils.isEmpty( permissions[0] ) ) )</a>
<span class="sourceLineNo">101</span><a id="line.101"> {</a>
<span class="sourceLineNo">102</span><a id="line.102"> SecuritySession securitySession = getSecuritySession( containerRequestContext, httpAuthenticator, request );</a>
<span class="sourceLineNo">103</span><a id="line.103"> AuthenticationResult authenticationResult = getAuthenticationResult( containerRequestContext, httpAuthenticator, request );</a>
<span class="sourceLineNo">104</span><a id="line.104"> log.debug( "authenticationResult from message: {}", authenticationResult );</a>
<span class="sourceLineNo">105</span><a id="line.105"></a>
<span class="sourceLineNo">106</span><a id="line.106"> if ( authenticationResult != null &amp;&amp; authenticationResult.isAuthenticated() )</a>
<span class="sourceLineNo">107</span><a id="line.107"> {</a>
<span class="sourceLineNo">108</span><a id="line.108"></a>
<span class="sourceLineNo">109</span><a id="line.109"> User userObject = securitySession == null ? authenticationResult.getUser( ) : securitySession.getUser( );</a>
<span class="sourceLineNo">110</span><a id="line.110"> for ( String permission : permissions )</a>
<span class="sourceLineNo">111</span><a id="line.111"> {</a>
<span class="sourceLineNo">112</span><a id="line.112"> log.debug( "check permission: {} with securitySession {}", permission, securitySession );</a>
<span class="sourceLineNo">113</span><a id="line.113"> if ( StringUtils.isBlank( permission ) )</a>
<span class="sourceLineNo">114</span><a id="line.114"> {</a>
<span class="sourceLineNo">115</span><a id="line.115"> continue;</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"> String resource = redbackAuthorization.resource();</a>
<span class="sourceLineNo">120</span><a id="line.120"> if (resource.startsWith("{") &amp;&amp; resource.endsWith("}") &amp;&amp; resource.length()&gt;2) {</a>
<span class="sourceLineNo">121</span><a id="line.121"> resource = getMethodParameter(containerRequestContext, resource.substring(1,resource.length()-1));</a>
<span class="sourceLineNo">122</span><a id="line.122"> log.debug("Found resource from annotated parameter: {}",resource);</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124"></a>
<span class="sourceLineNo">125</span><a id="line.125"> AuthorizationResult authorizationResult = null;</a>
<span class="sourceLineNo">126</span><a id="line.126"> if (userObject!=null)</a>
<span class="sourceLineNo">127</span><a id="line.127"> {</a>
<span class="sourceLineNo">128</span><a id="line.128"> authorizationResult = securitySystem.authorize( userObject, permission, //</a>
<span class="sourceLineNo">129</span><a id="line.129"> StringUtils.isBlank( resource ) //</a>
<span class="sourceLineNo">130</span><a id="line.130"> ? null : resource );</a>
<span class="sourceLineNo">131</span><a id="line.131"> }</a>
<span class="sourceLineNo">132</span><a id="line.132"> if ( authenticationResult != null &amp;&amp; authorizationResult.isAuthorized() )</a>
<span class="sourceLineNo">133</span><a id="line.133"> {</a>
<span class="sourceLineNo">134</span><a id="line.134"> log.debug( "isAuthorized for permission {}", permission );</a>
<span class="sourceLineNo">135</span><a id="line.135"> return;</a>
<span class="sourceLineNo">136</span><a id="line.136"> }</a>
<span class="sourceLineNo">137</span><a id="line.137"> else</a>
<span class="sourceLineNo">138</span><a id="line.138"> {</a>
<span class="sourceLineNo">139</span><a id="line.139"> if ( securitySession != null &amp;&amp; securitySession.getUser() != null )</a>
<span class="sourceLineNo">140</span><a id="line.140"> {</a>
<span class="sourceLineNo">141</span><a id="line.141"> log.debug( "user {} not authorized for permission {}", //</a>
<span class="sourceLineNo">142</span><a id="line.142"> securitySession.getUser().getUsername(), //</a>
<span class="sourceLineNo">143</span><a id="line.143"> permission );</a>
<span class="sourceLineNo">144</span><a id="line.144"> }</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"> catch ( AuthorizationException e )</a>
<span class="sourceLineNo">148</span><a id="line.148"> {</a>
<span class="sourceLineNo">149</span><a id="line.149"> log.debug( " AuthorizationException " + e.getMessage() //</a>
<span class="sourceLineNo">150</span><a id="line.150"> + " checking permission " + permission, e );</a>
<span class="sourceLineNo">151</span><a id="line.151"> containerRequestContext.abortWith( Response.status( Response.Status.FORBIDDEN ).build() );</a>
<span class="sourceLineNo">152</span><a id="line.152"> return;</a>
<span class="sourceLineNo">153</span><a id="line.153"> }</a>
<span class="sourceLineNo">154</span><a id="line.154"> }</a>
<span class="sourceLineNo">155</span><a id="line.155"> }</a>
<span class="sourceLineNo">156</span><a id="line.156"> else</a>
<span class="sourceLineNo">157</span><a id="line.157"> {</a>
<span class="sourceLineNo">158</span><a id="line.158"> if ( securitySession != null &amp;&amp; securitySession.getUser() != null )</a>
<span class="sourceLineNo">159</span><a id="line.159"> {</a>
<span class="sourceLineNo">160</span><a id="line.160"> log.debug( "user {} not authenticated, but permissions are set", securitySession.getUser().getUsername() );</a>
<span class="sourceLineNo">161</span><a id="line.161"> }</a>
<span class="sourceLineNo">162</span><a id="line.162"> containerRequestContext.abortWith( Response.status( Response.Status.FORBIDDEN ).build() );</a>
<span class="sourceLineNo">163</span><a id="line.163"> return;</a>
<span class="sourceLineNo">164</span><a id="line.164"> }</a>
<span class="sourceLineNo">165</span><a id="line.165"> }</a>
<span class="sourceLineNo">166</span><a id="line.166"> else</a>
<span class="sourceLineNo">167</span><a id="line.167"> {</a>
<span class="sourceLineNo">168</span><a id="line.168"> // The noPermission is only valid, if the user is authenticated</a>
<span class="sourceLineNo">169</span><a id="line.169"> if ( redbackAuthorization.noPermission() )</a>
<span class="sourceLineNo">170</span><a id="line.170"> {</a>
<span class="sourceLineNo">171</span><a id="line.171"> AuthenticationResult authenticationResult = getAuthenticationResult( containerRequestContext, httpAuthenticator, request );</a>
<span class="sourceLineNo">172</span><a id="line.172"> if (authenticationResult!=null &amp;&amp; authenticationResult.isAuthenticated())</a>
<span class="sourceLineNo">173</span><a id="line.173"> {</a>
<span class="sourceLineNo">174</span><a id="line.174"> log.debug( "Path {} doesn't need special permission. User authenticated.", requestPath );</a>
<span class="sourceLineNo">175</span><a id="line.175"> return;</a>
<span class="sourceLineNo">176</span><a id="line.176"> } else {</a>
<span class="sourceLineNo">177</span><a id="line.177"> log.debug( "Path {} is protected and needs authentication. User not authenticated.", requestPath );</a>
<span class="sourceLineNo">178</span><a id="line.178"> containerRequestContext.abortWith( Response.status( Response.Status.UNAUTHORIZED )</a>
<span class="sourceLineNo">179</span><a id="line.179"> .header( "WWW-Authenticate", "Bearer realm=\""+getAuthenticationRealm()+"\"" )</a>
<span class="sourceLineNo">180</span><a id="line.180"> .build() );</a>
<span class="sourceLineNo">181</span><a id="line.181"> return;</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"> log.warn( "No permissions defined for the REST method and noPermission=false" );</a>
<span class="sourceLineNo">185</span><a id="line.185"> containerRequestContext.abortWith( Response.status( Response.Status.FORBIDDEN ).build() );</a>
<span class="sourceLineNo">186</span><a id="line.186"> return;</a>
<span class="sourceLineNo">187</span><a id="line.187"> }</a>
<span class="sourceLineNo">188</span><a id="line.188"> }</a>
<span class="sourceLineNo">189</span><a id="line.189"></a>
<span class="sourceLineNo">190</span><a id="line.190"> log.warn( "http path {} doesn't contain any informations regarding permissions ", //</a>
<span class="sourceLineNo">191</span><a id="line.191"> containerRequestContext.getUriInfo().getRequestUri() );</a>
<span class="sourceLineNo">192</span><a id="line.192"> // here we failed to authenticate so 403 as there is no detail on karma for this</a>
<span class="sourceLineNo">193</span><a id="line.193"> // it must be marked as it's exposed</a>
<span class="sourceLineNo">194</span><a id="line.194"> containerRequestContext.abortWith( Response.status( Response.Status.FORBIDDEN ).build() );</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"></a>
<span class="sourceLineNo">198</span><a id="line.198"> /*</a>
<span class="sourceLineNo">199</span><a id="line.199"> * Extracts a request parameter value from the message. Currently checks only path and query parameter.</a>
<span class="sourceLineNo">200</span><a id="line.200"> */</a>
<span class="sourceLineNo">201</span><a id="line.201"> private String getMethodParameter( final ContainerRequestContext requestContext, final String parameterName ) {</a>
<span class="sourceLineNo">202</span><a id="line.202"> UriInfo uriInfo = requestContext.getUriInfo( );</a>
<span class="sourceLineNo">203</span><a id="line.203"> if (uriInfo.getPathParameters().containsKey( parameterName )) {</a>
<span class="sourceLineNo">204</span><a id="line.204"> return uriInfo.getPathParameters( ).get( parameterName ).get( 0 );</a>
<span class="sourceLineNo">205</span><a id="line.205"> } else if (uriInfo.getQueryParameters().containsKey( parameterName )) {</a>
<span class="sourceLineNo">206</span><a id="line.206"> return uriInfo.getQueryParameters( ).get( parameterName ).get( 0 );</a>
<span class="sourceLineNo">207</span><a id="line.207"> }</a>
<span class="sourceLineNo">208</span><a id="line.208"> return "";</a>
<span class="sourceLineNo">209</span><a id="line.209"> }</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 String getAuthenticationRealm( )</a>
<span class="sourceLineNo">213</span><a id="line.213"> {</a>
<span class="sourceLineNo">214</span><a id="line.214"> return authenticationRealm;</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"> public void setAuthenticationRealm( String authenticationRealm )</a>
<span class="sourceLineNo">218</span><a id="line.218"> {</a>
<span class="sourceLineNo">219</span><a id="line.219"> this.authenticationRealm = authenticationRealm;</a>
<span class="sourceLineNo">220</span><a id="line.220"> }</a>
<span class="sourceLineNo">221</span><a id="line.221">}</a>
</pre>
</div>
</main>
</body>
</html>