19

尝试使用非常简单的 websockets 应用程序使用 Django 通道进行身份验证，该应用程序会回显用户使用前缀发送的任何内容"You said: "。

我的流程：

web: gunicorn myproject.wsgi --log-file=- --pythonpath ./myproject
realtime: daphne myproject.asgi:channel_layer --port 9090 --bind 0.0.0.0 -v 2
reatime_worker: python manage.py runworker -v 2

我在本地测试时运行所有进程heroku local -e .env -p 8080，但您也可以单独运行它们。

注意我有 WSGIlocalhost:8080和 ASGI localhost:9090。

路由和消费者：

### routing.py ###

from . import consumers

channel_routing = {
    'websocket.connect': consumers.ws_connect,
    'websocket.receive': consumers.ws_receive,
    'websocket.disconnect': consumers.ws_disconnect,
}

和

### consumers.py ###

import traceback 

from django.http import HttpResponse
from channels.handler import AsgiHandler

from channels import Group
from channels.sessions import channel_session
from channels.auth import channel_session_user, channel_session_user_from_http

from myproject import CustomLogger
logger = CustomLogger(__name__)

@channel_session_user_from_http
def ws_connect(message):
    logger.info("ws_connect: %s" % message.user.email)
    message.reply_channel.send({"accept": True})
    message.channel_session['prefix'] = "You said"
    # message.channel_session['django_user'] = message.user  # tried doing this but it doesn't work...

@channel_session_user_from_http
def ws_receive(message, http_user=True):
    try:
        logger.info("1) User: %s" % message.user)
        logger.info("2) Channel session fields: %s" % message.channel_session.__dict__)
        logger.info("3) Anything at 'django_user' key? => %s" % (
            'django_user' in message.channel_session,))

        user = User.objects.get(pk=message.channel_session['_auth_user_id'])
        logger.info(None, "4) ws_receive: %s" % user.email)

        prefix = message.channel_session['prefix']

        message.reply_channel.send({
            'text' : "%s: %s" % (prefix, message['text']),
        })
    except Exception:
        logger.info("ERROR: %s" % traceback.format_exc())

@channel_session_user_from_http
def ws_disconnect(message):
    logger.info("ws_disconnect: %s" % message.__dict__)
    message.reply_channel.send({
        'text' : "%s" % "Sad to see you go :(",
    })

然后进行测试，我进入与我的 HTTP 站点相同域的 Javascript 控制台，然后输入：

> var socket = new WebSocket('ws://localhost:9090/')
> socket.onmessage = function(e) {console.log(e.data);}
> socket.send("Testing testing 123")
VM481:2 You said: Testing testing 123

我的本地服务器日志显示：

ws_connect: test@test.com

1) User: AnonymousUser
2) Channel session fields: {'_SessionBase__session_key': 'chnb79d91b43c6c9e1ca9a29856e00ab', 'modified': False, '_session_cache': {u'prefix': u'You said', u'_auth_user_hash': u'ca4cf77d8158689b2b6febf569244198b70d5531', u'_auth_user_backend': u'django.contrib.auth.backends.ModelBackend', u'_auth_user_id': u'1'}, 'accessed': True, 'model': <class 'django.contrib.sessions.models.Session'>, 'serializer': <class 'django.core.signing.JSONSerializer'>}
3) Anything at 'django_user' key? => False
4) ws_receive: test@test.com

当然，这没有任何意义。几个问题：

  1. 为什么 Django 会在会话中看到message.user一个AnonymousUser但有实际用户 ID _auth_user_id=1（这是我正确的用户 ID）？
  2. 我在 8080 上运行本地服务器（WSGI），在 9090（不同端口）上运行 daphne（ASGI）。而且我没有包含session_key=xxxx在我的 WebSocket 连接中 - 但是 Django 能够为正确的用户读取我的浏览器的 cookie test@test.com，？根据 Channels 文档，这应该是不可能的。
  3. 在我的设置下，使用 Django 通道进行身份验证的最佳/最简单方法是什么？
4

3 回答 3

20

注意：这个答案是明确的channels 1.x，channels 2.x使用不同的身份验证机制。

我也很难使用 django 频道，我不得不深入研究源代码以更好地理解文档......

问题一：

文档提到了这种相互依赖的装饰器的长路径（http_session，http_session_user...），您可以使用它们来包装您的消息消费者，在该路径的中间它说明了这一点：

现在，需要注意的一点是，您只能在 WebSocket 连接的连接消息期间获得详细的 HTTP 信息（您可以在 ASGI 规范中阅读更多相关信息）——这意味着我们不会浪费带宽通过网络发送相同的信息不必要的电线。这也意味着我们必须在连接处理程序中获取用户，然后将其存储在会话中；....

很容易迷失在这一切中，至少我们都这样做了......

您只需要记住，当您使用时会发生这种情况channel_session_user_from_http：

  1. 它调用http_session_user
    了一个。调用http_session将解析消息并给我们一个message.http_session属性。
    湾。从通话中返回后，它会message.user根据收到的信息启动一个message.http_session（稍后会咬你）
  2. 它调用channel_sessionwhich 将启动一个虚拟会话message.channel_session并将其绑定到消息回复通道。
  3. 现在它调用transfer_userwhich 将移动http_session到channel_session

这发生在 websocket 的连接处理期间，因此在后续消息中您将无法访问详细的 HTTP 信息，因此连接后发生的事情是您channel_session_user_from_http再次调用，在这种情况下（连接后消息）调用http_session_user这将尝试读取 Http 信息但失败导致设置message.http_session为None并覆盖message.user为AnonymousUser.
这就是为什么你需要channel_session_user在这种情况下使用。

问题2：

通道可以使用来自 cookie 的 Django 会话（如果你在与主站点相同的端口上运行 websocket 服务器，使用像 Daphne 之类的东西），或者来自 session_key GET 参数，如果你想继续运行你的 HTTP 请求，它可以工作通过 WSGI 服务器并将 WebSockets 卸载到另一个端口上的第二个服务器进程。

还记得http_session，那个为我们获取message.http_session数据的装饰器吗？看来，如果它没有找到session_keyGET 参数，它会失败settings.SESSION_COOKIE_NAME，这是常规sessionidcookie，所以无论您是否提供session_key，如果您登录，您仍然会连接，当然只有当您的 ASGI 时才会发生这种情况和 WSGI 服务器在同一个域（本例中为 127.0.0.1），端口差异无关紧要。

我认为文档尝试进行通信但未扩展的区别在于，当您的服务器和服务器位于不同的域session_key时，您需要设置 GET 参数，因为 cookie 受域而不是端口的限制。ASGIWSGI

由于缺乏解释，我不得不测试在相同端口和不同端口上运行 ASGI 和 WSGI，结果是相同的，我仍然获得身份验证，将一个服务器域更改为，127.0.0.2而不是127.0.0.1身份验证消失，设置session_keyget 参数身份验证又回来了。

更新：文档段落的更正刚刚被推送到频道回购，它的意思是提到域而不是我提到的端口。

问题 3：

我的答案与 turbotux 相同，但更长，您应该@channel_session_user_from_http在 ws_connect 以及@channel_session_userws_receive 和 ws_disconnect 上使用，您所展示的任何内容都没有表明如果您进行更改将不起作用，也许尝试http_user=True从您的接收消费者中删除？即使你怀疑它没有任何效果，因为它没有记录并且仅供一般消费者使用......

希望这可以帮助！

于 2017-02-19T23:54:15.407 回答
1

要回答您的第一个问题，您需要使用：

channel_session_user

接收和断开呼叫中的装饰器。

channel_session_user_from_http

在 connect 方法期间调用 transfer_user 会话将 http 会话传输到通道会话。这样，所有未来的调用都可以访问通道会话以检索用户信息。

对于您的第二个问题，我相信您所看到的是默认 Web 套接字库通过连接传递浏览器 cookie。

第三，我认为一旦更改了装饰器，您的设置就会运行良好。

于 2017-02-06T20:08:04.107 回答
1

我遇到了这个问题，我发现这可能是由于几个问题造成的。我并不是说这会解决您的问题，但可能会给您一些见解。请记住，我正在使用休息框架。首先，我覆盖了 User 模型。其次，当我application在根目录中定义变量时，我routing.py没有使用自己的 AuthMiddleware。我正在使用建议的 AuthMiddlewareStack 文档。因此，根据Channels文档，我定义了自己的自定义身份验证中间件，它从 cookie 中获取我的 JWT 值，对其进行身份验证并将其分配给类似的scope["user"]东西：

路由.py

from channels.routing import ProtocolTypeRouter, URLRouter

import app.routing
from .middleware import JsonTokenAuthMiddleware

application = ProtocolTypeRouter(
    {
        "websocket": JsonTokenAuthMiddleware(
            (URLRouter(app.routing.websocket_urlpatterns))
        )
    }

中间件.py

from http import cookies
from django.contrib.auth.models import AnonymousUser
from django.db import close_old_connections
from rest_framework.authtoken.models import Token
from rest_framework_jwt.authentication import BaseJSONWebTokenAuthentication

class JsonWebTokenAuthenticationFromScope(BaseJSONWebTokenAuthentication):

    def get_jwt_value(self, scope):
        try:
            cookie = next(x for x in scope["headers"] if x[0].decode("utf-8") 
                == "cookie")[1].decode("utf-8")
            return cookies.SimpleCookie(cookie)["JWT"].value
        except:
            return None


class JsonTokenAuthMiddleware(BaseJSONWebTokenAuthentication):
    def __init__(self, inner):
        self.inner = inner

    def __call__(self, scope):

        try:
            close_old_connections()
            user, jwt_value = 
                JsonWebTokenAuthenticationFromScope().authenticate(scope)
            scope["user"] = user
        except:
            scope["user"] = AnonymousUser()
        return self.inner(scope)

希望这会有所帮助！

于 2019-09-17T17:54:04.197 回答