PyGoat

意図的に脆弱性を含んだDjango製Webアプリケーションセキュリティ学習ツール。 ロードマップとして、OWASP Top 10に基づいた脆弱性を含むDjango製Webアプリケーションを構築します。

目次

• pygoat
  • インストール
    • ソースから
    • Dockerコンテナ
    • インストール動画
  • アンインストール
  • 解答
  • 開発者向け

インストール

ソースから

ローカルマシンにプロジェクトをセットアップするには：

まず、GitHubウェブサイトまたはターミナルのgitを使用してリポジトリをクローンします。

  git clone https://github.com/adeyosemanputra/pygoat.git
  ### 特定のブランチをダウンロードする場合
  git clone -b <branch_name> https://github.com/adeyosemanputra/pygoat.git

Windowsの注意点（PowerShellユーザー向け）

• PyGoatは主にLinux/macOS上でテストされています。Windowsユーザーは以下の使用を推奨します：
  • Docker Desktop（推奨）、または
  • WSL2 (Ubuntu) でよりスムーズなセットアップ。
• 一部のWindows環境では、python3コマンドがデフォルトで利用できない場合があります。
  • python3が認識されない場合は、代わりにpythonを使用してみてください（Python 3.xを指していることを確認）。
• Pythonのバージョンは3.10または3.11であることを確認し、最良の互換性を確保してください。
• 一部のラボはUnixスタイルのコマンドに依存しており、ネイティブWindowsシェルでは異なる動作をする可能性があります。

方法1

1. インストーラーファイルを使用してすべてのアプリとPython要件をインストール - bash installer.sh
2. マイグレーションを適用 python3 manage.py migrate。
   
3. 最後に、開発サーバーを実行 python3 manage.py runserver。
   
4. プロジェクトは http://127.0.0.1:8000 で利用可能になります。

方法2

1. python3の要件をインストール pip install -r requirements.txt。
   
2. マイグレーションを適用 python3 manage.py migrate。
   
3. 最後に、開発サーバーを実行 python3 manage.py runserver。
   
4. プロジェクトは http://127.0.0.1:8000 で利用可能になります。

方法3

1. setup.pyファイルを使用してすべてのアプリとPython要件をインストール - pip3 install .
2. マイグレーションを適用 python3 manage.py migrate。
   
3. 最後に、開発サーバーを実行 python3 manage.py runserver。
   
4. プロジェクトは http://127.0.0.1:8000 で利用可能になります。

Dockerコンテナ

1. Docker をインストール
2. docker pull pygoat/pygoat または docker pull pygoat/pygoat:latest を実行
3. docker run --rm -p 8000:8000 pygoat/pygoat:latest を実行
4. http://127.0.0.1:8000 にアクセス
5. エラーが発生した場合は、docker image rm pygoat/pygoatで既存イメージを削除して再度プルしてください。

Docker-Composeから

1. Docker をインストール
2. docker-compose up または docker-compose up -d を実行

チャレンジデータの投入

PyGoatはチャレンジ定義をchallenge/challenge.jsonに保存します。 このファイルからデータベースのChallengeテーブルにデータを投入するには、組み込みのDjango管理コマンドを使用します：

Docker Composeを使用

docker compose exec web python manage.py populate_challenges

Dockerイメージをビルドして実行

1. リポジトリをクローン   git clone https://github.com/adeyosemanputra/pygoat.git
2. DockerfileからDockerイメージをビルド   docker build -f Dockerfile -t pygoat .
3. Dockerイメージを実行  docker run --rm -p 8000:8000 pygoat:latest
4. http://127.0.0.1:8000 または http://0.0.0.0:8000 にアクセス

インストール動画

1. installer.shを使用したソースからのインストール

• ソースからPyGoatをインストール

2. installer.shを使用しない場合

3. Mac M1でのインストール（Virtualenv使用）

アンインストール

Debian/Ubuntuベースのシステム

• Debian/Ubuntuベースのシステムでは、uninstaller.shスクリプトを使用してpygoatとその依存関係をすべてアンインストールできます。
• pygoatをアンインストールするには、以下を実行：

$ bash ./uninstaller.sh

その他のシステム

• その他のシステムでは、uninstaller.pyスクリプトを使用してpygoatとその依存関係をすべてアンインストールできます。
• pygoatをアンインストールするには、以下を実行：

$ python3 uninstaller.py

解答

すべてのチャレンジの解答

コントリビューター ✨

これらの素晴らしい人々に感謝します（絵文字キー）：

このプロジェクトはall-contributors仕様に従っています。どんな種類の貢献も歓迎します！