OAuth로 Google 계정 연결

계정은 업계 표준 OAuth 2.0 승인 코드 흐름을 사용하여 연결됩니다.

에이전트용 OAuth 2.1 및 PKCE

상태 비저장 AI 에이전트 및 멀티모달 파이프라인의 경우 OAuth 2.1 시행이 권장됩니다.

• PKCE (Proof Key for Code Exchange): 승인 코드 플로우를 보호하고 가로채기 공격을 방지하는 데 사용해야 합니다.
• 암시적 흐름 없음: 암시적 흐름은 URL에 액세스 토큰을 노출하므로 에이전트 환경에 보안 위험이 됩니다.

서비스는 OAuth 2.0/2.1 호환 승인 및 토큰 교환 엔드포인트를 지원해야 합니다.

创建项目

如需创建项目以使用账号关联，请执行以下操作：

1. 前往 Google API 控制台。
2. 点击 Create project 。
3. 输入名称或接受生成的建议。
4. 确认或修改任何剩余字段。
5. 点击创建 。

如需查看项目 ID，请执行以下操作：

1. 前往 Google API 控制台。
2. 在着陆页的表格中找到您的项目。项目 ID 会显示在 ID 列中。

配置 OAuth 权限请求页面

Google 账号关联过程包含一个权限请求页面，该页面会告知用户请求访问其数据的应用、应用请求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。

1. 打开 Google API 控制台的 OAuth 权限请求页面 页面。
2. 如果系统提示您选择项目，请选择您刚刚创建的项目。

3. 在“OAuth 权限请求页面”上，填写表单，然后点击“保存”按钮。

   应用名称 ：向用户征求同意的应用的名称。该名称应准确反映您的应用，并且与用户在其他位置看到的应用名称保持一致。应用名称将显示在账号关联权限请求页面上。

   应用徽标：权限请求页面上显示的一张图片，用以让用户认出您的应用。徽标会显示在账号关联权限请求页面和账号设置中

   支持邮箱 ：用户用于针对其同意问题与您联系的邮箱。

   Google API 的范围 ：范围允许您的应用访问用户的私有 Google 数据。对于 Google 账号关联用例，默认范围（邮箱、个人资料、openid）就足够了，您无需添加任何敏感范围。通常，最佳做法是在需要访问权限时逐步请求范围，而不是提前请求。了解详情。

   已获授权的网域 ：为了保护您和您的用户，Google 只允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。

   应用首页链接 ：应用的首页。必须托管在已获授权的网域上。

   应用隐私权政策链接 ：显示在 Google 账号关联权限请求页面上。必须托管在已获授权的网域上。

   应用服务条款链接（可选） ：必须托管在已获授权的网域上。

   

   图 1. 虚构应用 Tunery 的 Google 账号关联权限请求页面

4. 查看“验证状态”，如果您的应用需要验证，请点击“提交以进行验证”按钮，提交应用以进行验证。如需了解详情，请参阅 OAuth 验证要求。

OAuth 서버 구현

승인 코드 흐름의 OAuth 2.0 서버 구현은 서비스에서 HTTPS를 통해 제공하는 두 개의 엔드포인트로 구성됩니다. 첫 번째 엔드포인트는 데이터 액세스에 대한 사용자 동의를 찾거나 획득하는 역할을 하는 승인 엔드포인트입니다. 승인 엔드포인트는 아직 로그인하지 않은 사용자에게 로그인 UI를 표시하고 요청된 액세스에 대한 동의를 기록합니다. 두 번째 엔드포인트는 토큰 교환 엔드포인트로, 사용자가 서비스에 액세스할 수 있도록 승인하는 토큰이라는 암호화된 문자열을 획득하는 데 사용됩니다.

Google 애플리케이션이 서비스의 API 중 하나를 호출해야 하는 경우 Google은 이러한 엔드포인트를 함께 사용하여 사용자를 대신하여 이러한 API를 호출할 권한을 사용자로부터 얻습니다.

Google 계정 연결: OAuth 승인 코드 플로우

다음 시퀀스 다이어그램은 사용자, Google, 서비스의 엔드포인트 간의 상호작용을 자세히 설명합니다.

역할 및 책임

다음 표에서는 Google 계정 연결 (GAL) OAuth 흐름의 행위자의 역할과 책임을 정의합니다. GAL에서 Google은 OAuth 클라이언트 역할을 하고 서비스는 ID/서비스 제공업체 역할을 합니다.

Google에서 시작한 OAuth 2.0 승인 코드 플로우 세션은 다음과 같은 플로우를 갖습니다.

1. Google이 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 작업의 흐름이 음성 전용 기기에서 시작된 경우 Google은 실행을 휴대전화로 트랜스퍼합니다.
2. 사용자가 아직 로그인하지 않은 경우 로그인하고, 아직 권한을 부여하지 않은 경우 Google에 API로 데이터에 액세스할 수 있는 권한을 부여합니다.
3. 서비스가 승인 코드를 만들어 Google에 반환합니다. 이렇게 하려면 요청에 승인 코드를 첨부하여 사용자의 브라우저를 Google로 다시 리디렉션하세요.
4. Google은 승인 코드를 토큰 교환 엔드포인트로 전송하며, 이 엔드포인트는 코드의 진위성을 확인하고 액세스 토큰과 갱신 토큰을 반환합니다. 액세스 토큰은 서비스가 API에 액세스하기 위한 사용자 인증 정보로 허용하는 단기 토큰입니다. 갱신 토큰은 Google이 저장하고 액세스 토큰이 만료될 때 새 액세스 토큰을 획득하는 데 사용할 수 있는 장기 토큰입니다.
5. 사용자가 계정 연결 흐름을 완료한 후 Google에서 전송되는 모든 후속 요청에는 액세스 토큰이 포함됩니다.

구현 레시피

다음 단계에 따라 승인 코드 플로우를 구현하세요.

1단계: 승인 요청 처리

Google이 계정 연결을 시작하면 사용자를 승인 엔드포인트로 리디렉션합니다. 자세한 프로토콜 계약 및 매개변수 요구사항은 인증 엔드포인트를 참고하세요.

요청을 처리하려면 다음 작업을 실행하세요.

1. 요청 유효성 검사:

   • client_id이 Google에 할당된 클라이언트 ID와 일치하는지 확인합니다.
   • redirect_uri이 예상되는 Google 리디렉션 URL과 일치하는지 확인합니다. none https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
   • response_type이 code인지 확인합니다.

2. 사용자 인증:

   • 사용자가 서비스에 로그인했는지 확인합니다.
   • 사용자가 로그인하지 않은 경우 로그인 또는 가입 절차를 완료하라는 메시지를 표시합니다.

3. 승인 코드 생성:

   • 사용자 및 클라이언트와 연결된 추측할 수 없는 고유한 승인 코드를 만듭니다.
   • 코드가 약 10분 후에 만료되도록 설정합니다.

4. Google로 다시 리디렉션:

   • 브라우저를 redirect_uri에 제공된 URL로 리디렉션합니다.
   • 다음 쿼리 매개변수를 추가합니다.
     • code: 생성한 승인 코드입니다.
     • state: Google에서 수신한 수정되지 않은 상태 값입니다.

2단계: 토큰 교환 요청 처리

토큰 교환 엔드포인트는 토큰용 코드 교환과 만료된 액세스 토큰 새로고침이라는 두 가지 유형의 요청을 처리합니다. 자세한 프로토콜 계약 및 매개변수 요구사항은 토큰 교환 엔드포인트를 참고하세요.

A. 승인 코드를 토큰으로 교환

Google에서 승인 코드를 수신하면 토큰 교환 엔드포인트 (POST)를 호출하여 토큰을 가져옵니다.

1. 요청 유효성 검사:

   • client_id 및 client_secret을 확인합니다.
   • 승인 코드가 유효하고 만료되지 않았는지 확인합니다.
   • redirect_uri이 1단계에서 사용한 값과 일치하는지 확인합니다.
   • 유효성 검사가 실패하면 {"error": "invalid_grant"}와 함께 HTTP 400 Bad Request를 반환합니다.

2. 토큰 발급:

   • 장기 refresh_token와 단기 access_token (일반적으로 1시간)을 생성합니다.
   • 표준 JSON 토큰 응답과 함께 HTTP 200 OK를 반환합니다.

B. 액세스 토큰 새로고침

액세스 토큰이 만료되면 Google은 갱신 토큰을 사용하여 새 토큰을 요청합니다.

1. 요청 유효성 검사:

   • client_id, client_secret, refresh_token를 확인합니다.
   • 유효성 검사가 실패하면 {"error": "invalid_grant"}와 함께 HTTP 400 Bad Request를 반환합니다.

2. 새 액세스 토큰 발급:

   • 새 단기 access_token를 생성합니다.
   • JSON 토큰 응답 (선택적으로 새 갱신 토큰 포함)과 함께 HTTP 200 OK를 반환합니다.

处理 userinfo 请求

userinfo 端点是受 OAuth 2.0 保护的资源，会返回关联用户的声明。实现和托管 userinfo 端点是可选的，但以下用例除外：

• 使用 Google One Tap 登录关联的账号。
• Android TV 提供顺畅的订阅体验。

从您的令牌端点成功检索到访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索关联用户的基本个人资料信息。

例如，如果您的 userinfo 端点可通过 https://myservice.example.com/userinfo 时，请求可能如下所示：

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

为了让 userinfo 端点能够处理请求，请执行以下步骤：

1. 从 Authorization 标头中提取访问令牌，并返回与访问令牌相关联的用户的信息。
2. 如果访问令牌无效，则使用 WWW-Authenticate 响应标头返回 HTTP 401 Unauthorized 错误。下面是一个 userinfo 错误响应示例：

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   如果在关联过程中返回 401 未经授权错误或任何其他失败的错误响应，该错误将无法恢复，检索到的令牌将被舍弃，并且用户必须重新开始关联流程。

3. 如果访问令牌有效，则返回 HTTPS 正文中包含以下 JSON 对象的 HTTP 200 响应 回答：

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }

   如果您的 userinfo 端点返回 HTTP 200 成功响应，则系统会针对用户的 Google 账号注册检索到的令牌和声明。

   userinfo 端点响应
   sub	系统中用于识别用户的唯一 ID。
   email	用户的电子邮件地址。
   given_name	可选：用户的名字。
   family_name	可选：用户的姓氏。
   name	可选：用户的全名。
   picture	可选：用户的个人资料照片。

구현 확인

OAuth 2.0 Playground 도구를 사용하여 구현의 유효성을 검사할 수 있습니다.

Google 계정 연결 데모 도구를 사용하여 구현의 유효성을 검사할 수 있습니다.

도구에서 다음 단계를 수행합니다.

1. Google 계정으로 로그인 버튼을 클릭합니다.
2. 연결하려는 계정을 선택합니다.
3. 서비스 ID를 입력합니다.
4. 액세스 권한을 요청할 범위를 하나 이상 입력합니다(선택사항).
5. 데모 시작 을 클릭합니다.
6. 메시지가 표시되면 연결 요청에 동의하거나 거부할 수 있음을 확인합니다.
7. 플랫폼으로 리디렉션되는지 확인합니다.