
Un fuzzer per API REST guidato dalla copertura, sviluppato sulla base di LibAFL
TNO ha sviluppato WuppieFuzz, un fuzzer per REST API guidato dalla copertura, realizzato sopra LibAFL, rivolto a un'ampia platea di utenti finali, con una forte attenzione alla facilità d'uso, all'esplicabilità dei difetti individuati e alla modularità. WuppieFuzz supporta tutte e tre le modalità di testing (black box, grey box e white box).
[!NOTE]
Per una guida rapida e passo-passo, segui il tutorial!
WuppieFuzz è stato presentato in:
Se desideri citare WuppieFuzz in un lavoro accademico, utilizza la pubblicazione preferita elencata in 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 è distribuito con licenza Apache-2.0; vedi LICENSE.
Le note sulle licenze di terze parti sono elencate in THIRD_PARTY_NOTICES.
Per un'installazione rapida di WuppieFuzz sui sistemi operativi più diffusi (MacOS,
Windows, Linux) vedi releases oppure usa brew install wuppiefuzz
Puoi creare l'immagine Docker con docker build . -t wuppiefuzz:local. Per utilizzarla, devi montare una cartella contenente la tua specifica OpenAPI. Quando esegui il fuzzing di un servizio in esecuzione localmente (non in Docker), devi specificare il networking dell'host:
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
Per compilare il progetto è necessario installare le seguenti dipendenze e strumenti:
sudo apt install -y build-essential pkg-config cmake # General build tools
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Rust
Prima di eseguire WuppieFuzz, è necessario avviare l'applicazione target (strumentata).
Inoltre, è necessario fornire a WuppieFuzz una specifica OpenAPI in modo che sappia come generare e mutare le sue richieste. Per assistenza sugli argomenti della riga di comando, utilizzare quanto segue:
$ cargo run -- --help # shows help for required parameters and flags
Usage: wuppiefuzz [OPTIONS] [OPENAPI_SPEC.YAML]
...
Ad esempio, per eseguire WuppieFuzz contro un target Java con l'agente JaCoCo collegato, si specifica il suo file OpenAPI (contenente l'URL su cui il target è in esecuzione nella specifica API). Inoltre, si specifica che il formato di copertura è JaCoCo, e si fornisce la directory delle classi come segue:
cargo run -- fuzz openapi.yaml --coverage-format jacoco --jacoco-class-dir ../Targets/app/target/classes/
Se desideri utilizzare un file di configurazione invece di/insieme agli argomenti
della riga di comando, puoi usare il flag --config <CONFIG_FILE>. Nel caso in cui utilizzi
argomenti della riga di comando in combinazione con un file di configurazione, gli argomenti
della riga di comando hanno la precedenza.
Il file di configurazione dovrebbe essere un file yaml e contenere una riga per ogni argomento della riga di comando che desideri specificare, ad esempio:
coverage_format: jacoco
output_format: human-readable
source_dir: "/swagger-petstore/src/main/java"
jacoco_class_dir: "/swagger-petstore/target"
timeout: 20
Un esempio di comando di esecuzione potrebbe in questo caso essere:
$ cargo run -- fuzz --config=config.yaml --report --coverage-host=localhost:6300 --timeout=10 ./openapi.yaml
Questa riga combinerebbe gli argomenti dalla riga di comando e dal file di
configurazione. Poiché il flag --timeout è specificato in entrambi, il timeout
specificato nella riga di comando (10 secondi) avrà la precedenza.
Nella directory example_configs/ troverai due file di configurazione di esempio
da utilizzare per generare report di copertura con JaCoCo per il codice Java e
per generare report di copertura con LCOV per il codice Python.
Quando esegui WuppieFuzz con il flag --report, viene creata una sottodirectory
all'interno di reports/ con un timestamp come nome. Tutti i report di copertura
supportati vengono scritti in questa sottodirectory. Esistono due tipi di report
di copertura:
Inoltre, un database viene popolato con tutte le informazioni sulle richieste relative alla tua campagna di fuzzing. Questo database può essere visualizzato ed esplorato tramite la dashboard Grafana.
Lo stesso flag --report scrive anche un file report.json nella directory
reports/<timestamp>, seguendo lo schema di report Web Fuzzing Commons,
consentendo ai risultati di essere utilizzati da strumenti compatibili con WFC.
Riassume i casi di test generati, gli endpoint e i codici di stato HTTP coperti,
eventuali fault (errori di validazione) rilevati e statistiche di copertura di
base (la copertura del codice è inclusa solo quando è configurato un agente di
copertura - ad es. JaCoCo -; in modalità black-box/solo endpoint viene riportata
solo la copertura degli endpoint).