forked from nmap/nmap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FPEngine.h
475 lines (406 loc) · 21.7 KB
/
FPEngine.h
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
/***************************************************************************
* FPEngine.h -- Header info for IPv6 OS detection via TCP/IP *
* fingerprinting. For more information on how this works in Nmap, see *
* http://insecure.org/osdetect/ *
* *
***********************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 [email protected]). 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 [email protected] 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 [email protected] 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 [email protected] 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) *
* *
***************************************************************************/
/* $Id$ */
#ifndef __FPENGINE_H__
#define __FPENGINE_H__ 1
#include "nsock.h"
#include <vector>
#include "libnetutil/npacket.h"
/* Mention some classes here so we don't have to place the declarations in
* the right order (otherwise the compiler complains). */
class FPHost;
class FPHost6;
class FPProbe;
class Target;
class FingerPrintResultsIPv6;
struct FingerMatch;
/******************************************************************************
* CONSTANT DEFINITIONS *
******************************************************************************/
#define NELEMS(a) (sizeof(a) / sizeof((a)[0]))
#define NUM_FP_PROBES_IPv6_TCP 13
#define NUM_FP_PROBES_IPv6_ICMPv6 4
#define NUM_FP_PROBES_IPv6_UDP 1
/* Total number of IPv6 OS detection probes. */
#define NUM_FP_PROBES_IPv6 (NUM_FP_PROBES_IPv6_TCP+NUM_FP_PROBES_IPv6_ICMPv6+NUM_FP_PROBES_IPv6_UDP)
/* Even with a successful classification, we may not consider a match good if it
is too different from other members of the class. */
#define FP_NOVELTY_THRESHOLD 15.0
const unsigned int OSDETECT_FLOW_LABEL = 0x12345;
/* Number of timed probes for IPv6 OS scan. This is, the number of probes that
* have specific timing requirements and need to be processed together. This
* are the probes that are sent 100ms apart. */
#define NUM_FP_TIMEDPROBES_IPv6 6
/* Initial congestion window. It is set to the number of timed probes because
* hosts need to be able to schedule all of them at once. */
#define OSSCAN_INITIAL_CWND (NUM_FP_TIMEDPROBES_IPv6)
/* Initial Slow Start threshold. It is set to four times the initial CWND. */
#define OSSCAN_INITIAL_SSTHRESH (4 * OSSCAN_INITIAL_CWND)
/* Host group size is the number of osscan hosts that are processed in parallel.
* Note that this osscan engine always keeps a working group of this many hosts.
* in other words, if one host in the group finishes, another is added to it
* dynamically. */
#define OSSCAN_GROUP_SIZE 10
/* Initial retransmission timeout. This is the time we initially wait for a
* probe response before retransmitting the original probe. Note that this is
* only the initial RTO, used only when no RTT measures have been taken yet.
* The actual RTO varies each time we get a response to a probe.
* It is set to 3 seconds (3*10^6 usecs) as per RFC 2988. */
#define OSSCAN_INITIAL_RTO (3*1000000)
/******************************************************************************
* CLASS DEFINITIONS *
******************************************************************************/
/* This class handles the access to the network. It handles packet transmission
* scheduling, packet capture and congestion control. Every FPHost should be
* linked to the same instance of this class, so the access to the network can
* be managed globally (for the whole OS detection process). */
class FPNetworkControl {
private:
nsock_pool nsp; /* Nsock pool. */
nsock_iod pcap_nsi; /* Nsock Pcap descriptor. */
nsock_event_id pcap_ev_id; /* Last pcap read event that was scheduled. */
bool first_pcap_scheduled; /* True if we scheduled the first pcap read event. */
bool nsock_init; /* True if the nsock pool has been initialized. */
int rawsd; /* Raw socket. */
std::vector<FPHost *> callers; /* List of users of this instance (used for callbacks).*/
int probes_sent; /* Number of unique probes sent (not retransmissions). */
int responses_recv; /* Number of probe responses received. */
int probes_timedout; /* Number of probes that timeout after all retransms. */
float cc_cwnd; /* Current congestion window. */
float cc_ssthresh; /* Current Slow Start threshold. */
int cc_init();
int cc_update_sent(int pkts);
int cc_report_drop();
int cc_update_received();
public:
FPNetworkControl();
~FPNetworkControl();
void init(const char *ifname, devtype iftype);
int register_caller(FPHost *newcaller);
int unregister_caller(FPHost *oldcaller);
int setup_sniffer(const char *iface, const char *bfp_filter);
void handle_events();
int scheduleProbe(FPProbe *pkt, int in_msecs_time);
void probe_transmission_handler(nsock_pool nsp, nsock_event nse, void *arg);
void response_reception_handler(nsock_pool nsp, nsock_event nse, void *arg);
bool request_slots(size_t num_packets);
int cc_report_final_timeout();
};
/* +-----------+
| FPEngine |
+-----------+
| |
+-----+-----+
|
+-------+-------+
| |
| |
+-----------+ +-----------+
| FPEngine4 | | FPEngine6 |
+-----------+ +-----------+
| | | |
+-----------+ +-----------+ */
/* This class is the generic fingerprinting engine. */
class FPEngine {
protected:
size_t osgroup_size;
public:
FPEngine();
~FPEngine();
void reset();
virtual int os_scan(std::vector<Target *> &Targets) = 0;
const char *bpf_filter(std::vector<Target *> &Targets);
};
/* This class handles IPv6 OS fingerprinting. Using it is very simple, just
* instance it and then call os_scan() with the list of IPv6 targets to
* fingerprint. If everything goes well, the internal state of the supplied
* target objects will be modified to reflect the results of the fingerprinting
* process. */
class FPEngine6 : public FPEngine {
private:
std::vector<FPHost6 *> fphosts; /* Information about each target to fingerprint */
public:
FPEngine6();
~FPEngine6();
void reset();
int os_scan(std::vector<Target *> &Targets);
};
/* +----------+
| FPPacket |
+----------+
| |
+-----+----+
|
|
+-----------+
| FPProbe |
+-----------+
| |
+-----+-----+ */
/* This class represents a generic packet for the OS fingerprinting process */
class FPPacket {
protected:
PacketElement *pkt; /* Actual packet associated with this FPPacket */
bool link_eth; /* Ethernet layer required? */
struct eth_nfo eth_hdr; /* Eth info, valid when this->link_eth==true */
struct timeval pkt_time; /* Time at which the packet was sent or received */
int resetTime();
void __reset();
public:
FPPacket();
~FPPacket();
int setTime(const struct timeval *tv = NULL);
struct timeval getTime() const;
int setPacket(PacketElement *pkt);
int setEthernet(const u8 *src_mac, const u8 *dst_mac, const char *devname);
const struct eth_nfo *getEthernet() const;
const PacketElement *getPacket() const;
size_t getLength() const;
u8 *getPacketBuffer(size_t *pkt_len) const;
bool is_set() const;
};
/* This class represents a generic OS fingerprinting probe. In other words, it
* represents a network packet that Nmap sends to a target in order to
* obtain information about the target's TCP/IP stack. */
class FPProbe : public FPPacket {
private:
char *probe_id;
int probe_no;
int retransmissions;
int times_replied;
bool failed;
bool timed;
public:
FPHost *host;
FPProbe();
~FPProbe();
void reset();
bool isResponse(PacketElement *rcvd);
int setProbeID(const char *id);
const char *getProbeID() const;
int getRetransmissions() const;
int incrementRetransmissions();
int getReplies() const;
int incrementReplies();
int setTimeSent();
int resetTimeSent();
struct timeval getTimeSent() const;
bool probeFailed() const;
int setFailed();
bool isTimed() const;
int setTimed();
};
/* This class represents a generic received packet. */
struct FPResponse {
const char *probe_id;
u8 *buf;
size_t len;
struct timeval senttime, rcvdtime;
FPResponse(const char *probe_id, const u8 *buf, size_t len,
struct timeval senttime, struct timeval rcvdtime);
~FPResponse();
};
/* +-----------+
| FPHost |
+-----------+
| |
+-----+-----+
|
+-------+-------+
| |
| |
+-----------+ +-----------+
| FPHost4 | | FPHost6 |
+-----------+ +-----------+
| | | |
+-----------+ +-----------+ */
/* This class represents a generic host to be fingerprinted. */
class FPHost {
protected:
unsigned int total_probes; /* Number of different OS scan probes to be sent to targets */
unsigned int timed_probes; /* Number of probes that have specific timing requirements */
unsigned int probes_sent; /* Number of FPProbes sent (not counting retransmissions) */
unsigned int probes_answered; /* Number of FPResponses received */
unsigned int probes_unanswered; /* Number of FPProbes that timedout (after all retransmissions) */
bool incomplete_fp; /* True if we were unable to send all attempted probes */
bool detection_done; /* True if the OS detection process has been completed. */
bool timedprobes_sent; /* True if the probes that have timing requirements were sent */
Target *target_host; /* Info about the host to fingerprint */
FPNetworkControl *netctl; /* Link to the network manager (for scheduling and CC) */
bool netctl_registered; /* True if we are already registered in the network controller */
u32 tcpSeqBase; /* Base for sequence numbers set in outgoing probes */
int open_port_tcp; /* Open TCP port to be used in the OS detection probes */
int closed_port_tcp; /* Closed TCP port for the OS detection probes. */
int closed_port_udp; /* Closed UDP port. */
int tcp_port_base; /* Send TCP probes starting with this port number. */
int udp_port_base; /* Send UDP probes with this port number. */
u16 icmp_seq_counter; /* ICMPv6 sequence number counter. */
int rto; /* Retransmission timeout for the host */
int rttvar; /* Round-Trip Time variation (RFC 2988) */
int srtt; /* Smoothed Round-Trip Time (RFC 2988) */
void __reset();
int update_RTO(int measured_rtt_usecs, bool retransmission);
int choose_osscan_ports();
private:
virtual int build_probe_list() = 0;
public:
struct timeval begin_time;
FPHost();
virtual ~FPHost();
virtual bool done() = 0;
virtual int schedule() = 0;
virtual int callback(const u8 *pkt, size_t pkt_len, const struct timeval *tv) = 0;
const struct sockaddr_storage *getTargetAddress();
void fail_one_probe();
};
/* This class represents IPv6 hosts to be fingerprinted. The class performs
* OS detection asynchronously. To use it, schedule() must be called at regular
* intervals until done() returns true. After that, status() will indicate
* whether the host was successfully matched with a particular OS or not. */
class FPHost6 : public FPHost {
private:
FPProbe fp_probes[NUM_FP_PROBES_IPv6]; /* OS detection probes to be sent.*/
FPResponse *fp_responses[NUM_FP_PROBES_IPv6]; /* Received responses. */
FPResponse *aux_resp[NUM_FP_TIMEDPROBES_IPv6]; /* Aux vector for timed responses */
int build_probe_list();
int set_done_and_wrap_up();
public:
FPHost6(Target *tgt, FPNetworkControl *fpnc);
~FPHost6();
void reset();
void init(Target *tgt, FPNetworkControl *fpnc);
void finish();
bool done();
int schedule();
int callback(const u8 *pkt, size_t pkt_len, const struct timeval *tv);
const FPProbe *getProbe(const char *id);
const FPResponse *getResponse(const char *id);
void fill_FPR(FingerPrintResultsIPv6 *FPR);
};
/******************************************************************************
* Nsock handler wrappers. *
******************************************************************************/
void probe_transmission_handler_wrapper(nsock_pool nsp, nsock_event nse, void *arg);
void response_reception_handler_wrapper(nsock_pool nsp, nsock_event nse, void *arg);
std::vector<FingerMatch> load_fp_matches();
#endif /* __FPENGINE_H__ */