| 1 |
# |
| 2 |
# Ragen Software |
| 3 |
# Copyright (c) 2000-2024 QoSient, LLC |
| 4 |
# All rights reserved. |
| 5 |
# |
| 6 |
# This program is free software; you can redistribute it and/or modify |
| 7 |
# it under the terms of the GNU General Public License as published by |
| 8 |
# the Free Software Foundation; either version 2, or (at your option) |
| 9 |
# any later version. |
| 10 |
# |
| 11 |
# This program is distributed in the hope that it will be useful, |
| 12 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 |
# GNU General Public License for more details. |
| 15 |
# |
| 16 |
# You should have received a copy of the GNU General Public License |
| 17 |
# along with this program; if not, write to the Free Software |
| 18 |
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 19 |
# |
| 20 |
# Example ragen.conf |
| 21 |
# |
| 22 |
# Ragen will open this ragen.conf if its installed as /etc/ragen.conf. |
| 23 |
# It will also search for this file as ragen.conf in directories |
| 24 |
# specified in $RAGENPATH, or $RAGENHOME, $RAGENHOME/lib, |
| 25 |
# or $HOME, $HOME/lib, and parse it to set common configuration |
| 26 |
# options. All values in this file can be overriden by command |
| 27 |
# line options, or other files of this format that can be read in |
| 28 |
# using the -F option. |
| 29 |
# |
| 30 |
# |
| 31 |
# Variable Syntax |
| 32 |
# |
| 33 |
# Variable assignments must be of the form: |
| 34 |
# |
| 35 |
# VARIABLE= |
| 36 |
# |
| 37 |
# with no white space between the VARIABLE and the '=' sign. |
| 38 |
# Quotes are optional for string arguements, but if you want |
| 39 |
# to embed comments, then quotes are required. |
| 40 |
# |
| 41 |
# |
| 42 |
# Variable Explanations |
| 43 |
# |
| 44 |
# Ragen is capable of running as a daemon, doing all the right things |
| 45 |
# that daemons do. When this specific configuration file is used |
| 46 |
# to configure the system daemon process (/etc/ragen.conf) this |
| 47 |
# variable should be set to "yes". |
| 48 |
# |
| 49 |
# The default value is to not run as a daemon. |
| 50 |
# |
| 51 |
# This example is to support the ./support/Startup/ragen script |
| 52 |
# which requires that this variable be set to "yes". |
| 53 |
# |
| 54 |
# Commandline equivalent -d |
| 55 |
# |
| 56 |
|
| 57 |
RAGEN_DAEMON=no |
| 58 |
|
| 59 |
|
| 60 |
# Ragen Monitor Data is uniquely identifiable based on the source |
| 61 |
# identifier that is included in each output record. This is to |
| 62 |
# allow you to work with Argus Data from multiple monitors at the |
| 63 |
# same time. The ID is 32 bits long, and supports a number of |
| 64 |
# formats as legitimate values. Ragen supports unsigned ints, IPv4 |
| 65 |
# addresses and 4 bytes strings, as values. |
| 66 |
# |
| 67 |
# The formats are discerned from the values provided. Double-quoted |
| 68 |
# values are treated as strings, and are truncated to 4 characters. |
| 69 |
# Non-quoted values are tested for whether they are hostnames, and if |
| 70 |
# not, then they are tested wheter they are numbers. |
| 71 |
# |
| 72 |
# The configuration allows for you to use host names, however, do |
| 73 |
# have some understanding how `hostname` will be resolved by the |
| 74 |
# nameserver before commiting to this strategy completely. |
| 75 |
# |
| 76 |
# For convenience, argus supports the notion of "`hostname`" for |
| 77 |
# assigning the probe's id. This is to support management of |
| 78 |
# large deployments, so you can have one argus.conf file that works |
| 79 |
# for a lot of probes. |
| 80 |
# |
| 81 |
# For security, argus does not rely on system programs, like hostname.1. |
| 82 |
# It implements the logic of hostname itself, so don't try to run |
| 83 |
# arbitrary programs using this method, because it won't work. |
| 84 |
# |
| 85 |
# Commandline equivalent -e |
| 86 |
# |
| 87 |
|
| 88 |
#RAGEN_MONITOR_ID=`hostname` // IPv4 address returned |
| 89 |
#RAGEN_MONITOR_ID=10.2.45.3 // IPv4 address |
| 90 |
#RAGEN_MONITOR_ID=2435 // Number |
| 91 |
#RAGEN_MONITOR_ID="rad0" // String |
| 92 |
|
| 93 |
RAGEN_MONITOR_ID=uuid:/22DD94B8-4A63-52B6-89A0-AAA833373D0C |
| 94 |
#RAGEN_MONITOR_ID=`hostuuid` // assigned uuid value |
| 95 |
|
| 96 |
# Srcid's are specified using the notion used for ARGUS_MONITOR_ID, as above. |
| 97 |
|
| 98 |
RAGEN_MONITOR_ID_INCLUDE_INF="gen0" |
| 99 |
|
| 100 |
|
| 101 |
# If compiled to support this option, Ragen is capable of |
| 102 |
# generating a lot of debug information. |
| 103 |
# |
| 104 |
# The default value is zero (0). |
| 105 |
# |
| 106 |
# Commandline equivalent -D |
| 107 |
# |
| 108 |
|
| 109 |
#RAGEN_DEBUG_LEVEL=0 |
| 110 |
|
| 111 |
|
| 112 |
# Ragen will periodically report on a its own health, providing |
| 113 |
# interface status, total packet and bytes counts, packet drop |
| 114 |
# rates, and flow oriented statistics. |
| 115 |
# |
| 116 |
# These records can be used as "keep alives" for periods when |
| 117 |
# there is no network traffic to be monitored. |
| 118 |
# |
| 119 |
# The default value is 60 seconds, but a value of 60 seconds is |
| 120 |
# very common. |
| 121 |
# |
| 122 |
# Commandline equivalent -M |
| 123 |
# |
| 124 |
|
| 125 |
RAGEN_MAR_STATUS_INTERVAL=5 |
| 126 |
|
| 127 |
|
| 128 |
# |
| 129 |
# Ragen can attach to any number of remote argus data sources, |
| 130 |
# argi or radii. The syntax for this variable is a URI that |
| 131 |
# specifies the URI schema, with transport, the hostname or a |
| 132 |
# dot notation IP address, followed by an optional port value, |
| 133 |
# separated by a ':'. If the URI format is not specified, |
| 134 |
# the URI schema and transport mechanism are the default, argus:// |
| 135 |
# If the port is not specified, the default value of 561 is used. |
| 136 |
# |
| 137 |
# Commandline equivalent -S <argus://host[:port]> |
| 138 |
# Commandline equivalent -S <argus-tcp://host[:port]> |
| 139 |
# Commandline equivalent -S <argus-udp://host[:port]> |
| 140 |
# Commandline equivalent -S <cisco://host[:port]> |
| 141 |
# Commandline equivalent -S <host[:port]> |
| 142 |
# |
| 143 |
|
| 144 |
#RAGEN_ARGUS_SERVER=127.0.0.1:562 |
| 145 |
|
| 146 |
# You can provide a filter expression here, if you like. |
| 147 |
# Ragen will filter all input records based on this definition. |
| 148 |
# It should be limited to 2K in length. The default is to |
| 149 |
# not filter. |
| 150 |
# |
| 151 |
# No Commandline equivalent |
| 152 |
# |
| 153 |
|
| 154 |
#RAGEN_FILTER="" |
| 155 |
|
| 156 |
|
| 157 |
# Ragen can adjust the timestamps in ragen records as it receives |
| 158 |
# them, based on the measured time difference between ragen() |
| 159 |
# and the sources. The variable takes a threshold value in |
| 160 |
# seconds, so you can specify when to make a correction. |
| 161 |
# |
| 162 |
# No Commandline equivalent |
| 163 |
# |
| 164 |
|
| 165 |
#RAGEN_ADJUST_TIME=5 |
| 166 |
|
| 167 |
|
| 168 |
# Ragen has filter capabilities that use a filter optimizer. |
| 169 |
# If there is a need to not use this filter optimizer, |
| 170 |
# you can turn it off here. The default is to leave it on. |
| 171 |
# |
| 172 |
# Commandline equivalent -O |
| 173 |
# |
| 174 |
|
| 175 |
#RAGEN_FILTER_OPTIMIZER=yes |
| 176 |
|
| 177 |
|
| 178 |
# Ragen can read Cicso Netflow records directly from Cisco |
| 179 |
# routers. Specifying this value will alert Ragen to open |
| 180 |
# a UDP based socket listening for data from this name or address. |
| 181 |
# |
| 182 |
# Commandline equivalent -C |
| 183 |
# |
| 184 |
|
| 185 |
#RAGEN_CISCONETFLOW_PORT=9996 |
| 186 |
|
| 187 |
|
| 188 |
# When ragen is compiled with SASL support, ragen may be |
| 189 |
# required to authenticate to the ragen data source before data |
| 190 |
# can be received. This variable will allow one to |
| 191 |
# set the user and authorization id's, if needed. Although |
| 192 |
# not recommended you can provide a password through the |
| 193 |
# RAGEN_AUTH_PASS variable. The format for this variable is: |
| 194 |
# |
| 195 |
# RAGEN_USER_AUTH="user_id/authorization_id" |
| 196 |
# |
| 197 |
# Commandline equivalent -U |
| 198 |
# |
| 199 |
|
| 200 |
#RAGEN_USER_AUTH="user/auth" |
| 201 |
#RAGEN_AUTH_PASS="password" |
| 202 |
|
| 203 |
|
| 204 |
# Ragen monitors can provide a real-time remote access port |
| 205 |
# for other programs to collect Ragen data. This is a TCP based |
| 206 |
# port service and the default port number is tcp/561, the |
| 207 |
# "experimental monitor" service. This feature is disabled by |
| 208 |
# default, and can be forced off by setting it to zero (0). |
| 209 |
# |
| 210 |
# When you do want to enable this service, 561 is a good choice, |
| 211 |
# as all ra* clients are configured to try this port by default. |
| 212 |
# |
| 213 |
# Commandline equivalent -P |
| 214 |
# |
| 215 |
|
| 216 |
RAGEN_ACCESS_PORT=563 |
| 217 |
|
| 218 |
|
| 219 |
# When remote access is enabled (see above), you can specify that Ragen |
| 220 |
# should bind only to a specific IP address. This is useful, for example, |
| 221 |
# in restricting access to the local host, or binding to a private |
| 222 |
# interface while capturing from another. The default is to bind to any |
| 223 |
# IP address. |
| 224 |
# |
| 225 |
# Commandline equivalent -B |
| 226 |
# |
| 227 |
|
| 228 |
RAGEN_BIND_IP=127.0.0.1 |
| 229 |
|
| 230 |
|
| 231 |
# |
| 232 |
# Ragen can write its output to one or a number of files, |
| 233 |
# default limit is 64 concurrent files, each with their own |
| 234 |
# independant filters. |
| 235 |
# |
| 236 |
# The format is: |
| 237 |
# RAGEN_OUTPUT_FILE=/full/path/file/name |
| 238 |
# RAGEN_OUTPUT_FILE=/full/path/file/name "filter" |
| 239 |
# |
| 240 |
# Most sites will have ragen write to a file, for reliablity |
| 241 |
# and performance. The example file name used here supports |
| 242 |
# the archive program ./support/Archive/ragenarchive |
| 243 |
# which is configured to use this file. |
| 244 |
# |
| 245 |
# Commandline equivalent -w |
| 246 |
# |
| 247 |
|
| 248 |
#RAGEN_OUTPUT_FILE=/var/log/ragen/ragen.out |
| 249 |
|
| 250 |
|
| 251 |
|
| 252 |
# Ragen can write its output to one or a number of remote hosts. |
| 253 |
# The default limit is 5 concurrent output streams, each with their |
| 254 |
# own independant filters. |
| 255 |
# |
| 256 |
# The format is: |
| 257 |
# RAGEN_OUTPUT_STREAM="URI [filter]" |
| 258 |
# RAGEN_OUTPUT_STREAN="argus-udp://host:port 'tcp and not udp'" |
| 259 |
# |
| 260 |
# Most sites will have argus listen() for remote sites to request |
| 261 |
# argus data, but for some sites and applications sending records without |
| 262 |
# registration is desired. This option will cause argus to transmit records |
| 263 |
# that match the optional filter, to the configured targets using UDP as the |
| 264 |
# transport mechanism. |
| 265 |
# |
| 266 |
# Commandline equivalent -w argus-udp://host:port |
| 267 |
# |
| 268 |
|
| 269 |
#RAGEN_OUTPUT_STREAM=argus-udp://224.0.23.40:561 |
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
# Ragen supports chroot(2) in order to control the file system that |
| 274 |
# ragen exists in and can access. Generally used when ragen is running |
| 275 |
# with privleges, this limits the negative impacts that ragen could |
| 276 |
# inflict on its host machine. |
| 277 |
# |
| 278 |
# This option will cause the output file names to be relative to this |
| 279 |
# directory, and so consider this when trying to find your output files. |
| 280 |
# |
| 281 |
# Commandline equivalent -C |
| 282 |
# |
| 283 |
|
| 284 |
#RAGEN_CHROOT_DIR="/tmp" |
| 285 |
|
| 286 |
|
| 287 |
# Ragen can be directed to change its user id using the setuid() system |
| 288 |
# call. This is can used when ragen is started as root, in order to |
| 289 |
# access privleged resources, but then after the resources are opened, |
| 290 |
# this directive will cause ragen to change its user id value to |
| 291 |
# a 'lesser' capable account. Recommended when ragen is running as a |
| 292 |
# daemon. |
| 293 |
# |
| 294 |
# Commandline equivalent -u |
| 295 |
# |
| 296 |
|
| 297 |
#RAGEN_SETUSER_ID=user |
| 298 |
|
| 299 |
|
| 300 |
# Ragen can be directed to change its group id using the setgid() system |
| 301 |
# call. This is can used when ragen is started as root, in order to |
| 302 |
# access privleged resources, but then after the resources are opened, |
| 303 |
# this directive can be used to change argu's group id value to |
| 304 |
# a 'lesser' capable account. Recommended when ragen is running as a |
| 305 |
# daemon. |
| 306 |
# |
| 307 |
# Commandline equivalent -g |
| 308 |
# |
| 309 |
|
| 310 |
#RAGEN_SETGROUP_ID=group |
| 311 |
|
| 312 |
|
| 313 |
# |
| 314 |
# Data transformation/processing is done on the complete set |
| 315 |
# of input records, and all output from this ragen node is |
| 316 |
# transformed. This makes cataloging and tracking the |
| 317 |
# transformational nodes a bit easier. |
| 318 |
# |
| 319 |
# This example enables data classification/labeling. |
| 320 |
# This function is enabled with a single ragen configuration |
| 321 |
# keyword RAGEN_CLASSIFIER, and then a ralabel() configuration |
| 322 |
# file is provided. |
| 323 |
# |
| 324 |
# Commandline equivalent none |
| 325 |
|
| 326 |
#RAGEN_CLASSIFIER_FILE=/usr/local/argus/ralabel.conf |
| 327 |
|
| 328 |
# |
| 329 |
# Ragen can advertise its port availability using Bonjour / mDns |
| 330 |
# if the system supports it. |
| 331 |
# |
| 332 |
# Commandline equivalent -M zeroconf |
| 333 |
|
| 334 |
RAGEN_ZEROCONF_REGISTER=yes |