blob: 9df02ed947ed973cdaa33298c86f4ab6464a3360 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.web.filter.authc;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.web.filter.PathMatchingFilter;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import javax.servlet.ServletRequest;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import javax.servlet.ServletResponse;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Filter that allows access to a path immeidately without performing security checks of any kind.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p/&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * This filter is useful primarily in exclusionary policies, where you have defined a url pattern<a name="line.29"></a>
<span class="sourceLineNo">030</span> * to require a certain security level, but maybe only subset of urls in that pattern should allow any access.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p/&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * For example, if you had a user-only section of a website, you might want to require that access to<a name="line.32"></a>
<span class="sourceLineNo">033</span> * any url in that section must be from an authenticated user.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p/&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Here is how that would look in the IniShiroFilter configuration:<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p/&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;code&gt;[urls]&lt;br/&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * /user/** = authc&lt;/code&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p/&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * 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 name="line.40"></a>
<span class="sourceLineNo">041</span> * it is a subset of the first. This is where the AnonymousFilter ('anon') is useful:<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p/&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;code&gt;[urls]&lt;br/&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * /user/signup/** = anon&lt;br/&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * /user/** = authc&lt;/code&gt;&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;p/&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Since the url pattern definitions follow a 'first match wins' paradigm, the &lt;code&gt;anon&lt;/code&gt; filter will<a name="line.47"></a>
<span class="sourceLineNo">048</span> * 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 name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @since 0.9<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span>public class AnonymousFilter extends PathMatchingFilter {<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * Always returns &lt;code&gt;true&lt;/code&gt; allowing unchecked access to the underlying path or resource.<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @return &lt;code&gt;true&lt;/code&gt; always, allowing unchecked access to the underlying path or resource.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> @Override<a name="line.59"></a>
<span class="sourceLineNo">060</span> protected boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> // Always return true since we allow access to anyone<a name="line.61"></a>
<span class="sourceLineNo">062</span> return true;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>}<a name="line.65"></a>
</pre>
</div>
</body>
</html>