Containment Plan

This playbook handles the main containment actions available with Cortex XSIAM, including the following sub-playbooks: * Containment Plan - Isolate endpoint * Containment Plan - Disable account * Containment Plan - Quarantine file * Containment Plan - Block indicators * Containment Plan - Clear user session (currently, the playbook supports only Okta) Note: The playbook inputs enable manipulating the execution flow. Read the input descriptions for details.

Common Playbooks · 18 tasks · 17 inputs · 4 outputs

Details

ID	`Containment Plan`
From Version	6.6.0
Tasks	18

README

This playbook handles the main containment actions available with Cortex XSIAM, including the following sub-playbooks:

Containment Plan - Isolate endpoint
Containment Plan - Disable account
Containment Plan - Quarantine file
Containment Plan - Block indicators
Containment Plan - Clear user session (currently, the playbook supports only Okta)

Note: The playbook inputs enable manipulating the execution flow. Read the input descriptions for details.

Dependencies

This playbook uses the following sub-playbooks, integrations, and scripts.

Sub-playbooks

Containment Plan - Block Indicators
Containment Plan - Isolate Device
Containment Plan - Clear User Sessions
Containment Plan - Disable Account
Containment Plan - Quarantine File

Integrations

This playbook does not use any integrations.

Scripts

Commands

core-get-endpoints

Playbook Inputs

Name	Description	Default Value	Required
AutoContainment	Whether to execute containment plan (except isolation) automatically. The specific containment playbook inputs should also be set to ‘True’.	False	Optional
HostContainment	Whether to execute endpoint isolation.	True	Optional
UserContainment	Set to ‘True’ to disable the user account.	True	Optional
BlockIndicators	Set to ‘True’ to block the indicators.	True	Optional
FileContainment	Set to ‘True’ to quarantine the identified file.	True	Optional
ClearUserSessions	Set to ‘True’ to clear the user active Okta sessions.	True	Optional
EndpointID	The endpoint ID to run commands over.		Optional
Username	The username to disable.		Optional
FileHash	The file hash to block.		Optional
FilePath	The path of the file to block.		Optional
IP	The IP indicators.		Optional
Domain	The domain indicators.		Optional
URL	The URL indicator.		Optional
FileRemediation	Choose ‘Quarantine’ or ‘Delete’ to avoid file remediation conflicts. For example, choosing ‘Quarantine’ ignores the ‘Delete file’ task under the eradication playbook and will execute only file quarantine.	Quarantine	Optional
IAMUserDomain	The Okta IAM users domain. The domain will be appended to the username. e.g. username@IAMUserDomain.		Optional
UserVerification	Possible values: True/False. Whether to provide user verification for blocking those IPs and disabling the users. False - No prompt will be displayed to the user. True - The server will ask the user for blocking verification and will display the blocking list.	False	Optional
AutoBlockIndicators	Possible values: True/False. Default: True. Should the given indicators be automatically blocked, or should the user be given the option to choose? If set to True - no prompt will appear, and all provided indicators will be blocked automatically. If set to False - the user will be prompted to select which indicators to block.	True	Optional

Playbook Outputs

Path	Description	Type
Blocklist.Final	The blocked accounts.	unknown
QuarantinedFilesFromEndpoints	The quarantined files from endpoint.	unknown
Core.blocklist.added_hashes	The file Hash that was added to the blocklist.	unknown
Core.Isolation.endpoint_id	The isolated endpoint ID.	unknown

Playbook Image

Containment Plan

Inputs

AutoContainment — Whether to execute containment plan (except isolation) automatically. The specific containment playbook inputs should also be set to 'True'.
HostContainment — Whether to execute endpoint isolation.
UserContainment — Set to 'True' to disable the user account.
BlockIndicators — Set to 'True' to block the indicators.
FileContainment — Set to 'True' to quarantine the identified file.
ClearUserSessions — Set to 'True' to clear the user active Okta sessions.
EndpointID — The endpoint ID to run commands over.
Username — The username to disable.
FileHash — The file hash to block.
FilePath — The path of the file to block.
IP — The IP indicators.
Domain — The domain indicators.
URL — The URL indicator.
FileRemediation — Choose 'Quarantine' or 'Delete' to avoid file remediation conflicts. For example, choosing 'Quarantine' ignores the 'Delete file' task under the eradication playbook and will execute only file quarantine.
IAMUserDomain — The Okta IAM users domain. The domain will be appended to the username. e.g. username@IAMUserDomain.
UserVerification — Possible values: True/False. Whether to provide user verification for blocking those IPs and disabling the users. False - No prompt will be displayed to the user. True - The server will ask the user for blocking verification and will display the blocking list.
AutoBlockIndicators — Possible values: True/False. Default: True. Should the given indicators be automatically blocked, or should the user be given the option to choose? If set to True - no prompt will appear, and all provided indicators will be blocked automatically. If set to False - the user will be prompted to select which indicators to block.

Outputs

Blocklist.Final — The blocked accounts.
QuarantinedFilesFromEndpoints — The quarantined files from endpoint.
Core.blocklist.added_hashes — The file Hash that was added to the blocklist.
Core.Isolation.endpoint_id — The isolated endpoint ID.

Commands used

core-get-endpoints

Flowchart

Source

Download History Raw

id: Containment Plan - Disable Account
version: -1
name: Containment Plan - Disable Account
description: |-
  ## Containment Plan - Disable Account

  This playbook is a sub-playbook within the containment plan playbook.
  The playbook disables users by utilizing the sub-playbook "Block Account - Generic v2"
starttaskid: "0"
tasks:
  "0":
    id: "0"
    taskid: 9fb1ed1d-c22c-48bb-8a3c-4d58bbca6347
    type: start
    task:
      id: 9fb1ed1d-c22c-48bb-8a3c-4d58bbca6347
      version: -1
      name: ""
      iscommand: false
      brand: ""
      description: ''
    nexttasks:
      '#none#':
      - "12"
    separatecontext: false
    continueonerrortype: ""
    view: |-
      {
        "position": {
          "x": 450,
          "y": -140
        }
      }
    note: false
    timertriggers: []
    ignoreworker: false
    skipunavailable: false
    quietmode: 0
    isoversize: false
    isautoswitchedtoquietmode: false
  "2":
    id: "2"
    taskid: 4d874c50-7a1f-489c-8397-3fc3304eeea6
    type: title
    task:
      id: 4d874c50-7a1f-489c-8397-3fc3304eeea6
      version: -1
      name: Done
      type: title
      iscommand: false
      brand: ""
      description: ''
    separatecontext: false
    continueonerrortype: ""
    view: |-
      {
        "position": {
          "x": 450,
          "y": 750
        }
      }
    note: false
    timertriggers: []
    ignoreworker: false
    skipunavailable: false
    quietmode: 0
    isoversize: false
    isautoswitchedtoquietmode: false
  "8":
    id: "8"
    taskid: 73bc4723-d270-4e04-8a74-c13b5b1369f1
    type: regular
    task:
      id: 73bc4723-d270-4e04-8a74-c13b5b1369f1
      version: -1
      name: Set disabled users to the Incident context
      description: commands.local.cmd.set.parent.incident.context
      script: Builtin|||setParentIncidentContext
      type: regular
      iscommand: true
      brand: Builtin
    nexttasks:
      '#none#':
      - "2"
    scriptarguments:
      key:
        simple: UsersBlockList
      value:
        complex:
          root: Blocklist
          accessor: Final
    separatecontext: false
    continueonerrortype: ""
    view: |-
      {
        "position": {
          "x": 450,
          "y": 575
        }
      }
    note: false
    timertriggers: []
    ignoreworker: false
    skipunavailable: true
    quietmode: 0
    isoversize: false
    isautoswitchedtoquietmode: false
  "12":
    id: "12"
    taskid: 073f607c-a924-43c1-8852-d480e1454fdc
    type: condition
    task:
      id: 073f607c-a924-43c1-8852-d480e1454fdc
      version: -1
      name: Should disable the account?
      description: Whether to disable the account based on the input values.
      type: condition
      iscommand: false
      brand: ""
    nexttasks:
      '#default#':
      - "2"
      "yes":
      - "13"
    separatecontext: false
    conditions:
    - label: "yes"
      condition:
      - - operator: isEqualString
          left:
            value:
              complex:
                root: inputs.UserContainment
            iscontext: true
          right:
            value:
              simple: "True"
          ignorecase: true
      - - operator: isNotEmpty
          left:
            value:
              complex:
                root: inputs.Username
            iscontext: true
    continueonerrortype: ""
    view: |-
      {
        "position": {
          "x": 450,
          "y": 0
        }
      }
    note: false
    timertriggers: []
    ignoreworker: false
    skipunavailable: false
    quietmode: 0
    isoversize: false
    isautoswitchedtoquietmode: false
  "13":
    id: "13"
    taskid: 32ec3207-df33-4d5f-8551-2a49ca677b62
    type: regular
    task:
      id: 32ec3207-df33-4d5f-8551-2a49ca677b62
      version: -1
      name: Set users to disable
      description: |-
        Set a value in context under the key you entered. If no value is entered, the script doesn't do anything.

        This automation runs using the default Limited User role, unless you explicitly change the permissions.
        For more information, see the section about permissions here:
        - For Cortex XSOAR 6 see https://docs-cortex.paloaltonetworks.com/r/Cortex-XSOAR/6.x/Cortex-XSOAR-Playbook-Design-Guide/Automations 
        - For Cortex XSOAR 8 Cloud see https://docs-cortex.paloaltonetworks.com/r/Cortex-XSOAR/8/Cortex-XSOAR-Cloud-Documentation/Create-a-script
        - For Cortex XSOAR 8.7 On-prem see https://docs-cortex.paloaltonetworks.com/r/Cortex-XSOAR/8.7/Cortex-XSOAR-On-prem-Documentation/Create-a-script
      scriptName: SetAndHandleEmpty
      type: regular
      iscommand: false
      brand: ""
    nexttasks:
      '#none#':
      - "18"
    scriptarguments:
      key:
        simple: UsersToDisable
      value:
        complex:
          root: inputs.Username
          transformers:
          - operator: uniq
    separatecontext: false
    continueonerrortype: ""
    view: |-
      {
        "position": {
          "x": 450,
          "y": 210
        }
      }
    note: false
    timertriggers: []
    ignoreworker: false
    skipunavailable: false
    quietmode: 0
    isoversize: false
    isautoswitchedtoquietmode: false
  "18":
    id: "18"
    taskid: b35ee9bb-51f1-4f64-8df5-b490d1592b2c
    type: playbook
    task:
      id: b35ee9bb-51f1-4f64-8df5-b490d1592b2c
      version: -1
      name: Block Account - Generic v2
      playbookName: Block Account - Generic v2
      type: playbook
      iscommand: false
      brand: ""
      description: ''
    nexttasks:
      '#none#':
      - "8"
    scriptarguments:
      Tag:
        simple: XSIAM alert - ${alert.id}
      UserVerification:
        complex:
          root: inputs.UserVerification
      Username:
        complex:
          root: UsersToDisable
    separatecontext: true
    continueonerrortype: ""
    loop:
      iscommand: false
      exitCondition: ""
      wait: 1
      max: 100
    view: |-
      {
        "position": {
          "x": 450,
          "y": 390
        }
      }
    note: false
    timertriggers: []
    ignoreworker: false
    skipunavailable: false
    quietmode: 0
    isoversize: false
    isautoswitchedtoquietmode: false
view: |-
  {
    "linkLabelsPosition": {
      "12_2_#default#": 0.16
    },
    "paper": {
      "dimensions": {
        "height": 955,
        "width": 380,
        "x": 450,
        "y": -140
      }
    }
  }
inputs:
- key: UserContainment
  value:
    simple: "True"
  required: false
  description: Set to 'True' to disable the user account.
  playbookInputQuery:
- key: Username
  value: {}
  required: false
  description: The username to disable.
  playbookInputQuery:
- key: UserVerification
  value:
    simple: "True"
  required: false
  description: |-
    Possible values:True/False. Default:True.
    Specify if User Verification is required to disable users.
  playbookInputQuery:
outputs:
- contextPath: Blocklist.Final
  description: Blocked accounts
  type: unknown
quiet: true
tests:
- No tests (auto formatted)
fromversion: 6.6.0
marketplaces:
- marketplacev2
- platform