GraphQLer

Единственный инструмент тестирования GraphQL API с учётом зависимостей!

GraphQLer — это передовой инструмент, предназначенный для динамического тестирования GraphQL API с акцентом на адаптивность. Он предлагает ряд сложных функций, которые упрощают процесс тестирования и обеспечивают надёжный анализ GraphQL API. GraphQLer умело управляет созданными объектами и ресурсами, эффективно определяет зависимости объектов, запросов и мутаций, а также динамически исправляет ошибки в запросах на основе ограничений API. GraphQLer использовался для поиска многих ошибок в production-grade GraphQL API!

Ключевые особенности

• Осведомлённость о зависимостях: Выполняйте запросы и мутации на основе их зависимостей!
• Динамическое тестирование: Отслеживайте ресурсы, созданные во время тестирования
• Исправление ошибок: Пытайтесь исправить запросы, чтобы GraphQL API их принял
• Сбор статистики: Показывает результаты в удобном файле
• Простота использования: Всё, что вам нужно — это конечная точка и, возможно, токен аутентификации 😁

Начало работы

Чтобы начать использовать 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 фазы: компиляция и фаззинг.

• Режим компиляции: Этот режим отвечает за выполнение introspection-запроса к заданному API и генерацию графа зависимостей.
• Режим фаззинга: Этот режим отвечает за обход графа зависимостей и отправку тестовых запросов к API.

Также включён третий режим для удобства, называемый run режимом. Этот режим объединяет оба режима компиляции и фаззинга в одну команду.

Режим компиляции

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

После компиляции вы можете просмотреть скомпилированные результаты в <SAVE_PATH>/compiled. Кроме того, будет сгенерирован граф с именем dependency_graph.png для просмотра. Любые UNKNOWNS в скомпилированных .yaml файлах можно отметить вручную; однако, если не отметить, фаззер всё равно выполнит их, но без использования цепочки зависимостей.

Режим фаззинга

(.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, и могут быть настроены по вашему усмотрению.