GitHub - D4-project/nmap2json: Library to Convert XML Nmap output to usable JSON

Description

nmap2json is a simple python library to convert nmap xml output to python object dumpable in json.

It could be also used in command line if you want to save the json as array or, per ip, or send it to the direct output.

Additionnal fields

nmap2json add two fields per object.

...
"host_reply": true,
"sha256": "446c094a24f248da6a87cc7bffaae3df9cf5b0dc5a07d1ca7fff8cdb2071b389",
...

host_reply is set to true if any of the scanned port of the host is up. sha256 is the hash of the whole object excluding the fields "starttime" and "endtime"

Example

Usage is simple; after running a nmap scan using export into XML file, for example with;

$ nmap -v -A -oX myoutput.xml -p 25,80,443,22 -Pn www.whateveryouscan.domain

you could simply output the results as a json object.

$ python -m nmap2json -i myoutput.xml

Help

$ python -m nmap2json -h
usage: __main__.py [-h] -i INPUT [-o OUTPUT] [-m]

Convert Nmap XML to JSON

options:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Input Nmap XML file
  -o OUTPUT, --output OUTPUT
                        Output JSON file (prints to stdout if omitted)
  -m, --multiple        Enable multiple JSON outputs (IP prefixed)
  -n, --notopen         Remove from output closed ports
  -d, --deadhost        Remove from output dead hosts

Requirements

Python >= 3.10

Library usage

This library allows you to load a nmap xml output either from a file or from a loaded string.

import json
from nmap2json import nmap_file_to_json, nmap_xml_to_json

Convert the XML loaded in a string
python_obj = nmap_xml_to_json(xml_str)

Convert the XML directly from a file
python_obj = nmap_file_to_json(xml_file)

print(json.dumps(python_obj, indent=2))