PingFederate を使用して Workforce Identity 連携を構成する

このドキュメントでは、PingFederate ID プロバイダ(IdP)を使用して Workforce Identity 連携を構成し、Google Cloudへのアクセスを管理する方法について説明します。PingFederate IdP を構成すると、連携ユーザーは SAML 2.0 プロトコルを使用して、Workforce Identity 連携をサポートする Google Cloud サービスにアクセスできるようになります。

始める前に

  1. Google Cloud 組織を設定していることを確認します。
  2. Google Cloud CLI をインストールします。インストール後、次のコマンドを実行して Google Cloud CLI を初期化します。

    gcloud init

    外部 ID プロバイダ(IdP)を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

  3. ログインの場合、IdP は署名付き認証情報を提供する必要があります。SAML IdP レスポンスは署名されている必要があります。
  4. 組織またはGoogle Cloud プロダクトの変更に関する重要な情報を受け取るには、重要な連絡先を指定する必要があります。詳細については、Workforce Identity 連携の概要をご覧ください。

費用

Workforce Identity 連携は、無料の機能として利用できます。ただし、Workforce Identity 連携の詳細な監査ロギングでは Cloud Logging が使用されます。Logging の料金については、Google Cloud Observability の料金をご覧ください。

必要なロール

Workforce Identity 連携の構成に必要な権限を取得するには、組織に対する IAM Workforce プール管理者 roles/iam.workforcePoolAdmin)の IAM ロールを付与するように管理者に依頼します。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

本番環境ではなく、開発環境またはテスト環境で権限を構成する場合は、IAM オーナー(roles/owner)の基本ロールを付与できます。このロールには、Workforce Identity 連携の権限も含まれています。

Workforce Identity プールを作成する

gcloud

Workforce Identity プールを作成するには、次のコマンドを実行します。

gcloud iam workforce-pools create WORKFORCE_POOL_ID \
    --organization=ORGANIZATION_ID \
    --display-name="DISPLAY_NAME" \
    --description="DESCRIPTION" \
    --session-duration=SESSION_DURATION \
    --location=global

次のように置き換えます。

  • WORKFORCE_POOL_ID: Google Cloud Workforce プールを表す ID。プール ID は、 Google Cloud内のすべての Workforce Identity プールでグローバルに一意である必要があります。ID の形式については、API ドキュメントのクエリ パラメータ セクションをご覧ください。
  • ORGANIZATION_ID: Workforce Identity プールの Google Cloud 組織の組織 ID。Workforce Identity プールは、組織内のすべてのプロジェクトとフォルダで使用できます。
  • DISPLAY_NAME: 省略可。Workforce Identity プールの表示名。
  • DESCRIPTION: 省略可。Workforce Identity プールの説明。
  • SESSION_DURATION: 省略可。セッション継続時間。s を付加した数値で表します(例: 3600s)。セッション継続時間は、この Workforce プールの Google Cloud アクセス トークン、コンソール(連携)ログイン セッション、gcloud CLI ログイン セッションの有効期間を決定します。セッション継続時間のデフォルトは 1 時間(3,600 秒)です。セッション継続時間は 15 分(900 秒)~12 時間(43,200 秒)の範囲で指定する必要があります。

コンソール

Workforce Identity プールを作成するには、次の操作を行います。

  1. Google Cloud コンソールで、[Workforce Identity プール] ページに移動します。

    [Workforce Identity プール] に移動

  2. Workforce Identity プールの組織を選択します。Workforce Identity プールは、組織内のすべてのプロジェクトとフォルダで使用できます。

  3. [プールを作成] をクリックして、次の操作を行います。

    1. [名前] フィールドに、プールの表示名を入力します。プール ID は、入力した名前から自動的に取得され、[名前] フィールドの下に表示されます。プール ID を更新するには、プール ID の横にある [編集] をクリックします。

    2. 省略可: [説明] にプールの説明を入力します。

    3. Workforce Identity プールを作成するには、[次へ] をクリックします。

Workforce Identity プールのセッション継続時間は、デフォルトで 1 時間(3,600 秒)に設定されます。セッション継続時間は、この Workforce プールの Google Cloud アクセス トークン、コンソール(連携)、gcloud CLI ログイン セッションの有効期間を決定します。プールを作成したら、プールを更新してカスタムのセッション継続時間を設定できます。セッション継続時間は 15 分(900 秒)から 12 時間(43,200 秒)にする必要があります。

PingFederate アプリケーションを作成する

このセクションでは、PingFederate アプリケーション統合を作成する方法について説明します。

SAML 2.0 プロトコルを使用する PingFederate アプリケーションを設定するには、PingFederate で次の操作を行います。

  1. PingFederate IdP の SAML 2.0 エンティティ ID を設定します。詳細については、連携情報の指定をご覧ください。
  2. SAML 2.0 SP 接続を作成します。SP 接続タイプの選択を参照して、次の操作を行います。

    1. [Connection Type] で、[Browser SSO Profiles] と [SAML 2.0 protocol] を選択します。
    2. [メタデータをインポート] で [なし] を選択します。
  3. [General Info] で、[Partner's Entity ID (Connection ID)] を次のように設定します。

    https://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
    
  4. [SAML Profiles] で、[SP-initiated SSO] を有効にします。IdP で開始されたシングル サインオン(SSO)も使用する場合は、有効にすることもできます。

  5. [Attribute Contract] で、アサーションで渡されるカスタム属性(メールやグループなど)を定義します。これらの属性は、後で Google Cloud でアクセス管理ポリシーを作成するために使用できます。

  6. [Attribute Contract Fulfillment] で、SAML_SUBJECT がユーザーごとに一意の値を持つフィールドにマッピングされていることを確認します。たとえば、メールアドレスは通常、ユーザーごとに一意であり、変更されません。また、 Google Cloud アクセス管理ポリシーで特定のユーザーを参照するためによく使用されます。

  7. コンソール(連携)ログインを設定するには、[Assertion Consumer Service URL] に次のエンドポイント URL を追加します。

    https://auth.cloud.google/signin-callback/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
    

    次のように置き換えます。

    • WORKFORCE_POOL_ID: 前に作成した Workforce プールの ID。
    • WORKFORCE_PROVIDER_ID: 後で作成する Workforce プロバイダの ID。
  8. このエンドポイントの [バインディング] を [POST] に設定します。

  9. コンソール(連携)のログインを有効にするには、[Allowable SAML Bindings] で [Redirect] を選択します。

  10. [Signature Policy] で、[Sign Response As Required] を選択します。

  11. 接続を保存して有効にします。

属性を使用する

このセクションでは、SAML アサーションの属性を使用する方法について説明します。

属性コントラクトを使用して、生成された SAML アサーションのカスタム属性を指定します。属性を構成したら、 Google Cloud でこれらの属性を使用してアクセス管理ポリシーを作成できます。属性コントラクトの詳細については、PingFederate サーバーのドキュメントの属性コントラクトをご覧ください。

たとえば、このガイドでは、PingFederate のデータストアとして PingOne を使用し、PingOne データストアのユーザー属性を使用して emailfirstNamegroups の属性コントラクトを次のようにマッピングします。

属性契約
email email
firstName name.given
groups memberOfGroupIDs

PingFederate Workforce Identity プール プロバイダを作成する

このセクションでは、IdP ユーザーが Google Cloudにアクセスできるように Workforce Identity プール プロバイダを作成する方法について説明します。SAML プロトコルを使用するようにプロバイダを構成できます。

SAML 2.0 Workforce Identity プール プロバイダを作成する

  1. SAML アプリケーションを構成する手順は次のとおりです。

    gcloud

    SAML Workforce Identity プール プロバイダを作成するには、次のコマンドを実行します。

    gcloud iam workforce-pools providers create-saml WORKFORCE_PROVIDER_ID \
        --workforce-pool="WORKFORCE_POOL_ID" \
        --display-name="DISPLAY_NAME" \
        --description="DESCRIPTION" \
        --idp-metadata-path="XML_METADATA_PATH" \
        --attribute-mapping="ATTRIBUTE_MAPPING" \
        --attribute-condition="ATTRIBUTE_CONDITION" \
        --location=global
    

    次のように置き換えます。

    • WORKFORCE_PROVIDER_ID: プロバイダ ID。
    • WORKFORCE_POOL_ID: Workforce Identity プールの ID。
    • DISPLAY_NAME: 表示名。
    • DESCRIPTION: 説明。
    • XML_METADATA_PATH: PingFederate の XML 形式のメタデータ ファイルのパス。
    • ATTRIBUTE_MAPPING: 属性マッピング。例: google.subject=assertion.subject,google.groups=assertion.attributes.groups,attribute.department=assertion.attributes.department[0]
    • ATTRIBUTE_CONDITION: オプションの属性条件。たとえば、ipaddr 属性を特定の IP 範囲に制限するには、条件を assertion.ipaddr.startsWith('98.11.12.') に設定します。

    このコマンドは、SAML アサーションの subjectgroupsdepartment を、それぞれ google.subjectgoogle.groupsattribute.department の属性に割り当てます。また、属性条件は、特定の IP 範囲内のユーザーのみがこの Workforce プロバイダを使用してログインできるようにします。

    コンソール

    Google Cloud コンソールを使用して SAML プロバイダを構成する手順は次のとおりです。

    1. Google Cloud コンソールで、[Workforce Identity プール] ページに移動します。 [Workforce Identity プール] に移動
    2. [Workforce Identity プール] テーブルで、プロバイダを作成するプールを選択します。
    3. [プロバイダ] セクションで [ プロバイダを追加] をクリックします。
    4. [プロバイダ ベンダーを選択] リストで、[汎用 ID プロバイダ] を選択します。
    5. [認証プロトコルを選択する] で、[SAML] を選択します。
    6. [プロバイダを作成する] セクションで、次の操作を行います。
      1. [名前] にプロバイダの名前を入力します。
      2. 省略可: [説明] にプロバイダの説明を入力します。
      3. [IDP メタデータ ファイル(XML)] で、PingFederate からメタデータ XML ファイルを選択します。
      4. 有効なプロバイダを作成するには、[有効なプロバイダ] がオンになっていることを確認します。
      5. [続行] をクリックします。
    7. [Share your provider information] セクションで、[Continue] をクリックします。
    8. 省略可: 詳細な監査ロギングを有効にするには、[プロバイダを構成する] セクションの [詳細なロギング] で、[属性値の監査ロギングを有効にする] 切り替えボタンをクリックします。

      Workforce Identity 連携の詳細な監査ロギングでは、IdP から受信した情報が Logging に記録されます。詳細な監査ロギングは、Workforce Identity プール プロバイダの構成のトラブルシューティングに役立ちます。詳細な監査ロギングを使用して属性マッピング エラーのトラブルシューティングを行う方法については、一般的な属性マッピング エラーをご覧ください。Logging の料金については、Google Cloud Observability の料金をご覧ください。

      Workforce Identity プール プロバイダの詳細な監査ロギングを無効にするには、プロバイダの作成時に [属性値の監査ロギングを有効にする] 切り替えボタンをオフにします。詳細な監査ロギングを無効にするには、プロバイダを更新することもできます。

    9. プロバイダを作成するには、[送信] をクリックします。

    プロバイダが作成されると、プロバイダ属性ページにリダイレクトされます。

    属性のマッピングと条件を構成する手順は次のとおりです。

    1. プロンプトが表示されたら、外部 IdP にログインしてデフォルトの属性マッピングを検証します。
    2. プロバイダの属性ページで、属性のマッピングと条件を表示して編集します。

      1. 属性のマッピングを追加または編集する手順は次のとおりです。

        1. [マッピングを追加] をクリックして新しいマッピングを追加するか、既存のマッピングを編集します。
        2. [Google n](n は数値)フィールドで、 Google Cloudでサポートされている鍵を選択します。
        3. 対応する [SAML n] フィールドに、IdP 属性名または CEL 式を入力します。例:

          google.subject=assertion.subject,
          google.groups=assertion.attributes['https://example.com/aliases'],
          attribute.costcenter=assertion.attributes.costcenter[0]
          
      2. 属性条件を追加する手順は次のとおりです。

        1. [条件を追加] をクリックします。
        2. [属性条件] フィールドに、CEL 形式で条件を入力します(例: assertion.ipaddr.startsWith('98.11.12.'))。
    3. マッピングを検証するには、[Save and refetch token] をクリックします。

    4. 設定を完了するには、[保存して終了] をクリックします。

Google Cloud リソースへのアクセスを管理する

このセクションでは、PingFederate ユーザーの Google Cloud リソースへのアクセスを管理する方法について説明します。

このガイドで使用されているサンプル プロジェクトは、Workforce Identity 連携の設定に使用したプロジェクトと異なる場合があります。

単一の ID、ID のグループ、プール全体のロールを管理できます。詳細については、許可ポリシーの Workforce プリンシパル ID をご覧ください。

マッピングされた部門属性を使用する

TEST_PROJECT_ID プロジェクトの特定の部門内のすべての ID にストレージ管理者ロール(roles/storage.admin)を付与するには、次のコマンドを実行します。

gcloud projects add-iam-policy-binding TEST_PROJECT_ID \
    --role="roles/storage.admin" \
    --member="principalSet://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/attribute.department/DEPARTMENT_VALUE"

次のように置き換えます。

  • TEST_PROJECT_ID: プロジェクト ID。
  • WORKFORCE_POOL_ID: Workforce Identity プールの ID。
  • DEPARTMENT_VALUE: マッピングされた attribute.department 値。

マッピングされたグループを使用する

TEST_PROJECT_ID プロジェクトの GROUP_ID グループ内のすべての ID にストレージ管理者ロール(roles/storage.admin)を付与するには、次のコマンドを実行します。

gcloud projects add-iam-policy-binding TEST_PROJECT_ID \
    --role="roles/storage.admin" \
    --member="principalSet://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/group/GROUP_ID"

次のように置き換えます。

  • TEST_PROJECT_ID: プロジェクト ID。
  • WORKFORCE_POOL_ID: Workforce Identity プールの ID。
  • GROUP_ID: マッピングされた google.groups クレーム内のグループ。

ログインしてアクセスをテストする

このセクションでは、Workforce Identity プールユーザーとしてログインし、アクセスをテストします。

ログイン

コンソール(連携)ログイン

Google Cloud Workforce Identity 連携コンソール(コンソール(連携))にログインするには、次の操作を行います。

  1. コンソール(連携)のログインページに移動します。

    コンソール(連携)に移動

  2. プロバイダ名を入力します。形式は次のとおりです。
    locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
  3. プロンプトが表示されたら、PingFederate の認証情報を入力します。

gcloud CLI ブラウザベースのログイン

ブラウザベースのログインフローを使用して gcloud CLI にログインするには:

次のコマンドを実行して、ログイン構成ファイルを作成します。

Linux / macOS

gcloud iam workforce-pools create-login-config \
    locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID \
    --output-file=LOGIN_CONFIG_PATH

Windows(PowerShell)

gcloud iam workforce-pools create-login-config `
    locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID `
    --output-file=LOGIN_CONFIG_PATH

次のように置き換えます。

  • WORKFORCE_POOL_ID: Workforce Identity 連携プール ID。
  • WORKFORCE_PROVIDER_ID: Workforce Identity 連携プロバイダ ID。
  • LOGIN_CONFIG_PATH: ログイン構成ファイルを書き込むパス。例: login-config.json

ログイン構成ファイルには、gcloud CLI でブラウザベースの認証フローを有効にし、Workforce Identity プール プロバイダで構成された IdP にオーディエンスを設定するために使用するエンドポイントが含まれています。ファイルに機密情報は含まれていません。

ログイン構成ファイルの内容は次のようになります。

{
  "universe_domain": "googleapis.com",
  "universe_cloud_web_domain": "cloud.google",
  "type": "external_account_authorized_user_login_config",
  "audience": "//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID",
  "auth_url": "https://auth.cloud.google/authorize",
  "token_url": "https://sts.googleapis.com/v1/oauthtoken",
  "token_info_url": "https://sts.googleapis.com/v1/introspect"
}

環境変数、アクティブな gcloud CLI 構成のプロパティを使用してログイン構成ファイルを指定するか、gcloud auth login コマンドで直接使用します。

環境変数

環境変数でログイン構成ファイルを使用するには、次の手順を行います。

  1. CLOUDSDK_AUTH_LOGIN_CONFIG_FILE 環境変数をログイン構成ファイルのパスに設定します。
  2. 次のコマンドを実行します。

    gcloud auth login
  3. gcloud CLI は、環境変数を参照してログイン構成ファイルを見つけ、認証プロセスを開始します。ブラウザベースのフローに沿って、gcloud CLI を認証し、今後のコマンドでユーザーに代わってリソースにアクセスできるように承認します。

gcloud auth login コマンドでログイン構成ファイルの使用を停止するには、CLOUDSDK_AUTH_LOGIN_CONFIG_FILE 環境変数をクリアします。

gcloud CLI の構成

gcloud CLI 構成プロパティでログイン構成ファイルを使用するには、次の手順を行います。

  1. 次のコマンドを使用して、アクティブな gcloud CLI 構成の auth/login_config_file プロパティをログイン構成ファイルのパスに設定します。

    gcloud config set auth/login_config_file LOGIN_CONFIG_PATH
  2. 次のコマンドを実行します。

    gcloud auth login
  3. gcloud CLI は、構成プロパティを参照してログイン構成ファイルを見つけ、認証プロセスを開始します。ブラウザベースのフローに沿って、gcloud CLI を認証し、今後のコマンドでユーザーに代わってリソースにアクセスできるように承認します。

gcloud auth login コマンドでログイン構成ファイルの使用を停止するには、次のコマンドを使用してプロパティの設定を解除します。

gcloud config unset auth/login_config_file

gcloud auth login

gcloud auth login コマンドでログイン構成ファイルを直接使用するには、次の手順を行います。

  • ログイン構成ファイルの作成時に --activate フラグを使用した場合は、次のコマンドを実行します。

    gcloud auth login
  • ログイン構成ファイルの作成時に --activate フラグを使用しなかった場合は、次のコマンドを実行します。

    Linux / macOS

    gcloud auth login \
        --login-config=LOGIN_CONFIG_PATH

    Windows(PowerShell)

    gcloud auth login `
        --login-config=LOGIN_CONFIG_PATH

    LOGIN_CONFIG_PATH は、ログイン構成ファイルのパスに置き換えます。

gcloud auth login コマンドは、アクセス認証情報をホーム ディレクトリに保存します。認証されたプリンシパルは、アクティブな gcloud CLI 構成のアクティブなプリンシパルになります。オーバーライドされない限り、gcloud CLI はこれらの保存された認証情報を使用して Google Cloudにアクセスします。

gcloud CLI ヘッドレス ログイン

SAML プロトコルを使用して gcloud CLI で PingFederate にログインする手順は次のとおりです。

  1. PingFederate アプリにユーザーをログインさせ、SAML レスポンスを取得します。
  2. PingFederate から返された SAML レスポンスをローカルマシンの安全な場所に保存します。パスを環境変数(SAML_ASSERTION_PATH=/path/to/assertion.xml など)に保存します。
  3. 構成ファイルを生成します。

    gcloud iam workforce-pools create-cred-config \
        locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID \
        --subject-token-type=urn:ietf:params:oauth:token-type:saml2 \
        --credential-source-file=SAML_ASSERTION_PATH \
        --workforce-pool-user-project=PROJECT_ID \
        --output-file=config.json
    

    次のように置き換えます。

    • SAML_ASSERTION_PATH: SAML アサーション ファイルのパス。
    • PROJECT_ID: プロジェクト ID。
  4. 生成される構成ファイルは次のようになります。

    {
      "type": "external_account",
      "audience": "//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID",
      "subject_token_type": "urn:ietf:params:oauth:token-type:saml2",
      "token_url": "https://sts.googleapis.com/v1/token",
      "credential_source": {
        "file": "SAML_ASSERTION_PATH"
      },
      "workforce_pool_user_project": "PROJECT_ID"
    }
    
  5. トークン交換を使用して gcloud CLI にログインするには、次のコマンドを実行します。

    gcloud auth login --cred-file=config.json
    

    次に、gcloud は、PingFederate の認証情報を一時的な Google Cloud アクセス トークンと透過的に交換して、 Google Cloudに対する他の gcloud 呼び出しを許可します。出力は次のようになります。

    Authenticated with external account user credentials for: [principal://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/subject/USER_ID].

  6. 認証されたアカウントとアクティブなアカウントを一覧表示するには、次のコマンドを実行します。

    gcloud auth list
    

アクセスをテストする

Workforce Identity 連携をサポートする Google Cloud サービスと、アクセス権を持つ対象にアクセスできるようになりました。このガイドでは、プロジェクト TEST_PROJECT_ID の特定の部門またはグループ内のすべての ID にストレージ管理者ロールを付与しました。Cloud Storage バケットを一覧表示して、アクセスできるかどうかをテストできます。

コンソール(連携)ログイン

コンソール(連携)でアクセス権を確認するには、次の操作を行います。

  1. Cloud Storage ページに移動
  2. プロジェクト TEST_PROJECT_ID の既存バケットの一覧が表示できることを確認します。

gcloud CLI

アクセス権を持っているプロジェクトの Cloud Storage バケットとオブジェクトを一覧表示するには、次のコマンドを実行します。

gcloud alpha storage ls --project="TEST_PROJECT_ID"

プリンシパルには、gcloud CLI セッションで設定されたプロジェクト(PROJECT_ID)に対する serviceusage.services.use 権限が必要です。

次のステップ