An open API service indexing awesome lists of open source software.

https://github.com/megabyteknight/pentestfilesetup

A Python script that generates a structured folder setup for penetration testing projects. Enter a root folder name, and it creates organized directories for evidence, logs, scans, scope, and tools—helping keep engagements structured and efficient.
https://github.com/megabyteknight/pentestfilesetup

Last synced: 4 months ago
JSON representation

A Python script that generates a structured folder setup for penetration testing projects. Enter a root folder name, and it creates organized directories for evidence, logs, scans, scope, and tools—helping keep engagements structured and efficient.

Awesome Lists containing this project

README

        

# Penetration Testing File Structure Setup

A simple Python script that prompts you for a root folder name and creates a standard folder structure for penetration testing projects.

## Features

- Automatically creates nested directories for different stages of an engagement.
- Separates EPT (External Penetration Test) and IPT (Internal Penetration Test) folders.
- Helps keep logs, evidence, tools, and scans organized in one place.

## Requirements

- **Python 3** (3.6 or later recommended)
- A UNIX-like environment (Linux, macOS, WSL on Windows) for best compatibility

## Installation

1. Download the python script:
```
curl -O https://raw.githubusercontent.com/MegaByteKnight/penTestFileSetup/main/penTestFileSetup.py
```

## Usage

1. Make the script executable (optional, but convenient):
```
chmod +x penTestFileSetup.py
./penTestFileSetup.py
```
2. Or
```
python3 penTestFileSetup.py
```
3. When prompted, enter the name of the directory (e.g., `Pen Test Company`), and the script will create a structured set of folders under that root.

## Example

Let's create a directory for penetration testing
Enter the name of the directory you would like to create (i.e. Pen Test Company): Pen Test Company

# After running the script, you'll have:

```
Pen Test Company/
├── EPT
│ ├── evidence
│ │ ├── credentials
│ │ ├── data
│ │ └── screenshots
│ ├── logs
│ ├── scans
│ ├── scope
│ └── tools
└── IPT
├── evidence
│ ├── credentials
│ ├── data
│ └── screenshots
├── logs
├── scans
├── scope
└── tools
```

## Customizing the Folder Structure

If you'd like a different folder structure, simply open the `penTestFileSetup.py` file in your favorite text editor and modify the `subdirectories` list. Adjust, add, or remove entries as needed to fit your project requirements. Save your changes and run the script again to generate the updated folder structure.

## Contributing

Feel free to submit issues or pull requests if you have ideas for improving this script. All contributions are welcome!

## License

This project is licensed under the [MIT License](LICENSE).
You’re free to modify, distribute, or sell this script as long as the original license is included.