Caracal

Caracal 是一个针对 Starknet 智能合约的 SIERRA 表示的静态分析工具。

功能特点

• 检测器：检测易受攻击的 Cairo 代码
• 打印器：报告信息
• 污点分析
• 数据流分析框架
• 易于在 Scarb 项目中运行

安装

预编译二进制文件

预编译的二进制文件可在我们的发布页面获取。如果您使用的是 Cairo 编译器 1.x.x，请使用 v0.1.x 二进制文件；如果您使用的是 Cairo 编译器 2.x.x，请使用 v0.2.x。

从源码构建

您需要安装 Rust 编译器和 Cargo。 从 git 构建：

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

从本地副本构建：

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

使用方法

列出检测器：

caracal detectors

列出打印器：

caracal printers

独立使用

要使用独立的 Cairo 文件，并且您有本地的 Cairo 编译器二进制文件，只需将其指向该文件即可。否则，将使用捆绑的编译器，并且您需要通过 --corelib 命令行选项或设置 CORELIB_PATH 环境变量来传递 corelib 库的路径。
运行检测器：

caracal detect path/file/to/analyze

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

运行打印器：

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

Cairo 项目

如果您有一个包含多个文件和合约的 Cairo 项目，可能需要通过 --contract-path 指定合约。如果可用，将使用本地的 Cairo 编译器二进制文件；否则将使用捆绑的编译器。在后一种情况下，您还需要按照独立使用情况中所述指定 corelib。路径是 cairo_project.toml 所在的目录。
运行检测器：

caracal detect path/to/dir

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

运行打印器：

caracal print path/to/dir --printer printer_to_use

Scarb

如果您有一个使用 Scarb 的项目，您需要在 Scarb.toml 中添加以下内容：

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

[cairo]
sierra-replace-ids = true

然后传递 Scarb.toml 所在目录的路径。 运行检测器：

caracal detect path/to/dir

运行打印器：

caracal print path/to/dir --printer printer_to_use

检测器

Cairo 列表示该检测器适用的编译器版本。

打印器

• cfg：将每个函数的 CFG 导出为 .dot 文件
• callgraph：将函数调用图导出为 .dot 文件

如何贡献

请查看以下主题的 wiki：

• 如何编写检测器
• 如何编写打印器

局限性

• 内联函数无法正确处理。
• 由于它基于 SIERRA 表示运行，因此无法报告源码中的错误位置，我们只能报告 SIERRA 指令 / SIERRA 程序中可用的信息。