
Управляемый покрытием фаззер REST API, разработанный на основе LibAFL
TNO разработала WuppieFuzz — REST API-фаззер с покрытийным управлением, созданный на основе LibAFL и ориентированный на широкую аудиторию конечных пользователей, с сильным акцентом на простоту использования, объяснимость обнаруженных уязвимостей и модульность. WuppieFuzz поддерживает все три режима тестирования (чёрный ящик, серый ящик и белый ящик).
[!NOTE]
Для быстрого пошагового руководства перейдите к tutorial!
WuppieFuzz был упомянут в:
Если вы хотите сослаться на WuppieFuzz в академической работе, пожалуйста, используйте предпочтительную публикацию, указанную в CITATION.cff:
Rooijakkers, T., Nijsten, A., Daniele, C., Weitenberg, E., Groenewegen, R., & Melissen, A. (2026). WuppieFuzz: Coverage-Guided, Stateful REST API Fuzzing. In Proceedings of the 12th International Conference on Information Systems Security and Privacy (ICISSP), Volume 2, 221-231. SciTePress. https://doi.org/10.5220/0000217100004061
WuppieFuzz распространяется под лицензией Apache-2.0; см. LICENSE.
Уведомления о лицензиях третьих сторон перечислены в THIRD_PARTY_NOTICES.
Для быстрой установки WuppieFuzz в популярных операционных системах (MacOS,
Windows, Linux) см. releases или используйте brew install wuppiefuzz
Вы можете собрать docker-образ командой docker build . -t wuppiefuzz:local. Чтобы использовать его, необходимо смонтировать папку, содержащую вашу спецификацию openapi. При фаззинге сервиса, запущенного локально (не в Docker), необходимо указать host networking:
docker run \
--network host \
-v ./fuzzing-folder:/fuzzing-folder \ # The folder will be populated with wuppiefuzz outputs
-w /fuzzing-folder \
wuppiefuzz:local fuzz --timeout 60 --report openapi.json
Чтобы собрать проект, необходимо установить следующие зависимости и инструменты:
sudo apt install -y build-essential pkg-config cmake # General build tools
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Rust
Перед запуском WuppieFuzz необходимо запустить ваше (инструментированное) целевое приложение.
Кроме того, вы должны предоставить WuppieFuzz спецификацию OpenAPI, чтобы он знал, как генерировать и мутировать свои запросы. Для получения справки по аргументам командной строки используйте следующее:
$ cargo run -- --help # shows help for required parameters and flags
Usage: wuppiefuzz [OPTIONS] [OPENAPI_SPEC.YAML]
...
Например, чтобы запустить WuppieFuzz против Java-цели с подключённым агентом JaCoCo, вы указываете его файл OpenAPI (содержащий URL, на котором запущена цель, в спецификации API). Кроме того, вы указываете, что формат покрытия — JaCoCo, и задаёте каталог классов следующим образом:
cargo run -- fuzz openapi.yaml --coverage-format jacoco --jacoco-class-dir ../Targets/app/target/classes/
Если вы хотите использовать файл конфигурации вместо аргументов командной строки или в сочетании с ними, вы можете использовать флаг --config <CONFIG_FILE>. В случае, если вы используете аргументы командной строки в сочетании с файлом конфигурации, аргументы командной строки имеют приоритет.
Файл конфигурации должен быть файлом yaml и содержать строку для каждого аргумента командной строки, который вы хотите указать, например:
coverage_format: jacoco
output_format: human-readable
source_dir: "/swagger-petstore/src/main/java"
jacoco_class_dir: "/swagger-petstore/target"
timeout: 20
Пример команды запуска в этом случае может быть таким:
$ cargo run -- fuzz --config=config.yaml --report --coverage-host=localhost:6300 --timeout=10 ./openapi.yaml
Эта строка объединила бы аргументы из командной строки и из файла
конфигурации. Поскольку флаг --timeout указан в обоих местах, таймаут,
указанный в командной строке (10 секунд), будет иметь приоритет.
В каталоге example_configs/ вы найдёте два примера файлов конфигурации для
использования при генерации отчётов о покрытии с помощью JaCoCo для кода на Java
и для генерации отчётов о покрытии с помощью LCOV для кода на Python.
Когда вы запускаете WuppieFuzz с флагом --report, внутри reports/ создаётся
подкаталог с именем в виде временной метки. Все поддерживаемые отчёты о покрытии
записываются в этот подкаталог. Существует два типа отчётов о покрытии:
Вдобавок ко всему, база данных заполняется всей информацией о запросах, относящейся к вашей кампании фаззинга. Эту базу данных можно визуализировать и исследовать через панель управления Grafana.
Тот же флаг --report также записывает файл report.json в каталог
reports/<timestamp> в соответствии со схемой отчёта Web Fuzzing
Commons,
что позволяет использовать результаты в инструментах, совместимых с WFC. В нём
суммируются сгенерированные тестовые случаи, охваченные эндпоинты и HTTP-коды
состояния, обнаруженные ошибки (ошибки валидации) и базовая статистика покрытия
(покрытие кода включается только при настроенном агенте покрытия — например,
JaCoCo; в режиме чёрного ящика/только эндпоинтов сообщается только покрытие
эндпоинтов).
Для получения дополнительной информации о каждом из них см. README в этих каталогах.