Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add boot_uid to device. #1335

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add boot_uid to device. #1335

wants to merge 2 commits into from

Conversation

hmadison
Copy link

@hmadison hmadison commented Feb 4, 2025

Related Issue: N/A

Description of changes:

On Linux systems, the procfs contains a unique per-boot identifier. Certain tools, such as EDR platforms or journald logs contain this identifier in their emitted telemetry. From an analytical perspective, it's useful to extract since it provides an analyst the ability to see activity from a given system across multiple reboots.

For more details see:
man 3 sd_id128_get_machine()

CHANGELOG.md Show resolved Hide resolved
On Linux systems, the procfs contains a unique per-boot identifier. Certain tools, such
as EDR platforms or journald logs contain this identifier in their emitted telemerty. From
an analytical perspective, it's useful to extract since it provides an analyst the ability
to see activity from a given system across multiple reboots.

For more details see:
`man 3 sd_id128_get_machine()`

Signed-off-by: Hunter Madison <[email protected]>
Copy link
Contributor

@mlmitch mlmitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff. We use boot identification in CPID calculation.

https://github.com/ocsf/common-process-id/blob/main/specification.md

@@ -130,6 +130,10 @@
"vendor_name": {
"description": "The vendor for the device. For example <code>Dell</code> or <code>Lenovo</code>.",
"requirement": "recommended"
},
"boot_uid": {
"description": "A unique identifier of the device that changes after every reboot. For example, the value of <code>/proc/sys/kernel/random/boot_id</code> from Linux's procfs.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to duplicate the description here because it is already defined in the dictionary.

@@ -401,6 +401,11 @@
"description": "The time when the system was booted.",
"type": "timestamp_t"
},
"boot_uid": {
"caption": "Boot UID",
"description": "A unique identifier of the device that changes after every reboot. For example, the value of <code>/proc/sys/kernel/random/boot_id</code> from Linux's procfs.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link/reference to kernel docs would be nice

https://docs.kernel.org/admin-guide/sysctl/kernel.html#random

},
"boot_uid": {
"requirement": "optional",
"references": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to add references in the dictionary itself


### Improved
* #### Objects
1. Added `boot_uid` to `device` objects.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: s/objects/object

Also for both the entries, add the PR number. No need to add a link, just the #number will suffice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v1.5.0 or later
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants