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

Secrets

Secrets は環境変数の一種で、情報を暗号化された形式で隠し、その値はビルドログに表示されません。bitrise.yml の設定にも表示されません。パスワードや API キーなどの機密情報を Secrets として保存できます。

Environment Variables と同様に、Secrets は Step 入力の値として使用できます:Env Var を Step 入力として使用する。

Secrets の管理方法は2つあります。

プロジェクトの Secrets ページには、その両方が一覧表示されます。共有 Secrets がある場合は最初に、続いて project level Secrets が表示されます。特に記載がない限り、このページの手順は project level Secrets を対象としています。

Secretの設定Click to copy link​

すべての環境変数の値は文字列です

環境変数またはシークレットの値には文字列のみを設定できます。数値(例:7)を設定した場合でも、文字列として渡されます。

シークレットは、Workflow EditorのSecretsページで作成するか、Step inputsを変更する際に作成できます。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. 左側でSecretsを選択します。

  4. Project level Secretsの下にあるAdd newボタンをクリックします。

    secrets-screenshot.png

  5. キーと値を追加します。

    $記号の使用

    環境変数やシークレットの値(パスワードなど)には$記号を使用できますが、その場合は必ずReplace variables in inputsオプションのチェックを外したままにしてください。変数のキーを値に置き換えて入力に使用すると、$記号があるため、Bitrise CLIはその値を別の環境変数として扱います。

  6. 必要に応じて、シークレットのキーを入力内でその値に置き換えることができます。Replace variables in inputsオプションをチェックしてください。

  7. 必要に応じて、このオプションを選択することで、シークレットをプルリクエストに公開できます。

    ほとんどの場合、Secretsを公開しないことを強くおすすめします。

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

既存のSecretの編集Click to copy link​

Secretsタブで新しいシークレット環境変数を追加したら、いつでもそこに戻って内容を変更したり、詮索好きな目から保護したりできます。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. 左側でSecretsを選択します。

  4. シークレットの値の隣にあるEditをクリックします。

  5. 必要に応じて内容を変更します。

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

Secretの値の保護Click to copy link​

通常、目のアイコンをクリックすると、Secret の値を表示または非表示にできます。この機能は、Secrets にシークレット環境変数が多数ある場合に、1つの Secret の値だけを確認し、他の値は非表示のままにしたいときに便利です。値が非表示の場合は、斜線付きの目のアイコンで表されます。

ただし、Secret を保護対象にすると、値全体を完全に非表示にできます。保護対象にすると、自分自身を含め誰も値全体を再び表示できなくなりますが、新しい値に置き換えることはできます。値の長さが16文字を超える場合は、最後の4文字を表示できます:保護された Secrets のマスク表示。

Secret の保護は元に戻せません

Secret を保護対象にすると元に戻せません。保護を再びオフにすることはできません。保護された Secret の値は、Edit をクリックして新しい値を入力すれば置き換えられます。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. 左側で Secrets を選択します。

  4. Secret の値の横にある Edit をクリックします。

    edit-button-secrets.png

  5. Protected にチェックを入れます。

  6. この操作は元に戻せないという警告がダイアログに表示されます。Save and protect をクリックします。

以上で完了です。これ以降、Secret の値全体を表示することはできません。

保護された Secrets のマスク表示Click to copy link​

保護された Secret の値の長さが16文字を超える場合は、最後の4文字を表示できます。値の長さが16文字以下の場合は、値のどの部分も表示できません。

  1. Secret を探します。

    Project level Secrets は、プロジェクトの Secrets ページにあります。共有 Secrets は、Workspace settings の Shared resources ページにあります。

  2. Secret の値の横にある小さな目のアイコンをクリックします。

    Secret が保護されている場合、値の長さが16文字を超えていれば、値の最後の4文字が表示されます。保護された Secret の値がそれより短い場合は、アスタリスクと値の合計の長さのみが表示されます。

    Masked value of a protected Secret in the Secrets tab, showing the last four characters and the total length

Secretのプルリクエストへの公開Click to copy link​

デフォルトでは、プルリクエストはSecretsの値にアクセスできません。つまり、リポジトリのフォークから作成されたプルリクエストがビルドをトリガーする場合、そのビルドではプロジェクトのSecretsを使用できません。

特定のSecretへのアクセスをプルリクエストビルドに許可する必要がある場合は、そのSecretをプルリクエストに公開できます。ただし、公開した場合でも、その値はログには表示されず、[REDACTED]と表示されます。

保護されたSecretsは公開できません

Secretが保護対象に設定されると、プルリクエストビルドに公開することはできません。

公開プロジェクト

プロジェクトが公開プロジェクトの場合、そのプロジェクトのSecretsをプルリクエストビルドに公開することはできません。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. 左側でSecretsを選択します。

  4. Secretの値の隣にあるEditをクリックします。

  5. Expose for Pull Requests?トグルを切り替えます。

Secretが公開されると、プルリクエストビルドからアクセスできるようになります。

複数のプロジェクトにまたがるSecretsの管理Click to copy link​

デフォルトでは、すべてのSecretsはプロジェクトレベルで管理されます。各プロジェクトで対応する値が異なっていても、複数のプロジェクト間でSecretのキーを再利用できます。

ただし、すべてのプロジェクトで同じ値を保持するSecretを設定し、そのSecretを1か所で管理することも可能です。例えば、すべてのプロジェクトが同じAPIへのアクセスを必要とする場合は、APIキーを含むSecretを一元的な場所に保存するのが適切です。APIキーが変更された場合も、その1か所で変更するだけで、すべてのプロジェクトに反映されます。

これを実現する方法は2つあります。

Workspace レベルでの Secrets の管理Click to copy link​

Enterprise プランでは、Secrets を Workspace レベルで保存できます。つまり、同じ Secret を、その Workspace が所有するすべてのプロジェクトで利用できます。これによりセキュリティが向上します。Workspace のオーナーとマネージャーだけが、これらの Secrets にアクセスできます。

Downgrading

Enterprise プランからダウングレードすると、Workspace Secrets は project level Secrets に変換されます。

ビルドに Secrets を渡す際は、利用可能性の順序に従い、project level Secrets が Workspace レベルの Secrets より優先されます。つまり、同じキーを持つ Secrets が2つある場合、ビルドではプロジェクトレベルの Secret が使用されます。

新しい Secret を追加するには:

  1. Bitrise のメインページで、左側のナビゲーションメニューから Settings を選択します。Workspace settings ページが開きます。

  2. Workspace settings ページで Shared resources を選択します。

    shared-res.png

  3. Add new ボタンをクリックします。

  4. キーと値を追加します。

    ws-secrets.png

  5. Secret の使用方法を設定します。

    • Replace variables in inputs:Secret の値を文字列としてビルドに渡します。埋め込みの Secrets や Environment Variables に使用します。つまり、Secret の値が別の Secret または環境変数のキーである場合です。ほとんどの場合、チェックを入れる必要はありません。
    • Expose for pull requests:Secret を PR に公開すると、その Secret をプルリクエストビルドで使用できるようになります。リポジトリのプライバシー設定によっては、セキュリティ上のリスクになる可能性があります。
    • Protected:値全体を表示できなくなり、値が16文字を超える場合に限り、最後の4文字のみ表示できます。値を置き換えることは引き続き可能です。この設定は、保存すると元に戻せません。詳細は、保護された Secrets のマスク表示を参照してください。
  6. 準備ができたら、Done をクリックします。

一元的なvaultやデータベースからSecretsを管理するClick to copy link​

一元的な場所にSecretsを設定するには、次の2つが必要です:

  • Secretsを保存するための一元的なvaultまたはデータベース(HashiCorpやDopplerなど)。CLI経由でアクセスできる必要があります。
  • 一元的なvault/データベースにアクセスし、シークレットを取得してBitrise上で機密として設定するためのScript Step。

ビルド中に新しいシークレットを作成し、一元的な場所に保存するには:

  1. 保存したいvaultまたはデータベースに、Secretsをキーと値のペアとして追加します。

  2. Secretsを使用したいすべてのWorkflowsに、Script Stepを追加します。

  3. vaultにアクセスしてSecretsを取得するために必要なコマンドを追加します。具体的なコマンドは使用しているサービスによって異なります。

  4. envmanツールを使用して、Secretsを機密としてマークします。envmanツールの構文は次のとおりです。

    envman add --key KEY --value value --sensitive .

  5. Stepがビルドログにシークレットの値を表示しないようにします。そのためには、Stepのcontentからset -xを削除します。

シークレットのマスキング

シークレットのマスキングをオフにしている場合、Secretsはマスキングされず、値がログに表示される可能性があるのでご注意ください。

SecretsをHashiCorp Vaultに保存する

secret/helloという名前のHashiCorp Vaultインスタンスがあるとします。このvaultインスタンスには2つのSecretsがあります。値がworldのfooと、値がworld2のfoo2です。これらのSecretsをBitriseビルドで使用するには、次の操作が必要です。

  • vaultインスタンスからエクスポートします。
  • それらを反復処理し、両方を機密としてマークします。

これらを実現するには、次のScriptを使用できます:

# Exporting the Secrets
vault kv get --format=json secret/hello | jq -r '.data.data | to_entries[] | [.key, .value] | @tsv' |
# Iterating over the Secrets and marking them as sensitive
while IFS=$'\t' read -r key value; do
envman add --key "$key" --value "$value" --sensitive
done

SecretsのマスキングClick to copy link​

Bitrise CLIは、Secret Env Varsを自動的にマスキングし、キーの後に改行を入れて[REDACTED]を出力します。これにより、Secret Env Varsはビルドログに表示されません。これは非公開プロジェクトと公開プロジェクトの両方に適用されます。

Secretsをログに表示する必要がある場合は、いつでもこの機能をオフにできます。

警告

これはセキュリティ上のリスクとなる可能性があります。Secretのマスキングをオフにしないことを強くおすすめします。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. 左側でSecretsを選択します。

  4. Add newをクリックして、BITRISE_SECRET_FILTERINGシークレットEnvironment Variableを偽の値で登録します。

  5. 右上のSave changesをクリックします。

セルフホスト環境におけるSecretsClick to copy link​

Bitriseビルドはself-hosted infrastructure(自分で管理するハードウェアまたは仮想化環境)で実行できます。セキュリティポリシー上、bitrise.ioでホストされているBitrise Secretsを使用できない場合、このガイドではSecretsにアクセスしてビルドで使用するための別の方法を紹介します。

セルフホストビルドでは、ホストマシンは仮想プライベートクラウドの内側にあります。そのため、SecretsをBitriseのコントロールプレーンやウェブサイトに公開することなく、任意のシークレットサービスにアクセスできます。使用しているサービスからシークレットを取得し、envmanを使用してBitriseビルドに追加します:

  1. 必要に応じて、Bitriseで任意の値を持つプレースホルダーのシークレットを作成します。シークレットの設定を参照してください。

    これは、Workflow EditorのGUI上で機密のStep入力にシークレットを使用したい場合にのみ必要です。機密入力ではSecretsのみを受け付け、Workflow Editorでは既存のSecretsのみを機密入力の値として追加できます。

    YAMLでBitriseの設定を編集する場合は、入力に任意の値を設定できるため、プレースホルダーは不要です。

  2. 使用しているサービスからシークレットを取得するために、Script Stepを使用します。

  3. スクリプト内で、set +xを設定してデバッグをオフにします:

    これは非常に重要です。デバッグモードでは、シークレットの値がビルドログに表示される可能性があります。

    #!/usr/bin/env bash
    # fail if any commands fails
    set -e
    # make pipelines' return status equal the last command to exit with a non-zero status, or zero if all commands exit successfully
    set -o pipefail
    # debug log
    set +x
  4. 使用しているサービスからシークレットの値を取得し、envmanに追加します。

    set +x
    GIT_PASSWORD_SECRET=TODO Your call to fetch the secret value
    envman add --key GIT_HTTP_PASSWORD --value $GIT_PASSWORD_SECRET

    実際のコマンドは使用しているサービスによって異なります。例えば、AWSでBitriseを使用しており、EC2マシンがAWS Secrets Managerにアクセスできる場合、次のようなコマンドでシークレットを取得できます:

    set +x
    USERNAME=aws secretsmanager get-secret-value --secret-id BitriseDemoGitUsername --region eu-central-1 | jq -r '.SecretString'
    envman add --key GIT_HTTP_USERNAME --value $USERNAME
    PASS=aws secretsmanager get-secret-value --secret-id BitriseDemoGitPassword --region eu-central-1 | jq -r '.SecretString'
    envman add --key GIT_HTTP_PASSWORD --value $PASS