Зависимости и установка Sydr-fuzz

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

Для запуска инструмента требуется наличие лицензионного ключа Sentinel нужной версии: YMYCK (legacy-вендор) или XEKDC (текущий вендор). Хост, на котором запускается Sydr-fuzz должен находиться в одной сети с машиной, к котрой подключен USB-донгл Sentinel (или иметь VPN-соединение к такой сети). На обоих хостах необходимо наличие драйверов Sentinel Runtime Environment:

$ wget -o log -O aksusbd_9.12-1_amd64.deb https://nextcloud.ispras.ru/index.php/s/xrtSXt8rMydRiFf/download?path=%2FLinux&files=aksusbd_9.12-1_amd64.deb
$ sudo dpkg -i aksusbd_9.12-1_amd64.deb

Если после установки DEB-пакета ключ все равно невиден (при попытке запуска инструмента выдается ошибка Sentinel key not found (H0007)), необходимо явно указать IP-адрес хоста, к которому подключен USB-донгл. Это можно сделать двумя способами:

При использовании Sydr-fuzz в докер-контейнере, запуск докера необходимо проводить с опцией --network host. Этого достаточно, если на хостовой машине уже установлены драйвера Sentinel Runtime Environment. Если на хостовой машине драйверов нет, их можно установить напрямую в докер-контейнере. Для этого в Dockerfile нужно скачать у установить DEB-пакет с драйверами, создать и настроить /etc/hasplm/hasplm.ini файл. Стоит отметить, что в некоторых случаях, при запуске построенного докер-контейнера для работы драйверов Sentinel необходимо дополнительно выполнить команду:

$ /usr/sbin/hasplmd -s

При возникновении проблем с докером, в некоторый случаях может помочь пробрасывание драйвера Sentinel в докер: -v /var/hasplm:/var/hasplm -v /etc/hasplm:/etc/hasplm.

Для работы лицензионного ключа на Astra Linux требуется разрешить трассировку ptrace: Пуск -> Панель управления -> Безопасность -> Политика безопасности -> Настройка безопасности -> Системные параметры -> Снять галочку с “Блокировать трассировку ptrace для всех пользователей”.

Минимальные системные требования

Рекомендуемые системные требования

Зависимости

Перед установкой инструмента установите следующие зависимости.

$ sudo apt install gcc-multilib binutils lsb-release gdb lcov

Установка

Для установки достаточно распаковать zip-архив.

$ unzip sydr.zip

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

Рекомендуется воспользоваться нашим докером sydr/ubuntu20.04-sydr-fuzz. Докер можно выкачать с помощью команды:

$ docker pull sydr/ubuntu20.04-sydr-fuzz

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

Зависимости libFuzzer

Sydr-fuzz можно запускать просто на системе (требуется LLVM 13+). Однако настоятельно рекомендуем установить Docker для сборки и запуска фаззинга целей в изолированном окружении.

Для корректного ранжирования входных данных, подающихся от libFuzzer к Sydr, требуется сборка LLVM, содержащая добавленный нами коммит. Данные изменения добавляют печать входных данных от Sydr, которые увеличивают покрытие кода с точки зрения фаззера. Эта функциональность присутствует с релиза LLVM 13.0.0. Более ранние версии LLVM также поддерживаются, но ранжирование не будет эффективным.

Зависимости AFL++

Фаззер AFL++ и все необходимые утилиты уже установлены в нашем докере sydr/ubuntu20.04-sydr-fuzz. При запуске на другой системе потребуется скачать и установить AFL++ (можно из репозитория). AFL++ активно разрабатывается, поэтому желательно использовать наиболее новую версию. Для запуска Sydr-fuzz с AFL++ также необходимы утилиты минимизации корпуса afl-cmin и построения битовой карты afl-showmap. Вместе с фаззером afl-fuzz они должны находиться в одной директории, путь до которой либо есть в $PATH, либо указан в конфигурационном файле.

Зависимости Honggfuzz

Фаззер Honggfuzz уже установлен в нашем докере sydr/ubuntu20.04-sydr-fuzz. При запуске на другой системе потребуется скачать и установить Honggfuzz (можно из репозитория). Для работы Honggfuzz также необходимо установить дополнительные пакеты binutils-dev, libunwind-dev и libblocksruntime-dev.

Зависимости Atheris

Библиотека фаззинга Atheris и все необходимые утилиты уже установлены в нашем докере sydr/ubuntu20.04-sydr-fuzz. При запуске на другой системе потребуется скачать и установить Atheris (можно из репозитория). Для работы sydr-fuzz с Atheris также необходима библиотека сбора покрытия Coverage.

Зависимости Jazzer

Фаззер Jazzer и все необходимые утилиты уже установлены в нашем докере sydr/ubuntu20.04-sydr-fuzz. При запуске на другой системе потребуется скачать и установить Jazzer (можно из репозитория). Для сбора покрытия понадобится библиотека Jacoco.

Зависимости Jazzer.js

Фаззер Jazzer.js и все необходимые утилиты уже установлены в нашем докере sydr/ubuntu20.04-sydr-fuzz. При запуске на другой системе потребуется скачать и установить Jazzer.js (можно из репозитория).

Зависимости luzer

Фаззер luzer и все необходимые утилиты уже установлены в нашем докере sydr/ubuntu22.04-sydr-fuzz. При запуске на другой системе потребуется скачать и установить luzer (для возможности задания параметра args в toml-конфиге можно использовать ветку patched форк-репозитория). Перед установкой luzer рекомендуется установить lua5.1 и llvm >=17. Для сбора информации о покрытии необходимо установить утилиту luacov.

Зависимости Sharpfuzz

Фаззер Sharpfuzz и все необходимые утилиты уже установлены в нашем докере sydr/ubuntu20.04-sydr-fuzz. При запуске на другой системе потребуется скачать Sharpfuzz (можно из репозитория), AFL++ (можно из репозитория), для сборки и запуска C# програм понадобится скачать .NET SDK (можно с сайта). Для сбора покрытия в форматах html, clover, coveralls, xml, opencover, cobertura, text понадобится инструмент minicover (скачать можно по гайдам из репозитория). Для сбора покрытия в форматах html (с помощью genhtml) или lcov понадобится инструмент AltCover (скачать можно по гайдам из репозитория).