Firebase ID Token 验证 Ruby Gem 使用教程

Firebase ID Token 验证 Ruby Gem 使用教程

firebase_id_token A Ruby gem to verify the signature of Firebase ID Tokens. 项目地址: https://gitcode.com/gh_mirrors/fi/firebase_id_token

1. 项目介绍

firebase_id_token 是一个用于验证 Firebase ID Token（JWT）的 Ruby Gem。它使用 Redis 存储 Google 的 x509 证书并管理其过期时间，从而无需在每次执行时请求 Google 的 API，可以像读取内存一样快速访问。此外，它还检查 JWT 有效负载参数，如 Firebase 官方文档中所推荐的那样。

该项目的主要功能包括：

• 使用 Redis 存储和管理 Google 的 x509 证书。
• 验证 Firebase ID Token 的签名。
• 检查 JWT 有效负载参数。

2. 项目快速启动

安装

首先，通过以下命令安装 firebase_id_token Gem：

gem install firebase_id_token

或者在 Gemfile 中添加：

gem 'firebase_id_token', '~> 3.0.0'

然后运行 bundle install。

配置

在 Rails 项目中，配置文件通常放在 config/initializers/firebase_id_token.rb 中：

FirebaseIdToken.configure do |config|
  config.redis = Redis.new(host: '10.0.1.1', port: 6380, db: 15)
  config.project_ids = ['your-firebase-project-id']
end

下载证书

在验证 Token 之前，需要下载 Google 的 x509 证书：

FirebaseIdToken::Certificates.request

验证 Token

使用以下代码验证 Firebase ID Token：

token = 'your-firebase-id-token'
payload = FirebaseIdToken::Signature.verify(token)

if payload
  puts "Token 验证成功: #{payload}"
else
  puts "Token 验证失败"
end

3. 应用案例和最佳实践

应用案例

假设你正在开发一个 Rails 应用，用户通过 Firebase 进行身份验证。你可以使用 firebase_id_token 来验证用户提供的 ID Token，确保用户身份的真实性。

最佳实践

1. 定期更新证书：建议每小时或每30分钟更新一次证书，以确保证书的有效性。
2. 错误处理：在验证 Token 时，处理可能的异常情况，如证书过期或 Token 无效。
3. 测试模式：在开发和测试环境中使用测试模式，避免频繁请求 Google 的 API。

4. 典型生态项目

相关项目

• Firebase Admin SDK：Firebase 官方提供的 SDK，用于管理 Firebase 项目。
• Redis：用于存储和管理 Google 的 x509 证书。
• JWT：用于生成和验证 JSON Web Token。

集成示例

假设你正在开发一个多租户应用，每个租户使用不同的 Firebase 项目。你可以扩展 firebase_id_token 以支持多个项目 ID：

FirebaseIdToken.configure do |config|
  config.redis = Redis.new(host: '10.0.1.1', port: 6380, db: 15)
  config.project_ids = ['project-id-1', 'project-id-2']
end

通过这种方式，你可以轻松管理多个 Firebase 项目的 Token 验证。

firebase_id_token A Ruby gem to verify the signature of Firebase ID Tokens. 项目地址: https://gitcode.com/gh_mirrors/fi/firebase_id_token