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 サーバーは 2 つのエンドポイントで構成されます。これらのエンドポイントには HTTPS 経由でアクセスできます。最初のエンドポイントは認可エンドポイントで、これはデータアクセスに対するユーザーの同意を検索または取得する処理を担当します。認可エンドポイントは、ログインしていないユーザーにログイン用の UI を表示し、リクエストされたアクセスへの同意を記録します。2 つ目のエンドポイントはトークン交換エンドポイントで、トークンという暗号化された文字列を取得し、ユーザーにサービスへのアクセスを許可します。

Google アプリケーションでサービスの API を呼び出す必要がある場合、Google はこれらのエンドポイントを使用して、API の呼び出し許可をユーザーから取得します。

Google が開始する OAuth 2.0 認可コードフローのセッションは次のような流れになります。

1. Google がユーザーのブラウザで認可エンドポイントを開きます。アクションのフローが音声専用デバイスで開始した場合、Google は実行をスマートフォンに転送します。
2. ユーザーがログインし（ログインしていない場合）、Google が API を使用してデータにアクセスすることを承諾します（まだ許可していない場合）。
3. サービスが認可コードを作成し、Google に返します。そのためには、認可コードをリクエストに付加して、ユーザーのブラウザを Google にリダイレクトします。
4. Google が認可コードをトークン交換エンドポイントに送信します。トークン交換エンドポイントはコードの真正性を検証し、アクセス トークンと更新トークンを返します。アクセス トークンは、API にアクセスするための認証情報としてサービスが受け入れる有効期間の短いトークンです。更新トークンは長期のトークンで、アクセス トークンが期限切れになったときに新しいトークンを取得するために使用されます。
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 からサービスに提供されたリダイレクト URL と一致することを確認します。これにより、対象外のクライアント アプリや誤って構成されたクライアント アプリによるアクセスを防ぐことができるため、このチェックは重要です。複数の OAuth 2.0 フローをサポートしている場合は、response_type が code であることも確認してください。
2. ユーザーがサービスにログインしているかどうか確認します。ユーザーがログインしていない場合は、サービスのログインまたは登録フローを完了します。
3. Google が API にアクセスする際に使用する認可コードを生成します。認可コードには任意の文字列値を使用できますが、ユーザー、そのトークンの対象となるクライアント、コードの有効期限を一意に表し、なおかつ簡単に推測できないものにする必要があります。通常、約 10 分後に期限切れになる認可コードを発行します。
4. redirect_uri パラメータで指定された URL が次の形式になっていることを確認します。

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

5. redirect_uri パラメータで指定された URL にユーザーのブラウザをリダイレクトします。code パラメータと state パラメータを追加してリダイレクトする場合は、生成された認可コードと元の未変更の state 値を含めます。結果の URL は次のようになります。

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

トークン交換リクエストの処理

サービスのトークン交換エンドポイントは、次の 2 種類のトークン交換を処理します。

• 認可コードとアクセス トークンおよび更新トークンとの交換
• 更新トークンとアクセス トークンの交換

トークン交換リクエストには、次のパラメータを使用します。

Google がサーバーに認証情報を送信する方法を設定する

認可サーバーは、実装に応じて、リクエスト本文またはリクエスト ヘッダーでクライアント認証情報を受け取ることを想定しています。

デフォルトでは、Google はリクエスト本文で認証情報を送信します。認可サーバーでクライアント認証情報がリクエスト ヘッダーに必要となる場合は、Cloud-to-cloud 統合を次のように構成する必要があります。

デベロッパー コンソールに移動

1. プロジェクトのリストで、操作するプロジェクトの横にある [開く] をクリックします。

2. [Cloud-to-Cloud] で [Develop] を選択します。

3. 統合の横にある [開く] をクリックします。

4. [Permissions (optional)]（権限（省略可））セクションまで下にスクロールし、[Have Google transmit Client ID and secret via HTTP basic auth header]（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 パラメータで指定された URL が、最初の認可リクエストで使用された値と同一であることを確認します。
4. 上記の条件のすべて満たしていない場合、本文で HTTP 400 Bad Request エラーと {"error": "invalid_grant"} を返します。
5. それ以外の場合は、認可コードのユーザー ID を使用して、更新トークンとアクセス トークンを生成します。これらのトークンには任意の文字列値を使用できますが、ユーザーとそのトークンの対象となるクライアントを一意に表し、なおかつ簡単には推測できないものにする必要があります。アクセス トークンには、トークンの有効期限（通常はトークンを発行してから 1 時間）も記録します。更新トークンに有効期限はありません。
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 を使用してアクセス トークンを生成します。これらのトークンには任意の文字列値を使用できますが、ユーザーとそのトークンの対象となるクライアントを一意に表し、なおかつ簡単には推測できないものにする必要があります。アクセス トークンには、トークンの有効期限（通常はトークンを発行してから 1 時間）も記録します。
5. HTTPS レスポンスの本文で次の JSON オブジェクトを返します。

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

userinfo リクエストを処理する

userinfo エンドポイントは、OAuth 2.0 で保護されたリソースで、リンクされたユーザーに関するクレームを返します。userinfo エンドポイントの実装とホストは任意ですが、以下のユースケースを除きます。

• Google One タップによるリンクされたアカウントへのログイン。
• 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 Unauthorized またはその他の失敗したエラー レスポンスが返された場合、そのエラーは修復不能となり、取得したトークンは破棄されるため、ユーザーはリンク処理をやり直す必要があります。

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	省略可: ユーザーのプロフィール写真。