-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnmap.py
1239 lines (1002 loc) · 41.2 KB
/
nmap.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
nmap.py - version and date, see below
Source code : https://bitbucket.org/xael/python-nmap
Author :
* Alexandre Norman - norman at xael.org
Contributors:
* Steve 'Ashcrow' Milner - steve at gnulinux.net
* Brian Bustin - brian at bustin.us
* old.schepperhand
* Johan Lundberg
* Thomas D. maaaaz
* Robert Bost
* David Peltier
* Ed Jones
Licence: GPL v3 or any later version for python-nmap
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
**************
IMPORTANT NOTE
**************
The Nmap Security Scanner used by python-nmap is distributed
under it's own licence that you can find at https://svn.nmap.org/nmap/COPYING
Any redistribution of python-nmap along with the Nmap Security Scanner
must conform to the Nmap Security Scanner licence
"""
import csv
import io
import os
import re
import shlex
import subprocess
import sys
from multiprocessing import Process
from xml.etree import ElementTree as ET
__author__ = "Alexandre Norman (norman@xael.org)"
__version__ = "0.7.1"
__last_modification__ = "2021.10.26"
############################################################################
class PortScanner(object):
"""
PortScanner class allows to use nmap from python
"""
def __init__(
self,
nmap_search_path=(
"nmap",
"/usr/bin/nmap",
"/usr/local/bin/nmap",
"/sw/bin/nmap",
"/opt/local/bin/nmap",
),
):
"""
Initialize PortScanner module
* detects nmap on the system and nmap version
* may raise PortScannerError exception if nmap is not found in the path
:param nmap_search_path: tupple of string where to search for nmap executable.
Change this if you want to use a specific version of nmap.
:returns: nothing
"""
self._nmap_path = "" # nmap path
self._scan_result = {}
self._nmap_version_number = 0 # nmap version number
self._nmap_subversion_number = 0 # nmap subversion number
self._nmap_last_output = "" # last full ascii nmap output
is_nmap_found = False # true if we have found nmap
self.__process = None
# regex used to detect nmap (http or https)
regex = re.compile(r"Nmap version [0-9]*\.[0-9]*[^ ]* \( http(|s)://.* \)")
# launch 'nmap -V', we wait after
# > 'Nmap version 5.0 ( http://nmap.org )'
# This is for Mac OSX. When idle3 is launched from the finder, PATH is not set so nmap was not found
for nmap_path in nmap_search_path:
try:
if (
sys.platform.startswith("freebsd")
or sys.platform.startswith("linux")
or sys.platform.startswith("darwin")
):
p = subprocess.Popen(
[nmap_path, "-V"],
bufsize=10000,
stdout=subprocess.PIPE,
close_fds=True,
)
else:
p = subprocess.Popen(
[nmap_path, "-V"], bufsize=10000, stdout=subprocess.PIPE
)
except OSError:
pass
else:
self._nmap_path = nmap_path # save path
break
else:
raise PortScannerError(
f"nmap program was not found in path. PATH is : {os.getenv('PATH')}"
)
self._nmap_last_output = bytes.decode(p.communicate()[0]) # sav stdout
for line in self._nmap_last_output.split(os.linesep):
if regex.match(line) is not None:
is_nmap_found = True
# Search for version number
regex_version = re.compile("[0-9]+")
regex_subversion = re.compile(r"\.[0-9]+")
rv = regex_version.search(line)
rsv = regex_subversion.search(line)
if rv is not None and rsv is not None:
# extract version/subversion
self._nmap_version_number = int(line[rv.start() : rv.end()])
self._nmap_subversion_number = int(
line[rsv.start() + 1 : rsv.end()]
)
break
if not is_nmap_found:
raise PortScannerError("nmap program was not found in path")
return
def get_nmap_last_output(self):
"""
Returns the last text output of nmap in raw text
this may be used for debugging purpose
:returns: string containing the last text output of nmap in raw text
"""
return self._nmap_last_output
def nmap_version(self):
"""
returns nmap version if detected (int version, int subversion)
or (0, 0) if unknown
:returns: (nmap_version_number, nmap_subversion_number)
"""
return (self._nmap_version_number, self._nmap_subversion_number)
def listscan(self, hosts="127.0.0.1"):
"""
do not scan but interpret target hosts and return a list a hosts
"""
assert (
type(hosts) is str
), f"Wrong type for [hosts], should be a string [was {type(hosts)}]"
output = self.scan(hosts, arguments="-sL")
# Test if host was IPV6
if (
"scaninfo" in output["nmap"]
and "error" in output["nmap"]["scaninfo"]
and len(output["nmap"]["scaninfo"]["error"]) > 0
and "looks like an IPv6 target specification"
in output["nmap"]["scaninfo"]["error"][0]
): # noqa
self.scan(hosts, arguments="-sL -6")
return self.all_hosts()
def scan( # NOQA: CFQ001, C901
self, hosts="127.0.0.1", ports=None, arguments="-sV", sudo=False, timeout=0
):
"""
Scan given hosts
May raise PortScannerError exception if nmap output was not xml
Test existance of the following key to know
if something went wrong : ['nmap']['scaninfo']['error']
If not present, everything was ok.
:param hosts: string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20'
:param ports: string for ports as nmap use it '22,53,110,143-4564'
:param arguments: string of arguments for nmap '-sU -sX -sC'
:param sudo: launch nmap with sudo if True
:param timeout: int, if > zero, will terminate scan after seconds, otherwise will wait indefintely
:returns: scan_result as dictionnary
"""
if sys.version_info[0] == 2:
assert type(hosts) in (
str,
), f"Wrong type for [hosts], should be a string [was {type(hosts)}]"
assert type(ports) in (
str,
type(None),
), f"Wrong type for [ports], should be a string [was {type(ports)}]"
assert type(arguments) in (
str,
), f"Wrong type for [arguments], should be a string [was {type(arguments)}]"
else:
assert (
type(hosts) is str
), f"Wrong type for [hosts], should be a string [was {type(hosts)}]"
assert type(ports) in (
str,
type(None),
), f"Wrong type for [ports], should be a string [was {type(ports)}]"
assert (
type(arguments) is str
), f"Wrong type for [arguments], should be a string [was {type(arguments)}]"
for redirecting_output in ["-oX", "-oA"]:
assert (
redirecting_output not in arguments
), "Xml output can't be redirected from command line.\nYou can access it after a scan using:\nnmap.nm.get_nmap_last_output()" # noqa
h_args = shlex.split(hosts)
f_args = shlex.split(arguments)
# Launch scan
args = (
[self._nmap_path, "-oX", "-"]
+ h_args
+ ["-p", ports] * (ports is not None)
+ f_args
)
if sudo:
args = ["sudo"] + args
p = subprocess.Popen(
args,
bufsize=100000,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
# wait until finished
# get output
# Terminate after user timeout
if timeout == 0:
(self._nmap_last_output, nmap_err) = p.communicate()
else:
try:
(self._nmap_last_output, nmap_err) = p.communicate(timeout=timeout)
except subprocess.TimeoutExpired:
p.kill()
raise PortScannerTimeout("Timeout from nmap process")
nmap_err = bytes.decode(nmap_err)
# If there was something on stderr, there was a problem so abort... in
# fact not always. As stated by AlenLPeacock :
# This actually makes python-nmap mostly unusable on most real-life
# networks -- a particular subnet might have dozens of scannable hosts,
# but if a single one is unreachable or unroutable during the scan,
# nmap.scan() returns nothing. This behavior also diverges significantly
# from commandline nmap, which simply stderrs individual problems but
# keeps on trucking.
nmap_err_keep_trace = []
nmap_warn_keep_trace = []
if len(nmap_err) > 0:
regex_warning = re.compile("^Warning: .*", re.IGNORECASE)
for line in nmap_err.split(os.linesep):
if len(line) > 0:
rgw = regex_warning.search(line)
if rgw is not None:
nmap_warn_keep_trace.append(line + os.linesep)
else:
nmap_err_keep_trace.append(nmap_err)
return self.analyse_nmap_xml_scan(
nmap_xml_output=self._nmap_last_output,
nmap_err=nmap_err,
nmap_err_keep_trace=nmap_err_keep_trace,
nmap_warn_keep_trace=nmap_warn_keep_trace,
)
def analyse_nmap_xml_scan( # NOQA: CFQ001, C901
self,
nmap_xml_output=None,
nmap_err="",
nmap_err_keep_trace="",
nmap_warn_keep_trace="",
):
"""
Analyses NMAP xml scan ouput
May raise PortScannerError exception if nmap output was not xml
Test existance of the following key to know if something went wrong : ['nmap']['scaninfo']['error']
If not present, everything was ok.
:param nmap_xml_output: xml string to analyse
:returns: scan_result as dictionnary
"""
# nmap xml output looks like :
# <host starttime="1267974521" endtime="1267974522">
# <status state="up" reason="user-set"/>
# <address addr="192.168.1.1" addrtype="ipv4" />
# <hostnames><hostname name="neufbox" type="PTR" /></hostnames>
# <ports>
# <port protocol="tcp" portid="22">
# <state state="filtered" reason="no-response" reason_ttl="0"/>
# <service name="ssh" method="table" conf="3" />
# </port>
# <port protocol="tcp" portid="25">
# <state state="filtered" reason="no-response" reason_ttl="0"/>
# <service name="smtp" method="table" conf="3" />
# </port>
# </ports>
# <hostscript>
# <script id="nbstat" output="NetBIOS name: GROSTRUC, NetBIOS user: <unknown>, NetBIOS MAC: <unknown>
" /> # NOQA: E501
# <script id="smb-os-discovery" output=" 
 OS: Unix (Samba 3.6.3)
 Name: WORKGROUP\Unknown
 System time: 2013-06-23 15:37:40 UTC+2
" /> # NOQA: E501
# <script id="smbv2-enabled" output="Server doesn't support SMBv2 protocol" />
# </hostscript>
# <times srtt="-1" rttvar="-1" to="1000000" />
# </host>
# <port protocol="tcp" portid="25">
# <state state="open" reason="syn-ack" reason_ttl="0"/>
# <service name="smtp" product="Exim smtpd" version="4.76" hostname="grostruc" method="probed" conf="10">
# <cpe>cpe:/a:exim:exim:4.76</cpe>
# </service>
# <script id="smtp-commands" output="grostruc Hello localhost [127.0.0.1], SIZE 52428800, PIPELINING, HELP, 
 Commands supported: AUTH HELO EHLO MAIL RCPT DATA NOOP QUIT RSET HELP "/> # NOQA: E501
# </port>
if nmap_xml_output is not None:
self._nmap_last_output = nmap_xml_output
scan_result = {}
try:
dom = ET.fromstring(self._nmap_last_output)
except Exception:
if len(nmap_err) > 0:
raise PortScannerError(nmap_err)
else:
raise PortScannerError(self._nmap_last_output)
# nmap command line
scan_result["nmap"] = {
"command_line": dom.get("args"),
"scaninfo": {},
"scanstats": {
"timestr": dom.find("runstats/finished").get("timestr"),
"elapsed": dom.find("runstats/finished").get("elapsed"),
"uphosts": dom.find("runstats/hosts").get("up"),
"downhosts": dom.find("runstats/hosts").get("down"),
"totalhosts": dom.find("runstats/hosts").get("total"),
},
}
# if there was an error
if len(nmap_err_keep_trace) > 0:
scan_result["nmap"]["scaninfo"]["error"] = nmap_err_keep_trace
# if there was a warning
if len(nmap_warn_keep_trace) > 0:
scan_result["nmap"]["scaninfo"]["warning"] = nmap_warn_keep_trace
# info about scan
for dsci in dom.findall("scaninfo"):
scan_result["nmap"]["scaninfo"][dsci.get("protocol")] = {
"method": dsci.get("type"),
"services": dsci.get("services"),
}
scan_result["scan"] = {}
for dhost in dom.findall("host"):
# host ip, mac and other addresses
host = None
address_block = {}
vendor_block = {}
for address in dhost.findall("address"):
addtype = address.get("addrtype")
address_block[addtype] = address.get("addr")
if addtype == "ipv4":
host = address_block[addtype]
elif addtype == "mac" and address.get("vendor") is not None:
vendor_block[address_block[addtype]] = address.get("vendor")
if host is None:
host = dhost.find("address").get("addr")
hostnames = []
if len(dhost.findall("hostnames/hostname")) > 0:
for dhostname in dhost.findall("hostnames/hostname"):
hostnames.append(
{"name": dhostname.get("name"), "type": dhostname.get("type")}
)
else:
hostnames.append({"name": "", "type": ""})
scan_result["scan"][host] = PortScannerHostDict({"hostnames": hostnames})
scan_result["scan"][host]["addresses"] = address_block
scan_result["scan"][host]["vendor"] = vendor_block
for dstatus in dhost.findall("status"):
# status : up...
scan_result["scan"][host]["status"] = {
"state": dstatus.get("state"),
"reason": dstatus.get("reason"),
}
for dstatus in dhost.findall("uptime"):
# uptime : seconds, lastboot
scan_result["scan"][host]["uptime"] = {
"seconds": dstatus.get("seconds"),
"lastboot": dstatus.get("lastboot"),
}
for dport in dhost.findall("ports/port"):
# protocol
proto = dport.get("protocol")
# port number converted as integer
port = int(dport.get("portid"))
# state of the port
state = dport.find("state").get("state")
# reason
reason = dport.find("state").get("reason")
# name, product, version, extra info and conf if any
name = product = version = extrainfo = conf = cpe = ""
for dname in dport.findall("service"):
name = dname.get("name")
if dname.get("product"):
product = dname.get("product")
if dname.get("version"):
version = dname.get("version")
if dname.get("extrainfo"):
extrainfo = dname.get("extrainfo")
if dname.get("conf"):
conf = dname.get("conf")
for dcpe in dname.findall("cpe"):
cpe = dcpe.text
# store everything
if proto not in list(scan_result["scan"][host].keys()):
scan_result["scan"][host][proto] = {}
scan_result["scan"][host][proto][port] = {
"state": state,
"reason": reason,
"name": name,
"product": product,
"version": version,
"extrainfo": extrainfo,
"conf": conf,
"cpe": cpe,
}
script_id = ""
script_out = ""
# get script output if any
for dscript in dport.findall("script"):
script_id = dscript.get("id")
script_out = dscript.get("output")
if "script" not in list(
scan_result["scan"][host][proto][port].keys()
):
scan_result["scan"][host][proto][port]["script"] = {}
scan_result["scan"][host][proto][port]["script"][
script_id
] = script_out
# <hostscript>
# <script id="nbstat" output="NetBIOS name: GROSTRUC, NetBIOS user: <unknown>, NetBIOS MAC: <unknown>
" /> # NOQA: E501
# <script id="smb-os-discovery" output=" 
 OS: Unix (Samba 3.6.3)
 Name: WORKGROUP\Unknown
 System time: 2013-06-23 15:37:40 UTC+2
" /> # NOQA: E501
# <script id="smbv2-enabled" output="Server doesn't support SMBv2 protocol" />
# </hostscript>
for dhostscript in dhost.findall("hostscript"):
for dname in dhostscript.findall("script"):
hsid = dname.get("id")
hsoutput = dname.get("output")
if "hostscript" not in list(scan_result["scan"][host].keys()):
scan_result["scan"][host]["hostscript"] = []
scan_result["scan"][host]["hostscript"].append(
{"id": hsid, "output": hsoutput}
)
# <osmatch name="Juniper SA4000 SSL VPN gateway (IVE OS 7.0)" accuracy="98" line="36241">
# <osclass type="firewall" vendor="Juniper" osfamily="IVE OS" osgen="7.X"
# accuracy="98"><cpe>cpe:/h:juniper:sa4000</cpe><cpe>cpe:/o:juniper:ive_os:7</cpe></osclass>
# </osmatch>
# <osmatch name="Cymphonix EX550 firewall" accuracy="98" line="17929">
# <osclass type="firewall" vendor="Cymphonix" osfamily="embedded"
# accuracy="98"><cpe>cpe:/h:cymphonix:ex550</cpe></osclass>
# </osmatch>
for dos in dhost.findall("os"):
osmatch = []
portused = []
for dportused in dos.findall("portused"):
# <portused state="open" proto="tcp" portid="443"/>
state = dportused.get("state")
proto = dportused.get("proto")
portid = dportused.get("portid")
portused.append({"state": state, "proto": proto, "portid": portid})
scan_result["scan"][host]["portused"] = portused
for dosmatch in dos.findall("osmatch"):
# <osmatch name="Linux 3.7 - 3.15" accuracy="100" line="52790">
name = dosmatch.get("name")
accuracy = dosmatch.get("accuracy")
line = dosmatch.get("line")
osclass = []
for dosclass in dosmatch.findall("osclass"):
# <osclass type="general purpose" vendor="Linux" osfamily="Linux" osgen="2.6.X" accuracy="98"/>
ostype = dosclass.get("type")
vendor = dosclass.get("vendor")
osfamily = dosclass.get("osfamily")
osgen = dosclass.get("osgen")
accuracy = dosclass.get("accuracy")
cpe = []
for dcpe in dosclass.findall("cpe"):
cpe.append(dcpe.text)
osclass.append(
{
"type": ostype,
"vendor": vendor,
"osfamily": osfamily,
"osgen": osgen,
"accuracy": accuracy,
"cpe": cpe,
}
)
osmatch.append(
{
"name": name,
"accuracy": accuracy,
"line": line,
"osclass": osclass,
}
)
else:
scan_result["scan"][host]["osmatch"] = osmatch
for dport in dhost.findall("osfingerprint"):
# <osfingerprint fingerprint="OS:SCAN(V=5.50%D=11/[...]S)
"/>
fingerprint = dport.get("fingerprint")
scan_result["scan"][host]["fingerprint"] = fingerprint
self._scan_result = scan_result # store for later use
return scan_result
def __getitem__(self, host):
"""
returns a host detail
"""
if sys.version_info[0] == 2:
assert type(host) in (
str,
), f"Wrong type for [host], should be a string [was {type(host)}]"
else:
assert (
type(host) is str
), f"Wrong type for [host], should be a string [was {type(host)}]"
return self._scan_result["scan"][host]
def all_hosts(self):
"""
returns a sorted list of all hosts
"""
if "scan" not in list(self._scan_result.keys()):
return []
listh = list(self._scan_result["scan"].keys())
listh.sort()
return listh
def command_line(self):
"""
returns command line used for the scan
may raise AssertionError exception if called before scanning
"""
assert "nmap" in self._scan_result, "Do a scan before trying to get result !"
assert (
"command_line" in self._scan_result["nmap"]
), "Do a scan before trying to get result !"
return self._scan_result["nmap"]["command_line"]
def scaninfo(self):
"""
returns scaninfo structure
{'tcp': {'services': '22', 'method': 'connect'}}
may raise AssertionError exception if called before scanning
"""
assert "nmap" in self._scan_result, "Do a scan before trying to get result !"
assert (
"scaninfo" in self._scan_result["nmap"]
), "Do a scan before trying to get result !"
return self._scan_result["nmap"]["scaninfo"]
def scanstats(self):
"""
returns scanstats structure
{'uphosts': '3', 'timestr': 'Thu Jun 3 21:45:07 2010', 'downhosts': '253', 'totalhosts': '256', 'elapsed': '5.79'} # NOQA: E501
may raise AssertionError exception if called before scanning
"""
assert "nmap" in self._scan_result, "Do a scan before trying to get result !"
assert (
"scanstats" in self._scan_result["nmap"]
), "Do a scan before trying to get result !"
return self._scan_result["nmap"]["scanstats"]
def has_host(self, host):
"""
returns True if host has result, False otherwise
"""
assert (
type(host) is str
), f"Wrong type for [host], should be a string [was {type(host)}]"
assert "scan" in self._scan_result, "Do a scan before trying to get result !"
if host in list(self._scan_result["scan"].keys()):
return True
return False
def csv(self):
"""
returns CSV output as text
Example :
host;hostname;hostname_type;protocol;port;name;state;product;extrainfo;reason;version;conf;cpe
127.0.0.1;localhost;PTR;tcp;22;ssh;open;OpenSSH;protocol 2.0;syn-ack;5.9p1 Debian 5ubuntu1;10;cpe
127.0.0.1;localhost;PTR;tcp;23;telnet;closed;;;conn-refused;;3;
127.0.0.1;localhost;PTR;tcp;24;priv-mail;closed;;;conn-refused;;3;
"""
assert "scan" in self._scan_result, "Do a scan before trying to get result !"
if sys.version_info < (3, 0):
fd = io.BytesIO()
else:
fd = io.StringIO()
csv_ouput = csv.writer(fd, delimiter=";")
csv_header = [
"host",
"hostname",
"hostname_type",
"protocol",
"port",
"name",
"state",
"product",
"extrainfo",
"reason",
"version",
"conf",
"cpe",
]
csv_ouput.writerow(csv_header)
for host in self.all_hosts():
for proto in self[host].all_protocols():
if proto not in ["tcp", "udp"]:
continue
lport = list(self[host][proto].keys())
lport.sort()
for port in lport:
hostname = ""
for h in self[host]["hostnames"]:
hostname = h["name"]
hostname_type = h["type"]
csv_row = [
host,
hostname,
hostname_type,
proto,
port,
self[host][proto][port]["name"],
self[host][proto][port]["state"],
self[host][proto][port]["product"],
self[host][proto][port]["extrainfo"],
self[host][proto][port]["reason"],
self[host][proto][port]["version"],
self[host][proto][port]["conf"],
self[host][proto][port]["cpe"],
]
csv_ouput.writerow(csv_row)
return fd.getvalue()
############################################################################
def __scan_progressive__( # NOQA: CFQ002
self, hosts, ports, arguments, callback, sudo, timeout
):
"""
Used by PortScannerAsync for callback
"""
for host in self._nm.listscan(hosts):
try:
scan_data = self._nm.scan(host, ports, arguments, sudo, timeout)
except PortScannerError:
scan_data = None
if callback is not None:
callback(host, scan_data)
return
############################################################################
class PortScannerAsync(object):
"""
PortScannerAsync allows to use nmap from python asynchronously
for each host scanned, callback is called with scan result for the host
"""
def __init__(self):
"""
Initialize the module
* detects nmap on the system and nmap version
* may raise PortScannerError exception if nmap is not found in the path
"""
self._process = None
self._nm = PortScanner()
return
def __del__(self):
"""
Cleanup when deleted
"""
if self._process is not None:
try:
if self._process.is_alive():
self._process.terminate()
except AssertionError:
# Happens on python3.4
# when using PortScannerAsync twice in a row
pass
self._process = None
return
def scan( # NOQA: CFQ002
self,
hosts="127.0.0.1",
ports=None,
arguments="-sV",
callback=None,
sudo=False,
timeout=0,
):
"""
Scan given hosts in a separate process and return host by host result using callback function
PortScannerError exception from standard nmap is catched and you won't know about but get None as scan_data
:param hosts: string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20'
:param ports: string for ports as nmap use it '22,53,110,143-4564'
:param arguments: string of arguments for nmap '-sU -sX -sC'
:param callback: callback function which takes (host, scan_data) as arguments
:param sudo: launch nmap with sudo if true
:param timeout: int, if > zero, will terminate scan after seconds, otherwise will wait indefintely
"""
if sys.version_info[0] == 2:
assert type(hosts) in (
str,
), f"Wrong type for [hosts], should be a string [was {type(hosts)}]"
assert type(ports) in (
str,
type(None),
), f"Wrong type for [ports], should be a string [was {type(ports)}]"
assert type(arguments) in (
str,
), f"Wrong type for [arguments], should be a string [was {type(arguments)}]"
else:
assert (
type(hosts) is str
), f"Wrong type for [hosts], should be a string [was {type(hosts)}]"
assert type(ports) in (
str,
type(None),
), f"Wrong type for [ports], should be a string [was {type(ports)}]"
assert (
type(arguments) is str
), f"Wrong type for [arguments], should be a string [was {type(arguments)}]"
assert (
callable(callback) or callback is None
), f"The [callback] {str(callback)} should be callable or None."
for redirecting_output in ["-oX", "-oA"]:
assert (
redirecting_output not in arguments
), "Xml output can't be redirected from command line.\nYou can access it after a scan using:\nnmap.nm.get_nmap_last_output()" # NOQA: E501
self._process = Process(
target=__scan_progressive__,
args=(self, hosts, ports, arguments, callback, sudo, timeout),
)
self._process.daemon = True
self._process.start()
return
def stop(self):
"""
Stop the current scan process
"""
if self._process is not None:
self._process.terminate()
return
def wait(self, timeout=None):
"""
Wait for the current scan process to finish, or timeout
:param timeout: default = None, wait timeout seconds
"""
assert type(timeout) in (
int,
type(None),
), f"Wrong type for [timeout], should be an int or None [was {type(timeout)}]"
self._process.join(timeout)
return
def still_scanning(self):
"""
:returns: True if a scan is currently running, False otherwise
"""
try:
return self._process.is_alive()
except Exception:
return False
############################################################################
class PortScannerYield(PortScannerAsync):
"""
PortScannerYield allows to use nmap from python with a generator
for each host scanned, yield is called with scan result for the host
"""
def __init__(self):
"""
Initialize the module
* detects nmap on the system and nmap version
* may raise PortScannerError exception if nmap is not found in the path
"""
PortScannerAsync.__init__(self)
return
def scan(
self, hosts="127.0.0.1", ports=None, arguments="-sV", sudo=False, timeout=0
):
"""
Scan given hosts in a separate process and return host by host result using callback function
PortScannerError exception from standard nmap is catched and you won't know about it
:param hosts: string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20'
:param ports: string for ports as nmap use it '22,53,110,143-4564'
:param arguments: string of arguments for nmap '-sU -sX -sC'
:param callback: callback function which takes (host, scan_data) as arguments
:param sudo: launch nmap with sudo if true
:param timeout: int, if > zero, will terminate scan after seconds, otherwise will wait indefintely
"""
assert (
type(hosts) is str
), f"Wrong type for [hosts], should be a string [was {type(hosts)}]"
assert type(ports) in (
str,
type(None),
), f"Wrong type for [ports], should be a string [was {type(ports)}]"
assert (
type(arguments) is str
), f"Wrong type for [arguments], should be a string [was {type(arguments)}]"
for redirecting_output in ["-oX", "-oA"]:
assert (
redirecting_output not in arguments
), "Xml output can't be redirected from command line.\nYou can access it after a scan using:\nnmap.nm.get_nmap_last_output()" # NOQA: E501
for host in self._nm.listscan(hosts):
try:
scan_data = self._nm.scan(host, ports, arguments, sudo, timeout)
except PortScannerError:
scan_data = None
yield (host, scan_data)
return
def stop(self):
pass
def wait(self, timeout=None):
pass
def still_scanning(self):
pass
############################################################################
class PortScannerHostDict(dict):
"""
Special dictionnary class for storing and accessing host scan result
"""
def hostnames(self):
"""
:returns: list of hostnames
"""
return self["hostnames"]
def hostname(self):
"""
For compatibility purpose...
:returns: try to return the user record or the first hostname of the list hostnames
"""
hostname = ""
for h in self["hostnames"]:
if h["type"] == "user":
return h["name"]
else:
if len(self["hostnames"]) > 0 and "name" in self["hostnames"][0]:
return self["hostnames"][0]["name"]
else:
return ""
return hostname
def state(self):
"""
:returns: host state