2 * Copyright (c) 2003 Mike Frantzen <frantzen@w4g.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 * $OpenBSD: pf_osfp.c,v 1.14 2008/06/12 18:17:01 henning Exp $
19 #include <sys/cdefs.h>
20 __FBSDID("$FreeBSD$");
22 #include <sys/param.h>
23 #include <sys/kernel.h>
26 #include <sys/rwlock.h>
27 #include <sys/socket.h>
29 #include <netinet/in.h>
30 #include <netinet/ip.h>
31 #include <netinet/tcp.h>
35 #include <net/pfvar.h>
37 #include <netinet/ip6.h>
39 static MALLOC_DEFINE(M_PFOSFP, "pf_osfp", "pf(4) operating system fingerprints");
40 #define DPFPRINTF(format, x...) \
41 if (V_pf_status.debug >= PF_DEBUG_NOISY) \
44 SLIST_HEAD(pf_osfp_list, pf_os_fingerprint);
45 static VNET_DEFINE(struct pf_osfp_list, pf_osfp_list) =
46 SLIST_HEAD_INITIALIZER();
47 #define V_pf_osfp_list VNET(pf_osfp_list)
49 static struct pf_osfp_enlist *pf_osfp_fingerprint_hdr(const struct ip *,
50 const struct ip6_hdr *,
51 const struct tcphdr *);
52 static struct pf_os_fingerprint *pf_osfp_find(struct pf_osfp_list *,
53 struct pf_os_fingerprint *, u_int8_t);
54 static struct pf_os_fingerprint *pf_osfp_find_exact(struct pf_osfp_list *,
55 struct pf_os_fingerprint *);
56 static void pf_osfp_insert(struct pf_osfp_list *,
57 struct pf_os_fingerprint *);
59 static struct pf_os_fingerprint *pf_osfp_validate(void);
63 * Passively fingerprint the OS of the host (IPv4 TCP SYN packets only)
64 * Returns the list of possible OSes.
66 struct pf_osfp_enlist *
67 pf_osfp_fingerprint(struct pf_pdesc *pd, struct mbuf *m, int off,
68 const struct tcphdr *tcp)
74 if ((pd->af != PF_INET && pd->af != PF_INET6) ||
75 pd->proto != IPPROTO_TCP || (tcp->th_off << 2) < sizeof(*tcp))
78 if (pd->af == PF_INET) {
79 ip = mtod(m, struct ip *);
80 ip6 = (struct ip6_hdr *)NULL;
82 ip = (struct ip *)NULL;
83 ip6 = mtod(m, struct ip6_hdr *);
85 if (!pf_pull_hdr(m, off, hdr, tcp->th_off << 2, NULL, NULL,
86 pd->af)) return (NULL);
88 return (pf_osfp_fingerprint_hdr(ip, ip6, (struct tcphdr *)hdr));
91 static struct pf_osfp_enlist *
92 pf_osfp_fingerprint_hdr(const struct ip *ip, const struct ip6_hdr *ip6, const struct tcphdr *tcp)
94 struct pf_os_fingerprint fp, *fpresult;
99 if ((tcp->th_flags & (TH_SYN|TH_ACK)) != TH_SYN)
102 if ((ip->ip_off & htons(IP_OFFMASK)) != 0)
106 memset(&fp, 0, sizeof(fp));
109 fp.fp_psize = ntohs(ip->ip_len);
110 fp.fp_ttl = ip->ip_ttl;
111 if (ip->ip_off & htons(IP_DF))
112 fp.fp_flags |= PF_OSFP_DF;
113 strlcpy(srcname, inet_ntoa(ip->ip_src), sizeof(srcname));
118 fp.fp_psize = sizeof(struct ip6_hdr) + ntohs(ip6->ip6_plen);
119 fp.fp_ttl = ip6->ip6_hlim;
120 fp.fp_flags |= PF_OSFP_DF;
121 fp.fp_flags |= PF_OSFP_INET6;
122 strlcpy(srcname, ip6_sprintf((struct in6_addr *)&ip6->ip6_src),
128 fp.fp_wsize = ntohs(tcp->th_win);
131 cnt = (tcp->th_off << 2) - sizeof(*tcp);
132 optp = (const u_int8_t *)((const char *)tcp + sizeof(*tcp));
133 for (; cnt > 0; cnt -= optlen, optp += optlen) {
134 if (*optp == TCPOPT_EOL)
138 if (*optp == TCPOPT_NOP) {
139 fp.fp_tcpopts = (fp.fp_tcpopts << PF_OSFP_TCPOPT_BITS) |
146 if (optlen > cnt || optlen < 2)
150 if (optlen >= TCPOLEN_MAXSEG)
151 memcpy(&fp.fp_mss, &optp[2],
153 fp.fp_tcpopts = (fp.fp_tcpopts <<
154 PF_OSFP_TCPOPT_BITS) | PF_OSFP_TCPOPT_MSS;
158 if (optlen >= TCPOLEN_WINDOW)
159 memcpy(&fp.fp_wscale, &optp[2],
160 sizeof(fp.fp_wscale));
162 fp.fp_tcpopts = (fp.fp_tcpopts <<
163 PF_OSFP_TCPOPT_BITS) |
164 PF_OSFP_TCPOPT_WSCALE;
166 case TCPOPT_SACK_PERMITTED:
167 fp.fp_tcpopts = (fp.fp_tcpopts <<
168 PF_OSFP_TCPOPT_BITS) | PF_OSFP_TCPOPT_SACK;
170 case TCPOPT_TIMESTAMP:
171 if (optlen >= TCPOLEN_TIMESTAMP) {
173 memcpy(&ts, &optp[2], sizeof(ts));
175 fp.fp_flags |= PF_OSFP_TS0;
178 fp.fp_tcpopts = (fp.fp_tcpopts <<
179 PF_OSFP_TCPOPT_BITS) | PF_OSFP_TCPOPT_TS;
185 optlen = MAX(optlen, 1); /* paranoia */
188 DPFPRINTF("fingerprinted %s:%d %d:%d:%d:%d:%llx (%d) "
189 "(TS=%s,M=%s%d,W=%s%d)\n",
190 srcname, ntohs(tcp->th_sport),
191 fp.fp_wsize, fp.fp_ttl, (fp.fp_flags & PF_OSFP_DF) != 0,
192 fp.fp_psize, (long long int)fp.fp_tcpopts, fp.fp_optcnt,
193 (fp.fp_flags & PF_OSFP_TS0) ? "0" : "",
194 (fp.fp_flags & PF_OSFP_MSS_MOD) ? "%" :
195 (fp.fp_flags & PF_OSFP_MSS_DC) ? "*" : "",
197 (fp.fp_flags & PF_OSFP_WSCALE_MOD) ? "%" :
198 (fp.fp_flags & PF_OSFP_WSCALE_DC) ? "*" : "",
201 if ((fpresult = pf_osfp_find(&V_pf_osfp_list, &fp,
202 PF_OSFP_MAXTTL_OFFSET)))
203 return (&fpresult->fp_oses);
207 /* Match a fingerprint ID against a list of OSes */
209 pf_osfp_match(struct pf_osfp_enlist *list, pf_osfp_t os)
211 struct pf_osfp_entry *entry;
212 int os_class, os_version, os_subtype;
213 int en_class, en_version, en_subtype;
215 if (os == PF_OSFP_ANY)
218 DPFPRINTF("osfp no match against %x\n", os);
219 return (os == PF_OSFP_UNKNOWN);
221 PF_OSFP_UNPACK(os, os_class, os_version, os_subtype);
222 SLIST_FOREACH(entry, list, fp_entry) {
223 PF_OSFP_UNPACK(entry->fp_os, en_class, en_version, en_subtype);
224 if ((os_class == PF_OSFP_ANY || en_class == os_class) &&
225 (os_version == PF_OSFP_ANY || en_version == os_version) &&
226 (os_subtype == PF_OSFP_ANY || en_subtype == os_subtype)) {
227 DPFPRINTF("osfp matched %s %s %s %x==%x\n",
228 entry->fp_class_nm, entry->fp_version_nm,
229 entry->fp_subtype_nm, os, entry->fp_os);
233 DPFPRINTF("fingerprint 0x%x didn't match\n", os);
237 /* Flush the fingerprint list */
241 struct pf_os_fingerprint *fp;
242 struct pf_osfp_entry *entry;
244 while ((fp = SLIST_FIRST(&V_pf_osfp_list))) {
245 SLIST_REMOVE_HEAD(&V_pf_osfp_list, fp_next);
246 while ((entry = SLIST_FIRST(&fp->fp_oses))) {
247 SLIST_REMOVE_HEAD(&fp->fp_oses, fp_entry);
248 free(entry, M_PFOSFP);
255 /* Add a fingerprint */
257 pf_osfp_add(struct pf_osfp_ioctl *fpioc)
259 struct pf_os_fingerprint *fp, fpadd;
260 struct pf_osfp_entry *entry;
264 memset(&fpadd, 0, sizeof(fpadd));
265 fpadd.fp_tcpopts = fpioc->fp_tcpopts;
266 fpadd.fp_wsize = fpioc->fp_wsize;
267 fpadd.fp_psize = fpioc->fp_psize;
268 fpadd.fp_mss = fpioc->fp_mss;
269 fpadd.fp_flags = fpioc->fp_flags;
270 fpadd.fp_optcnt = fpioc->fp_optcnt;
271 fpadd.fp_wscale = fpioc->fp_wscale;
272 fpadd.fp_ttl = fpioc->fp_ttl;
274 #if 0 /* XXX RYAN wants to fix logging */
275 DPFPRINTF("adding osfp %s %s %s = %s%d:%d:%d:%s%d:0x%llx %d "
276 "(TS=%s,M=%s%d,W=%s%d) %x\n",
277 fpioc->fp_os.fp_class_nm, fpioc->fp_os.fp_version_nm,
278 fpioc->fp_os.fp_subtype_nm,
279 (fpadd.fp_flags & PF_OSFP_WSIZE_MOD) ? "%" :
280 (fpadd.fp_flags & PF_OSFP_WSIZE_MSS) ? "S" :
281 (fpadd.fp_flags & PF_OSFP_WSIZE_MTU) ? "T" :
282 (fpadd.fp_flags & PF_OSFP_WSIZE_DC) ? "*" : "",
285 (fpadd.fp_flags & PF_OSFP_DF) ? 1 : 0,
286 (fpadd.fp_flags & PF_OSFP_PSIZE_MOD) ? "%" :
287 (fpadd.fp_flags & PF_OSFP_PSIZE_DC) ? "*" : "",
289 (long long int)fpadd.fp_tcpopts, fpadd.fp_optcnt,
290 (fpadd.fp_flags & PF_OSFP_TS0) ? "0" : "",
291 (fpadd.fp_flags & PF_OSFP_MSS_MOD) ? "%" :
292 (fpadd.fp_flags & PF_OSFP_MSS_DC) ? "*" : "",
294 (fpadd.fp_flags & PF_OSFP_WSCALE_MOD) ? "%" :
295 (fpadd.fp_flags & PF_OSFP_WSCALE_DC) ? "*" : "",
300 if ((fp = pf_osfp_find_exact(&V_pf_osfp_list, &fpadd))) {
301 SLIST_FOREACH(entry, &fp->fp_oses, fp_entry) {
302 if (PF_OSFP_ENTRY_EQ(entry, &fpioc->fp_os))
305 if ((entry = malloc(sizeof(*entry), M_PFOSFP, M_NOWAIT))
309 if ((fp = malloc(sizeof(*fp), M_PFOSFP, M_ZERO | M_NOWAIT))
312 fp->fp_tcpopts = fpioc->fp_tcpopts;
313 fp->fp_wsize = fpioc->fp_wsize;
314 fp->fp_psize = fpioc->fp_psize;
315 fp->fp_mss = fpioc->fp_mss;
316 fp->fp_flags = fpioc->fp_flags;
317 fp->fp_optcnt = fpioc->fp_optcnt;
318 fp->fp_wscale = fpioc->fp_wscale;
319 fp->fp_ttl = fpioc->fp_ttl;
320 SLIST_INIT(&fp->fp_oses);
321 if ((entry = malloc(sizeof(*entry), M_PFOSFP, M_NOWAIT))
326 pf_osfp_insert(&V_pf_osfp_list, fp);
328 memcpy(entry, &fpioc->fp_os, sizeof(*entry));
330 /* Make sure the strings are NUL terminated */
331 entry->fp_class_nm[sizeof(entry->fp_class_nm)-1] = '\0';
332 entry->fp_version_nm[sizeof(entry->fp_version_nm)-1] = '\0';
333 entry->fp_subtype_nm[sizeof(entry->fp_subtype_nm)-1] = '\0';
335 SLIST_INSERT_HEAD(&fp->fp_oses, entry, fp_entry);
338 if ((fp = pf_osfp_validate()))
339 printf("Invalid fingerprint list\n");
345 /* Find a fingerprint in the list */
346 static struct pf_os_fingerprint *
347 pf_osfp_find(struct pf_osfp_list *list, struct pf_os_fingerprint *find,
350 struct pf_os_fingerprint *f;
352 #define MATCH_INT(_MOD, _DC, _field) \
353 if ((f->fp_flags & _DC) == 0) { \
354 if ((f->fp_flags & _MOD) == 0) { \
355 if (f->_field != find->_field) \
358 if (f->_field == 0 || find->_field % f->_field) \
363 SLIST_FOREACH(f, list, fp_next) {
364 if (f->fp_tcpopts != find->fp_tcpopts ||
365 f->fp_optcnt != find->fp_optcnt ||
366 f->fp_ttl < find->fp_ttl ||
367 f->fp_ttl - find->fp_ttl > ttldiff ||
368 (f->fp_flags & (PF_OSFP_DF|PF_OSFP_TS0)) !=
369 (find->fp_flags & (PF_OSFP_DF|PF_OSFP_TS0)))
372 MATCH_INT(PF_OSFP_PSIZE_MOD, PF_OSFP_PSIZE_DC, fp_psize)
373 MATCH_INT(PF_OSFP_MSS_MOD, PF_OSFP_MSS_DC, fp_mss)
374 MATCH_INT(PF_OSFP_WSCALE_MOD, PF_OSFP_WSCALE_DC, fp_wscale)
375 if ((f->fp_flags & PF_OSFP_WSIZE_DC) == 0) {
376 if (f->fp_flags & PF_OSFP_WSIZE_MSS) {
377 if (find->fp_mss == 0)
381 * Some "smart" NAT devices and DSL routers will tweak the MSS size and
382 * will set it to whatever is suitable for the link type.
384 #define SMART_MSS 1460
385 if ((find->fp_wsize % find->fp_mss ||
386 find->fp_wsize / find->fp_mss !=
388 (find->fp_wsize % SMART_MSS ||
389 find->fp_wsize / SMART_MSS !=
392 } else if (f->fp_flags & PF_OSFP_WSIZE_MTU) {
393 if (find->fp_mss == 0)
396 #define MTUOFF (sizeof(struct ip) + sizeof(struct tcphdr))
397 #define SMART_MTU (SMART_MSS + MTUOFF)
398 if ((find->fp_wsize % (find->fp_mss + MTUOFF) ||
399 find->fp_wsize / (find->fp_mss + MTUOFF) !=
401 (find->fp_wsize % SMART_MTU ||
402 find->fp_wsize / SMART_MTU !=
405 } else if (f->fp_flags & PF_OSFP_WSIZE_MOD) {
406 if (f->fp_wsize == 0 || find->fp_wsize %
410 if (f->fp_wsize != find->fp_wsize)
420 /* Find an exact fingerprint in the list */
421 static struct pf_os_fingerprint *
422 pf_osfp_find_exact(struct pf_osfp_list *list, struct pf_os_fingerprint *find)
424 struct pf_os_fingerprint *f;
426 SLIST_FOREACH(f, list, fp_next) {
427 if (f->fp_tcpopts == find->fp_tcpopts &&
428 f->fp_wsize == find->fp_wsize &&
429 f->fp_psize == find->fp_psize &&
430 f->fp_mss == find->fp_mss &&
431 f->fp_flags == find->fp_flags &&
432 f->fp_optcnt == find->fp_optcnt &&
433 f->fp_wscale == find->fp_wscale &&
434 f->fp_ttl == find->fp_ttl)
441 /* Insert a fingerprint into the list */
443 pf_osfp_insert(struct pf_osfp_list *list, struct pf_os_fingerprint *ins)
445 struct pf_os_fingerprint *f, *prev = NULL;
447 /* XXX need to go semi tree based. can key on tcp options */
449 SLIST_FOREACH(f, list, fp_next)
452 SLIST_INSERT_AFTER(prev, ins, fp_next);
454 SLIST_INSERT_HEAD(list, ins, fp_next);
457 /* Fill a fingerprint by its number (from an ioctl) */
459 pf_osfp_get(struct pf_osfp_ioctl *fpioc)
461 struct pf_os_fingerprint *fp;
462 struct pf_osfp_entry *entry;
463 int num = fpioc->fp_getnum;
467 memset(fpioc, 0, sizeof(*fpioc));
468 SLIST_FOREACH(fp, &V_pf_osfp_list, fp_next) {
469 SLIST_FOREACH(entry, &fp->fp_oses, fp_entry) {
471 fpioc->fp_mss = fp->fp_mss;
472 fpioc->fp_wsize = fp->fp_wsize;
473 fpioc->fp_flags = fp->fp_flags;
474 fpioc->fp_psize = fp->fp_psize;
475 fpioc->fp_ttl = fp->fp_ttl;
476 fpioc->fp_wscale = fp->fp_wscale;
477 fpioc->fp_getnum = num;
478 memcpy(&fpioc->fp_os, entry,
479 sizeof(fpioc->fp_os));
490 /* Validate that each signature is reachable */
491 static struct pf_os_fingerprint *
492 pf_osfp_validate(void)
494 struct pf_os_fingerprint *f, *f2, find;
496 SLIST_FOREACH(f, &V_pf_osfp_list, fp_next) {
497 memcpy(&find, f, sizeof(find));
499 /* We do a few MSS/th_win percolations to make things unique */
500 if (find.fp_mss == 0)
502 if (f->fp_flags & PF_OSFP_WSIZE_MSS)
503 find.fp_wsize *= find.fp_mss;
504 else if (f->fp_flags & PF_OSFP_WSIZE_MTU)
505 find.fp_wsize *= (find.fp_mss + 40);
506 else if (f->fp_flags & PF_OSFP_WSIZE_MOD)
508 if (f != (f2 = pf_osfp_find(&V_pf_osfp_list, &find, 0))) {
510 printf("Found \"%s %s %s\" instead of "
512 SLIST_FIRST(&f2->fp_oses)->fp_class_nm,
513 SLIST_FIRST(&f2->fp_oses)->fp_version_nm,
514 SLIST_FIRST(&f2->fp_oses)->fp_subtype_nm,
515 SLIST_FIRST(&f->fp_oses)->fp_class_nm,
516 SLIST_FIRST(&f->fp_oses)->fp_version_nm,
517 SLIST_FIRST(&f->fp_oses)->fp_subtype_nm);
519 printf("Couldn't find \"%s %s %s\"\n",
520 SLIST_FIRST(&f->fp_oses)->fp_class_nm,
521 SLIST_FIRST(&f->fp_oses)->fp_version_nm,
522 SLIST_FIRST(&f->fp_oses)->fp_subtype_nm);