Django OAuth Toolkit 入门教程：快速搭建OAuth2授权服务器

最新推荐文章于 2025-06-12 09:08:48 发布

宫榕鹃Tobias

最新推荐文章于 2025-06-12 09:08:48 发布

阅读量332

点赞数 4

本文链接：https://blog.youkuaiyun.com/gitblog_00932/article/details/148601904

版权

Django OAuth Toolkit 入门教程：快速搭建OAuth2授权服务器

django-oauth-toolkit 项目地址: https://gitcode.com/gh_mirrors/dja/django-oauth-toolkit

前言

在现代Web开发中，OAuth2协议已成为API安全访问的事实标准。本文将基于django-oauth-toolkit项目，手把手教你如何在Django项目中快速搭建一个功能完整的OAuth2授权服务器。

环境准备

安装必要依赖

首先需要创建一个Python虚拟环境并安装必要的包：

pip install django-oauth-toolkit django-cors-headers

这里安装了两个关键组件：

django-oauth-toolkit：提供OAuth2服务器功能
django-cors-headers：处理跨域请求

项目配置

在Django项目的settings.py中，需要添加以下配置：

INSTALLED_APPS = {
    'django.contrib.admin',
    # 其他应用...
    'oauth2_provider',  # OAuth2提供者
    'corsheaders',      # 跨域支持
}

URL路由配置示例：

from django.urls import path, include
from oauth2_provider import urls as oauth2_urls

urlpatterns = [
    path("admin/", admin.site.urls),
    path("o/", include(oauth2_urls)),  # OAuth2端点
    # 其他路由...
]

跨域设置

为了在开发过程中处理跨域请求，需要添加中间件：

MIDDLEWARE = (
    'corsheaders.middleware.CorsMiddleware',  # 应尽可能靠前
    # 其他中间件...
)

开发环境下可以临时允许所有跨域请求：

CORS_ORIGIN_ALLOW_ALL = True

登录模板配置

OAuth2授权流程通常需要用户登录，因此需要确保登录模板包含next参数：

<input type="hidden" name="next" value="{{ next }}" />

数据库迁移

完成配置后，执行数据库迁移命令：

python manage.py migrate

创建OAuth2客户端应用

应用注册流程

访问管理后台(http://localhost:8000/admin)并登录
导航到OAuth2应用管理页面(http://localhost:8000/o/applications/)
创建新应用时需填写以下关键信息：

用户：应用所有者
重定向URI：授权后跳转的URI，测试时可使用https://www.getpostman.com/oauth2/callback
允许的源：允许访问令牌端点的域名列表
客户端类型：选择"Confidential"(机密)以获取更高安全性
授权类型：选择"Authorization code"(授权码)
名称：应用的显示名称

客户端凭证说明

创建应用后，系统会自动生成：

客户端ID：应用的唯一标识符
客户端密钥：用于验证应用身份的密钥

注意：如果启用了"Hash client secret"选项，客户端密钥将被哈希存储且无法恢复。

测试授权服务器

使用Postman测试

在Postman的Authorization标签页中配置：
- 授权类型：Authorization code (With PKCE)
- 回调URL：与注册时填写的重定向URI一致
- 授权URL：http://localhost:8000/o/authorize/
- 令牌URL：http://localhost:8000/o/token/
- 客户端ID和密钥：从应用详情中获取
点击"Get New Access Token"开始授权流程