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 CLI オプションまたは 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 プログラムで利用可能な情報のみを報告できます。