Merge lp:~soren/surveilr/auth into lp:surveilr

[Soren Hansen]

Add authentication

Use repoze.who to provide a simple authentication system.

[lp:~soren/surveilr/auth]

21. By Soren Hansen on 2012-01-04

Add authentication

Use repoze.who to provide a simple authentication system.

=== modified file 'surveilr/api/__init__.py'
--- surveilr/api/__init__.py	2011-11-19 22:01:55 +0000
+++ surveilr/api/__init__.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,19 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+"""
 
=== added directory 'surveilr/api/server'
=== added file 'surveilr/api/server/__init__.py'
--- surveilr/api/server/__init__.py	1970-01-01 00:00:00 +0000
+++ surveilr/api/server/__init__.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,21 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    Log collection server implementation
+"""
 
=== renamed file 'surveilr/api/server.py' => 'surveilr/api/server/app.py'
--- surveilr/api/server.py	2011-12-18 14:46:48 +0000
+++ surveilr/api/server/app.py	2012-01-04 23:13:32 +0000
@@ -18,11 +18,12 @@
     License along with this program.  If not, see
     <http://www.gnu.org/licenses/>.
 
-    Log collection server implementation
+    API server implementation
 """
 
 import eventlet
 import eventlet.wsgi
+import functools
 import json
 import time
 
@@ -34,12 +35,29 @@
 from webob import Response
 from webob.dec import wsgify
 from webob.exc import HTTPNotFound
+from webob.exc import HTTPForbidden
 
 from surveilr import config
 from surveilr import messaging
 from surveilr import models
 from surveilr import utils
 
+def is_privileged(req):
+    if 'surveilr.user' in req.environ:
+        return req.environ['surveilr.user'].credentials['admin']
+    # This feels pretty scary
+    return True
+
+
+def privileged(f):
+    @functools.wraps(f)
+    def wrapped(self, req, *args):
+        if is_privileged(req):
+            return f(self, req, *args)
+        else:
+            return HTTPForbidden()
+    return wrapped
+
 
 class NotificationController(object):
     """Routes style controller for notifications"""
@@ -58,15 +76,30 @@
 class UserController(object):
     """Routes style controller for actions related to users"""
 
+    @privileged
     def create(self, req):
         """Called for POST requests to /users
 
         Creates the user, returns a JSON object with the ID assigned
         to the user"""
         data = json.loads(req.body)
-        user = models.User(**data)
+
+        obj_data = {}
+
+        obj_data['credentials'] = {}
+
+        if 'admin' in data:
+            obj_data['credentials']['admin'] = data['admin']
+
+        for key in ['messaging_driver', 'messaging_address']:
+            if key in data:
+                obj_data[key] = data[key]
+
+        user = models.User(**obj_data)
         user.save()
-        response = {'id': user.key}
+        response = {'id': user.key,
+                    'key': user.api_key,
+                    'admin': user.credentials.get('admin', False)}
         return Response(json.dumps(response))
 
     def show(self, req, id):
@@ -77,7 +110,8 @@
             user = models.User.get(id)
             resp_dict = {'id': user.key,
                          'messaging_driver': user.messaging_driver,
-                         'messaging_address': user.messaging_address}
+                         'messaging_address': user.messaging_address,
+                         'admin': user.credentials.get('admin', False)}
             return Response(json.dumps(resp_dict))
         except riakalchemy.NoSuchObjectError:
             return HTTPNotFound()
@@ -183,7 +217,10 @@
                  path_prefix='/users/{user_id}')
 
     def __init__(self, global_config):
-        pass
+        riak_host = config.get_str('riak', 'host')
+        riak_port = config.get_int('riak', 'port')
+
+        riakalchemy.connect(host=riak_host, port=riak_port)
 
     @wsgify
     def __call__(self, req):
@@ -216,11 +253,6 @@
 
 
 def main():
-    riak_host = config.get_str('riak', 'host')
-    riak_port = config.get_int('riak', 'port')
-
-    riakalchemy.connect(host=riak_host, port=riak_port)
-
     server_factory({}, '', 9877)(SurveilrApplication({}))
 
 
 
=== added file 'surveilr/api/server/auth.py'
--- surveilr/api/server/auth.py	1970-01-01 00:00:00 +0000
+++ surveilr/api/server/auth.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,48 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    API server auth implementation
+"""
+
+from surveilr import models
+
+from riakalchemy import NoSuchObjectError
+
+class AlwaysRequireAuth(object):
+    def __call__(self, environ, status, headers):
+        return 'repoze.who.identity' not in environ
+
+
+class SurveilrAuthPlugin(object):
+    def authenticate(self, environ, identity):
+        try:
+            login = identity['login']
+            password = identity['password']
+        except KeyError:
+            return None
+
+        try:
+            user = models.User.get(key=login)
+        except NoSuchObjectError:
+            return None
+
+        if user.api_key == password:
+            environ['surveilr.user'] = user
+            return login
+        return None
 
=== added file 'surveilr/api/server/factory.py'
--- surveilr/api/server/factory.py	1970-01-01 00:00:00 +0000
+++ surveilr/api/server/factory.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,29 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    API server factory
+"""
+import eventlet
+
+def server_factory(global_conf, host, port):
+    port = int(port)
+    def serve(application):
+        socket = eventlet.listen((host, port))
+        eventlet.wsgi.server(socket, application)
+    return serve
 
=== modified file 'surveilr/defaults.cfg'
--- surveilr/defaults.cfg	2011-12-20 10:59:35 +0000
+++ surveilr/defaults.cfg	2012-01-04 23:13:32 +0000
@@ -12,13 +12,22 @@
 port = 8098
 
 [server:main]
-paste.server_factory = surveilr.api.server:server_factory
+paste.server_factory = surveilr.api.server.factory:server_factory
 host = 0.0.0.0
 port = 8977
 
 [composite:main]
 use = egg:Paste#urlmap
-/surveilr = core
+/surveilr = secured
+
+[pipeline:secured]
+pipeline = who core
 
 [app:core]
-paste.app_factory = surveilr.api.server:SurveilrApplication
+paste.app_factory = surveilr.api.server.app:SurveilrApplication
+
+[filter:who]
+use = egg:repoze.who#config
+config_file = %(here)s/who.ini
+log_file = stdout
+log_level = debug
 
=== modified file 'surveilr/models.py'
--- surveilr/models.py	2011-12-09 16:17:30 +0000
+++ surveilr/models.py	2012-01-04 23:13:32 +0000
@@ -22,6 +22,7 @@
 from riakalchemy import RiakObject
 from riakalchemy.types import Integer, String, Dict, RelatedObjects
 
+from surveilr import utils
 
 class Service(RiakObject):
     """A service that is referenced by many LogEntry's
@@ -43,9 +44,14 @@
     """A user of the service"""
     bucket_name = 'users'
 
+    api_key = String()
+    credentials = Dict()
     messaging_driver = String()
     messaging_address = String()
 
+    def pre_save(self):
+        if not hasattr(self, 'api_key'):
+            self.api_key = utils.generate_key()
 
 class LogEntry(RiakObject):
     """A log entry holding one or more metrics
 
=== added directory 'surveilr/tests/api/server'
=== added file 'surveilr/tests/api/server/__init__.py'
--- surveilr/tests/api/server/__init__.py	1970-01-01 00:00:00 +0000
+++ surveilr/tests/api/server/__init__.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,19 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+"""
 
=== renamed file 'surveilr/tests/api/test_server.py' => 'surveilr/tests/api/server/test_app.py'
--- surveilr/tests/api/test_server.py	2011-12-20 10:59:35 +0000
+++ surveilr/tests/api/server/test_app.py	2012-01-04 23:13:32 +0000
@@ -27,8 +27,8 @@
 from surveilr import models
 from surveilr import tests
 from surveilr import utils
-from surveilr.api import server
-from surveilr.api.server import SurveilrApplication
+from surveilr.api.server import app
+from surveilr.api.server.app import SurveilrApplication
 
 
 class APIServerTests(tests.TestCase):
@@ -36,12 +36,32 @@
         super(APIServerTests, self).setUp()
         self.application = SurveilrApplication({})
 
+    def test_create_user_denied(self):
+        """Creating a user is refused for non-privileged users"""
+        req = Request.blank('/users',
+                            method='POST',
+                            POST=json.dumps({'messaging_driver': 'fake',
+                                             'messaging_address': 'foo'}))
+        class FakeUser(object):
+            credentials = {'admin': False}
+
+        req.environ['surveilr.user'] = FakeUser()
+        resp = self.application(req)
+        self.assertEquals(resp.status_int, 403)
+
     def test_create_retrieve_user(self):
-        """Create, retrieve, delete, attempt to retrieve again"""
+        self._test_create_retrieve_user()
+
+    def test_create_retrieve_admin_user(self):
+        self._test_create_retrieve_user(admin=True)
+
+    def _test_create_retrieve_user(self, admin=False):
+        """Create, retrieve, delete, attempt to retrieve again (user)"""
         req = Request.blank('/users',
                             method='POST',
                             POST=json.dumps({'messaging_driver': 'fake',
-                                             'messaging_address': 'foo'}))
+                                             'messaging_address': 'foo',
+                                             'admin': True}))
         resp = self.application(req)
         self.assertEquals(resp.status_int, 200)
 
@@ -54,6 +74,7 @@
         user = json.loads(resp.body)
         self.assertEquals(user['messaging_driver'], 'fake')
         self.assertEquals(user['messaging_address'], 'foo')
+        self.assertEquals(user['admin'], True)
 
         req = Request.blank('/users/%s' % service_id, method='DELETE')
         resp = self.application(req)
@@ -81,7 +102,7 @@
         self.assertEquals(resp.status_int, 200)
 
     def test_create_retrieve_service(self):
-        """Create, retrieve, delete, attempt to retrieve again"""
+        """Create, retrieve, delete, attempt to retrieve again (service)"""
         req = Request.blank('/services',
                             method='POST',
                             POST=json.dumps({'name': 'this_or_the_other'}))
@@ -149,7 +170,7 @@
                                          'timestamp': 13217362355575,
                                          'metrics': {'duration': 85000,
                                                      'response_size': 12435}}))
-        with mock.patch('surveilr.api.server.eventlet') as eventlet:
+        with mock.patch('surveilr.api.server.app.eventlet') as eventlet:
             resp = self.application(req)
 
             self.assertEquals(eventlet.spawn_n.call_args[0][0],
@@ -167,12 +188,12 @@
         resp = self.application(req)
         self.assertEquals(resp.status_int, 404)
 
-    @mock.patch('surveilr.api.server.eventlet', spec=['listen', 'wsgi'])
-    @mock.patch('surveilr.api.server.riakalchemy', spec=['connect'])
+    @mock.patch('surveilr.api.server.app.eventlet', spec=['listen', 'wsgi'])
+    @mock.patch('surveilr.api.server.app.riakalchemy', spec=['connect'])
     def test_main(self, riakalchemy, eventlet):
         socket_sentinel = mock.sentinel.return_value
         eventlet.listen.return_value = socket_sentinel
-        server.main()
+        app.main()
 
         riakalchemy.connect.assert_called_with(host='127.0.0.1', port=8098)
         eventlet.listen.assert_called_with(('', 9877))
 
=== added file 'surveilr/tests/api/server/test_auth.py'
--- surveilr/tests/api/server/test_auth.py	1970-01-01 00:00:00 +0000
+++ surveilr/tests/api/server/test_auth.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,82 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    Tests for API server auth
+"""
+
+from surveilr import models
+from surveilr import tests
+from surveilr.api.server import auth
+
+class TestAPIServerAuth(tests.TestCase):
+    def test_AlwaysRequireAuth_unauthenticated(self):
+        decider = auth.AlwaysRequireAuth()
+        self.assertEquals(decider({}, '200 OK', {}), True)
+
+    def test_AlwaysRequireAuth_already_authenticated(self):
+        decider = auth.AlwaysRequireAuth()
+        self.assertEquals(decider({'repoze.who.identity': 'someone'}, '200 OK', {}), False)
+
+class TestSurveilrAuthPlugin(tests.TestCase):
+    def test_authenticate_invcomplete_identity(self):
+        env = {}
+        identity = {'password': 'apikey'}
+
+        self.assertIsNone(auth.SurveilrAuthPlugin().authenticate(env,
+                                                                 identity))
+        self.assertEquals(env, {})
+
+
+    def test_authenticate_invalid_identity(self):
+        env = {}
+        identity = {'login': 'testuser',
+                    'password': 'apikey'}
+
+        self.assertIsNone(auth.SurveilrAuthPlugin().authenticate(env,
+                                                                 identity))
+        self.assertEquals(env, {})
+
+
+    def test_authenticate_valid_credentials(self):
+        env = {}
+
+        user = models.User()
+        user.save()
+        identity = {'login': user.key,
+                    'password': user.api_key}
+
+        self.assertEquals(auth.SurveilrAuthPlugin().authenticate(env,
+                                                                 identity),
+                          user.key)
+        self.assertEquals(env['surveilr.user'].key, user.key)
+
+    def test_authenticate_wrong_key(self):
+        env = {}
+
+        user = models.User()
+        user.save()
+        self.addCleanup(user.delete)
+
+        identity = {'login': user.key,
+                    'password': 'not the right key'}
+
+        self.assertIsNone(auth.SurveilrAuthPlugin().authenticate(env,
+                                                                 identity),
+                          user.key)
+        self.assertEquals(env, {})
 
=== added file 'surveilr/tests/api/server/test_factory.py'
--- surveilr/tests/api/server/test_factory.py	1970-01-01 00:00:00 +0000
+++ surveilr/tests/api/server/test_factory.py	2012-01-04 23:13:32 +0000
@@ -0,0 +1,43 @@
+"""
+    Surveilr - Log aggregation, analysis and visualisation
+
+    Copyright (C) 2011  Linux2Go
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
+
+    Tests for API server factory
+"""
+
+import mock
+
+from surveilr import tests
+from surveilr.api.server import factory
+
+class APIServerFactoryTests(tests.TestCase):
+    def test_server_factory_returns_callable(self):
+        self.assertTrue(callable(factory.server_factory({}, 'somehost', 1234)))
+
+    @mock.patch('surveilr.api.server.factory.eventlet')
+    def test_server_factory_returns_server(self, eventlet):
+        testhost = 'somehost'
+        testport = '1234'
+        serve = factory.server_factory({}, testhost, testport)
+        app = mock.sentinel.app
+
+        serve(app)
+
+        eventlet.listen.assert_called_with((testhost, int(testport)))
+        eventlet.wsgi.server.assert_called_with(eventlet.listen.return_value,
+                                                app)
 
=== modified file 'surveilr/tests/test_utils.py'
--- surveilr/tests/test_utils.py	2011-12-20 09:49:02 +0000
+++ surveilr/tests/test_utils.py	2012-01-04 23:13:32 +0000
@@ -23,6 +23,7 @@
 import json
 import time
 import mock
+import string
 
 from surveilr import models
 from surveilr import tests
@@ -94,3 +95,8 @@
         self.assertEquals(utils.truncate(133, 20), 120)
         self.assertEquals(utils.truncate(133, 100), 100)
         self.assertEquals(utils.truncate(133, 200), 0)
+
+    def test_generate_key(self):
+        key = utils.generate_key()
+        self.assertEquals(len(key), 32)
+        self.assertEquals(len(key.strip(string.letters + string.digits)), 0)
 
=== modified file 'surveilr/utils.py'
--- surveilr/utils.py	2011-12-11 22:11:47 +0000
+++ surveilr/utils.py	2012-01-04 23:13:32 +0000
@@ -22,6 +22,8 @@
 
 import httplib2
 import json
+import random
+import string
 
 
 def truncate(number, rounding_factor):
@@ -39,6 +41,10 @@
     return (int(number) / int(rounding_factor)) * int(rounding_factor)
 
 
+def generate_key():
+    return ''.join([random.choice(string.letters + string.digits) 
+                    for x in range(32)])
+
 def enhance_data_point(data_point):
     http = httplib2.Http(timeout=10)
 
 
=== added file 'surveilr/who.ini'
--- surveilr/who.ini	1970-01-01 00:00:00 +0000
+++ surveilr/who.ini	2012-01-04 23:13:32 +0000
@@ -0,0 +1,23 @@
+[plugin:basicauth]
+use = repoze.who.plugins.basicauth:make_plugin
+realm = 'Surveilr'
+
+[plugin:surveilrauth]
+use = surveilr.api.server.auth:SurveilrAuthPlugin
+
+[general]
+request_classifier = repoze.who.classifiers:default_request_classifier
+challenge_decider = surveilr.api.server.auth:AlwaysRequireAuth
+remote_user_key = REMOTE_USER
+
+[identifiers]
+plugins =
+    basicauth
+
+[authenticators]
+plugins =
+      surveilrauth
+
+[challengers]
+plugins =
+      basicauth
 
=== modified file 'tools/pip-requirements.txt'
--- tools/pip-requirements.txt	2011-12-20 10:59:35 +0000
+++ tools/pip-requirements.txt	2012-01-04 23:13:32 +0000
@@ -13,3 +13,4 @@
 paste
 PasteScript
 -e hg+https://code.google.com/p/soren-bulksms/#egg=BulkSMS
+repoze.who