【工具篇】gitbub敏感数据扫描x-patrol基本使用

一、简介

Github leaked patrol为一款github泄露巡航工具：

1. 提供了WEB管理端，后台数据库支持SQLITE3、MYSQL和POSTGRES
2. 双引擎搜索，github code接口搜索全局github以及本地搜索例行监控的repos
3. 支持规则管理（github搜索规则及本地repos搜索规则）
4. 支持github token管理和用户管理
5. 支持在WEB中对扫描结果审核

二、docker搭建mysql

1、docker安装

1）使用yum安装

查看你当前的内核版本

uname -a

安装 Docke

yum -y install docke

启动 Docker 后台服务

service docker start

测试运行 hello-world,由于本地没有hello-world这个镜像，所以会下载一个hello-world的镜像，并在容器内运行。

docker run hello-world

2）使用脚本安装 Docker

确保 yum 包更新到最新

 yum update

执行 Docker 安装脚本,执行这个脚本会添加 docker.repo 源并安装 Docker。

curl -fsSL https://get.docker.com/ | sh

启动 Docker 进程

sudo service docker start

验证 docker 是否安装成功并在容器中执行一个测试的镜像

sudo docker run hello-world

2、查看版本

docker version

3、设置开机自启动

systemctl enable docke

4、使用相应的 pull 指令拉取 MySQL 镜像

docker pull registry.docker-cn.com/library/mysql:5.7

5、运行启动

docker run --name=patrol_db -p 3306:3306 -e MYSQL_ROOT_PASSWORD=adfgv!2dafggdaaw  -d 镜像ID

6、将mysql数据存到宿主机

docker run -p 3307:3306 --restart 策略名称 -v 宿主机数据目录:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=mysql密码 -d 镜像ID

三、x-patrol安装

1、x-patrol项目地址：

https://github.com/MiSecurity/x-patrol

2、安装go

该项目使用go语言开发，部署环境使用linux（release版本也有windows版的）环境部署，所以机器上需要提前安装好golang，我使用的kali机器，安装golang：

yum install epel-release -y  #更新epel源

yum install golang

3、安装x-patrol

golang环境安装好之后,将x-patrol源码拉下来：

 git clone https://github.com/MiSecurity/x-patrol.git

1）x-patrol源码下载下来之后，不用编译，编译太麻烦，作者已有编译好的release版本,下载地址如下：

release版本地址：https://github.com/MiSecurity/x-patrol/releases

选择x-patrol_linux_amd64二进制版本，将x-patrol_linux_amd64二进制包下载下来后，上传到x-patrol源码目录中

2）二进制包上传后，进入x-patrol/conf，app.ini文件是配置数据库信息，选择mysql数据库

HTTP_HOST = 127.0.0.1
HTTP_PORT = 8000
MAX_INDEXERS = 2
DEBUG_MODE = true
REPO_PATH = repos
MAX_Concurrency_REPOS = 1
[database]
;support sqlite3, mysql, postgres
DB_TYPE = mysql
HOST = 127.0.0.1
PORT = 3306
NAME = xsec
USER = root
PASSWD = x@xsec.io
SSL_MODE = disable
PATH = data   

3）mysql创建xsec数据库

4）配置好MySQL之后，就可以启动web端，规则和github token在web界面配置方便：

直接执行./x-patrol_linux_amd64 查看命令帮助

5）启动web界面命令如下：

&符号是后台运行

 ./x-patrol_linux_amd64 web --host 0.0.0.0 & 

启动后默认端口是8000端口，ip:端口方式访问，用户名密码为：xsec和x@xsec.io（注意修改密码）

6）登录后台后需要配置2个地方，一个是token管理，一个是规则管理

7）配置完规则后进行扫描

命令行参数如下：

1. web指令表示启动web管理端
2. scan指令表示只启动github搜索
3. scan -m local，表示只启动本地代码搜索功能
4. scan -m all，表示同时启动github代码搜索与本地Repos搜索功能

./x-patrol_linux_amd64 scan