Bitbucket-Sicherheit: Secret Scanner

Durchsucht Ihre Dateien nach fest codierten Secrets, Schlüsseln und Passwörtern. Erstellt einen Sicherheits-Code Insights-Bericht, falls welche gefunden werden.

Diese von Bitbucket Cloud unterstützte Pipe nutzt die gitleaks-Registry für Secret-Muster, um Bitbucket-Kunden branchenführende Funktionen zum Scannen nach Sicherheits-Secrets bereitzustellen. Weitere Informationen finden Sie im Abschnitt Details und Beispiele.

Hinweis: In Version 2.0.0 wurden Breaking Changes eingeführt. Bitte überprüfen Sie die aktuelle Version der Pipe und aktualisieren Sie Ihre Konfiguration entsprechend, bevor Sie ein Upgrade durchführen.

Hinweis: In Version 3.0.0 wurden Breaking Changes eingeführt. Bitte überprüfen Sie die aktuelle Version der Pipe und aktualisieren Sie Ihre Konfiguration entsprechend, bevor Sie ein Upgrade durchführen.

YAML-Definition

Fügen Sie den folgenden Ausschnitt zum Abschnitt script Ihrer Datei bitbucket-pipelines.yml hinzu:

- 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`

Variablen

Variable	Verwendung
GITLEAKS_COMMAND	Befehl zur Verwendung mit `gitleaks`. Verfügbar: `git`, `dir`, `stdin`. Standard: `git`.
GITLEAKS_EXTRA_ARGS	Zusätzliche Flags, die an `gitleaks` übergeben werden gitleaks extra args.
CREATE_REPORT	Steuert, ob die Pipe Bitbucket CodeInsights-Berichte mit den Ergebnissen der `gitleaks`-Ausführung erstellt. Standard: `true`.
DEBUG	Zusätzliche Debug-Informationen aktivieren. Standard: `false`.

Details

Standardmäßig durchsucht die Pipe Ihre Dateien mit dem Befehl gitleaks git nach fest codierten geheimen Anmeldedaten und erstellt einen Sicherheitsbericht mit Anmerkungen für jede gefundene Anmeldedaten.

Erweiterte Nutzung

Werfen Sie einen Blick auf diesen Blogbeitrag für eine erweiterte gitleaks-Konfiguration: gitleaks advanced configuration setup.

Wie man Testgeheimnisse ignoriert: gitleaks additional-configuration.

Beispiele

Einfaches Beispiel:

Führen Sie einen Scan nach geheimen Anmeldedaten mit dem Standardbefehl git aus:

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

Der Befehl dir ermöglicht es Ihnen, Verzeichnisse und Dateien zu scannen:

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

Erstellen Sie keinen CodeInsights-Bericht:

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

Fortgeschrittenes Beispiel:

Verzeichnisse und Dateien scannen, eine benutzerdefinierte gitleaks-Konfiguration bereitstellen und den Debug-Modus aktivieren:

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"

Support

Wenn Sie Hilfe zu dieser Pipe benötigen oder ein Problem bzw. einen Feature-Wunsch haben, lassen Sie es uns in der Community wissen.

Wenn Sie ein Problem melden, geben Sie bitte Folgendes an:

die Version der Pipe
relevante Logs und Fehlermeldungen
Schritte zur Reproduktion

git-secrets-scan

Beliebteste