Django Rest Framework 自定义 JWT 身份验证
Django Rest Framework Custom JWT authentication
我创建了一个 Django 应用程序,我希望能够在其中通过不仅检查用户名和密码而且检查相关模型中的特定字段来对用户进行身份验证。我要 POST
到端点的自定义请求正文是:
payload = { 'username': user, 'password': password, 'app_id': uuid4}
我正在使用 djangorestframework-simplejwt
模块来获取访问令牌。
models.py
class Application(models.Model):
app_name = models.CharField(max_length=300)
app_id = models.UUIDField(default=uuid.uuid4, editable=False)
def __str__(self):
return self.app_name
class ProfileApp(models.Model):
user = models.OneToOneField(User, on_delete=models.CASCADE)
app = models.ForeignKey(Application, on_delete=models.CASCADE)
expires_on = models.DateTimeField(default=datetime.now() + timedelta(days=15))
def __str__(self):
return self.app.app_name + " | " + self.user.username
是否可以覆盖 rest_framework_simplejwt
中的 TokenObtainPairView
以仅在 expires_on
日期尚未过期的情况下对用户进行身份验证?还是这样做有架构问题?
您可以通过创建一个继承自 TokenObtainPairSerializer
的自定义序列化程序并扩展 validate
方法来检查自定义字段值来实现这一点。如果您注意不要覆盖父 class.
的必要功能,则没有体系结构问题
这是一个例子:
import datetime as dt
import json
from rest_framework import exceptions
from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
from rest_framework_simplejwt.views import TokenObtainPairView
class MyTokenObtainPairSerializer(TokenObtainPairSerializer):
def validate(self, attrs):
try:
request = self.context["request"]
except KeyError:
pass
else:
request_data = json.loads(request.body)
username = request_data.get("username")
app_id = request_data.get("app_id")
profile_has_expired = False
try:
profile = ProfileApp.objects.get(user__username=username, app__app_id=app_id)
except ProfileApp.DoesNotExist:
profile_has_expired = True
else:
profile_has_expired = dt.date.today() > profile.expires_on
finally:
if profile_has_expired:
error_message = "This profile has expired"
error_name = "expired_profile"
raise exceptions.AuthenticationFailed(error_message, error_name)
finally:
return super().validate(attrs)
class MyTokenObtainPairView(TokenObtainPairView):
serializer_class = MyTokenObtainPairSerializer
然后在您的网址文件中使用 MyTokenObtainPairView
代替 TokenObtainPairView
。
此外,由于 User
和 ProfileApp
共享一个 one-to-one 字段,看来您可以不使用 "app_id
" key/field全部.
我创建了一个 Django 应用程序,我希望能够在其中通过不仅检查用户名和密码而且检查相关模型中的特定字段来对用户进行身份验证。我要 POST
到端点的自定义请求正文是:
payload = { 'username': user, 'password': password, 'app_id': uuid4}
我正在使用 djangorestframework-simplejwt
模块来获取访问令牌。
models.py
class Application(models.Model):
app_name = models.CharField(max_length=300)
app_id = models.UUIDField(default=uuid.uuid4, editable=False)
def __str__(self):
return self.app_name
class ProfileApp(models.Model):
user = models.OneToOneField(User, on_delete=models.CASCADE)
app = models.ForeignKey(Application, on_delete=models.CASCADE)
expires_on = models.DateTimeField(default=datetime.now() + timedelta(days=15))
def __str__(self):
return self.app.app_name + " | " + self.user.username
是否可以覆盖 rest_framework_simplejwt
中的 TokenObtainPairView
以仅在 expires_on
日期尚未过期的情况下对用户进行身份验证?还是这样做有架构问题?
您可以通过创建一个继承自 TokenObtainPairSerializer
的自定义序列化程序并扩展 validate
方法来检查自定义字段值来实现这一点。如果您注意不要覆盖父 class.
这是一个例子:
import datetime as dt
import json
from rest_framework import exceptions
from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
from rest_framework_simplejwt.views import TokenObtainPairView
class MyTokenObtainPairSerializer(TokenObtainPairSerializer):
def validate(self, attrs):
try:
request = self.context["request"]
except KeyError:
pass
else:
request_data = json.loads(request.body)
username = request_data.get("username")
app_id = request_data.get("app_id")
profile_has_expired = False
try:
profile = ProfileApp.objects.get(user__username=username, app__app_id=app_id)
except ProfileApp.DoesNotExist:
profile_has_expired = True
else:
profile_has_expired = dt.date.today() > profile.expires_on
finally:
if profile_has_expired:
error_message = "This profile has expired"
error_name = "expired_profile"
raise exceptions.AuthenticationFailed(error_message, error_name)
finally:
return super().validate(attrs)
class MyTokenObtainPairView(TokenObtainPairView):
serializer_class = MyTokenObtainPairSerializer
然后在您的网址文件中使用 MyTokenObtainPairView
代替 TokenObtainPairView
。
此外,由于 User
和 ProfileApp
共享一个 one-to-one 字段,看来您可以不使用 "app_id
" key/field全部.