Debian Codegraph @

support/Config/raconvert.zeek.conf

raw
1 #
2 # Argus-5.0 Client Software
3 # Raconvert Conversion Map Example
4 # Copyright (c) 2000-2022 QoSient, LLC
5 # All rights reserved.
6 #
7 # Raconvert configuration for zeek conversion
8 #
9 # Tue 16 Jun 10:33:20 EDT 2020
10 # Carter Bullard
11 # QoSient, LLC
12 #
13 # Example raconvert.conf
14 #
15 # This file is provided to describe the conversion of non-argus flow data
16 # output fields to argus flow data fields. This should provide a mapping of
17 # column titles and types to argus data fields and types.
18 #
19 # Fields that don't have a mapping are ignored, for fields where there are
20 # mappings, but the data type is incorrect, the mapping is ignored. When multiple
21 # fields map to a single argus data element (ie a label), a simple directive
22 # can be provided to indicate what action should be taken, ignore, replace, append.
23 #
24 #
25 # Variable Syntax
26 #
27 # Variable assignments must be of the form:
28 #
29 # VARIABLE=
30 #
31 # with no white space between the VARIABLE and the '=' sign.
32 # Quotes are optional for string arguements, but if you want
33 # to embed comments, then quotes are required.
34 #
35 # Specify the originator of the data to convert. Because raconvert.1 is designed
36 # to accept any ascii type of input, it doesn't have to have a source, and so this
37 # variable is optional.
38 #
39 # By specifying the source, you can identify data types for downstream analytics.
40 #
41 # Supported sources are:
42 # argus
43 # netflow
44 # suricata
45 # zeek
46 # none
47 #
48 RACONVERT_SOURCE=zeek
49
50
51 # For ra() like clients, the format that is used to print
52 # timestamps, is based on the strftime() library call, with
53 # an extension to print fractions of a sec "%f". The
54 # default is "%T.%f". You can overide this default time
55 # format by setting this variable. This string must conform
56 # to the format specified in strftime(). Malformed strings can
57 # generate interesting output, so be aware with this one, and
58 # don't forget the '.' when doing fractions of a second.
59 #
60 #RACONVERT_TIME_FORMAT="%Y/%m/%d"
61 #RACONVERT_TIME_FORMAT="%Y/%m/%d.%T.%f"
62
63 RACONVERT_TIME_FORMAT="%Y-%m-%dT%H:%M:%S.%fZ"
64
65 # Argus Monitor Data is uniquely identifiable based on the source
66 # identifier that is included in each output record. This is to
67 # allow you to work with Argus Data from multiple monitors at the
68 # same time. The ID can be 128 bits long, and argus suppors a
69 # number of formats as legitimate values.
70 #
71 # 128-bit uuid
72 # IPv4 addresses
73 # IPv6 addresses
74 # Ethernet addresses
75 # unsigned ints
76 # 4 bytes strings
77 #
78 # The formats are discerned from the values provided. Double-quoted
79 # values are treated as strings, and are truncated to 4 characters.
80 # Non-quoted values are tested for whether they are hostnames, and if
81 # not, then they are tested wheter they are numbers.
82 #
83 # The configuration allows for you to use host names, however, you
84 # should have some understanding as to how `hostname` will be
85 # resolved by the nameserver before commiting to this strategy.
86 #
87 # For convenience, argus supports the notion of "`hostname`" for
88 # assigning the probe's id. This is to support management of
89 # large deployments, so you can have one argus.conf file that works
90 # for a lot of probes.
91 #
92 # For security, argus does not rely on system programs, like hostname.1.
93 # It implements the logic of hostname itself, so don't try to run
94 # arbitrary programs using this method, because it won't work.
95 #
96 # The syntax for the monitor id, srcid, is:
97 # [type:/]sid
98 # where type can be:
99 # int, str, ipv4, ipv6, uuid
100 #
101 # where sid can be:
102 # int, "string", ipv4, ipv6, uuid
103 #
104 # Examples include:
105 # fe80::1
106 # 192.168.8.68
107 # 2345
108 # ipv4:/192.168.8.68
109 # D1EE0C4B-E247-4EA7-9765-4C902899B75A
110 # uuid:/D1EE0C4B-E247-4EA7-9765-4C902899B75A
111 #
112 #ARGUS_MONITOR_ID="zeek"
113 ARGUS_MONITOR_ID=192.168.8.68
114 #ARGUS_MONITOR_ID=2345678
115 #ARGUS_MONITOR_ID=uuid:/D1EE0C4B-E247-4EA7-9765-4C902899B75A
116
117 #
118 # Specify the fields that are expected in this conversion stream. This is providied if the input file doesn't have a column header.
119 #
120
121 #RACONVERT_FIELD_SPECIFIER=ts,uid,id.orig_h,id.orig_p,id.resp_h,id.resp_p,proto,service,duration,orig_bytes,resp_bytes,conn_state,local_orig,local_resp,missed_bytes,history,orig_pkts,orig_ip_bytes,resp_pkts,resp_ip_bytes,tunnel_parents,orig_l2_addr,resp_l2_addr
122 #
123 RACONVERT_FIELD_SPECIFIER=ts,uid,id.orig_h,id.orig_p,id.resp_h,id.resp_p,proto,service,duration,orig_bytes,resp_bytes,conn_state,local_orig,local_resp,missed_bytes,history,orig_pkts,orig_ip_bytes,resp_pkts,resp_ip_bytes,orig_cc,resp_cc,tunnel_parents,id.orig_h_name.vals,id.orig_h_name.src,id.resp_h_name.vals,id.resp_h_name.src,suri_ids
124
125 # Specify the field separation character. This can be a single character or a string that contains all separators.
126
127 RACONVERT_FIELD_DELIMITER='\t'
128
129 # An empty/non-existing field values can have a lot of different interpretations (should be expected but not available, empty
130 # because it was stripped, etc ... Here you can specify different indications, if used, for when a field is empty (zero value)
131 # and when it wasn't defined in the input data.
132 #
133 RACONVERT_FIELD_EMPTY=''
134 RACONVERT_FIELD_UNDEFINED='-'
135
136 # This will provide conversion information needed for foriegn data labels. Need to provide the name of the data label,
137 # what it will be mapped to, the data type (for correctness) and what to do if there are multiple values mapped to the
138 # same argus field. Generally you will ignore the redundant value (-), replace existing values with this value (),
139 # or you will append (+).
140 #
141 # Labels are constucted as traditional argus metadata labels, using the original column name as the key:
142 # column=string
143 #
144 # Additional processing needed to generate a reasonable label, such as field substitution or quoting can be
145 # specified using the RA_LABEL_CONVERSION variable (to be implemented) ...
146
147 RACONVERT_CONVERSION_MAP=
148 ts=StartTime, time
149 uid=Label, string+
150 id.orig_h=SrcAddr, addr
151 id.orig_p=Sport, port
152 id.resp_h=DstAddr, addr
153 id.resp_p=Dport, port
154 proto=Proto, proto
155 service=Label, string+
156 duration=Dur, interval
157 orig_bytes=SrcAppBytes, count
158 resp_bytes=DstAppBytes, count
159 conn_state=State, string
160 local_orig=Label, bool+
161 local_resp=Label, bool+
162 missed_bytes=Loss, count
163 history=State, string+
164 orig_pkts=SrcPkts, count
165 orig_ip_bytes=SrcBytes, count
166 resp_pkts=DstPkts, count
167 resp_ip_bytes=DstBytes, count
168 orig_cc=sCo, string
169 resp_cc=dCo, string
170 tunnel_parents=Label, string+
171 orig_l2_addr=SrcMac, string
172 resp_l2_addr=DstMac, string
173 vlan=sVlan, int
174 id.orig_h_name.vals=Label, string+
175 id.orig_h_name.src=Label, string+
176 id.resp_h_name.vals=Label, string+
177 id.resp_h_name.src=Label, string+
178 suri_ids=Label, string+
179
180