From dd0ace6d4a20a9fd481450197d3a86e634d9dbe4 Mon Sep 17 00:00:00 2001 From: dmiller Date: Thu, 16 Jan 2020 19:12:57 +0000 Subject: [PATCH] Split string pool functions into separate file from osscan.cc --- FPEngine.cc | 1 + Makefile.in | 6 +- osscan.cc | 79 +------------------ osscan.h | 6 -- osscan2.cc | 1 + string_pool.cc | 208 +++++++++++++++++++++++++++++++++++++++++++++++++ string_pool.h | 153 ++++++++++++++++++++++++++++++++++++ 7 files changed, 367 insertions(+), 87 deletions(-) create mode 100644 string_pool.cc create mode 100644 string_pool.h diff --git a/FPEngine.cc b/FPEngine.cc index b7f885fea..2b0e29d5c 100644 --- a/FPEngine.cc +++ b/FPEngine.cc @@ -140,6 +140,7 @@ #include "linear.h" #include "FPModel.h" #include "tcpip.h" +#include "string_pool.h" extern NmapOps o; #ifdef WIN32 /* Need DnetName2PcapName */ diff --git a/Makefile.in b/Makefile.in index 7ac5ae509..18800cac5 100644 --- a/Makefile.in +++ b/Makefile.in @@ -109,11 +109,11 @@ NSE_OBJS+=nse_zlib.o endif endif -export SRCS = charpool.cc FingerPrintResults.cc FPEngine.cc FPModel.cc idle_scan.cc MACLookup.cc main.cc nmap.cc nmap_dns.cc nmap_error.cc nmap_ftp.cc NmapOps.cc NmapOutputTable.cc nmap_tty.cc osscan2.cc osscan.cc output.cc payload.cc portlist.cc portreasons.cc protocols.cc scan_engine.cc scan_engine_connect.cc scan_engine_raw.cc scan_lists.cc service_scan.cc services.cc Target.cc NewTargets.cc TargetGroup.cc targets.cc tcpip.cc timing.cc traceroute.cc utils.cc xml.cc $(NSE_SRC) +export SRCS = charpool.cc FingerPrintResults.cc FPEngine.cc FPModel.cc idle_scan.cc MACLookup.cc main.cc nmap.cc nmap_dns.cc nmap_error.cc nmap_ftp.cc NmapOps.cc NmapOutputTable.cc nmap_tty.cc osscan2.cc osscan.cc output.cc payload.cc portlist.cc portreasons.cc protocols.cc scan_engine.cc scan_engine_connect.cc scan_engine_raw.cc scan_lists.cc service_scan.cc services.cc string_pool.cc Target.cc NewTargets.cc TargetGroup.cc targets.cc tcpip.cc timing.cc traceroute.cc utils.cc xml.cc $(NSE_SRC) -export HDRS = charpool.h FingerPrintResults.h FPEngine.h idle_scan.h MACLookup.h nmap_amigaos.h nmap_dns.h nmap_error.h nmap.h nmap_ftp.h NmapOps.h NmapOutputTable.h nmap_tty.h nmap_winconfig.h osscan2.h osscan.h output.h payload.h portlist.h portreasons.h probespec.h protocols.h scan_engine.h scan_engine_connect.h scan_engine_raw.h service_scan.h scan_lists.h services.h NewTargets.h TargetGroup.h Target.h targets.h tcpip.h timing.h traceroute.h utils.h xml.h $(NSE_HDRS) +export HDRS = charpool.h FingerPrintResults.h FPEngine.h idle_scan.h MACLookup.h nmap_amigaos.h nmap_dns.h nmap_error.h nmap.h nmap_ftp.h NmapOps.h NmapOutputTable.h nmap_tty.h nmap_winconfig.h osscan2.h osscan.h output.h payload.h portlist.h portreasons.h probespec.h protocols.h scan_engine.h scan_engine_connect.h scan_engine_raw.h service_scan.h scan_lists.h services.h string_pool.h NewTargets.h TargetGroup.h Target.h targets.h tcpip.h timing.h traceroute.h utils.h xml.h $(NSE_HDRS) -OBJS = charpool.o FingerPrintResults.o FPEngine.o FPModel.o idle_scan.o MACLookup.o nmap_dns.o nmap_error.o nmap.o nmap_ftp.o NmapOps.o NmapOutputTable.o nmap_tty.o osscan2.o osscan.o output.o payload.o portlist.o portreasons.o protocols.o scan_engine.o scan_engine_connect.o scan_engine_raw.o scan_lists.o service_scan.o services.o NewTargets.o TargetGroup.o Target.o targets.o tcpip.o timing.o traceroute.o utils.o xml.o $(NSE_OBJS) +OBJS = charpool.o FingerPrintResults.o FPEngine.o FPModel.o idle_scan.o MACLookup.o nmap_dns.o nmap_error.o nmap.o nmap_ftp.o NmapOps.o NmapOutputTable.o nmap_tty.o osscan2.o osscan.o output.o payload.o portlist.o portreasons.o protocols.o scan_engine.o scan_engine_connect.o scan_engine_raw.o scan_lists.o service_scan.o services.o string_pool.o NewTargets.o TargetGroup.o Target.o targets.o tcpip.o timing.o traceroute.o utils.o xml.o $(NSE_OBJS) # %.o : %.cc -- nope this is a GNU extension .cc.o: diff --git a/osscan.cc b/osscan.cc index 9f111c9ea..c8ab15757 100644 --- a/osscan.cc +++ b/osscan.cc @@ -136,93 +136,16 @@ #include "charpool.h" #include "FingerPrintResults.h" #include "nmap_error.h" +#include "string_pool.h" #include -#include #include #include #include -#include extern NmapOps o; -/* Store a string uniquely. The first time this function is called with a - certain string, it allocates memory and stores a copy of the string in a - static pool. Thereafter it will return a pointer to the saved string instead - of allocating memory for an identical one. */ -const char *string_pool_insert(const char *s) -{ - static std::set pool; - static std::pair::iterator, bool> pair; - - pair = pool.insert(s); - - return pair.first->c_str(); -} - -const char *string_pool_substr(const char *s, const char *t) -{ - return string_pool_insert(std::string(s, t).c_str()); -} - -const char *string_pool_substr_strip(const char *s, const char *t) { - while (isspace((int) (unsigned char) *s)) - s++; - while (t > s && isspace((int) (unsigned char) *(t - 1))) - t--; - - return string_pool_substr(s, t); -} - -/* Skip over whitespace to find the beginning of a word, then read until the - next whilespace character. Returns NULL if only whitespace is found. */ -static const char *string_pool_strip_word(const char *s) { - const char *t; - - while (isspace((int) (unsigned char) *s)) - s++; - t = s; - while (*t != '\0' && !isspace((int) (unsigned char) *t)) - t++; - - if (s == t) - return NULL; - - return string_pool_substr(s, t); -} - -/* Format a string with sprintf and insert it with string_pool_insert. */ -const char *string_pool_sprintf(const char *fmt, ...) -{ - const char *s; - char *buf; - int size, n; - va_list ap; - - buf = NULL; - size = 32; - /* Loop until we allocate a string big enough for the sprintf. */ - for (;;) { - buf = (char *) realloc(buf, size); - assert(buf != NULL); - va_start(ap, fmt); - n = Vsnprintf(buf, size, fmt, ap); - va_end(ap); - if (n < 0) - size = size * 2; - else if (n >= size) - size = n + 1; - else - break; - } - - s = string_pool_insert(buf); - free(buf); - - return s; -} - FingerPrintDB::FingerPrintDB() : MatchPoints(NULL) { } diff --git a/osscan.h b/osscan.h index d2cb311b2..c57e60e86 100644 --- a/osscan.h +++ b/osscan.h @@ -217,12 +217,6 @@ struct FingerPrintDB { /********************** PROTOTYPES ***********************************/ -/* The OS database consists of many small strings, many of which appear - thousands of times. It pays to allocate memory only once for each unique - string, and have all references point at the one allocated value. */ -const char *string_pool_insert(const char *s); -const char *string_pool_sprintf(const char *fmt, ...); - const char *fp2ascii(FingerPrint *FP); /* Parses a single fingerprint from the memory region given. If a diff --git a/osscan2.cc b/osscan2.cc index aa31feb12..b796830e8 100644 --- a/osscan2.cc +++ b/osscan2.cc @@ -144,6 +144,7 @@ #include #include "struct_ip.h" +#include "string_pool.h" #include #include diff --git a/string_pool.cc b/string_pool.cc new file mode 100644 index 000000000..9d557c9fb --- /dev/null +++ b/string_pool.cc @@ -0,0 +1,208 @@ +/*************************************************************************** + * string_pool.cc -- String interning for memory optimization * + ***********************IMPORTANT NMAP LICENSE TERMS************************ + * * + * The Nmap Security Scanner is (C) 1996-2019 Insecure.Com LLC ("The Nmap * + * Project"). Nmap is also a registered trademark of the Nmap Project. * + * 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 ("GPL"), BUT ONLY WITH ALL OF THE * + * CLARIFICATIONS AND EXCEPTIONS DESCRIBED HEREIN. 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@nmap.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 "derivative 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 with any software or content covered by this license * + * ("Covered Software"): * + * * + * o Integrates source code from Covered Software. * + * * + * o Reads or includes copyrighted data files, such as Nmap's nmap-os-db * + * or nmap-service-probes. * + * * + * o Is designed specifically to execute Covered Software and parse the * + * results (as opposed to typical shell or execution-menu apps, which will * + * execute anything you tell them to). * + * * + * o Includes Covered Software in a proprietary executable installer. The * + * installers produced by InstallShield are an example of this. Including * + * Nmap with other software in compressed or archival form does not * + * trigger this provision, provided appropriate open source decompression * + * or de-archiving software is widely available for no charge. For the * + * purposes of this license, an installer is considered to include Covered * + * Software even if it actually retrieves a copy of Covered Software from * + * another source during runtime (such as by downloading it from the * + * Internet). * + * * + * o Links (statically or dynamically) to a library which does any of the * + * above. * + * * + * o Executes a helper program, module, or script to do any of the above. * + * * + * This list is not exclusive, but is meant to clarify our interpretation * + * of derived works with some common examples. Other people may interpret * + * the plain GPL differently, so we consider this a special exception to * + * the GPL that we apply to Covered Software. Works which meet any of * + * these conditions must conform to all of the terms of this license, * + * particularly including the GPL Section 3 requirements of providing * + * source code and allowing free redistribution of the work as a whole. * + * * + * As another special exception to the GPL terms, the Nmap Project 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. * + * * + * The Nmap Project has permission to redistribute Npcap, a packet * + * capturing driver and library for the Microsoft Windows platform. * + * Npcap is a separate work with it's own license rather than this Nmap * + * license. Since the Npcap license does not permit redistribution * + * without special permission, our Nmap Windows binary packages which * + * contain Npcap may not be redistributed without special permission. * + * * + * Any redistribution of Covered Software, including any derived works, * + * must obey and carry forward all of the terms of this license, including * + * obeying all GPL rules and restrictions. For example, source code of * + * the whole work must be provided and free redistribution must be * + * allowed. All GPL references to "this License", are to be treated as * + * including the terms and conditions of this license text as well. * + * * + * Because this license imposes special exceptions to the GPL, Covered * + * Work may not be combined (even as part of a larger work) with plain GPL * + * software. The terms, conditions, and exceptions of this license must * + * be included as well. This license is incompatible with some other open * + * source licenses as well. In some cases we can relicense portions of * + * Nmap or grant special permissions to use it in other open source * + * software. Please contact fyodor@nmap.org with any such requests. * + * Similarly, we don't incorporate incompatible open source software into * + * Covered Software without special permission from the copyright holders. * + * * + * If you have any questions about the licensing restrictions on using * + * Nmap in other works, we are happy to help. As mentioned above, we also * + * offer an 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 support and updates. They also fund the continued * + * development of Nmap. Please email sales@nmap.com for further * + * information. * + * * + * If you have received a written license agreement or contract for * + * Covered Software stating terms other than these, you may choose to use * + * and redistribute Covered Software under those terms instead of these. * + * * + * 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. * + * * + * 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 the dev@nmap.org mailing list 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 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 Nmap * + * license file for more details (it's in a COPYING file included with * + * Nmap, and also available from https://svn.nmap.org/nmap/COPYING) * + * * + ***************************************************************************/ +#include "string_pool.h" +#include + +#include +#include +#include +#include +#include + +/* Keep assert() defined for security reasons */ +#undef NDEBUG +#include + +const char *string_pool_insert(const char *s) +{ + static std::set pool; + static std::pair::iterator, bool> pair; + + pair = pool.insert(s); + + return pair.first->c_str(); +} + +const char *string_pool_substr(const char *s, const char *t) +{ + return string_pool_insert(std::string(s, t).c_str()); +} + +const char *string_pool_substr_strip(const char *s, const char *t) { + while (isspace((int) (unsigned char) *s)) + s++; + while (t > s && isspace((int) (unsigned char) *(t - 1))) + t--; + + return string_pool_substr(s, t); +} + +const char *string_pool_strip_word(const char *s) { + const char *t; + + while (isspace((int) (unsigned char) *s)) + s++; + t = s; + while (*t != '\0' && !isspace((int) (unsigned char) *t)) + t++; + + if (s == t) + return NULL; + + return string_pool_substr(s, t); +} + +/* Format a string with sprintf and insert it with string_pool_insert. */ +const char *string_pool_sprintf(const char *fmt, ...) +{ + const char *s; + char *buf; + int size, n; + va_list ap; + + buf = NULL; + size = 32; + /* Loop until we allocate a string big enough for the sprintf. */ + for (;;) { + buf = (char *) realloc(buf, size); + assert(buf != NULL); + va_start(ap, fmt); + n = Vsnprintf(buf, size, fmt, ap); + va_end(ap); + if (n < 0) + size = size * 2; + else if (n >= size) + size = n + 1; + else + break; + } + + s = string_pool_insert(buf); + free(buf); + + return s; +} diff --git a/string_pool.h b/string_pool.h new file mode 100644 index 000000000..ec9c5fdb3 --- /dev/null +++ b/string_pool.h @@ -0,0 +1,153 @@ +/*************************************************************************** + * string_pool.h -- String interning for memory optimization * + ***********************IMPORTANT NMAP LICENSE TERMS************************ + * * + * The Nmap Security Scanner is (C) 1996-2019 Insecure.Com LLC ("The Nmap * + * Project"). Nmap is also a registered trademark of the Nmap Project. * + * 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 ("GPL"), BUT ONLY WITH ALL OF THE * + * CLARIFICATIONS AND EXCEPTIONS DESCRIBED HEREIN. 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@nmap.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 "derivative 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 with any software or content covered by this license * + * ("Covered Software"): * + * * + * o Integrates source code from Covered Software. * + * * + * o Reads or includes copyrighted data files, such as Nmap's nmap-os-db * + * or nmap-service-probes. * + * * + * o Is designed specifically to execute Covered Software and parse the * + * results (as opposed to typical shell or execution-menu apps, which will * + * execute anything you tell them to). * + * * + * o Includes Covered Software in a proprietary executable installer. The * + * installers produced by InstallShield are an example of this. Including * + * Nmap with other software in compressed or archival form does not * + * trigger this provision, provided appropriate open source decompression * + * or de-archiving software is widely available for no charge. For the * + * purposes of this license, an installer is considered to include Covered * + * Software even if it actually retrieves a copy of Covered Software from * + * another source during runtime (such as by downloading it from the * + * Internet). * + * * + * o Links (statically or dynamically) to a library which does any of the * + * above. * + * * + * o Executes a helper program, module, or script to do any of the above. * + * * + * This list is not exclusive, but is meant to clarify our interpretation * + * of derived works with some common examples. Other people may interpret * + * the plain GPL differently, so we consider this a special exception to * + * the GPL that we apply to Covered Software. Works which meet any of * + * these conditions must conform to all of the terms of this license, * + * particularly including the GPL Section 3 requirements of providing * + * source code and allowing free redistribution of the work as a whole. * + * * + * As another special exception to the GPL terms, the Nmap Project 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. * + * * + * The Nmap Project has permission to redistribute Npcap, a packet * + * capturing driver and library for the Microsoft Windows platform. * + * Npcap is a separate work with it's own license rather than this Nmap * + * license. Since the Npcap license does not permit redistribution * + * without special permission, our Nmap Windows binary packages which * + * contain Npcap may not be redistributed without special permission. * + * * + * Any redistribution of Covered Software, including any derived works, * + * must obey and carry forward all of the terms of this license, including * + * obeying all GPL rules and restrictions. For example, source code of * + * the whole work must be provided and free redistribution must be * + * allowed. All GPL references to "this License", are to be treated as * + * including the terms and conditions of this license text as well. * + * * + * Because this license imposes special exceptions to the GPL, Covered * + * Work may not be combined (even as part of a larger work) with plain GPL * + * software. The terms, conditions, and exceptions of this license must * + * be included as well. This license is incompatible with some other open * + * source licenses as well. In some cases we can relicense portions of * + * Nmap or grant special permissions to use it in other open source * + * software. Please contact fyodor@nmap.org with any such requests. * + * Similarly, we don't incorporate incompatible open source software into * + * Covered Software without special permission from the copyright holders. * + * * + * If you have any questions about the licensing restrictions on using * + * Nmap in other works, we are happy to help. As mentioned above, we also * + * offer an 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 support and updates. They also fund the continued * + * development of Nmap. Please email sales@nmap.com for further * + * information. * + * * + * If you have received a written license agreement or contract for * + * Covered Software stating terms other than these, you may choose to use * + * and redistribute Covered Software under those terms instead of these. * + * * + * 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. * + * * + * 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 the dev@nmap.org mailing list 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 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 Nmap * + * license file for more details (it's in a COPYING file included with * + * Nmap, and also available from https://svn.nmap.org/nmap/COPYING) * + * * + ***************************************************************************/ +#ifndef STRING_POOL_H +#define STRING_POOL_H + +/* The OS database consists of many small strings, many of which appear + thousands of times. It pays to allocate memory only once for each unique + string, and have all references point at the one allocated value. */ + +/* Store a string uniquely. The first time this function is called with a + certain string, it allocates memory and stores a copy of the string in a + static pool. Thereafter it will return a pointer to the saved string instead + of allocating memory for an identical one. */ +const char *string_pool_insert(const char *s); + +/* Format a string with sprintf and insert it with string_pool_insert. */ +const char *string_pool_sprintf(const char *fmt, ...); + +/* Store the string in the interval [s,t) */ +const char *string_pool_substr(const char *s, const char *t); + +/* Store the string in the interval [s,t), stripping whitespace from both ends. */ +const char *string_pool_substr_strip(const char *s, const char *t); + +/* Skip over whitespace to find the beginning of a word, then read until the + next whitespace character. Returns NULL if only whitespace is found. */ +const char *string_pool_strip_word(const char *s); + +#endif // STRING_POOL_H