Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feeicn/gsil
GitHub Sensitive Information Leakage（GitHub敏感信息泄露监控）
https://github.com/feeicn/gsil
security-scanner security-tools sensitive-data sensitive-data-security
Last synced: about 1 month ago
JSON representation
GitHub Sensitive Information Leakage（GitHub敏感信息泄露监控）
- Host: GitHub
- URL: https://github.com/feeicn/gsil
- Owner: FeeiCN
- License: gpl-3.0
- Archived: true
- Created: 2017-10-11T10:14:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-28T09:50:29.000Z (11 months ago)
- Last Synced: 2024-04-17T00:18:52.923Z (7 months ago)
- Topics: security-scanner, security-tools, sensitive-data, sensitive-data-security
- Language: Python
- Homepage: https://feei.cn/gsil/
- Size: 119 KB
- Stars: 2,106
- Watchers: 62
- Forks: 485
- Open Issues: 7
-
Metadata Files:
- Readme: README-zh.md
- License: LICENSE
Awesome Lists containing this project
README
# GSIL(GitHub敏感信息泄露)
[English documents](https://github.com/FeeiCN/GSIL/blob/master/README.md)
> 近实时监控GitHub敏感信息泄露，并发送告警通知。
## 安装
> 仅在Python3下验证过
```bash
$ git clone https://github.com/FeeiCN/GSIL.git
$ cd GSIL/
$ pip install -r requirements.txt
```
## 配置
### GSIL/config.gsil(复制config.gsil.cfg.example并重命名config.gsil.cfg): 告警邮箱和Github配置
```
[mail]
host : smtp.exmail.qq.com
# SMTP端口(非SSL端口，但会使用TLS加密)
port : 25
# 多个发件人使用逗号(,)分隔
mails : [email protected]
from : GSIL
password : your_password
# 多个收件人使用逗号(,)分隔
to : [email protected]
[github]
# 扫描到的漏洞仓库是否立刻Clone到本地（~/.gsil/codes/）
# 此选项用作监控其它厂商，避免因为仓库所有者发现后被删除
clone: false
# GitHub Token用来调用相关API，多个Token使用逗号(,)分隔
# https://github.com/settings/tokens
# GitHub已调整最新的速度限制，请求数量大幅降低，单账户多Token将共享限速，详见https://docs.github.com/en/rest/reference/search#rate-limit 以及 https://docs.github.com/en/rest/reference/rate-limit
# 建议你根据关键词数量配置多个GitHub账户的Token以避免超速
tokens : your_token
```
### GSIL/rules.gsil(复制rules.gsil.yaml.example并重命名rules.gsil.yaml): 扫描规则
> 规则一般选用内网独立的特征，比如蘑菇街的外网是mogujie.com，蘑菇街的内网是mogujie.org，则可以将mogujie.org作为一条规则。
> 其它还有类似代码头部特征、外部邮箱特征等
| 字段 | 意义 | 选填 | 默认 | 描述 |
| --- | --- | --- | --- | --- |
| keyword | 关键词 | 必填 | - | 多个关键词可以用空格，比如‘账号 密码’；某些关键字出现的结果非常多，所以需要精确搜索时可以用双引号括起来，比如‘”ele.me“’；|
| ext | 指定文件后缀 | 可选 | 全部后缀 | 多个后缀可以使用英文半角逗号（,）分隔，比如`java,php,python` |
| mode | 匹配模式 | 可选 | 正常匹配(normal-match) | 正常匹配(normal-match)：匹配包含keyword的行，并记录该行附近行 / 仅匹配(only-match)：仅匹配包含keyword行 / 全部匹配(full-match)（不推荐使用）：搜出来的整个问题都算作结果 |
```
{
# 一级分类，一般使用公司名，用作开启扫描的第一个参数（python gsil.py test）
"test": {
# 二级分类，一般使用产品线
"mogujie": {
# 公司内部域名
"\"mogujie.org\"": {
# mode/ext默认可不填
"mode": "normal-match",
"ext": "php,java,python,go,js,properties"
},
# 公司代码特征
"copyright meili inc": {},
# 内部主机域名
"yewu1.db.mogujie.host": {},
# 外部邮箱
"mail.mogujie.com": {}
},
"meilishuo": {
"meilishuo.org": {},
"meilishuo.io": {}
}
}
}
```
## 用法
```bash
# 启动测试
$ python gsil.py test
# 测试token有效性
$ python gsil.py --verify-tokens
```
```bash
$ crontab -e
# 漏洞报告，此项任务发现漏洞后会立刻发送漏洞报告
# 每个小时运行一次，GitHub API接口调用频率限制可以根据token数量、规则数量来调整crontab频率实现，若觉得麻烦可简单配置多个token来实现。
# crontab执行时间决定了报告的发送时效性，间隔越短报告越快但频率限制越容易触发
# 建议配置5个token+20条规则，每15分钟运行一次（可以配置更短，根据各自需求确定）
*/15 * * * * /usr/bin/python /var/app/GSIL/gsil.py test > /tmp/gsil
# 统计报告，发送一天的扫描进展，包括运行次数、成功次数、失败次数、发现漏洞数、各域名状况、异常等等
# 每天晚上11点发送统计报告
0 23 * * * /usr/bin/python /var/app/GSIL/gsil.py --report
```
*扫描报告过一次的将不会重复报告，缓存记录在~/.gsil/目录*
## 引用
- [GSIL详细介绍](https://feei.cn/gsil/)