| 1 |
# |
| 2 |
# Argus-5.0 Software |
| 3 |
# Copyright (c) 2000-2020 QoSient, LLC |
| 4 |
# All rights reserved. |
| 5 |
# |
| 6 |
# |
| 7 |
# Example .rarc |
| 8 |
# |
| 9 |
# Ra* clients will open this file if its in the users HOME directory, |
| 10 |
# or in the $ARGUSHOME directory, and parse it to set common configuration |
| 11 |
# options. All of these values will be overriden by those options |
| 12 |
# set on the command line, or in the file specified using the -f option. |
| 13 |
# |
| 14 |
# Values can be quoted to make string denotation easier, however, the |
| 15 |
# parser does not require that string values be quoted. To support this, |
| 16 |
# the parse will remove '\"' characters from input strings, so do not |
| 17 |
# use this character in strings themselves. |
| 18 |
# |
| 19 |
# Values specified as "" will be treated as a NULL string, and the parser |
| 20 |
# will ignore the variable setting. |
| 21 |
|
| 22 |
# |
| 23 |
# All ra* clients can attach to a remote server, and collect argus data |
| 24 |
# in real time. This variable can be a name or a dot notation IP address. |
| 25 |
# |
| 26 |
#RA_ARGUS_SERVER=localhost:561 |
| 27 |
|
| 28 |
|
| 29 |
# All ra* clients can read Cicso Netflow records directly from Cisco |
| 30 |
# routers. Specifying this value will alert the ra* client to open |
| 31 |
# a UDP based socket listening for data on this port number. |
| 32 |
# |
| 33 |
#RA_CISCONETFLOW_PORT= |
| 34 |
|
| 35 |
|
| 36 |
# Any ra* program can generate a pid file, which can be |
| 37 |
# used to control the number of instances that the system |
| 38 |
# can support. However, creating a system pid file may |
| 39 |
# require priviledges that are inappropriate for all cases. |
| 40 |
# |
| 41 |
# When configured to generate a pid file, if a file called |
| 42 |
# ra*.pid (where ra* is the name of the program in question) |
| 43 |
# exists in the RA_PID_PATH directory, and a program |
| 44 |
# exists with a pid that matches the one contained in the |
| 45 |
# file, then the program will not start. If the pid does |
| 46 |
# not exist, then the ra* program replaces the value in the |
| 47 |
# file, with its own pid. If a pid file does not exist, |
| 48 |
# then the ra* program will create it in the RA_PID_PATH |
| 49 |
# directory, if it can. The end result is that the system |
| 50 |
# will support only one instanace of the program, based |
| 51 |
# on name, running at a time. |
| 52 |
# |
| 53 |
# The default value is to not generate a pid. The default |
| 54 |
# path for the pid file, is /var/run. |
| 55 |
# |
| 56 |
# No Commandline equivalent |
| 57 |
# |
| 58 |
# |
| 59 |
RA_SET_PID="no" |
| 60 |
RA_PID_PATH="/var/run" |
| 61 |
|
| 62 |
|
| 63 |
# Argus supports the use of SASL to provide strong |
| 64 |
# authentication and confidentiality protection. |
| 65 |
# |
| 66 |
# When argus is compiled with SASL support, ra* clients may be |
| 67 |
# required to authenticate to the argus server before the argus |
| 68 |
# will accept the connection. This variable will allow one to |
| 69 |
# set the user and authorization id's, if needed. Although |
| 70 |
# not recommended you can provide a password through the |
| 71 |
# RA_AUTH_PASS variable. The format for this variable is: |
| 72 |
# |
| 73 |
# RA_USER_AUTH="user_id/authorization_id" |
| 74 |
# |
| 75 |
#RA_USER_AUTH="user/user" |
| 76 |
#RA_AUTH_PASS="password" |
| 77 |
|
| 78 |
# The clients can specify a part of the negotiation of the |
| 79 |
# security policy that argus uses. This is controlled through |
| 80 |
# the use of a minimum and maximum allowable protection |
| 81 |
# strength values. Set these variable to control this policy. |
| 82 |
# |
| 83 |
|
| 84 |
RA_MIN_SSF=0 |
| 85 |
RA_MAX_SSF=0 |
| 86 |
|
| 87 |
|
| 88 |
# All ra* clients can support writing its output as Argus Records into |
| 89 |
# a file. Stdout can be specified using "-". The format is: |
| 90 |
# "output.file filter" |
| 91 |
# |
| 92 |
#RA_OUTPUT_FILE="/tmp/ra.out tcp" |
| 93 |
|
| 94 |
|
| 95 |
# All ra* clients can support filtering its input based on a time |
| 96 |
# range. The format is: |
| 97 |
# timeSpecification[-timeSpecification] |
| 98 |
# |
| 99 |
# where the format of a timeSpecification can be one of these: |
| 100 |
# [mm/dd[/yy].]hh[:mm[:ss]] |
| 101 |
# mm/dd[/yy] |
| 102 |
# |
| 103 |
#RA_TIMERANGE="" |
| 104 |
|
| 105 |
|
| 106 |
# All ra* clients can support running for a number of seconds, |
| 107 |
# while attached to a remote source of argus data. This is a type |
| 108 |
# of polling. The default is zero (0), which means run indefinately. |
| 109 |
# |
| 110 |
RA_RUN_TIME=0 |
| 111 |
|
| 112 |
|
| 113 |
# Specify if ra* clients should print management records out |
| 114 |
# by default. This does not affect management record |
| 115 |
# processing, nor down stream management record propagation. |
| 116 |
# |
| 117 |
# |
| 118 |
RA_PRINT_MAN_RECORDS=yes |
| 119 |
RA_PRINT_EVENT_RECORDS=yes |
| 120 |
|
| 121 |
# Specify if rabins-like clients should print start and stop management |
| 122 |
# records to frame its output. This does not affect management record |
| 123 |
# processing, nor down stream management record propagation. |
| 124 |
# |
| 125 |
# |
| 126 |
RA_GENERATE_BIN_MAR_RECORDS=no |
| 127 |
|
| 128 |
|
| 129 |
# Most ra* clients are designed to print argus records out in ASCII, |
| 130 |
# with each client supporting its own output formats. For ra() like |
| 131 |
# clients, this variable will generate column headers as labels. |
| 132 |
# The number is the number of lines between repeated header output. |
| 133 |
# Setting this value to zero (0) will cause the labels to be printed |
| 134 |
# once. If you don't want labels, then comment this line out or |
| 135 |
# delete it. |
| 136 |
# |
| 137 |
# |
| 138 |
RA_PRINT_LABELS=0 |
| 139 |
|
| 140 |
|
| 141 |
# All ra* clients are designed to provide flexibility in what data |
| 142 |
# is printed when configured to generate ASCII output. |
| 143 |
# For ra() like clients, this variable overide the default field |
| 144 |
# printing specification. This is the equivalent to the "-s option". |
| 145 |
# The below example is the default field definition. |
| 146 |
# |
| 147 |
RA_FIELD_SPECIFIER="stime dur flgs proto saddr sport dir daddr dport spkts dpkts sbytes dbytes state" |
| 148 |
|
| 149 |
|
| 150 |
# Many ra* style programs sorting records as a part of its function. |
| 151 |
# Programs like rasort.1, providing explicit command-line options |
| 152 |
# to specify the sort algorithms and their order, using rasort's |
| 153 |
# '-m field [field ...]' option. |
| 154 |
# |
| 155 |
# Use this configuration directive to specify the default sorting |
| 156 |
# algorithm table. The default sort algorithm is record starting |
| 157 |
# time, stime. |
| 158 |
# |
| 159 |
RA_SORT_ALGORITHMS="pkts saddr daddr proto dport sport" |
| 160 |
|
| 161 |
|
| 162 |
# Most ra* clients are designed to print argus records out in ASCII, |
| 163 |
# with each client supporting its own output formats. For ra() like |
| 164 |
# clients, this variable can overide the default field delimiter, |
| 165 |
# which are variable spans of space (' '), to be any character. |
| 166 |
# The most common are expected to be '\t' for tabs, and ',' for |
| 167 |
# comma separated fields. |
| 168 |
# |
| 169 |
RA_FIELD_DELIMITER='' |
| 170 |
|
| 171 |
|
| 172 |
# For ra() like clients, this variable will control the |
| 173 |
# translation of numbers to names, such as resolving hostnames, |
| 174 |
# and print port or protocol names. There can be a huge performance |
| 175 |
# impact with name lookup, so the default is to not resolve hostnames. |
| 176 |
# |
| 177 |
# Valid options are 'none' to print no names, 'proto' |
| 178 |
# translate the protocol names, 'port' to translate |
| 179 |
# port names, and 'all' to translate all fields. An |
| 180 |
# invalid value will default to 'port', silently. |
| 181 |
# |
| 182 |
RA_PRINT_NAMES=proto |
| 183 |
|
| 184 |
|
| 185 |
# Ra() clients when printing numeric IP addresses, print them |
| 186 |
# as CIDR addresses. CIDR notation is constructed from the IP address and |
| 187 |
# the prefix size, the latter being the number of leading 1 bits of the |
| 188 |
# routing prefix. The IP address is expressed according to the standards |
| 189 |
# of IPv4 or IPv6. It is followed by a separator character, the forward |
| 190 |
# slash (/) character, and the prefix size expressed as a decimal number. |
| 191 |
# |
| 192 |
# Argus IPv4 data contains the CIDR mask length, when its less than 32, |
| 193 |
# and ra* programs will by default provides the "/masklen" suffix when |
| 194 |
# the mask is less than 32. |
| 195 |
# |
| 196 |
# This maybe confusing for some data processors, which would rather see |
| 197 |
# the "/masklen" never, or all the time. Use this option to specify |
| 198 |
# changes in the default printing stratgy. |
| 199 |
# |
| 200 |
# Accepatable values for this variable are: |
| 201 |
# "no" - do not provide the CIDR mask length (legacy mode) [default] |
| 202 |
# "yes" - print CIDR mask length when less than 32 |
| 203 |
# "strict" - always print CIDR mask length |
| 204 |
# |
| 205 |
RA_CIDR_ADDRESS_FORMAT="yes" |
| 206 |
|
| 207 |
|
| 208 |
# For ra() like clients, this variable will include the response |
| 209 |
# data that is provided by Argus. This is protocol and state |
| 210 |
# specific. |
| 211 |
# |
| 212 |
RA_PRINT_RESPONSE_DATA=no |
| 213 |
|
| 214 |
|
| 215 |
# For ra() like clients, this variable will force the timestamp |
| 216 |
# to be in Unix time format, which is an integer representing the |
| 217 |
# number of elapsed seconds since the epoch. |
| 218 |
# |
| 219 |
RA_PRINT_UNIX_TIME=no |
| 220 |
|
| 221 |
|
| 222 |
# For ra() like clients, the format that is used to print |
| 223 |
# timestamps, is based on the strftime() library call, with |
| 224 |
# an extension to print fractions of a sec "%f". The |
| 225 |
# default is "%T.%f". You can overide this default time |
| 226 |
# format by setting this variable. This string must conform |
| 227 |
# to the format specified in strftime(). Malformed strings can |
| 228 |
# generate interesting output, so be aware with this one, and |
| 229 |
# don't forget the '.' when doing fractions of a second. |
| 230 |
# |
| 231 |
#RA_TIME_FORMAT="%Y/%m/%d" |
| 232 |
#RA_TIME_FORMAT="%Y/%m/%d.%T.%f" |
| 233 |
RA_TIME_FORMAT="%m/%d.%T.%f" |
| 234 |
|
| 235 |
|
| 236 |
# The timezone used for timestamps is specified by the |
| 237 |
# tzset() library routines, and is normally specified by |
| 238 |
# factors such as the TZ environment variable found on |
| 239 |
# most machines. You can override the TZ environment variable |
| 240 |
# by specifying a time zone using this variable. The format |
| 241 |
# of this string must conform to the format specified by |
| 242 |
# tzset(3). |
| 243 |
# |
| 244 |
#RA_TZ="EST5EDT4,M3.2.0/02,M11.1.0/02" |
| 245 |
|
| 246 |
|
| 247 |
# For ra() like clients, this variable is used to override the |
| 248 |
# time format of the timestamp. This variable specifies the |
| 249 |
# number of decimal places that will be printed as the fractional |
| 250 |
# part of the time. Argus collects usec precision, and so a |
| 251 |
# maximum value of 6 is supported. To not print the fractional |
| 252 |
# part, specify the value zero (0). |
| 253 |
# |
| 254 |
RA_USEC_PRECISION=6 |
| 255 |
|
| 256 |
|
| 257 |
# Argus can capture user data. When printing out the user data |
| 258 |
# contents, using tools such as raxml(), the type of encoding |
| 259 |
# can be specified here. Supported values are "Ascii", "Encode64", |
| 260 |
# or "Encode32". |
| 261 |
# |
| 262 |
#RA_USERDATA_ENCODE=Encode32 |
| 263 |
#RA_USERDATA_ENCODE=Encode64 |
| 264 |
RA_USERDATA_ENCODE=Ascii |
| 265 |
|
| 266 |
# If compiled to support this option, ra* clients are capable |
| 267 |
# of generating a lot of use [full | less | whatever] debug |
| 268 |
# information. The default value is zero (0). |
| 269 |
# |
| 270 |
#RA_DEBUG_LEVEL=0 |
| 271 |
|
| 272 |
# Ra style clients use a non-blocking method to connect to |
| 273 |
# remote data sources, so the user can control how long to |
| 274 |
# wait if a remote source doesn't respond. This variable sets |
| 275 |
# the number of seconds to wait. This number should be set to |
| 276 |
# a reasonable value (5 < value < 60). The default value is |
| 277 |
# 10 seconds. |
| 278 |
# |
| 279 |
#RA_CONNECT_TIME=10 |
| 280 |
|
| 281 |
|
| 282 |
# You can provide a filter expression here, if you like. |
| 283 |
# It should be limited to 2K in length. The default is to |
| 284 |
# not filter. |
| 285 |
# |
| 286 |
#RA_FILTER="" |
| 287 |
|
| 288 |
|
| 289 |
# Some ra* clients have an interval based function. Ratop, as an |
| 290 |
# example, can refresh the screen at a fixed interval. This variable |
| 291 |
# can be set using the RA_UPDATE_INTERVAL variable, which is a |
| 292 |
# float in seconds. 0.5 seconds is the default. |
| 293 |
# |
| 294 |
RA_UPDATE_INTERVAL=0.15 |
| 295 |
|
| 296 |
|
| 297 |
# All ra* clients have the ability to alias the srcid to the "node" field. |
| 298 |
# The method for finding the alias is specified using the RA_SRCID_ALIAS variable. |
| 299 |
# |
| 300 |
RA_SRCID_ALIAS="file:/usr/argus/srcid.alias.txt" |
| 301 |
|
| 302 |
|
| 303 |
# All ra* clients have the ability to print vendor names for the |
| 304 |
# vendor part of ethernet addresses, that are in flow records. |
| 305 |
# ra* programs gets its strings for the ethernet vendors using |
| 306 |
# the Wireshark 'manuf' file, that is provided with the distribution. |
| 307 |
# |
| 308 |
# Commandline equivalents: |
| 309 |
# -M oui |
| 310 |
# |
| 311 |
RA_PRINT_ETHERNET_VENDORS="no" |
| 312 |
RA_ETHERNET_VENDORS="/usr/argus/wireshark.manuf.txt" |
| 313 |
|
| 314 |
# All ra* clients have the ability to print country codes for the |
| 315 |
# IP addresses that are in a flow record. Country codes are |
| 316 |
# generated from the ARIN delegated address space files. Specify |
| 317 |
# the location of your DELEGATED_IP file here. |
| 318 |
# |
| 319 |
# No Commandline equivalent |
| 320 |
# |
| 321 |
RA_DELEGATED_IP="/usr/argus/delegated-ipv4-latest" |
| 322 |
|
| 323 |
|
| 324 |
# All ra* clients can reliably connect to remote data sources. |
| 325 |
# This causes the ra* program to try to reconnect to lost remote |
| 326 |
# sources every 5 seconds, indefinately. This causes ra* program |
| 327 |
# to not terminate but retry connection attempts when they fail. |
| 328 |
# |
| 329 |
# This feature is implemented using threads, and so threads |
| 330 |
# support must be compiled in. |
| 331 |
# |
| 332 |
# No Commandline equivalent |
| 333 |
# |
| 334 |
#RA_RELIABLE_CONNECT=no |
| 335 |
|
| 336 |
|
| 337 |
# Many ra* clients can read and write into a system archive. |
| 338 |
# These variables are provided to specify the path to the archive |
| 339 |
# and define the archive strategy. |
| 340 |
# |
| 341 |
# Default values for these variables can be set here. |
| 342 |
# |
| 343 |
# Commandline equivalents: |
| 344 |
# No commandline equivalent |
| 345 |
# |
| 346 |
|
| 347 |
ARGUS_ARCHIVE="/home/argus/$srcid/$inf/%Y/%m/argus.%Y.%m.%d" |
| 348 |
ARGUS_ARCHIVE_STRATEGY="time 1d" |
| 349 |
|
| 350 |
|
| 351 |
# Many ra* clients can connect and use a MySQL database, either |
| 352 |
# reading for writing. This may require references to remotes |
| 353 |
# database hosts, databases, tables, and mysql account names |
| 354 |
# and passwords. |
| 355 |
# |
| 356 |
# Default values for these variables can be set here. |
| 357 |
# support must be compiled in. |
| 358 |
# |
| 359 |
# Commandline equivalents: |
| 360 |
# -r mysql://[username[:password]@]hostname[:port]/database/tablename |
| 361 |
# -w mysql://[username[:password]@]hostname[:port]/database/tablename |
| 362 |
# -u username:password |
| 363 |
# |
| 364 |
|
| 365 |
RA_DATABASE="inventory" |
| 366 |
RA_DB_USER="root" |
| 367 |
|
| 368 |
|
| 369 |
# Those ra* clients that can create database tables may need to |
| 370 |
# specify a table type or rather, a database engine other than the |
| 371 |
# defaul, MyISAM. |
| 372 |
# |
| 373 |
# Commandline equivalents: |
| 374 |
# -M mysql_engine=tableType |
| 375 |
# Current tableTypes are |
| 376 |
# MyISAM |
| 377 |
# InnoDB |
| 378 |
# Merge |
| 379 |
# Memory |
| 380 |
# Archive |
| 381 |
# NDB |
| 382 |
# Federated |
| 383 |
# CSV |
| 384 |
# |
| 385 |
|
| 386 |
MYSQL_DB_ENGINE="MyISAM" |
| 387 |
|
| 388 |
# For ra* programs that use curses, these variables defined color schemes |
| 389 |
# and color assignments. |
| 390 |
# |
| 391 |
# |
| 392 |
# Argus uses a sixteen color palette, with 8 monotone and 8 accent colors, |
| 393 |
# plus 16 colors of gray. Currently these color values are hard coded. |
| 394 |
# New versions should allow you to provide color definitions for all internal |
| 395 |
# values using a 256 Xterm color wheel, to assign foreground and background |
| 396 |
# colors. But we're not there yet |
| 397 |
# |
| 398 |
RA_COLOR_SUPPORT="yes" |
| 399 |
RA_COLOR_CONFIG=/root/.racolor.conf |
| 400 |
|
| 401 |
|
| 402 |
# Many ra* clients process flow records based on source and destination |
| 403 |
# properties. TCP and UDP ports values can be used to assign direction, |
| 404 |
# and are best used for well-known ports (< 1024), values that |
| 405 |
# are in the /etc/services defintions, and the reserved ports (> 1023, < 49151). |
| 406 |
# |
| 407 |
# The syntax is: |
| 408 |
# RA_PORT_DIRECTION="services" |
| 409 |
# RA_PORT_DIRECTION="services,wellknown" |
| 410 |
# RA_PORT_DIRECTION="services,wellknown,registered" |
| 411 |
# |
| 412 |
# We recommend the wellknown and services options, as they are a bit more |
| 413 |
# discriminating. If there are ports that you know are services that are in |
| 414 |
# the registered port range, we suggest that you add them to your /etc/services |
| 415 |
# file rather than include the registered port range; only because the |
| 416 |
# registered range is so large. However, this option is applied only to |
| 417 |
# flow in which the direction is ambiguous, and as such, corrections based |
| 418 |
# on the logic should have minimum effect on analytics. |
| 419 |
|
| 420 |
|
| 421 |
RA_PORT_DIRECTION="services,wellknown" |
| 422 |
|
| 423 |
|
| 424 |
# Many ra* clients process flow records where locality is an important |
| 425 |
# property. Sites use locality for a number of features, such as access control, |
| 426 |
# and this support is intended to support visualization, and analytics. |
| 427 |
# |
| 428 |
# Currently, you can identify a collection of IP addresses that represent RA_LOCAL, |
| 429 |
# and are specified using an iana-address-file formatted file. (See ralabel.conf) |
| 430 |
# |
| 431 |
# When locality information is available, programs like ra(), and |
| 432 |
# ratop() can use that information to make display decisions, such |
| 433 |
# as the assignement of source when the data does not provide |
| 434 |
# enough information to definitively make that assignment. |
| 435 |
# |
| 436 |
# RA_LOCAL_DIRECTION provides the logic for using the locality |
| 437 |
# information to assign flow direction. You can force the local |
| 438 |
# address to be either the source (src) or the destination (dst). |
| 439 |
# |
| 440 |
# The syntax is: |
| 441 |
# RA_LOCAL_DIRECTION="local:src" |
| 442 |
# RA_LOCAL_DIRECTION="local:dst" |
| 443 |
# |
| 444 |
RA_LOCAL=/usr/argus/ralocality.conf |
| 445 |
RA_LOCAL_CORRECT="yes" |
| 446 |
RA_LOCAL_DIRECTION="suggest:src" |
| 447 |
|
| 448 |
RA_CORRELATE_EVENTS="yes" |
| 449 |
|
| 450 |
#RATOP_CONTROL_PORT=15057 |