OAuth 2 Provider 技术文档

1. 安装指南

在开始使用 OAuth 2 Provider 模块之前，您需要确保已经安装了 Node.js。以下是安装 OAuth 2 Provider 的步骤：

1. 使用 npm 安装 OAuth 2 Provider：

   npm install oauth2-provider
   

2. 在您的应用程序的 package.json 文件中指定版本范围，以避免未来版本的不兼容问题。例如，对于 1.x 版本：

   "oauth2-provider": "1.x"
   

2. 项目使用说明

OAuth 2 Provider 是一个适用于 Connect 和 Express 的 Node.js 模块，允许您实现支持服务器端（代码）和客户端（令牌）OAuth 流的 OAuth2 服务器（提供者）。

该模块非常可定制，因此您需要（目前必须）处理 OAuth 令牌存储和客户端列表。在未来，将提供基于 Mongo 或 Redis 的抽象，这样您就无需关心任何类型的存储。

要将 OAuth 2 Provider 添加到您的 Connect 或 Express 应用程序中，请将其作为中间件添加：

• 确保启用了 bodyParser 和 query 中间件。
• OAuth2Provider 实例提供了两个中间件：
  • oauth(): OAuth 流的入口和访问令牌生成。
  • login(): 保护资源的访问控制。

OAuth2Provider 触发的最重要的事件是 access_token，它允许您设置请求，就像它已经被验证一样。例如，为了支持对受保护 URL 的 cookie 身份验证和 OAuth 访问，您可以填充 req.session.user，这样个别 URL 就不必关心使用了哪种类型的身份验证。

3. 项目API使用文档

OAuth 2 Provider 模块提供以下核心API：

• oauth(): 用于初始化 OAuth 流并处理访问令牌的生成。
• login(): 用于受保护资源的访问控制。

此外，模块会触发以下事件：

• access_token: 当访问令牌被生成时触发，可用于设置请求的验证状态。
• client_auth: 用于处理信任客户端的客户端认证（也称为 xAuth），通过交换用户名和密码来获取访问令牌。

4. 项目安装方式

OAuth 2 Provider 的安装方式如下：

1. 使用 npm 安装：

   npm install oauth2-provider
   

2. 在 package.json 中指定版本范围：

   "oauth2-provider": "1.x"
   

安装完成后，您可以通过示例代码来测试模块的功能。在 examples/simple_express4 目录下运行 npm install，然后执行以下命令：

node app.js

随后访问 <http://localhost:8081/login> 获取访问 <http://localhost:8081/secret> 的权限，或者使用 OAuth 获取访问令牌。