blob: ce54c5b7085ecd6c7c4c32cc1040df0b41ce7055 [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"></a>
<span class="sourceLineNo">020</span><a id="line.20">package org.apache.shiro.web.filter;</a>
<span class="sourceLineNo">021</span><a id="line.21"></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.util.Arrays;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.util.Collections;</a>
<span class="sourceLineNo">030</span><a id="line.30">import java.util.List;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">/**</a>
<span class="sourceLineNo">033</span><a id="line.33"> * A request filter that blocks malicious requests. Invalid request will respond with a 400 response code.</a>
<span class="sourceLineNo">034</span><a id="line.34"> * &lt;p&gt;</a>
<span class="sourceLineNo">035</span><a id="line.35"> * This filter checks and blocks the request if the following characters are found in the request URI:</a>
<span class="sourceLineNo">036</span><a id="line.36"> * &lt;ul&gt;</a>
<span class="sourceLineNo">037</span><a id="line.37"> * &lt;li&gt;Semicolon - can be disabled by setting {@code blockSemicolon = false}&lt;/li&gt;</a>
<span class="sourceLineNo">038</span><a id="line.38"> * &lt;li&gt;Backslash - can be disabled by setting {@code blockBackslash = false}&lt;/li&gt;</a>
<span class="sourceLineNo">039</span><a id="line.39"> * &lt;li&gt;Non-ASCII characters - can be disabled by setting {@code blockNonAscii = false}, the ability to disable this check will be removed in future version.&lt;/li&gt;</a>
<span class="sourceLineNo">040</span><a id="line.40"> * &lt;/ul&gt;</a>
<span class="sourceLineNo">041</span><a id="line.41"> *</a>
<span class="sourceLineNo">042</span><a id="line.42"> * @see &lt;a href="https://docs.spring.io/spring-security/site/docs/current/api/org/springframework/security/web/firewall/StrictHttpFirewall.html"&gt;This class was inspired by Spring Security StrictHttpFirewall&lt;/a&gt;</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @since 1.6</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45">public class InvalidRequestFilter extends AccessControlFilter {</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> private static final List&lt;String&gt; SEMICOLON = Collections.unmodifiableList(Arrays.asList(";", "%3b", "%3B"));</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> private static final List&lt;String&gt; BACKSLASH = Collections.unmodifiableList(Arrays.asList("\\", "%5c", "%5C"));</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> private boolean blockSemicolon = true;</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> private boolean blockBackslash = !Boolean.getBoolean(WebUtils.ALLOW_BACKSLASH);</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> private boolean blockNonAscii = true;</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> @Override</a>
<span class="sourceLineNo">058</span><a id="line.58"> protected boolean isAccessAllowed(ServletRequest req, ServletResponse response, Object mappedValue) throws Exception {</a>
<span class="sourceLineNo">059</span><a id="line.59"> HttpServletRequest request = WebUtils.toHttp(req);</a>
<span class="sourceLineNo">060</span><a id="line.60"> // check the original and decoded values</a>
<span class="sourceLineNo">061</span><a id="line.61"> return isValid(request.getRequestURI()) // user request string (not decoded)</a>
<span class="sourceLineNo">062</span><a id="line.62"> &amp;&amp; isValid(request.getServletPath()) // decoded servlet part</a>
<span class="sourceLineNo">063</span><a id="line.63"> &amp;&amp; isValid(request.getPathInfo()); // decoded path info (may be null)</a>
<span class="sourceLineNo">064</span><a id="line.64"> }</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> private boolean isValid(String uri) {</a>
<span class="sourceLineNo">067</span><a id="line.67"> return !StringUtils.hasText(uri)</a>
<span class="sourceLineNo">068</span><a id="line.68"> || ( !containsSemicolon(uri)</a>
<span class="sourceLineNo">069</span><a id="line.69"> &amp;&amp; !containsBackslash(uri)</a>
<span class="sourceLineNo">070</span><a id="line.70"> &amp;&amp; !containsNonAsciiCharacters(uri));</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"> @Override</a>
<span class="sourceLineNo">074</span><a id="line.74"> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {</a>
<span class="sourceLineNo">075</span><a id="line.75"> WebUtils.toHttp(response).sendError(400, "Invalid request");</a>
<span class="sourceLineNo">076</span><a id="line.76"> return false;</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"> private boolean containsSemicolon(String uri) {</a>
<span class="sourceLineNo">080</span><a id="line.80"> if (isBlockSemicolon()) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> return SEMICOLON.stream().anyMatch(uri::contains);</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"> return false;</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> private boolean containsBackslash(String uri) {</a>
<span class="sourceLineNo">087</span><a id="line.87"> if (isBlockBackslash()) {</a>
<span class="sourceLineNo">088</span><a id="line.88"> return BACKSLASH.stream().anyMatch(uri::contains);</a>
<span class="sourceLineNo">089</span><a id="line.89"> }</a>
<span class="sourceLineNo">090</span><a id="line.90"> return false;</a>
<span class="sourceLineNo">091</span><a id="line.91"> }</a>
<span class="sourceLineNo">092</span><a id="line.92"></a>
<span class="sourceLineNo">093</span><a id="line.93"> private boolean containsNonAsciiCharacters(String uri) {</a>
<span class="sourceLineNo">094</span><a id="line.94"> if (isBlockNonAscii()) {</a>
<span class="sourceLineNo">095</span><a id="line.95"> return !containsOnlyPrintableAsciiCharacters(uri);</a>
<span class="sourceLineNo">096</span><a id="line.96"> }</a>
<span class="sourceLineNo">097</span><a id="line.97"> return false;</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> private static boolean containsOnlyPrintableAsciiCharacters(String uri) {</a>
<span class="sourceLineNo">101</span><a id="line.101"> int length = uri.length();</a>
<span class="sourceLineNo">102</span><a id="line.102"> for (int i = 0; i &lt; length; i++) {</a>
<span class="sourceLineNo">103</span><a id="line.103"> char c = uri.charAt(i);</a>
<span class="sourceLineNo">104</span><a id="line.104"> if (c &lt; '\u0020' || c &gt; '\u007e') {</a>
<span class="sourceLineNo">105</span><a id="line.105"> return false;</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"> return true;</a>
<span class="sourceLineNo">109</span><a id="line.109"> }</a>
<span class="sourceLineNo">110</span><a id="line.110"></a>
<span class="sourceLineNo">111</span><a id="line.111"> public boolean isBlockSemicolon() {</a>
<span class="sourceLineNo">112</span><a id="line.112"> return blockSemicolon;</a>
<span class="sourceLineNo">113</span><a id="line.113"> }</a>
<span class="sourceLineNo">114</span><a id="line.114"></a>
<span class="sourceLineNo">115</span><a id="line.115"> public void setBlockSemicolon(boolean blockSemicolon) {</a>
<span class="sourceLineNo">116</span><a id="line.116"> this.blockSemicolon = blockSemicolon;</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"> public boolean isBlockBackslash() {</a>
<span class="sourceLineNo">120</span><a id="line.120"> return blockBackslash;</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"> public void setBlockBackslash(boolean blockBackslash) {</a>
<span class="sourceLineNo">124</span><a id="line.124"> this.blockBackslash = blockBackslash;</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"> public boolean isBlockNonAscii() {</a>
<span class="sourceLineNo">128</span><a id="line.128"> return blockNonAscii;</a>
<span class="sourceLineNo">129</span><a id="line.129"> }</a>
<span class="sourceLineNo">130</span><a id="line.130"></a>
<span class="sourceLineNo">131</span><a id="line.131"> public void setBlockNonAscii(boolean blockNonAscii) {</a>
<span class="sourceLineNo">132</span><a id="line.132"> this.blockNonAscii = blockNonAscii;</a>
<span class="sourceLineNo">133</span><a id="line.133"> }</a>
<span class="sourceLineNo">134</span><a id="line.134">}</a>
</pre>
</div>
</main>
</body>
</html>