Gaia: Globaler API-Integritätsprüfer

Abhängigkeiten

• Installieren Sie opam, um die Test-API zu erstellen.

• Installieren Sie git, python3, pip und .NET, um RESTler und Schemathesis zu erstellen.

• Installieren Sie cargo, um Gaia zu erstellen.

• Installieren Sie docker v26.0.1 und docker compose v2.26.1, um Gaia mit dem ELK-Stack zu erstellen (optional, falls nicht).

• Installieren Sie node >= v18.0.0 und npm >= v8.6.0

• Um einen lokalen opam-Switch zu erstellen:

make opam-switch

• Um alle Abhängigkeiten zu installieren:

make deps

Erstellen

• Um Gaia zu erstellen:

make build

• Um die Test-API zu erstellen:

make build-test

OpenAPI-Spezifikation

• Um die OpenAPI-Spezifikation für die Tests zu generieren:

make generate-swagger

• Um die OpenAPI-Spezifikation für die Tests zu entfernen:

make clean-swagger

Formatierung

• Um das Projekt zu formatieren (Test + Quelle):

make format

Bereinigen

• Um die Build-Dateien zu bereinigen (Test + Quelle):

make clean-build-files

• Um alles zu bereinigen:

make clean

Ausführung

• Nach dem Erstellen können Sie die GAIA-Optionen anzeigen mit:

./_bin/gaia --help

• GAIA-Verwendung:

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

• workdir-path: Das Arbeitsverzeichnis, in dem Sie die verschiedenen Protokolle der Fuzzer finden.

• openapi-path: Pfad der OpenAPI-Datei der realen API. Erforderlich, wenn Sie Fuzzing oder Monitoring verwenden, aber nicht für Statistiken

• verbose : Der Grad der Ausführlichkeit {NOTHING, LOW, MID, HIGH, ALL} (Standardwert: NOTHING)

• configuration: Der Pfad der JSON-Datei, die Folgendes enthält: