contrib/pf/man/pflog.4

   1 .\"     $OpenBSD: pflog.4,v 1.7 2004/03/21 19:47:59 miod Exp $
   2 .\"
   3 .\" Copyright (c) 2001 Tobias Weingartner
   4 .\" 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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd December 10, 2001
  29 .Dt PFLOG 4
  30 .Os
  31 .Sh NAME
  32 .Nm pflog
  33 .Nd packet filter logging interface
  34 .Sh SYNOPSIS
  35 .Cd "device pflog"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm pflog
  39 interface is a pseudo-device which makes visible all packets logged by
  40 the packet filter,
  41 .Xr pf 4 .
  42 Logged packets can easily be monitored in real
  43 time by invoking
  44 .Xr tcpdump 1
  45 on the
  46 .Nm
  47 interface, or stored to disk using
  48 .Xr pflogd 8 .
  49 .Pp
  50 Each packet retrieved on this interface has a header associated
  51 with it of length
  52 .Dv PFLOG_HDRLEN .
  53 This header documents the address family, interface name, rule
  54 number, reason, action, and direction of the packet that was logged.
  55 This structure, defined in
  56 .Aq Pa net/if_pflog.h
  57 looks like
  58 .Bd -literal -offset indent
  59 struct pfloghdr {
  60         u_int8_t        length;
  61         sa_family_t     af;
  62         u_int8_t        action;
  63         u_int8_t        reason;
  64         char            ifname[IFNAMSIZ];
  65         char            ruleset[PF_RULESET_NAME_SIZE];
  66         u_int32_t       rulenr;
  67         u_int32_t       subrulenr;
  68         u_int8_t        dir;
  69         u_int8_t        pad[3];
  70 };
  71 .Ed
  72 .Sh EXAMPLES
  73 .Bd -literal -offset indent
  74 # ifconfig pflog0 up
  75 # tcpdump -n -e -ttt -i pflog0
  76 .Ed
  77 .Sh SEE ALSO
  78 .Xr tcpdump 1
  79 .Xr inet 4 ,
  80 .Xr inet6 4 ,
  81 .Xr netintro 4 ,
  82 .Xr pf 4 ,
  83 .Xr ifconfig 8 ,
  84 .Xr pflogd 8
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 device first appeared in
  89 .Ox 3.0 .
  90 .\" .Sh BUGS
  91 .\" Anything here?