.\" Text automatically generated by txt2man
.TH pktanon 1 "01 August 2018" "pktanon 2~git20160407.0.2bde4f2+dfsg" ""
.SH NAME
\fBpktanon \fP- profile-based traffic anonymizer
\fB
.SH SYNOPSIS
.nf
.fam C
       \fBpktanon\fP [\fB-c\fP \fIprofile_file\fP] \fIinput_file\fP \fIoutput_file\fP
       \fBpktanon\fP [\fIoptions\fP] [\fIinput_file\fP] [\fIoutput_file\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
Pktanon is a generic framework for network traffic anonymization.
It aims at enabling wide-spread use of realistic network traces
by providing fine-grained, profile-based anonymization.
It can easily be configured by anonymization profiles, which are used to
define how the network traffic should be made anonymous. Such profiles ensure
an easy adaptation of the information actually being made anonymous to
different environments or local legislation.
.SH OPTIONS
Configuration:
.TP
.B
\fB-c\fP, \fB--config\fP <config_file>
anonymization profile
.PP
Input Parameters:
.TP
.B
\fB-s\fP, \fB--snaplen\fP <number>
read first snaplen bytes from each packet
(for both captures and files) [default:256]
.TP
.B
\fB-i\fP, \fB--interface\fP <interface>
capture packets from this interface
.TP
.B
\fB-p\fP, \fB--no-promiscuous-mode\fP
do not set interface in promiscuous mode
.TP
.B
\fB-e\fP, \fB--pcap-filter\fP <filter>
filter specification for libpcap
.TP
.B
\fB-r\fP, \fB--use-raw-sockets\fP
use linux raw sockets instead of libpcap
(\fB-e\fP option is not available)
.PP
Output Parameters:
.TP
.B
\fB-U\fP, \fB--packet-buffered\fP
output (to file) is flushed every N packets
.TP
.B
\fB-n\fP, \fB--network\fP <interface>
send packets to <interface> using libpcap-inject
(EXPERIMENTAL)
.TP
.B
\fB-o\fP, \fB--socket\fP <Addr:Port>
send packets to Addr:Port using sockets
.PP
(if '\fB--socket\fP' option is set:)
.TP
.B
\fB-6\fP, \fB--use-ipv6\fP
Use IPv6
.TP
.B
\fB-u\fP, \fB--use-udp\fP
Use UDP
.PP
Miscellaneous:
.TP
.B
\fB-l\fP, \fB--use-libpcap\fP
use libpcap for file i/o
.TP
.B
\fB-h\fP, \fB--help\fP, \fB--usage\fP
print this message and exit
.TP
.B
\fB-q\fP, \fB--quiet\fP
Reduce output
.TP
.B
\fB-v\fP, \fB--verbose\fP
Increase output
.RE
.PP

.SH RUNNING PKTANON
PktAnon needs a configuration file. Sample configuration files can be found
in the profiles directory in the distribution. This directory also includes a
sample network trace. Two included configuration files are
\(cqprofile-identity.xml' and 'profile.xml'. The first configuration copies all
the fields from original packets into anonymized packets except that packets
content is cropped. The second configuration anonymizes mac addresses, ip
addresses, and ports in the packets.
.PP
To anonymize sample trace using sample configuration files run:
.PP
.nf
.fam C
    pktanon -c /usr/share/doc/pktanon/examples/profiles/profile-identity.xml profiles/sample.pcap out.pcap

.fam T
.fi
or
.PP
.nf
.fam C
    pktanon -c /usr/share/doc/pktanon/examples/profiles/identity.xml profiles/sample.pcap out.pcap

.fam T
.fi
The output should look like this:
.PP
.nf
.fam C
    -----------------------------------------------
    pktanon --- profile-based traffic anonymization
    -----------------------------------------------
    initializing PktAnon,  configuration =  /usr/share/doc/pktanon/examples/profiles/profile-identity.xml
    istream: opened file profiles/sample.pcap
    ostream: opened output file out.pcap
    initialized
    complete

    statistics for input file 'profiles/sample.pcap'
      processed packets: 9
      errors in packets: 0
      elapsed time:      22us
      Mpps:              0.409

.fam T
.fi
.RE
The anonymized trace out.pcap will be created in the root directory of the distribution.
If the output file already exists it will be trimmed and rewritten without any warning.