Fortinet FortiGuard Outbreak provides key information about on-going cybersecurity attacks with significant ramifications affecting numerous companies, organizations, and industries. This connector facilitates automated operations to fetch Indicators of Compromise (IOCs) of outbreak alert.
This document provides information about the Fortinet FortiGuard Outbreak Connector, which facilitates automated interactions, with a Fortinet FortiGuard Outbreak server using FortiSOAR™ playbooks. Add the Fortinet FortiGuard Outbreak Connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiGuard Outbreak.
Connector Version: 2.0.0
FortiSOAR™ Version Tested on: 7.6.1 5272
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Fortinet FortiGuard Outbreak connector in version 2.0.0:
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-fortiguard-outbreak
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Fortinet FortiGuard Outbreak connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter | Description |
|---|---|
| Server Name | URL of the FortiGuard Threat Intelligence API server to which you will connect and perform automated operations. |
| Verify SSL | Specifies whether the SSL certificate for the server is to be verified. By default, this option is set to True. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
| Function | Description | Annotation and Category |
|---|---|---|
| List Outbreak Alert Tags | Retrieves a list of outbreak alert tags from FortiGuard | list_outbreak_alert_tags Investigation |
| Get Outbreak Alert IOCs | Retrieves a list of outbreak alert IOCs from FortiGuard based on the tag name that you have specified. | get_outbreak_alert_iocs Investigation |
| Bulk Ingest Outbreak Alert IOCs | Bulk Ingest Outbreak alert IOCs from FortiGuard based on the tag name that you have specified | bulk_ingest_outbreak_alert_iocs Investigation |
| Get Outbreak Alert Details by Slug Name | Retrieve latest Outbreak Alert details on the basis of Slug name that you have specified | get_outbreak_alert_details_by_slug_name Investigation |
None.
The output contains the following populated JSON schema:
[
{
"tag": ""
}
]
| Parameter | Description |
|---|---|
| Outbreak Alert Tag Name | Specify the tag name of the outbreak alert to retrieve its associated IOCs from the FortiGuard server. |
The output contains the following populated JSON schema:
[
{
"ioc": "",
"type": "",
"active": ""
}
]
| Parameter | Description |
|---|---|
| Outbreak Alert Tag Name | Specify the tag name of the Outbreak Alert to retrieve its associated IOCs from the FortiGuard server. |
| Record Creation Playbook IRI | Specify the IRI of the playbook that creates feed records in FortiSOAR™. |
| Playbook Environment Parameters | (Optional) Specify the parameters that to send to the Playbooks environment. |
| Deduplicate Field | (Optional) Specify the field on which to provide a uniqueness constraint. |
| Demo Mode | (Optional) Select to run this action in demo mode. |
The output contains the following populated JSON schema:
{
"message": ""
}
| Parameter | Description |
|---|---|
| Outbreak Alert Slug Name | Specify the slug tag name of the Outbreak Alert to retrieve its latest details from the FortiGuard server. |
The output contains the following populated JSON schema:
[
{
"tag": "",
"link": "",
"title": "",
"latest": "",
"mantis": "",
"status": "",
"approver": "",
"cve_list": [],
"products": {
"fnse": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fxdr": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
}
}
]
},
"product_name": ""
}
],
"fsecat": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"incresp": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fortiadc": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"forticwp": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortiedr": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortindr": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortiweb": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"forticasb": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortigate": [
{
"detection": {
"virusid": [
""
]
},
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortimail": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortisase": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortisiem": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"freconaci": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
}
}
]
},
"product_name": ""
}
],
"respready": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
}
}
]
},
"product_name": ""
}
],
"secrating": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fortiproxy": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"freconeasm": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"forticlient": [
{
"detection": {
"virus": []
},
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortisocaas": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fortisandbox": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortianalyzer": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
]
},
"severity": "",
"announced": "",
"published": "",
"sub_title": "",
"background": "",
"doc_status": "",
"description": "",
"last_revised": "",
"outbreak_url": "",
"release_date": "",
"threat_signal": "",
"event_handler_desc": "",
"additional_resources": [
{
"Link": "",
"Source": ""
}
]
}
]
The Sample - Fortinet FortiGuard Outbreak - 2.0.0 playbook collection comes bundled with the Fortinet FortiGuard Outbreak 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 FortiGuard Outbreak connector.
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.
Fortinet FortiGuard Outbreak provides key information about on-going cybersecurity attacks with significant ramifications affecting numerous companies, organizations, and industries. This connector facilitates automated operations to fetch Indicators of Compromise (IOCs) of outbreak alert.
This document provides information about the Fortinet FortiGuard Outbreak Connector, which facilitates automated interactions, with a Fortinet FortiGuard Outbreak server using FortiSOAR™ playbooks. Add the Fortinet FortiGuard Outbreak Connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiGuard Outbreak.
Connector Version: 2.0.0
FortiSOAR™ Version Tested on: 7.6.1 5272
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Fortinet FortiGuard Outbreak connector in version 2.0.0:
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-fortiguard-outbreak
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Fortinet FortiGuard Outbreak connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter | Description |
|---|---|
| Server Name | URL of the FortiGuard Threat Intelligence API server to which you will connect and perform automated operations. |
| Verify SSL | Specifies whether the SSL certificate for the server is to be verified. By default, this option is set to True. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
| Function | Description | Annotation and Category |
|---|---|---|
| List Outbreak Alert Tags | Retrieves a list of outbreak alert tags from FortiGuard | list_outbreak_alert_tags Investigation |
| Get Outbreak Alert IOCs | Retrieves a list of outbreak alert IOCs from FortiGuard based on the tag name that you have specified. | get_outbreak_alert_iocs Investigation |
| Bulk Ingest Outbreak Alert IOCs | Bulk Ingest Outbreak alert IOCs from FortiGuard based on the tag name that you have specified | bulk_ingest_outbreak_alert_iocs Investigation |
| Get Outbreak Alert Details by Slug Name | Retrieve latest Outbreak Alert details on the basis of Slug name that you have specified | get_outbreak_alert_details_by_slug_name Investigation |
None.
The output contains the following populated JSON schema:
[
{
"tag": ""
}
]
| Parameter | Description |
|---|---|
| Outbreak Alert Tag Name | Specify the tag name of the outbreak alert to retrieve its associated IOCs from the FortiGuard server. |
The output contains the following populated JSON schema:
[
{
"ioc": "",
"type": "",
"active": ""
}
]
| Parameter | Description |
|---|---|
| Outbreak Alert Tag Name | Specify the tag name of the Outbreak Alert to retrieve its associated IOCs from the FortiGuard server. |
| Record Creation Playbook IRI | Specify the IRI of the playbook that creates feed records in FortiSOAR™. |
| Playbook Environment Parameters | (Optional) Specify the parameters that to send to the Playbooks environment. |
| Deduplicate Field | (Optional) Specify the field on which to provide a uniqueness constraint. |
| Demo Mode | (Optional) Select to run this action in demo mode. |
The output contains the following populated JSON schema:
{
"message": ""
}
| Parameter | Description |
|---|---|
| Outbreak Alert Slug Name | Specify the slug tag name of the Outbreak Alert to retrieve its latest details from the FortiGuard server. |
The output contains the following populated JSON schema:
[
{
"tag": "",
"link": "",
"title": "",
"latest": "",
"mantis": "",
"status": "",
"approver": "",
"cve_list": [],
"products": {
"fnse": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fxdr": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
}
}
]
},
"product_name": ""
}
],
"fsecat": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"incresp": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fortiadc": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"forticwp": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortiedr": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortindr": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortiweb": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"forticasb": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortigate": [
{
"detection": {
"virusid": [
""
]
},
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortimail": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortisase": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortisiem": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"freconaci": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
}
}
]
},
"product_name": ""
}
],
"respready": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
}
}
]
},
"product_name": ""
}
],
"secrating": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fortiproxy": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"freconeasm": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"forticlient": [
{
"detection": {
"virus": []
},
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortisocaas": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
],
"fortisandbox": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"description": "",
"service_name": "",
"minimum_version": ""
}
]
},
"product_name": ""
}
],
"fortianalyzer": [
{
"remediation": {
"type": "",
"packages": [
{
"link": "",
"service": "",
"kill_chain": {
"step": ""
},
"service_name": ""
}
]
},
"product_name": ""
}
]
},
"severity": "",
"announced": "",
"published": "",
"sub_title": "",
"background": "",
"doc_status": "",
"description": "",
"last_revised": "",
"outbreak_url": "",
"release_date": "",
"threat_signal": "",
"event_handler_desc": "",
"additional_resources": [
{
"Link": "",
"Source": ""
}
]
}
]
The Sample - Fortinet FortiGuard Outbreak - 2.0.0 playbook collection comes bundled with the Fortinet FortiGuard Outbreak 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 FortiGuard Outbreak connector.
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.