Caracal

Caracal은 Starknet 스마트 계약을 위한 SIERRA 표현에 대한 정적 분석 도구입니다.

기능

• 취약한 Cairo 코드를 감지하는 탐지기
• 정보를 보고하는 프린터
• 오염 분석 (Taint analysis)
• 데이터 흐름 분석 프레임워크
• 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 파일로 내보내기

기여 방법

다음 주제에 대한 위키를 확인하십시오:

• 탐지기 작성 방법
• 프린터 작성 방법

제한 사항

• 인라인 함수는 올바르게 처리되지 않습니다.
• SIERRA 표현 위에서 동작하므로 소스 코드에서 오류 위치를 보고할 수 없으며, SIERRA 명령어/SIERRA 프로그램에서 사용 가능한 정보만 보고할 수 있습니다.