eburger

Analyseur statique des contrats intelligents basés sur un modèle

Discorde | Discussions | Demande de fonctionnalité | Wiki | Twitter dm

Qu'est-ce que Eburger

Eburger est un outil d'analyse statique qui fournit un moyen d'interroger rapidement et d'analyser les contrats intelligents de la solidité.

Créez votre modèle

Exécutez votre modèle

La course à pied des analyseurs statiques ne vous gagnera pas les compétitions. Ce que nous fournissons à la place avec Eburger, c'est la possibilité de tourner des modèles personnalisés adaptés à votre projet audité actuel en quelques minutes (wiki) vous permettant d'orchestrer des recherches uniques via la base de code pour permettre à vos audits.

• Comment installer
• Comment courir
  • Comment courir - simple
  • Comment fonctionner - avancé
• À quoi ça ressemble?
• Support Sarif
• Action github
• Modèles contributifs
• Table de comparaison
• Caractéristiques
• Que manque-t-il

Comment installer

De PYPI

 pip3 install eburger
eburger -h

De la source

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

Comment courir

Exemples simples

Le plus simple

 cd MyProject/
eburger
cat eburger-output.json

Sortie Sarif

eburger -f MyProject/ -o sarif

Sortie Markdown (en cours d'exécution du répertoire du projet)

eburger -o markdown

Analyse ciblée d'un seul fichier et de ses dépendances

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

Uniquement imprimer le nombre de NSLoc

eburger -f MyProject/ --nsloc

Exécutez des modèles YAML personnalisés

eburger -t MyCustomYAMLs/ -f MyProject/

Utilisation avancée

Reportez-vous au wiki.

À quoi ça ressemble

Voici une vidéo de démonstration

eburger.mov

Outre eburger-output.json , l'exemple ci-dessus générera également des informations prolongées sous le dossier .eburger .

Support Sarif

Sarif (Résultats de l'analyse statique Format d'échange) est un format standard pour les résultats de l'outil d'analyse statique.

Pour avoir une interface graphique interactive ouverte dans VSCODE qui peut organiser et interagir avec les résultats trouvés, suivez ces étapes:

• Installez l'extenstion de la visionneuse Sarif de Microsoft
• Run eburger --output sarif
• À partir de VSCODE, cliquez sur le fichier eburger-output.sarif résulté dans le répertoire de travail

Cela ouvrira un menu VScode interactif avec les problèmes, la description, la navigation des lignes de code vulnérables, etc.

Action github

Les pipelines CI sont pris en charge via l'action Eburger-Action GitHub, il aide à évaluer en permanence votre code et à consulter les informations surélevées sur le volet de sécurité de votre repo.

Visitez la page de l'action pour plus d'informations.

Modèles contributifs

Les modèles peuvent être ajoutés en créant de nouveaux fichiers YAML et en les chargeant avec eburger -t mytemplate.yaml . ou en les plaçant sous les templates/ répertoire.

Si vous préférez jouer avec Eburger sur le navigateur avant l'installation, vous pouvez essayer l'instance de cahier Jupyter dédiée:

Si vous utilisez Eburger comme package Python (installé via PIP Installer), l'emplacement des modèles existants peut être trouvé avec l'exécution pip3 show eburger ou en exécutant l'outil sur un contrat et en voyant le chemin des modèles imprimé vers la console.

Pour la rédaction et la documentation des modèles, reportez-vous au wiki.

Table de comparaison

Comparaison des analyseurs statiques du contrat intelligent Solidity Solidity activement maintenu / populaire

Analyseur statique	Langue	2 minutes pour écrire un modèle personnalisé avec chatppt	Action github	De nombreuses conclusions qui sont déjà trouvées avant le début du concours	Voudrait manger
Eburger	Python	✅	✅		✅
Glisser	Python		✅	✅
4naly3er	TypeScript?			✅
Mythril	Python
Adery	Rouiller

Vous avez oublié un ou fait une erreur? Ouvrez une demande de traction ou un problème :)

Caractéristiques

• Prise en charge du modèle YAML pour interroger la structure du contrat et soulever des informations pour toutes les correspondances
• Courbe d'apprentissage rapide pour la création de modèles, capacité à personnaliser les modèles au projet d'audit en cours actuel
• Fonderie et support dur ❣️
• Support Sarif et intégration VSCODE GUI
• Intégration des actions de GitHub via Eburger-action
• Rapport Markdown
• Génération rapide de modèles personnalisés via le générateur de modèles Eburger GPT
• Support communautaire et gratuit via Discord

Que manque-t-il

Quelles fonctionnalités aimeriez-vous voir? Faites-le nous savoir!