Merged script changes

Author: nmmapper

nmap3/exceptions.py

@@ -23,10 +23,9 @@
 import sys
 import re
 
-__author__ = 'Wangolo Joel ([email protected])'
-__version__ = '1.4.7'
-__last_modification__ = '2029/06/11'
-
+__author__ = 'Wangolo Joel ([email protected])'
+__version__ = '1.4.9'
+__last_modification__ = '2029/12/11'
 
 class NmapNotInstalledError(Exception):
     """Exception raised when nmap is not installed"""
@@ -41,4 +40,7 @@ class NmapXMLParserError(Exception):
     def __init__(self, message="Unable to parse xml output"):
         self.message = message 
         super().__init__(message)
-        
+
+class NmapExecutionError(Exception):
+    """Exception raised when en error occurred during nmap call"""
+

nmap3/nmap3.py

@@ -29,14 +29,13 @@
 import argparse
 from xml.etree import ElementTree as ET
 from xml.etree.ElementTree import ParseError
-from nmap3.exceptions import NmapNotInstalledError, NmapXMLParserError
 from nmap3.nmapparser import NmapCommandParser
 from nmap3.utils import get_nmap_path, user_is_root
-
+from nmap3.exceptions import NmapNotInstalledError, NmapXMLParserError, NmapExecutionError
 import xml
 
-__author__ = 'Wangolo Joel (info@nmapper.com)'
-__version__ = '1.4.7'
+__author__ = 'Wangolo Joel (inquiry@nmapper.com)'
+__version__ = '1.4.9'
 __last_modification__ = '2020/12/10'
 OS_TYPE = sys.platform
 
@@ -59,13 +58,23 @@ def __init__(self, path=None):
         self.top_ports = dict()
         self.parser  = NmapCommandParser(None)
         self.raw_ouput = None
+        self.as_root = False
+
+    def require_root(self, required=True):
+        """
+        Call this method to add "sudo" in front of nmap call
+        """
+        self.as_root = required
 
     def default_command(self):
         """
         Returns the default nmap command
         that will be chained with all others
         eg nmap -oX -
         """
+        if self.as_root:
+            return self.default_command_privileged()
+
         return self.default_args.format(nmap=self.nmaptool, outarg="-oX")
 
     def default_command_privileged(self):
@@ -240,19 +249,22 @@ def run_command(self, cmd):
 
         @param: cmd--> the command we want run eg /usr/bin/nmap -oX -  nmmapper.com --top-ports 10
         """
-        if(os.path.exists(self.nmaptool)):
-            sub_proc = subprocess.Popen(cmd, stdout=subprocess.PIPE)
+        if (os.path.exists(self.nmaptool)):
+            sub_proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
             try:
                 output, errs = sub_proc.communicate()
             except Exception as e:
                 sub_proc.kill()
-                raise(e)
+                raise (e)
             else:
+                if 0 != sub_proc.returncode:
+                    raise NmapExecutionError('Error during command: "' + ' '.join(cmd) + '"\n\n' + errs.decode('utf8'))
+
                 # Response is bytes so decode the output and return
                 return output.decode('utf8').strip()
         else:
             raise NmapNotInstalledError()
-            
+
     def get_xml_et(self, command_output):
         """
         @ return xml ET
@@ -318,14 +330,15 @@ def tpl(i):
 
         return xml_root
 
-
     def nmap_fin_scan(self, target, args=None):
         """
         Perform scan using nmap's fin scan
 
         @cmd nmap -sF 192.168.178.1
 
         """
+        self.require_root()
+
         xml_root = self.scan_command(self.fin_scan, target=target, args=args)
         results = self.parser.filter_top_ports(xml_root)
         return results
@@ -337,8 +350,8 @@ def nmap_syn_scan(self, target, args=None):
 
         @cmd nmap -sS 192.168.178.1
         """
+        self.require_root()
         xml_root = self.scan_command(self.sync_scan, target=target, args=args)
-        # Use the top_port_parser
         results = self.parser.filter_top_ports(xml_root)
         return results
 
@@ -360,6 +373,8 @@ def nmap_udp_scan(self, target, args=None):
 
         @cmd nmap -sU 192.168.178.1
         """
+        self.require_root()
+
         if(args):
             assert(isinstance(args, str)), "Expected string got {0} instead".format(type(args))
         xml_root = self.scan_command(self.udp_scan, target=target, args=args)
@@ -476,12 +491,6 @@ def nmap_disable_dns(self, target, args=None):
         results = self.parser.filter_top_ports(xml_root)
         return results
 
-class NmapScripts(Nmap):
-    """
-    This will be responsible for the nmap extra scriptin engine
-    """
-    pass
-    
 if __name__=="__main__":
     parser = argparse.ArgumentParser(prog="Python3 nmap")
     parser.add_argument('-d', '--d', help='Help', required=True)

nmap3/nmapparser.py

@@ -101,13 +101,12 @@ def filter_top_ports(self, xmlroot):
 
             port_result_dict["stats"]=stats
             port_result_dict["runtime"]=self.parse_runtime(xmlroot)
-            port_result_dict["totals"]=self.total_hosts(xmlroot)
 
         except Exception as e:
             raise(e)
         else:
             return port_result_dict
-    
+   
     def os_identifier_parser(self, xmlroot):
         """
         Parser for identified os
@@ -179,7 +178,11 @@ def parse_ports(self, xml_hosts):
                     cpe_list = []
                     cpe_list.append({"cpe": cp.text})
                     open_ports["cpe"] = cpe_list
+            
+            # Script
+            open_ports["scripts"]=self.parse_scripts(port.findall('script')) if port.findall('script') is not None else []
             open_ports_list.append(open_ports)
+            
         return open_ports_list
 
     def parse_runtime(self, xml):
@@ -192,16 +195,7 @@ def parse_runtime(self, xml):
         if runstats is not None:
             if runstats.find("finished") is not None:
                 return runstats.find("finished").attrib
-                
-    def total_hosts(self, xml):
-        """
-        Parse parts from xml
-        """
-        hosts = xml.find("runstats/hosts")
-        if hosts is not None:
-            return hosts.attrib
-        return {}
-        
+    
     def parse_mac_address(self, xml):
         """
         Parse parts from xml
@@ -211,8 +205,7 @@ def parse_mac_address(self, xml):
         for addr in addresses:
             if(addr.attrib.get("addrtype") == "mac"):
                 return addr.attrib
-        return {}
-        
+    
     def parse_hostnames(self, host):
         """
         Parse parts from xml
@@ -231,4 +224,56 @@ def get_hostname_state(self, xml):
         state = xml.find("status")
         if(state is not None):
             return state.attrib
-        return {}
+    
+    def parse_scripts(self, scripts_xml):
+        scripts = []
+
+        for script_xml in scripts_xml:
+            script_name = script_xml.attrib.get('id')
+            raw_output = script_xml.attrib.get('output')
+
+            data = self.convert_xml_elements(script_xml)
+            if script_xml.findall('table') is not None:
+                tables = script_xml.findall('table')
+                child_data = self.convert_xml_tables(tables)
+                for k in child_data:
+                    if {} != k:
+                        data[k] = child_data[k]
+
+            scripts.append({
+                'name': script_name,
+                'raw': raw_output,
+                'data': data
+            })
+
+        return scripts
+
+    def convert_xml_tables(self, xml_tables):
+        data = {}
+        for xml_table in xml_tables:
+            key = xml_table.attrib.get('key')
+            child_data = self.convert_xml_elements(xml_table)
+            if key is None:
+                if {} != child_data:
+                    a = data.get('children', [])
+                    data['children'] = a + [child_data]
+            else:
+                if xml_table.findall('table') is not None:
+                    data[key] = self.convert_xml_tables(xml_table.findall('table'))
+                if {} != child_data:
+                    a = data.get(key, {})
+                    b = a.get('children', [])
+                    a['children'] = b + [child_data]
+
+        return data
+
+    def convert_xml_elements(self, xml_obj):
+        elements = {}
+        elem_counter = 0
+        for elem in xml_obj.findall('elem'):
+            if None == elem.attrib.get('key'):
+                elements[elem_counter] = elem.text
+            else:
+                elements[elem.attrib.get('key')] = elem.text
+            elem_counter += 1
+        return elements

nmap3/utils.py

@@ -24,9 +24,9 @@
 import re
 import os
 
-__author__ = 'Wangolo Joel (info@nmapper.com)'
-__version__ = '0.1.1'
-__last_modification__ = '2019/11/22'
+__author__ = 'Wangolo Joel (inquiry@nmapper.com)'
+__version__ = '1.4.9'
+__last_modification__ = '2019/12/11'
 
 
 def get_nmap_path():