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 Event family meta schema keyword and Discovery classes #1260

Closed
wants to merge 19 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
a76f087
Removed the constraint from group_managenment.
pagbabian-splunk Oct 4, 2024
cbe6ff6
Merge branch 'main' of https://github.com/ocsf/ocsf-schema into main
pagbabian-splunk Oct 8, 2024
d15e704
Merge branch 'main' of https://github.com/ocsf/ocsf-schema into main
pagbabian-splunk Oct 16, 2024
294a294
Merge branch 'main' of https://github.com/ocsf/ocsf-schema into main
pagbabian-splunk Oct 29, 2024
f2b1d72
Merge branch 'main' of https://github.com/ocsf/ocsf-schema into main
pagbabian-splunk Oct 30, 2024
7103620
Merge branch 'main' of https://github.com/ocsf/ocsf-schema into main
pagbabian-splunk Nov 4, 2024
b197e14
Merge branch 'main' of https://github.com/ocsf/ocsf-schema into main
pagbabian-splunk Nov 20, 2024
5b68b7f
Deprecated the email_url_activity and email_file_activity classes in …
pagbabian-splunk Nov 20, 2024
df7fc18
Added changed for PR #1259
pagbabian-splunk Nov 20, 2024
e69358f
removed the optional tag for email_uid as it was causing the validati…
pagbabian-splunk Nov 20, 2024
8f2ac70
Relaxed the requirement of 'from' and 'to' to be recommended, and add…
pagbabian-splunk Nov 20, 2024
4e17230
Added the constraint and relaxed requirement to the email object.
pagbabian-splunk Nov 20, 2024
9b63ed2
Added a 'family' meta schema keyword for grouping of classes in a cat…
pagbabian-splunk Nov 20, 2024
6932791
Reverted files from the email_update branch that were incorrectly added.
pagbabian-splunk Nov 21, 2024
335dd6d
Removed file from branch erroneously included in the commit.
pagbabian-splunk Nov 21, 2024
a776eb4
Merge branch 'main' into event_family
pagbabian-splunk Dec 17, 2024
a37091b
Merge branch 'main' into event_family
floydtree Jan 21, 2025
f9bea66
Merge branch 'main' into event_family
pagbabian-splunk Jan 22, 2025
49ddbf4
Merge branch 'main' into event_family
pagbabian-splunk Jan 24, 2025
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
1 change: 1 addition & 0 deletions events/discovery/admin_group_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Admin Group Query events report information about administrative groups.",
"extends": "discovery_result",
"name": "admin_group_query",
"family": "Query",
"attributes": {
"group": {
"description": "The administrative group.",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/cloud_resources_inventory_info.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Cloud Resources Inventory Info events report cloud asset inventory data that is either logged or proactively collected. For example, use this event class when creating an inventory of cloud resource information from a Configuration Management Database (CMDB), Cyber Asset Attack Surface Management (CAASM), direct public cloud service provider APIs, Software-as-a-Service (SaaS) APIs, or otherwise.",
"extends": "discovery",
"name": "cloud_resources_inventory_info",
"family": "Inventory",
"attributes": {
"cloud": {
"profile": null,
Expand Down
1 change: 1 addition & 0 deletions events/discovery/config_state.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Device Config State events report device configuration data and CIS Benchmark results.",
"extends": "discovery",
"name": "config_state",
"family": "State",
"attributes": {
"actor": {
"group": "context",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/device_config_state_change.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Device Config State Change events report state changes that impact the security of the device.",
"extends": "discovery",
"name": "device_config_state_change",
"family": "State",
"attributes": {
"actor": {
"group": "context",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/discovery_result.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Discovery Result events report the results of a discovery request.",
"extends": "base_event",
"name": "discovery_result",
"family": "Query",
"attributes": {
"activity_id": {
"enum": {
Expand Down
1 change: 1 addition & 0 deletions events/discovery/file_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "File Query events report information about files that are present on the system.",
"extends": "discovery_result",
"name": "file_query",
"family": "Query",
"attributes": {
"file": {
"description": "The file that is the target of the query.",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/folder_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Folder Query events report information about folders that are present on the system.",
"extends": "discovery_result",
"name": "folder_query",
"family": "Query",
"attributes": {
"folder": {
"description": "The folder that is the target of the query.",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/inventory_info.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Device Inventory Info events report device inventory data that is either logged or proactively collected. For example, when collecting device information from a CMDB or running a network sweep of connected devices.",
"extends": "discovery",
"name": "inventory_info",
"family": "Inventory",
"attributes": {
"actor": {
"group": "context",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/job_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Job Query events report information about scheduled jobs.",
"extends": "discovery_result",
"name": "job_query",
"family": "Query",
"attributes": {
"job": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/kernel_object_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Kernel Object Query events report information about discovered kernel resources.",
"extends": "discovery_result",
"name": "kernel_object_query",
"family": "Query",
"attributes": {
"kernel": {
"description": "The kernel object that pertains to the event.",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/module_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Module Query events report information about loaded modules.",
"extends": "discovery_result",
"name": "module_query",
"family": "Query",
"attributes": {
"module": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/network_connection_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Network Connection Query events report information about active network connections.",
"extends": "discovery_result",
"name": "network_connection_query",
"family": "Query",
"attributes": {
"connection_info": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/networks_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Networks Query events report information about network adapters.",
"extends": "discovery_result",
"name": "networks_query",
"family": "Query",
"attributes": {
"network_interfaces": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/osint_inventory_info.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "OSINT Inventory Info events report open source intelligence or threat intelligence inventory data that is either logged or proactively collected. For example, when collecting OSINT information from Threat Intelligence Platforms (TIPs) or Extended Detection and Response (XDR) platforms, or collecting data from OSINT or other generic threat intelligence and enrichment feeds such as APIs and datastores.",
"extends": "discovery",
"name": "osint_inventory_info",
"family": "Inventory",
"attributes": {
"actor": {
"description": "The actor describes the process that was the source of the inventory activity. In the case of OSINT inventory data, that could be a particular process or script that is run to scrape the OSINT or threat intelligence data. For example, it could be a Python process that runs to pull data from a MISP or Shodan API.",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/patch_state.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Operating System Patch State reports the installation of an OS patch to a device and any associated knowledgebase articles.",
"extends": "discovery",
"name": "patch_state",
"family": "State",
"attributes": {
"device": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/peripheral_device_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Peripheral Device Query events report information about peripheral devices.",
"extends": "discovery_result",
"name": "peripheral_device_query",
"family": "Query",
"attributes": {
"peripheral_device": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/process_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Process Query events report information about running processes.",
"extends": "discovery_result",
"name": "process_query",
"family": "Query",
"attributes": {
"process": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/service_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Service Query events report information about running services.",
"extends": "discovery_result",
"name": "service_query",
"family": "Query",
"attributes": {
"service": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/session_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "User Session Query events report information about existing user sessions.",
"extends": "discovery_result",
"name": "session_query",
"family": "Query",
"attributes": {
"session": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/software_info.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Software Inventory Info events report device software inventory data that is either logged or proactively collected. For example, when collecting device information from a CMDB or running a network sweep of connected devices.",
"extends": "discovery",
"name": "software_info",
"family": "Inventory",
"attributes": {
"actor": {
"group": "context",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/startup_item_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"extends": "discovery_result",
"name": "startup_item_query",
"uid": 22,
"family": "Query",
"attributes": {
"startup_item": {
"group": "primary",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/user_inventory.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "User Inventory Info events report user inventory data that is either logged or proactively collected. For example, when collecting user information from Active Directory entries.",
"extends": "discovery",
"name": "user_inventory",
"family": "Inventory",
"attributes": {
"actor": {
"description": "The actor describes the process that was the source of the inventory activity. In the case of user inventory data, that could be a particular process or script that is run to scrape the user data. For example, it could be a powershell process that runs to pull data from the Azure AD graph API.",
Expand Down
1 change: 1 addition & 0 deletions events/discovery/user_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "User Query events report user data that have been discovered, queried, polled or searched. This event differs from User Inventory as it describes the result of a targeted search by filtering a subset of user attributes.",
"extends": "discovery_result",
"name": "user_query",
"family": "Query",
"attributes": {
"user": {
"group": "primary",
Expand Down
4 changes: 4 additions & 0 deletions metaschema/event.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
"type": "string",
"description": "The category that the event belongs to."
},
"family": {
"type:": "string",
"description": "The family or sub-category that the event belongs to, usually with a common suffix in its name."
},
"uid": {
"type": "integer",
"description": "A unique identifier for this event, must be unique within the category.",
Expand Down
Loading