gitleaks/gitleaks

Create rule for SourceGraph tokens

Open

#1.697 geöffnet am 15. Jan. 2025

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (2.048 Forks)batch import
enhancementgood first issue

Repository-Metriken

Stars
 (26.970 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T 17h) (2 gemergte PRs in 30 T)

Beschreibung

Is your feature request related to a problem? Please describe. Detect SourceGraph access tokens, which have a distinct format.

Describe the solution you'd like An overview of the syntaxes are available here: https://github.com/trufflesecurity/trufflehog/pull/2254#issue-2053456642

Describe alternatives you've considered N/A

Additional context I encountered a SourceGraph token in the following format. While , was added as an operator to generic-api-key in #1679, this was not detected due to the newline between the comma and the prefix (TOKEN).

    environment(
        "CODY_INTEGRATION_TEST_TOKEN",
        "sgp_******_******")

cc @zricethezav

Contributor Guide

Research-Richtung
Das Issue fordert das Hinzufügen einer Regel für SourceGraph Tokens. Die Syntaxen werden in einem trufflehog PR referenziert (https://github.com/trufflesecurity/trufflehog/pull/2254#issue 2053456642). Der Beitragende sollte zunächst diesen PR prüfen, um die Token Formate zu verstehen. Anschließend sollten die vorhandenen Gitleaks Regeln im `rules` Verzeichnis betrachtet werden, um das Muster für das Hinzufügen neuer Detektoren zu sehen. Die Implementierung würde das Hinzufügen eines neuen Regel Eintrags in der entsprechenden Go Datei und das Hinzufügen von Testfällen für verschiedene Token Formate umfassen. Das Issue erwähnt auch ein spezifisches Format mit einem mehrzeiligen Muster, das von generic api key nicht erkannt wurde, daher sollte die Regel diesen Fall behandeln.
Tech Stack
go
Domain
security
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GoGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70