メインコンテンツまでスキップ

GCP向けOIDC

OpenID Connect(OIDC)を使用すると、Bitrise は有効期間の長いサービスアカウントキーなしで、誰がリクエストを行っているかを Google Cloud Platform(GCP)に証明できます。Bitrise はビルドまたはセッションを記述する ID トークンを発行し、GCP は Workload Identity Federation を通じて、それをスコープ付きアクセストークンと交換します。

OIDC トークンは、次の 2 か所で GCP に使用できます。

OIDC トークンを GCP に使用するには、次の作業が必要です。

  • ワークロード ID プールを作成します。
  • Google サービスアカウントを ID プールに接続します。

セットアップは、ビルドとセッションで共通です。ただし、属性マッピングとプリンシパルフィルターは、ビルドまたはセッションのクレームに合わせて設定します。

ワークロード ID プールの作成Click to copy link​

GCP でワークロード ID プールを作成して、Workload Identity Federation を有効にします。

Workload Identity Federation

GCP での Workload Identity Federation による認証の仕組みについては、Google の公式ドキュメントを参照してください。

  1. Google Cloud コンソールで、IAM & Admin に移動し、Workload Identity Federation を選択します。

  2. Create an identity pool セクションで、次のフィールドに値を入力します。

    • Name: プールの名前。この名前はプール ID として使用され、後からプール ID を変更することはできません。
    • Description: プールの目的。
  3. Add a provider to pool で、Bitrise をプロバイダーとして追加します。

    • Select a provider フィールドで、OpenID Connect (OIDC) を選択します。
    • Provider name: 名前を入力します。わかりやすくするため、Bitrise の使用をおすすめします。
    • Issuer URL: https://token.builds.bitrise.io.
    • Audience: Select Allowed audience。トークンの使用時に、GCP は、許可されたオーディエンスが aud クレームにエンコードされたオーディエンスと一致するかどうかを確認します。Bitrise では、OIDC サービスを提供する Steps でオーディエンスを設定できます: GCP でのトークンの取得と交換。
  4. Continue をクリックします。

  5. Configure provider attributes で、必要な属性マッピングの値を設定します。

    • google.subject キーは、ユーザーの一意の識別子です。assertion.sub を使用して、トークンをリクエストするビルドまたは Remote Dev Environment セッションを識別できます。セッションのサブジェクトは rde: で始まります。OIDC でのクラウド認証を参照してください。
    • attribute.NAME 形式を使用して、最大 50 個のカスタム属性を追加します。各属性には assertion.VALUE 形式の値を指定します。Bitrise トークンで使用可能な属性の一覧は、こちらで確認できます: OIDC トークンに含まれる情報。
    明示的なマッピングが必要

    使用するすべての属性をマッピングする必要があります。Google では、明示的にマッピングされた属性のみを使用できます。詳細については、Google ドキュメントの属性マッピングを参照してください。

  6. 必要に応じて、属性条件を追加します。サービスアカウントの作成時に、プールレベルで属性に基づいて ID トークンを直接フィルタリングすることもできます。

ワークロードIDプールへのGoogleサービスアカウントの接続Click to copy link​

GCPサービスでOIDC認証を使用するには、ワークロードIDプールをGoogleサービスアカウントに接続する必要があります。これには次の作業が含まれます:

  • サービスアカウントの作成。
  • サービスアカウントの権限借用を使用したIDプールへのアクセス許可の付与。

サービスアカウントの作成Click to copy link​

  1. Google Cloudコンソールで、IAM & Adminに移動し、次にService accountsを選択します。

  2. Create service accountをクリックします。

  3. 表示名、一意のサービスアカウントID、説明を追加します。

  4. Create and continueをクリックします。

  5. 権限で、必要なall rolesを追加します。

    IAM conditions

    必要に応じて、Add IAM conditionをクリックすることで、先ほどマッピングした属性値に基づいてIAM conditionsを追加できます。

  6. Doneをクリックします。

ワークロード ID プールへのアクセス権の付与Click to copy link​

  1. Google Cloud コンソールで、IAM & Admin に移動し、Workload Identity Federation を選択します。

  2. ID プールを選択します。

  3. Grant access をクリックします。

  4. Grant access using service account impersonation オプションを選択します。

  5. 作成した service account を選択します。

  6. プリンシパルを選択します: サービスアカウントにアクセスできる ID です。

    選択可能なオプションは、ID プールのプロバイダー属性マッピングのキーに限られ、フィルターは属性の値と完全に一致します。たとえば、属性マッピング google.subject=assertion.sub を使用する場合は、Attribute name を subject に設定し、Attribute value にビルドのサブジェクトを app:APP_SLUG:workflow:WORKFLOW 形式で設定します。使用可能な値は、Bitrise トークンで確認できます: OIDC トークンに含まれる情報。

  7. Save をクリックします。

  8. ダイアログで、Bitrise OIDC トークン用に作成したプロバイダーを選択します。

  9. OIDC ID トークンのパス https://token.builds.bitrise.io を追加し、形式を text に設定します。

  10. Download config をクリックし、アクセスできる場所にファイルを保存します。

GCPでのトークンの取得と交換Click to copy link​

ワークロードIDプールの設定とGoogleサービスアカウントへの接続が完了すると、BitriseビルドはGCPとトークンを交換できるようになります。次のいずれかの方法を使用できます:

  • Authenticate with GCP Stepを使用して、プロセス全体を処理します。
  • Get OIDC Identity Token Stepでトークンを取得し、スクリプトで認証情報の交換を行います。
OIDCトークン内の情報

Bitriseは、OIDCトークンに次のクレームを含めます: Information in the OIDC token.

Authenticate with GCP Stepの使用Click to copy link​

  1. BitriseでWorkflow Editorを開きます。

  2. Authenticate with GCP StepをWorkflowに追加します。

  3. Client configとToken audienceの入力を設定します:

    • token audienceは、Google Cloudでワークロードのプールを設定する際に設定した許可されたaudienceと一致させる必要があります。
    • Client configの入力は、プロセスの最後にダウンロードしたファイルを指す必要があります。

Get OIDC Identity token Stepの使用Click to copy link​

  1. BitriseでWorkflow Editorを開きます。

  2. Get OIDC Identity Token StepをWorkflowに追加します。

  3. BITRISE_IDENTITY_TOKEN環境変数を使用します: ファイルに書き込み、client library configuration fileを更新して、その環境変数を含むファイルを参照するようにします。これはScriptStepで設定できます:

    tmpfile="$(mktemp)"
    printf '%s' "$BITRISE_IDENTITY_TOKEN" > "$tmpfile"

    # Replace the token path in client library configuration

    gcloud auth login --cred-file=/path/to/updated-client-library-config.json
    gcloud auth list

    その後、gcloud CLIが自動的にそれらを検出して使用します。CLIを介したあらゆる操作が問題なく動作します。