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 文档
• 配置指南
• 命令行选项