blob: d8bde8f50a79aa672d724ce100928c46e5ae42d8 [file] [log] [blame]
<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.config.ConfigurationException;<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.util.WebUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import javax.servlet.ServletRequest;<a name="line.25"></a>
<FONT color="green">026</FONT> import javax.servlet.ServletResponse;<a name="line.26"></a>
<FONT color="green">027</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.io.IOException;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * A Filter that requires the request to be on a specific port, and if not, redirects to the same URL on that port.<a name="line.31"></a>
<FONT color="green">032</FONT> * &lt;p/&gt;<a name="line.32"></a>
<FONT color="green">033</FONT> * Example config:<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;pre&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * [filters]<a name="line.35"></a>
<FONT color="green">036</FONT> * port.port = 80<a name="line.36"></a>
<FONT color="green">037</FONT> * &lt;p/&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * [urls]<a name="line.38"></a>
<FONT color="green">039</FONT> * /some/path/** = port<a name="line.39"></a>
<FONT color="green">040</FONT> * # override for just this path:<a name="line.40"></a>
<FONT color="green">041</FONT> * /another/path/** = port[8080]<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;/pre&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * @since 1.0<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public class PortFilter extends AuthorizationFilter {<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> public static final int DEFAULT_HTTP_PORT = 80;<a name="line.48"></a>
<FONT color="green">049</FONT> public static final String HTTP_SCHEME = "http";<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private int port = DEFAULT_HTTP_PORT;<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> public int getPort() {<a name="line.53"></a>
<FONT color="green">054</FONT> return port;<a name="line.54"></a>
<FONT color="green">055</FONT> }<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> public void setPort(int port) {<a name="line.57"></a>
<FONT color="green">058</FONT> this.port = port;<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> protected int toPort(Object mappedValue) {<a name="line.61"></a>
<FONT color="green">062</FONT> String[] ports = (String[]) mappedValue;<a name="line.62"></a>
<FONT color="green">063</FONT> if (ports == null || ports.length == 0) {<a name="line.63"></a>
<FONT color="green">064</FONT> return getPort();<a name="line.64"></a>
<FONT color="green">065</FONT> }<a name="line.65"></a>
<FONT color="green">066</FONT> if (ports.length &gt; 1) {<a name="line.66"></a>
<FONT color="green">067</FONT> throw new ConfigurationException("PortFilter can only be configured with a single port. You have " +<a name="line.67"></a>
<FONT color="green">068</FONT> "configured " + ports.length + ": " + StringUtils.toString(ports));<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> return Integer.parseInt(ports[0]);<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {<a name="line.73"></a>
<FONT color="green">074</FONT> int requiredPort = toPort(mappedValue);<a name="line.74"></a>
<FONT color="green">075</FONT> int requestPort = request.getServerPort();<a name="line.75"></a>
<FONT color="green">076</FONT> return requiredPort == requestPort;<a name="line.76"></a>
<FONT color="green">077</FONT> }<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> protected String getScheme(String requestScheme, int port) {<a name="line.79"></a>
<FONT color="green">080</FONT> if (port == DEFAULT_HTTP_PORT) {<a name="line.80"></a>
<FONT color="green">081</FONT> return HTTP_SCHEME;<a name="line.81"></a>
<FONT color="green">082</FONT> } else if (port == SslFilter.DEFAULT_HTTPS_PORT) {<a name="line.82"></a>
<FONT color="green">083</FONT> return SslFilter.HTTPS_SCHEME;<a name="line.83"></a>
<FONT color="green">084</FONT> } else {<a name="line.84"></a>
<FONT color="green">085</FONT> return requestScheme;<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> /**<a name="line.89"></a>
<FONT color="green">090</FONT> * Redirects the request to the same exact incoming URL, but with the port listed in the filter's configuration.<a name="line.90"></a>
<FONT color="green">091</FONT> *<a name="line.91"></a>
<FONT color="green">092</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.92"></a>
<FONT color="green">093</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.93"></a>
<FONT color="green">094</FONT> * @param mappedValue the config specified for the filter in the matching request's filter chain.<a name="line.94"></a>
<FONT color="green">095</FONT> * @return {@code false} always to force a redirect.<a name="line.95"></a>
<FONT color="green">096</FONT> */<a name="line.96"></a>
<FONT color="green">097</FONT> @Override<a name="line.97"></a>
<FONT color="green">098</FONT> protected boolean onAccessDenied(ServletRequest request, ServletResponse response, Object mappedValue) throws IOException {<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> //just redirect to the specified port:<a name="line.100"></a>
<FONT color="green">101</FONT> int port = toPort(mappedValue);<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> String scheme = getScheme(request.getScheme(), port);<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> StringBuilder sb = new StringBuilder();<a name="line.105"></a>
<FONT color="green">106</FONT> sb.append(scheme).append("://");<a name="line.106"></a>
<FONT color="green">107</FONT> sb.append(request.getServerName());<a name="line.107"></a>
<FONT color="green">108</FONT> if (port != DEFAULT_HTTP_PORT &amp;&amp; port != SslFilter.DEFAULT_HTTPS_PORT) {<a name="line.108"></a>
<FONT color="green">109</FONT> sb.append(":");<a name="line.109"></a>
<FONT color="green">110</FONT> sb.append(port);<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> if (request instanceof HttpServletRequest) {<a name="line.112"></a>
<FONT color="green">113</FONT> sb.append(WebUtils.toHttp(request).getRequestURI());<a name="line.113"></a>
<FONT color="green">114</FONT> String query = WebUtils.toHttp(request).getQueryString();<a name="line.114"></a>
<FONT color="green">115</FONT> if (query != null) {<a name="line.115"></a>
<FONT color="green">116</FONT> sb.append("?").append(query);<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> <a name="line.119"></a>
<FONT color="green">120</FONT> WebUtils.issueRedirect(request, response, sb.toString());<a name="line.120"></a>
<FONT color="green">121</FONT> <a name="line.121"></a>
<FONT color="green">122</FONT> return false;<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
</PRE>
</BODY>
</HTML>