Doorkeeper: OAuth 2 提供者指南

Doorkeeper: OAuth 2 提供者指南

doorkeeperDoorkeeper is an OAuth 2 provider for Ruby on Rails / Grape.项目地址:https://gitcode.com/gh_mirrors/do/doorkeeper

Doorkeeper 是一个专为 Ruby on Rails 和 Grape 框架设计的 OAuth 2 提供者 gem。它简化了在你的应用中实现OAuth2授权协议的过程，广泛应用于访问控制和身份验证场景。

1. 项目目录结构及介绍

Doorkeeper 的仓库结构是典型的Ruby on Rails风格，但因为这是一个gem，所以其核心组件更为简洁。以下是一些关键目录和它们的作用：

• lib: 包含gem的核心代码，如主要类和模块定义。

  • doorkeeper: 存放核心认证逻辑相关的Ruby类。
  • doorkeeper/railtie.rb: 集成到Rails应用的初始化脚本。

• config: 提供示例配置文件和初始设置说明。

  • initializers: 可能包括初始化门禁器的配置文件示例。

• spec: 单元测试和集成测试存放处，确保gem的功能完整性。

• docs: 文档和指南所在目录，对于理解如何使用门禁器至关重要。

• Gemfile: 定义了开发和运行门禁器所需的依赖项。

2. 项目的启动文件介绍

在实际部署Doorkeeper时，不需要直接“启动”gem本身，因为它被嵌入到你的Rails或Grape应用中。但是，配置过程通常涉及几个关键点：

• 在你的Rails应用的config/application.rb或特定环境配置（比如development.rb, production.rb）中，通过以下方式引入并配置Doorkeeper：

  config.middleware.use Doorkeeper::Middleware::OAuth
  

  接着，你会有一个自动生成的或者手动创建的配置文件（可能是config/initializers/doorkeeper.rb），在这里进行门禁器的行为定制，如端点URL、访问令牌策略等。

3. 项目的配置文件介绍

配置文件通常位于config/initializers/doorkeeper.rb，这里提供了对Doorkeeper行为的全面控制。以下是配置文件可能会包含的关键设置：

• 应用的基本配置:

  Doorkeeper.configure do
    resource_owner_authenticator do
      # 自定义逻辑来确定当前资源所有者是谁
    end
  
    default_scopes :public # 默认作用域
    optional_scopes :read, :write # 可选作用域
  
    access_token_expires_in 3600 # 设置访问令牌过期时间
  end
  

• 数据库适配器设置:

  如果你需要指定数据库适配器（例如使用MongoDB而非默认的ActiveRecord）：

  Doorkeeper::Models::Migration diffs
  Doorkeeper::Application.establish_connection adapter: 'mongo', database: 'your_database'
  

• 路由: 虽然不是直接在配置文件中，但Doorkeeper会在你Rails的路由文件中添加必要的OAuth路由。这通常是通过引入_doorkeeper助手完成的：

  mount Doorkeeper::Engine, at: '/oauth'
  

这些配置点仅是入门，Doorkeeper还支持更多高级功能，包括自定义模型、访问控制和授权策略等，详情需参考官方文档和配置指南以充分利用其灵活性。

doorkeeperDoorkeeper is an OAuth 2 provider for Ruby on Rails / Grape.项目地址:https://gitcode.com/gh_mirrors/do/doorkeeper