Fortinet FortiNDR v1.3.0

About the connector

The FortiNDR is a leading-edge product which utilizes machine learning technology for malware detection, intrusion detection and network anomalies.. This connector provides action to submits file samples for analysis and potentially fetches scan verdicts

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

Version information

Connector Version: 1.3.0

FortiSOAR™ Version Tested on: 7.5.0-4015

Fortinet FortiNDR Version Tested on: 7.4.1

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.3.0

Following enhancements have been made to the Fortinet FortiNDR Connector in version 1.3.0:

• Added a new action Get Events
• Following changes have been to the parameter Get Result By in the action Get File Verdict Result:
  • Removed the option SHA512
  • Added options SHA1 and SHA256
• Updated the output schema for the action Get File Verdict Result

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-fortiai

Prerequisites to configuring the connector

• You must have the URL of the Fortinet FortiNDR server to which you will connect and perform automated operations and the API key configured for your account for using that server.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the Fortinet FortiNDR server.

Minimum Permissions Required

• To perform actions and the automated operations using the Fortinet FortiNDR connector, users' admin profile should be assigned read-write access to FortiNDR.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Fortinet FortiNDR 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: Submit File

Input parameters

Output

The output contains the following populated JSON schema:

{
    "result": {
        "submit_id": ""
    },
    "status": ""
}

operation: Get File Verdict Result

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when you choose "Get Result By" as "SID(Submission ID)":

{
    "results": {
        "fileids": [],
        "total_fileids": ""
    }
}

This is the default output schema:

{
    "results": {
        "file_id": "",
        "virus_name": "",
        "md5": "",
        "sha1": "",
        "sha256": "",
        "file_size": "",
        "source": "",
        "severity": "",
        "category": "",
        "create_date": "",
        "confidence": "",
        "file_type": "",
        "victim_ip": "",
        "attacker_ip": "",
        "victim_port": "",
        "attacker_port": "",
        "engine_version": "",
        "kdb_version": "",
        "tmfc": "",
        "pbit": "",
        "detected_by_ai_only": "",
        "family": "",
        "file_name": "",
        "parent_fname": "",
        "tfc": ""
    }
}

operation: Get Events

Input parameters

Output

The output contains the following populated JSON schema:

{
    "results": [
        {
            "event_time": "",
            "source_ip": "",
            "source_port": "",
            "destination_ip": "",
            "destination_port": "",
            "severity": "",
            "attack_name": ""
        }
    ]
}

Included playbooks

The Sample - Fortinet FortiNDR - 1.3.0 playbook collection comes bundled with the Fortinet FortiNDR 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 FortiNDR connector.

• Get Events
• Get File Verdict Result
• Submit File

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.