Raptor

Raptor est un framework pour auditer l'écosystème blockchain (contrats, protocoles, etc.).

Aperçu

Raptor fournit des approches et outils structurés pour identifier les vulnérabilités de sécurité dans les smart contracts et les protocoles blockchain. Le framework aide les auditeurs à documenter les résultats de manière cohérente et à générer des rapports pour plusieurs plateformes d'audit.

Installation

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

Redémarrez ensuite votre shell ou exécutez :

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

Vérifiez l'installation :

raptor --version

Mise à jour de Raptor

Mise à jour vers la dernière version

# Update to latest stable version
raptor update

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

Mise à niveau vers une version majeure

# Upgrade to latest major version
raptor upgrade

# Upgrade to specific major version
raptor upgrade v1.0.0

Rétrogradation

# Downgrade to previous version
raptor downgrade v0.1.0

Lister les versions disponibles

# List all available versions
raptor version --list

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

Fonctionnalités

Findings au format JSON : Stockez les findings sous forme de JSON structuré suivant un schéma défini
Rapports multiplateformes : Générez des rapports pour Sherlock, Code4rena et CodeHawks
Intégration Git : Clonez les dépôts cibles directement lors de l'initialisation du projet
Système de plugins : Architecture de plugins extensible avec gestion des dépendances et support multi-versions
Workflow flexible : Créez des findings et générez des rapports indépendamment ou ensemble

Structure des fichiers

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

Modèles de rapports

Raptor prend en charge la génération de rapports pour plusieurs plateformes d'audit :

Sherlock : Concours d'audit communautaires
Code4rena : Plateforme d'audit compétitive
CodeHawks : Plateforme d'audit de Cyfrin

Chaque plateforme a des exigences de formatage spécifiques. Raptor stocke les findings dans un format JSON structuré et les transforme au format Markdown approprié pour chaque plateforme.

Emplacements des modèles :

Modèles du framework : ~/.raptor/schemas/reports/
Modèles du projet : <project>/audits/reports/.templates/
Modèles personnalisés : Configurables via raptor.toml

Voir CONFIGURATION.md pour ajouter des formats de rapports personnalisés.

Utilisation

Outil CLI

Raptor fournit une interface en ligne de commande pour gérer les projets d'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

Fonctionnalités clés :

Findings JSON : Tous les findings sont stockés au format JSON suivant un schéma structuré
Formats de rapports multiples : Générez des rapports pour les plateformes Sherlock, Code4rena et CodeHawks
Intégration Git : Clonez des dépôts avec --git-url ou gérez-les avec les commandes raptor git
Clones superficiels : Par défaut, les dépôts sont clonés avec --depth 1 pour des téléchargements plus rapides
Rapports flexibles : Générez des rapports pour tous les findings ou pour des findings spécifiques

Système de plugins

Raptor supporte une architecture de plugins extensible avec gestion automatique des dépendances et support multi-versions.

Gestion des plugins

# 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

Support multi-versions

Raptor permet d'installer plusieurs versions du même plugin côte à côte :

# 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

Fichier de verrouillage des plugins

Les plugins installés sont suivis dans .plugins.lock qui enregistre :

Toutes les versions installées par plugin
La version active pour chaque plugin
La source d'installation (explicite ou dépendance)
L'emplacement d'installation (projet ou global)
Les relations de dépendance

Création de plugins personnalisés

Ajoutez des plugins dans 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"

Contraintes de version :

"1.0.0" ou "@1.0.0" - Version exacte
">=1.0.0" - Version minimale
">1.0.0" - Supérieure à la version
"<=2.0.0" - Version maximale
"<2.0.0" - Inférieure à la version

Exemple de workflow

Initialisez un nouveau projet d'audit avec raptor init mon-audit
Clonez le dépôt du contrat cible avec raptor git add https://github.com/utilisateur/repo.git
Analysez le code et identifiez les vulnérabilités
Documentez les findings avec raptor finding --new "Titre" --severity HIGH
Générez des rapports spécifiques à la plateforme avec raptor report --format sherlock code4rena
Soumettez les rapports à la plateforme d'audit appropriée

Configuration

Voir CONFIGURATION.md pour un guide de configuration détaillé.

Contribution

Veuillez lire notre Guide de contribution.

Code de conduite

Veuillez être respectueux et professionnel dans toutes les interactions. Nous sommes tous ici pour apprendre et améliorer le projet ensemble.

Améliorations futures

Modèles de rapports supplémentaires pour les plateformes
Validation automatisée des findings
Intégration avec des outils de sécurité populaires
Fonctionnalités CLI améliorées

Licence

Sous licence Apache License, Version 2.0 ou MIT License à votre choix.

Sauf indication contraire explicite, toute contribution soumise intentionnellement pour inclusion dans ces crates par vous, telle que définie dans la licence Apache-2.0, sera sous double licence comme ci-dessus, sans conditions ou termes supplémentaires.

Avertissement

Ce framework est destiné à des fins éducatives et de tests de sécurité autorisés uniquement. Obtenez toujours une autorisation appropriée avant de mener des audits de sécurité.

raptor

Populaires