Pentest Service Microservice

Overview

This project is a Spring Boot microservice that performs network scans using Nmap. It is containerized with Docker for ease of deployment.

Features

• Perform network scans using Nmap
• Basic authentication
• Containerized with Docker

Prerequisites

• Docker
• Java 17
• Maven

Building the Project

Maven

mvn clean package

Building the Docker Image

docker build -t nmap-service .

Running the Docker Container

docker run -p 8080:8080 nmap-service

API Endpoints

Scan Endpoint

Performs an Nmap scan on the specified target.

URL : /scan

Method : GET

Auth required : YES

Query Params:

target=[string] Target to scan (e.g., localhost).

Response :

200 OK : Scan completed

Example Request

curl -u user:password "http://localhost:8080/scan?target=localhost"

Licence

MIT

MIT License

Copyright (c) 2024 Emanuel Diaz

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.