The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

NmapParser - parse nmap scan data with perl

SYNOPSIS

  use XML::NmapParser;
  my $parser = NmapParser->new();
  
  my $parsedFile = $parser->parse(<NMAP XML file>);
  
  my $ScannedIPs = $parser->scanned();
  my $LiveHosts = $parser->live();
  
  my @IPs = $parser->get_ips();
  
  my $host = $parser->get_host($ip);
    # NmapParser::Host object

  my @HostScripts = $host->hostscripts(); 
        # returns an array of NmapParser::Host::Script objects
   
  my $service = $host->tcp_service(<PORT>);
    # NmapParser::Host::Service object
    
  my @PortScripts = $host_portscripts(<PORT>);   
    # returns an array of NmapParser::Host::Script objects
    
  my @OS = $host->os_sig();
    # returns an array of NmapParser::Host::OS objects 
 

For a full listing of methods see the documentation corresponding to each object.

DESCRIPTION

A perl module to JUST parse nmap XML data output.

It is a fork of the Nmap-Parser minus the ability to do any scannings. It maintains all the calls of the other module along with adding some additional calls. It also adds a new method for accessing both host script and port script results. It also removes the Nmap::Parser::Session object in favor of making those default methods fpr the parsed object.

current code can be found at http://github.com/littleurl/XML-NmapParser/

OVERVIEW

This module has an internal framework to make it easy to retrieve the desired information of a scan. Every nmap scan is based on two main sections of informations: the scan session, and the scan information of all hosts. The session information will be stored as a Nmap::Parser::Session object. This object will contain its own methods to obtain the desired information. The same is true for any hosts that were scanned using the Nmap::Parser::Host object. There are two sub objects under Nmap::Parser::Host. One is the Nmap::Parser::Host::Service object which will be used to obtain information of a given service running on a given port. The second is the Nmap::Parser::Host::OS object which contains the operating system signature information (OS guessed names, classes, osfamily..etc).

  Nmap::Parser                         -- Core parser
     |  
     +--Nmap::Parser::Host             -- General host information
     |  |
     |  |-Nmap::Parser::Host::Service  -- Port service information
     |  |
     |  |-Nmap::Parser::Host::OS       -- Operating system signature information
     |  |
     |  |-Nmap::Parser::Host::Service  -- Port service information
     |  |
     |  |-Nmap::Parser::Host::Script   -- any NSE script data for host or port based scripts
     |  |
     |  |-Nmap::Parser::Host::TraceHop -- any traceroute data for hosts scanned 

METHODS

NmapParser

The main idea behind the core module is, you will first parse the information and then extract data. Therefore, all parse*() methods should be executed before any get_*() methods.

parse($xml_file)

Parses the nmap scan data in $xml_file. This file can be generated from an nmap scan by using the '-oX filename.xml' option with nmap. If you get an error or your program dies due to parsing, please check that the xml information is compliant. The file is closed no matter how parsefile() returns.

get_host($ip_addr)

Obtains the Nmap::Parser::Host object for the given $ip_addr.

get_ips()
get_ips($status,$type)

Returns the list of IP addresses that were scanned in this nmap session. They are sorted using addr_sort. If the optional status is given, it will only return those IP addresses that match that status. The status can be any of the following: (up|down|unknown|skipped). And the type can be either (ipv4|ipv6).

live()

Returns the number of hosts identified as live by the scan

down()

Returns the number of hosts identified as down by the scan

scanned()

Returns the number of hosts scanned

get_address()
get_host()
finish_time()

Returns the numeric time that the nmap scan finished.

nmap_version()

Returns the version of nmap used for the scan.

numservices()
numservices($type)

If numservices is called without argument, it returns the total number of services that were scanned for all types. If $type is given, it returns the number of services for that given scan type. See scan_types() for more info.

scan_args()

Returns a string which contains the nmap executed command line used to run the scan.

scan_type_proto($type)

Returns the protocol type of the given scan type (provided by $type). See scan_types() for more info.

scan_types()

Returns the list of scan types that were performed. It can be any of the following: (syn|ack|bounce|connect|null|xmas|window|maimon|fin|udp|ipproto).

start_str()

Returns the human readable format of the start time.

start_time()

Returns the numeric form of the time the nmap scan started.

time_str()

Returns the human readable format of the finish time.

xml_version()

Returns the version of nmap xml file.

Nmap::Parser::Host

This object represents the information collected from a scanned host.

status()

Returns the state of the host. It is usually one of these (up|down|unknown|skipped).

addr()

Returns the main IP address of the host. This is usually the IPv4 address. If there is no IPv4 address, the IPv6 is returned (hopefully there is one).

addrtype()

Returns the address type of the address given by addr() .

all_hostnames()

Returns a list of all hostnames found for the given host.

extraports_count()

Returns the number of extraports found.

extraports_state()

Returns the state of all the extraports found.

hostname()
hostname($index)

As a basic call, hostname() returns the first hostname obtained for the given host. If there exists more than one hostname, you can provide a number, which is used as the location in the array. The index starts at 0;

 #in the case that there are only 2 hostnames
 hostname() eq hostname(0);
 hostname(1); #second hostname found
 hostname(400) eq hostname(1) #nothing at 400; return the name at the last index
 
ipv4_addr()

Explicitly return the IPv4 address.

ipv6_addr()

Explicitly return the IPv6 address.

mac_addr()

Explicitly return the MAC address.

mac_vendor()

Return the vendor information of the MAC.

distance()

Return the distance (in hops) of the target machine from the machine that performed the scan.

trace_error()

Returns a true value (usually a meaningful error message) if the traceroute was performed but could not reach the destination. In this case all_trace_hops() contains only the part of the path that could be determined.

all_trace_hops()

Returns an array of Nmap::Parser::Host::TraceHop objects representing the path to the target host. This array may be empty if Nmap did not perform the traceroute for some reason (same network, for example).

Some hops may be missing if Nmap could not figure out information about them. In this case there is a gap between the ttl() values of consecutive returned hops. See also trace_error().

trace_proto()

Returns the name of the protocol used to perform the traceroute.

trace_port()

Returns the port used to perform the traceroute.

os_sig()

Returns an Nmap::Parser::Host::OS object that can be used to obtain all the Operating System signature (fingerprint) information. See Nmap::Parser::Host::OS for more details.

 $os = $host->os_sig;
 $os->name;
 $os->osfamily;
tcpsequence_class()
tcpsequence_index()
tcpsequence_values()

Returns the class, index and values information respectively of the tcp sequence.

ipidsequence_class()
ipidsequence_values()

Returns the class and values information respectively of the ipid sequence.

tcptssequence_class()
tcptssequence_values()

Returns the class and values information respectively of the tcpts sequence.

uptime_lastboot()

Returns the human readable format of the timestamp of when the host had last rebooted.

uptime_seconds()

Returns the number of seconds that have passed since the host's last boot from when the scan was performed.

hostscripts()
hostscripts($name)

A basic call to hostscripts() returns a list of the names of the host scripts run. If $name is given, it returns the text output of the a reference to a hash with "output" and "content" keys for the script with that name, or undef if that script was not run. The value of the "output" key is the text output of the script. The value of the "content" key is a data structure based on the XML output of the NSE script.

tcp_ports()
udp_ports()

Returns the sorted list of TCP|UDP ports respectively that were scanned on this host. Optionally a string argument can be given to these functions to filter the list.

 $host->tcp_ports('open') #returns all only 'open' ports (even 'open|filtered')
 $host->udp_ports('open|filtered'); #matches exactly ports with 'open|filtered'
 

Note that if a port state is set to 'open|filtered' (or any combination), it will be counted as an 'open' port as well as a 'filtered' one.

tcp_port_count()
udp_port_count()

Returns the total of TCP|UDP ports scanned respectively.

tcp_del_ports($portid, [$portid, ...])
udp_del_ports($portid, [ $portid, ...])

Deletes the current $portid from the list of ports for given protocol.

tcp_port_state($portid)
udp_port_state($portid)

Returns the state of the given port, provided by the port number in $portid.

tcp_open_ports()
udp_open_ports()

Returns the list of open TCP|UDP ports respectively. Note that if a port state is for example, 'open|filtered', it will appear on this list as well.

tcp_filtered_ports()
udp_filtered_ports()

Returns the list of filtered TCP|UDP ports respectively. Note that if a port state is for example, 'open|filtered', it will appear on this list as well.

tcp_closed_ports()
udp_closed_ports()

Returns the list of closed TCP|UDP ports respectively. Note that if a port state is for example, 'closed|filtered', it will appear on this list as well.

tcp_service($portid)
udp_service($portid)

Returns the Nmap::Parser::Host::Service object of a given service running on port, provided by $portid. See Nmap::Parser::Host::Service for more info.

 $svc = $host->tcp_service(80);
 $svc->name;
 $svc->proto;
 

Nmap::Parser::Host::Service

This object represents the service running on a given port in a given host. This object is obtained by using the tcp_service($portid) or udp_service($portid) method from the Nmap::Parser::Host object. If a portid is given that does not exist on the given host, these functions will still return an object (so your script doesn't die). Its good to use tcp_ports() or udp_ports() to see what ports were collected.

confidence()

Returns the confidence level in service detection.

extrainfo()

Returns any additional information nmap knows about the service.

method()

Returns the detection method.

name()

Returns the service name.

owner()

Returns the process owner of the given service. (If available)

port()

Returns the port number where the service is running on.

product()

Returns the product information of the service.

proto()

Returns the protocol type of the service.

rpcnum()

Returns the RPC number.

tunnel()

Returns the tunnel value. (If available)

fingerprint()

Returns the service fingerprint. (If available)

version()

Returns the version of the given product of the running service.

scripts()
scripts($name)

A basic call to scripts() returns a list of the names of the NSE scripts run for this port. If $name is given, it returns a reference to a hash with "output" and "content" keys for the script with that name, or undef if that script was not run. The value of the "output" key is the text output of the script. The value of the "content" key is a data structure based on the XML output of the NSE script.

Nmap::Parser::Host::OS

This object represents the Operating System signature (fingerprint) information of the given host. This object is obtained from an Nmap::Parser::Host object using the os_sig() method. One important thing to note is that the order of OS names and classes are sorted by DECREASING ACCURACY. This is more important than alphabetical ordering. Therefore, a basic call to any of these functions will return the record with the highest accuracy. (Which is probably the one you want anyways).

all_names()

Returns the list of all the guessed OS names for the given host.

class_accuracy()
class_accuracy($index)

A basic call to class_accuracy() returns the osclass accuracy of the first record. If $index is given, it returns the osclass accuracy for the given record. The index starts at 0.

class_count()

Returns the total number of OS class records obtained from the nmap scan.

name()
name($index)
names()
names($index)

A basic call to name() returns the OS name of the first record which is the name with the highest accuracy. If $index is given, it returns the name for the given record. The index starts at 0.

name_accuracy()
name_accuracy($index)

A basic call to name_accuracy() returns the OS name accuracy of the first record. If $index is given, it returns the name for the given record. The index starts at 0.

name_count()

Returns the total number of OS names (records) for the given host.

osfamily()
osfamily($index)

A basic call to osfamily() returns the OS family information of the first record. If $index is given, it returns the OS family information for the given record. The index starts at 0.

osgen()
osgen($index)

A basic call to osgen() returns the OS generation information of the first record. If $index is given, it returns the OS generation information for the given record. The index starts at 0.

portused_closed()

Returns the closed port number used to help identify the OS signatures. This might not be available for all hosts.

portused_open()

Returns the open port number used to help identify the OS signatures. This might not be available for all hosts.

os_fingerprint()

Returns the OS fingerprint used to help identify the OS signatures. This might not be available for all hosts.

type()
type($index)

A basic call to type() returns the OS type information of the first record. If $index is given, it returns the OS type information for the given record. The index starts at 0.

vendor()
vendor($index)

A basic call to vendor() returns the OS vendor information of the first record. If $index is given, it returns the OS vendor information for the given record. The index starts at 0.

Nmap::Parser::Host::TraceHop

This object represents a router on the IP path towards the destination or the destination itself. This is similar to what the traceroute command outputs.

Nmap::Parser::Host::TraceHop objects are obtained through the all_trace_hops() and trace_hop() Nmap::Parser::Host methods.

ttl()

The Time To Live is the network distance of this hop.

rtt()

The Round Trip Time is roughly equivalent to the "ping" time towards this hop. It is not always available (in which case it will be undef).

ipaddr()

The known IP address of this hop.

host()

The host name of this hop, if known.

EXAMPLES

 use Nmap::Parser;

 my $np = new Nmap::Parser;
 my @hosts = @ARGV; #get hosts from cmd line

SUPPORT

Discussion Forum

If you have questions about how to use the module please contact the author below.

Bug Reports, Enhancements, Merge Requests

Please submit any bugs or feature requests to: https://github.com/littleurl/XML-NmapParser/issues

SEE ALSO

nmap, XML::LibXML

The nmap security scanner homepage can be found at: http://www.insecure.org/nmap/.

AUTHORS

Paul M Johnson <pjohnson21211@gmail.com> but credit to the original author of Nmap-Parser is Anthony Persaud L <http://modernistik.com>

COPYRIGHT

1;