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