Caracal

Caracal é uma ferramenta de análise estática sobre a representação SIERRA para contratos inteligentes Starknet.

Funcionalidades

• Detectores para detectar código Cairo vulnerável
• Impressoras para relatar informações
• Análise de taint
• Estrutura de análise de fluxo de dados
• Fácil de executar em projetos Scarb

Instalação

Binários pré-compilados

Binários pré-compilados estão disponíveis na nossa página de releases. Se você estiver usando o compilador Cairo 1.x.x, use o binário v0.1.x; caso contrário, se estiver usando o compilador Cairo 2.x.x, use v0.2.x.

Compilando a partir do código fonte

Você precisa do compilador Rust e do Cargo. Compilando a partir do git:

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

Compilando a partir de uma cópia local:

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

Uso

Listar detectores:

caracal detectors

Listar impressoras:

caracal printers

Autônomo

Para usar com um arquivo cairo autônomo e você possui um binário local do compilador cairo, basta apontá-lo para o arquivo. Caso contrário, um compilador empacotado é usado e você precisa passar o caminho para a biblioteca corelib usando a opção --corelib da CLI ou definindo a variável de ambiente CORELIB_PATH.
Executar detectores:

caracal detect path/file/to/analyze

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

Executar impressoras:

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

Projeto Cairo

Se você tem um projeto Cairo com vários arquivos e contratos, pode ser necessário especificar quais contratos com --contract-path. O binário local do compilador Cairo é usado se disponível; caso contrário, um compilador empacotado é usado. Neste último caso, você também precisa especificar o corelib, conforme explicado acima para o caso autônomo. O caminho é o diretório onde o cairo_project.toml reside.
Executar detectores:

caracal detect path/to/dir

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

Executar impressoras:

caracal print path/to/dir --printer printer_to_use

Scarb

Se você tem um projeto que usa Scarb, precisa adicionar o seguinte no Scarb.toml:

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

[cairo]
sierra-replace-ids = true

Em seguida, passe o caminho para o diretório onde o Scarb.toml reside. Executar detectores:

caracal detect path/to/dir

Executar impressoras:

caracal print path/to/dir --printer printer_to_use

Detectores

A coluna Cairo representa a(s) versão(ões) do compilador para as quais o detector é válido.

Impressoras

• cfg: Exporta o CFG de cada função para um arquivo .dot
• callgraph: Exporta o grafo de chamadas de funções para um arquivo .dot

Como contribuir

Confira a wiki sobre os seguintes tópicos:

• Como escrever um detector
• Como escrever uma impressora

Limitações

• Funções inline não são tratadas corretamente.
• Por operar sobre a representação SIERRA, não é possível relatar onde um erro está no código fonte; podemos apenas relatar instruções SIERRA/o que está disponível em um programa SIERRA.