Doorkeeper与Devise集成终极指南：构建统一认证架构的5个关键步骤-平芜编程栈

Doorkeeper与Devise集成终极指南：构建统一认证架构的5个关键步骤

【免费下载链接】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提供者，而Devise是Ruby on Rails最流行的认证解决方案。将这两者集成可以构建一个强大而安全的统一认证架构，为你的应用提供专业的OAuth 2.0支持。本指南将通过5个关键步骤，帮助你快速实现Doorkeeper与Devise的无缝集成。

步骤1：安装与基础配置

首先，确保你的Rails项目中已经安装了Devise。如果还没有安装，可以通过以下命令添加到Gemfile并安装：

gem 'devise' bundle install rails generate devise:install rails generate devise User rails db:migrate

接下来，添加Doorkeeper到你的项目中：

gem 'doorkeeper' bundle install rails generate doorkeeper:install rails generate doorkeeper:migration rails db:migrate

这将生成Doorkeeper的配置文件和数据库迁移文件。Doorkeeper的主配置文件位于config/initializers/doorkeeper.rb，我们将在后续步骤中对其进行修改。

步骤2：配置资源所有者认证

Doorkeeper需要知道如何认证资源所有者（通常是你的应用用户）。这正是Devise发挥作用的地方。打开Doorkeeper的配置文件：

# config/initializers/doorkeeper.rb Doorkeeper.configure do # 其他配置... # 配置资源所有者认证 resource_owner_authenticator do # 使用Devise的authenticate_user!方法认证用户 current_user || warden.authenticate!(scope: :user) end # 其他配置... end

这段代码告诉Doorkeeper使用Devise的认证机制来验证用户身份。current_user是Devise提供的辅助方法，用于获取当前已认证的用户。如果用户未认证，warden.authenticate!将重定向到Devise的登录页面。

步骤3：设置管理员认证（可选）

如果你需要限制对Doorkeeper管理界面的访问，可以配置管理员认证：

# config/initializers/doorkeeper.rb Doorkeeper.configure do # 其他配置... # 配置管理员认证 admin_authenticator do if current_user head :forbidden unless current_user.admin? else redirect_to new_user_session_url end end # 其他配置... end

这段配置确保只有管理员用户才能访问Doorkeeper的管理界面。你需要在User模型中添加一个admin布尔字段来实现这个功能。

步骤4：配置OAuth 2.0授权流程

Doorkeeper支持多种OAuth 2.0授权流程。根据你的需求，在配置文件中启用相应的流程：

# config/initializers/doorkeeper.rb Doorkeeper.configure do # 其他配置... # 配置授权流程 grant_flows %w[authorization_code client_credentials password refresh_token] # 配置作用域 default_scopes :public optional_scopes :read, :write, :admin # 其他配置... end

常用的授权流程包括：

authorization_code: 用于第三方应用获取用户授权
client_credentials: 用于服务间通信
password: 用于第一方应用直接使用用户名密码获取令牌
refresh_token: 用于刷新访问令牌

步骤5：保护你的API端点

完成上述配置后，你可以使用Doorkeeper提供的doorkeeper_for方法来保护你的API端点：

# app/controllers/api/v1/products_controller.rb class Api::V1::ProductsController < ApplicationController doorkeeper_for :all, scopes: [:read, :write] def index @products = Product.all render json: @products end # 其他操作... end

你还可以在控制器中通过doorkeeper_token方法获取当前访问令牌的信息，例如资源所有者：

def create @product = current_user.products.new(product_params) if @product.save render json: @product, status: :created else render json: @product.errors, status: :unprocessable_entity end end private def current_user @current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token end