OAuth 기반 Google 로그인의 '간소화된' 연결을 통한 계정 연결

OAuth 기반 Google 로그인 '간소화된' 연결 유형은 OAuth 기반 계정 연결 위에 Google 로그인을 추가합니다. 이렇게 하면 Google 사용자에게 원활한 음성 기반 연결이 제공되는 동시에 Google 이외의 ID로 서비스에 등록한 사용자에게 계정 연결이 가능합니다.

이 연결 유형은 Google 로그인으로 시작하며, 이를 통해 사용자의 Google 프로필 정보가 시스템에 있는지 확인할 수 있습니다. 시스템에서 사용자 정보를 찾을 수 없으면 표준 OAuth 흐름이 시작됩니다. 사용자는 Google 프로필 정보를 사용하여 새 계정을 만들 수도 있습니다.

그림 1: 작업이 사용자의 Google 프로필에 액세스하면 이를 사용하여 인증 시스템에서 사용자와 일치하는 항목을 찾을 수 있습니다.

간소화된 연결 유형으로 계정 연결을 수행하려면 다음과 같은 일반적인 단계를 따르세요.

  1. 먼저 사용자에게 Google 프로필에 액세스하는 데 동의해 달라고 요청합니다.
  2. 프로필의 정보를 사용하여 사용자를 식별합니다.
  3. 인증 시스템에서 Google 사용자와 일치하는 항목을 찾을 수 없는 경우 사용자 계정 생성을 음성이나 웹사이트에서만 허용하도록 작업 콘솔에서 작업 프로젝트를 구성했는지 여부에 따라 흐름이 진행됩니다.
    • 음성을 통한 계정 생성을 허용하는 경우 Google에서 수신한 ID 토큰을 검증합니다. 그런 다음 ID 토큰에 포함된 프로필 정보를 기반으로 사용자를 만들 수 있습니다.
    • 음성을 통한 계정 생성을 허용하지 않으면 사용자는 브라우저로 이동되며 여기에서 사용자가 승인 페이지를 로드하고 사용자 생성 흐름을 완료할 수 있습니다.
음성을 통한 계정 생성을 허용했는데 인증 시스템에서 Google 프로필과 일치하는 항목을 찾을 수 없다면 Google에서 받은 ID 토큰을 검증해야 합니다. 그런 다음 ID 토큰에 포함된 프로필 정보를 바탕으로 사용자를 만들 수 있습니다. 음성을 통한 사용자 계정 생성을 허용하지 않으면 사용자는 브라우저로 이동되며 여기에서 승인 페이지를 로드하고 흐름을 완료할 수 있습니다.
그림 2. 시스템에서 사용자 정보를 찾을 수 없을 때 OAuth 및 Google 로그인 흐름을 보여주는 시각적 표현

음성을 통한 계정 생성 지원

음성을 통한 사용자 계정 생성을 허용하면 어시스턴트가 사용자에게 다음 작업을 할지 묻습니다.

  • 사용자의 Google 계정 정보를 사용하여 시스템에서 새 계정을 만듭니다.
  • 기존 Google 이외의 계정이 있는 경우 다른 계정으로 인증 시스템에 로그인합니다.

계정 생성 흐름의 마찰을 최소화하려면 음성을 통한 계정 생성을 허용하는 것이 좋습니다. 사용자는 Google 이외의 기존 계정을 사용하여 로그인하려는 경우에만 음성 흐름을 종료하면 됩니다.

음성을 통한 계정 생성 허용 안함

음성을 통한 사용자 계정 생성을 허용하지 않은 경우 어시스턴트는 사용자 인증을 위해 제공된 웹사이트 URL을 엽니다. 화면이 없는 기기에서 상호작용이 발생하면 어시스턴트는 사용자를 휴대전화로 안내하여 계정 연결 흐름을 계속 진행합니다.

다음과 같은 경우 생성을 허용하지 않는 것이 좋습니다.

  • Google 이외의 계정을 가진 사용자가 신규 사용자 계정을 만들고 인증 시스템의 기존 사용자 계정에 연결하도록 허용하지 않을 것입니다. 예를 들어 포인트 제도를 제공하는 경우 사용자가 기존 계정에서 누적된 포인트가 사라지지 않도록 하는 것이 좋습니다.

  • 계정 만들기 흐름을 완전히 관리할 수 있어야 합니다. 예를 들어 계정을 만드는 동안 사용자에게 서비스 약관을 표시해야 하는 경우 생성을 허용하지 않을 수 있습니다.

OAuth 기반 Google 로그인의 '간소화된' 연결 구현

계정은 업계 표준 OAuth 2.0 흐름에 연결됩니다. Actions on Google은 암시적 코드 흐름과 승인 코드 흐름을 지원합니다.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
  • The token exchange endpoint, which is responsible for two types of exchanges:
    1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
    2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

프로젝트 구성

간소화된 연결을 사용하도록 프로젝트를 구성하려면 다음 단계를 따르세요.

  1. Actions 콘솔을 열고 사용할 프로젝트를 선택합니다.
  2. 개발 탭을 클릭하고 계정 연결을 선택합니다.
  3. 계정 연결 옆에 있는 스위치를 사용 설정합니다.
  4. 계정 만들기 섹션에서 예를 선택합니다.

  5. 연결 유형에서 OAuth 및 Google 로그인 및 암시적을 선택합니다.

  6. 클라이언트 정보에서 다음을 수행합니다.

    • Actions에서 Google에 발행한 클라이언트 ID에 값을 할당하여 Google에서 수신되는 요청을 식별합니다.
    • 승인 및 토큰 교환 엔드포인트의 URL을 삽입합니다.

  7. 저장을 클릭합니다.

OAuth 서버 구현

为了支持 OAuth 2.0 隐式流程，您的服务会进行授权 端点。此端点负责 就数据访问征得用户同意。授权端点 向尚未登录的用户显示登录界面，并记录 同意所请求的访问。

当您的 Action 需要调用您的某项授权的 API 时，Google 会使用 此端点来获得用户许可，以在其上调用这些 API 。

由 Google 发起的典型 OAuth 2.0 隐式流会话具有以下特征： 以下流程：

  1. Google 会在用户的浏览器中打开您的授权端点。通过 如果用户尚未登录，则可以登录，并且授予 Google 访问 通过您的 API 访问其数据（如果尚未授予权限）。
  2. 您的服务会创建一个访问令牌并将其返回给 通过使用访问令牌将用户的浏览器重定向回 Google， 附件。
  3. Google 调用您的服务的 API，并使用 。您的服务会验证访问令牌是否向 Google 授予 访问 API 的授权，然后完成 API 调用。

处理授权请求

当您的 Action 需要通过 OAuth 2.0 隐式流程执行账号关联时， Google 会通过包含以下内容的请求将用户发送到您的授权端点： 以下参数：

授权端点参数
client_id 您分配给 Google 的客户 ID。
redirect_uri 此请求的响应发送到的网址。
state 将一个在 重定向 URI。
response_type 要在响应中返回的值的类型。对于 OAuth 2.0 隐式 则响应类型始终为 token。

例如，如果您的授权端点可通过 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

为了让授权端点能够处理登录请求，请执行以下步骤：

  1. 验证 client_id 和 redirect_uri 值， 防止向意外或配置错误的客户端应用授予访问权限：

    • 确认 client_id 是否与您的客户端 ID 匹配 分配给 Google。
    • 确认 redirect_uri 指定的网址 参数的格式如下： 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID 是项目设置页面上的 ID Actions 控制台界面。

  2. 检查用户是否已登录您的服务。如果用户未登录 中，完成服务的登录或注册流程。

  3. 生成 Google 将用于访问您的 API 的访问令牌。通过 访问令牌可以是任何字符串值，但必须唯一地表示 令牌对应的用户和客户端，且不得被猜到。

  4. 发送 HTTP 响应，将用户浏览器重定向到相应网址 由 redirect_uri 参数指定。添加所有 以下参数：

    • access_token：您刚刚生成的访问令牌
    • token_type：字符串 bearer
    • state：原始状态的未修改状态值 请求 以下是生成的网址示例： 
      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 会将该令牌附加到后续调用 作为 AppRequest 的一部分添加到您的 Action。

处理自动关联

在用户同意你的 Action 访问他们的 Google 个人资料后，Google 发送请求，其中包含 Google 用户身份的已签名断言。 该断言包含的信息包括用户的 Google 账号 ID、姓名、 和电子邮件地址。为项目配置的令牌交换端点处理 请求。

如果您的身份验证系统中已经存在相应的 Google 账号， 您的令牌交换端点为用户返回令牌。如果 Google 账号没有 匹配现有用户，您的令牌交换端点会返回 user_not_found 错误。

请求的格式如下：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

您的令牌交换端点必须能够处理以下参数：

令牌端点参数
grant_type 所交换的令牌的类型。对于这类请求 参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer。
intent 对于这些请求，此参数的值为 `get`。
assertion 一个 JSON Web 令牌 (JWT)，提供 Google 用户身份。JWT 包含的信息包括 账号 ID、名称和电子邮件地址。
consent_code 可选：一个一次性代码（如果存在）用于表明 用户已同意你的 Action 访问指定范围。
scope 可选：您配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，它应该 以下：

验证和解码 JWT 断言

您可以使用适用于您语言的 JWT 解码库来验证和解码 JWT 断言。 使用 Google 的公钥（适用于 JWK 或 PEM 格式）来验证令牌的 签名。

解码后，JWT 断言如以下示例所示： 

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，还要验证断言的颁发者 （iss 字段）为 https://accounts.google.com，且受众群体（aud 字段） 是分配给您的 Action 的客户端 ID。

检查您的身份验证系统中是否已存在该 Google 账号

请检查以下任一条件是否成立：

  • Google 账号 ID 可在断言的 sub 字段中找到，也可位于您的用户数据库中。
  • 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，则表明用户已经注册，您可以发出 访问令牌。

如果断言中指定的 Google 账号 ID 和电子邮件地址都没有 与您数据库中的用户匹配，表示该用户尚未注册。在这种情况下，您的 令牌交换端点应回复 HTTP 401 错误，指定 error=user_not_found， 如以下示例中所示：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}
当 Google 收到包含 user_not_found 错误的 401 错误响应时， 使用 intent 参数的值调用您的令牌交换端点 设置为 create 并发送包含用户个人资料信息的 ID 令牌 一起发送。

通过 Google 登录功能处理账号创建

当用户需要在您的服务中创建账号时，Google 会 向令牌交换端点发送的请求 intent=create，如以下示例所示：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

assertion 参数包含 JSON Web 令牌 (JWT)，可提供 Google 用户的身份的已签名断言。JWT 包含 其中包含用户的 Google 账号 ID、姓名和电子邮件地址 为您的服务创建一个新账号。

如需响应账号创建请求，您的令牌交换端点必须执行以下操作 以下：

验证和解码 JWT 断言

您可以使用适用于您语言的 JWT 解码库来验证和解码 JWT 断言。 使用 Google 的公钥（适用于 JWK 或 PEM 格式）来验证令牌的 签名。

解码后，JWT 断言如以下示例所示： 

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，还要验证断言的颁发者 （iss 字段）为 https://accounts.google.com，且受众群体（aud 字段） 是分配给您的 Action 的客户端 ID。

验证用户信息并创建新账号

请检查以下任一条件是否成立：

  • Google 账号 ID 可在断言的 sub 字段中找到，也可位于您的用户数据库中。
  • 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，则提示用户将其现有账号关联 通过使用 HTTP 401 错误响应请求 error=linking_error，并将用户的电子邮件地址为 login_hint，如 示例：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

如果以上两个条件都不满足，请使用相应信息创建一个新的用户账号 。新账号通常不会设置密码。时间是 建议您将 Google 登录功能添加到其他平台，以便用户能够 在您的应用的各个界面上通过 Google 投放广告。或者，您也可以 通过电子邮件向用户发送链接，启动密码恢复流程，以便用户设置 密码，以便在其他平台上登录。

创建完成后，发出一个访问令牌 并在 HTTPS 响应的正文，如以下示例所示： 

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",
  
  "expires_in": SECONDS_TO_EXPIRATION
}

인증 흐름을 위한 음성 사용자 인터페이스 설계

사용자가 인증되었는지 확인하고 계정 연결 흐름을 시작합니다.

  1. Actions 콘솔에서 Actions Builder 프로젝트를 엽니다.
  2. 작업에서 계정 연결을 시작할 새 장면을 만듭니다.
    1. 장면을 클릭합니다.
    2. add (+) 아이콘을 클릭하여 새 장면을 추가합니다.
  3. 새로 만든 장면에서 조건의 추가 아이콘을 클릭합니다.
  4. 대화와 연결된 사용자가 인증된 사용자인지 확인하는 조건을 추가합니다. 검사에 실패하면 작업이 대화 중에 계정 연결을 실행할 수 없으며 계정 연결이 필요하지 않은 기능에 대한 액세스 권한을 제공하는 것으로 대체됩니다.
    1. 조건의 Enter new expression 필드에 다음 로직을 입력합니다. user.verificationStatus != "VERIFIED"
    2. Transition에서 계정 연결이 필요하지 않은 장면이나 게스트 전용 기능의 진입점인 장면을 선택합니다.

  1. 조건의 추가 아이콘을 클릭합니다.
  2. 사용자에게 연결된 ID가 없는 경우 계정 연결 흐름을 트리거하는 조건을 추가합니다.
    1. 조건의 Enter new expression 필드에 다음 로직을 입력합니다. user.verificationStatus == "VERIFIED"
    2. Transition에서 Account Linking 시스템 장면을 선택합니다.
    3. 저장을 클릭합니다.

저장하면 <SceneName>_AccountLinking라는 새 계정 연결 시스템 장면이 프로젝트에 추가됩니다.

계정 연결 장면 맞춤설정

  1. Scenes(장면)에서 계정 연결 시스템 장면을 선택합니다.
  2. 메시지 보내기를 클릭하고 작업에서 사용자 ID에 액세스해야 하는 이유를 설명하는 짧은 문장을 추가합니다 (예: '환경설정 저장').
  3. 저장을 클릭합니다.

  1. 조건에서 사용자가 계정 연결을 완료한 경우를 클릭합니다.
  2. 사용자가 계정 연결에 동의하는 경우 흐름을 어떻게 진행할지 구성합니다. 예를 들어 웹훅을 호출하여 필요한 맞춤 비즈니스 로직을 처리하고 원래 장면으로 다시 전환할 수 있습니다.
  3. 저장을 클릭합니다.

  1. 조건에서 사용자가 계정 연결을 취소하거나 닫은 경우를 클릭합니다.
  2. 사용자가 계정 연결에 동의하지 않는 경우 흐름을 진행하는 방법을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
  3. 저장을 클릭합니다.

  1. 조건에서 시스템 또는 네트워크 오류가 발생한 경우를 클릭합니다.
  2. 시스템 또는 네트워크 오류로 인해 계정 연결 흐름을 완료할 수 없는 경우 흐름을 진행하는 방법을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
  3. 저장을 클릭합니다.

데이터 액세스 요청 처리

어시스턴트 요청에 액세스 토큰이 포함되어 있으면 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 후 사용자 계정 데이터베이스에서 토큰과 연결된 사용자 계정을 검색합니다.