GraphQLer

Le seul outil de test d'API GraphQL conscient des dépendances !

GraphQLer est un outil de pointe conçu pour tester dynamiquement les API GraphQL avec un accent sur l'adaptabilité. Il offre une gamme de fonctionnalités sophistiquées qui rationalisent le processus de test et garantissent une analyse robuste des API GraphQL. GraphQLer gère avec compétence les objets et ressources créés, identifie efficacement les dépendances entre objets, requêtes et mutations, et corrige dynamiquement les erreurs dans les requêtes en fonction des restrictions de l'API. GraphQLer a été utilisé pour trouver de nombreux bogues dans des API GraphQL de niveau production !

Fonctionnalités clés

• Conscience des dépendances : Exécutez des requêtes et des mutations en fonction de leurs dépendances !
• Tests dynamiques : Gardez une trace des ressources créées pendant les tests
• Correction d'erreurs : Essayez de corriger les requêtes pour que l'API GraphQL les accepte
• Collecte de statistiques : Affiche vos résultats dans un fichier pratique
• Facilité d'utilisation : Tout ce dont vous avez besoin est l'endpoint et peut-être le jeton d'authentification 😁

Pour commencer

Pour commencer à utiliser GraphQLer, consultez le guide d'installation.

Utilisation

❯ python3 main.py --help
usage: main.py [-h] [--compile] [--fuzz] [--run] --path PATH [--auth AUTH] --url URL

options:
  -h, --help   show this help message and exit
  --compile    runs on compile mode
  --fuzz       runs on fuzzing mode
  --run        run both the compiler and fuzzer (equivalent of running --compile then running --fuzz)
  --path PATH  directory location for saved files and files to be used from
  --auth AUTH  authentication token Example: 'Bearer arandompat-abcdefgh'
  --url URL    remote host URL

Voici les étapes pour utiliser ce programme afin de tester votre API GraphQL. L'utilisation est divisée en deux phases : la compilation et le fuzzing.

• Mode compilation : Ce mode est responsable de l'exécution d'une requête d'introspection sur l'API donnée et de la génération du graphe de dépendances.
• Mode fuzzing : Ce mode est responsable du parcours du graphe de dépendances et de l'envoi de requêtes de test à l'API.

Un troisième mode est également inclus pour plus de simplicité, appelé mode exécution. Ce mode combine les modes compilation et fuzzing en une seule commande.

Mode compilation

(.env) python main.py --compile --url <URL> --path <SAVE_PATH>

Après la compilation, vous pouvez visualiser les résultats compilés dans <SAVE_PATH>/compiled. De plus, un graphe nommé dependency_graph.png sera généré pour inspection. Tous les INCONNUS dans les fichiers .yaml compilés peuvent être marqués manuellement ; toutefois, s'ils ne sont pas marqués, le fuzzer les exécutera quand même, mais sans utiliser de chaîne de dépendances.

Mode fuzzing

(.env) python main.py --fuzz --url <URL> --path <SAVE_PATH>

Pendant le fuzzing, les statistiques relatives à l'API GraphQL et les compteurs de requêtes en cours sont affichés dans la console. Tous les codes de retour des requêtes sont écrits dans <SAVE_PATH>/stats.txt. Tous les logs du fuzzing sont conservés dans <SAVE_PATH>/logs/fuzzer.log. Le fichier de log vous indiquera exactement quelles requêtes sont envoyées à quels endpoints et quelle a été la réponse. Cela peut être utilisé pour une analyse plus approfondie des résultats.

Mode exécution

Exécute à la fois le mode Compilation et le mode Fuzzing.

(.env) python main.py --run --url <URL> --path <SAVE_PATH>

Fonctionnalités avancées

Il existe également des variables qui peuvent être modifiées dans le fichier constants.py. Elles correspondent à des fonctionnalités spécifiques implémentées dans GraphQLer et peuvent être ajustées selon vos préférences.