diff --git a/rfcs/text/0040-volume-device.md b/rfcs/text/0040-volume-device.md index ae0d01385..465bdf92e 100644 --- a/rfcs/text/0040-volume-device.md +++ b/rfcs/text/0040-volume-device.md @@ -1,8 +1,8 @@ # 0040: Volume device -- Stage: **0 (strawperson)** -- Date: **2023-06-09** +- Stage: **1 (draft)** +- Date: **2023-07-27** @@ -49,6 +44,133 @@ Stage X: Provide a brief explanation of why the proposal is being marked as aban +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: custom + 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: custom + 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: custom + 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: custom + 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: custom + 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: custom + 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: custom + 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: custom + type: keyword + description: > + Size of the volume device in bytes. +``` +These volume device fields can be used to describe some events and alerts associated with a volume device, which was proven to be [useful](https://www.elastic.co/security-labs/Hunting-for-Suspicious-Windows-Libraries-for-Execution-and-Evasion) 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. ## Source data @@ -67,6 +192,55 @@ The source of this data comes from monitoring a host, a Virtual Machine, or a k8 +```json +{ + "@timestamp": "2023-04-05T18:48:25.7435298Z", + "agent": { + "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", + "type": "endpoint", + "version": "8.8.0-SNAPSHOT" + }, + "data_stream": { + "dataset": "endpoint.events.volume_device", + "namespace": "default", + "type": "logs" + }, + "ecs": { + "version": "1.11.0" + }, + "elastic": { + "agent": { + "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" + } + }, + "event": { + "action": "attach", + "category": [ + "volume_device" + ], + "created": "2023-04-05T18:48:25.7435298Z", + "dataset": "endpoint.events.volume_device", + "id": "N0r0JIPXbQR6J+83++++++PP", + "kind": "event", + "module": "endpoint", + "outcome": "unknown", + "sequence": 1281, + "type": [ + "attach" + ] + }, + "message": "Endpoint volume device event", + "volume.bus_type": "FileBackedVirtual", + "volume.dos_name": "E:", + "volume.file_system_type": "UDF", + "volume.nt_name": "\\Device\\CdRom1", + "volume.product_name": "Virtual DVD-ROM", + "volume.vendor_name": "Msft", + "volume.serial_number": "12345", + "volume.volume_device_type": "CD-ROM File System", + "volume.size": 1000,000,000 +} +``` +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.