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

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

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

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

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

Возможности

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

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

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

slither .

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

Тем не менее, вы можете запустить Slither на отдельном файле, который не импортирует зависимости:

slither tests/uninitialized.sol

Установка

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

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

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

# 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 <target>

Для обновления:

uv tool upgrade slither-analyzer

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

python3 -m pip install slither-analyzer

Для обновления:

python3 -m pip install --upgrade slither-analyzer

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

brew install slither-analyzer

Использование Git (Разработка)

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 в контейнере.

docker pull trailofbits/eth-security-toolbox

Для совместного использования каталога в контейнере:

docker run -it -v /home/share:/share trailofbits/eth-security-toolbox

Интеграция

• Для интеграции с GitHub action используйте slither-action.
• Для интеграции с pre-commit используйте (замените $GIT_TAG на реальный тег) ```YAML
• repo: https://github.com/crytic/slither rev: $GIT_TAG hooks:
  • id: slither ```
• Для генерации отчета в 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: Объединение (flatten) базы кода
• 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/ (при выполнении команды ls вы должны видеть contracts/). Если у вас есть папка 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 Research Prize $10k.