Raptor

Raptor ist ein Framework zur Überprüfung des Blockchain-Ökosystems (Verträge, Protokolle usw.).

Übersicht

Raptor bietet strukturierte Ansätze und Werkzeuge zur Identifizierung von Sicherheitslücken in Smart Contracts und Blockchain-Protokollen. Das Framework hilft Prüfern, Ergebnisse konsistent zu dokumentieren und Berichte für mehrere Audit-Plattformen zu generieren.

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

Starten Sie dann Ihre Shell neu oder führen Sie Folgendes aus:

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

Installation überprüfen:

raptor --version

Aktualisieren von Raptor

Auf die neueste Version aktualisieren

# Update to latest stable version
raptor update

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

Auf eine Hauptversion upgraden

# 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

Verfügbare Versionen auflisten

# List all available versions
raptor version --list

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

Funktionen

JSON-basierte Ergebnisse: Speichert Ergebnisse als strukturiertes JSON gemäß einem definierten Schema
Plattformübergreifende Berichte: Generieren Sie Berichte für Sherlock, Code4rena und CodeHawks
Git-Integration: Klonen Sie Ziel-Repositorys direkt während der Projektinitialisierung
Plugin-System: Erweiterbare Plugin-Architektur mit Abhängigkeitsverwaltung und Mehrfachversionsunterstützung
Flexibler Arbeitsablauf: Erstellen Sie Ergebnisse und generieren Sie Berichte unabhängig oder gemeinsam

Dateistruktur

raptor/
├── bin/                   # CLI-Programme und Module
│   ├── raptor            # Hauptprogramm von Raptor CLI
│   └── cli/              # CLI-Modulcode
│       ├── __init__.py   # Versionsinformationen
│       ├── config.py     # Konfigurationsverwaltung
│       ├── finding.py    # Verwaltung von Ergebnissen
│       ├── git.py        # Verwaltung von Git-Repositorys
│       ├── init.py       # Projektinitialisierung
│       ├── plugin_lock.py      # Verwaltung von Plugin-Sperrdateien
│       ├── plugin_manager.py   # Plugin-Erkennung und -Installation
│       ├── raptor.py     # Haupt-CLI-Logik
│       ├── report.py     # Berichtsgenerierung
│       ├── update.py     # Versionsverwaltung
│       └── version_utils.py    # Versionsanalyse und -vergleich
├── scripts/              # Verzeichnis für benutzerdefinierte Skripte
├── schemas/              # Berichtsvorlagen und Ergebnis-Schemata
│   ├── reports/
│   │   ├── sherlock-report.yml   # Sherlock-Vorlage
│   │   ├── code4rena-report.yml  # Code4rena-Vorlage
│   │   └── codehawks-report.yml  # CodeHawks-Vorlage
│   └── findings/
│       └── finding-schema.json   # JSON-Schema für Ergebnisse
├── CONFIGURATION.md      # Konfigurationsanleitung
├── CONTRIBUTING.md       # Richtlinien für Beiträge
├── install.sh            # Installationsskript
├── raptor.toml           # Framework-Konfiguration
└── README.md             # Diese Datei

Berichtsvorlagen

Raptor unterstützt die Generierung von Berichten für mehrere Audit-Plattformen:

Sherlock: Community-gesteuerte Audit-Wettbewerbe
Code4rena: Wettbewerbsorientierte Audit-Plattform
CodeHawks: Cyfrins Audit-Plattform

Jede Plattform hat spezifische Formatierungsanforderungen. Raptor speichert Ergebnisse in einem strukturierten JSON-Format und wandelt sie in das entsprechende Markdown-Format für jede Plattform um.

Speicherorte der Vorlagen:

Framework-Vorlagen: ~/.raptor/schemas/reports/
Projekt-Vorlagen: <project>/audits/reports/.templates/
Benutzerdefinierte Vorlagen: Konfigurierbar über raptor.toml

Siehe CONFIGURATION.md zum Hinzufügen benutzerdefinierter Berichtsformate.

Verwendung

CLI-Tool

Raptor bietet eine Befehlszeilenschnittstelle zur Verwaltung von Audit-Projekten:

# 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

Hauptfunktionen:

JSON-basierte Ergebnisse: Alle Ergebnisse werden als JSON gemäß einem strukturierten Schema gespeichert
Mehrere Berichtsformate: Generieren Sie Berichte für Sherlock-, Code4rena- und CodeHawks-Plattformen
Git-Integration: Klonen Sie Repositorys mit --git-url oder verwalten Sie sie mit raptor git-Befehlen
Flache Klone: Standardmäßig werden Repos mit --depth 1 für schnellere Downloads geklont
Flexibles Reporting: Generieren Sie Berichte für alle oder bestimmte Ergebnisse

Plugin-System

Raptor unterstützt eine erweiterbare Plugin-Architektur mit automatischer Abhängigkeitsverwaltung und Mehrfachversionsunterstützung.

Plugins verwalten

# 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

Unterstützung mehrerer Versionen

Raptor ermöglicht die parallele Installation mehrerer Versionen desselben Plugins:

# 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

Plugin-Sperrdatei

Installierte Plugins werden in .plugins.lock verfolgt, das Folgendes aufzeichnet:

Alle installierten Versionen pro Plugin
Aktive Version für jedes Plugin
Installationsquelle (explizit vs. Abhängigkeit)
Installationsort (Projekt vs. global)
Abhängigkeitsbeziehungen

Erstellen benutzerdefinierter Plugins

Fügen Sie Plugins zu raptor.toml hinzu:

[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"

Versionsbeschränkungen:

"1.0.0" oder "@1.0.0" - Exakte Version
">=1.0.0" - Mindestversion
">1.0.0" - Größer als Version
"<=2.0.0" - Höchstversion
"<2.0.0" - Weniger als Version

Beispiel-Workflow

Initialisieren Sie ein neues Audit-Projekt mit raptor init my-audit
Klonen Sie das Zielvertrags-Repository mit raptor git add https://github.com/user/repo.git
Analysieren Sie den Code und identifizieren Sie Schwachstellen
Dokumentieren Sie Ergebnisse mit raptor finding --new "Title" --severity HIGH
Generieren Sie plattformspezifische Berichte mit raptor report --format sherlock code4rena
Reichen Sie die Berichte bei der entsprechenden Audit-Plattform ein

Konfiguration

Siehe CONFIGURATION.md für eine detaillierte Konfigurationsanleitung.

Mitwirken

Bitte lesen Sie unseren Leitfaden zum Mitwirken.

Verhaltenskodex

Bitte seien Sie in allen Interaktionen respektvoll und professionell. Wir sind alle hier, um gemeinsam zu lernen und das Projekt zu verbessern.

Zukünftige Erweiterungen

Zusätzliche Berichtsvorlagen für Plattformen
Automatisierte Validierung von Ergebnissen
Integration mit bekannten Sicherheitstools
Erweiterte CLI-Funktionen

Lizenz

Lizenziert unter entweder der Apache License, Version 2.0 oder der MIT License nach Ihrer Wahl.

Sofern Sie nicht ausdrücklich etwas anderes angeben, wird jeder von Ihnen absichtlich zur Aufnahme in diese Kisten eingereichte Beitrag, wie in der Apache-2.0-Lizenz definiert, wie oben doppelt lizenziert, ohne zusätzliche Bedingungen.

Haftungsausschluss

Dieses Framework dient nur zu Bildungszwecken und für autorisierte Sicherheitstests. Holen Sie stets die ordnungsgemäße Genehmigung ein, bevor Sie Sicherheitsaudits durchführen.

raptor

Beliebteste