GraphQLer

依存関係を認識する**唯一の**GraphQL APIテストツール！

GraphQLerは、適応性に重点を置いてGraphQL APIを動的にテストするために設計された最先端のツールです。テストプロセスを合理化し、GraphQL APIの堅牢な分析を確実にする、さまざまな高度な機能を提供します。GraphQLerは、作成されたオブジェクトとリソースを巧みに管理し、オブジェクト、クエリ、ミューテーションの依存関係を効果的に特定し、APIの制限に基づいてクエリ内のエラーを動的に修正します。GraphQLerは、本番環境グレードのGraphQL APIで数多くのバグを見つけるために使用されてきました！

主な機能

• 依存関係認識：依存関係に基づいてクエリとミューテーションを実行！
• 動的テスト：テスト中に作成されたリソースを追跡
• エラー修正：GraphQL APIが受け入れるようにリクエストを試行・修正
• 統計収集：結果をわかりやすいファイルで表示
• 使いやすさ：エンドポイントと場合によっては認証トークンがあればOK 😁

はじめに

GraphQLerの使用を開始するには、インストールガイドを参照してください。

使用方法

❯ 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

以下は、このプログラムを使用してGraphQL APIをテストする手順です。使用法は2つのフェーズ、コンパイルとファジングに分かれています。

• コンパイルモード：このモードは、指定されたAPIに対してイントロスペクションクエリを実行し、依存関係グラフを生成します。
• ファジングモード：このモードは、依存関係グラフをトラバースし、APIにテストリクエストを送信します。

使いやすさのために、実行モードと呼ばれる3つ目のモードも含まれています。このモードは、コンパイルモードとファジングモードを1つのコマンドにまとめたものです。

コンパイルモード

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

コンパイル後、コンパイル結果を<SAVE_PATH>/compiledで確認できます。さらに、dependency_graph.pngというグラフが生成され、検査できます。コンパイルされた.yamlファイル内のUNKNOWNSは手動でマークできます。ただし、マークしなくてもファジングは実行されますが、依存関係チェーンは使用されません。

ファジングモード

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

ファジング中は、GraphQL APIに関連する統計情報と進行中のリクエスト数がコンソールに記録されます。すべてのリクエストのリターンコードは<SAVE_PATH>/stats.txtに書き込まれます。ファジング中のすべてのログは<SAVE_PATH>/logs/fuzzer.logに保存されます。ログファイルには、どのリクエストがどのエンドポイントに送信され、その応答が何であったかが正確に記録されます。これは、さらなる結果分析に使用できます。

実行モード

コンパイルモードとファジングモードの両方を実行します。

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

高度な機能

constants.pyファイルで変更できる変数もあります。これらはGraphQLerに実装されている特定の機能に対応しており、好みに応じて調整できます。