GitLeaks GitLab CI Komponente

Eine GitLab CI-Komponente für Gitleaks – ein SAST-Tool zum Erkennen und Verhindern von hartcodierten Geheimnissen wie Passwörtern, API-Keys und Tokens in Git-Repos.

Funktionen

Geheimnis-Erkennung: Scannt Repositories nach hartcodierten Geheimnissen und sensiblen Informationen
Umfassende Regeln: Umfangreicher Satz integrierter Regeln zur Erkennung verschiedener Geheimnistypen
Benutzerdefinierte Konfiguration: Unterstützung für lokale und entfernte Konfigurationsdateien
Mehrere Ausgabeformate: Unterstützung für JSON, SARIF und andere Berichtsformate
Flexible Argumente: Zusätzliche Flags direkt an Gitleaks übergeben
Entfernte Konfiguration: Konfigurationsdateien von entfernten URLs herunterladen und verwenden
Konfigurierbare Job-Einstellungen: Job-Name, Stage und Container-Image anpassen

Verwendung

Grundlegende Verwendung

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

stages:
  - test

Mit benutzerdefinierter Konfiguration

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

Mit entfernter Konfiguration

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

Eingaben

Konfigurationsdateien

Lokale Konfiguration

Platzieren Sie eine .gitleaks.toml-Datei im Stammverzeichnis Ihres Repositorys oder geben Sie den Pfad mit GITLEAKS_CONFIG an.

Entfernte Konfiguration

Setzen Sie GITLEAKS_REMOTE_CONFIG, um eine Konfigurationsdatei von einer URL herunterzuladen. Dies ist nützlich, um Konfigurationen über mehrere Projekte hinweg zu teilen.

Standardkonfiguration

Wenn keine lokale oder entfernte Konfiguration angegeben wird, verwendet die Komponente die integrierten Standardregeln von Gitleaks.

Artefakte

Die Komponente generiert die folgenden Artefakte:

gitleaks-report.json: Scan-Ergebnisse im JSON-Format (oder anderem Format basierend auf dem --report-format-Argument)

Dokumentation

Weitere Informationen zur Konfiguration und zu den Optionen von Gitleaks finden Sie unter:

`job_name`	Name des CI-Jobs	`"Geheimnis-Scanning"`
`stage`	Pipeline-Stage	`"test"`
`image`	Docker-Image für Gitleaks	`"registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0"`
`GITLEAKS_EXTRA_ARGS`	Zusätzliche Argumente für Gitleaks	`"--verbose --redact --report-format json"`
`GITLEAKS_CONFIG`	Pfad zur lokalen Gitleaks-Konfigurationsdatei	`""`
`GITLEAKS_REMOTE_CONFIG`	URL zum Herunterladen der Gitleaks-Konfigurationsdatei	`""`

GitLeaks

Beliebteste