nmap2md.py

#!/usr/bin/env python

import re
import sys
import xml.etree.ElementTree as ET
from optparse import OptionParser

import columns_definition

__version__ = "1.2.1"

parser = OptionParser(usage="%prog [options] file.xml", version="%prog " + __version__)

parser.add_option("-c", "--columns", default="Port,State,Service,Version", help="define a columns for the table")
parser.add_option(
    "--hs",
    default=4,
    type="int",
    help="address is used as a header, this option defines header number h1 -> h6"
)
parser.add_option(
    "--rc",
    "--row-cells",
    default="[port.number]/[port.protocol],[state],[service.name],[service.product] [service.version]",
    help="define rows which will report certain data. Those rows: [port.number], [port.protocol], [state], "
         "[service.name], [service.product], [service.version] "
)
parser.add_option(
    "--print-empty",
    dest="print_empty",
    action="store_true",
    help="should addresses with no opened ports to be printed"
)
parser.add_option(
    "--sort",
    default="Port;asc",
    help="Sort results by provided row cell"
)
parser.set_defaults(print_empty=False)

(options, args) = parser.parse_args()

columns = options.columns.split(",")
row_cells = options.rc.split(",")

sorting = options.sort.split(";")
sorting_reverse = False

if len(sorting) == 2:
    try:
        if sorting[1] == 'desc':
            sorting_reverse = True
    except IndexError:
        print("[Err] Could not get sorting direction")
        print()
        sys.exit()

try:
    sorting_index = columns.index(sorting[0])
except ValueError:
    print("[Err] Please provide existing column")
    print()
    sys.exit()
except IndexError:
    print("[Err] No sorting value defined")
    print()
    sys.exit()

definitions = columns_definition.Element.build(columns_definition.definition)
result = {}
md = ""

if len(columns) != len(row_cells):
    print("[Err] Columns and row cells amount should be equal")
    sys.exit()

# Wrong header number, setting to default option
if options.hs < 0 or options.hs > 6:
    options.hs = 4

try:
    tree = ET.parse(args[0])
except IndexError:
    print("[Err] No filename supplied as an argument")
    print()
    parser.print_help()
    sys.exit()
except IOError:
    print("[Err] Non-readable or non-existent file supplied as an argument")
    print()
    sys.exit()
except ET.ParseError:
    print("[Err] Something went wrong when parsing the XML file - perhaps it's corrupted/invalid?")
    print()
    sys.exit()

for host in tree.getroot().findall("host"):
    address = host.find("address").attrib["addr"]
    port_info = []
    ports = host.find("ports")

    if ports:
        for port in ports.findall("port"):
            cells = []

            for rc in row_cells:
                current_cell = rc
                for bc in re.findall("(\[[a-z\.*]+\])", rc):
                    for definition in definitions:
                        elem = definition.find(bc[1:-1])

                        if elem:
                            xml_element = port.find(elem.xpathfull())
                            if xml_element is not None:
                                data = elem.data(xml_element)
                                current_cell = current_cell.replace(bc, data)
                                break

                            break

                cells.append(current_cell)

            port_info.append(cells)

    result[address] = port_info

# Start converting data to Markdown
# IP addresses are defined as a header
for address in result:
    if not options.print_empty and len(result[address]) == 0:
        continue

    if options.hs != 0:
        md += "%s %s\n\n" % ('#' * options.hs, address)
    md += "| %s |" % " | ".join(columns)
    md += "\n"

    # Adding +2 for 1 space on left and right sides
    md += "|%s|" % "|".join(map(lambda s: '-' * (len(s) + 2), columns))
    md += "\n"

    result[address] = sorted(
        result[address],
        key=lambda row: row[sorting_index],
        reverse=sorting_reverse
    )

    for port_info in result[address]:
        md += "| %s |" % " | ".join(port_info)
        md += "\n"

    md += "\n\n"

print()
print()
print(md)