導入 OAuth 2.0 伺服器

每個 Cloud-to-cloud 整合都必須包含使用者驗證機制。

驗證可讓您將使用者的 Google 帳戶連結至驗證系統中的使用者帳戶。這樣一來，當智慧住宅服務收到意圖時，您就能識別使用者。Google 智慧住宅僅支援使用授權碼流程的 OAuth。

本頁面說明如何設定 OAuth 2.0 伺服器，使其與 Cloud-to-cloud 整合服務搭配運作。

透過 OAuth 連結 Google 帳戶

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• 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.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.
2. You must have a Google authorization statement such as "By signing in, you are authorizing Google to control your devices." See the Google Device Control Authorization section of the Google Home Developer Policies.
3. You must open the Web OAuth linking page and ensure users have a clear method for signing in to their Google Account, such as fields for their username and password. Don't use the Google Sign-In (GSI) method that enables users to link without being taken to the Web OAuth Linking page. It is a violation of Google policy.
4. You must include at least one of the following items in the OAuth linking page to indicate the integration to which the user is linking:
   • Company logo
   • Company name
   • Integration name
   • App icon

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have a clear method for signing in to their Google Account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

授權碼流程

OAuth 2.0 伺服器實作的授權碼流程包含兩個端點，您的服務會透過 HTTPS 提供這些端點。第一個端點是授權端點，負責尋找或取得使用者同意，以存取資料。授權端點會向尚未登入的使用者顯示登入 UI，並記錄使用者同意授予要求的存取權。第二個端點是權杖交換端點，用於取得加密字串 (稱為權杖)，授權使用者存取您的服務。

當 Google 應用程式需要呼叫您服務的其中一個 API 時，Google 會一併使用這些端點，向使用者取得代表他們呼叫這些 API 的權限。

Google 啟動的 OAuth 2.0 授權碼流程工作階段會遵循下列流程：

1. Google 會在使用者瀏覽器中開啟授權端點。如果使用者在僅支援語音的裝置上啟動動作流程，Google 會將執行作業轉移到手機。
2. 使用者登入 (如果尚未登入)，並授權 Google 透過您的 API 存取資料 (如果尚未授權)。
3. 您的服務會建立授權碼，並傳回給 Google。如要這麼做，請將使用者的瀏覽器重新導向回 Google，並在要求中附加授權碼。
4. Google 會將授權碼傳送至權杖交換端點，該端點會驗證授權碼的真實性，並傳回存取權杖和更新權杖。存取權杖是短期權杖，服務會接受這類權杖做為存取 API 的憑證。更新權杖是長期有效的權杖，Google 可以儲存並在存取權杖過期時使用，以取得新的存取權杖。
5. 使用者完成帳戶連結流程後，Google 傳送的每個後續要求都會包含存取權杖。

處理授權要求

如要使用 OAuth 2.0 授權碼流程執行帳戶連結，Google 會將使用者傳送至您的授權端點，並在要求中加入下列參數：

舉例來說，如果授權端點位於 https://myservice.example.com/auth，要求可能如下所示：

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code

如要讓授權端點處理登入要求，請按照下列步驟操作：

1. 確認 client_id 與您指派給 Google 的用戶端 ID 相符，且 redirect_uri 與 Google 為您的服務提供的重新導向網址相符。這些檢查作業非常重要，可防止系統將存取權授予非預期或設定錯誤的用戶端應用程式。如果您支援多個 OAuth 2.0 流程，也請確認 response_type 為 code。
2. 確認使用者是否已登入您的服務。如果使用者未登入，請完成服務的登入或註冊流程。
3. 產生授權碼，供 Google 用來存取您的 API。授權碼可以是任何字串值，但必須能唯一代表使用者、權杖適用的用戶端和代碼的到期時間，且不得可供猜測。您通常會發出授權碼，該授權碼會在約 10 分鐘後失效。
4. 確認 redirect_uri 參數指定的網址具有下列格式：

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. 將使用者的瀏覽器重新導向至 redirect_uri 參數指定的網址。重新導向時，請附上您剛產生的授權碼和原始未修改的狀態值，方法是附加 code 和 state 參數。以下是產生的網址範例：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

處理權杖交換要求

服務的權杖交換端點負責兩種權杖交換：

• 以授權碼換取存取權杖和更新權杖
• 以重新整理權杖換取存取權杖

權杖交換要求包含下列參數：

設定 Google 將憑證傳送至伺服器的方式

視實作方式而定，授權伺服器會預期在要求主體或要求標頭中收到用戶端憑證。

根據預設，Google 會在要求主體中傳送憑證。如果授權伺服器要求用戶端憑證位於要求標頭中，您必須據此設定 Cloud-to-cloud 整合：

前往開發人員控制台

1. 在專案清單中，點選要處理的專案旁邊的「開啟」。

2. 在「Cloud-to-Cloud」下方，選取「Develop」。

3. 按一下整合項目旁的「開啟」。

4. 向下捲動至「權限 (選用)」部分，然後選取「讓 Google 透過 HTTP 基本驗證標頭傳輸用戶端 ID 和密鑰」核取方塊。

5. 按一下「儲存」以儲存您的變更。

以授權碼換取存取權杖和更新權杖

使用者登入後，授權端點會將短期授權碼傳回給 Google，接著 Google 會向權杖交換端點傳送要求，將授權碼換成存取權杖和更新權杖。

對於這類要求，grant_type 的值為 authorization_code，而 code 的值則是您先前授予 Google 的授權碼值。以下是要求交換授權碼以取得存取權杖和更新權杖的範例：

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

如要將授權碼換成存取權杖和更新權杖，權杖交換端點會執行下列步驟，回應 POST 要求：

1. 確認 client_id 將要求來源識別為授權來源，且 client_secret 符合預期值。
2. 確認授權碼有效且未過期，且要求中指定的用戶端 ID 與授權碼相關聯的用戶端 ID 相符。
3. 確認 redirect_uri 參數指定的網址與初始授權要求中使用的值相同。
4. 如果無法驗證上述所有條件，請傳回 HTTP 400 錯誤的要求錯誤，並以 {"error": "invalid_grant"} 做為主體。
5. 否則，請使用授權碼中的使用者 ID，產生更新憑證和存取憑證。這些權杖可以是任何字串值，但必須代表使用者和權杖所屬的用戶端，且不得為可猜測的值。如果是存取權杖，請一併記錄權杖的到期時間，通常是發放權杖後的一小時。更新權杖不會過期。
6. 在 HTTPS 回應的主體中傳回下列 JSON 物件：

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

Google 會儲存使用者的存取權杖和更新權杖，並記錄存取權杖的到期時間。存取權杖到期時，Google 會使用更新權杖，從權杖交換端點取得新的存取權杖。

以重新整理權杖換取存取權杖

存取權杖到期時，Google 會向權杖交換端點傳送要求，將更新權杖換成新的存取權杖。

對於這類要求，grant_type 的值為 refresh_token，而 refresh_token 的值則是您先前授予 Google 的重新整理權杖值。以下是要求將重新整理權杖換成存取權杖的範例：

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

如要以重新整理權杖換取存取權杖，權杖交換端點會執行下列步驟，回應 POST 要求：

1. 確認 client_id 將要求來源識別為 Google，且 client_secret 與預期值相符。
2. 確認重新整理權杖有效，且要求中指定的用戶端 ID 與重新整理權杖相關聯的用戶端 ID 相符。
3. 如果無法驗證上述所有條件，請傳回 HTTP 400 Bad Request 錯誤，並將 {"error": "invalid_grant"} 做為主體。
4. 否則，請使用更新權杖中的使用者 ID 產生存取權杖。這些權杖可以是任何字串值，但必須能唯一代表使用者和權杖所屬的用戶端，且不得可供猜測。如果是存取權杖，請一併記錄權杖的到期時間，通常是在核發權杖後一小時。
5. 在 HTTPS 回應主體中傳回下列 JSON 物件：

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

Handle userinfo requests

The userinfo endpoint is an OAuth 2.0 protected resource that return claims about the linked user. Implementing and hosting the userinfo endpoint is optional, except for the following use cases:

• Linked Account Sign-In with Google One Tap.
• Frictionless subscription on AndroidTV.

After the access token has been successfully retrieved from your token endpoint, Google sends a request to your userinfo endpoint to retrieve basic profile information about the linked user.

For example, if your userinfo endpoint is available at https://myservice.example.com/userinfo, a request might look like the following:

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

For your userinfo endpoint to handle requests, do the following steps:

1. Extract access token from the Authorization header and return information for the user associated with the access token.
2. If the access token is invalid, return an HTTP 401 Unauthorized error with using the WWW-Authenticate Response Header. Below is an example of a userinfo error response:

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

   If a 401 Unauthorized, or any other unsuccessful error response is returned during the linking process, the error will be non-recoverable, the retrieved token will be discarded and the user will have to initiate the linking process again.

3. If the access token is valid, return and HTTP 200 response with the following JSON object in the body of the HTTPS response:

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

   If your userinfo endpoint returns an HTTP 200 success response, the retrieved token and claims are registered against the user's Google account.

   userinfo endpoint response
   sub	A unique ID that identifies the user in your system.
   email	Email address of the user.
   given_name	Optional: First name of the user.
   family_name	Optional: Last name of the user.
   name	Optional: Full name of the user.
   picture	Optional: Profile picture of the user.