Debian Codegraph @

support/Config/ralabel.conf

raw
1 #
2 # Argus Client Software
3 # Copyright (c) 2000-2024 QoSient, LLC
4 # All rights reserved.
5 #
6 #
7 # RaLabel Configuration
8 #
9 # Carter Bullard
10 # QoSient, LLC
11 #
12 # This configuration is a ralabel(1) configuration file.
13 #
14 # The concept is to provide a number of labeling strategies
15 # with configuration capabilities for each of the labelers.
16 # This allows the user to specify the order of the labeling,
17 # which is provided to support hierarchical labeling.
18 #
19 # Here is a valid and simple configuration file. It doesn't do
20 # anything in particular, but it is one that is used at some sites.
21 #
22
23 # Supported Labeling Strategies
24
25 # L2 Addresss Based Classification
26 # L2 Address based classifications involve building a database
27 # of ethernet addresses and storing labels accordingly. The
28 # implementation strategy is to use a hash based datastore to store
29 # labels, and the configuration file will take the shape of:
30 #
31 # L2_address label
32 #
33 # The two items are separated by any number of SPACE and/or TAB char acters. A # at
34 # the beginning of a line starts a comment which extends to the end of the line.
35 # The Ethernet-address is written as x:x:x:x:x:x, where x is a hexadecimal
36 # number between 0 and ff which represents one byte of the address. The value is
37 # in network byte order (big-endian).
38 #
39 # The label is a string, and represents any form of meta-data or attribute value.
40 #
41 # Support exists for IEEE layer 2 address formats, such as ethernet
42 # address (802.3, 802.11) and future support will be for Infiniband addresses.
43 #
44 #RALABEL_IEEE_ADDRESS=yes
45 #RALABEL_IEEE_ADDRESS_FILE="/usr/local/argus/ieee-address-file"
46
47 # Addresss Based Classification
48 # Address based classifications involve building a patricia tree
49 # that we can hang labels against. The strategy is to order the
50 # address label configuration files, to develop a hierarchical
51 # label scheme.
52 #
53 # IANA IPv4 and IPv6 Address Classification Labeling
54 #
55 # The type of IP network address can be used by many analysis
56 # programs to make decisions. While IANA standard classifications
57 # don't change, this type of classification should be extendable
58 # to allow local sites to provide additional labeling capabilities.
59
60 #RALABEL_IANA_ADDRESS=yes
61 #RALABEL_IANA_ADDRESS_FILE="/usr/local/argus/iana-address-file"
62
63
64 # Addresss Based Country Code Classification
65 # Address based country code classification leverages the feature
66 # where ra* clients cant print country codes for the IP addresses
67 # that are in a flow record. Country codes are generated from the ARIN
68 # delegated address space files. Specify the location of your
69 # DELEGATED_IP file here, or in your .rarc file (which is default).
70 #
71 # Unlike the GeoIP based country code labeling, these codes can be sorted
72 # filtered and aggregated, so if you want to do that type of operations
73 # with country codes, enable this feature here.
74 #
75
76 #RALABEL_ARIN_COUNTRY_CODES=yes
77 #RA_DELEGATED_IP="/usr/local/argus/delegated-ipv4-latest"
78
79
80 # BIND Based Classification
81 # BIND services provide address to name translations, and these
82 # reverse lookup strategies can provide FQDN labels, or domain
83 # labels that can be added to flow. The IP addresses that can be
84 # 'labeled' are the saddr, daddr, or inode. Keywords "yes" and "all"
85 # are synonomous and result in labeling all three IP addresses.
86 #
87 # Use this strategy to provide transient semantic enhancement based
88 # on ip address values.
89 #
90
91 #RALABEL_BIND_NAME="all"
92
93 #
94 # When labelers provide names, they can use blocking or non-blocking
95 # resolvers to perform the lookups. Blocking, the default, will cause
96 # the labeler to wait for resolutions to return. This ensures that the
97 # label will have the best answer in every flow record process, however
98 # blocking resolvers can cause performance issues. Non-blocking will
99 # queue lookups and establish its name resolution cache, in a lazy
100 # manner.
101
102 #RALABEL_BIND_NON_BLOCKING="no""
103
104 #
105 # When labelers provide names, they can prit the FQDN, the host portion
106 # or just the domain name, depending on your uses of the name label.
107 #
108
109 #RALABEL_PRINT_DOMAINONLY="no"
110 #RALABEL_PRINT_LOCALONLY="no"
111
112 #
113 # All name resolutions are cached, to improve performance. This provides
114 # the best performance, however, for long lived labeling daemons, a timeout
115 # or TTL, can be placed on the name table, so that the labeler will
116 # periodically requery for resolutions.
117 #
118 # The default is -1, which disables cache timeouts.
119 # Zero (0) will turn off any caching and will have a performance impact.
120
121 #RALABEL_DNS_NAME_CACHE_TIMEOUT=-1
122
123
124
125 # Port Based Classification
126 # Port based classifications involves simple assignment of a text
127 # label to a specific port number. While IANA standard classifications
128 # are supported throught the Unix /etc/services file assignments,
129 # and the basic "src port" and "dst port" ra* filter schemes,
130 # this scheme is used to enhance/modify that labeling strategy.
131 # The text associated with a port number is placed in the metadata
132 # label field, and is searched using the regular expression searching
133 # strategies that are available to label matching.
134 #
135 # Use this strategy to provide transient semantic enhancement based
136 # on port values.
137 #
138
139 #RALABEL_IANA_PORT=yes
140 #RALABEL_IANA_PORT_FILE="/usr/local/argus/iana-port-numbers"
141
142
143 # Flow Filter Based Classification
144 # Flow filter based classification uses the standard flow
145 # filter strategies to provide a general purpose labeling scheme.
146 # The concept is similar to racluster()'s fall through matching
147 # scheme. Fall through the list of filters, if it matches, add the
148 # label. If you want to continue through the list, once there is
149 # a match, add a "cont" to the end of the matching rule.
150 #
151
152 #RALABEL_ARGUS_FLOW=yes
153 #RALABEL_ARGUS_FLOW_FILE="/usr/local/argus/argus-flow-file"
154 #
155
156
157 # Services Based Classification
158 # Services base classification uses a services/application signature
159 # file to identify / validate the service based on the user buffer
160 # content capture in argus flow records.
161 #
162 # The concept searches a signature library, first comparing content
163 # signatures for the tcp/udp ports that are used in the flow record,
164 # and if there is not a match that meets a specific threshold, we
165 # search for the pattern in the signature library for the best fit.
166 #
167 # The service name is added to the label of the flow.
168 #
169 #RALABEL_ARGUS_FLOW_SERVICE=yes
170 #RA_SERVICE_SIGNATURES="/usr/local/argus/std.sig"
171 #
172
173 # Netspatial Based Labeling
174 # The labeling features can provide netspatial locality scoring using
175 # IANA IPv4 and IPv6 Address classification labeling.
176 # This involves building a database of IP addresses, and providing
177 # locality scoring values that will be inserted into the records
178 # using the " local " and " asn " dsrs, if the optional ASN is included.
179 # . The configuration file syntax is:
180 #
181 # L3_address Locus (int) ASN (optional)
182 #
183 # Where an L3 address is a Dot Notation address, a CIDR address, or a
184 # contiguous range of addresses, denoted by 2 addresses separated by a '-'.
185 # Locus is an int with local significance, and the ASN is an optional value.
186 #
187 # The three items are separated by any number of SPACE and/or TAB char acters. A # at
188 # the beginning of a line starts a comment which extends to the end of the line.
189 #
190 RALABEL_LOCALITY=yes
191 RALABEL_LOCALITY_FILE="/usr/local/argus/LocalityData.txt"
192
193
194 # GeoIP Based Labeling
195 # The labeling features can use the databases provided by MaxMind
196 # using the GeoIP LGPL libraries. If your code was configured to use
197 # these libraries, then enable the features here.
198 #
199 # GeoIP provides a lot of support for geo-location, configure support
200 # by enabling a feature and providing the appropriate binary data files.
201 # ASN reporting is done from a separate set of data files, obtained from
202 # MaxMind.com, and so enabling this feature is independent of the
203 # traditional city data available.
204 #
205
206 #RALABEL_GEOIP_ASN=yes
207 #RALABEL_GEOIP_ASN_FILE="/usr/local/share/GeoIP/GeoIPASNum.dat"
208 #RALABEL_GEOIP_V6_ASN_FILE="/usr/local/share/GeoIP/GeoIPASNumv6.dat"
209
210 #
211 # Data for city relevant data is enabled through enabling and configuring
212 # the city database support. The types of data available are:
213 # country_code, country_code3, country_name, region, city, postal_code,
214 # latitude, longitude, metro_code, area_code and continent_code.
215 # time_offset is also available.
216 #
217 # The concept is that you should be able to add semantics for any
218 # IP address that is in the argus record. Support addresses are:
219 #
220 # saddr, daddr, inode
221 #
222 # The labels provided will be tagged as:
223 # scity, dcity, icity
224 #
225 # To configure what you want to have placed in the label, use the list of
226 # objects, in whatever order you like, as the RALABEL_GEOPIP_CITY string
227 # using these keywords:
228 # cco - country_code
229 # cco3 - country_code3
230 # cname - country_name
231 # reg - region
232 # city - city
233 # pcode - postal_code
234 # lat - latitude
235 # long - longitude
236 # metro - metro_code
237 # area - area_code
238 # cont - continent_code
239 # netmask - netmask value
240 #
241 # Working examples could be:
242 # RALABEL_GEOIP_CITY="saddr,daddr:lat/lon"
243 # RALABEL_GEOIP_CITY="*:city,region,cname,lat,lon"
244 #
245 #RALABEL_GEOIP_CITY="saddr,daddr,inode:off,cont,lat,lon"
246 #RALABEL_GEOIP_CITY_FILE="/usr/local/share/GeoIP/GeoIP.dat"
247 #RALABEL_GEOIP_V6_CITY_FILE="/usr/local/share/GeoIP/GeoIPv6.dat"