GraphQLer

A única ferramenta de teste de API GraphQL com reconhecimento de dependências!

GraphQLer é uma ferramenta de ponta projetada para testar dinamicamente APIs GraphQL com foco em adaptabilidade. Ela oferece uma gama de recursos sofisticados que simplificam o processo de teste e garantem uma análise robusta das APIs GraphQL. O GraphQLer gerencia com proficiência objetos e recursos criados, identifica efetivamente dependências em objetos, consultas e mutações, e corrige dinamicamente erros em consultas com base nas restrições da API. O GraphQLer foi usado para encontrar muitos bugs em APIs GraphQL de nível de produção!

Funcionalidades principais

• Reconhecimento de dependências: Execute consultas e mutações com base em suas dependências!
• Testes dinâmicos: Acompanhe os recursos criados durante os testes
• Correção de erros: Tente e corrija requisições para que a API GraphQL as aceite
• Coleta de estatísticas: Exibe seus resultados em um arquivo organizado
• Facilidade de uso: Tudo que você precisa é do endpoint e talvez do token de autenticação 😁

Primeiros passos

Para começar a usar o GraphQLer, consulte o guia de instalação.

Uso

❯ 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

Abaixo estão os passos de como você pode usar este programa para testar sua API GraphQL. O uso é dividido em 2 fases, compilação e fuzzing.

• Modo de compilação: Este modo é responsável por executar uma consulta de introspecção na API fornecida e gerar o grafo de dependências.
• Modo de fuzzing: Este modo é responsável por percorrer o grafo de dependências e enviar requisições de teste para a API.

Um terceiro modo também está incluído para facilidade de uso, chamado modo run. Este modo combina os modos de compilação e fuzzing em um único comando.

Modo de compilação

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

Após a compilação, você pode visualizar os resultados compilados em <SAVE_PATH>/compiled. Além disso, um grafo chamado dependency_graph.png será gerado para inspeção. Quaisquer UNKNOWNS nos arquivos .yaml compilados podem ser marcados manualmente; no entanto, se não forem marcados, o fuzzer ainda os executará, mas sem usar uma cadeia de dependências.

Modo de fuzzing

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

Durante o fuzzing, estatísticas relacionadas à API GraphQL e contagens de requisições em andamento são registradas no console. Quaisquer códigos de retorno de requisição são escritos em <SAVE_PATH>/stats.txt. Todos os logs durante o fuzzing são mantidos em <SAVE_PATH>/logs/fuzzer.log. O arquivo de log informará exatamente quais requisições são enviadas para quais endpoints e qual foi a resposta. Isso pode ser usado para análises adicionais dos resultados.

Modo de execução

Executa tanto o modo de compilação quanto o modo de fuzzing.

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

Funcionalidades avançadas

Existem também variáveis que podem ser modificadas no arquivo constants.py. Elas correspondem a funcionalidades específicas implementadas no GraphQLer e podem ser ajustadas conforme sua preferência.