usr.sbin/ipfwpcap/ipfwpcap.8

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