GitMAD 项目使用教程

GitMAD 项目使用教程

GitMADMonitor, Alert, and Discover sensitive info and data leakage on Github.项目地址:https://gitcode.com/gh_mirrors/gi/GitMAD

1. 项目的目录结构及介绍

GitMAD/
├── GitMAD-install/
│   └── ...
├── static/
│   └── ...
├── templates/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── conf.py
├── db_ops.py
├── directory_search.py
├── download_repo.py
├── email_alert.py
├── entropy_whitelist.py
├── find_entropy.py
├── github_search.py
├── github_search_db.sql
├── main.py
├── regex_matches.py
├── requirements.txt
└── web_home.py

目录结构介绍

• GitMAD-install/: 包含项目的安装文件。
• static/: 存放静态文件，如CSS、JavaScript等。
• templates/: 存放HTML模板文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• conf.py: 项目配置文件。
• db_ops.py: 数据库操作相关文件。
• directory_search.py: 目录搜索相关文件。
• download_repo.py: 下载仓库相关文件。
• email_alert.py: 邮件提醒相关文件。
• entropy_whitelist.py: 熵值白名单相关文件。
• find_entropy.py: 查找熵值相关文件。
• github_search.py: GitHub搜索相关文件。
• github_search_db.sql: GitHub搜索数据库SQL文件。
• main.py: 项目主启动文件。
• regex_matches.py: 正则表达式匹配相关文件。
• requirements.txt: 项目依赖文件。
• web_home.py: Web应用主文件。

2. 项目的启动文件介绍

main.py

main.py 是 GitMAD 项目的主启动文件。首次运行时，用户需要输入配置信息。启动命令如下：

python3 /<path-to-gitmad>/GitMAD/main.py -q <keyword-to-search>

web_home.py

web_home.py 是 GitMAD 项目的 Web 应用主文件。启动命令如下：

python3 /<path-to-gitmad>/GitMAD/web_home.py

3. 项目的配置文件介绍

conf.py

conf.py 是 GitMAD 项目的配置文件，用户可以在此文件中配置以下内容：

• 最大搜索结果数量
• 搜索间隔时间
• 最大仓库克隆大小

regex_matches.py

regex_matches.py 文件用于配置正则表达式匹配规则。用户可以在此文件中添加关键词和正则表达式，以便在仓库内容中进行搜索。

示例：

to_match = [
    {'match_regex': r'password', 'match_type': 'Password Match'},
    {'match_regex': r'\d[1-3]\.\d[1-3]\.\d[1-3]\.\d[1-3]', 'match_type': 'IP Match'},
    # 其他匹配规则
]

通过以上配置，GitMAD 将根据用户定义的规则在 GitHub 上搜索敏感信息并进行相应的处理。

GitMADMonitor, Alert, and Discover sensitive info and data leakage on Github.项目地址:https://gitcode.com/gh_mirrors/gi/GitMAD