diff --git a/rfcs/text/0033-host-fields.md b/rfcs/text/0033-host-fields.md new file mode 100644 index 0000000000..30dcf6459f --- /dev/null +++ b/rfcs/text/0033-host-fields.md @@ -0,0 +1,312 @@ +# 0000: Host Fields + + +- Stage: **0 (strawperson)** +- Date: **8-12-2022** + + + + + The host fields describe information about the host that is relevant to an event and extends the ECS host field set in several ways: + +- The host field set supports additional host bios fields. +- The host field set supports additional host cpu fields. +- The host field set supports additional fields describing a supplemental details that the host can generate. + + + +## Fields +
Definitions +

+ + +Field Name | Special Instructions | Justification/Use Case +| :--: | :-- | :-- | +| memory | The numeric value is a base value for memory. The two character unit type represents a multiplication factor to determine actual memory.

Normalize to byte value by multiplying base value by unit type as follows
Unit Multiplication Factor
B (2^0) 1
KB (2^10) 1024
MB (2^20) 1,048,576
GB (2^30) 1,073,741,824
TB (2^40) 1,099,511,627,776
| Detects specific baselines of physical configuration for asset management. +| last_logon.time | N/A | Login time tells the last time a user logged into the system, which may provide insights into events occurring on that system.| +| created | N/A | Indicates that device is known to domain.| +| distinguished_name | N/A | The distinguished name indicates ownership of the host. It uniquely identifies the host in an x509 certificate.| +| modified | N/A | Indicates when information has changed for the host in a directory service.| +| bios.manufacturer | Normalization: lower case | This is a string representing the system manufacturer of the host. Useful for supply chain issue detection.| +| bios.release_date | This date will need to be converted to a ECS date format. | The bios release date. Useful for supply chain issue detection.| +| bios.secure_boot_enabled | If disabled set to false; if enabled set to true. | Used to detect misconfiguration in Secure Boot.| +| bios.uuid | N/A | A unique identifier assigned to the computer mother board.| +| bios.version | N/A | Version of the BIOS, this string is created by the BIOS manufacturer. Useful for supply chain issue detection.| +| cpu.architecture | Normalize these entries to the following format:
:
"x64: x64-based PC"
"x64: x86_64"
"x32: x86-based PC" | Detects out of date CPUs.| +| cpu.core.count | N/A | Detects specific baselines of physical configuration for asset management.| +| cpu.count | N/A | Detects specific baselines of physical configuration for asset management.| +| cpu.logical_processor.count | N/A | Detects specific baselines of physical configuration for asset management.| +| cpu.manufacturer | Note that a manufacturer is displayed for each CPU, select the first. Multiple manufacturers are not expected. | Useful for supply chain issue detection.| +| cpu.name | Normalize raw field into lowercase format for easier query | Useful for supply chain issue detection.| +| cpu.speed | Normalize to GHZ, do not round but use 0.28 etc, where required.| Detects specific baselines of physical configuration for asset management.| +

+
+ + - name: memory + level: custom + type: unsigned long + example: 17,179,869,184 + description: > + Physical memory of the host machine in bytes. + + - name: last_logon.time + level: custom + type: date + description: > + The time of the last user logon to the host. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. + + - name: created + level: custom + type: date + description: > + Date and time of when the device was registered in the domain. + + - name: distinguished_name + level: custom + type: keyword + example: CN=foo, CN=computers, DC=acme, DC=company, DC=edu + normalized: array + description: > + Distinguished name of the host. + + - name: modified + level: custom + type: date + description: > + Date the host's details were last modified. + + - name: bios.manufacturer + level: custom + type: keyword + example: dell inc. + description: > + This is a string representing the system manufacturer of the host. + + - name: bios.release_date + level: custom + type: date + description: > + The bios release date. + + - name: bios.secure_boot_enabled + level: custom + type: boolean + description: > + Indicator that Secure Boot is enabled on the computer. + + - name: bios.uuid + level: custom + type: keyword + example: 4C4C4544-0056-5010-805A-CAC04F475132 + description: > + A unique identifier assigned to the computer mother board. + + - name: bios.version + level: custom + type: keyword + example: 1.6.13 + description: > + Version of the BIOS. This string is created by the BIOS manufacturer. + + - name: cpu.architecture + level: custom + type: keyword + example: "x64: x86_64" + description: > + The CPU architecture and raw string of the CPU provided by the OS. + + - name: cpu.core.count + level: custom + type: integer + example: 10 + description: > + Number of physical cores per CPU on host machine. + + - name: cpu.count + level: custom + type: integer + example: 2 + description: > + Number of CPUs on host machine. + + - name: cpu.logical_processor.count + level: custom + type: integer + example: 40 + description: > + Number of logical processors per CPU on host machine (physical cores multiplied by threads per core). + + - name: cpu.manufacturer + level: custom + type: keyword + example: Intel + description: > + Manufacturer of CPU. + + - name: cpu.name + level: custom + type: keyword + example: intel(r) core(tm) i3-2370m cpu + description: > + The full name of the cpu model. + + - name: cpu.speed + level: custom + type: float + example: 2.21 + description: > + Float type defining the speed of the CPU in GHZ with null and blank values stored as -1.0 and -2.0 respectively. + + + +## Usage + + + ### `memory` + Detects specific baselines of physical configuration for asset management. + + ### `last_logon.time` + Login time tells the last time a user logged into the system, which may provide insights into events occurring on that system. + + ### `created` + Indicates that device is known to domain. + + ### `distinguished_name` + The distinguished name indicates ownership of the host. It uniquely identifies the host in an x509 certificate. + + ### `modified` + Indicates when information has changed for the host in a directory service. + + ### `bios.manufacturer` + This is a string representing the system manufacturer of the host. Useful for supply chain issue detection. + + ### `bios.release_date` + The bios release date. Useful for supply chain issue detection. + + ### `bios.secure_boot_enabled` + Used to detect misconfiguration in Secure Boot. + + ### `bios.uuid` + A unique identifier assigned to the computer mother board. + + ### `bios.version` + Version of the BIOS, this string is created by the BIOS manufacturer. Useful for supply chain issue detection. + + ### `cpu.architecture` + Detects out of date CPUs. + + ### `cpu.core.count`, `cpu.count`, `cpu.logical_processor.count` + Detects specific baselines of physical configuration for asset management. + + ### `cpu.manufacturer`, `cpu.name` + Useful for supply chain issue detection. + + ### `cpu.speed` + Detects specific baselines of physical configuration for asset management. + +## Source data + + +The host fields in this RFC are sourced from the following data feeds: + - Endpoint Detection and Response System Audit Logs & Alerts + - Office 365 Device Audit Logs + - Active Directory Computer Objects + - Windows Event Logs + + + Host & Network Interface Information collects information about host computer configurations, vulnerabilities and compliance from endpoint computers. + + Azure Active Directory (Azure AD) tracks user activity and creates reports that help you understand how your users access and use Azure AD services. The Microsoft Graph API for Azure AD provides a means to access data in the activity reports. + + Active Directory (AD) stores information about objects on the network and makes this information available for administrators and users. AD uses a structured data store as the basis for a logical, hierarchical organization of directory information. This data store, also known as the directory, contains information about AD objects. These objects typically include shared resources such as Users, Computers, Groups, Organizational Units, etc. + + Host Information collects configuration and compliance data from endpoint computers. + + + + + + +## Scope of impact + + + * Ingestion mechanisms + - Custom + * Usage mechanisms (e.g. Kibana applications, detections) + - Kibana + - Custom applications + +## Concerns + + +The term manufacturer is used here while in Elastic Common Schema the appropriate equivalent could be viewed as vendor which may lead to confusion. + + + + +## People + +The following are the people that consulted on the contents of this RFC. + +* @donneesdata | Author, Sponsor + + + + +## References + + + +### RFC Pull Requests + + + +* Stage 0: https://github.com/elastic/ecs/pull/NNN + +