blob: f78a5c8d3515739aafb79b3f8a712ae43ff0759e [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>SslFilter.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Apache Shiro :: Jar Bundle</a> &gt; <a href="../index.html" class="el_bundle">shiro-web</a> &gt; <a href="index.source.html" class="el_package">org.apache.shiro.web.filter.authz</a> &gt; <span class="el_source">SslFilter.java</span></div><h1>SslFilter.java</h1><pre class="source lang-java linenums">/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.web.filter.authz;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
/**
* Filter which requires a request to be over SSL. Access is allowed if the request is received on the configured
* server {@link #setPort(int) port} &lt;em&gt;and&lt;/em&gt; the
* {@code request.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}. If either condition is {@code false},
* the filter chain will not continue.
* &lt;p/&gt;
* The {@link #getPort() port} property defaults to {@code 443} and also additionally guarantees that the
* request scheme is always 'https' (except for port 80, which retains the 'http' scheme).
* &lt;p/&gt;
* Example config:
* &lt;pre&gt;
* [urls]
* /secure/path/** = ssl
* &lt;/pre&gt;
*
* @since 1.0
*/
public class SslFilter extends PortFilter {
public static final int DEFAULT_HTTPS_PORT = 443;
public static final String HTTPS_SCHEME = &quot;https&quot;;
<span class="fc" id="L46"> public SslFilter() {</span>
<span class="fc" id="L47"> setPort(DEFAULT_HTTPS_PORT);</span>
<span class="fc" id="L48"> }</span>
@Override
protected String getScheme(String requestScheme, int port) {
<span class="nc bnc" id="L52" title="All 2 branches missed."> if (port == DEFAULT_HTTP_PORT) {</span>
<span class="nc" id="L53"> return PortFilter.HTTP_SCHEME;</span>
} else {
<span class="nc" id="L55"> return HTTPS_SCHEME;</span>
}
}
/**
* Retains the parent method's port-matching behavior but additionally guarantees that the
*{@code ServletRequest.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}. If the port does not match or
* the request is not secure, access is denied.
*
* @param request the incoming {@code ServletRequest}
* @param response the outgoing {@code ServletResponse} - ignored in this implementation
* @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings - ignored by this implementation.
* @return {@code true} if the request is received on an expected SSL port and the
* {@code request.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}, {@code false} otherwise.
* @throws Exception if the call to {@code super.isAccessAllowed} throws an exception.
* @since 1.2
*/
@Override
protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {
<span class="nc bnc" id="L74" title="All 4 branches missed."> return super.isAccessAllowed(request, response, mappedValue) &amp;&amp; request.isSecure();</span>
}
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.eclemma.org/jacoco">JaCoCo</a> 0.7.7.201606060606</span></div></body></html>