在 django 中故意构建的易受攻击 Web 应用安全项目。
我们的路线图是在 django 中构建故意易受攻击的 Web 应用。漏洞可以基于 OWASP 十大安全风险
每个实验环境都运行在各自的 Docker 容器中,因此 PyGoat 在所有安装方式中都需要 Docker。
这会启动 PyGoat、Traefik 以及实验环境所需的一切。
8000、80(Traefik,用于提供实验环境)和 8080(Traefik 仪表盘)必须空闲。git clone https://github.com/adeyosemanputra/pygoat.git
cd pygoat
docker compose up -d
(较旧的 Docker 安装使用 docker-compose up -d。)docker compose logs -f migration 跟踪进度。后续运行会复用镜像并快速启动。localhost)。实验通过 lab-<username>-<lab>.lvh.me 提供服务,并且只有启动该实验的用户才能访问,这要求登录 cookie 在 *.lvh.me 之间共享。docker compose down 停止所有内容。Docker Hub 上的
pygoat/pygoat镜像是旧的 v2 版本,不包含 v3 实验。请改用 Docker Compose。
要在本地机器上设置项目:
首先,使用 GitHub 网站或终端中的 git 克隆仓库
git clone https://github.com/adeyosemanputra/pygoat.git
### To Download a specific branch
git clone -b <branch_name> https://github.com/adeyosemanputra/pygoat.git
然后,从 Traefik 的 releases 页面将 Traefik 下载到本地机器上的 Pygoat 目录中(如果你不使用 Docker Compose)。打开一个单独的终端并运行以下命令:
对于 Linux/WSL -
tar -zxvf traefik_<traefik_version>_linux_<arch>.tar.gz
sudo ./traefik
对于 Windows(Powershell) -
Expand-Archive traefik_<traefik_version>_windows_<arch>.zip
cd traefik_<traefik_version>_windows_<arch>
./traefik.exe
如果在安装过程中遇到任何问题,请参阅文档
bash installer.shpython3 manage.py migrate
python3 manage.py seed_scoring
python3 manage.py populate_labs
python3 manage.py runserver。pip install -r requirements.txt。python3 manage.py migrate
python3 manage.py seed_scoring
python3 manage.py populate_labs
python3 manage.py runserver。setup.py 文件安装所有应用和 Python 依赖 - pip3 install .python3 manage.py migrate
python3 manage.py seed_scoring
python3 manage.py populate_labs
python3 manage.py runserver。python3 命令不可用。请改用 python,并确保它指向 Python 3。installer.sh 从源码安装installer.sh本节将指导你创建新的漏洞实验并将其集成到 PyGoat 中。
dockerized_labs 文件夹:cd dockerized_labs
mkdir your_lab_name
cd your_lab_name
创建标准应用程序结构,包括 Dockerfile、docker-compose.yml、requirements.txt(如果使用 Python)、主应用程序入口点(例如 app.py、main.py 或等效文件)、与实验相关的易受攻击端点或组件,以及记录该实验的 README.md。该应用程序不一定必须是 Flask 应用程序——它可以是任何 Python 项目(首选,因为这是 Pygoat 的一部分),或者如果合适,甚至可以是其他语言。请参考 dockerized_labs 文件夹中的现有实验,了解示例和结构约定。
重要:在 app.py 中添加 /health 端点,用于容器健康检查。
访问位于 http://localhost:8000/admin/ 的 Django 管理面板,并导航到 Labs 部分。
添加一个新条目,包含:
your_lab_namedockerized_labs/your_lab_name<PORT_NUMBER>(或者,你可以通过 Django shell 或自定义数据迁移来注册它)。
重要:
Dockerfile、docker-compose.yml、app.py 和数据库条目中使用相同的端口号。cd /path/to/pygoat
cd dockerized_labs/your_lab_name
docker compose up
在 http://localhost:<PORT_NUMBER> 访问你的实验环境
验证漏洞是否按预期生效
停止单独的实验容器
在 base.html 中添加你的实验环境详情
从 PyGoat 根目录重新构建整个应用:
docker compose down
docker compose up --build
uninstaller.sh 脚本卸载 pygoat 及其所有依赖项。pygoat,只需运行:$ bash ./uninstaller.sh
uninstaller.py 脚本卸载 pygoat 及其所有依赖项pygoat,只需运行:$ python3 uninstaller.py
感谢这些优秀的人(emoji 键):