Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.3.1 / apidocs / src-html / org / apache / shiro / web / filter / authz / SslFilter.html
blob: 86858f5c92ef5364bf05620e2d6d31f34e2c6b6e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<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.authz;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import javax.servlet.ServletRequest;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import javax.servlet.ServletResponse;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Filter which requires a request to be over SSL. Access is allowed if the request is received on the configured<a name="line.25"></a>
<span class="sourceLineNo">026</span> * server {@link #setPort(int) port} &lt;em&gt;and&lt;/em&gt; the<a name="line.26"></a>
<span class="sourceLineNo">027</span> * {@code request.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}. If either condition is {@code false},<a name="line.27"></a>
<span class="sourceLineNo">028</span> * the filter chain will not continue.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p/&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * The {@link #getPort() port} property defaults to {@code 443} and also additionally guarantees that the<a name="line.30"></a>
<span class="sourceLineNo">031</span> * request scheme is always 'https' (except for port 80, which retains the 'http' scheme).<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;p/&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Example config:<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;pre&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * [urls]<a name="line.35"></a>
<span class="sourceLineNo">036</span> * /secure/path/** = ssl<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/pre&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @since 1.0<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class SslFilter extends PortFilter {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> public static final int DEFAULT_HTTPS_PORT = 443;<a name="line.43"></a>
<span class="sourceLineNo">044</span> public static final String HTTPS_SCHEME = "https";<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> public SslFilter() {<a name="line.46"></a>
<span class="sourceLineNo">047</span> setPort(DEFAULT_HTTPS_PORT);<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> @Override<a name="line.50"></a>
<span class="sourceLineNo">051</span> protected String getScheme(String requestScheme, int port) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> if (port == DEFAULT_HTTP_PORT) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> return PortFilter.HTTP_SCHEME;<a name="line.53"></a>
<span class="sourceLineNo">054</span> } else {<a name="line.54"></a>
<span class="sourceLineNo">055</span> return HTTPS_SCHEME;<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><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Retains the parent method's port-matching behavior but additionally guarantees that the<a name="line.60"></a>
<span class="sourceLineNo">061</span> *{@code ServletRequest.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}. If the port does not match or<a name="line.61"></a>
<span class="sourceLineNo">062</span> * the request is not secure, access is denied.<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param request the incoming {@code ServletRequest}<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param response the outgoing {@code ServletResponse} - ignored in this implementation<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings - ignored by this implementation.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return {@code true} if the request is received on an expected SSL port and the<a name="line.67"></a>
<span class="sourceLineNo">068</span> * {@code request.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}, {@code false} otherwise.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @throws Exception if the call to {@code super.isAccessAllowed} throws an exception.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @since 1.2<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return super.isAccessAllowed(request, response, mappedValue) &amp;&amp; request.isSecure();<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span>}<a name="line.76"></a>
</pre>
</div>
</body>
</html>