Current ThreatQ Version Filter
 

Cisco ESA Export IOC Action Bundle

The web format of this guide reflects the most current release.  Guides for older iterations are available in PDF format.  

Integration Details

ThreatQuotient provides the following details for this integration:

Introduction

The Cisco ESA Export IOC Action Bundle uses AsyncOS API for Cisco Secure Email Gateway to enable users to add or delete Safelist and Blocklist entries.  Cisco Secure Email Gateway is an email security solution that blocks spam and security threats from the internet and prevents the accidental or intentional leakage of customer data. 

The integration provides the following actions:

  • Cisco ESA Add Recipients To Quarantine List - adds recipients to Safelist/Blocklist
  • Cisco ESA Add Senders To Quarantine List - adds senders to Safelist/Blocklist
  • Cisco ESA Delete Recipients From Quarantine List - deletes recipients from Safelist/Blocklist
  • Cisco ESA Delete Senders From Quarantine List - deletes senders from Safelist/Blocklist

The actions are compatible with following indicator types:

  • Email Address
  • FQDN
  • IP Address

This action is intended for use with ThreatQ TDR Orchestrator (TQO). An active TQO license is required for this feature.

Prerequisites

Installation

Perform the following steps to install the integration:

The same steps can be used to upgrade the integration to a new version.

  1. Log into https://marketplace.threatq.com/.
  2. Locate and download the action zip file.
  3. Navigate to the integrations management page on your ThreatQ instance.
  4. Click on the Add New Integration button.
  5. Upload the action zip file using one of the following methods:
    • Drag and drop the zip file into the dialog box
    • Select Click to Browse to locate the zip file on your local machine

    ThreatQ will inform you if the action already exists on the platform and will require user confirmation before proceeding. ThreatQ will also inform you if the new version of the action contains changes to the user configuration. The new user configurations will overwrite the existing ones for the action and will require user confirmation before proceeding.

You will still need to configure the action.

Configuration

ThreatQuotient does not issue API keys for third-party vendors. Contact the specific vendor to obtain API keys and other integration-related credentials.
 

To configure the integration:

  1. Navigate to your integrations management page in ThreatQ.
  2. Select the Actions option from the Category dropdown (optional).
  3. Click on the action entry to open its details page.
  4. Enter the following parameters under the Configuration tab:

    The configurations set on this page will be used as the default settings when inserting this action into a new workflow. Updating the configurations on this page will not update any instances of this action that have already been deployed to a workflow. In that scenario, you must update the action’s configurations within the workflow itself.

    Parameter Description
    Cisco ESA URL Enter the URL to your Cisco ESA instance (e.g https://cisco-esa.<domain>.com:<async-os-api-port>).
    Cisco ESA Username Enter your Cisco ESA Username.
    Cisco ESA Password Enter your Cisco ESA Password.
    List Type The type of the list changed by this action. Options: Blocklist or Safelist.
    Recipient List
    (Add Senders to Quarantine List only)
    A comma-separated list of valid Email Addresses. This list is set as recipient for the exported senders.
    Sender List
    (Add Recipients  to Quarantine List only)
    Enter a comma-separated list of Email Addresses.  This list is set as sender for the exported recipients. You can also add a domain to include all emails associated with it (example: threatq.com).  
    Enable SSL Verification When checked, validates the host-provided SSL certificate.  This parameter is enabled by default.
    Disable Proxies Enabling this option will have the action ignore proxy setting configured in ThreatQ.  
    Objects per run Enter the maximum number of objects to send to Cisco ESA per-run.

    Configuration Screen
  5. Review any additional settings, make any changes if needed, and click on Save.

Actions

The following actions are available:

Action Description Object Type Object Subtype
Cisco ESA Add Recipients To Quarantine List Adds recipients to Safelist/Blocklist Indicator Email Address
Cisco ESA Add Senders To Quarantine List Adds senders to Safelist/Blocklist Indicator Email Address, FQDN, IP Address
Cisco ESA Delete Recipients From Quarantine List Deletes recipients from Safelist/Blocklist Indicator Email Address
Cisco ESA Delete Senders From Quarantine List Deletes senders from Safelist/Blocklist Indicator Email Address, FQDN, IP Address

Cisco ESA Add Recipients to Quarantine List

The Cisco Esa Add Recipients to Quarantine List action adds recipient entries to the Safelist or Blocklist - depending on action configuration.  

POST {{CISCO_ESA_URL}}/esa/api/v2.0/quarantine/blocklist?resource_attribute

Sample Request Body:

{
  "action": "add",
  "quarantineType": "spam",
  "viewBy": "recipient",
  "recipientAddresses": [
    "user1@acme.com"
  ],
  "senderList": [
    "acme.com"
  ]
}

Sample Response:

{
  "data": {
    "action": "add",
    "recipientAddresses": [
      "user1@acme.com"
    ],
    "senderList": [
      "acme.com"
    ]
  }
}

Cisco ESA Add Senders to Quarantine List

The Cisco ESA Add Senders to Quarantine List action adds sender entries to either Safelist or Blocklist - depending on action configuration.  

POST {{CISCO_ESA_URL}}/esa/api/v2.0/quarantine/blocklist?resource_attribute

Sample Request Body:

{
  "action": "append",
  "quarantineType": "spam",
  "viewBy": "sender",
  "senderAddresses": [
    "user1@acme.com"
  ],
  "recipientList": [
    "user2@acme.com"
  ]
}

Sample Response:

{
  "data": {
    "action": "append",
    "recipientList": [
      "user2@acme.com"
    ],
    "senderList": [
      "acme.com"
    ]
  }
}

Cisco ESA Delete Recipients from Quarantine List

The Cisco ESA Delete Recipients from Quarantine List action deletes recipient entries from the Safelist or Blocklist - depending on action configuration.  

DELETE {{CISCO_ESA_URL}}/esa/api/v2.0/quarantine/blocklist

Sample Request Body:

{
  "quarantineType": "spam",
  "viewBy": "recipient",
  "recipientList": [
    "user1@acme.com"
  ]
}

Sample Request Body:

{
  "data": {
    "action": "delete",
    "totalCount": 1,
    "recipientList": [
      "user1@acme.com"
    ]
  }
}

Cisco ESA Delete Senders from Quarantine List

The Cisco ESA Delete Senders from Quarantine List action deletes sender entries from Safelist or Blocklist - depending on the action configuration.

DELETE {{CISCO_ESA_URL}}/esa/api/v2.0/quarantine/blocklist

Sample Request Body:

{
  "quarantineType": "spam",
  "viewBy": "sender",
  "senderList": [
    "user1@acme.com"
  ]
}

Sample Response:

{
  "data": {
    "action": "delete",
    "totalCount": 1,
    "senderList": [
      "user1@acme.com"
    ]
  }
}

Enriched Data

Object counts and action runtime are supplied as generalities only - objects returned by a provider can differ based on credential configurations and action runtime may vary based on system resources and load.

Cisco ESA Add Recipients To Quarantine List

Metric Result
Run Time 3 minutes
Indicators 50

Cisco ESA Add Senders To Quarantine List

Metric Result
Run Time 3 minutes
Indicators 50

Cisco ESA Delete Recipients From Quarantine List

Metric Result
Run Time 3 minutes
Indicators 50

Cisco ESA Delete Senders From Quarantine List

Metric Result
Run Time 3 minutes
Indicators 50

Known Issues / Limitations

  • Adding already existing indicators to a Safelist/Blocklist returns a 409 error with possible connection closed errors. Due to security reasons, Pynoceros is not tolerant of network issues and the errors logged.
  • The maximum number of entries that can be added to a list can be adjusted through the web interface of the Cisco ESA. The value must be in the range 1-500.

Change Log

  • Version 1.0.1
    • Added a new configuration option for all actions: Disable Proxies.  This allows users to determine whether or not the integration will honor ThreatQ proxy settings. 
    • Added a new known limitation entry regarding the max number of entries that can be added to a list.  
  • Version 1.0.0
    • Initial release

PDF Guides

Document ThreatQ Version
Cisco ESA Export IOC Action Bundle Guide v1.0.1 5.20.0 or Greater
Cisco ESA Export IOC Action Bundle Guide v1.0.0 5.20.0 or Greater