Debian Codegraph @

support/Config/raconvert.json.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 json data 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, in the case of csv, or key values, in the case of json,
18 # and types to argus data fields and types.
19 #
20 # Fields that don't have a mapping are ignored, for fields where there are
21 # mappings, but the data type is incorrect, the mapping is ignored. When multiple
22 # fields map to a single argus data element (ie a label), a simple directive
23 # can be provided to indicate what action should be taken, ignore, replace, append.
24 #
25 #
26 # Variable Syntax
27 #
28 # Variable assignments must be of the form:
29 #
30 # VARIABLE=
31 #
32 # with no white space between the VARIABLE and the '=' sign.
33 # Quotes are optional for string arguements, but if you want
34 # to embed comments, then quotes are required.
35 #
36 # Specify the originator of the data to convert. Because raconvert.1 is designed
37 # to accept any ascii type of input, it doesn't have to have a source, and so this
38 # variable is optional.
39 #
40 # By specifying the source, you can identify data types for downstream analytics.
41 #
42 # Supported sources are:
43 # argus
44 # netflow
45 # suricata
46 # zeek
47 # json
48 # none
49 #
50 RACONVERT_SOURCE=json
51
52
53 # For ra() like clients, the format that is used to print
54 # timestamps, is based on the strftime() library call, with
55 # an extension to print fractions of a sec "%f". The
56 # default is "%T.%f". You can overide this default time
57 # format by setting this variable. This string must conform
58 # to the format specified in strftime(). Malformed strings can
59 # generate interesting output, so be aware with this one, and
60 # don't forget the '.' when doing fractions of a second.
61 #
62 #RACONVERT_TIME_FORMAT="%Y/%m/%d"
63 #RACONVERT_TIME_FORMAT="%Y/%m/%d.%T.%f"
64
65 RACONVERT_TIME_FORMAT="%Y-%m-%dT%H:%M:%S.%fZ"
66
67 # Argus Monitor Data is uniquely identifiable based on the source
68 # identifier that is included in each output record. This is to
69 # allow you to work with Argus Data from multiple monitors at the
70 # same time. The ID can be 128 bits long, and argus suppors a
71 # number of formats as legitimate values.
72 #
73 # 128-bit uuid
74 # IPv4 addresses
75 # IPv6 addresses
76 # Ethernet addresses
77 # unsigned ints
78 # 4 bytes strings
79 #
80 # The formats are discerned from the values provided. Double-quoted
81 # values are treated as strings, and are truncated to 4 characters.
82 # Non-quoted values are tested for whether they are hostnames, and if
83 # not, then they are tested wheter they are numbers.
84 #
85 # The configuration allows for you to use host names, however, you
86 # should have some understanding as to how `hostname` will be
87 # resolved by the nameserver before commiting to this strategy.
88 #
89 # For convenience, argus supports the notion of "`hostname`" for
90 # assigning the probe's id. This is to support management of
91 # large deployments, so you can have one argus.conf file that works
92 # for a lot of probes.
93 #
94 # For security, argus does not rely on system programs, like hostname.1.
95 # It implements the logic of hostname itself, so don't try to run
96 # arbitrary programs using this method, because it won't work.
97 #
98 # The syntax for the monitor id, srcid, is:
99 # [type:/]sid
100 # where type can be:
101 # int, str, ipv4, ipv6, uuid
102 #
103 # where sid can be:
104 # int, "string", ipv4, ipv6, uuid
105 #
106 # Examples include:
107 # fe80::1
108 # 192.168.8.68
109 # 2345
110 # ipv4:/192.168.8.68
111 # D1EE0C4B-E247-4EA7-9765-4C902899B75A
112 # uuid:/D1EE0C4B-E247-4EA7-9765-4C902899B75A
113 #
114 #ARGUS_MONITOR_ID="zeek"
115 ARGUS_MONITOR_ID=192.168.8.68
116 #ARGUS_MONITOR_ID=2345678
117 #ARGUS_MONITOR_ID=uuid:/D1EE0C4B-E247-4EA7-9765-4C902899B75A
118
119 #
120 # Specify the fields that are expected in this conversion stream. This is providied if the input file doesn't have a column header.
121 #
122
123 RACONVERT_FIELD_SPECIFIER= srcid rank seq autoid stime ltime dur idle sstime sltime sdur ddur dstime dltime rtime offset srng erng trans flgs mean stddev min max sum snet saddr dir dnet daddr proto sport dport sco dco stos dtos sdsb ddsb sttl dttl shops dhops sipid dipid pkts spkts dpkts bytes sbytes dbytes appbytes sappbytes dappbytes load sload dload rate srate drate loss sloss dloss ploss sploss dploss retrans sretrans dretrans pretrans spretrans dpretrans sgap dgap nstroke snstroke dnstroke senc denc bssid ssid soui doui smac dmac sas das ias smpls dmpls svlan dvlan svid dvid svpri dvpri sintpkt dintpkt sintpktact dintpktact sintpktidl dintpktidl sintpktmax sintpktmin dintpktmax dintpktmin sintpktactmax sintpktactmin dintpktactmax dintpktactmin sintpktidlmax sintpktidlmin dintpktidlmax dintpktidlmin sjit djit sjitact djitact sjitidl djitidl state cause resp dldur dlstime dlltime dspkts ddpkts dlspkt dldpkt dsbytes ddbytes pdspkts pddpkts pdsbytes pddbytes spktsz smeansz smaxsz sminsz dpktsz dmeansz dmaxsz dminsz sintdist dintdist sintdistact dintdistact sintdistidl dintdistidl suser duser label icmpid tcpopt tcpext stcpmax dtcpmax swin dwin jdelay ldelay bins binnum stcpb dtcpb tcprtt synack ackdat inode smaxsz sminsz dmaxsz dminsz
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=''
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