开发手册

1 项目结构⚓︎

.
├── Dockerfile                                      # 构建容器镜像使用的 dockerfile
├── Dockerfile_base                                 # 构建基础容器镜像使用的 dockerfile    
├── LICENSE
├── README.md
├── ROADMAP.md
├── backend                                         # 后端项目主目录
│   ├── backend.iml
│   ├── pom.xml                                     # 后端 maven 项目使用的 pom 文件
│   └── src                                         # 后端代码目录
├── frontend                                        # 前端项目主目录
│   ├── babel.config.js
│   ├── frontend.iml
│   ├── node
│   ├── node_modules
│   ├── package-lock.json
│   ├── package.json
│   ├── pom.xml                                     # 前端 maven 项目使用的 pom 文件
│   ├── public
│   └── src                                         # 前端代码目录
└── pom.xml                                         # 整体 maven 项目使用的 pom 文件

2 配置开发环境⚓︎

2.1 环境准备⚓︎

后端前端安装 npm 或 yarn

后端

HummerRisk 后端使用了 Java 语言的 Spring Boot 框架，并使用 Maven 作为项目管理工具。开发者需要先在开发环境中安装 JDK 11 及 Maven。

前端

HummerRisk 前端使用了 Vue.js 作为前端框架，ElementUI 作为 UI 框架，并使用 npm 或 yarn 作为包管理工具。开发者请先下载 Node.js 或 Yarn 作为运行环境，IDEA 用户建议安装 Vue.js 插件，便于开发。

安装 npm 或 yarn

进入网站 https://nodejs.org/en/download 或 https://yarn.bootcss.com/docs/install，选择相应的安装包进行安装即可。

2.2 初始化配置⚓︎

数据库初始化

HummerRisk 使用 MySQL 数据库，推荐使用 MySQL 5.7 版本。同时 hummerrisk 对数据库部分配置项有要求，请参考下附的数据库配置，修改开发环境中的数据库配置文件

[mysqld]
default-storage-engine=INNODB
lower_case_table_names=1
table_open_cache=128
max_connections=2000
max_connect_errors=6000
innodb_file_per_table=1
innodb_buffer_pool_size=1G
max_allowed_packet=1G
slave_max_allowed_packet=1G
transaction_isolation=READ-COMMITTED
innodb_flush_method=O_DIRECT
innodb_lock_wait_timeout=1800
innodb_flush_log_at_trx_commit=0
sync_binlog=0
sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION
skip-name-resolve

注意：Windows 系统数据库初始化配置应删除 innodb_flush_method 参数，请参考文章。

请参考文档中的建库语句创建 HummerRisk 使用的数据库，HummerRisk 服务启动时会自动在配置的库中创建所需的表结构及初始化数据。

CREATE DATABASE `hummerrisk` /*!40100 DEFAULT CHARACTER SET utf8mb4 */

配置文件

HummerRisk 会默认加载该路径下的配置文件 /opt/hummerrisk/conf/hummerrisk.properties，请参考下列配置创建对应目录及配置文件，请参考下面配置创建对应目录及配置文件。
提示： 请自行将 MYSQL_HOST 配置为自己的 MySQL 地址。

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/hummerrisk?autoReconnect=false&useUnicode=true&characterEncoding=UTF-8&characterSetResults=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false
spring.datasource.username=root
spring.datasource.password=root

# 启动模式，lcoal 表示以本地开发模式启动
run.mode=local

3 代码运行⚓︎

3.1 IDEA 方式运行⚓︎

注意

在 Windows 环境下对配置文件的路径会有所要求，一般可以采用下面配置方案，非 Windows 环境以下方案可跳过。

Windows 下环境配置方案

将配置文件放置到工程源码的所在盘的指定路径下，以 hummerrisk.properties 配置文件举例，如源码工程在 D 盘下，则配置文件存放路径为 d:\opt\hummerrisk\conf\hummerrisk.properties。其他配置文件类似。
配置文件可以随意放置在任意路径下，但需要修改工程源码中配置文件的路径信息。以 hummerrisk.properties 配置文件举例，如该配置文件存放在 D 盘根目录下，则需要按下图修改两个地方的配置路径。

新建项目

新建一个 git 项目输入主工程 git 地址: git@github.com:HummerRisk/HummerRisk.git。

配置 maven

配置 maven 并引入 pom.xml。

启动项目

在启动配置中添加 Spring Boot 启动项，直接启动 Spring Boot 项目即可。
启动后端，两种启动方式：
- 可以使用 io.hummerrisk.Application 入口方法直接启动
- 可以使用 maven 插件中的 backend>spring-boot>spring-boot:start 启动

运行后端服务

后端服务成功运行如下所示。

后端服务成功运行

配置前端

进入 hummerrisk/frontend/ 目录，执行以下命令安装相关前端组件。

npm install

进入到 hummerrisk/frontend/ 目录，执行以下命令启动前端服务。

npm run serve

或者使用 yarn 启动

# 项目设置
yarn install

# 编译并最小化生产
yarn build

# 编译和热重装以进行开发
yarn serve

运行前端服务

前端服务成功运行如下所示。

前端服务成功运行

4 本地安装引擎组件⚓︎

注意： 若需要调试相应的检测功能，需要安装相应的组件引擎

Cloud Custodian 作为云平台检测引擎，详细的相关操作，请参考 Cloud Custodian
Prowler 作为 AWS 检测引擎，详细的相关操作，请参考 Prowler
Nuclei 作为漏洞检测引擎，详细的相关操作，请参考 Nuclei
Xray 作为漏洞检测引擎，详细的相关操作，请参考 Xray
Trivy 作为云原生检测引擎，详细的相关操作，请参考 Trivy

4.1 准备运行环境⚓︎

配置本地目录和配置文件

下载 installer 工程：

git clone https://github.com/HummerRisk/installer

初始化目录：

mkdir -p /opt/hummerrisk/conf
mkdir -p /opt/hummerrisk/image
mkdir -p /opt/hummerrisk/file
mkdir -p /opt/hummerrisk/trivy
mkdir -p /opt/hummerrisk/logs

准备配置文件：

cd installer/hummerrisk/config_init/hummerrisk
cp hummerrisk.properties /opt/hummerrisk/conf/hummerrisk.properties

安装 Custodian安装 Prowler安装 Nuclei安装 Xray安装 Trivy

安装 Custodian

$ python3 -m venv custodian
$ source custodian/bin/activate
(custodian) $ pip install c7n
(custodian) $ pip install -e tools/c7n_aliyun
(custodian) $ pip install -e tools/c7n_huawei
(custodian) $ pip install -e tools/c7n_tencent
(custodian) $ pip install -e tools/c7n_baidu
……

安装 Prowler

yum 源方式安装 Prowler

对于 Amazon Linux（yum 基于 Linux 发行版和 AWS CLI v2）

sudo yum update -y
sudo yum remove -y awscli
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
sudo yum install -y python3 jq git
sudo pip3 install detect-secrets==1.0.3
git clone https://github.com/prowler-cloud/prowler

apt 源方式安装 Prowler

对于 Ubuntu Linux（apt 基于 Linux 发行版和 AWS CLI v2）

sudo apt update
sudo apt install python3 python3-pip jq git zip
pip install detect-secrets==1.0.3
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
git clone https://github.com/prowler-cloud/prowler

安装 Nuclei

tar 安装 Nuclei

tar -xzvf nuclei-linux-amd64.tar> mv nuclei-linux-amd64 /usr/bin/nuclei> nuclei -h

源安装 Nuclei

# Nuclei 要求目标设备成功配置好 Go v1.13+ 环境，然后运行下列命令获取项目代码：
GO111MODULE=on go get -u -v github.com/projectdiscovery/nuclei/cmd/nuclei
# 如需更新 Nuclei，可以使用 -u 选项和 go get 命令。

安装 Xray

请下载的时候选择最新的版本下载。
Github: https://github.com/chaitin/xray/releases （国外速度快）
网盘: https://yunpan.360.cn/surl_y3Gu6cugi8u （国内速度快）
注意：不要直接 clone 仓库，xray 并不开源，仓库内不含源代码，直接下载构建的二进制文件即可。

安装 Trivy

Yum 源方式安装

$ sudo vim /etc/yum.repos.d/trivy.repo
[trivy]
name=Trivy repository
baseurl=https://aquasecurity.github.io/trivy-repo/rpm/releases/$releasever/$basearch/
gpgcheck=0
enabled=1
$ sudo yum -y update
$ sudo yum -y install trivy

rpm 方式安装

rpm -ivh https://github.com/aquasecurity/trivy/releases/download/v0.19.2/trivy_0.19.2_Linux-64bit.rpm

二进制方式安装

mkdir -p $GOPATH/src/github.com/aquasecurity
cd $GOPATH/src/github.com/aquasecurity
git clone --depth 1 --branch v0.19.2 https://github.com/aquasecurity/trivy
cd trivy/cmd/trivy/
export GO111MODULE=on
go install

5 镜像打包（推荐）⚓︎

源码中包含 Dockerfile 文件，建议将项目打包成镜像运行，建议 Dockerfile_base 打包用官方版本即可，用户可以替换自己的 Dockerfile 研发版本。

镜像打包

6 其他注意事项⚓︎

内置示例数据以 flyway 的形式在 HummerRisk 启动时自动插入到了 MySQL 数据库中，在源码运行的情况下可自动初始化获取内置检测规则等数据；