Add FilterByClientIpPlugin example (#381)

Author: abhinavsingh

dashboard/src/proxy.css

@@ -15,7 +15,7 @@ html, body {
 }
 
 main {
-    height: 88%;
+    height: 89.75%;
 }
 
 section {

proxy/common/version.py

@@ -8,5 +8,5 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-VERSION = (2, 2, 0)
+VERSION = (2, 2, 1)
 __version__ = '.'.join(map(str, VERSION[0:3]))

proxy/plugin/__init__.py

@@ -18,6 +18,7 @@
 from .web_server_route import WebServerPlugin
 from .reverse_proxy import ReverseProxyPlugin
 from .proxy_pool import ProxyPoolPlugin
+from .filter_by_client_ip import FilterByClientIpPlugin
 
 __all__ = [
     'CacheResponsesPlugin',
@@ -31,4 +32,5 @@
     'WebServerPlugin',
     'ReverseProxyPlugin',
     'ProxyPoolPlugin',
+    'FilterByClientIpPlugin',
 ]

proxy/plugin/filter_by_client_ip.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+"""
+    proxy.py
+    ~~~~~~~~
+    ⚡⚡⚡ Fast, Lightweight, Pluggable, TLS interception capable proxy server focused on
+    Network monitoring, controls & Application development, testing, debugging.
+
+    :copyright: (c) 2013-present by Abhinav Singh and contributors.
+    :license: BSD, see LICENSE for more details.
+"""
+from typing import Optional
+
+from ..http.exception import HttpRequestRejected
+from ..http.parser import HttpParser
+from ..http.codes import httpStatusCodes
+from ..http.proxy import HttpProxyBasePlugin
+
+
+class FilterByClientIpPlugin(HttpProxyBasePlugin):
+    """Drop traffic by inspecting incoming client IP address."""
+
+    FILTERED_IPS = ['127.0.0.1', '::1']
+
+    def before_upstream_connection(
+            self, request: HttpParser) -> Optional[HttpParser]:
+        if self.client.addr[0] in self.FILTERED_IPS:
+            raise HttpRequestRejected(
+                status_code=httpStatusCodes.I_AM_A_TEAPOT, reason=b'I\'m a tea pot',
+                headers={
+                    b'Connection': b'close',
+                }
+            )
+        return request
+
+    def handle_client_request(
+            self, request: HttpParser) -> Optional[HttpParser]:
+        return request
+
+    def handle_upstream_chunk(self, chunk: memoryview) -> memoryview:
+        return chunk
+
+    def on_upstream_connection_close(self) -> None:
+        pass

setup.py

@@ -10,7 +10,7 @@
 """
 from setuptools import setup, find_packages
 
-VERSION = (2, 2, 0)
+VERSION = (2, 2, 1)
 __version__ = '.'.join(map(str, VERSION[0:3]))
 __description__ = '''⚡⚡⚡Fast, Lightweight, Pluggable, TLS interception capable proxy server
     focused on Network monitoring, controls & Application development, testing, debugging.'''