Module source 

Source fields capture details about the sender of a network exchange/packet. These fields are populated from a network event, packet, or other event containing details of a network transaction. Source fields are usually populated in conjunction with destination fields. The source and destination fields are considered the baseline and should always be filled if an event contains source and destination details from a network transaction. If the event also contains identification of the client and server roles, then the client and server fields should also be populated.

Constants

SOURCE_ADDRESS

Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain, depending on which one it is.

SOURCE_AS_NUMBER

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

SOURCE_AS_ORGANIZATION_NAME

Organization name.

SOURCE_BYTES

Bytes sent from the source to the destination.

SOURCE_DOMAIN

The domain name of the source system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment.

SOURCE_GEO_CITY_NAME

City name.

SOURCE_GEO_CONTINENT_CODE

Two-letter code representing continent’s name.

SOURCE_GEO_CONTINENT_NAME

Name of the continent.

SOURCE_GEO_COUNTRY_ISO_CODE

Country ISO code.

SOURCE_GEO_COUNTRY_NAME

Country name.

SOURCE_GEO_LOCATION

Longitude and latitude.

SOURCE_GEO_NAME

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

SOURCE_GEO_POSTAL_CODE

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

SOURCE_GEO_REGION_ISO_CODE

Region ISO code.

SOURCE_GEO_REGION_NAME

Region name.

SOURCE_GEO_TIMEZONE

The time zone of the location, such as IANA time zone name.

SOURCE_IP

IP address of the source (IPv4 or IPv6).

SOURCE_MAC

MAC address of the source. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

SOURCE_NAT_IP

Translated ip of source based NAT sessions (e.g. internal client to internet) Typically connections traversing load balancers, firewalls, or routers.

SOURCE_NAT_PORT

Translated port of source based NAT sessions. (e.g. internal client to internet) Typically used with load balancers, firewalls, or routers.

SOURCE_PACKETS

Packets sent from the source to the destination.

SOURCE_PORT

Port of the source.

SOURCE_REGISTERED_DOMAIN

The highest registered source domain, stripped of the subdomain. For example, the registered domain for “foo.example.com” is “example.com”. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as “co.uk”.

SOURCE_SUBDOMAIN

The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of “www.east.mydomain.co.uk” is “east”. If the domain has multiple levels of subdomain, such as “sub2.sub1.example.com”, the subdomain field should contain “sub2.sub1”, with no trailing period.

SOURCE_TOP_LEVEL_DOMAIN

The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is “com”. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as “co.uk”.

SOURCE_USER_DOMAIN

Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name.

SOURCE_USER_EMAIL

User email address.

SOURCE_USER_FULL_NAME

User’s full name, if available.

SOURCE_USER_GROUP_DOMAIN

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

SOURCE_USER_GROUP_ID

Unique identifier for the group on the system/platform.

SOURCE_USER_GROUP_NAME

Name of the group.

SOURCE_USER_HASH

Unique user hash to correlate information for a user in anonymized form. Useful if user.id or user.name contain confidential information and cannot be used.

SOURCE_USER_ID

Unique identifier of the user.

SOURCE_USER_NAME

Short name or login of the user.

SOURCE_USER_ROLES

Array of user roles at the time of the event.