eburger

Analisador estático baseado em modelo baseado em modelos

Discord | Discussões | Solicitação de recurso | Wiki | Twitter DM

O que é eburger

O Eburger é uma ferramenta de análise estática que fornece uma maneira de consultar rapidamente e analisar contratos inteligentes da Solidity.

Crie seu modelo

Execute seu modelo

Os analisadores estáticos em execução não ganharão competições. O que fornecemos com o Eburger é a capacidade de aumentar os modelos personalizados adaptados ao seu projeto auditado atual em minutos (Wiki), permitindo que você orquestre pesquisas exclusivas através da base de código para capacitar suas auditorias.

• Como instalar
• Como correr
  • Como correr - simples
  • Como correr - avançado
• Como parece?
• Suporte de Sarif
• Ação do GitHub
• Modelos contribuintes
• Tabela de comparação
• Características
• O que está faltando

Como instalar

De Pypi

 pip3 install eburger
eburger -h

Da fonte

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

Como correr

Exemplos simples

Mais simples

 cd MyProject/
eburger
cat eburger-output.json

Saída SARIF

eburger -f MyProject/ -o sarif

Saída de marcação (executando do diretório do projeto)

eburger -o markdown

Varredura focada de um único arquivo e suas dependências

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

Apenas imprimir contagem nsloc

eburger -f MyProject/ --nsloc

Execute modelos de YAML personalizados

eburger -t MyCustomYAMLs/ -f MyProject/

Uso avançado

Consulte o wiki.

Como parece

Aqui está um vídeo de demonstração

eburger.mov

Além eburger-output.json , o exemplo acima também gerará informações estendidas sob a pasta .eburger .

Suporte de Sarif

SARIF (Formato de intercâmbio de resultados da análise estática) é um formato padrão para resultados da ferramenta de análise estática.

Para que uma GUI interativa seja aberta no VSCode que possa organizar e interagir com os resultados encontrados, siga estas etapas:

• Instale a extensão do visualizador Sarif VSCODE da Microsoft
• Run eburger --output sarif
• De dentro do VSCODE, clique no arquivo eburger-output.sarif resultante colocado no diretório de trabalho

Isso abrirá um menu interativo do VSCode com os problemas, descrição, navegação de linhas de código vulneráveis, etc.

Ação do GitHub

Os pipelines do CI são suportados por meio da ação do Github de ação eburger, ajuda a avaliar continuamente seu código e visualizar as informações elevadas no painel de segurança do seu repo.

Visite a página da ação para obter mais informações.

Modelos contribuintes

Os modelos podem ser adicionados criando novos arquivos YAML e carregá -los com eburger -t mytemplate.yaml . ou colocando -os sob os templates/ diretório.

Se você preferir brincar com o eburger no navegador antes da instalação, você pode experimentar a instância dedicada do Jupyter Notebook:

Se você estiver usando o Eburger como um pacote Python (instalado via instalação PIP), o local dos modelos existentes poderá ser encontrado com a execução pip3 show eburger ou executando a ferramenta em um contrato e vendo o caminho dos modelos impressos no console.

Para redação e documentação de modelos, consulte o wiki.

Tabela de comparação

Comparação de analisadores estáticos de contrato inteligente mantidos / populares mantidos / populares

Analisador estático	Linguagem	2 minutos para escrever um modelo personalizado com chatgpt	Ação do GitHub	Muitas descobertas que já foram encontradas antes do início do concurso	Gostaria de comer
eburger	Python	✅	✅		✅
Deslize	Python		✅	✅
4naly3er	Datilografado?			✅
Mythril	Python
ADERYN	Ferrugem

Esqueceu um ou cometeu um erro? Abra um pedido de tração ou um problema :)

Características

• Suporte de modelo YAML para consultar a estrutura do contrato e aumentar as idéias para qualquer partida
• Curva de aprendizado rápido para criar modelos, capacidade de personalizar modelos para o atual projeto de auditoria em andamento
• Fundição e suporte hardhat ❣️
• Suporte Sarif e Integração da GUI do VSCODE
• Integração de ações do GitHub através da ação de eburger
• Relatório de Markdown
• Geração de modelo personalizado rápido através do Eburger Models Gerator GPT
• Comunidade e apoio gratuito via discórdia

O que está faltando

Que recursos você gostaria de ver? Deixe -nos saber!