Version: 6.4

User-Defined Metadata

The IP address enrichment module provides supplemental information for IP addresses, such as hostname and additional user-defined metadata. Values are cached for improved performance and flow record throughput. For more control of when enrichment is applied, IP addresses can be included or excluded from various enrichers by CIDR, IP range or individual IP address.

This page provide detailed information about User-Defined Metadata Enrichment and Scoping Enrichment with Include/Exclude.

User-Defined Metadata Enrichment

An example of the format of this file is:

# Additional options are name, vlan, tags and metadata.
192.0.2.192/26:
  name: atlanta_guest_wifi
  tags:
    - wifi
    - dhcp
  metadata:
    dhcp.pool.name: atlanta_guest_wifi
    .site.id: atlanta

# Metadata fields beginning with a . will be organized under the object containing the IP address.
192.0.2.194-192.0.2.198:
  metadata:
    .site.bldg.id: hq
    .site.floor.id: 2
    .site.rack.id: 1

# An individual IP address.
192.0.2.194:
  metadata:
    device.type.name: wifi_ap

Metadata Types

The User-Defined Metadata enricher supports a combination of pre-defined metadata types as well as the ability to provide custom data as key-value pairs. This section describes the various metadata types. The following table provides a summary of these types.

Attribute	Data Type	Field Populated	Description
`name`	string	`<object>.ip.subnet.name`	The name given to this subnet.
`tags`	array of strings	`<object>.ip.subnet.tags`	Tags that describe attributes of the subnet or IP.
`metadata`	sequence of attributes	`<object><attribute>` or `<attribute>`	Key-value pairs which will be added at the IP object or record levels.

name

name is a string attribute to provide a user-friendly name to a subnet which is relevant to the user or organization.

danger

Only a single name value is returned for a given IP address. Care should be taken to ensure that there are no conflicting names among overlapping CIDRs, Ranges and IP addresses. If you must assign multiple values, these should be add to the tags attribute.

metadata

metadata is a list of key-value pairs which will be added as fields to the record. These can either be custom fields specific to the needs of the user, or existing fields from the ElastiFlow CODEX schema. When CODEX fields are specified, the configured metadata value will override any values that already exist in the record.

info

If you have enabled ECS (Elasticsearch/OpenSearch) or CIM (Splunk) support and want to override values from these schemas, you must specify the CODEX equivalent fields in the metadata attribute. Metadata is applied in the decoder portion of the collector, where all data is still in the CODEX schema. Conversion to other schemas is output-specific and thus occurs at a later phase of processing.

Key names can be specified with or without a leading ..

If specified with a leading ., the field will be placed within the parent object containing the IP address.
If specified without a leading ., the field will be placed at the root of the record.

Consider an IP address from system.ip.addr:

If the metadata key is defined as .site.name, the value would be assigned to system.site.name.
If the metadata key is defined as site.name, the value would be assigned directly to site.name.

Merging Values from Multiple Definitions

Attribute values for an IP address which matches multiple CIDR, Range or IP address entries will be merged into a single result set. Consider the following example:

192.168.0.0/16:
  metadata:
    .geo.loc.coord: 48.167106,11.486918
    .geo.city.name: Munich
    .geo.country.code: DE
    .geo.country.name: Germany
    .geo.tz.name: Europe/Berlin

192.168.1.0/24:
  name: munich_hq
  tags:
    - campus
  metadata:
    sec.zone.name: campus

192.168.1.151-192.168.1.200:
  tags:
    - guest_wifi
    - dhcp
  metadata:
    .host.name: guest_wifi
    .ip.addr: 192.168.1.0

Here you have:

the whole Class C private network 192.168.0.0/16 with some location metadata.
a /24 block of that network that is tagged as the campus network, and also the firewall zone to which it belongs.
a range of those IP address that belong to the guest WiFi and are provided by DHCP.

Given a value for system.ip.addr of 192.168.1.152, which matches all three entries in the above configuration, the resulting enrichment fields added to the record would be:

system.ip.subnet.name: munich_hq
system.ip.subnet.tags: [campus guest_wifi dhcp]
system.geo.loc.coord: 48.167106,11.486918
system.geo.city.name: Munich
system.geo.country.code: DE
system.geo.country.name: Germany
system.geo.tz.name: Europe/Berlin
sec.zone.name: campus
system.host.name: guest_wifi
system.ip.addr: 192.168.1.0

note

The last two values above demonstrate one of the use-cases for User-Defined Metadata. The host.name and ip.addr have been overridden to more generic static values, thus anonymizing the individual guest WiFi users. This allows the traffic to still be collected and analyzed, without tracking each guest individually. Network or security operations can investigate suspect traffic which they may want to block, while preserving individual guests' privacy.

Scoping Enrichment with Include/Exclude

The Hostname/DNS enrichment can be scoped to a subset of IP addresses by specifying specific Autonomous Systems or CIDRs to be included or excluded. These include/exclude definitions are provided via a YAML file which can be updated and refreshed without the need to restart the collector.

An Example of include/exclude definitions:

include:
  asn:
    - 14168
  cidr:
    - 10.0.0.0/8
    - 192.168.0.0/16
exclude:
  #asn:
  #  -
  cidr:
    - 192.168.100.0/24

Evaluation of Include/Exclude Definitions

It is important to understand how include/exclude definitions are evaluated to ensure your configuration provides the desired outcome. The following rules apply:

If no specific include values are defined, everything is included.
Exclude values are evaluated within the scope of included values.

Consider the following examples:

note

While the following examples use only CIDRs, the same logic applies when ASN values are specified.

no include/exclude definitions

# no path provided or an empty file

If no include/excludes are defined, everything is included.

IP Address	Included?
192.168.0.1	✓
10.0.0.1	✓
10.111.0.1	✓

only include is defined

include:
  cidr:
    - 10.0.0.0/8

Only those IP addresses within a defined AS or CIDR are included. In this example, only IPs within the CIDR 10.0.0.0/8 are included.

IP Address	Included?
192.168.0.1	✕
10.0.0.1	✓
10.111.0.1	✓

only exclude is defined

exclude:
  cidr:
    - 10.111.0.0/16

All IP address which are not specifically excluded by the defined AS or CIDR are included. In this example, all IPs except those within the CIDR 10.111.0.0/16 are included.

IP Address	Included?
192.168.0.1	✓
10.0.0.1	✓
10.111.0.1	✕

both include and exclude are defined

include:
  cidr:
    - 10.0.0.0/8
exclude:
  cidr:
    - 10.111.0.0/16

Only those IP addresses within a specified AS or CIDR are included, EXCEPT those within an excluded AS or CIDR.

IP Address	Included?
192.168.0.1	✕
10.0.0.1	✓
10.111.0.1	✕

192.168.0.1 is not included as it is not within an included AS or CIDR.
10.0.0.1 is included as it is within an included AS or CIDR.
10.111.0.1 is not included. While is does fall within the range of an included CIDR, it is also with a CIDR than is specifically excluded.

User-Defined Metadata Enrichment​

Metadata Types​

name​

tags​

metadata​

Merging Values from Multiple Definitions​

Scoping Enrichment with Include/Exclude​

Evaluation of Include/Exclude Definitions​

no include/exclude definitions​

only include is defined​

only exclude is defined​

both include and exclude are defined​