How do you authenticate a websocket with token authentication on django channels?

by

For Django-Channels 2 you can write custom authentication middleware
https://gist.github.com/rluts/22e05ed8f53f97bdd02eafdf38f3d60a

token_auth.py:

from channels.auth import AuthMiddlewareStack
from rest_framework.authtoken.models import Token
from django.contrib.auth.models import AnonymousUser


class TokenAuthMiddleware:
    """
    Token authorization middleware for Django Channels 2
    """

    def __init__(self, inner):
        self.inner = inner

    def __call__(self, scope):
        headers = dict(scope['headers'])
        if b'authorization' in headers:
            try:
                token_name, token_key = headers[b'authorization'].decode().split()
                if token_name == 'Token':
                    token = Token.objects.get(key=token_key)
                    scope['user'] = token.user
            except Token.DoesNotExist:
                scope['user'] = AnonymousUser()
        return self.inner(scope)

TokenAuthMiddlewareStack = lambda inner: TokenAuthMiddleware(AuthMiddlewareStack(inner))

routing.py:

from django.urls import path

from channels.http import AsgiHandler
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack

from yourapp.consumers import SocketCostumer
from yourapp.token_auth import TokenAuthMiddlewareStack

application = ProtocolTypeRouter({
    "websocket": TokenAuthMiddlewareStack(
        URLRouter([
            path("socket/", SocketCostumer),
        ]),
    ),

})

More Related Contents:

  1. Does the django-rest-framework provide an admin site to manage models?
  2. Django rest framework, use different serializers in the same ModelViewSet
  3. Retrieving a Foreign Key value with django-rest-framework serializers
  4. Django REST Framework upload image: “The submitted data was not a file”
  5. Django rest framework serializing many to many field
  6. Django serializer Imagefield to get full URL
  7. How do you use the django-filter package with a list of parameters?
  8. django-rest-framework 3.0 create or update in nested serializer
  9. Django Rest Framework with ChoiceField
  10. Django Rest Framework and JSONField
  11. django.db.migrations.exceptions.InconsistentMigrationHistory
  12. Django Rest Framework writable nested serializers
  13. Pass extra arguments to Serializer Class in Django Rest Framework
  14. “Post Image data using POSTMAN”
  15. CSRF Failed: CSRF token missing or incorrect
  16. Django Rest Framework – How to add custom field in ModelSerializer
  17. Order of Serializer Validation in Django REST Framework
  18. How do you filter a nested serializer in Django Rest Framework?
  19. OperationalError, no such column. Django
  20. Django Python rest framework, No ‘Access-Control-Allow-Origin’ header is present on the requested resource in chrome, works in firefox
  21. Send message using Django Channels from outside Consumer class
  22. Token Authentication for RESTful API: should the token be periodically changed?
  23. Authorization Credentials Stripped — django, elastic beanstalk, oauth
  24. How to use csrf_token in Django RESTful API and React?
  25. How to upload multiple files in django rest framework
  26. Django/DRF – 405 Method not allowed on DELETE operation
  27. Override JSONSerializer on django rest framework
  28. How to add custom field in ModelSerializer?
  29. Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?
  30. Multiple lookup_fields for django rest framework

Leave a Comment