[[ecs-base]]
=== Base Fields

The `base` field set contains all fields which are at the root of the events. These fields are common across all types of events.

[discrete]
==== Base Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-timestamp]]
<<field-timestamp, @timestamp>>

a| Date/time when the event originated.

This is the date/time extracted from the event, typically representing when the event was generated by the source.

If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline.

Required field for all events.

type: date



example: `2016-05-23T08:05:34.853Z`

| core

// ===============================================================

|
[[field-labels]]
<<field-labels, labels>>

a| Custom key/value pairs.

Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword.

Example: `docker` and `k8s` labels.

type: object



example: `{"application": "foo-bar", "env": "production"}`

| core

// ===============================================================

|
[[field-message]]
<<field-message, message>>

a| For log events the message field contains the log message, optimized for viewing in a log viewer.

For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event.

If multiple messages exist, they can be combined into one message.

type: match_only_text



example: `Hello World`

| core

// ===============================================================

|
[[field-tags]]
<<field-tags, tags>>

a| List of keywords used to tag each event.

type: keyword


Note: this field should contain an array of values.



example: `["production", "env2"]`

| core

// ===============================================================

|=====


[[ecs-agent]]
=== Agent Fields

The agent fields contain the data about the software entity, if any, that collects, detects, or observes events on a host, or takes measurements on a host.

Examples include Beats. Agents may also run on observers. ECS agent.* fields shall be populated with details of the agent running on the host or observer where the event happened or the measurement was taken.

[discrete]
==== Agent Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-agent-build-original]]
<<field-agent-build-original, agent.build.original>>

a| Extended build information for the agent.

This field is intended to contain any build information that a data source may provide, no specific formatting is required.

type: keyword



example: `metricbeat version 7.6.0 (amd64), libbeat 7.6.0 [6a23e8f8f30f5001ba344e4e54d8d9cb82cb107c built 2020-02-05 23:10:10 +0000 UTC]`

| core

// ===============================================================

|
[[field-agent-ephemeral-id]]
<<field-agent-ephemeral-id, agent.ephemeral_id>>

a| Ephemeral identifier of this agent (if one exists).

This id normally changes across restarts, but `agent.id` does not.

type: keyword



example: `8a4f500f`

| extended

// ===============================================================

|
[[field-agent-id]]
<<field-agent-id, agent.id>>

a| Unique identifier of this agent (if one exists).

Example: For Beats this would be beat.id.

type: keyword



example: `8a4f500d`

| core

// ===============================================================

|
[[field-agent-name]]
<<field-agent-name, agent.name>>

a| Custom name of the agent.

This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from.

type: keyword



example: `foo`

| core

// ===============================================================

|
[[field-agent-type]]
<<field-agent-type, agent.type>>

a| Type of the agent.

The agent type always stays the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine.

type: keyword



example: `filebeat`

| core

// ===============================================================

|
[[field-agent-version]]
<<field-agent-version, agent.version>>

a| Version of the agent.

type: keyword



example: `6.0.0-rc2`

| core

// ===============================================================

|=====


[[ecs-as]]
=== Autonomous System Fields

An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.

[discrete]
==== Autonomous System Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-as-number]]
<<field-as-number, as.number>>

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

type: long



example: `15169`

| extended

// ===============================================================

|
[[field-as-organization-name]]
<<field-as-organization-name, as.organization.name>>

a| Organization name.

type: keyword

Multi-fields:

* as.organization.name.text (type: match_only_text)





example: `Google LLC`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `as` fields are expected to be nested at:


* `client.as`

* `destination.as`

* `server.as`

* `source.as`

* `threat.enrichments.indicator.as`

* `threat.indicator.as`


Note also that the `as` fields are not expected to be used directly at the root of the events.
[[ecs-client]]
=== Client Fields

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.

[discrete]
==== Client Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-client-address]]
<<field-client-address, client.address>>

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

type: keyword





| extended

// ===============================================================

|
[[field-client-bytes]]
<<field-client-bytes, client.bytes>>

a| Bytes sent from the client to the server.

type: long



example: `184`

| core

// ===============================================================

|
[[field-client-domain]]
<<field-client-domain, client.domain>>

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

type: keyword



example: `foo.example.com`

| core

// ===============================================================

|
[[field-client-ip]]
<<field-client-ip, client.ip>>

a| IP address of the client (IPv4 or IPv6).

type: ip





| core

// ===============================================================

|
[[field-client-mac]]
<<field-client-mac, client.mac>>

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

type: keyword



example: `00-00-5E-00-53-23`

| core

// ===============================================================

|
[[field-client-nat-ip]]
<<field-client-nat-ip, client.nat.ip>>

a| Translated IP of source based NAT sessions (e.g. internal client to internet).

Typically connections traversing load balancers, firewalls, or routers.

type: ip





| extended

// ===============================================================

|
[[field-client-nat-port]]
<<field-client-nat-port, client.nat.port>>

a| Translated port of source based NAT sessions (e.g. internal client to internet).

Typically connections traversing load balancers, firewalls, or routers.

type: long





| extended

// ===============================================================

|
[[field-client-packets]]
<<field-client-packets, client.packets>>

a| Packets sent from the client to the server.

type: long



example: `12`

| core

// ===============================================================

|
[[field-client-port]]
<<field-client-port, client.port>>

a| Port of the client.

type: long





| core

// ===============================================================

|
[[field-client-registered-domain]]
<<field-client-registered-domain, client.registered_domain>>

a| 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".

type: keyword



example: `example.com`

| extended

// ===============================================================

|
[[field-client-subdomain]]
<<field-client-subdomain, client.subdomain>>

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

type: keyword



example: `east`

| extended

// ===============================================================

|
[[field-client-top-level-domain]]
<<field-client-top-level-domain, client.top_level_domain>>

a| 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".

type: keyword



example: `co.uk`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-client-nestings]]
[discrete]
===== Field sets that can be nested under Client

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `client.as.*`
| <<ecs-as,as>>
| Fields describing an Autonomous System (Internet routing prefix).

// ===============================================================


| `client.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `client.user.*`
| <<ecs-user,user>>
| Fields to describe the user relevant to the event.

// ===============================================================


|=====


[[ecs-cloud]]
=== Cloud Fields

Fields related to the cloud or infrastructure the events are coming from.

[discrete]
==== Cloud Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-cloud-account-id]]
<<field-cloud-account-id, cloud.account.id>>

a| The cloud account or organization id used to identify different entities in a multi-tenant environment.

Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.

type: keyword



example: `666777888999`

| extended

// ===============================================================

|
[[field-cloud-account-name]]
<<field-cloud-account-name, cloud.account.name>>

a| The cloud account name or alias used to identify different entities in a multi-tenant environment.

Examples: AWS account name, Google Cloud ORG display name.

type: keyword



example: `elastic-dev`

| extended

// ===============================================================

|
[[field-cloud-availability-zone]]
<<field-cloud-availability-zone, cloud.availability_zone>>

a| Availability zone in which this host, resource, or service is located.

type: keyword



example: `us-east-1c`

| extended

// ===============================================================

|
[[field-cloud-instance-id]]
<<field-cloud-instance-id, cloud.instance.id>>

a| Instance ID of the host machine.

type: keyword



example: `i-1234567890abcdef0`

| extended

// ===============================================================

|
[[field-cloud-instance-name]]
<<field-cloud-instance-name, cloud.instance.name>>

a| Instance name of the host machine.

type: keyword





| extended

// ===============================================================

|
[[field-cloud-machine-type]]
<<field-cloud-machine-type, cloud.machine.type>>

a| Machine type of the host machine.

type: keyword



example: `t2.medium`

| extended

// ===============================================================

|
[[field-cloud-project-id]]
<<field-cloud-project-id, cloud.project.id>>

a| The cloud project identifier.

Examples: Google Cloud Project id, Azure Project id.

type: keyword



example: `my-project`

| extended

// ===============================================================

|
[[field-cloud-project-name]]
<<field-cloud-project-name, cloud.project.name>>

a| The cloud project name.

Examples: Google Cloud Project name, Azure Project name.

type: keyword



example: `my project`

| extended

// ===============================================================

|
[[field-cloud-provider]]
<<field-cloud-provider, cloud.provider>>

a| Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.

type: keyword



example: `aws`

| extended

// ===============================================================

|
[[field-cloud-region]]
<<field-cloud-region, cloud.region>>

a| Region in which this host, resource, or service is located.

type: keyword



example: `us-east-1`

| extended

// ===============================================================

|
[[field-cloud-service-name]]
<<field-cloud-service-name, cloud.service.name>>

a| The cloud service name is intended to distinguish services running on different platforms within a provider, eg AWS EC2 vs Lambda, GCP GCE vs App Engine, Azure VM vs App Server.

Examples: app engine, app service, cloud run, fargate, lambda.

type: keyword



example: `lambda`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `cloud` fields are expected to be nested at:


* `cloud.origin`

* `cloud.target`


Note also that the `cloud` fields may be used directly at the root of the events.

[[ecs-cloud-nestings]]
[discrete]
===== Field sets that can be nested under Cloud

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `cloud.origin.*`
| <<ecs-cloud,cloud>>| beta:[ Reusing the `cloud` fields in this location is currently considered beta.]

Provides the cloud information of the origin entity in case of an incoming request or event.

// ===============================================================


| `cloud.target.*`
| <<ecs-cloud,cloud>>| beta:[ Reusing the `cloud` fields in this location is currently considered beta.]

Provides the cloud information of the target entity in case of an outgoing request or event.

// ===============================================================


|=====



[discrete]
==== Cloud Field Usage

For usage and examples of the cloud fields, please see the <<ecs-cloud-usage, Cloud Fields Usage and Examples>> section.

include::usage/cloud.asciidoc[]


[[ecs-code_signature]]
=== Code Signature Fields

These fields contain information about binary code signatures.

[discrete]
==== Code Signature Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-code-signature-digest-algorithm]]
<<field-code-signature-digest-algorithm, code_signature.digest_algorithm>>

a| The hashing algorithm used to sign the process.

This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm.

type: keyword



example: `sha256`

| extended

// ===============================================================

|
[[field-code-signature-exists]]
<<field-code-signature-exists, code_signature.exists>>

a| Boolean to capture if a signature is present.

type: boolean



example: `true`

| core

// ===============================================================

|
[[field-code-signature-signing-id]]
<<field-code-signature-signing-id, code_signature.signing_id>>

a| The identifier used to sign the process.

This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword



example: `com.apple.xpc.proxy`

| extended

// ===============================================================

|
[[field-code-signature-status]]
<<field-code-signature-status, code_signature.status>>

a| Additional information about the certificate status.

This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked.

type: keyword



example: `ERROR_UNTRUSTED_ROOT`

| extended

// ===============================================================

|
[[field-code-signature-subject-name]]
<<field-code-signature-subject-name, code_signature.subject_name>>

a| Subject name of the code signer

type: keyword



example: `Microsoft Corporation`

| core

// ===============================================================

|
[[field-code-signature-team-id]]
<<field-code-signature-team-id, code_signature.team_id>>

a| The team identifier used to sign the process.

This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword



example: `EQHXZ8M8AV`

| extended

// ===============================================================

|
[[field-code-signature-timestamp]]
<<field-code-signature-timestamp, code_signature.timestamp>>

a| Date and time when the code signature was generated and signed.

type: date



example: `2021-01-01T12:10:30Z`

| extended

// ===============================================================

|
[[field-code-signature-trusted]]
<<field-code-signature-trusted, code_signature.trusted>>

a| Stores the trust status of the certificate chain.

Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status.

type: boolean



example: `true`

| extended

// ===============================================================

|
[[field-code-signature-valid]]
<<field-code-signature-valid, code_signature.valid>>

a| Boolean to capture if the digital signature is verified against the binary content.

Leave unpopulated if a certificate was unchecked.

type: boolean



example: `true`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `code_signature` fields are expected to be nested at:


* `dll.code_signature`

* `file.code_signature`

* `process.code_signature`


Note also that the `code_signature` fields are not expected to be used directly at the root of the events.
[[ecs-container]]
=== Container Fields

Container fields are used for meta information about the specific container that is the source of information.

These fields help correlate data based containers from any runtime.

[discrete]
==== Container Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-container-cpu-usage]]
<<field-container-cpu-usage, container.cpu.usage>>

a| Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. Scaling factor: 1000.

type: scaled_float





| extended

// ===============================================================

|
[[field-container-disk-read-bytes]]
<<field-container-disk-read-bytes, container.disk.read.bytes>>

a| The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-container-disk-write-bytes]]
<<field-container-disk-write-bytes, container.disk.write.bytes>>

a| The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-container-id]]
<<field-container-id, container.id>>

a| Unique container id.

type: keyword





| core

// ===============================================================

|
[[field-container-image-hash-all]]
<<field-container-image-hash-all, container.image.hash.all>>

a| An array of digests of the image the container was built on. Each digest consists of the hash algorithm and value in this format: `algorithm:value`. Algorithm names should align with the field names in the ECS hash field set.

type: keyword


Note: this field should contain an array of values.



example: `[sha256:f8fefc80e3273dc756f288a63945820d6476ad64883892c771b5e2ece6bf1b26]`

| extended

// ===============================================================

|
[[field-container-image-name]]
<<field-container-image-name, container.image.name>>

a| Name of the image the container was built on.

type: keyword





| extended

// ===============================================================

|
[[field-container-image-tag]]
<<field-container-image-tag, container.image.tag>>

a| Container image tags.

type: keyword


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-container-labels]]
<<field-container-labels, container.labels>>

a| Image labels.

type: object





| extended

// ===============================================================

|
[[field-container-memory-usage]]
<<field-container-memory-usage, container.memory.usage>>

a| Memory usage percentage and it ranges from 0 to 1. Scaling factor: 1000.

type: scaled_float





| extended

// ===============================================================

|
[[field-container-name]]
<<field-container-name, container.name>>

a| Container name.

type: keyword





| extended

// ===============================================================

|
[[field-container-network-egress-bytes]]
<<field-container-network-egress-bytes, container.network.egress.bytes>>

a| The number of bytes (gauge) sent out on all network interfaces by the container since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-container-network-ingress-bytes]]
<<field-container-network-ingress-bytes, container.network.ingress.bytes>>

a| The number of bytes received (gauge) on all network interfaces by the container since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-container-runtime]]
<<field-container-runtime, container.runtime>>

a| Runtime managing this container.

type: keyword



example: `docker`

| extended

// ===============================================================

|=====


[[ecs-data_stream]]
=== Data Stream Fields

The data_stream fields take part in defining the new data stream naming scheme.

In the new data stream naming scheme the value of the data stream fields combine to the name of the actual data stream in the following manner: `{data_stream.type}-{data_stream.dataset}-{data_stream.namespace}`. This means the fields can only contain characters that are valid as part of names of data streams. More details about this can be found in this https://www.elastic.co/blog/an-introduction-to-the-elastic-data-stream-naming-scheme[blog post].

An Elasticsearch data stream consists of one or more backing indices, and a data stream name forms part of the backing indices names. Due to this convention, data streams must also follow index naming restrictions. For example, data stream names cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#`. Please see the Elasticsearch reference for additional https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html#indices-create-api-path-params[restrictions].

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== Data Stream Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-data-stream-dataset]]
<<field-data-stream-dataset, data_stream.dataset>>

a| The field can contain anything that makes sense to signify the source of the data.

Examples include `nginx.access`, `prometheus`, `endpoint` etc. For data streams that otherwise fit, but that do not have dataset set we use the value "generic" for the dataset value. `event.dataset` should have the same value as `data_stream.dataset`.

Beyond the Elasticsearch data stream naming criteria noted above, the `dataset` value has additional restrictions:

  * Must not contain `-`

  * No longer than 100 characters

type: constant_keyword



example: `nginx.access`

| extended

// ===============================================================

|
[[field-data-stream-namespace]]
<<field-data-stream-namespace, data_stream.namespace>>

a| A user defined namespace. Namespaces are useful to allow grouping of data.

Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with `default`. If no value is used, it falls back to `default`.

Beyond the Elasticsearch index naming criteria noted above, `namespace` value has the additional restrictions:

  * Must not contain `-`

  * No longer than 100 characters

type: constant_keyword



example: `production`

| extended

// ===============================================================

|
[[field-data-stream-type]]
<<field-data-stream-type, data_stream.type>>

a| An overarching type for the data stream.

Currently allowed values are "logs" and "metrics". We expect to also add "traces" and "synthetics" in the near future.

type: constant_keyword



example: `logs`

| extended

// ===============================================================

|=====


[[ecs-destination]]
=== Destination Fields

Destination fields capture details about the receiver of a network exchange/packet. These fields are populated from a network event, packet, or other event containing details of a network transaction.

Destination fields are usually populated in conjunction with source 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.

[discrete]
==== Destination Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-destination-address]]
<<field-destination-address, destination.address>>

a| Some event destination 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.

type: keyword





| extended

// ===============================================================

|
[[field-destination-bytes]]
<<field-destination-bytes, destination.bytes>>

a| Bytes sent from the destination to the source.

type: long



example: `184`

| core

// ===============================================================

|
[[field-destination-domain]]
<<field-destination-domain, destination.domain>>

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

type: keyword



example: `foo.example.com`

| core

// ===============================================================

|
[[field-destination-ip]]
<<field-destination-ip, destination.ip>>

a| IP address of the destination (IPv4 or IPv6).

type: ip





| core

// ===============================================================

|
[[field-destination-mac]]
<<field-destination-mac, destination.mac>>

a| MAC address of the destination.

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.

type: keyword



example: `00-00-5E-00-53-23`

| core

// ===============================================================

|
[[field-destination-nat-ip]]
<<field-destination-nat-ip, destination.nat.ip>>

a| Translated ip of destination based NAT sessions (e.g. internet to private DMZ)

Typically used with load balancers, firewalls, or routers.

type: ip





| extended

// ===============================================================

|
[[field-destination-nat-port]]
<<field-destination-nat-port, destination.nat.port>>

a| Port the source session is translated to by NAT Device.

Typically used with load balancers, firewalls, or routers.

type: long





| extended

// ===============================================================

|
[[field-destination-packets]]
<<field-destination-packets, destination.packets>>

a| Packets sent from the destination to the source.

type: long



example: `12`

| core

// ===============================================================

|
[[field-destination-port]]
<<field-destination-port, destination.port>>

a| Port of the destination.

type: long





| core

// ===============================================================

|
[[field-destination-registered-domain]]
<<field-destination-registered-domain, destination.registered_domain>>

a| The highest registered destination 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".

type: keyword



example: `example.com`

| extended

// ===============================================================

|
[[field-destination-subdomain]]
<<field-destination-subdomain, destination.subdomain>>

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

type: keyword



example: `east`

| extended

// ===============================================================

|
[[field-destination-top-level-domain]]
<<field-destination-top-level-domain, destination.top_level_domain>>

a| 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".

type: keyword



example: `co.uk`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-destination-nestings]]
[discrete]
===== Field sets that can be nested under Destination

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `destination.as.*`
| <<ecs-as,as>>
| Fields describing an Autonomous System (Internet routing prefix).

// ===============================================================


| `destination.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `destination.user.*`
| <<ecs-user,user>>
| Fields to describe the user relevant to the event.

// ===============================================================


|=====


[[ecs-device]]
=== Device Fields

Fields that describe a device instance and its characteristics.  Data collected for applications and processes running on a (mobile) device can be enriched with these fields to describe the identity, type and other characteristics of the device.

This field group definition is based on the Device namespace of the OpenTelemetry Semantic Conventions (https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/device/).

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== Device Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-device-id]]
<<field-device-id, device.id>>

a| The unique identifier of a device. The identifier must not change across application sessions but stay fixex for an instance of a (mobile) device. 

On iOS, this value must be equal to the vendor identifier (https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android, this value must be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application.

For GDPR and data protection law reasons this identifier should not carry information that would allow to identify a user.

type: keyword



example: `00000000-54b3-e7c7-0000-000046bffd97`

| extended

// ===============================================================

|
[[field-device-manufacturer]]
<<field-device-manufacturer, device.manufacturer>>

a| The vendor name of the device manufacturer.

type: keyword



example: `Samsung`

| extended

// ===============================================================

|
[[field-device-model-identifier]]
<<field-device-model-identifier, device.model.identifier>>

a| The machine readable identifier of the device model.

type: keyword



example: `SM-G920F`

| extended

// ===============================================================

|
[[field-device-model-name]]
<<field-device-model-name, device.model.name>>

a| The human readable marketing name of the device model.

type: keyword



example: `Samsung Galaxy S6`

| extended

// ===============================================================

|=====


[[ecs-dll]]
=== DLL Fields

These fields contain information about code libraries dynamically loaded into processes.



Many operating systems refer to "shared code libraries" with different names, but this field set refers to all of the following:

* Dynamic-link library (`.dll`) commonly used on Windows

* Shared Object (`.so`) commonly used on Unix-like operating systems

* Dynamic library (`.dylib`) commonly used on macOS

[discrete]
==== DLL Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-dll-name]]
<<field-dll-name, dll.name>>

a| Name of the library.

This generally maps to the name of the file on disk.

type: keyword



example: `kernel32.dll`

| core

// ===============================================================

|
[[field-dll-path]]
<<field-dll-path, dll.path>>

a| Full file path of the library.

type: keyword



example: `C:\Windows\System32\kernel32.dll`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-dll-nestings]]
[discrete]
===== Field sets that can be nested under DLL

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `dll.code_signature.*`
| <<ecs-code_signature,code_signature>>
| These fields contain information about binary code signatures.

// ===============================================================


| `dll.hash.*`
| <<ecs-hash,hash>>
| Hashes, usually file hashes.

// ===============================================================


| `dll.pe.*`
| <<ecs-pe,pe>>
| These fields contain Windows Portable Executable (PE) metadata.

// ===============================================================


|=====


[[ecs-dns]]
=== DNS Fields

Fields describing DNS queries and answers.

DNS events should either represent a single DNS query prior to getting answers (`dns.type:query`) or they should represent a full exchange and contain the query details as well as all of the answers that were provided for this query (`dns.type:answer`).

[discrete]
==== DNS Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-dns-answers]]
<<field-dns-answers, dns.answers>>

a| An array containing an object for each answer section returned by the server.

The main keys that should be present in these objects are defined by ECS. Records that have more information may contain more keys than what ECS defines.

Not all DNS data sources give all details about DNS answers. At minimum, answer objects must contain the `data` key. If more information is available, map as much of it to ECS as possible, and add any additional fields to the answer objects as custom fields.

type: object


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-dns-answers-class]]
<<field-dns-answers-class, dns.answers.class>>

a| The class of DNS data contained in this resource record.

type: keyword



example: `IN`

| extended

// ===============================================================

|
[[field-dns-answers-data]]
<<field-dns-answers-data, dns.answers.data>>

a| The data describing the resource.

The meaning of this data depends on the type and class of the resource record.

type: keyword



example: `10.10.10.10`

| extended

// ===============================================================

|
[[field-dns-answers-name]]
<<field-dns-answers-name, dns.answers.name>>

a| The domain name to which this resource record pertains.

If a chain of CNAME is being resolved, each answer's `name` should be the one that corresponds with the answer's `data`. It should not simply be the original `question.name` repeated.

type: keyword



example: `www.example.com`

| extended

// ===============================================================

|
[[field-dns-answers-ttl]]
<<field-dns-answers-ttl, dns.answers.ttl>>

a| The time interval in seconds that this resource record may be cached before it should be discarded. Zero values mean that the data should not be cached.

type: long



example: `180`

| extended

// ===============================================================

|
[[field-dns-answers-type]]
<<field-dns-answers-type, dns.answers.type>>

a| The type of data contained in this resource record.

type: keyword



example: `CNAME`

| extended

// ===============================================================

|
[[field-dns-header-flags]]
<<field-dns-header-flags, dns.header_flags>>

a| Array of 2 letter DNS header flags.

Expected values for this field:

* `AA`
* `TC`
* `RD`
* `RA`
* `AD`
* `CD`
* `DO`

type: keyword


Note: this field should contain an array of values.



example: `["RD", "RA"]`

| extended

// ===============================================================

|
[[field-dns-id]]
<<field-dns-id, dns.id>>

a| The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response.

type: keyword



example: `62111`

| extended

// ===============================================================

|
[[field-dns-op-code]]
<<field-dns-op-code, dns.op_code>>

a| The DNS operation code that specifies the kind of query in the message. This value is set by the originator of a query and copied into the response.

type: keyword



example: `QUERY`

| extended

// ===============================================================

|
[[field-dns-question-class]]
<<field-dns-question-class, dns.question.class>>

a| The class of records being queried.

type: keyword



example: `IN`

| extended

// ===============================================================

|
[[field-dns-question-name]]
<<field-dns-question-name, dns.question.name>>

a| The name being queried.

If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively.

type: keyword



example: `www.example.com`

| extended

// ===============================================================

|
[[field-dns-question-registered-domain]]
<<field-dns-question-registered-domain, dns.question.registered_domain>>

a| The highest registered 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".

type: keyword



example: `example.com`

| extended

// ===============================================================

|
[[field-dns-question-subdomain]]
<<field-dns-question-subdomain, dns.question.subdomain>>

a| The subdomain is all of the labels under the registered_domain.

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.

type: keyword



example: `www`

| extended

// ===============================================================

|
[[field-dns-question-top-level-domain]]
<<field-dns-question-top-level-domain, dns.question.top_level_domain>>

a| 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".

type: keyword



example: `co.uk`

| extended

// ===============================================================

|
[[field-dns-question-type]]
<<field-dns-question-type, dns.question.type>>

a| The type of record being queried.

type: keyword



example: `AAAA`

| extended

// ===============================================================

|
[[field-dns-resolved-ip]]
<<field-dns-resolved-ip, dns.resolved_ip>>

a| Array containing all IPs seen in `answers.data`.

The `answers` array can be difficult to use, because of the variety of data formats it can contain. Extracting all IP addresses seen in there to `dns.resolved_ip` makes it possible to index them as IP addresses, and makes them easier to visualize and query for.

type: ip


Note: this field should contain an array of values.



example: `["10.10.10.10", "10.10.10.11"]`

| extended

// ===============================================================

|
[[field-dns-response-code]]
<<field-dns-response-code, dns.response_code>>

a| The DNS response code.

type: keyword



example: `NOERROR`

| extended

// ===============================================================

|
[[field-dns-type]]
<<field-dns-type, dns.type>>

a| The type of DNS event captured, query or answer.

If your source of DNS events only gives you DNS queries, you should only create dns events of type `dns.type:query`.

If your source of DNS events gives you answers as well, you should create one event per query (optionally as soon as the query is seen). And a second event containing all query details as well as an array of answers.

type: keyword



example: `answer`

| extended

// ===============================================================

|=====


[[ecs-ecs]]
=== ECS Fields

Meta-information specific to ECS.

[discrete]
==== ECS Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-ecs-version]]
<<field-ecs-version, ecs.version>>

a| ECS version this event conforms to. `ecs.version` is a required field and must exist in all events.

When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.

type: keyword



example: `1.0.0`

| core

// ===============================================================

|=====


[[ecs-elf]]
=== ELF Header Fields

These fields contain Linux Executable Linkable Format (ELF) metadata.

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== ELF Header Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-elf-architecture]]
<<field-elf-architecture, elf.architecture>>

a| Machine architecture of the ELF file.

type: keyword



example: `x86-64`

| extended

// ===============================================================

|
[[field-elf-byte-order]]
<<field-elf-byte-order, elf.byte_order>>

a| Byte sequence of ELF file.

type: keyword



example: `Little Endian`

| extended

// ===============================================================

|
[[field-elf-cpu-type]]
<<field-elf-cpu-type, elf.cpu_type>>

a| CPU type of the ELF file.

type: keyword



example: `Intel`

| extended

// ===============================================================

|
[[field-elf-creation-date]]
<<field-elf-creation-date, elf.creation_date>>

a| Extracted when possible from the file's metadata. Indicates when it was built or compiled. It can also be faked by malware creators.

type: date





| extended

// ===============================================================

|
[[field-elf-exports]]
<<field-elf-exports, elf.exports>>

a| List of exported element names and types.

type: flattened


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-elf-go-import-hash]]
<<field-elf-go-import-hash, elf.go_import_hash>>

a| A hash of the Go language imports in an ELF file excluding standard library imports. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

The algorithm used to calculate the Go symbol hash and a reference implementation are available [here](https://github.com/elastic/toutoumomoma).

type: keyword



example: `10bddcb4cee42080f76c88d9ff964491`

| extended

// ===============================================================

|
[[field-elf-go-imports]]
<<field-elf-go-imports, elf.go_imports>>

a| List of imported Go language element names and types.

type: flattened





| extended

// ===============================================================

|
[[field-elf-go-imports-names-entropy]]
<<field-elf-go-imports-names-entropy, elf.go_imports_names_entropy>>

a| Shannon entropy calculation from the list of Go imports.

type: long





| extended

// ===============================================================

|
[[field-elf-go-imports-names-var-entropy]]
<<field-elf-go-imports-names-var-entropy, elf.go_imports_names_var_entropy>>

a| Variance for Shannon entropy calculation from the list of Go imports.

type: long





| extended

// ===============================================================

|
[[field-elf-go-stripped]]
<<field-elf-go-stripped, elf.go_stripped>>

a| Set to true if the file is a Go executable that has had its symbols stripped or obfuscated and false if an unobfuscated Go executable.

type: boolean





| extended

// ===============================================================

|
[[field-elf-header-abi-version]]
<<field-elf-header-abi-version, elf.header.abi_version>>

a| Version of the ELF Application Binary Interface (ABI).

type: keyword





| extended

// ===============================================================

|
[[field-elf-header-class]]
<<field-elf-header-class, elf.header.class>>

a| Header class of the ELF file.

type: keyword





| extended

// ===============================================================

|
[[field-elf-header-data]]
<<field-elf-header-data, elf.header.data>>

a| Data table of the ELF header.

type: keyword





| extended

// ===============================================================

|
[[field-elf-header-entrypoint]]
<<field-elf-header-entrypoint, elf.header.entrypoint>>

a| Header entrypoint of the ELF file.

type: long





| extended

// ===============================================================

|
[[field-elf-header-object-version]]
<<field-elf-header-object-version, elf.header.object_version>>

a| "0x1" for original ELF files.

type: keyword





| extended

// ===============================================================

|
[[field-elf-header-os-abi]]
<<field-elf-header-os-abi, elf.header.os_abi>>

a| Application Binary Interface (ABI) of the Linux OS.

type: keyword





| extended

// ===============================================================

|
[[field-elf-header-type]]
<<field-elf-header-type, elf.header.type>>

a| Header type of the ELF file.

type: keyword





| extended

// ===============================================================

|
[[field-elf-header-version]]
<<field-elf-header-version, elf.header.version>>

a| Version of the ELF header.

type: keyword





| extended

// ===============================================================

|
[[field-elf-import-hash]]
<<field-elf-import-hash, elf.import_hash>>

a| A hash of the imports in an ELF file. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

This is an ELF implementation of the Windows PE imphash.

type: keyword



example: `d41d8cd98f00b204e9800998ecf8427e`

| extended

// ===============================================================

|
[[field-elf-imports]]
<<field-elf-imports, elf.imports>>

a| List of imported element names and types.

type: flattened


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-elf-imports-names-entropy]]
<<field-elf-imports-names-entropy, elf.imports_names_entropy>>

a| Shannon entropy calculation from the list of imported element names and types.

type: long





| extended

// ===============================================================

|
[[field-elf-imports-names-var-entropy]]
<<field-elf-imports-names-var-entropy, elf.imports_names_var_entropy>>

a| Variance for Shannon entropy calculation from the list of imported element names and types.

type: long





| extended

// ===============================================================

|
[[field-elf-sections]]
<<field-elf-sections, elf.sections>>

a| An array containing an object for each section of the ELF file.

The keys that should be present in these objects are defined by sub-fields underneath `elf.sections.*`.

type: nested


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-elf-sections-chi2]]
<<field-elf-sections-chi2, elf.sections.chi2>>

a| Chi-square probability distribution of the section.

type: long





| extended

// ===============================================================

|
[[field-elf-sections-entropy]]
<<field-elf-sections-entropy, elf.sections.entropy>>

a| Shannon entropy calculation from the section.

type: long





| extended

// ===============================================================

|
[[field-elf-sections-flags]]
<<field-elf-sections-flags, elf.sections.flags>>

a| ELF Section List flags.

type: keyword





| extended

// ===============================================================

|
[[field-elf-sections-name]]
<<field-elf-sections-name, elf.sections.name>>

a| ELF Section List name.

type: keyword





| extended

// ===============================================================

|
[[field-elf-sections-physical-offset]]
<<field-elf-sections-physical-offset, elf.sections.physical_offset>>

a| ELF Section List offset.

type: keyword





| extended

// ===============================================================

|
[[field-elf-sections-physical-size]]
<<field-elf-sections-physical-size, elf.sections.physical_size>>

a| ELF Section List physical size.

type: long





| extended

// ===============================================================

|
[[field-elf-sections-type]]
<<field-elf-sections-type, elf.sections.type>>

a| ELF Section List type.

type: keyword





| extended

// ===============================================================

|
[[field-elf-sections-var-entropy]]
<<field-elf-sections-var-entropy, elf.sections.var_entropy>>

a| Variance for Shannon entropy calculation from the section.

type: long





| extended

// ===============================================================

|
[[field-elf-sections-virtual-address]]
<<field-elf-sections-virtual-address, elf.sections.virtual_address>>

a| ELF Section List virtual address.

type: long





| extended

// ===============================================================

|
[[field-elf-sections-virtual-size]]
<<field-elf-sections-virtual-size, elf.sections.virtual_size>>

a| ELF Section List virtual size.

type: long





| extended

// ===============================================================

|
[[field-elf-segments]]
<<field-elf-segments, elf.segments>>

a| An array containing an object for each segment of the ELF file.

The keys that should be present in these objects are defined by sub-fields underneath `elf.segments.*`.

type: nested


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-elf-segments-sections]]
<<field-elf-segments-sections, elf.segments.sections>>

a| ELF object segment sections.

type: keyword





| extended

// ===============================================================

|
[[field-elf-segments-type]]
<<field-elf-segments-type, elf.segments.type>>

a| ELF object segment type.

type: keyword





| extended

// ===============================================================

|
[[field-elf-shared-libraries]]
<<field-elf-shared-libraries, elf.shared_libraries>>

a| List of shared libraries used by this ELF object.

type: keyword


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-elf-telfhash]]
<<field-elf-telfhash, elf.telfhash>>

a| telfhash symbol hash for ELF file.

type: keyword





| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `elf` fields are expected to be nested at:


* `file.elf`

* `process.elf`


Note also that the `elf` fields are not expected to be used directly at the root of the events.
[[ecs-email]]
=== Email Fields

Event details relating to an email transaction.

This field set focuses on the email message header, body, and attachments. Network protocols that send and receive email messages such as SMTP are outside the scope of the `email.*` fields.

[discrete]
==== Email Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-email-attachments]]
<<field-email-attachments, email.attachments>>

a| A list of objects describing the attachment files sent along with an email message.

type: nested


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-email-attachments-file-extension]]
<<field-email-attachments-file-extension, email.attachments.file.extension>>

a| Attachment file extension, excluding the leading dot.

type: keyword



example: `txt`

| extended

// ===============================================================

|
[[field-email-attachments-file-mime-type]]
<<field-email-attachments-file-mime-type, email.attachments.file.mime_type>>

a| The MIME media type of the attachment.

This value will typically be extracted from the `Content-Type` MIME header field.

type: keyword



example: `text/plain`

| extended

// ===============================================================

|
[[field-email-attachments-file-name]]
<<field-email-attachments-file-name, email.attachments.file.name>>

a| Name of the attachment file including the file extension.

type: keyword



example: `attachment.txt`

| extended

// ===============================================================

|
[[field-email-attachments-file-size]]
<<field-email-attachments-file-size, email.attachments.file.size>>

a| Attachment file size in bytes.

type: long



example: `64329`

| extended

// ===============================================================

|
[[field-email-bcc-address]]
<<field-email-bcc-address, email.bcc.address>>

a| The email address of BCC recipient

type: keyword


Note: this field should contain an array of values.



example: `bcc.user1@example.com`

| extended

// ===============================================================

|
[[field-email-cc-address]]
<<field-email-cc-address, email.cc.address>>

a| The email address of CC recipient

type: keyword


Note: this field should contain an array of values.



example: `cc.user1@example.com`

| extended

// ===============================================================

|
[[field-email-content-type]]
<<field-email-content-type, email.content_type>>

a| Information about how the message is to be displayed.

Typically a MIME type.

type: keyword



example: `text/plain`

| extended

// ===============================================================

|
[[field-email-delivery-timestamp]]
<<field-email-delivery-timestamp, email.delivery_timestamp>>

a| The date and time when the email message was received by the service or client.

type: date



example: `2020-11-10T22:12:34.8196921Z`

| extended

// ===============================================================

|
[[field-email-direction]]
<<field-email-direction, email.direction>>

a| The direction of the message based on the sending and receiving domains.

type: keyword



example: `inbound`

| extended

// ===============================================================

|
[[field-email-from-address]]
<<field-email-from-address, email.from.address>>

a| The email address of the sender, typically from the RFC 5322 `From:` header field.

type: keyword


Note: this field should contain an array of values.



example: `sender@example.com`

| extended

// ===============================================================

|
[[field-email-local-id]]
<<field-email-local-id, email.local_id>>

a| Unique identifier given to the email by the source that created the event.

Identifier is not persistent across hops.

type: keyword



example: `c26dbea0-80d5-463b-b93c-4e8b708219ce`

| extended

// ===============================================================

|
[[field-email-message-id]]
<<field-email-message-id, email.message_id>>

a| Identifier from the RFC 5322 `Message-ID:` email header that refers to a particular email message.

type: wildcard



example: `81ce15$8r2j59@mail01.example.com`

| extended

// ===============================================================

|
[[field-email-origination-timestamp]]
<<field-email-origination-timestamp, email.origination_timestamp>>

a| The date and time the email message was composed. Many email clients will fill in this value automatically when the message is sent by a user.

type: date



example: `2020-11-10T22:12:34.8196921Z`

| extended

// ===============================================================

|
[[field-email-reply-to-address]]
<<field-email-reply-to-address, email.reply_to.address>>

a| The address that replies should be delivered to based on the value in the RFC 5322 `Reply-To:` header.

type: keyword


Note: this field should contain an array of values.



example: `reply.here@example.com`

| extended

// ===============================================================

|
[[field-email-sender-address]]
<<field-email-sender-address, email.sender.address>>

a| Per RFC 5322, specifies the address responsible for the actual transmission of the message.

type: keyword





| extended

// ===============================================================

|
[[field-email-subject]]
<<field-email-subject, email.subject>>

a| A brief summary of the topic of the message.

type: keyword

Multi-fields:

* email.subject.text (type: match_only_text)





example: `Please see this important message.`

| extended

// ===============================================================

|
[[field-email-to-address]]
<<field-email-to-address, email.to.address>>

a| The email address of recipient

type: keyword


Note: this field should contain an array of values.



example: `user1@example.com`

| extended

// ===============================================================

|
[[field-email-x-mailer]]
<<field-email-x-mailer, email.x_mailer>>

a| The name of the application that was used to draft and send the original email message.

type: keyword



example: `Spambot v2.5`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-email-nestings]]
[discrete]
===== Field sets that can be nested under Email

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `email.attachments.file.hash.*`
| <<ecs-hash,hash>>
| Hashes, usually file hashes.

// ===============================================================


|=====


[[ecs-error]]
=== Error Fields

These fields can represent errors of any kind.

Use them for errors that happen while fetching events or in cases where the event itself contains an error.

[discrete]
==== Error Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-error-code]]
<<field-error-code, error.code>>

a| Error code describing the error.

type: keyword





| core

// ===============================================================

|
[[field-error-id]]
<<field-error-id, error.id>>

a| Unique identifier for the error.

type: keyword





| core

// ===============================================================

|
[[field-error-message]]
<<field-error-message, error.message>>

a| Error message.

type: match_only_text





| core

// ===============================================================

|
[[field-error-stack-trace]]
<<field-error-stack-trace, error.stack_trace>>

a| The stack trace of this error in plain text.

type: wildcard

Multi-fields:

* error.stack_trace.text (type: match_only_text)







| extended

// ===============================================================

|
[[field-error-type]]
<<field-error-type, error.type>>

a| The type of the error, for example the class name of the exception.

type: keyword



example: `java.lang.NullPointerException`

| extended

// ===============================================================

|=====


[[ecs-event]]
=== Event Fields

The event fields are used for context information about the log or metric event itself.

A log is defined as an event containing details of something that happened. Log events must include the time at which the thing happened. Examples of log events include a process starting on a host, a network packet being sent from a source to a destination, or a network connection between a client and a server being initiated or closed. A metric is defined as an event containing one or more numerical measurements and the time at which the measurement was taken. Examples of metric events include memory pressure measured on a host and device temperature. See the `event.kind` definition in this section for additional details about metric and state events.

[discrete]
==== Event Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-event-action]]
<<field-event-action, event.action>>

a| The action captured by the event.

This describes the information in the event. It is more specific than `event.category`. Examples are `group-add`, `process-started`, `file-created`. The value is normally defined by the implementer.

type: keyword



example: `user-password-change`

| core

// ===============================================================

|
[[field-event-agent-id-status]]
<<field-event-agent-id-status, event.agent_id_status>>

a| Agents are normally responsible for populating the `agent.id` field value. If the system receiving events is capable of validating the value based on authentication information for the client then this field can be used to reflect the outcome of that validation.

For example if the agent's connection is authenticated with mTLS and the client cert contains the ID of the agent to which the cert was issued then the `agent.id` value in events can be checked against the certificate. If the values match then `event.agent_id_status: verified` is added to the event, otherwise one of the other allowed values should be used.

If no validation is performed then the field should be omitted.

The allowed values are:

`verified` - The `agent.id` field value matches expected value obtained from auth metadata.

`mismatch` - The `agent.id` field value does not match the expected value obtained from auth metadata.

`missing` - There was no `agent.id` field in the event to validate.

`auth_metadata_missing` - There was no auth metadata or it was missing information about the agent ID.

type: keyword



example: `verified`

| extended

// ===============================================================

|
[[field-event-category]]
<<field-event-category, event.category>>

a| This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy.

`event.category` represents the "big buckets" of ECS categories. For example, filtering on `event.category:process` yields all events relating to process activity. This field is closely related to `event.type`, which is used as a subcategory.

This field is an array. This will allow proper categorization of some events that fall in multiple categories.

type: keyword


Note: this field should contain an array of values.




*Important*: The field value must be one of the following:

authentication, configuration, database, driver, email, file, host, iam, intrusion_detection, malware, network, package, process, registry, session, threat, vulnerability, web

To learn more about when to use which value, visit the page
<<ecs-allowed-values-event-category,allowed values for event.category>>


| core

// ===============================================================

|
[[field-event-code]]
<<field-event-code, event.code>>

a| Identification code for this event, if one exists.

Some event sources use event codes to identify messages unambiguously, regardless of message language or wording adjustments over time. An example of this is the Windows Event ID.

type: keyword



example: `4648`

| extended

// ===============================================================

|
[[field-event-created]]
<<field-event-created, event.created>>

a| event.created contains the date/time when the event was first read by an agent, or by your pipeline.

This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event.

In most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent's or pipeline's ability to keep up with your event source.

In case the two timestamps are identical, @timestamp should be used.

type: date



example: `2016-05-23T08:05:34.857Z`

| core

// ===============================================================

|
[[field-event-dataset]]
<<field-event-dataset, event.dataset>>

a| Name of the dataset.

If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from.

It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.

type: keyword



example: `apache.access`

| core

// ===============================================================

|
[[field-event-duration]]
<<field-event-duration, event.duration>>

a| Duration of the event in nanoseconds.

If event.start and event.end are known this value should be the difference between the end and start time.

type: long





| core

// ===============================================================

|
[[field-event-end]]
<<field-event-end, event.end>>

a| event.end contains the date when the event ended or when the activity was last observed.

type: date





| extended

// ===============================================================

|
[[field-event-hash]]
<<field-event-hash, event.hash>>

a| Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.

type: keyword



example: `123456789012345678901234567890ABCD`

| extended

// ===============================================================

|
[[field-event-id]]
<<field-event-id, event.id>>

a| Unique ID to describe the event.

type: keyword



example: `8a4f500d`

| core

// ===============================================================

|
[[field-event-ingested]]
<<field-event-ingested, event.ingested>>

a| Timestamp when an event arrived in the central data store.

This is different from `@timestamp`, which is when the event originally occurred.  It's also different from `event.created`, which is meant to capture the first time an agent saw the event.

In normal conditions, assuming no tampering, the timestamps should chronologically look like this: `@timestamp` < `event.created` < `event.ingested`.

type: date



example: `2016-05-23T08:05:35.101Z`

| core

// ===============================================================

|
[[field-event-kind]]
<<field-event-kind, event.kind>>

a| This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy.

`event.kind` gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events.

The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.

type: keyword




*Important*: The field value must be one of the following:

alert, enrichment, event, metric, state, pipeline_error, signal

To learn more about when to use which value, visit the page
<<ecs-allowed-values-event-kind,allowed values for event.kind>>


| core

// ===============================================================

|
[[field-event-module]]
<<field-event-module, event.module>>

a| Name of the module this data is coming from.

If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), `event.module` should contain the name of this module.

type: keyword



example: `apache`

| core

// ===============================================================

|
[[field-event-original]]
<<field-event-original, event.original>>

a| Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex.

This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from `_source`. If users wish to override this and index this field, please see `Field data types` in the `Elasticsearch Reference`.

type: keyword



example: `Sep 19 08:26:10 host CEF:0&#124;Security&#124; threatmanager&#124;1.0&#124;100&#124; worm successfully stopped&#124;10&#124;src=10.0.0.1 dst=2.1.2.2spt=1232`

| core

// ===============================================================

|
[[field-event-outcome]]
<<field-event-outcome, event.outcome>>

a| This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy.

`event.outcome` simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event.

Note that when a single transaction is described in multiple events, each event may populate different values of `event.outcome`, according to their perspective.

Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer.

Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with `event.type:info`, or any events for which an outcome does not make logical sense.

type: keyword




*Important*: The field value must be one of the following:

failure, success, unknown

To learn more about when to use which value, visit the page
<<ecs-allowed-values-event-outcome,allowed values for event.outcome>>


| core

// ===============================================================

|
[[field-event-provider]]
<<field-event-provider, event.provider>>

a| Source of the event.

Event transports such as Syslog or the Windows Event Log typically mention the source of an event. It can be the name of the software that generated the event (e.g. Sysmon, httpd), or of a subsystem of the operating system (kernel, Microsoft-Windows-Security-Auditing).

type: keyword



example: `kernel`

| extended

// ===============================================================

|
[[field-event-reason]]
<<field-event-reason, event.reason>>

a| Reason why this event happened, according to the source.

This describes the why of a particular action or outcome captured in the event. Where `event.action` captures the action from the event, `event.reason` describes why that action was taken. For example, a web proxy with an `event.action` which denied the request may also populate `event.reason` with the reason why (e.g. `blocked site`).

type: keyword



example: `Terminated an unexpected process`

| extended

// ===============================================================

|
[[field-event-reference]]
<<field-event-reference, event.reference>>

a| Reference URL linking to additional information about this event.

This URL links to a static definition of this event. Alert events, indicated by `event.kind:alert`, are a common use case for this field.

type: keyword



example: `https://system.example.com/event/#0001234`

| extended

// ===============================================================

|
[[field-event-risk-score]]
<<field-event-risk-score, event.risk_score>>

a| Risk score or priority of the event (e.g. security solutions). Use your system's original value here.

type: float





| core

// ===============================================================

|
[[field-event-risk-score-norm]]
<<field-event-risk-score-norm, event.risk_score_norm>>

a| Normalized risk score or priority of the event, on a scale of 0 to 100.

This is mainly useful if you use more than one system that assigns risk scores, and you want to see a normalized value across all systems.

type: float





| extended

// ===============================================================

|
[[field-event-sequence]]
<<field-event-sequence, event.sequence>>

a| Sequence number of the event.

The sequence number is a value published by some event sources, to make the exact ordering of events unambiguous, regardless of the timestamp precision.

type: long





| extended

// ===============================================================

|
[[field-event-severity]]
<<field-event-severity, event.severity>>

a| The numeric severity of the event according to your event source.

What the different severity values mean can be different between sources and use cases. It's up to the implementer to make sure severities are consistent across events from the same source.

The Syslog severity belongs in `log.syslog.severity.code`. `event.severity` is meant to represent the severity according to the event source (e.g. firewall, IDS). If the event source does not publish its own severity, you may optionally copy the `log.syslog.severity.code` to `event.severity`.

type: long



example: `7`

| core

// ===============================================================

|
[[field-event-start]]
<<field-event-start, event.start>>

a| event.start contains the date when the event started or when the activity was first observed.

type: date





| extended

// ===============================================================

|
[[field-event-timezone]]
<<field-event-timezone, event.timezone>>

a| This field should be populated when the event's timestamp does not include timezone information already (e.g. default Syslog timestamps). It's optional otherwise.

Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"), abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00").

type: keyword





| extended

// ===============================================================

|
[[field-event-type]]
<<field-event-type, event.type>>

a| This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy.

`event.type` represents a categorization "sub-bucket" that, when used along with the `event.category` field values, enables filtering events down to a level appropriate for single visualization.

This field is an array. This will allow proper categorization of some events that fall in multiple event types.

type: keyword


Note: this field should contain an array of values.




*Important*: The field value must be one of the following:

access, admin, allowed, change, connection, creation, deletion, denied, end, error, group, indicator, info, installation, protocol, start, user

To learn more about when to use which value, visit the page
<<ecs-allowed-values-event-type,allowed values for event.type>>


| core

// ===============================================================

|
[[field-event-url]]
<<field-event-url, event.url>>

a| URL linking to an external system to continue investigation of this event.

This URL links to another system where in-depth investigation of the specific occurrence of this event can take place. Alert events, indicated by `event.kind:alert`, are a common use case for this field.

type: keyword



example: `https://mysystem.example.com/alert/5271dedb-f5b0-4218-87f0-4ac4870a38fe`

| extended

// ===============================================================

|=====


[[ecs-faas]]
=== FaaS Fields

The user fields describe information about the function as a service (FaaS) that is relevant to the event.

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== FaaS Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-faas-coldstart]]
<<field-faas-coldstart, faas.coldstart>>

a| Boolean value indicating a cold start of a function.

type: boolean





| extended

// ===============================================================

|
[[field-faas-execution]]
<<field-faas-execution, faas.execution>>

a| The execution ID of the current function execution.

type: keyword



example: `af9d5aa4-a685-4c5f-a22b-444f80b3cc28`

| extended

// ===============================================================

|
[[field-faas-id]]
<<field-faas-id, faas.id>>

a| The unique identifier of a serverless function.

For AWS Lambda it's the function ARN (Amazon Resource Name) without a version or alias suffix.

type: keyword



example: `arn:aws:lambda:us-west-2:123456789012:function:my-function`

| extended

// ===============================================================

|
[[field-faas-name]]
<<field-faas-name, faas.name>>

a| The name of a serverless function.

type: keyword



example: `my-function`

| extended

// ===============================================================

|
[[field-faas-trigger]]
<<field-faas-trigger, faas.trigger>>

a| Details about the function trigger.

type: nested





| extended

// ===============================================================

|
[[field-faas-trigger-request-id]]
<<field-faas-trigger-request-id, faas.trigger.request_id>>

a| The ID of the trigger request , message, event, etc.

type: keyword



example: `123456789`

| extended

// ===============================================================

|
[[field-faas-trigger-type]]
<<field-faas-trigger-type, faas.trigger.type>>

a| The trigger for the function execution.

Expected values for this field:

* `http`
* `pubsub`
* `datasource`
* `timer`
* `other`

type: keyword



example: `http`

| extended

// ===============================================================

|
[[field-faas-version]]
<<field-faas-version, faas.version>>

a| The version of a serverless function.

type: keyword



example: `123`

| extended

// ===============================================================

|=====


[[ecs-file]]
=== File Fields

A file is defined as a set of information that has been created on, or has existed on a filesystem.

File objects can be associated with host events, network events, and/or file events (e.g., those produced by File Integrity Monitoring [FIM] products or services). File fields provide details about the affected file associated with the event or metric.

[discrete]
==== File Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-file-accessed]]
<<field-file-accessed, file.accessed>>

a| Last time the file was accessed.

Note that not all filesystems keep track of access time.

type: date





| extended

// ===============================================================

|
[[field-file-attributes]]
<<field-file-attributes, file.attributes>>

a| Array of file attributes.

Attributes names will vary by platform. Here's a non-exhaustive list of values that are expected in this field: archive, compressed, directory, encrypted, execute, hidden, read, readonly, system, write.

type: keyword


Note: this field should contain an array of values.



example: `["readonly", "system"]`

| extended

// ===============================================================

|
[[field-file-created]]
<<field-file-created, file.created>>

a| File creation time.

Note that not all filesystems store the creation time.

type: date





| extended

// ===============================================================

|
[[field-file-ctime]]
<<field-file-ctime, file.ctime>>

a| Last time the file attributes or metadata changed.

Note that changes to the file content will update `mtime`. This implies `ctime` will be adjusted at the same time, since `mtime` is an attribute of the file.

type: date





| extended

// ===============================================================

|
[[field-file-device]]
<<field-file-device, file.device>>

a| Device that is the source of the file.

type: keyword



example: `sda`

| extended

// ===============================================================

|
[[field-file-directory]]
<<field-file-directory, file.directory>>

a| Directory where the file is located. It should include the drive letter, when appropriate.

type: keyword



example: `/home/alice`

| extended

// ===============================================================

|
[[field-file-drive-letter]]
<<field-file-drive-letter, file.drive_letter>>

a| Drive letter where the file is located. This field is only relevant on Windows.

The value should be uppercase, and not include the colon.

type: keyword



example: `C`

| extended

// ===============================================================

|
[[field-file-extension]]
<<field-file-extension, file.extension>>

a| File extension, excluding the leading dot.

Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz").

type: keyword



example: `png`

| extended

// ===============================================================

|
[[field-file-fork-name]]
<<field-file-fork-name, file.fork_name>>

a| A fork is additional data associated with a filesystem object.

On Linux, a resource fork is used to store additional data with a filesystem object. A file always has at least one fork for the data portion, and additional forks may exist.

On NTFS, this is analogous to an Alternate Data Stream (ADS), and the default data stream for a file is just called $DATA. Zone.Identifier is commonly used by Windows to track contents downloaded from the Internet. An ADS is typically of the form: `C:\path\to\filename.extension:some_fork_name`, and `some_fork_name` is the value that should populate `fork_name`. `filename.extension` should populate `file.name`, and `extension` should populate `file.extension`. The full path, `file.path`, will include the fork name.

type: keyword



example: `Zone.Identifer`

| extended

// ===============================================================

|
[[field-file-gid]]
<<field-file-gid, file.gid>>

a| Primary group ID (GID) of the file.

type: keyword



example: `1001`

| extended

// ===============================================================

|
[[field-file-group]]
<<field-file-group, file.group>>

a| Primary group name of the file.

type: keyword



example: `alice`

| extended

// ===============================================================

|
[[field-file-inode]]
<<field-file-inode, file.inode>>

a| Inode representing the file in the filesystem.

type: keyword



example: `256383`

| extended

// ===============================================================

|
[[field-file-mime-type]]
<<field-file-mime-type, file.mime_type>>

a| MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used.

type: keyword





| extended

// ===============================================================

|
[[field-file-mode]]
<<field-file-mode, file.mode>>

a| Mode of the file in octal representation.

type: keyword



example: `0640`

| extended

// ===============================================================

|
[[field-file-mtime]]
<<field-file-mtime, file.mtime>>

a| Last time the file content was modified.

type: date





| extended

// ===============================================================

|
[[field-file-name]]
<<field-file-name, file.name>>

a| Name of the file including the extension, without the directory.

type: keyword



example: `example.png`

| extended

// ===============================================================

|
[[field-file-owner]]
<<field-file-owner, file.owner>>

a| File owner's username.

type: keyword



example: `alice`

| extended

// ===============================================================

|
[[field-file-path]]
<<field-file-path, file.path>>

a| Full path to the file, including the file name. It should include the drive letter, when appropriate.

type: keyword

Multi-fields:

* file.path.text (type: match_only_text)





example: `/home/alice/example.png`

| extended

// ===============================================================

|
[[field-file-size]]
<<field-file-size, file.size>>

a| File size in bytes.

Only relevant when `file.type` is "file".

type: long



example: `16384`

| extended

// ===============================================================

|
[[field-file-target-path]]
<<field-file-target-path, file.target_path>>

a| Target path for symlinks.

type: keyword

Multi-fields:

* file.target_path.text (type: match_only_text)







| extended

// ===============================================================

|
[[field-file-type]]
<<field-file-type, file.type>>

a| File type (file, dir, or symlink).

type: keyword



example: `file`

| extended

// ===============================================================

|
[[field-file-uid]]
<<field-file-uid, file.uid>>

a| The user ID (UID) or security identifier (SID) of the file owner.

type: keyword



example: `1001`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `file` fields are expected to be nested at:


* `threat.enrichments.indicator.file`

* `threat.indicator.file`


Note also that the `file` fields may be used directly at the root of the events.

[[ecs-file-nestings]]
[discrete]
===== Field sets that can be nested under File

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `file.code_signature.*`
| <<ecs-code_signature,code_signature>>
| These fields contain information about binary code signatures.

// ===============================================================


| `file.elf.*`
| <<ecs-elf,elf>>| beta:[ This field reuse is beta and subject to change.]

These fields contain Linux Executable Linkable Format (ELF) metadata.

// ===============================================================


| `file.hash.*`
| <<ecs-hash,hash>>
| Hashes, usually file hashes.

// ===============================================================


| `file.macho.*`
| <<ecs-macho,macho>>| beta:[ This field reuse is beta and subject to change.]

These fields contain Mac OS Mach Object file format (Mach-O) metadata.

// ===============================================================


| `file.pe.*`
| <<ecs-pe,pe>>
| These fields contain Windows Portable Executable (PE) metadata.

// ===============================================================


| `file.x509.*`
| <<ecs-x509,x509>>
| These fields contain x509 certificate metadata.

// ===============================================================


|=====


[[ecs-geo]]
=== Geo Fields

Geo fields can carry data about a specific location related to an event.

This geolocation information can be derived from techniques such as Geo IP, or be user-supplied.

[discrete]
==== Geo Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-geo-city-name]]
<<field-geo-city-name, geo.city_name>>

a| City name.

type: keyword



example: `Montreal`

| core

// ===============================================================

|
[[field-geo-continent-code]]
<<field-geo-continent-code, geo.continent_code>>

a| Two-letter code representing continent's name.

type: keyword



example: `NA`

| core

// ===============================================================

|
[[field-geo-continent-name]]
<<field-geo-continent-name, geo.continent_name>>

a| Name of the continent.

type: keyword



example: `North America`

| core

// ===============================================================

|
[[field-geo-country-iso-code]]
<<field-geo-country-iso-code, geo.country_iso_code>>

a| Country ISO code.

type: keyword



example: `CA`

| core

// ===============================================================

|
[[field-geo-country-name]]
<<field-geo-country-name, geo.country_name>>

a| Country name.

type: keyword



example: `Canada`

| core

// ===============================================================

|
[[field-geo-location]]
<<field-geo-location, geo.location>>

a| Longitude and latitude.

type: geo_point



example: `{ "lon": -73.614830, "lat": 45.505918 }`

| core

// ===============================================================

|
[[field-geo-name]]
<<field-geo-name, geo.name>>

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

type: keyword



example: `boston-dc`

| extended

// ===============================================================

|
[[field-geo-postal-code]]
<<field-geo-postal-code, geo.postal_code>>

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

type: keyword



example: `94040`

| core

// ===============================================================

|
[[field-geo-region-iso-code]]
<<field-geo-region-iso-code, geo.region_iso_code>>

a| Region ISO code.

type: keyword



example: `CA-QC`

| core

// ===============================================================

|
[[field-geo-region-name]]
<<field-geo-region-name, geo.region_name>>

a| Region name.

type: keyword



example: `Quebec`

| core

// ===============================================================

|
[[field-geo-timezone]]
<<field-geo-timezone, geo.timezone>>

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

type: keyword



example: `America/Argentina/Buenos_Aires`

| core

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `geo` fields are expected to be nested at:


* `client.geo`

* `destination.geo`

* `host.geo`

* `observer.geo`

* `server.geo`

* `source.geo`

* `threat.enrichments.indicator.geo`

* `threat.indicator.geo`


Note also that the `geo` fields are not expected to be used directly at the root of the events.
[[ecs-group]]
=== Group Fields

The group fields are meant to represent groups that are relevant to the event.

[discrete]
==== Group Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-group-domain]]
<<field-group-domain, group.domain>>

a| Name of the directory the group is a member of.

For example, an LDAP or Active Directory domain name.

type: keyword





| extended

// ===============================================================

|
[[field-group-id]]
<<field-group-id, group.id>>

a| Unique identifier for the group on the system/platform.

type: keyword





| extended

// ===============================================================

|
[[field-group-name]]
<<field-group-name, group.name>>

a| Name of the group.

type: keyword





| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `group` fields are expected to be nested at:


* `process.attested_groups`

* `process.group`

* `process.real_group`

* `process.saved_group`

* `process.supplemental_groups`

* `user.group`


Note also that the `group` fields may be used directly at the root of the events.


[[ecs-hash]]
=== Hash Fields

The hash fields represent different bitwise hash algorithms and their values.

Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512).

Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively).

[discrete]
==== Hash Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-hash-md5]]
<<field-hash-md5, hash.md5>>

a| MD5 hash.

type: keyword





| extended

// ===============================================================

|
[[field-hash-sha1]]
<<field-hash-sha1, hash.sha1>>

a| SHA1 hash.

type: keyword





| extended

// ===============================================================

|
[[field-hash-sha256]]
<<field-hash-sha256, hash.sha256>>

a| SHA256 hash.

type: keyword





| extended

// ===============================================================

|
[[field-hash-sha384]]
<<field-hash-sha384, hash.sha384>>

a| SHA384 hash.

type: keyword





| extended

// ===============================================================

|
[[field-hash-sha512]]
<<field-hash-sha512, hash.sha512>>

a| SHA512 hash.

type: keyword





| extended

// ===============================================================

|
[[field-hash-ssdeep]]
<<field-hash-ssdeep, hash.ssdeep>>

a| SSDEEP hash.

type: keyword





| extended

// ===============================================================

|
[[field-hash-tlsh]]
<<field-hash-tlsh, hash.tlsh>>

a| TLSH hash.

type: keyword





| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `hash` fields are expected to be nested at:


* `dll.hash`

* `email.attachments.file.hash`

* `file.hash`

* `process.hash`


Note also that the `hash` fields are not expected to be used directly at the root of the events.
[[ecs-host]]
=== Host Fields

A host is defined as a general computing instance.

ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.

[discrete]
==== Host Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-host-architecture]]
<<field-host-architecture, host.architecture>>

a| Operating system architecture.

type: keyword



example: `x86_64`

| core

// ===============================================================

|
[[field-host-boot-id]]
<<field-host-boot-id, host.boot.id>>

a| beta:[ This field is beta and subject to change. ]

Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the boot_id value from /proc may or may not be the same in containers as on the host. Some container runtimes will bind mount a new boot_id value onto the proc file in each container.

type: keyword



example: `88a1f0ed-5ae5-41ee-af6b-41921c311872`

| extended

// ===============================================================

|
[[field-host-cpu-usage]]
<<field-host-cpu-usage, host.cpu.usage>>

a| Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1.

Scaling factor: 1000.

For example: For a two core host, this value should be the average of the two cores, between 0 and 1.

type: scaled_float





| extended

// ===============================================================

|
[[field-host-disk-read-bytes]]
<<field-host-disk-read-bytes, host.disk.read.bytes>>

a| The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-host-disk-write-bytes]]
<<field-host-disk-write-bytes, host.disk.write.bytes>>

a| The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-host-domain]]
<<field-host-domain, host.domain>>

a| Name of the domain of which the host is a member.

For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider.

type: keyword



example: `CONTOSO`

| extended

// ===============================================================

|
[[field-host-hostname]]
<<field-host-hostname, host.hostname>>

a| Hostname of the host.

It normally contains what the `hostname` command returns on the host machine.

type: keyword





| core

// ===============================================================

|
[[field-host-id]]
<<field-host-id, host.id>>

a| Unique host id.

As hostname is not always unique, use values that are meaningful in your environment.

Example: The current usage of `beat.name`.

type: keyword





| core

// ===============================================================

|
[[field-host-ip]]
<<field-host-ip, host.ip>>

a| Host ip addresses.

type: ip


Note: this field should contain an array of values.





| core

// ===============================================================

|
[[field-host-mac]]
<<field-host-mac, host.mac>>

a| Host MAC addresses.

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.

type: keyword


Note: this field should contain an array of values.



example: `["00-00-5E-00-53-23", "00-00-5E-00-53-24"]`

| core

// ===============================================================

|
[[field-host-name]]
<<field-host-name, host.name>>

a| Name of the host.

It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.

type: keyword





| core

// ===============================================================

|
[[field-host-network-egress-bytes]]
<<field-host-network-egress-bytes, host.network.egress.bytes>>

a| The number of bytes (gauge) sent out on all network interfaces by the host since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-host-network-egress-packets]]
<<field-host-network-egress-packets, host.network.egress.packets>>

a| The number of packets (gauge) sent out on all network interfaces by the host since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-host-network-ingress-bytes]]
<<field-host-network-ingress-bytes, host.network.ingress.bytes>>

a| The number of bytes received (gauge) on all network interfaces by the host since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-host-network-ingress-packets]]
<<field-host-network-ingress-packets, host.network.ingress.packets>>

a| The number of packets (gauge) received on all network interfaces by the host since the last metric collection.

type: long





| extended

// ===============================================================

|
[[field-host-pid-ns-ino]]
<<field-host-pid-ns-ino, host.pid_ns_ino>>

a| beta:[ This field is beta and subject to change. ]

This is the inode number of the namespace in the namespace file system (nsfs). Unsigned int inum in include/linux/ns_common.h.

type: keyword



example: `256383`

| extended

// ===============================================================

|
[[field-host-type]]
<<field-host-type, host.type>>

a| Type of host.

For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment.

type: keyword





| core

// ===============================================================

|
[[field-host-uptime]]
<<field-host-uptime, host.uptime>>

a| Seconds the host has been up.

type: long



example: `1325`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-host-nestings]]
[discrete]
===== Field sets that can be nested under Host

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `host.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `host.os.*`
| <<ecs-os,os>>
| OS fields contain information about the operating system.

// ===============================================================


| `host.risk.*`
| <<ecs-risk,risk>>
| Fields for describing risk score and level.

// ===============================================================


|=====


[[ecs-http]]
=== HTTP Fields

Fields related to HTTP activity. Use the `url` field set to store the url of the request.

[discrete]
==== HTTP Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-http-request-body-bytes]]
<<field-http-request-body-bytes, http.request.body.bytes>>

a| Size in bytes of the request body.

type: long



example: `887`

| extended

// ===============================================================

|
[[field-http-request-body-content]]
<<field-http-request-body-content, http.request.body.content>>

a| The full HTTP request body.

type: wildcard

Multi-fields:

* http.request.body.content.text (type: match_only_text)





example: `Hello world`

| extended

// ===============================================================

|
[[field-http-request-bytes]]
<<field-http-request-bytes, http.request.bytes>>

a| Total size in bytes of the request (body and headers).

type: long



example: `1437`

| extended

// ===============================================================

|
[[field-http-request-id]]
<<field-http-request-id, http.request.id>>

a| A unique identifier for each HTTP request to correlate logs between clients and servers in transactions.

The id may be contained in a non-standard HTTP header, such as `X-Request-ID` or `X-Correlation-ID`.

type: keyword



example: `123e4567-e89b-12d3-a456-426614174000`

| extended

// ===============================================================

|
[[field-http-request-method]]
<<field-http-request-method, http.request.method>>

a| HTTP request method.

The value should retain its casing from the original event. For example, `GET`, `get`, and `GeT` are all considered valid values for this field.

type: keyword



example: `POST`

| extended

// ===============================================================

|
[[field-http-request-mime-type]]
<<field-http-request-mime-type, http.request.mime_type>>

a| Mime type of the body of the request.

This value must only be populated based on the content of the request body, not on the `Content-Type` header. Comparing the mime type of a request with the request's Content-Type header can be helpful in detecting threats or misconfigured clients.

type: keyword



example: `image/gif`

| extended

// ===============================================================

|
[[field-http-request-referrer]]
<<field-http-request-referrer, http.request.referrer>>

a| Referrer for this HTTP request.

type: keyword



example: `https://blog.example.com/`

| extended

// ===============================================================

|
[[field-http-response-body-bytes]]
<<field-http-response-body-bytes, http.response.body.bytes>>

a| Size in bytes of the response body.

type: long



example: `887`

| extended

// ===============================================================

|
[[field-http-response-body-content]]
<<field-http-response-body-content, http.response.body.content>>

a| The full HTTP response body.

type: wildcard

Multi-fields:

* http.response.body.content.text (type: match_only_text)





example: `Hello world`

| extended

// ===============================================================

|
[[field-http-response-bytes]]
<<field-http-response-bytes, http.response.bytes>>

a| Total size in bytes of the response (body and headers).

type: long



example: `1437`

| extended

// ===============================================================

|
[[field-http-response-mime-type]]
<<field-http-response-mime-type, http.response.mime_type>>

a| Mime type of the body of the response.

This value must only be populated based on the content of the response body, not on the `Content-Type` header. Comparing the mime type of a response with the response's Content-Type header can be helpful in detecting misconfigured servers.

type: keyword



example: `image/gif`

| extended

// ===============================================================

|
[[field-http-response-status-code]]
<<field-http-response-status-code, http.response.status_code>>

a| HTTP response status code.

type: long



example: `404`

| extended

// ===============================================================

|
[[field-http-version]]
<<field-http-version, http.version>>

a| HTTP version.

type: keyword



example: `1.1`

| extended

// ===============================================================

|=====


[[ecs-interface]]
=== Interface Fields

The interface fields are used to record ingress and egress interface information when reported by an observer (e.g. firewall, router, load balancer) in the context of the observer handling a network connection.  In the case of a single observer interface (e.g. network sensor on a span port) only the observer.ingress information should be populated.

[discrete]
==== Interface Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-interface-alias]]
<<field-interface-alias, interface.alias>>

a| Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.

type: keyword



example: `outside`

| extended

// ===============================================================

|
[[field-interface-id]]
<<field-interface-id, interface.id>>

a| Interface ID as reported by an observer (typically SNMP interface ID).

type: keyword



example: `10`

| extended

// ===============================================================

|
[[field-interface-name]]
<<field-interface-name, interface.name>>

a| Interface name as reported by the system.

type: keyword



example: `eth0`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `interface` fields are expected to be nested at:


* `observer.egress.interface`

* `observer.ingress.interface`


Note also that the `interface` fields are not expected to be used directly at the root of the events.
[[ecs-log]]
=== Log Fields

Details about the event's logging mechanism or logging transport.

The log.* fields are typically populated with details about the logging mechanism used to create and/or transport the event. For example, syslog details belong under `log.syslog.*`.

The details specific to your event source are typically not logged under `log.*`, but rather in `event.*` or in other ECS fields.

[discrete]
==== Log Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-log-file-path]]
<<field-log-file-path, log.file.path>>

a| Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate.

If the event wasn't read from a log file, do not populate this field.

type: keyword



example: `/var/log/fun-times.log`

| extended

// ===============================================================

|
[[field-log-level]]
<<field-log-level, log.level>>

a| Original log level of the log event.

If the source of the event provides a log level or textual severity, this is the one that goes in `log.level`. If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity).

Some examples are `warn`, `err`, `i`, `informational`.

type: keyword



example: `error`

| core

// ===============================================================

|
[[field-log-logger]]
<<field-log-logger, log.logger>>

a| The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name.

type: keyword



example: `org.elasticsearch.bootstrap.Bootstrap`

| core

// ===============================================================

|
[[field-log-origin-file-line]]
<<field-log-origin-file-line, log.origin.file.line>>

a| The line number of the file containing the source code which originated the log event.

type: long



example: `42`

| extended

// ===============================================================

|
[[field-log-origin-file-name]]
<<field-log-origin-file-name, log.origin.file.name>>

a| The name of the file containing the source code which originated the log event.

Note that this field is not meant to capture the log file. The correct field to capture the log file is `log.file.path`.

type: keyword



example: `Bootstrap.java`

| extended

// ===============================================================

|
[[field-log-origin-function]]
<<field-log-origin-function, log.origin.function>>

a| The name of the function or method which originated the log event.

type: keyword



example: `init`

| extended

// ===============================================================

|
[[field-log-syslog]]
<<field-log-syslog, log.syslog>>

a| The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164.

type: object





| extended

// ===============================================================

|
[[field-log-syslog-appname]]
<<field-log-syslog-appname, log.syslog.appname>>

a| The device or application that originated the Syslog message, if available.

type: keyword



example: `sshd`

| extended

// ===============================================================

|
[[field-log-syslog-facility-code]]
<<field-log-syslog-facility-code, log.syslog.facility.code>>

a| The Syslog numeric facility of the log event, if available.

According to RFCs 5424 and 3164, this value should be an integer between 0 and 23.

type: long



example: `23`

| extended

// ===============================================================

|
[[field-log-syslog-facility-name]]
<<field-log-syslog-facility-name, log.syslog.facility.name>>

a| The Syslog text-based facility of the log event, if available.

type: keyword



example: `local7`

| extended

// ===============================================================

|
[[field-log-syslog-hostname]]
<<field-log-syslog-hostname, log.syslog.hostname>>

a| The hostname, FQDN, or IP of the machine that originally sent the Syslog message. This is sourced from the hostname field of the syslog header. Depending on the environment, this value may be different from the host that handled the event, especially if the host handling the events is acting as a collector.

type: keyword



example: `example-host`

| extended

// ===============================================================

|
[[field-log-syslog-msgid]]
<<field-log-syslog-msgid, log.syslog.msgid>>

a| An identifier for the type of Syslog message, if available. Only applicable for RFC 5424 messages.

type: keyword



example: `ID47`

| extended

// ===============================================================

|
[[field-log-syslog-priority]]
<<field-log-syslog-priority, log.syslog.priority>>

a| Syslog numeric priority of the event, if available.

According to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191.

type: long



example: `135`

| extended

// ===============================================================

|
[[field-log-syslog-procid]]
<<field-log-syslog-procid, log.syslog.procid>>

a| The process name or ID that originated the Syslog message, if available.

type: keyword



example: `12345`

| extended

// ===============================================================

|
[[field-log-syslog-severity-code]]
<<field-log-syslog-severity-code, log.syslog.severity.code>>

a| The Syslog numeric severity of the log event, if available.

If the event source publishing via Syslog provides a different numeric severity value (e.g. firewall, IDS), your source's numeric severity should go to `event.severity`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `event.severity`.

type: long



example: `3`

| extended

// ===============================================================

|
[[field-log-syslog-severity-name]]
<<field-log-syslog-severity-name, log.syslog.severity.name>>

a| The Syslog numeric severity of the log event, if available.

If the event source publishing via Syslog provides a different severity value (e.g. firewall, IDS), your source's text severity should go to `log.level`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `log.level`.

type: keyword



example: `Error`

| extended

// ===============================================================

|
[[field-log-syslog-structured-data]]
<<field-log-syslog-structured-data, log.syslog.structured_data>>

a| Structured data expressed in RFC 5424 messages, if available. These are key-value pairs formed from the structured data portion of the syslog message, as defined in RFC 5424 Section 6.3.

type: flattened





| extended

// ===============================================================

|
[[field-log-syslog-version]]
<<field-log-syslog-version, log.syslog.version>>

a| The version of the Syslog protocol specification. Only applicable for RFC 5424 messages.

type: keyword



example: `1`

| extended

// ===============================================================

|=====


[[ecs-macho]]
=== Mach-O Header Fields

These fields contain Mac OS Mach Object file format (Mach-O) metadata.

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== Mach-O Header Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-macho-go-import-hash]]
<<field-macho-go-import-hash, macho.go_import_hash>>

a| A hash of the Go language imports in a Mach-O file excluding standard library imports. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

The algorithm used to calculate the Go symbol hash and a reference implementation are available [here](https://github.com/elastic/toutoumomoma).

type: keyword



example: `10bddcb4cee42080f76c88d9ff964491`

| extended

// ===============================================================

|
[[field-macho-go-imports]]
<<field-macho-go-imports, macho.go_imports>>

a| List of imported Go language element names and types.

type: flattened





| extended

// ===============================================================

|
[[field-macho-go-imports-names-entropy]]
<<field-macho-go-imports-names-entropy, macho.go_imports_names_entropy>>

a| Shannon entropy calculation from the list of Go imports.

type: long





| extended

// ===============================================================

|
[[field-macho-go-imports-names-var-entropy]]
<<field-macho-go-imports-names-var-entropy, macho.go_imports_names_var_entropy>>

a| Variance for Shannon entropy calculation from the list of Go imports.

type: long





| extended

// ===============================================================

|
[[field-macho-go-stripped]]
<<field-macho-go-stripped, macho.go_stripped>>

a| Set to true if the file is a Go executable that has had its symbols stripped or obfuscated and false if an unobfuscated Go executable.

type: boolean





| extended

// ===============================================================

|
[[field-macho-import-hash]]
<<field-macho-import-hash, macho.import_hash>>

a| A hash of the imports in a Mach-O file. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

This is a synonym for symhash.

type: keyword



example: `d41d8cd98f00b204e9800998ecf8427e`

| extended

// ===============================================================

|
[[field-macho-imports]]
<<field-macho-imports, macho.imports>>

a| List of imported element names and types.

type: flattened


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-macho-imports-names-entropy]]
<<field-macho-imports-names-entropy, macho.imports_names_entropy>>

a| Shannon entropy calculation from the list of imported element names and types.

type: long





| extended

// ===============================================================

|
[[field-macho-imports-names-var-entropy]]
<<field-macho-imports-names-var-entropy, macho.imports_names_var_entropy>>

a| Variance for Shannon entropy calculation from the list of imported element names and types.

type: long





| extended

// ===============================================================

|
[[field-macho-sections]]
<<field-macho-sections, macho.sections>>

a| An array containing an object for each section of the Mach-O file.

The keys that should be present in these objects are defined by sub-fields underneath `macho.sections.*`.

type: nested


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-macho-sections-entropy]]
<<field-macho-sections-entropy, macho.sections.entropy>>

a| Shannon entropy calculation from the section.

type: long





| extended

// ===============================================================

|
[[field-macho-sections-name]]
<<field-macho-sections-name, macho.sections.name>>

a| Mach-O Section List name.

type: keyword





| extended

// ===============================================================

|
[[field-macho-sections-physical-size]]
<<field-macho-sections-physical-size, macho.sections.physical_size>>

a| Mach-O Section List physical size.

type: long





| extended

// ===============================================================

|
[[field-macho-sections-var-entropy]]
<<field-macho-sections-var-entropy, macho.sections.var_entropy>>

a| Variance for Shannon entropy calculation from the section.

type: long





| extended

// ===============================================================

|
[[field-macho-sections-virtual-size]]
<<field-macho-sections-virtual-size, macho.sections.virtual_size>>

a| Mach-O Section List virtual size. This is always the same as `physical_size`.

type: long





| extended

// ===============================================================

|
[[field-macho-symhash]]
<<field-macho-symhash, macho.symhash>>

a| A hash of the imports in a Mach-O file. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

This is a Mach-O implementation of the Windows PE imphash

type: keyword



example: `d3ccf195b62a9279c3c19af1080497ec`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `macho` fields are expected to be nested at:


* `file.macho`

* `process.macho`


Note also that the `macho` fields are not expected to be used directly at the root of the events.
[[ecs-network]]
=== Network Fields

The network is defined as the communication path over which a host or network event happens.

The network.* fields should be populated with details about the network activity associated with an event.

[discrete]
==== Network Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-network-application]]
<<field-network-application, network.application>>

a| When a specific application or service is identified from network connection details (source/dest IPs, ports, certificates, or wire format), this field captures the application's or service's name.

For example, the original event identifies the network connection being from a specific web service in a `https` network connection, like `facebook` or `twitter`.

The field value must be normalized to lowercase for querying.

type: keyword



example: `aim`

| extended

// ===============================================================

|
[[field-network-bytes]]
<<field-network-bytes, network.bytes>>

a| Total bytes transferred in both directions.

If `source.bytes` and `destination.bytes` are known, `network.bytes` is their sum.

type: long



example: `368`

| core

// ===============================================================

|
[[field-network-community-id]]
<<field-network-community-id, network.community_id>>

a| A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows.

Learn more at https://github.com/corelight/community-id-spec.

type: keyword



example: `1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=`

| extended

// ===============================================================

|
[[field-network-direction]]
<<field-network-direction, network.direction>>

a| Direction of the network traffic.

When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values "ingress" or "egress".

When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of the network perimeter, using the values "inbound", "outbound", "internal" or "external".

Note that "internal" is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that "external" is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers.

Expected values for this field:

* `ingress`
* `egress`
* `inbound`
* `outbound`
* `internal`
* `external`
* `unknown`

type: keyword



example: `inbound`

| core

// ===============================================================

|
[[field-network-forwarded-ip]]
<<field-network-forwarded-ip, network.forwarded_ip>>

a| Host IP address when the source IP address is the proxy.

type: ip



example: `192.1.1.2`

| core

// ===============================================================

|
[[field-network-iana-number]]
<<field-network-iana-number, network.iana_number>>

a| IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number.

type: keyword



example: `6`

| extended

// ===============================================================

|
[[field-network-inner]]
<<field-network-inner, network.inner>>

a| Network.inner fields are added in addition to network.vlan fields to describe the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.)

type: object





| extended

// ===============================================================

|
[[field-network-name]]
<<field-network-name, network.name>>

a| Name given by operators to sections of their network.

type: keyword



example: `Guest Wifi`

| extended

// ===============================================================

|
[[field-network-packets]]
<<field-network-packets, network.packets>>

a| Total packets transferred in both directions.

If `source.packets` and `destination.packets` are known, `network.packets` is their sum.

type: long



example: `24`

| core

// ===============================================================

|
[[field-network-protocol]]
<<field-network-protocol, network.protocol>>

a| In the OSI Model this would be the Application Layer protocol. For example, `http`, `dns`, or `ssh`.

The field value must be normalized to lowercase for querying.

type: keyword



example: `http`

| core

// ===============================================================

|
[[field-network-transport]]
<<field-network-transport, network.transport>>

a| Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.)

The field value must be normalized to lowercase for querying.

type: keyword



example: `tcp`

| core

// ===============================================================

|
[[field-network-type]]
<<field-network-type, network.type>>

a| In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc

The field value must be normalized to lowercase for querying.

type: keyword



example: `ipv4`

| core

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-network-nestings]]
[discrete]
===== Field sets that can be nested under Network

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `network.inner.vlan.*`
| <<ecs-vlan,vlan>>
| Fields to describe observed VLAN information.

// ===============================================================


| `network.vlan.*`
| <<ecs-vlan,vlan>>
| Fields to describe observed VLAN information.

// ===============================================================


|=====


[[ecs-observer]]
=== Observer Fields

An observer is defined as a special network, security, or application device used to detect, observe, or create network, security, or application-related events and metrics.

This could be a custom hardware appliance or a server that has been configured to run special network, security, or application software. Examples include firewalls, web proxies, intrusion detection/prevention systems, network monitoring sensors, web application firewalls, data loss prevention systems, and APM servers. The observer.* fields shall be populated with details of the system, if any, that detects, observes and/or creates a network, security, or application event or metric. Message queues and ETL components used in processing events or metrics are not considered observers in ECS.

[discrete]
==== Observer Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-observer-egress]]
<<field-observer-egress, observer.egress>>

a| Observer.egress holds information like interface number and name, vlan, and zone information to classify egress traffic.  Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic.

type: object





| extended

// ===============================================================

|
[[field-observer-egress-zone]]
<<field-observer-egress-zone, observer.egress.zone>>

a| Network zone of outbound traffic as reported by the observer to categorize the destination area of egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc.

type: keyword



example: `Public_Internet`

| extended

// ===============================================================

|
[[field-observer-hostname]]
<<field-observer-hostname, observer.hostname>>

a| Hostname of the observer.

type: keyword





| core

// ===============================================================

|
[[field-observer-ingress]]
<<field-observer-ingress, observer.ingress>>

a| Observer.ingress holds information like interface number and name, vlan, and zone information to classify ingress traffic.  Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic.

type: object





| extended

// ===============================================================

|
[[field-observer-ingress-zone]]
<<field-observer-ingress-zone, observer.ingress.zone>>

a| Network zone of incoming traffic as reported by the observer to categorize the source area of ingress traffic. e.g. internal, External, DMZ, HR, Legal, etc.

type: keyword



example: `DMZ`

| extended

// ===============================================================

|
[[field-observer-ip]]
<<field-observer-ip, observer.ip>>

a| IP addresses of the observer.

type: ip


Note: this field should contain an array of values.





| core

// ===============================================================

|
[[field-observer-mac]]
<<field-observer-mac, observer.mac>>

a| MAC addresses of the observer.

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.

type: keyword


Note: this field should contain an array of values.



example: `["00-00-5E-00-53-23", "00-00-5E-00-53-24"]`

| core

// ===============================================================

|
[[field-observer-name]]
<<field-observer-name, observer.name>>

a| Custom name of the observer.

This is a name that can be given to an observer. This can be helpful for example if multiple firewalls of the same model are used in an organization.

If no custom name is needed, the field can be left empty.

type: keyword



example: `1_proxySG`

| extended

// ===============================================================

|
[[field-observer-product]]
<<field-observer-product, observer.product>>

a| The product name of the observer.

type: keyword



example: `s200`

| extended

// ===============================================================

|
[[field-observer-serial-number]]
<<field-observer-serial-number, observer.serial_number>>

a| Observer serial number.

type: keyword





| extended

// ===============================================================

|
[[field-observer-type]]
<<field-observer-type, observer.type>>

a| The type of the observer the data is coming from.

There is no predefined list of observer types. Some examples are `forwarder`, `firewall`, `ids`, `ips`, `proxy`, `poller`, `sensor`, `APM server`.

type: keyword



example: `firewall`

| core

// ===============================================================

|
[[field-observer-vendor]]
<<field-observer-vendor, observer.vendor>>

a| Vendor name of the observer.

type: keyword



example: `Symantec`

| core

// ===============================================================

|
[[field-observer-version]]
<<field-observer-version, observer.version>>

a| Observer version.

type: keyword





| core

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-observer-nestings]]
[discrete]
===== Field sets that can be nested under Observer

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `observer.egress.interface.*`
| <<ecs-interface,interface>>
| Fields to describe observer interface information.

// ===============================================================


| `observer.egress.vlan.*`
| <<ecs-vlan,vlan>>
| Fields to describe observed VLAN information.

// ===============================================================


| `observer.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `observer.ingress.interface.*`
| <<ecs-interface,interface>>
| Fields to describe observer interface information.

// ===============================================================


| `observer.ingress.vlan.*`
| <<ecs-vlan,vlan>>
| Fields to describe observed VLAN information.

// ===============================================================


| `observer.os.*`
| <<ecs-os,os>>
| OS fields contain information about the operating system.

// ===============================================================


|=====


[[ecs-orchestrator]]
=== Orchestrator Fields

Fields that describe the resources which container orchestrators manage or act upon.

[discrete]
==== Orchestrator Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-orchestrator-api-version]]
<<field-orchestrator-api-version, orchestrator.api_version>>

a| API version being used to carry out the action

type: keyword



example: `v1beta1`

| extended

// ===============================================================

|
[[field-orchestrator-cluster-id]]
<<field-orchestrator-cluster-id, orchestrator.cluster.id>>

a| Unique ID of the cluster.

type: keyword





| extended

// ===============================================================

|
[[field-orchestrator-cluster-name]]
<<field-orchestrator-cluster-name, orchestrator.cluster.name>>

a| Name of the cluster.

type: keyword





| extended

// ===============================================================

|
[[field-orchestrator-cluster-url]]
<<field-orchestrator-cluster-url, orchestrator.cluster.url>>

a| URL of the API used to manage the cluster.

type: keyword





| extended

// ===============================================================

|
[[field-orchestrator-cluster-version]]
<<field-orchestrator-cluster-version, orchestrator.cluster.version>>

a| The version of the cluster.

type: keyword





| extended

// ===============================================================

|
[[field-orchestrator-namespace]]
<<field-orchestrator-namespace, orchestrator.namespace>>

a| Namespace in which the action is taking place.

type: keyword



example: `kube-system`

| extended

// ===============================================================

|
[[field-orchestrator-organization]]
<<field-orchestrator-organization, orchestrator.organization>>

a| Organization affected by the event (for multi-tenant orchestrator setups).

type: keyword



example: `elastic`

| extended

// ===============================================================

|
[[field-orchestrator-resource-id]]
<<field-orchestrator-resource-id, orchestrator.resource.id>>

a| Unique ID of the resource being acted upon.

type: keyword





| extended

// ===============================================================

|
[[field-orchestrator-resource-ip]]
<<field-orchestrator-resource-ip, orchestrator.resource.ip>>

a| IP address assigned to the resource associated with the event being observed. In the case of a Kubernetes Pod, this array would contain only one element: the IP of the Pod (as opposed to the Node on which the Pod is running).

type: ip


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-orchestrator-resource-name]]
<<field-orchestrator-resource-name, orchestrator.resource.name>>

a| Name of the resource being acted upon.

type: keyword



example: `test-pod-cdcws`

| extended

// ===============================================================

|
[[field-orchestrator-resource-parent-type]]
<<field-orchestrator-resource-parent-type, orchestrator.resource.parent.type>>

a| Type or kind of the parent resource associated with the event being observed. In Kubernetes, this will be the name of a built-in workload resource (e.g., Deployment, StatefulSet, DaemonSet).

type: keyword



example: `DaemonSet`

| extended

// ===============================================================

|
[[field-orchestrator-resource-type]]
<<field-orchestrator-resource-type, orchestrator.resource.type>>

a| Type of resource being acted upon.

type: keyword



example: `service`

| extended

// ===============================================================

|
[[field-orchestrator-type]]
<<field-orchestrator-type, orchestrator.type>>

a| Orchestrator cluster type (e.g. kubernetes, nomad or cloudfoundry).

type: keyword



example: `kubernetes`

| extended

// ===============================================================

|=====


[[ecs-organization]]
=== Organization Fields

The organization fields enrich data with information about the company or entity the data is associated with.

These fields help you arrange or filter data stored in an index by one or multiple organizations.

[discrete]
==== Organization Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-organization-id]]
<<field-organization-id, organization.id>>

a| Unique identifier for the organization.

type: keyword





| extended

// ===============================================================

|
[[field-organization-name]]
<<field-organization-name, organization.name>>

a| Organization name.

type: keyword

Multi-fields:

* organization.name.text (type: match_only_text)







| extended

// ===============================================================

|=====


[[ecs-os]]
=== Operating System Fields

The OS fields contain information about the operating system.

[discrete]
==== Operating System Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-os-family]]
<<field-os-family, os.family>>

a| OS family (such as redhat, debian, freebsd, windows).

type: keyword



example: `debian`

| extended

// ===============================================================

|
[[field-os-full]]
<<field-os-full, os.full>>

a| Operating system name, including the version or code name.

type: keyword

Multi-fields:

* os.full.text (type: match_only_text)





example: `Mac OS Mojave`

| extended

// ===============================================================

|
[[field-os-kernel]]
<<field-os-kernel, os.kernel>>

a| Operating system kernel version as a raw string.

type: keyword



example: `4.4.0-112-generic`

| extended

// ===============================================================

|
[[field-os-name]]
<<field-os-name, os.name>>

a| Operating system name, without the version.

type: keyword

Multi-fields:

* os.name.text (type: match_only_text)





example: `Mac OS X`

| extended

// ===============================================================

|
[[field-os-platform]]
<<field-os-platform, os.platform>>

a| Operating system platform (such centos, ubuntu, windows).

type: keyword



example: `darwin`

| extended

// ===============================================================

|
[[field-os-type]]
<<field-os-type, os.type>>

a| Use the `os.type` field to categorize the operating system into one of the broad commercial families.

If the OS you're dealing with is not listed as an expected value, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition.

Expected values for this field:

* `linux`
* `macos`
* `unix`
* `windows`
* `ios`
* `android`

type: keyword



example: `macos`

| extended

// ===============================================================

|
[[field-os-version]]
<<field-os-version, os.version>>

a| Operating system version as a raw string.

type: keyword



example: `10.14.1`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `os` fields are expected to be nested at:


* `host.os`

* `observer.os`

* `user_agent.os`


Note also that the `os` fields are not expected to be used directly at the root of the events.
[[ecs-package]]
=== Package Fields

These fields contain information about an installed software package. It contains general information about a package, such as name, version or size. It also contains installation details, such as time or location.

[discrete]
==== Package Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-package-architecture]]
<<field-package-architecture, package.architecture>>

a| Package architecture.

type: keyword



example: `x86_64`

| extended

// ===============================================================

|
[[field-package-build-version]]
<<field-package-build-version, package.build_version>>

a| Additional information about the build version of the installed package.

For example use the commit SHA of a non-released package.

type: keyword



example: `36f4f7e89dd61b0988b12ee000b98966867710cd`

| extended

// ===============================================================

|
[[field-package-checksum]]
<<field-package-checksum, package.checksum>>

a| Checksum of the installed package for verification.

type: keyword



example: `68b329da9893e34099c7d8ad5cb9c940`

| extended

// ===============================================================

|
[[field-package-description]]
<<field-package-description, package.description>>

a| Description of the package.

type: keyword



example: `Open source programming language to build simple/reliable/efficient software.`

| extended

// ===============================================================

|
[[field-package-install-scope]]
<<field-package-install-scope, package.install_scope>>

a| Indicating how the package was installed, e.g. user-local, global.

type: keyword



example: `global`

| extended

// ===============================================================

|
[[field-package-installed]]
<<field-package-installed, package.installed>>

a| Time when package was installed.

type: date





| extended

// ===============================================================

|
[[field-package-license]]
<<field-package-license, package.license>>

a| License under which the package was released.

Use a short name, e.g. the license identifier from SPDX License List where possible (https://spdx.org/licenses/).

type: keyword



example: `Apache License 2.0`

| extended

// ===============================================================

|
[[field-package-name]]
<<field-package-name, package.name>>

a| Package name

type: keyword



example: `go`

| extended

// ===============================================================

|
[[field-package-path]]
<<field-package-path, package.path>>

a| Path where the package is installed.

type: keyword



example: `/usr/local/Cellar/go/1.12.9/`

| extended

// ===============================================================

|
[[field-package-reference]]
<<field-package-reference, package.reference>>

a| Home page or reference URL of the software in this package, if available.

type: keyword



example: `https://golang.org`

| extended

// ===============================================================

|
[[field-package-size]]
<<field-package-size, package.size>>

a| Package size in bytes.

type: long



example: `62231`

| extended

// ===============================================================

|
[[field-package-type]]
<<field-package-type, package.type>>

a| Type of package.

This should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar.

type: keyword



example: `rpm`

| extended

// ===============================================================

|
[[field-package-version]]
<<field-package-version, package.version>>

a| Package version

type: keyword



example: `1.12.9`

| extended

// ===============================================================

|=====


[[ecs-pe]]
=== PE Header Fields

These fields contain Windows Portable Executable (PE) metadata.

[discrete]
==== PE Header Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-pe-architecture]]
<<field-pe-architecture, pe.architecture>>

a| CPU architecture target for the file.

type: keyword



example: `x64`

| extended

// ===============================================================

|
[[field-pe-company]]
<<field-pe-company, pe.company>>

a| Internal company name of the file, provided at compile-time.

type: keyword



example: `Microsoft Corporation`

| extended

// ===============================================================

|
[[field-pe-description]]
<<field-pe-description, pe.description>>

a| Internal description of the file, provided at compile-time.

type: keyword



example: `Paint`

| extended

// ===============================================================

|
[[field-pe-file-version]]
<<field-pe-file-version, pe.file_version>>

a| Internal version of the file, provided at compile-time.

type: keyword



example: `6.3.9600.17415`

| extended

// ===============================================================

|
[[field-pe-go-import-hash]]
<<field-pe-go-import-hash, pe.go_import_hash>>

a| A hash of the Go language imports in a PE file excluding standard library imports. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

The algorithm used to calculate the Go symbol hash and a reference implementation are available [here](https://github.com/elastic/toutoumomoma).

type: keyword



example: `10bddcb4cee42080f76c88d9ff964491`

| extended

// ===============================================================

|
[[field-pe-go-imports]]
<<field-pe-go-imports, pe.go_imports>>

a| List of imported Go language element names and types.

type: flattened





| extended

// ===============================================================

|
[[field-pe-go-imports-names-entropy]]
<<field-pe-go-imports-names-entropy, pe.go_imports_names_entropy>>

a| Shannon entropy calculation from the list of Go imports.

type: long





| extended

// ===============================================================

|
[[field-pe-go-imports-names-var-entropy]]
<<field-pe-go-imports-names-var-entropy, pe.go_imports_names_var_entropy>>

a| Variance for Shannon entropy calculation from the list of Go imports.

type: long





| extended

// ===============================================================

|
[[field-pe-go-stripped]]
<<field-pe-go-stripped, pe.go_stripped>>

a| Set to true if the file is a Go executable that has had its symbols stripped or obfuscated and false if an unobfuscated Go executable.

type: boolean





| extended

// ===============================================================

|
[[field-pe-imphash]]
<<field-pe-imphash, pe.imphash>>

a| A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html.

type: keyword



example: `0c6803c4e922103c4dca5963aad36ddf`

| extended

// ===============================================================

|
[[field-pe-import-hash]]
<<field-pe-import-hash, pe.import_hash>>

a| A hash of the imports in a PE file. An import hash can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values.

This is a synonym for imphash.

type: keyword



example: `d41d8cd98f00b204e9800998ecf8427e`

| extended

// ===============================================================

|
[[field-pe-imports]]
<<field-pe-imports, pe.imports>>

a| List of imported element names and types.

type: flattened


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-pe-imports-names-entropy]]
<<field-pe-imports-names-entropy, pe.imports_names_entropy>>

a| Shannon entropy calculation from the list of imported element names and types.

type: long





| extended

// ===============================================================

|
[[field-pe-imports-names-var-entropy]]
<<field-pe-imports-names-var-entropy, pe.imports_names_var_entropy>>

a| Variance for Shannon entropy calculation from the list of imported element names and types.

type: long





| extended

// ===============================================================

|
[[field-pe-original-file-name]]
<<field-pe-original-file-name, pe.original_file_name>>

a| Internal name of the file, provided at compile-time.

type: keyword



example: `MSPAINT.EXE`

| extended

// ===============================================================

|
[[field-pe-pehash]]
<<field-pe-pehash, pe.pehash>>

a| A hash of the PE header and data from one or more PE sections. An pehash can be used to cluster files by transforming structural information about a file into a hash value.

Learn more at https://www.usenix.org/legacy/events/leet09/tech/full_papers/wicherski/wicherski_html/index.html.

type: keyword



example: `73ff189b63cd6be375a7ff25179a38d347651975`

| extended

// ===============================================================

|
[[field-pe-product]]
<<field-pe-product, pe.product>>

a| Internal product name of the file, provided at compile-time.

type: keyword



example: `Microsoft® Windows® Operating System`

| extended

// ===============================================================

|
[[field-pe-sections]]
<<field-pe-sections, pe.sections>>

a| An array containing an object for each section of the PE file.

The keys that should be present in these objects are defined by sub-fields underneath `pe.sections.*`.

type: nested


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-pe-sections-entropy]]
<<field-pe-sections-entropy, pe.sections.entropy>>

a| Shannon entropy calculation from the section.

type: long





| extended

// ===============================================================

|
[[field-pe-sections-name]]
<<field-pe-sections-name, pe.sections.name>>

a| PE Section List name.

type: keyword





| extended

// ===============================================================

|
[[field-pe-sections-physical-size]]
<<field-pe-sections-physical-size, pe.sections.physical_size>>

a| PE Section List physical size.

type: long





| extended

// ===============================================================

|
[[field-pe-sections-var-entropy]]
<<field-pe-sections-var-entropy, pe.sections.var_entropy>>

a| Variance for Shannon entropy calculation from the section.

type: long





| extended

// ===============================================================

|
[[field-pe-sections-virtual-size]]
<<field-pe-sections-virtual-size, pe.sections.virtual_size>>

a| PE Section List virtual size. This is always the same as `physical_size`.

type: long





| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `pe` fields are expected to be nested at:


* `dll.pe`

* `file.pe`

* `process.pe`


Note also that the `pe` fields are not expected to be used directly at the root of the events.
[[ecs-process]]
=== Process Fields

These fields contain information about a process.

These fields can help you correlate metrics information with a process id/name from a log message.  The `process.pid` often stays in the metric itself and is copied to the global field for correlation.

[discrete]
==== Process Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-process-args]]
<<field-process-args, process.args>>

a| Array of process arguments, starting with the absolute path to the executable.

May be filtered to protect sensitive information.

type: keyword


Note: this field should contain an array of values.



example: `["/usr/bin/ssh", "-l", "user", "10.0.0.16"]`

| extended

// ===============================================================

|
[[field-process-args-count]]
<<field-process-args-count, process.args_count>>

a| Length of the process.args array.

This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity.

type: long



example: `4`

| extended

// ===============================================================

|
[[field-process-command-line]]
<<field-process-command-line, process.command_line>>

a| Full command line that started the process, including the absolute path to the executable, and all arguments.

Some arguments may be filtered to protect sensitive information.

type: wildcard

Multi-fields:

* process.command_line.text (type: match_only_text)





example: `/usr/bin/ssh -l user 10.0.0.16`

| extended

// ===============================================================

|
[[field-process-end]]
<<field-process-end, process.end>>

a| The time the process ended.

type: date



example: `2016-05-23T08:05:34.853Z`

| extended

// ===============================================================

|
[[field-process-entity-id]]
<<field-process-entity-id, process.entity_id>>

a| Unique identifier for the process.

The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process.

Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts.

type: keyword



example: `c2c455d9f99375d`

| extended

// ===============================================================

|
[[field-process-entry-meta-type]]
<<field-process-entry-meta-type, process.entry_meta.type>>

a| The entry type for the entry session leader. Values include: init(e.g systemd), sshd, ssm, kubelet, teleport, terminal, console

Note: This field is only set on process.session_leader.

type: keyword





| extended

// ===============================================================

|
[[field-process-env-vars]]
<<field-process-env-vars, process.env_vars>>

a| beta:[ This field is beta and subject to change. ]

Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution.

May be filtered to protect sensitive information.

type: keyword


Note: this field should contain an array of values.



example: `["PATH=/usr/local/bin:/usr/bin", "USER=ubuntu"]`

| extended

// ===============================================================

|
[[field-process-executable]]
<<field-process-executable, process.executable>>

a| Absolute path to the process executable.

type: keyword

Multi-fields:

* process.executable.text (type: match_only_text)





example: `/usr/bin/ssh`

| extended

// ===============================================================

|
[[field-process-exit-code]]
<<field-process-exit-code, process.exit_code>>

a| The exit code of the process, if this is a termination event.

The field should be absent if there is no exit code for the event (e.g. process start).

type: long



example: `137`

| extended

// ===============================================================

|
[[field-process-interactive]]
<<field-process-interactive, process.interactive>>

a| Whether the process is connected to an interactive shell.

Process interactivity is inferred from the processes file descriptors. If the character device for the controlling tty is the same as stdin and stderr for the process, the process is considered interactive.

Note: A non-interactive process can belong to an interactive session and is simply one that does not have open file descriptors reading the controlling TTY on FD 0 (stdin) or writing to the controlling TTY on FD 2 (stderr). A backgrounded process is still considered interactive if stdin and stderr are connected to the controlling TTY.

type: boolean



example: `True`

| extended

// ===============================================================

|
[[field-process-io]]
<<field-process-io, process.io>>

a| beta:[ This field is beta and subject to change. ]

A chunk of input or output (IO) from a single process.

This field only appears on the top level process object, which is the process that wrote the output or read the input.

type: object





| extended

// ===============================================================

|
[[field-process-io-bytes-skipped]]
<<field-process-io-bytes-skipped, process.io.bytes_skipped>>

a| beta:[ This field is beta and subject to change. ]

An array of byte offsets and lengths denoting where IO data has been skipped.

type: object


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-process-io-bytes-skipped-length]]
<<field-process-io-bytes-skipped-length, process.io.bytes_skipped.length>>

a| beta:[ This field is beta and subject to change. ]

The length of bytes skipped.

type: long





| extended

// ===============================================================

|
[[field-process-io-bytes-skipped-offset]]
<<field-process-io-bytes-skipped-offset, process.io.bytes_skipped.offset>>

a| beta:[ This field is beta and subject to change. ]

The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped.

type: long





| extended

// ===============================================================

|
[[field-process-io-max-bytes-per-process-exceeded]]
<<field-process-io-max-bytes-per-process-exceeded, process.io.max_bytes_per_process_exceeded>>

a| beta:[ This field is beta and subject to change. ]

If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting.

type: boolean





| extended

// ===============================================================

|
[[field-process-io-text]]
<<field-process-io-text, process.io.text>>

a| beta:[ This field is beta and subject to change. ]

A chunk of output or input sanitized to UTF-8.

Best efforts are made to ensure complete lines are captured in these events. Assumptions should NOT be made that multiple lines will appear in the same event. TTY output may contain terminal control codes such as for cursor movement, so some string queries may not match due to terminal codes inserted between characters of a word.

type: wildcard





| extended

// ===============================================================

|
[[field-process-io-total-bytes-captured]]
<<field-process-io-total-bytes-captured, process.io.total_bytes_captured>>

a| beta:[ This field is beta and subject to change. ]

The total number of bytes captured in this event.

type: long





| extended

// ===============================================================

|
[[field-process-io-total-bytes-skipped]]
<<field-process-io-total-bytes-skipped, process.io.total_bytes_skipped>>

a| beta:[ This field is beta and subject to change. ]

The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure this value is always zero

type: long





| extended

// ===============================================================

|
[[field-process-io-type]]
<<field-process-io-type, process.io.type>>

a| beta:[ This field is beta and subject to change. ]

The type of object on which the IO action (read or write) was taken.

Currently only 'tty' is supported. Other types may be added in the future for 'file' and 'socket' support.

type: keyword





| extended

// ===============================================================

|
[[field-process-name]]
<<field-process-name, process.name>>

a| Process name.

Sometimes called program name or similar.

type: keyword

Multi-fields:

* process.name.text (type: match_only_text)





example: `ssh`

| extended

// ===============================================================

|
[[field-process-pgid]]
<<field-process-pgid, process.pgid>>

a| Deprecated for removal in next major version release. This field is superseded by `process.group_leader.pid`.

Identifier of the group of processes the process belongs to.

type: long





| extended

// ===============================================================

|
[[field-process-pid]]
<<field-process-pid, process.pid>>

a| Process id.

type: long



example: `4242`

| core

// ===============================================================

|
[[field-process-same-as-process]]
<<field-process-same-as-process, process.same_as_process>>

a| This boolean is used to identify if a leader process is the same as the top level process.

For example, if `process.group_leader.same_as_process = true`, it means the process event in question is the leader of its process group. Details under `process.*` like `pid` would be the same under `process.group_leader.*` The same applies for both `process.session_leader` and `process.entry_leader`.

This field exists to the benefit of EQL and other rule engines since it's not possible to compare equality between two fields in a single document. e.g `process.entity_id` = `process.group_leader.entity_id` (top level process is the process group leader) OR `process.entity_id` = `process.entry_leader.entity_id` (top level process is the entry session leader)

Instead these rules could be written like: `process.group_leader.same_as_process: true` OR `process.entry_leader.same_as_process: true`

Note: This field is only set on `process.entry_leader`, `process.session_leader` and `process.group_leader`.

type: boolean



example: `True`

| extended

// ===============================================================

|
[[field-process-start]]
<<field-process-start, process.start>>

a| The time the process started.

type: date



example: `2016-05-23T08:05:34.853Z`

| extended

// ===============================================================

|
[[field-process-thread-id]]
<<field-process-thread-id, process.thread.id>>

a| Thread ID.

type: long



example: `4242`

| extended

// ===============================================================

|
[[field-process-thread-name]]
<<field-process-thread-name, process.thread.name>>

a| Thread name.

type: keyword



example: `thread-0`

| extended

// ===============================================================

|
[[field-process-title]]
<<field-process-title, process.title>>

a| Process title.

The proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened.

type: keyword

Multi-fields:

* process.title.text (type: match_only_text)







| extended

// ===============================================================

|
[[field-process-tty]]
<<field-process-tty, process.tty>>

a| Information about the controlling TTY device. If set, the process belongs to an interactive session.

type: object





| extended

// ===============================================================

|
[[field-process-tty-char-device-major]]
<<field-process-tty-char-device-major, process.tty.char_device.major>>

a| The major number identifies the driver associated with the device. The character device's major and minor numbers can be algorithmically combined to produce the more familiar terminal identifiers such as "ttyS0" and "pts/0". For more details, please refer to the Linux kernel documentation.

type: long



example: `4`

| extended

// ===============================================================

|
[[field-process-tty-char-device-minor]]
<<field-process-tty-char-device-minor, process.tty.char_device.minor>>

a| The minor number is used only by the driver specified by the major number; other parts of the kernel don’t use it, and merely pass it along to the driver. It is common for a driver to control several devices; the minor number provides a way for the driver to differentiate among them.

type: long



example: `1`

| extended

// ===============================================================

|
[[field-process-tty-columns]]
<<field-process-tty-columns, process.tty.columns>>

a| beta:[ This field is beta and subject to change. ]

The number of character columns per line. e.g terminal width

Terminal sizes can change, so this value reflects the maximum value for a given IO event. i.e. where event.action = 'text_output'

type: long



example: `80`

| extended

// ===============================================================

|
[[field-process-tty-rows]]
<<field-process-tty-rows, process.tty.rows>>

a| beta:[ This field is beta and subject to change. ]

The number of character rows in the terminal. e.g terminal height

Terminal sizes can change, so this value reflects the maximum value for a given IO event. i.e. where event.action = 'text_output'

type: long



example: `24`

| extended

// ===============================================================

|
[[field-process-uptime]]
<<field-process-uptime, process.uptime>>

a| Seconds the process has been up.

type: long



example: `1325`

| extended

// ===============================================================

|
[[field-process-working-directory]]
<<field-process-working-directory, process.working_directory>>

a| The working directory of the process.

type: keyword

Multi-fields:

* process.working_directory.text (type: match_only_text)





example: `/home/alice`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `process` fields are expected to be nested at:


* `process.entry_leader`

* `process.entry_leader.parent`

* `process.entry_leader.parent.session_leader`

* `process.group_leader`

* `process.parent`

* `process.parent.group_leader`

* `process.previous`

* `process.session_leader`

* `process.session_leader.parent`

* `process.session_leader.parent.session_leader`


Note also that the `process` fields may be used directly at the root of the events.

[[ecs-process-nestings]]
[discrete]
===== Field sets that can be nested under Process

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `process.attested_groups.*`
| <<ecs-group,group>>| beta:[ Reusing the `group` fields in this location is currently considered beta.]

The externally attested groups based on an external source such as the Kube API.

Note: this reuse should contain an array of group field set objects.

// ===============================================================


| `process.attested_user.*`
| <<ecs-user,user>>| beta:[ Reusing the `user` fields in this location is currently considered beta.]

The externally attested user based on an external source such as the Kube API.

// ===============================================================


| `process.code_signature.*`
| <<ecs-code_signature,code_signature>>
| These fields contain information about binary code signatures.

// ===============================================================


| `process.elf.*`
| <<ecs-elf,elf>>| beta:[ This field reuse is beta and subject to change.]

These fields contain Linux Executable Linkable Format (ELF) metadata.

// ===============================================================


| `process.entry_leader.*`
| <<ecs-process,process>>
| First process from terminal or remote access via SSH, SSM, etc OR a service directly started by the init process.

// ===============================================================


| `process.entry_leader.parent.*`
| <<ecs-process,process>>
| Information about the entry leader's parent process. Only pid, start and entity_id fields are set.

// ===============================================================


| `process.entry_leader.parent.session_leader.*`
| <<ecs-process,process>>
| Information about the parent session of the entry leader. Only pid, start and entity_id fields are set.

// ===============================================================


| `process.entry_meta.source.*`
| <<ecs-source,source>>
| Remote client information such as ip, port and geo location.

// ===============================================================


| `process.group.*`
| <<ecs-group,group>>
| The effective group (egid).

// ===============================================================


| `process.group_leader.*`
| <<ecs-process,process>>
| Information about the process group leader. In some cases this may be the same as the top level process.

// ===============================================================


| `process.hash.*`
| <<ecs-hash,hash>>
| Hashes, usually file hashes.

// ===============================================================


| `process.macho.*`
| <<ecs-macho,macho>>| beta:[ This field reuse is beta and subject to change.]

These fields contain Mac OS Mach Object file format (Mach-O) metadata.

// ===============================================================


| `process.parent.*`
| <<ecs-process,process>>
| Information about the parent process.

// ===============================================================


| `process.parent.group_leader.*`
| <<ecs-process,process>>
| Information about the parent's process group leader. Only pid, start and entity_id fields are set.

// ===============================================================


| `process.pe.*`
| <<ecs-pe,pe>>
| These fields contain Windows Portable Executable (PE) metadata.

// ===============================================================


| `process.previous.*`
| <<ecs-process,process>>
| An array of previous executions for the process, including the initial fork. Only executable and args are set.

Note: this reuse should contain an array of process field set objects.

// ===============================================================


| `process.real_group.*`
| <<ecs-group,group>>
| The real group (rgid).

// ===============================================================


| `process.real_user.*`
| <<ecs-user,user>>
| The real user (ruid). Identifies the real owner of the process.

// ===============================================================


| `process.saved_group.*`
| <<ecs-group,group>>
| The saved group (sgid).

// ===============================================================


| `process.saved_user.*`
| <<ecs-user,user>>
| The saved user (suid).

// ===============================================================


| `process.session_leader.*`
| <<ecs-process,process>>
| Often the same as entry_leader. When it differs, it represents a session started within another session. e.g. using tmux

// ===============================================================


| `process.session_leader.parent.*`
| <<ecs-process,process>>
| Information about the session leader's parent process. Only pid, start and entity_id fields are set.

// ===============================================================


| `process.session_leader.parent.session_leader.*`
| <<ecs-process,process>>
| Information about the parent session of the session leader. Only pid, start and entity_id fields are set.

// ===============================================================


| `process.supplemental_groups.*`
| <<ecs-group,group>>
| An array of supplemental groups.

Note: this reuse should contain an array of group field set objects.

// ===============================================================


| `process.user.*`
| <<ecs-user,user>>
| The effective user (euid).

// ===============================================================


|=====


[[ecs-registry]]
=== Registry Fields

Fields related to Windows Registry operations.

[discrete]
==== Registry Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-registry-data-bytes]]
<<field-registry-data-bytes, registry.data.bytes>>

a| Original bytes written with base64 encoding.

For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by `lp_data`. This is optional but provides better recoverability and should be populated for REG_BINARY encoded values.

type: keyword



example: `ZQBuAC0AVQBTAAAAZQBuAAAAAAA=`

| extended

// ===============================================================

|
[[field-registry-data-strings]]
<<field-registry-data-strings, registry.data.strings>>

a| Content when writing string types.

Populated as an array when writing string data to the registry. For single string registry types (REG_SZ, REG_EXPAND_SZ), this should be an array with one string. For sequences of string with REG_MULTI_SZ, this array will be variable length. For numeric data, such as REG_DWORD and REG_QWORD, this should be populated with the decimal representation (e.g `"1"`).

type: wildcard


Note: this field should contain an array of values.



example: `["C:\rta\red_ttp\bin\myapp.exe"]`

| core

// ===============================================================

|
[[field-registry-data-type]]
<<field-registry-data-type, registry.data.type>>

a| Standard registry type for encoding contents

type: keyword



example: `REG_SZ`

| core

// ===============================================================

|
[[field-registry-hive]]
<<field-registry-hive, registry.hive>>

a| Abbreviated name for the hive.

type: keyword



example: `HKLM`

| core

// ===============================================================

|
[[field-registry-key]]
<<field-registry-key, registry.key>>

a| Hive-relative path of keys.

type: keyword



example: `SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe`

| core

// ===============================================================

|
[[field-registry-path]]
<<field-registry-path, registry.path>>

a| Full path, including hive, key and value

type: keyword



example: `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe\Debugger`

| core

// ===============================================================

|
[[field-registry-value]]
<<field-registry-value, registry.value>>

a| Name of the value written.

type: keyword



example: `Debugger`

| core

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `registry` fields are expected to be nested at:


* `threat.enrichments.indicator.registry`

* `threat.indicator.registry`


Note also that the `registry` fields may be used directly at the root of the events.


[[ecs-related]]
=== Related Fields

This field set is meant to facilitate pivoting around a piece of data.

Some pieces of information can be seen in many places in an ECS event. To facilitate searching for them, store an array of all seen values to their corresponding field in `related.`.

A concrete example is IP addresses, which can be under host, observer, source, destination, client, server, and network.forwarded_ip. If you append all IPs to `related.ip`, you can then search for a given IP trivially, no matter where it appeared, by querying `related.ip:192.0.2.15`.

[discrete]
==== Related Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-related-hash]]
<<field-related-hash, related.hash>>

a| All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search).

type: keyword


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-related-hosts]]
<<field-related-hosts, related.hosts>>

a| All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases.

type: keyword


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-related-ip]]
<<field-related-ip, related.ip>>

a| All of the IPs seen on your event.

type: ip


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-related-user]]
<<field-related-user, related.user>>

a| All the user names or other user identifiers seen on the event.

type: keyword


Note: this field should contain an array of values.





| extended

// ===============================================================

|=====


[[ecs-risk]]
=== Risk information Fields

Fields for describing risk score and risk level of entities such as hosts and users.  These fields are not allowed to be nested under `event.*`. Please continue to use  `event.risk_score` and `event.risk_score_norm` for event risk.

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== Risk information Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-risk-calculated-level]]
<<field-risk-calculated-level, risk.calculated_level>>

a| A risk classification level calculated by an internal system as part of entity analytics and entity risk scoring.

type: keyword



example: `High`

| extended

// ===============================================================

|
[[field-risk-calculated-score]]
<<field-risk-calculated-score, risk.calculated_score>>

a| A risk classification score calculated by an internal system as part of entity analytics and entity risk scoring.

type: float



example: `880.73`

| extended

// ===============================================================

|
[[field-risk-calculated-score-norm]]
<<field-risk-calculated-score-norm, risk.calculated_score_norm>>

a| A risk classification score calculated by an internal system as part of entity analytics and entity risk scoring, and normalized to a range of 0 to 100.

type: float



example: `88.73`

| extended

// ===============================================================

|
[[field-risk-static-level]]
<<field-risk-static-level, risk.static_level>>

a| A risk classification level obtained from outside the system, such as from some external Threat Intelligence Platform.

type: keyword



example: `High`

| extended

// ===============================================================

|
[[field-risk-static-score]]
<<field-risk-static-score, risk.static_score>>

a| A risk classification score obtained from outside the system, such as from some external Threat Intelligence Platform.

type: float



example: `830.0`

| extended

// ===============================================================

|
[[field-risk-static-score-norm]]
<<field-risk-static-score-norm, risk.static_score_norm>>

a| A risk classification score obtained from outside the system, such as from some external Threat Intelligence Platform, and normalized to a range of 0 to 100.

type: float



example: `83.0`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `risk` fields are expected to be nested at:


* `host.risk`

* `user.risk`


Note also that the `risk` fields are not expected to be used directly at the root of the events.
[[ecs-rule]]
=== Rule Fields

Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events.

Examples of data sources that would populate the rule fields include: network admission control platforms, network or host IDS/IPS, network firewalls, web application firewalls, url filters, endpoint detection and response (EDR) systems, etc.

[discrete]
==== Rule Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-rule-author]]
<<field-rule-author, rule.author>>

a| Name, organization, or pseudonym of the author or authors who created the rule used to generate this event.

type: keyword


Note: this field should contain an array of values.



example: `["Star-Lord"]`

| extended

// ===============================================================

|
[[field-rule-category]]
<<field-rule-category, rule.category>>

a| A categorization value keyword used by the entity using the rule for detection of this event.

type: keyword



example: `Attempted Information Leak`

| extended

// ===============================================================

|
[[field-rule-description]]
<<field-rule-description, rule.description>>

a| The description of the rule generating the event.

type: keyword



example: `Block requests to public DNS over HTTPS / TLS protocols`

| extended

// ===============================================================

|
[[field-rule-id]]
<<field-rule-id, rule.id>>

a| A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event.

type: keyword



example: `101`

| extended

// ===============================================================

|
[[field-rule-license]]
<<field-rule-license, rule.license>>

a| Name of the license under which the rule used to generate this event is made available.

type: keyword



example: `Apache 2.0`

| extended

// ===============================================================

|
[[field-rule-name]]
<<field-rule-name, rule.name>>

a| The name of the rule or signature generating the event.

type: keyword



example: `BLOCK_DNS_over_TLS`

| extended

// ===============================================================

|
[[field-rule-reference]]
<<field-rule-reference, rule.reference>>

a| Reference URL to additional information about the rule used to generate this event.

The URL can point to the vendor's documentation about the rule. If that's not available, it can also be a link to a more general page describing this type of alert.

type: keyword



example: `https://en.wikipedia.org/wiki/DNS_over_TLS`

| extended

// ===============================================================

|
[[field-rule-ruleset]]
<<field-rule-ruleset, rule.ruleset>>

a| Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member.

type: keyword



example: `Standard_Protocol_Filters`

| extended

// ===============================================================

|
[[field-rule-uuid]]
<<field-rule-uuid, rule.uuid>>

a| A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event.

type: keyword



example: `1100110011`

| extended

// ===============================================================

|
[[field-rule-version]]
<<field-rule-version, rule.version>>

a| The version / revision of the rule being used for analysis.

type: keyword



example: `1.1`

| extended

// ===============================================================

|=====


[[ecs-server]]
=== Server Fields

A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records.

For TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term "responder" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server 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.

[discrete]
==== Server Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-server-address]]
<<field-server-address, server.address>>

a| Some event server 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.

type: keyword





| extended

// ===============================================================

|
[[field-server-bytes]]
<<field-server-bytes, server.bytes>>

a| Bytes sent from the server to the client.

type: long



example: `184`

| core

// ===============================================================

|
[[field-server-domain]]
<<field-server-domain, server.domain>>

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

type: keyword



example: `foo.example.com`

| core

// ===============================================================

|
[[field-server-ip]]
<<field-server-ip, server.ip>>

a| IP address of the server (IPv4 or IPv6).

type: ip





| core

// ===============================================================

|
[[field-server-mac]]
<<field-server-mac, server.mac>>

a| MAC address of the server.

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.

type: keyword



example: `00-00-5E-00-53-23`

| core

// ===============================================================

|
[[field-server-nat-ip]]
<<field-server-nat-ip, server.nat.ip>>

a| Translated ip of destination based NAT sessions (e.g. internet to private DMZ)

Typically used with load balancers, firewalls, or routers.

type: ip





| extended

// ===============================================================

|
[[field-server-nat-port]]
<<field-server-nat-port, server.nat.port>>

a| Translated port of destination based NAT sessions (e.g. internet to private DMZ)

Typically used with load balancers, firewalls, or routers.

type: long





| extended

// ===============================================================

|
[[field-server-packets]]
<<field-server-packets, server.packets>>

a| Packets sent from the server to the client.

type: long



example: `12`

| core

// ===============================================================

|
[[field-server-port]]
<<field-server-port, server.port>>

a| Port of the server.

type: long





| core

// ===============================================================

|
[[field-server-registered-domain]]
<<field-server-registered-domain, server.registered_domain>>

a| The highest registered server 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".

type: keyword



example: `example.com`

| extended

// ===============================================================

|
[[field-server-subdomain]]
<<field-server-subdomain, server.subdomain>>

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

type: keyword



example: `east`

| extended

// ===============================================================

|
[[field-server-top-level-domain]]
<<field-server-top-level-domain, server.top_level_domain>>

a| 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".

type: keyword



example: `co.uk`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-server-nestings]]
[discrete]
===== Field sets that can be nested under Server

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `server.as.*`
| <<ecs-as,as>>
| Fields describing an Autonomous System (Internet routing prefix).

// ===============================================================


| `server.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `server.user.*`
| <<ecs-user,user>>
| Fields to describe the user relevant to the event.

// ===============================================================


|=====


[[ecs-service]]
=== Service Fields

The service fields describe the service for or from which the data was collected.

These fields help you find and correlate logs for a specific service and version.

[discrete]
==== Service Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-service-address]]
<<field-service-address, service.address>>

a| Address where data about this service was collected from.

This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).

type: keyword



example: `172.26.0.2:5432`

| extended

// ===============================================================

|
[[field-service-environment]]
<<field-service-environment, service.environment>>

a| beta:[ This field is beta and subject to change. ]

Identifies the environment where the service is running.

If the same service runs in different environments (production, staging, QA, development, etc.), the environment can identify other instances of the same service. Can also group services and applications from the same environment.

type: keyword



example: `production`

| extended

// ===============================================================

|
[[field-service-ephemeral-id]]
<<field-service-ephemeral-id, service.ephemeral_id>>

a| Ephemeral identifier of this service (if one exists).

This id normally changes across restarts, but `service.id` does not.

type: keyword



example: `8a4f500f`

| extended

// ===============================================================

|
[[field-service-id]]
<<field-service-id, service.id>>

a| Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes.

This id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event.

Note that if you need to see the events from one specific host of the service, you should filter on that `host.name` or `host.id` instead.

type: keyword



example: `d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6`

| core

// ===============================================================

|
[[field-service-name]]
<<field-service-name, service.name>>

a| Name of the service data is collected from.

The name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name.

In the case of Elasticsearch the `service.name` could contain the cluster name. For Beats the `service.name` is by default a copy of the `service.type` field if no name is specified.

type: keyword



example: `elasticsearch-metrics`

| core

// ===============================================================

|
[[field-service-node-name]]
<<field-service-node-name, service.node.name>>

a| Name of a service node.

This allows for two nodes of the same service running on the same host to be differentiated. Therefore, `service.node.name` should typically be unique across nodes of a given service.

In the case of Elasticsearch, the `service.node.name` could contain the unique node name within the Elasticsearch cluster. In cases where the service doesn't have the concept of a node name, the host name or container name can be used to distinguish running instances that make up this service. If those do not provide uniqueness (e.g. multiple instances of the service running on the same host) - the node name can be manually set.

type: keyword



example: `instance-0000000016`

| extended

// ===============================================================

|
[[field-service-node-role]]
<<field-service-node-role, service.node.role>>

a| Deprecated for removal in next major version release. This field will be superseded by `node.roles`.

Role of a service node.

This allows for distinction between different running roles of the same service.

In the case of Kibana, the `service.node.role` could be `ui` or `background_tasks`.

In the case of Elasticsearch, the `service.node.role` could be `master` or `data`.

Other services could use this to distinguish between a `web` and `worker` role running as part of the service.

type: keyword



example: `background_tasks`

| extended

// ===============================================================

|
[[field-service-node-roles]]
<<field-service-node-roles, service.node.roles>>

a| Roles of a service node.

This allows for distinction between different running roles of the same service.

In the case of Kibana, the `service.node.role` could be `ui` or `background_tasks` or both.

In the case of Elasticsearch, the `service.node.role` could be `master` or `data` or both.

Other services could use this to distinguish between a `web` and `worker` role running as part of the service.

type: keyword


Note: this field should contain an array of values.



example: `["ui", "background_tasks"]`

| extended

// ===============================================================

|
[[field-service-state]]
<<field-service-state, service.state>>

a| Current state of the service.

type: keyword





| core

// ===============================================================

|
[[field-service-type]]
<<field-service-type, service.type>>

a| The type of the service data is collected from.

The type can be used to group and correlate logs and metrics from one service type.

Example: If logs or metrics are collected from Elasticsearch, `service.type` would be `elasticsearch`.

type: keyword



example: `elasticsearch`

| core

// ===============================================================

|
[[field-service-version]]
<<field-service-version, service.version>>

a| Version of the service the data was collected from.

This allows to look at a data set only for a specific version of a service.

type: keyword



example: `3.2.4`

| core

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `service` fields are expected to be nested at:


* `service.origin`

* `service.target`


Note also that the `service` fields may be used directly at the root of the events.

[[ecs-service-nestings]]
[discrete]
===== Field sets that can be nested under Service

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `service.origin.*`
| <<ecs-service,service>>| beta:[ Reusing the `service` fields in this location is currently considered beta.]

Describes the origin service in case of an incoming request or event.

// ===============================================================


| `service.target.*`
| <<ecs-service,service>>| beta:[ Reusing the `service` fields in this location is currently considered beta.]

Describes the target service in case of an outgoing request or event.

// ===============================================================


|=====



[discrete]
==== Service Field Usage

For usage and examples of the service fields, please see the <<ecs-service-usage, Service Fields Usage and Examples>> section.

include::usage/service.asciidoc[]


[[ecs-source]]
=== Source Fields

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.

[discrete]
==== Source Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-source-address]]
<<field-source-address, source.address>>

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

type: keyword





| extended

// ===============================================================

|
[[field-source-bytes]]
<<field-source-bytes, source.bytes>>

a| Bytes sent from the source to the destination.

type: long



example: `184`

| core

// ===============================================================

|
[[field-source-domain]]
<<field-source-domain, source.domain>>

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

type: keyword



example: `foo.example.com`

| core

// ===============================================================

|
[[field-source-ip]]
<<field-source-ip, source.ip>>

a| IP address of the source (IPv4 or IPv6).

type: ip





| core

// ===============================================================

|
[[field-source-mac]]
<<field-source-mac, source.mac>>

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

type: keyword



example: `00-00-5E-00-53-23`

| core

// ===============================================================

|
[[field-source-nat-ip]]
<<field-source-nat-ip, source.nat.ip>>

a| Translated ip of source based NAT sessions (e.g. internal client to internet)

Typically connections traversing load balancers, firewalls, or routers.

type: ip





| extended

// ===============================================================

|
[[field-source-nat-port]]
<<field-source-nat-port, source.nat.port>>

a| Translated port of source based NAT sessions. (e.g. internal client to internet)

Typically used with load balancers, firewalls, or routers.

type: long





| extended

// ===============================================================

|
[[field-source-packets]]
<<field-source-packets, source.packets>>

a| Packets sent from the source to the destination.

type: long



example: `12`

| core

// ===============================================================

|
[[field-source-port]]
<<field-source-port, source.port>>

a| Port of the source.

type: long





| core

// ===============================================================

|
[[field-source-registered-domain]]
<<field-source-registered-domain, source.registered_domain>>

a| 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".

type: keyword



example: `example.com`

| extended

// ===============================================================

|
[[field-source-subdomain]]
<<field-source-subdomain, source.subdomain>>

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

type: keyword



example: `east`

| extended

// ===============================================================

|
[[field-source-top-level-domain]]
<<field-source-top-level-domain, source.top_level_domain>>

a| 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".

type: keyword



example: `co.uk`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `source` fields are expected to be nested at:


* `process.entry_meta.source`


Note also that the `source` fields may be used directly at the root of the events.

[[ecs-source-nestings]]
[discrete]
===== Field sets that can be nested under Source

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `source.as.*`
| <<ecs-as,as>>
| Fields describing an Autonomous System (Internet routing prefix).

// ===============================================================


| `source.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `source.user.*`
| <<ecs-user,user>>
| Fields to describe the user relevant to the event.

// ===============================================================


|=====


[[ecs-threat]]
=== Threat Fields

Fields to classify events and alerts according to a threat taxonomy such as the MITRE ATT&CK® framework.

These fields are for users to classify alerts from all of their sources (e.g. IDS, NGFW, etc.) within a common taxonomy. The threat.tactic.* fields are meant to capture the high level category of the threat (e.g. "impact"). The threat.technique.* fields are meant to capture which kind of approach is used by this detected threat, to accomplish the goal (e.g. "endpoint denial of service").

[discrete]
==== Threat Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-threat-enrichments]]
<<field-threat-enrichments, threat.enrichments>>

a| A list of associated indicators objects enriching the event, and the context of that association/enrichment.

type: nested


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-threat-enrichments-indicator]]
<<field-threat-enrichments-indicator, threat.enrichments.indicator>>

a| Object containing associated indicators enriching the event.

type: object





| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-confidence]]
<<field-threat-enrichments-indicator-confidence, threat.enrichments.indicator.confidence>>

a| Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields.

Expected values for this field:

* `Not Specified`
* `None`
* `Low`
* `Medium`
* `High`

type: keyword



example: `Medium`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-description]]
<<field-threat-enrichments-indicator-description, threat.enrichments.indicator.description>>

a| Describes the type of action conducted by the threat.

type: keyword



example: `IP x.x.x.x was observed delivering the Angler EK.`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-email-address]]
<<field-threat-enrichments-indicator-email-address, threat.enrichments.indicator.email.address>>

a| Identifies a threat indicator as an email address (irrespective of direction).

type: keyword



example: `phish@example.com`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-first-seen]]
<<field-threat-enrichments-indicator-first-seen, threat.enrichments.indicator.first_seen>>

a| The date and time when intelligence source first reported sighting this indicator.

type: date



example: `2020-11-05T17:25:47.000Z`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-ip]]
<<field-threat-enrichments-indicator-ip, threat.enrichments.indicator.ip>>

a| Identifies a threat indicator as an IP address (irrespective of direction).

type: ip



example: `1.2.3.4`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-last-seen]]
<<field-threat-enrichments-indicator-last-seen, threat.enrichments.indicator.last_seen>>

a| The date and time when intelligence source last reported sighting this indicator.

type: date



example: `2020-11-05T17:25:47.000Z`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-marking-tlp-version]]
<<field-threat-enrichments-indicator-marking-tlp-version, threat.enrichments.indicator.marking.tlp.version>>

a| Traffic Light Protocol version.

type: keyword



example: `2.0`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-modified-at]]
<<field-threat-enrichments-indicator-modified-at, threat.enrichments.indicator.modified_at>>

a| The date and time when intelligence source last modified information for this indicator.

type: date



example: `2020-11-05T17:25:47.000Z`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-port]]
<<field-threat-enrichments-indicator-port, threat.enrichments.indicator.port>>

a| Identifies a threat indicator as a port number (irrespective of direction).

type: long



example: `443`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-provider]]
<<field-threat-enrichments-indicator-provider, threat.enrichments.indicator.provider>>

a| The name of the indicator's provider.

type: keyword



example: `lrz_urlhaus`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-reference]]
<<field-threat-enrichments-indicator-reference, threat.enrichments.indicator.reference>>

a| Reference URL linking to additional information about this indicator.

type: keyword



example: `https://system.example.com/indicator/0001234`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-scanner-stats]]
<<field-threat-enrichments-indicator-scanner-stats, threat.enrichments.indicator.scanner_stats>>

a| Count of AV/EDR vendors that successfully detected malicious file or URL.

type: long



example: `4`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-sightings]]
<<field-threat-enrichments-indicator-sightings, threat.enrichments.indicator.sightings>>

a| Number of times this indicator was observed conducting threat activity.

type: long



example: `20`

| extended

// ===============================================================

|
[[field-threat-enrichments-indicator-type]]
<<field-threat-enrichments-indicator-type, threat.enrichments.indicator.type>>

a| Type of indicator as represented by Cyber Observable in STIX 2.0.

Expected values for this field:

* `autonomous-system`
* `artifact`
* `directory`
* `domain-name`
* `email-addr`
* `file`
* `ipv4-addr`
* `ipv6-addr`
* `mac-addr`
* `mutex`
* `port`
* `process`
* `software`
* `url`
* `user-account`
* `windows-registry-key`
* `x509-certificate`

type: keyword



example: `ipv4-addr`

| extended

// ===============================================================

|
[[field-threat-enrichments-matched-atomic]]
<<field-threat-enrichments-matched-atomic, threat.enrichments.matched.atomic>>

a| Identifies the atomic indicator value that matched a local environment endpoint or network event.

type: keyword



example: `bad-domain.com`

| extended

// ===============================================================

|
[[field-threat-enrichments-matched-field]]
<<field-threat-enrichments-matched-field, threat.enrichments.matched.field>>

a| Identifies the field of the atomic indicator that matched a local environment endpoint or network event.

type: keyword



example: `file.hash.sha256`

| extended

// ===============================================================

|
[[field-threat-enrichments-matched-id]]
<<field-threat-enrichments-matched-id, threat.enrichments.matched.id>>

a| Identifies the _id of the indicator document enriching the event.

type: keyword



example: `ff93aee5-86a1-4a61-b0e6-0cdc313d01b5`

| extended

// ===============================================================

|
[[field-threat-enrichments-matched-index]]
<<field-threat-enrichments-matched-index, threat.enrichments.matched.index>>

a| Identifies the _index of the indicator document enriching the event.

type: keyword



example: `filebeat-8.0.0-2021.05.23-000011`

| extended

// ===============================================================

|
[[field-threat-enrichments-matched-occurred]]
<<field-threat-enrichments-matched-occurred, threat.enrichments.matched.occurred>>

a| Indicates when the indicator match was generated

type: date



example: `2021-10-05T17:00:58.326Z`

| extended

// ===============================================================

|
[[field-threat-enrichments-matched-type]]
<<field-threat-enrichments-matched-type, threat.enrichments.matched.type>>

a| Identifies the type of match that caused the event to be enriched with the given indicator

type: keyword



example: `indicator_match_rule`

| extended

// ===============================================================

|
[[field-threat-feed-dashboard-id]]
<<field-threat-feed-dashboard-id, threat.feed.dashboard_id>>

a| The saved object ID of the dashboard belonging to the threat feed for displaying dashboard links to threat feeds in Kibana.

type: keyword



example: `5ba16340-72e6-11eb-a3e3-b3cc7c78a70f`

| extended

// ===============================================================

|
[[field-threat-feed-description]]
<<field-threat-feed-description, threat.feed.description>>

a| Description of the threat feed in a UI friendly format.

type: keyword



example: `Threat feed from the AlienVault Open Threat eXchange network.`

| extended

// ===============================================================

|
[[field-threat-feed-name]]
<<field-threat-feed-name, threat.feed.name>>

a| The name of the threat feed in UI friendly format.

type: keyword



example: `AlienVault OTX`

| extended

// ===============================================================

|
[[field-threat-feed-reference]]
<<field-threat-feed-reference, threat.feed.reference>>

a| Reference information for the threat feed in a UI friendly format.

type: keyword



example: `https://otx.alienvault.com`

| extended

// ===============================================================

|
[[field-threat-framework]]
<<field-threat-framework, threat.framework>>

a| Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events.

type: keyword



example: `MITRE ATT&CK`

| extended

// ===============================================================

|
[[field-threat-group-alias]]
<<field-threat-group-alias, threat.group.alias>>

a| The alias(es) of the group for a set of related intrusion activity that are tracked by a common name in the security community.

While not required, you can use a MITRE ATT&CK® group alias(es).

type: keyword


Note: this field should contain an array of values.



example: `[ "Magecart Group 6" ]`

| extended

// ===============================================================

|
[[field-threat-group-id]]
<<field-threat-group-id, threat.group.id>>

a| The id of the group for a set of related intrusion activity that are tracked by a common name in the security community.

While not required, you can use a MITRE ATT&CK® group id.

type: keyword



example: `G0037`

| extended

// ===============================================================

|
[[field-threat-group-name]]
<<field-threat-group-name, threat.group.name>>

a| The name of the group for a set of related intrusion activity that are tracked by a common name in the security community.

While not required, you can use a MITRE ATT&CK® group name.

type: keyword



example: `FIN6`

| extended

// ===============================================================

|
[[field-threat-group-reference]]
<<field-threat-group-reference, threat.group.reference>>

a| The reference URL of the group for a set of related intrusion activity that are tracked by a common name in the security community.

While not required, you can use a MITRE ATT&CK® group reference URL.

type: keyword



example: `https://attack.mitre.org/groups/G0037/`

| extended

// ===============================================================

|
[[field-threat-indicator-confidence]]
<<field-threat-indicator-confidence, threat.indicator.confidence>>

a| Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields.

Expected values for this field:

* `Not Specified`
* `None`
* `Low`
* `Medium`
* `High`

type: keyword



example: `Medium`

| extended

// ===============================================================

|
[[field-threat-indicator-description]]
<<field-threat-indicator-description, threat.indicator.description>>

a| Describes the type of action conducted by the threat.

type: keyword



example: `IP x.x.x.x was observed delivering the Angler EK.`

| extended

// ===============================================================

|
[[field-threat-indicator-email-address]]
<<field-threat-indicator-email-address, threat.indicator.email.address>>

a| Identifies a threat indicator as an email address (irrespective of direction).

type: keyword



example: `phish@example.com`

| extended

// ===============================================================

|
[[field-threat-indicator-first-seen]]
<<field-threat-indicator-first-seen, threat.indicator.first_seen>>

a| The date and time when intelligence source first reported sighting this indicator.

type: date



example: `2020-11-05T17:25:47.000Z`

| extended

// ===============================================================

|
[[field-threat-indicator-ip]]
<<field-threat-indicator-ip, threat.indicator.ip>>

a| Identifies a threat indicator as an IP address (irrespective of direction).

type: ip



example: `1.2.3.4`

| extended

// ===============================================================

|
[[field-threat-indicator-last-seen]]
<<field-threat-indicator-last-seen, threat.indicator.last_seen>>

a| The date and time when intelligence source last reported sighting this indicator.

type: date



example: `2020-11-05T17:25:47.000Z`

| extended

// ===============================================================

|
[[field-threat-indicator-marking-tlp]]
<<field-threat-indicator-marking-tlp, threat.indicator.marking.tlp>>

a| Traffic Light Protocol sharing markings.

Expected values for this field:

* `WHITE`
* `CLEAR`
* `GREEN`
* `AMBER`
* `AMBER+STRICT`
* `RED`

type: keyword



example: `CLEAR`

| extended

// ===============================================================

|
[[field-threat-indicator-modified-at]]
<<field-threat-indicator-modified-at, threat.indicator.modified_at>>

a| The date and time when intelligence source last modified information for this indicator.

type: date



example: `2020-11-05T17:25:47.000Z`

| extended

// ===============================================================

|
[[field-threat-indicator-port]]
<<field-threat-indicator-port, threat.indicator.port>>

a| Identifies a threat indicator as a port number (irrespective of direction).

type: long



example: `443`

| extended

// ===============================================================

|
[[field-threat-indicator-provider]]
<<field-threat-indicator-provider, threat.indicator.provider>>

a| The name of the indicator's provider.

type: keyword



example: `lrz_urlhaus`

| extended

// ===============================================================

|
[[field-threat-indicator-reference]]
<<field-threat-indicator-reference, threat.indicator.reference>>

a| Reference URL linking to additional information about this indicator.

type: keyword



example: `https://system.example.com/indicator/0001234`

| extended

// ===============================================================

|
[[field-threat-indicator-scanner-stats]]
<<field-threat-indicator-scanner-stats, threat.indicator.scanner_stats>>

a| Count of AV/EDR vendors that successfully detected malicious file or URL.

type: long



example: `4`

| extended

// ===============================================================

|
[[field-threat-indicator-sightings]]
<<field-threat-indicator-sightings, threat.indicator.sightings>>

a| Number of times this indicator was observed conducting threat activity.

type: long



example: `20`

| extended

// ===============================================================

|
[[field-threat-indicator-type]]
<<field-threat-indicator-type, threat.indicator.type>>

a| Type of indicator as represented by Cyber Observable in STIX 2.0.

Expected values for this field:

* `autonomous-system`
* `artifact`
* `directory`
* `domain-name`
* `email-addr`
* `file`
* `ipv4-addr`
* `ipv6-addr`
* `mac-addr`
* `mutex`
* `port`
* `process`
* `software`
* `url`
* `user-account`
* `windows-registry-key`
* `x509-certificate`

type: keyword



example: `ipv4-addr`

| extended

// ===============================================================

|
[[field-threat-software-alias]]
<<field-threat-software-alias, threat.software.alias>>

a| The alias(es) of the software for a set of related intrusion activity that are tracked by a common name in the security community.

While not required, you can use a MITRE ATT&CK® associated software description.

type: keyword


Note: this field should contain an array of values.



example: `[ "X-Agent" ]`

| extended

// ===============================================================

|
[[field-threat-software-id]]
<<field-threat-software-id, threat.software.id>>

a| The id of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®.

While not required, you can use a MITRE ATT&CK® software id.

type: keyword



example: `S0552`

| extended

// ===============================================================

|
[[field-threat-software-name]]
<<field-threat-software-name, threat.software.name>>

a| The name of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®.

While not required, you can use a MITRE ATT&CK® software name.

type: keyword



example: `AdFind`

| extended

// ===============================================================

|
[[field-threat-software-platforms]]
<<field-threat-software-platforms, threat.software.platforms>>

a| The platforms of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®.

While not required, you can use MITRE ATT&CK® software platform values.

Expected values for this field:

* `AWS`
* `Azure`
* `Azure AD`
* `GCP`
* `Linux`
* `macOS`
* `Network`
* `Office 365`
* `SaaS`
* `Windows`

type: keyword


Note: this field should contain an array of values.



example: `[ "Windows" ]`

| extended

// ===============================================================

|
[[field-threat-software-reference]]
<<field-threat-software-reference, threat.software.reference>>

a| The reference URL of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®.

While not required, you can use a MITRE ATT&CK® software reference URL.

type: keyword



example: `https://attack.mitre.org/software/S0552/`

| extended

// ===============================================================

|
[[field-threat-software-type]]
<<field-threat-software-type, threat.software.type>>

a| The type of software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®.

While not required, you can use a MITRE ATT&CK® software type.

Expected values for this field:

* `Malware`
* `Tool`

type: keyword



example: `Tool`

| extended

// ===============================================================

|
[[field-threat-tactic-id]]
<<field-threat-tactic-id, threat.tactic.id>>

a| The id of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ )

type: keyword


Note: this field should contain an array of values.



example: `TA0002`

| extended

// ===============================================================

|
[[field-threat-tactic-name]]
<<field-threat-tactic-name, threat.tactic.name>>

a| Name of the type of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/)

type: keyword


Note: this field should contain an array of values.



example: `Execution`

| extended

// ===============================================================

|
[[field-threat-tactic-reference]]
<<field-threat-tactic-reference, threat.tactic.reference>>

a| The reference url of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ )

type: keyword


Note: this field should contain an array of values.



example: `https://attack.mitre.org/tactics/TA0002/`

| extended

// ===============================================================

|
[[field-threat-technique-id]]
<<field-threat-technique-id, threat.technique.id>>

a| The id of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/)

type: keyword


Note: this field should contain an array of values.



example: `T1059`

| extended

// ===============================================================

|
[[field-threat-technique-name]]
<<field-threat-technique-name, threat.technique.name>>

a| The name of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/)

type: keyword

Multi-fields:

* threat.technique.name.text (type: match_only_text)




Note: this field should contain an array of values.



example: `Command and Scripting Interpreter`

| extended

// ===============================================================

|
[[field-threat-technique-reference]]
<<field-threat-technique-reference, threat.technique.reference>>

a| The reference url of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/)

type: keyword


Note: this field should contain an array of values.



example: `https://attack.mitre.org/techniques/T1059/`

| extended

// ===============================================================

|
[[field-threat-technique-subtechnique-id]]
<<field-threat-technique-subtechnique-id, threat.technique.subtechnique.id>>

a| The full id of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/)

type: keyword


Note: this field should contain an array of values.



example: `T1059.001`

| extended

// ===============================================================

|
[[field-threat-technique-subtechnique-name]]
<<field-threat-technique-subtechnique-name, threat.technique.subtechnique.name>>

a| The name of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/)

type: keyword

Multi-fields:

* threat.technique.subtechnique.name.text (type: match_only_text)




Note: this field should contain an array of values.



example: `PowerShell`

| extended

// ===============================================================

|
[[field-threat-technique-subtechnique-reference]]
<<field-threat-technique-subtechnique-reference, threat.technique.subtechnique.reference>>

a| The reference url of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/)

type: keyword


Note: this field should contain an array of values.



example: `https://attack.mitre.org/techniques/T1059/001/`

| extended

// ===============================================================

|
[[field-threat-threat-indicator-marking-tlp-version]]
<<field-threat-threat-indicator-marking-tlp-version, threat.threat.indicator.marking.tlp.version>>

a| Traffic Light Protocol version.

type: keyword



example: `2.0`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-threat-nestings]]
[discrete]
===== Field sets that can be nested under Threat

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `threat.enrichments.indicator.as.*`
| <<ecs-as,as>>
| Fields describing an Autonomous System (Internet routing prefix).

// ===============================================================


| `threat.enrichments.indicator.file.*`
| <<ecs-file,file>>
| Fields describing files.

// ===============================================================


| `threat.enrichments.indicator.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `threat.enrichments.indicator.registry.*`
| <<ecs-registry,registry>>
| Fields related to Windows Registry operations.

// ===============================================================


| `threat.enrichments.indicator.url.*`
| <<ecs-url,url>>
| Fields that let you store URLs in various forms.

// ===============================================================


| `threat.enrichments.indicator.x509.*`
| <<ecs-x509,x509>>
| These fields contain x509 certificate metadata.

// ===============================================================


| `threat.indicator.as.*`
| <<ecs-as,as>>
| Fields describing an Autonomous System (Internet routing prefix).

// ===============================================================


| `threat.indicator.file.*`
| <<ecs-file,file>>
| Fields describing files.

// ===============================================================


| `threat.indicator.geo.*`
| <<ecs-geo,geo>>
| Fields describing a location.

// ===============================================================


| `threat.indicator.registry.*`
| <<ecs-registry,registry>>
| Fields related to Windows Registry operations.

// ===============================================================


| `threat.indicator.url.*`
| <<ecs-url,url>>
| Fields that let you store URLs in various forms.

// ===============================================================


| `threat.indicator.x509.*`
| <<ecs-x509,x509>>
| These fields contain x509 certificate metadata.

// ===============================================================


|=====



[discrete]
==== Threat Field Usage

For usage and examples of the threat fields, please see the <<ecs-threat-usage, Threat Fields Usage and Examples>> section.

include::usage/threat.asciidoc[]


[[ecs-tls]]
=== TLS Fields

Fields related to a TLS connection. These fields focus on the TLS protocol itself and intentionally avoids in-depth analysis of the related x.509 certificate files.

[discrete]
==== TLS Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-tls-cipher]]
<<field-tls-cipher, tls.cipher>>

a| String indicating the cipher used during the current connection.

type: keyword



example: `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256`

| extended

// ===============================================================

|
[[field-tls-client-certificate]]
<<field-tls-client-certificate, tls.client.certificate>>

a| PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list.

type: keyword



example: `MII...`

| extended

// ===============================================================

|
[[field-tls-client-certificate-chain]]
<<field-tls-client-certificate-chain, tls.client.certificate_chain>>

a| Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain.

type: keyword


Note: this field should contain an array of values.



example: `["MII...", "MII..."]`

| extended

// ===============================================================

|
[[field-tls-client-hash-md5]]
<<field-tls-client-hash-md5, tls.client.hash.md5>>

a| Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.

type: keyword



example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC`

| extended

// ===============================================================

|
[[field-tls-client-hash-sha1]]
<<field-tls-client-hash-sha1, tls.client.hash.sha1>>

a| Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.

type: keyword



example: `9E393D93138888D288266C2D915214D1D1CCEB2A`

| extended

// ===============================================================

|
[[field-tls-client-hash-sha256]]
<<field-tls-client-hash-sha256, tls.client.hash.sha256>>

a| Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.

type: keyword



example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0`

| extended

// ===============================================================

|
[[field-tls-client-issuer]]
<<field-tls-client-issuer, tls.client.issuer>>

a| Distinguished name of subject of the issuer of the x.509 certificate presented by the client.

type: keyword



example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com`

| extended

// ===============================================================

|
[[field-tls-client-ja3]]
<<field-tls-client-ja3, tls.client.ja3>>

a| A hash that identifies clients based on how they perform an SSL/TLS handshake.

type: keyword



example: `d4e5b18d6b55c71272893221c96ba240`

| extended

// ===============================================================

|
[[field-tls-client-not-after]]
<<field-tls-client-not-after, tls.client.not_after>>

a| Date/Time indicating when client certificate is no longer considered valid.

type: date



example: `2021-01-01T00:00:00.000Z`

| extended

// ===============================================================

|
[[field-tls-client-not-before]]
<<field-tls-client-not-before, tls.client.not_before>>

a| Date/Time indicating when client certificate is first considered valid.

type: date



example: `1970-01-01T00:00:00.000Z`

| extended

// ===============================================================

|
[[field-tls-client-server-name]]
<<field-tls-client-server-name, tls.client.server_name>>

a| Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to `destination.domain`.

type: keyword



example: `www.elastic.co`

| extended

// ===============================================================

|
[[field-tls-client-subject]]
<<field-tls-client-subject, tls.client.subject>>

a| Distinguished name of subject of the x.509 certificate presented by the client.

type: keyword



example: `CN=myclient, OU=Documentation Team, DC=example, DC=com`

| extended

// ===============================================================

|
[[field-tls-client-supported-ciphers]]
<<field-tls-client-supported-ciphers, tls.client.supported_ciphers>>

a| Array of ciphers offered by the client during the client hello.

type: keyword


Note: this field should contain an array of values.



example: `["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "..."]`

| extended

// ===============================================================

|
[[field-tls-curve]]
<<field-tls-curve, tls.curve>>

a| String indicating the curve used for the given cipher, when applicable.

type: keyword



example: `secp256r1`

| extended

// ===============================================================

|
[[field-tls-established]]
<<field-tls-established, tls.established>>

a| Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel.

type: boolean





| extended

// ===============================================================

|
[[field-tls-next-protocol]]
<<field-tls-next-protocol, tls.next_protocol>>

a| String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case.

type: keyword



example: `http/1.1`

| extended

// ===============================================================

|
[[field-tls-resumed]]
<<field-tls-resumed, tls.resumed>>

a| Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation.

type: boolean





| extended

// ===============================================================

|
[[field-tls-server-certificate]]
<<field-tls-server-certificate, tls.server.certificate>>

a| PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list.

type: keyword



example: `MII...`

| extended

// ===============================================================

|
[[field-tls-server-certificate-chain]]
<<field-tls-server-certificate-chain, tls.server.certificate_chain>>

a| Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain.

type: keyword


Note: this field should contain an array of values.



example: `["MII...", "MII..."]`

| extended

// ===============================================================

|
[[field-tls-server-hash-md5]]
<<field-tls-server-hash-md5, tls.server.hash.md5>>

a| Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.

type: keyword



example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC`

| extended

// ===============================================================

|
[[field-tls-server-hash-sha1]]
<<field-tls-server-hash-sha1, tls.server.hash.sha1>>

a| Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.

type: keyword



example: `9E393D93138888D288266C2D915214D1D1CCEB2A`

| extended

// ===============================================================

|
[[field-tls-server-hash-sha256]]
<<field-tls-server-hash-sha256, tls.server.hash.sha256>>

a| Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.

type: keyword



example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0`

| extended

// ===============================================================

|
[[field-tls-server-issuer]]
<<field-tls-server-issuer, tls.server.issuer>>

a| Subject of the issuer of the x.509 certificate presented by the server.

type: keyword



example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com`

| extended

// ===============================================================

|
[[field-tls-server-ja3s]]
<<field-tls-server-ja3s, tls.server.ja3s>>

a| A hash that identifies servers based on how they perform an SSL/TLS handshake.

type: keyword



example: `394441ab65754e2207b1e1b457b3641d`

| extended

// ===============================================================

|
[[field-tls-server-not-after]]
<<field-tls-server-not-after, tls.server.not_after>>

a| Timestamp indicating when server certificate is no longer considered valid.

type: date



example: `2021-01-01T00:00:00.000Z`

| extended

// ===============================================================

|
[[field-tls-server-not-before]]
<<field-tls-server-not-before, tls.server.not_before>>

a| Timestamp indicating when server certificate is first considered valid.

type: date



example: `1970-01-01T00:00:00.000Z`

| extended

// ===============================================================

|
[[field-tls-server-subject]]
<<field-tls-server-subject, tls.server.subject>>

a| Subject of the x.509 certificate presented by the server.

type: keyword



example: `CN=www.example.com, OU=Infrastructure Team, DC=example, DC=com`

| extended

// ===============================================================

|
[[field-tls-version]]
<<field-tls-version, tls.version>>

a| Numeric part of the version parsed from the original string.

type: keyword



example: `1.2`

| extended

// ===============================================================

|
[[field-tls-version-protocol]]
<<field-tls-version-protocol, tls.version_protocol>>

a| Normalized lowercase protocol name parsed from original string.

type: keyword



example: `tls`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-tls-nestings]]
[discrete]
===== Field sets that can be nested under TLS

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `tls.client.x509.*`
| <<ecs-x509,x509>>
| These fields contain x509 certificate metadata.

// ===============================================================


| `tls.server.x509.*`
| <<ecs-x509,x509>>
| These fields contain x509 certificate metadata.

// ===============================================================


|=====


[[ecs-tracing]]
=== Tracing Fields

Distributed tracing makes it possible to analyze performance throughout a microservice architecture all in one view. This is accomplished by tracing all of the requests - from the initial web request in the front-end service - to queries made through multiple back-end services.

Unlike most field sets in ECS, the tracing fields are *not* nested under the field set name. In other words, the correct field name is `trace.id`, not `tracing.trace.id`, and so on.

[discrete]
==== Tracing Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-span-id]]
<<field-span-id, span.id>>

a| Unique identifier of the span within the scope of its trace.

A span represents an operation within a transaction, such as a request to another service, or a database query.

type: keyword



example: `3ff9a8981b7ccd5a`

| extended

// ===============================================================

|
[[field-trace-id]]
<<field-trace-id, trace.id>>

a| Unique identifier of the trace.

A trace groups multiple events like transactions that belong together. For example, a user request handled by multiple inter-connected services.

type: keyword



example: `4bf92f3577b34da6a3ce929d0e0e4736`

| extended

// ===============================================================

|
[[field-transaction-id]]
<<field-transaction-id, transaction.id>>

a| Unique identifier of the transaction within the scope of its trace.

A transaction is the highest level of work measured within a service, such as a request to a server.

type: keyword



example: `00f067aa0ba902b7`

| extended

// ===============================================================

|=====


[[ecs-url]]
=== URL Fields

URL fields provide support for complete or partial URLs, and supports the breaking down into scheme, domain, path, and so on.

[discrete]
==== URL Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-url-domain]]
<<field-url-domain, url.domain>>

a| Domain of the url, such as "www.elastic.co".

In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the `domain` field.

If the URL contains a literal IPv6 address enclosed by `[` and `]` (IETF RFC 2732), the `[` and `]` characters should also be captured in the `domain` field.

type: keyword



example: `www.elastic.co`

| extended

// ===============================================================

|
[[field-url-extension]]
<<field-url-extension, url.extension>>

a| The field contains the file extension from the original request url, excluding the leading dot.

The file extension is only set if it exists, as not every url has a file extension.

The leading period must not be included. For example, the value must be "png", not ".png".

Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz").

type: keyword



example: `png`

| extended

// ===============================================================

|
[[field-url-fragment]]
<<field-url-fragment, url.fragment>>

a| Portion of the url after the `#`, such as "top".

The `#` is not part of the fragment.

type: keyword





| extended

// ===============================================================

|
[[field-url-full]]
<<field-url-full, url.full>>

a| If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source.

type: wildcard

Multi-fields:

* url.full.text (type: match_only_text)





example: `https://www.elastic.co:443/search?q=elasticsearch#top`

| extended

// ===============================================================

|
[[field-url-original]]
<<field-url-original, url.original>>

a| Unmodified original url as seen in the event source.

Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path.

This field is meant to represent the URL as it was observed, complete or not.

type: wildcard

Multi-fields:

* url.original.text (type: match_only_text)





example: `https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=elasticsearch`

| extended

// ===============================================================

|
[[field-url-password]]
<<field-url-password, url.password>>

a| Password of the request.

type: keyword





| extended

// ===============================================================

|
[[field-url-path]]
<<field-url-path, url.path>>

a| Path of the request, such as "/search".

type: wildcard





| extended

// ===============================================================

|
[[field-url-port]]
<<field-url-port, url.port>>

a| Port of the request, such as 443.

type: long



example: `443`

| extended

// ===============================================================

|
[[field-url-query]]
<<field-url-query, url.query>>

a| The query field describes the query string of the request, such as "q=elasticsearch".

The `?` is excluded from the query string. If a URL contains no `?`, there is no query field. If there is a `?` but no query, the query field exists with an empty string. The `exists` query can be used to differentiate between the two cases.

type: keyword





| extended

// ===============================================================

|
[[field-url-registered-domain]]
<<field-url-registered-domain, url.registered_domain>>

a| The highest registered url 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".

type: keyword



example: `example.com`

| extended

// ===============================================================

|
[[field-url-scheme]]
<<field-url-scheme, url.scheme>>

a| Scheme of the request, such as "https".

Note: The `:` is not part of the scheme.

type: keyword



example: `https`

| extended

// ===============================================================

|
[[field-url-subdomain]]
<<field-url-subdomain, url.subdomain>>

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

type: keyword



example: `east`

| extended

// ===============================================================

|
[[field-url-top-level-domain]]
<<field-url-top-level-domain, url.top_level_domain>>

a| 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".

type: keyword



example: `co.uk`

| extended

// ===============================================================

|
[[field-url-username]]
<<field-url-username, url.username>>

a| Username of the request.

type: keyword





| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `url` fields are expected to be nested at:


* `threat.enrichments.indicator.url`

* `threat.indicator.url`


Note also that the `url` fields may be used directly at the root of the events.


[[ecs-user]]
=== User Fields

The user fields describe information about the user that is relevant to the event.

Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.

[discrete]
==== User Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-user-domain]]
<<field-user-domain, user.domain>>

a| Name of the directory the user is a member of.

For example, an LDAP or Active Directory domain name.

type: keyword





| extended

// ===============================================================

|
[[field-user-email]]
<<field-user-email, user.email>>

a| User email address.

type: keyword





| extended

// ===============================================================

|
[[field-user-full-name]]
<<field-user-full-name, user.full_name>>

a| User's full name, if available.

type: keyword

Multi-fields:

* user.full_name.text (type: match_only_text)





example: `Albert Einstein`

| extended

// ===============================================================

|
[[field-user-hash]]
<<field-user-hash, user.hash>>

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

type: keyword





| extended

// ===============================================================

|
[[field-user-id]]
<<field-user-id, user.id>>

a| Unique identifier of the user.

type: keyword



example: `S-1-5-21-202424912787-2692429404-2351956786-1000`

| core

// ===============================================================

|
[[field-user-name]]
<<field-user-name, user.name>>

a| Short name or login of the user.

type: keyword

Multi-fields:

* user.name.text (type: match_only_text)





example: `a.einstein`

| core

// ===============================================================

|
[[field-user-roles]]
<<field-user-roles, user.roles>>

a| Array of user roles at the time of the event.

type: keyword


Note: this field should contain an array of values.



example: `["kibana_admin", "reporting_user"]`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `user` fields are expected to be nested at:


* `client.user`

* `destination.user`

* `process.attested_user`

* `process.real_user`

* `process.saved_user`

* `process.user`

* `server.user`

* `source.user`

* `user.changes`

* `user.effective`

* `user.target`


Note also that the `user` fields may be used directly at the root of the events.

[[ecs-user-nestings]]
[discrete]
===== Field sets that can be nested under User

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `user.changes.*`
| <<ecs-user,user>>
| Captures changes made to a user.

// ===============================================================


| `user.effective.*`
| <<ecs-user,user>>
| User whose privileges were assumed.

// ===============================================================


| `user.group.*`
| <<ecs-group,group>>
| User's group relevant to the event.

// ===============================================================


| `user.risk.*`
| <<ecs-risk,risk>>
| Fields for describing risk score and level.

// ===============================================================


| `user.target.*`
| <<ecs-user,user>>
| Targeted user of action taken.

// ===============================================================


|=====



[discrete]
==== User Field Usage

For usage and examples of the user fields, please see the <<ecs-user-usage, User Fields Usage and Examples>> section.

include::usage/user.asciidoc[]


[[ecs-user_agent]]
=== User agent Fields

The user_agent fields normally come from a browser request.

They often show up in web service logs coming from the parsed user agent string.

[discrete]
==== User agent Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-user-agent-device-name]]
<<field-user-agent-device-name, user_agent.device.name>>

a| Name of the device.

type: keyword



example: `iPhone`

| extended

// ===============================================================

|
[[field-user-agent-name]]
<<field-user-agent-name, user_agent.name>>

a| Name of the user agent.

type: keyword



example: `Safari`

| extended

// ===============================================================

|
[[field-user-agent-original]]
<<field-user-agent-original, user_agent.original>>

a| Unparsed user_agent string.

type: keyword

Multi-fields:

* user_agent.original.text (type: match_only_text)





example: `Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1`

| extended

// ===============================================================

|
[[field-user-agent-version]]
<<field-user-agent-version, user_agent.version>>

a| Version of the user agent.

type: keyword



example: `12.0`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

[[ecs-user_agent-nestings]]
[discrete]
===== Field sets that can be nested under User agent

[options="header"]
|=====
| Location | Field Set | Description

// ===============================================================


| `user_agent.os.*`
| <<ecs-os,os>>
| OS fields contain information about the operating system.

// ===============================================================


|=====


[[ecs-vlan]]
=== VLAN Fields

The VLAN fields are used to identify 802.1q tag(s) of a packet, as well as ingress and egress VLAN associations of an observer in relation to a specific packet or connection.

Network.vlan fields are used to record a single VLAN tag, or the outer tag in the case of q-in-q encapsulations, for a packet or connection as observed, typically provided by a network sensor (e.g. Zeek, Wireshark) passively reporting on traffic.

Network.inner VLAN fields are used to report inner q-in-q 802.1q tags (multiple 802.1q encapsulations) as observed, typically provided by a network sensor  (e.g. Zeek, Wireshark) passively reporting on traffic. Network.inner VLAN fields should only be used in addition to network.vlan fields to indicate q-in-q tagging.

Observer.ingress and observer.egress VLAN values are used to record observer specific information when observer events contain discrete ingress and egress VLAN information, typically provided by firewalls, routers, or load balancers.

[discrete]
==== VLAN Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-vlan-id]]
<<field-vlan-id, vlan.id>>

a| VLAN ID as reported by the observer.

type: keyword



example: `10`

| extended

// ===============================================================

|
[[field-vlan-name]]
<<field-vlan-name, vlan.name>>

a| Optional VLAN name as reported by the observer.

type: keyword



example: `outside`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `vlan` fields are expected to be nested at:


* `network.inner.vlan`

* `network.vlan`

* `observer.egress.vlan`

* `observer.ingress.vlan`


Note also that the `vlan` fields are not expected to be used directly at the root of the events.
[[ecs-vulnerability]]
=== Vulnerability Fields

The vulnerability fields describe information about a vulnerability that is relevant to an event.

[discrete]
==== Vulnerability Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-vulnerability-category]]
<<field-vulnerability-category, vulnerability.category>>

a| The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm[Qualys vulnerability categories])

This field must be an array.

type: keyword


Note: this field should contain an array of values.



example: `["Firewall"]`

| extended

// ===============================================================

|
[[field-vulnerability-classification]]
<<field-vulnerability-classification, vulnerability.classification>>

a| The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/)

type: keyword



example: `CVSS`

| extended

// ===============================================================

|
[[field-vulnerability-description]]
<<field-vulnerability-description, vulnerability.description>>

a| The description of the vulnerability that provides additional context of the vulnerability. For example (https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created[Common Vulnerabilities and Exposure CVE description])

type: keyword

Multi-fields:

* vulnerability.description.text (type: match_only_text)





example: `In macOS before 2.12.6, there is a vulnerability in the RPC...`

| extended

// ===============================================================

|
[[field-vulnerability-enumeration]]
<<field-vulnerability-enumeration, vulnerability.enumeration>>

a| The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/)

type: keyword



example: `CVE`

| extended

// ===============================================================

|
[[field-vulnerability-id]]
<<field-vulnerability-id, vulnerability.id>>

a| The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (https://cve.mitre.org/about/faqs.html#what_is_cve_id)[Common Vulnerabilities and Exposure CVE ID]

type: keyword



example: `CVE-2019-00001`

| extended

// ===============================================================

|
[[field-vulnerability-reference]]
<<field-vulnerability-reference, vulnerability.reference>>

a| A resource that provides additional information, context, and mitigations for the identified vulnerability.

type: keyword



example: `https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111`

| extended

// ===============================================================

|
[[field-vulnerability-report-id]]
<<field-vulnerability-report-id, vulnerability.report_id>>

a| The report or scan identification number.

type: keyword



example: `20191018.0001`

| extended

// ===============================================================

|
[[field-vulnerability-scanner-vendor]]
<<field-vulnerability-scanner-vendor, vulnerability.scanner.vendor>>

a| The name of the vulnerability scanner vendor.

type: keyword



example: `Tenable`

| extended

// ===============================================================

|
[[field-vulnerability-score-base]]
<<field-vulnerability-score-base, vulnerability.score.base>>

a| Scores can range from 0.0 to 10.0, with 10.0 being the most severe.

Base scores cover an assessment for exploitability metrics (attack vector, complexity, privileges, and user interaction), impact metrics (confidentiality, integrity, and availability), and scope. For example (https://www.first.org/cvss/specification-document)

type: float



example: `5.5`

| extended

// ===============================================================

|
[[field-vulnerability-score-environmental]]
<<field-vulnerability-score-environmental, vulnerability.score.environmental>>

a| Scores can range from 0.0 to 10.0, with 10.0 being the most severe.

Environmental scores cover an assessment for any modified Base metrics, confidentiality, integrity, and availability requirements. For example (https://www.first.org/cvss/specification-document)

type: float



example: `5.5`

| extended

// ===============================================================

|
[[field-vulnerability-score-temporal]]
<<field-vulnerability-score-temporal, vulnerability.score.temporal>>

a| Scores can range from 0.0 to 10.0, with 10.0 being the most severe.

Temporal scores cover an assessment for code maturity, remediation level, and confidence. For example (https://www.first.org/cvss/specification-document)

type: float





| extended

// ===============================================================

|
[[field-vulnerability-score-version]]
<<field-vulnerability-score-version, vulnerability.score.version>>

a| The National Vulnerability Database (NVD) provides qualitative severity rankings of "Low", "Medium", and "High" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification.

CVSS is owned and managed by FIRST.Org, Inc. (FIRST), a US-based non-profit organization, whose mission is to help computer security incident response teams across the world. For example (https://nvd.nist.gov/vuln-metrics/cvss)

type: keyword



example: `2.0`

| extended

// ===============================================================

|
[[field-vulnerability-severity]]
<<field-vulnerability-severity, vulnerability.severity>>

a| The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss)

type: keyword



example: `Critical`

| extended

// ===============================================================

|=====


[[ecs-x509]]
=== x509 Certificate Fields

This implements the common core fields for x509 certificates. This information is likely logged with TLS sessions, digital signatures found in executable binaries, S/MIME information in email bodies, or analysis of files on disk.

When the certificate relates to a file, use the fields at `file.x509`. When hashes of the DER-encoded certificate are available, the `hash` data set should be populated as well (e.g. `file.hash.sha256`).

Events that contain certificate information about network connections, should use the x509 fields under the relevant TLS fields: `tls.server.x509` and/or `tls.client.x509`.

[discrete]
==== x509 Certificate Field Details

[options="header"]
|=====
| Field  | Description | Level

// ===============================================================

|
[[field-x509-alternative-names]]
<<field-x509-alternative-names, x509.alternative_names>>

a| List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses.

type: keyword


Note: this field should contain an array of values.



example: `*.elastic.co`

| extended

// ===============================================================

|
[[field-x509-issuer-common-name]]
<<field-x509-issuer-common-name, x509.issuer.common_name>>

a| List of common name (CN) of issuing certificate authority.

type: keyword


Note: this field should contain an array of values.



example: `Example SHA2 High Assurance Server CA`

| extended

// ===============================================================

|
[[field-x509-issuer-country]]
<<field-x509-issuer-country, x509.issuer.country>>

a| List of country \(C) codes

type: keyword


Note: this field should contain an array of values.



example: `US`

| extended

// ===============================================================

|
[[field-x509-issuer-distinguished-name]]
<<field-x509-issuer-distinguished-name, x509.issuer.distinguished_name>>

a| Distinguished name (DN) of issuing certificate authority.

type: keyword



example: `C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA`

| extended

// ===============================================================

|
[[field-x509-issuer-locality]]
<<field-x509-issuer-locality, x509.issuer.locality>>

a| List of locality names (L)

type: keyword


Note: this field should contain an array of values.



example: `Mountain View`

| extended

// ===============================================================

|
[[field-x509-issuer-organization]]
<<field-x509-issuer-organization, x509.issuer.organization>>

a| List of organizations (O) of issuing certificate authority.

type: keyword


Note: this field should contain an array of values.



example: `Example Inc`

| extended

// ===============================================================

|
[[field-x509-issuer-organizational-unit]]
<<field-x509-issuer-organizational-unit, x509.issuer.organizational_unit>>

a| List of organizational units (OU) of issuing certificate authority.

type: keyword


Note: this field should contain an array of values.



example: `www.example.com`

| extended

// ===============================================================

|
[[field-x509-issuer-state-or-province]]
<<field-x509-issuer-state-or-province, x509.issuer.state_or_province>>

a| List of state or province names (ST, S, or P)

type: keyword


Note: this field should contain an array of values.



example: `California`

| extended

// ===============================================================

|
[[field-x509-not-after]]
<<field-x509-not-after, x509.not_after>>

a| Time at which the certificate is no longer considered valid.

type: date



example: `2020-07-16T03:15:39Z`

| extended

// ===============================================================

|
[[field-x509-not-before]]
<<field-x509-not-before, x509.not_before>>

a| Time at which the certificate is first considered valid.

type: date



example: `2019-08-16T01:40:25Z`

| extended

// ===============================================================

|
[[field-x509-public-key-algorithm]]
<<field-x509-public-key-algorithm, x509.public_key_algorithm>>

a| Algorithm used to generate the public key.

type: keyword



example: `RSA`

| extended

// ===============================================================

|
[[field-x509-public-key-curve]]
<<field-x509-public-key-curve, x509.public_key_curve>>

a| The curve used by the elliptic curve public key algorithm. This is algorithm specific.

type: keyword



example: `nistp521`

| extended

// ===============================================================

|
[[field-x509-public-key-exponent]]
<<field-x509-public-key-exponent, x509.public_key_exponent>>

a| Exponent used to derive the public key. This is algorithm specific.

type: long



example: `65537`

| extended

// ===============================================================

|
[[field-x509-public-key-size]]
<<field-x509-public-key-size, x509.public_key_size>>

a| The size of the public key space in bits.

type: long



example: `2048`

| extended

// ===============================================================

|
[[field-x509-serial-number]]
<<field-x509-serial-number, x509.serial_number>>

a| Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters.

type: keyword



example: `55FBB9C7DEBF09809D12CCAA`

| extended

// ===============================================================

|
[[field-x509-signature-algorithm]]
<<field-x509-signature-algorithm, x509.signature_algorithm>>

a| Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353.

type: keyword



example: `SHA256-RSA`

| extended

// ===============================================================

|
[[field-x509-subject-common-name]]
<<field-x509-subject-common-name, x509.subject.common_name>>

a| List of common names (CN) of subject.

type: keyword


Note: this field should contain an array of values.



example: `shared.global.example.net`

| extended

// ===============================================================

|
[[field-x509-subject-country]]
<<field-x509-subject-country, x509.subject.country>>

a| List of country \(C) code

type: keyword


Note: this field should contain an array of values.



example: `US`

| extended

// ===============================================================

|
[[field-x509-subject-distinguished-name]]
<<field-x509-subject-distinguished-name, x509.subject.distinguished_name>>

a| Distinguished name (DN) of the certificate subject entity.

type: keyword



example: `C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net`

| extended

// ===============================================================

|
[[field-x509-subject-locality]]
<<field-x509-subject-locality, x509.subject.locality>>

a| List of locality names (L)

type: keyword


Note: this field should contain an array of values.



example: `San Francisco`

| extended

// ===============================================================

|
[[field-x509-subject-organization]]
<<field-x509-subject-organization, x509.subject.organization>>

a| List of organizations (O) of subject.

type: keyword


Note: this field should contain an array of values.



example: `Example, Inc.`

| extended

// ===============================================================

|
[[field-x509-subject-organizational-unit]]
<<field-x509-subject-organizational-unit, x509.subject.organizational_unit>>

a| List of organizational units (OU) of subject.

type: keyword


Note: this field should contain an array of values.





| extended

// ===============================================================

|
[[field-x509-subject-state-or-province]]
<<field-x509-subject-state-or-province, x509.subject.state_or_province>>

a| List of state or province names (ST, S, or P)

type: keyword


Note: this field should contain an array of values.



example: `California`

| extended

// ===============================================================

|
[[field-x509-version-number]]
<<field-x509-version-number, x509.version_number>>

a| Version of x509 format.

type: keyword



example: `3`

| extended

// ===============================================================

|=====

[discrete]
==== Field Reuse

The `x509` fields are expected to be nested at:


* `file.x509`

* `threat.enrichments.indicator.x509`

* `threat.indicator.x509`

* `tls.client.x509`

* `tls.server.x509`


Note also that the `x509` fields are not expected to be used directly at the root of the events.
