GitHub Dorks 项目使用教程
1. 项目目录结构及介绍
github-dorks/
├── LICENSE
├── README.md
├── github-dork.py
├── github-dorks-test.txt
├── github-dorks.txt
├── requirements.txt
├── setup.cfg
└── setup.py
- LICENSE: 项目许可证文件,采用 Apache-2.0 许可证。
- README.md: 项目说明文件,包含项目的基本介绍、安装和使用说明。
- github-dork.py: 项目的主启动文件,用于搜索 GitHub 上的敏感信息。
- github-dorks-test.txt: 测试用的 GitHub Dorks 文件。
- github-dorks.txt: 包含用于搜索敏感信息的 GitHub Dorks 列表。
- requirements.txt: 项目依赖的 Python 包列表。
- setup.cfg: 项目配置文件,包含安装和打包的配置信息。
- setup.py: 用于安装项目的 Python 脚本。
2. 项目启动文件介绍
github-dork.py
github-dork.py
是项目的主启动文件,用于搜索 GitHub 上的敏感信息。该脚本使用 github3.py
库与 GitHub Search API 进行交互。
主要功能
- 搜索单个仓库中的敏感信息。
- 搜索用户或组织所有仓库中的敏感信息。
- 支持使用 GitHub 用户名、密码或令牌进行身份验证。
- 支持搜索 GitHub Enterprise 实例。
使用示例
# 搜索单个仓库
python github-dork.py -r techgaun/github-dorks
# 搜索用户所有仓库
python github-dork.py -u techgaun
# 搜索组织所有仓库
python github-dork.py -u dev-nepal
# 使用身份验证搜索
GH_USER=techgaun GH_PWD=<mypass> python github-dork.py -u dev-nepal
# 使用令牌搜索
GH_TOKEN=<github_token> python github-dork.py -u dev-nepal
# 搜索 GitHub Enterprise 实例
GH_URL=https://github.example.com python github-dork.py -u dev-nepal
3. 项目配置文件介绍
setup.cfg
setup.cfg
是项目的配置文件,包含安装和打包的配置信息。该文件通常用于定义项目的元数据、依赖项和其他安装选项。
主要配置项
- metadata: 包含项目的名称、版本、作者等信息。
- options: 定义安装选项,如依赖项、Python 版本等。
requirements.txt
requirements.txt
文件列出了项目依赖的 Python 包及其版本。在安装项目时,可以使用以下命令安装所有依赖项:
pip install -r requirements.txt
github-dorks.txt
github-dorks.txt
文件包含用于搜索敏感信息的 GitHub Dorks 列表。每个 Dork 描述了一个特定的搜索模式,用于查找可能泄露的敏感数据。
示例 Dork
filename:.npmrc _auth npm registry authentication data
filename:.dockercfg auth docker registry authentication data
extension:pem private private keys
这些 Dork 可以用于搜索包含敏感信息的文件,如 npm 认证数据、Docker 认证数据和私钥文件。
通过以上内容,您可以了解 github-dorks
项目的基本结构、启动文件和配置文件的使用方法。希望这份教程对您有所帮助!