README.md

GITHUB MONITOR 是vipkid安全研发团队打造的用于监控Github代码仓库、及时发现企业内部代码泄露、从而降低由于代码泄露导致的一系列安全风险。用户通过简单的任务配置，即可在分钟级发现代码泄露的情况。项目后端使用 django-rest-framework 开发，前端使用 react 和 antd-pro 开发。

系统特点

• 分钟级监控
• 简单且灵活的任务配置
• 邮件提醒
• github token管理
• 运行十分稳定

安装指南

首先将代码clone到本地：

git clone https://github.com/VKSRC/Github-Monitor.git

1. docker 部署

我们推荐使用Docker进行部署, 相对于源码部署更为简单和快速。

部署前请务必先安装Docker及docker-compose。

修改配置文件

首先复制根目录的.env.docker并重命名为.env，修改其中的Email Settings和initial Administrator配置。这两个配置分别控制邮件提醒，以及初始管理帐号密码。

一键启动

docker-compose up -d

访问http://127.0.0.1:8001即可看到页面。

修改启动端口

如果想修改启动端口，可以修改docker-compose.yaml文件中web容器的ports。

默认为8001:80，必须要修改为8080端口可改为8080:80。

2. 源码部署:

项目运行依赖 redis, 请在运行服务前启动redis-server

首先将.env.sample复制一份重命名为.env，并按照自己的要求修改配置:

# Django Settings
DEBUG="True"  # Django后台是否以debug模式运行, 可选True/False
ALLOWED_HOSTS="127.0.0.1,localhost"  # 配置Django Allowed_Hosts

# Database Settings
# DATABASE choice is mysql or sqlite
DATABASE="sqlite"  # 数据库类型, 可选sqlite或mysql
DB_NAME="github"  # 数据库名称
DB_HOST="127.0.0.1"  # mysql host
DB_PORT="3306"  # mysql port
DB_USER="root"  # mysql用户名
DB_PASSWORD="vipkid@2018"  # mysql密码

# Email Settings
# If you do not fill it in, it is None/False
EMAIL_HOST="smtp.example.com"  # smtp host
EMAIL_PORT="25"  # smtp port
FROM_EMAIL="[email protected]"  # 发件人
EMAIL_HOST_USER="[email protected]"  # email user, 如为匿名发送，将值设为空字符即可
EMAIL_HOST_PASSWORD="password123!@#"  # email password, 如为匿名发送，将值设为空字符即可
EMAIL_USE_TLS=
EMAIL_USE_SSL=

# initial Administrator
INIT_ADMIN_USERNAME="admin"  # 初始化系统用户使用的用户名
INIT_ADMIN_PASSWORD="password123!@#"  # 初始化系统用户使用的用户密码

• 后端代码运行部署:

测试环境可以使用django runserver的方式来进行部署，生产环境建议使用uwsgi + Nginx的方式部署，配置文件的示例可以参考 配置 目录下的文件。

1. 进入项目根目录下的server目录

2. 配置virtualenv环境（建议）

3. 在mysql里创建数据库(如使用sqlite、请忽略此步):

   登录进mysql后， 执行 CREATE DATABASE IF NOT EXISTS github DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_bin;

4. 在server目录下执行如下脚本:

# 安装python依赖
pip3 install -r requirements.pip -i http://pypi.doubanio.com/simple --trusted-host pypi.doubanio.com
# 初始化数据库
python3 manage.py migrate
# 初始化用户账号
python3 manage.py init_admin
# 启动web后端服务:
python3 manage.py runserver 127.0.0.1:8001
# 启动监控任务服务:
python3 manage.py monitor_task_service

• 前端代码部署:

测试环境可以使用 npm run start 方式启动, 生产环境建议先通过 npm run build生成静态文件，然后通过nginx做转发来做。

1. 进入项目根目录下的client目录
2. 如果后端接口地址不为 127.0.0.1:8001, 需要修改config/config.local.js, 将target修改为后端地址即可
3. 执行: npm install && npm run start

使用手册

1.添加Token

Github Monitor使用Github REST API v3接口进行搜索，所以需要预先配置Token进行认证。

首先登录Github，然后进入Token配置页面创建Token。

随后把Token添加到Github Monitor中。

Github API有次数限制，1分钟最多请求30次，为了提高爬取速度，Github Monitor支持添加多个Token。

2.添加监控任务

如图：

• 任务名称：仅做标记使用,无实际意义。
• 关键词：支持多个关键词，每行一个，支持Github REST API v3搜索语法，如：vipkid extension:java，只搜索java后缀文件。
• 忽略帐号：不支持模糊匹配，忽略指定帐号下的仓库，同样支持多个帐号，换行分隔。
• 忽略仓库：支持模糊匹配，比如：github.io，可忽略test.github.io、vipkid.github.io等仓库。
• 邮箱：可为空，不填则不会邮件提醒。
• 爬取页数：默认5页，每页50条数据。
• 爬取间隔：默认60分钟，可根据自己需求修改。

3.确认/忽略风险

如图：

爬虫爬取到的数据会入库，可以在查询系统中进行操作，进行处理/加白/忽略仓库操作。

• 处理：确认有风险，需要处理。
• 加白：确认无风险，以后不会再提醒，如果文件有修改，还是会再次提醒。
• 忽略仓库：批量加白该仓库下已经发现的信息。

联系我们

关注VKSRC微信公众号，有任何建议和意见都可以发送到公众号/提交Issue。