django-pfx 1.7.3.dev12__tar.gz → 1.7.3.dev14__tar.gz

{django_pfx-1.7.3.dev12 → django_pfx-1.7.3.dev14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.3.dev12
+Version: 1.7.3.dev14
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.3.dev12 → django_pfx-1.7.3.dev14}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.3.dev12
+Version: 1.7.3.dev14
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.3.dev12 → django_pfx-1.7.3.dev14}/django_pfx.egg-info/SOURCES.txt

@@ -89,6 +89,7 @@ pfx/pfxcore/middleware/authentication.py
 pfx/pfxcore/middleware/locale.py
 pfx/pfxcore/middleware/profiling.py
 pfx/pfxcore/middleware/request_too_big_middleware.py
+pfx/pfxcore/middleware/ws_cookie_authentication_middleware.py
 pfx/pfxcore/migrations/0001_initial.py
 pfx/pfxcore/migrations/0002_pfxpermissionsuser.py
 pfx/pfxcore/migrations/0003_delete_pfxpermissionsuser.py
@@ -227,6 +228,7 @@ tests/tests/test_user_job_api.py
 tests/tests/test_user_job_messages.py
 tests/tests/test_user_job_model.py
 tests/tests/test_user_queryset.py
+tests/tests/test_user_websocket.py
 tests/tests/test_view_decorators.py
 tests/tests/test_view_fields.py
 tests_base_user/__init__.py

{django_pfx-1.7.3.dev12 → django_pfx-1.7.3.dev14}/pfx/pfxcore/middleware/__init__.py

@@ -5,3 +5,6 @@ from .authentication import (
 from .locale import LocaleMiddleware
 from .profiling import ProfilingDatabaseRouter, ProfilingMiddleware
 from .request_too_big_middleware import RequestTooBigMiddleware
+from .ws_cookie_authentication_middleware import (
+    WSCookieAuthenticationMiddleware,
+)

django_pfx-1.7.3.dev14/pfx/pfxcore/middleware/ws_cookie_authentication_middleware.py

@@ -0,0 +1,45 @@
+import logging
+
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import AnonymousUser
+from django.http import parse_cookie
+
+from channels.db import database_sync_to_async
+from channels.middleware import BaseMiddleware
+
+from pfx.pfxcore.exceptions import APIError
+from pfx.pfxcore.http import JsonResponse
+from pfx.pfxcore.middleware.authentication import JWTTokenDecodeMixin
+
+logger = logging.getLogger(__name__)
+
+
+class WSCookieAuthenticationMiddleware(JWTTokenDecodeMixin, BaseMiddleware):
+    async def __call__(self, scope, receive, send):
+        scope = dict(scope)
+        if "headers" not in scope:
+            raise ValueError("No headers")
+        # Go through headers to find the cookie one
+        for name, value in scope.get("headers", []):
+            if name == b"cookie":
+                cookies = parse_cookie(value.decode("utf-8"))
+                break
+        else:
+            # No cookie header found - add an empty default.
+            cookies = {}
+        # Return inner application
+        key = cookies.get('token')
+        if key:
+            try:
+                user, __, __ = await database_sync_to_async(
+                    self.decode_jwt)(key)
+            except get_user_model().DoesNotExist:
+                return JsonResponse(
+                    {'message': 'Authentication error'}, status=401)
+            except APIError as e:
+                return e.response
+        elif not scope.get('user'):
+            user = AnonymousUser()
+
+        scope['user'] = user
+        return await super().__call__(scope, receive, send)

{django_pfx-1.7.3.dev12 → django_pfx-1.7.3.dev14}/tests/tests/__init__.py

@@ -33,5 +33,6 @@ from .test_user_job_api import TestUserJobApi
 from .test_user_job_messages import TestUserJobMessages
 from .test_user_job_model import TestUserJobModel
 from .test_user_queryset import TestUserQuerySet
+from .test_user_websocket import TestUserWebsocket
 from .test_view_decorators import ViewDecoratorTest
 from .test_view_fields import ViewFieldTest

django_pfx-1.7.3.dev14/tests/tests/test_user_websocket.py

@@ -0,0 +1,79 @@
+import json
+import logging
+
+from django.test import TransactionTestCase
+
+from asgiref.sync import sync_to_async
+from channels.routing import URLRouter
+from channels.testing import WebsocketCommunicator
+
+from pfx.pfxcore.middleware import WSCookieAuthenticationMiddleware
+from pfx.pfxcore.test import APIClient, TestAssertMixin
+from pfx.userjobs.urls import websocket_urlpatterns
+from tests.models import User
+
+logger = logging.getLogger(__name__)
+
+
+def WebsocketMiddlewareStack(inner):
+    return WSCookieAuthenticationMiddleware(inner)
+
+
+class TestUserWebsocket(TestAssertMixin, TransactionTestCase):
+    async def asyncSetUp(self):
+        """Ensure parent setUp is called for async tests"""
+        await sync_to_async(super().setUp)()
+
+    async def async_setup(self):
+        @sync_to_async
+        def setup_all():
+            User.objects.create_user(
+                username='user',
+                email="user@example.com",
+                password='test',
+                first_name="Test",
+                last_name="User",
+                is_superuser=False)
+            client = APIClient(with_cookie=True, default_locale='en')
+            client.login(username='user')
+            return client
+        return await setup_all()
+
+    @staticmethod
+    def get_websocket_communicator(headers=[]):
+        headers.append((b"host", b"localhost:8000"))
+        return WebsocketCommunicator(
+            WebsocketMiddlewareStack(URLRouter(websocket_urlpatterns)),
+            'ws/user', headers)
+
+    async def test_websocket(self):
+        client = await self.async_setup()
+        headers = [(
+            b'cookie',
+            client.cookies.output(header='', sep='; ').encode())]
+
+        communicator = self.get_websocket_communicator(headers)
+        connected, sub_protocol = await communicator.connect()
+        self.assertTrue(connected)
+        # Test sending message
+        await communicator.send_json_to(
+            dict(type='send_event',
+                 message='123 updated')
+        )
+        response = await communicator.receive_from()
+        res = json.loads(response)
+        self.assertEqual(
+            res['message'], '123 updated')
+
+        # Close
+        await communicator.disconnect()
+
+    async def test_anonymous(self):
+        await self.async_setup()
+        headers = []
+
+        communicator = self.get_websocket_communicator(headers)
+        connected, sub_protocol = await communicator.connect()
+
+        self.assertFalse(connected)
+        self.assertEqual(sub_protocol, 4001)