如何在“ django-rest-framework-simplejwt”中使用“ email”而不是“ username”来生成令牌？

Question

在django-rest-framework-simplejwt插件中，默认使用username和password插件。但是我想使用email而不是username。所以，我确实喜欢以下内容：

在序列化器中：

class MyTokenObtainSerializer(Serializer):
    username_field = User.EMAIL_FIELD

    def __init__(self, *args, **kwargs):
        super(MyTokenObtainSerializer, self).__init__(*args, **kwargs)

        self.fields[self.username_field] = CharField()
        self.fields['password'] = PasswordField()

    def validate(self, attrs):
        # self.user = authenticate(**{
        #     self.username_field: attrs[self.username_field],
        #     'password': attrs['password'],
        # })
        self.user = User.objects.filter(email=attrs[self.username_field]).first()
        print(self.user)

        if not self.user:
            raise ValidationError('The user is not valid.')

        if self.user:
            if not self.user.check_password(attrs['password']):
                raise ValidationError('Incorrect credentials.')
        print(self.user)
        # Prior to Django 1.10, inactive users could be authenticated with the
        # default `ModelBackend`.  As of Django 1.10, the `ModelBackend`
        # prevents inactive users from authenticating.  App designers can still
        # allow inactive users to authenticate by opting for the new
        # `AllowAllUsersModelBackend`.  However, we explicitly prevent inactive
        # users from authenticating to enforce a reasonable policy and provide
        # sensible backwards compatibility with older Django versions.
        if self.user is None or not self.user.is_active:
            raise ValidationError('No active account found with the given credentials')

        return {}

    @classmethod
    def get_token(cls, user):
        raise NotImplemented(
            'Must implement `get_token` method for `MyTokenObtainSerializer` subclasses')


class MyTokenObtainPairSerializer(MyTokenObtainSerializer):
    @classmethod
    def get_token(cls, user):
        return RefreshToken.for_user(user)

    def validate(self, attrs):
        data = super(MyTokenObtainPairSerializer, self).validate(attrs)

        refresh = self.get_token(self.user)

        data['refresh'] = text_type(refresh)
        data['access'] = text_type(refresh.access_token)

        return data

视图中：

class MyTokenObtainPairView(TokenObtainPairView):
   """
    Takes a set of user credentials and returns an access and refresh JSON web
    token pair to prove the authentication of those credentials.
   """
    serializer_class = MyTokenObtainPairSerializer

它有效！！

现在我的问题是，我怎样才能更有效地做到这一点？谁能对此提出建议？预先感谢。

Answer 1

为什么要复制和粘贴那么多而不是子类化？我可以使用它：

# serializers.py 
from rest_framework_simplejwt.serializers import TokenObtainSerializer

class EmailTokenObtainSerializer(TokenObtainSerializer):
    username_field = User.EMAIL_FIELD


class CustomTokenObtainPairSerializer(EmailTokenObtainSerializer):
    @classmethod
    def get_token(cls, user):
        return RefreshToken.for_user(user)

    def validate(self, attrs):
        data = super().validate(attrs)

        refresh = self.get_token(self.user)

        data["refresh"] = str(refresh)
        data["access"] = str(refresh.access_token)

        return data

和

# views.py
from rest_framework_simplejwt.views import TokenObtainPairView

class EmailTokenObtainPairView(TokenObtainPairView):
    serializer_class = CustomTokenObtainPairSerializer

当然

#urls.py
from rest_framework_simplejwt.views import TokenRefreshView
from .views import EmailTokenObtainPairView

url("token/", EmailTokenObtainPairView.as_view(), name="token_obtain_pair"),
url("refresh/", TokenRefreshView.as_view(), name="token_refresh"),

Answer 2

总结一下上面的解决方案：

1- 通过 Django 命令创建两个应用程序。一个用于新令牌，另一个用于用户：

python manage.py startapp m_token  # modified token
python manage.py startapp m_user  # modified user

2- 在 m_token 中，创建 serializers.py 并覆盖序列化程序以将用户名替换为电子邮件字段：

# serializers.py
from rest_framework_simplejwt.serializers import TokenObtainPairSerializer, User


class CustomTokenObtainPairSerializer(TokenObtainPairSerializer):
        username_field = User.EMAIL_FIELD

3- 在 m_token 中，覆盖视图以用新的序列化器替换序列化器：

# views.py
from rest_framework_simplejwt.views import TokenObtainPairView
from .serializer import CustomTokenObtainPairSerializer


class EmailTokenObtainPairView(TokenObtainPairView):
    serializer_class = CustomTokenObtainPairSerializer

4- 在 m_token 中，创建 urls.py 并提供如下路径：

# urls.py
from django.urls import path
from .views import TokenObtainPairView
from rest_framework_simplejwt.views import TokenRefreshView, TokenVerifyView


urlpatterns = [
    path(r'token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
    path(r'token/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
    path(r'token/verify/', TokenVerifyView.as_view(), name='token_verify'),
]

5- 在 m_user 中，按如下方式覆盖用户模型：

# models.py
from django.contrib.auth.models import AbstractUser


class MUser(AbstractUser):
    USERNAME_FIELD = 'email'
    EMAIL_FIELD = 'email'
    REQUIRED_FIELDS = ['username']

6- 在 django 项目根目录中，将 AUTH_USER_MODEL = 'm_user.MUser' 添加到 setting.py。

我在我的项目中对其进行了测试，并且运行良好。我希望我没有错过任何东西。这样，swagger 还在令牌参数中显示“电子邮件”而不是“用户名”：

Answer 3

此答案适用于将来的读者，因此包含更多信息。

为了简化身份验证后端，您需要挂钩多个类。我建议您在下面执行选项1 （以及可选的选项3 ）。在继续阅读之前，请注意以下几点：

• 注释1： django不会按要求执行电子邮件，也不在创建用户时将其设置为唯一（您可以覆盖它，但这是不合主题的）！因此，选项3（您的实现）可能会给您带来重复电子邮件的问题。
• 注释1b：：使用User.objects.filter(email__iexact=...)以不区分大小写的方式匹配电子邮件。
• 注释1c：：如果以后要替换默认的用户模型，请使用get_user_model()，对于初学者来说，这确实是一个救命稻草！
• 注意2：避免将用户打印到控制台。您可能正在打印敏感数据。

关于3个选项：

1. 通过f.e.调整Django身份验证后端class EmailModelBackend(ModelBackend)并替换身份验证功能。
   • 不调整代币声明
   • 不依赖于JWT类/中间件（SimpleJWT，JWT或其他）
   • 还调整其他身份验证类型（会话/ Cookie /非API身份验证等）
   • 所需的输入参数仍然是用户名，如下所示。如果您不喜欢它，请进行调整，但要小心。 （可能会破坏您的导入/插件，这不是必需的！）
2. 从 django.contrib.auth 替换django authenticate(username=, password=, **kwarg)
   • 不调整代币声明
   • 您还需要替换令牌后端，因为它应该使用与上面相同的身份验证。
   • 不使用authenticate(...)调整其他应用，仅替换JWT身份验证（如果您以此方式进行设置） 参数不是必需的，因此建议不要使用此选项。）
3. 用电子邮件声明MyTokenObtainPairSerializer。
   • 现在，电子邮件已作为JWT数据发送回（而不是id）。
   • 连同选项1，您的应用程序身份验证已与用户名无关。

选项1 （请注意，这也允许用户名！）：

from django.contrib.auth import get_user_model
from django.contrib.auth.backends import ModelBackend
from django.db.models import Q

class EmailorUsernameModelBackend(ModelBackend):
    def authenticate(self, request, username=None, password=None, **kwargs):
        UserModel = get_user_model()
        try:
            user = UserModel.objects.get(Q(username__iexact=username) | Q(email__iexact=username))
        except UserModel.DoesNotExist:
            return None
        else:
            if user.check_password(password):
                return user
        return None

选项2： 跳过，留给读者，不建议。

选项3： 您似乎已经在上面提到了这一点。

注意：您不必定义MyTokenObtainPairView，可以在urls.py中使用TokenObtainPairView(serializer_class=MyTokenObtainPairSerializer).as_view()。较小的简化将覆盖已使用的令牌序列化器。

注意2：：您可以在settings.py（或设置文件）中指定识别性声明和添加的数据，以便也使用电子邮件。这也将使您的前端应用程序也将电子邮件用于声明（而不是默认的 user .id）

SIMPLE_JWT = {
    'USER_ID_FIELD': 'id', # model property to attempt claims for
    'USER_ID_CLAIM': 'user_id', # actual keyword in token data
}

但是，请注意创作者给出的独特性警告：

  

例如，指定“用户名”或“电子邮件”字段将是一个糟糕的选择，因为帐户的用户名或电子邮件可能会根据给定服务中帐户管理的设计方式而改变。

如果您可以保证唯一性，那么您已经准备就绪。

Answer 4

除了@Mic的答案外，请记住设置USERNAME_FIELD = 'email'，并且在用户模型中可以设为REQUIRED_FIELDS = ['username']。

Answer 5

问题已经有一段时间了，但是，我为@Mic的答案添加了+1。顺便说一句，仅按以下方式更新到TokenObtainPairSerializer还不够吗？：

from rest_framework_simplejwt.views import TokenObtainPairView
from rest_framework_simplejwt.serializers import (
    TokenObtainPairSerializer, User
)

class CustomTokenObtainPairSerializer(TokenObtainPairSerializer):
    username_field = User.EMAIL_FIELD


class EmailTokenObtainPairView(TokenObtainPairView):
    serializer_class = CustomTokenObtainPairSerializer