Debian Codegraph @

examples/ratod/rarc

raw
1 #
2 # Gargoyle Client Software. Tools to read, analyze and manage Argus data.
3 # Copyright (c) 2000-2024 QoSient, LLC
4 # All rights reserved.
5 #
6 # THE ACCOMPANYING PROGRAM IS PROPRIETARY SOFTWARE OF QoSIENT, LLC,
7 # AND CANNOT BE USED, DISTRIBUTED, COPIED OR MODIFIED WITHOUT
8 # EXPRESS PERMISSION OF QoSIENT, LLC.
9 #
10 # QOSIENT, LLC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
11 # SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
12 # AND FITNESS, IN NO EVENT SHALL QOSIENT, LLC BE LIABLE FOR ANY
13 # SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
15 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
16 # ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
17 # THIS SOFTWARE.
18 #
19 #
20 # Example .rarc
21 #
22 # Ra* clients will open this file if its in the users HOME directory,
23 # or in the $ARGUSHOME directory, and parse it to set common configuration
24 # options. All of these values will be overriden by those options
25 # set on the command line, or in the file specified using the -f option.
26 #
27 # Values can be quoted to make string denotation easier, however, the
28 # parser does not require that string values be quoted. To support this,
29 # the parse will remove '\"' characters from input strings, so do not
30 # use this character in strings themselves.
31 #
32 # Values specified as "" will be treated as a NULL string, and the parser
33 # will ignore the variable setting.
34
35 #
36 # All ra* clients can attach to a remote server, and collect argus data
37 # in real time. This variable can be a name or a dot notation IP address.
38 #
39 #RA_ARGUS_SERVER=localhost:561
40
41 #
42 # You can specify the source port that will be used on all remote TCP
43 # connections, using this variable.
44 #
45 #RA_SOURCE_PORT=13564
46
47
48 # Any ra* program can generate a pid file, which can be
49 # used to control the number of instances that the system
50 # can support. However, creating a system pid file may
51 # require priviledges that are inappropriate for all cases.
52 #
53 # When configured to generate a pid file, if a file called
54 # ra*.pid (where ra* is the name of the program in question)
55 # exists in the RA_PID_PATH directory, and a program
56 # exists with a pid that matches the one contained in the
57 # file, then the program will not start. If the pid does
58 # not exist, then the ra* program replaces the value in the
59 # file, with its own pid. If a pid file does not exist,
60 # then the ra* program will create it in the RA_PID_PATH
61 # directory, if it can. The end result is that the system
62 # will support only one instanace of the program, based
63 # on name, running at a time.
64 #
65 # The default value is to not generate a pid. The default
66 # path for the pid file, is /var/run.
67 #
68 # No Commandline equivalent
69 #
70 #
71 RA_SET_PID="no"
72 RA_PID_PATH="/var/run"
73
74
75 # Argus supports the use of SASL to provide strong
76 # authentication and confidentiality protection.
77 #
78 # When argus is compiled with SASL support, ra* clients may be
79 # required to authenticate to the argus server before the argus
80 # will accept the connection. This variable will allow one to
81 # set the user and authorization id's, if needed. Although
82 # not recommended you can provide a password through the
83 # RA_AUTH_PASS variable. The format for this variable is:
84 #
85 # RA_USER_AUTH="user_id/authorization_id"
86 #
87 #RA_USER_AUTH="user/user"
88 #RA_AUTH_PASS="password"
89
90 # The clients can specify a part of the negotiation of the
91 # security policy that argus uses. This is controlled through
92 # the use of a minimum and maximum allowable protection
93 # strength values. Set these variable to control this policy.
94 #
95
96 #RA_MIN_SSF=0
97 #RA_MAX_SSF=128
98
99
100 # All ra* clients can support writing its output as Argus Records into
101 # a file. Stdout can be specified using "-". The format is:
102 # "output.file filter"
103 #
104 #RA_OUTPUT_FILE="/tmp/ra.out tcp"
105
106
107 # All ra* clients can support filtering its input based on a time
108 # range. The format is:
109 # timeSpecification[-timeSpecification]
110 #
111 # where the format of a timeSpecification can be one of these:
112 # [mm/dd[/yy].]hh[:mm[:ss]]
113 # mm/dd[/yy]
114 #
115 #RA_TIMERANGE=""
116
117
118 # All ra* clients can support running for a number of seconds,
119 # while attached to a remote source of argus data. This is a type
120 # of polling. The default is zero (0), which means run indefinately.
121 #
122 RA_RUN_TIME=0
123
124
125 # Specify if ra* clients should print management records by default.
126 # This does not affect management record processing, nor down stream
127 # management record propagation.
128 #
129 RA_PRINT_MAN_RECORDS=yes
130 RA_PRINT_EVENT_RECORDS=yes
131
132
133 # Most ra* clients are designed to print argus records out in ASCII,
134 # with each client supporting its own output formats. For ra() like
135 # clients, this variable will generate column headers as labels.
136 # The number is the number of lines between repeated header output.
137 # Setting this value to zero (0) will cause the labels to be printed
138 # once. If you don't want labels, then comment this line out or
139 # delete it.
140 #
141 RA_PRINT_LABELS=0
142
143
144 # All ra* clients are designed to provide flexibility in what data
145 # is printed when configured to generate ASCII output.
146 # For ra() like clients, this variable overide the default field
147 # printing specification. This is the equivalent to the "-s option".
148 # The below example is the default field definition.
149 #
150 RA_FIELD_SPECIFIER="stime flgs proto saddr sport dir daddr dport spkts dpkts sbytes dbytes state"
151
152
153 # Most ra* clients are designed to print argus records out in ASCII,
154 # with each client supporting its own output formats. For ra() like
155 # clients, this variable can overide the default field delimiter,
156 # which are variable spans of space (' '), to be any character.
157 # The most common are expected to be '\t' for tabs, and ',' for
158 # comma separated fields.
159 #
160 RA_FIELD_DELIMITER=''
161
162
163 # The field width generates columnar output for the ra* programs,
164 # but in some cases, you don't really want a lot of white space
165 # in your output.
166 #
167 # To handle these cases, use the RA_FIELD_WIDTH variable to specify
168 # whether you want 'variable' or 'fixed'. 'fixed' is the default.
169 #
170 # When using 'variable', the field width is the length of the string
171 # needed to print the entire field's value. This is generally the
172 # ideal behavior when you want to use the output in other programs,
173 # such as the use of CSV ('comma seperated values') formated input
174 # for importing into Excel.
175 #
176 # When the field delimiter is changed, all ra* programs will change
177 # to 'variable' field widths. To override this, remove the comment
178 # below, so that you explicitly set the width to be 'fixed'.
179 #
180 #RA_FIELD_WIDTH='fixed'
181
182
183 # For ra() like clients, this variable will control the
184 # translation of numbers to names, such as resolving hostnames,
185 # and print port or protocol names. There can be a huge performance
186 # impact with name lookup, so the default is to not resolve hostnames.
187 #
188 # Valid options are 'none' to print no names, 'proto'
189 # translate the protocol names, 'port' to translate
190 # port names, and 'all' to translate all fields. An
191 # invalid value will default to 'port', silently.
192 #
193 RA_PRINT_NAMES=port
194
195
196 # Ra() clients when printing numeric IP addresses, print them
197 # as CIDR addresses. CIDR notation is constructed from the IP address and
198 # the prefix size, the latter being the number of leading 1 bits of the
199 # routing prefix. The IP address is expressed according to the standards
200 # of IPv4 or IPv6. It is followed by a separator character, the forward
201 # slash (/) character, and the prefix size expressed as a decimal number.
202 #
203 # Argus IPv4 data contains the CIDR mask length, when its less than 32,
204 # and ra* programs will by default provides the "/masklen" suffix when
205 # the mask is less than 32.
206 #
207 # This maybe confusing for some data processors, which would rather see
208 # the "/masklen" never, or all the time. Use this option to specify
209 # changes in the default printing stratgy.
210 #
211 # Accepatable values for this variable are:
212 # "no" - do not provide the CIDR mask length (legacy mode) [default]
213 # "yes" - print CIDR mask length when less than 32
214 # "strict" - always print CIDR mask length
215 #
216 RA_CIDR_ADDRESS_FORMAT="yes"
217
218
219 # For ra() like clients, this variable will include the response
220 # data that is provided by Argus. This is protocol and state
221 # specific.
222 #
223 RA_PRINT_RESPONSE_DATA=no
224
225
226 # For ra() like clients, this variable will force the timestamp
227 # to be in Unix time format, which is an integer representing the
228 # number of elapsed seconds since the epoch.
229 #
230 RA_PRINT_UNIX_TIME=no
231
232
233 # For ra() like clients, the format that is used to print
234 # timestamps, is based on the strftime() library call, with
235 # an extension to print fractions of a sec "%f". The
236 # default is "%T.%f". You can overide this default time
237 # format by setting this variable. This string must conform
238 # to the format specified in strftime(). Malformed strings can
239 # generate interesting output, so be aware with this one, and
240 # don't forget the '.' when doing fractions of a second.
241 #
242 RA_TIME_FORMAT="%Y/%m/%d.%T.%f"
243
244
245 # The timezone used for timestamps is specified by the
246 # tzset() library routines, and is normally specified by
247 # factors such as the TZ environment variable found on
248 # most machines. You can override the TZ environment variable
249 # by specifying a time zone using this variable. The format
250 # of this string must conform to the format specified by
251 # tzset(3).
252 #
253 #RA_TZ="EST5EDT4,M3.2.0/02,M11.1.0/02"
254
255
256 # For ra() like clients, this variable is used to override the
257 # time format of the timestamp. This variable specifies the
258 # number of decimal places that will be printed as the fractional
259 # part of the time. Argus collects usec precision, and so a
260 # maximum value of 6 is supported. To not print the fractional
261 # part, specify the value zero (0).
262 #
263 RA_USEC_PRECISION=6
264
265
266 # Argus can capture user data. When printing out the user data
267 # contents, using tools such as raxml(), the type of encoding
268 # can be specified here. Supported values are "Ascii", "Encode64",
269 # or "Encode32".
270 #
271 #RA_USERDATA_ENCODE=Encode32
272 #RA_USERDATA_ENCODE=Encode64
273 #RA_USERDATA_ENCODE=Ascii
274
275 # If compiled to support this option, ra* clients are capable
276 # of generating a lot of use [full | less | whatever] debug
277 # information. The default value is zero (0).
278 #
279 #RA_DEBUG_LEVEL=0
280
281 # Ra style clients use a non-blocking method to connect to
282 # remote data sources, so the user can control how long to
283 # wait if a remote source doesn't respond. This variable sets
284 # the number of seconds to wait. This number should be set to
285 # a reasonable value (5 < value < 60). The default value is
286 # 10 seconds.
287 #
288 #RA_CONNECT_TIME=10
289
290
291 # You can provide a filter expression here, if you like.
292 # It should be limited to 2K in length. The default is to
293 # not filter.
294 #
295 #RA_FILTER=""
296
297
298 # Many ra* programs sort records as a part of their function.
299 # Programs like rasort.1, providing explicit command-line options
300 # to specify the sort algorithms and their order, using the
301 # '-m field [field ...]' option.
302 #
303 # Use this configuration directive to specify the default sorting
304 # algorithm table for your ra* programs. The default sort algorithm
305 # is record start time "stime".
306 #
307 #RA_SORT_ALGORITHMS="stime "
308
309
310
311 # Some ra* clients have a timeout based function. Ratop, as an
312 # example, times out flows and removes them from screen at a fixed
313 # interval. This variable can be set using the RA_TIMEOUT_INTERVAL
314 # variable, which is a float in seconds. 60.0 seconds is the default.
315 #
316 #RA_TIMEOUT_INTERVAL=60.0
317
318
319 # Some ra* clients have an interval based function. Ratop, as an
320 # example, can refresh the screen at a fixed interval. This variable
321 # can be set using the RA_UPDATE_INTERVAL variable, which is a
322 # float in seconds. 0.5 seconds is the default.
323 #
324 #RA_UPDATE_INTERVAL=0.5
325
326
327 # All ra* clients have the ability to print country codes for the
328 # IP addresses that are in a flow record. Country codes are
329 # generated from the ARIN delegated address space files. Specify
330 # the location of your DELEGATED_IP file here.
331 #
332 # No Commandline equivalent
333 #
334 RA_DELEGATED_IP="/usr/local/argus/delegated-ipv4-latest"
335
336
337 # All ra* clients can reliably connect to remote data sources.
338 # This causes the ra* program to try to reconnect to lost remote
339 # sources every 5 seconds, indefinately. This causes ra* program
340 # to not terminate but retry connection attempts when they fail.
341 #
342 # This feature is implemented using threads, and so threads
343 # support must be compiled in.
344 #
345 # No Commandline equivalent
346 #
347 #RA_RELIABLE_CONNECT=no
348
349
350 # Many ra* clients can connect and use a MySQL database, either
351 # reading for writing. This may require references to remotes
352 # database hosts, databases, tables, and mysql account names
353 # and passwords.
354 #
355 # Default values for these variables can be set here.
356 # support must be compiled in.
357 #
358 # Commandline equivalents:
359 # -r mysql://[username[:password]@]hostname[:port]/database/tablename
360 # -w mysql://[username[:password]@]hostname[:port]/database/tablename
361 # -u username:password
362 #
363
364 #RA_DATABASE="argus"
365 #RA_DB_TABLE="table"
366 #RA_DB_USER="root"
367 #RA_DB_PASS="whatever"
368
369
370 # For ra* programs that use curses, these variables defined color schemes
371 # and color assignments.
372 #
373 #RA_COLOR_SUPPORT="yes"
374 #
375 # Argus uses a sixteen color palette, with 8 monotone and 8 accent colors,
376 # plus 16 colors of gray. You can provide color definitions for all internal
377 # values using a 256 Xterm color wheel, to assign foreground and background
378 # colors.
379
380 # The monotone values are here specified as MONO_1-8.
381
382 #RA_MONO_1=
383 #RA_MONO_2=
384 #RA_MONO_3=
385 #RA_MONO_4=
386 #RA_MONO_4=
387 #RA_MONO_5=
388 #RA_MONO_6=
389 #RA_MONO_7=
390 #RA_MONO_8=
391
392 #RA_YELLOW=
393 #RA_ORANGE=
394 #RA_RED=
395 #RA_MAGENTA=
396 #RA_VIOLET=
397 #RA_BLUE=
398 #RA_CYAN=
399 #RA_GREEN=
400
401
402 # Many ra* clients process flow records, where locality is an important
403 # property. Used for a number of issues, such as access control,
404 # visualization, and analytics.
405 #
406 # RA_LOCAL is assigned an iana-address-file formatted file.
407
408 RA_LOCAL=/usr/local/argus/local.addrs
409 RA_LOCAL_DIRECTION="local:left"
410
411
412
413 # Many ra* clients can identify services through analysis of the contents of
414 # the user data buffers.
415 #
416 # RA_LOCAL is assigned an iana-address-file formatted file.
417
418 RA_SERVICES_SIGNATURES=/usr/local/argus/std.sig