このページは Cloud Translation API によって翻訳されました。

帯域外（OOB）フロー移行ガイド

概要

2022 年 2 月 16 日に、より安全な OAuth フローを使用して Google OAuth の操作をより安全にする計画を発表しました。このガイドでは、OAuth の帯域外（OOB）フローからサポートされている代替フローに正常に移行するために必要な変更と手順について説明します。

この取り組みは、Google の OAuth 2.0 認可エンドポイントとのやり取り中のフィッシング攻撃やアプリのなりすまし攻撃から保護するための対策です。

OOB とは

OAuth の帯域外（OOB）（手動コピー/貼り付けオプションとも呼ばれます）は、ユーザーが OAuth 同意リクエストを承認した後に認証情報を受け入れるリダイレクト URI を持たないネイティブクライアントをサポートするために開発されたレガシーフローです。OOB フローはリモートフィッシングのリスクをもたらすため、クライアントはこの脆弱性から保護するために別の方法に移行する必要があります。

ウェブアプリケーション、Android、iOS、Universal Windows Platform（UWP）、Chrome アプリ、テレビ、入力制限のあるデバイス、デスクトップアプリなど、すべての種類のクライアントで OOB フローが非推奨になります。

主なコンプライアンス期間

2022 年 2 月 28 日 - OOB フローでの新しい OAuth の使用のブロック
2022 年 9 月 5 日 - ポリシーに準拠していない OAuth リクエストに対して、ユーザー向けの警告メッセージが表示される場合がある
2022 年 10 月 3 日 - 2022 年 2 月 28 日より前に作成された OAuth クライアントに対する OOB フローのサポートを終了
2023 年 1 月 31 日 - 既存のすべてのクライアントがブロックされる（除外されたクライアントを含む）

準拠していないリクエストについては、ユーザー向けのエラーメッセージが表示されます。このメッセージは、アプリがブロックされていることをユーザーに伝えると同時に、Google API Console の OAuth 同意画面で登録したサポートメールを表示します。

移行プロセスを完了するには、主に次の 2 つの手順を行います。

ご自身に影響があるかどうかを判断します。
影響を受ける場合は、より安全な代替手段に移行してください。

影響を受けるかどうかを判断する

このサポート終了は、製品版アプリ（公開ステータスが [ 製品版] に設定されているアプリ）にのみ適用されます。このフローは、テスト公開ステータスのアプリでも引き続き機能します。

Google API Console の OAuth Consent Screen pageで公開ステータスを確認し、公開ステータスが「製品版」のプロジェクトで OOB フローを使用している場合は次のステップに進みます。

アプリが OOB フローを使用しているかどうかを確認する方法

アプリコードまたは送信ネットワーク呼び出し（アプリが OAuth ライブラリを使用している場合）を検査して、アプリが行う Google OAuth 認証リクエストが OOB リダイレクト URI 値を使用しているかどうかを確認します。

アプリケーションコードを検査する

Google OAuth 認可エンドポイントを呼び出すアプリケーションコードのセクションを確認し、redirect_uri パラメータが次のいずれかの値になっているか確認します。

redirect_uri=urn:ietf:wg:oauth:2.0:oob
redirect_uri=urn:ietf:wg:oauth:2.0:oob:auto
redirect_uri=oob

OOB リダイレクトフローリクエストの例を以下に示します。

https://accounts.google.com/o/oauth2/v2/auth?
response_type=code&
scope=<SCOPES>&
state=<STATE>&
redirect_uri=urn:ietf:wg:oauth:2.0:oob&
client_id=<CLIENT_ID>

注: アプリケーション構成ファイル（.env ファイルなど）も確認する必要があります。通常、redirect_uri 値は、アプリケーションが実行されている環境に応じて異なる値に設定されるためです。

発信ネットワーク呼び出しの検査

ネットワーク呼び出しを検査する方法は、アプリのクライアントのタイプによって異なります。

ウェブアプリケーション - Chrome でのネットワークアクティビティを調査
Android - Network Inspector を使用してネットワークトラフィックを検査する
Chrome アプリ
- Chrome 拡張機能のページに移動します。
- 拡張機能ページの右上にある [デベロッパーモード] チェックボックスをオンにします。
- モニタリングする拡張機能を選択する
- 拡張機能ページの [Inspect view] セクションにある [バックグラウンドページ] リンクをクリックします。
- デベロッパーツールのポップアップが開き、 [Network] タブでネットワークトラフィックをモニタリングできます。
iOS - Instruments を使用した HTTP トラフィックの分析
Universal Windows Platform（UWP） - Visual Studio でネットワークトラフィックを検査する
デスクトップアプリ - 開発対象のオペレーティングシステムで利用可能なネットワークキャプチャツールを使用する

ネットワーク呼び出しの検査中に、Google OAuth 認可エンドポイントに送信されたリクエストを探し、redirect_uri パラメータが次のいずれかの値となっているかどうかを確認します。

redirect_uri=urn:ietf:wg:oauth:2.0:oob
redirect_uri=urn:ietf:wg:oauth:2.0:oob:auto
redirect_uri=oob

OOB リダイレクトフローリクエストの例を以下に示します。

https://accounts.google.com/o/oauth2/v2/auth?
response_type=code&
scope=<SCOPES>&
state=<STATE>&
redirect_uri=urn:ietf:wg:oauth:2.0:oob&
client_id=<CLIENT_ID>

安全な代替サービスに移行する

モバイルクライアント（Android / iOS）

アプリが Android または iOS の OAuth クライアントタイプで OOB フローを使用していると判断した場合は、Google ログインモバイル SDK（Android、iOS）を使用するように移行する必要があります。

この SDK により、Google API に簡単にアクセスでき、Google の OAuth 2.0 認可エンドポイントへのすべての呼び出しが処理されます。

以下のドキュメントリンクでは、Google ログイン SDK を使用して、OOB リダイレクト URI を使用せずに Google API にアクセスする方法について説明しています。

Android で Google API にアクセスする

サーバーサイド（オフライン）アクセス

次の例は、Android のサーバー側から Google API にアクセスする方法を示しています。

Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data);
try {
  GoogleSignInAccount account = task.getResult(ApiException.class);
  
  // request a one-time authorization code that your server exchanges for an
  // access token and sometimes refresh token
  String authCode = account.getServerAuthCode();
  
  // Show signed-in UI
  updateUI(account);

  // TODO(developer): send code to server and exchange for access/refresh/ID tokens
} catch (ApiException e) {
  Log.w(TAG, "Sign-in failed", e);
  updateUI(null);
}

サーバー側から Google API にアクセスする方法については、サーバー側のアクセスガイドをご覧ください。

iOS アプリで Google API にアクセスする

クライアントサイドアクセス

次の例は、iOS のクライアント側で Google API にアクセスする方法を示しています。

user.authentication.do { authentication, error in
  guard error == nil else { return }
  guard let authentication = authentication else { return }
  
  // Get the access token to attach it to a REST or gRPC request.
  let accessToken = authentication.accessToken
  
  // Or, get an object that conforms to GTMFetcherAuthorizationProtocol for
  // use with GTMAppAuth and the Google APIs client library.
  let authorizer = authentication.fetcherAuthorizer()
}

アクセストークンを使用して API を呼び出すには、アクセストークンを REST または gRPC リクエストのヘッダーに含めるか（Authorization: Bearer ACCESS_TOKEN）、フェッチャー承認ツール（GTMFetcherAuthorizationProtocol）と Objective-C for REST 用 Google API クライアントライブラリを使用します。

クライアントサイドで Google API にアクセスする方法については、クライアントサイドアクセスガイドをご覧ください。クライアント側で Google API にアクセスする方法も学びました。

サーバーサイド（オフライン）アクセス

以下の例は、サーバー側で Google API にアクセスして iOS クライアントをサポートする方法を示しています。

GIDSignIn.sharedInstance.signIn(with: signInConfig, presenting: self) { user, error in
  guard error == nil else { return }
  guard let user = user else { return }
  
  // request a one-time authorization code that your server exchanges for
  // an access token and refresh token
  let authCode = user.serverAuthCode
}

サーバー側から Google API にアクセスする方法については、サーバー側のアクセスガイドをご覧ください。

Chrome アプリクライアント

アプリが Chrome アプリクライアントの OOB フローを使用していると判断した場合は、 Chrome Identity API を使用するよう移行する必要があります。

次の例は、OOB リダイレクト URI を使用せずにすべてのユーザーの連絡先を取得する方法を示しています。

window.onload = function() {
  document.querySelector('button').addEventListener('click', function() {

  
  // retrieve access token
  chrome.identity.getAuthToken({interactive: true}, function(token) {
  
  // ..........


  // the example below shows how to use a retrieved access token with an appropriate scope
  // to call the Google People API contactGroups.get endpoint

  fetch(
    'https://people.googleapis.com/v1/contactGroups/all?maxMembers=20&key=API_KEY',
    init)
    .then((response) => response.json())
    .then(function(data) {
      console.log(data)
    });
   });
 });
};

Chrome Identity API を使用してユーザー認証にアクセスし、Google エンドポイントを呼び出す方法については、 Chrome Identity API ガイドをご覧ください。

ウェブアプリケーション

アプリがウェブアプリケーションの OOB フローを使用していると判断した場合は、Google API クライアントライブラリのいずれかを使用するよう移行する必要があります。各種プログラミング言語のクライアントライブラリについては、こちらをご覧ください。

このライブラリにより、Google API に簡単にアクセスして、Google エンドポイントへのすべての呼び出しを処理できるようになります。

サーバーサイド（オフライン）アクセス

サーバーサイド（オフライン）アクセスモードでは、次のことを行う必要があります。

サーバーを起動し、一般公開エンドポイント（リダイレクト URI）を定義して認可コードを受信します。
Google API Consoleの Credentials page でリダイレクト URI を構成します。

次のコードスニペットは、Google Drive API を使用して、OOB リダイレクト URI を使用せずにサーバー側でユーザーの Google ドライブファイルを一覧表示する NodeJS の例を示しています。

async function main() {
  const server = http.createServer(async function (req, res) {

  if (req.url.startsWith('/oauth2callback')) {
    let q = url.parse(req.url, true).query;

    if (q.error) {
      console.log('Error:' + q.error);
    } else {
      
      // Get access and refresh tokens (if access_type is offline)
      let { tokens } = await oauth2Client.getToken(q.code);
      oauth2Client.setCredentials(tokens);

      // Example of using Google Drive API to list filenames in user's Drive.
      const drive = google.drive('v3');
      drive.files.list({
        auth: oauth2Client,
        pageSize: 10,
        fields: 'nextPageToken, files(id, name)',
      }, (err1, res1) => {
        // TODO(developer): Handle response / error.
      });
    }
  }
}

サーバーサイドから Google API にアクセスする方法については、サーバーサイドウェブアプリのガイドをご覧ください。

クライアントサイドアクセス

以下の JavaScript のコードスニペットは、Google API を使用してクライアント側でユーザーのカレンダーの予定にアクセスする例を示しています。


// initTokenClient() initializes a new token client with your
// web app's client ID and the scope you need access to

const client = google.accounts.oauth2.initTokenClient({
  client_id: 'YOUR_GOOGLE_CLIENT_ID',
  scope: 'https://www.googleapis.com/auth/calendar.readonly',
  
  // callback function to handle the token response
  callback: (tokenResponse) => {
    if (tokenResponse && tokenResponse.access_token) { 
      gapi.client.setApiKey('YOUR_API_KEY');
      gapi.client.load('calendar', 'v3', listUpcomingEvents);
    }
  },
});

function listUpcomingEvents() {
  gapi.client.calendar.events.list(...);
}

クライアントサイドから Google API にアクセスする方法については、クライアントサイドウェブアプリのガイドをご覧ください。

デスクトップクライアント

アプリがデスクトップクライアントで OOB フローを使用していると判断した場合は、ループバック IP アドレス（localhost または 127.0.0.1）フローを使用するよう移行する必要があります。

帯域外（OOB）フロー移行ガイド

概要

OOB とは

主なコンプライアンス期間

影響を受けるかどうかを判断する

アプリが OOB フローを使用しているかどうかを確認する方法

アプリケーション コードを検査する

発信ネットワーク呼び出しの検査

安全な代替サービスに移行する

モバイル クライアント（Android / iOS）

Android で Google API にアクセスする

サーバーサイド（オフライン）アクセス

iOS アプリで Google API にアクセスする

クライアントサイド アクセス

サーバーサイド（オフライン）アクセス

Chrome アプリ クライアント

ウェブ アプリケーション

サーバーサイド（オフライン）アクセス

クライアントサイド アクセス

デスクトップ クライアント

アプリケーションコードを検査する

モバイルクライアント（Android / iOS）

クライアントサイドアクセス

Chrome アプリクライアント

ウェブアプリケーション

クライアントサイドアクセス

デスクトップクライアント