contrib/pf/man/pf.os.5

   1 .\"     $OpenBSD: pf.os.5,v 1.5 2003/10/25 07:55:27 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2003 Mike Frantzen <frantzen@w4g.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .Dd August 18, 2003
  17 .Dt PF.OS 5
  18 .Os
  19 .Sh NAME
  20 .Nm pf.os
  21 .Nd format of the operating system fingerprints file
  22 .Sh DESCRIPTION
  23 The
  24 .Xr pf 4
  25 firewall and the
  26 .Xr tcpdump 8
  27 program can both fingerprint the operating system of hosts that
  28 originate an IPv4 TCP connection.
  29 The file consists of newline-separated records, one per fingerprint,
  30 containing nine colon
  31 .Pq Ql \&:
  32 separated fields.
  33 These fields are as follows:
  34 .Pp
  35 .Bl -tag -width Description -offset indent -compact
  36 .It window
  37 The TCP window size.
  38 .It TTL
  39 The IP time to live.
  40 .It df
  41 The presence of the IPv4 don't fragment bit.
  42 .It packet size
  43 The size of the initial TCP packet.
  44 .It TCP options
  45 An ordered list of the TCP options.
  46 .It class
  47 The class of operating system.
  48 .It version
  49 The version of the operating system.
  50 .It subtype
  51 The subtype of patchlevel of the operating system.
  52 .It description
  53 The overall textual description of the operating system, version and subtype.
  54 .El
  55 .Pp
  56 The
  57 .Ar window
  58 field corresponds to the th->th_win field in the TCP header and is the
  59 source host's advertised TCP window size.
  60 It may be between zero and 65,535 inclusive.
  61 The window size may be given as a multiple of a constant by prepending
  62 the size with a percent sign
  63 .Sq %
  64 and the value will be used as a modulus.
  65 Three special values may be used for the window size:
  66 .Pp
  67 .Bl -tag -width xxx -offset indent -compact
  68 .It *
  69 An asterisk will wildcard the value so any window size will match.
  70 .It S
  71 Allow any window size which is a multiple of the maximum segment size (MSS).
  72 .It T
  73 Allow any window size which is a multiple of the maximum transmission unit
  74 (MTU).
  75 .El
  76 .Pp
  77 The
  78 .Ar ttl
  79 value is the initial time to live in the IP header.
  80 The fingerprint code will account for the volatility of the packet's TTL
  81 as it traverses a network.
  82 .Pp
  83 The
  84 .Ar df
  85 bit corresponds to the Don't Fragment bit in an IPv4 header.
  86 It tells intermediate routers not to fragment the packet and is used for
  87 path MTU discovery.
  88 It may be either a zero or a one.
  89 .Pp
  90 The
  91 .Ar packet size
  92 is the literal size of the full IP packet and is a function of all of
  93 the IP and TCP options.
  94 .Pp
  95 The
  96 .Ar TCP options
  97 field is an ordered list of the individual TCP options that appear in the
  98 SYN packet.
  99 Each option is described by a single character separated by a comma and
 100 certain ones may include a value.
 101 The options are:
 102 .Pp
 103 .Bl -tag -width Description -offset indent -compact
 104 .It Mnnn
 105 maximum segment size (MSS) option.
 106 The value is the maximum packet size of the network link which may
 107 include the
 108 .Sq %
 109 modulus or match all MSSes with the
 110 .Sq *
 111 value.
 112 .It N
 113 the NOP option (NO Operation).
 114 .It T[0]
 115 the timestamp option.
 116 Certain operating systems always start with a zero timestamp in which
 117 case a zero value is added to the option; otherwise no value is appended.
 118 .It S
 119 the Selective ACKnowledgement OK (SACKOK) option.
 120 .It Wnnn
 121 window scaling option.
 122 The value is the size of the window scaling which may include the
 123 .Sq %
 124 modulus or match all window scalings with the
 125 .Sq *
 126 value.
 127 .El
 128 .Pp
 129 No TCP options in the fingerprint may be given with a single dot
 130 .Sq \&. .
 131 .Pp
 132 An example of OpenBSD's TCP options are:
 133 .Pp
 134 .Dl M*,N,N,S,N,W0,N,N,T
 135 .Pp
 136 The first option
 137 .Ar M*
 138 is the MSS option and will match all values.
 139 The second and third options
 140 .Ar N
 141 will match two NOPs.
 142 The fourth option
 143 .Ar S
 144 will match the SACKOK option.
 145 The fifth
 146 .Ar N
 147 will match another NOP.
 148 The sixth
 149 .Ar W0
 150 will match a window scaling option with a zero scaling size.
 151 The seventh and eighth
 152 .Ar N
 153 options will match two NOPs.
 154 And the ninth and final option
 155 .Ar T
 156 will match the timestamp option with any time value.
 157 .Pp
 158 The TCP options in a fingerprint will only match packets with the
 159 exact same TCP options in the same order.
 160 .Pp
 161 The
 162 .Ar class
 163 field is the class, genre or vender of the operating system.
 164 .Pp
 165 The
 166 .Ar version
 167 is the version of the operating system.
 168 It is used to distinguish between different fingerprints of operating
 169 systems of the same class but different versions.
 170 .Pp
 171 The
 172 .Ar subtype
 173 is the subtype or patch level of the operating system version.
 174 It is used to distinguish between different fingerprints of operating
 175 systems of the same class and same version but slightly different
 176 patches or tweaking.
 177 .Pp
 178 The
 179 .Ar description
 180 is a general description of the operating system, its version,
 181 patchlevel and any further useful details.
 182 .Sh EXAMPLES
 183 The fingerprint of a plain
 184 .Ox 3.3
 185 host is:
 186 .Bd -literal
 187   16384:64:1:64:M*,N,N,S,N,W0,N,N,T:OpenBSD:3.3::OpenBSD 3.3
 188 .Ed
 189 .Pp
 190 The fingerprint of an
 191 .Ox 3.3
 192 host behind a PF scrubbing firewall with a no-df rule would be:
 193 .Bd -literal
 194   16384:64:0:64:M*,N,N,S,N,W0,N,N,T:OpenBSD:3.3:!df:OpenBSD 3.3 scrub no-df
 195 .Ed
 196 .Pp
 197 An absolutely braindead embedded operating system fingerprint could be:
 198 .Bd -literal
 199   65535:255:0:40:.:DUMMY:1.1:p3:Dummy embedded OS v1.1p3
 200 .Ed
 201 .Pp
 202 The
 203 .Xr tcpdump 8
 204 output of
 205 .Bd -literal
 206   # tcpdump -s128 -c1 -nv 'tcp[13] == 2'
 207   03:13:48.118526 10.0.0.1.3377 > 10.0.0.0.2: S [tcp sum ok] \e
 208       534596083:534596083(0) win 57344 <mss 1460> (DF) [tos 0x10] \e
 209       (ttl 64, id 11315)
 210 .Ed
 211 .Pp
 212 almost translates into the following fingerprint
 213 .Bd -literal
 214   57344:64:1:44:M1460:  exampleOS:1.0::exampleOS 1.0
 215 .Ed
 216 .Pp
 217 .Xr tcpdump 8
 218 does not explicitly give the packet length.
 219 But it can usually be derived by adding the size of the IPv4 header to
 220 the size of the TCP header to the size of the TCP options.
 221 The size of both headers is typically twenty each and the usual
 222 sizes of the TCP options are:
 223 .Pp
 224 .Bl -tag -width timestamp -offset indent -compact
 225 .It mss
 226 four bytes.
 227 .It nop
 228 1 byte.
 229 .It sackOK
 230 two bytes.
 231 .It timestamp
 232 ten bytes.
 233 .It wscale
 234 three bytes.
 235 .El
 236 .Pp
 237 In the above example, the packet size comes out to 44 bytes.
 238 .Sh SEE ALSO
 239 .Xr pf 4 ,
 240 .Xr pf.conf 5 ,
 241 .Xr pfctl 8 ,
 242 .Xr tcpdump 8