Raptor

Raptor è un framework per l'audit dell'ecosistema blockchain (contratti, protocolli, ecc.).

Panoramica

Raptor fornisce approcci strutturati e strumenti per identificare vulnerabilità di sicurezza nei contratti intelligenti e nei protocolli blockchain. Il framework aiuta gli auditor a documentare i risultati in modo coerente e generare report per più piattaforme di audit.

Installazione

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

Quindi riavvia la shell o esegui:

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

Verifica l'installazione:

raptor --version

Aggiornare Raptor

Aggiornamento all'ultima versione

# Update to latest stable version
raptor update

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

Aggiornamento a una major version

# Upgrade to latest major version
raptor upgrade

# Upgrade to specific major version
raptor upgrade v1.0.0

Downgrade

# Downgrade to previous version
raptor downgrade v0.1.0

Elenca le versioni disponibili

# List all available versions
raptor version --list

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

Funzionalità

Findings in formato JSON: Memorizza i risultati come JSON strutturato seguendo uno schema definito
Report multi-piattaforma: Genera report per Sherlock, Code4rena e CodeHawks
Integrazione Git: Clona repository target direttamente durante l'inizializzazione del progetto
Sistema di Plugin: Architettura plugin estensibile con gestione delle dipendenze e supporto multi-versione
Workflow Flessibile: Crea findings e genera report in modo indipendente o insieme

Struttura dei File

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

Modelli di Report

Raptor supporta la generazione di report per più piattaforme di audit:

Sherlock: Concorsi di audit guidati dalla community
Code4rena: Piattaforma di audit competitiva
CodeHawks: Piattaforma di audit di Cyfrin

Ogni piattaforma ha requisiti di formattazione specifici. Raptor memorizza i risultati in un formato JSON strutturato e li trasforma nel formato markdown appropriato per ogni piattaforma.

Posizioni dei modelli:

Modelli del framework: ~/.raptor/schemas/reports/
Modelli del progetto: <project>/audits/reports/.templates/
Modelli personalizzati: Configurabili tramite raptor.toml

Vedi CONFIGURATION.md per aggiungere formati di report personalizzati.

Utilizzo

Strumento CLI

Raptor fornisce un'interfaccia a riga di comando per gestire progetti di audit:

# 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

Caratteristiche principali:

Findings in formato JSON: Tutti i risultati sono memorizzati come JSON seguendo uno schema strutturato
Formati di report multipli: Genera report per le piattaforme Sherlock, Code4rena e CodeHawks
Integrazione Git: Clona repository con --git-url o gestiscili con i comandi raptor git
Clone shallow: Per impostazione predefinita, i repo vengono clonati con --depth 1 per download più veloci
Report flessibile: Genera report per tutti i risultati o per specifici

Sistema di Plugin

Raptor supporta un'architettura plugin estensibile con gestione automatica delle dipendenze e supporto multi-versione.

Gestione dei Plugin

# 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

Supporto Multi-Versione

Raptor permette di installare più versioni dello stesso plugin affiancate:

# 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

File di blocco dei Plugin

I plugin installati vengono tracciati in .plugins.lock che registra:

Tutte le versioni installate per plugin
Versione attiva per ogni plugin
Fonte di installazione (esplicita vs dipendenza)
Posizione di installazione (progetto vs globale)
Relazioni di dipendenza

Creazione di Plugin Personalizzati

Aggiungi plugin a raptor.toml:

[plugins.my-plugin]
url = "https://raw.githubusercontent.com/user/repo/main/plugin/install.py"
version = ">=1.0.0"  # Optional version constraint
description = "My custom plugin"

# Or use local path
[plugins.local-plugin]
url = "/path/to/plugin"
# or relative path
url = "../my-plugins/analyzer"

Vincoli di versione:

"1.0.0" o "@1.0.0" - Versione esatta
">=1.0.0" - Versione minima
">1.0.0" - Maggiore della versione
"<=2.0.0" - Versione massima
"<2.0.0" - Minore della versione

Esempio di Workflow

Inizializza un nuovo progetto di audit con raptor init my-audit
Clona il repository del contratto target con raptor git add https://github.com/user/repo.git
Analizza il codice e identifica le vulnerabilità
Documenta i risultati usando raptor finding --new "Titolo" --severity HIGH
Genera report specifici per la piattaforma con raptor report --format sherlock code4rena
Invia i report alla piattaforma di audit appropriata

Configurazione

Vedi CONFIGURATION.md per una guida dettagliata alla configurazione.

Contribuire

Leggi la nostra Guida ai Contributi.

Codice di Condotta

Si prega di essere rispettosi e professionali in tutte le interazioni. Siamo tutti qui per imparare e migliorare insieme il progetto.

Miglioramenti Futuri

Modelli aggiuntivi per piattaforme di report
Validazione automatica dei risultati
Integrazione con strumenti di sicurezza popolari
Funzionalità CLI migliorate

Licenza

Concesso in licenza sotto Apache License, Versione 2.0 o MIT License a tua scelta.

Salvo diversa dichiarazione esplicita, qualsiasi contributo intenzionalmente inviato per l'inclusione in questi crate da te, come definito nella licenza Apache-2.0, sarà concesso in licenza duale come sopra, senza ulteriori termini o condizioni.

Dichiarazione di non responsabilità

Questo framework è destinato esclusivamente a scopi educativi e di test di sicurezza autorizzati. Ottenere sempre l'autorizzazione appropriata prima di condurre audit di sicurezza.

raptor

Più Popolari