Skip to content

Commit c12029e

Browse files
committed
fix issues with readme
according to MD022 'Headings should be surrounded by blank lines' according to MD001 'Heading levels should only increment by one level at a time' use `a basic` not `basic`, `the text file` not `text file` and `a password` not `password`
1 parent 38ee335 commit c12029e

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
# Github Dorks
2+
23
[Github Search](https://github.com/search) is a quite powerful and useful feature that can be used to search for sensitive data on repositories. Collection of Github dorks can reveal sensitive personal and/or organizational information such as private keys, credentials, authentication tokens, etc. This list is supposed to be useful for assessing security and performing pen-testing of systems.
34

4-
### GitHub Dork Search Tool
5-
[github-dork.py](github-dork.py) is a simple python tool that can search through your repository or your organization/user repositories. It's not a perfect tool at the moment but provides a basic functionality to automate the search on your repositories against the dorks specified in text file.
5+
## GitHub Dork Search Tool
6+
7+
[github-dork.py](github-dork.py) is a simple python tool that can search through your repository or your organization/user repositories. It's not a perfect tool at the moment but provides basic functionality to automate the search on your repositories against the dorks specified in the text file.
8+
9+
### Installation
610

7-
#### Installation
811
This tool uses [github3.py](https://github.com/sigmavirus24/github3.py) to talk with GitHub Search API.
912

1013
Clone this repository and run:
14+
1115
```shell
1216
pip install -r requirements.txt
1317
```
1418

15-
#### Usage
19+
### Usage
20+
1621
```
1722
GH_USER - Environment variable to specify Github user
18-
GH_PWD - Environment variable to specify password
23+
GH_PWD - Environment variable to specify a password
1924
GH_TOKEN - Environment variable to specify Github token
2025
GH_URL - Environment variable to specify GitHub Enterprise base URL
2126
```
@@ -36,16 +41,18 @@ GH_TOKEN=<github_token> python github-dork.py -u dev-nepal # search
3641
GH_URL=https://github.example.com python github-dork.py -u dev-nepal # search a GitHub Enterprise instance
3742
```
3843

39-
#### Limitations
44+
### Limitations
4045

4146
- Authenticated requests get a higher rate limit. But, since this tool waits for the api rate limit to be reset (which is usually less than a minute), it can be slightly slow.
4247
- Output formatting is not great. PR welcome
4348
- ~~Handle rate limit and retry. PR welcome~~
4449

4550
### Contribution
51+
4652
Please consider contributing dorks that can reveal potentially sensitive information on Github.
4753

4854
### List of Dorks
55+
4956
I am not categorizing at the moment. Instead, I am going to just the list of dorks with a description. Many of the dorks can be modified to make the search more specific or generic. You can see more options [here](https://github.com/search#search_cheatsheet_pane).
5057

5158
Dork | Description

0 commit comments

Comments
 (0)