|PyPI latest| |PyPI Version| |PyPI License|
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.
It can even be used asynchronously. Results are returned one host at a time to a callback function defined by the user.
python-nmap-0.4.1.tar.gz - 2015-08-21
md5sum is b466e4b2ef30a0b9c0cb80aac215fb79
Warning : this version is intended to work with Python 3.x. For Python 2.x, please use python-nmap-0.1.4.tar.gz
.. code-block:: bash
$ hg clone https://bitbucket.org/xael/python-nmap
From the shell, uncompress python-nmap-0.4.1.tar.gz and then run make :
.. code-block:: bash
$ tar xvzf python-nmap-0.4.1.tar.gz
$ cd python-nmap-0.4.1
$ python setup.py install
or using Pip
.. code-block:: bash
$ pip install python-nmap
Now you may invoke nmap from python
.. code-block:: bash
$ python
Python 2.6.4 (r264:75706, Dec 7 2009, 18:45:15)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>> import nmap
.. code-block:: python
>>> import nmap
>>> nm = nmap.PortScanner()
>>> nm.scan('127.0.0.1', '22-443')
>>> nm.command_line()
'nmap -oX - -p 22-443 -sV 127.0.0.1'
>>> nm.scaninfo()
{'tcp': {'services': '22-443', 'method': 'connect'}}
>>> nm.all_hosts()
['127.0.0.1']
>>> nm['127.0.0.1'].hostname()
'localhost'
>>> nm['127.0.0.1'].state()
'up'
>>> nm['127.0.0.1'].all_protocols()
['tcp']
>>> nm['127.0.0.1']['tcp'].keys()
[80, 25, 443, 22, 111]
>>> nm['127.0.0.1'].has_tcp(22)
True
>>> nm['127.0.0.1'].has_tcp(23)
False
>>> nm['127.0.0.1']['tcp'][22]
{'state': 'open', 'reason': 'syn-ack', 'name': 'ssh'}
>>> nm['127.0.0.1'].tcp(22)
{'state': 'open', 'reason': 'syn-ack', 'name': 'ssh'}
>>> nm['127.0.0.1']['tcp'][22]['state']
'open'
>>> 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']))
----------------------------------------------------
Host : 127.0.0.1 (localhost)
State : up
----------
Protocol : tcp
port : 22 state : open
port : 25 state : open
port : 80 state : open
port : 111 state : open
port : 443 state : open
.. code-block:: python
>>> print(nm.csv())
host;protocol;port;name;state;product;extrainfo;reason;version;conf
127.0.0.1;tcp;22;ssh;open;OpenSSH;protocol 2.0;syn-ack;5.9p1 Debian 5ubuntu1;10
127.0.0.1;tcp;25;smtp;open;Exim smtpd;;syn-ack;4.76;10
127.0.0.1;tcp;53;domain;open;dnsmasq;;syn-ack;2.59;10
127.0.0.1;tcp;80;http;open;Apache httpd;(Ubuntu);syn-ack;2.2.22;10
127.0.0.1;tcp;111;rpcbind;open;;;syn-ack;;10
127.0.0.1;tcp;139;netbios-ssn;open;Samba smbd;workgroup: WORKGROUP;syn-ack;3.X;10
127.0.0.1;tcp;443;;open;;;syn-ack;;
.. code-block:: python
>>> 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}'.host)
192.168.1.0:down
192.168.1.1:up
192.168.1.10:down
192.168.1.100:down
192.168.1.101:down
192.168.1.102:down
192.168.1.103:down
192.168.1.104:down
192.168.1.105:down
[...]
.. code-block:: python
>>> 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
>>>
192.168.1.1 {'nmap': {'scanstats': {'uphosts': '1', 'timestr': 'Mon Jun 7 11:31:11 2010', 'downhosts': '0', 'totalhosts': '1', 'elapsed': '0.43'}, 'scaninfo': {}, 'command_line': 'nmap -oX - -sP 192.168.1.1'}, 'scan': {'192.168.1.1': {'status': {'state': 'up', 'reason': 'arp-response'}, 'hostname': 'neufbox'}}}
------------------
192.168.1.2 {'nmap': {'scanstats': {'uphosts': '0', 'timestr': 'Mon Jun 7 11:31:11 2010', 'downhosts': '1', 'totalhosts': '1', 'elapsed': '0.29'}, 'scaninfo': {}, 'command_line': 'nmap -oX - -sP 192.168.1.2'}, 'scan': {'192.168.1.2': {'status': {'state': 'down', 'reason': 'no-response'}, 'hostname': ''}}}
------------------
192.168.1.3 {'nmap': {'scanstats': {'uphosts': '0', 'timestr': 'Mon Jun 7 11:31:11 2010', 'downhosts': '1', 'totalhosts': '1', 'elapsed': '0.29'}, 'scaninfo': {}, 'command_line': 'nmap -oX - -sP 192.168.1.3'}, 'scan': {'192.168.1.3': {'status': {'state': 'down', 'reason': 'no-response'}, 'hostname': ''}}}
>>> nm = nmap.PortScannerYield() >>> for progressive_result in nm.scan('127.0.0.1/24', '22-25'): >>> print(progressive_result)
See also example.py in archive file.
.. code-block:: python
>>> nm = nmap.PortScanner()
>>> nm.scan('127.0.0.1', '22-40043', timeout=10)
PortScannerTimeout: 'Timeout from nmap process'
.. code-block:: text
Steve 'Ashcrow' Milner
Brian Bustin
old.schepperhand
Johan Lundberg
Thomas D. maaaaz
Robert Bost
David Peltier
Ed Jones
http://xael.org/norman/python/python-nmap/
.. |PyPI Version| image:: https://img.shields.io/pypi/pyversions/python-nmap.svg?maxAge=2592000 :target: https://pypi.python.org/pypi/python-nmap .. |PyPI License| image:: https://img.shields.io/pypi/l/python-nmap.svg?maxAge=2592000 :target: https://pypi.python.org/pypi/python-nmap .. |PyPI latest| image:: https://img.shields.io/pypi/v/python-nmap.svg?maxAge=360 :target: https://pypi.python.org/pypi/python-nmap
Closes bugs :
Change in data structure :
Data structure for a host looks like :
.. code-block:: python
{'addresses': {'ipv4': '127.0.0.1'}, 'hostnames': [], 'osmatch': [{'accuracy': '98', 'line': '36241', 'name': 'Juniper SA4000 SSL VPN gateway (IVE OS 7.0)', 'osclass': [{'accuracy': '98', 'cpe': ['cpe:/h:juniper:sa4000', 'cpe:/o:juniper:ive_os:7'], 'osfamily': 'IVE OS', 'osgen': '7.X', 'type': 'firewall', 'vendor': 'Juniper'}]}, {'accuracy': '91', 'line': '17374', 'name': 'Citrix Access Gateway VPN gateway', 'osclass': [{'accuracy': '91', 'cpe': [], 'osfamily': 'embedded', 'osgen': None, 'type': 'proxy server', 'vendor': 'Citrix'}]}], 'portused': [{'portid': '443', 'proto': 'tcp', 'state': 'open'}, {'portid': '113', 'proto': 'tcp', 'state': 'closed'}], 'status': {'reason': 'syn-ack', 'state': 'up'}, 'tcp': {113: {'conf': '3', 'cpe': '', 'extrainfo': '', 'name': 'ident', 'product': '', 'reason': 'conn-refused', 'state': 'closed', 'version': ''}, 443: {'conf': '10', 'cpe': '', 'extrainfo': '', 'name': 'http', 'product': 'Juniper SA2000 or SA4000 VPN gateway http config', 'reason': 'syn-ack', 'state': 'open', 'version': ''}}, 'vendor': {}}
nm = nmap.PortScannerYield() for i in nm.scan('127.0.0.1/24', '22-25'): print(i)
.. code-block:: python
r=nm.scan(hosts='127.0.0.1', ports='139', arguments="-sC ") print(nm._scan_result['scan']['127.0.0.1']['hostscript'])
.. code-block:: python
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'}
FAQs
This is a python class to use nmap and access scan results from python3
We found that python-nmap demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.