blob: b4585250bce3d08a813d3251ef2cb677884802d2 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.web.filter.authc;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.authc.BearerToken;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.authc.AuthenticationToken;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.servlet.ServletRequest;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.servlet.ServletResponse;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Requires the requesting user to be {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated} for the<a name="line.31"></a>
<span class="sourceLineNo">032</span> * request to continue, and if they're not, requires the user to login via the HTTP Bearer protocol-specific challenge.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Upon successful login, they're allowed to continue on to the requested resource/url.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p/&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * The {@link #onAccessDenied(ServletRequest, ServletResponse)} method will<a name="line.35"></a>
<span class="sourceLineNo">036</span> * only be called if the subject making the request is not<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated}<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @see &lt;a href="https://tools.ietf.org/html/rfc2617"&gt;RFC 2617&lt;/a&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @see &lt;a href="https://tools.ietf.org/html/rfc6750#section-2.1"&gt;OAuth2 Authorization Request Header Field&lt;/a&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @since 1.5<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class BearerHttpAuthenticationFilter extends HttpAuthenticationFilter {<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * This class's private logger.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final Logger log = LoggerFactory.getLogger(BearerHttpAuthenticationFilter.class);<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final String BEARER = "Bearer";<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public BearerHttpAuthenticationFilter() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> setAuthcScheme(BEARER);<a name="line.53"></a>
<span class="sourceLineNo">054</span> setAuthzScheme(BEARER);<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;p/&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * This implementation:<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;ol&gt;&lt;li&gt;acquires the username and password based on the request's<a name="line.61"></a>
<span class="sourceLineNo">062</span> * {@link #getAuthzHeader(ServletRequest) authorization header} via the<a name="line.62"></a>
<span class="sourceLineNo">063</span> * {@link #getPrincipalsAndCredentials(String, ServletRequest) getPrincipalsAndCredentials} method&lt;/li&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &lt;li&gt;The return value of that method is converted to an &lt;code&gt;AuthenticationToken&lt;/code&gt; via the<a name="line.64"></a>
<span class="sourceLineNo">065</span> * {@link #createToken(String, String, ServletRequest, ServletResponse) createToken} method&lt;/li&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;li&gt;The created &lt;code&gt;AuthenticationToken&lt;/code&gt; is returned.&lt;/li&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;/ol&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param request incoming ServletRequest<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param response outgoing ServletResponse<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @return the AuthenticationToken used to execute the login attempt<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> protected AuthenticationToken createToken(ServletRequest request, ServletResponse response) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> String authorizationHeader = getAuthzHeader(request);<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (authorizationHeader == null || authorizationHeader.length() == 0) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> // Create an empty authentication token since there is no<a name="line.76"></a>
<span class="sourceLineNo">077</span> // Authorization header.<a name="line.77"></a>
<span class="sourceLineNo">078</span> return createBearerToken("", request);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> log.debug("Attempting to execute login with auth header");<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> String[] prinCred = getPrincipalsAndCredentials(authorizationHeader, request);<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (prinCred == null || prinCred.length &lt; 1) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> // Create an authentication token with an empty password,<a name="line.85"></a>
<span class="sourceLineNo">086</span> // since one hasn't been provided in the request.<a name="line.86"></a>
<span class="sourceLineNo">087</span> return createBearerToken("", request);<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> String token = prinCred[0] != null ? prinCred[0] : "";<a name="line.90"></a>
<span class="sourceLineNo">091</span> return createBearerToken(token, request);<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> @Override<a name="line.93"></a>
<span class="sourceLineNo">094</span> protected String[] getPrincipalsAndCredentials(String scheme, String token) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return new String[] {token};<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> protected AuthenticationToken createBearerToken(String token, ServletRequest request) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return new BearerToken(token, request.getRemoteHost());<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span>}<a name="line.101"></a>
</pre>
</div>
</body>
</html>