Raptor

Raptor — это фреймворк для аудита экосистемы блокчейна (контрактов, протоколов и т.д.).

Обзор

Raptor предоставляет структурированные подходы и инструменты для выявления уязвимостей безопасности в смарт-контрактах и блокчейн-протоколах. Фреймворк помогает аудиторам последовательно документировать находки и создавать отчеты для нескольких аудиторских платформ.

Установка

curl

# Install latest stable version (recommended)
curl -sSL https://raw.githubusercontent.com/calvin-kimani/raptor/main/install.sh | bash

# Install specific version
curl -sSL https://raw.githubusercontent.com/calvin-kimani/raptor/main/install.sh | bash -s -- v0.1.0
curl -sSL https://raw.githubusercontent.com/calvin-kimani/raptor/main/install.sh | bash -s -- 0.1.0

clone

# Latest stable
git clone https://github.com/calvin-kimani/raptor.git /tmp/raptor-install
bash /tmp/raptor-install/install.sh
rm -rf /tmp/raptor-install

# Specific version
git clone https://github.com/calvin-kimani/raptor.git /tmp/raptor-install
bash /tmp/raptor-install/install.sh v0.1.5
rm -rf /tmp/raptor-install

Затем перезапустите оболочку или выполните:

source ~/.bashrc  # or ~/.zshrc for zsh

Проверка установки:

raptor --version

Обновление Raptor

Обновление до последней версии

# Update to latest stable version
raptor update

# Update to specific version
raptor update v0.2.5
raptor update 0.2.5

Обновление до мажорной версии

# Upgrade to latest major version
raptor upgrade

# Upgrade to specific major version
raptor upgrade v1.0.0

Откат

# Downgrade to previous version
raptor downgrade v0.1.0

Список доступных версий

# List all available versions
raptor version --list

# Show current version
raptor version --current
raptor --version

Возможности

• JSON-находки: Хранение находок в структурированном JSON по определённой схеме
• Мультиплатформенные отчёты: Генерация отчётов для Sherlock, Code4rena и CodeHawks
• Интеграция с Git: Клонирование целевых репозиториев напрямую при инициализации проекта
• Система плагинов: Расширяемая архитектура плагинов с управлением зависимостями и поддержкой нескольких версий
• Гибкий рабочий процесс: Создание находок и генерация отчётов как независимо, так и совместно

Структура файлов

raptor/
├── bin/                   # CLI executables and modules
│   ├── raptor            # Main Raptor CLI executable
│   └── cli/              # CLI module code
│       ├── __init__.py   # Version info
│       ├── config.py     # Configuration management
│       ├── finding.py    # Finding management
│       ├── git.py        # Git repository management
│       ├── init.py       # Project initialization
│       ├── plugin_lock.py      # Plugin lock file management
│       ├── plugin_manager.py   # Plugin discovery and installation
│       ├── raptor.py     # Main CLI logic
│       ├── report.py     # Report generation
│       ├── update.py     # Version management
│       └── version_utils.py    # Version parsing and comparison
├── scripts/              # Custom user scripts directory
├── schemas/              # Report templates and finding schemas
│   ├── reports/
│   │   ├── sherlock-report.yml   # Sherlock format template
│   │   ├── code4rena-report.yml  # Code4rena format template
│   │   └── codehawks-report.yml  # CodeHawks format template
│   └── findings/
│       └── finding-schema.json   # JSON schema for findings
├── CONFIGURATION.md      # Configuration guide
├── CONTRIBUTING.md       # Contribution guidelines
├── install.sh            # Installation script
├── raptor.toml           # Framework configuration
└── README.md             # This file

Шаблоны отчётов

Raptor поддерживает генерацию отчётов для нескольких аудиторских платформ:

• Sherlock: Аудиторские конкурсы на основе сообщества
• Code4rena: Конкурентная аудиторская платформа
• CodeHawks: Аудиторская платформа Cyfrin

Каждая платформа имеет особые требования к форматированию. Raptor хранит находки в структурированном формате JSON и преобразует их в соответствующий формат Markdown для каждой платформы.

Расположение шаблонов:

• Шаблоны фреймворка: ~/.raptor/schemas/reports/
• Шаблоны проекта: <project>/audits/reports/.templates/
• Пользовательские шаблоны: Настраиваются через raptor.toml

См. CONFIGURATION.md для добавления пользовательских форматов отчётов.

Использование

CLI-инструмент

Raptor предоставляет интерфейс командной строки для управления аудиторскими проектами:

# Initialize a new audit project
raptor init my-audit

# Force overwrite existing directory
raptor init my-audit --force

# Clone repositories during init (shallow by default)
raptor init --git-url https://github.com/user/repo.git

# Clone multiple repos with full commit history
raptor init --git-url URL1 URL2 --commit

# Add repositories to existing project (shallow by default)
raptor git add https://github.com/user/repo.git

# Add multiple repos with full history
raptor git add URL1 URL2 --commit

# List all repositories in src/
raptor git list

# Update all repositories
raptor git update

# Update specific repositories
raptor git update repo1 repo2

# Remove repositories
raptor git remove repo-name

# Create a new finding (stored as JSON)
raptor finding --new "Attacker will drain funds from stakers" --severity HIGH

# Create finding and immediately generate reports
raptor finding --new "Reentrancy in withdraw" --severity CRITICAL --report sherlock code4rena

# Generate reports for all findings (default: sherlock format)
raptor report

# Generate reports in specific formats
raptor report --format sherlock code4rena codehawks

# Generate report for specific finding
raptor report --format sherlock --finding HIGH-reentrancy-attack

Ключевые возможности:

• JSON-находки: Все находки хранятся в JSON по структурированной схеме
• Несколько форматов отчётов: Генерация отчётов для платформ Sherlock, Code4rena и CodeHawks
• Интеграция с Git: Клонирование репозиториев с помощью --git-url или управление ими через команды raptor git
• Поверхностное клонирование: По умолчанию репозитории клонируются с --depth 1 для ускорения загрузки
• Гибкая отчётность: Генерация отчётов для всех или конкретных находок

Система плагинов

Raptor поддерживает расширяемую архитектуру плагинов с автоматическим управлением зависимостями и поддержкой нескольких версий.

Управление плагинами

# List all available plugins
raptor plugins list
raptor plugins -l

# Install plugin to project (.plugins/)
raptor plugins install solidity-parser

# Install plugin globally (~/.raptor/bin/cli/plugins/)
raptor plugins install solidity-parser --global
raptor plugins -i solidity-parser -g

# Install multiple plugins
raptor plugins install parser-plugin graph-plugin

# Force reinstall
raptor plugins install solidity-parser --force
raptor plugins -i solidity-parser -f

# Check plugin status
raptor plugins status solidity-parser

Поддержка нескольких версий

Raptor позволяет устанавливать несколько версий одного плагина одновременно:

# First installation (becomes active version)
raptor plugins install solidity-parser
# Installs to: .plugins/solidity-parser/1.0.0/

# Install different version (previous remains active)
raptor plugins install solidity-parser
# Installs to: .plugins/solidity-parser/1.1.0/

# List shows all versions
raptor plugins list
# Output:
#   solidity-parser   [Project]    v1.0.0 (2 versions)
#                                   Versions: v1.0.0*, v1.1.0

# Switch active version
raptor plugins switch solidity-parser 1.1.0
# Output: ✓ Switched 'solidity-parser' from v1.0.0 to v1.1.0

Файл блокировки плагинов