blob: ccde2e5a3567839b04d0282184013d720d335769 [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">package org.apache.shiro.web.filter.authz;</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.StringUtils;</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">import java.util.regex.Pattern;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.Map;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">/**</a>
<span class="sourceLineNo">029</span><a id="line.29"> * A Filter that can allow or deny access based on the host that sent the request.</a>
<span class="sourceLineNo">030</span><a id="line.30"> *</a>
<span class="sourceLineNo">031</span><a id="line.31"> * &lt;b&gt;WARNING:&lt;/b&gt; NOT YET FULLY IMPLEMENTED!!! Work in progress.</a>
<span class="sourceLineNo">032</span><a id="line.32"> *</a>
<span class="sourceLineNo">033</span><a id="line.33"> * @since 1.0</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">public class HostFilter extends AuthorizationFilter {</a>
<span class="sourceLineNo">036</span><a id="line.36"></a>
<span class="sourceLineNo">037</span><a id="line.37"> public static final String IPV4_QUAD_REGEX = "(?:[0-9]|[1-9][0-9]|1[0-9][0-9]|2(?:[0-4][0-9]|5[0-5]))";</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"> public static final String IPV4_REGEX = "(?:" + IPV4_QUAD_REGEX + "\\.){3}" + IPV4_QUAD_REGEX + "$";</a>
<span class="sourceLineNo">040</span><a id="line.40"> public static final Pattern IPV4_PATTERN = Pattern.compile(IPV4_REGEX);</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> public static final String PRIVATE_CLASS_B_SUBSET = "(?:1[6-9]|2[0-9]|3[0-1])";</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> public static final String PRIVATE_CLASS_A_REGEX = "10\\.(?:" + IPV4_QUAD_REGEX + "\\.){2}" + IPV4_QUAD_REGEX + "$";</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> public static final String PRIVATE_CLASS_B_REGEX =</a>
<span class="sourceLineNo">047</span><a id="line.47"> "172\\." + PRIVATE_CLASS_B_SUBSET + "\\." + IPV4_QUAD_REGEX + "\\." + IPV4_QUAD_REGEX + "$";</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> public static final String PRIVATE_CLASS_C_REGEX = "192\\.168\\." + IPV4_QUAD_REGEX + "\\." + IPV4_QUAD_REGEX + "$";</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> Map&lt;String, String&gt; authorizedIps; //user-configured IP (which can be wildcarded) to constructed regex mapping</a>
<span class="sourceLineNo">052</span><a id="line.52"> Map&lt;String, String&gt; deniedIps;</a>
<span class="sourceLineNo">053</span><a id="line.53"> Map&lt;String, String&gt; authorizedHostnames;</a>
<span class="sourceLineNo">054</span><a id="line.54"> Map&lt;String, String&gt; deniedHostnames;</a>
<span class="sourceLineNo">055</span><a id="line.55"></a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> public void setAuthorizedHosts(String authorizedHosts) {</a>
<span class="sourceLineNo">058</span><a id="line.58"> if (!StringUtils.hasText(authorizedHosts)) {</a>
<span class="sourceLineNo">059</span><a id="line.59"> throw new IllegalArgumentException("authorizedHosts argument cannot be null or empty.");</a>
<span class="sourceLineNo">060</span><a id="line.60"> }</a>
<span class="sourceLineNo">061</span><a id="line.61"> String[] hosts = StringUtils.tokenizeToStringArray(authorizedHosts, ", \t");</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> for (String host : hosts) {</a>
<span class="sourceLineNo">064</span><a id="line.64"> //replace any periods with \\. to ensure the regex works:</a>
<span class="sourceLineNo">065</span><a id="line.65"> String periodsReplaced = host.replace(".", "\\.");</a>
<span class="sourceLineNo">066</span><a id="line.66"> //check for IPv4:</a>
<span class="sourceLineNo">067</span><a id="line.67"> String wildcardsReplaced = periodsReplaced.replace("*", IPV4_QUAD_REGEX);</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> if (IPV4_PATTERN.matcher(wildcardsReplaced).matches()) {</a>
<span class="sourceLineNo">070</span><a id="line.70"> authorizedIps.put(host, wildcardsReplaced);</a>
<span class="sourceLineNo">071</span><a id="line.71"> } else {</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> }</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"></a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> public void setDeniedHosts(String deniedHosts) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> if (!StringUtils.hasText(deniedHosts)) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> throw new IllegalArgumentException("deniedHosts argument cannot be null or empty.");</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</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"> protected boolean isIpv4Candidate(String host) {</a>
<span class="sourceLineNo">087</span><a id="line.87"> String[] quads = StringUtils.tokenizeToStringArray(host, ".");</a>
<span class="sourceLineNo">088</span><a id="line.88"> if (quads == null || quads.length != 4) {</a>
<span class="sourceLineNo">089</span><a id="line.89"> return false;</a>
<span class="sourceLineNo">090</span><a id="line.90"> }</a>
<span class="sourceLineNo">091</span><a id="line.91"> for (String quad : quads) {</a>
<span class="sourceLineNo">092</span><a id="line.92"> if (!quad.equals("*")) {</a>
<span class="sourceLineNo">093</span><a id="line.93"> try {</a>
<span class="sourceLineNo">094</span><a id="line.94"> Integer.parseInt(quad);</a>
<span class="sourceLineNo">095</span><a id="line.95"> } catch (NumberFormatException nfe) {</a>
<span class="sourceLineNo">096</span><a id="line.96"> return false;</a>
<span class="sourceLineNo">097</span><a id="line.97"> }</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"> return true;</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"> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {</a>
<span class="sourceLineNo">104</span><a id="line.104"> throw new UnsupportedOperationException("Not yet fully implemented!!!" );</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106">}</a>
</pre>
</div>
</main>
</body>
</html>