Remediation Activity

remediation_activity (7001)

Remediation Activity events report on attempts at remediating a compromised device or computer network. It follows the MITRE countermeasures defined by the D3FEND™ Matrix.

Contents

Attributes

Caption Name Type Is Array Default Description
Activity ID activity_id Integer Matches the MITRE D3FEND™ Tactic. Note: the Model and Detect Tactics are not supported as remediations by the OCSF Remediation event class.
0
Unknown
1
Isolate
2
Evict
3
Restore
4
Harden
99
Other
Activity activity_name String The event activity name, as defined by the activity_id.
Actor actor Actor The actor object describes details about the user/role/process that was the source of the activity.
API Details api API Describes details about a typical API (Application Programming Interface) call.
Category category_name String The event category name, as defined by category_uid value.
Category ID category_uid Integer The category unique identifier of the event.
7
Remediation
Class class_name String The event class name, as defined by class_uid value.
Class ID class_uid Integer The unique identifier of a class. A class describes the attributes available in an event.
7001
Remediation Activity
Cloud cloud Cloud Describes details about the Cloud environment where the event was originally created or logged.
Command UID command_uid String The unique identifier of the remediation command that pertains to this event.
Confidence confidence Integer The confidence of the reported event severity as a percentage: 0%-100%.

Deprecated since 1.1.0: Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0
Count count Integer 1 The number of times that events in the same logical group occurred during the event Start Time to End Time period.
Countermeasures countermeasures MITRE D3FEND™ The MITRE DEFEND™ Matrix Countermeasures associated with a remediation.
Data data JSON Additional data that is associated with the event.

Deprecated since 1.1.0: Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0
Device device Device An addressable device, computer system or host.
Duration duration Long The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
End Time end_time Timestamp The end time of a time period, or the time of the most recent event included in the aggregate event.
Enrichments enrichments Enrichment 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"}}]
Message message String The description of the event/finding, as defined by the source.
Metadata metadata Metadata The metadata associated with the event or a finding.
Observables observables Observable The observables associated with the event or a finding.
OSINT osint OSINT 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.
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique idenifier for the event
Remediation Guidance remediation Remediation Describes the recommended remediation steps to address identified issue(s).
Scan scan Scan The remediation scan that pertains to this event.
Severity severity String The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
Severity ID severity_id Integer

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.
0
Unknown
1
Informational
2
Low
3
Medium
4
High
5
Critical
6
Fatal
99
Other
Start Time start_time Timestamp The start time of a time period, or the time of the least recent event included in the aggregate event.
Status status String The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.
Status Code status_code String 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.
Status Details status_detail String The status detail contains additional information about the event/finding outcome.
Status ID status_id Integer The normalized identifier of the event status.
0
Unknown
1
Success
2
Failure
3
Does Not Exist
4
Partial
5
Unsupported
6
Error
99
Other
Event Time time Timestamp The normalized event occurrence time or the finding creation time.
Timezone Offset timezone_offset Integer The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
Type Name type_name String The event/finding type name, as defined by the type_uid.
Type ID type_uid Long 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.
700100
Remediation Activity: Unknown
700101
Remediation Activity: Isolate
700102
Remediation Activity: Evict
700103
Remediation Activity: Restore
700104
Remediation Activity: Harden
700199
Remediation Activity: Other
Unmapped Data unmapped Unmapped The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

Context

Remediation Activity

JSON

            
{
  "caption": "Remediation Activity",
  "description": "Remediation Activity events report on attempts at remediating a compromised device or computer network. It follows the MITRE countermeasures defined by the D3FEND\u2122 <a target='_blank' href='https://d3fend.mitre.org/'>Matrix</a>.",
  "name": "remediation_activity",
  "category": "remediation",
  "extends": "base_event",
  "uid": 1,
  "profiles": [
    "host"
  ],
  "attributes": {
    "$include": [
      "profiles/host.json"
    ],
    "activity_id": {
      "enum": {
        "1": {
          "caption": "Isolate",
          "description": "Creates logical or physical barriers in a system which reduces opportunities for adversaries to create further accesses. Defined by D3FEND\u2122 <a target='_blank' href='https://d3fend.mitre.org/d3f:Isolate/'>d3f:Isolate</a>."
        },
        "2": {
          "caption": "Evict",
          "description": "Removes an adversary or malicious resource from a device or computer network. Defined by D3FEND\u2122 <a target='_blank' href='https://d3fend.mitre.org/d3f:Evict/'>d3f:Evict</a>."
        },
        "3": {
          "caption": "Restore",
          "description": "Returns the system to a better state. Defined by D3FEND\u2122 <a target='_blank' href='https://d3fend.mitre.org/d3f:Restore/'>d3f:Restore</a>."
        },
        "4": {
          "caption": "Harden",
          "description": " Increases the opportunity cost of computer network exploitation. Defined by D3FEND\u2122 <a target='_blank' href='https://d3fend.mitre.org/d3f:Harden/'>d3f:Harden</a>."
        },
        "0": {
          "caption": "Unknown",
          "description": "The event activity is unknown."
        },
        "99": {
          "caption": "Other",
          "description": "The event activity is not mapped. See the <code>activity_name</code> attribute, which contains a data source specific value."
        }
      },
      "description": "Matches the MITRE D3FEND\u2122 Tactic. Note: the Model and Detect Tactics are not supported as remediations by the OCSF Remediation event class.",
      "requirement": "required",
      "caption": "Activity ID",
      "sibling": "activity_name",
      "type": "integer_t"
    },
    "command_uid": {
      "description": "The unique identifier of the remediation command that pertains to this event.",
      "group": "primary",
      "requirement": "required",
      "caption": "Command UID",
      "type": "string_t"
    },
    "countermeasures": {
      "group": "primary",
      "requirement": "recommended",
      "caption": "Countermeasures",
      "description": "The MITRE DEFEND\u2122 Matrix Countermeasures associated with a remediation.",
      "type": "d3fend",
      "is_array": true
    },
    "remediation": {
      "group": "context",
      "requirement": "optional",
      "caption": "Remediation Guidance",
      "description": "Describes the recommended remediation steps to address identified issue(s).",
      "type": "remediation"
    },
    "scan": {
      "group": "context",
      "description": "The remediation scan that pertains to this event.",
      "requirement": "optional",
      "caption": "Scan",
      "type": "scan"
    },
    "status_id": {
      "enum": {
        "3": {
          "caption": "Does Not Exist",
          "description": "The target of the remediation does not exist."
        },
        "4": {
          "caption": "Partial",
          "description": "The remediation was partially completed."
        },
        "5": {
          "caption": "Unsupported",
          "description": "The remediation was not supported."
        },
        "6": {
          "caption": "Error",
          "description": "There was an error during the remediation process."
        },
        "0": {
          "caption": "Unknown",
          "description": "The status is unknown."
        },
        "1": {
          "caption": "Success"
        },
        "2": {
          "caption": "Failure"
        },
        "99": {
          "caption": "Other",
          "description": "The event status is not mapped. See the <code>status</code> attribute, which contains a data source specific value."
        }
      },
      "group": "primary",
      "requirement": "recommended",
      "caption": "Status ID",
      "description": "The normalized identifier of the event status.",
      "sibling": "status",
      "type": "integer_t"
    },
    "device": {
      "requirement": "recommended",
      "caption": "Device",
      "description": "An addressable device, computer system or host.",
      "type": "device"
    },
    "actor": {
      "requirement": "optional",
      "caption": "Actor",
      "description": "The actor object describes details about the user/role/process that was the source of the activity.",
      "type": "actor"
    },
    "enrichments": {
      "group": "context",
      "requirement": "optional",
      "caption": "Enrichments",
      "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:</p><code>[{\"name\": \"answers.ip\", \"value\": \"92.24.47.250\", \"type\": \"location\", \"data\": {\"city\": \"Socotra\", \"continent\": \"Asia\", \"coordinates\": [-25.4153, 17.0743], \"country\": \"YE\", \"desc\": \"Yemen\"}}]</code>",
      "type": "enrichment",
      "is_array": true
    },
    "message": {
      "group": "primary",
      "requirement": "recommended",
      "caption": "Message",
      "description": "The description of the event/finding, as defined by the source.",
      "type": "string_t"
    },
    "metadata": {
      "group": "context",
      "requirement": "required",
      "caption": "Metadata",
      "description": "The metadata associated with the event or a finding.",
      "type": "metadata"
    },
    "observables": {
      "group": "primary",
      "requirement": "recommended",
      "caption": "Observables",
      "description": "The observables associated with the event or a finding.",
      "type": "observable",
      "is_array": true
    },
    "raw_data": {
      "group": "context",
      "requirement": "optional",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "severity": {
      "group": "classification",
      "requirement": "optional",
      "caption": "Severity",
      "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.",
      "type": "string_t"
    },
    "severity_id": {
      "group": "classification",
      "requirement": "required",
      "caption": "Severity ID",
      "description": "<p>The normalized identifier of the event/finding severity.</p>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.",
      "sibling": "severity",
      "type": "integer_t",
      "enum": {
        "0": {
          "caption": "Unknown",
          "description": "The event severity is not known."
        },
        "1": {
          "caption": "Informational",
          "description": "Informational message. No action required."
        },
        "2": {
          "caption": "Low",
          "description": "The user decides if action is needed."
        },
        "3": {
          "caption": "Medium",
          "description": "Action is required but the situation is not serious at this time."
        },
        "4": {
          "caption": "High",
          "description": "Action is required immediately."
        },
        "5": {
          "caption": "Critical",
          "description": "Action is required immediately and the scope is broad."
        },
        "6": {
          "caption": "Fatal",
          "description": "An error occurred but it is too late to take remedial action."
        },
        "99": {
          "caption": "Other",
          "description": "The event/finding severity is not mapped. See the <code>severity</code> attribute, which contains a data source specific value."
        }
      }
    },
    "status": {
      "group": "primary",
      "requirement": "recommended",
      "caption": "Status",
      "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.",
      "type": "string_t"
    },
    "status_code": {
      "group": "primary",
      "requirement": "recommended",
      "caption": "Status Code",
      "description": "The event status code, as reported by the event source.<br /><br />For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.",
      "type": "string_t"
    },
    "status_detail": {
      "group": "primary",
      "requirement": "recommended",
      "caption": "Status Details",
      "description": "The status detail contains additional information about the event/finding outcome.",
      "type": "string_t"
    },
    "unmapped": {
      "group": "context",
      "requirement": "optional",
      "caption": "Unmapped Data",
      "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
      "type": "unmapped",
      "is_array": true
    },
    "activity_name": {
      "requirement": "optional",
      "caption": "Activity",
      "description": "The event activity name, as defined by the activity_id.",
      "type": "string_t"
    },
    "category_name": {
      "requirement": "optional",
      "caption": "Category",
      "description": "The event category name, as defined by category_uid value.",
      "type": "string_t"
    },
    "category_uid": {
      "enum": {
        "7": {
          "caption": "Remediation",
          "description": "Remediation events report the results of remediation commands targeting files, processes, and other objects."
        }
      },
      "requirement": "required",
      "caption": "Category ID",
      "description": "The category unique identifier of the event.",
      "sibling": "category_name",
      "type": "integer_t"
    },
    "class_name": {
      "requirement": "optional",
      "caption": "Class",
      "description": "The event class name, as defined by class_uid value.",
      "type": "string_t"
    },
    "class_uid": {
      "enum": {
        "7001": {
          "caption": "Remediation Activity",
          "description": "Remediation Activity events report on attempts at remediating a compromised device or computer network. It follows the MITRE countermeasures defined by the D3FEND\u2122 <a target='_blank' href='https://d3fend.mitre.org/'>Matrix</a>."
        }
      },
      "requirement": "required",
      "caption": "Class ID",
      "description": "The unique identifier of a class. A class describes the attributes available in an event.",
      "sibling": "class_name",
      "type": "integer_t"
    },
    "type_name": {
      "requirement": "optional",
      "caption": "Type Name",
      "description": "The event/finding type name, as defined by the type_uid.",
      "type": "string_t"
    },
    "type_uid": {
      "requirement": "required",
      "caption": "Type ID",
      "description": "The event/finding type ID. It identifies the event's semantics and structure. The value is calculated by the logging system as: <code>class_uid * 100 + activity_id</code>.",
      "sibling": "type_name",
      "type": "long_t",
      "enum": {
        "700101": {
          "caption": "Remediation Activity: Isolate"
        },
        "700102": {
          "caption": "Remediation Activity: Evict"
        },
        "700103": {
          "caption": "Remediation Activity: Restore"
        },
        "700104": {
          "caption": "Remediation Activity: Harden"
        },
        "700100": {
          "caption": "Remediation Activity: Unknown"
        },
        "700199": {
          "caption": "Remediation Activity: Other"
        }
      }
    },
    "count": {
      "requirement": "optional",
      "caption": "Count",
      "description": "The number of times that events in the same logical group occurred during the event <strong>Start Time</strong> to <strong>End Time</strong> period.",
      "type": "integer_t",
      "default": 1
    },
    "duration": {
      "description": "The event duration or aggregate time, the amount of time the event covers from <code>start_time</code> to <code>end_time</code> in milliseconds.",
      "requirement": "optional",
      "caption": "Duration",
      "type": "long_t"
    },
    "end_time": {
      "description": "The end time of a time period, or the time of the most recent event included in the aggregate event.",
      "requirement": "optional",
      "caption": "End Time",
      "type": "timestamp_t"
    },
    "start_time": {
      "description": "The start time of a time period, or the time of the least recent event included in the aggregate event.",
      "requirement": "optional",
      "caption": "Start Time",
      "type": "timestamp_t"
    },
    "time": {
      "requirement": "required",
      "caption": "Event Time",
      "description": "The normalized event occurrence time or the finding creation time.",
      "type": "timestamp_t"
    },
    "timezone_offset": {
      "requirement": "recommended",
      "caption": "Timezone Offset",
      "description": "The number of minutes that the reported event <code>time</code> is ahead or behind UTC, in the range -1,080 to +1,080.",
      "type": "integer_t"
    },
    "cloud": {
      "requirement": "required",
      "group": "primary",
      "caption": "Cloud",
      "description": "Describes details about the Cloud environment where the event was originally created or logged.",
      "type": "cloud"
    },
    "api": {
      "requirement": "optional",
      "group": "context",
      "caption": "API Details",
      "description": "Describes details about a typical API (Application Programming Interface) call.",
      "type": "api"
    },
    "osint": {
      "requirement": "required",
      "group": "primary",
      "caption": "OSINT",
      "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.",
      "is_array": true,
      "type": "osint"
    },
    "data": {
      "description": "Additional data that is associated with the event.",
      "requirement": "optional",
      "caption": "Data",
      "type": "json_t",
      "@deprecated": {
        "since": "1.1.0",
        "message": "Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0"
      }
    },
    "confidence": {
      "group": "classification",
      "requirement": "optional",
      "caption": "Confidence",
      "description": "The confidence of the reported event severity as a percentage: 0%-100%.",
      "type": "integer_t",
      "@deprecated": {
        "since": "1.1.0",
        "message": "Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0"
      }
    },
    "record_id": {
      "description": "Unique idenifier for the event",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    }
  }
}