Django REST framework 之 jwt认证

1.应用背景

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

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

2. JWT的构成

JWT就一段字符串，由三段信息构成的，这三段信息文本用 . 链接在一起就构成了JWT字符串。就像这样：

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwI
iwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30
RMHrHDcEfxjoYZgeFONFh7HgQ

第一部分我们称它为头部（header），第二部分我们称其为载荷（payload,类似于飞机上承载的物品），第三部分是签证（signature）。

header

jwt的头部承载两部分信息：

• 声明类型，这里是jwt
• 声明加密的短发 通常使用 HMAC SHA256

完整的头部就像下面这样的 JSON:

{
'typ': 'JWT'
'alg': 'HS256'
}

然后讲头部进行base64加密（该加密是可以对称解密的），构成了第一部分。

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

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

signature

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

• header（base64后的）
• payload (base64后的)
• secret

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

// javascript如果要模拟生成你的jwttoken，可能可以采用以下代码生成[注意：伪代码]
var encodedString = base64UrlEncode(header) + '.' + base64UrlEncode(payload);

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

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

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

注意： secret 是保存在服务器端的， jwt 的签发生成也是在服务器端的， secret就是用来进行jwt的签发和jwt的验证，所以，他就是你服务端的私钥。在任何场合都不应该流露出去。一旦客户端得知这个secret，那么意味着是可以自我签发jwt了。

3. 安装配置 JWT

文档参考：https://github.com/jpadilla/django-rest-framework-jwt

安装

pip install djangorestframework-jwt

配置

REST_FRAMEWORK = {
		'DEFAULT_AUTHENTICATION_CLASSES':(
		'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
		'rest_framework.authentication.SessionAuthentication',
		'rest_framework.authentication.BasicAuthentication',)
		}
import datetime
JWT_AUTH = {
	'JWT_EXPIRATION_DELTA': datatime.timedelta(days=1),
	}
		

• JWT_EXPIRATION_DELTA 指明token的有效期。

手动生成jwt

Django REST framework JWT 扩展的说明文档中旅提供了手动签发JWT的方法

from rest_framework_jwt.settings import api_settings

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)

在用户注册或登录成功后，在序列化器中返回用户信息以后同事返回token即可。

后端实现登录认证接口

Django REST framework JWT 提供了登录获取 token的视图，可以直接使用
在子应用users路由urls.py中

from rest_framework_jwt.views import obtain_jwt_token

urlpatterns = [
	path(r'authorizations/', obtain_jwt_token, name='authorizations'),
	]

在子路由中，引入当前子应用的路由文件

urlpatterns = [
	...
	path('users/',include("users.urls")),
	# include 的值必须是 模块名.urls 格式，字符串中间只能出现一个圆点
]

接下来，我们可以通过postman来测试下功能