diff --git a/crates/openshell-ocsf/schemas/ocsf/README.md b/crates/openshell-ocsf/schemas/ocsf/README.md index 520325a01a..b15b6511c6 100644 --- a/crates/openshell-ocsf/schemas/ocsf/README.md +++ b/crates/openshell-ocsf/schemas/ocsf/README.md @@ -5,7 +5,7 @@ for offline test validation. ## Version -- **OCSF v1.7.0** — fetched from `https://schema.ocsf.io/api/1.7.0/` +- **OCSF v1.8.0** — fetched from `https://schema.ocsf.io/api/1.8.0/` ## Contents @@ -25,14 +25,18 @@ for offline test validation. - `metadata`, `network_endpoint`, `network_proxy`, `process`, `actor` - `device`, `container`, `product`, `firewall_rule`, `finding_info` - `evidences`, `http_request`, `http_response`, `url`, `attack` -- `remediation`, `connection_info` +- `remediation`, `connection_info`, `ai_model` + +### Profiles (1) + +- `ai_operation` ## Updating To update to a new OCSF version: ```bash -VERSION=1.7.0 +VERSION=1.8.0 for class in network_activity http_activity ssh_activity process_activity \ detection_finding application_lifecycle device_config_state_change base_event; do diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/VERSION b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/VERSION new file mode 100644 index 0000000000..27f9cd322b --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/VERSION @@ -0,0 +1 @@ +1.8.0 diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/application_lifecycle.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/application_lifecycle.json new file mode 100644 index 0000000000..7bf04ea1fa --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/application_lifecycle.json @@ -0,0 +1,931 @@ +{ + "attributes": { + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host.", + "group": "primary", + "requirement": "recommended", + "caption": "Device", + "object_type": "device", + "profiles": [ + "host" + ], + "object_name": "Device" + }, + "app": { + "type": "object_t", + "description": "The application that was affected by the lifecycle event. This also applies to self-updating application systems.", + "group": "primary", + "requirement": "required", + "caption": "Application", + "object_type": "product", + "object_name": "Product" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "600200": { + "caption": "Application Lifecycle: Unknown" + }, + "600299": { + "caption": "Application Lifecycle: Other" + }, + "600201": { + "description": "Install the application.", + "caption": "Application Lifecycle: Install" + }, + "600202": { + "description": "Remove the application.", + "caption": "Application Lifecycle: Remove" + }, + "600203": { + "description": "Start the application.", + "caption": "Application Lifecycle: Start" + }, + "600204": { + "description": "Stop the application.", + "caption": "Application Lifecycle: Stop" + }, + "600205": { + "description": "Restart the application.", + "caption": "Application Lifecycle: Restart" + }, + "600206": { + "description": "Enable the application.", + "caption": "Application Lifecycle: Enable" + }, + "600207": { + "description": "Disable the application.", + "caption": "Application Lifecycle: Disable" + }, + "600208": { + "description": "Update the application.", + "caption": "Application Lifecycle: Update" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "6": { + "description": "Application Activity events report detailed information about the behavior of applications and services.", + "uid": 6, + "caption": "Application Activity" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Start the application.", + "caption": "Start" + }, + "6": { + "description": "Enable the application.", + "caption": "Enable" + }, + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Install the application.", + "caption": "Install" + }, + "2": { + "description": "Remove the application.", + "caption": "Remove" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Stop the application.", + "caption": "Stop" + }, + "5": { + "description": "Restart the application.", + "caption": "Restart" + }, + "7": { + "description": "Disable the application.", + "caption": "Disable" + }, + "8": { + "description": "Update the application.", + "caption": "Update" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: Application Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: Application Lifecycle.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "6002": { + "description": "Application Lifecycle events report installation, removal, start, stop of an application or service.", + "caption": "Application Lifecycle" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "primary", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": [ + "host" + ], + "object_name": "Actor" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "application_lifecycle", + "description": "Application Lifecycle events report installation, removal, start, stop of an application or service.", + "uid": 6002, + "extends": "application", + "category": "application", + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:ApplicationEvent", + "url": "https://d3fend.mitre.org/event/d3f:ApplicationEvent/" + } + ], + "caption": "Application Lifecycle", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "macos/macos_users", + "osint", + "security_control" + ], + "category_name": "Application Activity", + "category_uid": 6 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/base_event.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/base_event.json new file mode 100644 index 0000000000..14eee209b5 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/base_event.json @@ -0,0 +1,848 @@ +{ + "attributes": { + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host.", + "group": "primary", + "requirement": "recommended", + "caption": "Device", + "object_type": "device", + "profiles": [ + "host" + ], + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "0": { + "caption": "Base Event: Unknown" + }, + "99": { + "caption": "Base Event: Other" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "0": { + "caption": "Uncategorized" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: Base Event.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "0": { + "description": "The base event is a generic and concrete event. It also defines a set of attributes available in most event classes. As a generic event that does not belong to any event category, it could be used to log events that are not otherwise defined by the schema.", + "caption": "Base Event" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "primary", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": [ + "host" + ], + "object_name": "Actor" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "base_event", + "description": "The base event is a generic and concrete event. It also defines a set of attributes available in most event classes. As a generic event that does not belong to any event category, it could be used to log events that are not otherwise defined by the schema.", + "uid": 0, + "category": "other", + "caption": "Base Event", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "macos/macos_users", + "osint", + "security_control" + ], + "category_uid": 0 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/detection_finding.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/detection_finding.json new file mode 100644 index 0000000000..f0a1adc9d7 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/detection_finding.json @@ -0,0 +1,1210 @@ +{ + "attributes": { + "verdict": { + "type": "string_t", + "description": "The verdict assigned to an Incident finding.", + "group": "primary", + "requirement": "recommended", + "caption": "Verdict", + "profiles": [ + "incident" + ], + "type_name": "String" + }, + "vendor_attributes": { + "type": "object_t", + "description": "The Vendor Attributes object can be used to represent values of attributes populated by the Vendor/Finding Provider. It can help distinguish between the vendor-provided values and consumer-updated values, of key attributes like severity_id.
The original finding producer should not populate this object. It should be populated by consuming systems that support data mutability.", + "group": "context", + "requirement": "optional", + "caption": "Vendor Attributes", + "object_type": "vendor_attributes", + "object_name": "Vendor Attributes" + }, + "priority_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Critical functionality or network access is interrupted, degraded or unusable, having a severe impact on services availability. No acceptable alternative is possible.", + "caption": "High" + }, + "0": { + "description": "No priority is assigned.", + "caption": "Unknown" + }, + "1": { + "description": "Application or personal procedure is unusable, where a workaround is available or a repair is possible.", + "caption": "Low" + }, + "2": { + "description": "Non-critical function or procedure is unusable or hard to use causing operational disruptions with no direct impact on a service's availability. A workaround is available.", + "caption": "Medium" + }, + "99": { + "description": "The priority is not normalized.", + "caption": "Other" + }, + "4": { + "description": "Interruption making a critical functionality inaccessible or a complete network interruption causing a severe impact on services availability. There is no possible alternative.", + "caption": "Critical" + } + }, + "description": "The normalized priority. Priority identifies the relative importance of the incident or finding. It is a measurement of urgency.", + "group": "context", + "requirement": "recommended", + "caption": "Priority ID", + "sibling": "priority", + "profiles": [ + "incident" + ], + "type_name": "Integer" + }, + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": null, + "type_name": "Integer" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "comment": { + "type": "string_t", + "description": "A user provided comment about the finding.", + "group": "context", + "requirement": "optional", + "caption": "Comment", + "type_name": "String" + }, + "impact_score": { + "type": "integer_t", + "description": "The impact as an integer value of the finding, valid range 0-100.", + "group": "context", + "requirement": "optional", + "caption": "Impact Score", + "profiles": null, + "type_name": "Integer" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "resources": { + "type": "object_t", + "description": "Describes details about resources that were the target of the activity that triggered the finding.", + "group": "context", + "is_array": true, + "requirement": "recommended", + "caption": "Affected Resources", + "object_type": "resource_details", + "object_name": "Resource Details" + }, + "priority": { + "type": "string_t", + "description": "The priority, normalized to the caption of the priority_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Priority", + "profiles": [ + "incident" + ], + "type_name": "String" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The time of the least recent event included in the finding.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "impact": { + "type": "string_t", + "description": "The impact , normalized to the caption of the impact_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Impact", + "profiles": null, + "type_name": "String" + }, + "evidences": { + "type": "object_t", + "description": "Describes various evidence artifacts associated to the activity/activities that triggered a security detection.", + "group": "primary", + "is_array": true, + "requirement": "recommended", + "caption": "Evidence Artifacts", + "object_type": "evidences", + "object_name": "Evidence Artifacts" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The time of the most recent event included in the finding.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": null, + "type_name": "String" + }, + "finding_info": { + "type": "object_t", + "description": "Describes the supporting information about a generated finding.", + "group": "primary", + "requirement": "required", + "caption": "Finding Information", + "object_type": "finding_info", + "object_name": "Finding Information" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about malware scan job that triggered this Detection Finding.", + "group": "context", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": null, + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The time of the most recent event included in the finding.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "verdict_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The incident can be disregarded as it is unimportant, an error or accident.", + "caption": "Disregard" + }, + "6": { + "description": "The incident is a test.", + "caption": "Test" + }, + "0": { + "description": "The type is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The incident is a false positive.", + "caption": "False Positive" + }, + "2": { + "description": "The incident is a true positive.", + "caption": "True Positive" + }, + "99": { + "description": "The type is not mapped. See the type attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The incident is suspicious.", + "caption": "Suspicious" + }, + "5": { + "description": "The incident is benign.", + "caption": "Benign" + }, + "7": { + "description": "The incident has insufficient data to make a verdict.", + "caption": "Insufficient Data" + }, + "8": { + "description": "The incident is a security risk.", + "caption": "Security Risk" + }, + "9": { + "description": "The incident remediation or required actions are managed externally.", + "caption": "Managed Externally" + }, + "10": { + "description": "The incident is a duplicate.", + "caption": "Duplicate" + } + }, + "description": "The normalized verdict of an Incident.", + "group": "primary", + "requirement": "recommended", + "caption": "Verdict ID", + "sibling": "verdict", + "profiles": [ + "incident" + ], + "type_name": "Integer" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "src_url": { + "type": "url_t", + "description": "A Url link used to access the original incident.", + "group": "primary", + "requirement": "recommended", + "caption": "Source URL", + "profiles": [ + "incident" + ], + "type_name": "URL String" + }, + "device": { + "type": "object_t", + "description": "Describes the affected device/host. If applicable, it can be used in conjunction with Resource(s).

e.g. Specific details about an AWS EC2 instance, that is affected by the Finding.

", + "group": "context", + "requirement": "optional", + "caption": "Device", + "object_type": "device", + "profiles": null, + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": null, + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "200400": { + "caption": "Detection Finding: Unknown" + }, + "200499": { + "caption": "Detection Finding: Other" + }, + "200401": { + "description": "A finding was created.", + "caption": "Detection Finding: Create" + }, + "200402": { + "description": "A finding was updated.", + "caption": "Detection Finding: Update" + }, + "200403": { + "description": "A finding was closed.", + "caption": "Detection Finding: Close" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "ticket": { + "type": "object_t", + "description": "The linked ticket in the ticketing system.", + "group": "context", + "requirement": "optional", + "caption": "Ticket", + "object_type": "ticket", + "profiles": [ + "incident" + ], + "@deprecated": { + "message": "Use tickets instead.", + "since": "1.5.0" + }, + "object_name": "Ticket" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": null, + "type_name": "Integer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "2": { + "description": "Findings events report findings, detections, and possible resolutions of malware, anomalies, or other actions performed by security products.", + "uid": 2, + "caption": "Findings" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A finding was closed.", + "caption": "Close" + }, + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A finding was created.", + "caption": "Create" + }, + "2": { + "description": "A finding was updated.", + "caption": "Update" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the finding activity.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "impact_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The magnitude of harm is high.", + "caption": "High" + }, + "0": { + "description": "The normalized impact is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The magnitude of harm is low.", + "caption": "Low" + }, + "2": { + "description": "The magnitude of harm is moderate.", + "caption": "Medium" + }, + "99": { + "description": "The impact is not mapped. See the impact attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The magnitude of harm is high and the scope is widespread.", + "caption": "Critical" + } + }, + "description": "The normalized impact of the incident or finding. Per NIST, this is the magnitude of harm that can be expected to result from the consequences of unauthorized disclosure, modification, destruction, or loss of information or information system availability.", + "group": "context", + "source": "impact value; impact level", + "references": [ + { + "description": "NIST SP 800-172 from FIPS 199", + "url": "https://doi.org/10.6028/NIST.FIPS.199" + }, + { + "description": "NIST Computer Security Resource Center", + "url": "https://doi.org/10.6028/NIST.FIPS.199" + } + ], + "requirement": "optional", + "caption": "Impact ID", + "sibling": "impact", + "profiles": null, + "type_name": "Integer" + }, + "tickets": { + "type": "object_t", + "description": "The associated ticket(s) in the ticketing system. Each ticket contains details like ticket ID, status, etc.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Tickets", + "object_type": "ticket", + "profiles": [ + "incident" + ], + "object_name": "Ticket" + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: Findings.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The time of the least recent event included in the finding.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "remediation": { + "type": "object_t", + "description": "Describes the recommended remediation steps to address identified issue(s).", + "group": "context", + "requirement": "optional", + "caption": "Remediation Guidance", + "object_type": "remediation", + "object_name": "Remediation" + }, + "status_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The Finding was reviewed, determined to be benign or a false positive and is now suppressed.", + "caption": "Suppressed" + }, + "6": { + "description": "The Finding was deleted. For example, it might have been created in error.", + "caption": "Deleted" + }, + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The Finding is new and yet to be reviewed.", + "caption": "New" + }, + "2": { + "description": "The Finding is under review.", + "caption": "In Progress" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The Finding was reviewed, remediated and is now considered resolved.", + "caption": "Resolved" + }, + "5": { + "description": "The Finding was archived.", + "caption": "Archived" + } + }, + "description": "The normalized status identifier of the Finding, set by the consumer.", + "group": "context", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: Detection Finding.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "activity_name": { + "type": "string_t", + "description": "The finding activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "2004": { + "description": "A Detection Finding describes detections or alerts generated by security products using correlation engines, detection engines or other methodologies. Note: if the event producer is a security control, the security_control profile should be applied and its attacks information, if present, should be duplicated into the finding_info object.
Note: If the Finding is an incident, i.e. requires incident workflow, also apply the incident profile or aggregate this finding into an Incident Finding.", + "caption": "Detection Finding" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "is_suspected_breach": { + "type": "boolean_t", + "description": "A determination based on analytics as to whether a potential breach was found.", + "group": "context", + "requirement": "optional", + "caption": "Suspected Breach", + "profiles": [ + "incident" + ], + "type_name": "Boolean" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": null, + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. For example, an activity_id of 'Create' could constitute an alertable signal and the value would be true, while 'Close' likely would not and either omit the attribute or set its value to false. Note that other events with the security_control profile may also be deemed alertable signals and may also carry is_alert = true attributes.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": null, + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": null, + "type_name": "String" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "Describes malware reported in a Detection Finding.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": null, + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "primary", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": [ + "host" + ], + "object_name": "Actor" + }, + "anomaly_analyses": { + "type": "object_t", + "description": "Describes baseline information about normal activity patterns, along with any detected deviations or anomalies that triggered this finding.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Anomaly Analyses", + "object_type": "anomaly_analysis", + "object_name": "Anomaly Analysis" + }, + "assignee_group": { + "type": "object_t", + "description": "The details of the group assigned to an Incident.", + "group": "context", + "requirement": "optional", + "caption": "Assignee Group", + "object_type": "group", + "profiles": [ + "incident" + ], + "object_name": "Group" + }, + "vulnerabilities": { + "type": "object_t", + "description": "Describes vulnerabilities reported in a Detection Finding.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Vulnerabilities", + "object_type": "vulnerability", + "object_name": "Vulnerability Details" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": null, + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The normalized status of the Finding set by the consumer normalized to the caption of the status_id value. In the case of 'Other', it is defined by the source.", + "group": "context", + "requirement": "optional", + "caption": "Status", + "type_name": "String" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "assignee": { + "type": "object_t", + "description": "The details of the user assigned to an Incident.", + "group": "context", + "requirement": "optional", + "caption": "Assignee", + "object_type": "user", + "profiles": [ + "incident" + ], + "object_name": "User" + } + }, + "name": "detection_finding", + "description": "A Detection Finding describes detections or alerts generated by security products using correlation engines, detection engines or other methodologies. Note: if the event producer is a security control, the security_control profile should be applied and its attacks information, if present, should be duplicated into the finding_info object.
Note: If the Finding is an incident, i.e. requires incident workflow, also apply the incident profile or aggregate this finding into an Incident Finding.", + "uid": 2004, + "extends": "finding", + "category": "findings", + "caption": "Detection Finding", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "incident", + "linux/linux_users", + "macos/macos_users", + "osint", + "security_control" + ], + "category_name": "Findings", + "category_uid": 2 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/device_config_state_change.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/device_config_state_change.json new file mode 100644 index 0000000000..4ad3746fe6 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/device_config_state_change.json @@ -0,0 +1,987 @@ +{ + "attributes": { + "state_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The Config Change state is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Config State Changed to Disabled.", + "caption": "Disabled" + }, + "2": { + "description": "Config State Changed to Enabled.", + "caption": "Enabled" + }, + "99": { + "description": "The Config Change is not mapped. See the state attribute, which contains data source specific values.", + "caption": "Other" + } + }, + "description": "The Config Change State of the managed entity.", + "requirement": "recommended", + "caption": "Config Change State ID", + "sibling": "state", + "type_name": "Integer" + }, + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "state": { + "type": "string_t", + "description": "The Config Change Stat, normalized to the caption of the state_id value. In the case of 'Other', it is defined by the source.", + "requirement": "optional", + "caption": "Config Change State", + "type_name": "String" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "device": { + "type": "object_t", + "description": "The device that is impacted by the state change.", + "group": "primary", + "requirement": "required", + "caption": "Device", + "object_type": "device", + "profiles": null, + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "501900": { + "caption": "Device Config State Change: Unknown" + }, + "501999": { + "caption": "Device Config State Change: Other" + }, + "501901": { + "description": "The discovered information is via a log.", + "caption": "Device Config State Change: Log" + }, + "501902": { + "description": "The discovered information is via a collection process.", + "caption": "Device Config State Change: Collect" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "security_states": { + "type": "object_t", + "description": "The current security states of the device.", + "group": "primary", + "is_array": true, + "requirement": "recommended", + "caption": "Security States", + "object_type": "security_state", + "object_name": "Security State" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "prev_security_states": { + "type": "object_t", + "description": "The previous security states of the device.", + "group": "primary", + "is_array": true, + "requirement": "recommended", + "caption": "Previous Security States", + "object_type": "security_state", + "object_name": "Security State" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "5": { + "description": "Discovery events report the existence and state of devices, files, configurations, processes, registry keys, and other objects.", + "uid": 5, + "caption": "Discovery" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The discovered information is via a log.", + "caption": "Log" + }, + "2": { + "description": "The discovered information is via a collection process.", + "caption": "Collect" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: Discovery.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "prev_security_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "Compromised" + }, + "0": { + "caption": "Unknown" + }, + "1": { + "caption": "Secure" + }, + "2": { + "caption": "At Risk" + }, + "99": { + "description": "The security level is not mapped. See the prev_security_level attribute, which contains data source specific values.", + "caption": "Other" + } + }, + "description": "The previous security level of the entity", + "group": "primary", + "requirement": "recommended", + "caption": "Previous Security Level ID", + "sibling": "prev_security_level", + "type_name": "Integer" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: Device Config State Change.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "security_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "Compromised" + }, + "0": { + "caption": "Unknown" + }, + "1": { + "caption": "Secure" + }, + "2": { + "caption": "At Risk" + }, + "99": { + "description": "The security level is not mapped. See the security_level attribute, which contains data source specific values.", + "caption": "Other" + } + }, + "description": "The current security level of the entity", + "group": "primary", + "requirement": "recommended", + "caption": "Security Level ID", + "sibling": "security_level", + "type_name": "Integer" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "5019": { + "description": "Device Config State Change events report state changes that impact the security of the device.", + "caption": "Device Config State Change" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "security_level": { + "type": "string_t", + "description": "The current security level of the entity", + "group": "primary", + "requirement": "recommended", + "caption": "Security Level", + "type_name": "String" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "prev_security_level": { + "type": "string_t", + "description": "The previous security level of the entity", + "group": "primary", + "requirement": "recommended", + "caption": "Previous Security Level", + "type_name": "String" + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "context", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": null, + "object_name": "Actor" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "device_config_state_change", + "description": "Device Config State Change events report state changes that impact the security of the device.", + "uid": 5019, + "extends": "discovery", + "category": "discovery", + "caption": "Device Config State Change", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "macos/macos_users", + "osint", + "security_control" + ], + "category_name": "Discovery", + "category_uid": 5 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/http_activity.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/http_activity.json new file mode 100644 index 0000000000..e77b085853 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/http_activity.json @@ -0,0 +1,1243 @@ +{ + "attributes": { + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "proxy_http_response": { + "type": "object_t", + "description": "The HTTP Response from the remote server to the proxy server.", + "group": "context", + "requirement": "optional", + "caption": "Proxy HTTP Response", + "object_type": "http_response", + "profiles": [ + "network_proxy" + ], + "object_name": "HTTP Response" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "app_name": { + "type": "string_t", + "description": "The network application name identified by tools such as NBAR or App ID (e.g., youtube, facebook, webex). This represents a specific network application that uses standard protocols (such as https or quic) to deliver its service.", + "group": "context", + "requirement": "optional", + "caption": "Application Name", + "type_name": "String" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "http_response": { + "type": "object_t", + "description": "The HTTP Response from a web server to a requester.", + "group": "primary", + "requirement": "recommended", + "caption": "HTTP Response", + "object_type": "http_response", + "object_name": "HTTP Response" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "network_observation_point": { + "type": "object_t", + "description": "The network endpoint that observes or inspects network traffic as a third-party system, used when the observer is neither the source nor the destination of the communication (when observation_point_id = 3). Examples include network taps, span ports, inline security devices, or packet capture systems that monitor traffic between other endpoints.", + "group": "context", + "requirement": "optional", + "caption": "Network Observation Point", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "http_status": { + "type": "integer_t", + "description": "The Hypertext Transfer Protocol (HTTP) status code returned to the client.", + "group": "primary", + "requirement": "recommended", + "caption": "HTTP Status", + "type_name": "Integer", + "@deprecated": { + "message": "Use the http_response.code attribute instead.", + "since": "1.1.0" + } + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "proxy_traffic": { + "type": "object_t", + "description": "The network traffic refers to the amount of data moving across a network, from proxy to remote server at a given point of time.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy Traffic", + "object_type": "network_traffic", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Traffic" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "proxy_http_request": { + "type": "object_t", + "description": "The HTTP Request from the proxy server to the remote server.", + "group": "context", + "requirement": "optional", + "caption": "Proxy HTTP Request", + "object_type": "http_request", + "profiles": [ + "network_proxy" + ], + "object_name": "HTTP Request" + }, + "connection_info": { + "type": "object_t", + "description": "The network connection information.", + "group": "primary", + "requirement": "recommended", + "caption": "Connection Info", + "object_type": "network_connection_info", + "object_name": "Network Connection Information" + }, + "proxy_endpoint": { + "type": "object_t", + "description": "The proxy (server) in a network connection.", + "group": "context", + "requirement": "optional", + "caption": "Proxy Endpoint", + "object_type": "network_proxy", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Proxy Endpoint" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "ja4_fingerprint_list": { + "type": "object_t", + "description": "A list of the JA4+ network fingerprints.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "JA4+ Fingerprints", + "object_type": "ja4_fingerprint", + "object_name": "JA4+ Fingerprint" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "http_cookies": { + "type": "object_t", + "description": "The cookies object describes details about HTTP cookies", + "group": "primary", + "is_array": true, + "requirement": "recommended", + "caption": "HTTP Cookies", + "object_type": "http_cookie", + "object_name": "HTTP Cookie" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host.", + "group": "primary", + "requirement": "recommended", + "caption": "Device", + "object_type": "device", + "profiles": [ + "host" + ], + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "400200": { + "caption": "HTTP Activity: Unknown" + }, + "400299": { + "caption": "HTTP Activity: Other" + }, + "400201": { + "description": "The CONNECT method establishes a tunnel to the server identified by the target resource.", + "caption": "HTTP Activity: Connect" + }, + "400202": { + "description": "The DELETE method deletes the specified resource.", + "caption": "HTTP Activity: Delete" + }, + "400203": { + "description": "The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.", + "caption": "HTTP Activity: Get" + }, + "400204": { + "description": "The HEAD method asks for a response identical to a GET request, but without the response body.", + "caption": "HTTP Activity: Head" + }, + "400205": { + "description": "The OPTIONS method describes the communication options for the target resource.", + "caption": "HTTP Activity: Options" + }, + "400206": { + "description": "The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.", + "caption": "HTTP Activity: Post" + }, + "400207": { + "description": "The PUT method replaces all current representations of the target resource with the request payload.", + "caption": "HTTP Activity: Put" + }, + "400208": { + "description": "The TRACE method performs a message loop-back test along the path to the target resource.", + "caption": "HTTP Activity: Trace" + }, + "400209": { + "description": "The PATCH method applies partial modifications to a resource.", + "caption": "HTTP Activity: Patch" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cumulative_traffic": { + "type": "object_t", + "description": "The cumulative (running total) network traffic aggregated from the start of a flow or session. Use when reporting: (1) total accumulated bytes/packets since flow initiation, (2) combined aggregation models where both incremental deltas and running totals are reported together (populate both traffic for the delta and this attribute for the cumulative total), or (3) final summary metrics when a long-lived connection closes. This represents the sum of all activity from flow start to the current observation, not a delta or point-in-time value.", + "group": "context", + "requirement": "optional", + "caption": "Cumulative Traffic", + "object_type": "network_traffic", + "object_name": "Network Traffic" + }, + "load_balancer": { + "type": "object_t", + "description": "The Load Balancer object contains information related to the device that is distributing incoming traffic to specified destinations.", + "group": "primary", + "requirement": "recommended", + "caption": "Load Balancer", + "object_type": "load_balancer", + "profiles": [ + "load_balancer" + ], + "object_name": "Load Balancer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "trace": { + "type": "object_t", + "description": "The trace object contains information about distributed traces which are critical to observability and describe how requests move through a system, capturing each step's timing and status.", + "group": "primary", + "requirement": "recommended", + "caption": "Trace", + "object_type": "trace", + "profiles": [ + "trace" + ], + "object_name": "Trace" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "4": { + "description": "Network Activity events.", + "uid": 4, + "caption": "Network Activity" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.", + "caption": "Get" + }, + "6": { + "description": "The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.", + "caption": "Post" + }, + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The CONNECT method establishes a tunnel to the server identified by the target resource.", + "caption": "Connect" + }, + "2": { + "description": "The DELETE method deletes the specified resource.", + "caption": "Delete" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The HEAD method asks for a response identical to a GET request, but without the response body.", + "caption": "Head" + }, + "5": { + "description": "The OPTIONS method describes the communication options for the target resource.", + "caption": "Options" + }, + "7": { + "description": "The PUT method replaces all current representations of the target resource with the request payload.", + "caption": "Put" + }, + "8": { + "description": "The TRACE method performs a message loop-back test along the path to the target resource.", + "caption": "Trace" + }, + "9": { + "description": "The PATCH method applies partial modifications to a resource.", + "caption": "Patch" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "tls": { + "type": "object_t", + "description": "The Transport Layer Security (TLS) attributes.", + "group": "context", + "requirement": "optional", + "caption": "TLS", + "object_type": "tls", + "object_name": "Transport Layer Security (TLS)" + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: Network Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "app_protocol_name": { + "type": "string_t", + "description": "The application-layer (Layer 7) protocol name identified by deep packet inspection or packet parsing (e.g., https, quic, ssh, dns), expressed as an IANA-registered service name from the IANA Service Name and Transport Protocol Port Number Registry.\n\n

Note: Port numbers alone are not always a reliable indicator of the actual application protocol in use.

", + "group": "context", + "references": [ + { + "description": "IANA Service Name and Transport Protocol Port Number Registry", + "url": "https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml" + } + ], + "requirement": "optional", + "caption": "Application Protocol Name", + "type_name": "String" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "traffic": { + "type": "object_t", + "description": "The network traffic for this observation period. Use when reporting: (1) delta values (bytes/packets transferred since the last observation), (2) instantaneous measurements at a specific point in time, or (3) standalone single-event metrics. This attribute represents a point-in-time measurement or incremental change, not a running total. For accumulated totals across multiple observations or the lifetime of a flow, use cumulative_traffic instead.", + "group": "primary", + "requirement": "recommended", + "caption": "Traffic", + "object_type": "network_traffic", + "object_name": "Network Traffic" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: HTTP Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "packet_list": { + "type": "object_t", + "description": "The list of packet objects describing captured network packets.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Packets", + "object_type": "packet", + "object_name": "Packet" + }, + "http_request": { + "type": "object_t", + "description": "The HTTP Request Object documents attributes of a request made to a web server.", + "group": "primary", + "requirement": "recommended", + "caption": "HTTP Request", + "object_type": "http_request", + "object_name": "HTTP Request" + }, + "proxy_tls": { + "type": "object_t", + "description": "The TLS protocol negotiated between the proxy server and the remote server.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy TLS", + "object_type": "tls", + "profiles": [ + "network_proxy" + ], + "object_name": "Transport Layer Security (TLS)" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "4002": { + "description": "HTTP Activity events report HTTP connection and traffic information.", + "caption": "HTTP Activity" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "observation_point": { + "type": "string_t", + "description": "Indicates whether the source network endpoint, destination network endpoint, or neither served as the observation point for the activity. The value is normalized to the caption of the observation_point_id.", + "requirement": "optional", + "caption": "Observation Point", + "type_name": "String" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "dst_endpoint": { + "type": "object_t", + "description": "The responder (server) in a network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Destination Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "src_endpoint": { + "type": "object_t", + "description": "The initiator (client) of the network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Source Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "primary", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": [ + "host" + ], + "object_name": "Actor" + }, + "proxy_connection_info": { + "type": "object_t", + "description": "The connection information from the proxy server to the remote server.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy Connection Info", + "object_type": "network_connection_info", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Connection Information" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "proxy": { + "type": "object_t", + "description": "The proxy (server) in a network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Proxy", + "object_type": "network_proxy", + "@deprecated": { + "message": "Use the proxy_endpoint attribute instead.", + "since": "1.1.0" + }, + "object_name": "Network Proxy Endpoint" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "file": { + "type": "object_t", + "description": "The file that is the target of the HTTP activity.", + "group": "context", + "requirement": "optional", + "caption": "File", + "object_type": "file", + "object_name": "File" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "observation_point_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Neither the source nor destination network endpoint is the observation point. Refer to the network_observation_point attribute for details.", + "caption": "Neither" + }, + "0": { + "description": "The observation point is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The source network endpoint is the observation point.", + "caption": "Source" + }, + "2": { + "description": "The destination network endpoint is the observation point.", + "caption": "Destination" + }, + "99": { + "description": "The observation point is not mapped. See the observation_point attribute for a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Both the source and destination network endpoint are the observation point. This typically occurs in localhost or internal communications where the source and destination are the same endpoint, often resulting in a connection_info.direction of Local.", + "caption": "Both" + } + }, + "description": "The normalized identifier of the observation point. The observation point identifier indicates whether the source network endpoint, destination network endpoint, or neither served as the observation point for the activity.", + "requirement": "optional", + "caption": "Observation Point ID", + "sibling": "observation_point", + "type_name": "Integer" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "http_activity", + "description": "HTTP Activity events report HTTP connection and traffic information.", + "uid": 4002, + "extends": "network", + "category": "network", + "constraints": { + "at_least_one": [ + "http_request", + "http_response" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:HTTPEvent", + "url": "https://d3fend.mitre.org/event/d3f:HTTPEvent/" + } + ], + "caption": "HTTP Activity", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "load_balancer", + "macos/macos_users", + "network_proxy", + "osint", + "security_control", + "trace" + ], + "category_name": "Network Activity", + "category_uid": 4 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/network_activity.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/network_activity.json new file mode 100644 index 0000000000..88cf930542 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/network_activity.json @@ -0,0 +1,1182 @@ +{ + "attributes": { + "is_src_dst_assignment_known": { + "type": "boolean_t", + "description": "true denotes that src_endpoint and dst_endpoint correctly identify the initiator and responder respectively. false denotes that the event source has arbitrarily assigned one peer to src_endpoint and the other to dst_endpoint, in other words that initiator and responder are not being asserted. This can occur, for example, when the event source is a network appliance that has not observed the initiation of a given connection. In the absence of this attribute, interpretation of the initiator and responder is implementation-specific.", + "group": "primary", + "requirement": "recommended", + "caption": "Source/Destination Assignment Known", + "type_name": "Boolean" + }, + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "proxy_http_response": { + "type": "object_t", + "description": "The HTTP Response from the remote server to the proxy server.", + "group": "context", + "requirement": "optional", + "caption": "Proxy HTTP Response", + "object_type": "http_response", + "profiles": [ + "network_proxy" + ], + "object_name": "HTTP Response" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "app_name": { + "type": "string_t", + "description": "The network application name identified by tools such as NBAR or App ID (e.g., youtube, facebook, webex). This represents a specific network application that uses standard protocols (such as https or quic) to deliver its service.", + "group": "context", + "requirement": "optional", + "caption": "Application Name", + "type_name": "String" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "network_observation_point": { + "type": "object_t", + "description": "The network endpoint that observes or inspects network traffic as a third-party system, used when the observer is neither the source nor the destination of the communication (when observation_point_id = 3). Examples include network taps, span ports, inline security devices, or packet capture systems that monitor traffic between other endpoints.", + "group": "context", + "requirement": "optional", + "caption": "Network Observation Point", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "proxy_traffic": { + "type": "object_t", + "description": "The network traffic refers to the amount of data moving across a network, from proxy to remote server at a given point of time.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy Traffic", + "object_type": "network_traffic", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Traffic" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "proxy_http_request": { + "type": "object_t", + "description": "The HTTP Request from the proxy server to the remote server.", + "group": "context", + "requirement": "optional", + "caption": "Proxy HTTP Request", + "object_type": "http_request", + "profiles": [ + "network_proxy" + ], + "object_name": "HTTP Request" + }, + "connection_info": { + "type": "object_t", + "description": "The network connection information.", + "group": "primary", + "requirement": "recommended", + "caption": "Connection Info", + "object_type": "network_connection_info", + "object_name": "Network Connection Information" + }, + "proxy_endpoint": { + "type": "object_t", + "description": "The proxy (server) in a network connection.", + "group": "context", + "requirement": "optional", + "caption": "Proxy Endpoint", + "object_type": "network_proxy", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Proxy Endpoint" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "ja4_fingerprint_list": { + "type": "object_t", + "description": "A list of the JA4+ network fingerprints.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "JA4+ Fingerprints", + "object_type": "ja4_fingerprint", + "object_name": "JA4+ Fingerprint" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host.", + "group": "primary", + "requirement": "recommended", + "caption": "Device", + "object_type": "device", + "profiles": [ + "host" + ], + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "400100": { + "caption": "Network Activity: Unknown" + }, + "400199": { + "caption": "Network Activity: Other" + }, + "400101": { + "description": "A new network connection was opened.", + "caption": "Network Activity: Open" + }, + "400102": { + "description": "The network connection was closed.", + "caption": "Network Activity: Close" + }, + "400103": { + "description": "The network connection was abnormally terminated or closed by a middle device like firewalls.", + "caption": "Network Activity: Reset" + }, + "400104": { + "description": "The network connection failed. For example a connection timeout or no route to host.", + "caption": "Network Activity: Fail" + }, + "400105": { + "description": "The network connection was refused. For example an attempt to connect to a server port which is not open.", + "caption": "Network Activity: Refuse" + }, + "400106": { + "description": "Network traffic report.", + "caption": "Network Activity: Traffic" + }, + "400107": { + "description": "A network endpoint began listening for new network connections.", + "caption": "Network Activity: Listen" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cumulative_traffic": { + "type": "object_t", + "description": "The cumulative (running total) network traffic aggregated from the start of a flow or session. Use when reporting: (1) total accumulated bytes/packets since flow initiation, (2) combined aggregation models where both incremental deltas and running totals are reported together (populate both traffic for the delta and this attribute for the cumulative total), or (3) final summary metrics when a long-lived connection closes. This represents the sum of all activity from flow start to the current observation, not a delta or point-in-time value.", + "group": "context", + "requirement": "optional", + "caption": "Cumulative Traffic", + "object_type": "network_traffic", + "object_name": "Network Traffic" + }, + "load_balancer": { + "type": "object_t", + "description": "The Load Balancer object contains information related to the device that is distributing incoming traffic to specified destinations.", + "group": "primary", + "requirement": "recommended", + "caption": "Load Balancer", + "object_type": "load_balancer", + "profiles": [ + "load_balancer" + ], + "object_name": "Load Balancer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "4": { + "description": "Network Activity events.", + "uid": 4, + "caption": "Network Activity" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The network connection was abnormally terminated or closed by a middle device like firewalls.", + "caption": "Reset" + }, + "6": { + "description": "Network traffic report.", + "caption": "Traffic" + }, + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A new network connection was opened.", + "caption": "Open" + }, + "2": { + "description": "The network connection was closed.", + "caption": "Close" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The network connection failed. For example a connection timeout or no route to host.", + "caption": "Fail" + }, + "5": { + "description": "The network connection was refused. For example an attempt to connect to a server port which is not open.", + "caption": "Refuse" + }, + "7": { + "description": "A network endpoint began listening for new network connections.", + "caption": "Listen" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "tls": { + "type": "object_t", + "description": "The Transport Layer Security (TLS) attributes.", + "group": "context", + "requirement": "optional", + "caption": "TLS", + "object_type": "tls", + "object_name": "Transport Layer Security (TLS)" + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: Network Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "app_protocol_name": { + "type": "string_t", + "description": "The application-layer (Layer 7) protocol name identified by deep packet inspection or packet parsing (e.g., https, quic, ssh, dns), expressed as an IANA-registered service name from the IANA Service Name and Transport Protocol Port Number Registry.\n\n

Note: Port numbers alone are not always a reliable indicator of the actual application protocol in use.

", + "group": "context", + "references": [ + { + "description": "IANA Service Name and Transport Protocol Port Number Registry", + "url": "https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml" + } + ], + "requirement": "optional", + "caption": "Application Protocol Name", + "type_name": "String" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "traffic": { + "type": "object_t", + "description": "The network traffic for this observation period. Use when reporting: (1) delta values (bytes/packets transferred since the last observation), (2) instantaneous measurements at a specific point in time, or (3) standalone single-event metrics. This attribute represents a point-in-time measurement or incremental change, not a running total. For accumulated totals across multiple observations or the lifetime of a flow, use cumulative_traffic instead.", + "group": "primary", + "requirement": "recommended", + "caption": "Traffic", + "object_type": "network_traffic", + "object_name": "Network Traffic" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "url": { + "type": "object_t", + "description": "The URL details relevant to the network traffic.", + "group": "primary", + "requirement": "recommended", + "caption": "URL", + "object_type": "url", + "object_name": "Uniform Resource Locator" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: Network Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "packet_list": { + "type": "object_t", + "description": "The list of packet objects describing captured network packets.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Packets", + "object_type": "packet", + "object_name": "Packet" + }, + "proxy_tls": { + "type": "object_t", + "description": "The TLS protocol negotiated between the proxy server and the remote server.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy TLS", + "object_type": "tls", + "profiles": [ + "network_proxy" + ], + "object_name": "Transport Layer Security (TLS)" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "4001": { + "description": "Network Activity events report network connection and traffic activity.", + "caption": "Network Activity" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "observation_point": { + "type": "string_t", + "description": "Indicates whether the source network endpoint, destination network endpoint, or neither served as the observation point for the activity. The value is normalized to the caption of the observation_point_id.", + "requirement": "optional", + "caption": "Observation Point", + "type_name": "String" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "dst_endpoint": { + "type": "object_t", + "description": "The responder of the network connection. In some contexts an event source cannot correctly identify the responder. Refer to is_src_dst_assignment_known for certainty.", + "group": "primary", + "requirement": "recommended", + "caption": "Destination Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "src_endpoint": { + "type": "object_t", + "description": " The initiator of the network connection. In some contexts an event source cannot correctly identify the initiator. Refer to is_src_dst_assignment_known for certainty.", + "group": "primary", + "requirement": "recommended", + "caption": "Source Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "primary", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": [ + "host" + ], + "object_name": "Actor" + }, + "proxy_connection_info": { + "type": "object_t", + "description": "The connection information from the proxy server to the remote server.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy Connection Info", + "object_type": "network_connection_info", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Connection Information" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "proxy": { + "type": "object_t", + "description": "The proxy (server) in a network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Proxy", + "object_type": "network_proxy", + "@deprecated": { + "message": "Use the proxy_endpoint attribute instead.", + "since": "1.1.0" + }, + "object_name": "Network Proxy Endpoint" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "observation_point_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Neither the source nor destination network endpoint is the observation point. Refer to the network_observation_point attribute for details.", + "caption": "Neither" + }, + "0": { + "description": "The observation point is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The source network endpoint is the observation point.", + "caption": "Source" + }, + "2": { + "description": "The destination network endpoint is the observation point.", + "caption": "Destination" + }, + "99": { + "description": "The observation point is not mapped. See the observation_point attribute for a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Both the source and destination network endpoint are the observation point. This typically occurs in localhost or internal communications where the source and destination are the same endpoint, often resulting in a connection_info.direction of Local.", + "caption": "Both" + } + }, + "description": "The normalized identifier of the observation point. The observation point identifier indicates whether the source network endpoint, destination network endpoint, or neither served as the observation point for the activity.", + "requirement": "optional", + "caption": "Observation Point ID", + "sibling": "observation_point", + "type_name": "Integer" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "network_activity", + "description": "Network Activity events report network connection and traffic activity.", + "uid": 4001, + "extends": "network", + "category": "network", + "constraints": { + "at_least_one": [ + "dst_endpoint", + "src_endpoint" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:NetworkConnectionEvent", + "url": "https://d3fend.mitre.org/event/d3f:NetworkConnectionEvent/" + } + ], + "caption": "Network Activity", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "load_balancer", + "macos/macos_users", + "network_proxy", + "osint", + "security_control" + ], + "category_name": "Network Activity", + "category_uid": 4 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/process_activity.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/process_activity.json new file mode 100644 index 0000000000..1758412e7a --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/process_activity.json @@ -0,0 +1,1072 @@ +{ + "attributes": { + "exit_code": { + "type": "integer_t", + "description": "The exit code reported by a process when it terminates. The convention is that zero indicates success and any non-zero exit code indicates that some error occurred.", + "group": "primary", + "requirement": "recommended", + "caption": "Exit Code", + "type_name": "Integer" + }, + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "launch_type_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Denotes that the Launch event represents the \"exec\" step of Unix process creation, where a process replaces its executable image, command line, and environment. WSL1 pico processes on Windows also use the 2-step Unix model.", + "caption": "Exec" + }, + "0": { + "description": "The launch type is unknown or not specified.", + "caption": "Unknown" + }, + "1": { + "description": "Denotes that the Launch event represents atomic creation of a new process on Windows. This launch type ID may also be used to represent both steps of Unix process creation in a single Launch event.", + "caption": "Spawn" + }, + "2": { + "description": "Denotes that the Launch event represents the \"fork\" step of Unix process creation, where a process creates a clone of itself in a parent-child relationship. WSL1 pico processes on Windows also use the 2-step Unix model.", + "caption": "Fork" + }, + "99": { + "description": "The launch type is not mapped. See the launch_type attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier for the specific type of Launch activity.", + "group": "primary", + "references": [ + { + "description": "fork() man page", + "url": "https://www.man7.org/linux/man-pages/man2/fork.2.html" + }, + { + "description": "execve() man page", + "url": "https://www.man7.org/linux/man-pages/man2/execve.2.html" + } + ], + "requirement": "recommended", + "caption": "Launch Type ID", + "sibling": "launch_type", + "type_name": "Integer" + }, + "actual_permissions": { + "type": "integer_t", + "description": "The permissions that were granted to the process in a platform-native format.", + "group": "primary", + "requirement": "recommended", + "caption": "Actual Permissions", + "type_name": "Integer" + }, + "message_context": { + "type": "object_t", + "description": "Communication context for AI system interactions including protocols, roles, clients, and session information for MCP and other AI communication systems.", + "group": "context", + "requirement": "optional", + "caption": "Message Context", + "object_type": "message_context", + "profiles": [ + "ai_operation" + ], + "object_name": "Message Context" + }, + "launch_type": { + "type": "string_t", + "description": "The specific type of Launch activity, normalized to the caption of the launch_type_id value. In the case of Other it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Launch Type", + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "module": { + "type": "object_t", + "description": "The module that was injected by the actor process.", + "group": "primary", + "requirement": "recommended", + "caption": "Module", + "object_type": "module", + "object_name": "Module" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "injection_type_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "Queue APC" + }, + "0": { + "description": "The injection type is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Remote Thread" + }, + "2": { + "caption": "Load Library" + }, + "99": { + "description": "The injection type is not mapped. See the injection_type attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the process injection method.", + "group": "primary", + "requirement": "recommended", + "caption": "Injection Type ID", + "sibling": "injection_type", + "type_name": "Integer" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host.", + "group": "primary", + "requirement": "required", + "caption": "Device", + "object_type": "device", + "profiles": null, + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "100700": { + "caption": "Process Activity: Unknown" + }, + "100799": { + "caption": "Process Activity: Other" + }, + "100701": { + "description": "A request by the actor to launch another process. Refer to the launch_type_id attribute for details of the specific launch type.", + "caption": "Process Activity: Launch" + }, + "100702": { + "description": "A request by the actor to terminate a process. This activity is most commonly reflexive, this being the case when a process exits at its own initiation. Note too that Windows security products cannot always identify the actor in the case of inter-process termination. In this case, actor.process and process refer to the exiting process, i.e. indistinguishable from the reflexive case.", + "caption": "Process Activity: Terminate" + }, + "100703": { + "description": "A request by the actor to obtain a handle or descriptor to a process with the aim of performing further actions upon that process. The target is usually a different process but this activity can also be reflexive.", + "caption": "Process Activity: Open" + }, + "100704": { + "description": "A request by the actor to execute code within the context of a process. The target is usually a different process but this activity can also be reflexive. Refer to the injection_type_id attribute for details of the specific injection type.", + "references": [ + { + "description": "Guidance on the use of \"Module Activity: Load\" and \"Process Activity: Inject\".", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/faqs/schema-faq.md#when-should-i-use-a-module-activity-load-event-and-when-should-i-use-a-process-activity-inject-event" + } + ], + "caption": "Process Activity: Inject" + }, + "100705": { + "description": "A request by the actor to change its user identity by invoking the setuid() system call. Common programs like su and sudo use this mechanism. Note that the impersonation mechanism on Windows is not directly equivalent because it acts at the thread level.", + "caption": "Process Activity: Set User ID" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "1": { + "description": "System Activity events.", + "uid": 1, + "caption": "System Activity" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A request by the actor to obtain a handle or descriptor to a process with the aim of performing further actions upon that process. The target is usually a different process but this activity can also be reflexive.", + "caption": "Open" + }, + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A request by the actor to launch another process. Refer to the launch_type_id attribute for details of the specific launch type.", + "caption": "Launch" + }, + "2": { + "description": "A request by the actor to terminate a process. This activity is most commonly reflexive, this being the case when a process exits at its own initiation. Note too that Windows security products cannot always identify the actor in the case of inter-process termination. In this case, actor.process and process refer to the exiting process, i.e. indistinguishable from the reflexive case.", + "caption": "Terminate" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A request by the actor to execute code within the context of a process. The target is usually a different process but this activity can also be reflexive. Refer to the injection_type_id attribute for details of the specific injection type.", + "references": [ + { + "description": "Guidance on the use of \"Module Activity: Load\" and \"Process Activity: Inject\".", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/faqs/schema-faq.md#when-should-i-use-a-module-activity-load-event-and-when-should-i-use-a-process-activity-inject-event" + } + ], + "caption": "Inject" + }, + "5": { + "description": "A request by the actor to change its user identity by invoking the setuid() system call. Common programs like su and sudo use this mechanism. Note that the impersonation mechanism on Windows is not directly equivalent because it acts at the thread level.", + "caption": "Set User ID" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "references": [ + { + "description": "setuid() man page", + "url": "https://www.man7.org/linux/man-pages/man2/setuid.2.html" + } + ], + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: System Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "ai_model": { + "type": "object_t", + "description": "The AI Model object describes the characteristics of an AI/ML model. Examples include language models like GPT-4, embedding models like text-embedding-ada-002, and computer vision models like CLIP.", + "group": "context", + "requirement": "recommended", + "caption": "AI Model", + "object_type": "ai_model", + "profiles": [ + "ai_operation" + ], + "object_name": "AI Model" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: Process Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "process": { + "type": "object_t", + "description": "The process that was launched, injected into, opened, or terminated.", + "group": "primary", + "requirement": "required", + "caption": "Process", + "object_type": "process", + "object_name": "Process" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "injection_type": { + "type": "string_t", + "description": "The process injection method, normalized to the caption of the injection_type_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Injection Type", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "1007": { + "description": "Process Activity events report when a process launches, injects, opens or terminates another process, successful or otherwise.", + "caption": "Process Activity" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "requested_permissions": { + "type": "integer_t", + "description": "The permissions mask that was requested by the process.", + "group": "primary", + "requirement": "recommended", + "caption": "Requested Permissions", + "type_name": "Integer" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor that performed the activity on the target process. For example, the process that started a new process or injected code into another process.", + "group": "primary", + "requirement": "required", + "caption": "Actor", + "object_type": "actor", + "profiles": null, + "object_name": "Actor" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "process_activity", + "description": "Process Activity events report when a process launches, injects, opens or terminates another process, successful or otherwise.", + "uid": 1007, + "extends": "system", + "category": "system", + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:ProcessEvent", + "url": "https://d3fend.mitre.org/event/d3f:ProcessEvent/" + } + ], + "caption": "Process Activity", + "profiles": [ + "ai_operation", + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "macos/macos_users", + "osint", + "security_control" + ], + "associations": { + "device": [ + "actor.user" + ], + "actor.user": [ + "device" + ] + }, + "category_name": "System Activity", + "category_uid": 1 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/ssh_activity.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/ssh_activity.json new file mode 100644 index 0000000000..6175425740 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/classes/ssh_activity.json @@ -0,0 +1,1251 @@ +{ + "attributes": { + "status_code": { + "type": "string_t", + "description": "The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Code", + "type_name": "String" + }, + "proxy_http_response": { + "type": "object_t", + "description": "The HTTP Response from the remote server to the proxy server.", + "group": "context", + "requirement": "optional", + "caption": "Proxy HTTP Response", + "object_type": "http_response", + "profiles": [ + "network_proxy" + ], + "object_name": "HTTP Response" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Risk Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "app_name": { + "type": "string_t", + "description": "The network application name identified by tools such as NBAR or App ID (e.g., youtube, facebook, webex). This represents a specific network application that uses standard protocols (such as https or quic) to deliver its service.", + "group": "context", + "requirement": "optional", + "caption": "Application Name", + "type_name": "String" + }, + "time": { + "type": "timestamp_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "required", + "caption": "Event Time", + "type_name": "Timestamp" + }, + "protocol_ver": { + "type": "string_t", + "description": "The Secure Shell Protocol version.", + "group": "context", + "requirement": "recommended", + "caption": "SSH Version", + "type_name": "String" + }, + "observables": { + "type": "object_t", + "description": "The observables associated with the event or a finding.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "OCSF Observables FAQ", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/defining-and-using-observables.md" + } + ], + "requirement": "recommended", + "caption": "Observables", + "object_type": "observable", + "object_name": "Observable" + }, + "severity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Action is required but the situation is not serious at this time.", + "caption": "Medium" + }, + "6": { + "description": "An error occurred but it is too late to take remedial action.", + "caption": "Fatal" + }, + "0": { + "description": "The event/finding severity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Informational message. No action required.", + "caption": "Informational" + }, + "2": { + "description": "The user decides if action is needed.", + "caption": "Low" + }, + "99": { + "description": "The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Action is required immediately.", + "caption": "High" + }, + "5": { + "description": "Action is required immediately and the scope is broad.", + "caption": "Critical" + } + }, + "description": "

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.", + "group": "classification", + "requirement": "required", + "caption": "Severity ID", + "sibling": "severity", + "type_name": "Integer" + }, + "action": { + "type": "string_t", + "description": "The normalized caption of action_id.", + "group": "primary", + "requirement": "optional", + "caption": "Action", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "start_time": { + "type": "timestamp_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "type_name": "Timestamp" + }, + "enrichments": { + "type": "object_t", + "description": "The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Enrichments", + "object_type": "enrichment", + "object_name": "Enrichment" + }, + "end_time_dt": { + "type": "datetime_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "server_hassh": { + "type": "object_t", + "description": "The Server HASSH fingerprinting object.", + "group": "primary", + "requirement": "recommended", + "caption": "Server HASSH", + "object_type": "hassh", + "object_name": "HASSH" + }, + "network_observation_point": { + "type": "object_t", + "description": "The network endpoint that observes or inspects network traffic as a third-party system, used when the observer is neither the source nor the destination of the communication (when observation_point_id = 3). Examples include network taps, span ports, inline security devices, or packet capture systems that monitor traffic between other endpoints.", + "group": "context", + "requirement": "optional", + "caption": "Network Observation Point", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "profiles": [ + "security_control" + ], + "object_name": "Authorization Result" + }, + "confidence": { + "type": "string_t", + "description": "The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "osint": { + "type": "object_t", + "description": "The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.", + "group": "primary", + "is_array": true, + "requirement": "required", + "caption": "OSINT", + "object_type": "osint", + "profiles": [ + "osint" + ], + "object_name": "OSINT" + }, + "firewall_rule": { + "type": "object_t", + "description": "The firewall rule that pertains to the control that triggered the event, if applicable.", + "group": "primary", + "requirement": "optional", + "caption": "Firewall Rule", + "object_type": "firewall_rule", + "profiles": [ + "security_control" + ], + "object_name": "Firewall Rule" + }, + "malware_scan_info": { + "type": "object_t", + "description": "Describes details about the scan job that identified malware on the target system.", + "group": "primary", + "requirement": "optional", + "caption": "Malware Scan Info", + "object_type": "malware_scan_info", + "profiles": [ + "security_control" + ], + "object_name": "Malware Scan Info" + }, + "end_time": { + "type": "timestamp_t", + "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "End Time", + "type_name": "Timestamp" + }, + "proxy_traffic": { + "type": "object_t", + "description": "The network traffic refers to the amount of data moving across a network, from proxy to remote server at a given point of time.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy Traffic", + "object_type": "network_traffic", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Traffic" + }, + "attacks": { + "type": "object_t", + "description": "An array of MITRE ATT&CK\u00ae objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS\u2122 tactics, techniques & sub-techniques.", + "group": "primary", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "profiles": [ + "security_control" + ], + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "proxy_http_request": { + "type": "object_t", + "description": "The HTTP Request from the proxy server to the remote server.", + "group": "context", + "requirement": "optional", + "caption": "Proxy HTTP Request", + "object_type": "http_request", + "profiles": [ + "network_proxy" + ], + "object_name": "HTTP Request" + }, + "connection_info": { + "type": "object_t", + "description": "The network connection information.", + "group": "primary", + "requirement": "recommended", + "caption": "Connection Info", + "object_type": "network_connection_info", + "object_name": "Network Connection Information" + }, + "proxy_endpoint": { + "type": "object_t", + "description": "The proxy (server) in a network connection.", + "group": "context", + "requirement": "optional", + "caption": "Proxy Endpoint", + "object_type": "network_proxy", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Proxy Endpoint" + }, + "time_dt": { + "type": "datetime_t", + "description": "The normalized event occurrence time or the finding creation time.", + "group": "occurrence", + "requirement": "optional", + "caption": "Event Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "ja4_fingerprint_list": { + "type": "object_t", + "description": "A list of the JA4+ network fingerprints.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "JA4+ Fingerprints", + "object_type": "ja4_fingerprint", + "object_name": "JA4+ Fingerprint" + }, + "metadata": { + "type": "object_t", + "description": "The metadata associated with the event or a finding.", + "group": "context", + "requirement": "required", + "caption": "Metadata", + "object_type": "metadata", + "object_name": "Metadata" + }, + "raw_data_hash": { + "type": "object_t", + "description": "The hash, which describes the content of the raw_data field.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "disposition": { + "type": "string_t", + "description": "The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "optional", + "caption": "Disposition", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host.", + "group": "primary", + "requirement": "recommended", + "caption": "Device", + "object_type": "device", + "profiles": [ + "host" + ], + "object_name": "Device" + }, + "confidence_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "description": "The normalized confidence is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.", + "group": "context", + "requirement": "recommended", + "caption": "Confidence ID", + "sibling": "confidence", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "type_uid": { + "type": "long_t", + "enum": { + "400700": { + "caption": "SSH Activity: Unknown" + }, + "400799": { + "caption": "SSH Activity: Other" + }, + "400701": { + "description": "A new network connection was opened.", + "caption": "SSH Activity: Open" + }, + "400702": { + "description": "The network connection was closed.", + "caption": "SSH Activity: Close" + }, + "400703": { + "description": "The network connection was abnormally terminated or closed by a middle device like firewalls.", + "caption": "SSH Activity: Reset" + }, + "400704": { + "description": "The network connection failed. For example a connection timeout or no route to host.", + "caption": "SSH Activity: Fail" + }, + "400705": { + "description": "The network connection was refused. For example an attempt to connect to a server port which is not open.", + "caption": "SSH Activity: Refuse" + }, + "400706": { + "description": "Network traffic report.", + "caption": "SSH Activity: Traffic" + }, + "400707": { + "description": "A network endpoint began listening for new network connections.", + "caption": "SSH Activity: Listen" + } + }, + "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.", + "group": "classification", + "requirement": "required", + "caption": "Type ID", + "sibling": "type_name", + "type_name": "Long" + }, + "confidence_score": { + "type": "integer_t", + "description": "The confidence score as reported by the event source.", + "group": "context", + "requirement": "optional", + "caption": "Confidence Score", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "cumulative_traffic": { + "type": "object_t", + "description": "The cumulative (running total) network traffic aggregated from the start of a flow or session. Use when reporting: (1) total accumulated bytes/packets since flow initiation, (2) combined aggregation models where both incremental deltas and running totals are reported together (populate both traffic for the delta and this attribute for the cumulative total), or (3) final summary metrics when a long-lived connection closes. This represents the sum of all activity from flow start to the current observation, not a delta or point-in-time value.", + "group": "context", + "requirement": "optional", + "caption": "Cumulative Traffic", + "object_type": "network_traffic", + "object_name": "Network Traffic" + }, + "load_balancer": { + "type": "object_t", + "description": "The Load Balancer object contains information related to the device that is distributing incoming traffic to specified destinations.", + "group": "primary", + "requirement": "recommended", + "caption": "Load Balancer", + "object_type": "load_balancer", + "profiles": [ + "load_balancer" + ], + "object_name": "Load Balancer" + }, + "cloud": { + "type": "object_t", + "description": "Describes details about the Cloud environment where the event or finding was created.", + "group": "primary", + "requirement": "required", + "caption": "Cloud", + "object_type": "cloud", + "profiles": [ + "cloud" + ], + "object_name": "Cloud" + }, + "type_name": { + "type": "string_t", + "description": "The event/finding type name, as defined by the type_uid.", + "group": "classification", + "requirement": "optional", + "caption": "Type Name", + "type_name": "String" + }, + "status_detail": { + "type": "string_t", + "description": "The status detail contains additional information about the event/finding outcome.", + "group": "primary", + "requirement": "recommended", + "caption": "Status Detail", + "type_name": "String" + }, + "auth_type": { + "type": "string_t", + "description": "The SSH authentication type, normalized to the caption of 'auth_type_id'. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Authentication Type", + "type_name": "String" + }, + "category_uid": { + "type": "integer_t", + "enum": { + "4": { + "description": "Network Activity events.", + "uid": 4, + "caption": "Network Activity" + } + }, + "description": "The category unique identifier of the event.", + "group": "classification", + "requirement": "required", + "caption": "Category ID", + "sibling": "category_name", + "type_name": "Integer" + }, + "activity_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The network connection was abnormally terminated or closed by a middle device like firewalls.", + "caption": "Reset" + }, + "6": { + "description": "Network traffic report.", + "caption": "Traffic" + }, + "0": { + "description": "The event activity is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A new network connection was opened.", + "caption": "Open" + }, + "2": { + "description": "The network connection was closed.", + "caption": "Close" + }, + "99": { + "description": "The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The network connection failed. For example a connection timeout or no route to host.", + "caption": "Fail" + }, + "5": { + "description": "The network connection was refused. For example an attempt to connect to a server port which is not open.", + "caption": "Refuse" + }, + "7": { + "description": "A network endpoint began listening for new network connections.", + "caption": "Listen" + } + }, + "description": "The normalized identifier of the activity that triggered the event.", + "group": "classification", + "requirement": "required", + "caption": "Activity ID", + "sibling": "activity_name", + "type_name": "Integer", + "suppress_checks": [ + "sibling_convention" + ] + }, + "tls": { + "type": "object_t", + "description": "The Transport Layer Security (TLS) attributes.", + "group": "context", + "requirement": "optional", + "caption": "TLS", + "object_type": "tls", + "object_name": "Transport Layer Security (TLS)" + }, + "category_name": { + "type": "string_t", + "description": "The event category name, as defined by category_uid value: Network Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "start_time_dt": { + "type": "datetime_t", + "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.", + "group": "occurrence", + "requirement": "optional", + "caption": "Start Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "app_protocol_name": { + "type": "string_t", + "description": "The application-layer (Layer 7) protocol name identified by deep packet inspection or packet parsing (e.g., https, quic, ssh, dns), expressed as an IANA-registered service name from the IANA Service Name and Transport Protocol Port Number Registry.\n\n

Note: Port numbers alone are not always a reliable indicator of the actual application protocol in use.

", + "group": "context", + "references": [ + { + "description": "IANA Service Name and Transport Protocol Port Number Registry", + "url": "https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml" + } + ], + "requirement": "optional", + "caption": "Application Protocol Name", + "type_name": "String" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "group": "primary", + "requirement": "recommended", + "caption": "Message", + "type_name": "String" + }, + "raw_data_size": { + "type": "long_t", + "description": "The size of the raw data which was transformed into an OCSF event, in bytes.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data Size", + "type_name": "Long" + }, + "traffic": { + "type": "object_t", + "description": "The network traffic for this observation period. Use when reporting: (1) delta values (bytes/packets transferred since the last observation), (2) instantaneous measurements at a specific point in time, or (3) standalone single-event metrics. This attribute represents a point-in-time measurement or incremental change, not a running total. For accumulated totals across multiple observations or the lifetime of a flow, use cumulative_traffic instead.", + "group": "primary", + "requirement": "recommended", + "caption": "Traffic", + "object_type": "network_traffic", + "object_name": "Network Traffic" + }, + "status_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "The status is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Success" + }, + "2": { + "caption": "Failure" + }, + "99": { + "description": "The status is not mapped. See the status attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the event status.", + "group": "primary", + "requirement": "recommended", + "caption": "Status ID", + "sibling": "status", + "type_name": "Integer" + }, + "auth_type_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Authentication based on the client host's identity.", + "caption": "Host Based" + }, + "6": { + "description": "Paired public key authentication.", + "caption": "Public Key" + }, + "0": { + "description": "The authentication type is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Authentication using digital certificates.", + "caption": "Certificate Based" + }, + "2": { + "description": "GSSAPI for centralized authentication.", + "caption": "GSSAPI" + }, + "99": { + "description": "The authentication type is not mapped. See the auth_type attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Multi-step, interactive authentication.", + "caption": "Keyboard Interactive" + }, + "5": { + "description": "Password Authentication.", + "caption": "Password" + } + }, + "description": "The normalized identifier of the SSH authentication type.", + "group": "primary", + "requirement": "recommended", + "caption": "Authentication Type ID", + "sibling": "auth_type", + "type_name": "Integer" + }, + "class_name": { + "type": "string_t", + "description": "The event class name, as defined by class_uid value: SSH Activity.", + "group": "classification", + "requirement": "optional", + "caption": "Class", + "type_name": "String" + }, + "packet_list": { + "type": "object_t", + "description": "The list of packet objects describing captured network packets.", + "group": "context", + "is_array": true, + "requirement": "optional", + "caption": "Packets", + "object_type": "packet", + "object_name": "Packet" + }, + "proxy_tls": { + "type": "object_t", + "description": "The TLS protocol negotiated between the proxy server and the remote server.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy TLS", + "object_type": "tls", + "profiles": [ + "network_proxy" + ], + "object_name": "Transport Layer Security (TLS)" + }, + "activity_name": { + "type": "string_t", + "description": "The event activity name, as defined by the activity_id.", + "group": "classification", + "requirement": "optional", + "caption": "Activity", + "type_name": "String" + }, + "count": { + "type": "integer_t", + "description": "The number of times that events in the same logical group occurred during the event Start Time to End Time period.", + "group": "occurrence", + "requirement": "optional", + "caption": "Count", + "type_name": "Integer" + }, + "duration": { + "type": "long_t", + "description": "The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.", + "group": "occurrence", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "client_hassh": { + "type": "object_t", + "description": "The Client HASSH fingerprinting object.", + "group": "primary", + "requirement": "recommended", + "caption": "Client HASSH", + "object_type": "hassh", + "object_name": "HASSH" + }, + "action_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The activity was observed, but neither explicitly allowed nor denied. This is common with IDS and EDR controls that report additional information on observed behavior such as TTPs. The disposition_id attribute should be set to a value that conforms to this action, for example 'Logged', 'Alert', 'Detected', 'Count', etc.", + "caption": "Observed" + }, + "0": { + "description": "The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Custom Action', 'Challenge'.", + "caption": "Unknown" + }, + "1": { + "description": "The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc.", + "caption": "Allowed" + }, + "2": { + "description": "The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc.", + "caption": "Denied" + }, + "99": { + "description": "The action is not mapped. See the action attribute which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The activity was modified, adjusted, or corrected. The disposition_id attribute should be set appropriately, for example 'Restored', 'Corrected', 'Delayed', 'Captcha', 'Tagged'.", + "caption": "Modified" + } + }, + "description": "The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.", + "group": "primary", + "requirement": "recommended", + "caption": "Action ID", + "sibling": "action", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + }, + "class_uid": { + "type": "integer_t", + "enum": { + "4007": { + "description": "SSH Activity events report remote client connections to a server using the Secure Shell (SSH) Protocol.", + "caption": "SSH Activity" + } + }, + "description": "The unique identifier of a class. A class describes the attributes available in an event.", + "group": "classification", + "requirement": "required", + "caption": "Class ID", + "sibling": "class_name", + "type_name": "Integer" + }, + "unmapped": { + "type": "object_t", + "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.", + "group": "context", + "requirement": "optional", + "caption": "Unmapped Data", + "object_type": "object", + "object_name": "Object" + }, + "observation_point": { + "type": "string_t", + "description": "Indicates whether the source network endpoint, destination network endpoint, or neither served as the observation point for the activity. The value is normalized to the caption of the observation_point_id.", + "requirement": "optional", + "caption": "Observation Point", + "type_name": "String" + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "profiles": [ + "security_control" + ], + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "dst_endpoint": { + "type": "object_t", + "description": "The responder (server) in a network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Destination Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "is_alert": { + "type": "boolean_t", + "description": "Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", + "group": "primary", + "requirement": "recommended", + "caption": "Alert", + "profiles": [ + "security_control" + ], + "type_name": "Boolean" + }, + "policy": { + "type": "object_t", + "description": "The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.", + "group": "primary", + "requirement": "optional", + "caption": "Policy", + "object_type": "policy", + "profiles": [ + "security_control" + ], + "object_name": "Policy" + }, + "risk_details": { + "type": "string_t", + "description": "Describes the risk associated with the finding.", + "group": "context", + "requirement": "optional", + "caption": "Risk Details", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "src_endpoint": { + "type": "object_t", + "description": "The initiator (client) of the network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Source Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "raw_data": { + "type": "string_t", + "description": "The raw event/finding data as received from the source.", + "group": "context", + "requirement": "optional", + "caption": "Raw Data", + "type_name": "String" + }, + "malware": { + "type": "object_t", + "description": "A list of Malware objects, describing details about the identified malware.", + "group": "primary", + "is_array": true, + "requirement": "optional", + "caption": "Malware", + "object_type": "malware", + "profiles": [ + "security_control" + ], + "object_name": "Malware" + }, + "actor": { + "type": "object_t", + "description": "The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.", + "group": "primary", + "requirement": "optional", + "caption": "Actor", + "object_type": "actor", + "profiles": [ + "host" + ], + "object_name": "Actor" + }, + "proxy_connection_info": { + "type": "object_t", + "description": "The connection information from the proxy server to the remote server.", + "group": "context", + "requirement": "recommended", + "caption": "Proxy Connection Info", + "object_type": "network_connection_info", + "profiles": [ + "network_proxy" + ], + "object_name": "Network Connection Information" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "group": "context", + "requirement": "optional", + "caption": "Risk Level", + "profiles": [ + "security_control" + ], + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.", + "group": "primary", + "requirement": "recommended", + "caption": "Status", + "type_name": "String" + }, + "proxy": { + "type": "object_t", + "description": "The proxy (server) in a network connection.", + "group": "primary", + "requirement": "recommended", + "caption": "Proxy", + "object_type": "network_proxy", + "@deprecated": { + "message": "Use the proxy_endpoint attribute instead.", + "since": "1.1.0" + }, + "object_name": "Network Proxy Endpoint" + }, + "api": { + "type": "object_t", + "description": "Describes details about a typical API (Application Programming Interface) call.", + "group": "context", + "requirement": "optional", + "caption": "API Details", + "object_type": "api", + "profiles": [ + "cloud" + ], + "object_name": "API" + }, + "file": { + "type": "object_t", + "description": "The file that is the target of the SSH activity.", + "group": "context", + "requirement": "optional", + "caption": "File", + "object_type": "file", + "object_name": "File" + }, + "timezone_offset": { + "type": "integer_t", + "description": "The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.", + "group": "occurrence", + "requirement": "recommended", + "caption": "Timezone Offset", + "type_name": "Integer" + }, + "severity": { + "type": "string_t", + "description": "The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.", + "group": "classification", + "requirement": "optional", + "caption": "Severity", + "type_name": "String" + }, + "observation_point_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "Neither the source nor destination network endpoint is the observation point. Refer to the network_observation_point attribute for details.", + "caption": "Neither" + }, + "0": { + "description": "The observation point is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The source network endpoint is the observation point.", + "caption": "Source" + }, + "2": { + "description": "The destination network endpoint is the observation point.", + "caption": "Destination" + }, + "99": { + "description": "The observation point is not mapped. See the observation_point attribute for a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "Both the source and destination network endpoint are the observation point. This typically occurs in localhost or internal communications where the source and destination are the same endpoint, often resulting in a connection_info.direction of Local.", + "caption": "Both" + } + }, + "description": "The normalized identifier of the observation point. The observation point identifier indicates whether the source network endpoint, destination network endpoint, or neither served as the observation point for the activity.", + "requirement": "optional", + "caption": "Observation Point ID", + "sibling": "observation_point", + "type_name": "Integer" + }, + "disposition_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A suspicious file or other content was moved to a benign location.", + "caption": "Quarantined" + }, + "6": { + "description": "The request was detected as a threat and resulted in the connection being dropped.", + "caption": "Dropped" + }, + "0": { + "description": "The disposition is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "Granted access or allowed the action to the protected resource.", + "caption": "Allowed" + }, + "2": { + "description": "Denied access or blocked the action to the protected resource.", + "caption": "Blocked" + }, + "99": { + "description": "The disposition is not mapped. See the disposition attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A session was isolated on the network or within a browser.", + "caption": "Isolated" + }, + "5": { + "description": "A file or other content was deleted.", + "caption": "Deleted" + }, + "7": { + "description": "A custom action was executed such as running of a command script. Use the message attribute of the base class for details.", + "caption": "Custom Action" + }, + "8": { + "description": "A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'.", + "caption": "Approved" + }, + "9": { + "description": "A quarantined file or other content was restored to its original location.", + "caption": "Restored" + }, + "10": { + "description": "A suspicious or risky entity was deemed to no longer be suspicious (re-scored).", + "caption": "Exonerated" + }, + "11": { + "description": "A corrupt file or configuration was corrected.", + "caption": "Corrected" + }, + "12": { + "description": "A corrupt file or configuration was partially corrected.", + "caption": "Partially Corrected" + }, + "14": { + "description": "An operation was delayed, for example if a restart was required to finish the operation.", + "caption": "Delayed" + }, + "15": { + "description": "Suspicious activity or a policy violation was detected without further action.", + "caption": "Detected" + }, + "16": { + "description": "The outcome of an operation had no action taken.", + "caption": "No Action" + }, + "17": { + "description": "The operation or action was logged without further action.", + "caption": "Logged" + }, + "18": { + "description": "A file or other entity was marked with extended attributes.", + "caption": "Tagged" + }, + "20": { + "description": "Counted the request or activity but did not determine whether to allow it or block it.", + "caption": "Count" + }, + "21": { + "description": "The request was detected as a threat and resulted in the connection being reset.", + "caption": "Reset" + }, + "22": { + "description": "Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.", + "caption": "Captcha" + }, + "23": { + "description": "Ran a silent challenge that required the client session to verify that it's a browser, and not a bot.", + "caption": "Challenge" + }, + "24": { + "description": "The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class.", + "caption": "Access Revoked" + }, + "25": { + "description": "A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'.", + "caption": "Rejected" + }, + "26": { + "description": "An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail.", + "caption": "Unauthorized" + }, + "27": { + "description": "An error occurred during the processing of the activity or request. Use the message attribute of the base class for details.", + "caption": "Error" + }, + "13": { + "description": "A corrupt file or configuration was not corrected.", + "caption": "Uncorrected" + }, + "19": { + "description": "The request or activity was detected as a threat and resulted in a notification but request was not blocked.", + "caption": "Alert" + } + }, + "description": "Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.", + "group": "primary", + "requirement": "recommended", + "caption": "Disposition ID", + "sibling": "disposition", + "profiles": [ + "security_control" + ], + "type_name": "Integer" + } + }, + "name": "ssh_activity", + "description": "SSH Activity events report remote client connections to a server using the Secure Shell (SSH) Protocol.", + "uid": 4007, + "extends": "network", + "category": "network", + "constraints": { + "at_least_one": [ + "dst_endpoint", + "src_endpoint" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:SSHEvent", + "url": "https://d3fend.mitre.org/event/d3f:SSHEvent/" + } + ], + "caption": "SSH Activity", + "profiles": [ + "cloud", + "container", + "data_classification", + "datetime", + "host", + "linux/linux_users", + "load_balancer", + "macos/macos_users", + "network_proxy", + "osint", + "security_control" + ], + "category_name": "Network Activity", + "category_uid": 4 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/actor.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/actor.json new file mode 100644 index 0000000000..a03d3af355 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/actor.json @@ -0,0 +1,96 @@ +{ + "attributes": { + "process": { + "type": "object_t", + "description": "The process that initiated the activity.", + "requirement": "recommended", + "caption": "Process", + "object_type": "process", + "object_name": "Process" + }, + "session": { + "type": "object_t", + "description": "The user session from which the activity was initiated.", + "requirement": "optional", + "caption": "Session", + "object_type": "session", + "object_name": "Session" + }, + "user": { + "type": "object_t", + "description": "The user that initiated the activity or the user context from which the activity was initiated.", + "requirement": "recommended", + "caption": "User", + "object_type": "user", + "object_name": "User" + }, + "app_name": { + "type": "string_t", + "description": "The client application or service that initiated the activity. This can be in conjunction with the user if present. Note that app_name is distinct from the process if present.", + "requirement": "optional", + "caption": "Application Name", + "type_name": "String" + }, + "app_uid": { + "type": "string_t", + "description": "The unique identifier of the client application or service that initiated the activity. This can be in conjunction with the user if present. Note that app_name is distinct from the process.pid or process.uid if present.", + "requirement": "optional", + "caption": "Application ID", + "type_name": "String" + }, + "authorizations": { + "type": "object_t", + "description": "Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.", + "is_array": true, + "requirement": "optional", + "caption": "Authorization Information", + "object_type": "authorization", + "object_name": "Authorization Result" + }, + "idp": { + "type": "object_t", + "description": "This object describes details about the Identity Provider used.", + "requirement": "optional", + "caption": "Identity Provider", + "object_type": "idp", + "object_name": "Identity Provider" + }, + "invoked_by": { + "type": "string_t", + "description": "The name of the service that invoked the activity as described in the event.", + "requirement": "optional", + "caption": "Invoked by", + "type_name": "String", + "@deprecated": { + "message": "Use app_name, app_uid attributes instead.", + "since": "1.2.0" + } + } + }, + "name": "actor", + "description": "The Actor object contains details about the user, role, application, service, or process that initiated or performed a specific activity. Note that Actor is not the threat actor of a campaign but may be part of a campaign.", + "extends": "object", + "constraints": { + "at_least_one": [ + "process", + "user", + "invoked_by", + "session", + "app_name", + "app_uid" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:Agent.", + "url": "https://next.d3fend.mitre.org/agent/d3f:Agent/" + } + ], + "caption": "Actor", + "profiles": [ + "container", + "data_classification", + "linux/linux_users", + "macos/macos_users" + ] +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/ai_model.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/ai_model.json new file mode 100644 index 0000000000..5bc229b0ac --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/ai_model.json @@ -0,0 +1,52 @@ +{ + "attributes": { + "name": { + "type": "string_t", + "description": "Human-readable model name. For example: gpt-4o, claude-3-sonnet, or text-embedding-ada-002.", + "requirement": "required", + "caption": "Name", + "type_name": "String" + }, + "version": { + "type": "string_t", + "description": "Model version identifier. For example: 2024-05-13, v2.1.0, or beta.", + "requirement": "recommended", + "caption": "Version", + "type_name": "String" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the AI model.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String" + }, + "ai_provider": { + "type": "string_t", + "description": "AI service provider or organization name. For example: OpenAI, Anthropic, Google, or Internal.", + "requirement": "required", + "caption": "AI Provider", + "type_name": "String" + } + }, + "name": "ai_model", + "description": "The AI Model object describes the characteristics of an AI/ML model. Examples include language models like GPT-4, embedding models like text-embedding-ada-002, and computer vision models like CLIP.", + "extends": "_entity", + "constraints": { + "at_least_one": [ + "name", + "uid" + ] + }, + "references": [ + { + "description": "AI Model Registry and Documentation Standards", + "url": "https://huggingface.co/docs/hub/models" + }, + { + "description": "OpenAI Model Documentation", + "url": "https://platform.openai.com/docs/models" + } + ], + "caption": "AI Model" +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/attack.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/attack.json new file mode 100644 index 0000000000..f1e9235898 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/attack.json @@ -0,0 +1,117 @@ +{ + "attributes": { + "version": { + "type": "string_t", + "description": "The ATT&CK\u00ae or ATLAS\u2122 Matrix version.", + "requirement": "recommended", + "caption": "Version", + "type_name": "String" + }, + "tactics": { + "type": "object_t", + "description": "The Tactic object describes the tactic ID and/or tactic name that are associated with the attack technique, as defined by ATT&CK\u00ae Matrix.", + "is_array": true, + "requirement": "optional", + "caption": "Tactics", + "object_type": "tactic", + "@deprecated": { + "message": "Use the tactic attribute instead.", + "since": "1.1.0" + }, + "object_name": "MITRE Tactic" + }, + "technique": { + "type": "object_t", + "description": "The Technique object describes the MITRE ATT&CK\u00ae or ATLAS\u2122 Technique ID and/or name associated to an attack.", + "references": [ + { + "description": "ATT&CK\u00ae Matrix", + "url": "https://attack.mitre.org" + }, + { + "description": "ATLAS\u2122 Matrix", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "recommended", + "caption": "MITRE Technique", + "object_type": "technique", + "object_name": "MITRE Technique" + }, + "mitigation": { + "type": "object_t", + "description": "The Mitigation object describes the MITRE ATT&CK\u00ae or ATLAS\u2122 Mitigation ID and/or name that is associated to an attack.", + "references": [ + { + "description": "ATT&CK\u00ae Matrix", + "url": "https://attack.mitre.org" + }, + { + "description": "ATLAS\u2122 Matrix", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE Mitigation", + "object_type": "mitigation", + "object_name": "MITRE Mitigation" + }, + "sub_technique": { + "type": "object_t", + "description": "The Sub-technique object describes the MITRE ATT&CK\u00ae or ATLAS\u2122 Sub-technique ID and/or name associated to an attack.", + "references": [ + { + "description": "ATT&CK\u00ae Matrix", + "url": "https://attack.mitre.org" + }, + { + "description": "ATLAS\u2122 Matrix", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "recommended", + "caption": "MITRE Sub-technique", + "object_type": "sub_technique", + "object_name": "MITRE Sub-technique" + }, + "tactic": { + "type": "object_t", + "description": "The Tactic object describes the MITRE ATT&CK\u00ae or ATLAS\u2122 Tactic ID and/or name that is associated to an attack.", + "references": [ + { + "description": "ATT&CK\u00ae Matrix", + "url": "https://attack.mitre.org" + }, + { + "description": "ATLAS\u2122 Matrix", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "recommended", + "caption": "MITRE Tactic", + "object_type": "tactic", + "object_name": "MITRE Tactic" + } + }, + "name": "attack", + "description": "The MITRE ATT&CK\u00ae & ATLAS\u2122 object describes the tactic, technique, sub-technique & mitigation associated to an attack.", + "extends": "object", + "constraints": { + "at_least_one": [ + "tactic", + "technique", + "sub_technique" + ] + }, + "references": [ + { + "description": "ATT&CK\u00ae Matrix", + "url": "https://attack.mitre.org" + }, + { + "description": "ATLAS\u2122 Matrix", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "caption": "MITRE ATT&CK\u00ae & ATLAS\u2122" +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/connection_info.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/connection_info.json new file mode 100644 index 0000000000..7ad5deccd8 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/connection_info.json @@ -0,0 +1,3 @@ +{ + "error": "Object connection_info not found" +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/container.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/container.json new file mode 100644 index 0000000000..38310a308a --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/container.json @@ -0,0 +1,114 @@ +{ + "attributes": { + "name": { + "type": "string_t", + "description": "The container name.", + "requirement": "recommended", + "caption": "Name", + "type_name": "String" + }, + "runtime": { + "type": "string_t", + "description": "The backend running the container, such as containerd or cri-o.", + "requirement": "optional", + "caption": "Runtime", + "type_name": "String" + }, + "size": { + "type": "long_t", + "description": "The size of the container image.", + "requirement": "recommended", + "caption": "Size", + "type_name": "Long" + }, + "tag": { + "type": "string_t", + "description": "The tag used by the container. It can indicate version, format, OS.", + "requirement": "optional", + "caption": "Image Tag", + "type_name": "String", + "@deprecated": { + "message": "Use the labels or tags attribute instead.", + "since": "1.4.0" + } + }, + "uid": { + "type": "string_t", + "description": "The full container unique identifier for this instantiation of the container. For example: ac2ea168264a08f9aaca0dfc82ff3551418dfd22d02b713142a6843caa2f61bf.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String" + }, + "hash": { + "type": "object_t", + "description": "Commit hash of image created for docker or the SHA256 hash of the container. For example: 13550340a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de.", + "requirement": "recommended", + "caption": "Hash", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "image": { + "type": "object_t", + "description": "The container image used as a template to run the container.", + "requirement": "recommended", + "caption": "Image", + "object_type": "image", + "object_name": "Image" + }, + "labels": { + "type": "string_t", + "description": "The list of labels associated to the container.", + "is_array": true, + "requirement": "optional", + "caption": "Labels", + "type_name": "String" + }, + "tags": { + "type": "object_t", + "description": "The list of tags; {key:value} pairs associated to the container.", + "is_array": true, + "requirement": "optional", + "caption": "Tags", + "object_type": "key_value_object", + "object_name": "Key:Value object" + }, + "network_driver": { + "type": "string_t", + "description": "The network driver used by the container. For example, bridge, overlay, host, none, etc.", + "requirement": "optional", + "caption": "Network Driver", + "type_name": "String" + }, + "orchestrator": { + "type": "string_t", + "description": "The orchestrator managing the container, such as ECS, EKS, K8s, or OpenShift.", + "requirement": "optional", + "caption": "Orchestrator", + "type_name": "String" + }, + "pod_uuid": { + "type": "uuid_t", + "description": "The unique identifier of the pod (or equivalent) that the container is executing on.", + "requirement": "optional", + "caption": "Pod UUID", + "type_name": "UUID" + } + }, + "name": "container", + "description": "The Container object describes an instance of a specific container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.", + "extends": "object", + "constraints": { + "at_least_one": [ + "uid", + "name" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:ContainerProcess.", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:ContainerProcess/" + } + ], + "caption": "Container", + "observable": 27 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/device.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/device.json new file mode 100644 index 0000000000..f0005e9c33 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/device.json @@ -0,0 +1,642 @@ +{ + "attributes": { + "imei": { + "type": "string_t", + "description": "The International Mobile Equipment Identity that is associated with the device.", + "requirement": "optional", + "caption": "IMEI", + "type_name": "String", + "@deprecated": { + "message": "Use the imei_list attribute instead.", + "since": "1.4.0" + } + }, + "org": { + "type": "object_t", + "description": "Organization and org unit related to the device.", + "requirement": "optional", + "caption": "Organization", + "object_type": "organization", + "object_name": "Organization" + }, + "last_seen_time_dt": { + "type": "datetime_t", + "description": "The most recent discovery time of the device.", + "requirement": "optional", + "caption": "Last Seen", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "vpc_uid": { + "type": "string_t", + "description": "The unique identifier of the Virtual Private Cloud (VPC).", + "requirement": "optional", + "caption": "VPC UID", + "type_name": "String" + }, + "os": { + "type": "object_t", + "description": "The endpoint operating system.", + "requirement": "optional", + "caption": "OS", + "object_type": "os", + "object_name": "Operating System (OS)" + }, + "risk_score": { + "type": "integer_t", + "description": "The risk score as reported by the event source.", + "requirement": "optional", + "caption": "Risk Score", + "type_name": "Integer" + }, + "uid_alt": { + "type": "string_t", + "description": "An alternate unique identifier of the device if any. For example the ActiveDirectory DN.", + "requirement": "optional", + "caption": "Alternate ID", + "type_name": "String" + }, + "type_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A laptop computer.", + "caption": "Laptop" + }, + "6": { + "description": "A virtual machine.", + "caption": "Virtual" + }, + "0": { + "description": "The type is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A server.", + "caption": "Server" + }, + "2": { + "description": "A desktop computer.", + "caption": "Desktop" + }, + "99": { + "description": "The type is not mapped. See the type attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A tablet computer.", + "caption": "Tablet" + }, + "5": { + "description": "A mobile phone.", + "caption": "Mobile" + }, + "7": { + "description": "An IOT (Internet of Things) device.", + "caption": "IOT" + }, + "8": { + "description": "A web browser.", + "caption": "Browser" + }, + "9": { + "description": "A networking firewall.", + "caption": "Firewall" + }, + "10": { + "description": "A networking switch.", + "caption": "Switch" + }, + "11": { + "description": "A networking hub.", + "caption": "Hub" + }, + "12": { + "description": "A networking router.", + "caption": "Router" + }, + "14": { + "description": "An intrusion prevention system.", + "caption": "IPS" + }, + "15": { + "description": "A Load Balancer device.", + "caption": "Load Balancer" + }, + "13": { + "description": "An intrusion detection system.", + "caption": "IDS" + } + }, + "description": "The device type ID.", + "requirement": "required", + "caption": "Type ID", + "sibling": "type", + "type_name": "Integer" + }, + "is_backed_up": { + "type": "boolean_t", + "description": "Indicates whether the device or resource has a backup enabled, such as an automated snapshot or a cloud backup. For example, this is indicated by the cloudBackupEnabled value within JAMF Pro mobile devices or the registration of an AWS ARN with the AWS Backup service.", + "requirement": "optional", + "caption": "Back Ups Configured", + "type_name": "Boolean" + }, + "vendor_name": { + "type": "string_t", + "description": "The vendor for the device. For example Dell or Lenovo.", + "requirement": "recommended", + "caption": "Vendor Name", + "type_name": "String" + }, + "groups": { + "type": "object_t", + "description": "The group names to which the device belongs. For example: [\"Windows Laptops\", \"Engineering\"].", + "is_array": true, + "requirement": "optional", + "caption": "Groups", + "object_type": "group", + "object_name": "Group" + }, + "subnet_uid": { + "type": "string_t", + "description": "The unique identifier of a virtual subnet.", + "requirement": "optional", + "caption": "Subnet UID", + "type_name": "String" + }, + "created_time": { + "type": "timestamp_t", + "description": "The time when the device was known to have been created.", + "requirement": "optional", + "caption": "Created Time", + "type_name": "Timestamp" + }, + "is_shared": { + "type": "boolean_t", + "description": "The event occurred on a shared device.", + "requirement": "optional", + "caption": "Shared Device", + "type_name": "Boolean" + }, + "mac_vendor": { + "type": "string_t", + "description": "The vendor or manufacturer of the endpoint's network interface controller (NIC), as identified from the MAC address.", + "references": [ + { + "description": "IEEE Registration Authority", + "url": "https://standards.ieee.org/products-programs/regauth/" + } + ], + "requirement": "optional", + "caption": "MAC Vendor", + "type_name": "String" + }, + "owner": { + "type": "object_t", + "description": "The identity of the service or user account that owns the endpoint or was last logged into it.", + "requirement": "recommended", + "caption": "Owner", + "object_type": "user", + "object_name": "User" + }, + "vlan_uid": { + "type": "string_t", + "description": "The Virtual LAN identifier.", + "requirement": "optional", + "caption": "VLAN", + "type_name": "String" + }, + "desc": { + "type": "string_t", + "description": "The description of the device, ordinarily as reported by the operating system.", + "requirement": "optional", + "caption": "Description", + "type_name": "String" + }, + "type": { + "type": "string_t", + "description": "The device type. For example: unknown, server, desktop, laptop, tablet, mobile, virtual, browser, or other.", + "requirement": "recommended", + "caption": "Type", + "type_name": "String" + }, + "first_seen_time": { + "type": "timestamp_t", + "description": "The initial discovery time of the device.", + "requirement": "optional", + "caption": "First Seen", + "type_name": "Timestamp" + }, + "image": { + "type": "object_t", + "description": "The image used as a template to run the virtual machine.", + "requirement": "optional", + "caption": "Image", + "object_type": "image", + "object_name": "Image" + }, + "domain": { + "type": "string_t", + "description": "The network domain where the device resides. For example: work.example.com.", + "requirement": "optional", + "caption": "Domain", + "type_name": "String" + }, + "pool": { + "type": "object_t", + "description": "The pool of desktops or virtual machines to which the endpoint belongs.", + "requirement": "optional", + "caption": "Pool", + "object_type": "group", + "object_name": "Group" + }, + "location": { + "type": "object_t", + "description": "The geographical location of the device.", + "requirement": "optional", + "caption": "Geo Location", + "object_type": "location", + "object_name": "Geo Location" + }, + "interface_uid": { + "type": "string_t", + "description": "The unique identifier of the network interface.", + "requirement": "recommended", + "caption": "Network Interface ID", + "type_name": "String" + }, + "model": { + "type": "string_t", + "description": "The model of the device. For example ThinkPad X1 Carbon.", + "requirement": "optional", + "caption": "Model", + "type_name": "String" + }, + "modified_time_dt": { + "type": "datetime_t", + "description": "The time when the device was last known to have been modified.", + "requirement": "optional", + "caption": "Modified Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "eid": { + "type": "string_t", + "description": "An Embedded Identity Document, is a unique serial number that identifies an eSIM-enabled device.", + "requirement": "optional", + "caption": "EID", + "type_name": "String" + }, + "iccid": { + "type": "string_t", + "description": "The Integrated Circuit Card Identification of a mobile device. Typically it is a unique 18 to 22 digit number that identifies a SIM card.", + "requirement": "optional", + "caption": "ICCID", + "type_name": "String" + }, + "name": { + "type": "string_t", + "description": "The alternate device name, ordinarily as assigned by an administrator.

Note: The Name could be any other string that helps to identify the device, such as a phone number; for example 310-555-1234.

", + "requirement": "optional", + "caption": "Name", + "type_name": "String" + }, + "namespace_pid": { + "type": "integer_t", + "description": "If running under a process namespace (such as in a container), the process identifier within that process namespace.", + "group": "context", + "requirement": "recommended", + "caption": "Namespace PID", + "profiles": [ + "container" + ], + "type_name": "Integer" + }, + "is_trusted": { + "type": "boolean_t", + "description": "The event occurred on a trusted device.", + "requirement": "optional", + "caption": "Trusted Device", + "type_name": "Boolean" + }, + "os_machine_uuid": { + "type": "uuid_t", + "description": "The operating system assigned Machine ID. In Windows, this is the value stored at the registry path: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Cryptography\\MachineGuid. In Linux, this is stored in the file: /etc/machine-id.", + "requirement": "optional", + "caption": "OS Machine UUID", + "type_name": "UUID" + }, + "instance_uid": { + "type": "string_t", + "description": "The unique identifier of a VM instance.", + "requirement": "recommended", + "caption": "Instance ID", + "type_name": "String" + }, + "boot_uid": { + "type": "string_t", + "description": "A unique identifier of the device that changes after every reboot. For example, the value of /proc/sys/kernel/random/boot_id from Linux's procfs.", + "references": [ + { + "description": "Linux kernel's documentation", + "url": "https://docs.kernel.org/admin-guide/sysctl/kernel.html#random" + } + ], + "requirement": "optional", + "caption": "Boot UID", + "type_name": "String" + }, + "container": { + "type": "object_t", + "description": "The information describing an instance of a container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.", + "group": "context", + "requirement": "recommended", + "caption": "Container", + "object_type": "container", + "profiles": [ + "container" + ], + "object_name": "Container" + }, + "mac": { + "type": "mac_t", + "description": "The Media Access Control (MAC) address of the endpoint.", + "requirement": "optional", + "caption": "MAC Address", + "type_name": "MAC Address" + }, + "imei_list": { + "type": "string_t", + "description": "The International Mobile Equipment Identity values that are associated with the device.", + "is_array": true, + "requirement": "optional", + "caption": "IMEI List", + "type_name": "String" + }, + "hostname": { + "type": "hostname_t", + "description": "The device hostname.", + "requirement": "recommended", + "caption": "Hostname", + "type_name": "Hostname" + }, + "created_time_dt": { + "type": "datetime_t", + "description": "The time when the device was known to have been created.", + "requirement": "optional", + "caption": "Created Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "is_personal": { + "type": "boolean_t", + "description": "The event occurred on a personal device.", + "requirement": "optional", + "caption": "Personal Device", + "type_name": "Boolean" + }, + "interface_name": { + "type": "string_t", + "description": "The name of the network interface (e.g. eth2).", + "requirement": "recommended", + "caption": "Network Interface Name", + "type_name": "String" + }, + "is_supervised": { + "type": "boolean_t", + "description": "The event occurred on a supervised device. Devices that are supervised are typically mobile devices managed by a Mobile Device Management solution and are restricted from specific behaviors such as Apple AirDrop.", + "requirement": "optional", + "caption": "Supervised Device", + "type_name": "Boolean" + }, + "autoscale_uid": { + "type": "string_t", + "description": "The unique identifier of the cloud autoscale configuration.", + "requirement": "optional", + "caption": "Autoscale UID", + "type_name": "String" + }, + "is_managed": { + "type": "boolean_t", + "description": "The event occurred on a managed device.", + "requirement": "optional", + "caption": "Managed Device", + "type_name": "Boolean" + }, + "modified_time": { + "type": "timestamp_t", + "description": "The time when the device was last known to have been modified.", + "requirement": "optional", + "caption": "Modified Time", + "type_name": "Timestamp" + }, + "region": { + "type": "string_t", + "description": "The region where the virtual machine is located. For example, an AWS Region.", + "requirement": "recommended", + "caption": "Region", + "type_name": "String" + }, + "zone": { + "type": "string_t", + "description": "The network zone or LAN segment.", + "requirement": "optional", + "caption": "Network Zone", + "type_name": "String" + }, + "is_mobile_account_active": { + "type": "boolean_t", + "description": "Indicates whether the device has an active mobile account. For example, this is indicated by the itunesStoreAccountActive value within JAMF Pro mobile devices.", + "requirement": "optional", + "caption": "Mobile Account Active", + "type_name": "Boolean" + }, + "boot_time": { + "type": "timestamp_t", + "description": "The time the system was booted.", + "requirement": "optional", + "caption": "Boot Time", + "type_name": "Timestamp" + }, + "subnet": { + "type": "subnet_t", + "description": "The subnet mask.", + "requirement": "optional", + "caption": "Subnet", + "type_name": "Subnet" + }, + "udid": { + "type": "string_t", + "description": "The Apple assigned Unique Device Identifier (UDID). For iOS, iPadOS, tvOS, watchOS and visionOS devices, this is the UDID. For macOS devices, it is the Provisioning UDID. For example: 00008020-008D4548007B4F26", + "references": [ + { + "description": "Apple Wiki", + "url": "https://theapplewiki.com/wiki/UDID" + } + ], + "requirement": "optional", + "caption": "Unique Device Identifier", + "type_name": "String" + }, + "first_seen_time_dt": { + "type": "datetime_t", + "description": "The initial discovery time of the device.", + "requirement": "optional", + "caption": "First Seen", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "meid": { + "type": "string_t", + "description": "The Mobile Equipment Identifier. It's a unique number that identifies a Code Division Multiple Access (CDMA) mobile device.", + "requirement": "optional", + "caption": "MEID", + "type_name": "String" + }, + "is_compliant": { + "type": "boolean_t", + "description": "The event occurred on a compliant device.", + "requirement": "optional", + "caption": "Compliant Device", + "type_name": "Boolean" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the device. For example the Windows TargetSID or AWS EC2 ARN.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String", + "observable": 47 + }, + "risk_level_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "High" + }, + "0": { + "caption": "Info" + }, + "1": { + "caption": "Low" + }, + "2": { + "caption": "Medium" + }, + "99": { + "description": "The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "Critical" + } + }, + "description": "The normalized risk level id.", + "requirement": "optional", + "caption": "Risk Level ID", + "sibling": "risk_level", + "type_name": "Integer", + "suppress_checks": [ + "enum_convention" + ] + }, + "hw_info": { + "type": "object_t", + "description": "The endpoint hardware information.", + "requirement": "optional", + "caption": "Hardware Info", + "object_type": "device_hw_info", + "object_name": "Device Hardware Info" + }, + "risk_level": { + "type": "string_t", + "description": "The risk level, normalized to the caption of the risk_level_id value.", + "requirement": "optional", + "caption": "Risk Level", + "type_name": "String" + }, + "ip": { + "type": "ip_t", + "description": "The device IP address, in either IPv4 or IPv6 format.", + "requirement": "optional", + "caption": "IP Address", + "type_name": "IP Address" + }, + "network_interfaces": { + "type": "object_t", + "description": "The physical or virtual network interfaces that are associated with the device, one for each unique MAC address/IP address/hostname/name combination.

Note: The first element of the array is the network information that pertains to the event.

", + "is_array": true, + "requirement": "optional", + "caption": "Network Interfaces", + "object_type": "network_interface", + "object_name": "Network Interface" + }, + "last_seen_time": { + "type": "timestamp_t", + "description": "The most recent discovery time of the device.", + "requirement": "optional", + "caption": "Last Seen", + "type_name": "Timestamp" + }, + "boot_time_dt": { + "type": "datetime_t", + "description": "The time the system was booted.", + "requirement": "optional", + "caption": "Boot Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "agent_list": { + "type": "object_t", + "description": "A list of agent objects associated with a device, endpoint, or resource.", + "is_array": true, + "requirement": "optional", + "caption": "Agent List", + "object_type": "agent", + "object_name": "Agent" + }, + "hypervisor": { + "type": "string_t", + "description": "The name of the hypervisor running on the device. For example, Xen, VMware, Hyper-V, VirtualBox, etc.", + "requirement": "optional", + "caption": "Hypervisor", + "type_name": "String" + } + }, + "name": "device", + "description": "The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network.", + "extends": "endpoint", + "constraints": { + "at_least_one": [ + "ip", + "uid", + "name", + "hostname", + "instance_uid", + "interface_uid", + "interface_name" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:Host.", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:Host/" + } + ], + "caption": "Device", + "profiles": [ + "container", + "datetime" + ], + "observable": 20 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/evidences.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/evidences.json new file mode 100644 index 0000000000..30d372507f --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/evidences.json @@ -0,0 +1,333 @@ +{ + "attributes": { + "data": { + "type": "json_t", + "description": "Additional evidence data that is not accounted for in the specific evidence attributes. Use only when absolutely necessary.", + "requirement": "optional", + "caption": "Data", + "type_name": "JSON" + }, + "http_response": { + "type": "object_t", + "description": "Describes details about the http response associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "HTTP Response", + "object_type": "http_response", + "object_name": "HTTP Response" + }, + "http_request": { + "type": "object_t", + "description": "Describes details about the http request associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "HTTP Request", + "object_type": "http_request", + "object_name": "HTTP Request" + }, + "name": { + "type": "string_t", + "description": "The naming convention or type identifier of the evidence associated with the security detection. For example, the @odata.type from Microsoft Graph Alerts V2 or display_name from CrowdStrike Falcon Incident Behaviors.", + "requirement": "optional", + "caption": "Name", + "type_name": "String" + }, + "process": { + "type": "object_t", + "description": "Describes details about the process associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Process", + "object_type": "process", + "object_name": "Process" + }, + "file": { + "type": "object_t", + "description": "Describes details about the file associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "File", + "object_type": "file", + "object_name": "File" + }, + "user": { + "type": "object_t", + "description": "Describes details about the user that was the target or somehow else associated with the activity that triggered the detection.", + "requirement": "recommended", + "caption": "User", + "object_type": "user", + "object_name": "User" + }, + "script": { + "type": "object_t", + "description": "Describes details about the script that was associated with the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Script", + "object_type": "script", + "object_name": "Script" + }, + "device": { + "type": "object_t", + "description": "An addressable device, computer system or host associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Device", + "object_type": "device", + "object_name": "Device" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the evidence associated with the security detection. For example, the activity_id from CrowdStrike Falcon Alerts or behavior_id from CrowdStrike Falcon Incident Behaviors.", + "requirement": "optional", + "caption": "Unique ID", + "type_name": "String" + }, + "query": { + "type": "object_t", + "description": "Describes details about the DNS query associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "DNS Query", + "object_type": "dns_query", + "object_name": "DNS Query" + }, + "connection_info": { + "type": "object_t", + "description": "Describes details about the network connection associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Connection Info", + "object_type": "network_connection_info", + "object_name": "Network Connection Information" + }, + "url": { + "type": "object_t", + "description": "The URL object that pertains to the event or object associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "URL", + "object_type": "url", + "object_name": "Uniform Resource Locator" + }, + "email": { + "type": "object_t", + "description": "The email object associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Email", + "object_type": "email", + "object_name": "Email" + }, + "tls": { + "type": "object_t", + "description": "Describes details about the Transport Layer Security (TLS) activity that triggered the detection.", + "requirement": "recommended", + "caption": "TLS", + "object_type": "tls", + "object_name": "Transport Layer Security (TLS)" + }, + "api": { + "type": "object_t", + "description": "Describes details about the API call associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "API Details", + "object_type": "api", + "object_name": "API" + }, + "resources": { + "type": "object_t", + "description": "Describes details about the cloud resources directly related to activity that triggered the detection. For resources impacted by the detection, use Affected Resources at the top-level of the finding.", + "is_array": true, + "requirement": "recommended", + "caption": "Cloud Resources", + "object_type": "resource_details", + "object_name": "Resource Details" + }, + "actor": { + "type": "object_t", + "description": "Describes details about the user/role/process that was the source of the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Actor", + "object_type": "actor", + "object_name": "Actor" + }, + "container": { + "type": "object_t", + "description": "Describes details about the container associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Container", + "object_type": "container", + "object_name": "Container" + }, + "database": { + "type": "object_t", + "description": "Describes details about the database associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Database", + "object_type": "database", + "object_name": "Database" + }, + "databucket": { + "type": "object_t", + "description": "Describes details about the databucket associated to the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Databucket", + "object_type": "databucket", + "object_name": "Databucket" + }, + "dst_endpoint": { + "type": "object_t", + "description": "Describes details about the destination of the network activity that triggered the detection.", + "requirement": "recommended", + "caption": "Destination Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "ja4_fingerprint_list": { + "type": "object_t", + "description": "Describes details about the JA4+ fingerprints that triggered the detection.", + "is_array": true, + "requirement": "recommended", + "caption": "JA4+ Fingerprints", + "object_type": "ja4_fingerprint", + "object_name": "JA4+ Fingerprint" + }, + "job": { + "type": "object_t", + "description": "Describes details about the scheduled job that was associated with the activity that triggered the detection.", + "requirement": "recommended", + "caption": "Job", + "object_type": "job", + "object_name": "Job" + }, + "src_endpoint": { + "type": "object_t", + "description": "Describes details about the source of the network activity that triggered the detection.", + "requirement": "recommended", + "caption": "Source Endpoint", + "object_type": "network_endpoint", + "object_name": "Network Endpoint" + }, + "verdict": { + "type": "string_t", + "description": "The normalized verdict of the evidence associated with the security detection. ", + "requirement": "optional", + "caption": "Verdict", + "type_name": "String" + }, + "verdict_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "The verdict for the evidence is that is should be Disregarded.", + "caption": "Disregard" + }, + "6": { + "description": "The evidence is part of a Test, or other sanctioned behavior(s).", + "caption": "Test" + }, + "0": { + "description": "The type is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "The verdict for the evidence has been identified as a False Positive.", + "caption": "False Positive" + }, + "2": { + "description": "The verdict for the evidence has been identified as a True Positive.", + "caption": "True Positive" + }, + "99": { + "description": "The type is not mapped. See the type attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "The verdict for the evidence is that the behavior has been identified as Suspicious.", + "caption": "Suspicious" + }, + "5": { + "description": "The verdict for the evidence is that the behavior has been identified as Benign.", + "caption": "Benign" + }, + "7": { + "description": "There is insufficient data to render a verdict on the evidence.", + "caption": "Insufficient Data" + }, + "8": { + "description": "The verdict for the evidence is that the behavior has been identified as a Security Risk.", + "caption": "Security Risk" + }, + "9": { + "description": "The verdict for the evidence is Managed Externally, such as in a case management tool.", + "caption": "Managed Externally" + }, + "10": { + "description": "This evidence duplicates existing evidence related to this finding.", + "caption": "Duplicate" + } + }, + "description": "The normalized verdict (or status) ID of the evidence associated with the security detection. For example, Microsoft Graph Security Alerts contain a verdict enumeration for each type of evidence associated with the Alert. This is typically set by an automated investigation process or an analyst/investigator assigned to the finding.", + "requirement": "optional", + "caption": "Verdict ID", + "sibling": "verdict", + "type_name": "Integer" + }, + "reg_key": { + "type": "object_t", + "description": "Describes details about the registry key that triggered the detection.", + "extension": "win", + "requirement": "recommended", + "extension_id": 2, + "caption": "Registry Key", + "object_type": "win/reg_key", + "object_name": "Registry Key" + }, + "win_service": { + "type": "object_t", + "description": "Describes details about the Windows service that triggered the detection.", + "extension": "win", + "requirement": "recommended", + "extension_id": 2, + "caption": "Windows Service", + "object_type": "win/win_service", + "object_name": "Windows Service" + }, + "reg_value": { + "type": "object_t", + "description": "Describes details about the registry value that triggered the detection.", + "extension": "win", + "requirement": "recommended", + "extension_id": 2, + "caption": "Registry Value", + "object_type": "win/reg_value", + "object_name": "Registry Value" + } + }, + "name": "evidences", + "description": "A collection of evidence artifacts associated to the activity/activities that triggered a security detection.", + "extends": "_entity", + "constraints": { + "at_least_one": [ + "actor", + "api", + "connection_info", + "data", + "database", + "databucket", + "device", + "dst_endpoint", + "email", + "file", + "process", + "query", + "src_endpoint", + "url", + "user", + "job", + "script", + "reg_key", + "reg_value", + "win_service" + ] + }, + "caption": "Evidence Artifacts", + "profiles": [ + "cloud", + "container", + "data_classification", + "linux/linux_users", + "macos/macos_users" + ] +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/finding_info.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/finding_info.json new file mode 100644 index 0000000000..f04f27c999 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/finding_info.json @@ -0,0 +1,248 @@ +{ + "attributes": { + "title": { + "type": "string_t", + "description": "A title or a brief phrase summarizing the reported finding.", + "requirement": "recommended", + "caption": "Title", + "type_name": "String" + }, + "product": { + "type": "object_t", + "description": "Details about the product that reported the finding.", + "requirement": "optional", + "caption": "Product", + "object_type": "product", + "object_name": "Product" + }, + "desc": { + "type": "string_t", + "description": "The description of the reported finding.", + "requirement": "optional", + "caption": "Description", + "type_name": "String" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the reported finding.", + "requirement": "required", + "caption": "Unique ID", + "type_name": "String" + }, + "types": { + "type": "string_t", + "description": "One or more types of the reported finding.", + "is_array": true, + "requirement": "optional", + "caption": "Types", + "type_name": "String" + }, + "tags": { + "type": "object_t", + "description": "The list of tags; {key:value} pairs associated with the finding.", + "is_array": true, + "requirement": "optional", + "caption": "Tags", + "object_type": "key_value_object", + "object_name": "Key:Value object" + }, + "attacks": { + "type": "object_t", + "description": "The MITRE ATT&CK\u00ae technique and associated tactics related to the finding.", + "is_array": true, + "references": [ + { + "description": "MITRE ATT&CK\u00ae", + "url": "https://attack.mitre.org" + }, + { + "description": "MITRE ATLAS", + "url": "https://atlas.mitre.org/matrices/ATLAS" + } + ], + "requirement": "optional", + "caption": "MITRE ATT&CK\u00ae and ATLAS\u2122 Details", + "object_type": "attack", + "object_name": "MITRE ATT&CK\u00ae & ATLAS\u2122" + }, + "analytic": { + "type": "object_t", + "description": "The analytic technique used to analyze and derive insights from the data or information that led to the finding or conclusion.", + "requirement": "recommended", + "caption": "Analytic", + "object_type": "analytic", + "object_name": "Analytic" + }, + "attack_graph": { + "type": "object_t", + "description": "An Attack Graph describes possible routes an attacker could take through an environment. It describes relationships between resources and their findings, such as malware detections, vulnerabilities, misconfigurations, and other security actions.", + "group": "context", + "references": [ + { + "description": "MS Defender description of Attack Path", + "url": "https://learn.microsoft.com/en-us/azure/defender-for-cloud/how-to-manage-attack-path" + }, + { + "description": "SentinelOne Attack Path documentation", + "url": "https://www.sentinelone.com/cybersecurity-101/cybersecurity/attack-path-analysis/" + } + ], + "requirement": "optional", + "caption": "Attack Graph", + "object_type": "graph", + "object_name": "Graph" + }, + "created_time": { + "type": "timestamp_t", + "description": "The time when the finding was created.", + "requirement": "optional", + "caption": "Created Time", + "type_name": "Timestamp" + }, + "data_sources": { + "type": "string_t", + "description": "A list of data sources utilized in generation of the finding.", + "is_array": true, + "requirement": "optional", + "caption": "Data Sources", + "type_name": "String" + }, + "first_seen_time": { + "type": "timestamp_t", + "description": "The time when the finding was first observed. e.g. The time when a vulnerability was first observed.

It can differ from the created_time timestamp, which reflects the time this finding was created.

", + "requirement": "optional", + "caption": "First Seen", + "type_name": "Timestamp" + }, + "kill_chain": { + "type": "object_t", + "description": "The Cyber Kill Chain\u00ae provides a detailed description of each phase and its associated activities within the broader context of a cyber attack.", + "is_array": true, + "requirement": "optional", + "caption": "Kill Chain", + "object_type": "kill_chain_phase", + "object_name": "Kill Chain Phase" + }, + "last_seen_time": { + "type": "timestamp_t", + "description": "The time when the finding was most recently observed. e.g. The time when a vulnerability was most recently observed.

It can differ from the modified_time timestamp, which reflects the time this finding was last modified.

", + "requirement": "optional", + "caption": "Last Seen", + "type_name": "Timestamp" + }, + "modified_time": { + "type": "timestamp_t", + "description": "The time when the finding was last modified.", + "requirement": "optional", + "caption": "Modified Time", + "type_name": "Timestamp" + }, + "product_uid": { + "type": "string_t", + "description": "The unique identifier of the product that reported the finding.", + "requirement": "optional", + "caption": "Product Identifier", + "type_name": "String", + "@deprecated": { + "message": "Use the uid attribute in the product object instead. See specific usage.", + "since": "1.4.0" + } + }, + "related_analytics": { + "type": "object_t", + "description": "Other analytics related to this finding.", + "is_array": true, + "requirement": "optional", + "caption": "Related Analytics", + "object_type": "analytic", + "object_name": "Analytic" + }, + "related_events": { + "type": "object_t", + "description": "Describes events and/or other findings related to the finding as identified by the security product. Note that these events may or may not be in OCSF.", + "is_array": true, + "requirement": "optional", + "caption": "Related Events/Findings", + "object_type": "related_event", + "object_name": "Related Event/Finding" + }, + "related_events_count": { + "type": "integer_t", + "description": "Number of related events or findings.", + "requirement": "optional", + "caption": "Related Events/Findings Count", + "type_name": "Integer" + }, + "src_url": { + "type": "url_t", + "description": "The URL pointing to the source of the finding.", + "requirement": "optional", + "caption": "Source URL", + "type_name": "URL String" + }, + "traits": { + "type": "object_t", + "description": "The list of key traits or characteristics extracted from the finding.", + "is_array": true, + "requirement": "optional", + "caption": "Traits", + "object_type": "trait", + "object_name": "Trait" + }, + "uid_alt": { + "type": "string_t", + "description": "The alternative unique identifier of the reported finding.", + "requirement": "optional", + "caption": "Alternate ID", + "type_name": "String" + }, + "created_time_dt": { + "type": "datetime_t", + "description": "The time when the finding was created.", + "requirement": "optional", + "caption": "Created Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "first_seen_time_dt": { + "type": "datetime_t", + "description": "The time when the finding was first observed. e.g. The time when a vulnerability was first observed.

It can differ from the created_time timestamp, which reflects the time this finding was created.

", + "requirement": "optional", + "caption": "First Seen", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "last_seen_time_dt": { + "type": "datetime_t", + "description": "The time when the finding was most recently observed. e.g. The time when a vulnerability was most recently observed.

It can differ from the modified_time timestamp, which reflects the time this finding was last modified.

", + "requirement": "optional", + "caption": "Last Seen", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "modified_time_dt": { + "type": "datetime_t", + "description": "The time when the finding was last modified.", + "requirement": "optional", + "caption": "Modified Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + } + }, + "name": "finding_info", + "description": "The Finding Information object describes metadata related to a security finding generated by a security tool or system.", + "extends": "object", + "caption": "Finding Information", + "profiles": [ + "data_classification", + "datetime" + ] +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/firewall_rule.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/firewall_rule.json new file mode 100644 index 0000000000..c3bd49b621 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/firewall_rule.json @@ -0,0 +1,99 @@ +{ + "attributes": { + "name": { + "type": "string_t", + "description": "The name of the rule that generated the event.", + "requirement": "recommended", + "caption": "Name", + "type_name": "String" + }, + "type": { + "type": "string_t", + "description": "The rule type.", + "requirement": "optional", + "caption": "Type", + "type_name": "String" + }, + "version": { + "type": "string_t", + "description": "The rule version. For example: 1.1.", + "requirement": "optional", + "caption": "Version", + "type_name": "String" + }, + "desc": { + "type": "string_t", + "description": "The description of the rule that generated the event.", + "requirement": "optional", + "caption": "Description", + "type_name": "String" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the rule that generated the event.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String" + }, + "category": { + "type": "string_t", + "description": "The rule category.", + "requirement": "optional", + "caption": "Category", + "type_name": "String" + }, + "duration": { + "type": "long_t", + "description": "The rule response time duration, usually used for challenge completion time.", + "requirement": "optional", + "caption": "Duration Milliseconds", + "type_name": "Long" + }, + "condition": { + "type": "string_t", + "description": "The rule trigger condition for the rule. For example: SQL_INJECTION.", + "requirement": "optional", + "caption": "Condition", + "type_name": "String" + }, + "match_details": { + "type": "string_t", + "description": "The data in a request that rule matched. For example: '[\"10\",\"and\",\"1\"]'.", + "is_array": true, + "requirement": "optional", + "caption": "Match Details", + "type_name": "String" + }, + "match_location": { + "type": "string_t", + "description": "The location of the matched data in the source which resulted in the triggered firewall rule. For example: HEADER.", + "requirement": "optional", + "caption": "Match Location", + "type_name": "String" + }, + "rate_limit": { + "type": "integer_t", + "description": "The rate limit for a rate-based rule.", + "requirement": "optional", + "caption": "Rate Limit", + "type_name": "Integer" + }, + "sensitivity": { + "type": "string_t", + "description": "The sensitivity of the firewall rule in the matched event. For example: HIGH.", + "requirement": "optional", + "caption": "Sensitivity", + "type_name": "String" + } + }, + "name": "firewall_rule", + "description": "The Firewall Rule object represents a specific rule within a firewall policy or event. It contains information about a rule's configuration, properties, and associated actions that define how network traffic is handled by the firewall.", + "extends": "rule", + "constraints": { + "at_least_one": [ + "name", + "uid" + ] + }, + "caption": "Firewall Rule" +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/http_request.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/http_request.json new file mode 100644 index 0000000000..36baedb432 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/http_request.json @@ -0,0 +1,134 @@ +{ + "attributes": { + "args": { + "type": "string_t", + "description": "The arguments sent along with the HTTP request.", + "requirement": "optional", + "caption": "HTTP Arguments", + "type_name": "String" + }, + "version": { + "type": "string_t", + "description": "The Hypertext Transfer Protocol (HTTP) version.", + "requirement": "recommended", + "caption": "HTTP Version", + "type_name": "String" + }, + "length": { + "type": "integer_t", + "description": "The length of the entire HTTP request, in number of bytes.", + "requirement": "optional", + "caption": "Request Length", + "type_name": "Integer" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the http request.", + "requirement": "optional", + "caption": "Unique ID", + "type_name": "String" + }, + "url": { + "type": "object_t", + "description": "The URL object that pertains to the request.", + "requirement": "recommended", + "caption": "URL", + "object_type": "url", + "object_name": "Uniform Resource Locator" + }, + "x_forwarded_for": { + "type": "ip_t", + "description": "The X-Forwarded-For header identifying the originating IP address(es) of a client connecting to a web server through an HTTP proxy or a load balancer.", + "is_array": true, + "requirement": "optional", + "caption": "X-Forwarded-For", + "type_name": "IP Address" + }, + "body_length": { + "type": "integer_t", + "description": "The actual length of the HTTP request body, in number of bytes, independent of a potentially existing Content-Length header.", + "requirement": "optional", + "caption": "Request Body Length", + "type_name": "Integer" + }, + "user_agent": { + "type": "string_t", + "description": "The request header that identifies the operating system and web browser.", + "requirement": "recommended", + "caption": "HTTP User-Agent", + "type_name": "String", + "observable": 16 + }, + "http_headers": { + "type": "object_t", + "description": "Additional HTTP headers of an HTTP request or response.", + "is_array": true, + "requirement": "recommended", + "caption": "HTTP Headers", + "object_type": "http_header", + "object_name": "HTTP Header" + }, + "http_method": { + "type": "string_t", + "enum": { + "OPTIONS": { + "description": "The OPTIONS method describes the communication options for the target resource.", + "caption": "Options" + }, + "GET": { + "description": "The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.", + "caption": "Get" + }, + "HEAD": { + "description": "The HEAD method asks for a response identical to a GET request, but without the response body.", + "caption": "Head" + }, + "POST": { + "description": "The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.", + "caption": "Post" + }, + "PUT": { + "description": "The PUT method replaces all current representations of the target resource with the request payload.", + "caption": "Put" + }, + "DELETE": { + "description": "The DELETE method deletes the specified resource.", + "caption": "Delete" + }, + "TRACE": { + "description": "The TRACE method performs a message loop-back test along the path to the target resource.", + "caption": "Trace" + }, + "CONNECT": { + "description": "The CONNECT method establishes a tunnel to the server identified by the target resource.", + "caption": "Connect" + }, + "PATCH": { + "description": "The PATCH method applies partial modifications to a resource.", + "caption": "Patch" + } + }, + "description": "The HTTP request method indicates the desired action to be performed for a given resource.", + "requirement": "recommended", + "caption": "HTTP Method", + "type_name": "String" + }, + "referrer": { + "type": "string_t", + "description": "The request header that identifies the address of the previous web page, which is linked to the current web page or resource being requested.", + "requirement": "optional", + "caption": "HTTP Referrer", + "type_name": "String" + } + }, + "name": "http_request", + "description": "The HTTP Request object represents the attributes of a request made to a web server. It encapsulates the details and metadata associated with an HTTP request, including the request method, headers, URL, query parameters, body content, and other relevant information.", + "extends": "object", + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:OutboundInternetNetworkTraffic.", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:OutboundInternetNetworkTraffic/" + } + ], + "caption": "HTTP Request" +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/http_response.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/http_response.json new file mode 100644 index 0000000000..498bf2d2c5 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/http_response.json @@ -0,0 +1,72 @@ +{ + "attributes": { + "code": { + "type": "integer_t", + "description": "The Hypertext Transfer Protocol (HTTP) status code returned from the web server to the client. For example, 200.", + "requirement": "required", + "caption": "Response Code", + "type_name": "Integer" + }, + "message": { + "type": "string_t", + "description": "The description of the event/finding, as defined by the source.", + "requirement": "optional", + "caption": "Message", + "type_name": "String" + }, + "status": { + "type": "string_t", + "description": "The response status. For example: A successful HTTP status of 'OK' which corresponds to a code of 200.", + "requirement": "optional", + "caption": "Status", + "type_name": "String" + }, + "length": { + "type": "integer_t", + "description": "The length of the entire HTTP response, in number of bytes.", + "requirement": "optional", + "caption": "Response Length", + "type_name": "Integer" + }, + "content_type": { + "type": "string_t", + "description": "The request header that identifies the original media type of the resource (prior to any content encoding applied for sending).", + "requirement": "optional", + "caption": "HTTP Content Type", + "type_name": "String" + }, + "body_length": { + "type": "integer_t", + "description": "The actual length of the HTTP response body, in number of bytes, independent of a potentially existing Content-Length header.", + "requirement": "optional", + "caption": "Response Body Length", + "type_name": "Integer" + }, + "http_headers": { + "type": "object_t", + "description": "Additional HTTP headers of an HTTP request or response.", + "is_array": true, + "requirement": "recommended", + "caption": "HTTP Headers", + "object_type": "http_header", + "object_name": "HTTP Header" + }, + "latency": { + "type": "integer_t", + "description": "The HTTP response latency measured in milliseconds.", + "requirement": "optional", + "caption": "Latency", + "type_name": "Integer" + } + }, + "name": "http_response", + "description": "The HTTP Response object contains detailed information about the response sent from a web server to the requester. It encompasses attributes and metadata that describe the response status, headers, body content, and other relevant information.", + "extends": "object", + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:InboundInternetNetworkTraffic.", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:InboundInternetNetworkTraffic/" + } + ], + "caption": "HTTP Response" +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/metadata.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/metadata.json new file mode 100644 index 0000000000..b99a736684 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/metadata.json @@ -0,0 +1,338 @@ +{ + "attributes": { + "tenant_uid": { + "type": "string_t", + "description": "The unique tenant identifier.", + "requirement": "recommended", + "caption": "Tenant UID", + "type_name": "String" + }, + "log_version": { + "type": "string_t", + "description": "The event log schema version of the original event. For example the syslog version or the Cisco Log Schema version", + "requirement": "optional", + "caption": "Log Version", + "type_name": "String" + }, + "labels": { + "type": "string_t", + "description": "The list of labels attached to the event. For example: [\"sample\", \"dev\"]", + "is_array": true, + "requirement": "optional", + "caption": "Labels", + "type_name": "String" + }, + "original_time": { + "type": "string_t", + "description": "The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.", + "requirement": "recommended", + "caption": "Original Time", + "type_name": "String" + }, + "log_level": { + "type": "string_t", + "description": "The level at which an event was logged. This can be log provider specific. For example the audit level.", + "requirement": "optional", + "caption": "Log Level", + "type_name": "String" + }, + "transmit_time_dt": { + "type": "datetime_t", + "description": "The time when the event was transmitted from the logging device to it's next destination.", + "requirement": "optional", + "caption": "Transmission Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "is_truncated": { + "type": "boolean_t", + "description": "Indicates whether the OCSF event data has been truncated due to size limitations. When true, some event data may have been omitted to fit within system constraints.", + "requirement": "optional", + "caption": "Is Truncated", + "type_name": "Boolean" + }, + "processed_time": { + "type": "timestamp_t", + "description": "The event processed time, such as an ETL operation.", + "requirement": "optional", + "caption": "Processed Time", + "type_name": "Timestamp" + }, + "type": { + "type": "string_t", + "description": "The type of the event or finding as a subset of the source of the event. This can be any distinguishing characteristic of the data. For example 'Management Events' or 'Device Penetration Test'.", + "requirement": "optional", + "caption": "Type", + "type_name": "String" + }, + "extensions": { + "type": "object_t", + "description": "The schema extensions used to create the event.", + "is_array": true, + "requirement": "optional", + "caption": "Schema Extensions", + "object_type": "extension", + "object_name": "Schema Extension" + }, + "log_format": { + "type": "string_t", + "description": "The format of data in the log where the data originated. For example CSV, XML, Windows Multiline, JSON, syslog or Cisco Log Schema.", + "requirement": "optional", + "caption": "Log Source Format", + "type_name": "String" + }, + "untruncated_size": { + "type": "integer_t", + "description": "The original size of the OCSF event data in kilobytes before any truncation occurred. This field is typically populated when is_truncated is true to indicate the full size of the original event.", + "requirement": "optional", + "caption": "Untruncated Size", + "type_name": "Integer" + }, + "processed_time_dt": { + "type": "datetime_t", + "description": "The event processed time, such as an ETL operation.", + "requirement": "optional", + "caption": "Processed Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "modified_time_dt": { + "type": "datetime_t", + "description": "The time when the event was last modified or enriched.", + "requirement": "optional", + "caption": "Modified Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "original_event_uid": { + "type": "string_t", + "description": "The unique identifier assigned to the event in its original logging system before transformation to OCSF format. This field preserves the source system's native event identifier, enabling traceability back to the raw log entry. For example, a Windows Event Record ID, a syslog message ID, a Splunk _cd value, or a database transaction log sequence number.", + "requirement": "optional", + "caption": "Original Event ID", + "type_name": "String" + }, + "log_provider": { + "type": "string_t", + "description": "The logging provider or logging service that logged the event. For example AWS CloudWatch or Splunk.", + "requirement": "optional", + "caption": "Log Provider", + "type_name": "String" + }, + "loggers": { + "type": "object_t", + "description": "An array of Logger objects that describe the pipeline of devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow and/or to track the chain of custody of the data.", + "is_array": true, + "requirement": "optional", + "caption": "Loggers", + "object_type": "logger", + "object_name": "Logger" + }, + "log_source": { + "type": "string_t", + "description": "The log system or component where the data originated. For example, a file path, syslog server name or a Windows hostname and logging subsystem such as Security.", + "requirement": "optional", + "caption": "Log Source", + "type_name": "String" + }, + "log_name": { + "type": "string_t", + "description": "The event log name, typically for the consumer of the event. For example, the storage bucket name, SIEM repository index name, etc.", + "requirement": "recommended", + "caption": "Log Name", + "type_name": "String" + }, + "product": { + "type": "object_t", + "description": "The product that reported the event.", + "requirement": "required", + "caption": "Product", + "object_type": "product", + "object_name": "Product" + }, + "tags": { + "type": "object_t", + "description": "The list of tags; {key:value} pairs associated to the event.", + "is_array": true, + "requirement": "optional", + "caption": "Tags", + "object_type": "key_value_object", + "object_name": "Key:Value object" + }, + "profiles": { + "type": "string_t", + "description": "The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.", + "is_array": true, + "requirement": "optional", + "caption": "Profiles", + "type_name": "String" + }, + "extension": { + "type": "object_t", + "description": "The schema extension used to create the event.", + "requirement": "optional", + "caption": "Schema Extension", + "object_type": "extension", + "@deprecated": { + "message": "Use the extensions attribute instead.", + "since": "1.1.0" + }, + "object_name": "Schema Extension" + }, + "logged_time_dt": { + "type": "datetime_t", + "description": "

The time when the logging system collected and logged the event.

This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.", + "requirement": "optional", + "caption": "Logged Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "event_code": { + "type": "string_t", + "description": "The identifier of the original event. For example the numerical Windows Event Code or Cisco syslog code.", + "requirement": "optional", + "caption": "Event Code", + "type_name": "String" + }, + "reporter": { + "type": "object_t", + "description": "The entity from which the event or finding was first reported.", + "requirement": "recommended", + "caption": "Reporter", + "object_type": "reporter", + "object_name": "Reporter" + }, + "transformation_info_list": { + "type": "object_t", + "description": "An array of transformation info that describes the mappings or transforms applied to the data.", + "is_array": true, + "requirement": "optional", + "caption": "Transformation Info", + "object_type": "transformation_info", + "object_name": "Transformation Info" + }, + "version": { + "type": "string_t", + "description": "The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.", + "requirement": "required", + "caption": "Version", + "type_name": "String" + }, + "modified_time": { + "type": "timestamp_t", + "description": "The time when the event was last modified or enriched.", + "requirement": "optional", + "caption": "Modified Time", + "type_name": "Timestamp" + }, + "total_queued_duration": { + "type": "object_t", + "description": "The amount of time an event spent in a queue awaiting processing. In this case, the value is the difference between processed_time and logged_time. This duration is inclusive of all queues between the originator of the event and the intended long-term storage destination of the event.", + "requirement": "optional", + "caption": "Total Queued Duration", + "object_type": "timespan", + "object_name": "Time Span" + }, + "correlation_uid": { + "type": "string_t", + "description": "A unique identifier used to correlate this OCSF event with other related OCSF events, distinct from the event's uid value. This enables linking multiple OCSF events that are part of the same activity, transaction, or security incident across different systems or time periods.", + "requirement": "optional", + "caption": "Correlation UID", + "type_name": "String" + }, + "debug": { + "type": "string_t", + "description": "Debug information about non-fatal issues with this OCSF event. Each issue is a line in this string array.", + "is_array": true, + "requirement": "optional", + "caption": "Debug Information", + "type_name": "String" + }, + "data_classification": { + "type": "object_t", + "description": "The Data Classification object includes information about data classification levels and data category types.", + "group": "context", + "requirement": "recommended", + "caption": "Data Classification", + "object_type": "data_classification", + "profiles": [ + "data_classification" + ], + "@deprecated": { + "message": "Use the attribute data_classifications instead", + "since": "1.4.0" + }, + "object_name": "Data Classification" + }, + "source": { + "type": "string_t", + "description": "The source of the event or finding. This can be any distinguishing name for the logical origin of the data \u2014 for example, 'CloudTrail Events', or a use case like 'Attack Simulations' or 'Vulnerability Scans'.", + "requirement": "optional", + "caption": "Source", + "type_name": "String" + }, + "logged_time": { + "type": "timestamp_t", + "description": "

The time when the logging system collected and logged the event.

This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.", + "requirement": "optional", + "caption": "Logged Time", + "type_name": "Timestamp" + }, + "uid": { + "type": "string_t", + "description": "A unique identifier assigned to the OCSF event. This ID is specific to the OCSF event itself and is distinct from the original event identifier in the source system (see original_event_uid).", + "requirement": "optional", + "caption": "Event UID", + "type_name": "String" + }, + "sequence": { + "type": "integer_t", + "description": "Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.", + "requirement": "optional", + "caption": "Sequence Number", + "type_name": "Integer" + }, + "data_classifications": { + "type": "object_t", + "description": "A list of Data Classification objects, that include information about data classification levels and data category types, identified by a classifier.", + "group": "context", + "is_array": true, + "requirement": "recommended", + "caption": "Data Classification", + "object_type": "data_classification", + "profiles": [ + "data_classification" + ], + "object_name": "Data Classification" + }, + "transmit_time": { + "type": "timestamp_t", + "description": "The time when the event was transmitted from the logging device to it's next destination.", + "requirement": "optional", + "caption": "Transmission Time", + "type_name": "Timestamp" + } + }, + "name": "metadata", + "description": "The Metadata object describes the metadata associated with the event.", + "extends": "object", + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:Metadata", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:Metadata/" + } + ], + "caption": "Metadata", + "profiles": [ + "container", + "data_classification", + "datetime" + ] +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/network_endpoint.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/network_endpoint.json new file mode 100644 index 0000000000..5a510e4f02 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/network_endpoint.json @@ -0,0 +1,387 @@ +{ + "attributes": { + "vpc_uid": { + "type": "string_t", + "description": "The unique identifier of the Virtual Private Cloud (VPC).", + "requirement": "optional", + "caption": "VPC UID", + "type_name": "String" + }, + "os": { + "type": "object_t", + "description": "The endpoint operating system.", + "requirement": "optional", + "caption": "OS", + "object_type": "os", + "object_name": "Operating System (OS)" + }, + "type_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A laptop computer.", + "caption": "Laptop" + }, + "6": { + "description": "A virtual machine.", + "caption": "Virtual" + }, + "0": { + "description": "The type is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A server.", + "caption": "Server" + }, + "2": { + "description": "A desktop computer.", + "caption": "Desktop" + }, + "99": { + "description": "The type is not mapped. See the type attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A tablet computer.", + "caption": "Tablet" + }, + "5": { + "description": "A mobile phone.", + "caption": "Mobile" + }, + "7": { + "description": "An IOT (Internet of Things) device.", + "caption": "IOT" + }, + "8": { + "description": "A web browser.", + "caption": "Browser" + }, + "9": { + "description": "A networking firewall.", + "caption": "Firewall" + }, + "10": { + "description": "A networking switch.", + "caption": "Switch" + }, + "11": { + "description": "A networking hub.", + "caption": "Hub" + }, + "12": { + "description": "A networking router.", + "caption": "Router" + }, + "14": { + "description": "An intrusion prevention system.", + "caption": "IPS" + }, + "15": { + "description": "A Load Balancer device.", + "caption": "Load Balancer" + }, + "13": { + "description": "An intrusion detection system.", + "caption": "IDS" + } + }, + "description": "The network endpoint type ID.", + "requirement": "recommended", + "caption": "Type ID", + "sibling": "type", + "type_name": "Integer" + }, + "subnet_uid": { + "type": "string_t", + "description": "The unique identifier of a virtual subnet.", + "requirement": "optional", + "caption": "Subnet UID", + "type_name": "String" + }, + "network_scope_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "Unknown whether this endpoint resides within the customer\u2019s network.", + "caption": "Unknown" + }, + "1": { + "description": "The endpoint resides inside the customer\u2019s network.", + "caption": "Internal" + }, + "2": { + "description": "The endpoint is on the Internet or otherwise external to the customer\u2019s network.", + "caption": "External" + }, + "99": { + "description": "The network scope is not mapped. See the network_scope attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the endpoint\u2019s network scope. The normalized network scope identifier indicates whether the endpoint resides inside the customer\u2019s network, outside on the Internet, or if its location relative to the customer\u2019s network cannot be determined.", + "requirement": "optional", + "caption": "Network Scope ID", + "sibling": "network_scope", + "type_name": "Integer" + }, + "port": { + "type": "port_t", + "description": "The port used for communication within the network connection.", + "requirement": "recommended", + "caption": "Port", + "type_name": "Port" + }, + "mac_vendor": { + "type": "string_t", + "description": "The vendor or manufacturer of the endpoint's network interface controller (NIC), as identified from the MAC address.", + "references": [ + { + "description": "IEEE Registration Authority", + "url": "https://standards.ieee.org/products-programs/regauth/" + } + ], + "requirement": "optional", + "caption": "MAC Vendor", + "type_name": "String" + }, + "owner": { + "type": "object_t", + "description": "The identity of the service or user account that owns the endpoint or was last logged into it.", + "requirement": "recommended", + "caption": "Owner", + "object_type": "user", + "object_name": "User" + }, + "vlan_uid": { + "type": "string_t", + "description": "The Virtual LAN identifier.", + "requirement": "optional", + "caption": "VLAN", + "type_name": "String" + }, + "type": { + "type": "string_t", + "description": "The network endpoint type. For example: unknown, server, desktop, laptop, tablet, mobile, virtual, browser, or other.", + "requirement": "optional", + "caption": "Type", + "type_name": "String" + }, + "domain": { + "type": "string_t", + "description": "The name of the domain that the endpoint belongs to or that corresponds to the endpoint.", + "requirement": "optional", + "caption": "Domain", + "type_name": "String" + }, + "pool": { + "type": "object_t", + "description": "The pool of desktops or virtual machines to which the endpoint belongs.", + "requirement": "optional", + "caption": "Pool", + "object_type": "group", + "object_name": "Group" + }, + "location": { + "type": "object_t", + "description": "The geographical location of the endpoint.", + "requirement": "optional", + "caption": "Geo Location", + "object_type": "location", + "object_name": "Geo Location" + }, + "interface_uid": { + "type": "string_t", + "description": "The unique identifier of the network interface.", + "requirement": "recommended", + "caption": "Network Interface ID", + "type_name": "String" + }, + "network_scope": { + "type": "string_t", + "description": "Indicates whether the endpoint resides inside the customer\u2019s network, outside on the Internet, or if its location relative to the customer\u2019s network cannot be determined. The value is normalized to the caption of the network_scope_id.", + "requirement": "optional", + "caption": "Network Scope", + "type_name": "String" + }, + "proxy_endpoint": { + "type": "object_t", + "description": "The network proxy information pertaining to a specific endpoint. This can be used to describe information pertaining to network address translation (NAT).", + "requirement": "optional", + "caption": "Proxy Endpoint", + "object_type": "network_proxy", + "object_name": "Network Proxy Endpoint" + }, + "isp": { + "type": "string_t", + "description": "The name of the Internet Service Provider (ISP).", + "requirement": "optional", + "caption": "ISP Name", + "type_name": "String" + }, + "name": { + "type": "string_t", + "description": "The short name of the endpoint.", + "requirement": "recommended", + "caption": "Name", + "type_name": "String" + }, + "namespace_pid": { + "type": "integer_t", + "description": "If running under a process namespace (such as in a container), the process identifier within that process namespace.", + "group": "context", + "requirement": "recommended", + "caption": "Namespace PID", + "profiles": [ + "container" + ], + "type_name": "Integer" + }, + "autonomous_system": { + "type": "object_t", + "description": "The Autonomous System details associated with an IP address.", + "requirement": "optional", + "caption": "Autonomous System", + "object_type": "autonomous_system", + "object_name": "Autonomous System" + }, + "intermediate_ips": { + "type": "ip_t", + "description": "The intermediate IP Addresses. For example, the IP addresses in the HTTP X-Forwarded-For header.", + "is_array": true, + "requirement": "optional", + "caption": "Intermediate IP Addresses", + "type_name": "IP Address" + }, + "instance_uid": { + "type": "string_t", + "description": "The unique identifier of a VM instance.", + "requirement": "recommended", + "caption": "Instance ID", + "type_name": "String" + }, + "container": { + "type": "object_t", + "description": "The information describing an instance of a container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.", + "group": "context", + "requirement": "recommended", + "caption": "Container", + "object_type": "container", + "profiles": [ + "container" + ], + "object_name": "Container" + }, + "mac": { + "type": "mac_t", + "description": "The Media Access Control (MAC) address of the endpoint.", + "requirement": "optional", + "caption": "MAC Address", + "type_name": "MAC Address" + }, + "hostname": { + "type": "hostname_t", + "description": "The fully qualified name of the endpoint.", + "requirement": "recommended", + "caption": "Hostname", + "type_name": "Hostname" + }, + "interface_name": { + "type": "string_t", + "description": "The name of the network interface (e.g. eth2).", + "requirement": "recommended", + "caption": "Network Interface Name", + "type_name": "String" + }, + "zone": { + "type": "string_t", + "description": "The network zone or LAN segment.", + "requirement": "optional", + "caption": "Network Zone", + "type_name": "String" + }, + "svc_name": { + "type": "string_t", + "description": "The service name in service-to-service connections. For example, AWS VPC logs the pkt-src-aws-service and pkt-dst-aws-service fields identify the connection is coming from or going to an AWS service.", + "requirement": "recommended", + "caption": "Service Name", + "type_name": "String" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the endpoint.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String", + "observable": 48 + }, + "isp_org": { + "type": "string_t", + "description": "The organization name of the Internet Service Provider (ISP). This represents the parent organization or company that owns/operates the ISP. For example, Comcast Corporation would be the ISP org for Xfinity internet service. This attribute helps identify the ultimate provider when ISPs operate under different brand names.", + "requirement": "optional", + "caption": "ISP Org", + "type_name": "String" + }, + "hw_info": { + "type": "object_t", + "description": "The endpoint hardware information.", + "requirement": "optional", + "caption": "Hardware Info", + "object_type": "device_hw_info", + "object_name": "Device Hardware Info" + }, + "ip": { + "type": "ip_t", + "description": "The IP address of the endpoint, in either IPv4 or IPv6 format.", + "requirement": "recommended", + "caption": "IP Address", + "type_name": "IP Address" + }, + "fingerprints": { + "type": "object_t", + "description": "Fingerprints that identify the specific application implementation on this endpoint, such as Cisco NPF or HASSH.", + "is_array": true, + "requirement": "optional", + "caption": "Fingerprints", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "agent_list": { + "type": "object_t", + "description": "A list of agent objects associated with a device, endpoint, or resource.", + "is_array": true, + "requirement": "optional", + "caption": "Agent List", + "object_type": "agent", + "object_name": "Agent" + } + }, + "name": "network_endpoint", + "description": "The Network Endpoint object describes characteristics of a network endpoint. These can be a source or destination of a network connection.", + "extends": "endpoint", + "constraints": { + "at_least_one": [ + "ip", + "uid", + "name", + "hostname", + "svc_name", + "instance_uid", + "interface_uid", + "interface_name", + "domain" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:ComputerNetworkNode.", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:ComputerNetworkNode/" + } + ], + "caption": "Network Endpoint", + "profiles": [ + "container" + ], + "observable": 20 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/network_proxy.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/network_proxy.json new file mode 100644 index 0000000000..cf116e421b --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/network_proxy.json @@ -0,0 +1,387 @@ +{ + "attributes": { + "vpc_uid": { + "type": "string_t", + "description": "The unique identifier of the Virtual Private Cloud (VPC).", + "requirement": "optional", + "caption": "VPC UID", + "type_name": "String" + }, + "os": { + "type": "object_t", + "description": "The endpoint operating system.", + "requirement": "optional", + "caption": "OS", + "object_type": "os", + "object_name": "Operating System (OS)" + }, + "type_id": { + "type": "integer_t", + "enum": { + "3": { + "description": "A laptop computer.", + "caption": "Laptop" + }, + "6": { + "description": "A virtual machine.", + "caption": "Virtual" + }, + "0": { + "description": "The type is unknown.", + "caption": "Unknown" + }, + "1": { + "description": "A server.", + "caption": "Server" + }, + "2": { + "description": "A desktop computer.", + "caption": "Desktop" + }, + "99": { + "description": "The type is not mapped. See the type attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "description": "A tablet computer.", + "caption": "Tablet" + }, + "5": { + "description": "A mobile phone.", + "caption": "Mobile" + }, + "7": { + "description": "An IOT (Internet of Things) device.", + "caption": "IOT" + }, + "8": { + "description": "A web browser.", + "caption": "Browser" + }, + "9": { + "description": "A networking firewall.", + "caption": "Firewall" + }, + "10": { + "description": "A networking switch.", + "caption": "Switch" + }, + "11": { + "description": "A networking hub.", + "caption": "Hub" + }, + "12": { + "description": "A networking router.", + "caption": "Router" + }, + "14": { + "description": "An intrusion prevention system.", + "caption": "IPS" + }, + "15": { + "description": "A Load Balancer device.", + "caption": "Load Balancer" + }, + "13": { + "description": "An intrusion detection system.", + "caption": "IDS" + } + }, + "description": "The network endpoint type ID.", + "requirement": "recommended", + "caption": "Type ID", + "sibling": "type", + "type_name": "Integer" + }, + "subnet_uid": { + "type": "string_t", + "description": "The unique identifier of a virtual subnet.", + "requirement": "optional", + "caption": "Subnet UID", + "type_name": "String" + }, + "network_scope_id": { + "type": "integer_t", + "enum": { + "0": { + "description": "Unknown whether this endpoint resides within the customer\u2019s network.", + "caption": "Unknown" + }, + "1": { + "description": "The endpoint resides inside the customer\u2019s network.", + "caption": "Internal" + }, + "2": { + "description": "The endpoint is on the Internet or otherwise external to the customer\u2019s network.", + "caption": "External" + }, + "99": { + "description": "The network scope is not mapped. See the network_scope attribute, which contains a data source specific value.", + "caption": "Other" + } + }, + "description": "The normalized identifier of the endpoint\u2019s network scope. The normalized network scope identifier indicates whether the endpoint resides inside the customer\u2019s network, outside on the Internet, or if its location relative to the customer\u2019s network cannot be determined.", + "requirement": "optional", + "caption": "Network Scope ID", + "sibling": "network_scope", + "type_name": "Integer" + }, + "port": { + "type": "port_t", + "description": "The port used for communication within the network connection.", + "requirement": "recommended", + "caption": "Port", + "type_name": "Port" + }, + "mac_vendor": { + "type": "string_t", + "description": "The vendor or manufacturer of the endpoint's network interface controller (NIC), as identified from the MAC address.", + "references": [ + { + "description": "IEEE Registration Authority", + "url": "https://standards.ieee.org/products-programs/regauth/" + } + ], + "requirement": "optional", + "caption": "MAC Vendor", + "type_name": "String" + }, + "owner": { + "type": "object_t", + "description": "The identity of the service or user account that owns the endpoint or was last logged into it.", + "requirement": "recommended", + "caption": "Owner", + "object_type": "user", + "object_name": "User" + }, + "vlan_uid": { + "type": "string_t", + "description": "The Virtual LAN identifier.", + "requirement": "optional", + "caption": "VLAN", + "type_name": "String" + }, + "type": { + "type": "string_t", + "description": "The network endpoint type. For example: unknown, server, desktop, laptop, tablet, mobile, virtual, browser, or other.", + "requirement": "optional", + "caption": "Type", + "type_name": "String" + }, + "domain": { + "type": "string_t", + "description": "The name of the domain that the endpoint belongs to or that corresponds to the endpoint.", + "requirement": "optional", + "caption": "Domain", + "type_name": "String" + }, + "pool": { + "type": "object_t", + "description": "The pool of desktops or virtual machines to which the endpoint belongs.", + "requirement": "optional", + "caption": "Pool", + "object_type": "group", + "object_name": "Group" + }, + "location": { + "type": "object_t", + "description": "The geographical location of the endpoint.", + "requirement": "optional", + "caption": "Geo Location", + "object_type": "location", + "object_name": "Geo Location" + }, + "interface_uid": { + "type": "string_t", + "description": "The unique identifier of the network interface.", + "requirement": "recommended", + "caption": "Network Interface ID", + "type_name": "String" + }, + "network_scope": { + "type": "string_t", + "description": "Indicates whether the endpoint resides inside the customer\u2019s network, outside on the Internet, or if its location relative to the customer\u2019s network cannot be determined. The value is normalized to the caption of the network_scope_id.", + "requirement": "optional", + "caption": "Network Scope", + "type_name": "String" + }, + "proxy_endpoint": { + "type": "object_t", + "description": "The network proxy information pertaining to a specific endpoint. This can be used to describe information pertaining to network address translation (NAT).", + "requirement": "optional", + "caption": "Proxy Endpoint", + "object_type": "network_proxy", + "object_name": "Network Proxy Endpoint" + }, + "isp": { + "type": "string_t", + "description": "The name of the Internet Service Provider (ISP).", + "requirement": "optional", + "caption": "ISP Name", + "type_name": "String" + }, + "name": { + "type": "string_t", + "description": "The short name of the endpoint.", + "requirement": "recommended", + "caption": "Name", + "type_name": "String" + }, + "namespace_pid": { + "type": "integer_t", + "description": "If running under a process namespace (such as in a container), the process identifier within that process namespace.", + "group": "context", + "requirement": "recommended", + "caption": "Namespace PID", + "profiles": [ + "container" + ], + "type_name": "Integer" + }, + "autonomous_system": { + "type": "object_t", + "description": "The Autonomous System details associated with an IP address.", + "requirement": "optional", + "caption": "Autonomous System", + "object_type": "autonomous_system", + "object_name": "Autonomous System" + }, + "intermediate_ips": { + "type": "ip_t", + "description": "The intermediate IP Addresses. For example, the IP addresses in the HTTP X-Forwarded-For header.", + "is_array": true, + "requirement": "optional", + "caption": "Intermediate IP Addresses", + "type_name": "IP Address" + }, + "instance_uid": { + "type": "string_t", + "description": "The unique identifier of a VM instance.", + "requirement": "recommended", + "caption": "Instance ID", + "type_name": "String" + }, + "container": { + "type": "object_t", + "description": "The information describing an instance of a container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.", + "group": "context", + "requirement": "recommended", + "caption": "Container", + "object_type": "container", + "profiles": [ + "container" + ], + "object_name": "Container" + }, + "mac": { + "type": "mac_t", + "description": "The Media Access Control (MAC) address of the endpoint.", + "requirement": "optional", + "caption": "MAC Address", + "type_name": "MAC Address" + }, + "hostname": { + "type": "hostname_t", + "description": "The fully qualified name of the endpoint.", + "requirement": "recommended", + "caption": "Hostname", + "type_name": "Hostname" + }, + "interface_name": { + "type": "string_t", + "description": "The name of the network interface (e.g. eth2).", + "requirement": "recommended", + "caption": "Network Interface Name", + "type_name": "String" + }, + "zone": { + "type": "string_t", + "description": "The network zone or LAN segment.", + "requirement": "optional", + "caption": "Network Zone", + "type_name": "String" + }, + "svc_name": { + "type": "string_t", + "description": "The service name in service-to-service connections. For example, AWS VPC logs the pkt-src-aws-service and pkt-dst-aws-service fields identify the connection is coming from or going to an AWS service.", + "requirement": "recommended", + "caption": "Service Name", + "type_name": "String" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the endpoint.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String", + "observable": 48 + }, + "isp_org": { + "type": "string_t", + "description": "The organization name of the Internet Service Provider (ISP). This represents the parent organization or company that owns/operates the ISP. For example, Comcast Corporation would be the ISP org for Xfinity internet service. This attribute helps identify the ultimate provider when ISPs operate under different brand names.", + "requirement": "optional", + "caption": "ISP Org", + "type_name": "String" + }, + "hw_info": { + "type": "object_t", + "description": "The endpoint hardware information.", + "requirement": "optional", + "caption": "Hardware Info", + "object_type": "device_hw_info", + "object_name": "Device Hardware Info" + }, + "ip": { + "type": "ip_t", + "description": "The IP address of the endpoint, in either IPv4 or IPv6 format.", + "requirement": "recommended", + "caption": "IP Address", + "type_name": "IP Address" + }, + "fingerprints": { + "type": "object_t", + "description": "Fingerprints that identify the specific application implementation on this endpoint, such as Cisco NPF or HASSH.", + "is_array": true, + "requirement": "optional", + "caption": "Fingerprints", + "object_type": "fingerprint", + "object_name": "Fingerprint" + }, + "agent_list": { + "type": "object_t", + "description": "A list of agent objects associated with a device, endpoint, or resource.", + "is_array": true, + "requirement": "optional", + "caption": "Agent List", + "object_type": "agent", + "object_name": "Agent" + } + }, + "name": "network_proxy", + "description": "The network proxy endpoint object describes a proxy server, which acts as an intermediary between a client requesting a resource and the server providing that resource.", + "extends": "network_endpoint", + "constraints": { + "at_least_one": [ + "ip", + "uid", + "name", + "hostname", + "svc_name", + "instance_uid", + "interface_uid", + "interface_name", + "domain" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:ProxyServer", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:ProxyServer/" + } + ], + "caption": "Network Proxy Endpoint", + "profiles": [ + "container" + ], + "observable": 20 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/process.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/process.json new file mode 100644 index 0000000000..e08dbe80ab --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/process.json @@ -0,0 +1,357 @@ +{ + "attributes": { + "name": { + "type": "process_name_t", + "description": "The friendly name of the process, for example: Notepad++.", + "requirement": "recommended", + "caption": "Name", + "type_name": "Process Name" + }, + "pid": { + "type": "integer_t", + "description": "The process identifier, as reported by the operating system. Process ID (PID) is a number used by the operating system to uniquely identify an active process.", + "requirement": "recommended", + "caption": "Process ID", + "type_name": "Integer", + "observable": 15 + }, + "session": { + "type": "object_t", + "description": "The user session under which this process is running.", + "requirement": "optional", + "caption": "Session", + "object_type": "session", + "object_name": "Session" + }, + "file": { + "type": "object_t", + "description": "The process file object.", + "requirement": "recommended", + "caption": "File", + "object_type": "file", + "object_name": "File" + }, + "user": { + "type": "object_t", + "description": "The user under which this process is running.", + "requirement": "recommended", + "caption": "User", + "object_type": "user", + "object_name": "User" + }, + "path": { + "type": "string_t", + "description": "The process file path.", + "requirement": "optional", + "caption": "Path", + "type_name": "String" + }, + "group": { + "type": "object_t", + "description": "The group under which this process is running.", + "requirement": "recommended", + "caption": "Group", + "object_type": "group", + "profiles": [ + "linux/linux_users" + ], + "object_name": "Group" + }, + "tid": { + "type": "integer_t", + "description": "The identifier of the thread associated with the event, as returned by the operating system.", + "requirement": "optional", + "caption": "Thread ID", + "type_name": "Integer", + "@deprecated": { + "message": "tid is deprecated in favor of ptid. ptid has type long_t which can accommodate the thread identifiers returned by all platforms (e.g. 64-bit on MacOS).", + "since": "1.6.0" + } + }, + "uid": { + "type": "string_t", + "description": "A unique identifier for this process assigned by the producer (tool). Facilitates correlation of a process event with other events for that process.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String", + "observable": 39 + }, + "loaded_modules": { + "type": "string_t", + "description": "The list of loaded module names.", + "is_array": true, + "requirement": "optional", + "caption": "Loaded Modules", + "type_name": "String" + }, + "ancestry": { + "type": "object_t", + "description": "An array of Process Entities describing the extended parentage of this process object. Direct parent information should be expressed through the parent_process attribute. The first array element is the direct parent of this process object. Subsequent list elements go up the process parentage hierarchy. That is, the array is sorted from newest to oldest process. It is recommended to only populate this field for the top-level process object.", + "is_array": true, + "references": [ + { + "description": "Guidance on Representing Process Parentage", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/representing-process-parentage.md" + } + ], + "requirement": "optional", + "caption": "Ancestry", + "object_type": "process_entity", + "object_name": "Process Entity" + }, + "auid": { + "type": "integer_t", + "description": "The audit user assigned at login by the audit subsystem.", + "requirement": "optional", + "caption": "Audit User ID", + "profiles": [ + "linux/linux_users" + ], + "type_name": "Integer" + }, + "cmd_line": { + "type": "string_t", + "description": "The full command line used to launch an application, service, process, or job. For example: ssh user@10.0.0.10. If the command line is unavailable or missing, the empty string '' is to be used.", + "requirement": "recommended", + "caption": "Command Line", + "type_name": "String", + "observable": 13 + }, + "container": { + "type": "object_t", + "description": "The information describing an instance of a container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.", + "group": "context", + "requirement": "recommended", + "caption": "Container", + "object_type": "container", + "profiles": [ + "container" + ], + "object_name": "Container" + }, + "cpid": { + "type": "uuid_t", + "description": "A unique process identifier that can be assigned deterministically by multiple system data producers.", + "source": "cpid", + "references": [ + { + "description": "OCSF Common Process Identifier (CPID) Specification", + "url": "https://github.com/ocsf/common-process-id" + } + ], + "requirement": "recommended", + "caption": "Common Process Identifier", + "type_name": "UUID" + }, + "created_time": { + "type": "timestamp_t", + "description": "The time when the process was created/started.", + "requirement": "recommended", + "caption": "Created Time", + "type_name": "Timestamp" + }, + "egid": { + "type": "integer_t", + "description": "The effective group under which this process is running.", + "requirement": "optional", + "caption": "Effective Group ID", + "profiles": [ + "linux/linux_users", + "macos/macos_users" + ], + "type_name": "Integer" + }, + "environment_variables": { + "type": "object_t", + "description": "Environment variables associated with the process.", + "is_array": true, + "requirement": "optional", + "caption": "Environment Variables", + "object_type": "environment_variable", + "object_name": "Environment Variable" + }, + "euid": { + "type": "integer_t", + "description": "The effective user under which this process is running.", + "requirement": "optional", + "caption": "Effective User ID", + "profiles": [ + "linux/linux_users", + "macos/macos_users" + ], + "type_name": "Integer" + }, + "integrity": { + "type": "string_t", + "description": "The process integrity level, normalized to the caption of the integrity_id value. In the case of 'Other', it is defined by the event source (Windows only).", + "requirement": "optional", + "caption": "Integrity", + "type_name": "String" + }, + "integrity_id": { + "type": "integer_t", + "enum": { + "3": { + "caption": "Medium" + }, + "6": { + "caption": "Protected" + }, + "0": { + "description": "The integrity level is unknown.", + "caption": "Unknown" + }, + "1": { + "caption": "Untrusted" + }, + "2": { + "caption": "Low" + }, + "99": { + "description": "The integrity level is not mapped. See the integrity attribute, which contains a data source specific value.", + "caption": "Other" + }, + "4": { + "caption": "High" + }, + "5": { + "caption": "System" + } + }, + "description": "The normalized identifier of the process integrity level (Windows only).", + "requirement": "optional", + "caption": "Integrity Level", + "sibling": "integrity", + "type_name": "Integer" + }, + "lineage": { + "type": "file_path_t", + "description": "The lineage of the process, represented by a list of paths for each ancestor process. For example: ['/usr/sbin/sshd', '/usr/bin/bash', '/usr/bin/whoami'].", + "is_array": true, + "requirement": "optional", + "caption": "Lineage", + "type_name": "File Path", + "@deprecated": { + "message": "Use the ancestry attribute.", + "since": "1.4.0" + } + }, + "namespace_pid": { + "type": "integer_t", + "description": "If running under a process namespace (such as in a container), the process identifier within that process namespace.", + "group": "context", + "requirement": "recommended", + "caption": "Namespace PID", + "profiles": [ + "container" + ], + "type_name": "Integer" + }, + "parent_process": { + "type": "object_t", + "description": "The parent process of this process object. It is recommended to only populate this field for the top-level process object, to prevent deep nesting. Additional ancestry information can be supplied in the ancestry attribute.", + "references": [ + { + "description": "Guidance on Representing Process Parentage", + "url": "https://github.com/ocsf/ocsf-docs/blob/main/articles/representing-process-parentage.md" + } + ], + "requirement": "recommended", + "caption": "Parent Process", + "object_type": "process", + "object_name": "Process" + }, + "ptid": { + "type": "long_t", + "description": "The identifier of the process thread associated with the event, as returned by the operating system.", + "requirement": "optional", + "caption": "Process Thread ID", + "type_name": "Long" + }, + "sandbox": { + "type": "string_t", + "description": "The name of the containment jail (i.e., sandbox). For example, hardened_ps, high_security_ps, oracle_ps, netsvcs_ps, or default_ps.", + "requirement": "optional", + "caption": "Sandbox", + "type_name": "String" + }, + "terminated_time": { + "type": "timestamp_t", + "description": "The time when the process was terminated.", + "requirement": "optional", + "caption": "Terminated Time", + "type_name": "Timestamp" + }, + "working_directory": { + "type": "string_t", + "description": "The working directory of a process.", + "requirement": "optional", + "caption": "Working Directory", + "type_name": "String" + }, + "xattributes": { + "type": "object_t", + "description": "An unordered collection of zero or more name/value pairs that represent a process extended attribute.", + "requirement": "optional", + "caption": "Extended Attributes", + "object_type": "object", + "object_name": "Object" + }, + "created_time_dt": { + "type": "datetime_t", + "description": "The time when the process was created/started.", + "requirement": "optional", + "caption": "Created Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "terminated_time_dt": { + "type": "datetime_t", + "description": "The time when the process was terminated.", + "requirement": "optional", + "caption": "Terminated Time", + "profiles": [ + "datetime" + ], + "type_name": "Datetime" + }, + "hosted_services": { + "type": "object_t", + "description": "The Windows services that this process is hosting.", + "extension": "win", + "is_array": true, + "requirement": "optional", + "extension_id": 2, + "caption": "Hosted Services", + "object_type": "win/win_service", + "object_name": "Windows Service" + } + }, + "name": "process", + "description": "The Process object describes a running instance of a launched program.", + "extends": "process_entity", + "constraints": { + "at_least_one": [ + "pid", + "uid", + "cpid" + ] + }, + "references": [ + { + "description": "D3FEND\u2122 Ontology d3f:Process", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:Process/" + } + ], + "caption": "Process", + "profiles": [ + "container", + "data_classification", + "datetime", + "linux/linux_users", + "macos/macos_users" + ], + "observable": 25 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/product.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/product.json new file mode 100644 index 0000000000..b97aac76b8 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/product.json @@ -0,0 +1,110 @@ +{ + "attributes": { + "name": { + "type": "string_t", + "description": "The name of the product.", + "requirement": "recommended", + "caption": "Name", + "type_name": "String" + }, + "version": { + "type": "string_t", + "description": "The version of the product, as defined by the event source. For example: 2013.1.3-beta.", + "requirement": "recommended", + "caption": "Version", + "type_name": "String" + }, + "path": { + "type": "string_t", + "description": "The installation path of the product.", + "requirement": "optional", + "caption": "Path", + "type_name": "String" + }, + "uid": { + "type": "string_t", + "description": "The unique identifier of the product.", + "requirement": "recommended", + "caption": "Unique ID", + "type_name": "String" + }, + "feature": { + "type": "object_t", + "description": "The feature that reported the event.", + "requirement": "optional", + "caption": "Feature", + "object_type": "feature", + "object_name": "Feature" + }, + "lang": { + "type": "string_t", + "description": "The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).", + "requirement": "optional", + "caption": "Language", + "type_name": "String" + }, + "cpe_name": { + "type": "string_t", + "description": "The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.", + "requirement": "optional", + "caption": "The product CPE identifier", + "type_name": "String" + }, + "data_classification": { + "type": "object_t", + "description": "The Data Classification object includes information about data classification levels and data category types.", + "group": "context", + "requirement": "recommended", + "caption": "Data Classification", + "object_type": "data_classification", + "profiles": [ + "data_classification" + ], + "@deprecated": { + "message": "Use the attribute data_classifications instead", + "since": "1.4.0" + }, + "object_name": "Data Classification" + }, + "data_classifications": { + "type": "object_t", + "description": "A list of Data Classification objects, that include information about data classification levels and data category types, identified by a classifier.", + "group": "context", + "is_array": true, + "requirement": "recommended", + "caption": "Data Classification", + "object_type": "data_classification", + "profiles": [ + "data_classification" + ], + "object_name": "Data Classification" + }, + "url_string": { + "type": "url_t", + "description": "The URL pointing towards the product.", + "requirement": "optional", + "caption": "URL String", + "type_name": "URL String" + }, + "vendor_name": { + "type": "string_t", + "description": "The name of the vendor of the product.", + "requirement": "recommended", + "caption": "Vendor Name", + "type_name": "String" + } + }, + "name": "product", + "description": "The Product object describes characteristics of a software product.", + "extends": "_entity", + "constraints": { + "at_least_one": [ + "name", + "uid" + ] + }, + "caption": "Product", + "profiles": [ + "data_classification" + ] +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/remediation.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/remediation.json new file mode 100644 index 0000000000..ff83d907df --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/remediation.json @@ -0,0 +1,62 @@ +{ + "attributes": { + "desc": { + "type": "string_t", + "description": "The description of the remediation strategy.", + "requirement": "required", + "caption": "Description", + "type_name": "String" + }, + "references": { + "type": "string_t", + "description": "A list of supporting URL/s, references that help describe the remediation strategy.", + "is_array": true, + "requirement": "optional", + "caption": "References", + "type_name": "String" + }, + "cis_controls": { + "type": "object_t", + "description": "An array of Center for Internet Security (CIS) Controls that can be optionally mapped to provide additional remediation details.", + "is_array": true, + "references": [ + { + "description": "Center For Internet Security Controls", + "url": "https://www.cisecurity.org/controls/" + } + ], + "requirement": "optional", + "caption": "CIS Controls", + "object_type": "cis_control", + "object_name": "CIS Control" + }, + "kb_article_list": { + "type": "object_t", + "description": "A list of KB articles or patches related to an endpoint. A KB Article contains metadata that describes the patch or an update.", + "is_array": true, + "requirement": "optional", + "caption": "Knowledgebase Articles", + "object_type": "kb_article", + "object_name": "KB Article" + }, + "kb_articles": { + "type": "string_t", + "description": "The KB article/s related to the entity. A KB Article contains metadata that describes the patch or an update.", + "is_array": true, + "requirement": "optional", + "caption": "Knowledgebase Articles", + "type_name": "String", + "@deprecated": { + "message": "Use the kb_article_list attribute instead.", + "since": "1.1.0" + } + } + }, + "name": "remediation", + "description": "The Remediation object describes the recommended remediation steps to address identified issue(s).", + "extends": "object", + "caption": "Remediation", + "profiles": [ + "data_classification" + ] +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/url.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/url.json new file mode 100644 index 0000000000..63f51d8816 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/objects/url.json @@ -0,0 +1,370 @@ +{ + "attributes": { + "port": { + "type": "port_t", + "description": "The URL port. For example: 80.", + "requirement": "recommended", + "caption": "Port", + "type_name": "Port" + }, + "scheme": { + "type": "string_t", + "description": "The scheme portion of the URL. For example: http, https, ftp, or sftp.", + "requirement": "recommended", + "caption": "Scheme", + "type_name": "String" + }, + "path": { + "type": "string_t", + "description": "The URL path as extracted from the URL. For example: /download/trouble from www.example.com/download/trouble.", + "requirement": "recommended", + "caption": "Path", + "type_name": "String" + }, + "domain": { + "type": "string_t", + "description": "The domain portion of the URL. For example: example.com in https://sub.example.com.", + "requirement": "optional", + "caption": "Domain", + "type_name": "String" + }, + "hostname": { + "type": "hostname_t", + "description": "The URL host as extracted from the URL. For example: www.example.com from www.example.com/download/trouble.", + "requirement": "recommended", + "caption": "Hostname", + "type_name": "Hostname" + }, + "query_string": { + "type": "string_t", + "description": "The query portion of the URL. For example: the query portion of the URL http://www.example.com/search?q=bad&sort=date is q=bad&sort=date.", + "requirement": "recommended", + "caption": "HTTP Query String", + "type_name": "String" + }, + "categories": { + "type": "string_t", + "description": "The Website categorization names, as defined by category_ids enum values.", + "is_array": true, + "requirement": "optional", + "caption": "Website Categorization", + "type_name": "String" + }, + "category_ids": { + "type": "integer_t", + "enum": { + "60": { + "caption": "Real Estate" + }, + "93": { + "caption": "Sexual Expression" + }, + "32": { + "caption": "Brokerage/Trading" + }, + "15": { + "caption": "Weapons" + }, + "37": { + "caption": "Health" + }, + "5": { + "caption": "Intimate Apparel/Swimsuit" + }, + "102": { + "caption": "Potentially Unwanted Software" + }, + "47": { + "caption": "Personals/Dating" + }, + "20": { + "caption": "Entertainment" + }, + "16": { + "caption": "Abortion" + }, + "101": { + "caption": "Spam" + }, + "109": { + "caption": "Internet Connected Devices" + }, + "85": { + "caption": "Office/Business Applications" + }, + "31": { + "caption": "Financial Services" + }, + "25": { + "caption": "Controlled Substances" + }, + "114": { + "caption": "TV/Video Streams" + }, + "36": { + "caption": "Political/Social Advocacy" + }, + "63": { + "caption": "Personal Sites" + }, + "22": { + "caption": "Alternative Spirituality/Belief" + }, + "59": { + "caption": "Auctions" + }, + "34": { + "caption": "Government/Legal" + }, + "27": { + "caption": "Education" + }, + "99": { + "description": "The Domain/URL category is not mapped. See the categories attribute, which contains a data source specific value.", + "caption": "Other" + }, + "118": { + "caption": "Piracy/Copyright Concerns" + }, + "4": { + "caption": "Sex Education" + }, + "45": { + "caption": "Job Search/Careers" + }, + "90": { + "caption": "Uncategorized" + }, + "56": { + "caption": "File Storage/Sharing" + }, + "29": { + "caption": "Charitable Organizations" + }, + "67": { + "caption": "Vehicles" + }, + "65": { + "caption": "Sports/Recreation" + }, + "24": { + "caption": "Tobacco" + }, + "83": { + "caption": "Peer-to-Peer (P2P)" + }, + "1": { + "caption": "Adult/Mature Content" + }, + "66": { + "caption": "Travel" + }, + "57": { + "caption": "Remote Access Tools" + }, + "97": { + "caption": "Content Servers" + }, + "92": { + "caption": "Suspicious" + }, + "38": { + "caption": "Technology/Internet" + }, + "111": { + "caption": "Online Meetings" + }, + "51": { + "caption": "Chat (IM)/SMS" + }, + "52": { + "caption": "Email" + }, + "46": { + "caption": "News/Media" + }, + "23": { + "caption": "Alcohol" + }, + "14": { + "caption": "Violence/Hate/Racism" + }, + "87": { + "caption": "For Kids" + }, + "89": { + "caption": "Web Hosting" + }, + "88": { + "caption": "Web Ads/Analytics" + }, + "107": { + "caption": "Informational" + }, + "61": { + "caption": "Society/Daily Living" + }, + "113": { + "caption": "Radio/Audio Streams" + }, + "103": { + "caption": "Dynamic DNS Host" + }, + "121": { + "caption": "Marijuana" + }, + "86": { + "caption": "Proxy Avoidance" + }, + "55": { + "caption": "Social Networking" + }, + "49": { + "caption": "Reference" + }, + "106": { + "caption": "E-Card/Invitations" + }, + "7": { + "caption": "Extreme" + }, + "98": { + "caption": "Placeholders" + }, + "112": { + "caption": "Media Sharing" + }, + "40": { + "caption": "Search Engines/Portals" + }, + "58": { + "caption": "Shopping" + }, + "17": { + "caption": "Hacking" + }, + "6": { + "caption": "Nudity" + }, + "44": { + "caption": "Malicious Outbound Data/Botnets" + }, + "3": { + "caption": "Pornography" + }, + "110": { + "caption": "Internet Telephony" + }, + "26": { + "caption": "Child Pornography" + }, + "50": { + "caption": "Mixed Content/Potentially Adult" + }, + "30": { + "caption": "Art/Culture" + }, + "95": { + "caption": "Translation" + }, + "18": { + "caption": "Phishing" + }, + "0": { + "description": "The Domain/URL category is unknown.", + "caption": "Unknown" + }, + "71": { + "caption": "Software Downloads" + }, + "53": { + "caption": "Newsgroups/Forums" + }, + "35": { + "caption": "Military" + }, + "54": { + "caption": "Religion" + }, + "43": { + "caption": "Malicious Sources/Malnets" + }, + "84": { + "caption": "Audio/Video Clips" + }, + "64": { + "caption": "Restaurants/Dining/Food" + }, + "21": { + "caption": "Business/Economy" + }, + "11": { + "caption": "Gambling" + }, + "68": { + "caption": "Humor/Jokes" + }, + "108": { + "caption": "Computer/Information Security" + }, + "9": { + "caption": "Scam/Questionable/Illegal" + }, + "96": { + "caption": "Non-Viewable/Infrastructure" + }, + "33": { + "caption": "Games" + } + }, + "description": "The Website categorization identifiers.", + "is_array": true, + "requirement": "recommended", + "caption": "Website Categorization IDs", + "sibling": "categories", + "type_name": "Integer" + }, + "resource_type": { + "type": "string_t", + "description": "The context in which a resource was retrieved in a web request.", + "requirement": "optional", + "caption": "Resource Type", + "type_name": "String" + }, + "subdomain": { + "type": "string_t", + "description": "The subdomain portion of the URL. For example: sub in https://sub.example.com or sub2.sub1 in https://sub2.sub1.example.com.", + "requirement": "optional", + "caption": "Subdomain", + "type_name": "String" + }, + "url_string": { + "type": "url_t", + "description": "The URL string. See RFC 1738. For example: http://www.example.com/download/trouble.exe. Note: The URL path should not populate the URL string.", + "requirement": "recommended", + "caption": "URL String", + "type_name": "URL String" + } + }, + "name": "url", + "description": "The Uniform Resource Locator (URL) object describes the characteristics of a URL.", + "extends": "object", + "constraints": { + "at_least_one": [ + "url_string", + "path" + ] + }, + "references": [ + { + "description": "Defined in RFC 1738", + "url": "https://datatracker.ietf.org/doc/html/rfc1738" + }, + { + "description": "D3FEND\u2122 Ontology d3f:URL", + "url": "https://d3fend.mitre.org/dao/artifact/d3f:URL/" + } + ], + "caption": "Uniform Resource Locator", + "observable": 23 +} diff --git a/crates/openshell-ocsf/schemas/ocsf/v1.8.0/profiles/ai_operation.json b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/profiles/ai_operation.json new file mode 100644 index 0000000000..7cac95ef03 --- /dev/null +++ b/crates/openshell-ocsf/schemas/ocsf/v1.8.0/profiles/ai_operation.json @@ -0,0 +1,26 @@ +{ + "attributes": { + "ai_model": { + "type": "object_t", + "description": "The AI Model object describes the characteristics of an AI/ML model. Examples include language models like GPT-4, embedding models like text-embedding-ada-002, and computer vision models like CLIP.", + "group": "context", + "requirement": "recommended", + "caption": "AI Model", + "object_type": "ai_model", + "object_name": "AI Model" + }, + "message_context": { + "type": "object_t", + "description": "Communication context for AI system interactions including protocols, roles, clients, and session information for MCP and other AI communication systems.", + "group": "context", + "requirement": "optional", + "caption": "Message Context", + "object_type": "message_context", + "object_name": "Message Context" + } + }, + "meta": "profile", + "name": "ai_operation", + "description": "AI-specific attributes for model operations, retrieval systems, and agent activities. e.g. model_name, total_token_counts etc.", + "caption": "AI Operation" +} diff --git a/crates/openshell-ocsf/src/builders/http.rs b/crates/openshell-ocsf/src/builders/http.rs index ae91cf7c41..aab89d8a17 100644 --- a/crates/openshell-ocsf/src/builders/http.rs +++ b/crates/openshell-ocsf/src/builders/http.rs @@ -7,7 +7,7 @@ use crate::builders::SandboxContext; use crate::enums::{ActionId, ActivityId, DispositionId, SeverityId, StatusId}; use crate::events::base_event::BaseEventData; use crate::events::{HttpActivityEvent, OcsfEvent}; -use crate::objects::{Actor, Endpoint, FirewallRule, HttpRequest, HttpResponse}; +use crate::objects::{Actor, AiModel, Endpoint, FirewallRule, HttpRequest, HttpResponse}; /// Builder for HTTP Activity [4002] events. pub struct HttpActivityBuilder<'a> { @@ -25,6 +25,7 @@ pub struct HttpActivityBuilder<'a> { firewall_rule: Option, message: Option, status_detail: Option, + ai_model: Option, unmapped: serde_json::Map, } @@ -46,6 +47,7 @@ impl<'a> HttpActivityBuilder<'a> { firewall_rule: None, message: None, status_detail: None, + ai_model: None, unmapped: serde_json::Map::new(), } } @@ -71,6 +73,13 @@ impl<'a> HttpActivityBuilder<'a> { self } + /// Attach the `ai_operation` profile with model identity. + #[must_use] + pub fn ai_model(mut self, model: AiModel) -> Self { + self.ai_model = Some(model); + self + } + /// Add a source-specific attribute that is not defined by the OCSF class. #[must_use] pub fn unmapped(mut self, key: &str, value: impl Into) -> Self { @@ -81,6 +90,11 @@ impl<'a> HttpActivityBuilder<'a> { #[must_use] pub fn build(self) -> OcsfEvent { let activity_name = self.activity.http_label().to_string(); + let mut profiles: Vec<&str> = + vec!["security_control", "network_proxy", "container", "host"]; + if self.ai_model.is_some() { + profiles.push("ai_operation"); + } let mut base = BaseEventData::new( 4002, "HTTP Activity", @@ -89,12 +103,14 @@ impl<'a> HttpActivityBuilder<'a> { self.activity.as_u8(), &activity_name, self.severity, - self.ctx - .metadata(&["security_control", "network_proxy", "container", "host"]), + self.ctx.metadata(&profiles), ); if let Some(detail) = self.status_detail { base.set_status_detail(detail); } + if let Some(ai_model) = self.ai_model { + base.set_ai_model(ai_model); + } if !self.unmapped.is_empty() { base.unmapped = Some(serde_json::Value::Object(self.unmapped)); } diff --git a/crates/openshell-ocsf/src/builders/mod.rs b/crates/openshell-ocsf/src/builders/mod.rs index cbedad1df6..185bbf4397 100644 --- a/crates/openshell-ocsf/src/builders/mod.rs +++ b/crates/openshell-ocsf/src/builders/mod.rs @@ -272,7 +272,7 @@ mod tests { fn test_sandbox_context_metadata() { let ctx = test_sandbox_context(); let meta = ctx.metadata(&["security_control", "container"]); - assert_eq!(meta.version, "1.7.0"); + assert_eq!(meta.version, "1.8.0"); assert_eq!(meta.product.name, "OpenShell Sandbox Supervisor"); assert_eq!(meta.profiles.len(), 2); assert_eq!(meta.uid.as_deref(), Some("sandbox-abc123")); diff --git a/crates/openshell-ocsf/src/enums/http_method.rs b/crates/openshell-ocsf/src/enums/http_method.rs index b7b04e09d6..6ac89533ef 100644 --- a/crates/openshell-ocsf/src/enums/http_method.rs +++ b/crates/openshell-ocsf/src/enums/http_method.rs @@ -5,7 +5,7 @@ use serde::{Deserialize, Serialize}; -/// HTTP method as defined in the OCSF v1.7.0 `http_request` object schema. +/// HTTP method as defined in the OCSF v1.8.0 `http_request` object schema. /// /// The 9 standard methods are typed variants. Non-standard methods use /// `Other(String)`. diff --git a/crates/openshell-ocsf/src/enums/mod.rs b/crates/openshell-ocsf/src/enums/mod.rs index 8ab03eb63f..96567f86d5 100644 --- a/crates/openshell-ocsf/src/enums/mod.rs +++ b/crates/openshell-ocsf/src/enums/mod.rs @@ -1,7 +1,7 @@ // SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. // SPDX-License-Identifier: Apache-2.0 -//! OCSF v1.7.0 enum types. +//! OCSF v1.8.0 enum types. mod action; mod activity; diff --git a/crates/openshell-ocsf/src/events/app_lifecycle.rs b/crates/openshell-ocsf/src/events/app_lifecycle.rs index 4dc074eb73..103b385e2a 100644 --- a/crates/openshell-ocsf/src/events/app_lifecycle.rs +++ b/crates/openshell-ocsf/src/events/app_lifecycle.rs @@ -38,7 +38,7 @@ mod tests { "Start", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["container".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/base_event.rs b/crates/openshell-ocsf/src/events/base_event.rs index 97e7c038b8..f781ff1393 100644 --- a/crates/openshell-ocsf/src/events/base_event.rs +++ b/crates/openshell-ocsf/src/events/base_event.rs @@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize}; use crate::enums::{SeverityId, StatusId}; -use crate::objects::{Container, Device, Metadata}; +use crate::objects::{AiModel, Container, Device, Metadata}; /// Common fields shared by all OCSF event classes. /// @@ -67,6 +67,10 @@ pub struct BaseEventData { #[serde(skip_serializing_if = "Option::is_none")] pub container: Option, + /// AI model info (`ai_operation` profile, OCSF v1.8.0+). + #[serde(skip_serializing_if = "Option::is_none")] + pub ai_model: Option, + /// Unmapped fields that don't fit the OCSF schema. #[serde(skip_serializing_if = "Option::is_none")] pub unmapped: Option, @@ -112,6 +116,9 @@ impl Serialize for BaseEventData { if let Some(ref container) = self.container { map.serialize_entry("container", container)?; } + if let Some(ref ai_model) = self.ai_model { + map.serialize_entry("ai_model", ai_model)?; + } if let Some(ref unmapped) = self.unmapped { map.serialize_entry("unmapped", unmapped)?; } @@ -154,6 +161,7 @@ impl BaseEventData { metadata, device: None, container: None, + ai_model: None, unmapped: None, } } @@ -188,6 +196,11 @@ impl BaseEventData { self.container = Some(container); } + /// Set AI model info (`ai_operation` profile). + pub fn set_ai_model(&mut self, ai_model: AiModel) { + self.ai_model = Some(ai_model); + } + /// Add an unmapped field. pub fn add_unmapped(&mut self, key: &str, value: impl Into) { let map = self @@ -214,7 +227,7 @@ mod tests { fn test_metadata() -> Metadata { Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["container".to_string(), "host".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/config_state_change.rs b/crates/openshell-ocsf/src/events/config_state_change.rs index a28b437568..69333554a1 100644 --- a/crates/openshell-ocsf/src/events/config_state_change.rs +++ b/crates/openshell-ocsf/src/events/config_state_change.rs @@ -73,7 +73,7 @@ mod tests { "Log", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/detection_finding.rs b/crates/openshell-ocsf/src/events/detection_finding.rs index 35ef222c1f..0c928be44c 100644 --- a/crates/openshell-ocsf/src/events/detection_finding.rs +++ b/crates/openshell-ocsf/src/events/detection_finding.rs @@ -103,7 +103,7 @@ mod tests { "Create", SeverityId::High, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/http_activity.rs b/crates/openshell-ocsf/src/events/http_activity.rs index fe3b035799..dc5c9f8484 100644 --- a/crates/openshell-ocsf/src/events/http_activity.rs +++ b/crates/openshell-ocsf/src/events/http_activity.rs @@ -114,7 +114,7 @@ mod tests { "Get", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/mod.rs b/crates/openshell-ocsf/src/events/mod.rs index 23519e5662..d9d05e9746 100644 --- a/crates/openshell-ocsf/src/events/mod.rs +++ b/crates/openshell-ocsf/src/events/mod.rs @@ -1,7 +1,7 @@ // SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. // SPDX-License-Identifier: Apache-2.0 -//! OCSF v1.7.0 event class definitions. +//! OCSF v1.8.0 event class definitions. mod app_lifecycle; pub(crate) mod base_event; @@ -277,6 +277,33 @@ mod tests { assert_eq!(deserialized.class_uid(), 0); } + #[test] + fn test_roundtrip_http_activity_with_ai_model() { + let ctx = test_sandbox_context(); + let event = HttpActivityBuilder::new(&ctx) + .activity(ActivityId::Traffic) + .severity(SeverityId::Informational) + .ai_model(AiModel::new("claude-3-haiku", "anthropic")) + .build(); + + let json = serde_json::to_value(&event).unwrap(); + assert_eq!(json["class_uid"], 4002); + assert_eq!(json["ai_model"]["name"], "claude-3-haiku"); + assert_eq!(json["ai_model"]["ai_provider"], "anthropic"); + assert!( + json["metadata"]["profiles"] + .as_array() + .unwrap() + .iter() + .any(|p| p == "ai_operation") + ); + + let deserialized: OcsfEvent = serde_json::from_value(json).unwrap(); + assert!(matches!(deserialized, OcsfEvent::HttpActivity(_))); + assert_eq!(deserialized.class_uid(), 4002); + assert!(deserialized.base().ai_model.is_some()); + } + #[test] fn test_deserialize_unknown_class_uid_errors() { let json = serde_json::json!({"class_uid": 9999}); diff --git a/crates/openshell-ocsf/src/events/network_activity.rs b/crates/openshell-ocsf/src/events/network_activity.rs index 92450bbe80..86cebaa8e2 100644 --- a/crates/openshell-ocsf/src/events/network_activity.rs +++ b/crates/openshell-ocsf/src/events/network_activity.rs @@ -109,7 +109,7 @@ mod tests { "Open", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string(), "network_proxy".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/process_activity.rs b/crates/openshell-ocsf/src/events/process_activity.rs index 0c5829f92b..ade85a1950 100644 --- a/crates/openshell-ocsf/src/events/process_activity.rs +++ b/crates/openshell-ocsf/src/events/process_activity.rs @@ -16,10 +16,10 @@ pub struct ProcessActivityEvent { #[serde(flatten)] pub base: BaseEventData, - /// The process being acted upon (required in v1.7.0). + /// The process being acted upon (required in v1.8.0). pub process: Process, - /// Actor (parent/supervisor process, required in v1.7.0). + /// Actor (parent/supervisor process, required in v1.8.0). #[serde(skip_serializing_if = "Option::is_none")] pub actor: Option, @@ -86,7 +86,7 @@ mod tests { "Launch", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["container".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/events/ssh_activity.rs b/crates/openshell-ocsf/src/events/ssh_activity.rs index 0248c6593a..29ffdeca38 100644 --- a/crates/openshell-ocsf/src/events/ssh_activity.rs +++ b/crates/openshell-ocsf/src/events/ssh_activity.rs @@ -103,7 +103,7 @@ mod tests { "Open", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/format/jsonl.rs b/crates/openshell-ocsf/src/format/jsonl.rs index 8f3606ba0e..27fa8fb700 100644 --- a/crates/openshell-ocsf/src/format/jsonl.rs +++ b/crates/openshell-ocsf/src/format/jsonl.rs @@ -38,7 +38,7 @@ mod tests { "Other", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["container".to_string()], uid: Some("sandbox-abc123".to_string()), @@ -63,7 +63,7 @@ mod tests { assert_eq!(json["time"], 1_742_054_400_000_i64); assert_eq!(json["severity_id"], 1); assert_eq!(json["severity"], "Informational"); - assert_eq!(json["metadata"]["version"], "1.7.0"); + assert_eq!(json["metadata"]["version"], "1.8.0"); } #[test] diff --git a/crates/openshell-ocsf/src/format/shorthand.rs b/crates/openshell-ocsf/src/format/shorthand.rs index 60df77639f..25af4752b0 100644 --- a/crates/openshell-ocsf/src/format/shorthand.rs +++ b/crates/openshell-ocsf/src/format/shorthand.rs @@ -296,7 +296,23 @@ impl OcsfEvent { } else { String::new() }; - format!("HTTP:{method} {sev}{detail}{rule_ctx}{outcome_ctx}{message_ctx}") + let ai_ctx = e + .base + .ai_model + .as_ref() + .map(|m| { + let latency = e + .base + .unmapped + .as_ref() + .and_then(|u| u.get("latency_ms")) + .and_then(serde_json::Value::as_u64) + .map(|ms| format!(" {ms}ms")) + .unwrap_or_default(); + format!(" [ai:{} via {}{}]", m.name, m.ai_provider, latency) + }) + .unwrap_or_default(); + format!("HTTP:{method} {sev}{detail}{rule_ctx}{outcome_ctx}{message_ctx}{ai_ctx}") } Self::SshActivity(e) => { @@ -481,7 +497,7 @@ mod tests { fn test_metadata() -> Metadata { Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string()], uid: Some("sandbox-abc123".to_string()), diff --git a/crates/openshell-ocsf/src/lib.rs b/crates/openshell-ocsf/src/lib.rs index e9d1402a68..58726a95c8 100644 --- a/crates/openshell-ocsf/src/lib.rs +++ b/crates/openshell-ocsf/src/lib.rs @@ -3,7 +3,7 @@ //! # openshell-ocsf //! -//! OCSF v1.7.0 event types, formatters, and tracing layers for `OpenShell` +//! OCSF v1.8.0 event types, formatters, and tracing layers for `OpenShell` //! sandbox logging. //! //! This crate provides: @@ -22,7 +22,7 @@ //! tracing system /// OCSF schema version this crate implements. -pub const OCSF_VERSION: &str = "1.7.0"; +pub const OCSF_VERSION: &str = "1.8.0"; pub mod builders; pub mod ctx; @@ -50,7 +50,7 @@ pub use enums::{ // --- Object types --- pub use objects::{ - Actor, Attack, ConnectionInfo, Container, Device, Endpoint, Evidence, FindingInfo, + Actor, AiModel, Attack, ConnectionInfo, Container, Device, Endpoint, Evidence, FindingInfo, FirewallRule, HttpRequest, HttpResponse, Image, Metadata, OsInfo, Process, Product, Remediation, Tactic, Technique, Url, }; diff --git a/crates/openshell-ocsf/src/objects/ai_model.rs b/crates/openshell-ocsf/src/objects/ai_model.rs new file mode 100644 index 0000000000..8ff6709edb --- /dev/null +++ b/crates/openshell-ocsf/src/objects/ai_model.rs @@ -0,0 +1,59 @@ +// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +// SPDX-License-Identifier: Apache-2.0 + +//! OCSF `ai_model` object (introduced with the `ai_operation` profile in v1.8.0). + +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct AiModel { + pub name: String, + pub ai_provider: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub uid: Option, +} + +impl AiModel { + #[must_use] + pub fn new(name: impl Into, ai_provider: impl Into) -> Self { + Self { + name: name.into(), + ai_provider: ai_provider.into(), + version: None, + uid: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_ai_model_serialization() { + let model = AiModel::new("claude-3-haiku", "anthropic"); + let json = serde_json::to_value(&model).unwrap(); + assert_eq!(json["name"], "claude-3-haiku"); + assert_eq!(json["ai_provider"], "anthropic"); + assert!(json.get("version").is_none()); + assert!(json.get("uid").is_none()); + } + + #[test] + fn test_ai_model_roundtrip() { + let model = AiModel { + name: "gpt-4o".to_string(), + ai_provider: "openai".to_string(), + version: Some("2024-05-13".to_string()), + uid: Some("model-123".to_string()), + }; + let json = serde_json::to_string(&model).unwrap(); + let deserialized: AiModel = serde_json::from_str(&json).unwrap(); + assert_eq!(deserialized.name, "gpt-4o"); + assert_eq!(deserialized.ai_provider, "openai"); + assert_eq!(deserialized.version.as_deref(), Some("2024-05-13")); + assert_eq!(deserialized.uid.as_deref(), Some("model-123")); + } +} diff --git a/crates/openshell-ocsf/src/objects/metadata.rs b/crates/openshell-ocsf/src/objects/metadata.rs index 0ffc8e15c2..060f13ac6a 100644 --- a/crates/openshell-ocsf/src/objects/metadata.rs +++ b/crates/openshell-ocsf/src/objects/metadata.rs @@ -8,7 +8,7 @@ use serde::{Deserialize, Serialize}; /// OCSF Metadata object — event provenance and schema info. #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] pub struct Metadata { - /// OCSF schema version (e.g., "1.7.0"). + /// OCSF schema version (e.g., "1.8.0"). pub version: String, /// The product that generated the event. @@ -60,7 +60,7 @@ mod tests { #[test] fn test_metadata_serialization() { let metadata = Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec!["security_control".to_string(), "container".to_string()], uid: Some("sandbox-abc123".to_string()), @@ -68,7 +68,7 @@ mod tests { }; let json = serde_json::to_value(&metadata).unwrap(); - assert_eq!(json["version"], "1.7.0"); + assert_eq!(json["version"], "1.8.0"); assert_eq!(json["product"]["name"], "OpenShell Sandbox Supervisor"); assert_eq!(json["product"]["vendor_name"], "OpenShell"); assert!(json.get("log_source").is_none()); @@ -77,7 +77,7 @@ mod tests { #[test] fn test_metadata_with_log_source() { let metadata = Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec![], uid: None, diff --git a/crates/openshell-ocsf/src/objects/mod.rs b/crates/openshell-ocsf/src/objects/mod.rs index 8493c19d36..c292ee48ee 100644 --- a/crates/openshell-ocsf/src/objects/mod.rs +++ b/crates/openshell-ocsf/src/objects/mod.rs @@ -1,8 +1,9 @@ // SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. // SPDX-License-Identifier: Apache-2.0 -//! OCSF v1.7.0 object types. +//! OCSF v1.8.0 object types. +mod ai_model; mod attack; mod connection; mod container; @@ -14,6 +15,7 @@ mod http; mod metadata; mod process; +pub use ai_model::AiModel; pub use attack::{Attack, Tactic, Technique}; pub use connection::ConnectionInfo; pub use container::{Container, Image}; diff --git a/crates/openshell-ocsf/src/tracing_layers/event_bridge.rs b/crates/openshell-ocsf/src/tracing_layers/event_bridge.rs index caa94ca8d8..c07cd64b53 100644 --- a/crates/openshell-ocsf/src/tracing_layers/event_bridge.rs +++ b/crates/openshell-ocsf/src/tracing_layers/event_bridge.rs @@ -82,7 +82,7 @@ mod tests { "Other", SeverityId::Informational, Metadata { - version: "1.7.0".to_string(), + version: "1.8.0".to_string(), product: Product::openshell_sandbox("0.1.0"), profiles: vec![], uid: None, diff --git a/crates/openshell-ocsf/src/validation/schema.rs b/crates/openshell-ocsf/src/validation/schema.rs index f1160ecdbf..ee21619ba0 100644 --- a/crates/openshell-ocsf/src/validation/schema.rs +++ b/crates/openshell-ocsf/src/validation/schema.rs @@ -14,7 +14,7 @@ use std::fs; #[must_use] pub fn load_class_schema(class: &str) -> Value { let path = format!( - "{}/schemas/ocsf/v1.7.0/classes/{class}.json", + "{}/schemas/ocsf/v1.8.0/classes/{class}.json", env!("CARGO_MANIFEST_DIR") ); let data = @@ -30,7 +30,7 @@ pub fn load_class_schema(class: &str) -> Value { #[must_use] pub fn load_object_schema(object: &str) -> Value { let path = format!( - "{}/schemas/ocsf/v1.7.0/objects/{object}.json", + "{}/schemas/ocsf/v1.8.0/objects/{object}.json", env!("CARGO_MANIFEST_DIR") ); let data = @@ -43,15 +43,28 @@ pub fn load_object_schema(object: &str) -> Value { /// The OCSF schema stores attributes as an object where each key is a field name /// and the value contains a `requirement` field. pub fn validate_required_fields(event: &Value, schema: &Value) { - if let Some(attrs) = schema.get("attributes").and_then(|a| a.as_object()) { - for (name, def) in attrs { - if def.get("requirement").and_then(|r| r.as_str()) == Some("required") { - assert!( - event.get(name).is_some(), - "Missing required field '{name}' in OCSF event. Event keys: {:?}", - event.as_object().map(|o| o.keys().collect::>()) - ); - } + let attrs = match schema.get("attributes") { + Some(Value::Object(map)) => map + .iter() + .map(|(k, v)| (k.clone(), v.clone())) + .collect::>(), + Some(Value::Array(arr)) => arr + .iter() + .filter_map(|item| item.as_object()) + .flat_map(|obj| obj.iter().map(|(k, v)| (k.clone(), v.clone()))) + .collect::>(), + _ => return, + }; + + for (name, def) in &attrs { + let is_required = def.get("requirement").and_then(|r| r.as_str()) == Some("required"); + let is_profile_field = def.get("profile").is_some() || def.get("profiles").is_some(); + if is_required && !is_profile_field { + assert!( + event.get(name).is_some(), + "Missing required field '{name}' in OCSF event. Event keys: {:?}", + event.as_object().map(|o| o.keys().collect::>()) + ); } } } diff --git a/crates/openshell-supervisor-network/src/proxy.rs b/crates/openshell-supervisor-network/src/proxy.rs index 152a78a680..43ec0cbd15 100644 --- a/crates/openshell-supervisor-network/src/proxy.rs +++ b/crates/openshell-supervisor-network/src/proxy.rs @@ -23,7 +23,7 @@ use openshell_core::policy::ProxyPolicy; use openshell_core::provider_credentials::ProviderCredentialState; use openshell_core::secrets::{self, SecretResolver, rewrite_header_line_checked}; use openshell_ocsf::{ - ActionId, ActivityId, DispositionId, Endpoint, HttpActivityBuilder, HttpRequest, + ActionId, ActivityId, AiModel, DispositionId, Endpoint, HttpActivityBuilder, HttpRequest, NetworkActivityBuilder, Process, SeverityId, StatusId, Url as OcsfUrl, ocsf_emit, }; use std::net::{IpAddr, SocketAddr}; @@ -2303,6 +2303,87 @@ async fn process_inference_keepalive Option { + #[derive(serde::Deserialize)] + struct Req { + model: Option, + } + serde_json::from_slice::(body) + .ok() + .and_then(|r| r.model) + .filter(|m| !m.is_empty()) +} + +/// Extract token usage from an inference response body. +fn extract_usage_from_response(body: &[u8]) -> (Option, Option) { + #[derive(serde::Deserialize)] + struct Resp { + usage: Option, + } + #[derive(serde::Deserialize)] + struct Usage { + prompt_tokens: Option, + completion_tokens: Option, + } + match serde_json::from_slice::(body) { + Ok(r) => { + let u = r.usage.unwrap_or(Usage { + prompt_tokens: None, + completion_tokens: None, + }); + (u.prompt_tokens, u.completion_tokens) + } + Err(_) => (None, None), + } +} + +/// Emit an OCSF HTTP Activity event with the `ai_operation` profile after an inference call. +fn emit_ai_inference( + method: &str, + path: &str, + model: Option<&str>, + provider: Option<&str>, + input_tokens: Option, + output_tokens: Option, + latency: std::time::Duration, +) { + let model_name = model.unwrap_or("unknown"); + let provider_name = provider.unwrap_or("unknown"); + let latency_ms = u64::try_from(latency.as_millis()).unwrap_or(u64::MAX); + + let mut builder = HttpActivityBuilder::new(openshell_ocsf::ctx::ctx()) + .activity(ActivityId::Traffic) + .severity(SeverityId::Informational) + .status(StatusId::Success) + .ai_model(AiModel::new(model_name, provider_name)) + .http_request(HttpRequest::new( + method, + OcsfUrl::new("https", INFERENCE_LOCAL_HOST, path, 443), + )) + .dst_endpoint(Endpoint::from_domain( + INFERENCE_LOCAL_HOST, + INFERENCE_LOCAL_PORT, + )) + .unmapped("latency_ms", latency_ms); + + if let Some(t) = input_tokens { + builder = builder.unmapped("input_tokens", t); + } + if let Some(t) = output_tokens { + builder = builder.unmapped("output_tokens", t); + } + + let msg = format!( + "Model call: {model_name} via {provider_name} ({}in, {}out)", + input_tokens.map_or_else(|| "?".to_string(), |t| t.to_string()), + output_tokens.map_or_else(|| "?".to_string(), |t| t.to_string()), + ); + builder = builder.message(msg); + + ocsf_emit!(builder.build()); +} + /// Route a parsed inference request locally via the sandbox router, or deny it. /// /// Returns `Ok(true)` if the request was routed to an inference backend, @@ -2358,6 +2439,11 @@ async fn route_inference_request( // the body on a size-cap or idle-timeout truncation, corrupting a // payload the client parses as one JSON object. Framing is declared per // protocol on the matched pattern. + let req_model = extract_model_from_request(&request.body); + let route_model = routes.first().map(|r| r.model.clone()); + let route_endpoint = routes.first().map(|r| r.endpoint.clone()); + let infer_start = std::time::Instant::now(); + if pattern.is_buffered() { match ctx .router @@ -2372,6 +2458,18 @@ async fn route_inference_request( .await { Ok(resp) => { + let (input_tokens, output_tokens) = extract_usage_from_response(&resp.body); + let model = req_model.as_deref().or(route_model.as_deref()); + emit_ai_inference( + &request.method, + &normalized_path, + model, + route_endpoint.as_deref(), + input_tokens, + output_tokens, + infer_start.elapsed(), + ); + let resp_headers = sanitize_inference_response_headers(resp.headers); let response = format_http_response(resp.status, &resp_headers, &resp.body); write_all(tls_client, &response).await?; @@ -2474,6 +2572,20 @@ async fn route_inference_request( // Terminate the chunked stream. write_all(tls_client, format_chunk_terminator()).await?; + + // Emit ai_operation for the completed streaming call. + // Token counts are not available without accumulating all + // SSE chunks; emit with model/provider/latency only. + let model = req_model.as_deref().or(route_model.as_deref()); + emit_ai_inference( + &request.method, + &normalized_path, + model, + route_endpoint.as_deref(), + None, + None, + infer_start.elapsed(), + ); } Err(e) => write_inference_router_error(tls_client, &e).await?, }