Merge pull request #140 from rayhidayat/basicauth

Adding basic authentication to web server as a configurable option

docs/configuration.rst

@@ -23,3 +23,7 @@ A configuration file in YAML format will be created at ``~/.wemo/config.yml``::
     # Web app bind address
     #
     # listen: 0.0.0.0:5000
+
+    # Require basic authentication (username:password) for the web app
+    #
+    # auth: admin:password

docs/server.rst

@@ -13,7 +13,9 @@ The necessary dependencies to run the server are not installed unless the
 Configuration
 -------------
 The IP and port to which the server will bind are specified by the ``listen``
-parameter in the configuration file. Default: ``0.0.0.0:5000``.
+parameter in the configuration file. Default: ``0.0.0.0:5000``.  
+Optionally, basic authentication can be enabled for the web server by 
+setting the ``auth`` parameter in the configuration file.
 
 Web App
 --------
@@ -52,4 +54,4 @@ is as valid as::
    POST /api/device/NAME         Toggle switch state, specified by optional
                                  ``state`` argument (default: "toggle"). Valid
                                  values are "on", "off" or "toggle".
-   =====================         =========================================
+   =====================         =========================================

ouimeaux/cli.py

@@ -294,7 +294,7 @@ def server(args):
     except ImportError:
         print("ouimeaux server dependencies are not installed. Please run, e.g., 'pip install ouimeaux[server]'")
         sys.exit(1)
-    initialize(bind=getattr(args, 'bind', None))
+    initialize(bind=getattr(args, 'bind', None), auth=(WemoConfiguration().auth or None))
     level = logging.INFO
     if getattr(args, 'debug', False):
         level = logging.DEBUG

ouimeaux/config.py

@@ -41,6 +41,10 @@ def __init__(self, filename=None):
 # Web app bind address
 #
 # listen: 0.0.0.0:5000
+
+# Require basic authentication (username:password) for the web app
+#
+# auth: admin:password
 """)
         with open(filename, 'r') as cfg:
             self._parsed = yaml.load(cfg)
@@ -56,3 +60,7 @@ def bind(self):
     @property
     def listen(self):
         return self._parsed.get('listen', None)
+
+    @property
+    def auth(self):
+        return self._parsed.get('auth', None)

ouimeaux/server/__init__.py

@@ -5,6 +5,7 @@
 from flask import render_template, send_from_directory, url_for
 from flask import send_file, make_response, abort
 from flask.ext.restful import reqparse, abort, Api, Resource
+from flask.ext.basicauth import BasicAuth
 
 
 from ouimeaux.signals import statechange
@@ -25,12 +26,21 @@
 ENV = None
 
 
-def initialize(bind=None):
+def initialize(bind=None, auth=None):
     global ENV
     if ENV is None:
         ENV = Environment(bind=bind)
         ENV.start()
         gevent.spawn(ENV.discover, 10)
+    if auth is not None:
+        elems = auth.split(':', 1)
+        username = elems[0]
+        password = elems[1]
+        print("Protected server with basic auth username/password: ", username, password)
+        app.config['BASIC_AUTH_USERNAME'] = username
+        app.config['BASIC_AUTH_PASSWORD'] = password
+        app.config['BASIC_AUTH_FORCE'] = True
+        basic_auth = BasicAuth(app)
 
 
 def serialize(device):

setup.py

@@ -22,7 +22,7 @@
 
 setup(
     name='ouimeaux',
-    version='0.8',
+    version='0.8.1',
     description='Open source control for Belkin WeMo devices',
     long_description=readme + '\n\n' + history,
     author='Ian McCracken',
@@ -57,7 +57,11 @@
         ]
     },
     extras_require = {
-        'server':  ["flask-restful", "gevent-socketio"],
+        'server':  [
+            "flask-restful",
+            "flask-basicauth",
+            "gevent-socketio",
+        ],
     },
     test_suite='tests',
 )