Rizin Notebook

Ein Notizbuch für die Binäranalyse mit Rizin. Organisieren Sie Notizen, Befehle und Skripte pro Binärdatei.

Erfordert Rizin 0.7.0 oder neuer.

Funktionsweise

Jede Notizbuch-Seite ist an eine Binärdatei gebunden. Sie speichert die Binärdatei selbst, ihren SHA-256-Hash und eine Liste von Zellen:

Befehlszellen – ein Rizin-Befehl und seine Ausgabe
Skriptzellen – ein JavaScript-Snippet, das serverseitig gegen eine Rizin-Pipe ausgeführt wird
Markdown-Zellen – Freitextnotizen

Seiten werden als einzelne .rznb-Dateien (SQLite-Datenbanken) in ~/.rizin-notebook/ gespeichert. Sie können als einzelne eigenständige Dateien exportiert und importiert werden.

Komponenten

Go-Server (rizin-notebook) – die Hauptanwendung. Stellt eine Weboberfläche bereit, bietet eine Protobuf- + JSON-REST-API, speichert alles in seitenweisen .rznb-SQLite-Dateien.
rizin-notebook-plugin – ein Rizin-Core-Plugin (C). Fügt Rizin NB-Befehle hinzu, sodass Sie aus der Rizin-Shell mit dem Notizbuch interagieren können.
cutter-notebook-plugin – ein Cutter-Plugin (C++/Qt6). Fügt Cutter einen Plugins -> Notebook-Dock und ein Menü hinzu.

Die Plugins sind optional. Der Go-Server funktioniert eigenständig mit einem Browser.

Kompatibilitätshinweis

Der Go-Server ist plattformunabhängig. Die Plugins hängen von der verwendeten Rizin-Version ab, gegen die sie kompiliert wurden.

Wenn auf Ihrem Rechner eigenständiges Rizin und Cutter unterschiedliche Rizin-Versionen mitbringen, bauen Sie rz_notebook einmal für jede Version. Beide Builds können mit demselben Server kommunizieren und dieselben .rznb-Daten verwenden.

Einfache Regel:

ein Server
ein rz_notebook-Build pro verwendeter Rizin-Version
ein Cutter-Plugin, falls Sie den Cutter-Dock wünschen

Screenshots

Projekt-Screenshots sind unter docs/images/ organisiert.

Weboberfläche

Abbildung 1. Startseitenansicht (mit Zellen- und Bereichsbasierter Suche, die mehrere Modi unterstützt.) Rizin Notebook Einstellungsseite

Abbildung 2. Einstellungsseite für Umgebungskonfiguration, Tastaturkürzel und serverseitiges Verhalten. Autovervollständigungsvorschläge für Rizin-Befehle in der Notizbuch-Weboberfläche

Autovervollständigungsvorschläge für Rizin-Befehle in der Notizbuch-Weboberfläche

Abbildung 3. Befehlsautovervollständigung in der Webkonsole, die hilft, Rizin-Befehle schnell zu entdecken und zu vervollständigen. Befehlssuche und Hilfe-Modal in der Notizbuch-Weboberfläche

Befehlssuche und Hilfe-Modal in der Notizbuch-Weboberfläche

Abbildung 4. Integrierte Befehlshilfe und Such-Modal zum Erkunden von Befehlsbeschreibungen und -argumenten.

Plugin-Integration

Abbildung 5. Rizin Core-Plugin-Integration, die die Notizbuch-Interaktion direkt aus der Rizin-Shell ermöglicht. Cutter Plugin Integration Screenshot 1

Abbildung 6. Cutter-Plugin-Integrationsansicht, die das Notizbucherlebnis innerhalb der Cutter-Oberfläche zeigt. Cutter Plugin Integration Screenshot 2

Abbildung 7. Zusätzliche Cutter-Plugin-Workflow-Ansicht, die mögliche Notizbuchverwendungen demonstriert.

Den Server bauen

go build -o rizin-notebook .

Versionstring während Release-Builds einbetten:

go build -ldflags "-X main.NBVERSION=$(git rev-parse --short HEAD)" -o rizin-notebook .

Ausführen

./rizin-notebook

Öffnet standardmäßig unter http://127.0.0.1:8000/.

Flags:

-bind 127.0.0.1:8000    Adresse und Port, auf denen gelauscht wird
-root /                  URL-Pfadpräfix
-notebook /path/to/data  Datenverzeichnis (Standard: ~/.rizin-notebook)
-debug-assets /path      Vorlagen von Festplatte laden statt eingebettet
-debug                   HTTP-Anfragelogs aktivieren

Setzen Sie RIZIN_PATH, um den für die Pipe-Ausführung verwendeten Rizin-Binärpfad zu überschreiben.

Das Rizin-Plugin bauen

Siehe rizin-notebook-plugin/README.md.

Das Cutter-Plugin bauen

Siehe cutter-notebook-plugin/README.md.

Wenn Cutter ein eigenes eingebettetes Rizin mitbringt, muss das von Cutter geladene rz_notebook-Plugin gegen dieselbe gebündelte Rizin-Version kompiliert werden.

Datenspeicherung

Jede Seite ist eine .rznb-Datei im Datenverzeichnis. Es handelt sich um eine SQLite-Datenbank, die Folgendes enthält:

Seitenmetadaten (Titel, ursprünglicher Dateiname, Speicher-Schlüssel der Binärdatei, SHA-256-Hash)
Zellen (Typ, Inhalt, Ausgabe, Zeitstempel)
den Binärdatei-Blob selbst
seitenweise Konfiguration (Schlüssel/Wert)

Der Server verwaltet einen catalog.db-Index für schnelle Auflistung über alle Seiten hinweg.

Beim ersten Start migriert der Server automatisch alle Seiten aus einem älteren monolithischen notebook.db-Format in das seitenweise .rznb-Layout.

API

Alle NB-Plugin-Befehle verwenden die Protobuf-API (Content-Type: application/x-protobuf). Das Schema befindet sich in proto/notebook.proto.

Eine parallele JSON-API unter /api/v1/json/... wird vom Cutter-Plugin und der Browser-Oberfläche verwendet.

rizin-notebook

Beliebteste