usr.sbin/ipfwpcap/ipfwpcap.8

   1 .\" Copyright (c) 2006 Niclas Zeising <zeising@FreeBSD.org>
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd May 22, 2006
  27 .Dt IPFWPCAP 8
  28 .Os
  29 .Sh NAME
  30 .Nm ipfwpcap
  31 .Nd "copy diverted packets to a file in tcpdump format"
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl dr
  35 .Op Fl b Ar maxbytes
  36 .Op Fl p Ar maxpkts
  37 .Op Fl P Ar pidfile
  38 .Ar portnum
  39 .Ar dumpfile
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility is used to copy diverted packets to a file in
  44 .Xr tcpdump 1
  45 format.
  46 The interesting packets are diverted by
  47 .Xr ipfw 8
  48 to a port on which
  49 .Nm
  50 listens.
  51 The packets are then dropped unless
  52 .Fl r
  53 is used.
  54 .Pp
  55 The options are as follows:
  56 .Bl -tag -width indent
  57 .It Fl d
  58 Turns on extra debugging messages.
  59 .It Fl r
  60 Writes packets back to the
  61 .Xr divert 4
  62 socket.
  63 .It Fl rr
  64 Indicates that it is okay to quit if
  65 .Ar maxbytes
  66 or
  67 .Ar maxpkts
  68 are reached.
  69 Diverted packets will silently disappear if nothing is listening on the
  70 .Xr divert 4
  71 socket.
  72 .It Fl b Ar maxbytes
  73 Stop dumping after
  74 .Ar maxbytes
  75 bytes.
  76 .It Fl p Ar maxpkts
  77 Stop dumping after
  78 .Ar maxpkt
  79 packets.
  80 .It Fl P Ar pidfile
  81 File to store PID number in.
  82 Default is
  83 .Pa /var/run/ipwfpcap.portnr.pid .
  84 .El
  85 .Pp
  86 The
  87 .Ar portnum
  88 argument specifies which
  89 .Xr divert 4
  90 socket port to listen on.
  91 The
  92 .Ar dumpfile
  93 argument is the path to the file to write captured packets to.
  94 Specify
  95 .Sq Fl
  96 to write to stdout.
  97 .Sh EXIT STATUS
  98 .Ex -std
  99 .Sh EXAMPLES
 100 .Dl "ipfwpcap -r 8091 divt.log &"
 101 .Pp
 102 Starts
 103 .Nm
 104 as a background job listening to port 8091 and reflecting the packets
 105 back to the socket.
 106 .Pp
 107 .Dl "ipfw add 2864 divert 8091 ip from 192.0.2.101"
 108 .Pp
 109 Example
 110 .Xr ipfw 8
 111 rule to divert all packets from 192.0.2.101 to port 8091.
 112 See
 113 .Xr ipfw 8
 114 for details.
 115 .Sh SEE ALSO
 116 .Xr tcpdump 1 ,
 117 .Xr pcap 3 ,
 118 .Xr divert 4 ,
 119 .Xr ipfw 8
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 utility first appeared in
 124 .Fx 7.0 .
 125 .Sh AUTHORS
 126 .An -nosplit
 127 .Nm
 128 was written by
 129 .An P. Kern Aq Mt pkern@cns.utoronto.ca .
 130 This manual page was written by
 131 .An Niclas Zeising Aq Mt zeising@FreeBSD.org .