- Stage: 3 (finished)
- Date: 2023-12-12
This RFC propose adding the volume device fieldset to describe volume storage devices such as hard disks, removable USB, mountable virtual disks such as ISO.
- volume.mount_name
- volume.device_name
- volume.dos_name
- volume.nt_name
- volume.bus_type
- volume.writable
- volume.default_access
- volume.file_system_type
- volume.product_id
- volume.product_name
- volume.vendor_id
- volume.vendor_name
- volume.serial_number
- volume.device_type
- volume.size
- volume.removable
Details of the proposed fields:
---
- name: volume
title: Volume
group: 2
short: Fields relevant to storage volumes.
description: >
Fields that describe the storage volumes.
type: group
fields:
- name: mount_name
level: extended
type: keyword
description: >
Mount name of the volume device.
The field is relevant to Posix only.
- name: device_name
level: extended
type: keyword
description: >
Full path of the device.
The field is relevant to Posix only.
- name: dos_name
level: extended
type: keyword
short: DOS name of the device.
description: >
DOS name of the device.
DOS device name is in the format of uppercase driver letter followed by colon, such as C:, D:,...
The field is relevant to Windows only.
- name: nt_name
level: extended
type: keyword
short: NT name of the device.
description: >
NT name of the device.
NT device name is in the format such as:
\Device\HarddiskVolume2
The field is relevant to Windows only.
- name: bus_type
level: extended
type: keyword
short: Bus type of the device.
description: >
Bus type of the device, such as Nvme, Usb, FileBackedVirtual,... etc.
- name: writable
level: extended
type: boolean
description: >
This field indicates if the volume is writable.
- name: default_access
level: extended
type: keyword
short: Bus type of the device.
description: >
A string to describe the default access(es) of the volume.
- name: file_system_type
level: extended
type: keyword
short: Volume device file system type.
description: >
Volume device file system type.
Following are examples of the most frequently seen volume device file system types:
NTFS
UDF
- name: product_id
level: extended
type: keyword
short: ProductID of the device.
description: >
ProductID of the device. It is provided by the vendor of the device if any.
- name: product_name
level: extended
type: keyword
description: >
Product name of the volume device. It is provided by the vendor of the device.
- name: vendor_id
level: extended
type: keyword
short: VendorID of the device.
description: >
VendorID of the device. It is provided by the vendor of the device.
- name: vendor_name
level: extended
type: keyword
short: Vendor name of the device.
description: >
Vendor name of the volume device. It is provided by the vendor of the device.
- name: serial_number
level: extended
type: keyword
short: Serial Number of the device.
description: >
Serial Number of the device. It is provided by the vendor of the device if any.
- name: device_type
level: extended
type: keyword
short: Volume device type.
description: >
Volume device type.
Following are examples of the most frequently seen volume device types:
Disk File System
CD-ROM File System
- name: size
level: extended
type: long
description: >
Size of the volume device in bytes.
- name: removable
level: extended
type: boolean
description: >
This field indicates if the volume is removable.
These volume device fields can be used to describe some events and alerts associated with a volume device, which was proven to be useful for Elastic Defend.
These fields can also be used by the products and features to manage such devices based on their properties such as serial number and vendor name, etc.
The source of this data comes from monitoring a host, or a Virtual Machine.
{
"@timestamp":"2023-10-04T06:04:02.1449425Z",
"agent":
{
"id":"ada69fee-8801-4248-9ea5-acada41cef88",
"type":"endpoint",
"version":"8.10.0-SNAPSHOT"
},
"data_stream":
{
"dataset":"endpoint.events.volume_device",
"namespace":"default",
"type":"logs"
},
"ecs":
{
"version":"1.11.0"
},
"elastic":
{
"agent":
{
"id":"ada69fee-8801-4248-9ea5-acada41cef88"
}
},
"event":
{
"action":"mount",
"category": [
"volume_device"
],
"created":"2023-10-04T06:04:02.1449425Z",
"dataset":"endpoint.events.volume_device",
"id":"NFo+FezAt1+c7ZVs++++++Lm",
"kind":"event",
"module":"endpoint",
"outcome":"success",
"sequence":1656,
"type": [
"start"
]
},
"host":
{
"architecture":"x86_64",
"hostname":"win11-laptop",
"id":"01d52cf8-1917-4fab-8317-100076ab9aab",
"ip":
[
"192.168.2.3","127.0.0.1","::1"
],
"mac": [
"00-0a-9d-b2-55-61"
],
"name":"win11-laptop",
"os":
{
"Ext":
{
"variant":"Windows 11 Pro"
},
"family":"windows",
"full":"Windows 11 Pro 22H2 (10.0.22621.2134)",
"kernel":"22H2 (10.0.22621.2134)",
"name":"Windows",
"platform":"windows",
"type":"windows",
"version":"22H2 (10.0.22621.2134)"
}
},
"message":"Endpoint volume device event",
"process":
{
"Ext":
{
"code_signature": [
{
"exists":true,
"status":"trusted",
"subject_name":"Microsoft Windows",
"trusted":true
}
]
},
"code_signature":
{
"exists":true,
"status":"trusted",
"subject_name":"Microsoft Windows",
"trusted":true
},
"entity_id":"MDEwMTAxMDEtMDEwMS0wMTAxLTAxMDEtMDEwMTAxMDEwMTAxLTcwMDAtMTY5NjA4NDk2My40MjAxMDc1MDA=",
"executable":"C:\\Windows\\explorer.exe",
"name":"explorer.exe",
"pid":7000
},
"user":
{
"domain":"win11-laptop",
"id":"S-1-5-21-3464081356-168676461-1647206113-1001",
"name":"john doe"
},
"volume":
{
"bus_type":"FileBackedVirtual",
"device_type":"CD-ROM File System",
"dos_name":"E:",
"file_system_type":"UDF",
"nt_name":"\\Device\\CdRom1",
"product_name":"Virtual DVD-ROM",
"serial_number":"",
"vendor_name":"Msft",
"size": 1439744,
"removable": true,
"writable": false
}
}{
"@timestamp": "2023-10-03T09:11:44.7139082Z",
"agent": {
"id": "01010101-0101-0101-0101-010101010101",
"type": "endpoint",
"version": "8.11.0-SNAPSHOT"
},
"data_stream": {
"dataset": "endpoint.events.volume_device",
"namespace": "default",
"type": "logs"
},
"ecs": {
"version": "1.11.0"
},
"elastic": {
"agent": {
"id": "01010101-0101-0101-0101-010101010101"
}
},
"event": {
"action": "mount",
"category": [
"volume_device"
],
"created": "2023-10-03T09:11:44.7139082Z",
"dataset": "endpoint.events.volume_device",
"id": "NFjOC63JOYrK5sD+++++++hN",
"kind": "event",
"module": "endpoint",
"outcome": "success",
"sequence": 1859,
"type": [
"start"
]
},
"host": {
"architecture": "x86_64",
"hostname": "ec2amaz-9c327o5",
"id": "00000000-0000-0000-0000-000000000000",
"ip": [
"172.31.0.74",
"fe80::be8c:c386:ee1d:7361",
"127.0.0.1",
"::1"
],
"mac": [
"02-86-18-1a-ff-5b"
],
"name": "ec2amaz-9c327o5",
"os": {
"Ext": {
"variant": "Windows Server 2022 Datacenter"
},
"family": "windows",
"full": "Windows Server 2022 Datacenter 21H2 (10.0.20348.1970)",
"kernel": "21H2 (10.0.20348.1970)",
"name": "Windows",
"platform": "windows",
"type": "windows",
"version": "21H2 (10.0.20348.1970)"
}
},
"message": "Endpoint volume device event",
"process": {
"Ext": {
"ancestry": [
"MDEwMTAxMDEtMDEwMS0wMTAxLTAxMDEtMDEwMTAxMDEwMTAxLTg4MC0xNjk2MzIwNDUzLjgxMjk5NTEwMA==",
"MDEwMTAxMDEtMDEwMS0wMTAxLTAxMDEtMDEwMTAxMDEwMTAxLTc3Mi0xNjk2MzIwNDUyLjc3NjA4MTUwMA==",
"MDEwMTAxMDEtMDEwMS0wMTAxLTAxMDEtMDEwMTAxMDEwMTAxLTY2MC0xNjk2MzIwNDUyLjUwMDIxMzQwMA=="
],
"code_signature": [
{
"exists": true,
"status": "trusted",
"subject_name": "Microsoft Windows",
"trusted": true
}
]
},
"code_signature": {
"exists": true,
"status": "trusted",
"subject_name": "Microsoft Windows",
"trusted": true
},
"entity_id": "MDEwMTAxMDEtMDEwMS0wMTAxLTAxMDEtMDEwMTAxMDEwMTAxLTU5NTItMTY5NjMyNDMwMS44NjM1NzI0MDA=",
"executable": "C:\\Windows\\System32\\dllhost.exe",
"name": "dllhost.exe",
"pid": 5952
},
"user": {
"domain": "EC2AMAZ-9C327O5",
"id": "S-1-5-21-1707753557-122306462-275618382-500",
"name": "Administrator"
},
"volume": {
"bus_type": "Ssa",
"device_type": "CD-ROM File System",
"dos_name": "D:",
"file_system_type": "UDF",
"nt_name": "\\Device\\CdRom1",
"product_name": "Virtual DVD-ROM",
"size": 1511424,
"serial_number": "",
"vendor_name": "Msft",
"removable": true,
"writable": false
}
}
As this RFC involves the creation of an entirely new fieldset, no breaking changes are envisaged. Some existing tooling might need updates to factor in the new fieldset's availability, however.
Implementing volume device related functions usually will be relying on low level operating system support. Due to the multitudes of operating system kernels we want to support and the potential stability,compatibility issues, the complexity level of the solution could increase. Therefore we'll adopt a staged approach to implement it.
The following are the people that consulted on the contents of this RFC.
- @Trinity2019 | author, sponsor
- @ricardoungureanu | reviewer
- @stanek-michal | reviewer
- @intxgo | reviewer