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