Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.13 / apidocs / src-html / org / apache / mina / filter / firewall / BlacklistFilter.html
blob: 87a052a05960bfd1a039f45a14d9d3ba5c1986db [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> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.filter.firewall;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.InetSocketAddress;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.SocketAddress;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.CopyOnWriteArrayList;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.mina.core.filterchain.IoFilter;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.core.filterchain.IoFilterAdapter;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.session.IdleStatus;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.session.IoSession;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.core.write.WriteRequest;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.slf4j.Logger;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.slf4j.LoggerFactory;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * A {@link IoFilter} which blocks connections from blacklisted remote<a name="line.37"></a>
<span class="sourceLineNo">038</span> * address.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @org.apache.xbean.XBean<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class BlacklistFilter extends IoFilterAdapter {<a name="line.43"></a>
<span class="sourceLineNo">044</span> /** The list of blocked addresses */<a name="line.44"></a>
<span class="sourceLineNo">045</span> private final List&lt;Subnet&gt; blacklist = new CopyOnWriteArrayList&lt;Subnet&gt;();<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> private final static Logger LOGGER = LoggerFactory.getLogger(BlacklistFilter.class);<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * Sets the addresses to be blacklisted.<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * NOTE: this call will remove any previously blacklisted addresses.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param addresses an array of addresses to be blacklisted.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> public void setBlacklist(InetAddress[] addresses) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> if (addresses == null) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> throw new IllegalArgumentException("addresses");<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> blacklist.clear();<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> for (int i = 0; i &lt; addresses.length; i++) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> InetAddress addr = addresses[i];<a name="line.64"></a>
<span class="sourceLineNo">065</span> block(addr);<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * Sets the subnets to be blacklisted.<a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> * NOTE: this call will remove any previously blacklisted subnets.<a name="line.72"></a>
<span class="sourceLineNo">073</span> *<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @param subnets an array of subnets to be blacklisted.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> public void setSubnetBlacklist(Subnet[] subnets) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (subnets == null) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> throw new IllegalArgumentException("Subnets must not be null");<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> blacklist.clear();<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> for (Subnet subnet : subnets) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> block(subnet);<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Sets the addresses to be blacklisted.<a name="line.89"></a>
<span class="sourceLineNo">090</span> *<a name="line.90"></a>
<span class="sourceLineNo">091</span> * NOTE: this call will remove any previously blacklisted addresses.<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param addresses a collection of InetAddress objects representing the<a name="line.93"></a>
<span class="sourceLineNo">094</span> * addresses to be blacklisted.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @throws IllegalArgumentException if the specified collections contains<a name="line.95"></a>
<span class="sourceLineNo">096</span> * non-{@link InetAddress} objects.<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public void setBlacklist(Iterable&lt;InetAddress&gt; addresses) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (addresses == null) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> throw new IllegalArgumentException("addresses");<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> blacklist.clear();<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> for (InetAddress address : addresses) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> block(address);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
<span class="sourceLineNo">111</span> * Sets the subnets to be blacklisted.<a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * NOTE: this call will remove any previously blacklisted subnets.<a name="line.113"></a>
<span class="sourceLineNo">114</span> *<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @param subnets an array of subnets to be blacklisted.<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> public void setSubnetBlacklist(Iterable&lt;Subnet&gt; subnets) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (subnets == null) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> throw new IllegalArgumentException("Subnets must not be null");<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> blacklist.clear();<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> for (Subnet subnet : subnets) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> block(subnet);<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Blocks the specified endpoint.<a name="line.130"></a>
<span class="sourceLineNo">131</span> * <a name="line.131"></a>
<span class="sourceLineNo">132</span> * @param address The address to block<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> public void block(InetAddress address) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (address == null) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> throw new IllegalArgumentException("Adress to block can not be null");<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> block(new Subnet(address, 32));<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> /**<a name="line.142"></a>
<span class="sourceLineNo">143</span> * Blocks the specified subnet.<a name="line.143"></a>
<span class="sourceLineNo">144</span> * <a name="line.144"></a>
<span class="sourceLineNo">145</span> * @param subnet The subnet to block<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> public void block(Subnet subnet) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (subnet == null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> throw new IllegalArgumentException("Subnet can not be null");<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> blacklist.add(subnet);<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
<span class="sourceLineNo">156</span> * Unblocks the specified endpoint.<a name="line.156"></a>
<span class="sourceLineNo">157</span> * <a name="line.157"></a>
<span class="sourceLineNo">158</span> * @param address The address to unblock<a name="line.158"></a>
<span class="sourceLineNo">159</span> */<a name="line.159"></a>
<span class="sourceLineNo">160</span> public void unblock(InetAddress address) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (address == null) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> throw new IllegalArgumentException("Adress to unblock can not be null");<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> unblock(new Subnet(address, 32));<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
<span class="sourceLineNo">169</span> * Unblocks the specified subnet.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * <a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param subnet The subnet to unblock<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> public void unblock(Subnet subnet) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if (subnet == null) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> throw new IllegalArgumentException("Subnet can not be null");<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> blacklist.remove(subnet);<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> @Override<a name="line.181"></a>
<span class="sourceLineNo">182</span> public void sessionCreated(NextFilter nextFilter, IoSession session) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> if (!isBlocked(session)) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> // forward if not blocked<a name="line.184"></a>
<span class="sourceLineNo">185</span> nextFilter.sessionCreated(session);<a name="line.185"></a>
<span class="sourceLineNo">186</span> } else {<a name="line.186"></a>
<span class="sourceLineNo">187</span> blockSession(session);<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> @Override<a name="line.191"></a>
<span class="sourceLineNo">192</span> public void sessionOpened(NextFilter nextFilter, IoSession session) throws Exception {<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (!isBlocked(session)) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> // forward if not blocked<a name="line.194"></a>
<span class="sourceLineNo">195</span> nextFilter.sessionOpened(session);<a name="line.195"></a>
<span class="sourceLineNo">196</span> } else {<a name="line.196"></a>
<span class="sourceLineNo">197</span> blockSession(session);<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> @Override<a name="line.201"></a>
<span class="sourceLineNo">202</span> public void sessionClosed(NextFilter nextFilter, IoSession session) throws Exception {<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (!isBlocked(session)) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> // forward if not blocked<a name="line.204"></a>
<span class="sourceLineNo">205</span> nextFilter.sessionClosed(session);<a name="line.205"></a>
<span class="sourceLineNo">206</span> } else {<a name="line.206"></a>
<span class="sourceLineNo">207</span> blockSession(session);<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span><a name="line.210"></a>
<span class="sourceLineNo">211</span> @Override<a name="line.211"></a>
<span class="sourceLineNo">212</span> public void sessionIdle(NextFilter nextFilter, IoSession session, IdleStatus status) throws Exception {<a name="line.212"></a>
<span class="sourceLineNo">213</span> if (!isBlocked(session)) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> // forward if not blocked<a name="line.214"></a>
<span class="sourceLineNo">215</span> nextFilter.sessionIdle(session, status);<a name="line.215"></a>
<span class="sourceLineNo">216</span> } else {<a name="line.216"></a>
<span class="sourceLineNo">217</span> blockSession(session);<a name="line.217"></a>
<span class="sourceLineNo">218</span> }<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> @Override<a name="line.221"></a>
<span class="sourceLineNo">222</span> public void messageReceived(NextFilter nextFilter, IoSession session, Object message) {<a name="line.222"></a>
<span class="sourceLineNo">223</span> if (!isBlocked(session)) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> // forward if not blocked<a name="line.224"></a>
<span class="sourceLineNo">225</span> nextFilter.messageReceived(session, message);<a name="line.225"></a>
<span class="sourceLineNo">226</span> } else {<a name="line.226"></a>
<span class="sourceLineNo">227</span> blockSession(session);<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> @Override<a name="line.231"></a>
<span class="sourceLineNo">232</span> public void messageSent(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception {<a name="line.232"></a>
<span class="sourceLineNo">233</span> if (!isBlocked(session)) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> // forward if not blocked<a name="line.234"></a>
<span class="sourceLineNo">235</span> nextFilter.messageSent(session, writeRequest);<a name="line.235"></a>
<span class="sourceLineNo">236</span> } else {<a name="line.236"></a>
<span class="sourceLineNo">237</span> blockSession(session);<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span> }<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span> private void blockSession(IoSession session) {<a name="line.241"></a>
<span class="sourceLineNo">242</span> LOGGER.warn("Remote address in the blacklist; closing.");<a name="line.242"></a>
<span class="sourceLineNo">243</span> session.close(true);<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span> private boolean isBlocked(IoSession session) {<a name="line.246"></a>
<span class="sourceLineNo">247</span> SocketAddress remoteAddress = session.getRemoteAddress();<a name="line.247"></a>
<span class="sourceLineNo">248</span><a name="line.248"></a>
<span class="sourceLineNo">249</span> if (remoteAddress instanceof InetSocketAddress) {<a name="line.249"></a>
<span class="sourceLineNo">250</span> InetAddress address = ((InetSocketAddress) remoteAddress).getAddress();<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span> // check all subnets<a name="line.252"></a>
<span class="sourceLineNo">253</span> for (Subnet subnet : blacklist) {<a name="line.253"></a>
<span class="sourceLineNo">254</span> if (subnet.inSubnet(address)) {<a name="line.254"></a>
<span class="sourceLineNo">255</span> return true;<a name="line.255"></a>
<span class="sourceLineNo">256</span> }<a name="line.256"></a>
<span class="sourceLineNo">257</span> }<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> return false;<a name="line.260"></a>
<span class="sourceLineNo">261</span> }<a name="line.261"></a>
<span class="sourceLineNo">262</span>}<a name="line.262"></a>
</pre>
</div>
</body>
</html>