Nmass

Nmass is a python3 library that makes it easier for developers to use nmap and masscan. It translates many and complex arguments into idiomatic methods and wraps the scan results in well-defined pydantic models.

Requirements

Python 3.9+

Installation

pip install nmass

Examples

Basic nmap example

nmap_example.py

nm = (
    Nmap()
    .with_targets("172.18.0.2")
    .with_most_common_ports(100)
    .with_service_info()
    .with_default_script()
    .without_ping()
    .without_dns_resolution()
)
if result := nm.run(timeout=100):
    print(result.model_dump_json(exclude_none=True))

Basic masscan example

masscan_example.py

ms = (
    Masscan()
    .with_targets("183.2.172.185")
    .with_ports("80,443")
    .with_banner()
)
if result := ms.run(timeout=100):
    print(result.model_dump_json(exclude_none=True))

Async support

try:
    result = await Nmap().with_targets("example.com").with_ports(80, 443).arun(timeout=100)
except asyncio.TimeoutError:
    ...
else:
    if result is not None:
        print(result.model_dump_json(exclude_none=True))

More?

Masscan is fast, and nmap is powerful. Why not combine the two?🤩 Start by using masscan to quickly detect open ports in bulk, then use nmap to perform in-depth scans on these open ports!

step1 = (
    Masscan()
    .with_targets("10.0.0.0/8") # (1)
    .with_ports(80, 443)
    .with_rate(10000)
)
step2 = (
    Nmap()
    .with_step(step1.run())
    .with_service_info()
    .with_scripts("http-title")
    .with_verbose()
)
retult = step2.run()

1. This is just an example, is not recommended to run.