dist/pf/sbin/pflogd/pflogd.8

   1 .\"     $NetBSD: pflogd.8,v 1.5 2009/03/21 00:15:54 perry Exp $
   2 .\"     $OpenBSD: pflogd.8,v 1.35 2007/05/31 19:19:47 jmc Exp $
   3 .\"
   4 .\" Copyright (c) 2001 Can Erkin Acar.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .Dd May 31, 2007
  29 .Dt PFLOGD 8
  30 .Os
  31 .Sh NAME
  32 .Nm pflogd
  33 .Nd packet filter logging daemon
  34 .Sh SYNOPSIS
  35 .Nm pflogd
  36 .Bk -words
  37 .Op Fl Dx
  38 .Op Fl d Ar delay
  39 .Op Fl f Ar filename
  40 .Op Fl i Ar interface
  41 .Op Fl p Ar pidfile
  42 .Op Fl s Ar snaplen
  43 .Op Ar expression
  44 .Ek
  45 .Sh DESCRIPTION
  46 .Nm
  47 is a background daemon which reads packets logged by
  48 .Xr pf 4
  49 to a
  50 .Xr pflog 4
  51 interface, normally
  52 .Pa pflog0 ,
  53 and writes the packets to a logfile (normally
  54 .Pa /var/log/pflog )
  55 in
  56 .Xr tcpdump 8
  57 binary format.
  58 These logs can be reviewed later using the
  59 .Fl r
  60 option of
  61 .Xr tcpdump 8 ,
  62 hopefully offline in case there are bugs in the packet parsing code of
  63 .Xr tcpdump 8 .
  64 .Pp
  65 .Nm
  66 closes and then re-opens the log file when it receives
  67 .Dv SIGHUP ,
  68 permitting
  69 .Xr newsyslog 8
  70 to rotate logfiles automatically.
  71 .Dv SIGALRM
  72 causes
  73 .Nm
  74 to flush the current logfile buffers to the disk, thus making the most
  75 recent logs available.
  76 The buffers are also flushed every
  77 .Ar delay
  78 seconds.
  79 .Pp
  80 If the log file contains data after a restart or a
  81 .Dv SIGHUP ,
  82 new logs are appended to the existing file.
  83 If the existing log file was created with a different snaplen,
  84 .Nm
  85 temporarily uses the old snaplen to keep the log file consistent.
  86 .Pp
  87 .Nm
  88 tries to preserve the integrity of the log file against I/O errors.
  89 Furthermore, integrity of an existing log file is verified before
  90 appending.
  91 If there is an invalid log file or an I/O error, the log file is moved
  92 out of the way and a new one is created.
  93 If a new file cannot be created, logging is suspended until a
  94 .Dv SIGHUP
  95 or a
  96 .Dv SIGALRM
  97 is received.
  98 .Pp
  99 The options are as follows:
 100 .Bl -tag -width Ds
 101 .It Fl D
 102 Debugging mode.
 103 .Nm
 104 does not disassociate from the controlling terminal.
 105 .It Fl d Ar delay
 106 Time in seconds to delay between automatic flushes of the file.
 107 This may be specified with a value between 5 and 3600 seconds.
 108 If not specified, the default is 60 seconds.
 109 .It Fl f Ar filename
 110 Log output filename.
 111 Default is
 112 .Pa /var/log/pflog .
 113 .It Fl i Ar interface
 114 Specifies the
 115 .Xr pflog 4
 116 interface to use.
 117 By default,
 118 .Nm
 119 will use
 120 .Ar pflog0 .
 121 .It Fl p Ar pidfile
 122 Writes a file containing the process ID of the program.
 123 The file name has the form
 124 .Pa /var/run/pidname.pid .
 125 If the option is not given,
 126 .Ar pidfile
 127 defaults to
 128 .Pa pflogd .
 129 .It Fl s Ar snaplen
 130 Analyze at most the first
 131 .Ar snaplen
 132 bytes of data from each packet rather than the default of 116.
 133 The default of 116 is adequate for IP, ICMP, TCP, and UDP headers but may
 134 truncate protocol information for other protocols.
 135 Other file parsers may desire a higher snaplen.
 136 .It Fl x
 137 Check the integrity of an existing log file, and return.
 138 .It Ar expression
 139 Selects which packets will be dumped, using the regular language of
 140 .Xr tcpdump 8 .
 141 .El
 142 .Sh FILES
 143 .Bl -tag -width /var/run/pflogd.pid -compact
 144 .It Pa /var/run/pflogd.pid
 145 Process ID of the currently running
 146 .Nm .
 147 .It Pa /var/log/pflog
 148 Default log file.
 149 .El
 150 .Sh EXAMPLES
 151 Log specific tcp packets to a different log file with a large snaplen
 152 (useful with a log-all rule to dump complete sessions):
 153 .Bd -literal -offset indent
 154 # pflogd -s 1600 -f suspicious.log port 80 and host evilhost
 155 .Ed
 156 .Pp
 157 Log from another
 158 .Xr pflog 4
 159 interface, excluding specific packets:
 160 .Bd -literal -offset indent
 161 # pflogd -i pflog3 -f network3.log "not (tcp and port 23)"
 162 .Ed
 163 .Pp
 164 Display binary logs:
 165 .Bd -literal -offset indent
 166 # tcpdump -n -e -ttt -r /var/log/pflog
 167 .Ed
 168 .Pp
 169 Display the logs in real time (this does not interfere with the
 170 operation of
 171 .Nm ) :
 172 .Bd -literal -offset indent
 173 # tcpdump -n -e -ttt -i pflog0
 174 .Ed
 175 .Pp
 176 Tcpdump has been extended to be able to filter on the pfloghdr
 177 structure defined in
 178 .Aq Ar net/if_pflog.h .
 179 Tcpdump can restrict the output
 180 to packets logged on a specified interface, a rule number, a reason,
 181 a direction, an IP family or an action.
 182 .Pp
 183 .Bl -tag -width "ruleset authpf " -compact
 184 .It ip
 185 Address family equals IPv4.
 186 .It ip6
 187 Address family equals IPv6.
 188 .It ifname kue0
 189 Interface name equals "kue0".
 190 .It on kue0
 191 Interface name equals "kue0".
 192 .It ruleset authpf
 193 Ruleset name equals "authpf".
 194 .It rulenum 10
 195 Rule number equals 10.
 196 .It reason match
 197 Reason equals match.
 198 Also accepts "bad-offset", "fragment", "bad-timestamp", "short",
 199 "normalize", "memory", "congestion", "ip-option", "proto-cksum",
 200 "state-mismatch", "state-insert", "state-limit", "src-limit",
 201 and "synproxy".
 202 .It action pass
 203 Action equals pass.
 204 Also accepts "block".
 205 .It inbound
 206 The direction was inbound.
 207 .It outbound
 208 The direction was outbound.
 209 .El
 210 .Pp
 211 Display the logs in real time of inbound packets that were blocked on
 212 the wi0 interface:
 213 .Bd -literal -offset indent
 214 # tcpdump -n -e -ttt -i pflog0 inbound and action block and on wi0
 215 .Ed
 216 .Sh SEE ALSO
 217 .Xr pcap 3 ,
 218 .Xr pf 4 ,
 219 .Xr pflog 4 ,
 220 .Xr pf.conf 5 ,
 221 .Xr newsyslog 8 ,
 222 .Xr tcpdump 8
 223 .Sh HISTORY
 224 The
 225 .Nm
 226 command appeared in
 227 .Ox 3.0 .
 228 .Sh AUTHORS
 229 .Nm
 230 was written by
 231 .An Can Erkin Acar Aq canacar@openbsd.org .