eburger

Contratos inteligentes basados ​​en plantillas Analizador estático

Discordia | Discusiones | Solicitud de función | Wiki | Twitter DM

¿Qué es la eburgadora?

Ebugger es una herramienta de análisis estático que proporciona una forma de consultar y analizar rápidamente los contratos inteligentes de solidez.

Crea tu plantilla

Ejecute su plantilla

Ejecutar analizadores estáticos no ganará sus competiciones. Lo que proporcionamos en su lugar con Eburger es la capacidad de girar plantillas personalizadas adaptadas a su proyecto auditado actual en minutos (wiki) que le permite orquestar búsquedas únicas a través de la base de código para capacitar a sus auditorías.

• Cómo instalar
• Cómo correr
  • Cómo ejecutar - Simple
  • Cómo ejecutar - Avanzado
• ¿Cómo se ve?
• Soporte SARIF
• Acción de github
• Plantillas contribuyentes
• Tabla de comparación
• Características
• Qué está faltando

Cómo instalar

De Pypi

 pip3 install eburger
eburger -h

De la fuente

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

Cómo correr

Ejemplos simples

Más simple

 cd MyProject/
eburger
cat eburger-output.json

Salida SARIF

eburger -f MyProject/ -o sarif

Salida de Markdown (que se ejecuta desde el directorio del proyecto)

eburger -o markdown

Escaneo enfocado de un solo archivo y sus dependencias

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

Solo imprima el recuento NSLOC

eburger -f MyProject/ --nsloc

Ejecutar plantillas YAML personalizadas

eburger -t MyCustomYAMLs/ -f MyProject/

Uso avanzado

Consulte el wiki.

Como se ve

Aquí hay un video de demostración

ebugger.mov

Además de eburger-output.json , el ejemplo anterior también generará información extendida en la carpeta .eburger .

Soporte SARIF

SARIF (Formato de intercambio de resultados de análisis de análisis estático) es un formato estándar para los resultados de la herramienta de análisis estático.

Para que una GUI interactiva se abra en VScode que puede organizarse e interactuar con los resultados encontrados, siga estos pasos:

• Instale el espectador SARIF de Microsoft VScode ExtenStion
• Ejecutar eburger --output sarif
• Desde dentro de VScode, haga clic en el archivo eburger-output.sarif resultado colocado en el directorio de trabajo

Esto abrirá un menú Vscode interactivo con los problemas, la descripción, la navegación de las líneas de código vulnerables, etc.

Acción de github

Las tuberías de CI son compatibles a través de la acción de GitHub de acción eburger, ayuda continuamente a evaluar su código y ver las ideas elevadas en el panel de seguridad de su repositorio.

Visite la página de la acción para obtener más información.

Plantillas contribuyentes

Las plantillas se pueden agregar creando nuevos archivos YAML y cargarlos con eburger -t mytemplate.yaml . o colocándolos bajo las templates/ directorio.

Si prefiere jugar con Eburger en el navegador antes de la instalación, puede probar la instancia dedicada del cuaderno Jupyter:

Si está utilizando Eburger como un paquete Python (instalado a través de PIP Install), la ubicación de plantillas existente se puede encontrar con pip3 show eburger en ejecución o ejecutando la herramienta en un contrato y viendo la ruta de las plantillas impresas en la consola.

Para la redacción y documentación de la plantilla, consulte el wiki.

Tabla de comparación

Comparación de analizadores estáticos de contrato inteligente de solidez de solidez activa / popular

Analizador estático	Idioma	2 minutos para escribir una plantilla personalizada con chatgpt	Acción de github	Muchos hallazgos que ya se encuentran antes de que comenzara el concurso	Me gustaría comer
eburbor	Pitón	✅	✅		✅
Deslizarse	Pitón		✅	✅
4naly3er	Tipos mecanografiados?			✅
Mio	Pitón
Aderyn	Óxido

¿Olvidó uno o cometió un error? Abra una solicitud de extracción o un problema :)

Características

• Soporte de plantilla YAML para consultar la estructura del contrato y aumentar los conocimientos para cualquier coincidencia
• Curva de aprendizaje rápido para crear plantillas, capacidad de personalizar plantillas al proyecto de auditoría actual actual
• Soporte de Foundry y Hardhat ❣️
• Soporte SARIF e integración de GUI VScode
• Integración de acciones de GitHub a través de la acción de la ébugger
• Informe de Markdown
• Generación de plantillas personalizada rápida a través del generador de plantillas de Eburger GPT
• Comunidad y apoyo gratuito a través de Discord

Qué está faltando

¿Qué características te gustaría ver? ¡Háganos saber!