Fortinet FortiRecon Brand Protection v2.1.0

About the connector

FortiRecon is a Digital Risk Protection Service (DRPS) product that provides an outside-the-network view to the risks posed to your enterprise.

This document provides information about the Fortinet FortiRecon Brand Protection Connector, which facilitates automated interactions, with a Fortinet FortiRecon Brand Protection server using FortiSOAR™ playbooks. Add the Fortinet FortiRecon Brand Protection Connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiRecon Brand Protection.

Version information

Connector Version: 2.1.0

FortiSOAR™ Version Tested on: 7.6.1-5275

Fortinet FortiRecon Brand Protection Version Tested on: 24.4.a

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.1.0

Following enhancements have been made to the Fortinet FortiRecon Brand Protection Connector in version 2.1.0:

• Added the following actions:
  • Get Code Repositories
  • Get Code Repo Statistics
  • Get Code Repo Matched Domains Statistics
  • Update Domain Threat Status
  • Update Code Repo Status
  • Update Open Bucket Exposure Status
  • Update Rogue App Status
  • Update Social Media Threat status
• Added the following parameters in the action Get Rogue Apps:
  • App Store Name
  • Start Date
  • End Date
• Updated the action Get Original Domains Statistics to run without input parameters.
• Updated the drop-down options for the parameter Status in the following actions:
  • Get Rogue Apps
  • Get Takedown Requests
• Renamed the parameter Keyword to Search By Keyword in the action Get Takedown Requests:
• Updated the output schema for following actions:
  • Get Rogue Apps
  • Get Rogue App By ID
  • Get Takedown Requests
• Remove the following actions as they are now deprecated:
  • Get Code Repo Exposures Statistics
  • Get Matched Domains Statistics

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-fortirecon-brand-protection

Prerequisites to configuring the connector

• You must have the credentials of Fortinet FortiRecon Brand Protection server to which you will connect and perform automated operations.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the Fortinet FortiRecon Brand Protection 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 FortiRecon Brand Protection 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

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

.

operation: Get Code Repo Exposures

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "added_ts": "",
            "attribute": "",
            "attribute_type": "",
            "id": "",
            "matched_domain": "",
            "raw_info": "",
            "risk_level": "",
            "status": "",
            "url": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Domain Threats

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "added_ts": "",
            "domain": "",
            "expiration_date": "",
            "fuzzer": "",
            "id": "",
            "is_false_positive": "",
            "is_impersonation": "",
            "is_parked": "",
            "online_status": "",
            "original_domain": "",
            "registration_date": "",
            "severity": "",
            "source": "",
            "source_name": "",
            "status": "",
            "tags": []
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Domain Threats By ID

Input parameters

Output

The output contains the following populated JSON schema:

{
    "added_ts": "",
    "domain": "",
    "expiration_date": "",
    "fuzzer": "",
    "id": "",
    "is_false_positive": "",
    "is_impersonation": "",
    "is_parked": "",
    "online_status": "",
    "original_domain": "",
    "registration_date": "",
    "severity": "",
    "source": "",
    "source_name": "",
    "status": "",
    "tags": [
        {
            "id": "",
            "name": ""
        }
    ]
}

operation: Get Executive Exposures

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "added_ts": "",
            "data": {},
            "executive_id": "",
            "id": "",
            "matched_keywords": [
                {
                    "type": "",
                    "value": ""
                }
            ],
            "source_type": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Executive Profiles

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "id": "",
            "name": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Open Bucket Exposures

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "accessibility_status": "",
            "added_ts": "",
            "bucket": "",
            "bucket_id": "",
            "bucket_type": "",
            "file_name": "",
            "file_size": "",
            "file_type": "",
            "full_path": "",
            "id": "",
            "source_id": "",
            "status": "",
            "url": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Rogue Apps

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "added_ts": "",
            "app_name": "",
            "app_size": "",
            "appstore": "",
            "description": "",
            "developer_name": "",
            "download_count": "",
            "download_url": "",
            "first_seen": "",
            "id": "",
            "keyword": "",
            "package_name": "",
            "status": "",
            "ticket_id": "",
            "updated_ts": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Rogue App By ID

Input parameters

Output

The output contains the following populated JSON schema:

{
    "app_name": "",
    "app_size": "",
    "appstore": "",
    "description": "",
    "developer_name": "",
    "developer_url": "",
    "download_count": "",
    "download_url": "",
    "first_seen": "",
    "id": "",
    "is_whitelisted": "",
    "keyword": "",
    "last_seen": "",
    "listing_url": "",
    "package_name": "",
    "review_count": "",
    "review_stars": "",
    "screenshot_url": "",
    "status": "",
    "ticket_id": "",
    "updated_ts": ""
}

operation: Get Social Media Threats

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "added_ts": "",
            "followers_count": "",
            "friends_count": "",
            "handle_name": "",
            "id": "",
            "is_verified": "",
            "location": "",
            "media_type": "",
            "posts_count": "",
            "profile_creation_ts": "",
            "profile_name": "",
            "profile_url": "",
            "source_id": "",
            "status": "",
            "ticket_id": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Domain Threats Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "count_by_action": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_domain_status": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_tags": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    }
}

operation: Get Original Domains Statistics

Input parameters

None

Output

The output contains the following populated JSON schema:

{
    "count_by_original_domain": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    }
}

operation: Get Open Bucket Exposures Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "count_by_accessibility_status": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_bucket_type": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_file_type": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_status": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    }
}

operation: Get Social Media Threats Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "count_by_is_verified": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_media_type": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_status": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    }
}

operation: Get Tags

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "id": "",
            "name": ""
        }
    ]
}

operation: Get Takedown Requests

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "added_ts": "",
            "category": "",
            "entity": "",
            "id": "",
            "resource_id": "",
            "status": "",
            "ticket_id": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

Get Code Repositories

Input parameters

Output

The output contains the following populated JSON schema:

{
    "hits": [
        {
            "id": "",
            "repo_url": "",
            "files_count": "",
            "risk_level": "",
            "attribute": "",
            "matched_domain": "",
            "attribute_type": "",
            "added_ts": "",
            "status": ""
        }
    ],
    "page": "",
    "size": "",
    "total": ""
}

operation: Get Code Repos Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "count_by_action": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_attribute_type": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            },
            {
                "count": "",
                "id": ""
            },
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    },
    "count_by_risk_level": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            },
            {
                "count": "",
                "id": ""
            },
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    }
}

operation: Get Code Repo Matched Domains Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "count_by_matched_domain": {
        "aggregations": [
            {
                "count": "",
                "id": ""
            }
        ],
        "total": ""
    }
}

operation: Update Code Repo Status

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": ""
}

operation: Update Domain Threat Status

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": ""
}

operation: Update Open Bucket Exposure Status

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": ""
}

operation: Update Rogue App Status

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": ""
}

operation: Update Social Media Threat Status

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": ""
}

Included playbooks

The Sample - Fortinet FortiRecon Brand Protection - 2.1.0 playbook collection comes bundled with the Fortinet FortiRecon Brand Protection 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 FortiRecon Brand Protection connector.

• Get Code Repo Exposures
• Get Domain Threats
• Get Domain Threats By ID
• Get Domain Threats Statistics
• Get Executive Exposures
• Get Executive Profiles
• Get Open Bucket Exposures
• Get Open Bucket Exposures Statistics
• Get Original Domains Statistics
• Get Rogue App By ID
• Get Rogue Apps
• Get Social Media Threats
• Get Social Media Threats Statistics
• Get Tags
• Get Takedown Requests
• Get Code Repositories
• Get Code Repo Statistics
• Get Code Repo Matched Domains Statistics
• Update Domain Threat Status
• Update Code Repo Status
• Update Open Bucket Exposure Status
• Update Rogue App Status
• Update Social Media Threat status

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.