Skip to main content

This is a python class to use nmap and access scan results from python3

Project description

python-nmap is a python library which helps in using nmap port scanner. It allows to easilly manipulate nmap scan results and will be a perfect tool for systems administrators who want to automatize scanning task and reports. It also supports nmap script outputs.

Typical usage looks like:

 #!/usr/bin/env python
 import nmap                         # import nmap.py module
 nm = nmap.PortScanner()         # instantiate nmap.PortScanner object
 nm.scan('127.0.0.1', '22-443')      # scan host 127.0.0.1, ports from 22 to 443
 nm.command_line()                   # get command line used for the scan : nmap -oX - -p 22-443 127.0.0.1
 nm.scaninfo()                       # get nmap scan informations {'tcp': {'services': '22-443', 'method': 'connect'}}
 nm.all_hosts()                      # get all hosts that were scanned
 nm['127.0.0.1'].hostname()          # get hostname for host 127.0.0.1
 nm['127.0.0.1'].state()             # get state of host 127.0.0.1 (up|down|unknown|skipped)
 nm['127.0.0.1'].all_protocols()     # get all scanned protocols ['tcp', 'udp'] in (ip|tcp|udp|sctp)
 nm['127.0.0.1']['tcp'].keys()       # get all ports for tcp protocol
 nm['127.0.0.1'].all_tcp()           # get all ports for tcp protocol (sorted version)
 nm['127.0.0.1'].all_udp()           # get all ports for udp protocol (sorted version)
 nm['127.0.0.1'].all_ip()            # get all ports for ip protocol (sorted version)
 nm['127.0.0.1'].all_sctp()          # get all ports for sctp protocol (sorted version)
 nm['127.0.0.1'].has_tcp(22)         # is there any information for port 22/tcp on host 127.0.0.1
 nm['127.0.0.1']['tcp'][22]          # get infos about port 22 in tcp on host 127.0.0.1
 nm['127.0.0.1'].tcp(22)             # get infos about port 22 in tcp on host 127.0.0.1
 nm['127.0.0.1']['tcp'][22]['state'] # get state of port 22/tcp on host 127.0.0.1 (open


 # a more usefull example :
 for host in nm.all_hosts():
     print('----------------------------------------------------')
     print('Host : %s (%s)' % (host, nm[host].hostname()))
     print('State : %s' % nm[host].state())

     for proto in nm[host].all_protocols():
         print('----------')
         print('Protocol : %s' % proto)

         lport = nm[host][proto].keys()
         lport.sort()
         for port in lport:
             print('port : %s\tstate : %s' % (port, nm[host][proto][port]['state']))

 print('----------------------------------------------------')
 # print result as CSV
 print(nm.csv())


 print('----------------------------------------------------')
 # If you want to do a pingsweep on network 192.168.1.0/24:
 nm.scan(hosts='192.168.1.0/24', arguments='-n -sP -PE -PA21,23,80,3389')
 hosts_list = [(x, nm[x]['status']['state']) for x in nm.all_hosts()]
 for host, status in hosts_list:
     print('{0}:{1}'.format(host, status))


print '----------------------------------------------------'
# Asynchronous usage of PortScannerAsync
nma = nmap.PortScannerAsync()
def callback_result(host, scan_result):
    print '------------------'
    print host, scan_result
nma.scan(hosts='192.168.1.0/30', arguments='-sP', callback=callback_result)
while nma.still_scanning():
    print("Waiting ...")
    nma.wait(2)   # you can do whatever you want but I choose to wait after the end of the scan

Changelog

2015/08/01 (v0.4.0)
  • Closes bugs : - #2: use close_fds in subprocess.Popen - #3: memory leak parsing xml using xml.dom.minidom
  • Corrects a bug in parsing osclass
  • Add nosetests for case testing
  • Removed test case in docstring
2015/05/08 (v0.3.7)
  • adding sudo parameter for scanning (idea from scupython)
2015/05/08 (v0.3.6)
  • correcting issue 7 : Issues under windows
2015/05/08 (v0.3.5)
  • correcting a bug in all_protocols()
  • correcting issue 8 : PortScannerAsync Doesn’t work in windows…
2014/06/22 (v0.3.4)
  • adding PortScannerYield class with generator >>> nm = nmap.PortScannerYield() >>> for i in nm.scan(‘127.0.0.1/24’, ‘22-25’): >>> print(i)
2014/03/13 (v0.3.3)
  • moving file example.py
  • adding function convert_nmap_output_to_encoding
  • adding vendor for mac address
2013/09/23 (v0.3.2)
  • adding acces to CPE values under [host][proto][port][‘cpe’] key
2013/07/27 (v0.3.1)
  • Bug correction on callback’s assert in PortScannerAsync.scan proposed by Robert Bost
2013/06/23 (v0.3.0)
  • added support for NMAP SCRIPT ENGINE >>> r=nm.scan(hosts=‘127.0.0.1’, ports=‘139’, arguments=”-sC “) >>> print(nm._scan_result[‘scan’][‘127.0.0.1’][‘hostscript’])
2013/02/24 (v0.2.7)
  • added an address block in host scan result which contains ipv4, mac and other addresses : nm = nmap.PortScanner() r = nm.scan(arguments=’-sS -p T:22’, hosts=‘192.168.1.3’) print r[‘scan’][‘192.168.1.3’][‘addresses’] {u’mac’: u‘02:50:43:F4:02:B1’, u’ipv4’: u‘192.168.1.3’}
  • Adding a CSV scan output as a string.
  • Changes examples.py to make it python3 compliant
2012/12/13 (v0.2.6)
  • patch from lundberg.johan
  • bug correction : when nmap doesn’t work displays stderr instead of stdout
2012/11/23 (v0.2.5)
  • corrected : Issue 2: “map.nmap.PortScannerError: ‘nmap program was not found in path’” on CentOS
  • corrected : Issue 3: nmap.scan() short-circuits prematurely
2011/11/09 (v0.2.4)
2011/11/04
  • bug in example.py : if no tcp port was open between 22-443
2010/12/17 (v0.2.3)
  • adding __get_last_online_version to check if current version is the last published
2010/12/17 (v0.2.2)
  • bug in handling nmap_error output (returned value was bin, string was expected)
  • removed test strings form __init__.py file.
2010/12/15 (v0.2.1)
  • corrected bug in __init__.py about scope problem
  • try to find nmap executable in known directories
  • raise AssertionError when trying to call command_line, scaninfo, scanstats, has_host before scanning
2010/12/14 (v0.2.0)
  • Make python-nmap works with Python 3.x
  • Contribution from Brian Bustin <brian at bustin.us>
2010/06/07 (v0.1.4)
  • Patches from Steve ‘Ashcrow’ Milner <steve at gnulinux.net>
  • remove shebang from __init__.py as it is not a runnable script
  • allow use with ALPHA and BETA nmap releases
  • .has_key() is deprecated, replaced instances with in
  • move to using the print function for python2 and 3 usage
2010/06/04
  • adding PortScanner.listscan
  • PortScanner.scan now returns scan_result
  • adding class PortScannerAsync (idea from Steve ‘Ashcrow’ Milner <steve at gnulinux.net>)
2010/06/03
  • Import on google code svn checkout https://python-nmap.googlecode.com/svn/trunk/ python-nmap –username XXXXX
  • added PortScanner.scanstats method
  • updated example.py and documentation for pingsweep
  • updated Makefile for generating documentation
2010/03/09
  • Modified packaging. v0.1.1 [norman]
2010/03/08
  • Initial release. v0.1.0 [norman]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
python-nmap-0.4.0.tar.gz (45.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page