| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.web.filter.authz;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.subject.Subject;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.util.StringUtils;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.web.filter.AccessControlFilter;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> import javax.servlet.ServletRequest;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import javax.servlet.ServletResponse;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import javax.servlet.http.HttpServletResponse;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import java.io.IOException;<a name="line.29"></a> |
| <FONT color="green">030</FONT> <a name="line.30"></a> |
| <FONT color="green">031</FONT> /**<a name="line.31"></a> |
| <FONT color="green">032</FONT> * Superclass for authorization-related filters. If an request is unauthorized, response handling is delegated to the<a name="line.32"></a> |
| <FONT color="green">033</FONT> * {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse) onAccessDenied} method, which<a name="line.33"></a> |
| <FONT color="green">034</FONT> * provides reasonable handling for most applications.<a name="line.34"></a> |
| <FONT color="green">035</FONT> *<a name="line.35"></a> |
| <FONT color="green">036</FONT> * @see #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)<a name="line.36"></a> |
| <FONT color="green">037</FONT> * @since 0.9<a name="line.37"></a> |
| <FONT color="green">038</FONT> */<a name="line.38"></a> |
| <FONT color="green">039</FONT> public abstract class AuthorizationFilter extends AccessControlFilter {<a name="line.39"></a> |
| <FONT color="green">040</FONT> <a name="line.40"></a> |
| <FONT color="green">041</FONT> /**<a name="line.41"></a> |
| <FONT color="green">042</FONT> * The URL to which users should be redirected if they are denied access to an underlying path or resource,<a name="line.42"></a> |
| <FONT color="green">043</FONT> * {@code null} by default which will issue a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response<a name="line.43"></a> |
| <FONT color="green">044</FONT> * (401 Unauthorized).<a name="line.44"></a> |
| <FONT color="green">045</FONT> */<a name="line.45"></a> |
| <FONT color="green">046</FONT> private String unauthorizedUrl;<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> /**<a name="line.48"></a> |
| <FONT color="green">049</FONT> * Returns the URL to which users should be redirected if they are denied access to an underlying path or resource,<a name="line.49"></a> |
| <FONT color="green">050</FONT> * or {@code null} if a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response should be issued (401 Unauthorized).<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <p/><a name="line.51"></a> |
| <FONT color="green">052</FONT> * The default is {@code null}, ensuring default web server behavior. Override this default by calling the<a name="line.52"></a> |
| <FONT color="green">053</FONT> * {@link #setUnauthorizedUrl(String) setUnauthorizedUrl} method with a meaningful path within your application<a name="line.53"></a> |
| <FONT color="green">054</FONT> * if you would like to show the user a 'nice' page in the event of unauthorized access.<a name="line.54"></a> |
| <FONT color="green">055</FONT> *<a name="line.55"></a> |
| <FONT color="green">056</FONT> * @return the URL to which users should be redirected if they are denied access to an underlying path or resource,<a name="line.56"></a> |
| <FONT color="green">057</FONT> * or {@code null} if a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response should be issued (401 Unauthorized).<a name="line.57"></a> |
| <FONT color="green">058</FONT> */<a name="line.58"></a> |
| <FONT color="green">059</FONT> public String getUnauthorizedUrl() {<a name="line.59"></a> |
| <FONT color="green">060</FONT> return unauthorizedUrl;<a name="line.60"></a> |
| <FONT color="green">061</FONT> }<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> /**<a name="line.63"></a> |
| <FONT color="green">064</FONT> * Sets the URL to which users should be redirected if they are denied access to an underlying path or resource.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * <p/><a name="line.65"></a> |
| <FONT color="green">066</FONT> * If the value is {@code null} a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response will<a name="line.66"></a> |
| <FONT color="green">067</FONT> * be issued (401 Unauthorized), retaining default web server behavior.<a name="line.67"></a> |
| <FONT color="green">068</FONT> * <p/><a name="line.68"></a> |
| <FONT color="green">069</FONT> * Unless overridden by calling this method, the default value is {@code null}. If desired, you can specify a<a name="line.69"></a> |
| <FONT color="green">070</FONT> * meaningful path within your application if you would like to show the user a 'nice' page in the event of<a name="line.70"></a> |
| <FONT color="green">071</FONT> * unauthorized access.<a name="line.71"></a> |
| <FONT color="green">072</FONT> *<a name="line.72"></a> |
| <FONT color="green">073</FONT> * @param unauthorizedUrl the URL to which users should be redirected if they are denied access to an underlying<a name="line.73"></a> |
| <FONT color="green">074</FONT> * path or resource, or {@code null} to a ensure raw {@link HttpServletResponse#SC_UNAUTHORIZED} response is<a name="line.74"></a> |
| <FONT color="green">075</FONT> * issued (401 Unauthorized).<a name="line.75"></a> |
| <FONT color="green">076</FONT> */<a name="line.76"></a> |
| <FONT color="green">077</FONT> public void setUnauthorizedUrl(String unauthorizedUrl) {<a name="line.77"></a> |
| <FONT color="green">078</FONT> this.unauthorizedUrl = unauthorizedUrl;<a name="line.78"></a> |
| <FONT color="green">079</FONT> }<a name="line.79"></a> |
| <FONT color="green">080</FONT> <a name="line.80"></a> |
| <FONT color="green">081</FONT> /**<a name="line.81"></a> |
| <FONT color="green">082</FONT> * Handles the response when access has been denied. It behaves as follows:<a name="line.82"></a> |
| <FONT color="green">083</FONT> * <ul><a name="line.83"></a> |
| <FONT color="green">084</FONT> * <li>If the {@code Subject} is unknown<sup><a href="#known">[1]</a></sup>:<a name="line.84"></a> |
| <FONT color="green">085</FONT> * <ol><li>The incoming request will be saved and they will be redirected to the login page for authentication<a name="line.85"></a> |
| <FONT color="green">086</FONT> * (via the {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}<a name="line.86"></a> |
| <FONT color="green">087</FONT> * method).</li><a name="line.87"></a> |
| <FONT color="green">088</FONT> * <li>Once successfully authenticated, they will be redirected back to the originally attempted page.</li></ol><a name="line.88"></a> |
| <FONT color="green">089</FONT> * </li><a name="line.89"></a> |
| <FONT color="green">090</FONT> * <li>If the Subject is known:</li><a name="line.90"></a> |
| <FONT color="green">091</FONT> * <ol><a name="line.91"></a> |
| <FONT color="green">092</FONT> * <li>The HTTP {@link HttpServletResponse#SC_UNAUTHORIZED} header will be set (401 Unauthorized)</li><a name="line.92"></a> |
| <FONT color="green">093</FONT> * <li>If the {@link #getUnauthorizedUrl() unauthorizedUrl} has been configured, a redirect will be issued to that<a name="line.93"></a> |
| <FONT color="green">094</FONT> * URL. Otherwise the 401 response is rendered normally</li><a name="line.94"></a> |
| <FONT color="green">095</FONT> * </ul><a name="line.95"></a> |
| <FONT color="green">096</FONT> * <code><a name="known">[1]</a></code>: A {@code Subject} is 'known' when<a name="line.96"></a> |
| <FONT color="green">097</FONT> * <code>subject.{@link org.apache.shiro.subject.Subject#getPrincipal() getPrincipal()}</code> is not {@code null},<a name="line.97"></a> |
| <FONT color="green">098</FONT> * which implicitly means that the subject is either currently authenticated or they have been remembered via<a name="line.98"></a> |
| <FONT color="green">099</FONT> * 'remember me' services.<a name="line.99"></a> |
| <FONT color="green">100</FONT> *<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @param request the incoming <code>ServletRequest</code><a name="line.101"></a> |
| <FONT color="green">102</FONT> * @param response the outgoing <code>ServletResponse</code><a name="line.102"></a> |
| <FONT color="green">103</FONT> * @return {@code false} always for this implementation.<a name="line.103"></a> |
| <FONT color="green">104</FONT> * @throws IOException if there is any servlet error.<a name="line.104"></a> |
| <FONT color="green">105</FONT> */<a name="line.105"></a> |
| <FONT color="green">106</FONT> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws IOException {<a name="line.106"></a> |
| <FONT color="green">107</FONT> <a name="line.107"></a> |
| <FONT color="green">108</FONT> Subject subject = getSubject(request, response);<a name="line.108"></a> |
| <FONT color="green">109</FONT> // If the subject isn't identified, redirect to login URL<a name="line.109"></a> |
| <FONT color="green">110</FONT> if (subject.getPrincipal() == null) {<a name="line.110"></a> |
| <FONT color="green">111</FONT> saveRequestAndRedirectToLogin(request, response);<a name="line.111"></a> |
| <FONT color="green">112</FONT> } else {<a name="line.112"></a> |
| <FONT color="green">113</FONT> // If subject is known but not authorized, redirect to the unauthorized URL if there is one<a name="line.113"></a> |
| <FONT color="green">114</FONT> // If no unauthorized URL is specified, just return an unauthorized HTTP status code<a name="line.114"></a> |
| <FONT color="green">115</FONT> String unauthorizedUrl = getUnauthorizedUrl();<a name="line.115"></a> |
| <FONT color="green">116</FONT> //SHIRO-142 - ensure that redirect _or_ error code occurs - both cannot happen due to response commit:<a name="line.116"></a> |
| <FONT color="green">117</FONT> if (StringUtils.hasText(unauthorizedUrl)) {<a name="line.117"></a> |
| <FONT color="green">118</FONT> WebUtils.issueRedirect(request, response, unauthorizedUrl);<a name="line.118"></a> |
| <FONT color="green">119</FONT> } else {<a name="line.119"></a> |
| <FONT color="green">120</FONT> WebUtils.toHttp(response).sendError(HttpServletResponse.SC_UNAUTHORIZED);<a name="line.120"></a> |
| <FONT color="green">121</FONT> }<a name="line.121"></a> |
| <FONT color="green">122</FONT> }<a name="line.122"></a> |
| <FONT color="green">123</FONT> return false;<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> <a name="line.125"></a> |
| <FONT color="green">126</FONT> }<a name="line.126"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
