doc/editcap.pod

   1
   2 =head1 NAME
   3
   4 editcap - Edit and/or translate the format of capture files
   5
   6 =head1 SYNOPSIS
   7
   8 B<editcap>
   9 S<[ B<-c> E<lt>packets per fileE<gt> ]>
  10 S<[ B<-C> E<lt>choplenE<gt> ]>
  11 S<[ B<-E> E<lt>error probabilityE<gt> ]>
  12 S<[ B<-F> E<lt>file formatE<gt> ]>
  13 S<[ B<-A> E<lt>start timeE<gt> ]>
  14 S<[ B<-B> E<lt>stop timeE<gt> ]>
  15 S<[ B<-h> ]>
  16 S<[ B<-i> E<lt>seconds per fileE<gt> ]>
  17 S<[ B<-r> ]>
  18 S<[ B<-s> E<lt>snaplenE<gt> ]>
  19 S<[ B<-t> E<lt>time adjustmentE<gt> ]>
  20 S<[ B<-S> E<lt>strict time adjustmentE<gt> ]>
  21 S<[ B<-T> E<lt>encapsulation typeE<gt> ]>
  22 S<[ B<-v> ]>
  23 I<infile>
  24 I<outfile>
  25 S<[ I<packet#>[-I<packet#>] ... ]>
  26
  27 B<editcap>
  28 S< B<-d> > |
  29 S< B<-D> E<lt>dup windowE<gt> > |
  30 S< B<-w> E<lt>dup time windowE<gt> >
  31 S<[ B<-v> ]>
  32 I<infile>
  33 I<outfile>
  34
  35 =head1 DESCRIPTION
  36
  37 B<Editcap> is a program that reads some or all of the captured packets from the
  38 I<infile>, optionally converts them in various ways and writes the
  39 resulting packets to the capture I<outfile> (or outfiles).
  40
  41 By default, it reads all packets from the I<infile> and writes them to the
  42 I<outfile> in libpcap file format.
  43
  44 An optional list of packet numbers can be specified on the command tail;
  45 individual packet numbers separated by whitespace and/or ranges of packet
  46 numbers can be specified as I<start>-I<end>, referring to all packets from
  47 I<start> to I<end>.  By default the selected packets with those numbers will
  48 I<not> be written to the capture file.  If the B<-r> flag is specified, the
  49 whole packet selection is reversed; in that case I<only> the selected packets
  50 will be written to the capture file.
  51
  52 B<Editcap> can also be used to remove duplicate packets.  Several different
  53 options (B<-d>, B<-D> and B<-w>) are used to control the packet window
  54 or relative time window to be used for duplicate comparison.
  55
  56 B<Editcap> is able to detect, read and write the same capture files that
  57 are supported by B<Wireshark>.
  58 The input file doesn't need a specific filename extension; the file
  59 format and an optional gzip compression will be automatically detected.
  60 Near the beginning of the DESCRIPTION section of wireshark(1) or
  61 L<http://www.wireshark.org/docs/man-pages/wireshark.html>
  62 is a detailed description of the way B<Wireshark> handles this, which is
  63 the same way B<Editcap> handles this.
  64
  65 B<Editcap> can write the file in several output formats. The B<-F>
  66 flag can be used to specify the format in which to write the capture
  67 file; B<editcap -F> provides a list of the available output formats.
  68
  69 =head1 OPTIONS
  70
  71 =over 4
  72
  73 =item -c  E<lt>packets per fileE<gt>
  74
  75 Splits the packet output to different files based on uniform packet counts
  76 with a maximum of <packets per file> each. Each output file will
  77 be created with a suffix -nnnnn, starting with 00000. If the specified
  78 number of packets is written to the output file, the next output file is
  79 opened. The default is to use a single output file.
  80
  81 =item -C  E<lt>choplenE<gt>
  82
  83 Sets the chop length to use when writing the packet data.
  84 Each packet is chopped at the packet end by a few <choplen> bytes of data.
  85
  86 This is useful in the rare case that the conversion between two file
  87 formats leaves some random bytes at the end of each packet.
  88
  89 =item -d
  90
  91 Attempts to remove duplicate packets.  The length and MD5 hash of the
  92 current packet are compared to the previous four (4) packets.  If a
  93 match is found, the current packet is skipped.  This option is equivalent
  94 to using the option B<-D 5>.
  95
  96 =item -D  E<lt>dup windowE<gt>
  97
  98 Attempts to remove duplicate packets.  The length and MD5 hash of the
  99 current packet are compared to the previous <dup window> - 1 packets.
 100 If a match is found, the current packet is skipped.
 101
 102 The use of the option B<-D 0> combined with the B<-v> option is useful
 103 in that each packet's Packet number, Len and MD5 Hash will be printed
 104 to standard out.  This verbose output (specifically the MD5 hash strings)
 105 can be useful in scripts to identify duplicate packets across trace
 106 files.
 107
 108 The <dup window> is specifed as an integer value between 0 and 1000000 (inclusive).
 109
 110 NOTE: Specifying large <dup window> values with large tracefiles can
 111 result in very long processing times for B<editcap>.
 112
 113 =item -w  E<lt>dup time windowE<gt>
 114
 115 Attempts to remove duplicate packets.  The current packet's arrival time
 116 is compared with up to 1000000 previous packets.  If the packet's relative
 117 arrival time is I<less than or equal to> the <dup time window> of a previous packet
 118 and the packet length and MD5 hash of the current packet are the same then
 119 the packet to skipped.  The duplicate comparison test stops when
 120 the current packet's relative arrival time is greater than <dup time window>.
 121
 122 The <dup time window> is specifed as I<seconds>[I<.fractional seconds>].
 123
 124 The [.fractional seconds] component can be specified to nine (9) decimal
 125 places (billionths of a second) but most typical trace files have resolution
 126 to six (6) decimal places (millionths of a second).
 127
 128 NOTE: Specifying large <dup time window> values with large tracefiles can
 129 result in very long processing times for B<editcap>.
 130
 131 NOTE: The B<-w> option assumes that the packets are in chronological order.
 132 If the packets are NOT in chronological order then the B<-w> duplication
 133 removal option may not identify some duplicates.
 134
 135 =item -E  E<lt>error probabilityE<gt>
 136
 137 Sets the probabilty that bytes in the output file are randomly changed.
 138 B<Editcap> uses that probability (between 0.0 and 1.0 inclusive)
 139 to apply errors to each data byte in the file.  For instance, a
 140 probability of 0.02 means that each byte has a 2% chance of having an error.
 141
 142 This option is meant to be used for fuzz-testing protocol dissectors.
 143
 144 =item -F  E<lt>file formatE<gt>
 145
 146 Sets the file format of the output capture file.
 147 B<Editcap> can write the file in several formats, B<editcap -F>
 148 provides a list of the available output formats. The default
 149 is the B<libpcap> format.
 150
 151 =item -A  E<lt>start timeE<gt>
 152
 153 Saves only the packets whose timestamp is on or after start time.
 154 The time is given in the following format YYYY-MM-DD HH:MM:SS
 155
 156 =item -B  E<lt>stop timeE<gt>
 157
 158 Saves only the packets whose timestamp is on or before stop time.
 159 The time is given in the following format YYYY-MM-DD HH:MM:SS
 160
 161 =item -h
 162
 163 Prints the version and options and exits.
 164
 165 =item -i  E<lt>seconds per fileE<gt>
 166
 167 Splits the packet output to different files based on uniform time intervals
 168 using a maximum interval of <seconds per file> each. Each output file will
 169 be created with a suffix -nnnnn, starting with 00000. If packets for the specified
 170 time interval are written to the output file, the next output file is
 171 opened. The default is to use a single output file.
 172
 173 =item -r
 174
 175 Reverse the packet selection.
 176 Causes the packets whose packet numbers are specified on the command
 177 line to be written to the output capture file, instead of discarding them.
 178
 179 =item -s  E<lt>snaplenE<gt>
 180
 181 Sets the snapshot length to use when writing the data.
 182 If the B<-s> flag is used to specify a snapshot length, packets in the
 183 input file with more captured data than the specified snapshot length
 184 will have only the amount of data specified by the snapshot length
 185 written to the output file.
 186
 187 This may be useful if the program that is
 188 to read the output file cannot handle packets larger than a certain size
 189 (for example, the versions of snoop in Solaris 2.5.1 and Solaris 2.6
 190 appear to reject Ethernet packets larger than the standard Ethernet MTU,
 191 making them incapable of handling gigabit Ethernet captures if jumbo
 192 packets were used).
 193
 194 =item -t  E<lt>time adjustmentE<gt>
 195
 196 Sets the time adjustment to use on selected packets.
 197 If the B<-t> flag is used to specify a time adjustment, the specified
 198 adjustment will be applied to all selected packets in the capture file.
 199 The adjustment is specified as [-]I<seconds>[I<.fractional seconds>].
 200 For example, B<-t> 3600 advances the timestamp on selected packets by one
 201 hour while B<-t> -0.5 reduces the timestamp on selected packets by
 202 one-half second.
 203
 204 This feature is useful when synchronizing dumps
 205 collected on different machines where the time difference between the
 206 two machines is known or can be estimated.
 207
 208 =item -S  E<lt>strict time adjustmentE<gt>
 209
 210 Time adjust selected packets to insure strict chronological order.
 211
 212 The <strict time adjustment> value represents relative seconds
 213 specified as [-]I<seconds>[I<.fractional seconds>].
 214
 215 As the capture file is processed each packet's absolute time is
 216 I<possibly> adjusted to be equal to or greater than the previous
 217 packet's absolute timestamp depending on the <strict time
 218 adjustment> value.
 219
 220 If <strict time adjustment> value is 0 or greater (e.g. 0.000001)
 221 then B<only> packets with a timestamp less than the previous packet
 222 will adjusted.  The adjusted timestamp value will be set to be
 223 equal to the timestamp value of the previous packet plus the value
 224 of the <strict time adjustment> value.  A <strict time adjustment>
 225 value of 0 will adjust the minimum number of timestamp values
 226 necessary to insure that the resulting capture file is in
 227 strict chronological order.
 228
 229 If <strict time adjustment> value is specified as a
 230 negative value, then the timestamp values of B<all>
 231 packets will be adjusted to be equal to the timestamp value
 232 of the previous packet plus the absolute value of the
 233 <lt>strict time adjustment<gt> value. A <strict time
 234 adjustment> value of -0 will result in all packets
 235 having the timestamp value of the first packet.
 236
 237 This feature is useful when the trace file has an occasional
 238 packet with a negative delta time relative to the previous
 239 packet.
 240
 241 =item -T  E<lt>encapsulation typeE<gt>
 242
 243 Sets the packet encapsulation type of the output capture file.
 244 If the B<-T> flag is used to specify an encapsulation type, the
 245 encapsulation type of the output capture file will be forced to the
 246 specified type.
 247 B<editcap -T> provides a list of the available types. The default
 248 type is the one appropriate to the encapsulation type of the input
 249 capture file.
 250
 251 Note: this merely
 252 forces the encapsulation type of the output file to be the specified
 253 type; the packet headers of the packets will not be translated from the
 254 encapsulation type of the input capture file to the specified
 255 encapsulation type (for example, it will not translate an Ethernet
 256 capture to an FDDI capture if an Ethernet capture is read and 'B<-T
 257 fddi>' is specified). If you need to remove/add headers from/to a
 258 packet, you will need od(1)/text2pcap(1).
 259
 260 =item -v
 261
 262 Causes B<editcap> to print verbose messages while it's working.
 263
 264 Use of B<-v> with the de-duplication switches of B<-d>, B<-D> or B<-w>
 265 will cause all MD5 hashes to be printed whether the packet is skipped
 266 or not.
 267
 268 =back
 269
 270 =head1 EXAMPLES
 271
 272 To see more detailed description of the options use:
 273
 274     editcap -h
 275
 276 To shrink the capture file by truncating the packets at 64 bytes and writing it as Sun snoop file use:
 277
 278     editcap -s 64 -F snoop capture.pcap shortcapture.snoop
 279
 280 To delete packet 1000 from the capture file use:
 281
 282     editcap capture.pcap sans1000.pcap 1000
 283
 284 To limit a capture file to packets from number 200 to 750 (inclusive) use:
 285
 286     editcap -r capture.pcap small.pcap 200-750
 287
 288 To get all packets from number 1-500 (inclusive) use:
 289
 290     editcap -r capture.pcap first500.pcap 1-500
 291
 292 or
 293
 294     editcap capture.pcap first500.pcap 501-9999999
 295
 296 To exclude packets 1, 5, 10 to 20 and 30 to 40 from the new file use:
 297
 298     editcap capture.pcap exclude.pcap 1 5 10-20 30-40
 299
 300 To select just packets 1, 5, 10 to 20 and 30 to 40 for the new file use:
 301
 302     editcap -r capture.pcap select.pcap 1 5 10-20 30-40
 303
 304 To remove duplicate packets seen within the prior four frames use:
 305
 306     editcap -d capture.pcap dedup.pcap
 307
 308 To remove duplicate packets seen within the prior 100 frames use:
 309
 310     editcap -D 101 capture.pcap dedup.pcap
 311
 312 To remove duplicate packets seen I<equal to or less than> 1/10th of a second:
 313
 314     editcap -w 0.1 capture.pcap dedup.pcap
 315
 316 To display the MD5 hash for all of the packets (and NOT generate any
 317 real output file):
 318
 319     editcap -v -D 0 capture.pcap /dev/null
 320
 321 or on Windows systems
 322
 323     editcap -v -D 0 capture.pcap NUL
 324
 325 To advance the timestamps of each packet forward by 3.0827 seconds:
 326
 327     editcap -t 3.0827 capture.pcap adjusted.pcap
 328
 329 To insure all timestamps are in strict chronological order:
 330
 331     editcap -S 0 capture.pcap adjusted.pcap
 332
 333 To introduce 5% random errors in a capture file use:
 334
 335 =over 4
 336
 337   editcap -E 0.05 capture.pcap capture_error.pcap
 338
 339 =back
 340
 341 =head1 SEE ALSO
 342
 343 tcpdump(8), pcap(3), wireshark(1), tshark(1), mergecap(1), dumpcap(1),
 344 capinfos(1), text2pcap(1), od(1)
 345
 346 =head1 NOTES
 347
 348 B<Editcap> is part of the B<Wireshark> distribution.  The latest version
 349 of B<Wireshark> can be found at L<http://www.wireshark.org>.
 350
 351 HTML versions of the Wireshark project man pages are available at:
 352 L<http://www.wireshark.org/docs/man-pages>.
 353
 354 =head1 AUTHORS
 355
 356   Original Author
 357   -------- ------
 358   Richard Sharpe           <sharpe[AT]ns.aus.com>
 359
 360
 361   Contributors
 362   ------------
 363   Guy Harris               <guy[AT]alum.mit.edu>
 364   Ulf Lamping              <ulf.lamping[AT]web.de>