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

Improve device trust audit events when using Jamf sync #49147

Open
zmb3 opened this issue Nov 18, 2024 · 3 comments
Open

Improve device trust audit events when using Jamf sync #49147

zmb3 opened this issue Nov 18, 2024 · 3 comments
Labels
audit-log Issues related to Teleports Audit Log devicetrust feature-request Used for new features in Teleport, improvements to current should be #enhancements platform-security

Comments

@zmb3
Copy link
Collaborator

zmb3 commented Nov 18, 2024

When using Jamf to sync device inventory, the Device Updated audit events show up in the web UI as:

User [<LONG_GUID_HERE>.example.teleport.sh] has updated a device.

There are a few problems with this:

  • It says "user" but this is more of system activity than user activity
  • It's not clear what the UUID in the description refers to.
  • The event description doesn't mention Jamf at all.

Clicking the details to see the raw audit event shows something like this:

{
  "cluster_name": "exampe.teleport.sh",
  "code": "TV001I",
  "device": {
    "asset_tag": "ABC123XYZ",
    "device_id": "5523db18-e72a-46e5-a123-e8f33d19d006",
    "device_origin": 2,
    "os_type": 2
  },
  "ei": 0,
  "event": "device.create",
  "success": true,
  "time": "2024-11-18T17:51:44.256Z",
  "uid": "41b15373-ff84-4aaf-8b52-e29c5f13fe01",
  "user": "9af86a59-1fda-4350-af3c-4b98e4e837b7.example.teleport.sh",
  "user_kind": 1
}

If you're not an expert in Teleport's source code you probably don't know that "device_origin": 2 means Jamf, nor do you know what os_type and user_kind are referring to.

Consider marshaling these enums with descriptive strings rather than numbers, and improving the summary description that shows up in the web UI.

@zmb3 zmb3 added audit-log Issues related to Teleports Audit Log devicetrust feature-request Used for new features in Teleport, improvements to current should be #enhancements labels Nov 18, 2024
@zmb3
Copy link
Collaborator Author

zmb3 commented Nov 18, 2024

FYI @codingllama

@codingllama
Copy link
Contributor

Fair enough, this took me a while to figure out too (although I did suspect UUID.example.teleport.sh was a service user).

Suggestions:

  1. user: use "Jamf Service (UUID.example.teleport.sh)"
  2. user_kind: this is part UserMetadata and technically how Teleport sees system users. I'd rather not touch it only for this.
  3. device_origin and os_type: add device_origin_name and os_type_name fields with the human-friendly variants for those. (Best not to change the marshal format now.)

How does this sound?

@zmb3
Copy link
Collaborator Author

zmb3 commented Nov 18, 2024

Sounds good.

We could at least use the user_kind value to format the event description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
audit-log Issues related to Teleports Audit Log devicetrust feature-request Used for new features in Teleport, improvements to current should be #enhancements platform-security
Projects
None yet
Development

No branches or pull requests

2 participants