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