PyGoat

Django로 작성된 의도적으로 취약한 웹 애플리케이션 보안 도구입니다. 로드맵: Django로 의도적으로 취약한 웹 애플리케이션을 구축합니다. 취약점은 OWASP Top 10을 기반으로 합니다.

목차

• pygoat
  • 설치
    • 소스에서
    • Docker 컨테이너
    • 설치 동영상
  • 제거
  • 해결 방법
  • 개발자 가이드

설치

소스에서

로컬 머신에 프로젝트를 설정하려면:

먼저, GitHub 웹사이트 또는 터미널에서 git을 사용하여 리포지토리를 클론하세요.

  git clone https://github.com/adeyosemanputra/pygoat.git
  ### 특정 브랜치 다운로드 시
  git clone -b <브랜치_이름> 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. installer 파일을 사용하여 모든 앱 및 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으로 기존 이미지를 제거하고 다시 pull하세요.

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 명세를 따릅니다. 모든 종류의 기여를 환영합니다!