tcprewrite.1 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  1. .TH TCPREWRITE 1 2008-01-16 "(tcprewrite )" "Programmer's Manual"
  2. .\" DO NOT EDIT THIS FILE (tcprewrite.1)
  3. .\"
  4. .\" It has been AutoGen-ed Wednesday January 16, 2008 at 10:09:47 PM PST
  5. .\" From the definitions tcprewrite_opts.def
  6. .\" and the template file agman1.tpl
  7. .\"
  8. .SH NAME
  9. tcprewrite \- Rewrite the packets in a pcap file.
  10. .SH SYNOPSIS
  11. .B tcprewrite
  12. .\" Mixture of short (flag) options and long options
  13. .RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \--\fIopt-name\fP " [[=| ]\fIvalue\fP]]..."
  14. .PP
  15. All arguments must be options.
  16. .SH "DESCRIPTION"
  17. This manual page documents, briefly, the \fBtcprewrite\fP command.
  18. Tcprewrite is a tool to rewrite packets stored in \fIpcap(3)\fP file format,
  19. such as crated by tools such as \fItcpdump(1)\fP and \fIethereal(1)\fP.
  20. Once a pcap file has had it's packets rewritten, they can be replayed back
  21. out on the network using \fItcpreplay(1)\fP.
  22. tcprewrite currently supports reading the following DLT types:
  23. .sp 1
  24. \fBDLT_C_HDLC\fP aka Cisco HDLC
  25. .sp 1
  26. \fBDLT_EN10MB\fP aka Ethernet
  27. .sp 1
  28. \fBDLT_LINUX_SLL\fP aka Linux Cooked Socket
  29. .sp 1
  30. \fBDLT_RAW\fP aka RAW IP
  31. .sp 1
  32. \fBDLT_NULL\fP aka BSD Loopback
  33. .sp 1
  34. \fBDLT_LOOP\fP aka OpenBSD Loopback
  35. .sp 1
  36. \fBDLT_IEEE802_11\fP aka 802.11a/b/g
  37. .sp 1
  38. \fBDLT_IEEE802_11_RADIO\fP aka 802.11a/b/g with Radiotap headers
  39. Please see the \--dlt option for supported DLT types for writing.
  40. The packet editing features of tcprewrite which distinguish between "client"
  41. and "server" traffic requires a tcpprep(1) cache file.
  42. For more details, please see the Tcpreplay Manual at:
  43. http://tcpreplay.synfin.net/trac/wiki/manual
  44. .SH OPTIONS
  45. .SS ""
  46. .TP
  47. .BR \-r " \fIstring\fP, " \--portmap "=" \fIstring\fP
  48. Rewrite TCP/UDP ports.
  49. This option may appear up to 1 times.
  50. .sp
  51. Specify a list of comma delimited port mappingings consisting of
  52. colon delimited port number pairs. Each colon delimited port pair
  53. consists of the port to match followed by the port number to rewrite.
  54. Example:
  55. .nf
  56. \--portmap=80:8000,8080:80
  57. .fi
  58. .TP
  59. .BR \-s " \fInumber\fP, " \--seed "=" \fInumber\fP
  60. Randomize src/dst IP addresses w/ given seed.
  61. This option may appear up to 1 times.
  62. This option takes an integer number as its argument.
  63. .sp
  64. Causes the source and destination IP addresses to be pseudo
  65. randomized but still maintain client/server relationships.
  66. Since the randomization is deterministic based on the seed,
  67. you can reuse the same seed value to recreate the traffic.
  68. .TP
  69. .BR \-N " \fIstring\fP, " \--pnat "=" \fIstring\fP
  70. Rewrite IP addresses using pseudo-NAT.
  71. This option may appear up to 2 times.
  72. This option must not appear in combination with any of the following options:
  73. srcipmap.
  74. .sp
  75. Takes a comma delimited series of colon delimited CIDR
  76. netblock pairs. Each netblock pair is evaluated in order against
  77. the IP addresses. If the IP address in the packet matches the
  78. first netblock, it is rewriten using the second netblock as a
  79. mask against the high order bits.
  80. Example:
  81. .nf
  82. \--pnat=192.168.0.0/16:10.77.0.0/16,172.16.0.0/12:10.1.0.0/24
  83. .fi
  84. .TP
  85. .BR \-S " \fIstring\fP, " \--srcipmap "=" \fIstring\fP
  86. Rewrite source IP addresses using pseudo-NAT.
  87. This option may appear up to 1 times.
  88. This option must not appear in combination with any of the following options:
  89. pnat.
  90. .sp
  91. Works just like the \--pnat option, but only affects the source IP
  92. addresses in the IPv4 header.
  93. .TP
  94. .BR \-D " \fIstring\fP, " \--dstipmap "=" \fIstring\fP
  95. Rewrite destination IP addresses using pseudo-NAT.
  96. This option may appear up to 1 times.
  97. This option must not appear in combination with any of the following options:
  98. pnat.
  99. .sp
  100. Works just like the \--pnat option, but only affects the destination IP
  101. addresses in the IPv4 header.
  102. .TP
  103. .BR \-e " \fIstring\fP, " \--endpoints "=" \fIstring\fP
  104. Rewrite IP addresses to be between two endpoints.
  105. This option may appear up to 1 times.
  106. This option must appear in combination with the following options:
  107. cachefile.
  108. .sp
  109. Takes a pair of colon delimited IP addresses which will be used to rewrite
  110. all traffic to appear to be between the two IP's.
  111. Example:
  112. .nf
  113. \--endpoints=172.16.0.1:172.16.0.2
  114. .fi
  115. .TP
  116. .BR \-b ", " \--skipbroadcast
  117. Skip rewriting broadcast/multicast IP's.
  118. .sp
  119. By default \--seed, \--pnat and \--endpoints will rewrite
  120. broadcast and multicast IP and MAC addresses. Setting this flag
  121. will keep broadcast/multicast IP and MAC addresses from being rewritten.
  122. .TP
  123. .BR \-C ", " \--fixcsum
  124. Force recalculation of IP/TCP/UDP checksums.
  125. .sp
  126. Causes each IP packet to have it's checksums recalcualted and
  127. fixed. Automatically enabled for packets modified with \fB--seed\fP,
  128. \fB--pnat\fP, \fB--endpoints\fP or \fB--fixlen\fP.
  129. .TP
  130. .BR \-m " \fInumber\fP, " \--mtu "=" \fInumber\fP
  131. Override default MTU length (1500 bytes).
  132. This option may appear up to 1 times.
  133. This option takes an integer number as its argument.
  134. The value of \fInumber\fP is constrained to being:
  135. .in +4
  136. .nf
  137. .na
  138. in the range 1 through MAXPACKET
  139. .fi
  140. .in -4
  141. .sp
  142. Override the default 1500 byte MTU size for determining the maximum padding length.
  143. .TP
  144. .BR \-E ", " \--efcs
  145. Remove Ethernet checksums (FCS) from end of frames.
  146. .sp
  147. Note, this option is pretty dangerous! We don't actually check to see if a FCS
  148. actually exists in the frame, we just blindly delete the last two bytes. Hence,
  149. you should only use this if you know know that your OS provides the FCS when
  150. reading raw packets.
  151. .TP
  152. .BR \-F " \fIstring\fP, " \--fixlen "=" \fIstring\fP
  153. Pad or truncate packet data to match header length.
  154. This option may appear up to 1 times.
  155. .sp
  156. Packets may be truncated during capture if the snaplen is smaller then the
  157. packet. This option allows you to modify the packet to pad the packet back
  158. out to the size stored in the IPv4 header or rewrite the IP header total length
  159. to reflect the stored packet length.
  160. .sp 1
  161. \fBpad\fP
  162. Truncated packets will be padded out so that the packet length matches the
  163. IPv4 total length
  164. .sp 1
  165. \fBtrunc\fP
  166. Truncated packets will have their IPv4 total length field rewritten to match
  167. the actual packet length
  168. .sp 1
  169. \fBdel\fP
  170. Delete the packet
  171. .TP
  172. .BR \--skipl2broadcast
  173. Skip rewriting broadcast/multicast Layer 2 addresses.
  174. .sp
  175. By default, editing Layer 2 addresses will rewrite
  176. broadcast and multicast MAC addresses. Setting this flag
  177. will keep broadcast/multicast MAC addresses from being rewritten.
  178. .TP
  179. .BR \--dlt "=\fIstring\fP"
  180. Override output DLT encapsulation.
  181. This option may appear up to 1 times.
  182. .sp
  183. By default, no DLT (data link type) conversion will be made.
  184. To change the DLT type of the output pcap, select one of the following values:
  185. .sp 1
  186. \fBenet\fP
  187. Ethernet aka DLT_EN10MB
  188. .sp 1
  189. \fBhdlc\fP
  190. Cisco HDLC aka DLT_C_HDLC
  191. .sp 1
  192. \fBuser\fP
  193. User specified Layer 2 header and DLT type
  194. .br
  195. .TP
  196. .BR \--enet-dmac "=\fIstring\fP"
  197. Override destination ethernet MAC addresses.
  198. This option may appear up to 1 times.
  199. .sp
  200. Takes a pair of comma deliminated ethernet MAC addresses which
  201. will replace the destination MAC address of outbound packets.
  202. The first MAC address will be used for the server to client traffic
  203. and the optional second MAC address will be used for the client
  204. to server traffic.
  205. Example:
  206. .nf
  207. \--enet-dmac=00:12:13:14:15:16,00:22:33:44:55:66
  208. .fi
  209. .TP
  210. .BR \--enet-smac "=\fIstring\fP"
  211. Override source ethernet MAC addresses.
  212. This option may appear up to 1 times.
  213. .sp
  214. Takes a pair of comma deliminated ethernet MAC addresses which
  215. will replace the source MAC address of outbound packets.
  216. The first MAC address will be used for the server to client traffic
  217. and the optional second MAC address will be used for the client
  218. to server traffic.
  219. Example:
  220. .nf
  221. \--enet-smac=00:12:13:14:15:16,00:22:33:44:55:66
  222. .fi
  223. .TP
  224. .BR \--enet-vlan "=\fIstring\fP"
  225. Specify ethernet 802.1q VLAN tag mode.
  226. This option may appear up to 1 times.
  227. .sp
  228. Allows you to rewrite ethernet frames to add a 802.1q header to standard 802.3
  229. ethernet headers or remove the 802.1q VLAN tag information.
  230. .sp 1
  231. \fBadd\fP
  232. Rewrites the existing 802.3 ethernet header as an 802.1q VLAN header
  233. .sp 1
  234. \fBdel\fP
  235. Rewrites the existing 802.1q VLAN header as an 802.3 ethernet header
  236. .TP
  237. .BR \--enet-vlan-tag "=\fInumber\fP"
  238. Specify the new ethernet 802.1q VLAN tag value.
  239. This option may appear up to 1 times.
  240. This option must appear in combination with the following options:
  241. enet-vlan.
  242. This option takes an integer number as its argument.
  243. The value of \fInumber\fP is constrained to being:
  244. .in +4
  245. .nf
  246. .na
  247. in the range 0 through 4095
  248. .fi
  249. .in -4
  250. .sp
  251. .TP
  252. .BR \--enet-vlan-cfi "=\fInumber\fP"
  253. Specify the ethernet 802.1q VLAN CFI value.
  254. This option may appear up to 1 times.
  255. This option must appear in combination with the following options:
  256. enet-vlan.
  257. This option takes an integer number as its argument.
  258. The value of \fInumber\fP is constrained to being:
  259. .in +4
  260. .nf
  261. .na
  262. in the range 0 through 1
  263. .fi
  264. .in -4
  265. .sp
  266. .TP
  267. .BR \--enet-vlan-pri "=\fInumber\fP"
  268. Specify the ethernet 802.1q VLAN priority.
  269. This option may appear up to 1 times.
  270. This option must appear in combination with the following options:
  271. enet-vlan.
  272. This option takes an integer number as its argument.
  273. The value of \fInumber\fP is constrained to being:
  274. .in +4
  275. .nf
  276. .na
  277. in the range 0 through 7
  278. .fi
  279. .in -4
  280. .sp
  281. .TP
  282. .BR \--hdlc-control "=\fInumber\fP"
  283. Specify HDLC control value.
  284. This option may appear up to 1 times.
  285. This option takes an integer number as its argument.
  286. .sp
  287. The Cisco HDLC header has a 1 byte "control" field. Apparently this should
  288. always be 0, but if you can use any 1 byte value.
  289. .TP
  290. .BR \--hdlc-address "=\fInumber\fP"
  291. Specify HDLC address.
  292. This option may appear up to 1 times.
  293. This option takes an integer number as its argument.
  294. .sp
  295. The Cisco HDLC header has a 1 byte "address" field which has two valid
  296. values:
  297. .sp 1
  298. \fB0x0F\fP
  299. Unicast
  300. .sp 1
  301. \fB0xBF\fP
  302. Broadcast
  303. .br
  304. You can however specify any single byte value.
  305. .TP
  306. .BR \--user-dlt "=\fInumber\fP"
  307. Set output file DLT type.
  308. This option may appear up to 1 times.
  309. This option takes an integer number as its argument.
  310. .sp
  311. Set the DLT value of the output pcap file.
  312. .TP
  313. .BR \--user-dlink "=\fIstring\fP"
  314. Rewrite Data-Link layer with user specified data.
  315. This option may appear up to 2 times.
  316. .sp
  317. Provide a series of comma deliminated hex values which will be
  318. used to rewrite or create the Layer 2 header of the packets.
  319. The first instance of this argument will rewrite both server
  320. and client traffic, but if this argument is specified a second
  321. time, it will be used for the client traffic.
  322. Example:
  323. .nf
  324. \--user-dlink=01,02,03,04,05,06,00,1A,2B,3C,4D,5E,6F,08,00
  325. .fi
  326. .TP
  327. .BR \-d " \fInumber\fP, " \--dbug "=" \fInumber\fP
  328. Enable debugging output.
  329. This option may appear up to 1 times.
  330. This option takes an integer number as its argument.
  331. The value of \fInumber\fP is constrained to being:
  332. .in +4
  333. .nf
  334. .na
  335. in the range 0 through 5
  336. .fi
  337. .in -4
  338. The default \fInumber\fP for this option is:
  339. .ti +4
  340. 0
  341. .sp
  342. If configured with \--enable-debug, then you can specify a verbosity
  343. level for debugging output. Higher numbers increase verbosity.
  344. .TP
  345. .BR \-i " \fIstring\fP, " \--infile "=" \fIstring\fP
  346. Input pcap file to be processed.
  347. This option may appear up to 1 times.
  348. .sp
  349. .TP
  350. .BR \-o " \fIstring\fP, " \--outfile "=" \fIstring\fP
  351. Output pcap file.
  352. This option may appear up to 1 times.
  353. .sp
  354. .TP
  355. .BR \-c " \fIstring\fP, " \--cachefile "=" \fIstring\fP
  356. Split traffic via tcpprep cache file.
  357. This option may appear up to 1 times.
  358. .sp
  359. Use tcpprep cache file to split traffic based upon client/server relationships.
  360. .TP
  361. .BR \-v ", " \--verbose
  362. Print decoded packets via tcpdump to STDOUT.
  363. This option may appear up to 1 times.
  364. .sp
  365. .TP
  366. .BR \-A " \fIstring\fP, " \--decode "=" \fIstring\fP
  367. Arguments passed to tcpdump decoder.
  368. This option may appear up to 1 times.
  369. This option must appear in combination with the following options:
  370. verbose.
  371. .sp
  372. When enabling verbose mode (\fB-v\fP) you may also specify one or
  373. more additional arguments to pass to \fBtcpdump\fP to modify
  374. the way packets are decoded. By default, \-n and \-l are used.
  375. Be sure to quote the arguments so that they are not interpreted
  376. by tcprewrite. Please see the tcpdump(1) man page for a complete list of
  377. options.
  378. .TP
  379. .BR \--skip-soft-errors
  380. Skip writing packets with soft errors.
  381. This option may appear up to 1 times.
  382. .sp
  383. In some cases, packets can't be decoded or the requested editing
  384. is not possible. Normally these packets are written to the output
  385. file unedited so that tcpprep cache files can still be used, but if
  386. you wish, these packets can be suppressed.
  387. One example of this is 802.11 management frames which contain no data.
  388. .TP
  389. .BR \-V ", " \--version
  390. Print version information.
  391. .sp
  392. .TP
  393. .BR \-h ", " \--less-help
  394. Display less usage information and exit.
  395. .sp
  396. .TP
  397. .BR \-H , " \--help"
  398. Display usage information and exit.
  399. .TP
  400. .BR \-! , " \--more-help"
  401. Extended usage information passed thru pager.
  402. .TP
  403. .BR \- " [\fIrcfile\fP]," " \--save-opts" "[=\fIrcfile\fP]"
  404. Save the option state to \fIrcfile\fP. The default is the \fIlast\fP
  405. configuration file listed in the \fBOPTION PRESETS\fP section, below.
  406. .TP
  407. .BR \- " \fIrcfile\fP," " \--load-opts" "=\fIrcfile\fP," " \--no-load-opts"
  408. Load options from \fIrcfile\fP.
  409. The \fIno-load-opts\fP form will disable the loading
  410. of earlier RC/INI files. \fI--no-load-opts\fP is handled early,
  411. out of order.
  412. .SH OPTION PRESETS
  413. Any option that is not marked as \fInot presettable\fP may be preset
  414. by loading values from configuration ("RC" or ".INI") file(s).
  415. The \fIhomerc\fP file is "\fI$$/\fP", unless that is a directory.
  416. In that case, the file "\fI.tcprewriterc\fP"
  417. is searched for within that directory.
  418. .SH "SEE ALSO"
  419. tcpdump(1), tcpprep(1), tcpreplay(1)
  420. .SH AUTHOR
  421. Copyright 2004-2007 Aaron Turner
  422. For support please use the tcpreplay-users@lists.sourceforge.net mailing list.
  423. The latest version of this software is always available from:
  424. http://tcpreplay.synfin.net/
  425. .PP
  426. Released under the Free BSD License.
  427. .PP
  428. This manual page was \fIAutoGen\fP-erated from the \fBtcprewrite\fP
  429. option definitions.