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