source: tools/traceanon/traceanon.1 @ ba91618

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since ba91618 was ba91618, checked in by Shane Alcock <salcock@…>, 11 years ago
  • Updated manpages for traceanon and tracemerge to reflect new -Z option.
  • Attempted to add some consistency in the naming of long options for -z and -Z across tools
  • Property mode set to 100644
File size: 2.6 KB
Line 
1.TH TRACEANON "1" "October 2005" "traceanon (libtrace)" "User Commands"
2.SH NAME
3traceanon \- anonymise ip addresses of traces
4.SH SYNOPSIS
5.B traceanon
6[ \-s | \-\^\-encrypt-source ]
7[ \-d | \-\^\-encrypt-dest ]
8[ \-p prefix | \-\^\-prefix=prefix ]
9[ \-c key | \-\^\-cryptopan=key ]
10[ \-z level | \-\^\-compress-level=level ]
11[ \-Z method | \-\^\-compress-type=method ]
12sourceuri
13desturi
14.SH DESCRPTION
15traceanon anonymises a trace by replacing IP addresses found in the IP header,
16and any embedded packets inside an ICMP packet.  It also fixes the checksums
17inside TCP and UDP headers.
18
19Two anonymisation schemes are supported, the first replaces a prefix with
20another prefix.  This can be used for instance to replace a /16 with the
21equivilent prefix from RFC1918.  The other scheme is cryptopan which is a
22prefix preserving encryption scheme based on AES.
23.TP
24.PD 0
25.BI \-s
26.TP
27.PD
28.BI \-\^\-encrypt-source
29encrypt only source ip addresses.
30
31.TP
32.PD 0
33.BI \-d
34.TP
35.PD
36.BI \-\^\-encrypt-dest
37encrypt only destination ip addresses.
38
39.TP
40.PD 0
41.BI \-p
42.TP
43.PD
44.BI \-\^\-prefix=prefix
45substitute the high bits of the IP addresses with the provided prefix.
46
47.TP
48.PD 0
49.BI \-c
50.TP
51.PD
52.BI \-\^\-cryptopan=key
53encrypt the IP addresses using the prefix-preserving cryptopan method using
54the key "key".  The key can be up to 32 bytes long, and will be padded with
55NULL characters.
56
57.TP
58.PD 0
59.BI \-z
60.TP
61.PD
62.BI \-\^\-compress-level=level
63compress the output trace using a compression level of "level". Compression
64level can range from 0 (no compression) through to 9. Higher compression levels
65require more CPU to compress data. Defaults to no compression.
66
67.TP
68.PD 0
69.BI \-Z
70.TP
71.PD
72.BI \-\^\-compress-type=method
73compress the output trace using the compression algorithm "method". Possible
74algorithms are "gzip", "bzip2", "lzo" and "none". Default is "none".
75
76.SH EXAMPLES
77.nf
78traceanon \-\^\-cryptopan="fish go moo, oh yes they do" \\
79        \-\^\-encrypt-source \\
80        \-\^\-encrypt-dest \\
81        \-\^\-compress-level=1 \\
82        \-\^\-compress-type=gzip \\
83        erf:/traces/unenc.gz \\
84        erf:/traces/enc.gz \\
85.fi
86
87.SH BUGS
88This software should support encrypting based on the direction/interface flag.
89
90IP addresses inside ARP's are not encrypted.
91
92.SH LINKS
93More details about traceanon (and libtrace) can be found at
94http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
95
96.SH SEE ALSO
97libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracestats(1),
98tracesummary(1), tracertstats(1), tracesplit(1), tracesplit_dir(1),
99tracereport(1), tracepktdump(1), tracediff(1), tracereplay(1)
100
101.SH AUTHORS
102Perry Lorier <perry@cs.waikato.ac.nz>
Note: See TracBrowser for help on using the repository browser.