Fortinet FortiWeb Cloud v1.1.0

About the connector

FortiWeb Cloud is an cloud native SaaS based web application firewall (WAF) that protects web applications & APIs from the Open Worldwide Application Security Project's (OWASP) Top 10 threats, zero-day attacks, and other application layer attacks.

This document provides information about the Fortinet FortiWeb Cloud connector, which facilitates automated interactions, with a Fortinet FortiWeb Cloud server using FortiSOAR™ playbooks. Add the Fortinet FortiWeb Cloud connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiWeb Cloud.

NOTE: This connector has been renamed to Fortinet FortiAppSec Cloud. For subsequent updated versions of this connector, refer to Fortinet FortiAppSec Cloud connector documentation.

Version information

Connector Version: 1.1.0

FortiSOAR™ Version Tested on: 7.6.0-5012

Fortinet FortiWeb Cloud Version Tested on: 23.3.a

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.1.0

Following enhancements have been made to the Fortinet FortiWeb Cloud connector in version 1.1.0:

• Added the following operations and playbooks:
  • Get Applications List
  • Add IP Protection
  • Get IP Protection
  • Delete IP Protection
  • Update Geo IP Block List

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-fortinet-fortiweb-cloud

Prerequisites to configuring the connector

• You must have the credentials of Fortinet FortiWeb Cloud server to which you will connect and perform automated operations.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the Fortinet FortiWeb Cloud server.

Minimum Permissions Required

• Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Fortinet FortiWeb Cloud connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Actions supported by the connector

You can use the following automated operations in playbooks and also use the annotations to access operations:

operation: Get Incident Dashboard Details

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when you choose Widget Name as Threats Timeline:

{
    "start": "",
    "end": "",
    "line_data": [
        {
            "line_name": "",
            "number": [
                {
                    "id": "",
                    "value": "",
                    "time": ""
                }
            ]
        }
    ]
}

Output schema when you choose Widget Name as Incidents Timeline:

{
    "start": "",
    "end": "",
    "line_data": [
        {
            "line_name": "",
            "number": [
                {
                    "id": "",
                    "value": "",
                    "time": ""
                }
            ]
        }
    ]
}

Output schema when you choose Widget Name as Source Country:

[
    {
        "name": "",
        "value": ""
    }
]

Output schema when you choose Widget Name as Attack Type:

[
    {
        "name": "",
        "percentage": ""
    }
]

Output schema when you choose Widget Name as High Risk:

[
    {
        "incident_id": "",
        "platform": "",
        "risk": "",
        "name": ""
    }
]

Output schema when you choose Widget Name as HTTP Host:

[
    {
        "name": "",
        "threat_count": "",
        "monitor_count": "",
        "block_count": "",
        "platform": ""
    }
]

operation: Get Incidents List

Input parameters

Output

The output contains the following populated JSON schema:

{
    "total": "",
    "result": [
        {
            "incident_id": "",
            "platform": "",
            "risk": "",
            "description": "",
            "threat_count": "",
            "block_count": "",
            "tags": [],
            "lasttime": "",
            "create_time": "",
            "blocked": "",
            "host_desc": "",
            "app_names": []
        }
    ]
}

operation: Get Incident Details

Input parameters

Output

The output contains the following populated JSON schema:

{
    "incident_id": "",
    "platform": "",
    "risk": "",
    "description": "",
    "threat_count": "",
    "block_count": "",
    "tags": [],
    "lasttime": "",
    "create_time": "",
    "blocked": "",
    "host_desc": "",
    "app_names": [],
    "comments": [],
    "attack_types": [],
    "cve_ids": [],
    "hosts": [],
    "src_countries": [],
    "firsttime": "",
    "src_ips": [],
    "http_urls": []
}

operation: Get Incident Timeline Details

Input parameters

Output

The output contains the following populated JSON schema:

{
    "start": "",
    "end": "",
    "line_data": [
        {
            "line_name": "",
            "number": [
                {
                    "id": "",
                    "value": "",
                    "time": ""
                }
            ]
        }
    ]
}

operation: Get Insight Events Summary

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "detail": "",
    "result": {
        "summary": [
            {
                "type": "",
                "active": ""
            }
        ]
    }
}

operation: Get Incident Aggregated Details

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when you choose Group By as Logs:

{
    "total": "",
    "result": [
        {
            "msg": "",
            "log_id": "",
            "threat_level": "",
            "signature_cve_id": "",
            "owasp_top10": "",
            "main_type": "",
            "http_url": "",
            "srccountry": "",
            "src_ip": "",
            "signature_id": "",
            "date_time": "",
            "sub_type": "",
            "action": "",
            "msg_id": "",
            "country_flag": "",
            "_id": ""
        }
    ]
}

Output schema when you choose some other option in Group By parameter:

{
    "total": "",
    "result": [
        {
            "name": "",
            "threat_count": "",
            "monitor_count": "",
            "block_count": "",
            "platform": ""
        }
    ]
}

operation: Get Insight Events

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when you choose Event Type as Exposed Server:

{
    "detail": "",
    "result": {
        "type": "",
        "events": [
            {
                "id": "",
                "app_name": "",
                "origin_server": [],
                "exposed_dns": "",
                "direct_access": "",
                "last_updated": ""
            }
        ],
        "prev_cursor": "",
        "next_cursor": "",
        "total": ""
    }
}

Output schema when you choose Event Type as Trust IP:

{
    "detail": "",
    "result": {
        "type": "",
        "events": [],
        "prev_cursor": "",
        "next_cursor": "",
        "total": ""
    }
}

Output schema when you choose Event Type as Unprotected Host:

{
    "detail": "",
    "result": {
        "type": "",
        "events": [],
        "prev_cursor": "",
        "next_cursor": "",
        "total": ""
    }
}

Output schema when you choose Event Type as Monitor Service:

{
    "detail": "",
    "result": {
        "type": "",
        "events": [],
        "prev_cursor": "",
        "next_cursor": "",
        "total": ""
    }
}

Output schema when you choose Event Type as WAF Config Alarm:

{
    "detail": "",
    "result": {
        "type": "",
        "events": [
            {
                "id": "",
                "app_name": "",
                "configuration": "",
                "status": "",
                "last_updated": ""
            }
        ],
        "prev_cursor": "",
        "next_cursor": "",
        "total": ""
    }
}

operation: Get IP Protection

Input parameters

Output

The output contains the following populated JSON schema:

{
    "result": {
        "configs": {
            "status": "",
            "ip_list": [
                {
                    "ip": "",
                    "idx": "",
                    "type": ""
                }
            ],
            "ip_reputation": "",
            "block_country_list": [],
            "geo_ip_exception_list": []
        },
        "template": ""
    }
}

operation: Add IP Protection

Input parameters

NOTE: These IP addresses are added to the list selected in the IP Type parameter.

Output

The output contains the following populated JSON schema:

{
    "detail": ""
}

operation: Delete IP Protection

Input parameters

Output

The output contains the following populated JSON schema:

{
    "detail": ""
}

operation: Update Geo IP Block List

Input parameters

Output

The output contains the following populated JSON schema:

{
    "detail": ""
}

operation: Get Applications List

Input parameters

Output

The output contains the following populated JSON schema:

{
    "total": "",
    "can_add": "",
    "app_list": [
        {
            "req": "",
            "cost": "",
            "data": "",
            "ep_id": "",
            "region": "",
            "user_id": "",
            "app_name": "",
            "ep_cname": "",
            "platform": "",
            "acme_info": [],
            "tenant_id": "",
            "block_mode": "",
            "can_delete": "",
            "can_update": "",
            "cdn_status": "",
            "dns_status": "",
            "blocked_req": "",
            "create_time": "",
            "domain_name": "",
            "template_id": "",
            "domain_status": {},
            "extra_domains": [],
            "template_name": "",
            "platform_region": "",
            "naked_domain_ips": []
        }
    ],
    "next_cursor": "",
    "prev_cursor": "",
    "template_perm": ""
}

Included playbooks

The Sample - Fortinet FortiWeb Cloud - 1.1.0 playbook collection comes bundled with the Fortinet FortiWeb Cloud connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Fortinet FortiWeb Cloud connector.

• Add IP Protection
• Delete IP Protection
• Get Applications List
• Get IP Protection
• Get Incident Aggregated Details
• Get Incident Dashboard Details
• Get Incident Details
• Get Incident Timeline Details
• Get Incidents List
• Get Insight Events
• Get Insight Events Summary
• Update Geo IP Block List

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.