Module client 

A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term “originator” to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events. Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.

Constants

CLIENT_ADDRESS

Some event client 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.

CLIENT_AS_NUMBER

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

CLIENT_AS_ORGANIZATION_NAME

Organization name.

CLIENT_BYTES

Bytes sent from the client to the server.

CLIENT_DOMAIN

The domain name of the client 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.

CLIENT_GEO_CITY_NAME

City name.

CLIENT_GEO_CONTINENT_CODE

Two-letter code representing continent’s name.

CLIENT_GEO_CONTINENT_NAME

Name of the continent.

CLIENT_GEO_COUNTRY_ISO_CODE

Country ISO code.

CLIENT_GEO_COUNTRY_NAME

Country name.

CLIENT_GEO_LOCATION

Longitude and latitude.

CLIENT_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.

CLIENT_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.

CLIENT_GEO_REGION_ISO_CODE

Region ISO code.

CLIENT_GEO_REGION_NAME

Region name.

CLIENT_GEO_TIMEZONE

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

CLIENT_IP

IP address of the client (IPv4 or IPv6).

CLIENT_MAC

MAC address of the client. 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.

CLIENT_NAT_IP

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

CLIENT_NAT_PORT

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

CLIENT_PACKETS

Packets sent from the client to the server.

CLIENT_PORT

Port of the client.

CLIENT_REGISTERED_DOMAIN

The highest registered client 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”.

CLIENT_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.

CLIENT_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”.

CLIENT_USER_DOMAIN

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

CLIENT_USER_EMAIL

User email address.

CLIENT_USER_FULL_NAME

User’s full name, if available.

CLIENT_USER_GROUP_DOMAIN

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

CLIENT_USER_GROUP_ID

Unique identifier for the group on the system/platform.

CLIENT_USER_GROUP_NAME

Name of the group.

CLIENT_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.

CLIENT_USER_ID

Unique identifier of the user.

CLIENT_USER_NAME

Short name or login of the user.

CLIENT_USER_ROLES

Array of user roles at the time of the event.