| <!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"> * <p></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"> * <ul></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <li>Semicolon - can be disabled by setting {@code blockSemicolon = false}</li></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * <li>Backslash - can be disabled by setting {@code blockBackslash = false}</li></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * <li>Non-ASCII characters - can be disabled by setting {@code blockNonAscii = false}, the ability to disable this check will be removed in future version.</li></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <li>Path traversals - can be disabled by setting {@code blockTraversal = false}</li></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * </ul></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @see <a href="https://docs.spring.io/spring-security/site/docs/current/api/org/springframework/security/web/firewall/StrictHttpFirewall.html">This class was inspired by Spring Security StrictHttpFirewall</a></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @since 1.6</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> */</a> |
| <span class="sourceLineNo">046</span><a id="line.46">public class InvalidRequestFilter extends AccessControlFilter {</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> private static final List<String> SEMICOLON = Collections.unmodifiableList(Arrays.asList(";", "%3b", "%3B"));</a> |
| <span class="sourceLineNo">049</span><a id="line.49"></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> private static final List<String> BACKSLASH = Collections.unmodifiableList(Arrays.asList("\\", "%5c", "%5C"));</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> private static final List<String> FORWARDSLASH = Collections.unmodifiableList(Arrays.asList("%2f", "%2F"));</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> private static final List<String> PERIOD = Collections.unmodifiableList(Arrays.asList("%2e", "%2E"));</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> private boolean blockSemicolon = true;</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> private boolean blockBackslash = !Boolean.getBoolean(WebUtils.ALLOW_BACKSLASH);</a> |
| <span class="sourceLineNo">059</span><a id="line.59"></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> private boolean blockNonAscii = true;</a> |
| <span class="sourceLineNo">061</span><a id="line.61"></a> |
| <span class="sourceLineNo">062</span><a id="line.62"> private boolean blockTraversal = true;</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> @Override</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> protected boolean isAccessAllowed(ServletRequest req, ServletResponse response, Object mappedValue) throws Exception {</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> HttpServletRequest request = WebUtils.toHttp(req);</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> // check the original and decoded values</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> return isValid(request.getRequestURI()) // user request string (not decoded)</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> && isValid(request.getServletPath()) // decoded servlet part</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> && isValid(request.getPathInfo()); // decoded path info (may be null)</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"> private boolean isValid(String uri) {</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> return !StringUtils.hasText(uri)</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> || ( !containsSemicolon(uri)</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> && !containsBackslash(uri)</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> && !containsNonAsciiCharacters(uri))</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> && !containsTraversal(uri);</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> }</a> |
| <span class="sourceLineNo">080</span><a id="line.80"></a> |
| <span class="sourceLineNo">081</span><a id="line.81"> @Override</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> WebUtils.toHttp(response).sendError(400, "Invalid request");</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> return false;</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> }</a> |
| <span class="sourceLineNo">086</span><a id="line.86"></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> private boolean containsSemicolon(String uri) {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> if (isBlockSemicolon()) {</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> return SEMICOLON.stream().anyMatch(uri::contains);</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> }</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> return false;</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> }</a> |
| <span class="sourceLineNo">093</span><a id="line.93"></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> private boolean containsBackslash(String uri) {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> if (isBlockBackslash()) {</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> return BACKSLASH.stream().anyMatch(uri::contains);</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> }</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> return false;</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> }</a> |
| <span class="sourceLineNo">100</span><a id="line.100"></a> |
| <span class="sourceLineNo">101</span><a id="line.101"> private boolean containsNonAsciiCharacters(String uri) {</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> if (isBlockNonAscii()) {</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> return !containsOnlyPrintableAsciiCharacters(uri);</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> }</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"> private static boolean containsOnlyPrintableAsciiCharacters(String uri) {</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> int length = uri.length();</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> for (int i = 0; i < length; i++) {</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> char c = uri.charAt(i);</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> if (c < '\u0020' || c > '\u007e') {</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> return false;</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> }</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> }</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> return true;</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"> private boolean containsTraversal(String uri) {</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> if (isBlockTraversal()) {</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> return !(isNormalized(uri)</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> && PERIOD.stream().noneMatch(uri::contains)</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> && FORWARDSLASH.stream().noneMatch(uri::contains));</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> }</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> return false;</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"> * Checks whether a path is normalized (doesn't contain path traversal sequences like</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * "./", "/../" or "/.")</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @param path the path to test</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * @return true if the path doesn't contain any path-traversal character sequences.</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> */</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> private boolean isNormalized(String path) {</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> if (path == null) {</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> return true;</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> }</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> for (int i = path.length(); i > 0;) {</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> int slashIndex = path.lastIndexOf('/', i - 1);</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> int gap = i - slashIndex;</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> if (gap == 2 && path.charAt(slashIndex + 1) == '.') {</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> return false; // ".", "/./" or "/."</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> }</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> if (gap == 3 && path.charAt(slashIndex + 1) == '.' && path.charAt(slashIndex + 2) == '.') {</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> return false;</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> }</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> i = slashIndex;</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> }</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> return true;</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> }</a> |
| <span class="sourceLineNo">151</span><a id="line.151"></a> |
| <span class="sourceLineNo">152</span><a id="line.152"> public boolean isBlockSemicolon() {</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> return blockSemicolon;</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> }</a> |
| <span class="sourceLineNo">155</span><a id="line.155"></a> |
| <span class="sourceLineNo">156</span><a id="line.156"> public void setBlockSemicolon(boolean blockSemicolon) {</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> this.blockSemicolon = blockSemicolon;</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> }</a> |
| <span class="sourceLineNo">159</span><a id="line.159"></a> |
| <span class="sourceLineNo">160</span><a id="line.160"> public boolean isBlockBackslash() {</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> return blockBackslash;</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> }</a> |
| <span class="sourceLineNo">163</span><a id="line.163"></a> |
| <span class="sourceLineNo">164</span><a id="line.164"> public void setBlockBackslash(boolean blockBackslash) {</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> this.blockBackslash = blockBackslash;</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> }</a> |
| <span class="sourceLineNo">167</span><a id="line.167"></a> |
| <span class="sourceLineNo">168</span><a id="line.168"> public boolean isBlockNonAscii() {</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> return blockNonAscii;</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> }</a> |
| <span class="sourceLineNo">171</span><a id="line.171"></a> |
| <span class="sourceLineNo">172</span><a id="line.172"> public void setBlockNonAscii(boolean blockNonAscii) {</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> this.blockNonAscii = blockNonAscii;</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> }</a> |
| <span class="sourceLineNo">175</span><a id="line.175"></a> |
| <span class="sourceLineNo">176</span><a id="line.176"> public boolean isBlockTraversal() {</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> return blockTraversal;</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> }</a> |
| <span class="sourceLineNo">179</span><a id="line.179"></a> |
| <span class="sourceLineNo">180</span><a id="line.180"> public void setBlockTraversal(boolean blockTraversal) {</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> this.blockTraversal = blockTraversal;</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> }</a> |
| <span class="sourceLineNo">183</span><a id="line.183">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
