| 1 |
# |
| 2 |
# Argus Software |
| 3 |
# Copyright (c) 2000-2024 QoSient, LLC |
| 4 |
# All rights reserved. |
| 5 |
# |
| 6 |
# Permission to use, copy, modify, and distribute this software and |
| 7 |
# its documentation for any purpose and without fee is hereby granted, |
| 8 |
# provided that the above copyright notice appear in all copies and |
| 9 |
# that both that copyright notice and this permission notice appear |
| 10 |
# in supporting documentation, and that the name of QoSient not |
| 11 |
# be used in advertising or publicity pertaining to distribution of |
| 12 |
# the software without specific, written prior permission. |
| 13 |
# |
| 14 |
# QOSIENT, LLC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS |
| 15 |
# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND |
| 16 |
# FITNESS, IN NO EVENT SHALL QOSIENT, LLC BE LIABLE FOR ANY |
| 17 |
# SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER |
| 18 |
# RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF |
| 19 |
# CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN |
| 20 |
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 21 |
# |
| 22 |
# |
| 23 |
# Example ranonymize.conf |
| 24 |
# |
| 25 |
# Ranonymize will open this file and parse it to set common |
| 26 |
# configuration options. |
| 27 |
# |
| 28 |
# Values can be quoted to make string denotation easier, however, the |
| 29 |
# parser does not require that string values be quoted. To support this, |
| 30 |
# the parse will remove '\"' characters from input strings, so do not |
| 31 |
# use this character in strings themselves. |
| 32 |
# |
| 33 |
# Values specified as "" will be treated as a NULL string, and the parser |
| 34 |
# will ignore the variable setting. |
| 35 |
|
| 36 |
# Supported Options |
| 37 |
|
| 38 |
# Ranonymize allows you to specify the type of anonymization methods |
| 39 |
# used for a number of categories. The types are "sequential", "random", |
| 40 |
# "specific", "fixed" or "no" anonymization. Each is described below |
| 41 |
# as they appear in the configuration. |
| 42 |
# |
| 43 |
# ranonymize() uses various strategies to seed its random number |
| 44 |
# generator. If the user specifies a seed, then the srandon(seed) |
| 45 |
# function is used. If keyword "time" is used, then the system usec |
| 46 |
# value at the invocation is used. If the keyword "crypto" is used, |
| 47 |
# then the system call srandomdev() is used if available. If not, |
| 48 |
# the "time" method is used. Configuring with a specific seed value |
| 49 |
# in this configuration file, will generate deterministic values |
| 50 |
# which should result in assignments that are duplicated with |
| 51 |
# reach run. |
| 52 |
# |
| 53 |
|
| 54 |
#RANON_SEED="time" |
| 55 |
#RANON_SEED="crypto" |
| 56 |
RANON_SEED=29384938 |
| 57 |
|
| 58 |
# |
| 59 |
# Ranonymize automatcially anonymizes various fields in Argus records, such |
| 60 |
# as the timestamps, transaction reference numbers, and sequence numbers. |
| 61 |
# These values if not anonymized, would provide simple means to match pre and |
| 62 |
# post anonymized flow records, defeating the anonymization process, however |
| 63 |
# you can always turn anonymization off for any fields with the "no" directive. |
| 64 |
|
| 65 |
# For many attributes, there is a desire to preserve the relative values, |
| 66 |
# rather than absolute ... In order to preserve relative values, anonymization |
| 67 |
# involves subtracting a constant value from the field in every argus record seen. |
| 68 |
# These values, if needed, can be defined by ranonymize or the user. |
| 69 |
# The anonymization method is "fixed" offset, and the constant |
| 70 |
# value can be specified by the user, "fixed:x", where x is a numerical |
| 71 |
# value, +/- 2^31, or chosen by ranonymize at random, "fixed:random", |
| 72 |
# where the random value is choosen from the same range as above. |
| 73 |
# "random" is equivalent to "fixed:random" for these values. |
| 74 |
# |
| 75 |
|
| 76 |
RANON_TRANSREFNUM_OFFSET=fixed:82736487 |
| 77 |
RANON_SEQNUM_OFFSET=fixed:10234 |
| 78 |
RANON_TIME_SEC_OFFSET=random |
| 79 |
RANON_TIME_USEC_OFFSET=random |
| 80 |
|
| 81 |
|
| 82 |
# Ranonymize allows you to specify the type of anonymization methods |
| 83 |
# used for L2 and L3 network addresses. For ethernet network and host |
| 84 |
# address conversion, ranonymize can support "sequential", "random", |
| 85 |
# "specific", "fixed" or "no" anonymization. |
| 86 |
|
| 87 |
# Sequential anonymization involves allocating new addresses in a |
| 88 |
# monotonically increasing fashion on a first come first serve basis. |
| 89 |
# For ethernet addresses this starts with the address xx:xx:xx:00:00:01, |
| 90 |
# where the xx:xx:xx is the vendor identification part, which could be |
| 91 |
# preserved, based on configuration (see below) or anonymized starting |
| 92 |
# with the value 00:00:00. For IP v4 addresses, the sequential address |
| 93 |
# range starts with the non-routable address space 10.0.0, by default. |
| 94 |
# Sequential randomization uses the least amount of memory and minimizes |
| 95 |
# anonymization processing time, however it does not offer the best |
| 96 |
# object scrambling method. |
| 97 |
# |
| 98 |
# As an example, if the first Argus record contained the addresses |
| 99 |
# 128.64.2.4 and 132.243.2.87 as source and destination, sequential |
| 100 |
# anonymization would generate the addresses 10.0.0.1 and 10.0.1.1 |
| 101 |
# as the new source and destination addresses, because there are two |
| 102 |
# unique network parts, 128.64.2 -> 10.0.0, and 132.243.2 -> 10.0.1. |
| 103 |
# Host parts are sequentially allocated within the new network address |
| 104 |
# space, and because both addresses are first, they come up as 1. |
| 105 |
# |
| 106 |
# Random anonymization involves choosing a value from a pool |
| 107 |
# of random values. The type of anonymization, net, host, |
| 108 |
# ethernet, dictates the size of the pool of values. |
| 109 |
# |
| 110 |
# Random anonymization could generate 10.24.31.203 and 10.1.34.18 |
| 111 |
# as examples, as both the 24 bit network parts would be allocated |
| 112 |
# randomly from the 10 network space, and the host address part |
| 113 |
# would be allocated randomly from the possible host addresses for |
| 114 |
# each allocated network space. Random anonymization provides better |
| 115 |
# address scrambling, as it is not dependant on address ordering, but |
| 116 |
# it is significantly more computationaly complex. |
| 117 |
|
| 118 |
# Ranonymize has the option to preserve specific aspects of ethernet |
| 119 |
# address semantics, such as vendor identification, and broadcast/ |
| 120 |
# multicast use. These can be selected independantly. |
| 121 |
|
| 122 |
RANON_ETHERNET_ANONYMIZATION=sequential |
| 123 |
RANON_PRESERVE_ETHERNET_VENDOR=no |
| 124 |
RANON_PRESERVE_ETHERNET_BROADCAST=yes |
| 125 |
RANON_PRESERVE_ETHERNET_MULTICAST=yes |
| 126 |
|
| 127 |
|
| 128 |
#RANON_IP_ADDRESS_ANONYMIZATION=no |
| 129 |
#RANON_NET_ANONYMIZATION=no |
| 130 |
RANON_NET_ANONYMIZATION=sequential |
| 131 |
|
| 132 |
#RANON_HOST_ANONYMIZATION=no |
| 133 |
RANON_HOST_ANONYMIZATION=sequential |
| 134 |
|
| 135 |
#RANON_AS_ANONYMIZATION=no |
| 136 |
RANON_AS_ANONYMIZATION=sequential |
| 137 |
|
| 138 |
# The length of the network address part of IPv4 addresses is by |
| 139 |
# default 24 bits, but it can be set to any value < 32. |
| 140 |
|
| 141 |
RANON_NETWORK_ADDRESS_LENGTH=24 |
| 142 |
|
| 143 |
# Ranonymize can be configured to perform specific network |
| 144 |
# address translation, regardless of the types of anonymization |
| 145 |
# that are being employed. These must be specified using the |
| 146 |
# configured network address length. These addresses are allocated |
| 147 |
# prior to any processing, and represent a culling from the available |
| 148 |
# anonymization address pool. |
| 149 |
# |
| 150 |
#Examples could be: |
| 151 |
# |
| 152 |
#RANON_SPECIFY_NET_TRANSLATION=192.168.0/24::128.2.134/24 |
| 153 |
#RANON_SPECIFY_NET_TRANSLATION=64.12.0/24::134.5.0/24 |
| 154 |
#RANON_SPECIFY_NET_TRANSLATION=128.2/24.0::200.200.0/24 |
| 155 |
# |
| 156 |
# |
| 157 |
# Ranonymize can also be configured to perform specific host |
| 158 |
# address translation. Feel free to list as many addresses |
| 159 |
# that you would like. |
| 160 |
# |
| 161 |
#Examples would be: |
| 162 |
# |
| 163 |
#RANON_SPECIFY_HOST_TRANSLATION=192.168.0.64::128.2.34.5 |
| 164 |
# |
| 165 |
|
| 166 |
# Ranonymize has the option to preserve the network address |
| 167 |
# hierarchy at various levels of granularity. This allows you to |
| 168 |
# preserve the addressing relationships between addresses. |
| 169 |
# The options are "cidr", "class" and "no". |
| 170 |
# |
| 171 |
# CIDR network address anoyminization specifies the length of |
| 172 |
# the network part for all address allocations. The default is |
| 173 |
# 24 bits. |
| 174 |
|
| 175 |
RANON_PRESERVE_NET_ADDRESS_HIERARCHY=cidr/24 |
| 176 |
|
| 177 |
|
| 178 |
# Class network adddress heirarchy preservation, causes ranonymize() |
| 179 |
# to allocate new network addresses base on the address class. All |
| 180 |
# CLASSA network addresses will be allocated new addresses from the |
| 181 |
# Class A network pool. The Class option sets the NETWORK_ADDRESS_LENGTH |
| 182 |
# value to 24. Specifing "specific" network translations is allowed, |
| 183 |
# however these address will not be hierarchy preserving. |
| 184 |
|
| 185 |
#RANON_PRESERVE_NET_ADDRESS_HIERARCHY=class |
| 186 |
|
| 187 |
# Ranonymize has the option to preserve the broadcast address |
| 188 |
# relationship by not modifying host addresses of 0 and 255. |
| 189 |
|
| 190 |
RANON_PRESERVE_BROADCAST_ADDRESS=yes |
| 191 |
|
| 192 |
# Preserving Multicast addresses means mapping any IANA defined |
| 193 |
# IPv4 multicast address to another multicast address. While there |
| 194 |
# is no inherient semantic of network and host values for mulitcast |
| 195 |
# addresses, ranonymize treats multicast addresses as normal addresses |
| 196 |
# but allocated from a separate pool. |
| 197 |
# Semantics for network and host parts still apply as above. |
| 198 |
|
| 199 |
RANON_PRESERVE_MULTICAST_ADDRESS=yes |
| 200 |
|
| 201 |
|
| 202 |
# Ranonymize anonymizes the IP_ID value in IPv4 records, by adding |
| 203 |
# a constant value to the existing ip_id and wrapping where appropriate. |
| 204 |
# The constant value can be generated by ranonymize as "fixed:random", |
| 205 |
# or the user can provid a "fixed:x", where x is the fixed offset, |
| 206 |
# or the keyword "none" can be used to turn off the default |
| 207 |
# |
| 208 |
RANON_PRESERVE_IP_ID=fixed:random |
| 209 |
|
| 210 |
|
| 211 |
# Ranonymize anonymizes the IP TTL value in IPv4 records, by shortening |
| 212 |
# or lengthing the distance from a specific IP address/network by a |
| 213 |
# constant value to the existing src and dst ttls. This functionally |
| 214 |
# moves the observation point of the probe relative to the set of |
| 215 |
# observed addresses. In order to achieve this, ranonymize tracks |
| 216 |
# the ttl offset by translated IP address. |
| 217 |
# |
| 218 |
# When hierarchy perservation is specified, the ttl changes will |
| 219 |
# be adjusted based on the network part of the address. |
| 220 |
# |
| 221 |
# Three values that are significant and can be preserved independantly |
| 222 |
# are 0, 255 and 254. 255 and 254 function in many distance contraint |
| 223 |
# mechanisms and are used by network equipment itself, and they have |
| 224 |
# network relivance that is significant. |
| 225 |
# |
| 226 |
# The constant value can be generated by ranonymize as "fixed:random", |
| 227 |
# or the user can provid a "fixed:x", where x is the fixed offset, |
| 228 |
# or the keyword "none" can be used to turn off the default |
| 229 |
# |
| 230 |
RANON_PRESERVE_ICMPMAPPED_TTL=yes |
| 231 |
RANON_PRESERVE_IP_TTL=fixed:random |
| 232 |
|
| 233 |
|
| 234 |
# Ranonymize anonymizes the IP TOS value in IPv4 records, by adding |
| 235 |
# a constant value to the existing src and dst ttl and wrapping where |
| 236 |
# appropriate. While there are significant DSByte and TOS encodings |
| 237 |
# the value to treatment is functionally arbitrary, allowing for |
| 238 |
# random or fixed offset preservation to provide some semantics. |
| 239 |
# |
| 240 |
# The constant value can be generated by ranonymize as "fixed:random", |
| 241 |
# or the user can provid a "fixed:x", where x is the fixed offset, |
| 242 |
# or the keyword "none" can be used to turn off the default |
| 243 |
# |
| 244 |
RANON_PRESERVE_IP_TOS=fixed:random |
| 245 |
|
| 246 |
|
| 247 |
# Ranonymize anonymizes the IP Options value in IPv4 records, by |
| 248 |
# a constant value to the existing src and dst ttl and wrapping where |
| 249 |
# appropriate. While there are significant DSByte and TOS encodings |
| 250 |
# the value to treatment is functionally arbitrary, allowing for |
| 251 |
# random or fixed offset preservation to provide some semantics. |
| 252 |
# |
| 253 |
# The constant value can be generated by ranonymize as "fixed:random", |
| 254 |
# or the user can provid a "fixed:x", where x is the fixed offset, |
| 255 |
# or the keyword "none" can be used to turn off the default |
| 256 |
# |
| 257 |
RANON_PRESERVE_IP_TOS=fixed:random |
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
# Ranonymize can be configured to preserve specific ranges |
| 262 |
# of port numbers. For convenience, ranonymize() can be |
| 263 |
# configured to preserve the IANA well known port allocation |
| 264 |
# range (0-1023), the registered ports (1024-49151) and/or |
| 265 |
# the private port range (49152 - 65535). Also, ranonymize() |
| 266 |
# can be configured to preserve specific port numbers. These |
| 267 |
# numbers are independent of protocol type, so if port 23461 |
| 268 |
# is to be preserved, it will be for both tcp and udp based |
| 269 |
# flows. |
| 270 |
# |
| 271 |
RANON_PRESERVE_WELLKNOWN_PORT_NUMS=yes |
| 272 |
RANON_PRESERVE_REGISTERED_PORT_NUMS=no |
| 273 |
RANON_PRESERVE_PRIVATE_PORT_NUMS=no |
| 274 |
|
| 275 |
|
| 276 |
# Ranonymize can be configured to use several methods for |
| 277 |
# anonymizing port values. "random", "fixed:random", "fixed:x" |
| 278 |
# and "no" anonymization. Random ensures that every port value |
| 279 |
# is allocated from a random pool, where the offset: methods |
| 280 |
# shift the port number by either a "random" amount, changing |
| 281 |
# on each invocation, or with a fixed offset of 'x', specified by the user. |
| 282 |
|
| 283 |
RANON_PORT_METHOD="offset:random" |
| 284 |
|
| 285 |
|
| 286 |
# There are a number of fields that are not subject to anonymization, |
| 287 |
# such as protocol types. These values, if not needed, can be zeroed |
| 288 |
# out, but upper protocol information, such as TCP base sequence numbers, |
| 289 |
# window performance etc.... need to be removed as needed. |
| 290 |
|
| 291 |
# By default, ranonymize() removes or zeroizes all other fields, in |
| 292 |
# the record, including TTL, TOS. Whole DSR's that are not anonymizable, |
| 293 |
# such as jitter values, user data contents, etc... are removed from the |
| 294 |
# record at anonymization time. |
| 295 |
|
| 296 |
|