From 824f9dcb2fe3997be51f3b8bc9f70eecf1f22baa Mon Sep 17 00:00:00 2001 From: dmiller Date: Thu, 1 Nov 2018 04:35:00 +0000 Subject: [PATCH] Rearrange declarations to put all addrset functions in nbase.h, hide struct addrset internals. --- nbase/Makefile.in | 2 +- nbase/nbase.h | 16 +---- nbase/nbase.vcxproj | 1 - nbase/nbase_addrset.c | 44 +++++++++++- nbase/nbase_addrset.h | 153 ------------------------------------------ ncat/ncat_core.c | 4 +- ncat/ncat_core.h | 4 +- ncat/ncat_main.c | 4 +- ncat/test/addrset.c | 10 +-- ncat/util.c | 4 +- nmap.cc | 14 ++-- targets.cc | 8 +-- 12 files changed, 67 insertions(+), 197 deletions(-) delete mode 100644 nbase/nbase_addrset.h diff --git a/nbase/Makefile.in b/nbase/Makefile.in index a41b00aa0..db1380f39 100644 --- a/nbase/Makefile.in +++ b/nbase/Makefile.in @@ -24,7 +24,7 @@ MAKEDEPEND = @MAKEDEPEND@ TARGET = libnbase.a -DEPS = getopt.h nbase.h nbase_winconfig.h nbase_config.h nbase_ipv6.h nbase_winunix.h nbase_crc32ct.h nbase_addrset.h +DEPS = getopt.h nbase.h nbase_winconfig.h nbase_config.h nbase_ipv6.h nbase_winunix.h nbase_crc32ct.h OBJS = @LIBOBJS@ all: $(TARGET) diff --git a/nbase/nbase.h b/nbase/nbase.h index f6baf1091..3cd54e3c4 100644 --- a/nbase/nbase.h +++ b/nbase/nbase.h @@ -561,22 +561,12 @@ char *executable_path(const char *argv0); /* addrset management functions and definitions */ /* A set of addresses. Used to match against allow/deny lists. */ -struct addrset_elem; -/* A radix tree (trie) used to match quickly against allow/deny lists. */ -struct trie_node; - -/* A set of addresses. Used to match against allow/deny lists. */ -struct addrset { - /* Linked list of struct addset_elem. */ - struct addrset_elem *head; - /* Radix tree for faster matching of certain cases */ - struct trie_node *trie; -}; +struct addrset; void nbase_set_log(void (*log_user_func)(const char *, ...),void (*log_debug_func)(const char *, ...)); -extern void addrset_init(struct addrset *set); +struct addrset *addrset_new(); extern void addrset_free(struct addrset *set); -extern void addrset_elem_print(FILE *fp, const struct addrset_elem *elem); +extern void addrset_print(FILE *fp, const struct addrset *set); extern int addrset_add_spec(struct addrset *set, const char *spec, int af, int dns); extern int addrset_add_file(struct addrset *set, FILE *fd, int af, int dns); extern int addrset_contains(const struct addrset *set, const struct sockaddr *sa); diff --git a/nbase/nbase.vcxproj b/nbase/nbase.vcxproj index 948d7c86c..30d834dda 100644 --- a/nbase/nbase.vcxproj +++ b/nbase/nbase.vcxproj @@ -120,7 +120,6 @@ - diff --git a/nbase/nbase_addrset.c b/nbase/nbase_addrset.c index fa14a65ea..3021bb976 100644 --- a/nbase/nbase_addrset.c +++ b/nbase/nbase_addrset.c @@ -131,8 +131,10 @@ program after making any big changes. Also, please add tests for any new features. */ +#include /* CHAR_BIT */ +#include + #include "nbase.h" -#include "nbase_addrset.h" /* A fancy logging system to allow this file to take advantage of different logging systems used by various programs */ @@ -170,12 +172,38 @@ struct trie_node { struct trie_node *next_bit_zero; }; +/* We use bit vectors to represent what values are allowed in an IPv4 octet. + Each vector is built up of an array of bitvector_t (any convenient integer + type). */ +typedef unsigned long bitvector_t; +/* A 256-element bit vector, representing legal values for one octet. */ +typedef bitvector_t octet_bitvector[(256 - 1) / (sizeof(unsigned long) * CHAR_BIT) + 1]; + +/* A chain of tests for set inclusion. If one test is passed, the address is in + the set. */ +struct addrset_elem { + struct { + /* A bit vector for each address octet. */ + octet_bitvector bits[4]; + } ipv4; + struct addrset_elem *next; +}; + +/* A set of addresses. Used to match against allow/deny lists. */ +struct addrset { + /* Linked list of struct addset_elem. */ + struct addrset_elem *head; + /* Radix tree for faster matching of certain cases */ + struct trie_node *trie; +}; + /* Special node pointer to represent "all possible addresses" * This will be used to represent netmask specifications. */ static struct trie_node *TRIE_NODE_TRUE = NULL; -void addrset_init(struct addrset *set) +struct addrset *addrset_new() { + struct addrset *set = (struct addrset *) safe_zalloc(sizeof(struct addrset)); set->head = NULL; /* We could simply allocate one byte to get a unique address, but this * feels safer and is not too large. */ @@ -185,6 +213,7 @@ void addrset_init(struct addrset *set) /* Allocate the first node of the IPv4 trie */ set->trie = (struct trie_node *) safe_zalloc(sizeof(struct trie_node)); + return set; } void trie_free(struct trie_node *curr) @@ -222,6 +251,7 @@ void addrset_free(struct addrset *set) } trie_free(set->trie); + free(set); } @@ -546,7 +576,7 @@ int trie_match (const struct trie_node *this, const struct sockaddr *sa) /* A debugging function to print out the contents of an addrset_elem. For IPv4 this is the four bit vectors. For IPv6 it is the address and netmask. */ -void addrset_elem_print(FILE *fp, const struct addrset_elem *elem) +static void addrset_elem_print(FILE *fp, const struct addrset_elem *elem) { const size_t num_bitvector = sizeof(octet_bitvector) / sizeof(bitvector_t); int i; @@ -559,6 +589,14 @@ void addrset_elem_print(FILE *fp, const struct addrset_elem *elem) } } +void addrset_print(FILE *fp, const struct addrset *set) +{ + const struct addrset_elem *elem; + for (elem = set->head; elem != NULL; elem = elem->next) { + addrset_elem_print(fp, elem); + } +} + /* This is a wrapper around getaddrinfo that automatically handles hints for IPv4/IPv6, TCP/UDP, and whether name resolution is allowed. */ static int resolve_name(const char *name, struct addrinfo **result, int af, int use_dns) diff --git a/nbase/nbase_addrset.h b/nbase/nbase_addrset.h deleted file mode 100644 index 37eb79d68..000000000 --- a/nbase/nbase_addrset.h +++ /dev/null @@ -1,153 +0,0 @@ -/*************************************************************************** - * nbase_addrset.h * - ***********************IMPORTANT NMAP LICENSE TERMS************************ - * * - * The Nmap Security Scanner is (C) 1996-2018 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) * - * * - ***************************************************************************/ - -/* $Id$ */ - -#ifndef _NBASE_ADDRSET_H -#define _NBASE_ADDRSET_H - -//#define HAVE_IPV6 1 -#include /* CHAR_BIT */ - -/* We use bit vectors to represent what values are allowed in an IPv4 octet. - Each vector is built up of an array of bitvector_t (any convenient integer - type). */ -typedef unsigned long bitvector_t; -/* A 256-element bit vector, representing legal values for one octet. */ -typedef bitvector_t octet_bitvector[(256 - 1) / (sizeof(unsigned long) * CHAR_BIT) + 1]; - -/* A chain of tests for set inclusion. If one test is passed, the address is in - the set. */ -struct addrset_elem { - struct { - /* A bit vector for each address octet. */ - octet_bitvector bits[4]; - } ipv4; - struct addrset_elem *next; -}; - -#endif diff --git a/ncat/ncat_core.c b/ncat/ncat_core.c index 647c23cd4..40040a038 100644 --- a/ncat/ncat_core.c +++ b/ncat/ncat_core.c @@ -188,8 +188,8 @@ void options_init(void) o.crlf = 0; o.allow = 0; o.deny = 0; - addrset_init(&o.allowset); - addrset_init(&o.denyset); + o.allowset = addrset_new(); + o.denyset = addrset_new(); o.httpserver = 0; o.nsock_engine = 0; diff --git a/ncat/ncat_core.h b/ncat/ncat_core.h index b817bc999..3ff47ee5c 100644 --- a/ncat/ncat_core.h +++ b/ncat/ncat_core.h @@ -189,8 +189,8 @@ struct options { /* Were any hosts specifically allowed? If so, deny all others. */ int allow; int deny; - struct addrset allowset; - struct addrset denyset; + struct addrset *allowset; + struct addrset *denyset; int httpserver; int nsock_engine; /* Output messages useful for testing to stderr? */ diff --git a/ncat/ncat_main.c b/ncat/ncat_main.c index ef630d10e..13a029faa 100644 --- a/ncat/ncat_main.c +++ b/ncat/ncat_main.c @@ -802,9 +802,9 @@ int main(int argc, char *argv[]) bye("Could not resolve source address \"%s\": %s.", source, gai_strerror(rc)); } - host_list_to_set(&o.allowset, allow_host_list); + host_list_to_set(o.allowset, allow_host_list); host_list_free(allow_host_list); - host_list_to_set(&o.denyset, deny_host_list); + host_list_to_set(o.denyset, deny_host_list); host_list_free(deny_host_list); if (optind == argc) { diff --git a/ncat/test/addrset.c b/ncat/test/addrset.c index ff4e99cf7..61a0f0d2d 100644 --- a/ncat/test/addrset.c +++ b/ncat/test/addrset.c @@ -51,7 +51,7 @@ static int resolve_name(const char *name, struct addrinfo **result) int main(int argc, char *argv[]) { - struct addrset set; + struct addrset *set; char line[1024]; int i; @@ -59,12 +59,12 @@ int main(int argc, char *argv[]) win_init(); #endif - addrset_init(&set); + set = addrset_new(); options_init(); for (i = 1; i < argc; i++) { - if (!addrset_add_spec(&set, argv[i], o.af, !o.nodns)) { + if (!addrset_add_spec(set, argv[i], o.af, !o.nodns)) { fprintf(stderr, "Error adding spec \"%s\".\n", argv[i]); exit(1); } @@ -91,14 +91,14 @@ int main(int argc, char *argv[]) } /* Check just the first address returned. */ - if (addrset_contains(&set, addrs->ai_addr)) + if (addrset_contains(set, addrs->ai_addr)) printf("%s\n", hostname); freeaddrinfo(addrs); } } - addrset_free(&set); + addrset_free(set); return 0; } diff --git a/ncat/util.c b/ncat/util.c index d7c0952fe..b41ad8db5 100644 --- a/ncat/util.c +++ b/ncat/util.c @@ -581,9 +581,9 @@ int allow_access(const union sockaddr_u *su) { /* A host not in the allow set is denied, but only if the --allow or --allowfile option was given. */ - if (o.allow && !addrset_contains(&o.allowset, &su->sockaddr)) + if (o.allow && !addrset_contains(o.allowset, &su->sockaddr)) return 0; - if (addrset_contains(&o.denyset, &su->sockaddr)) + if (addrset_contains(o.denyset, &su->sockaddr)) return 0; return 1; diff --git a/nmap.cc b/nmap.cc index d3d16c3e5..99187e1b3 100644 --- a/nmap.cc +++ b/nmap.cc @@ -1769,7 +1769,7 @@ int nmap_main(int argc, char *argv[]) { struct hostent *target = NULL; time_t timep; char mytime[128]; - struct addrset exclude_group; + struct addrset *exclude_group; #ifndef NOLUA /* Only NSE scripts can add targets */ NewTargets *new_targets = NULL; @@ -1969,19 +1969,19 @@ int nmap_main(int argc, char *argv[]) { shortfry(ports.prots, ports.prot_count); } - addrset_init(&exclude_group); + exclude_group = addrset_new(); /* lets load our exclude list */ if (o.excludefd != NULL) { - load_exclude_file(&exclude_group, o.excludefd); + load_exclude_file(exclude_group, o.excludefd); fclose(o.excludefd); } if (o.exclude_spec != NULL) { - load_exclude_string(&exclude_group, o.exclude_spec); + load_exclude_string(exclude_group, o.exclude_spec); } if (o.debugging > 3) - dumpExclude(&exclude_group); + dumpExclude(exclude_group); #ifndef NOLUA if (o.scriptupdatedb) { @@ -2014,7 +2014,7 @@ int nmap_main(int argc, char *argv[]) { while (Targets.size() < ideal_scan_group_sz) { o.current_scantype = HOST_DISCOVERY; - currenths = nexthost(&hstate, &exclude_group, &ports, o.pingtype); + currenths = nexthost(&hstate, exclude_group, &ports, o.pingtype); if (!currenths) break; @@ -2261,7 +2261,7 @@ int nmap_main(int argc, char *argv[]) { } #endif - addrset_free(&exclude_group); + addrset_free(exclude_group); if (o.inputfd != NULL) fclose(o.inputfd); diff --git a/targets.cc b/targets.cc index b726a9fd9..9ccecc164 100644 --- a/targets.cc +++ b/targets.cc @@ -132,7 +132,7 @@ /* $Id$ */ -#include "nbase/nbase_addrset.h" +#include #include "targets.h" #include "timing.h" #include "tcpip.h" @@ -260,11 +260,7 @@ int load_exclude_string(struct addrset *excludelist, const char *s) { /* A debug routine to dump some information to stdout. Invoked if debugging is set to 4 or higher. */ int dumpExclude(struct addrset *exclude_group) { - const struct addrset_elem *elem; - - for (elem = exclude_group->head; elem != NULL; elem = elem->next) - addrset_elem_print(stdout, elem); - + addrset_print(stdout, exclude_group); return 1; }