Net Pretzel

This project is in early development!

A FAST network scanner that identifies security vulnerabilities in your network and alerts you to new ones as they arise.

Features:

• Scan your network for open ports and services.
• Identify security vulnerabilities in your network.
• Display all CVEs and CVVSS scores for each device where vulnerabilities are found.
• Alert you to new vulnerabilities as they arise.
• Alert you to new devices on your network.
• Platform agnostic (Windows, MacOS, Linux).

Development

Requirements

• Python 3.13.+ (with pip)
• Nmap installed on your system

Installation

To install the backend dependencies, run the following command:

pip install -r backend/requirements.txt

Running the Backend

Scanning your network requires root access! To get root access, run the following command:

sudo su

With root access, now you can run the backend:

cd backend
uvicorn main:app --reload

If using VSCode, you can run the API backend by running the debugger under Python Debugger: FastAPI.

Once the API is running, you have access to it at http://localhost:8000, and the Swagger UI at http://localhost:8000/docs.

Testing the Backend

This project uses pytest for testing. To run the tests, run the following command:

pytest --cov --cov-report=xml

Running the Frontend

To run the frontend, run the following commands:

cd frontend
npm install
npm start

Once the frontend is running, you can access to it at http://localhost:8080.

Project Structure

|-- backend/
│   ├── api/              # API Endpoints
│   │── scan/              # NMap scanner
│   │── main.py            # FastAPI entrypoint
├── frontend/               # React Frontend
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   ├── App.tsx
│   └── package.json        # Frontend dependencies
├── .gitignore
└── README.md