Gaia: Global API Integrity Assessor

Dipendenze

• Installa opam per compilare le API di test.

• Installa git, python3, pip e .NET per compilare RESTler e Schemathesis.

• Installa cargo per compilare Gaia.

• Installa docker v26.0.1 e docker compose v2.26.1 per compilare Gaia con ELK Stack (opzionale se non serve).

• Installa node >= v18.0.0 e npm >= v8.6.0

• Per creare uno switch opam locale:

make opam-switch

• Per installare tutte le dipendenze:

make deps

Compilazione

• Per compilare Gaia:

make build

• Per compilare le API di test:

make build-test

Specifica OpenAPI

• Per generare la specifica OpenAPI per i test:

make generate-swagger

• Per rimuovere la specifica OpenAPI per i test:

make clean-swagger

Formattazione

• Per formattare il progetto (test + sorgente):

make format

Pulizia

• Per pulire i file di compilazione (test + sorgente):

make clean-build-files

• Per pulire tutto:

make clean

Esecuzione

• Dopo la compilazione, puoi visualizzare le opzioni di GAIA con:

./_bin/gaia --help

• Utilizzo di GAIA:

gaia --configuration <configuration> --openapi-path <openapi-path> --workdir-path <workdir-path> --verbose <verbose>

• workdir-path: La directory di lavoro dove troverai i diversi log dei fuzzer.

• openapi-path: Percorso del file OpenAPI dell'API reale. Richiesto quando si utilizza il fuzzing o il monitoraggio, ma non per le statistiche

• verbose: Il livello di verbosità {NOTHING, LOW, MID, HIGH, ALL} (Valore predefinito: NOTHING)

• configuration: Il percorso del file json che contiene: