OAuth 2.0 サーバーを実装する

すべての smart home アクションには、ユーザーを認証するメカニズムを含める必要があります。

認証によって、ユーザーの Google アカウントを認証システムのユーザー アカウントにリンクできます。これにより、フルフィルメントがスマートホーム インテントを受け取ったときにユーザーを識別できます。Google スマートホームは、認証コードフローを使用した OAuth のみをサポートしています。

このページでは、smart home アクションと連携するように OAuth 2.0 サーバーを設定する方法について説明します。

OAuth を使用した Google アカウントのリンク

認可コードフローでは、次の 2 つのエンドポイントが必要です。

• 認可エンドポイント。まだログインしていないユーザーにログイン UI を表示します。認可エンドポイントは、リクエストされたアクセスに対するユーザーの同意を記録する有効期間の短い認可コードも作成します。

• トークン交換エンドポイント。次の 2 種類の交換を処理します。

  1. 長期の更新トークンと短期のアクセス トークンの認可コードを交換します。この交換は、ユーザーがアカウント リンクのフローを完了したときに行われます。
  2. 有効期間の長い更新トークンを有効期間の短いアクセス トークンと交換します。この交換は、アクセス トークンの有効期限が切れたために Google が新しいアクセス トークンを必要とする場合に発生します。

設計ガイドライン

このセクションでは、OAuth リンクフロー向けにホストするユーザー画面の設計要件と推奨事項について説明します。Google のアプリから呼び出されると、プラットフォームは Google へのログインページとアカウントのリンクの同意画面をユーザーに表示します。ユーザーがアカウントのリンクに同意すると、Google のアプリに戻ります。

要件

1. ユーザーのアカウントが、Google Home や Google アシスタントなどの特定の Google サービスではなく Google にリンクされることを伝える必要があります。
2. 「ログインすることで、Google によるデバイスの管理を承認したことになります」といった Google の文言が必要です。詳しくは、Google Home デベロッパー ポリシーの Google Device Control の承認をご覧ください。
3. ユーザーがリンクをしなかった場合は、戻るまたはキャンセルできる方法を提供する必要があります。
4. ウェブ OAuth リンクページを開いて、ユーザーが明確な方法（ユーザー名とパスワードのフィールドなど）で Google アカウントにログインできることを確認する必要があります。[ウェブ OAuth リンク] ページに移動せずにユーザーがリンクできる Google ログイン（GSI）メソッドは使用しないでください。このような行為は Google ポリシー違反に該当します。

推奨事項

次の手順を行うことをおすすめします。

1. Google のプライバシー ポリシーを表示します。同意画面に Google のプライバシー ポリシーへのリンクを含めます。

2. 共有されるデータ。明確で簡潔な表現を使用して、Google が必要とするデータとその理由をユーザーに伝えます。

3. 行動を促す明確なフレーズ。同意画面には、「同意してリンクする」など、行動を促す明確なフレーズを明記します。これは、アカウントをリンクするために Google と共有する必要があるデータをユーザーが理解する必要があるためです。

4. リンク解除できます。プラットフォーム上のアカウント設定への URL など、ユーザーがリンクを解除するためのメカニズムを提供します。また、リンクされたアカウントを管理できる Google アカウントへのリンクを含めることもできます。

5. ユーザー アカウントを変更できます。ユーザーがアカウントを切り替える方法を提案する。これは、ユーザーが複数のアカウントを持つ傾向がある場合に特に便利です。

   • ユーザーがアカウントを切り替えるために同意画面を閉じる必要がある場合は、回復可能なエラーを Google に送信します。これにより、ユーザーは OAuth リンクを使用して目的のアカウントにログインできます。

6. ロゴを含める。同意画面に会社のロゴを表示する。 スタイル ガイドラインに沿ってロゴを配置します。Google のロゴも表示する場合は、ロゴと商標をご覧ください。

認可コードフロー

認証コードフローの OAuth 2.0 サーバー実装は 2 つのエンドポイントで構成され、サービスは HTTPS で利用可能です。最初のエンドポイントは承認エンドポイントです。このエンドポイントは、データアクセスについて、ユーザーに対する同意を取得または取得します。認可エンドポイントは、まだログインしていないユーザーにログイン UI を表示し、リクエストされたアクセスへの同意を記録します。2 つ目のエンドポイントはトークン交換エンドポイントです。トークンは、ユーザーがサービスにアクセスすることを承認する暗号化された文字列（トークン）を取得するために使用されます。

Google アプリケーションがサービスの API の 1 つを呼び出す必要がある場合、Google はこれらのエンドポイントを一緒に使用して、ユーザーに代わってユーザーにこれらの API を呼び出す権限を与えます。

Google によって開始される OAuth 2.0 認証コードフローのセッションは、次のようなフローになります。

1. Google がユーザーのブラウザで認可エンドポイントを開きます。アクションの音声操作専用デバイスでフローが開始された場合、Google は実行をスマートフォンに転送します。
2. ユーザーが（まだログインしていない場合は）ログインし、API を使用してデータにアクセスする権限を Google に付与します（権限がまだ付与されていない場合）。
3. サービスにより認証コードが作成され、Google に返されます。これを行うには、リクエストに添付された認証コードを使用して、ユーザーのブラウザを Google にリダイレクトします。
4. Google が認証コードをトークン交換エンドポイントに送信します。トークン交換エンドポイントはコードの信頼性を検証し、アクセス トークンと更新トークンを返します。アクセス トークンは有効期間が短いトークンで、API にアクセスするための認証情報として承認されます。更新トークンは有効期間の長いトークンです。トークンを保管すると、有効期限が切れたときに新しいアクセス トークンを取得するために使用できます。
5. ユーザーがアカウント リンクのフローを完了すると、それ以降に Google から送信されるすべてのリクエストにアクセス トークンが含まれるようになります。

認可リクエストの処理

OAuth 2.0 認証コードフローを使用してアカウントのリンクを行う必要がある場合、Google は以下のパラメータを含むリクエストによってユーザーを認証エンドポイントに送信します。

認可エンドポイントのパラメータ
client_id	Google に割り当てられたクライアント ID。
redirect_uri	このリクエストに対するレスポンスを送信する宛先 URL。
state	リダイレクト URL で変更されずに Google に返される会計上の値。
scope	省略可: Google が承認をリクエストするデータを指定するためのスコープ文字列のセット。スペースで区切ります。
response_type	レスポンスで返される値のタイプ。OAuth 2.0 認証コードフローの場合、レスポンス タイプは常に code です。
user_locale	Google アカウントの言語設定（RFC5646 形式）。ユーザーの好みの言語にコンテンツをローカライズするために使用されます。

たとえば、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&user_locale=LOCALE

認証エンドポイントがログイン リクエストを処理するには、次の手順を行います。

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 パラメータを追加して、生成した認証コードと元の変更されていない状態値を含めます。結果の URL の例を次に示します。

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

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

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

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

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

トークン交換エンドポイントのパラメータ
client_id	リクエスト元を Google として識別する文字列。この文字列は、Google の一意の識別子としてシステムに登録されている必要があります。
client_secret	Google に登録したサービスのシークレット文字列。
grant_type	交換されるトークンの種類。authorization_code または refresh_token のいずれかです。
code	grant_type=authorization_code の場合、このパラメータは、Google がログイン エンドポイントまたはトークン交換エンドポイントから受け取ったコードです。
redirect_uri	grant_type=authorization_code の場合、このパラメータは最初の承認リクエストで使用される URL です。
refresh_token	grant_type=refresh_token の場合、このパラメータは、Google がトークン交換エンドポイントから受け取った更新トークンです。

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

ユーザーがログインし、認証エンドポイントから有効期間の短い認証コードが 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. 上記の条件をすべて確認できない場合は、本文に {"error": "invalid_grant"} を含む HTTP 400 Bad Request エラーを返します。
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. 上記の条件をすべて確認できない場合は、{"error": "invalid_grant"} を本文とする HTTP 400 Bad Request エラーを返します。
4. それ以外の場合は、更新トークンのユーザー ID を使用してアクセス トークンを生成します。これらのトークンには任意の文字列値を使用できますが、ユーザーとトークンの対象となるユーザーを一意に表すことができ、推測可能なものであってはなりません。アクセス トークンの場合は、トークンの有効期限（通常はトークンの発行後 1 時間）も記録します。
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.

userinfo endpoint request headers
Authorization header	The access token of type Bearer.

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.