/*************************************************************************** * Nping.h -- This file contains general defines and constants used * * throughout Nping's code. * * * ***********************IMPORTANT NMAP LICENSE TERMS************************ * * * The Nmap Security Scanner is (C) 1996-2015 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 ("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, 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. * * * * 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, are 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@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 (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 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 NPING_H #define NPING_H 1 /* Common library requirements and definitions *******************************/ #include #include #include #include #include #include #include #include #include #include #include "../libnetutil/netutil.h" #include "../libnetutil/npacket.h" #ifdef HAVE_CONFIG_H #include "nping_config.h" #else #ifdef WIN32 #include "nping_winconfig.h" #endif /* WIN32 */ #endif /* HAVE_CONFIG_H */ #ifndef WIN32 #include #endif #if HAVE_UNISTD_H #include #endif #ifdef STDC_HEADERS #include #else void *malloc(); void *realloc(); #endif #if STDC_HEADERS || HAVE_STRING_H #include #if !STDC_HEADERS && HAVE_MEMORY_H #include #endif #endif #if HAVE_STRINGS_H #include #endif #ifdef HAVE_BSTRING_H #include #endif #ifndef WIN32 #include #endif /* !WIN32 */ #ifdef HAVE_SYS_PARAM_H #include /* Defines MAXHOSTNAMELEN on BSD*/ #endif #if HAVE_RPC_TYPES_H #include #endif #if HAVE_SYS_SOCKET_H #include #endif #if HAVE_NETINET_IN_H #include #endif #if HAVE_NETDB_H #include #endif #if TIME_WITH_SYS_TIME #include #include #else #if HAVE_SYS_TIME_H #include #else #include # endif #endif #ifdef HAVE_PWD_H #include #endif #if HAVE_ARPA_INET_H #include #endif #if HAVE_SYS_RESOURCE_H #include #endif /* Keep assert() defined for security reasons */ #undef NDEBUG #ifndef MAXHOSTNAMELEN #define MAXHOSTNAMELEN 128 #endif #define MAXLINE 255 /* CONSTANT DEFINES *********************************************************** * @warning It's better not to play with these, because the code may make * * SOME assumptions like "defined value A is an integer greater than defined * * value B" or "value C is an odd integer greater than 0", etc. */ /* VERBOSITY LEVELS */ /* These are the defines for Nping's internal verbosity levels. Every time * you write code for Nping and you have to print something to the terminal, * you'll have to choose a verbosity level. You choose a level so your message * gets printed only when the user has requested messages from that level to be * printed. For example, we have some calls to output functions that print out * things like "%d target IPs resolved". We don't want that message to always * get printed during Nping's execution. We only want it out when the user * has increase the verbosity. * * So the thing here is that there are two things that should be taken * into account: * 1. The current verbosity level that user has supplied from the command line * 2. The verbosity level that we supply in our print calls ( nping_print(), * nping_warning(), etc...) * * Fortunately Nping output functions already take care of checking the * current verbosity level, so programmers only have to decide which level * should they specify in their output calls. If you are a programmer and * you are using nping_print(), nping_warning() or nping_fatal() calls in Nping's code, * you have to ask yourself: Do I want to print extra information that * shouldn't be printed by default? Or am I printing important stuff like * errors, etc, that should almost always be printed out? * * In the first case, you will call the output function using a verbosity * level of VB_0 or higher. Calls that specify VB_0 are printed by default * as VB_0 is the base verbosity level. Calls that specify VB_1 get printed * only when the user has incremented verbosity level by at least one using * option "-v". Same with VB_2 for which the users needs to have specified * either "-v2" or "-v -v". * * In the other case, where you are printing errors etc, you have supply * levels like QT_1, QT_2, QT_3 or QT_4. Those are called quiet levels. * They are called quiet levels from a user point of view but they are * verbose to us, programmers, because calls that supply QT_X levels almost * always get printed. This is because base verbosity is VB_0 and that * includes all QT_X levels. So you have to be careful with those. QT_ levels * should only be used to print important stuff like fatal errors, warnings, * and some basic running time information. Level QT_4 is the quiet-est one * and nothing is ever printed out. * * Check the comments after each level definition to see how they should be * used. Here are some examples: * * nping_fatal(QT_3,"createIPv4(): NULL pointer supplied."); * nping_print(DBG_2,"Resolving specified targets..."); * nping_print(VB_0, "Raw packets sent: %llu ", this->stats.getSentPackets() ); * * */ /* Less verbosity */ #define QT_4 0 /**< No output at all */ #define QT_3 1 /**< Fatal error messages, help info, version number */ #define QT_2 2 /**< Warnings and very limited output(just some statistics) */ #define QT_1 3 /**< Start and timing information but no sent/recv packets */ /* Base level (QT_0 is provided for consistency but should not be used) */ #define QT_0 4 /**< Normal info (sent/recv packets, statistics...) (DEFAULT */ #define VB_0 4 /**< Normal info (sent/recv packets, statistics...) (DEFAULT)*/ /* More verbosity */ #define VB_1 5 /**< Detailed information about times, flags, etc. */ #define VB_2 6 /**< Very detailed information about packets, */ #define VB_3 7 /**< Reserved for future use */ #define VB_4 8 /**< Reserved for future use */ /* DEBUGGING LEVELS */ #define DBG_0 30 /**< No debug information at all (DEFAULT) */ #define DBG_1 31 /**< Very important or high level debug information */ #define DBG_2 32 /**< Important or medium level debug information */ #define DBG_3 33 /**< Regular and low level debug information */ #define DBG_4 34 /**< Messages only a real Nping freak would want to see */ #define DBG_5 35 /**< Enables Nsock (and other libs) basic tracing */ #define DBG_6 36 /**< Enables full Nsock (and other libs) tracing */ #define DBG_7 37 /**< Reserved for future use */ #define DBG_8 38 /**< Reserved for future use */ #define DBG_9 39 /**< Reserved for future use */ #define MAX_IP_PACKET_LEN 65535 /**< Max len of an IP datagram */ #define MAX_UDP_PAYLOAD_LEN 65507 /**< Check comments in UDPHeader::setSum() */ #define MAX_DEV_LEN 128 /**< Max network interface name length */ #define NO_NEWLINE 0x8000 /**< Used in nping_fatal(), nping_warning() and nping_print() */ /** Bit count for number parsing functions */ #define RANGE_8_BITS 8 #define RANGE_16_BITS 16 #define RANGE_32_BITS 32 #define RANGE_64_BITS 64 /* Crypto Lengths */ #define CIPHER_BLOCK_SIZE (128/8) #define CIPHER_KEY_LEN (128/8) #define MAC_KEY_LEN (128/8) /* General tunable defines **************************************************/ #define NPING_NAME "Nping" #define NPING_URL "http://nmap.org/nping" #define NPING_VERSION "0.6.49BETA6" #define DEFAULT_VERBOSITY VB_0 #define DEFAULT_DEBUGGING DBG_0 /**< Default number of probes that are sent to each target */ #define DEFAULT_PACKET_COUNT 5 /* When doing traceroute, the number of packets sent to each host must be * higher because 5 is probably not enough to reach the average target on the * Internet. The following paper suggests that internet hosts are no more than * 30 hops apart, so setting the packet count to 48 when --traceroute is set * seems like a safe choice. * Cheng, J., Haining, W. and Kang, GS. (2006). Hop-Count Filtering: An * Effective Defense Against Spoofed DDoS Traffic. Australian Telecommu- * nication Networks & Applications Conference (ATNAC). Australia. * */ #define TRACEROUTE_PACKET_COUNT 48 #define DEFAULT_DELAY 1000 /**< Milliseconds between each probe */ /** Milliseconds Nping waits for replies after all probes have been sent */ #define DEFAULT_WAIT_AFTER_PROBES 1000 #define DEFAULT_IP_TTL 64 /**< Default IP Time To Live */ #define DEFAULT_IP_TOS 0 /**< Default IP Type of Service */ #define DEFAULT_IPv6_TTL 64 /**< Default IPv6 Hop Limit */ #define DEFAULT_IPv6_TRAFFIC_CLASS 0x00 /**< Default IPv6 Traffic Class */ #define DEFAULT_TCP_TARGET_PORT 80 /**< Default TCP target port */ #define DEFAULT_UDP_TARGET_PORT 40125 /**< Default UDP target port */ #define DEFAULT_UDP_SOURCE_PORT 53 /**< Default UDP source port */ #define DEFAULT_TCP_WINDOW_SIZE 1480 /**< Default TCP Window size */ /**< MTU used when user just supplies option -f but no MTU value */ #define DEFAULT_MTU_FOR_FRAGMENTATION 72 #define DEFAULT_ICMP_TYPE 8 /**< Default ICMP message: Echo Request */ #define DEFAULT_ICMP_CODE 0 /**< Default ICMP code: 0 (standard) */ #define DEFAULT_ICMPv6_TYPE 128 /**< Default ICMPv6 message: Echo Request */ #define DEFAULT_ICMPv6_CODE 0 /**< Default ICMPv6 code: 0 (standard) */ #define DEFAULT_ARP_OP 1 /**< Default ARP operation: OP_ARP_REQUEST */ /* WARNING: This is the max length for UDP and TCP payloads. Whatever you set * here, it cannot exceed the worst case: * 65535 bytes - IPv6Header with options - TCP Header with options. */ #define MAX_PAYLOAD_ALLOWED 65400 /* I've tested this on a GNU/Linux 2.6.24 and I've seen that if the length * of the whole IP packet is more than 16436 when using loopback interface or * more than 1500 when using a normal network interface, the kernel complains * and says "Message too long". This is obviously caused by the configured * MTU. So the thing is that although we allow users to specify payloads up to * MAX_PAYLOAD_ALLOWED bytes, when we generate random payloads, we set our * on limit on 1500-20-20=1460 bytes. Let's be conservative and consider that * IP packet has 40bytes of options and TCP has 20. So max length should be * 1500-60-40 = 1400. */ #define MAX_RANDOM_PAYLOAD 1400 #define MAX_RECOMMENDED_PAYLOAD 1400 /* Cached hosts in resolveChached() and gethostbynameCached() */ #define MAX_CACHED_HOSTS 512 #define MAX_CACHED_HOSTNAME_LEN 512 /* (9929 because is prime as has not been assigned by IANA yet) */ #define DEFAULT_ECHO_PORT 9929 /* The echo server tries to zero any application layer data before echoing * network packets. However, sometimes we may not be able to successfully * parse a given packet (decide whether the packet contains application data * or not), so this define specifies the amount of bytes of a packet that the * server does not zero in such case. 40 bytes allows IPv4+TCP, an IPv6 header, * an IPv4+UDP+12payload bytes, etc. In the case of UDP, the first 12 data bytes * would be leaked. However, we should be able to parse simple IPv4-UDP packets * without problem, so it should never happen. We expect to use this constant * when received packets are really weird (eg. tunneled traffic, protocols we * don't understand, etc. The 40 bytes are a compromise between dropping the * packet but provide total protection against data leakage due to attacks to * the echo server, and providing some flexibility at the risk of leaking * a few bytes if an attacker is able to trick the echo server into echoing * packets that were not originated by him. */ #define PAYLOAD_ECHO_BYTES_IN_DOUBT 40 #define NSOCK_INFINITE -1 /* Prototypes for nping.cc shared functions */ char *getBPFFilterString(); #endif