JSON ウェブトークンを発行する

このドキュメントでは、ウェブベースおよびモバイルベースのアプリが Fleet Engine データにアクセスできるようにする際に、JSON ウェブトークンを発行する方法について説明します。まだお読みでない場合は、JSON ウェブトークンをFleet Engine のセキュリティセクションでご覧ください。Fleet Engine サービスでは、次のいずれかの方法で JWT を発行できます。

  • 認可ライブラリを使用する—コードベースが Java で記述されている場合は、この方法を使用することをおすすめします。このライブラリは、サービスで必要となる可能性のあるすべてのユースケース シナリオの JWT の発行を処理し、実装を大幅に簡素化します。
  • 独自の JWT を作成する—JWT ライブラリを使用できない場合は、 独自のコードベースに組み込む必要があります。このセクションでは、シナリオごとに JWT のさまざまな例を示します。

JWT の仕組み

モバイル デバイスやウェブブラウザなど、信頼できない環境の場合、バックエンド サーバーは次のように機能する JWT を発行します。

  • 信頼度の低い環境で実行されているクライアント コードは、完全に信頼できる環境で実行されているサーバー コードを呼び出して、Fleet Engine に渡す適切な JWT をリクエストします。

  • JWT はサービス アカウントに関連付けられているため、Fleet Engine に送信されるリクエストは、JWT に署名したサービス アカウントに暗黙的に関連付けられます。

  • JWT クレームは、クライアントが操作できるリソース（特定の車両、移動、タスクなど）をさらに制限します。

Java 用認可ライブラリを使用する

Java 用 Fleet Engine 認可ライブラリを使用するには、GitHub リポジトリにアクセスしてください。このライブラリを使用すると、Fleet Engine JWT の作成が簡素化され、安全に署名されます。次の機能が用意されています。

  • プロジェクトの依存関係の宣言
  • オンデマンドの移動またはスケジュール設定されたタスクのすべてのサービス アカウント ロールの完全なリスト
  • 認証情報ファイルを使用する以外のトークン署名メカニズム（サービス アカウントの権限借用など）
  • gRPC スタブまたは Google API Codegen（GAPIC）クライアント ライブラリから送信されるアウトバウンド リクエストに署名付きトークンを添付する
  • 署名者を Fleet Engine クライアント ライブラリと統合する手順

コードから JWT を発行する場合

Java 用認可ライブラリを使用できない場合は、独自のコードベースに JWT を実装する必要があります。このセクションでは、独自のトークンを作成するためのガイドラインをいくつか示します。JWT フィールドとクレームのリストについては、Fleet Engine のセキュリティ セクションの JSON ウェブトークンをご覧ください。Fleet Engine で使用されるサービス アカウント ロールについては、サービス アカウント ロールをご覧ください。オンデマンドの移動またはスケジュール設定されたタスクの JWT の例については、次のセクションをご覧ください。

一般的なガイドライン

  • 適切なサービス アカウントとロールを使用する 。サービス アカウントと関連付けられたロールにより、トークンをリクエストするユーザーが、トークンによってアクセス権が付与される情報を表示する権限を持っていることが保証されます。詳細は以下のとおりです。
    • モバイル デバイスに渡す JWT に署名する場合 は、Driver SDK または Consumer SDK ロールのサービス アカウントを使用します。そうしないと、モバイル デバイスがアクセス権のないデータを変更してアクセスする可能性があります。
    • 特権呼び出しに使用する JWT に署名する場合は、ADC または JWT を使用するときに、正しい Fleet Engine 管理者ロールを持つサービス アカウントを使用します。 そうしないと、オペレーションは失敗します。
  • 作成したトークンのみを共有する 。トークンの作成に使用した認証情報を共有しないでください。
  • gRPC 呼び出しの場合、トークンを添付するメカニズムは、呼び出しに使用する 言語とフレームワークによって異なります。HTTP 呼び出しにトークンを指定するメカニズムは、値がトークンの署名なしトークンを含む Authorization ヘッダーを含めることです。
  • 有効期限を返す。サーバーは、トークンの有効期限（通常は秒単位）を返す必要があります。
  • OAuth 2.0 アクセス トークンを使用するのではなく、JSON をトークン署名なしトークンとして直接作成して署名する必要がある場合は、Identity デベロッパー ドキュメントのOAuth を使用しないサービス アカウントの認可の手順をご覧ください。

オンデマンドの移動の場合

  • JWT ペイロードを作成するときに、呼び出しが行われる車両 ID または移動 ID の値に設定されたキー vehicleid または tripid を使用して、認可セクションに追加のクレームを追加します。

スケジュール設定されたタスクの場合

  • サーバーが他の API を呼び出す場合、トークンには適切なクレームも含まれている必要があります。これを行うには、次の操作を行います。
    • 各キーの値を * に設定します。
    • ユーザーにすべての taskids と deliveryvehicleids へのアクセス権を付与します。これを行うには、キー taskid と deliveryvehicleid を使用して、認可セクションに追加のクレームを追加します。
    • taskids クレームでアスタリスク（*）を使用する場合は、配列内の唯一の要素にする必要があります。

オンデマンドの移動の JWT の例

このセクションでは、オンデマンドの移動を使用する場合の一般的なシナリオの JWT の例を示します。

ドライバー アプリのオペレーションのトークンの例

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_driver_service_account"
}
.
{
  "iss": "driver@yourgcpproject.iam.gserviceaccount.com",
  "sub": "driver@yourgcpproject.iam.gserviceaccount.com",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "authorization": {
     "vehicleid": "driver_12345"
   }
}

コンシューマー アプリのオペレーションのトークンの例

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_consumer_service_account"
}
.
{
  "iss": "consumer@yourgcpproject.iam.gserviceaccount.com",
  "sub": "consumer@yourgcpproject.iam.gserviceaccount.com",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "authorization": {
     "tripid": "trip_54321"
   }
}

スケジュール設定されたタスクの JWT の例

このセクションでは、スケジュール設定されたタスクを使用する場合の一般的なシナリオの JWT の例を示します。

ドライバー アプリのトークンの例

    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "private_key_id_of_delivery_driver_service_account"
    }
    .
    {
      "iss": "driver@yourgcpproject.iam.gserviceaccount.com",
      "sub": "driver@yourgcpproject.iam.gserviceaccount.com",
      "aud": "https://fleetengine.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600,
      "authorization": {
         "deliveryvehicleid": "driver_12345"
       }
    }

コンシューマー アプリのトークンの例

    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "private_key_id_of_delivery_consumer_service_account"
    }
    .
    {
      "iss": "consumer@yourgcpproject.iam.gserviceaccount.com",
      "sub": "consumer@yourgcpproject.iam.gserviceaccount.com",
      "aud": "https://fleetengine.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600,
      "authorization": {
         "trackingid": "shipment_12345"
       }
    }

フリート オペレーションの JWT の例

このセクションでは、フリート オペレーションの一般的なシナリオの JWT の例を示します。

フリート内のすべてのタスクと車両を追跡するトークンの例

次の例は、オペレーターが使用するウェブベースのアプリからフリート内のすべてのタスクと車両を追跡するトークンです。これらのオペレーションに必要な権限は、クライアント アプリケーションよりも大きくなります。このトークンを使用するクライアント側の 実装については、 JavaScript Fleet Tracking ライブラリを設定するをご覧ください。

  • Fleet Engine Delivery Fleet Reader Cloud IAM ロールを使用してトークンに署名します。

   {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "private_key_id_of_consumer_service_account"
    }
    .
    {
      "iss": "superuser@yourgcpproject.iam.gserviceaccount.com",
      "sub": "superuser@yourgcpproject.iam.gserviceaccount.com",
      "aud": "https://fleetengine.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600,
      "scope": "https://www.googleapis.com/auth/xapi",
      "authorization": {
         "taskid": "*",
         "deliveryvehicleid": "*",
       }
    }

バックエンド サーバー オペレーションの代替認証方法

バックエンド サーバー オペレーションの認証には ADC を使用することをおすすめします。ADC を使用できず、JWT を使用する必要がある場合は、次の例を参照してください。

オンデマンドのバックエンド サーバー オペレーションのトークンの例

  {
    "alg": "RS256",
    "typ": "JWT",
    "kid": "private_key_id_of_provider_service_account"
  }

  {
    "iss": "provider@yourgcpproject.iam.gserviceaccount.com",
    "sub": "provider@yourgcpproject.iam.gserviceaccount.com",
    "aud": "https://fleetengine.googleapis.com/",
    "iat": 1511900000,
    "exp": 1511903600,
    "authorization": {
       "vehicleid": "*",
       "tripid": "*"
     }
  }

スケジュール設定されたバックエンド サーバー オペレーションのトークンの例

    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "private_key_id_of_provider_service_account"
    }
    .
    {
      "iss": "provider@yourgcpproject.iam.gserviceaccount.com",
      "sub": "provider@yourgcpproject.iam.gserviceaccount.com",
      "aud": "https://fleetengine.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600,
      "authorization": {
         "taskid": "*"
       }
    }

スケジュール設定されたバックエンド サーバーのタスクの一括作成オペレーションのトークンの例

    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "private_key_id_of_provider_service_account"
    }
    .
    {
      "iss": "provider@yourgcpproject.iam.gserviceaccount.com",
      "sub": "provider@yourgcpproject.iam.gserviceaccount.com",
      "aud": "https://fleetengine.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600,
      "authorization": {
         "taskids": ["*"]
       }
    }

スケジュール設定されたバックエンド サーバーの配送車両ごとのオペレーションのトークンの例

    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "private_key_id_of_provider_service_account"
    }
    .
    {
      "iss": "provider@yourgcpproject.iam.gserviceaccount.com",
      "sub": "provider@yourgcpproject.iam.gserviceaccount.com",
      "aud": "https://fleetengine.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600,
      "authorization": {
         "deliveryvehicleid": "*"
       }
    }

次のステップ

  • 設定を確認して、テスト車両を作成し、 トークンが意図したとおりに動作することを確認する
  • バックエンド サーバー オペレーションに JWT の代わりに ADC を使用する方法については、 セキュリティの概要をご覧ください。