Guardicore Monkey项目开发环境部署指南

项目概述

Guardicore Monkey是一个开源的安全测试工具，主要用于模拟网络行为，帮助团队评估和提升企业网络的安全性。本文将详细介绍如何在Windows和Linux系统上搭建Monkey项目的开发环境。

环境准备

在开始部署前，请确保系统已安装以下必备组件：

• Git版本控制系统
• 管理员权限（Linux系统需要sudo权限）

Windows系统部署

1. 获取部署脚本

使用PowerShell执行以下命令下载部署脚本：

Invoke-WebRequest [部署脚本URL] -OutFile deploy_windows.ps1

2. 执行部署脚本

脚本支持以下参数配置：

• -monkey_home：指定项目安装目录（默认为当前目录下的infection_monkey文件夹）
• -branch：指定要克隆的分支（默认为develop分支）
• agents：是否下载最新代理二进制文件（默认为true）

典型使用示例：

.\deploy_windows.ps1 -monkey_home "C:\monkey_dev" -branch 'feature-branch'

3. 常见问题解决

• 执行策略限制：可通过powershell -ExecutionPolicy ByPass参数绕过
• Python环境变量：安装时请勾选"Add Python to PATH"选项

Linux系统部署

1. 获取部署脚本

适用于Ubuntu 16/18系统，执行以下命令：

wget [部署脚本URL]
chmod u+x ./deploy_linux.sh

2. 执行部署脚本

参数说明：

1. 绝对路径参数：指定安装目录（默认为./infection_monkey）
2. 分支参数：指定克隆分支（默认为develop）
3. 代理下载开关：false表示不下载代理二进制文件

使用示例：

./deploy_linux.sh /opt/monkey_dev "master" false

3. 启动Monkey Island

部署完成后，执行以下命令启动服务：

cd infection_monkey/monkey/monkey_island
pipenv run python ../monkey_island.py

注意：建议在新的终端会话中执行，确保环境变量已更新。

代码提交规范配置

部署脚本会自动安装pre-commit钩子，它会在代码提交时执行以下检查：

• 代码格式验证
• 语法错误检测
• 安全检查

如需手动安装：

pip install --user pre-commit
pre-commit install -t pre-commit -t pre-push -t prepare-commit-msg

开发建议

1. 分支管理：建议在feature分支开发，通过PR合并到develop分支
2. 测试验证：修改代码后应运行完整测试套件
3. 文档更新：代码变更时同步更新相关文档

结语

通过本文的部署指南，开发者可以快速搭建Guardicore Monkey的开发环境。建议定期同步上游仓库获取最新更新，并遵循项目的代码贡献规范进行开发工作。