toqulent/github-email-extractor
GitHub: toqulent/github-email-extractor
一款利用 GitHub API 从用户公开仓库和提交记录中自动发现并提取邮箱地址的 Python 命令行工具。
Stars: 6 | Forks: 0
# GitHub Email 提取器 (GEE)
一款 Python 工具,用于从 GitHub 用户的公开仓库、commit 和事件中发现并收集邮箱地址。
## 环境要求
- Python 3.6+
- `requests` 库
## 用法
### 基本用法
```
python main.py
```
### 使用 GitHub Token(强烈推荐)
使用 token 会将你的速率限制从每小时 60 次请求提升到 5000 次:
```
python main.py
```
[了解如何获取 Github token](https://github.com/toqulent/github-email-extractor/blob/main/docs/creating-a-gitHub-access-token.md)
### 开启详细日志
```
python main.py -logs
```
### 同时使用 Token 和日志
```
python main.py -logs
```
## 工作原理
该工具执行三个主要的邮箱发现阶段:
**阶段 1:自有仓库**
- 获取目标用户直接拥有的所有仓库
**阶段 2:公开事件**
- 扫描最近的公开 push 事件
- 从 push payload 中提取 commit 作者邮箱
- 发现用户曾参与贡献的其他仓库
**阶段 3:Commit 搜索与深度扫描**
- 在 GitHub 的 commit 索引中搜索由该用户编写的 commit(最多 10 页)
- 对所有发现的仓库执行深度扫描
- **从 commit 元数据中提取邮箱地址**
## 许可证
MIT 许可证。因此,请随意将此项目用于教育和信息参考目的。
## 贡献
欢迎任何贡献!请随时提交 issue 或发起 pull request。
## 免责声明
本工具按“原样”提供,仅供教育和研究目的使用。用户有责任遵守 GitHub 的服务条款以及有关数据收集和隐私的适用法律。
标签:BSD, GitHub API, Python, 实时处理, 数据挖掘, 无后门, 逆向工具