14-drf-JWT认证
18-drf-JWT认证
详细内容:
0- Session
1- JWT认证
在用户注册或登录后,我们想记录用户的登录状态,或者为用户创建身份认证的凭证。我们不再使用Session认证机制,而使用Json Web Token(本质就是token)认证机制。
Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准((RFC 7519).该token被设计为紧凑且安全的,特别适用于分布式站点的单点登录(SSO)场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息,以便于从资源服务器获取资源,也可以增加一些额外的其它业务逻辑所必须的声明信息,该token也可直接被用于认证,也可被加密。
1.1构成和工作原理
0-JWT的构成
#JWT就是一段字符串,由三段信息构成的,将这三段信息文本用.链接一起就构成了Jwt字符串。就像这样:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
1-header(头部)
#1-jwt的头部承载两部分信息:
1-声明类型,这里是jwt
2-声明加密的算法 通常直接使用 HMAC SHA256
#2-完整的头部就像下面这样的JSON:
'typ': 'JWT',
'alg': 'HS256'
#3-然后将头部进行base64加密
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
2-payload(载荷)
# 1-载荷就是存放有效信息的地方,一般该信息包含三部分
1-标准中注册的声明
2-公共的声明
3-私有的声明
# 2-定义一个payload
"sub": "1234567890",
"name": "John Doe",
"admin": true
# 3-其进行base64加密
eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9
3-signature(签证信息)
#1 -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:
1.2 本质原理
1-jwt认证算法:签发与校验
#1、jwt分三段式:头.体.签名 (head.payload.sgin)
#2、加密数据
头和体是可逆加密,让服务器可以反解出user对象, base64
签名是不可逆加密,保证整个token的安全性的 MD5加密算法
2-签发:根据登录请求提交来的 账号 + 密码 + 设备信息 签发 token
1)用基本信息存储json字典,采用base64算法加密得到 头字符串
2)用关键信息存储json字典,采用base64算法加密得到 体字符串
3)用头、体加密字符串再加安全码信息存储json字典,采用hash md5算法加密得到 签名字符串
账号密码就能根据User表得到user对象,形成的三段字符串用 . 拼接成token返回给前台
3-校验:根据客户端带token的请求 反解出 user 对象
#将token按 . 拆分为三段字符串
(1)第一部分
1-头加密字符串 一般不需要做任何处理
(2)第二部分
2.1-体加密字符串,要反解出用户主键,通过主键从User表中就能得到登录用户,
2.2-过期时间和设备信息都是安全信息,确保token没过期,且时同一设备来的
(3)第三部分
再用 第一段 + 第二段 + 服务器安全码 不可逆md5加密,与第三段 签名字符串 进行碰撞校验,通过后才能代表第二段校验得到的user对象就是合法的登录用户
1.3 base64编码解码
import base64
import json
dic_info={
"sub": "1234567890",
"name": "lqz",
"admin": True
byte_info=json.dumps(dic_info).encode('utf-8')
# base64编码
base64_str=base64.b64encode(byte_info)
print(base64_str)
# base64解码
base64_str='eyJzdWIiOiAiMTIzNDU2Nzg5MCIsICJuYW1lIjogImxxeiIsICJhZG1pbiI6IHRydWV9'
str_url = base64.b64decode(base64_str).decode("utf-8")
print(str_url)
1.4 drf+jwt开发流程
1)用账号密码访问登录接口,登录接口逻辑中调用 签发token 算法,得到token,返回给客户端,客户端自己存到cookies中
2)校验token的算法应该写在认证类中(在认证类中调用),全局配置给认证组件,所有视图类请求,都会进行认证校验,所以请求带了token,就会反解出user对象,在视图类中用request.user就能访问登录的用户
注:登录接口需要做 认证 + 权限 两个局部禁用
#使用jwt的开发流程
-用户表,写一个登录功能,登录成功,签发一个token,返回给前端
-以后前端访问,都要携带这个token串
-进入我的认证类(drf,中间件),取出token,认证,认证通过,反解出当前登录用户
-以后再视图类中使用,request.user就是当前登录用户
"""
2-使用第三方drf-jwt 实现自动签发token
注意必须是使用或者继承auth表
1-drf-jwt安装和简单使用
#1-官网
http://getblimp.github.io/django-rest-framework-jwt/
#2-安装
pip install djangorestframework-jwt
#3-简单使用
(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测试
http://127.0.0.1:8000/login/
2-实战之使用Django auth的UserInfo表继承了auth.user自动签发
"""
1 -自己重新写了自定义的认证类 auth.py ---> JsonAuthentication #注意这个在下面写的
2 -模型表继承的auth.user表 ---> UserInfo #添加了字段
3 -settings.py配置里面 ---> 改了默认的过期时间,将自己写的认证类添加添加进去
4 -重新封装了jwt-token的返回值 ---> utils.py --->重写response_user_login函数的返回值
"""
1-模型表model.py
from django.contrib.auth.models import AbstractUser
class UserInfo(AbstractUser):
phone = models.BigIntegerField(null=True)
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.IntegerField()
#继承了auth.user表需要在settings.py中进行配置
AUTH_USER_MODEL = 'app01.UserInfo'
2 -配置文件settings.py
# djangorestframework-jwt也有配置文件,也有默认配置 --> 默认过期时间是5分钟
import datetime
JWT_AUTH = {
# 过期时间1天
'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),
# 自定义认证结果:见下方序列化user和自定义response
# 如果不自定义,返回的格式是固定的,只有token字段
'JWT_RESPONSE_PAYLOAD_HANDLER': 'users.utils.jwt_response_payload_handler',
}
3-编写序列化类serializer.py
from rest_framework import serializers
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = models.Book
fields = '__all__'
4-自定义utils.py认证返回结果(setting中配置)
# 由于drf-jwt默认的只返回一个,如果要想返回更多的信心需要自己重写此方法。
def response_user_login(token, user=None, request=None):
print(request.method)
return {
'status':100,
'msg':'登录成功',
'username':user.username,
'token':token
}
5-视图函数views.py
from rest_framework.permissions import IsAuthenticated
from rest_framework.pagination import PageNumberPagination
from rest_framework.viewsets import ModelViewSet
from app01 import serializer
from app01 import models
#jwt自动认证
PageNumberPagination.page_size=2 #这里可以这么写,实际工作不这么写
class Book(ModelViewSet):
queryset = models.Book
.objects.all()
serializer_class = serializer.BookSerializer
pagination_class = PageNumberPagination #分页功能
#如果使用的jwt内置的认证类,需要配合一个权限类
authentication_classes = [JsonAuthentication, ]
permission_classes = [IsAuthenticated, ]
def list(self, request, *args, **kwargs):
print(request.user) # AnonymousUser
# 只是打印了request.user的用户,然后有返回了上面继承的list方法
return super().list(request, *args, **kwargs)
6-路由层urls.py
from rest_framework_jwt.views import obtain_jwt_token
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
router.register('book', views.Book)
urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include(router.urls)),
path('login/', obtain_jwt_token), # 自动签发token
]
7 -具体使用
1、先登录生成token
2、Authorization: jwt +空格+"上面生成的token字符串"
3 自定义认证类 新建文件auth.py
import jwt
from rest_framework import exceptions
from rest_framework_jwt.authentication import JSONWebTokenAuthentication
from rest_framework_jwt.settings import api_settings
jwt_decode_handler = api_settings.JWT_DECODE_HANDLER
from app01 import models
class JsonAuthentication(JSONWebTokenAuthentication):
def authenticate(self, request):
jwt_value=self.get_jwt_value(request)
# jwt_value=request.GET.get('token')
#验证签名,验证是否过期
try:
# 得到荷载
payload = jwt_decode_handler(jwt_value)
# user=models.User.objects.filter(id=payload['user_id']).first()
#效率更高一写,不需要查数据库了,只不过点不出来他的password
user=models.UserInfo(id=payload['user_id'],username=payload['username'])
# user={'id':payload['user_id'],'username':payload['username']}
except jwt.ExpiredSignature:
msg = 'token过期'
raise exceptions.AuthenticationFailed(msg)
except jwt.DecodeError:
msg = '签名错误'
raise exceptions.AuthenticationFailed(msg)
except jwt.InvalidTokenError:
raise exceptions.AuthenticationFailed('反正就不对')
# 这个咱么不能用,因为它找的是auth的user表,我们是去自己表中查,这个我们需要自己写
# user = self.authenticate_credentials(payload)
# models.User.objects.filter(username=)
return (user, jwt_value)
3-JSONWebTokenAuthentication 源码分析
"""
源码里面有:
1- 在请求有里要写上: Authorization: jwt + 空格 + token字符串 #这里为什么要加上一个空格
2- jwt认证必须与权限配合使用才行,permission_classes = [IsAuthenticated, ] #用来判断当前登录用户是否通过了认证
"""
4 - 继承Model的User表、使用jwt手动签发token
"""
1- 将token写在了 序列化类的全局钩子中
2- 可以拥有原生登录基于Model类user对象签发JWT
# 1- view.py
class UserLoginNew(CreateAPIView):
queryset = models.User.objects.all()
serializer_class = serializer.UserSerializer
def create(self, request, *args, **kwargs):
ser = self.serializer_class(data=request.data)
ser.is_valid(raise_exception=True)
return Response({'status': 100, 'msg': '登录成功', 'token': ser.validated_data.get('token')})
# 2- serializer.py
class UserSerializer(serializers.ModelSerializer):
class Meta:
model = models.User
fields = '__all__'
def validate(self, attrs):
username = attrs.get('username')
password = attrs.get('password')
user = models.User.objects.filter(username=username, password=password).first()
if user:
payload = jwt_payload_handler(user)
token = jwt_encode_handler(payload)
attrs['token'] = token
return attrs
else:
raise ValidationError('用户不存在')
#3 模型类
class User(models.Model):
username = models.CharField(max_length=32)
password = models.CharField(max_length=32)
5 - 多方式登录 --import
"""
1- 输入用户名,输入手机号,输入邮箱+密码
2- 使用的是UserInfo表,继承了auth.user表
"""
1 视图函数中
class UserInfoLoginView(CreateAPIView):
queryset = models.UserInfo.objects.all()
serializer_class = serializer.UserInfoSerializer
def create(self, request, *args, **kwargs):
# context是上下文,是视图类和序列化类沟通的桥梁
# ser = self.serializer_class(data=request.data,context={'request':request})
ser = self.serializer_class(data=request.data)
if ser.is_valid():
token = ser.context['token']
username = ser.context['username']
return Response({'status': 100, 'msg': '登录成功', 'token': token, 'username': username})
else:
print(ser.errors)
return Response({'status': 101, 'msg': '登录失败'})
2 序列化类
class UserInfoSerializer(serializers.ModelSerializer):
# 由于继承的user中的有unique,经过序列化类中的校验没有通过,这里会校验用户名是够已经存在
username = serializers.CharField()
class Meta:
model = models.UserInfo
fields = ['username', 'password']
def validate(self, attrs):
username = attrs.get('username')
password = attrs.get('password')
# 多方式登录,username有可能是手机号,邮箱,用户名
if re.match('^1[3-9][0-9]{9}$', username):
# 用手机号登录
user = models.UserInfo.objects.filter(phone=username).first()
elif re.match(r'^.+@.+$', username):
# 以邮箱登录
user = models.UserInfo.objects.filter(email=username).first()
else:
# 以用户名登录
user = models.UserInfo.objects.filter(username=username).first()
if user and user.check_password(password):
# 登录成,签发token
payload = jwt_payload_handler(user)
token = jwt_encode_handler(payload)