GitLeaks GitLab CI コンポーネント

Gitleaks 用の GitLab CI コンポーネント - パスワード、API キー、トークンといったハードコードされた秘密情報を git リポジトリで検出・防止する SAST ツールです。

機能

• シークレット検出: リポジトリをスキャンし、ハードコードされた秘密情報や機密情報を検出します。
• 包括的なルール: さまざまな種類の秘密情報を検出するための豊富なビルトインルール
• カスタム設定: ローカルおよびリモート設定ファイルのサポート
• 複数の出力形式: JSON、SARIF、その他のレポート形式をサポート
• 柔軟な引数: 追加のフラグを直接 Gitleaks に渡せます
• リモート設定: リモート URL から設定ファイルをダウンロードして使用
• 設定可能なジョブ設定: ジョブ名、ステージ、コンテナイメージをカスタマイズ可能

使用方法

基本的な使用方法

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest

stages:
  - test

カスタム設定を使用する

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_CONFIG: ".gitleaks.toml"
      GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"

stages:
  - test

リモート設定を使用する

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"

stages:
  - test

入力

設定ファイル

ローカル設定

.gitleaks.toml ファイルをリポジトリルートに配置するか、GITLEAKS_CONFIG を使用してパスを指定します。

リモート設定

GITLEAKS_REMOTE_CONFIG を設定して、URL から設定ファイルをダウンロードします。これは複数のプロジェクト間で設定を共有するのに便利です。

デフォルト設定

ローカルまたはリモート設定が指定されていない場合、コンポーネントは Gitleaks の組み込みデフォルトルールを使用します。

アーティファクト

コンポーネントは以下のアーティファクトを生成します：

• gitleaks-report.json: JSON 形式のスキャン結果（--report-format 引数に基づく他の形式も可能）

ドキュメント

Gitleaks の設定とオプションの詳細については、以下を参照してください：

• Gitleaks Documentation
• Configuration Guide
• Command Line Options