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 the api value to event.category #2147

Merged
merged 4 commits into from
Feb 1, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Thanks, you're awesome :-) -->

#### Added

* adding `api` option to `event.category` #2147

#### Improvements

#### Deprecated
Expand Down
2 changes: 1 addition & 1 deletion docs/fields/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3389,7 +3389,7 @@ Note: this field should contain an array of values.

*Important*: The field value must be one of the following:

authentication, configuration, database, driver, email, file, host, iam, intrusion_detection, malware, network, package, process, registry, session, threat, vulnerability, web
api, authentication, configuration, database, driver, email, file, host, iam, intrusion_detection, malware, network, package, process, registry, session, threat, vulnerability, web

To learn more about when to use which value, visit the page
<<ecs-allowed-values-event-category,allowed values for event.category>>
Expand Down
13 changes: 13 additions & 0 deletions docs/fields/field-values.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ This field is an array. This will allow proper categorization of some events tha

*Allowed Values*

* <<ecs-event-category-api,api>>
* <<ecs-event-category-authentication,authentication>>
* <<ecs-event-category-configuration,configuration>>
* <<ecs-event-category-database,database>>
Expand All @@ -151,6 +152,18 @@ This field is an array. This will allow proper categorization of some events tha
* <<ecs-event-category-vulnerability,vulnerability>>
* <<ecs-event-category-web,web>>

[float]
[[ecs-event-category-api]]
==== api

Events in this category correspond to API events propagated directly from the Operating System (Windows, Linux, etc.), from either the native API function or system call, or a managed source of events (such as ETW, syslog).


*Expected event types for category api:*

access, admin, allowed, denied, end, start, user


[float]
[[ecs-event-category-authentication]]
==== authentication
Expand Down
12 changes: 12 additions & 0 deletions experimental/generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2944,6 +2944,18 @@ event.agent_id_status:
type: keyword
event.category:
allowed_values:
- description: Events in this category correspond to API events propagated directly
from the Operating System (Windows, Linux, etc.), from either the native API
function or system call, or a managed source of events (such as ETW, syslog).
expected_event_types:
- access
- admin
- allowed
- denied
- end
- start
- user
name: api
- description: Events in this category are related to the challenge and response
process in which credentials are supplied and verified to allow the creation
of a session. Common sources for these logs are Windows event logs and ssh logs.
Expand Down
13 changes: 13 additions & 0 deletions experimental/generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3936,6 +3936,19 @@ event:
type: keyword
event.category:
allowed_values:
- description: Events in this category correspond to API events propagated directly
from the Operating System (Windows, Linux, etc.), from either the native
API function or system call, or a managed source of events (such as ETW,
syslog).
expected_event_types:
- access
- admin
- allowed
- denied
- end
- start
- user
name: api
- description: Events in this category are related to the challenge and response
process in which credentials are supplied and verified to allow the creation
of a session. Common sources for these logs are Windows event logs and ssh
Expand Down
12 changes: 12 additions & 0 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2875,6 +2875,18 @@ event.agent_id_status:
type: keyword
event.category:
allowed_values:
- description: Events in this category correspond to API events propagated directly
from the Operating System (Windows, Linux, etc.), from either the native API
function or system call, or a managed source of events (such as ETW, syslog).
expected_event_types:
- access
- admin
- allowed
- denied
- end
- start
- user
name: api
- description: Events in this category are related to the challenge and response
process in which credentials are supplied and verified to allow the creation
of a session. Common sources for these logs are Windows event logs and ssh logs.
Expand Down
13 changes: 13 additions & 0 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3856,6 +3856,19 @@ event:
type: keyword
event.category:
allowed_values:
- description: Events in this category correspond to API events propagated directly
from the Operating System (Windows, Linux, etc.), from either the native
API function or system call, or a managed source of events (such as ETW,
syslog).
expected_event_types:
- access
- admin
- allowed
- denied
- end
- start
- user
name: api
- description: Events in this category are related to the challenge and response
process in which credentials are supplied and verified to allow the creation
of a session. Common sources for these logs are Windows event logs and ssh
Expand Down
13 changes: 13 additions & 0 deletions schemas/event.yml
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,19 @@
normalize:
- array
allowed_values:
- name: api
description: >
Events in this category correspond to API events propagated directly
Copy link
Member

Choose a reason for hiding this comment

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

The event.category field values are designed to be fairly broad, and the term api encompasses a wide range: native, SOAP, RPC, Websocket, REST, etc.

I don't think we should limit its intended usage only to native/system API calls.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Understood, I'll rephrase

from the Operating System (Windows, Linux, etc.), from either the native
API function or system call, or a managed source of events (such as ETW, syslog).
expected_event_types:
Copy link
Member

Choose a reason for hiding this comment

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

Narrowing down this list of expected event.type values is tough. I could see adding others, but it's also far easier to add others later than remove.

Maybe info for APIs that are purely returning information and not taking action or making a state change?

And perhaps also creation/change/deletion for the creating and removing of a resource by way of an API call?

- access
- admin
- allowed
- denied
- end
- start
- user
- name: authentication
description: >
Events in this category are related to the challenge and response process
Expand Down