1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/***************************************************************************
* 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-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. *
* *
***************************************************************************/
/* $Id: timing.h 28192 2012-03-01 06:53:35Z fyodor $ */
#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);
#define DEFAULT_CURRENT_RATE_HISTORY 5.0
/* 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);
/* This class measures current and lifetime average rates for some quantity. */
class RateMeter {
public:
RateMeter(double current_rate_history = DEFAULT_CURRENT_RATE_HISTORY);
void start(const struct timeval *now = NULL);
void stop(const struct timeval *now = NULL);
void update(double amount, const struct timeval *now = NULL);
double getOverallRate(const struct timeval *now = NULL) const;
double getCurrentRate(const struct timeval *now = NULL, bool update = true);
double getTotal(void) const;
double elapsedTime(const struct timeval *now = NULL) const;
private:
/* How many seconds to look back when calculating the "current" rates. */
double current_rate_history;
/* When this meter started recording. */
struct timeval start_tv;
/* When this meter stopped recording. */
struct timeval stop_tv;
/* The last time the current sample rates were updated. */
struct timeval last_update_tv;
double total;
double current_rate;
static bool isSet(const struct timeval *tv);
};
/* A specialization of RateMeter that measures packet and byte rates. */
class PacketRateMeter {
public:
PacketRateMeter(double current_rate_history = DEFAULT_CURRENT_RATE_HISTORY);
void start(const struct timeval *now = NULL);
void stop(const struct timeval *now = NULL);
void update(u32 len, const struct timeval *now = NULL);
double getOverallPacketRate(const struct timeval *now = NULL) const;
double getCurrentPacketRate(const struct timeval *now = NULL, bool update = true);
double getOverallByteRate(const struct timeval *now = NULL) const;
double getCurrentByteRate(const struct timeval *now = NULL, bool update =true);
unsigned long long getNumPackets(void) const;
unsigned long long getNumBytes(void) const;
private:
RateMeter packet_rate_meter;
RateMeter byte_rate_meter;
};
class ScanProgressMeter {
public:
/* A COPY of stypestr is made and saved for when stats are printed */
ScanProgressMeter(const 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 printStatsIfNecessary 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 printStatsIfNecessary(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 printStatsIfNecessary 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 */
|
