Nosey Parker wird jetzt durch Titus ersetzt. Nosey Parker ist offiziell eingestellt

Siehe unseren Ankündigungsbeitrag https://www.praetorian.com/blog/titus-open-source-secret-scanner/. Das Titus-Repo finden Sie unter https://github.com/praetorian-inc/titus

Übersicht

Nosey Parker ist ein CLI-Tool, das Geheimnisse und sensible Informationen in Textdaten findet. Es ist im Wesentlichen ein spezielles, grep-ähnliches Werkzeug zur Erkennung von Geheimnissen.

Es wurde für offensive Sicherheit entwickelt (z. B. zur Ermöglichung lateraler Bewegung in Red Teams), kann aber auch für defensive Sicherheitstests nützlich sein. Es hat in Hunderten von offensiven Sicherheitseinsätzen bei Praetorian Geheimnisse gefunden.

Hauptfunktionen:

• Flexibilität: Es scannt nativ Dateien, Verzeichnisse, GitHub und Git-Verlauf und verfügt über einen erweiterbaren Eingabeaufzählungsmechanismus
• Erprobte Regeln: Es verwendet reguläre Ausdrücke mit 188 Regeln, die basierend auf Feedback von Sicherheitsingenieuren für hohe Präzision ausgewählt wurden
• Signal-Rausch-Verhältnis: Es dedupliziert Übereinstimmungen, die dasselbe Geheimnis teilen, und reduziert den Überprüfungsaufwand um das 10- bis 1000-fache oder mehr
• Geschwindigkeit und Skalierbarkeit: Es kann auf einem Mehrkernsystem mit GB/s scannen und hat während Sicherheitseinsätzen Eingaben von bis zu 20 TB gescannt

Der typische Workflow besteht aus drei Phasen:

1. Scannen Sie interessante Eingaben mit dem Befehl scan
2. Melden Sie Details der Scanergebnisse mit dem Befehl report
3. Überprüfen und priorisieren Sie die Ergebnisse

Installation

Homebrew-Formel

brew install noseyparker

Vorgefertigte Binärdateien

Die letzte Release-Seite enthält vorgefertigte Binärdateien für x86_64/aarch64 Linux und macOS.

Docker: x86_64/aarch64

docker pull ghcr.io/praetorian-inc/noseyparker:latest

Der aktuellste Commit ist auch über das main-Tag verfügbar.

Docker: x86_64/aarch64, Alpine-Basis:

docker pull ghcr.io/praetorian-inc/noseyparker-alpine:latest

Der aktuellste Commit ist auch über das main-Tag verfügbar.

Arch Linux-Paket

https://aur.archlinux.org/packages/noseyparker

Windows

Nosey Parker lässt sich nicht nativ unter Windows erstellen (#121). Es ist möglich, es unter Windows mit WSL1 und der nativen Linux-Version auszuführen.

Erstellen aus dem Quellcode

$ rm -rf release && ./scripts/create-release.zsh

Hilfe erhalten

Das Ausführen der noseyparker-Binärdatei ohne Argumente zeigt die Hilfe der obersten Ebene an und beendet sich. Sie können eine verkürzte Hilfe für einen bestimmten Befehl erhalten, indem Sie noseyparker BEFEHL -h ausführen. Ausführlichere Hilfe ist mit dem Befehl help oder der Langform --help verfügbar.

Die vorgefertigten Releases enthalten auch Manpages, die die Befehlszeilenhilfe an einem Ort zusammenfassen. Diese in das Markdown-Format konvertierten Manpages sind ebenfalls im Repository hier enthalten.

Wenn Sie eine Frage haben, die in dieser Dokumentation nicht beantwortet wird, starten Sie bitte eine Diskussion.

Terminologie und Datenmodell

Der Datenspeicher

Der Datenspeicher ist ein spezielles Verzeichnis, das Nosey Parker verwendet, um seine Ergebnisse aufzuzeichnen und seinen internen Zustand zu verwalten. Ein Datenspeicher wird bei Bedarf automatisch vom Befehl scan erstellt.

Blobs

Jede gescannte Eingabe wird als Blob bezeichnet. Jeder Blob hat eine eindeutige Blob-ID, einen SHA-1-Digest, der auf die gleiche Weise wie git berechnet wird.

Provenienz

Jeder Blob hat einen oder mehrere zugehörige Provenienz-Einträge. Ein Provenienzeintrag sind Metadaten, die beschreiben, wie die Eingabe entdeckt wurde, z. B. eine Datei im Dateisystem oder eine Datei im Git-Repository-Verlauf.

Regeln

Nosey Parker ist ein regelbasiertes System, das reguläre Ausdrücke verwendet. Jede Regel hat ein einzelnes Muster mit mindestens einer Erfassungsgruppe, die den Übereinstimmungsinhalt vom umgebenden Kontext isoliert. Sie können verfügbare Regeln mit noseyparker rules list auflisten.

Regelsätze

Eine Sammlung von Regeln ist in einem Regelsatz organisiert. Nosey Parkers Standard-Regelsatz enthält Regeln, die Dinge erkennen, die Geheimnisse zu sein scheinen. Andere Regelsätze sind verfügbar; Sie können sie mit noseyparker rules list. auflisten.

Übereinstimmungen

Wenn das Muster einer Regel mit einer Eingabe übereinstimmt, erzeugt es eine Übereinstimmung. Eine Übereinstimmung wird eindeutig durch eine Regel, Blob-ID, Start-Byte-Offset und End-Byte-Offset definiert; diese Felder werden verwendet, um einen eindeutigen Übereinstimmungsbezeichner zu berechnen.

Ergebnisse

Übereinstimmungen, die sich eine Regel und Erfassungsgruppen teilen, werden zu einem Ergebnis zusammengefasst. Mit anderen Worten, ein Ergebnis ist eine Gruppe von Übereinstimmungen. Dies ist die oberste Berichtseinheit von Nosey Parker.

Anwendungsbeispiele

HINWEIS: Bei Verwendung von Docker...

Wenn Sie das Docker-Image verwenden, ersetzen Sie noseyparker in den folgenden Befehlen durch einen Docker-Aufruf, der ein gemountetes Volume verwendet:

docker run -v "$PWD":/scan ghcr.io/praetorian-inc/noseyparker:latest <ARGS>

Der Docker-Container läuft mit /scan als Arbeitsverzeichnis, sodass das Mounten von $PWD auf /scan im Container die automatische Vervollständigung und relative Pfade in Ihrem Befehlszeilenaufruf funktionieren lässt.

Scannen von Dateisysteminhalten, einschließlich lokaler Git-Repos

Nosey Parker unterstützt nativ das Scannen von Dateien, Verzeichnissen und des gesamten Verlaufs von Git-Repositories.