eburger

Vorlagenbasierte Smart Contracts statischer Analysator

Zwietracht | Diskussionen | Feature -Anfrage | Wiki | Twitter DM

Was ist Eburger

Eburger ist ein statisches Analyse -Tool, das eine Möglichkeit bietet, Smart Contracts für Solidität schnell abzufragen und zu analysieren.

Erstellen Sie Ihre Vorlage

Führen Sie Ihre Vorlage aus

Durch das Durchführen statischer Analysatoren werden Sie keine Wettbewerbe gewinnen. Was wir stattdessen mit Eburger zur Verfügung stellen, ist die Möglichkeit, benutzerdefinierte Vorlagen zu spinnen, die in Minuten (Wiki) auf Ihr aktuelles geprüftes Projekt zugeschnitten sind, sodass Sie einzigartige Lookups durch die Codebasis orchestrieren können, um Ihre Audits zu stärken.

• So installieren
• Wie man rennt
  • Wie man rennt - einfach
  • Wie man rennt - Fortgeschrittene
• Wie sieht es aus?
• Sarif -Unterstützung
• Github -Aktion
• Vorlagen beitragen
• Vergleichstabelle
• Merkmale
• Was fehlt

So installieren

Von pypi

 pip3 install eburger
eburger -h

Von Quelle

 git clone https://github.com/forefy/eburger.git
cd eburger
pip3 install .
eburger -h

Wie man rennt

Einfache Beispiele

Einfachste

 cd MyProject/
eburger
cat eburger-output.json

Sarif -Ausgabe

eburger -f MyProject/ -o sarif

Markdown -Ausgabe (Aus dem Verzeichnis des Projekts ausgeführt)

eburger -o markdown

Fokussierter Scan einer einzelnen Datei und ihrer Abhängigkeiten

eburger -f ../ProjectToScan/src/SomeContract.sol

Drucken Sie nur die NSLOC -Anzahl

eburger -f MyProject/ --nsloc

Führen Sie benutzerdefinierte YAML -Vorlagen aus

eburger -t MyCustomYAMLs/ -f MyProject/

Erweiterte Verwendung

Beziehen Sie sich auf das Wiki.

Wie es aussieht, wie es aussieht

Hier ist ein Demo -Video

Eburger.Mov

Neben eburger-output.json generiert oben auch erweiterte Informationen unter dem Ordner .eburger .

Sarif -Unterstützung

SARIF (statische Analyseergebnisse Interchange -Format) ist ein Standardformat für die Ergebnisse der statischen Analyse -Tools.

Um eine interaktive GUI in VSCODE zu öffnen, die die gefundenen Ergebnisse organisieren und mit den Ergebnissen interagieren kann, folgen Sie folgenden Schritten:

• Installieren Sie die Sarif Viewer VSCODE Extension von Microsoft
• Führen Sie eburger --output sarif aus
• Klicken Sie innerhalb von VSCODE auf die entstandene eburger-output.sarif Datei, die im Arbeitsverzeichnis platziert ist

Dadurch wird ein interaktives VSCODE -Menü mit den Problemen, der Beschreibung, der Navigation verletzlicher Codestellen usw. geöffnet.

Github -Aktion

CI-Pipelines werden über die Eburger-Action-Github-Aktion unterstützt. Sie hilft dabei, Ihren Code kontinuierlich zu bewerten und die erhöhten Erkenntnisse in das Sicherheitsbereich Ihres Repos anzuzeigen.

Besuchen Sie die Seite der Aktion für weitere Informationen.

Vorlagen beitragen

Vorlagen können durch Erstellen neuer YAML -Dateien hinzugefügt und entweder mit eburger -t mytemplate.yaml . oder durch Platzieren Sie sie unter die templates/ Verzeichnisse.

Wenn Sie vor der Installation lieber mit Eburger auf dem Browser spielen möchten, können Sie die dedizierte Jupyter -Notebook -Instanz ausprobieren:

Wenn Sie Eburger als Python -Paket verwenden (installiert über PIP -Installation), befindet sich der vorhandene Vorlagenort mit laufender pip3 show eburger oder durch Ausführen des Tools für einen Vertrag und Sehenswürdigkeit des Vorlagenpfads, der zur Konsole gedruckt ist.

Für das Schreiben und die Dokumentation von Vorlagen finden Sie im Wiki.

Vergleichstabelle

Vergleich von aktiv gepflegten / beliebten Smart Contract -statischen Analysatoren in Smart Contract

Statischer Analysator	Sprache	2 Minuten, um eine benutzerdefinierte Vorlage mit Chatgpt zu schreiben	Github -Aktion	Viele Ergebnisse, die bereits vor Beginn des Wettbewerbs gefunden wurden	Würde essen wollen wollen
Eburger	Python	✅	✅		✅
Slide	Python		✅	✅
4naly3er	Typscript?			✅
Mythril	Python
ADERN	Rost

Einen vergessen oder einen Fehler gemacht? Öffnen Sie eine Pull -Anfrage oder ein Problem :)

Merkmale

• YAML -Vorlagenunterstützung bei der Abfragevertragsstruktur und sammeln Erkenntnisse für alle Übereinstimmungen
• Schnelle Lernkurve zum Erstellen von Vorlagen, Fähigkeit, Vorlagen an das aktuelle laufende Audit -Projekt anzupassen
• Gießerei und Hardhat -Unterstützung ❣️
• Sarif Support & VSCODE GUI -Integration
• Integration von Github-Aktionen durch Eburger-Action
• Markdown -Bericht
• Schnelle benutzerdefinierte Vorlageerzeugung über die Eburger -Vorlagen Generator GPT
• Gemeinschaft und kostenlose Unterstützung durch Zwietracht

Was fehlt

Welche Funktionen möchten Sie sehen? Lass es uns wissen!