Google API Ruby客户端库中的服务器间OAuth 2.0认证指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00480/article/details/148758240

Google API Ruby客户端库中的服务器间OAuth 2.0认证指南

google-api-ruby-client REST client for Google APIs 项目地址: https://gitcode.com/gh_mirrors/go/google-api-ruby-client

前言

在现代应用开发中，服务间通信的安全性至关重要。Google API Ruby客户端库提供了完善的OAuth 2.0支持，使开发者能够安全地实现服务器到服务器的认证流程。本文将深入解析如何利用服务账号(Service Account)实现无用户参与的API调用。

服务账号基础概念

服务账号是一种特殊类型的账号，代表应用程序而非个人用户。当您的应用需要访问自身数据而非用户数据时，服务账号是最佳选择。这种认证模式通常被称为"两腿OAuth"(2LO)，与需要用户授权的"三腿OAuth"形成对比。

服务账号的核心组件包括：

唯一的生成邮箱地址
客户端ID
至少一对公钥/私钥

服务账号应用场景

应用自有数据访问：如使用Cloud Datastore进行数据持久化
域内用户数据代理访问：需域管理员授权，可代表域内用户执行操作

服务账号创建流程

在云控制台中创建

访问服务账号管理页面
点击"创建服务账号"
填写服务账号名称并选择"提供新私钥"
如需域范围授权，勾选相应选项
点击"创建"完成设置

重要提示：私钥文件仅下载一次，务必安全存储。不会保留您的私钥副本。

域范围授权配置

如需服务账号访问域内用户数据，管理员需执行：

登录管理控制台
进入安全 > 高级设置 > 管理第三方OAuth客户端访问
输入服务账号的客户端ID
指定所需的API范围(如Drive和Calendar API)
点击"授权"

Ruby实现详解

基础认证设置

require 'googleauth'
require 'google/apis/compute_v1'

# 初始化服务对象
compute = Google::Apis::ComputeV1::ComputeService.new

# 配置授权范围和默认应用凭证
scopes = ['https://www.googleapis.com/auth/cloud-platform', 
          'https://www.googleapis.com/auth/compute']
compute.authorization = Google::Auth.get_application_default(scopes)

用户模拟(域范围授权)

require 'googleauth'
require 'google/apis/sqladmin_v1beta4'

# 获取默认授权
scopes = ['https://www.googleapis.com/auth/sqlservice.admin']
authorization = Google::Auth.get_application_default(scopes)

# 克隆并设置模拟用户
auth_client = authorization.dup
auth_client.sub = 'user@example.org'

获取访问令牌

auth_client.fetch_access_token!

API调用示例

sqladmin = Google::Apis::SqladminV1beta4::SqladminService.new
sqladmin.authorization = auth_client

# 列出项目中的Cloud SQL实例
instances = sqladmin.list_instances('your-project-id')

完整示例代码

以下示例展示了如何列出项目中的所有Cloud SQL实例：

require 'googleauth'
require 'google/apis/sqladmin_v1beta4'

# 初始化SQL管理服务
sqladmin = Google::Apis::SqladminV1beta4::SqladminService.new

# 配置授权
scopes = ['https://www.googleapis.com/auth/sqlservice.admin']
sqladmin.authorization = Google::Auth.get_application_default(scopes)

# 获取并输出实例列表
instances = sqladmin.list_instances('your-project-id')
puts instances.to_json