1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-09 06:01:28 +00:00
Files
nmap/zenmap/zenmapCore/NSEDocParser.py

157 lines
8.9 KiB
Python

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# ***********************IMPORTANT NMAP LICENSE TERMS************************
# * *
# * The Nmap Security Scanner is (C) 1996-2012 Insecure.Com LLC. Nmap is *
# * also a registered trademark of Insecure.Com LLC. This program is free *
# * software; you may redistribute and/or modify it under the terms of the *
# * GNU General Public License as published by the Free Software *
# * Foundation; Version 2 with the clarifications and exceptions described *
# * below. This guarantees your right to use, modify, and redistribute *
# * this software under certain conditions. If you wish to embed Nmap *
# * technology into proprietary software, we sell alternative licenses *
# * (contact sales@insecure.com). Dozens of software vendors already *
# * license Nmap technology such as host discovery, port scanning, OS *
# * detection, version detection, and the Nmap Scripting Engine. *
# * *
# * Note that the GPL places important restrictions on "derived works", yet *
# * it does not provide a detailed definition of that term. To avoid *
# * misunderstandings, we interpret that term as broadly as copyright law *
# * allows. For example, we consider an application to constitute a *
# * "derivative work" for the purpose of this license if it does any of the *
# * following: *
# * o Integrates source code from Nmap *
# * o Reads or includes Nmap copyrighted data files, such as *
# * nmap-os-db or nmap-service-probes. *
# * o Executes Nmap and parses the results (as opposed to typical shell or *
# * execution-menu apps, which simply display raw Nmap output and so are *
# * not derivative works.) *
# * o Integrates/includes/aggregates Nmap into a proprietary executable *
# * installer, such as those produced by InstallShield. *
# * o Links to a library or executes a program that does any of the above *
# * *
# * The term "Nmap" should be taken to also include any portions or derived *
# * works of Nmap, as well as other software we distribute under this *
# * license such as Zenmap, Ncat, and Nping. This list is not exclusive, *
# * but is meant to clarify our interpretation of derived works with some *
# * common examples. Our interpretation applies only to Nmap--we don't *
# * speak for other people's GPL works. *
# * *
# * If you have any questions about the GPL licensing restrictions on using *
# * Nmap in non-GPL works, we would be happy to help. As mentioned above, *
# * we also offer alternative license to integrate Nmap into proprietary *
# * applications and appliances. These contracts have been sold to dozens *
# * of software vendors, and generally include a perpetual license as well *
# * as providing for priority support and updates. They also fund the *
# * continued development of Nmap. Please email sales@insecure.com for *
# * further information. *
# * *
# * As a special exception to the GPL terms, Insecure.Com LLC grants *
# * permission to link the code of this program with any version of the *
# * OpenSSL library which is distributed under a license identical to that *
# * listed in the included docs/licenses/OpenSSL.txt file, and distribute *
# * linked combinations including the two. You must obey the GNU GPL in all *
# * respects for all of the code used other than OpenSSL. If you modify *
# * this file, you may extend this exception to your version of the file, *
# * but you are not obligated to do so. *
# * *
# * If you received these files with a written license agreement or *
# * contract stating terms other than the terms above, then that *
# * alternative license agreement takes precedence over these comments. *
# * *
# * Source is provided to this software because we believe users have a *
# * right to know exactly what a program is going to do before they run it. *
# * This also allows you to audit the software for security holes (none *
# * have been found so far). *
# * *
# * Source code also allows you to port Nmap to new platforms, fix bugs, *
# * and add new features. You are highly encouraged to send your changes *
# * to nmap-dev@insecure.org for possible incorporation into the main *
# * distribution. By sending these changes to Fyodor or one of the *
# * Insecure.Org development mailing lists, or checking them into the Nmap *
# * source code repository, it is understood (unless you specify otherwise) *
# * that you are offering the Nmap Project (Insecure.Com LLC) the *
# * unlimited, non-exclusive right to reuse, modify, and relicense the *
# * code. Nmap will always be available Open Source, but this is important *
# * because the inability to relicense code has caused devastating problems *
# * for other Free Software projects (such as KDE and NASM). We also *
# * occasionally relicense the code to third parties as discussed above. *
# * If you wish to specify special license conditions of your *
# * contributions, just say so when you send them. *
# * *
# * This program is distributed in the hope that it will be useful, but *
# * WITHOUT ANY WARRANTY; without even the implied warranty of *
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
# * General Public License v2.0 for more details at *
# * http://www.gnu.org/licenses/gpl-2.0.html , or in the COPYING file *
# * included with Nmap. *
# * *
# ***************************************************************************/
import re
class NSEDocEvent (object):
def __init__(self, type, text = None):
self.type = type
self.text = text
def nsedoc_parse_sub(text, pos):
"""Parse paragraph-level NSEDoc markup, inside of paragraphs and lists.
Returns the position after the end of parsing followed by a list of
events."""
events = []
m = re.match(r'([^\n]*?)<code>(.*?)</code>', text[pos:], re.S)
if m:
if m.group(1):
events.append(NSEDocEvent("text", m.group(1).replace("\n", " ")))
events.append(NSEDocEvent("code", m.group(2)))
return pos + m.end(), events
m = re.match(r'[^\n]*(\n|$)', text[pos:])
if m:
if m.group():
events.append(NSEDocEvent("text", m.group().replace("\n", " ")))
return pos + m.end(), events
return pos, events
def nsedoc_parse(text):
"""Parse text marked up for NSEDoc. This is a generator that returns a
sequence of NSEDocEvents. The type of the event may be "paragraph_start",
"paragraph_end", "list_start", "list_end", "list_item_start",
"list_item_end", "text", or "code". The types "text" and "code" have a text
member with the text that they contain."""
i = 0
j = 0
in_list = False
while i < len(text):
while i < len(text) and text[i].isspace():
i += 1
if i >= len(text):
break
yield NSEDocEvent("paragraph_start")
while i < len(text):
if re.match(r'\s*(\n|$)', text[i:]):
break
if text.startswith("* ", i):
if not in_list:
yield NSEDocEvent("list_start")
in_list = True
i += 2
yield NSEDocEvent("list_item_start")
i, events = nsedoc_parse_sub(text, i)
for event in events:
yield event
yield NSEDocEvent("list_item_end")
else:
if in_list:
yield NSEDocEvent("list_end")
in_list = False
i, events = nsedoc_parse_sub(text, i)
for event in events:
yield event
if in_list:
yield NSEDocEvent("list_end")
in_list = False
yield NSEDocEvent("paragraph_end")