Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.0 / apidocs / src-html / org / apache / shiro / web / filter / authz / SslFilter.HSTS.html
blob: d12c67db9a1901e0bcc6e61305b43c91e7d9f244 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="fr">
<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">import javax.servlet.http.HttpServletResponse;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">/**</a>
<span class="sourceLineNo">026</span><a id="line.26"> * Filter which requires a request to be over SSL. Access is allowed if the request is received on the configured</a>
<span class="sourceLineNo">027</span><a id="line.27"> * server {@link #setPort(int) port} &lt;em&gt;and&lt;/em&gt; the</a>
<span class="sourceLineNo">028</span><a id="line.28"> * {@code request.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}. If either condition is {@code false},</a>
<span class="sourceLineNo">029</span><a id="line.29"> * the filter chain will not continue.</a>
<span class="sourceLineNo">030</span><a id="line.30"> * &lt;p/&gt;</a>
<span class="sourceLineNo">031</span><a id="line.31"> * The {@link #getPort() port} property defaults to {@code 443} and also additionally guarantees that the</a>
<span class="sourceLineNo">032</span><a id="line.32"> * request scheme is always 'https' (except for port 80, which retains the 'http' scheme).</a>
<span class="sourceLineNo">033</span><a id="line.33"> * &lt;p/&gt;</a>
<span class="sourceLineNo">034</span><a id="line.34"> * In addition the filter allows enabling HTTP Strict Transport Security (HSTS).</a>
<span class="sourceLineNo">035</span><a id="line.35"> * This feature is opt-in and disabled by default. If enabled HSTS</a>
<span class="sourceLineNo">036</span><a id="line.36"> * will prevent &lt;b&gt;any&lt;/b&gt; communications from being sent over HTTP to the </a>
<span class="sourceLineNo">037</span><a id="line.37"> * specified domain and will instead send all communications over HTTPS.</a>
<span class="sourceLineNo">038</span><a id="line.38"> * &lt;/p&gt;</a>
<span class="sourceLineNo">039</span><a id="line.39"> * The {@link #getMaxAge() maxAge} property defaults {@code 31536000}, and </a>
<span class="sourceLineNo">040</span><a id="line.40"> * {@link #isIncludeSubDomains includeSubDomains} is {@code false}.</a>
<span class="sourceLineNo">041</span><a id="line.41"> * &lt;/p&gt;</a>
<span class="sourceLineNo">042</span><a id="line.42"> * &lt;b&gt;Warning:&lt;/b&gt; Use this setting with care and only if you plan to enable </a>
<span class="sourceLineNo">043</span><a id="line.43"> * SSL on every path.</a>
<span class="sourceLineNo">044</span><a id="line.44"> * &lt;/p&gt;</a>
<span class="sourceLineNo">045</span><a id="line.45"> * Example configs:</a>
<span class="sourceLineNo">046</span><a id="line.46"> * &lt;pre&gt;</a>
<span class="sourceLineNo">047</span><a id="line.47"> * [urls]</a>
<span class="sourceLineNo">048</span><a id="line.48"> * /secure/path/** = ssl</a>
<span class="sourceLineNo">049</span><a id="line.49"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">050</span><a id="line.50"> * with HSTS enabled</a>
<span class="sourceLineNo">051</span><a id="line.51"> * &lt;pre&gt;</a>
<span class="sourceLineNo">052</span><a id="line.52"> * [main]</a>
<span class="sourceLineNo">053</span><a id="line.53"> * ssl.hsts.enabled = true</a>
<span class="sourceLineNo">054</span><a id="line.54"> * [urls]</a>
<span class="sourceLineNo">055</span><a id="line.55"> * /** = ssl</a>
<span class="sourceLineNo">056</span><a id="line.56"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">057</span><a id="line.57"> * @since 1.0</a>
<span class="sourceLineNo">058</span><a id="line.58"> * @see &lt;a href="https://tools.ietf.org/html/rfc6797"&gt;HTTP Strict Transport Security (HSTS)&lt;/a&gt;</a>
<span class="sourceLineNo">059</span><a id="line.59"> */</a>
<span class="sourceLineNo">060</span><a id="line.60">public class SslFilter extends PortFilter {</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> public static final int DEFAULT_HTTPS_PORT = 443;</a>
<span class="sourceLineNo">063</span><a id="line.63"> public static final String HTTPS_SCHEME = "https";</a>
<span class="sourceLineNo">064</span><a id="line.64"> </a>
<span class="sourceLineNo">065</span><a id="line.65"> private HSTS hsts;</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> public SslFilter() {</a>
<span class="sourceLineNo">068</span><a id="line.68"> setPort(DEFAULT_HTTPS_PORT);</a>
<span class="sourceLineNo">069</span><a id="line.69"> this.hsts = new HSTS();</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"></a>
<span class="sourceLineNo">072</span><a id="line.72"> public HSTS getHsts() {</a>
<span class="sourceLineNo">073</span><a id="line.73"> return hsts;</a>
<span class="sourceLineNo">074</span><a id="line.74"> }</a>
<span class="sourceLineNo">075</span><a id="line.75"></a>
<span class="sourceLineNo">076</span><a id="line.76"> public void setHsts(HSTS hsts) {</a>
<span class="sourceLineNo">077</span><a id="line.77"> this.hsts = hsts;</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> @Override</a>
<span class="sourceLineNo">081</span><a id="line.81"> protected String getScheme(String requestScheme, int port) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> if (port == DEFAULT_HTTP_PORT) {</a>
<span class="sourceLineNo">083</span><a id="line.83"> return PortFilter.HTTP_SCHEME;</a>
<span class="sourceLineNo">084</span><a id="line.84"> } else {</a>
<span class="sourceLineNo">085</span><a id="line.85"> return HTTPS_SCHEME;</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"> * Retains the parent method's port-matching behavior but additionally guarantees that the</a>
<span class="sourceLineNo">091</span><a id="line.91"> *{@code ServletRequest.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}. If the port does not match or</a>
<span class="sourceLineNo">092</span><a id="line.92"> * the request is not secure, access is denied.</a>
<span class="sourceLineNo">093</span><a id="line.93"> *</a>
<span class="sourceLineNo">094</span><a id="line.94"> * @param request the incoming {@code ServletRequest}</a>
<span class="sourceLineNo">095</span><a id="line.95"> * @param response the outgoing {@code ServletResponse} - ignored in this implementation</a>
<span class="sourceLineNo">096</span><a id="line.96"> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings - ignored by this implementation.</a>
<span class="sourceLineNo">097</span><a id="line.97"> * @return {@code true} if the request is received on an expected SSL port and the</a>
<span class="sourceLineNo">098</span><a id="line.98"> * {@code request.}{@link javax.servlet.ServletRequest#isSecure() isSecure()}, {@code false} otherwise.</a>
<span class="sourceLineNo">099</span><a id="line.99"> * @throws Exception if the call to {@code super.isAccessAllowed} throws an exception.</a>
<span class="sourceLineNo">100</span><a id="line.100"> * @since 1.2</a>
<span class="sourceLineNo">101</span><a id="line.101"> */</a>
<span class="sourceLineNo">102</span><a id="line.102"> @Override</a>
<span class="sourceLineNo">103</span><a id="line.103"> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {</a>
<span class="sourceLineNo">104</span><a id="line.104"> return super.isAccessAllowed(request, response, mappedValue) &amp;&amp; request.isSecure();</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106"></a>
<span class="sourceLineNo">107</span><a id="line.107"> /**</a>
<span class="sourceLineNo">108</span><a id="line.108"> * If HTTP Strict Transport Security (HSTS) is enabled the HTTP header</a>
<span class="sourceLineNo">109</span><a id="line.109"> * will be written, otherwise this method does nothing.</a>
<span class="sourceLineNo">110</span><a id="line.110"> * @param request the incoming {@code ServletRequest}</a>
<span class="sourceLineNo">111</span><a id="line.111"> * @param response the outgoing {@code ServletResponse}</a>
<span class="sourceLineNo">112</span><a id="line.112"> */</a>
<span class="sourceLineNo">113</span><a id="line.113"> @Override</a>
<span class="sourceLineNo">114</span><a id="line.114"> protected void postHandle(ServletRequest request, ServletResponse response) {</a>
<span class="sourceLineNo">115</span><a id="line.115"> if (hsts.isEnabled()) {</a>
<span class="sourceLineNo">116</span><a id="line.116"> StringBuilder directives = new StringBuilder(64)</a>
<span class="sourceLineNo">117</span><a id="line.117"> .append("max-age=").append(hsts.getMaxAge());</a>
<span class="sourceLineNo">118</span><a id="line.118"> </a>
<span class="sourceLineNo">119</span><a id="line.119"> if (hsts.isIncludeSubDomains()) {</a>
<span class="sourceLineNo">120</span><a id="line.120"> directives.append("; includeSubDomains");</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"> </a>
<span class="sourceLineNo">123</span><a id="line.123"> HttpServletResponse resp = (HttpServletResponse) response;</a>
<span class="sourceLineNo">124</span><a id="line.124"> resp.addHeader(HSTS.HTTP_HEADER, directives.toString());</a>
<span class="sourceLineNo">125</span><a id="line.125"> }</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</a>
<span class="sourceLineNo">127</span><a id="line.127"> </a>
<span class="sourceLineNo">128</span><a id="line.128"> /**</a>
<span class="sourceLineNo">129</span><a id="line.129"> * Helper class for HTTP Strict Transport Security (HSTS)</a>
<span class="sourceLineNo">130</span><a id="line.130"> */</a>
<span class="sourceLineNo">131</span><a id="line.131"> public class HSTS {</a>
<span class="sourceLineNo">132</span><a id="line.132"> </a>
<span class="sourceLineNo">133</span><a id="line.133"> public static final String HTTP_HEADER = "Strict-Transport-Security";</a>
<span class="sourceLineNo">134</span><a id="line.134"> </a>
<span class="sourceLineNo">135</span><a id="line.135"> public static final boolean DEFAULT_ENABLED = false;</a>
<span class="sourceLineNo">136</span><a id="line.136"> public static final int DEFAULT_MAX_AGE = 31536000; // approx. one year in seconds</a>
<span class="sourceLineNo">137</span><a id="line.137"> public static final boolean DEFAULT_INCLUDE_SUB_DOMAINS = false;</a>
<span class="sourceLineNo">138</span><a id="line.138"> </a>
<span class="sourceLineNo">139</span><a id="line.139"> private boolean enabled;</a>
<span class="sourceLineNo">140</span><a id="line.140"> private int maxAge;</a>
<span class="sourceLineNo">141</span><a id="line.141"> private boolean includeSubDomains;</a>
<span class="sourceLineNo">142</span><a id="line.142"> </a>
<span class="sourceLineNo">143</span><a id="line.143"> public HSTS() {</a>
<span class="sourceLineNo">144</span><a id="line.144"> this.enabled = DEFAULT_ENABLED;</a>
<span class="sourceLineNo">145</span><a id="line.145"> this.maxAge = DEFAULT_MAX_AGE;</a>
<span class="sourceLineNo">146</span><a id="line.146"> this.includeSubDomains = DEFAULT_INCLUDE_SUB_DOMAINS;</a>
<span class="sourceLineNo">147</span><a id="line.147"> }</a>
<span class="sourceLineNo">148</span><a id="line.148"></a>
<span class="sourceLineNo">149</span><a id="line.149"> public boolean isEnabled() {</a>
<span class="sourceLineNo">150</span><a id="line.150"> return enabled;</a>
<span class="sourceLineNo">151</span><a id="line.151"> }</a>
<span class="sourceLineNo">152</span><a id="line.152"></a>
<span class="sourceLineNo">153</span><a id="line.153"> public void setEnabled(boolean enabled) {</a>
<span class="sourceLineNo">154</span><a id="line.154"> this.enabled = enabled;</a>
<span class="sourceLineNo">155</span><a id="line.155"> }</a>
<span class="sourceLineNo">156</span><a id="line.156"></a>
<span class="sourceLineNo">157</span><a id="line.157"> public int getMaxAge() {</a>
<span class="sourceLineNo">158</span><a id="line.158"> return maxAge;</a>
<span class="sourceLineNo">159</span><a id="line.159"> }</a>
<span class="sourceLineNo">160</span><a id="line.160"></a>
<span class="sourceLineNo">161</span><a id="line.161"> public void setMaxAge(int maxAge) {</a>
<span class="sourceLineNo">162</span><a id="line.162"> this.maxAge = maxAge;</a>
<span class="sourceLineNo">163</span><a id="line.163"> }</a>
<span class="sourceLineNo">164</span><a id="line.164"></a>
<span class="sourceLineNo">165</span><a id="line.165"> public boolean isIncludeSubDomains() {</a>
<span class="sourceLineNo">166</span><a id="line.166"> return includeSubDomains;</a>
<span class="sourceLineNo">167</span><a id="line.167"> }</a>
<span class="sourceLineNo">168</span><a id="line.168"></a>
<span class="sourceLineNo">169</span><a id="line.169"> public void setIncludeSubDomains(boolean includeSubDomains) {</a>
<span class="sourceLineNo">170</span><a id="line.170"> this.includeSubDomains = includeSubDomains;</a>
<span class="sourceLineNo">171</span><a id="line.171"> }</a>
<span class="sourceLineNo">172</span><a id="line.172"> }</a>
<span class="sourceLineNo">173</span><a id="line.173">}</a>
</pre>
</div>
</main>
</body>
</html>