| <!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.mgt;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.AntPathMatcher;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.util.PatternMatcher;</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">import org.owasp.encoder.Encode;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.owasp.encoder.Encoder;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">import javax.servlet.FilterChain;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import javax.servlet.FilterConfig;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import javax.servlet.ServletRequest;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import javax.servlet.ServletResponse;</a> |
| <span class="sourceLineNo">033</span><a id="line.33"></a> |
| <span class="sourceLineNo">034</span><a id="line.34">/**</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * A {@code FilterChainResolver} that resolves {@link FilterChain}s based on url path</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * matching, as determined by a configurable {@link #setPathMatcher(org.apache.shiro.util.PatternMatcher) PathMatcher}.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <p/></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * This implementation functions by consulting a {@link org.apache.shiro.web.filter.mgt.FilterChainManager} for all configured filter chains (keyed</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * by configured path pattern). If an incoming Request path matches one of the configured path patterns (via</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * the {@code PathMatcher}, the corresponding configured {@code FilterChain} is returned.</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> *</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * @since 1.0</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> */</a> |
| <span class="sourceLineNo">044</span><a id="line.44">public class PathMatchingFilterChainResolver implements FilterChainResolver {</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> private static transient final Logger log = LoggerFactory.getLogger(PathMatchingFilterChainResolver.class);</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> private FilterChainManager filterChainManager;</a> |
| <span class="sourceLineNo">049</span><a id="line.49"></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> private PatternMatcher pathMatcher;</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> private static final String DEFAULT_PATH_SEPARATOR = "/";</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> public PathMatchingFilterChainResolver() {</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> this.pathMatcher = new AntPathMatcher();</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> this.filterChainManager = new DefaultFilterChainManager();</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"> public PathMatchingFilterChainResolver(FilterConfig filterConfig) {</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> this.pathMatcher = new AntPathMatcher();</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> this.filterChainManager = new DefaultFilterChainManager(filterConfig);</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> }</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> /**</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Returns the {@code PatternMatcher} used when determining if an incoming request's path</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * matches a configured filter chain. Unless overridden, the</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * default implementation is an {@link org.apache.shiro.util.AntPathMatcher AntPathMatcher}.</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> *</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @return the {@code PatternMatcher} used when determining if an incoming request's path</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * matches a configured filter chain.</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> */</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> public PatternMatcher getPathMatcher() {</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> return pathMatcher;</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"> /**</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * Sets the {@code PatternMatcher} used when determining if an incoming request's path</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * matches a configured filter chain. Unless overridden, the</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * default implementation is an {@link org.apache.shiro.util.AntPathMatcher AntPathMatcher}.</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> *</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * @param pathMatcher the {@code PatternMatcher} used when determining if an incoming request's path</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * matches a configured filter chain.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> */</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> public void setPathMatcher(PatternMatcher pathMatcher) {</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> this.pathMatcher = pathMatcher;</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"> public FilterChainManager getFilterChainManager() {</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> return filterChainManager;</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> }</a> |
| <span class="sourceLineNo">091</span><a id="line.91"></a> |
| <span class="sourceLineNo">092</span><a id="line.92"> @SuppressWarnings({"UnusedDeclaration"})</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> public void setFilterChainManager(FilterChainManager filterChainManager) {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> this.filterChainManager = filterChainManager;</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96"></a> |
| <span class="sourceLineNo">097</span><a id="line.97"> public FilterChain getChain(ServletRequest request, ServletResponse response, FilterChain originalChain) {</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> FilterChainManager filterChainManager = getFilterChainManager();</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> if (!filterChainManager.hasChains()) {</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> return null;</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> }</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> String requestURI = getPathWithinApplication(request);</a> |
| <span class="sourceLineNo">104</span><a id="line.104"></a> |
| <span class="sourceLineNo">105</span><a id="line.105"> // in spring web, the requestURI "/resource/menus" ---- "resource/menus/" bose can access the resource</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> // but the pathPattern match "/resource/menus" can not match "resource/menus/"</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> // user can use requestURI + "/" to simply bypassed chain filter, to bypassed shiro protect</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> if(requestURI != null && !DEFAULT_PATH_SEPARATOR.equals(requestURI)</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> && requestURI.endsWith(DEFAULT_PATH_SEPARATOR)) {</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> requestURI = requestURI.substring(0, requestURI.length() - 1);</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> }</a> |
| <span class="sourceLineNo">112</span><a id="line.112"></a> |
| <span class="sourceLineNo">113</span><a id="line.113"></a> |
| <span class="sourceLineNo">114</span><a id="line.114"> //the 'chain names' in this implementation are actually path patterns defined by the user. We just use them</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> //as the chain name for the FilterChainManager's requirements</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> for (String pathPattern : filterChainManager.getChainNames()) {</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> if (pathPattern != null && !DEFAULT_PATH_SEPARATOR.equals(pathPattern)</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> && pathPattern.endsWith(DEFAULT_PATH_SEPARATOR)) {</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> pathPattern = pathPattern.substring(0, pathPattern.length() - 1);</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> }</a> |
| <span class="sourceLineNo">121</span><a id="line.121"></a> |
| <span class="sourceLineNo">122</span><a id="line.122"> // If the path does match, then pass on to the subclass implementation for specific checks:</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> if (pathMatches(pathPattern, requestURI)) {</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> log.trace("Matched path pattern [" + pathPattern + "] for requestURI [" + Encode.forHtml(requestURI) + "]. " +</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> "Utilizing corresponding filter chain...");</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> }</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> return filterChainManager.proxy(originalChain, pathPattern);</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"></a> |
| <span class="sourceLineNo">132</span><a id="line.132"> return null;</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> }</a> |
| <span class="sourceLineNo">134</span><a id="line.134"></a> |
| <span class="sourceLineNo">135</span><a id="line.135"> /**</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * Returns {@code true} if an incoming request path (the {@code path} argument)</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * matches a configured filter chain path (the {@code pattern} argument), {@code false} otherwise.</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * <p/></a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * Simply delegates to</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * <b><code>{@link #getPathMatcher() getPathMatcher()}.{@link org.apache.shiro.util.PatternMatcher#matches(String, String) matches(pattern,path)}</code></b>.</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * Subclass implementors should think carefully before overriding this method, as typically a custom</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * {@code PathMatcher} should be configured for custom path matching behavior instead. Favor OO composition</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * rather than inheritance to limit your exposure to Shiro implementation details which may change over time.</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> *</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * @param pattern the pattern to match against</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> * @param path the value to match with the specified {@code pattern}</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * @return {@code true} if the request {@code path} matches the specified filter chain url {@code pattern},</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> * {@code false} otherwise.</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> */</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> protected boolean pathMatches(String pattern, String path) {</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> PatternMatcher pathMatcher = getPathMatcher();</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> return pathMatcher.matches(pattern, path);</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> }</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"> * Merely returns</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> * <code>WebUtils.{@link org.apache.shiro.web.util.WebUtils#getPathWithinApplication(javax.servlet.http.HttpServletRequest) getPathWithinApplication(request)}</code></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * and can be overridden by subclasses for custom request-to-application-path resolution behavior.</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> *</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * @param request the incoming {@code ServletRequest}</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * @return the request's path within the appliation.</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> */</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> protected String getPathWithinApplication(ServletRequest request) {</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> return WebUtils.getPathWithinApplication(WebUtils.toHttp(request));</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> }</a> |
| <span class="sourceLineNo">166</span><a id="line.166">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
