Caracal

Caracal ist ein statisches Analysewerkzeug für die SIERRA-Darstellung von Starknet-Smart-Contracts.

Features

• Erkennungsmodule zur Erkennung von anfälligem Cairo-Code
• Drucker zur Berichterstattung von Informationen
• Taint-Analyse
• Datenflussanalyse-Framework
• Einfach in Scarb-Projekten auszuführen

Installation

Precompiled binaries

Precompiled binaries sind auf unserer Releases Seite verfügbar. Wenn Sie den Cairo-Compiler 1.x.x verwenden, nutzen Sie die Binärdatei v0.1.x, andernfalls, wenn Sie den Cairo-Compiler 2.x.x verwenden, nutzen Sie v0.2.x.

Aus dem Quellcode erstellen

Sie benötigen den Rust-Compiler und Cargo. Erstellen aus Git:

cargo install --git https://github.com/crytic/caracal --profile release --force

Erstellen aus einer lokalen Kopie:

git clone https://github.com/crytic/caracal
cd caracal
cargo install --path . --profile release --force

Verwendung

Erkennungsmodule auflisten:

caracal detectors

Drucker auflisten:

caracal printers

Eigenständig

Um eine eigenständige Cairo-Datei zu verwenden und wenn Sie eine lokale Cairo-Compiler-Binärdatei haben, reicht es, auf die Datei zu verweisen. Andernfalls wird ein gebündelter Compiler verwendet und Sie müssen den Pfad zur corelib-Bibliothek entweder mit der --corelib CLI-Option oder durch Setzen der Umgebungsvariablen CORELIB_PATH angeben. Erkennungsmodule ausführen:

caracal detect path/file/to/analyze

caracal detect path/file/to/analyze --corelib path/to/corelib/src

Drucker ausführen:

caracal print path/file/to/analyze --printer printer_to_use --corelib path/to/corelib/src

Cairo-Projekt

Wenn Sie ein Cairo-Projekt mit mehreren Dateien und Contracts haben, müssen Sie möglicherweise angeben, welche Contracts mit --contract-path. Die lokale Cairo-Compiler-Binärdatei wird verwendet, falls verfügbar, andernfalls wird ein gebündelter Compiler verwendet. In letzterem Fall müssen Sie auch die corelib angeben, wie oben für den eigenständigen Fall erläutert. Der Pfad ist das Verzeichnis, in dem sich cairo_project.toml befindet. Erkennungsmodule ausführen:

caracal detect path/to/dir

caracal detect path/to/dir --contract-path token::myerc20::... token::myerc721::...

Drucker ausführen:

caracal print path/to/dir --printer printer_to_use

Scarb

Wenn Sie ein Projekt haben, das Scarb verwendet, müssen Sie Folgendes in Scarb.toml hinzufügen:

[[target.starknet-contract]]
sierra = true

[cairo]
sierra-replace-ids = true

Übergeben Sie dann den Pfad zum Verzeichnis, in dem Scarb.toml liegt. Erkennungsmodule ausführen:

caracal detect path/to/dir

Drucker ausführen:

caracal print path/to/dir --printer printer_to_use

Erkennungsmodule

Die Cairo-Spalte repräsentiert die Compiler-Version(en), für die das Erkennungsmodul gültig ist.

Drucker

• cfg: Exportiert das CFG jeder Funktion in eine .dot-Datei
• callgraph: Exportiert den Funktionsaufrufgraphen in eine .dot-Datei

So können Sie beitragen

Schauen Sie im Wiki zu den folgenden Themen nach:

• Wie man ein Erkennungsmodul schreibt
• Wie man einen Drucker schreibt

Einschränkungen

• Inline-Funktionen werden nicht korrekt verarbeitet.
• Da es über der SIERRA-Darstellung arbeitet, ist es nicht möglich, den Ort eines Fehlers im Quellcode zu melden, sondern wir können nur SIERRA-Anweisungen/ das, was in einem SIERRA-Programm verfügbar ist, melden.