# # Argus Client Software # Copyright (c) 2000-2024 QoSient, LLC # All rights reserved. # # # RaLabel Configuration # # Carter Bullard # QoSient, LLC # # This configuration is a ralabel(1) configuration file. # # The concept is to provide a number of labeling strategies # with configuration capabilities for each of the labelers. # This allows the user to specify the order of the labeling, # which is provided to support hierarchical labeling. # # Here is a valid and simple configuration file. It doesn't do # anything in particular, but it is one that is used at some sites. # # Supported Labeling Strategies # L2 Addresss Based Classification # L2 Address based classifications involve building a database # of ethernet addresses and storing labels accordingly. The # implementation strategy is to use a hash based datastore to store # labels, and the configuration file will take the shape of: # # L2_address label # # The two items are separated by any number of SPACE and/or TAB char acters. A # at # the beginning of a line starts a comment which extends to the end of the line. # The Ethernet-address is written as x:x:x:x:x:x, where x is a hexadecimal # number between 0 and ff which represents one byte of the address. The value is # in network byte order (big-endian). # # The label is a string, and represents any form of meta-data or attribute value. # # Support exists for IEEE layer 2 address formats, such as ethernet # address (802.3, 802.11) and future support will be for Infiniband addresses. # #RALABEL_IEEE_ADDRESS=yes #RALABEL_IEEE_ADDRESS_FILE="/usr/local/argus/ieee-address-file" # Addresss Based Classification # Address based classifications involve building a patricia tree # that we can hang labels against. The strategy is to order the # address label configuration files, to develop a hierarchical # label scheme. # # IANA IPv4 and IPv6 Address Classification Labeling # # The type of IP network address can be used by many analysis # programs to make decisions. While IANA standard classifications # don't change, this type of classification should be extendable # to allow local sites to provide additional labeling capabilities. #RALABEL_IANA_ADDRESS=yes #RALABEL_IANA_ADDRESS_FILE="/usr/local/argus/iana-address-file" # Addresss Based Country Code Classification # Address based country code classification leverages the feature # where ra* clients cant print country codes for the IP addresses # that are in a flow record. Country codes are generated from the ARIN # delegated address space files. Specify the location of your # DELEGATED_IP file here, or in your .rarc file (which is default). # # Unlike the GeoIP based country code labeling, these codes can be sorted # filtered and aggregated, so if you want to do that type of operations # with country codes, enable this feature here. # #RALABEL_ARIN_COUNTRY_CODES=yes #RA_DELEGATED_IP="/usr/local/argus/delegated-ipv4-latest" # BIND Based Classification # BIND services provide address to name translations, and these # reverse lookup strategies can provide FQDN labels, or domain # labels that can be added to flow. The IP addresses that can be # 'labeled' are the saddr, daddr, or inode. Keywords "yes" and "all" # are synonomous and result in labeling all three IP addresses. # # Use this strategy to provide transient semantic enhancement based # on ip address values. # #RALABEL_BIND_NAME="all" # # When labelers provide names, they can use blocking or non-blocking # resolvers to perform the lookups. Blocking, the default, will cause # the labeler to wait for resolutions to return. This ensures that the # label will have the best answer in every flow record process, however # blocking resolvers can cause performance issues. Non-blocking will # queue lookups and establish its name resolution cache, in a lazy # manner. #RALABEL_BIND_NON_BLOCKING="no"" # # When labelers provide names, they can prit the FQDN, the host portion # or just the domain name, depending on your uses of the name label. # #RALABEL_PRINT_DOMAINONLY="no" #RALABEL_PRINT_LOCALONLY="no" # # All name resolutions are cached, to improve performance. This provides # the best performance, however, for long lived labeling daemons, a timeout # or TTL, can be placed on the name table, so that the labeler will # periodically requery for resolutions. # # The default is -1, which disables cache timeouts. # Zero (0) will turn off any caching and will have a performance impact. #RALABEL_DNS_NAME_CACHE_TIMEOUT=-1 # Port Based Classification # Port based classifications involves simple assignment of a text # label to a specific port number. While IANA standard classifications # are supported throught the Unix /etc/services file assignments, # and the basic "src port" and "dst port" ra* filter schemes, # this scheme is used to enhance/modify that labeling strategy. # The text associated with a port number is placed in the metadata # label field, and is searched using the regular expression searching # strategies that are available to label matching. # # Use this strategy to provide transient semantic enhancement based # on port values. # #RALABEL_IANA_PORT=yes #RALABEL_IANA_PORT_FILE="/usr/local/argus/iana-port-numbers" # Flow Filter Based Classification # Flow filter based classification uses the standard flow # filter strategies to provide a general purpose labeling scheme. # The concept is similar to racluster()'s fall through matching # scheme. Fall through the list of filters, if it matches, add the # label. If you want to continue through the list, once there is # a match, add a "cont" to the end of the matching rule. # #RALABEL_ARGUS_FLOW=yes #RALABEL_ARGUS_FLOW_FILE="/usr/local/argus/argus-flow-file" # # Services Based Classification # Services base classification uses a services/application signature # file to identify / validate the service based on the user buffer # content capture in argus flow records. # # The concept searches a signature library, first comparing content # signatures for the tcp/udp ports that are used in the flow record, # and if there is not a match that meets a specific threshold, we # search for the pattern in the signature library for the best fit. # # The service name is added to the label of the flow. # #RALABEL_ARGUS_FLOW_SERVICE=yes #RA_SERVICE_SIGNATURES="/usr/local/argus/std.sig" # # Netspatial Based Labeling # The labeling features can provide netspatial locality scoring using # IANA IPv4 and IPv6 Address classification labeling. # This involves building a database of IP addresses, and providing # locality scoring values that will be inserted into the records # using the " local " and " asn " dsrs, if the optional ASN is included. # . The configuration file syntax is: # # L3_address Locus (int) ASN (optional) # # Where an L3 address is a Dot Notation address, a CIDR address, or a # contiguous range of addresses, denoted by 2 addresses separated by a '-'. # Locus is an int with local significance, and the ASN is an optional value. # # The three items are separated by any number of SPACE and/or TAB char acters. A # at # the beginning of a line starts a comment which extends to the end of the line. # RALABEL_LOCALITY=yes RALABEL_LOCALITY_FILE="/usr/local/argus/LocalityData.txt" # GeoIP Based Labeling # The labeling features can use the databases provided by MaxMind # using the GeoIP LGPL libraries. If your code was configured to use # these libraries, then enable the features here. # # GeoIP provides a lot of support for geo-location, configure support # by enabling a feature and providing the appropriate binary data files. # ASN reporting is done from a separate set of data files, obtained from # MaxMind.com, and so enabling this feature is independent of the # traditional city data available. # #RALABEL_GEOIP_ASN=yes #RALABEL_GEOIP_ASN_FILE="/usr/local/share/GeoIP/GeoIPASNum.dat" #RALABEL_GEOIP_V6_ASN_FILE="/usr/local/share/GeoIP/GeoIPASNumv6.dat" # # Data for city relevant data is enabled through enabling and configuring # the city database support. The types of data available are: # country_code, country_code3, country_name, region, city, postal_code, # latitude, longitude, metro_code, area_code and continent_code. # time_offset is also available. # # The concept is that you should be able to add semantics for any # IP address that is in the argus record. Support addresses are: # # saddr, daddr, inode # # The labels provided will be tagged as: # scity, dcity, icity # # To configure what you want to have placed in the label, use the list of # objects, in whatever order you like, as the RALABEL_GEOPIP_CITY string # using these keywords: # cco - country_code # cco3 - country_code3 # cname - country_name # reg - region # city - city # pcode - postal_code # lat - latitude # long - longitude # metro - metro_code # area - area_code # cont - continent_code # netmask - netmask value # # Working examples could be: # RALABEL_GEOIP_CITY="saddr,daddr:lat/lon" # RALABEL_GEOIP_CITY="*:city,region,cname,lat,lon" # #RALABEL_GEOIP_CITY="saddr,daddr,inode:off,cont,lat,lon" #RALABEL_GEOIP_CITY_FILE="/usr/local/share/GeoIP/GeoIP.dat" #RALABEL_GEOIP_V6_CITY_FILE="/usr/local/share/GeoIP/GeoIPv6.dat"