Slither, der statische Analysator für Smart Contracts

Tritt dem Empire Hacking Slack bei

- Diskussionen und Support

Slither ist ein in Python3 geschriebenes statisches Analyse-Framework für Solidity und Vyper. Es führt eine Reihe von Schwachstellendetektoren aus, gibt visuelle Informationen über Vertragsdetails aus und bietet eine API, um benutzerdefinierte Analysen einfach zu schreiben. Slither ermöglicht Entwicklern, Schwachstellen zu finden, ihr Codeverständnis zu verbessern und schnell individuelle Analysen zu prototypisieren.

• Funktionen
• Verwendung
• Installation
  • Mit uv (empfohlen)
  • Mit Pip
  • Mit Git
  • Mit Docker
  • Integration
• Detektoren
• Printer
  • Schnellüberblick-Printer
  • Detaillierte Analyse-Printer
• Werkzeuge
• API-Dokumentation
• Hilfe
• FAQ
• Lizenz
• Veröffentlichungen
  • Veröffentlichungen von Trail of Bits
  • Externe Veröffentlichungen

Funktionen

• Erkennt verwundbaren Solidity-Code mit niedriger Falsch-Positiv-Rate (siehe die Liste der Trophäen)
• Identifiziert die Stelle im Quellcode, an der der Fehler auftritt
• Einfache Integration in Continuous Integration und Hardhat/Foundry-Builds
• Integrierte 'Printer' melden schnell wichtige Vertragsinformationen
• Detektor-API zum Schreiben benutzerdefinierter Analysen in Python
• Fähigkeit, Verträge zu analysieren, die mit Solidity >= 0.4 geschrieben wurden
• Zwischendarstellung (SlithIR) ermöglicht einfache, hochpräzise Analysen
• Analysiert korrekt 99,9% aller öffentlichen Solidity-Codes
• Durchschnittliche Ausführungszeit von weniger als 1 Sekunde pro Vertrag
• Integration in die Code-Scannung von GitHub in CI
• Unterstützung für Vyper-Smart Contracts

Verwendung

Führe Slither auf einer Hardhat/Foundry/Dapp/Brownie-Anwendung aus:```console slither .

Dies ist die bevorzugte Option, wenn Ihr Projekt Abhängigkeiten hat, da Slither auf dem zugrunde liegenden Kompilierungs-Framework basiert, um Quellcode zu kompilieren.

Sie können Slither jedoch auch auf einer einzelnen Datei ausführen, die keine Abhängigkeiten importiert:```console
slither tests/uninitialized.sol

Wie installieren

Hinweis Slither benötigt Python 3.10+. Falls Sie keines der unterstützten Compilierungs-Frameworks verwenden, benötigen Sie solc, den Solidity-Compiler. Wir empfehlen solc-select für den bequemen Wechsel zwischen solc-Versionen.

Verwendung von uv (empfohlen)

uv ist ein schneller Python-Paketmanager, der 10-100x schneller ist als pip.```console

Install uv if you haven't already

curl -LsSf https://astral.sh/uv/install.sh | sh

Install slither as a tool

uv tool install slither-analyzer

Or run slither without installation

uvx --from slither-analyzer slither

Zum Aktualisieren:```console
uv tool upgrade slither-analyzer

Mit Pip verwenden```console

python3 -m pip install slither-analyzer

Aktualisieren:```console
python3 -m pip install --upgrade slither-analyzer

Brew verwenden```console

brew install slither-analyzer

### Mit Git (Entwicklung)```bash
git clone https://github.com/crytic/slither.git && cd slither

# Install as editable for development
uv tool install -e .

# Or use uv run for testing without installation
uv run slither <target>

The -e flag installiert im bearbeitbaren Modus, was bedeutet, dass Änderungen am Quellcode sofort übernommen werden, ohne dass eine Neuinstallation erforderlich ist.

Docker verwenden

Verwenden Sie das Docker-Image eth-security-toolbox. Es enthält alle unsere Sicherheitstools und jede Hauptversion von Solidity in einem einzigen Image. /home/share wird im Container auf /share gemountet.```bash docker pull trailofbits/eth-security-toolbox

Um ein Verzeichnis im Container freizugeben:```bash
docker run -it -v /home/share:/share trailofbits/eth-security-toolbox

Integration

• Für die GitHub action Integration verwenden Sie slither-action.
• Für die pre-commit Integration verwenden Sie (ersetzen Sie $GIT_TAG durch das tatsächliche Tag) ```YAML
  • repo: https://github.com/crytic/slither rev: $GIT_TAG hooks:
    • id: slither
  root@kitploit:~

• Um einen Markdown-Bericht zu erstellen, verwenden Sie slither [target] --checklist.
• Um einen Markdown mit GitHub-Quellcode-Hervorhebung zu generieren, verwenden Sie slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/ (ersetzen Sie ORG, REPO, COMMIT)

Detektoren

Weitere Informationen finden Sie unter

• Die Detektor-Dokumentation für Details zu jedem Detektor
• Die Erkennungsauswahl zur Ausführung nur ausgewählter Detektoren. Standardmäßig werden alle Detektoren ausgeführt.
• Der Triage-Modus zur Filterung einzelner Ergebnisse

Printer

Schnellüberblick-Printer

• human-summary: Gibt eine menschenlesbare Zusammenfassung der Verträge aus
• inheritance-graph: Exportiert den Vererbungsgraphen jedes Vertrags in eine DOT-Datei
• contract-summary: Gibt eine Zusammenfassung der Verträge aus
• loc: Zählt die Gesamtzahl der Codezeilen (LOC), Quellcodezeilen (SLOC) und Kommentarzeilen (CLOC) in Quelldateien (SRC), Abhängigkeiten (DEP) und Testdateien (TEST).
• entry-points: Gibt alle zustandsändernden Einstiegspunktfunktionen und deren Variablen der Verträge aus

Detailprüfungs-Printer* call-graph: Exportiere den Call-Graphen der Verträge in eine dot-Datei

• cfg: Exportiere das CFG jeder Funktion
• function-summary: Drucke eine Zusammenfassung der Funktionen
• vars-and-auth: Drucke die geschriebenen Zustandsvariablen und die Autorisierung der Funktionen
• not-pausable: Drucke Funktionen, die den Modifikator whenNotPaused nicht verwenden.

Um einen Drucker auszuführen, verwende --print und eine kommagetrennte Liste von Druckern.

Siehe die Printer-Dokumentation für die vollständigen Listen.

Tools

• slither-check-upgradeability: Überprüfe die auf delegatecall basierende Upgradeability
• slither-prop: Automatische Unit-Tests und Eigenschaftsgenerierung
• slither-flat: Glätten einer Codebasis
• slither-check-erc: Überprüfe die ERC-Konformität
• slither-read-storage: Lese Speicherwerte aus Verträgen
• slither-interface: Generiere ein Interface für einen Vertrag

Siehe die Tool-Dokumentation für weitere Tools.

Kontaktiere uns, um Hilfe beim Erstellen benutzerdefinierter Tools zu erhalten.

API-Dokumentation

Die Dokumentation zu Slithers Interna ist hier verfügbar.

Hilfe erhalten

Besuche gerne unseren Slack-Kanal (#ethereum) für Hilfe bei der Nutzung oder Erweiterung von Slither.

• Die Printer-Dokumentation beschreibt die Informationen, die Slither für jeden Vertrag visualisieren kann.

• Die Detector-Dokumentation beschreibt, wie man eine neue Schwachstellenanalyse schreibt.

• Die API-Dokumentation beschreibt die Methoden und Objekte, die für benutzerdefinierte Analysen verfügbar sind.

• Die SlithIR-Dokumentation beschreibt die Zwischendarstellung SlithIR.

FAQ

Wie schließe ich Mocks oder Tests aus?

• Siehe unsere Dokumentation zur Pfadfilterung.

Wie behebe ich "unknown file" oder Kompilierungsprobleme?

• Da Slither den solc AST benötigt, müssen alle Abhängigkeiten verfügbar sein. Wenn ein Vertrag Abhängigkeiten hat, wird slither contract.sol fehlschlagen. Verwende stattdessen slither . im übergeordneten Verzeichnis von contracts/ (du solltest contracts/ sehen, wenn du ls ausführst). Wenn du einen node_modules/-Ordner hast, muss er sich im selben Verzeichnis wie contracts/ befinden. Um zu überprüfen, ob dieses Problem mit Slither zusammenhängt, führe den Kompilierungsbefehl für das von dir verwendete Framework aus, z.B. npx hardhat compile. Das muss erfolgreich funktionieren; andernfalls kann Slithers Kompilierungs-Engine, crytic-compile, den AST nicht generieren.

Lizenz

Slither ist unter der AGPLv3-Lizenz lizenziert und wird unter dieser vertrieben. Kontaktiere uns, wenn du eine Ausnahme von den Bedingungen suchst.

Veröffentlichungen

Veröffentlichung von Trail of Bits

• Slither: A Static Analysis Framework For Smart Contracts, Josselin Feist, Gustavo Grieco, Alex Groce - WETSEB '19

Externe Veröffentlichungen

Wenn du Slither in einer akademischen Arbeit verwendest, erwäge eine Bewerbung für den Crytic $10k Research Prize.