Python3-nmap converts Nmap commands into python3 methods making it very easy to use nmap in any of your python pentesting projects
Project description
python3-nmap
A python 3 library which helps in using nmap port scanner. The way this tools works is by defining each nmap command into a python function making it very easy to use sophisticated nmap commands in other python scripts. For example in nmap if you want to scan for common ports you would to something like this
$ nmap nmmapper.com --top-ports 10
But in this python3 script you would do something like this
import nmap3
nmap = nmap3.Nmap()
results = nmap.scan_top_ports("nmmapper.com")
# And you would get your results in json
Again in nmap if you want to use the famous dns-brute script you would do something like this
$ nmap nmmapper.com --script dns-brute.nse
But in this python3 script again it's very easy you just do something like this
import nmap3
nmap = nmap3.Nmap()
results = nmap.nmap_dns_brute_script("nmmapper.com")
# And you would get your results in json
[
{
"address": "mail.nmmapper.com",
"hostname": "68.65.122.10"
},
{
"address": "www.nmmapper.com",
"hostname": "5.189.129.43"
}
]
Why this script?
Why the design of this tool? At Nmmapper.com we ran an online port scanner and we wanted a simple script that could help us extend our online port scanner with more options. So we decided to develop a custom python3 script which holds all the common nmap command we want to host online.
How to
The scripts assumes you have nmap already installed
$ pip3 install -r requirements.txt
# Install nmap online
$ apt-get install nmap
# That's all is needed to get started
In nmap some commands require root privileges for example the command to identify OS requires root privileges;
$ nmap -O nmmapper.com
TCP/IP fingerprinting (for OS scan) requires root privileges.
QUITTING!
# Until you sudo
$ sudo nmap -O nmmapper.com
The same applies to the script to be able to run the os identifier you have to be a super user.
How to use the script to identify OS
import nmap3
nmap = nmap3.Nmap()
os_results = nmap.nmap_os_detection("192.168.178.2") # MOST BE ROOT
[
{
"accuracy": "100",
"cpe": "cpe:/o:linux:linux_kernel:2.6",
"line": "45249",
"name": "Linux 2.6.14 - 2.6.34",
"osclass": {
"accuracy": "100",
"osfamily": "Linux",
"osgen": "2.6.X",
"type": "general purpose",
"vendor": "Linux"
}
},
{
"accuracy": "100",
"cpe": "cpe:/o:linux:linux_kernel:2.6.17",
"line": "45775",
"name": "Linux 2.6.17",
"osclass": {
"accuracy": "100",
"osfamily": "Linux",
"osgen": "2.6.X",
"type": "general purpose",
"vendor": "Linux"
}
},
{
"accuracy": "100",
"cpe": "cpe:/o:linux:linux_kernel:2.6.17",
"line": "45811",
"name": "Linux 2.6.17 (Mandriva)",
"osclass": {
"accuracy": "100",
"osfamily": "Linux",
"osgen": "2.6.X",
"type": "general purpose",
"vendor": "Linux"
}
},
{
"accuracy": "100",
"cpe": "cpe:/o:linux:linux_kernel:3.13",
"line": "60884",
"name": "Linux 3.13",
"osclass": {
"accuracy": "100",
"osfamily": "Linux",
"osgen": "3.X",
"type": "general purpose",
"vendor": "Linux"
}
}
]
Identifying service version
In nmap if you want to identify versions you would run this kind of command
$ nmap 192.168.178.1 -sV
In this python script you would do something like this
import nmap3
nmap = nmap3.Nmap()
version_result = nmap.nmap_version_detection("nmmapper.com")
[
{
"cpe": [
{
"cpe": "cpe:/o:linux:linux_kernel"
}
],
"port": "80",
"protocol": "tcp",
"service": {
"conf": "10",
"extrainfo": "Ubuntu",
"method": "probed",
"name": "http",
"ostype": "Linux",
"product": "nginx",
"version": "1.14.0"
}
},
{
"cpe": [
{
"cpe": "cpe:/o:linux:linux_kernel"
}
],
"port": "443",
"protocol": "tcp",
"service": {
"conf": "10",
"extrainfo": "Ubuntu",
"method": "probed",
"name": "http",
"ostype": "Linux",
"product": "nginx",
"tunnel": "ssl",
"version": "1.14.0"
}
},
{
"cpe": [
{
"cpe": "cpe:/o:linux:linux_kernel"
}
],
"port": "2000",
"protocol": "tcp",
"service": {
"conf": "10",
"extrainfo": "Ubuntu Linux; protocol 2.0",
"method": "probed",
"name": "ssh",
"ostype": "Linux",
"product": "OpenSSH",
"version": "7.6p1 Ubuntu 4ubuntu0.3"
}
}
]
Nmap commands available
The following nmaps commands have been added to the following scripts
- Nmap top port scan
- Nmap Dns-brute-script( to get subdomains )
- Nmap list scan
- Nmap Os detection
- Nmap subnet scan
- Nmap version detection
## Nmap Scanning Techniques
-
nmap_fin_scan
import nmap3 nmap = nmap3.NmapScanTechniques() result = nmap.nmap_fin_scan("192.168.178.1")
-
nmap_idle_scan
import nmap3
nmap = nmap3.NmapScanTechniques()
result = nmap.nmap_idle_scan("192.168.178.1")
- nmap_ping_scan
import nmap3
nmap = nmap3.NmapScanTechniques()
result = nmap.nmap_ping_scan("192.168.178.1")
- nmap_syn_scan
import nmap3
nmap = nmap3.NmapScanTechniques()
result = nmap.nmap_syn_scan("192.168.178.1")
- nmap_tcp_scan
import nmap3
nmap = nmap3.NmapScanTechniques()
result = nmap.nmap_tcp_scan("192.168.178.1")
# Documentation
Supporting the nmap host discovery
Added Nmap Host discovery techniques
- Only port scan (-Pn)
- Only host discover (-sn)
- Arp discovery on a local network (-PR)
- Disable DNS resolution (-n)
NmapHostDiscovery
def nmap_portscan_only(self, host, args=None)
def nmap_no_portscan(self, host, args=None):
def nmap_arp_discovery(self, host, args=None):
def nmap_disable_dns(self, host, args=None):
Pull requests and Issues
Feel free to open up a pull request or open an issue so we can fix it.
Cross-Selling
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python3_nmap-1.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4c1dffde0898611bd25b8b5135d3ac217921297ac467a83590fd71bbe2c4555 |
|
MD5 | 71639db037013c0fad92658f6bb577da |
|
BLAKE2b-256 | d5bce86783e96ef087295785a408e0d2dcc4844181036767bbc33d9f10771dde |