JWT
- Json web token
- 适用于分布式站点的单点登录(SSO)场景
1. 讲在前面:
传统的session认证
http协议本身是一种无状态的协议,而这就意味着如果用户向我们的应用提供了用户名和密码来进行用户认证,那么下一次请求时,用户还要再一次进行用户认证才行,因为根据http协议,我们并不能知道是哪个用户发出的请求,所以为了让我们的应用能识别是哪个用户发出的请求,我们只能在服务器存储一份用户登录的信息,这份登录信息会在响应时传递给浏览器,告诉其保存为cookie,以便下次请求时发送给我们的应用,这样我们的应用就能识别请求来自哪个用户了,这就是传统的基于session认证。
2. 基于session认证所显露的问题
Session: 每个用户经过我们的应用认证之后,我们的应用都要在服务端做一次记录,以方便用户下次请求的鉴别,通常而言session都是保存在内存中,而随着认证用户的增多,服务端的开销会明显增大。
扩展性: 用户认证之后,服务端做认证记录,如果认证的记录被保存在内存中的话,这意味着用户下次请求还必须要请求在这台服务器上,这样才能拿到授权的资源,这样在分布式的应用上,相应的限制了负载均衡器的能力。这也意味着限制了应用的扩展能力。
CSRF: 因为是基于cookie来进行用户识别的, cookie如果被截获,用户就会很容易受到跨站请求伪造的攻击。
3. 基于token的鉴权机制
基于token的鉴权机制类似于http协议也是无状态的,它不需要在服务端去保留用户的认证信息或者会话信息。这就意味着基于token认证机制的应用不需要去考虑用户在哪一台服务器登录了,这就为应用的扩展提供了便利。
流程上是这样的:
- 用户使用用户名密码来请求服务器
- 服务器进行验证用户的信息
- 服务器通过验证发送给用户一个token
- 客户端存储token,并在每次请求时附送上这个token值
- 服务端验证token值,并返回数据
这个token必须要在每次请求时传递给服务端,它应该保存在请求头里, 另外,服务端要支持CORS(跨来源资源共享)
策略,一般我们在服务端这么做就可以了
Access-Control-Allow-Origin: *
。
那么我们现在回到JWT的主题上。
- JWT是由三段信息构成的,将这三段信息文本用
.
链接一起就构成了Jwt字符串。
第一部分我们称它为头部(header)
声明类型,这里是jwt
声明加密的算法 通常直接使用 HMAC SHA256
-
{ 'typ': 'JWT', 'alg': 'HS256' }
然后将头部进行base64加密(该加密是可以对称解密的),构成了第一部分.
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
第二部分我们称其为载荷(payload, 类似于飞机上承载的物品)
- 不存隐私, 可解密的
第三部分是签证(signature)
- 由三部分组成, 并加密:
- header (base64后的)
- payload (base64后的)
- secret
httpOnly=true ???
4. 安装配置
安装
pip install djangorestframework-jwt
配置
# settings 配置
REST_FRAMEWORK = {
# 认证方式 设置
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework_jwt.authentication.JSONWebTokenAuthentication', # 设置第一个为 JWT 认证
'rest_framework.authentication.SessionAuthentication', # session 认证
'rest_framework.authentication.BasicAuthentication',
),
}
import datetime
JWT_AUTH = {
# 配置token有效时间
'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),
# 配置返回 的 token 响应 中 添加 user.id 和user.name, 配置 见 下一个 代码块
'JWT_RESPONSE_PAYLOAD_HANDLER': 'utils.users.jwt_response_payload_handler',
}
# utils/users.py
# 重写 token组件的 返回响应的 函数方法,
# 除了返回 token, 额外 user.id 和 user.username字段
def jwt_response_payload_handler(token, user=None, request=None):
"""
自定义jwt认证成功返回数据
"""
return {
'token': token,
'user_id': user.id,
'username': user.username
}
视图 views.py配置
在注册成功后,连同返回token,需要在注册视图中创建token。
修改CreateUserSerializer序列化器,在create方法中增加手动创建token的方法
# 这是user_app的 serializers.py, 负责 组织返回, 注册后自动登陆 返回token的校验
from rest_framework_jwt.settings import api_settings
class RegisterCreateSerializer(serializers.ModelSerializer):
"""
创建用户序列化器
"""
...
token = serializers.CharField(label='登录状态token', read_only=True) # 增加token字段
class Meta:
...
fields = ('id', 'username', 'password', 'password2', 'sms_code', 'mobile', 'allow', 'token') # 增加token
...
def create(self, validated_data):
"""
创建用户
"""
# 移除数据库模型类中不存在的属性
del validated_data['password2']
del validated_data['sms_code']
del validated_data['allow']
user = super().create(validated_data)
# 调用django的认证系统加密密码
user.set_password(validated_data['password'])
user.save()
# 补充生成记录登录状态的token
jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
payload = jwt_payload_handler(user)
token = jwt_encode_handler(payload)
user.token = token
return user
注意: 要给 序列化器添加token字段,token字段只是序列号使用 所有 read_only=True