python/Django-rest-framework框架/高级8-drf-JWT认证

一 JWT认证

在用户注册或登录后,我们想记录用户的登录状态,或者为用户创建身份认证的凭证。我们不再使用Session认证机制,而使用Json Web Token(本质就是token)认证机制。

Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准((RFC 7519).该token被设计为紧凑且安全的,特别适用于分布式站点的单点登录(SSO)场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息,以便于从资源服务器获取资源,也可以增加一些额外的其它业务逻辑所必须的声明信息,该token也可直接被用于认证,也可被加密
image
image
image
image

Json web token (JWT), token的应用于web方向的称之为jwt

构成和工作原理

JWT就是一段字符串,由三段信息构成的,将这三段信息文本用.链接一起就构成了Jwt字符串。就像这样:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

1.1 header:头

	-jwt的头部承载两部分信息:
  • 声明类型,这里是jwt
  • 声明加密的算法 通常直接使用 HMAC SHA256
    完整的头部就像下面这样的JSON:
        {
          'typ': 'JWT',
          'alg': 'HS256'
        }

然后将头部进行base64加密(该加密是可以对称解密的),构成了第一部分.

  • eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

1.1.2 payload

载荷就是存放有效信息的地方。这个名字像是特指飞机上承载的货品,这些有效信息包含三个部分

标准中注册的声明
公共的声明
私有的声明
标准中注册的声明 (建议但不强制使用) :

iss: jwt签发者
sub: jwt所面向的用户
aud: 接收jwt的一方
exp: jwt的过期时间,这个过期时间必须要大于签发时间
nbf: 定义在什么时间之前,该jwt都是不可用的.
iat: jwt的签发时间
jti: jwt的唯一身份标识,主要用来作为一次性token,从而回避时序攻击。
公共的声明 : 公共的声明可以添加任何的信息,一般添加用户的相关信息或其他业务需要的必要信息.但不建议添加敏感信息,因为该部分在客户端可解密.

私有的声明 : 私有声明是提供者和消费者所共同定义的声明,一般不建议存放敏感信息,因为base64是对称解密的,意味着该部分信息可以归类为明文信息。

定义一个payload:

{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}

然后将其进行base64加密,得到JWT的第二部分。

  • eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9

1.1.3 signature

JWT的第三部分是一个签证信息,这个签证信息由三部分组成:

header (base64后的)
payload (base64后的)
secret
这个部分需要base64加密后的header和base64加密后的payload使用.连接组成的字符串,然后通过header中声明的加密方式进行加盐secret组合加密,然后就构成了jwt的第三部分。

// javascript
var encodedString = base64UrlEncode(header) + '.' + base64UrlEncode(payload);

var signature = HMACSHA256(encodedString, 'secret'); // TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

将这三部分用.连接成一个完整的字符串,构成了最终的jwt

  • eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

注意:secret是保存在服务器端的,jwt的签发生成也是在服务器端的,secret就是用来进行jwt的签发和jwt的验证,所以,它就是你服务端的私钥,在任何场景都不应该流露出去。一旦客户端得知这个secret, 那就意味着客户端是可以自我签发jwt了。关于签发和核验JWT,我们可以使用Django REST framework JWT扩展来完成。

jwt使用流程最核心的是:

-签发:登录接口签发
-认证:认证类认证

1.2 本质原理

jwt认证算法:签发与校验

"""
1)jwt分三段式:头.体.签名 (head.payload.sgin)
2)头和体是可逆加密,让服务器可以反解出user对象;签名是不可逆加密,保证整个token的安全性的
3)头体签名三部分,都是采用json格式的字符串,进行加密,可逆加密一般采用base64算法,不可逆加密一般采用hash(md5)算法
4)头中的内容是基本信息:公司信息、项目组信息、token采用的加密方式信息
{
	"company": "公司信息",
	...
}
5)体中的内容是关键信息:用户主键、用户名、签发时客户端信息(设备号、地址)、过期时间
{
	"user_id": 1,
	...
}
6)签名中的内容时安全信息:头的加密结果 + 体的加密结果 + 服务器不对外公开的安全码 进行md5加密
{
	"head": "头的加密字符串",
	"payload": "体的加密字符串",
	"secret_key": "安全码"
}
"""
  • 签发:根据登录请求提交来的 账号 + 密码 + 设备信息 签发 token
"""
1)用基本信息存储json字典,采用base64算法加密得到 头字符串
2)用关键信息存储json字典,采用base64算法加密得到 体字符串
3)用头、体加密字符串再加安全码信息存储json字典,采用hash md5算法加密得到 签名字符串

账号密码就能根据User表得到user对象,形成的三段字符串用 . 拼接成token返回给前台
"""
  • 校验:根据客户端带token的请求 反解出 user 对象
"""
1)将token按 . 拆分为三段字符串,第一段 头加密字符串 一般不需要做任何处理
2)第二段 体加密字符串,要反解出用户主键,通过主键从User表中就能得到登录用户,过期时间和设备信息都是安全信息,确保token没过期,且时同一设备来的
3)再用 第一段 + 第二段 + 服务器安全码 不可逆md5加密,与第三段 签名字符串 进行碰撞校验,通过后才能代表第二段校验得到的user对象就是合法的登录用户
"""
  • drf项目的jwt认证开发流程(重点)
"""
1)用账号密码访问登录接口,登录接口逻辑中调用 签发token 算法,得到token,返回给客户端,客户端自己存到cookies中

2)校验token的算法应该写在认证类中(在认证类中调用),全局配置给认证组件,所有视图类请求,都会进行认证校验,所以请求带了token,就会反解出user对象,在视图类中用request.user就能访问登录的用户

注:登录接口需要做 认证 + 权限 两个局部禁用

base64编码和解码

image

image
base编码后会随机生成=在字符串结尾供解码时使用

把字符串转成bytes格式两种方式
info = bytes(info,encoding='utf8')
info.encode('utf8')
# base64 可以把字符串编码成base64的编码格式:(大小写字母,数字和 =)eyJzdWIiOiAiMTIzNDU2Nzg5MCIsICJuYW1lIjogImxxeiIsICJhZG1pbiI6IHRydWV9

# base64可以把base64编码的字符串,解码回原来的格式

# 应用场景:
	- jwt中使用
    - 网络中传输字符串就可以使用base64编码
    - 网络中传输图片,也可能使用base64的编码
    
    
# 编码解码


# 把图片保存起来看看
import json
import base64
d = {'name': 'lqz', 'userid': 6, 'age': 19}
info = json.dumps(d)
print(info)
# 把字符串使用base64编码
res=base64.b64encode(info.encode('utf-8'))
print(res)  # eyJuYW1lIjogImxxeiIsICJ1c2VyaWQiOiA2LCAiYWdlIjogMTl9


res=base64.b64decode(s)
with open('code.png','wb') as f:
    f.write(res)

二 drf-jwt安装和简单使用

jwt:签发(登录接口) 认证(认证类)

django中使用jwt

-可以自己写
-https://github.com/jpadilla/django-rest-framework-jwt  (比较老)
-https://github.com/jazzband/djangorestframework-simplejwt (比较新)

2.1 官网

2.2 安装

  • pip install djangorestframework-jwt

2.3内置token生成:

# 1 创建超级用户
python3 manage.py createsuperuser
# 2 配置路由urls.py
from django.urls import path
from rest_framework_jwt.views import obtain_jwt_token
urlpatterns = [
    path('login/', obtain_jwt_token),
]
# 3 postman测试
向后端接口发送post请求,携带用户名密码,即可看到生成的token

# 4 setting.py中配置认证使用jwt提供的jsonwebtoken
# 5 postman发送访问请求(必须带jwt空格)

token使用

  • 配合权限类的使用
使用的时候需要配合认权限同时使用
认证(认证类):导入,配置在视图类上
    	class TestView(APIView):
            authentication_classes = [JSONWebTokenAuthentication,]
            permission_classes = [IsAuthenticated,]
    -前端访问时,token需要放在请求头中
    	Authorization:jwt token串

image

def修改jwt返回的格式

如果配置自己的则用自己的如果不配置则使用drf默认的

  • from rest_framework_jwt.utils import jwt_response_payload_handler
    image
# 登录成功后,前端看到的格式,太固定了,只有token,我们想做成
	{code:100,msg:'登录成功',token:adfasdfasdf}
    
    
# 固定写法:写一个函数,函数返回什么,前端就看到什么,配置在配置文件中

# 使用步骤
from rest_framework_jwt.utils import jwt_response_payload_handler
def jwt_response_payload_handler(token, user=None, request=None):
    print(user)
    print(type(user))  # 当前登陆用户
    return {'code': 100,
            'msg': '登陆成功',
            'username': user.username,
            'token': token}
函数返回什么前端就展示什么
2 把函数配置在配置文件中
        JWT_AUTH={'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),  # 认证时间
        'JWT_RESPONSE_PAYLOAD_HANDLER': 'app01.response.jwt_response_payload_handler',
    	}  # 自定义的数据返回格式登陆成功后的返回格式如果失败则返回内置的错误信息格式没有修改

3.5 内置全局使用全局使用

# setting.py
配合使用做登陆认证
from rest_framework_jwt.authentication import JSONWebTokenAuthentication
from rest_framework.permissions import IsAuthenticated
REST_FRAMEWORK = {
    # 登陆认证 jwt 内置
'DEFAULT_AUTHENTICATION_CLASSES': [
       'rest_framework_jwt.authentication.JSONWebTokenAuthentication'
    ],

	# 权限认证django内置
  'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.AllowAny', 'rest_framework.permissions.IsAuthenticated'
    ]   # 默认所有人都有权限IsAuthenticated判定登陆后才有权限
}

3.6 局部启用禁用

# 局部禁用
authentication_classes = []
# 局部启用
from rest_framework_jwt.authentication import JSONWebTokenAuthentication
authentication_classes = [JSONWebTokenAuthentication]

四实战之自定义User表,手动签发:

  • 手动签发token
from .models import UserInfo
from rest_framework_jwt.settings import api_settings
jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
from .response import jwt_response_payload_handler
from datetime import datetime
class UserVies(APIView):
    authentication_classes = []
    def post(self, request):
        # try:
            username = request.data.get('name')
            password = request.data.get('pwd')
            user = UserInfo.objects.get(username=username,password=password)
            # 使用模块提供的签发token的函数
            payload = jwt_payload_handler(user)
            token = jwt_encode_handler(payload)
            response_data = jwt_response_payload_handler(token, user, request)
            return response_data  # 调用自定义的返回函数返回自定义的数据格式
  • 自定义认证类的不需要配合权限类使用
import jwt
from rest_framework.exceptions import AuthenticationFailed
from rest_framework_jwt.settings import api_settings
from rest_framework.authentication import BaseAuthentication
from rest_framework import exceptions
jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
jwt_decode_handler = api_settings.JWT_DECODE_HANDLER
jwt_key = api_settings.JWT_AUTH_HEADER_PREFIX
from .models import UserInfo
class MyJSONWebTokenAuthentication(BaseAuthentication):
    HTTP_HEADER_ENCODING = 'iso-8859-1'
    def authenticate(self, request):
	# 带jwt 的认证
        auth = request.META.get('HTTP_TOKEN', b'')
        if isinstance(auth, str):
            # Work around django test client oddness
            auth = auth.encode(self.HTTP_HEADER_ENCODING)
        auth = auth.split()
        if not auth:
            raise AuthenticationFailed('该字段必须填')
        try:
            assert auth[0].decode() == jwt_key.lower()
            jwt_value = auth[1]
        except:
            raise AuthenticationFailed('认证失败')
        try:
            payload = jwt_decode_handler(jwt_value)
        except jwt.ExpiredSignature:
            raise AuthenticationFailed('签名过期')
        except jwt.InvalidTokenError:
            raise AuthenticationFailed('非法用户')
        username = payload.get('username')
        user = UserInfo.objects.filter(username=username).first()
        print(type(user))
        return (user, jwt_value)

    ##### 不带jwt前缀
    def authenticate(self, request):
        auth = request.META.get('HTTP_TOKEN', b'')
        if not auth:
            raise AuthenticationFailed('该字段必须填')
        try:
            payload = jwt_decode_handler(auth)
        except jwt.ExpiredSignature:
            raise AuthenticationFailed('签名过期')
        except jwt.InvalidTokenError:
            raise AuthenticationFailed('非法用户')
        username = payload.get('username')
        user = UserInfo.objects.filter(username=username).first()
        print(type(user))
        return (user, payload)

手动认证配置

REST_FRAMEWORK = {
    # 认证模块
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'app01.authtication.MyJSONWebTokenAuthentication',
    ),
}

修改token过期时间配置

JWT_AUTH = {'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),
            'JWT_RESPONSE_PAYLOAD_HANDLER': 'app01.response.jwt_response_payload_handler', }

4.4 登陆获取token

image

4.5 编写测试接口

from .authtication import MyJSONWebTokenAuthentication
class Index(APIView):
    authentication_classes = [MyJSONWebTokenAuthentication, ]
    # permission_classes = [IsAuthenticated,]  # 自定义的认证不需要配合权限使用
    def get(self, request):
        return Response('ok')

image
认证通过返回用户需要的数据验证不同过则抛异常 在认证类中返回错误的信息

posted @ 2022-10-13 19:20  懒羊羊A  阅读(226)  评论(0)    收藏  举报