blob: 80a91f7aba27880ee7921015722906045c2b8edd [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.authc;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.web.filter.PathMatchingFilter;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">import javax.servlet.ServletRequest;</a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.servlet.ServletResponse;</a>
<span class="sourceLineNo">025</span><a id="line.25"></a>
<span class="sourceLineNo">026</span><a id="line.26">/**</a>
<span class="sourceLineNo">027</span><a id="line.27"> * Filter that allows access to a path immeidately without performing security checks of any kind.</a>
<span class="sourceLineNo">028</span><a id="line.28"> * &lt;p/&gt;</a>
<span class="sourceLineNo">029</span><a id="line.29"> * This filter is useful primarily in exclusionary policies, where you have defined a url pattern</a>
<span class="sourceLineNo">030</span><a id="line.30"> * to require a certain security level, but maybe only subset of urls in that pattern should allow any access.</a>
<span class="sourceLineNo">031</span><a id="line.31"> * &lt;p/&gt;</a>
<span class="sourceLineNo">032</span><a id="line.32"> * For example, if you had a user-only section of a website, you might want to require that access to</a>
<span class="sourceLineNo">033</span><a id="line.33"> * any url in that section must be from an authenticated user.</a>
<span class="sourceLineNo">034</span><a id="line.34"> * &lt;p/&gt;</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Here is how that would look in the IniShiroFilter configuration:</a>
<span class="sourceLineNo">036</span><a id="line.36"> * &lt;p/&gt;</a>
<span class="sourceLineNo">037</span><a id="line.37"> * &lt;code&gt;[urls]&lt;br/&gt;</a>
<span class="sourceLineNo">038</span><a id="line.38"> * /user/** = authc&lt;/code&gt;</a>
<span class="sourceLineNo">039</span><a id="line.39"> * &lt;p/&gt;</a>
<span class="sourceLineNo">040</span><a id="line.40"> * But if you wanted &lt;code&gt;/user/signup/**&lt;/code&gt; to be available to anyone, you have to exclude that path since</a>
<span class="sourceLineNo">041</span><a id="line.41"> * it is a subset of the first. This is where the AnonymousFilter ('anon') is useful:</a>
<span class="sourceLineNo">042</span><a id="line.42"> * &lt;p/&gt;</a>
<span class="sourceLineNo">043</span><a id="line.43"> * &lt;code&gt;[urls]&lt;br/&gt;</a>
<span class="sourceLineNo">044</span><a id="line.44"> * /user/signup/** = anon&lt;br/&gt;</a>
<span class="sourceLineNo">045</span><a id="line.45"> * /user/** = authc&lt;/code&gt;&gt;</a>
<span class="sourceLineNo">046</span><a id="line.46"> * &lt;p/&gt;</a>
<span class="sourceLineNo">047</span><a id="line.47"> * Since the url pattern definitions follow a 'first match wins' paradigm, the &lt;code&gt;anon&lt;/code&gt; filter will</a>
<span class="sourceLineNo">048</span><a id="line.48"> * match the &lt;code&gt;/user/signup/**&lt;/code&gt; paths and the &lt;code&gt;/user/**&lt;/code&gt; path chain will not be evaluated.</a>
<span class="sourceLineNo">049</span><a id="line.49"> *</a>
<span class="sourceLineNo">050</span><a id="line.50"> * @since 0.9</a>
<span class="sourceLineNo">051</span><a id="line.51"> */</a>
<span class="sourceLineNo">052</span><a id="line.52">public class AnonymousFilter extends PathMatchingFilter {</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54"> /**</a>
<span class="sourceLineNo">055</span><a id="line.55"> * Always returns &lt;code&gt;true&lt;/code&gt; allowing unchecked access to the underlying path or resource.</a>
<span class="sourceLineNo">056</span><a id="line.56"> *</a>
<span class="sourceLineNo">057</span><a id="line.57"> * @return &lt;code&gt;true&lt;/code&gt; always, allowing unchecked access to the underlying path or resource.</a>
<span class="sourceLineNo">058</span><a id="line.58"> */</a>
<span class="sourceLineNo">059</span><a id="line.59"> @Override</a>
<span class="sourceLineNo">060</span><a id="line.60"> protected boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) {</a>
<span class="sourceLineNo">061</span><a id="line.61"> // Always return true since we allow access to anyone</a>
<span class="sourceLineNo">062</span><a id="line.62"> return true;</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">}</a>
</pre>
</div>
</main>
</body>
</html>