# # Ragen Software # Copyright (c) 2000-2024 QoSient, LLC # All rights reserved. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2, or (at your option) # any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. # # Example ragen.conf # # Ragen will open this ragen.conf if its installed as /etc/ragen.conf. # It will also search for this file as ragen.conf in directories # specified in $RAGENPATH, or $RAGENHOME, $RAGENHOME/lib, # or $HOME, $HOME/lib, and parse it to set common configuration # options. All values in this file can be overriden by command # line options, or other files of this format that can be read in # using the -F option. # # # Variable Syntax # # Variable assignments must be of the form: # # VARIABLE= # # with no white space between the VARIABLE and the '=' sign. # Quotes are optional for string arguements, but if you want # to embed comments, then quotes are required. # # # Variable Explanations # # Ragen is capable of running as a daemon, doing all the right things # that daemons do. When this specific configuration file is used # to configure the system daemon process (/etc/ragen.conf) this # variable should be set to "yes". # # The default value is to not run as a daemon. # # This example is to support the ./support/Startup/ragen script # which requires that this variable be set to "yes". # # Commandline equivalent -d # RAGEN_DAEMON=no # Ragen Monitor Data is uniquely identifiable based on the source # identifier that is included in each output record. This is to # allow you to work with Argus Data from multiple monitors at the # same time. The ID is 32 bits long, and supports a number of # formats as legitimate values. Ragen supports unsigned ints, IPv4 # addresses and 4 bytes strings, as values. # # The formats are discerned from the values provided. Double-quoted # values are treated as strings, and are truncated to 4 characters. # Non-quoted values are tested for whether they are hostnames, and if # not, then they are tested wheter they are numbers. # # The configuration allows for you to use host names, however, do # have some understanding how `hostname` will be resolved by the # nameserver before commiting to this strategy completely. # # For convenience, argus supports the notion of "`hostname`" for # assigning the probe's id. This is to support management of # large deployments, so you can have one argus.conf file that works # for a lot of probes. # # For security, argus does not rely on system programs, like hostname.1. # It implements the logic of hostname itself, so don't try to run # arbitrary programs using this method, because it won't work. # # Commandline equivalent -e # #RAGEN_MONITOR_ID=`hostname` // IPv4 address returned #RAGEN_MONITOR_ID=10.2.45.3 // IPv4 address #RAGEN_MONITOR_ID=2435 // Number #RAGEN_MONITOR_ID="rad0" // String RAGEN_MONITOR_ID=uuid:/22DD94B8-4A63-52B6-89A0-AAA833373D0C #RAGEN_MONITOR_ID=`hostuuid` // assigned uuid value # Srcid's are specified using the notion used for ARGUS_MONITOR_ID, as above. RAGEN_MONITOR_ID_INCLUDE_INF="gen0" # If compiled to support this option, Ragen is capable of # generating a lot of debug information. # # The default value is zero (0). # # Commandline equivalent -D # #RAGEN_DEBUG_LEVEL=0 # Ragen will periodically report on a its own health, providing # interface status, total packet and bytes counts, packet drop # rates, and flow oriented statistics. # # These records can be used as "keep alives" for periods when # there is no network traffic to be monitored. # # The default value is 60 seconds, but a value of 60 seconds is # very common. # # Commandline equivalent -M # RAGEN_MAR_STATUS_INTERVAL=5 # # Ragen can attach to any number of remote argus data sources, # argi or radii. The syntax for this variable is a URI that # specifies the URI schema, with transport, the hostname or a # dot notation IP address, followed by an optional port value, # separated by a ':'. If the URI format is not specified, # the URI schema and transport mechanism are the default, argus:// # If the port is not specified, the default value of 561 is used. # # Commandline equivalent -S # Commandline equivalent -S # Commandline equivalent -S # Commandline equivalent -S # Commandline equivalent -S # #RAGEN_ARGUS_SERVER=127.0.0.1:562 # You can provide a filter expression here, if you like. # Ragen will filter all input records based on this definition. # It should be limited to 2K in length. The default is to # not filter. # # No Commandline equivalent # #RAGEN_FILTER="" # Ragen can adjust the timestamps in ragen records as it receives # them, based on the measured time difference between ragen() # and the sources. The variable takes a threshold value in # seconds, so you can specify when to make a correction. # # No Commandline equivalent # #RAGEN_ADJUST_TIME=5 # Ragen has filter capabilities that use a filter optimizer. # If there is a need to not use this filter optimizer, # you can turn it off here. The default is to leave it on. # # Commandline equivalent -O # #RAGEN_FILTER_OPTIMIZER=yes # Ragen can read Cicso Netflow records directly from Cisco # routers. Specifying this value will alert Ragen to open # a UDP based socket listening for data from this name or address. # # Commandline equivalent -C # #RAGEN_CISCONETFLOW_PORT=9996 # When ragen is compiled with SASL support, ragen may be # required to authenticate to the ragen data source before data # can be received. This variable will allow one to # set the user and authorization id's, if needed. Although # not recommended you can provide a password through the # RAGEN_AUTH_PASS variable. The format for this variable is: # # RAGEN_USER_AUTH="user_id/authorization_id" # # Commandline equivalent -U # #RAGEN_USER_AUTH="user/auth" #RAGEN_AUTH_PASS="password" # Ragen monitors can provide a real-time remote access port # for other programs to collect Ragen data. This is a TCP based # port service and the default port number is tcp/561, the # "experimental monitor" service. This feature is disabled by # default, and can be forced off by setting it to zero (0). # # When you do want to enable this service, 561 is a good choice, # as all ra* clients are configured to try this port by default. # # Commandline equivalent -P # RAGEN_ACCESS_PORT=563 # When remote access is enabled (see above), you can specify that Ragen # should bind only to a specific IP address. This is useful, for example, # in restricting access to the local host, or binding to a private # interface while capturing from another. The default is to bind to any # IP address. # # Commandline equivalent -B # RAGEN_BIND_IP=127.0.0.1 # # Ragen can write its output to one or a number of files, # default limit is 64 concurrent files, each with their own # independant filters. # # The format is: # RAGEN_OUTPUT_FILE=/full/path/file/name # RAGEN_OUTPUT_FILE=/full/path/file/name "filter" # # Most sites will have ragen write to a file, for reliablity # and performance. The example file name used here supports # the archive program ./support/Archive/ragenarchive # which is configured to use this file. # # Commandline equivalent -w # #RAGEN_OUTPUT_FILE=/var/log/ragen/ragen.out # Ragen can write its output to one or a number of remote hosts. # The default limit is 5 concurrent output streams, each with their # own independant filters. # # The format is: # RAGEN_OUTPUT_STREAM="URI [filter]" # RAGEN_OUTPUT_STREAN="argus-udp://host:port 'tcp and not udp'" # # Most sites will have argus listen() for remote sites to request # argus data, but for some sites and applications sending records without # registration is desired. This option will cause argus to transmit records # that match the optional filter, to the configured targets using UDP as the # transport mechanism. # # Commandline equivalent -w argus-udp://host:port # #RAGEN_OUTPUT_STREAM=argus-udp://224.0.23.40:561 # Ragen supports chroot(2) in order to control the file system that # ragen exists in and can access. Generally used when ragen is running # with privleges, this limits the negative impacts that ragen could # inflict on its host machine. # # This option will cause the output file names to be relative to this # directory, and so consider this when trying to find your output files. # # Commandline equivalent -C # #RAGEN_CHROOT_DIR="/tmp" # Ragen can be directed to change its user id using the setuid() system # call. This is can used when ragen is started as root, in order to # access privleged resources, but then after the resources are opened, # this directive will cause ragen to change its user id value to # a 'lesser' capable account. Recommended when ragen is running as a # daemon. # # Commandline equivalent -u # #RAGEN_SETUSER_ID=user # Ragen can be directed to change its group id using the setgid() system # call. This is can used when ragen is started as root, in order to # access privleged resources, but then after the resources are opened, # this directive can be used to change argu's group id value to # a 'lesser' capable account. Recommended when ragen is running as a # daemon. # # Commandline equivalent -g # #RAGEN_SETGROUP_ID=group # # Data transformation/processing is done on the complete set # of input records, and all output from this ragen node is # transformed. This makes cataloging and tracking the # transformational nodes a bit easier. # # This example enables data classification/labeling. # This function is enabled with a single ragen configuration # keyword RAGEN_CLASSIFIER, and then a ralabel() configuration # file is provided. # # Commandline equivalent none #RAGEN_CLASSIFIER_FILE=/usr/local/argus/ralabel.conf # # Ragen can advertise its port availability using Bonjour / mDns # if the system supports it. # # Commandline equivalent -M zeroconf RAGEN_ZEROCONF_REGISTER=yes