계정은 업계 표준 OAuth 2.0 암시적 및 승인 코드 흐름을 사용하여 연결됩니다.
서비스는 OAuth 2.0 호환 승인 및 토큰 교환 엔드포인트를 지원해야 합니다.
在 隐式 流程中,Google 会在用户的浏览器中打开您的授权端点。成功登录后,您会向 Google 返回长期有效的访问令牌。此访问令牌现在包含在 Google 发送的每个请求中。
在 授权代码 流程中,您需要两个端点:
授权 端点,用于向尚未登录的用户显示登录界面。授权端点还会创建一个短期有效的授权代码,以记录用户对所请求访问权限的同意情况。
令牌交换 端点,负责两种类型的交换:
- 将授权代码交换为长期有效的刷新令牌和短期有效的访问令牌。当用户完成账号关联流程时,会发生此交换。
- 将长期有效的刷新令牌交换为短期有效的访问令牌。 当 Google 需要新的访问令牌(因为其拥有的访问令牌已过期)时,会发生此交换。
选择 OAuth 2.0 流程
虽然 隐式 流程的实现较为简单,但 Google 建议通过隐式流程颁发的访问令牌永不过期。这是因为,如果令牌通过隐式流程过期,用户就必须再次关联其账号。如果您出于安全原因需要令牌过期,我们强烈建议您改用 授权代码 流程。
设计准则
本部分介绍了您为 OAuth 关联流程托管的用户界面的设计要求和建议。在 Google 的应用调用后,您的平台会向用户显示“登录 Google”页面和账号关联同意屏幕。用户同意关联账号后,系统会将用户重定向回 Google 的应用。
要求
- 您必须说明,用户的账号将与 Google 关联, 而不是与 Google Home 或 Google 助理等特定 Google 产品关联。
建议
建议您执行以下操作:
显示 Google 的隐私权政策。在权限请求页面上添加指向 Google 的隐私权政策 的链接。
要共享的数据。 使用清晰简洁的语言告知用户 Google 需要哪些数据及其原因。
明确的号召性用语。 在同意屏幕上添加明确的号召性用语,例如“同意并关联”。 这是因为用户需要了解他们需要与 Google 共享哪些数据才能关联其账号。
能够取消。 为用户提供返回或取消的方式(如果他们选择不关联)。
清晰的登录流程。 确保用户有清晰的 Google 账号登录方法,例如用户名和密码字段,或 “使用 Google 账号登录”。
能够取消关联。 为用户提供取消关联的机制,例如指向您平台上账号设置的网址。或者,您可以 添加指向 Google 账号的链接,用户 可以在其中管理其关联的账号。
能够更改用户账号。 为用户提供切换账号的方法。如果用户倾向于拥有多个账号,这一点尤其有用。
- 如果用户必须关闭权限请求页面才能切换账号,请向 Google 发送可恢复的错误,以便用户可以使用 OAuth 关联 和 隐式 流程登录所选账号。
添加您的徽标。 在权限请求页面上显示您的公司徽标。请按照您的样式指南放置徽标。如果您想要或需要 同时显示 Google 的徽标,请参阅 徽标和商标。
创建项目
如需创建项目以使用账号关联,请执行以下操作:
- 前往 Google API 控制台。
- 点击 Create project 。
- 输入名称或接受生成的建议。
- 确认或修改任何剩余字段。
- 点击创建 。
如需查看项目 ID,请执行以下操作:
- 前往 Google API 控制台。
- 在着陆页的表格中找到您的项目。项目 ID 会显示在 ID 列中。
配置 OAuth 权限请求页面
Google 账号关联过程包含一个权限请求页面,该页面会告知用户请求访问其数据的应用、应用请求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面,然后才能生成 Google API 客户端 ID。
- 打开 Google API 控制台的 OAuth 权限请求页面 页面。
- 如果系统提示您选择项目,请选择您刚刚创建的项目。
在“OAuth 权限请求页面”上,填写表单,然后点击“保存”按钮。
应用名称 :向用户征求同意的应用的名称。该名称应准确反映您的应用,并且与用户在其他位置看到的应用名称保持一致。应用名称将显示在账号关联权限请求页面上。
应用徽标:权限请求页面上显示的一张图片,用以让用户认出您的应用。徽标会显示在账号关联权限请求页面和账号设置中
支持邮箱 :用户用于针对其同意问题与您联系的邮箱。
Google API 的范围 :范围允许您的应用访问用户的私有 Google 数据。对于 Google 账号关联用例,默认范围(邮箱、个人资料、openid)就足够了,您无需添加任何敏感范围。通常,最佳做法是在需要访问权限时逐步请求范围,而不是提前请求。了解详情。
已获授权的网域 :为了保护您和您的用户,Google 只允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。
应用首页链接 :应用的首页。必须托管在已获授权的网域上。
应用隐私权政策链接 :显示在 Google 账号关联权限请求页面上。必须托管在已获授权的网域上。
应用服务条款链接(可选) :必须托管在已获授权的网域上。
图 1. 虚构应用 Tunery 的 Google 账号关联权限请求页面
查看“验证状态”,如果您的应用需要验证,请点击“提交以进行验证”按钮,提交应用以进行验证。如需了解详情,请参阅 OAuth 验证要求。
OAuth 서버 구현
n
OAuth 2.0 암시적 흐름을 지원하기 위해 서비스는 HTTPS를 통해 승인 엔드포인트를 제공합니다. 이 엔드포인트는 인증을 담당하고 데이터 액세스에 대한 사용자 동의를 획득합니다. 승인 엔드포인트는 아직 로그인하지 않은 사용자에게 로그인 UI를 표시하고 요청된 액세스에 대한 동의를 기록합니다.
Google 애플리케이션이 서비스의 승인된 API 중 하나를 호출해야 하는 경우 Google은 이 엔드포인트를 사용하여 사용자를 대신하여 이러한 API를 호출할 수 있는 권한을 사용자로부터 얻습니다.
Google 계정 연결: OAuth 암시적 흐름
다음 시퀀스 다이어그램은 사용자, Google, 서비스의 엔드포인트 간의 상호작용을 자세히 설명합니다.
역할 및 책임
다음 표에서는 Google 계정 연결 (GAL) OAuth 암시적 흐름의 행위자 역할과 책임을 정의합니다. GAL에서 Google은 OAuth 클라이언트로 작동하고 서비스는 ID/서비스 제공업체로 작동합니다.
| 작업 수행자 / 구성요소 | GAL 역할 | 책임 |
|---|---|---|
| Google 앱 / 서버 | OAuth 클라이언트 | 흐름을 시작하고, 브라우저 리디렉션을 사용하여 액세스 토큰을 수신하고, 서비스의 API에 액세스하기 위해 안전하게 저장합니다. |
| 승인 엔드포인트 | 승인 서버 | 사용자를 인증하고, 동의를 얻고, Google에 직접 장기 액세스 토큰을 발급합니다. |
| Google 리디렉션 URI | 콜백 엔드포인트 | URL 프래그먼트에 access_token 및 state 값이 포함된 승인 서비스에서 사용자 리디렉션을 수신합니다. |
Google에서 시작한 일반적인 OAuth 2.0 암시적 흐름 세션에는 다음 흐름이 있습니다.
- Google이 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 사용자가 아직 로그인하지 않은 경우 로그인하고, 아직 권한을 부여하지 않은 경우 Google에 API로 데이터에 액세스할 수 있는 권한을 부여합니다.
- 서비스가 액세스 토큰을 생성하여 Google에 반환합니다. 이렇게 하려면 요청에 액세스 토큰을 첨부하여 사용자의 브라우저를 Google로 다시 리디렉션하세요.
- Google은 서비스의 API를 호출하고 각 요청에 액세스 토큰을 첨부합니다. 서비스는 액세스 토큰이 Google에 API 액세스 권한을 부여하는지 확인한 후 API 호출을 완료합니다.
승인 요청 처리
Google 애플리케이션이 OAuth 2.0 암시적 흐름을 사용하여 계정 연결을 실행해야 하는 경우 Google은 다음 매개변수가 포함된 요청과 함께 사용자를 승인 엔드포인트로 보냅니다.
| 승인 엔드포인트 매개변수 | |
|---|---|
client_id |
Google에 할당한 클라이언트 ID입니다. |
redirect_uri |
이 요청에 대한 응답을 전송할 URL입니다. |
state |
리디렉션 URI에서 변경되지 않은 상태로 Google에 다시 전달되는 부기 값입니다. |
response_type |
응답에서 반환할 값의 유형입니다. OAuth 2.0 암시적 흐름의 경우 응답 유형은 항상 token입니다. |
user_locale |
사용자가 선호하는 언어로 콘텐츠를 현지화하는 데 사용되는 RFC5646 형식의 Google 계정 언어 설정입니다. |
예를 들어 승인 엔드포인트가 https://myservice.example.com/auth에서 제공되는 경우 요청은 다음과 같이 표시될 수 있습니다.
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token&user_locale=LOCALE
승인 엔드포인트가 로그인 요청을 처리하려면 다음 단계를 따르세요.
의도하지 않았거나 잘못 구성된 클라이언트 앱에 액세스 권한이 부여되지 않도록
client_id및redirect_uri값을 확인합니다.client_id가 Google에 할당한 클라이언트 ID와 일치하는지 확인합니다.redirect_uri매개변수로 지정된 URL이 다음 형식을 갖는지 확인합니다.https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
사용자가 서비스에 로그인했는지 확인합니다. 사용자가 로그인하지 않은 경우 서비스의 로그인 또는 가입 흐름을 완료합니다.
Google이 API에 액세스하는 데 사용할 액세스 토큰을 생성합니다. 액세스 토큰은 문자열 값일 수 있지만 토큰이 적용되는 사용자와 클라이언트를 고유하게 나타내야 하며 추측할 수 없어야 합니다.
사용자의 브라우저를
redirect_uri매개변수로 지정된 URL로 리디렉션하는 HTTP 응답을 전송합니다. URL 프래그먼트에 다음 매개변수를 모두 포함합니다.access_token: 방금 생성한 액세스 토큰token_type: 문자열bearerstate: 원래 요청의 수정되지 않은 상태 값
결과 URL의 예는 다음과 같습니다.
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Google의 OAuth 2.0 리디렉션 핸들러는 액세스 토큰을 수신하고 state 값이 변경되지 않았음을 확인합니다. Google이 서비스의 액세스 토큰을 획득하면 Google은 서비스 API에 대한 후속 호출에 토큰을 연결합니다.
사용자 정보 요청 처리
userinfo 엔드포인트는 연결된 사용자에 대한 클레임을 반환하는 OAuth 2.0 보호 리소스입니다. 다음 사용 사례를 제외하고 userinfo 엔드포인트를 구현하고 호스팅하는 것은 선택사항입니다.
- Google 원탭을 사용한 연결된 계정 로그인
- AndroidTV의 원활한 구독
토큰 엔드포인트에서 액세스 토큰을 성공적으로 가져오면 Google은 사용자 정보 엔드포인트에 요청을 보내 연결된 사용자에 대한 기본 프로필 정보를 가져옵니다.
| 사용자 정보 엔드포인트 요청 헤더 | |
|---|---|
Authorization header |
Bearer 유형의 액세스 토큰입니다. |
예를 들어
https://myservice.example.com/userinfo인 경우 요청은 다음과 같을 수 있습니다.
GET /userinfo HTTP/1.1 Host: myservice.example.com Authorization: Bearer ACCESS_TOKEN
userinfo 엔드포인트에서 요청을 처리하려면 다음 단계를 수행합니다.
- 승인 헤더에서 액세스 토큰을 추출하고 액세스 토큰과 연결된 사용자의 정보를 반환합니다.
- 액세스 토큰이 유효하지 않은 경우
WWW-Authenticate응답 헤더를 사용하여 HTTP 401 승인되지 않은 오류를 반환합니다. 다음은 userinfo 오류 응답의 예입니다. 드림 연결 과정 중에 401 승인되지 않음 또는 기타 실패한 오류 응답이 반환되면 오류는 복구할 수 없으며 검색된 토큰은 삭제되며 사용자는 연결 프로세스를 다시 시작해야 합니다.HTTP/1.1 401 Unauthorized WWW-Authenticate: error="invalid_token", error_description="The Access Token expired"
액세스 토큰이 유효하면 HTTPS 본문에 다음 JSON 객체가 포함된 HTTP 200 응답을 반환합니다. 응답:
드림 userinfo 엔드포인트가 HTTP 200 성공 응답을 반환하는 경우 가져온 토큰과 클레임은 사용자의 Google 계정에 등록됩니다.{ "sub": "USER_UUID", "email": "EMAIL_ADDRESS", "given_name": "FIRST_NAME", "family_name": "LAST_NAME", "name": "FULL_NAME", "picture": "PROFILE_PICTURE", }사용자 정보 엔드포인트 응답 sub시스템에서 사용자를 식별하는 고유 ID email사용자의 이메일 주소입니다. given_name선택사항: 사용자의 이름입니다. family_name선택사항: 사용자의 성. name선택사항: 사용자의 전체 이름입니다. picture선택사항: 사용자의 프로필 사진입니다.
구현 확인
OAuth 2.0 Playground 도구를 사용하여 구현의 유효성을 검사할 수 있습니다.
도구에서 다음 단계를 수행합니다.
- 구성 을 클릭하여 OAuth 2.0 구성 창을 엽니다.
- OAuth 흐름 필드에서 클라이언트 측 을 선택합니다.
- OAuth 엔드포인트 필드에서 맞춤 을 선택합니다.
- 해당 필드에서 OAuth 2.0 엔드포인트와 Google에 할당한 클라이언트 ID를 지정합니다.
- 1단계 섹션에서 Google 범위를 선택하지 않습니다. 대신 이 필드를 비워 두거나 서버에 유효한 범위 (또는 OAuth 범위를 사용하지 않는 경우 임의의 문자열)를 입력합니다. 완료되면 API 승인 을 클릭합니다.
- 2단계 및 3단계 섹션에서 OAuth 2.0 흐름을 진행하고 각 단계가 의도한 대로 작동하는지 확인합니다.
Google 계정 연결 데모 도구를 사용하여 구현의 유효성을 검사할 수 있습니다.
도구에서 다음 단계를 수행합니다.
- Google 계정으로 로그인 버튼을 클릭합니다.
- 연결하려는 계정을 선택합니다.
- 서비스 ID를 입력합니다.
- 액세스 권한을 요청할 범위를 하나 이상 입력합니다(선택사항).
- 데모 시작 을 클릭합니다.
- 메시지가 표시되면 연결 요청에 동의하거나 거부할 수 있음을 확인합니다.
- 플랫폼으로 리디렉션되는지 확인합니다.