https://github.com/ks98/os-nmap
OPNsense Nmap Plugin
https://github.com/ks98/os-nmap
nmap opnsense opnsense-plugin opnsense-plugins
Last synced: 6 months ago
JSON representation
OPNsense Nmap Plugin
- Host: GitHub
- URL: https://github.com/ks98/os-nmap
- Owner: ks98
- Created: 2026-01-09T11:12:54.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-11T11:26:40.000Z (7 months ago)
- Last Synced: 2026-01-11T15:57:51.548Z (6 months ago)
- Topics: nmap, opnsense, opnsense-plugin, opnsense-plugins
- Language: Volt
- Homepage:
- Size: 359 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# os-nmap (OPNsense Nmap Plugin)
This repository contains the OPNsense plugin "os-nmap". It provides a WebUI
to run safe, pre-defined Nmap scans and custom commands.
## Features
- Quick Scan and interface scans from the UI
- Scan profiles with editable arguments
- Results display including services, MAC, and vendor info
- Export host results as JSON or CSV
- Results stored at `/var/db/nmap/scan_results.json`
## Usage (UI)
1. OPNsense: Interfaces -> Diagnostics -> Nmap
2. Quick Scan: choose target and profile
3. Interfaces: select networks and start scan
4. Custom: enter target and arguments (without "nmap" and without target)
## Scan Profiles
Default profiles are created via migration, e.g. Ping scan, Fast TCP scan,
TCP scan, Service detection, Full TCP scan, and Aggressive scan. Custom profiles
can be created and edited in the "Scan Profiles" tab.
## Development / Build
This repo follows the OPNsense plugin layout.
- `make` shows the plugin description (from `pkg-descr`)
- `make package` builds a package in `work/pkg`
- `make install DESTDIR=...` installs into a staging directory
Note: the build system expects an OPNsense builder environment (LOCALBASE, PKG,
etc.).
## Structure
- `src/opnsense/scripts/OPNsense/Nmap/nmap_scan.py`: scan runner
- `src/opnsense/mvc/app/`: UI, controllers, and model
- `src/opnsense/service/conf/actions.d/actions_nmap.conf`: configd action
- `pkg-descr`: short description and changelog