Django Rest Framework学习(七)

JWT认证

  • 优点
1) 服务器不要存储token,token交给每一个客户端自己存储,服务器压力小
2)服务器存储的是 签发和校验token 两段算法,签发认证的效率高
3)算法完成各集群服务器同步成本低,路由项目完成集群部署(适应高并发)
  • 格式
1) jwt token采用三段式:头部.载荷.签名
2)每一部分都是一个json字典加密形参的字符串
3)头部和载荷采用的是base64可逆加密(前台后台都可以解密)
4)签名采用hash256不可逆加密(后台校验采用碰撞校验)
5)各部分字典的内容:
    头部:基础信息 - 公司信息、项目组信息、可逆加密采用的算法
    载荷:有用但非私密的信息 - 用户可公开信息、过期时间
    签名:头部+载荷+秘钥 不可逆加密后的结果
    注:服务器jwt签名加密秘钥一定不能泄露

签发token:固定的头部信息加密.当前的登陆用户与过期时间加密.头部+载荷+秘钥生成不可逆加密
校验token:头部可校验也可以不校验,载荷校验出用户与过期时间,头部+载荷+秘钥完成碰撞检测校验token是否被篡改
  • 安装
pip install djangorestframework-jwt
  • 签发token
# ObtainJSONWebToken视图类就是通过username和password得到user对象然后签发token(生成token)
from rest_framework_jwt.views import ObtainJSONWebToken, obtain_jwt_token
urlpatterns = [
    # url(r'^obtain/$', ObtainJSONWebToken.as_view()),
    url(r'^obtain/$', obtain_jwt_token),
]

  • 认证-校验token
from rest_framework.views import APIView
from utils.response import APIResponse
# 必须登录后才能访问 - 通过了认证权限组件
from rest_framework.permissions import IsAuthenticated
from rest_framework_jwt.authentication import JSONWebTokenAuthentication
class UserDetail(APIView):
    authentication_classes = [JSONWebTokenAuthentication]  # jwt-token校验request.user
    permission_classes = [IsAuthenticated]  # 结合权限组件筛选掉游客
    def get(self, request, *args, **kwargs):
        return APIResponse(results={'username': request.user.username})


手动签发

源码入口

获取提交的username和password
1)rest_framework_jwt.views.ObtainJSONWebToken的父类JSONWebTokenAPIView的post方法接受有username、password的post请求校验数据,并且签发token

2)post方法将请求数据交给 rest_framework_jwt.serializer.JSONWebTokenSerializer处理完成数据的校验,会走序列化类的全局钩子校验规则,校验得到登录用户并签发token存储在序列化对象中

核心源码: rest_framework_jwt.serializer.JSONWebTokenSerializer的validate(self,attrs)方法

def validate(self, attrs):
    # 账号密码字典
    credentials = {
        self.username_field: attrs.get(self.username_field),
        'password': attrs.get('password')
    }
    if all(credentials.values()):
        # 签发token第1步:用账号密码得到user对象
        user = authenticate(**credentials)
        if user:
            if not user.is_active:
                msg = _('User account is disabled.')
                raise serializers.ValidationError(msg)
            # 签发token第2步:通过user得到payload,payload包含着用户信息与过期时间
            payload = jwt_payload_handler(user)
            # 在视图类中,可以通过 序列化对象.object.get('user'或者'token') 拿到user和token 
            return {
                # 签发token第3步:通过payload签发出token
                'token': jwt_encode_handler(payload),
                'user': user
            }
        else:
            msg = _('Unable to log in with provided credentials.')
            raise serializers.ValidationError(msg)
    else:
        msg = _('Must include "{username_field}" and "password".')
        msg = msg.format(username_field=self.username_field)
        raise serializers.ValidationError(msg)

手动签发token逻辑

1)通过username、password得到user对象
2)通过user对象生成payload:jwt_payload_handler(user) => payload
        from rest_framework_jwt.serializers import jwt_payload_handler
3)通过payload签发token:jwt_encode_handler(payload) => token
        from rest_framework_jwt.serializers import jwt_encode_handler

总结

jwt_payload_handler方法传入登录对象,返回payload(包含用户信息,过期时间)
jwt_encode_handler方法传入payload,返回一个加密的token

流程:
1. 获取登录用户对象user
2. jwt_payload_handler(user)生成payload(包含用户信息和过期时间)
3. jwt_encode_handler(payload)生成一个加密的token

手动校验

前提:访问一个配置了jwt认证规则的视图类,就需要提交认证字符串token,在认证类中完成token的校验
rest_framework_jwt.authentication.JSONWebTokenAuthentication的父类BaseJSONWebTokenAuthentication的authenticate方法请求头拿认证信息authenticate => 通过反爬小规则确定有用的token => payload => user

BaseJSONWebTokenAuthentication的authenticate(self,request)方法源码:

def authenticate(self, request):
    """
    Returns a two-tuple of `User` and token if a valid signature has been
    supplied using JWT-based authentication.  Otherwise returns `None`.
    """
    # 带有反爬小规则的获取token:前台必须按 "jwt token字符串" 方式提交
    # 校验user第1步:从请求头 HTTP_AUTHORIZATION 中拿token,并提取
    jwt_value = self.get_jwt_value(request)
    # 游客
    if jwt_value is None:
        return None
    # 校验
    try:
        # 校验user第2步:token => payload
        payload = jwt_decode_handler(jwt_value)
    except jwt.ExpiredSignature:
        msg = _('Signature has expired.')
        raise exceptions.AuthenticationFailed(msg)
    except jwt.DecodeError:
        msg = _('Error decoding signature.')
        raise exceptions.AuthenticationFailed(msg)
    except jwt.InvalidTokenError:
        raise exceptions.AuthenticationFailed()
    # 校验user第3步:payload => user
    user = self.authenticate_credentials(payload)

    return (user, jwt_value)

校验token逻辑

1)从请求头中获取token
2)根据token解析出payload, jwt_decode_handler(token) => payloay
3)根据payload解析出user, self.authenticate_credentials(payload) => user

案例

  • 序列号器:
from rest_framework import serializers
from django.contrib.auth import get_user_model
from rest_framework_jwt.settings import api_settings
from rest_framework.exceptions import ValidationError
from django.db.models import Q

# 1) 前台提交多种登录信息都采用一个key,所以后台可以自定义反序列化字段进行对应
# 2) 序列化类要处理序列化与反序列化,要在fields中设置model绑定的Model类所有使用到的字段
# 3) 区分序列化字段与反序列化字段 read_only | write_only
# 4) 在自定义校验规则中(局部钩子、全局钩子)校验数据是否合法、确定登录的用户、根据用户签发token
# 5) 将登录的用户与签发的token保存在序列化类对象中

class UserModelSerializer(serializers.ModelSerializer):
    # 自定义反序列字段:一定要设置write_only,只参与反序列化,不会与model类字段映射
    un = serializers.CharField(write_only=True)
    pwd = serializers.CharField(write_only=True)

    class Meta:
        model = get_user_model()
        fields = ['un', 'pwd', 'username', 'email']
        extra_kwargs = {
            'username': {
                'read_only': True
            },
            'email': {
                'read_only': True
            }
        }

    #全局钩子,校验数据
    def validate(self, attrs):
        jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
        jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
        un = attrs.get('un')
        pwd = attrs.get('pwd')
        User = get_user_model()
        # 多方式登录:各分支处理得到该方式下对应的用户
        user = User.objects.filter(Q(username=un) | Q(email=un)).first()
        # 签发token:得到登录用户,签发token并存储在实例化对象中
        if user and user.check_password(pwd):
            # 签发token, 将token存放到 实例化类对象的token 名字中
            payload = jwt_payload_handler(user)
            self.token = jwt_encode_handler(payload)
            # 将当前用户与签发的token都保存在序列化对象中
            self.user = user
            return attrs

        raise serializers.ValidationError({'data': '数据有误'})
  • 视图
from rest_framework.views import APIView
from utils.response import APIResponse
from .serializers import UserModelSerializer

class LoginAPIView(APIView):
    # 禁用认证权限组件
    permission_classes = []
    authentication_classes = []

    def post(self, request, *args, **kwargs):
        # 拿到前台登录信息, 交给序列化类
        users = UserModelSerializer(data=request.data)
        # 序列化类校验得到用户与token放在序列化对象中
        users.is_valid(raise_exception=True)
        # 取出登录用户与token返回给前台
        return APIResponse(token=users.token, results=UserModelSerializer(users.user).data)

实际上post也可以用最简单的办法解决, 也就是把所有逻辑都在视图类中解决:

def post(self, request, *args, **kwargs):
        un = request.data.get('un')
        pwd = request.data.get('pwd')
        user = User.objects.filter(Q(username=un) | Q(email=un)).first()
        if user and user.check_password(pwd):
            payload = jwt_payload_handler(user_obj)
            token = jwt_encode_handler(payload)
            return APIResponse(results={'username': user_obj.username}, token=token)
        return APIResponse(data_msg='不可控错误')

如果本文对你有启发,或者对本文有疑问或者功能/方法建议,可以在下方做出评论,或者直接联系我,谢谢您的观看和支持!

添加新评论

本站现已启用评论投票,被点踩过多的评论将自动折叠。与本文无关评论请发留言板。请不要水评论,谢谢。

已有 0条评论