]>
git.saurik.com Git - apple/xnu.git/blob - bsd/net/pf_osfp.c
2 * Copyright (c) 2008 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 /* $apfw: pf_osfp.c,v 1.4 2008/08/27 00:01:32 jhw Exp $ */
30 /* $OpenBSD: pf_osfp.c,v 1.12 2006/12/13 18:14:10 itojun Exp $ */
33 * Copyright (c) 2003 Mike Frantzen <frantzen@w4g.org>
35 * Permission to use, copy, modify, and distribute this software for any
36 * purpose with or without fee is hereby granted, provided that the above
37 * copyright notice and this permission notice appear in all copies.
39 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
40 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
41 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
42 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
43 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
44 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
45 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
49 #include <machine/endian.h>
50 #include <sys/param.h>
51 #include <sys/socket.h>
52 #include <sys/systm.h>
55 #include <netinet/in.h>
56 #include <netinet/in_systm.h>
57 #include <netinet/ip.h>
58 #include <netinet/tcp.h>
59 #include <netinet/tcp_fsm.h>
62 #include <net/pfvar.h>
65 #include <netinet/ip6.h>
66 #include <netinet6/in6_var.h>
69 #define DPFPRINTF(format, x...) \
70 if (pf_status.debug >= PF_DEBUG_NOISY) \
73 static SLIST_HEAD(pf_osfp_list
, pf_os_fingerprint
) pf_osfp_list
;
74 static struct pool pf_osfp_entry_pl
;
75 static struct pool pf_osfp_pl
;
77 static struct pf_os_fingerprint
*pf_osfp_find(struct pf_osfp_list
*,
78 struct pf_os_fingerprint
*, u_int8_t
);
79 static struct pf_os_fingerprint
*pf_osfp_find_exact(struct pf_osfp_list
*,
80 struct pf_os_fingerprint
*);
81 static void pf_osfp_insert(struct pf_osfp_list
*, struct pf_os_fingerprint
*);
85 * Passively fingerprint the OS of the host (IPv4 TCP SYN packets only)
86 * Returns the list of possible OSes.
88 struct pf_osfp_enlist
*
89 pf_osfp_fingerprint(struct pf_pdesc
*pd
, struct mbuf
*m
, int off
,
90 const struct tcphdr
*tcp
)
96 if ((pd
->af
!= PF_INET
&& pd
->af
!= PF_INET6
) ||
97 pd
->proto
!= IPPROTO_TCP
||
98 (tcp
->th_off
<< 2) < (int)sizeof (*tcp
))
101 if (pd
->af
== PF_INET
) {
102 ip
= mtod(m
, struct ip
*);
103 ip6
= (struct ip6_hdr
*)NULL
;
105 ip
= (struct ip
*)NULL
;
106 ip6
= mtod(m
, struct ip6_hdr
*);
108 if (!pf_pull_hdr(m
, off
, hdr
, tcp
->th_off
<< 2, NULL
, NULL
,
112 return (pf_osfp_fingerprint_hdr(ip
, ip6
, (struct tcphdr
*)hdr
));
115 struct pf_osfp_enlist
*
116 pf_osfp_fingerprint_hdr(const struct ip
*ip
, const struct ip6_hdr
*ip6
,
117 const struct tcphdr
*tcp
)
122 struct pf_os_fingerprint fp
, *fpresult
;
124 const u_int8_t
*optp
;
127 if ((tcp
->th_flags
& (TH_SYN
|TH_ACK
)) != TH_SYN
)
130 if ((ip
->ip_off
& htons(IP_OFFMASK
)) != 0)
134 memset(&fp
, 0, sizeof (fp
));
137 fp
.fp_psize
= ntohs(ip
->ip_len
);
138 fp
.fp_ttl
= ip
->ip_ttl
;
139 if (ip
->ip_off
& htons(IP_DF
))
140 fp
.fp_flags
|= PF_OSFP_DF
;
141 (void) inet_ntop(AF_INET
, &ip
->ip_src
, srcname
,
142 (socklen_t
)sizeof (srcname
));
147 fp
.fp_psize
= sizeof (struct ip6_hdr
) + ntohs(ip6
->ip6_plen
);
148 fp
.fp_ttl
= ip6
->ip6_hlim
;
149 fp
.fp_flags
|= PF_OSFP_DF
;
150 fp
.fp_flags
|= PF_OSFP_INET6
;
151 (void) inet_ntop(AF_INET6
, &ip6
->ip6_src
, srcname
,
152 (socklen_t
)sizeof (srcname
));
157 fp
.fp_wsize
= ntohs(tcp
->th_win
);
160 cnt
= (tcp
->th_off
<< 2) - sizeof (*tcp
);
161 optp
= (const u_int8_t
*)((const char *)tcp
+ sizeof (*tcp
));
162 for (; cnt
> 0; cnt
-= optlen
, optp
+= optlen
) {
163 if (*optp
== TCPOPT_EOL
)
167 if (*optp
== TCPOPT_NOP
) {
168 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<< PF_OSFP_TCPOPT_BITS
) |
175 if (optlen
> cnt
|| optlen
< 2)
179 if (optlen
>= TCPOLEN_MAXSEG
)
180 memcpy(&fp
.fp_mss
, &optp
[2],
182 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
183 PF_OSFP_TCPOPT_BITS
) | PF_OSFP_TCPOPT_MSS
;
184 #if BYTE_ORDER != BIG_ENDIAN
189 if (optlen
>= TCPOLEN_WINDOW
)
190 memcpy(&fp
.fp_wscale
, &optp
[2],
191 sizeof (fp
.fp_wscale
));
192 #if BYTE_ORDER != BIG_ENDIAN
195 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
196 PF_OSFP_TCPOPT_BITS
) |
197 PF_OSFP_TCPOPT_WSCALE
;
199 case TCPOPT_SACK_PERMITTED
:
200 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
201 PF_OSFP_TCPOPT_BITS
) | PF_OSFP_TCPOPT_SACK
;
203 case TCPOPT_TIMESTAMP
:
204 if (optlen
>= TCPOLEN_TIMESTAMP
) {
206 memcpy(&ts
, &optp
[2], sizeof (ts
));
208 fp
.fp_flags
|= PF_OSFP_TS0
;
211 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
212 PF_OSFP_TCPOPT_BITS
) | PF_OSFP_TCPOPT_TS
;
218 optlen
= MAX(optlen
, 1); /* paranoia */
221 DPFPRINTF("fingerprinted %s:%d %d:%d:%d:%d:%llx (%d) "
222 "(TS=%s,M=%s%d,W=%s%d)\n",
223 srcname
, ntohs(tcp
->th_sport
),
224 fp
.fp_wsize
, fp
.fp_ttl
, (fp
.fp_flags
& PF_OSFP_DF
) != 0,
225 fp
.fp_psize
, (long long int)fp
.fp_tcpopts
, fp
.fp_optcnt
,
226 (fp
.fp_flags
& PF_OSFP_TS0
) ? "0" : "",
227 (fp
.fp_flags
& PF_OSFP_MSS_MOD
) ? "%" :
228 (fp
.fp_flags
& PF_OSFP_MSS_DC
) ? "*" : "",
230 (fp
.fp_flags
& PF_OSFP_WSCALE_MOD
) ? "%" :
231 (fp
.fp_flags
& PF_OSFP_WSCALE_DC
) ? "*" : "",
234 if ((fpresult
= pf_osfp_find(&pf_osfp_list
, &fp
,
235 PF_OSFP_MAXTTL_OFFSET
)))
236 return (&fpresult
->fp_oses
);
240 /* Match a fingerprint ID against a list of OSes */
242 pf_osfp_match(struct pf_osfp_enlist
*list
, pf_osfp_t os
)
244 struct pf_osfp_entry
*entry
;
245 int os_class
, os_version
, os_subtype
;
246 int en_class
, en_version
, en_subtype
;
248 if (os
== PF_OSFP_ANY
)
251 DPFPRINTF("osfp no match against %x\n", os
);
252 return (os
== PF_OSFP_UNKNOWN
);
254 PF_OSFP_UNPACK(os
, os_class
, os_version
, os_subtype
);
255 SLIST_FOREACH(entry
, list
, fp_entry
) {
256 PF_OSFP_UNPACK(entry
->fp_os
, en_class
, en_version
, en_subtype
);
257 if ((os_class
== PF_OSFP_ANY
|| en_class
== os_class
) &&
258 (os_version
== PF_OSFP_ANY
|| en_version
== os_version
) &&
259 (os_subtype
== PF_OSFP_ANY
|| en_subtype
== os_subtype
)) {
260 DPFPRINTF("osfp matched %s %s %s %x==%x\n",
261 entry
->fp_class_nm
, entry
->fp_version_nm
,
262 entry
->fp_subtype_nm
, os
, entry
->fp_os
);
266 DPFPRINTF("fingerprint 0x%x didn't match\n", os
);
270 /* Initialize the OS fingerprint system */
272 pf_osfp_initialize(void)
274 pool_init(&pf_osfp_entry_pl
, sizeof (struct pf_osfp_entry
), 0, 0, 0,
276 pool_init(&pf_osfp_pl
, sizeof (struct pf_os_fingerprint
), 0, 0, 0,
278 SLIST_INIT(&pf_osfp_list
);
283 pf_osfp_destroy(void)
287 pool_destroy(&pf_osfp_pl
);
288 pool_destroy(&pf_osfp_entry_pl
);
292 /* Flush the fingerprint list */
296 struct pf_os_fingerprint
*fp
;
297 struct pf_osfp_entry
*entry
;
299 while ((fp
= SLIST_FIRST(&pf_osfp_list
))) {
300 SLIST_REMOVE_HEAD(&pf_osfp_list
, fp_next
);
301 while ((entry
= SLIST_FIRST(&fp
->fp_oses
))) {
302 SLIST_REMOVE_HEAD(&fp
->fp_oses
, fp_entry
);
303 pool_put(&pf_osfp_entry_pl
, entry
);
305 pool_put(&pf_osfp_pl
, fp
);
310 /* Add a fingerprint */
312 pf_osfp_add(struct pf_osfp_ioctl
*fpioc
)
314 struct pf_os_fingerprint
*fp
, fpadd
;
315 struct pf_osfp_entry
*entry
;
317 memset(&fpadd
, 0, sizeof (fpadd
));
318 fpadd
.fp_tcpopts
= fpioc
->fp_tcpopts
;
319 fpadd
.fp_wsize
= fpioc
->fp_wsize
;
320 fpadd
.fp_psize
= fpioc
->fp_psize
;
321 fpadd
.fp_mss
= fpioc
->fp_mss
;
322 fpadd
.fp_flags
= fpioc
->fp_flags
;
323 fpadd
.fp_optcnt
= fpioc
->fp_optcnt
;
324 fpadd
.fp_wscale
= fpioc
->fp_wscale
;
325 fpadd
.fp_ttl
= fpioc
->fp_ttl
;
327 DPFPRINTF("adding osfp %s %s %s = %s%d:%d:%d:%s%d:0x%llx %d "
328 "(TS=%s,M=%s%d,W=%s%d) %x\n",
329 fpioc
->fp_os
.fp_class_nm
, fpioc
->fp_os
.fp_version_nm
,
330 fpioc
->fp_os
.fp_subtype_nm
,
331 (fpadd
.fp_flags
& PF_OSFP_WSIZE_MOD
) ? "%" :
332 (fpadd
.fp_flags
& PF_OSFP_WSIZE_MSS
) ? "S" :
333 (fpadd
.fp_flags
& PF_OSFP_WSIZE_MTU
) ? "T" :
334 (fpadd
.fp_flags
& PF_OSFP_WSIZE_DC
) ? "*" : "",
337 (fpadd
.fp_flags
& PF_OSFP_DF
) ? 1 : 0,
338 (fpadd
.fp_flags
& PF_OSFP_PSIZE_MOD
) ? "%" :
339 (fpadd
.fp_flags
& PF_OSFP_PSIZE_DC
) ? "*" : "",
341 (long long int)fpadd
.fp_tcpopts
, fpadd
.fp_optcnt
,
342 (fpadd
.fp_flags
& PF_OSFP_TS0
) ? "0" : "",
343 (fpadd
.fp_flags
& PF_OSFP_MSS_MOD
) ? "%" :
344 (fpadd
.fp_flags
& PF_OSFP_MSS_DC
) ? "*" : "",
346 (fpadd
.fp_flags
& PF_OSFP_WSCALE_MOD
) ? "%" :
347 (fpadd
.fp_flags
& PF_OSFP_WSCALE_DC
) ? "*" : "",
352 if ((fp
= pf_osfp_find_exact(&pf_osfp_list
, &fpadd
))) {
353 SLIST_FOREACH(entry
, &fp
->fp_oses
, fp_entry
) {
354 if (PF_OSFP_ENTRY_EQ(entry
, &fpioc
->fp_os
))
357 if ((entry
= pool_get(&pf_osfp_entry_pl
, PR_WAITOK
)) == NULL
)
360 if ((fp
= pool_get(&pf_osfp_pl
, PR_WAITOK
)) == NULL
)
362 memset(fp
, 0, sizeof (*fp
));
363 fp
->fp_tcpopts
= fpioc
->fp_tcpopts
;
364 fp
->fp_wsize
= fpioc
->fp_wsize
;
365 fp
->fp_psize
= fpioc
->fp_psize
;
366 fp
->fp_mss
= fpioc
->fp_mss
;
367 fp
->fp_flags
= fpioc
->fp_flags
;
368 fp
->fp_optcnt
= fpioc
->fp_optcnt
;
369 fp
->fp_wscale
= fpioc
->fp_wscale
;
370 fp
->fp_ttl
= fpioc
->fp_ttl
;
371 SLIST_INIT(&fp
->fp_oses
);
372 if ((entry
= pool_get(&pf_osfp_entry_pl
, PR_WAITOK
)) == NULL
) {
373 pool_put(&pf_osfp_pl
, fp
);
376 pf_osfp_insert(&pf_osfp_list
, fp
);
378 memcpy(entry
, &fpioc
->fp_os
, sizeof (*entry
));
380 /* Make sure the strings are NUL terminated */
381 entry
->fp_class_nm
[sizeof (entry
->fp_class_nm
)-1] = '\0';
382 entry
->fp_version_nm
[sizeof (entry
->fp_version_nm
)-1] = '\0';
383 entry
->fp_subtype_nm
[sizeof (entry
->fp_subtype_nm
)-1] = '\0';
385 SLIST_INSERT_HEAD(&fp
->fp_oses
, entry
, fp_entry
);
388 if ((fp
= pf_osfp_validate()))
389 printf("Invalid fingerprint list\n");
395 /* Find a fingerprint in the list */
396 struct pf_os_fingerprint
*
397 pf_osfp_find(struct pf_osfp_list
*list
, struct pf_os_fingerprint
*find
,
400 struct pf_os_fingerprint
*f
;
402 #define MATCH_INT(_MOD, _DC, _field) \
403 if ((f->fp_flags & _DC) == 0) { \
404 if ((f->fp_flags & _MOD) == 0) { \
405 if (f->_field != find->_field) \
408 if (f->_field == 0 || find->_field % f->_field) \
413 SLIST_FOREACH(f
, list
, fp_next
) {
414 if (f
->fp_tcpopts
!= find
->fp_tcpopts
||
415 f
->fp_optcnt
!= find
->fp_optcnt
||
416 f
->fp_ttl
< find
->fp_ttl
||
417 f
->fp_ttl
- find
->fp_ttl
> ttldiff
||
418 (f
->fp_flags
& (PF_OSFP_DF
|PF_OSFP_TS0
)) !=
419 (find
->fp_flags
& (PF_OSFP_DF
|PF_OSFP_TS0
)))
422 MATCH_INT(PF_OSFP_PSIZE_MOD
, PF_OSFP_PSIZE_DC
, fp_psize
)
423 MATCH_INT(PF_OSFP_MSS_MOD
, PF_OSFP_MSS_DC
, fp_mss
)
424 MATCH_INT(PF_OSFP_WSCALE_MOD
, PF_OSFP_WSCALE_DC
, fp_wscale
)
425 if ((f
->fp_flags
& PF_OSFP_WSIZE_DC
) == 0) {
426 if (f
->fp_flags
& PF_OSFP_WSIZE_MSS
) {
427 if (find
->fp_mss
== 0)
431 * Some "smart" NAT devices and DSL routers will tweak the MSS size and
432 * will set it to whatever is suitable for the link type.
434 #define SMART_MSS 1460
435 if ((find
->fp_wsize
% find
->fp_mss
||
436 find
->fp_wsize
/ find
->fp_mss
!=
438 (find
->fp_wsize
% SMART_MSS
||
439 find
->fp_wsize
/ SMART_MSS
!=
442 } else if (f
->fp_flags
& PF_OSFP_WSIZE_MTU
) {
443 if (find
->fp_mss
== 0)
446 #define MTUOFF (sizeof (struct ip) + sizeof (struct tcphdr))
447 #define SMART_MTU (SMART_MSS + MTUOFF)
448 if ((find
->fp_wsize
% (find
->fp_mss
+ MTUOFF
) ||
449 find
->fp_wsize
/ (find
->fp_mss
+ MTUOFF
) !=
451 (find
->fp_wsize
% SMART_MTU
||
452 find
->fp_wsize
/ SMART_MTU
!=
455 } else if (f
->fp_flags
& PF_OSFP_WSIZE_MOD
) {
456 if (f
->fp_wsize
== 0 || find
->fp_wsize
%
460 if (f
->fp_wsize
!= find
->fp_wsize
)
470 /* Find an exact fingerprint in the list */
471 struct pf_os_fingerprint
*
472 pf_osfp_find_exact(struct pf_osfp_list
*list
, struct pf_os_fingerprint
*find
)
474 struct pf_os_fingerprint
*f
;
476 SLIST_FOREACH(f
, list
, fp_next
) {
477 if (f
->fp_tcpopts
== find
->fp_tcpopts
&&
478 f
->fp_wsize
== find
->fp_wsize
&&
479 f
->fp_psize
== find
->fp_psize
&&
480 f
->fp_mss
== find
->fp_mss
&&
481 f
->fp_flags
== find
->fp_flags
&&
482 f
->fp_optcnt
== find
->fp_optcnt
&&
483 f
->fp_wscale
== find
->fp_wscale
&&
484 f
->fp_ttl
== find
->fp_ttl
)
491 /* Insert a fingerprint into the list */
493 pf_osfp_insert(struct pf_osfp_list
*list
, struct pf_os_fingerprint
*ins
)
495 struct pf_os_fingerprint
*f
, *prev
= NULL
;
497 /* XXX need to go semi tree based. can key on tcp options */
499 SLIST_FOREACH(f
, list
, fp_next
)
502 SLIST_INSERT_AFTER(prev
, ins
, fp_next
);
504 SLIST_INSERT_HEAD(list
, ins
, fp_next
);
507 /* Fill a fingerprint by its number (from an ioctl) */
509 pf_osfp_get(struct pf_osfp_ioctl
*fpioc
)
511 struct pf_os_fingerprint
*fp
;
512 struct pf_osfp_entry
*entry
;
513 int num
= fpioc
->fp_getnum
;
517 memset(fpioc
, 0, sizeof (*fpioc
));
518 SLIST_FOREACH(fp
, &pf_osfp_list
, fp_next
) {
519 SLIST_FOREACH(entry
, &fp
->fp_oses
, fp_entry
) {
521 fpioc
->fp_mss
= fp
->fp_mss
;
522 fpioc
->fp_wsize
= fp
->fp_wsize
;
523 fpioc
->fp_flags
= fp
->fp_flags
;
524 fpioc
->fp_psize
= fp
->fp_psize
;
525 fpioc
->fp_ttl
= fp
->fp_ttl
;
526 fpioc
->fp_wscale
= fp
->fp_wscale
;
527 fpioc
->fp_getnum
= num
;
528 memcpy(&fpioc
->fp_os
, entry
,
529 sizeof (fpioc
->fp_os
));
539 /* Validate that each signature is reachable */
540 struct pf_os_fingerprint
*
541 pf_osfp_validate(void)
543 struct pf_os_fingerprint
*f
, *f2
, find
;
545 SLIST_FOREACH(f
, &pf_osfp_list
, fp_next
) {
546 memcpy(&find
, f
, sizeof (find
));
548 /* We do a few MSS/th_win percolations to make things unique */
549 if (find
.fp_mss
== 0)
551 if (f
->fp_flags
& PF_OSFP_WSIZE_MSS
)
552 find
.fp_wsize
*= find
.fp_mss
, 1;
553 else if (f
->fp_flags
& PF_OSFP_WSIZE_MTU
)
554 find
.fp_wsize
*= (find
.fp_mss
+ 40);
555 else if (f
->fp_flags
& PF_OSFP_WSIZE_MOD
)
557 if (f
!= (f2
= pf_osfp_find(&pf_osfp_list
, &find
, 0))) {
559 printf("Found \"%s %s %s\" instead of "
561 SLIST_FIRST(&f2
->fp_oses
)->fp_class_nm
,
562 SLIST_FIRST(&f2
->fp_oses
)->fp_version_nm
,
563 SLIST_FIRST(&f2
->fp_oses
)->fp_subtype_nm
,
564 SLIST_FIRST(&f
->fp_oses
)->fp_class_nm
,
565 SLIST_FIRST(&f
->fp_oses
)->fp_version_nm
,
566 SLIST_FIRST(&f
->fp_oses
)->fp_subtype_nm
);
568 printf("Couldn't find \"%s %s %s\"\n",
569 SLIST_FIRST(&f
->fp_oses
)->fp_class_nm
,
570 SLIST_FIRST(&f
->fp_oses
)->fp_version_nm
,
571 SLIST_FIRST(&f
->fp_oses
)->fp_subtype_nm
);