Bitbucket セキュリティ: シークレットスキャナー

ファイル内のハードコードされたシークレット、キー、パスワードをスキャンします。検出された場合は、セキュリティ Code Insights レポートを作成します。

この Bitbucket Cloud 対応 Pipe は、gitleaks のシークレットパターンレジストリを活用し、業界をリードするセキュリティシークレットスキャン機能を Bitbucket のお客様に提供します。詳細と例のセクションを参照してください。

注: バージョン 2.0.0 で破壊的変更が導入されました。アップグレードする前に、Pipe の現在のバージョンを確認し、それに応じて設定を更新してください。

注: バージョン 3.0.0 で破壊的変更が導入されました。アップグレードする前に、Pipe の現在のバージョンを確認し、それに応じて設定を更新してください。

YAML 定義

bitbucket-pipelines.yml ファイルの script セクションに以下のスニペットを追加します:

- pipe: atlassian/git-secrets-scan:3.2.0
  variables:
    # GITLEAKS_COMMAND: '<string>' # Optional. Default: `git`
    # GITLEAKS_EXTRA_ARGS: '<array>' # Optional.
    # CREATE_REPORT: "<boolean>" # Optional. Default: `true`
    # DEBUG: "<boolean>" # Optional. Default: `false`

変数

変数	用途
GITLEAKS_COMMAND	`gitleaks` で使用するコマンド。利用可能: `git`、`dir`、`stdin`。デフォルト: `git`。
GITLEAKS_EXTRA_ARGS	`gitleaks` に渡す追加フラグ gitleaks extra args。
CREATE_REPORT	パイプが `gitleaks` 実行結果を使用して Bitbucket CodeInsights レポートを作成するかどうかを制御します。デフォルト: `true`。
DEBUG	追加のデバッグ情報を有効にします。デフォルト: `false`。

詳細

デフォルトでは、パイプは gitleaks git コマンドでハードコードされたシークレット認証情報をファイルからスキャンし、検出された各認証情報のアノテーションを含むセキュリティレポートを作成します。

高度な使用方法

高度な gitleaks 設定のセットアップについては、こちらのブログ記事を参照してください: gitleaks advanced configuration setup。

テスト用シークレットを無視する方法: gitleaks additional-configuration。

例

基本的な例:

デフォルトの git コマンドでシークレット認証情報のスキャンを実行します:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0

dir コマンドを使用すると、ディレクトリとファイルをスキャンできます:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: "./path_to_directory_or_file"

CodeInsights レポートを作成しないでください:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      CREATE_REPORT: "false"

高度な例:

ディレクトリとファイルをスキャンし、カスタムの gitleaks 設定を指定してデバッグを有効にします:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      DEBUG: "true"
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: 
        - "./path_to_directory_or_file"
        - "--config=my-gitleaks-config.toml"

サポート

このパイプに関するサポートが必要な場合、または問題や機能リクエストがある場合は、Community でお知らせください。

問題を報告する場合は、以下を含めてください:

パイプのバージョン
関連するログとエラーメッセージ
再現手順

git-secrets-scan

人気