在 Django REST Framework 中使用 JWT(JSON Web Tokens)通常涉及到 djangorestframework-simplejwt 这个库。默认情况下,djangorestframework-simplejwt 使用 HS256(HMAC SHA-256)作为其签名算法。如果你想要改用 RS256(RSA SHA-256)算法,你需要做一些额外的配置,包括生成 RSA 密钥对、配置 Django 以使用这些密钥以及确保你的 JWT 设置正确地使用了 RS256。
步骤 1: 安装和配置 djangorestframework-simplejwt
首先,确保你已经安装了 djangorestframework-simplejwt。如果还没有安装,可以通过 pip 安装:
pip install djangorestframework-simplejwt
然后,在你的 Django 项目中配置 settings.py 文件:
INSTALLED_APPS = [
# 其他应用...
'rest_framework',
'rest_framework_simplejwt',
]
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework_simplejwt.authentication.JWTAuthentication',
),
}
步骤 2: 生成 RSA 密钥对
你需要生成 RSA 密钥对。你可以使用 OpenSSL 来生成密钥:
openssl genpkey -algorithm RSA -out private.pem -pkeyopt rsa_keygen_bits:2048
openssl rsa -pubout -in private.pem -out public.pem
这将生成一个私钥文件 private.pem 和一个公钥文件 public.pem。
步骤 3: 配置 simplejwt 以使用 RS256
为了使用 RS256 算法,你需要修改 settings.py 中的 SIMPLE_JWT 设置来指定密钥和算法:
SIMPLE_JWT = {
'AUTH_HEADER_TYPES': ('Bearer',),
'TOKEN_TYPE_CLAIM': 'access',
'ALGORITHM': 'RS256', # 使用 RS256 算法
'SIGNING_KEY': open('path/to/private.pem').read(), # 私钥路径
'VERIFYING_KEY': open('path/to/public.pem').read(), # 公钥路径(可选,用于验证)
}
步骤 4: 确保正确处理密钥文件
在生产环境中,直接在 settings.py 中硬编码密钥文件的内容可能不是最佳实践。更好的做法是使用环境变量或 Django 的安全设置来管理密钥文件。例如,你可以将密钥存储在环境变量中:
import os
from dotenv import load_dotenv
load_dotenv() # 加载环境变量
SIMPLE_JWT = {
'AUTH_HEADER_TYPES': ('Bearer',),
'TOKEN_TYPE_CLAIM': 'access',
'ALGORITHM': 'RS256', # 使用 RS256 算法
'SIGNING_KEY': os.getenv('SIGNING_KEY'), # 从环境变量获取私钥
'VERIFYING_KEY': os.getenv('VERIFYING_KEY'), # 从环境变量获取公钥(可选)
}
确保在 .env 文件中正确设置这些环境变量:
SIGNING_KEY=$(cat path/to/private.pem)
VERIFYING_KEY=$(cat path/to/public.pem)
步骤 5: 测试你的设置
最后,运行你的 Django 项目并测试 JWT 的生成和验证以确保一切工作正常。你可以使用 TokenObtainPairView 来获取一个 token:
from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView
from django.urls import path, include
from rest_framework_simplejwt.views import (
TokenObtainPairView,
TokenRefreshView,
)
urlpatterns = [
path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
path('api/token/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
]
通过这些步骤,你应该能够使用 RS256 算法来生成和验证 JWT。