eburger

Устатический анализатор на основе шаблонов.

Раздор | Обсуждения | Запрос функции | Вики | Twitter DM

Что такое Eburger

Eburger - это статический инструмент анализа, который предоставляет способ быстро запросить и проанализировать интеллектуальные контракты.

Создайте свой шаблон

Запустите свой шаблон

Запуск статических анализаторов не выиграет вам соревнования. Вместо этого мы предоставляем Eburger, так это возможность развернуть пользовательские шаблоны, адаптированные к вашему текущему аудируемому проекту в минуты (Wiki), позволяя вам организовать уникальные поиски через кодовую базу для расширения возможностей ваших аудитов.

• Как установить
• Как бежать
  • Как бежать - просто
  • Как запустить - продвинутый
• Как это выглядит?
• Поддержка сари
• Действие GitHub
• Вклад шаблонов
• Сравнение таблицы
• Функции
• Чего не хватает

Как установить

От PYPI

 pip3 install eburger
eburger -h

Из источника

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

Как бежать

Простые примеры

Простейший

 cd MyProject/
eburger
cat eburger-output.json

Вывод сарифа

eburger -f MyProject/ -o sarif

Вывод на Марсоудан (работающий с каталога проекта)

eburger -o markdown

Сфокусированное сканирование одного файла и его зависимости

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

Только печатная nsloc count

eburger -f MyProject/ --nsloc

Запустите пользовательские шаблоны YAML

eburger -t MyCustomYAMLs/ -f MyProject/

Расширенное использование

См. Вики.

Как это выглядит

Вот демонстрационное видео

eburger.mov

Помимо eburger-output.json , выше пример также будет генерировать расширенную информацию в папке .eburger .

Поддержка сари

SARIF (Статический анализ результатов обмена форматом) является стандартным форматом для результатов инструмента статического анализа.

Чтобы получить интерактивный графический интерфейс, открытый в VSCODE, который может организовать и взаимодействовать с найденными результатами, выполните эти шаги:

• Установите Microsoft Sarif Viewer Vscode Extensition
• Запустить eburger --output sarif
• Внутри vscode нажмите на полученный файл eburger-output.sarif размещенный в рабочем каталоге

Это откроет интерактивное меню VSCODE с проблемами, описанием, навигацией уязвимых строк кода и т. Д.

Действие GitHub

Трубопроводы CI поддерживаются через действие Github Eceurger-Action, это помогает постоянно оценивать ваш код и просматривать поднятые идеи на панели безопасности вашего репо.

Посетите страницу действия для получения дополнительной информации.

Вклад шаблонов

Шаблоны могут быть добавлены путем создания новых файлов YAML и либо загружать их с помощью eburger -t mytemplate.yaml . или разместив их под templates/ каталог.

Если вы предпочитаете играть с Eburger в браузере перед установкой, вы можете попробовать специальный экземпляр ноутбука Jupyter:

Если вы используете Eburger в качестве пакета Python (установлено с помощью установки PIP), существующее местоположение шаблонов можно найти с помощью работы pip3 show eburger или запустив инструмент по контракту и просмотреть путь шаблонов, напечатанный на консоли.

Для написания и документации шаблона относятся к вики.

Сравнение таблицы

Сравнение активно поддерживаемого / популярного смарт -контракта Статические анализаторы смарт -контракта.

Статический анализатор	Язык	2 минуты, чтобы написать пользовательский шаблон с Chatgpt	Действие GitHub	Много выводов, которые уже найдены до начала конкурса	Хотел бы поесть
экологи	Питон	✅	✅		✅
Скользить	Питон		✅	✅
4naly3er	Типография?			✅
Митрил	Питон
Адерин	Ржавчина

Забыли один или допустили ошибку? Откройте запрос на тягу или проблему :)

Функции

• Поддержка шаблона YAML для запроса структуры контракта и поднять понимание любых матчей
• Быстрая кривая обучения для создания шаблонов, способность настраивать шаблоны к текущему текущему проекту аудита
• Литейные и хардхатские поддержки ❣
• Поддержка SARIF и интеграция с графическим интерфейсом VSCODE
• Интеграция действий GitHub через эвбургер
• Отчет об отметках
• Быстрая индивидуальная генерация шаблонов с помощью генератора шаблонов Emburg
• Сообщество и бесплатная поддержка через Discord

Чего не хватает

Какие функции вы хотели бы увидеть? Дайте нам знать!