<HTML
><HEAD
><TITLE
>flow-xlate</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.73
"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
><SPAN
CLASS="APPLICATION"
>flow-xlate</SPAN
></A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN6"
></A
><H2
>Name</H2
><SPAN
CLASS="APPLICATION"
>flow-xlate</SPAN
> -- Apply translations to selected fields of a flow.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN10"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>flow-xlate</B
> [-hkn] [-b<TT
CLASS="REPLACEABLE"
><I
> big</I
></TT
>|<TT
CLASS="REPLACEABLE"
><I
>little</I
></TT
>] [-C<TT
CLASS="REPLACEABLE"
><I
> comment</I
></TT
>] [-d<TT
CLASS="REPLACEABLE"
><I
> debug_level</I
></TT
>] [-v<TT
CLASS="REPLACEABLE"
><I
> variable binding</I
></TT
>] [-V<TT
CLASS="REPLACEABLE"
><I
> flow_version</I
></TT
>] [-x<TT
CLASS="REPLACEABLE"
><I
> xlate_fname</I
></TT
>] [-X<TT
CLASS="REPLACEABLE"
><I
> xlate_definition</I
></TT
>] [-z<TT
CLASS="REPLACEABLE"
><I
> z_level</I
></TT
>]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN31"
></A
><H2
>DESCRIPTION</H2
><P
>The <B
CLASS="COMMAND"
>flow-xlate</B
> utility is used to apply translations
to flows. Translations are defined in a configuration file and are
composed of actions and a definition to invoke action(s). The definitions
are in the form of terms, each term can have a filter and multiple actions.</P
><P
>Words in the configuration file of the form @VAR or @{VAR:default} will be
expanded at run-time by setting variable names with the -v option.</P
><P
>Translation actions begin with the xlate-action keyword followed by
a symbolic name. Each action has a type defined below.</P
><P
>Translation definitions begin with the xlate-definition keyword followed
by a symbolic name. Each definition is composed of terms which are
evaluated in the order of the configuration file. A term may invoke
a filter to conditionally invoke an action.</P
><PRE
CLASS="SCREEN"
>Action type/sub-commands Description/Example
------------------------------------------------------------------------
ip-source-address-to-network Zero host bits based on mask.
ip-destination-address-to-network Zero host bits based on mask.
(no sub-commands)
ip-source-address-to-class-network Zero source host bits to
match class.
ip-destination-address-to-class-network Zero dst host bits to
match class.
(no sub-commands)
ip-source-address-anonymize Anonymize source address.
ip-destination-address-anonymize Anonymize destination address.
ip-address-anonymize Anonymize src/dst address.
algorithm Algorithm. cryptopan-aes128 is
currently supported.
algorithm cryptopan-aes128
key Key. Key is 128 bits in hex.
key 0123456789ABCDEFG
key-file File to load key from. Key is
128 bits in hex.
key-file /mfstmp/secret-key
key-file-refresh How often to check the key file.
Interval is in minutes, the
optional second argument is
hour:min:sec to specify the
first refresh. This example
will load a new key every day
at 12:00:00.
14400 12:00:00
ip-address-privacy-mask Apply a mask to the source and
destination address to remove
bits.
ip-port-privacy-mask Apply a mask to the source and
destination port to remove
bits.
tag-mask Apply mask to the source and
destination tag.
mask Source and Destination mask
to apply.
mask 0xFFFF 0xFFFF
scale Scale packets and bytes.
scale Scale to apply.
scale 100
replace-source-as0 Replace source AS 0
replace-destination-as0 Replace destination AS 0
as AS replacement value.
as 3112 </PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN39"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-b<TT
CLASS="REPLACEABLE"
><I
> big</I
></TT
>|<TT
CLASS="REPLACEABLE"
><I
>little</I
></TT
></DT
><DD
><P
>Byte order of output.</P
></DD
><DT
>-C<TT
CLASS="REPLACEABLE"
><I
> Comment</I
></TT
></DT
><DD
><P
>Add a comment.</P
></DD
><DT
>-d<TT
CLASS="REPLACEABLE"
><I
> debug_level</I
></TT
></DT
><DD
><P
>Enable debugging.</P
></DD
><DT
>-h</DT
><DD
><P
>Display help.</P
></DD
><DT
>-k</DT
><DD
><P
>Keep time from input.</P
></DD
><DT
>-n</DT
><DD
><P
>Don't load configuration file. Useful only with -V</P
></DD
><DT
>-v<TT
CLASS="REPLACEABLE"
><I
> variable binding</I
></TT
></DT
><DD
><P
>Set a variable FOO=bar. </P
></DD
><DT
>-V<TT
CLASS="REPLACEABLE"
><I
> pdu_version</I
></TT
></DT
><DD
><P
>Use <TT
CLASS="REPLACEABLE"
><I
>pdu_version</I
></TT
> format output.
<P
CLASS="LITERALLAYOUT"
> 1 NetFlow version 1 (No sequence numbers, AS, or mask)<br>
5 NetFlow version 5<br>
6 NetFlow version 6 (5+ Encapsulation size)<br>
7 NetFlow version 7 (Catalyst switches)<br>
8.1 NetFlow AS Aggregation<br>
8.2 NetFlow Proto Port Aggregation<br>
8.3 NetFlow Source Prefix Aggregation<br>
8.4 NetFlow Destination Prefix Aggregation<br>
8.5 NetFlow Prefix Aggregation<br>
8.6 NetFlow Destination (Catalyst switches)<br>
8.7 NetFlow Source Destination (Catalyst switches)<br>
8.8 NetFlow Full Flow (Catalyst switches)<br>
8.9 NetFlow ToS AS Aggregation<br>
8.10 NetFlow ToS Proto Port Aggregation<br>
8.11 NetFlow ToS Source Prefix Aggregation<br>
8.12 NetFlow ToS Destination Prefix Aggregation<br>
8.13 NetFlow ToS Prefix Aggregation<br>
8.14 NetFlow ToS Prefix Port Aggregation<br>
1005 Flow-Tools tagged version 5</P
></P
></DD
><DT
>-x<TT
CLASS="REPLACEABLE"
><I
> xlate_fname</I
></TT
></DT
><DD
><P
>Translation config file name. Defaults to <TT
CLASS="FILENAME"
>/etc/ft/cfg/xlate.cfg</TT
></P
></DD
><DT
>-X<TT
CLASS="REPLACEABLE"
><I
> xlate_definition</I
></TT
></DT
><DD
><P
>Translation definition. Defaults to default.</P
></DD
><DT
>-z<TT
CLASS="REPLACEABLE"
><I
> z_level</I
></TT
></DT
><DD
><P
>Configure compression level to <TT
CLASS="REPLACEABLE"
><I
> z_level</I
></TT
>. 0 is
disabled (no compression), 9 is highest compression.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN99"
></A
><H2
>EXAMPLES</H2
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN101"
></A
><P
></P
><P
>Convert the version 7 flows in <TT
CLASS="FILENAME"
>flows.v7</TT
> to version 5,
storing the result in <TT
CLASS="FILENAME"
>flows.v5</TT
>.</P
><P
> <B
CLASS="COMMAND"
>flow-xlate -V5 < flows.v7 > flows.v5</B
></P
><P
></P
></DIV
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN107"
></A
><P
></P
><P
>Set the low 11 bits in the IP addresses to zero unless the address
is multicast or it belongs to the 192.88.99/24 network.
<P
CLASS="LITERALLAYOUT"
># xlate.cfg<br>
include-filter filter.cfg<br>
<br>
xlate-action MULTICAST-PRIVACY<br>
type ip-address-privacy-mask<br>
mask 0xFFFFFFFF 0xFFFFFFFF <br>
<br>
xlate-action UNICAST-PRIVACY<br>
type ip-address-privacy-mask<br>
mask 0xFFFFFF00 0xFFFFF800<br>
<br>
xlate-definition abilene_privacy<br>
term<br>
filter mcast<br>
action MULTICAST-PRIVACY<br>
stop<br>
term<br>
filter ucast<br>
action UNICAST-PRIVACY<br> </P
>
<P
CLASS="LITERALLAYOUT"
># filter.cfg<br>
filter-primitive MCAST<br>
type ip-address-mask<br>
permit 224.0.0.0 240.0.0.0<br>
<br>
filter-primitive UCAST<br>
type ip-address-mask<br>
deny 224.0.0.0 240.0.0.0<br>
default permit<br>
<br>
filter-primitive SKIP<br>
type ip-address-mask<br>
deny 192.88.99.0 255.255.255.0<br>
default permit<br>
<br>
filter-definition mcast<br>
match ip-destination-address MCAST<br>
<br>
filter-definition ucast<br>
match ip-destination-address UCAST<br>
match ip-destination-address SKIP<br>
match ip-source-address SKIP</P
>
<B
CLASS="COMMAND"
>flow-cat <TT
CLASS="FILENAME"
>flows</TT
> | flow-xlate -xxlate.cfg -Xabilene_privacy | flow-print</B
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN113"
></A
><H2
>FILES</H2
><P
> Configuration files:
Symbols - <TT
CLASS="FILENAME"
>/etc/ft/sym/*</TT
>.
Filter - <TT
CLASS="FILENAME"
>/etc/ft/cfg/filter.cfg</TT
>.
Xlate - <TT
CLASS="FILENAME"
>/etc/ft/cfg/xlate.cfg</TT
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN119"
></A
><H2
>BUGS</H2
><P
>The scale option can overflow the 32 bit flow counters. This could be
solved by detecting this condition and splitting the flow in two.</P
><P
>Translation between aggregated and non aggregated formats is not supported.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN123"
></A
><H2
>AUTHOR</H2
><P
>Mark Fullmer
<TT
CLASS="EMAIL"
><<A
HREF="mailto:maf@splintered.net"
>maf@splintered.net</A
>></TT
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN130"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="APPLICATION"
>flow-tools</SPAN
>(1)</P
></DIV
></BODY
></HTML
>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
ff20406d142eae55c792d2ecde94c604
>
files
>
35
