Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikitastupin/clairvoyance
Obtain GraphQL API schema even if the introspection is disabled
https://github.com/nikitastupin/clairvoyance
bug-bounty graphql penetration-testing security
Last synced: about 1 month ago
JSON representation
Obtain GraphQL API schema even if the introspection is disabled
- Host: GitHub
- URL: https://github.com/nikitastupin/clairvoyance
- Owner: nikitastupin
- License: apache-2.0
- Created: 2020-10-23T14:07:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T19:22:44.000Z (about 2 months ago)
- Last Synced: 2024-05-03T20:47:22.299Z (about 2 months ago)
- Topics: bug-bounty, graphql, penetration-testing, security
- Language: Python
- Homepage:
- Size: 366 KB
- Stars: 910
- Watchers: 10
- Forks: 80
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Lists
- Awesome-Pentest - clairvoyance - Obtain GraphQL API schema despite disabled introspection! (Web Tools / GraphQL)
- awesome-list - clairvoyance
- awesome-api-security - clairvoyance
- awesome-graphql-security - Clairvoyance - Patrial introspection fetcher when introspection is disabled. (Offensive Security / Discovery)
- awesome-bugbounty-tools - clairvoyance - Obtain GraphQL API schema despite disabled introspection! (Exploitation / GraphQL Injection)
- awesome-apisec - clairvoyance
- WebHackersWeapons - Clairvoyance
- awesome-bugbounty-tools - clairvoyance - Obtain GraphQL API schema despite disabled introspection! (Exploitation / GraphQL Injection)
- awesome-bugbounty-tools - clairvoyance - Obtain GraphQL API schema despite disabled introspection! (Exploitation / GraphQL Injection)
- awesome-hacking-lists - nikitastupin/clairvoyance - Obtain GraphQL API schema even if the introspection is disabled (Python)
- my-awesome-stars - nikitastupin/clairvoyance - Obtain GraphQL API schema even if the introspection is disabled (Python)
- awesome-stars - nikitastupin/clairvoyance - Obtain GraphQL API schema even if the introspection is disabled (Python)
README
# Clairvoyance
Obtain GraphQL API schema even if the introspection is disabled.
[](https://pypi.org/project/clairvoyance/)
[](https://pypi.org/project/clairvoyance/)
[](https://pypi.org/project/clairvoyance/)
[](https://github.com/nikitastupin/clairvoyance/blob/main/LICENSE)
## Introduction
Some GraphQL APIs have disabled introspection. For example, [Apollo Server disables introspection automatically if the `NODE_ENV` environment variable is set to `production`](https://www.apollographql.com/docs/tutorial/schema/#explore-your-schema).
Clairvoyance helps to obtain GraphQL API schema even if the introspection is disabled. It produces schema in JSON format suitable for other tools like [GraphQL Voyager](https://github.com/APIs-guru/graphql-voyager), [InQL](https://github.com/doyensec/inql) or [graphql-path-enum](https://gitlab.com/dee-see/graphql-path-enum).
## Contributors
Thanks to the contributors for their work.
- [nikitastupin](https://github.com/nikitastupin)
- [Escape](https://escape.tech) team
- [iCarossio](https://github.com/iCarossio)
- [Swan](https://github.com/c3b5aw)
- [QuentinN42](https://github.com/QuentinN42)
- [Nohehf](https://github.com/Nohehf)
- [i-tsaturov](https://github.com/i-tsaturov)
- [EONRaider](https://github.com/EONRaider)
- [noraj](https://github.com/noraj)
- [belane](https://github.com/belane)
## Getting Started
### pip
```bash
pip install clairvoyance
clairvoyance https://rickandmortyapi.com/graphql -o schema.json
# should take about 2 minutes
```
### docker
```bash
docker run --rm nikitastupin/clairvoyance --help
```
## Advanced Usage
### Which wordlist should I use?
There are at least three approaches:
- Use one of the [wordlists](https://github.com/Escape-Technologies/graphql-wordlist) collected by Escape Technologies
- Use general English words (e.g. [google-10000-english](https://github.com/first20hours/google-10000-english)).
- Create target specific wordlist by extracting all valid GraphQL names from application HTTP traffic, from mobile application static files, etc. Regex for GraphQL name is [`[_A-Za-z][_0-9A-Za-z]*`](http://spec.graphql.org/June2018/#sec-Names).
### Environment variables
```bash
LOG_FMT=`%(asctime)s \t%(levelname)s\t| %(message)s` # A string format for logging.
LOG_DATEFMT=`%Y-%m-%d %H:%M:%S` # A string format for logging date.
LOG_LEVEL=`INFO` # A string level for logging.
```
## Support
> Due to time constraints @nikitastupin won't be able to answer all the issues for some time but he'll do his best to review & merge PRs
In case of questions or issues with Clairvoyance please refer to [wiki](https://github.com/nikitastupin/clairvoyance/wiki) or [issues](https://github.com/nikitastupin/clairvoyance/issues). If this doesn't solve your problem feel free to open a [new issue](https://github.com/nikitastupin/clairvoyance/issues/new).
## Contributing
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. For more information about tests, internal project structure and so on refer to [Development](https://github.com/nikitastupin/clairvoyance/wiki/Development) wiki page.
## Documentation
You may find more details on how the tool works in the second half of the [GraphQL APIs from bug hunter's perspective by Nikita Stupin](https://youtu.be/nPB8o0cSnvM) talk.