CISCO Firepower

Overview

Cisco Firepower is an integrated suite of network security and traffic management products, deployed either on purpose-built platforms or as a software solution. The system offers unified management of firewalls, application control, intrusion prevention, URL filtering, and advanced malware protection, to help organizations handle network traffic in a way that complies with the organizations’ security policy - the guidelines for protecting the organizations’ network. This integration enables organizations to block suspicious IP addresses and URLs.

D3 SOAR is providing REST operations to function with CISCO Firepower.

For example, you can use the CISCO Firepower Management Center to collect data and gather information such as spam messages or malicious email messages.

CISCO Firepower is available for use in:

Known Limitations

The management center REST API implements rate limiting to reduce network load.

The API will accept no more than 120 messages per minute from an individual IP address. It will only allow 10 simultaneous connections per IP address. These are not configurable parameters.

If a client exceeds these limits, the API will give an HTTP 429 error.

Please refer to CISCO REST API Rate Limiting for detailed information.

Connection

To connect to CISCO Firepower from D3 SOAR, please follow this part to collect the required information below:

Reader Note

The scenario outlined in this user guide assumes that you already have the following prerequisites:

• A machine with CISCO Firepower Management Center installed.

• A user account in CISCO Firepower Management Center with an admin role.

Permission Requirements

Each endpoint in the CISCO Firepower API requires a certain permission scope. The following are required scopes for the commands in this integration:

As CISCO Firepower is using role-based access control (RBAC), the API access token is generated based on a specific user account and the application. Therefore, the command permissions are inherited from the user account’s role. Users need to configure their user profile from the CISCO Firepower console for each command in this integration.

Reader Note

CISCO Firepower’s system-provided user profiles are as follows:

• Administrator

• Access Admin

• Discovery Admin

• External Database User (Read Only)

• Intrusion Admin

• Maintenance User

• Network Admin

• Security Analyst

• Security Analyst (Read Only)

• Security Approver

• Threat Intelligence Director (TID) User

Please refer to Predefined User Roles for details on configuring user profiles.

The permission requirements inside the table above are policies. If the default roles do not meet your requirements, these policies can be used to create custom roles for users. Please refer to Configuring CISCO Firepower to work with D3 SOAR for more details.

• For “Object Manager > Modify Object Manager” permissions, it means you only need to select the sub policy “Modify Object Manager” under “Object Manager”.

  

Configuring CISCO Firepower to Work with D3 SOAR

1. Log into CISCO Firepower Management Center.

   

2. Click System, then click Users.

   

3. Create a custom user role.

   1. Select User Roles. Then click the button Create User Role.

      

   2. Enter a name for the Role. Refer to the Permission Requirements for the permissions your role requires, and check each box as needed.. Then click Save.

      

4. Create a new user.

   1. Click Users, then click the button Create User.

      

   2. Enter a User Name and Password. Click + Add Domain to grant user roles.

      

   3. Select the custom role you just created and click Save.

      

   4. Then Save the user you created.

      

Configuring D3 SOAR to Work with CISCO Firepower

1. Log in to D3 SOAR.

2. Find the CISCO Firepower integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type CISCO Firepower in the search box to find the integration, then click it to select it.

   4. Click + New Connection, on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to CISCO Firepower.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add your desired description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: Check the tick box to ensure the connection is available for use.

      

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      1. Input your domain level Server URL.
      2. Input your created user name. Please refer to step 4 of Configuring CISCO Firepower to work with D3 SOAR for how to create user.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

   11. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
       To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.

4. Test the connection.

   

   1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

CISCO Firepower includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the CISCO Firepower API, please refer to the CISCO Firepower API reference.

Reader Note

Certain permissions are required for each command. Please refer to the Permission Requirements and Configuring CISCO Firepower to Work with D3 SOAR for details.

Block IPs

Blocks IP address(es) by assigning them to a Network Group which is attached to a policy. To create an IP Block List network group and attach it to a policy, please refer to How to create Firepower IP Block List.

Input

Output

{
    "links": {
        "self": "https://1.1.1.1/api/fmc_config/v1/domain/***-***-***-***-***/object/networkgroups/***-***-***-***-***"
    },
    "type": "NetworkGroup",
    "literals": [
        {
            "type": "Network",
            "value": "1.1.1.1/30"
        },
        {
            "type": "Host",
            "value": "***:***:***::***:***:***"
        },
        {
            "type": "Host",
            "value": "10.0.0.0"
        }
    ],
    "overridable": true,
    "description": "IP Addresses to be blocked.",
    "id": "***-***-***-***-***",
    "name": "IP_Block_List_0804",
    "metadata": {
        "timestamp": 0,
        "lastUser": {
            "name": "sysint"
        },
        "domain": {
            "name": "Global",
            "id": "***-***-***-***-***",
            "type": "Domain"
        }
    }
}

{
    "NetworkGroupName": "IP_Block_List_0804",
    "NetworkGroupID": "***-***-***-***-***",
    "BlockedIPs": [
        "1.1.1.1/30",
        "***:***:***::***:***:***",
        "10.0.0.0"
    ]
}

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Block URLs

Blocks URL(s) by assigning them to a URL Group which is attached to a policy. To create a URL group of URL Block Lists and attach it to a policy, please refer to How to create Firepower URL Block List.

Input

Output

{
    "links": {
        "self": "https://1.1.1.1/api/fmc_config/v1/domain/***-***-***-***-***/object/urlgroups/***-***-***-***-***"
    },
    "type": "UrlGroup",
    "literals": [
        {
            "url": "www.g00gle.com",
            "type": "Url"
        },
        {
            "url": "https://xmr.pool.minergate.com",
            "type": "Url"
        }
    ],
    "overridable": true,
    "description": "URLs to be blocked",
    "id": "***-***-***-***-***",
    "name": "URL_Block_List_0804",
    "metadata": {
        "timestamp": 0,
        "lastUser": {
            "name": "***"
        },
        "domain": {
            "name": "Global",
            "id": "***-***-***-***-***",
            "type": "Domain"
        }
    }
}

{
    "URLGroupName": "URL_Block_List_0804",
    "URLGroupId": "***-***-***-***-***",
    "BlockedURLs": [
        "www.g00gle.com",
        "https://xmr.pool.minergate.com"
    ]
}

Successful

Error Handling

If the Return Data is or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Get IPs By NetworkGroup Name

Returns IP Addresses in the IP block list with the NetworkGroup Name. NetworkGroup Names can be obtained in Firepower Management Center under Objects > Object Management > Network.

Input

Output

{
    "links": {
        "self": "https://1.1.1.1/api/fmc_config/v1/domain/***-***-***-***-***/object/networkgroups/***-***-***-***-***"
    },
    "type": "NetworkGroup",
    "literals": [
        {
            "type": "Network",
            "value": "1.1.1.1/30"
        },
        {
            "type": "Host",
            "value": "1.1.1.1.101"
        },
        {
            "type": "Host",
            "value": "1.1.1.1.101"
        }
    ],
    "overridable": true,
    "description": "Block IP List 0804a description",
    "id": "***-***-***-***-***",
    "name": "BlockIPList_0729a",
    "metadata": {
        "timestamp": 1659631133433,
        "lastUser": {
            "name": "***"
        },
        "domain": {
            "name": "***",
            "id": "***-***-***-***-***",
            "type": "Domain"
        }
    }
}

{
    "NetworkGroupName": "BlockIPList_0729a",
    "NetworkGroupID": "***-***-***-***-***",
    "BlockedIPs": [
        "1.1.1.1/30",
        "1.1.1.1.101",
        "1.1.1.1.102"
    ]
}

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Get URLs By URL Group Name

Returns URLs in the URL block list with the URL Group Name. URL Group Names can be obtained in Firepower Management Center under Objects > Object Management > URL.

Input

Output

{
    "links": {
        "self": "https://1.1.1.1/api/fmc_config/v1/domain/***-***-***-***-***/object/urlgroups/***-***-***-***-***"
    },
    "type": "UrlGroup",
    "literals": [
        {
            "url": "www.ciscoc.com",
            "type": "Url"
        },
        {
            "url": "https://xmr.pool.minergate.com",
            "type": "Url"
        }
    ],
    "overridable": false,
    "description": "Block URL List 804b description",
    "id": "***-***-***-***-***",
    "name": "BlockUrlList_0729b",
    "metadata": {
        "timestamp": 1659631339996,
        "lastUser": {
            "name": "***"
        },
        "domain": {
            "name": "***",
            "id": "***-***-***-***-***",
            "type": "Domain"
        }
    }
}

{
    "URLGroupName": "BlockUrlList_0729b",
    "URLGroupID": "***-***-***-***-***",
    "BlockedURLs": [
        "www.ciscoc.com",
        "https://xmr.pool.minergate.com"
    ]
}

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Successful

Error Handling

If the Return Data is failed, an Error tab will appear in the Test Result window.

The error tab contains the responses from the third-party API calls including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

FAQ

Question 1: How do I create a Firepower IP Block List?

1. Log into your Firepower Management Center with your login credentials.

2. Click Objects on the top, then click Object Management.

   

3. Click Network on the left side, then select Add Group in the Add Network dropdown list on the top.

   

4. In the pop-up window, enter the Name and Description for the IP Block List. You can add existing network objects to the list or check Allow Overrides and just leave the list blank. Then click Save.

   

5. If the object list is empty, a Warning window will appear, click Yes.

   

6. You should find the IP Block List you just created in the Network object list. Save the name which will be used when you block IPs.

   

7. Attach the IP Block List to a policy. Click Policies on the top, then select Access Control on the dropdown list.

   

8. Select a policy on which to attach IP Block List, or create a new policy by clicking New Policy on the top right corner. Make sure your policy is linked to a device, so that device can block the IPs from the list.

   

9. In the Security Intelligence tab, go to the Networks tab, then select the IP Block List you just created, and set Available Zones to Any, then click Add to Blacklist to attach the IP Block List you created to the Blacklist. After you click that button, the IP Block List will show in the Blacklist box. Click Save to save the changes. The IP Addresses will be blocked if you added the IP Block List in the policy blacklist.

   

10. Then run the Block IPs command, and the IPs you add to the list will be blocked.

Question 2: How do I create a Firepower URL Block List?

1. Log into your Firepower Management Center with your login credentials.

2. Click Objects on the top, then click Object Management.

   

3. Click URL on the left side, then select Add Group in the Add URL dropdown list on the top.

   

4. In the pop-up window, enter the Name and Description for the URL Block List. You can add existing URL objects to the list or check Allow Overrides and just leave the list blank. Then click Save.

   

5. If the object list is empty, a Warning window will appear, click Yes.

   

6. You should find the URL Block List you just created in the URL object list. Save the name which will be used when you block URLs.

   

7. Attach the URL Block List to a policy. Click Policies on the top, then select Access Control on the dropdown list. Select a policy on which to attach URL Block List, or create a new policy by clicking New Policy on the top right corner.

   

8. In the Security Intelligence tab, go to the URLs tab, then select the URL Block List you just created. Set Available Zones to Any, then click Add to Blacklist to attach the URL Block List to the Blacklist. You should find the URL Block List you just created is displayed under Blacklist URLs. Don’t forget to click Save on the top right corner to save your change. If the policy is enabled, the URLs you added to the URL Block List will be blocked.