mirror of
https://github.com/nmap/nmap.git
synced 2025-12-06 04:31:29 +00:00
172 lines
10 KiB
C++
172 lines
10 KiB
C++
|
|
/***************************************************************************
|
|
* timing.h -- Functions related to computing scan timing (such as keeping *
|
|
* track of and adjusting smoothed round trip times, statistical *
|
|
* deviations, timeout values, etc. Various user options (such as the *
|
|
* timing policy (-T)) also play a role in these calculations. *
|
|
* *
|
|
***********************IMPORTANT NMAP LICENSE TERMS************************
|
|
* *
|
|
* The Nmap Security Scanner is (C) 1996-2008 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, and version detection. *
|
|
* *
|
|
* 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 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-fingerprints 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. This list is not exclusive, but is just meant to *
|
|
* clarify our interpretation of derived works with some common examples. *
|
|
* These restrictions only apply when you actually redistribute Nmap. For *
|
|
* example, nothing stops you from writing and selling a proprietary *
|
|
* front-end to Nmap. Just distribute it by itself, and point people to *
|
|
* http://insecure.org/nmap/ to download Nmap. *
|
|
* *
|
|
* We don't consider these to be added restrictions on top of the GPL, but *
|
|
* just a clarification of how we interpret "derived works" as it applies *
|
|
* to our GPL-licensed Nmap product. This is similar to the way Linus *
|
|
* Torvalds has announced his interpretation of how "derived works" *
|
|
* applies to Linux kernel modules. Our interpretation refers only to *
|
|
* Nmap - we don't speak for any other GPL products. *
|
|
* *
|
|
* 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 as well as helping to *
|
|
* fund the continued development of Nmap technology. 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 Copying.OpenSSL 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 fyodor@insecure.org for possible incorporation into the main *
|
|
* distribution. By sending these changes to Fyodor or one the *
|
|
* Insecure.Org development mailing lists, it is assumed that you are *
|
|
* offering Fyodor and 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 for more details at *
|
|
* http://www.gnu.org/copyleft/gpl.html , or in the COPYING file included *
|
|
* with Nmap. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
/* $Id$ */
|
|
|
|
#ifndef NMAP_TIMING_H
|
|
#define NMAP_TIMING_H
|
|
|
|
#include "nmap.h"
|
|
#include "global_structures.h"
|
|
|
|
/* Call this function on a newly allocated struct timeout_info to
|
|
initialize the values appropriately */
|
|
void initialize_timeout_info(struct timeout_info *to);
|
|
|
|
/* Same as adjust_timeouts(), except this one allows you to specify
|
|
the receive time too (which could be because it was received a while
|
|
back or it could be for efficiency because the caller already knows
|
|
the current time */
|
|
void adjust_timeouts2(const struct timeval *sent,
|
|
const struct timeval *received,
|
|
struct timeout_info *to);
|
|
|
|
/* Adjust our timeout values based on the time the latest probe took for a
|
|
response. We update our RTT averages, etc. */
|
|
void adjust_timeouts(struct timeval sent, struct timeout_info *to);
|
|
|
|
|
|
/* Sleeps if necessary to ensure that it isn't called twice within less
|
|
time than o.send_delay. If it is passed a non-null tv, the POST-SLEEP
|
|
time is recorded in it */
|
|
void enforce_scan_delay(struct timeval *tv);
|
|
|
|
class ScanProgressMeter {
|
|
public:
|
|
/* A COPY of stypestr is made and saved for when stats are printed */
|
|
ScanProgressMeter(char *stypestr);
|
|
~ScanProgressMeter();
|
|
/* Decides whether a timing report is likely to even be
|
|
printed. There are stringent limitations on how often they are
|
|
printed, as well as the verbosity level that must exist. So you
|
|
might as well check this before spending much time computing
|
|
progress info. now can be NULL if caller doesn't have the current
|
|
time handy. Just because this function returns true does not mean
|
|
that the next printStatsIfNeccessary will always print something.
|
|
It depends on whether time estimates have changed, which this func
|
|
doesn't even know about. */
|
|
bool mayBePrinted(const struct timeval *now);
|
|
|
|
/* Prints an estimate of when this scan will complete. It only does
|
|
so if mayBePrinted() is true, and it seems reasonable to do so
|
|
because the estimate has changed significantly. Returns whether
|
|
or not a line was printed.*/
|
|
bool printStatsIfNeccessary(double perc_done, const struct timeval *now);
|
|
|
|
/* Prints an estimate of when this scan will complete. */
|
|
bool printStats(double perc_done, const struct timeval *now);
|
|
|
|
/* Prints that this task is complete. */
|
|
bool endTask(const struct timeval *now, const char *additional_info) { return beginOrEndTask(now, additional_info, false); }
|
|
|
|
struct timeval begin; /* When this ScanProgressMeter was instantiated */
|
|
private:
|
|
struct timeval last_print_test; /* Last time printStatsIfNeccessary was called */
|
|
struct timeval last_print; /* The most recent time the ETC was printed */
|
|
char *scantypestr;
|
|
struct timeval last_est; /* The latest PRINTED estimate */
|
|
|
|
bool beginOrEndTask(const struct timeval *now, const char *additional_info, bool beginning);
|
|
};
|
|
|
|
#endif /* NMAP_TIMING_H */
|
|
|