Caracal

Caracal est un outil d'analyse statique basé sur la représentation SIERRA pour les contrats intelligents Starknet.

Fonctionnalités

• Détecteurs pour repérer du code Cairo vulnérable
• Imprimantes pour rapporter des informations
• Analyse de flux de données contaminé (taint analysis)
• Cadre d'analyse de flux de données
• Facile à exécuter dans les projets Scarb

Installation

Binaires précompilés

Des binaires précompilés sont disponibles sur notre page des versions. Si vous utilisez le compilateur Cairo 1.x.x, utilisez le binaire v0.1.x ; sinon, si vous utilisez le compilateur Cairo 2.x.x, utilisez v0.2.x.

Construction à partir des sources

Vous avez besoin du compilateur Rust et de Cargo. Construction depuis git :

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

Construction à partir d'une copie locale :

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

Utilisation

Lister les détecteurs :

caracal detectors

Lister les imprimantes :

caracal printers

Autonome

Pour utiliser avec un fichier Cairo autonome et si vous avez un binaire du compilateur Cairo local, il suffit de le pointer vers le fichier. Sinon, un compilateur intégré est utilisé et vous devez fournir le chemin vers la bibliothèque corelib soit avec l'option CLI --corelib, soit en définissant la variable d'environnement CORELIB_PATH.
Exécuter les détecteurs :

caracal detect path/file/to/analyze

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

Exécuter les imprimantes :

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

Projet Cairo

Si vous avez un projet Cairo avec plusieurs fichiers et contrats, vous devrez peut-être spécifier quels contrats avec --contract-path. Le binaire du compilateur Cairo local est utilisé s'il est disponible, sinon un compilateur intégré est utilisé. Dans ce dernier cas, vous devez également spécifier le corelib comme expliqué ci-dessus pour le cas autonome. Le chemin est le répertoire où se trouve cairo_project.toml.
Exécuter les détecteurs :

caracal detect path/to/dir

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

Exécuter les imprimantes :

caracal print path/to/dir --printer printer_to_use

Scarb

Si vous avez un projet qui utilise Scarb, vous devez ajouter ce qui suit dans Scarb.toml :

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

[cairo]
sierra-replace-ids = true

Ensuite, fournissez le chemin vers le répertoire où se trouve Scarb.toml. Exécuter les détecteurs :

caracal detect path/to/dir

Exécuter les imprimantes :

caracal print path/to/dir --printer printer_to_use

Détecteurs

La colonne Cairo représente la ou les versions du compilateur pour lesquelles le détecteur est valide.

Imprimantes

• cfg : Exporte le CFG de chaque fonction dans un fichier .dot
• callgraph : Exporte le graphe d'appels de fonctions dans un fichier .dot

Comment contribuer

Consultez le wiki sur les sujets suivants :

• Comment écrire un détecteur
• Comment écrire une imprimante

Limitations

• Les fonctions inline ne sont pas traitées correctement.
• Comme il fonctionne sur la représentation SIERRA, il n'est pas possible de signaler où se trouve une erreur dans le code source, nous ne pouvons signaler que les instructions SIERRA / ce qui est disponible dans un programme SIERRA.