5分钟,快速入门PythonJWT接口认证

 [[409954]]

本文转载自微信公众号「AirPython」,作者星安果。转载本文请联系AirPython公众号。

十余年的抚松网站建设经验,针对设计、前端、开发、售后、文案、推广等六对一服务,响应快,48小时及时工作处理。全网营销推广的优势是能够根据用户设备显示端的尺寸不同,自动调整抚松建站的显示方式,使网站能够适用不同显示终端,在浏览器中调整网站的宽度,无论在任何一种浏览器上浏览网站,都能展现优雅布局与设计,从而大程度地提升浏览体验。创新互联从事“抚松网站设计”,“抚松网站推广”以来,每个客户项目都认真落实执行。

1. 前言

大家好,我是安果!

为了反爬或限流节流,后端编写接口时,大部分 API 都会进行权限认证,只有认证通过,即:数据正常及未过期才会返回数据,否则直接报错

本篇文章以 Django 为例,聊聊后端 JWT 接口认证的操作流程

2. JWT 介绍

JWT 全称为 JSON Web Token,是目前主流的跨域认证解决方案

数据结构由 3 部分组成,中间由「 . 」分割开

它们分别是:

  • Header 头部
  • Payload 负载
  • Signature 签名
 
 
 
  1. # JWT 数据的格式 
  2. # 组成方式:头部.负载.签名 
  3. Header.Payload.Signature 

其中

Header 用于设置签名算法及令牌类型,默认签名算法为 「 HS256 」,令牌类型可以设置为「 JWT 」

Payload 用于设置需要传递的数据,包含:iss 签发人、exp 过期时间、iat 签发时间等

Signature 用于对 Header 和 Payload 进行签名,默认使用的签名算法为 Header 中指定的算法

 
 
 
  1. # JWT 数据组成 
  2. # Header. Payload. Signature 
  3. # Header:{ "alg": "HS256","typ": "JWT"} 
  4. # Payload:iss、exp、iat等 
  5. # Signature:签名 
  6. Signature = HMACSHA256( 
  7.   base64UrlEncode(header) + "." + 
  8.   base64UrlEncode(payload), 
  9.   secret) 

PS:base64UrlEncode 相比 Base64 算法,会将结果中的「 = 」省略、「 + 」替换成「 - 」、「 / 」替换成「 _ 」

3. 实战一下

首先,在虚拟环境中安装 JWT 依赖包

 
 
 
  1. # 安装jwt依赖包 
  2. pip3 install pyjwt 

然后,定义一个方法用于生成 JWT Token

需要注意的是,生成 JWT Token 时需要指定过期时间、加密方式等

 
 
 
  1. import time 
  2. import jwt 
  3. from django.conf import settings 
  4.  
  5. def generate_jwt_token(user): 
  6.     """ 
  7.     生成一个JWT Token 
  8.     :param user: 
  9.     :return: 
  10.     """ 
  11.     # 设置token的过期时间戳 
  12.     # 比如:设置7天过期 
  13.     timestamp = int(time.time()) + 60 * 60 * 24 * 7 
  14.  
  15.     # 加密生成Token 
  16.     # 加密方式:HS256 
  17.     return jwt.encode({"userid": user.pk, "exp": timestamp}, settings.SECRET_KEY,'HS256') 

接着,编写一个认证类

该类继承于「 BaseAuthentication 」基类,重写内部函数「 authenticate() 」,对请求参数进行 JWT 解密,并进行数据库查询,只有认证通过才返回数据,否则抛出异常

 
 
 
  1. import time 
  2.  
  3. import jwt 
  4. from django.conf import settings 
  5. from django.contrib.auth import get_user_model 
  6. from rest_framework import exceptions 
  7. from rest_framework.authentication import BaseAuthentication, get_authorization_header 
  8.  
  9. User = get_user_model() 
  10.  
  11. class JWTAuthentication(BaseAuthentication): 
  12.     """自定义认证类""" 
  13.  
  14.     keyword = 'jwt' 
  15.     model = None 
  16.  
  17.     def get_model(self): 
  18.         if self.model is not None: 
  19.             return self.model 
  20.         from rest_framework.authtoken.models import Token 
  21.         return Token 
  22.  
  23.     """ 
  24.     A custom token model may be used, but must have the following properties. 
  25.  
  26.     * key -- The string identifying the token 
  27.     * user -- The user to which the token belongs 
  28.     """ 
  29.  
  30.     def authenticate(self, request): 
  31.         auth = get_authorization_header(request).split() 
  32.  
  33.         if not auth or auth[0].lower() != self.keyword.lower().encode(): 
  34.             return None 
  35.  
  36.         if len(auth) !=2: 
  37.             raise exceptions.AuthenticationFailed("认证异常!") 
  38.  
  39.         # jwt解码 
  40.         try: 
  41.             jwt_token = auth[1] 
  42.             jwt_info = jwt.decode(jwt_token, settings.SECRET_KEY,'HS256') 
  43.  
  44.             # 获取userid 
  45.             userid = jwt_info.get("userid") 
  46.  
  47.             # 查询用户是否存在 
  48.             try: 
  49.                 user = User.objects.get(pk=userid) 
  50.                 return user, jwt_token 
  51.             except Exception: 
  52.                 raise exceptions.AuthenticationFailed("用户不存在") 
  53.         except jwt.ExpiredSignatureError: 
  54.             raise exceptions.AuthenticationFailed("抱歉,该token已过期!") 

最后,在视图集 ViewSet 中,只需要在属性「 authentication_classes 」中指定认证列表即可

 
 
 
  1. from rest_framework import viewsets 
  2. from .models import * 
  3. from .serializers import * 
  4. from .authentications import * 
  5.  
  6. class GoodsViewSet(viewsets.ModelViewSet): 
  7.     # 所有商品数据 
  8.     queryset = Goods.objects.all() 
  9.  
  10.     # 序列化 
  11.     serializer_class = GoodsSerializer 
  12.  
  13.     # JWT授权 
  14.     authentication_classes = [JWTAuthentication] 

4. 最后

在实际项目中,一般在登录的时候生成 JWT Token,后续接口中只需要在请求头中设置 JWT Token 即可正常返回数据

 
 
 
  1. import requests 
  2.  
  3. url = "***.***.****" 
  4.  
  5. payload={} 
  6. headers = { 
  7.   'AUTHORIZATION': 'jwt eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyaWQiOiJVTmJCRTJTRlNndm5DU0c3amdQZGJVIiwiZXhwIjoxNjI2MDk5NDA5fQ.cxXsRulEWWQotNpb7XwlZbISrrpb7rSRCjkLsyb8WDM' 
  8.  
  9. response = requests.request("GET", url, headers=headers, data=payload) 
  10. print(response.text) 

新闻名称:5分钟,快速入门PythonJWT接口认证
网站链接:http://www.36103.cn/qtweb/news15/5065.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联