Aller au contenu

scan openapi

Charge une spécification OpenAPI (fichier local ou URL distante) et exécute des scans de sécurité sur chaque opération qu’elle définit.

Terminal window
vulnapi scan openapi <PATH_OR_URL> [flags]
OptionPar défautDescription
--security-schemes <name=value>Remplace la valeur du token pour un schéma de sécurité nommé (répétable)

Accepte aussi toutes les options communes.

Un token transmis via stdin est utilisé comme valeur par défaut pour tous les schémas de sécurité acceptant un bearer token. Les surcharges nommées via --security-schemes sont prioritaires.

Terminal window
echo "<token>" | vulnapi scan openapi ./openapi.json

Spécification locale avec un token transmis via stdin

Terminal window
echo "<token>" | vulnapi scan openapi ./openapi.json

Spécification distante avec un token transmis via stdin

Terminal window
echo "<token>" | vulnapi scan openapi https://api.example.com/.well-known/openapi.json

Surcharge d’un schéma de sécurité nommé

Terminal window
vulnapi scan openapi ./openapi.json --security-schemes bearerAuth=<token>

Plusieurs surcharges de schémas

Terminal window
vulnapi scan openapi ./openapi.json \
--security-schemes bearerAuth=<token> \
--security-schemes apiKey=<key>
CodeSignification
0Scan terminé avec succès
1Erreur fatale (spécification invalide, échec réseau, etc.)

Quand un résultat dépasse --severity-threshold, une sortie supplémentaire est écrite sur stderr. Voir comportement de sortie.