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 .Dd May 22, 2006
  25 .Dt IPFWPCAP 8
  26 .Os
  27 .Sh NAME
  28 .Nm ipfwpcap
  29 .Nd "copy diverted packets to a file in tcpdump format"
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl dr
  33 .Op Fl b Ar maxbytes
  34 .Op Fl p Ar maxpkts
  35 .Op Fl P Ar pidfile
  36 .Ar portnum
  37 .Ar dumpfile
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility is used to copy diverted packets to a file in
  42 .Xr tcpdump 1
  43 format.
  44 The interesting packets are diverted by
  45 .Xr ipfw 8
  46 to a port on which
  47 .Nm
  48 listens.
  49 The packets are then dropped unless
  50 .Fl r
  51 is used.
  52 .Pp
  53 The options are as follows:
  54 .Bl -tag -width indent
  55 .It Fl d
  56 Turns on extra debugging messages.
  57 .It Fl r
  58 Writes packets back to the
  59 .Xr divert 4
  60 socket.
  61 .It Fl rr
  62 Indicates that it is okay to quit if
  63 .Ar maxbytes
  64 or
  65 .Ar maxpkts
  66 are reached.
  67 Diverted packets will silently disappear if nothing is listening on the
  68 .Xr divert 4
  69 socket.
  70 .It Fl b Ar maxbytes
  71 Stop dumping after
  72 .Ar maxbytes
  73 bytes.
  74 .It Fl p Ar maxpkts
  75 Stop dumping after
  76 .Ar maxpkt
  77 packets.
  78 .It Fl P Ar pidfile
  79 File to store PID number in.
  80 Default is
  81 .Pa /var/run/ipwfpcap.portnr.pid .
  82 .El
  83 .Pp
  84 The
  85 .Ar portnum
  86 argument specifies which
  87 .Xr divert 4
  88 socket port to listen on.
  89 The
  90 .Ar dumpfile
  91 argument is the path to the file to write captured packets to.
  92 Specify
  93 .Sq Fl
  94 to write to stdout.
  95 .Sh EXIT STATUS
  96 .Ex -std
  97 .Sh EXAMPLES
  98 .Dl "ipfwpcap -r 8091 divt.log &"
  99 .Pp
 100 Starts
 101 .Nm
 102 as a background job listening to port 8091 and reflecting the packets
 103 back to the socket.
 104 .Pp
 105 .Dl "ipfw add 2864 divert 8091 ip from 192.0.2.101"
 106 .Pp
 107 Example
 108 .Xr ipfw 8
 109 rule to divert all packets from 192.0.2.101 to port 8091.
 110 See
 111 .Xr ipfw 8
 112 for details.
 113 .Sh SEE ALSO
 114 .Xr tcpdump 1 ,
 115 .Xr pcap 3 ,
 116 .Xr divert 4 ,
 117 .Xr ipfw 8
 118 .Sh HISTORY
 119 The
 120 .Nm
 121 utility first appeared in
 122 .Fx 7.0 .
 123 .Sh AUTHORS
 124 .An -nosplit
 125 .Nm
 126 was written by
 127 .An P. Kern Aq Mt pkern@cns.utoronto.ca .
 128 This manual page was written by
 129 .An Niclas Zeising Aq Mt zeising@FreeBSD.org .