Doorkeeper-JWT 使用手册

Doorkeeper-JWT 使用手册

doorkeeper-jwtJWT Token support for Doorkeeper项目地址:https://gitcode.com/gh_mirrors/do/doorkeeper-jwt

---

1. 项目目录结构及介绍

Doorkeeper-JWT 是一个为 Doorkeeper 增加 JWT 支持的插件。其仓库在 GitHub，下面是该插件的基本目录结构和重要文件简介：

doorkeeper-jwt/
|-- lib                   # 主要的库代码存放位置
   |-- doorkeeper         # Doorkeeper 相关扩展代码
      |-- jwt             # JWT 特性实现的代码
         |-- config.rb    # 配置门禁JWT的初始化文件
         |-- generator.rb  # 可能涉及的JWT生成器逻辑（未直接在引用中提到，但一般会有此类文件来定制JWT的生成）
|-- spec                 # 单元测试和规格说明
|-- README.md            # 项目的主要读我文件，包含快速入门指南
|-- LICENSE.txt          # 许可证文件，声明了MIT许可证

• lib/doorkeeper/jwt: 这是插件的核心部分，包含了JWT集成到Doorkeeper的逻辑。
• config.rb: 在这个上下文中指的是如何在Doorkeeper配置中启用和调整JWT配置的关键文件。
• 其他如spec目录用于存放单元测试，确保代码质量。

2. 项目的启动文件介绍

在Doorkeeper-JWT的上下文中，并没有一个直接的“启动文件”概念，因为它是一个RubyGem，通常被其他Rails应用作为依赖引入。不过，在你的应用程序中，关键的“启动”动作涉及到在Doorkeeper的配置中启用JWT功能。这通常发生在Rails应用中的一个或多个初始化文件中，比如config/initializers/doorkeeper.rb。

你需要在这里添加以下配置来启用JWT：

Doorkeeper.configure do
  # ...
  access_token_generator '::Doorkeeper::JWT'
end

Doorkeeper::JWT.configure do
  # 根据官方指南设置JWT的具体偏好
  token_payload do |opts|
    # 示例配置，实际配置会包含具体的用户信息
    user = User.find(opts[:resource_owner_id])
    {
      iss: 'Your App Name',
      iat: Time.current.utc.to_i,
      aud: opts[:application][:uid],
      jti: SecureRandom.uuid,
      sub: user.id,
      user: {
        id: user.id,
        email: user.email
      }
    }
  end
  # 更多可能的配置项...
end

3. 项目的配置文件介绍

配置Doorkeeper-JWT主要是通过在你的Doorkeeper初始化文件中插入特定的配置块完成的。这个过程并不直接关联于单一的、显式的配置文件，而是嵌入到了Doorkeeper的自定义配置中。

主配置块

在你的Doorkeeper配置初始化文件中，你需要指定使用JWT作为访问令牌生成器：

Doorkeeper.configure do
  # ...
  access_token_generator '::Doorkeeper::JWT'
end

JWT特有配置块

紧接着，在主配置之后，你会创建一个新的配置块专门用于JWT的设置：

Doorkeeper::JWT.configure do
  # 自定义JWT的payload、秘钥、算法等
  token_payload do
    # 实现逻辑以构建JWT的载荷
  end
  
  # 可能还包括签名算法、过期时间等其他选项
end

这里的配置允许高度定制JWT的生成逻辑和特性，确保它适应你的应用需求。记住，这些配置是在你的Rails应用内部进行管理的，而不是直接在Doorkeeper-JWT项目本身的文件中。

doorkeeper-jwtJWT Token support for Doorkeeper项目地址:https://gitcode.com/gh_mirrors/do/doorkeeper-jwt