rmcmillan34 / project-pwn

Project PWN (Portable Wargame NUC) is a cyber range homelab designed for taking cybersecurity training on the go.

Project-PWN

Project Portable Wargame Network (PWN) is a comprehensive cyber range and home-lab designed to facilitate cybersecurity training anytime, anywhere. The primary focus of this project is to provide a portable and self-contained infrastructure for hands-on learning and experimentation in the field of cybersecurity.

---

Table of Contents

1. Introduction
2. Objectives
3. Key Features
4. Intended Audience
5. Project Structure
6. How to Use
7. Contribution Guidelines
8. License

---

Purpose and Objectives

PWN emerged from my own necessity to maintain consistent access to a practical learning environment while being mobile, especially during extended work-related travel periods with limited or unreliable internet connectivity. By creating a self-contained cyber range, the primary objectives are:

1. Accessibility: Enabling cybersecurity enthusiasts, professionals, and learners to have a mobile and self-sufficient platform for practical training, irrespective of their location or internet availability.
2. Skill Enhancement: Serving as a learning platform for upskilling in the setup, maintenance, and management of a home-lab. It provides hands-on experience installing and configuring operating systems, creating virtual networks, and practicing ethical hacking concepts in a controlled environment.
3. CTF Challenges and Events: Hosting and developing Capture The Flag challenges and events. This platform will be used for hosting and developing CTF challenges, sharing the learning experience with others while travelling, and fostering a community of learners to participate in and learn from real-world scenarios and cybersecurity challenges.

---

Key Features

• Portability: The lab is built on portable hardware (NUC) that allows for easy transportation without compromising its functionality.
• Self-Contained Infrastructure: The cyber range is designed to operate independently, requiring minimal external resources or internet connectivity.
• Flexibility: Offers the ability to simulate various cybersecurity scenarios, allowing users to experiment with different configurations and scenarios.

---

Intended Audience

This project is intended for:

• Cybersecurity enthusiasts and professionals looking to practice and enhance their skills in a hands-on environment.
• Individuals who require a portable home-lab for cybersecurity training, especially in situations where stable internet connectivity is limited or not available.
• Those seeking practical experience in building and maintaining a cyber range or home-lab.
• Participants interested in engaging and learning through CTF challenges, CTF development and events.

---

Project Structure

The project is structured into several directories, each focusing on a specific aspect of the cyber range home lab setup.

• /hardware_build

  • This directory contains information and guides about my chosen hardware configuration, including details about the components selected and the build and configuration process

• /proxmox_configuration

  • Here, you'll find instructions and configurations tailored for Proxmox setup. This includes installation guides, networking setup, and storage configurations.

• /truenas_configuration

  • Within this directory, you'll find information regarding TrueNAS configuration, covering installation, setup, and essential configurations.

• /pfsense_configuration

  • Detailed guides on the setup and configuration of pfSense, including installation steps, network configuration, and security considerations.

• /ctfd_configuration

  • This directory hosts the configuration for the CTFd framework and various Capture The Flag challenges I created. Each challenge is organized within its own subdirectory, containing challenge descriptions and associated files.

• /vulnerable_os_configuration

  • Information and walkthroughs on setting up and configuring vulnerable operating systems; each vulnerable OS is organised within its own subdirectory.

Each directory contains detailed documentation, README files, and further subdirectories to maintain a well-organized structure and provide easy access to specific information within the project.

---

How to Use

The primary goal of Project PWN is to enable users to create their own PWN home-lab, facilitating learning in virtualization and cybersecurity.

Prerequisites To engage with the cyber range home lab setup, users will need hardware capable of hosting virtual machines. The hardware specifications of my personal build are provided in the hardware_build subdirectory, enabling users to replicate the setup.

Accessing Setup Guides The setup guides and configurations are available online in the GitHub repository. Users can access these guides directly from the repository or fork their own version for personal use.

Installation Steps Hardware Build: Build the hardware as outlined in the hardware_build subdirectory or ensure your hardware meets the specified requirements. Proxmox Hypervisor Installation: Install the Proxmox hypervisor following the provided setup guide. pfSense and Vulnerable Operating Systems: Configure and install pfSense followed by other vulnerable operating systems as detailed in the setup guides.

Connection and Accessibility Connect your Project PWN home-lab to your network or a stand-alone network. Once the vulnerable operating systems are configured, they should be accessible and ready for use.

Additional Notes

• No specific tools or software need to be preinstalled, as the setup guides should cover the necessary installations.
• At this stage, the project is not complete, and as such, potential troubleshooting steps have not yet been identified.
• Links to official websites for tools and software will be provided within the guides, enabling users to find resources for troubleshooting setup and usage issues.

---

TODO

Here is a list of ongoing tasks required for Project PWN cyber range home-lab:

Hardware Build

• Hardware Installation
  • Installation Guide
  • Installation Video
• Hardware Configuration
  • Boot Drive Order
  • Travel Router Network Configuration
• References/Resources

Proxmox Configuration

• Install Proxmox
  • Proxmox Installation Guide
  • Proxmox Video
• Configure Management Port

pfSense Configuration

• Install pfSense
  • pfSense VM Installation Guide
  • pfSense VM Installation Video
• Configure pfSense
  • pfSense Configuration Guide
  • pfSense Configuration Video

TrueNAS Configuration

• TrueNAS Installation
  • Installation Guide
  • Installation Video
• TrueNAS Configuration
  • Create users
  • Create shares

Vulnerable OS Configuration

• Vulnerable Applications reference list
• Converting *.ova to .qcow2/.raw
  • Create script to automate process
  • Video on how to achieve manually
• Converting vulnerable images to docker containers
• Install Metasploitable2
• Install Metasploitable3 - Linux
• Install Metasploitable3 - Windows
• Install OWASP-JuiceShop
• Install OWASP-

---

Contribution Guidelines

Contributing

We welcome contributions to enhance and improve Project PWN. Here are the guidelines and steps for contributing:

How to Contribute

1. Fork the Repository: Start by forking this repository to your own GitHub account.
2. Clone the Repository: Clone the forked repository to your local machine.

   git clone https://github.com/rmcmillan34/Project-PWN.git

3. Create a New Branch: Make changes in a new branch for each specific update or improvement.

   git checkout -b feature/your-feature

4. Make Changes: Implement the desired changes or additions.
5. Commit Changes: Commit your changes with clear and concise commit messages.

   git commit -m "Brief description of changes."

6. Push Changes: Push your changes to your forked repository.

   git push origin feature/your-feature

7. Create a Pull Request: Visit the original repository on GitHub and create a Pull Request with a detailed description of your changes.

Contribution Guidelines

• Before contributing, ensure your proposed changes align with the project's objectives and guidelines.
• Follow the existing code style and structure.
• Be clear and descriptive in your commit messages and Pull Request descriptions.
• Verify that your changes work effectively and do not break existing functionality.

Contributors

Thank you to all the contributors who have helped improve Project PWN! Your contributions are valuable and greatly appreciated.

• Ryan McMillan (@rmcmillan34)
• [Add your name here as you contribute!]

If you'd like to become a contributor, follow the above guidelines to get started.

---

License

Project PWN is licensed under the MIT LICENSE