Slither, статический анализатор смарт-контрактов

Присоединяйтесь к Slack-каналу Empire Hacking

- Обсуждения и поддержка

Slither — это фреймворк статического анализа для Solidity и Vyper, написанный на Python3. Он запускает набор детекторов уязвимостей, выводит визуальную информацию о деталях контрактов и предоставляет API для простого написания собственных анализов. Slither позволяет разработчикам находить уязвимости, улучшать понимание кода и быстро прототипировать собственные анализы.

• Возможности
• Использование
• Как установить
  • Используя uv (рекомендуется)
  • Используя Pip
  • Используя Git
  • Используя Docker
  • Интеграция
• Детекторы
• Принтеры
  • Быстрые принтеры для обзора
  • Углублённые принтеры для рецензирования
• Инструменты
• Документация API
• Получение помощи
• Часто задаваемые вопросы
• Лицензия
• Публикации
  • Публикации Trail of Bits
  • Внешние публикации

Возможности

• Обнаруживает уязвимый код Solidity с низким уровнем ложных срабатываний (см. список трофеев)
• Определяет, где в исходном коде возникает условие ошибки
• Легко интегрируется в непрерывную интеграцию и сборки Hardhat/Foundry
• Встроенные «принтеры» быстро сообщают важную информацию о контракте
• API детекторов для написания собственных анализов на Python
• Возможность анализа контрактов, написанных на Solidity >= 0.4
• Промежуточное представление (SlithIR) обеспечивает простые и высокоточные анализы
• Корректно парсит 99.9% всего публичного кода Solidity
• Среднее время выполнения менее 1 секунды на контракт
• Интегрируется со сканированием кода GitHub в CI
• Поддержка смарт-контрактов Vyper

Использование

Запустите Slither в приложении Hardhat/Foundry/Dapp/Brownie:```console slither .

Это предпочтительный вариант, если ваш проект имеет зависимости, поскольку Slither полагается на базовый фреймворк компиляции для компиляции исходного кода.

Однако вы можете запустить Slither на одном файле, который не импортирует зависимости:```console
slither tests/uninitialized.sol

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

Примечание Slither требует Python 3.10+. Если вы не собираетесь использовать один из поддерживаемых фреймворков сборки, вам потребуется solc, компилятор Solidity; мы рекомендуем использовать solc-select для удобного переключения между версиями solc.

Использование uv (рекомендуется)

uv — это быстрый менеджер пакетов Python, который в 10-100 раз быстрее pip.```console

Install uv if you haven't already

curl -LsSf https://astral.sh/uv/install.sh | sh

Install slither as a tool

uv tool install slither-analyzer

Or run slither without installation

uvx --from slither-analyzer slither

Для обновления:```console
uv tool upgrade slither-analyzer

Использование Pip```console

python3 -m pip install slither-analyzer

Для обновления:```console
python3 -m pip install --upgrade slither-analyzer

Использование Brew```console

brew install slither-analyzer

### Использование Git (Разработка)```bash
git clone https://github.com/crytic/slither.git && cd slither

# Install as editable for development
uv tool install -e .

# Or use uv run for testing without installation
uv run slither <target>

Флаг -e устанавливает в редактируемый режим, то есть изменения в исходном коде немедленно отражаются без переустановки.

Использование Docker

Используйте образ Docker eth-security-toolbox. Он включает все наши инструменты безопасности и все основные версии Solidity в одном образе. /home/share будет смонтирован в /share внутри контейнера.```bash docker pull trailofbits/eth-security-toolbox

Чтобы предоставить общий доступ к каталогу в контейнере:```bash
docker run -it -v /home/share:/share trailofbits/eth-security-toolbox

Интеграция

• Для интеграции с GitHub Actions используйте slither-action.
• Для интеграции с pre-commit используйте (замените $GIT_TAG на реальный тег) ```YAML
  • repo: https://github.com/crytic/slither rev: $GIT_TAG hooks:
    • id: slither
  root@kitploit:~

• Чтобы сгенерировать отчёт в Markdown, используйте slither [target] --checklist.
• Чтобы сгенерировать Markdown с подсветкой исходного кода GitHub, используйте slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/ (замените ORG, REPO, COMMIT)

Детекторы

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

• Документацию по детекторам для подробностей о каждом детекторе
• Выбор детекторов для запуска только выбранных детекторов. По умолчанию запускаются все детекторы.
• Режим триажа для фильтрации отдельных результатов

Принтеры

Принтеры быстрого обзора

• human-summary: Вывести удобочитаемую сводку по контрактам
• inheritance-graph: Экспортировать граф наследования каждого контракта в dot-файл
• contract-summary: Вывести сводку по контрактам
• loc: Подсчитать общее количество строк кода (LOC), исходных строк кода (SLOC) и строк комментариев (CLOC) в исходных файлах (SRC), зависимостях (DEP) и тестовых файлах (TEST).
• entry-points: Вывести все изменяющие состояние точки входа и их переменные контрактов

Принтеры углублённого обзора* call-graph: Экспортировать граф вызовов контрактов в dot-файл

• cfg: Экспортировать CFG каждой функции
• function-summary: Вывести сводку по функциям
• vars-and-auth: Вывести записываемые переменные состояния и авторизацию функций
• not-pausable: Вывести функции, не использующие модификатор whenNotPaused.

Для запуска принтера используйте --print и список принтеров, разделённых запятыми.

См. документацию принтера для полного списка.

Инструменты

• slither-check-upgradeability: Проверить обновляемость на основе delegatecall
• slither-prop: Автоматическая генерация юнит-тестов и свойств
• slither-flat: Свести код в один файл
• slither-check-erc: Проверить соответствие стандарту ERC
• slither-read-storage: Чтение значений хранилища из контрактов
• slither-interface: Создать интерфейс для контракта

См. документацию по инструментам для дополнительных инструментов.

Свяжитесь с нами, чтобы получить помощь в создании собственных инструментов.

Документация API

Документация по внутренностям Slither доступна здесь.

Получение помощи

Не стесняйтесь заглянуть в наш Slack-канал (#ethereum) для получения помощи по использованию или расширению Slither.

• Документация принтера описывает информацию, которую Slither может визуализировать для каждого контракта.

• Документация детектора описывает, как написать новый анализ уязвимостей.

• Документация API описывает методы и объекты, доступные для пользовательского анализа.

• Документация SlithIR описывает промежуточное представление SlithIR.

Часто задаваемые вопросы

Как исключить моки или тесты?

• Ознакомьтесь с нашей документацией по фильтрации путей.

Как исправить ошибки «unknown file» или проблемы компиляции?

• Поскольку slither требует AST solc, все зависимости должны быть доступны. Если контракт имеет зависимости, slither contract.sol завершится ошибкой. Вместо этого используйте slither . в родительской директории contracts/ (вы должны увидеть contracts/ при выполнении ls). Если у вас есть папка node_modules/, она должна находиться в той же директории, что и contracts/. Чтобы убедиться, что проблема связана с slither, выполните команду компиляции для используемой вами платформы, например npx hardhat compile. Это должно успешно работать; в противном случае механизм компиляции slither, crytic-compile, не сможет сгенерировать AST.

Лицензия

Slither распространяется под лицензией AGPLv3. Свяжитесь с нами, если вам нужно исключение из условий.

Публикации

Публикация Trail of Bits

• Slither: A Static Analysis Framework For Smart Contracts, Josselin Feist, Gustavo Grieco, Alex Groce - WETSEB '19

Внешние публикации

Если вы используете Slither в академической работе, рассмотрите возможность подачи заявки на Crytic $10k Research Prize.