Cisco Umbrella Enforcement

Add and remove domains in Cisco OpenDNS.

Network Security · Cisco Umbrella Enforcement

Details

IDCisco Umbrella Enforcement
ProviderCisco Systems
CategoryNetwork Security
From Version5.0.0
Docker Imagedemisto/python3:3.12.13.10116658
Supported ModulesAgentix XSIAM

README

Add and remove domains in Cisco OpenDNS.
This integration was integrated and tested with version 1.0 of Cisco Umbrella Enforcement.
Supported Cortex XSOAR versions: 5.0.0 and later.

Configure Cisco Umbrella Enforcement in Cortex

Parameter Description Required
url Server URL (e.g., https://example.net) True
api_key API Key True
insecure Trust any certificate (not secure) False
proxy Use system proxy settings False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

umbrella-domain-event-add


Posts a malware event to the API for processing and optionally adding to a customer’s domain lists.

Base Command

umbrella-domain-event-add

Input

Argument Name Description Required
alert_time Alert time of the new event in datetime format, e.g., 2013-02-08T09:30:26.0Z. Required
device_id Device ID of the new event. Required
destination_domain Destination domain of the new event. Required
destination_url Destination URL of the new event. Required
device_version Device version for the new event. Required
destination_ip The destination IP address of the domain, specified in IPv4 dotted-decimal notation e.g., ‘8.8.8.8’. Optional
event_severity The partner threat level or rating, e.g., severe, bad, high, and so on. Optional
event_type Common name or classification of the threat. Optional
event_description Variant or other descriptor of the event type. Optional
file_name Path to the file exhibiting malicious behavior. Optional
file_hash SHA-1 of file reported by the appliance. Optional
source IP/Host of the infected computer/device that was patient 0 for the event. Optional

Context Output

There is no context output for this command.

Command Example

!umbrella-domain-event-add alert_time=2013-02-08T09:30:26.0Z device_id=ba6a58f4-e692-4724-ba36-c28132c761de destination_domain=test6.com device_version=13.7a destination_url=test6.com

Context Example

{}

Human Readable Output

New event was added successfully, The Event id is 31bb0adb,8f27,4423,a081-3b5773260f87.

umbrella-domains-list


List of domains.

Base Command

umbrella-domains-list

Input

Argument Name Description Required
page Number of page to return. Default is “1”. Optional
limit The maximum number of queries per page. Default is “50”. Default is 50. Optional

Context Output

Path Type Description
UmbrellaEnforcement.Domains.name String Name of the domains.
UmbrellaEnforcement.Domains.id Number ID of the domains.
UmbrellaEnforcement.Domains.IsDeleted Boolean True if the domain has been deleted from list.

Command Example


#### Context Example

```json
{
    "UmbrellaEnforcement": {
        "Domains": [
            {
                "IsDeleted": false,
                "id": 3569571,
                "name": "test6.com"
            },
            {
                "IsDeleted": false,
                "id": 3790609,
                "name": "test7.com"
            },
            {
                "IsDeleted": false,
                "id": 3912159,
                "name": "test8.com"
            },
            {
                "IsDeleted": false,
                "id": 3912161,
                "name": "test9.com"
            },
            {
                "IsDeleted": false,
                "id": 54637170,
                "name": "badinterner4.com"
            }
        ]
    }
}

Human Readable Output

List of Domains

id name
3569571 test6.com
3790609 test7.com
3912159 test8.com
3912161 test9.com
54637170 badinterner4.com

umbrella-domain-delete


Delete domain.

Base Command

umbrella-domain-delete

Input

Argument Name Description Required
id ID of the domain. Optional
name Name of the domain. Optional

Context Output

There is no context output for this command.

Command Example

!umbrella-domain-delete name=test6.com

Context Example

{}

Human Readable Output

test6.com domain was removed from block list

Configuration parameters

  • url — Server URL (e.g., https://example.net) (required)
  • api_key — API Key
  • cred_api_key
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (3)

  • umbrella-domain-delete

    Delete domain.

  • umbrella-domain-event-add

    Posts a malware event to the API for processing and optionally adding to a customer's domain lists.

  • umbrella-domains-list

    List of domains.

category: Network Security
provider: Cisco Systems
sectionorder:
- Connect
- Collect
commonfields:
  id: Cisco Umbrella Enforcement
  version: -1
configuration:
- defaultvalue: https://s-platform.api.opendns.com
  display: Server URL (e.g., https://example.net)
  name: url
  required: true
  type: 0
  section: Connect
- display: API Key
  name: api_key
  type: 4
  section: Connect
  hidden: true
  required: false
- name: cred_api_key
  type: 9
  section: Connect
  displaypassword: API Key
  hiddenusername: true
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  section: Connect
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  section: Connect
  required: false
description: Add and remove domains in Cisco OpenDNS.
display: Cisco Umbrella Enforcement
name: Cisco Umbrella Enforcement
script:
  commands:
  - arguments:
    - description: Alert time of the new event in datetime format, e.g., 2013-02-08T09:30:26.0Z.
      name: alert_time
      required: true
    - description: Device ID of the new event.
      name: device_id
      required: true
    - description: Destination domain of the new event.
      name: destination_domain
      required: true
    - description: Destination URL of the new event.
      name: destination_url
      required: true
    - description: Device version for the new event.
      name: device_version
      required: true
    - description: The destination IP address of the domain, specified in IPv4 dotted-decimal notation e.g., '8.8.8.8'.
      name: destination_ip
    - description: 'The partner threat level or rating, e.g., severe, bad, high, and so on.'
      name: event_severity
    - description: Common name or classification of the threat.
      name: event_type
    - description: Variant or other descriptor of the event type.
      name: event_description
    - description: Path to the file exhibiting malicious behavior.
      name: file_name
    - description: SHA-1 of file reported by the appliance.
      name: file_hash
    - description: IP/Host of the infected computer/device that was patient 0 for the event.
      name: source
    description: Posts a malware event to the API for processing and optionally adding to a customer's domain lists.
    name: umbrella-domain-event-add
    compliantpolicies:
    - Domain Blockage
  - arguments:
    - description: Number of page to return. Default is "1".
      name: page
    - defaultValue: '50'
      description: The maximum number of queries per page. Default is "50".
      name: limit
    description: List of domains.
    name: umbrella-domains-list
    outputs:
    - contextPath: UmbrellaEnforcement.Domains.name
      description: Name of the domains.
      type: String
    - contextPath: UmbrellaEnforcement.Domains.id
      description: ID of the domains.
      type: Number
    - contextPath: UmbrellaEnforcement.Domains.IsDeleted
      description: True if the domain has been deleted from list.
      type: Boolean
  - arguments:
    - description: ID of the domain.
      name: id
    - description: Name of the domain.
      name: name
    description: Delete domain.
    name: umbrella-domain-delete
    compliantpolicies:
      - Domain Blockage
  dockerimage: demisto/python3:3.12.13.10116658
  runonce: true
  script: '-'
  subtype: python3
  type: python
fromversion: 5.0.0
tests:
- No tests (auto formatted)