├── TODO ├── MANIFEST.in ├── MANIFEST ├── README.md ├── .gitignore ├── Makefile ├── nmap ├── __init__.py ├── example.py └── nmap.py ├── setup.py ├── CHANGELOG ├── README.txt ├── nmap.html └── gpl-3.0.txt /TODO: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include *.txt 2 | include CHANGELOG 3 | include Makefile 4 | include nmap.html 5 | include MANIFEST.in -------------------------------------------------------------------------------- /MANIFEST: -------------------------------------------------------------------------------- 1 | # file GENERATED by distutils, do NOT edit 2 | CHANGELOG 3 | MANIFEST.in 4 | Makefile 5 | README.txt 6 | gpl-3.0.txt 7 | nmap.html 8 | setup.py 9 | nmap/__init__.py 10 | nmap/example.py 11 | nmap/nmap.py 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | python-nmap 2 | =========== 3 | 4 | Cloned from https://code.google.com/p/python-nmap/ with some extra values that I need. 5 | 6 | The upstream project has now moved to https://bitbucket.org/xael/python-nmap. 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # Packages 7 | *.egg 8 | *.egg-info 9 | dist 10 | build 11 | eggs 12 | parts 13 | bin 14 | var 15 | sdist 16 | develop-eggs 17 | .installed.cfg 18 | lib 19 | lib64 20 | 21 | # Installer logs 22 | pip-log.txt 23 | 24 | # Unit test / coverage reports 25 | .coverage 26 | .tox 27 | nosetests.xml 28 | 29 | # Translations 30 | *.mo 31 | 32 | # Mr Developer 33 | .mr.developer.cfg 34 | .project 35 | .pydevproject 36 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # python-nmap Makefile 2 | 3 | VERSION=`python setup.py --version` 4 | ARCHIVE=`python setup.py --fullname` 5 | 6 | 7 | test: 8 | @python3 nmap/nmap.py 9 | 10 | install: 11 | @python3 setup.py install 12 | 13 | archive: doc 14 | @python3 setup.py sdist 15 | @echo Archive is create and named dist/$(ARCHIVE).tar.gz 16 | @echo -n md5sum is : 17 | @md5sum dist/$(ARCHIVE).tar.gz 18 | 19 | license: 20 | @python3 setup.py --license 21 | 22 | register: 23 | @python3 setup.py register 24 | 25 | doc: 26 | @pydoc3 -w nmap/nmap.py 27 | 28 | web: 29 | @echo $(VERSION) > web/python-nmap_CURRENT_VERSION.txt 30 | @cp dist/$(ARCHIVE).tar.gz web/ 31 | @md5sum web/$(ARCHIVE).tar.gz > LAST_MD5 32 | @emacsclient -a /usr/bin/emacs22 LAST_MD5 web/index.gtm 33 | @rm LAST_MD5 34 | 35 | .PHONY: web -------------------------------------------------------------------------------- /nmap/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: latin-1 -*- 2 | 3 | """ 4 | __init__.py - 2010.12.17 5 | 6 | Author : Alexandre Norman - norman@xael.org 7 | Contributors: Steve 'Ashcrow' Milner - steve@gnulinux.net 8 | Brian Bustin - brian at bustin.us 9 | Licence : GPL v3 or any later version 10 | 11 | 12 | This program is free software: you can redistribute it and/or modify 13 | it under the terms of the GNU General Public License as published by 14 | the Free Software Foundation, either version 3 of the License, or 15 | any later version. 16 | 17 | This program is distributed in the hope that it will be useful, 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | GNU General Public License for more details. 21 | 22 | You should have received a copy of the GNU General Public License 23 | along with this program. If not, see . 24 | """ 25 | 26 | from .nmap import * 27 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | 2 | from distutils.core import setup, Extension 3 | 4 | nmap = Extension('nmap', 5 | sources = ['nmap/nmap.py', 'nmap/__init__.py', 'nmap/example.py']) 6 | 7 | from nmap import * 8 | 9 | # Install : python setup.py install 10 | # Register : python setup.py register 11 | 12 | # platform = 'Unix', 13 | # download_url = 'http://xael.org/norman/python/python-nmap/', 14 | 15 | 16 | setup ( 17 | name = 'python-nmap', 18 | version = nmap.__version__, 19 | author = 'Alexandre Norman', 20 | author_email = 'norman@xael.org', 21 | license ='gpl-3.0.txt', 22 | keywords="nmap, portscanner, network, sysadmin", 23 | # Get more strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers 24 | platforms=[ 25 | "Operating System :: OS Independent", 26 | ], 27 | classifiers=[ 28 | "Development Status :: 5 - Production/Stable", 29 | "Programming Language :: Python", 30 | "Environment :: Console", 31 | "Intended Audience :: Developers", 32 | "Intended Audience :: System Administrators", 33 | "License :: OSI Approved :: GNU General Public License (GPL)", 34 | "Operating System :: OS Independent", 35 | "Topic :: System :: Monitoring", 36 | "Topic :: System :: Networking", 37 | "Topic :: System :: Networking :: Firewalls", 38 | "Topic :: System :: Networking :: Monitoring", 39 | ], 40 | packages=['nmap'], 41 | url = 'http://xael.org/norman/python/python-nmap/', 42 | description = 'This is a python class to use nmap and access scan results from python3', 43 | long_description=open('README.txt').read() + "\n" + open('CHANGELOG').read(), 44 | ) 45 | -------------------------------------------------------------------------------- /CHANGELOG: -------------------------------------------------------------------------------- 1 | Changelog 2 | ========= 3 | 4 | 2012/12/13 (v0.2.6) 5 | - patch from lundberg.johan 6 | - bug correction : when nmap doesn't work displays stderr instead of stdout 7 | 8 | 2012/11/23 (v0.2.5) 9 | - corrected : Issue 2: "map.nmap.PortScannerError: 'nmap program was not found in path'" on CentOS 10 | - corrected : Issue 3: nmap.scan() short-circuits prematurely 11 | 12 | 2011/11/09 (v0.2.4) 13 | - implemented a request from Santhosh Edukulla : 14 | parse OS scanning output 15 | - Error with multiple host specifications : 16 | bug and patch from old.schepperhand@gmail.com 17 | 18 | 2011/11/04 19 | - bug in example.py : if no tcp port was open between 22-443 20 | 21 | 2010/12/17 (v0.2.3) 22 | - adding __get_last_online_version to check if current version is the last published 23 | 24 | 2010/12/17 (v0.2.2) 25 | - bug in handling nmap_error output (returned value was bin, string was expected) 26 | - removed test strings form __init__.py file. 27 | 28 | 2010/12/15 (v0.2.1) 29 | - corrected bug in __init__.py about scope problem 30 | - try to find nmap executable in known directories 31 | - raise AssertionError when trying to call command_line, scaninfo, scanstats, has_host before scanning 32 | 33 | 2010/12/14 (v0.2.0) 34 | - Make python-nmap works with Python 3.x 35 | - Contribution from Brian Bustin 36 | 37 | 2010/06/07 (v0.1.4) 38 | Patches from Steve 'Ashcrow' Milner 39 | - remove shebang from __init__.py as it is not a runnable script 40 | - allow use with ALPHA and BETA nmap releases 41 | - .has_key() is deprecated, replaced instances with in 42 | - move to using the print function for python2 and 3 usage 43 | 44 | 2010/06/04 45 | - adding PortScanner.listscan 46 | - PortScanner.scan now returns scan_result 47 | - adding class PortScannerAsync (idea from Steve 'Ashcrow' Milner ) 48 | 49 | 2010/06/03 50 | - Import on google code 51 | svn checkout https://python-nmap.googlecode.com/svn/trunk/ python-nmap --username XXXXX 52 | - added PortScanner.scanstats method 53 | - updated example.py and documentation for pingsweep 54 | - updated Makefile for generating documentation 55 | 56 | 2010/03/09 57 | - Modified packaging. v0.1.1 [norman] 58 | 59 | 2010/03/08 60 | - Initial release. v0.1.0 [norman] 61 | -------------------------------------------------------------------------------- /README.txt: -------------------------------------------------------------------------------- 1 | =========== 2 | python-nmap 3 | =========== 4 | 5 | python-nmap is a python library which helps in using nmap port scanner. 6 | It allows to easilly manipulate nmap scan results and will be a perfect 7 | tool for systems administrators who want to automatize scanning task 8 | and reports. It also supports nmap script outputs. 9 | 10 | Typical usage looks like:: 11 | 12 | #!/usr/bin/env python 13 | import nmap # import nmap.py module 14 | nm = nmap.PortScanner() # instantiate nmap.PortScanner object 15 | nm.scan('127.0.0.1', '22-443') # scan host 127.0.0.1, ports from 22 to 443 16 | nm.command_line() # get command line used for the scan : nmap -oX - -p 22-443 127.0.0.1 17 | nm.scaninfo() # get nmap scan informations {'tcp': {'services': '22-443', 'method': 'connect'}} 18 | nm.all_hosts() # get all hosts that were scanned 19 | nm['127.0.0.1'].hostname() # get hostname for host 127.0.0.1 20 | nm['127.0.0.1'].state() # get state of host 127.0.0.1 (up|down|unknown|skipped) 21 | nm['127.0.0.1'].all_protocols() # get all scanned protocols ['tcp', 'udp'] in (ip|tcp|udp|sctp) 22 | nm['127.0.0.1']['tcp'].keys() # get all ports for tcp protocol 23 | nm['127.0.0.1'].all_tcp() # get all ports for tcp protocol (sorted version) 24 | nm['127.0.0.1'].all_udp() # get all ports for udp protocol (sorted version) 25 | nm['127.0.0.1'].all_ip() # get all ports for ip protocol (sorted version) 26 | nm['127.0.0.1'].all_sctp() # get all ports for sctp protocol (sorted version) 27 | nm['127.0.0.1'].has_tcp(22) # is there any information for port 22/tcp on host 127.0.0.1 28 | nm['127.0.0.1']['tcp'][22] # get infos about port 22 in tcp on host 127.0.0.1 29 | nm['127.0.0.1'].tcp(22) # get infos about port 22 in tcp on host 127.0.0.1 30 | nm['127.0.0.1']['tcp'][22]['state'] # get state of port 22/tcp on host 127.0.0.1 (open 31 | 32 | 33 | # a more usefull example : 34 | for host in nm.all_hosts(): 35 | print('----------------------------------------------------') 36 | print('Host : %s (%s)' % (host, nm[host].hostname())) 37 | print('State : %s' % nm[host].state()) 38 | 39 | for proto in nm[host].all_protocols(): 40 | print('----------') 41 | print('Protocol : %s' % proto) 42 | 43 | lport = nm[host][proto].keys() 44 | lport.sort() 45 | for port in lport: 46 | print('port : %s\tstate : %s' % (port, nm[host][proto][port]['state'])) 47 | 48 | 49 | print('----------------------------------------------------') 50 | # If you want to do a pingsweep on network 192.168.1.0/24: 51 | nm.scan(hosts='192.168.1.0/24', arguments='-n -sP -PE -PA21,23,80,3389') 52 | hosts_list = [(x, nm[x]['status']['state']) for x in nm.all_hosts()] 53 | for host, status in hosts_list: 54 | print('{0}:{1}'.format(host, status)) 55 | 56 | 57 | print '----------------------------------------------------' 58 | # Asynchronous usage of PortScannerAsync 59 | nma = nmap.PortScannerAsync() 60 | def callback_result(host, scan_result): 61 | print '------------------' 62 | print host, scan_result 63 | nma.scan(hosts='192.168.1.0/30', arguments='-sP', callback=callback_result) 64 | while nma.still_scanning(): 65 | print("Waiting ...") 66 | nma.wait(2) # you can do whatever you want but I choose to wait after the end of the scan 67 | 68 | 69 | Homepage 70 | ======== 71 | 72 | http://xael.org/norman/python/python-nmap/ 73 | 74 | -------------------------------------------------------------------------------- /nmap/example.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: latin-1 -*- 3 | 4 | """ 5 | example.py - 2011.11.09 6 | 7 | Author : Alexandre Norman - norman@xael.org 8 | Contributor: Steve 'Ashcrow' Milner - steve@gnulinux.net 9 | Licence : GPL v3 or any later version 10 | 11 | 12 | This program is free software: you can redistribute it and/or modify 13 | it under the terms of the GNU General Public License as published by 14 | the Free Software Foundation, either version 3 of the License, or 15 | any later version. 16 | 17 | This program is distributed in the hope that it will be useful, 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | GNU General Public License for more details. 21 | 22 | You should have received a copy of the GNU General Public License 23 | along with this program. If not, see . 24 | 25 | """ 26 | import sys 27 | import os 28 | 29 | import nmap # import nmap.py module 30 | try: 31 | nm = nmap.PortScanner() # instantiate nmap.PortScanner object 32 | except nmap.PortScannerError: 33 | print('Nmap not found', sys.exc_info()[0]) 34 | sys.exit(0) 35 | except: 36 | print("Unexpected error:", sys.exc_info()[0]) 37 | sys.exit(0) 38 | 39 | 40 | 41 | 42 | 43 | 44 | nm.scan('127.0.0.1', '22-443') # scan host 127.0.0.1, ports from 22 to 443 45 | nm.command_line() # get command line used for the scan : nmap -oX - -p 22-443 127.0.0.1 46 | nm.scaninfo() # get nmap scan informations {'tcp': {'services': '22-443', 'method': 'connect'}} 47 | nm.all_hosts() # get all hosts that were scanned 48 | nm['127.0.0.1'].hostname() # get hostname for host 127.0.0.1 49 | nm['127.0.0.1'].state() # get state of host 127.0.0.1 (up|down|unknown|skipped) 50 | nm['127.0.0.1'].all_protocols() # get all scanned protocols ['tcp', 'udp'] in (ip|tcp|udp|sctp) 51 | if ('tcp' in nm['127.0.0.1']): 52 | list(nm['127.0.0.1']['tcp'].keys()) # get all ports for tcp protocol 53 | 54 | nm['127.0.0.1'].all_tcp() # get all ports for tcp protocol (sorted version) 55 | nm['127.0.0.1'].all_udp() # get all ports for udp protocol (sorted version) 56 | nm['127.0.0.1'].all_ip() # get all ports for ip protocol (sorted version) 57 | nm['127.0.0.1'].all_sctp() # get all ports for sctp protocol (sorted version) 58 | if nm['127.0.0.1'].has_tcp(22): # is there any information for port 22/tcp on host 127.0.0.1 59 | nm['127.0.0.1']['tcp'][22] # get infos about port 22 in tcp on host 127.0.0.1 60 | nm['127.0.0.1'].tcp(22) # get infos about port 22 in tcp on host 127.0.0.1 61 | nm['127.0.0.1']['tcp'][22]['state'] # get state of port 22/tcp on host 127.0.0.1 (open 62 | 63 | 64 | # a more usefull example : 65 | for host in nm.all_hosts(): 66 | print('----------------------------------------------------') 67 | print('Host : %s (%s)' % (host, nm[host].hostname())) 68 | print('State : %s' % nm[host].state()) 69 | 70 | for proto in nm[host].all_protocols(): 71 | print('----------') 72 | print('Protocol : %s' % proto) 73 | 74 | lport = list(nm[host][proto].keys()) 75 | lport.sort() 76 | for port in lport: 77 | print('port : %s\tstate : %s' % (port, nm[host][proto][port]['state'])) 78 | 79 | 80 | 81 | print('----------------------------------------------------') 82 | # If you want to do a pingsweep on network 192.168.1.0/24: 83 | nm.scan(hosts='192.168.1.0/24', arguments='-n -sP -PE -PA21,23,80,3389') 84 | hosts_list = [(x, nm[x]['status']['state']) for x in nm.all_hosts()] 85 | for host, status in hosts_list: 86 | print('{0}:{1}'.format(host, status)) 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | print('----------------------------------------------------') 95 | # Asynchronous usage of PortScannerAsync 96 | 97 | 98 | nma = nmap.PortScannerAsync() 99 | 100 | def callback_result(host, scan_result): 101 | print('------------------') 102 | print(host, scan_result) 103 | 104 | nma.scan(hosts='192.168.1.0/30', arguments='-sP', callback=callback_result) 105 | 106 | while nma.still_scanning(): 107 | print("Waiting ...") 108 | nma.wait(2) # you can do whatever you want but I choose to wait after the end of the scan 109 | 110 | if (os.getuid() == 0): 111 | print('----------------------------------------------------') 112 | # Os detection (need root privileges) 113 | nm.scan("127.0.0.1", arguments="-O") 114 | if nm['127.0.0.1'].has_key('osclass'): 115 | for osclass in nm['127.0.0.1']['osclass']: 116 | print('OsClass.type : {0}'.format(osclass['type'])) 117 | print('OsClass.vendor : {0}'.format(osclass['vendor'])) 118 | print('OsClass.osfamily : {0}'.format(osclass['osfamily'])) 119 | print('OsClass.osgen : {0}'.format(osclass['osgen'])) 120 | print('OsClass.accuracy : {0}'.format(osclass['accuracy'])) 121 | print('') 122 | 123 | if nm['127.0.0.1'].has_key('osmatch'): 124 | for osmatch in nm['127.0.0.1']['osmatch']: 125 | print('osmatch.name : {0}'.format(osmatch['name'])) 126 | print('osmatch.accuracy : {0}'.format(osmatch['accuracy'])) 127 | print('osmatch.line : {0}'.format(osmatch['line'])) 128 | print('') 129 | 130 | if nm['127.0.0.1'].has_key('fingerprint'): 131 | print('Fingerprint : {0}'.format(nm['127.0.0.1']['fingerprint'])) 132 | 133 | -------------------------------------------------------------------------------- /nmap/nmap.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: latin-1 -*- 3 | 4 | """ 5 | nmap.py - version and date, see below 6 | 7 | Author : Alexandre Norman - norman at xael.org 8 | Contributors: Steve 'Ashcrow' Milner - steve at gnulinux.net 9 | Brian Bustin - brian at bustin.us 10 | old.schepperhand 11 | Johan Lundberg 12 | Licence : GPL v3 or any later version 13 | 14 | 15 | This program is free software: you can redistribute it and/or modify 16 | it under the terms of the GNU General Public License as published by 17 | the Free Software Foundation, either version 3 of the License, or 18 | any later version. 19 | 20 | This program is distributed in the hope that it will be useful, 21 | but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | GNU General Public License for more details. 24 | 25 | You should have received a copy of the GNU General Public License 26 | along with this program. If not, see . 27 | 28 | 29 | Test strings : 30 | ^^^^^^^^^^^^ 31 | >>> import nmap 32 | >>> if __get_last_online_version() != __version__: 33 | ... raise ValueError('Current version is {0} - Last published version is {1}'.format(__version__, __get_last_online_version())) 34 | >>> nm = nmap.PortScanner() 35 | >>> try: 36 | ... nm.scan(arguments='-wrongargs') 37 | ... except nmap.PortScannerError: 38 | ... pass 39 | >>> 'error' in nm.scan('yahoo.fs', arguments='-sP')['nmap']['scaninfo'] 40 | True 41 | >>> r=nm.scan('127.0.0.1', '22-443') 42 | >>> nm.command_line() 43 | 'nmap -oX - -p 22-443 -sV 127.0.0.1' 44 | >>> nm.scaninfo() 45 | {'tcp': {'services': '22-443', 'method': 'syn'}} 46 | >>> nm.all_hosts() 47 | ['127.0.0.1'] 48 | >>> nm['127.0.0.1'].hostname() 49 | 'localhost' 50 | >>> nm['127.0.0.1'].state() 51 | 'up' 52 | >>> nm['127.0.0.1'].all_protocols() 53 | ['tcp'] 54 | >>> nm['127.0.0.1']['tcp'].keys() 55 | dict_keys([139, 111, 80, 53, 22, 25, 443]) 56 | >>> nm['127.0.0.1'].has_tcp(22) 57 | True 58 | >>> nm['127.0.0.1'].has_tcp(23) 59 | False 60 | >>> nm['127.0.0.1']['tcp'][22] 61 | {'state': 'open', 'reason': 'syn-ack', 'name': 'ssh'} 62 | >>> nm['127.0.0.1'].tcp(22) 63 | {'state': 'open', 'reason': 'syn-ack', 'name': 'ssh'} 64 | >>> nm['127.0.0.1']['tcp'][22]['state'] 65 | 'open' 66 | >>> nm.scanstats()['uphosts'] 67 | '1' 68 | >>> nm.scanstats()['downhosts'] 69 | '0' 70 | >>> nm.scanstats()['totalhosts'] 71 | '1' 72 | >>> 'timestr' in nm.scanstats().keys() 73 | True 74 | >>> 'elapsed' in nm.scanstats().keys() 75 | True 76 | >>> nm.listscan('192.168.1.0/30') 77 | ['192.168.1.0', '192.168.1.1', '192.168.1.2', '192.168.1.3'] 78 | >>> nm.listscan('localhost/30') 79 | ['127.0.0.0', '127.0.0.1', '127.0.0.2', '127.0.0.3'] 80 | >>> r=nm.scan('127.0.0.1', arguments='-O') 81 | >>> nm['127.0.0.1']['osclass'] 82 | [{'vendor': 'Linux', 'osfamily': 'Linux', 'type': 'general purpose', 'osgen': '2.6.X', 'accuracy': '96'}, {'vendor': 'AXIS', 'osfamily': 'Linux', 'type': 'webcam', 'osgen': '2.6.X', 'accuracy': '91'}, {'vendor': 'Crestron', 'osfamily': '2-Series', 'type': 'specialized', 'osgen': '', 'accuracy': ''}, {'vendor': 'Gemtek', 'osfamily': 'embedded', 'type': 'WAP', 'osgen': '', 'accuracy': ''}, {'vendor': 'Siemens', 'osfamily': 'embedded', 'type': 'WAP', 'osgen': '', 'accuracy': ''}, {'vendor': 'Linux', 'osfamily': 'Linux', 'type': 'general purpose', 'osgen': '2.4.X', 'accuracy': '88'}, {'vendor': 'Check Point', 'osfamily': 'embedded', 'type': 'firewall', 'osgen': '', 'accuracy': ''}, {'vendor': 'Check Point', 'osfamily': 'Linux', 'type': 'firewall', 'osgen': '2.4.X', 'accuracy': '88'}, {'vendor': 'Linux', 'osfamily': 'Linux', 'type': 'WAP', 'osgen': '2.4.X', 'accuracy': '88'}, {'vendor': 'Linux', 'osfamily': 'Linux', 'type': 'general purpose', 'osgen': '', 'accuracy': ''}, {'vendor': 'Linux', 'osfamily': 'Linux', 'type': 'WAP', 'osgen': '2.6.X', 'accuracy': '87'}, {'vendor': 'Vodavi', 'osfamily': 'embedded', 'type': 'PBX', 'osgen': '', 'accuracy': ''}, {'vendor': 'Lexmark', 'osfamily': 'embedded', 'type': 'printer', 'osgen': '', 'accuracy': ''}] 83 | >>> nm['127.0.0.1']['fingerprint'] 84 | 'OS:SCAN(V=5.21%D=11/23%OT=22%CT=1%CU=33028%PV=N%DS=0%DC=L%G=Y%TM=50AFE898%P\\nOS:=x86_64-unknown-linux-gnu)SEQ(SP=105%GCD=1%ISR=107%TI=Z%CI=Z%II=I%TS=8)O\\nOS:PS(O1=M400CST11NW6%O2=M400CST11NW6%O3=M400CNNT11NW6%O4=M400CST11NW6%O5=M\\nOS:400CST11NW6%O6=M400CST11)WIN(W1=8000%W2=8000%W3=8000%W4=8000%W5=8000%W6=\\nOS:8000)ECN(R=Y%DF=Y%T=40%W=8018%O=M400CNNSNW6%CC=Y%Q=)T1(R=Y%DF=Y%T=40%S=O\\nOS:%A=S+%F=AS%RD=0%Q=)T2(R=N)T3(R=N)T4(R=Y%DF=Y%T=40%W=0%S=A%A=Z%F=R%O=%RD=\\nOS:0%Q=)T5(R=Y%DF=Y%T=40%W=0%S=Z%A=S+%F=AR%O=%RD=0%Q=)T6(R=Y%DF=Y%T=40%W=0%\\nOS:S=A%A=Z%F=R%O=%RD=0%Q=)T7(R=Y%DF=Y%T=40%W=0%S=Z%A=S+%F=AR%O=%RD=0%Q=)U1(\\nOS:R=Y%DF=N%T=40%IPL=164%UN=0%RIPL=G%RID=G%RIPCK=G%RUCK=G%RUD=G)IE(R=Y%DFI=\\nOS:N%T=40%CD=S)\\n' 85 | """ 86 | 87 | 88 | __author__ = 'Alexandre Norman (norman@xael.org)' 89 | __version__ = '0.2.6' 90 | __last_modification__ = '2012.12.13' 91 | 92 | 93 | import os 94 | import re 95 | import string 96 | import subprocess 97 | import sys 98 | import types 99 | import xml.dom.minidom 100 | import shlex 101 | import collections 102 | 103 | 104 | try: 105 | from multiprocessing import Process 106 | except ImportError: 107 | # For pre 2.6 releases 108 | from threading import Thread as Process 109 | 110 | ############################################################################ 111 | 112 | class PortScanner(object): 113 | """ 114 | PortScanner allows to use nmap from python 115 | """ 116 | 117 | def __init__(self, nmap_search_path=('nmap','/usr/bin/nmap','/usr/local/bin/nmap','/sw/bin/nmap','/opt/local/bin/nmap') ): 118 | """ 119 | Initialize the module 120 | detects nmap on the system and nmap version 121 | may raise PortScannerError exception if nmap is not found in the path 122 | 123 | nmap_search_path = tupple of string where to search for nmap executable. Change this if you want to use a specific version of nmap. 124 | """ 125 | 126 | self._nmap_path = '' # nmap path 127 | self._scan_result = {} 128 | self._nmap_version_number = 0 # nmap version number 129 | self._nmap_subversion_number = 0 # nmap subversion number 130 | self._nmap_last_output = '' # last full ascii nmap output 131 | is_nmap_found = False # true if we have found nmap 132 | 133 | self.__process = None 134 | 135 | # regex used to detect nmap 136 | regex = re.compile('Nmap version [0-9]*\.[0-9]*[^ ]* \( http://.* \)') 137 | # launch 'nmap -V', we wait after 'Nmap version 5.0 ( http://nmap.org )' 138 | # This is for Mac OSX. When idle3 is launched from the finder, PATH is not set so nmap was not found 139 | for nmap_path in nmap_search_path: 140 | try: 141 | p = subprocess.Popen([nmap_path, '-V'], bufsize=10000, stdout=subprocess.PIPE) 142 | except OSError: 143 | pass 144 | else: 145 | self._nmap_path = nmap_path # save path 146 | break 147 | else: 148 | raise PortScannerError('nmap program was not found in path. PATH is : {0}'.format(os.getenv('PATH'))) 149 | 150 | 151 | 152 | self._nmap_last_output = bytes.decode(p.communicate()[0]) # store stdout 153 | for line in self._nmap_last_output.split('\n'): 154 | if regex.match(line) is not None: 155 | is_nmap_found = True 156 | # Search for version number 157 | regex_version = re.compile('[0-9]+') 158 | regex_subversion = re.compile('\.[0-9]+') 159 | 160 | rv = regex_version.search(line) 161 | rsv = regex_subversion.search(line) 162 | 163 | if rv is not None and rsv is not None: 164 | # extract version/subversion 165 | self._nmap_version_number = int(line[rv.start():rv.end()]) 166 | self._nmap_subversion_number = int(line[rsv.start()+1:rsv.end()]) 167 | break 168 | 169 | if is_nmap_found == False: 170 | raise PortScannerError('nmap program was not found in path') 171 | 172 | return 173 | 174 | 175 | def get_nmap_last_output(self): 176 | """ 177 | returns the last text output of nmap in raw text 178 | this may be used for debugging purpose 179 | """ 180 | return self._nmap_last_output 181 | 182 | 183 | 184 | def nmap_version(self): 185 | """ 186 | returns nmap version if detected (int version, int subversion) 187 | or (0, 0) if unknown 188 | """ 189 | return (self._nmap_version_number, self._nmap_subversion_number) 190 | 191 | 192 | 193 | def listscan(self, hosts='127.0.0.1'): 194 | """ 195 | do not scan but interpret target hosts and return a list a hosts 196 | """ 197 | assert type(hosts) is str, 'Wrong type for [hosts], should be a string [was {0}]'.format(type(hosts)) 198 | 199 | self.scan(hosts, arguments='-sL') 200 | return self.all_hosts() 201 | 202 | 203 | 204 | def scan(self, hosts='127.0.0.1', ports=None, arguments='-sV'): 205 | """ 206 | Scan given hosts 207 | 208 | May raise PortScannerError exception if nmap output was not xml 209 | 210 | Test existance of the following key to know if something went wrong : ['nmap']['scaninfo']['error'] 211 | If not present, everything was ok. 212 | 213 | hosts = string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20' 214 | ports = string for ports as nmap use it '22,53,110,143-4564' 215 | arguments = string of arguments for nmap '-sU -sX -sC' 216 | """ 217 | if sys.version_info[0]==2: 218 | assert type(hosts) in (str, unicode), 'Wrong type for [hosts], should be a string [was {0}]'.format(type(hosts)) 219 | else: 220 | assert type(hosts) is str, 'Wrong type for [hosts], should be a string [was {0}]'.format(type(hosts)) 221 | assert type(ports) in (str, type(None)), 'Wrong type for [ports], should be a string [was {0}]'.format(type(ports)) 222 | assert type(arguments) is str, 'Wrong type for [arguments], should be a string [was {0}]'.format(type(arguments)) 223 | 224 | h_args = shlex.split(hosts) 225 | f_args = shlex.split(arguments) 226 | 227 | # Launch scan 228 | args = [self._nmap_path, '-oX', '-'] + h_args + ['-p', ports]*(ports!=None) + f_args 229 | 230 | p = subprocess.Popen(args, bufsize=100000, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE) 231 | 232 | # wait until finished 233 | # get output 234 | (self._nmap_last_output, nmap_err) = p.communicate() 235 | self._nmap_last_output = bytes.decode(self._nmap_last_output) 236 | nmap_err = bytes.decode(nmap_err) 237 | 238 | # If there was something on stderr, there was a problem so abort... in 239 | # fact not always. As stated by AlenLPeacock : 240 | # This actually makes python-nmap mostly unusable on most real-life 241 | # networks -- a particular subnet might have dozens of scannable hosts, 242 | # but if a single one is unreachable or unroutable during the scan, 243 | # nmap.scan() returns nothing. This behavior also diverges significantly 244 | # from commandline nmap, which simply stderrs individual problems but 245 | # keeps on trucking. 246 | 247 | nmap_err_keep_trace = [] 248 | if len(nmap_err) > 0: 249 | regex_warning = re.compile('^Warning: .*') 250 | for line in nmap_err.split('\n'): 251 | if len(line) > 0: 252 | rgw = regex_warning.search(line) 253 | if rgw is not None: 254 | sys.stderr.write(line+'\n') 255 | pass 256 | else: 257 | #raise PortScannerError(nmap_err) 258 | nmap_err_keep_trace.append(nmap_err) 259 | 260 | # nmap xml output looks like : 261 | # 262 | # 263 | #
264 | # 265 | # 266 | # 267 | # 268 | # 269 | # 270 | # 271 | # 272 | # 273 | # 274 | # 275 | # 276 | # 277 | 278 | 279 | 280 | scan_result = {} 281 | 282 | 283 | try: 284 | dom = xml.dom.minidom.parseString(self._nmap_last_output) 285 | except xml.parsers.expat.ExpatError: 286 | if len(nmap_err)>0: 287 | raise PortScannerError(nmap_err) 288 | else: 289 | raise PortScannerError(self._nmap_last_output) 290 | 291 | # nmap command line 292 | scan_result['nmap'] = { 293 | 'command_line': dom.getElementsByTagName('nmaprun')[0].getAttributeNode('args').value, 294 | 'scaninfo': {}, 295 | 'scanstats':{'timestr':dom.getElementsByTagName("finished")[0].getAttributeNode('timestr').value, 296 | 'elapsed':dom.getElementsByTagName("finished")[0].getAttributeNode('elapsed').value, 297 | 'uphosts':dom.getElementsByTagName("hosts")[0].getAttributeNode('up').value, 298 | 'downhosts':dom.getElementsByTagName("hosts")[0].getAttributeNode('down').value, 299 | 'totalhosts':dom.getElementsByTagName("hosts")[0].getAttributeNode('total').value} 300 | } 301 | 302 | # if there was an error 303 | if len(nmap_err_keep_trace)>0: 304 | scan_result['nmap']['scaninfo']['error'] = nmap_err_keep_trace 305 | 306 | # info about scan 307 | for dsci in dom.getElementsByTagName('scaninfo'): 308 | scan_result['nmap']['scaninfo'][dsci.getAttributeNode('protocol').value] = { 309 | 'method': dsci.getAttributeNode('type').value, 310 | 'services': dsci.getAttributeNode('services').value 311 | } 312 | 313 | 314 | scan_result['scan'] = {} 315 | 316 | for dhost in dom.getElementsByTagName('host'): 317 | # host ip 318 | host = dhost.getElementsByTagName('address')[0].getAttributeNode('addr').value 319 | hostname = '' 320 | for dhostname in dhost.getElementsByTagName('hostname'): 321 | hostname = dhostname.getAttributeNode('name').value 322 | scan_result['scan'][host] = PortScannerHostDict({'hostname': hostname}) 323 | for dstatus in dhost.getElementsByTagName('status'): 324 | # status : up... 325 | scan_result['scan'][host]['status'] = {'state': dstatus.getAttributeNode('state').value, 326 | 'reason': dstatus.getAttributeNode('reason').value} 327 | for dstatus in dhost.getElementsByTagName('uptime'): 328 | # uptime : seconds, lastboot 329 | scan_result['scan'][host]['uptime'] = {'seconds': dstatus.getAttributeNode('seconds').value, 330 | 'lastboot': dstatus.getAttributeNode('lastboot').value} 331 | for dport in dhost.getElementsByTagName('port'): 332 | # protocol 333 | proto = dport.getAttributeNode('protocol').value 334 | # port number converted as integer 335 | port = int(dport.getAttributeNode('portid').value) 336 | # state of the port 337 | state = dport.getElementsByTagName('state')[0].getAttributeNode('state').value 338 | # reason 339 | reason = dport.getElementsByTagName('state')[0].getAttributeNode('reason').value 340 | # name, product, version, extra info and conf if any 341 | name,product,version,extrainfo,conf = '','','','','' 342 | for dname in dport.getElementsByTagName('service'): 343 | name = dname.getAttributeNode('name').value 344 | if dname.hasAttribute('product'): 345 | product = dname.getAttributeNode('product').value 346 | if dname.hasAttribute('version'): 347 | version = dname.getAttributeNode('version').value 348 | if dname.hasAttribute('extrainfo'): 349 | extrainfo = dname.getAttributeNode('extrainfo').value 350 | if dname.hasAttribute('conf'): 351 | conf = dname.getAttributeNode('conf').value 352 | # store everything 353 | if not proto in list(scan_result['scan'][host].keys()): 354 | scan_result['scan'][host][proto] = {} 355 | scan_result['scan'][host][proto][port] = {'state': state, 356 | 'reason': reason, 357 | 'name': name, 358 | 'product': product, 359 | 'version': version, 360 | 'extrainfo': extrainfo, 361 | 'conf': conf} 362 | script_id = '' 363 | script_out = '' 364 | # get script output if any 365 | for dscript in dport.getElementsByTagName('script'): 366 | script_id = dscript.getAttributeNode('id').value 367 | script_out = dscript.getAttributeNode('output').value 368 | if not 'script' in list(scan_result['scan'][host][proto][port].keys()): 369 | scan_result['scan'][host][proto][port]['script'] = {} 370 | 371 | scan_result['scan'][host][proto][port]['script'][script_id] = script_out 372 | 373 | for dport in dhost.getElementsByTagName('osclass'): 374 | # 375 | ostype = '' 376 | vendor = '' 377 | osfamily = '' 378 | osgen = '' 379 | accuracy = '' 380 | try: 381 | ostype = dport.getAttributeNode('type').value 382 | vendor = dport.getAttributeNode('vendor').value 383 | osfamily = dport.getAttributeNode('osfamily').value 384 | osgen = dport.getAttributeNode('osgen').value 385 | accuracy = dport.getAttributeNode('accuracy').value 386 | except AttributeError: 387 | pass 388 | if not 'osclass' in list(scan_result['scan'][host].keys()): 389 | scan_result['scan'][host]['osclass'] = [] 390 | 391 | scan_result['scan'][host]['osclass'].append( 392 | { 393 | 'type': ostype, 394 | 'vendor': vendor, 395 | 'osfamily': osfamily, 396 | 'osgen': osgen, 397 | 'accuracy': accuracy 398 | } 399 | ) 400 | 401 | 402 | 403 | for dport in dhost.getElementsByTagName('osmatch'): 404 | # 405 | name = '' 406 | accuracy = '' 407 | line = '' 408 | try: 409 | name = dport.getAttributeNode('name').value 410 | accuracy = dport.getAttributeNode('accuracy').value 411 | line = dport.getAttributeNode('line').value 412 | except AttributeError: 413 | pass 414 | if not 'osmatch' in list(scan_result['scan'][host].keys()): 415 | scan_result['scan'][host]['osmatch'] = [] 416 | 417 | scan_result['scan'][host]['osmatch'].append( 418 | { 419 | 'name': name, 420 | 'accuracy': accuracy, 421 | 'line': line, 422 | } 423 | ) 424 | 425 | 426 | for dport in dhost.getElementsByTagName('osfingerprint'): 427 | # 428 | fingerprint = '' 429 | try: 430 | fingerprint = dport.getAttributeNode('fingerprint').value 431 | except AttributeError: 432 | pass 433 | 434 | scan_result['scan'][host]['fingerprint'] = fingerprint 435 | 436 | 437 | 438 | self._scan_result = scan_result # store for later use 439 | return scan_result 440 | 441 | 442 | 443 | def __getitem__(self, host): 444 | """ 445 | returns a host detail 446 | """ 447 | if sys.version_info[0]==2: 448 | assert type(host) in (str, unicode), 'Wrong type for [host], should be a string [was {0}]'.format(type(host)) 449 | else: 450 | assert type(host) is str, 'Wrong type for [host], should be a string [was {0}]'.format(type(host)) 451 | return self._scan_result['scan'][host] 452 | 453 | 454 | def all_hosts(self): 455 | """ 456 | returns a sorted list of all hosts 457 | """ 458 | if not 'scan' in list(self._scan_result.keys()): 459 | return [] 460 | listh = list(self._scan_result['scan'].keys()) 461 | listh.sort() 462 | return listh 463 | 464 | 465 | def command_line(self): 466 | """ 467 | returns command line used for the scan 468 | 469 | may raise AssertionError exception if called before scanning 470 | """ 471 | assert 'nmap' in self._scan_result, 'Do a scan before trying to get result !' 472 | assert 'command_line' in self._scan_result['nmap'], 'Do a scan before trying to get result !' 473 | 474 | return self._scan_result['nmap']['command_line'] 475 | 476 | 477 | def scaninfo(self): 478 | """ 479 | returns scaninfo structure 480 | {'tcp': {'services': '22', 'method': 'connect'}} 481 | 482 | may raise AssertionError exception if called before scanning 483 | """ 484 | assert 'nmap' in self._scan_result, 'Do a scan before trying to get result !' 485 | assert 'scaninfo' in self._scan_result['nmap'], 'Do a scan before trying to get result !' 486 | 487 | return self._scan_result['nmap']['scaninfo'] 488 | 489 | 490 | def scanstats(self): 491 | """ 492 | returns scanstats structure 493 | {'uphosts': '3', 'timestr': 'Thu Jun 3 21:45:07 2010', 'downhosts': '253', 'totalhosts': '256', 'elapsed': '5.79'} 494 | 495 | may raise AssertionError exception if called before scanning 496 | """ 497 | assert 'nmap' in self._scan_result, 'Do a scan before trying to get result !' 498 | assert 'scanstats' in self._scan_result['nmap'], 'Do a scan before trying to get result !' 499 | 500 | return self._scan_result['nmap']['scanstats'] 501 | 502 | 503 | def has_host(self, host): 504 | """ 505 | returns True if host has result, False otherwise 506 | """ 507 | assert type(host) is str, 'Wrong type for [host], should be a string [was {0}]'.format(type(host)) 508 | assert 'scan' in self._scan_result, 'Do a scan before trying to get result !' 509 | 510 | if host in list(self._scan_result['scan'].keys()): 511 | return True 512 | 513 | return False 514 | 515 | 516 | 517 | 518 | ############################################################################ 519 | 520 | 521 | class PortScannerAsync(object): 522 | """ 523 | PortScannerAsync allows to use nmap from python asynchronously 524 | for each host scanned, callback is called with scan result for the host 525 | """ 526 | 527 | def __init__(self): 528 | """ 529 | Initialize the module 530 | detects nmap on the system and nmap version 531 | may raise PortScannerError exception if nmap is not found in the path 532 | """ 533 | self._process = None 534 | self._nm = PortScanner() 535 | return 536 | 537 | 538 | def __del__(self): 539 | """ 540 | Cleanup when deleted 541 | """ 542 | if self._process is not None and self._process.is_alive(): 543 | self._process.terminate() 544 | return 545 | 546 | 547 | def scan(self, hosts='127.0.0.1', ports=None, arguments='-sV', callback=None): 548 | """ 549 | Scan given hosts in a separate process and return host by host result using callback function 550 | 551 | PortScannerError exception from standard nmap is catched and you won't know about it 552 | 553 | hosts = string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20' 554 | ports = string for ports as nmap use it '22,53,110,143-4564' 555 | arguments = string of arguments for nmap '-sU -sX -sC' 556 | callback = callback function which takes (host, scan_data) as arguments 557 | """ 558 | 559 | assert type(hosts) is str, 'Wrong type for [hosts], should be a string [was {0}]'.format(type(hosts)) 560 | assert type(ports) in (str, type(None)), 'Wrong type for [ports], should be a string [was {0}]'.format(type(ports)) 561 | assert type(arguments) is str, 'Wrong type for [arguments], should be a string [was {0}]'.format(type(arguments)) 562 | assert type(callback) in (types.FunctionType, type(None)), 'Wrong type for [callback], should be a function or None [was {0}]'.format(type(callback)) 563 | 564 | def scan_progressive(self, hosts, ports, arguments, callback): 565 | for host in self._nm.listscan(hosts): 566 | try: 567 | scan_data = self._nm.scan(host, ports, arguments) 568 | except PortScannerError: 569 | pass 570 | if callback is not None and isinstance(callback, collections.Callable): 571 | callback(host, scan_data) 572 | return 573 | 574 | self._process = Process( 575 | target=scan_progressive, 576 | args=(self, hosts, ports, arguments, callback) 577 | ) 578 | self._process.daemon = True 579 | self._process.start() 580 | return 581 | 582 | 583 | def stop(self): 584 | """ 585 | Stop the current scan process 586 | """ 587 | if self._process is not None: 588 | self._process.terminate() 589 | return 590 | 591 | 592 | def wait(self, timeout=None): 593 | """ 594 | Wait for the current scan process to finish, or timeout 595 | """ 596 | 597 | assert type(timeout) in (int, type(None)), 'Wrong type for [timeout], should be an int or None [was {0}]'.format(type(timeout)) 598 | 599 | self._process.join(timeout) 600 | return 601 | 602 | 603 | 604 | def still_scanning(self): 605 | """ 606 | Return True if a scan is currently running, False otherwise 607 | """ 608 | try: 609 | return self._process.is_alive() 610 | except: 611 | return False 612 | 613 | 614 | 615 | ############################################################################ 616 | 617 | 618 | 619 | class PortScannerHostDict(dict): 620 | """ 621 | Special dictionnary class for storing and accessing host scan result 622 | """ 623 | def hostname(self): 624 | """ 625 | returns hostname 626 | """ 627 | return self['hostname'] 628 | 629 | def state(self): 630 | """ 631 | returns host state 632 | """ 633 | return self['status']['state'] 634 | 635 | def uptime(self): 636 | """ 637 | returns host state 638 | """ 639 | return self['uptime'] 640 | 641 | def all_protocols(self): 642 | """ 643 | returns a list of all scanned protocols 644 | """ 645 | lp = list(self.keys()) 646 | lp.remove('status') 647 | lp.remove('hostname') 648 | lp.sort() 649 | return lp 650 | 651 | 652 | 653 | def all_tcp(self): 654 | """ 655 | returns list of tcp ports 656 | """ 657 | if 'tcp' in list(self.keys()): 658 | ltcp = list(self['tcp'].keys()) 659 | ltcp.sort() 660 | return ltcp 661 | return [] 662 | 663 | 664 | def has_tcp(self, port): 665 | """ 666 | returns True if tcp port has info, False otherwise 667 | """ 668 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 669 | 670 | if ('tcp' in list(self.keys()) 671 | and port in list(self['tcp'].keys())): 672 | return True 673 | return False 674 | 675 | 676 | def tcp(self, port): 677 | """ 678 | returns info for tpc port 679 | """ 680 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 681 | return self['tcp'][port] 682 | 683 | 684 | def all_udp(self): 685 | """ 686 | returns list of udp ports 687 | """ 688 | if 'udp' in list(self.keys()): 689 | ludp = list(self['udp'].keys()) 690 | ludp.sort() 691 | return ludp 692 | return [] 693 | 694 | 695 | def has_udp(self, port): 696 | """ 697 | returns True if udp port has info, False otherwise 698 | """ 699 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 700 | 701 | if ('udp' in list(self.keys()) 702 | and 'port' in list(self['udp'].keys())): 703 | return True 704 | return False 705 | 706 | 707 | def udp(self, port): 708 | """ 709 | returns info for udp port 710 | """ 711 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 712 | 713 | return self['udp'][port] 714 | 715 | 716 | def all_ip(self): 717 | """ 718 | returns list of ip ports 719 | """ 720 | if 'ip' in list(self.keys()): 721 | lip = list(self['ip'].keys()) 722 | lip.sort() 723 | return lip 724 | return [] 725 | 726 | 727 | def has_ip(self, port): 728 | """ 729 | returns True if ip port has info, False otherwise 730 | """ 731 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 732 | 733 | if ('ip' in list(self.keys()) 734 | and port in list(self['ip'].keys())): 735 | return True 736 | return False 737 | 738 | 739 | def ip(self, port): 740 | """ 741 | returns info for ip port 742 | """ 743 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 744 | 745 | return self['ip'][port] 746 | 747 | 748 | def all_sctp(self): 749 | """ 750 | returns list of sctp ports 751 | """ 752 | if 'sctp' in list(self.keys()): 753 | lsctp = list(self['sctp'].keys()) 754 | lsctp.sort() 755 | return lsctp 756 | return [] 757 | 758 | 759 | def has_sctp(self, port): 760 | """ 761 | returns True if sctp port has info, False otherwise 762 | """ 763 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 764 | 765 | if ('sctp' in list(self.keys()) 766 | and port in list(self['sctp'].keys())): 767 | return True 768 | return False 769 | 770 | 771 | def sctp(self, port): 772 | """ 773 | returns info for sctp port 774 | """ 775 | assert type(port) is int, 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) 776 | 777 | return self['sctp'][port] 778 | 779 | 780 | 781 | ############################################################################ 782 | 783 | 784 | class PortScannerError(Exception): 785 | """ 786 | Exception error class for PortScanner class 787 | """ 788 | def __init__(self, value): 789 | self.value = value 790 | 791 | 792 | def __str__(self): 793 | return repr(self.value) 794 | 795 | 796 | ############################################################################ 797 | 798 | def __get_last_online_version(): 799 | """ 800 | Gets last python-nmap published version 801 | WARNING : it does an http connection to http://xael.org/norman/python/python-nmap/python-nmap_CURRENT_VERSION.txt 802 | 803 | returns a string '0.2.3' 804 | """ 805 | import http.client 806 | conn = http.client.HTTPConnection("xael.org") 807 | conn.request("GET", "/norman/python/python-nmap/python-nmap_CURRENT_VERSION.txt") 808 | online_version = bytes.decode(conn.getresponse().read()).strip() 809 | return online_version 810 | 811 | 812 | ############################################################################ 813 | 814 | 815 | # MAIN ------------------- 816 | if __name__ == '__main__': 817 | import doctest 818 | # non regression test 819 | doctest.testmod() 820 | 821 | 822 | ####################################################################### 823 | 824 | -------------------------------------------------------------------------------- /nmap.html: -------------------------------------------------------------------------------- 1 | 2 | Python: module nmap 3 | 4 | 5 | 6 | 7 | 8 |
 
9 |  
nmap (version 0.2.4)		index
/home/xael/ESPACE_KM/python/python-nmap/nmap/nmap.py
12 |

nmap.py - version and date, see below
13 |  
14 | Author : Alexandre Norman - norman at xael.org
15 | Contributors: Steve 'Ashcrow' Milner - steve at gnulinux.net
16 |               Brian Bustin - brian at bustin.us
17 | Licence : GPL v3 or any later version
18 |  
19 |  
20 | This program is free software: you can redistribute it and/or modify
21 | it under the terms of the GNU General Public License as published by
22 | the Free Software Foundation, either version 3 of the License, or
23 | any later version.
24 |  
25 | This program is distributed in the hope that it will be useful,
26 | but WITHOUT ANY WARRANTY; without even the implied warranty of
27 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28 | GNU General Public License for more details.
29 |  
30 | You should have received a copy of the GNU General Public License
31 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
32 |  
33 |  
34 | Test strings :
35 | ^^^^^^^^^^^^
36 | >>> import nmap
37 | >>> if __get_last_online_version() != __version__:
38 | ...     raise ValueError('Current version is {0} - Last published version is {1}'.format(__version__, __get_last_online_version()))
39 | >>> nm = nmap.PortScanner()
40 | >>> try:
41 | ...     nm.scan(arguments='-wrongargs')
42 | ... except nmap.PortScannerError:
43 | ...     pass
44 | >>> r=nm.scan('127.0.0.1', '22-443')
45 | >>> nm.command_line()
46 | 'nmap -oX - -p 22-443 -sV 127.0.0.1'
47 | >>> nm.scaninfo()
48 | {'tcp': {'services': '22-443', 'method': 'connect'}}
49 | >>> nm.all_hosts()
50 | ['127.0.0.1']
51 | >>> nm['127.0.0.1'].hostname()
52 | 'localhost.localdomain'
53 | >>> nm['127.0.0.1'].state()
54 | 'up'
55 | >>> nm['127.0.0.1'].all_protocols()
56 | ['tcp']
57 | >>> nm['127.0.0.1']['tcp'].keys()
58 | dict_keys([80, 25, 443, 22, 111])
59 | >>> nm['127.0.0.1'].has_tcp(22)
60 | True
61 | >>> nm['127.0.0.1'].has_tcp(23)
62 | False
63 | >>> nm['127.0.0.1']['tcp'][22]
64 | {'state': 'open', 'reason': 'syn-ack', 'name': 'ssh'}
65 | >>> nm['127.0.0.1'].tcp(22)
66 | {'state': 'open', 'reason': 'syn-ack', 'name': 'ssh'}
67 | >>> nm['127.0.0.1']['tcp'][22]['state']
68 | 'open'
69 | >>> nm.scanstats()['uphosts']
70 | '1'
71 | >>> nm.scanstats()['downhosts']
72 | '0'
73 | >>> nm.scanstats()['totalhosts']
74 | '1'
75 | >>> 'timestr' in nm.scanstats().keys()
76 | True
77 | >>> 'elapsed' in nm.scanstats().keys()
78 | True
79 | >>> nm.listscan('192.168.1.0/30')
80 | ['192.168.1.0', '192.168.1.1', '192.168.1.2', '192.168.1.3']
81 | >>> nm.listscan('localhost/30')
82 | ['127.0.0.0', '127.0.0.1', '127.0.0.2', '127.0.0.3']
83 | >>> r=nm.scan('127.0.0.1', arguments='-O')
84 | >>> nm['127.0.0.1']['osclass']
85 | [{'vendor': u'Linux', 'osfamily': u'Linux', 'type': u'general purpose', 'osgen': u'2.6.X', 'accuracy': u'98'}, {'vendor': u'Netgear', 'osfamily': u'embedded', 'type': u'WAP', 'osgen': '', 'accuracy': ''}, {'vendor': u'Gemtek', 'osfamily': u'embedded', 'type': u'WAP', 'osgen': '', 'accuracy': ''}, {'vendor': u'Siemens', 'osfamily': u'embedded', 'type': u'WAP', 'osgen': '', 'accuracy': ''}, {'vendor': u'Linux', 'osfamily': u'Linux', 'type': u'general purpose', 'osgen': u'2.4.X', 'accuracy': u'90'}, {'vendor': u'Linksys', 'osfamily': u'embedded', 'type': u'WAP', 'osgen': '', 'accuracy': ''}, {'vendor': u'Linux', 'osfamily': u'Linux', 'type': u'WAP', 'osgen': u'2.4.X', 'accuracy': u'90'}, {'vendor': u'Nokia', 'osfamily': u'Linux', 'type': u'general purpose', 'osgen': u'2.6.X', 'accuracy': u'89'}]
86 | >>> nm['127.0.0.1']['fingerprint']
87 | 'OS:SCAN(V=5.50%D=11/9%OT=22%CT=1%CU=37937%PV=N%DS=0%DC=L%G=Y%TM=4EBAE79D%P=\nOS:i686-pc-linux-gnu)SEQ(SP=103%GCD=1%ISR=10D%TI=Z%CI=Z%II=I%TS=8)OPS(O1=M4\nOS:00CST11NW6%O2=M400CST11NW6%O3=M400CNNT11NW6%O4=M400CST11NW6%O5=M400CST11\nOS:NW6%O6=M400CST11)WIN(W1=8000%W2=8000%W3=8000%W4=8000%W5=8000%W6=8000)ECN\nOS:(R=Y%DF=Y%T=40%W=8018%O=M400CNNSNW6%CC=Y%Q=)T1(R=Y%DF=Y%T=40%S=O%A=S+%F=\nOS:AS%RD=0%Q=)T2(R=N)T3(R=Y%DF=Y%T=40%W=8000%S=O%A=S+%F=AS%O=M400CST11NW6%R\nOS:D=0%Q=)T4(R=Y%DF=Y%T=40%W=0%S=A%A=Z%F=R%O=%RD=0%Q=)T5(R=Y%DF=Y%T=40%W=0%\nOS:S=Z%A=S+%F=AR%O=%RD=0%Q=)T6(R=Y%DF=Y%T=40%W=0%S=A%A=Z%F=R%O=%RD=0%Q=)T7(\nOS:R=Y%DF=Y%T=40%W=0%S=Z%A=S+%F=AR%O=%RD=0%Q=)U1(R=Y%DF=N%T=40%IPL=164%UN=0\nOS:%RIPL=G%RID=G%RIPCK=G%RUCK=G%RUD=G)IE(R=Y%DFI=N%T=40%CD=S)\n'

88 |

89 | 90 | 91 | 93 | 94 | 95 |
 
92 | Modules
       
collections
96 | os
97 | re
98 | 		shlex
99 | string
100 | subprocess
101 | 		sys
102 | types
103 | xml
104 |

105 | 106 | 107 | 109 | 110 | 111 |
 
108 | Classes
       
112 |
builtins.Exception(builtins.BaseException) 113 |
114 |
115 |
PortScannerError 116 |
117 |
118 |
builtins.dict(builtins.object) 119 |
120 |
121 |
PortScannerHostDict 122 |
123 |
124 |
builtins.object 125 |
126 |
127 |
PortScanner 128 |
PortScannerAsync 129 |
130 |
131 |
132 |

133 | 134 | 135 | 137 | 138 | 139 | 140 | 141 |
 
136 | class PortScanner(builtins.object)
   PortScanner allows to use nmap from python
 
 Methods defined here:
142 |
__getitem__(self, host)
returns a host detail
143 | 144 |
__init__(self, nmap_search_path=('nmap', '/usr/bin/nmap', '/usr/local/bin/nmap', '/sw/bin/nmap', '/opt/local/bin/nmap'))
Initialize the module
145 | detects nmap on the system and nmap version
146 | may raise PortScannerError exception if nmap is not found in the path
147 |  
148 | nmap_search_path = tupple of string where to search for nmap executable. Change this if you want to use a specific version of nmap.
149 | 150 |
all_hosts(self)
returns a sorted list of all hosts
151 | 152 |
command_line(self)
returns command line used for the scan
153 |  
154 | may raise AssertionError exception if called before scanning
155 | 156 |
get_nmap_last_output(self)
returns the last text output of nmap in raw text
157 | this may be used for debugging purpose
158 | 159 |
has_host(self, host)
returns True if host has result, False otherwise
160 | 161 |
listscan(self, hosts='127.0.0.1')
do not scan but interpret target hosts and return a list a hosts
162 | 163 |
nmap_version(self)
returns nmap version if detected (int version, int subversion)
164 | or (0, 0) if unknown
165 | 166 |
scan(self, hosts='127.0.0.1', ports=None, arguments='-sV')
Scan given hosts
167 |  
168 | May raise PortScannerError exception if nmap output something on stderr
169 |  
170 | hosts = string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20'
171 | ports = string for ports as nmap use it '22,53,110,143-4564'
172 | arguments = string of arguments for nmap '-sU -sX -sC'
173 | 174 |
scaninfo(self)
returns scaninfo structure
175 | {'tcp': {'services': '22', 'method': 'connect'}}
176 |  
177 | may raise AssertionError exception if called before scanning
178 | 179 |
scanstats(self)
returns scanstats structure
180 | {'uphosts': '3', 'timestr': 'Thu Jun  3 21:45:07 2010', 'downhosts': '253', 'totalhosts': '256', 'elapsed': '5.79'}
181 |  
182 | may raise AssertionError exception if called before scanning
183 | 184 |
185 | Data descriptors defined here:
186 |
__dict__
187 |
dictionary for instance variables (if defined)
188 |
189 |
__weakref__
190 |
list of weak references to the object (if defined)
191 |
192 |

193 | 194 | 195 | 197 | 198 | 199 | 201 | 202 |
 
196 | class PortScannerAsync(builtins.object)
   PortScannerAsync allows to use nmap from python asynchronously
200 | for each host scanned, callback is called with scan result for the host
 
 Methods defined here:
203 |
__del__(self)
Cleanup when deleted
204 | 205 |
__init__(self)
Initialize the module
206 | detects nmap on the system and nmap version
207 | may raise PortScannerError exception if nmap is not found in the path
208 | 209 |
scan(self, hosts='127.0.0.1', ports=None, arguments='-sV', callback=None)
Scan given hosts in a separate process and return host by host result using callback function
210 |  
211 | PortScannerError exception from standard nmap is catched and you won't know about it
212 |  
213 | hosts = string for hosts as nmap use it 'scanme.nmap.org' or '198.116.0-255.1-127' or '216.163.128.20/20'
214 | ports = string for ports as nmap use it '22,53,110,143-4564'
215 | arguments = string of arguments for nmap '-sU -sX -sC'
216 | callback = callback function which takes (host, scan_data) as arguments
217 | 218 |
still_scanning(self)
Return True if a scan is currently running, False otherwise
219 | 220 |
stop(self)
Stop the current scan process
221 | 222 |
wait(self, timeout=None)
Wait for the current scan process to finish, or timeout
223 | 224 |
225 | Data descriptors defined here:
226 |
__dict__
227 |
dictionary for instance variables (if defined)
228 |
229 |
__weakref__
230 |
list of weak references to the object (if defined)
231 |
232 |

233 | 234 | 235 | 237 | 238 | 239 | 240 | 241 |
 
236 | class PortScannerError(builtins.Exception)
   Exception error class for PortScanner class
 
 
Method resolution order:
242 |
PortScannerError
243 |
builtins.Exception
244 |
builtins.BaseException
245 |
builtins.object
246 |
247 |
248 | Methods defined here:
249 |
__init__(self, value)
250 | 251 |
__str__(self)
252 | 253 |
254 | Data descriptors defined here:
255 |
__weakref__
256 |
list of weak references to the object (if defined)
257 |
258 |
259 | Data and other attributes inherited from builtins.Exception:
260 |
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
261 | 262 |
263 | Methods inherited from builtins.BaseException:
264 |
__delattr__(...)
x.__delattr__('name') <==> del x.name
265 | 266 |
__getattribute__(...)
x.__getattribute__('name') <==> x.name
267 | 268 |
__reduce__(...)
269 | 270 |
__repr__(...)
x.__repr__() <==> repr(x)
271 | 272 |
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
273 | 274 |
__setstate__(...)
275 | 276 |
with_traceback(...)
Exception.with_traceback(tb) --
277 | set self.__traceback__ to tb and return self.
278 | 279 |
280 | Data descriptors inherited from builtins.BaseException:
281 |
__cause__
282 |
exception cause
283 |
284 |
__context__
285 |
exception context
286 |
287 |
__dict__
288 |
289 |
__traceback__
290 |
291 |
args
292 |
293 |

294 | 295 | 296 | 298 | 299 | 300 | 301 | 302 |
 
297 | class PortScannerHostDict(builtins.dict)
   Special dictionnary class for storing and accessing host scan result
 
 
Method resolution order:
303 |
PortScannerHostDict
304 |
builtins.dict
305 |
builtins.object
306 |
307 |
308 | Methods defined here:
309 |
all_ip(self)
returns list of ip ports
310 | 311 |
all_protocols(self)
returns a list of all scanned protocols
312 | 313 |
all_sctp(self)
returns list of sctp ports
314 | 315 |
all_tcp(self)
returns list of tcp ports
316 | 317 |
all_udp(self)
returns list of udp ports
318 | 319 |
has_ip(self, port)
returns True if ip port has info, False otherwise
320 | 321 |
has_sctp(self, port)
returns True if sctp port has info, False otherwise
322 | 323 |
has_tcp(self, port)
returns True if tcp port has info, False otherwise
324 | 325 |
has_udp(self, port)
returns True if udp port has info, False otherwise
326 | 327 |
hostname(self)
returns hostname
328 | 329 |
ip(self, port)
returns info for ip port
330 | 331 |
sctp(self, port)
returns info for sctp port
332 | 333 |
state(self)
returns host state
334 | 335 |
tcp(self, port)
returns info for tpc port
336 | 337 |
udp(self, port)
returns info for udp port
338 | 339 |
340 | Data descriptors defined here:
341 |
__dict__
342 |
dictionary for instance variables (if defined)
343 |
344 |
__weakref__
345 |
list of weak references to the object (if defined)
346 |
347 |
348 | Methods inherited from builtins.dict:
349 |
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
350 | 351 |
__delitem__(...)
x.__delitem__(y) <==> del x[y]
352 | 353 |
__eq__(...)
x.__eq__(y) <==> x==y
354 | 355 |
__ge__(...)
x.__ge__(y) <==> x>=y
356 | 357 |
__getattribute__(...)
x.__getattribute__('name') <==> x.name
358 | 359 |
__getitem__(...)
x.__getitem__(y) <==> x[y]
360 | 361 |
__gt__(...)
x.__gt__(y) <==> x>y
362 | 363 |
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
364 | 365 |
__iter__(...)
x.__iter__() <==> iter(x)
366 | 367 |
__le__(...)
x.__le__(y) <==> x<=y
368 | 369 |
__len__(...)
x.__len__() <==> len(x)
370 | 371 |
__lt__(...)
x.__lt__(y) <==> x<y
372 | 373 |
__ne__(...)
x.__ne__(y) <==> x!=y
374 | 375 |
__repr__(...)
x.__repr__() <==> repr(x)
376 | 377 |
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
378 | 379 |
__sizeof__(...)
D.__sizeof__() -> size of D in memory, in bytes
380 | 381 |
clear(...)
D.clear() -> None.  Remove all items from D.
382 | 383 |
copy(...)
D.copy() -> a shallow copy of D
384 | 385 |
fromkeys(...)
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
386 | v defaults to None.
387 | 388 |
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
389 | 390 |
items(...)
D.items() -> a set-like object providing a view on D's items
391 | 392 |
keys(...)
D.keys() -> a set-like object providing a view on D's keys
393 | 394 |
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
395 | If key is not found, d is returned if given, otherwise KeyError is raised
396 | 397 |
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
398 | 2-tuple; but raise KeyError if D is empty.
399 | 400 |
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
401 | 402 |
update(...)
D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
403 | If E present and has a .keys() method, does:     for k in E: D[k] = E[k]
404 | If E present and lacks .keys() method, does:     for (k, v) in E: D[k] = v
405 | In either case, this is followed by: for k in F: D[k] = F[k]
406 | 407 |
values(...)
D.values() -> an object providing a view on D's values
408 | 409 |
410 | Data and other attributes inherited from builtins.dict:
411 |
__hash__ = None
412 | 413 |
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
414 | 415 |

416 | 417 | 418 | 420 | 421 | 422 |
 
419 | Data
       __last_modification__ = '2011.11.09'

423 | 424 | 425 | 427 | 428 | 429 |
 
426 | Author
       Alexandre Norman (norman@xael.org)
430 | -------------------------------------------------------------------------------- /gpl-3.0.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------