]>
git.saurik.com Git - apple/xnu.git/blob - bsd/net/pf_osfp.c
2 * Copyright (c) 2007-2020 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>
64 #include <netinet/ip6.h>
65 #include <netinet6/in6_var.h>
67 #define DPFPRINTF(format, x...) \
68 if (pf_status.debug >= PF_DEBUG_NOISY) \
71 static SLIST_HEAD(pf_osfp_list
, pf_os_fingerprint
) pf_osfp_list
;
72 static struct pool pf_osfp_entry_pl
;
73 static struct pool pf_osfp_pl
;
75 static struct pf_os_fingerprint
*pf_osfp_find(struct pf_osfp_list
*,
76 struct pf_os_fingerprint
*, u_int8_t
);
77 static struct pf_os_fingerprint
*pf_osfp_find_exact(struct pf_osfp_list
*,
78 struct pf_os_fingerprint
*);
79 static void pf_osfp_insert(struct pf_osfp_list
*, struct pf_os_fingerprint
*);
83 * Passively fingerprint the OS of the host (IPv4 TCP SYN packets only)
84 * Returns the list of possible OSes.
86 struct pf_osfp_enlist
*
87 pf_osfp_fingerprint(struct pf_pdesc
*pd
, pbuf_t
*pbuf
, int off
,
88 const struct tcphdr
*tcp
)
94 if ((pd
->af
!= PF_INET
&& pd
->af
!= PF_INET6
) ||
95 pd
->proto
!= IPPROTO_TCP
||
96 (tcp
->th_off
<< 2) < (int)sizeof(*tcp
)) {
100 if (pd
->af
== PF_INET
) {
102 ip6
= (struct ip6_hdr
*)NULL
;
104 ip
= (struct ip
*)NULL
;
107 if (!pf_pull_hdr(pbuf
, off
, hdr
, tcp
->th_off
<< 2, NULL
, NULL
,
112 return pf_osfp_fingerprint_hdr(ip
, ip6
, (struct tcphdr
*)(void *)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
)
119 struct pf_os_fingerprint fp
, *fpresult
;
121 const u_int8_t
*optp
;
124 if ((tcp
->th_flags
& (TH_SYN
| TH_ACK
)) != TH_SYN
) {
128 if ((ip
->ip_off
& htons(IP_OFFMASK
)) != 0) {
133 memset(&fp
, 0, sizeof(fp
));
136 fp
.fp_psize
= ntohs(ip
->ip_len
);
137 fp
.fp_ttl
= ip
->ip_ttl
;
138 if (ip
->ip_off
& htons(IP_DF
)) {
139 fp
.fp_flags
|= PF_OSFP_DF
;
141 (void) inet_ntop(AF_INET
, &ip
->ip_src
, srcname
,
142 (socklen_t
)sizeof(srcname
));
145 fp
.fp_psize
= sizeof(struct ip6_hdr
) + ntohs(ip6
->ip6_plen
);
146 fp
.fp_ttl
= ip6
->ip6_hlim
;
147 fp
.fp_flags
|= PF_OSFP_DF
;
148 fp
.fp_flags
|= PF_OSFP_INET6
;
149 (void) inet_ntop(AF_INET6
, &ip6
->ip6_src
, srcname
,
150 (socklen_t
)sizeof(srcname
));
154 fp
.fp_wsize
= ntohs(tcp
->th_win
);
157 cnt
= (tcp
->th_off
<< 2) - sizeof(*tcp
);
158 optp
= (const u_int8_t
*)((const char *)tcp
+ sizeof(*tcp
));
159 for (; cnt
> 0; cnt
-= optlen
, optp
+= optlen
) {
160 if (*optp
== TCPOPT_EOL
) {
165 if (*optp
== TCPOPT_NOP
) {
166 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<< PF_OSFP_TCPOPT_BITS
) |
174 if (optlen
> cnt
|| optlen
< 2) {
179 if (optlen
>= TCPOLEN_MAXSEG
) {
180 memcpy(&fp
.fp_mss
, &optp
[2],
183 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
184 PF_OSFP_TCPOPT_BITS
) | PF_OSFP_TCPOPT_MSS
;
185 #if BYTE_ORDER != BIG_ENDIAN
190 if (optlen
>= TCPOLEN_WINDOW
) {
191 memcpy(&fp
.fp_wscale
, &optp
[2],
192 sizeof(fp
.fp_wscale
));
194 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
195 PF_OSFP_TCPOPT_BITS
) |
196 PF_OSFP_TCPOPT_WSCALE
;
198 case TCPOPT_SACK_PERMITTED
:
199 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
200 PF_OSFP_TCPOPT_BITS
) | PF_OSFP_TCPOPT_SACK
;
202 case TCPOPT_TIMESTAMP
:
203 if (optlen
>= TCPOLEN_TIMESTAMP
) {
205 memcpy(&ts
, &optp
[2], sizeof(ts
));
207 fp
.fp_flags
|= PF_OSFP_TS0
;
210 fp
.fp_tcpopts
= (fp
.fp_tcpopts
<<
211 PF_OSFP_TCPOPT_BITS
) | PF_OSFP_TCPOPT_TS
;
217 optlen
= MAX(optlen
, 1); /* paranoia */
220 DPFPRINTF("fingerprinted %s:%d %d:%d:%d:%d:%llx (%d) "
221 "(TS=%s,M=%s%d,W=%s%d)\n",
222 srcname
, ntohs(tcp
->th_sport
),
223 fp
.fp_wsize
, fp
.fp_ttl
, (fp
.fp_flags
& PF_OSFP_DF
) != 0,
224 fp
.fp_psize
, (long long int)fp
.fp_tcpopts
, fp
.fp_optcnt
,
225 (fp
.fp_flags
& PF_OSFP_TS0
) ? "0" : "",
226 (fp
.fp_flags
& PF_OSFP_MSS_MOD
) ? "%" :
227 (fp
.fp_flags
& PF_OSFP_MSS_DC
) ? "*" : "",
229 (fp
.fp_flags
& PF_OSFP_WSCALE_MOD
) ? "%" :
230 (fp
.fp_flags
& PF_OSFP_WSCALE_DC
) ? "*" : "",
233 if ((fpresult
= pf_osfp_find(&pf_osfp_list
, &fp
,
234 PF_OSFP_MAXTTL_OFFSET
))) {
235 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
) {
252 DPFPRINTF("osfp no match against %x\n", os
);
253 return os
== PF_OSFP_UNKNOWN
;
255 PF_OSFP_UNPACK(os
, os_class
, os_version
, os_subtype
);
256 SLIST_FOREACH(entry
, list
, fp_entry
) {
257 PF_OSFP_UNPACK(entry
->fp_os
, en_class
, en_version
, en_subtype
);
258 if ((os_class
== PF_OSFP_ANY
|| en_class
== os_class
) &&
259 (os_version
== PF_OSFP_ANY
|| en_version
== os_version
) &&
260 (os_subtype
== PF_OSFP_ANY
|| en_subtype
== os_subtype
)) {
261 DPFPRINTF("osfp matched %s %s %s %x==%x\n",
262 entry
->fp_class_nm
, entry
->fp_version_nm
,
263 entry
->fp_subtype_nm
, os
, entry
->fp_os
);
267 DPFPRINTF("fingerprint 0x%x didn't match\n", os
);
271 /* Initialize the OS fingerprint system */
273 pf_osfp_initialize(void)
275 pool_init(&pf_osfp_entry_pl
, sizeof(struct pf_osfp_entry
), 0, 0, 0,
277 pool_init(&pf_osfp_pl
, sizeof(struct pf_os_fingerprint
), 0, 0, 0,
279 SLIST_INIT(&pf_osfp_list
);
284 pf_osfp_destroy(void)
288 pool_destroy(&pf_osfp_pl
);
289 pool_destroy(&pf_osfp_entry_pl
);
293 /* Flush the fingerprint list */
297 struct pf_os_fingerprint
*fp
;
298 struct pf_osfp_entry
*entry
;
300 while ((fp
= SLIST_FIRST(&pf_osfp_list
))) {
301 SLIST_REMOVE_HEAD(&pf_osfp_list
, fp_next
);
302 while ((entry
= SLIST_FIRST(&fp
->fp_oses
))) {
303 SLIST_REMOVE_HEAD(&fp
->fp_oses
, fp_entry
);
304 pool_put(&pf_osfp_entry_pl
, entry
);
306 pool_put(&pf_osfp_pl
, fp
);
311 /* Add a fingerprint */
313 pf_osfp_add(struct pf_osfp_ioctl
*fpioc
)
315 struct pf_os_fingerprint
*fp
, fpadd
;
316 struct pf_osfp_entry
*entry
, *uentry
;
318 memset(&fpadd
, 0, sizeof(fpadd
));
319 fpadd
.fp_tcpopts
= fpioc
->fp_tcpopts
;
320 fpadd
.fp_wsize
= fpioc
->fp_wsize
;
321 fpadd
.fp_psize
= fpioc
->fp_psize
;
322 fpadd
.fp_mss
= fpioc
->fp_mss
;
323 fpadd
.fp_flags
= fpioc
->fp_flags
;
324 fpadd
.fp_optcnt
= fpioc
->fp_optcnt
;
325 fpadd
.fp_wscale
= fpioc
->fp_wscale
;
326 fpadd
.fp_ttl
= fpioc
->fp_ttl
;
328 uentry
= &fpioc
->fp_os
;
329 uentry
->fp_entry
.sle_next
= NULL
;
330 uentry
->fp_class_nm
[sizeof(uentry
->fp_class_nm
) - 1] = '\0';
331 uentry
->fp_version_nm
[sizeof(uentry
->fp_version_nm
) - 1] = '\0';
332 uentry
->fp_subtype_nm
[sizeof(uentry
->fp_subtype_nm
) - 1] = '\0';
334 DPFPRINTF("adding osfp %s %s %s = %s%d:%d:%d:%s%d:0x%llx %d "
335 "(TS=%s,M=%s%d,W=%s%d) %x\n",
336 fpioc
->fp_os
.fp_class_nm
, fpioc
->fp_os
.fp_version_nm
,
337 fpioc
->fp_os
.fp_subtype_nm
,
338 (fpadd
.fp_flags
& PF_OSFP_WSIZE_MOD
) ? "%" :
339 (fpadd
.fp_flags
& PF_OSFP_WSIZE_MSS
) ? "S" :
340 (fpadd
.fp_flags
& PF_OSFP_WSIZE_MTU
) ? "T" :
341 (fpadd
.fp_flags
& PF_OSFP_WSIZE_DC
) ? "*" : "",
344 (fpadd
.fp_flags
& PF_OSFP_DF
) ? 1 : 0,
345 (fpadd
.fp_flags
& PF_OSFP_PSIZE_MOD
) ? "%" :
346 (fpadd
.fp_flags
& PF_OSFP_PSIZE_DC
) ? "*" : "",
348 (long long int)fpadd
.fp_tcpopts
, fpadd
.fp_optcnt
,
349 (fpadd
.fp_flags
& PF_OSFP_TS0
) ? "0" : "",
350 (fpadd
.fp_flags
& PF_OSFP_MSS_MOD
) ? "%" :
351 (fpadd
.fp_flags
& PF_OSFP_MSS_DC
) ? "*" : "",
353 (fpadd
.fp_flags
& PF_OSFP_WSCALE_MOD
) ? "%" :
354 (fpadd
.fp_flags
& PF_OSFP_WSCALE_DC
) ? "*" : "",
359 if ((fp
= pf_osfp_find_exact(&pf_osfp_list
, &fpadd
))) {
360 SLIST_FOREACH(entry
, &fp
->fp_oses
, fp_entry
) {
361 if (PF_OSFP_ENTRY_EQ(entry
, &fpioc
->fp_os
)) {
365 if ((entry
= pool_get(&pf_osfp_entry_pl
, PR_WAITOK
)) == NULL
) {
369 if ((fp
= pool_get(&pf_osfp_pl
, PR_WAITOK
)) == NULL
) {
372 memset(fp
, 0, sizeof(*fp
));
373 fp
->fp_tcpopts
= fpioc
->fp_tcpopts
;
374 fp
->fp_wsize
= fpioc
->fp_wsize
;
375 fp
->fp_psize
= fpioc
->fp_psize
;
376 fp
->fp_mss
= fpioc
->fp_mss
;
377 fp
->fp_flags
= fpioc
->fp_flags
;
378 fp
->fp_optcnt
= fpioc
->fp_optcnt
;
379 fp
->fp_wscale
= fpioc
->fp_wscale
;
380 fp
->fp_ttl
= fpioc
->fp_ttl
;
381 SLIST_INIT(&fp
->fp_oses
);
382 if ((entry
= pool_get(&pf_osfp_entry_pl
, PR_WAITOK
)) == NULL
) {
383 pool_put(&pf_osfp_pl
, fp
);
386 pf_osfp_insert(&pf_osfp_list
, fp
);
388 memcpy(entry
, &fpioc
->fp_os
, sizeof(*entry
));
390 /* Make sure the strings are NUL terminated */
391 entry
->fp_class_nm
[sizeof(entry
->fp_class_nm
) - 1] = '\0';
392 entry
->fp_version_nm
[sizeof(entry
->fp_version_nm
) - 1] = '\0';
393 entry
->fp_subtype_nm
[sizeof(entry
->fp_subtype_nm
) - 1] = '\0';
395 SLIST_INSERT_HEAD(&fp
->fp_oses
, entry
, fp_entry
);
398 if ((fp
= pf_osfp_validate())) {
399 printf("Invalid fingerprint list\n");
406 /* Find a fingerprint in the list */
407 struct pf_os_fingerprint
*
408 pf_osfp_find(struct pf_osfp_list
*list
, struct pf_os_fingerprint
*find
,
411 struct pf_os_fingerprint
*f
;
413 #define MATCH_INT(_MOD, _DC, _field) \
414 if ((f->fp_flags & _DC) == 0) { \
415 if ((f->fp_flags & _MOD) == 0) { \
416 if (f->_field != find->_field) \
419 if (f->_field == 0 || find->_field % f->_field) \
424 SLIST_FOREACH(f
, list
, fp_next
) {
425 if (f
->fp_tcpopts
!= find
->fp_tcpopts
||
426 f
->fp_optcnt
!= find
->fp_optcnt
||
427 f
->fp_ttl
< find
->fp_ttl
||
428 f
->fp_ttl
- find
->fp_ttl
> ttldiff
||
429 (f
->fp_flags
& (PF_OSFP_DF
| PF_OSFP_TS0
)) !=
430 (find
->fp_flags
& (PF_OSFP_DF
| PF_OSFP_TS0
))) {
434 MATCH_INT(PF_OSFP_PSIZE_MOD
, PF_OSFP_PSIZE_DC
, fp_psize
)
435 MATCH_INT(PF_OSFP_MSS_MOD
, PF_OSFP_MSS_DC
, fp_mss
)
436 MATCH_INT(PF_OSFP_WSCALE_MOD
, PF_OSFP_WSCALE_DC
, fp_wscale
)
437 if ((f
->fp_flags
& PF_OSFP_WSIZE_DC
) == 0) {
438 if (f
->fp_flags
& PF_OSFP_WSIZE_MSS
) {
439 if (find
->fp_mss
== 0) {
444 * Some "smart" NAT devices and DSL routers will tweak the MSS size and
445 * will set it to whatever is suitable for the link type.
447 #define SMART_MSS 1460
448 if ((find
->fp_wsize
% find
->fp_mss
||
449 find
->fp_wsize
/ find
->fp_mss
!=
451 (find
->fp_wsize
% SMART_MSS
||
452 find
->fp_wsize
/ SMART_MSS
!=
456 } else if (f
->fp_flags
& PF_OSFP_WSIZE_MTU
) {
457 if (find
->fp_mss
== 0) {
461 #define MTUOFF (sizeof (struct ip) + sizeof (struct tcphdr))
462 #define SMART_MTU (SMART_MSS + MTUOFF)
463 if ((find
->fp_wsize
% (find
->fp_mss
+ MTUOFF
) ||
464 find
->fp_wsize
/ (find
->fp_mss
+ MTUOFF
) !=
466 (find
->fp_wsize
% SMART_MTU
||
467 find
->fp_wsize
/ SMART_MTU
!=
471 } else if (f
->fp_flags
& PF_OSFP_WSIZE_MOD
) {
472 if (f
->fp_wsize
== 0 || find
->fp_wsize
%
477 if (f
->fp_wsize
!= find
->fp_wsize
) {
488 /* Find an exact fingerprint in the list */
489 struct pf_os_fingerprint
*
490 pf_osfp_find_exact(struct pf_osfp_list
*list
, struct pf_os_fingerprint
*find
)
492 struct pf_os_fingerprint
*f
;
494 SLIST_FOREACH(f
, list
, fp_next
) {
495 if (f
->fp_tcpopts
== find
->fp_tcpopts
&&
496 f
->fp_wsize
== find
->fp_wsize
&&
497 f
->fp_psize
== find
->fp_psize
&&
498 f
->fp_mss
== find
->fp_mss
&&
499 f
->fp_flags
== find
->fp_flags
&&
500 f
->fp_optcnt
== find
->fp_optcnt
&&
501 f
->fp_wscale
== find
->fp_wscale
&&
502 f
->fp_ttl
== find
->fp_ttl
) {
510 /* Insert a fingerprint into the list */
512 pf_osfp_insert(struct pf_osfp_list
*list
, struct pf_os_fingerprint
*ins
)
514 struct pf_os_fingerprint
*f
, *prev
= NULL
;
516 /* XXX need to go semi tree based. can key on tcp options */
518 SLIST_FOREACH(f
, list
, fp_next
)
521 SLIST_INSERT_AFTER(prev
, ins
, fp_next
);
523 SLIST_INSERT_HEAD(list
, ins
, fp_next
);
527 /* Fill a fingerprint by its number (from an ioctl) */
529 pf_osfp_get(struct pf_osfp_ioctl
*fpioc
)
531 struct pf_os_fingerprint
*fp
;
532 struct pf_osfp_entry
*entry
;
533 int num
= fpioc
->fp_getnum
;
537 memset(fpioc
, 0, sizeof(*fpioc
));
538 SLIST_FOREACH(fp
, &pf_osfp_list
, fp_next
) {
539 SLIST_FOREACH(entry
, &fp
->fp_oses
, fp_entry
) {
541 fpioc
->fp_mss
= fp
->fp_mss
;
542 fpioc
->fp_wsize
= fp
->fp_wsize
;
543 fpioc
->fp_flags
= fp
->fp_flags
;
544 fpioc
->fp_psize
= fp
->fp_psize
;
545 fpioc
->fp_ttl
= fp
->fp_ttl
;
546 fpioc
->fp_wscale
= fp
->fp_wscale
;
547 fpioc
->fp_getnum
= num
;
548 memcpy(&fpioc
->fp_os
, entry
,
549 sizeof(fpioc
->fp_os
));
550 fpioc
->fp_os
.fp_entry
.sle_next
= NULL
;
560 /* Validate that each signature is reachable */
561 struct pf_os_fingerprint
*
562 pf_osfp_validate(void)
564 struct pf_os_fingerprint
*f
, *f2
, find
;
566 SLIST_FOREACH(f
, &pf_osfp_list
, fp_next
) {
567 memcpy(&find
, f
, sizeof(find
));
569 /* We do a few MSS/th_win percolations to make things unique */
570 if (find
.fp_mss
== 0) {
573 if (f
->fp_flags
& PF_OSFP_WSIZE_MSS
) {
574 find
.fp_wsize
*= find
.fp_mss
;
575 } else if (f
->fp_flags
& PF_OSFP_WSIZE_MTU
) {
576 find
.fp_wsize
*= (find
.fp_mss
+ 40);
577 } else if (f
->fp_flags
& PF_OSFP_WSIZE_MOD
) {
580 if (f
!= (f2
= pf_osfp_find(&pf_osfp_list
, &find
, 0))) {
582 printf("Found \"%s %s %s\" instead of "
584 SLIST_FIRST(&f2
->fp_oses
)->fp_class_nm
,
585 SLIST_FIRST(&f2
->fp_oses
)->fp_version_nm
,
586 SLIST_FIRST(&f2
->fp_oses
)->fp_subtype_nm
,
587 SLIST_FIRST(&f
->fp_oses
)->fp_class_nm
,
588 SLIST_FIRST(&f
->fp_oses
)->fp_version_nm
,
589 SLIST_FIRST(&f
->fp_oses
)->fp_subtype_nm
);
591 printf("Couldn't find \"%s %s %s\"\n",
592 SLIST_FIRST(&f
->fp_oses
)->fp_class_nm
,
593 SLIST_FIRST(&f
->fp_oses
)->fp_version_nm
,
594 SLIST_FIRST(&f
->fp_oses
)->fp_subtype_nm
);