Fortinet FortiSIEM v2.0.0

About the connector

Fortinet FortiSIEM is a highly scalable multi-tenant Security Information and Event Management (SIEM) solution that provides real-time infrastructure and user awareness for accurate threat detection, analysis and reporting.

This document provides information about the Fortinet FortiSIEM Connector, which facilitates automated interactions, with your Fortinet FortiSIEM server using FortiSOAR™ playbooks. Add the Fortinet FortiSIEM Connector, as a step in FortiSOAR™ playbooks and perform automated operations such as retrieving device information for all devices configured on the Fortinet FortiSIEM server and retrieving a list of monitored organizations from the Fortinet FortiSIEM server.

About the FortiSIEM app

If you want bidirectional integration between FortiSIEM and FortiSOAR™, then you can use the FortiSIEM app. The FortiSIEM app pushes incidents generated in FortiSIEM to an external FortiSOAR™ system as Alerts, and when these alerts are closed then the corresponding incidents are automatically cleared in FortiSIEM. To get the FortiSIEM app and the procedure on how to install and configure it, see the FortiSOAR™ - FortiSIEM application section.

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

Fortinet FortiSIEM Version Tested on: 5.0.1

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

Following enhancements have been made to the Fortinet FortiSIEM connector in version 2.0.0:

• Added the following operations and playbooks:
  • Comment Incident
  • Clear Incident With Reason
• Added Search as an input parameter to the List Incidents operation.

Installing the connector

For the procedure to install a connector, click here.

Prerequisites to configuring the connector

• You must have the URL of a Fortinet FortiSIEM server to which you will connect and perform automated operations and the credentials, such as the username and password to access that server.
• To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Fortinet FortiSIEM connector row, and in the Configure tab enter the required configuration details.

Parameter	Description
Server URL	URL of the Fortinet FortiSIEM server to which you will connect and perform the automated operations.
Username	Username used to access the Fortinet FortiSIEM server to which you will connect and perform the automated operations.
Password	Password used to access the Fortinet FortiSIEM server to which you will connect and perform the automated operations.
Domain	Domain that you will access on the Fortinet FortiSIEM server to perform the automated operations.
Verify SSL	Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function	Description	Annotation and Category
Get All Devices	Retrieves a short description for all devices that are configured on the Fortinet FortiSIEM server.	get_devices Investigation
Get All Devices For Specified IP Address Range	Retrieves a short description for devices that are configured on the Fortinet FortiSIEM server, based on the IP address range that you have specified.	get_devices Investigation
Get Device Information	Retrieves details of a specific device that is configured on the Fortinet FortiSIEM server, based on the Device IP that you have specified.	get_devices Investigation
List Monitored Devices and Attributes	Retrieves a list and attributes of all monitored devices that are configured on the Fortinet FortiSIEM server.	get_devices Investigation
List Monitored Organizations	Retrieves a list and details of all monitored organizations that are configured on the Fortinet FortiSIEM server.	get_domains Investigation
List Incidents	Retrieves a list and details of incidents from the Fortinet FortiSIEM server based on the search criteria you have specified.	get_incidents Investigation
Comment Incident	Adds a comment to a specific incident on the Fortinet FortiSIEM server based on the incident ID you have specified.	incident_comment Investigation
Clear Incident With Reason	Clears an incident with the reason you have specified on the Fortinet FortiSIEM server based on the incident ID you have specified.	clear_incident Investigation

operation: Get All Devices

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"devices": {
"device": [
{
"organization": {
"@name": "",
"@id": ""
},
"approved": "",
"discoverMethod": "",
"creationMethod": "",
"version": "",
"updateMethod": "",
"name": "",
"deviceType": {
"vendor": "",
"jobWeight": "",
"model": "",
"version": "",
"accessProtocols": ""
},
"accessIp": "",
"discoverTime": "",
"unmanaged": ""
}
]
}
}

operation: Get All Devices For Specified IP Address Range

Input parameters

Parameter	Description
Include IP SET	Value of IP addresses based on which you want for retrieve device information from the Fortinet FortiSIEM server. You must provide the value of this field as a range or in the .csv format. For example, enter, 192.168.20.1-192.168.20.100
Exclude IP SET	(Optional) Value of the range of IP addresses that you want to exclude from this search operation. You must provide the value of this field as a range or in the .csv format.

Output

The output contains the following populated JSON schema:
{
"devices": {
"device": [
{
"organization": {
"@name": "",
"@id": ""
},
"approved": "",
"discoverMethod": "",
"creationMethod": "",
"version": "",
"updateMethod": "",
"name": "",
"deviceType": {
"vendor": "",
"jobWeight": "",
"model": "",
"version": "",
"accessProtocols": ""
},
"accessIp": "",
"discoverTime": "",
"unmanaged": ""
}
]
}
}

operation: Get Device Information

Input parameters

Parameter	Description
Device IP	IP address of the device for which you want to retrieve details from the Fortinet FortiSIEM server.

Output

The output contains the following populated JSON schema:
{
"device": {
"approved": "",
"discoverMethod": "",
"raidGroups": "",
"applications": "",
"ipToHostNames": "",
"storageGroups": "",
"unmanaged": "",
"storages": "",
"softwarePatches": "",
"updateMethod": "",
"accessIp": "",
"softwareServices": "",
"processors": "",
"sanControllerPorts": "",
"interfaces": "",
"name": "",
"components": "",
"creationMethod": "",
"version": "",
"organization": {
"@name": "",
"@id": ""
},
"deviceType": {
"vendor": "",
"jobWeight": "",
"model": "",
"version": "",
"category": ""
},
"discoverTime": "",
"luns": ""
}
}

operation: List Monitored Devices and Attributes

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"monitoredDevices": {
"eventPullingDevices": "",
"perfMonDevices": {
"device": {
"organization": "",
"deviceType": "",
"accessIp": "",
"monitors": {
"monitor": [
{
"method": "",
"category": ""
}
]
},
"deviceName": ""
}
}
}
}

operation: List Monitored Organizations

Input parameters

None.

Output

No output schema is available at this time.

operation: List Incidents

Input parameters

Parameter	Description
Search	Search criteria based on which you want to retrieve incidents from the Fortinet FortiSIEM server. You can choose from the following options: Incident Status, Severity, Host, IP, or Organization. By default, this option is set as Incident Status.
Search Value	Value of the search criteria based on what you have selected in the Search parameter. For example, in the case of Incident Status, you must select the status of the incident (Active or Cleared) based on which you want to retrieve incidents from the Fortinet FortiSIEM server. OR For example, if you select Host, then you must specify the hostname based on which you want to retrieve incidents from the Fortinet FortiSIEM server.
Time Selection	(Optional) Specify the time for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server. By default, this is set as Relative Time. For example, if you select Absolute Time, then you must specify the datetime. In the case of Relative Time, you have to specify the time duration for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server. For example, if you choose Last 24 Hours, then this operation retrieves a list of incidents that have occurred in the last 24 hours, from the Fortinet FortiSIEM server. Choose from the following options: Last 2 Hours, Last 10 Hours, Last 24 Hours, Last 3 Days, Last 5 Days, Last 7 Days, Last 15 Days, Last 25 Days, Last 30 Days, Last 50 Days, Last 60 Days, Last 90 Days, Last 120 Days, or Last 180 Days. Note: By default, this is set to Last 2 Hours.

Output

The output contains the following populated JSON schema:
{
"queryResult": {
"events": {
"event": [
{
"attributes": {
"attribute": [
{
"@name": ""
}
]
},
"id": "",
"index": "",
"custId": "",
"receiveTime": "",
"dataStr": "",
"nid": "",
"eventType": ""
}
]
},
"@start": "",
"@totalCount": "",
"@queryId": "",
"@errorCode": ""
}
}

operation: Comment Incident

Input parameters

Parameter	Description
Incident ID	ID of the incident in which you want to add the comment on the Fortinet FortiSIEM server.
Comment Text	Text of the comment that you want to add to the specified incident on the Fortinet FortiSIEM server.

Output

The output contains the following populated JSON schema:
{
"message": "",
"incident_id": ""
}

operation: Clear Incident With Reason

Input parameters

Parameter	Description
Incident ID	ID of the incident that you want to clear from the Fortinet FortiSIEM server.
Reason	Text of the reason that you want to provide which clearing the specified incident from the Fortinet FortiSIEM server.

Output

The output contains the following populated JSON schema:
{
"message": "",
"incident_id": ""
}

Included playbooks

The Sample - Fortinet FortiSIEM - 2.0.0 playbook collection comes bundled with the Fortinet FortiSIEM connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Fortinet FortiSIEM connector.

• Clear Incident With Reason
• Comment Incident
• Get All Devices
• Get All Devices For Specified IP Address Range
• Get Device Information
• List Incidents
• List Monitored Devices and Attributes
• List Monitored Organizations

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 the connector upgrade and delete.

FortiSOAR™ - FortiSIEM Application

The FortiSIEM app allows the bidirectional integration with the FortiSOAR™ UI. You can use the FortiSIEM app, to push incidents generated in FortiSIEM to an external FortiSOAR™ system as Alerts, and when these alerts are closed in FortiSOAR™ then the corresponding incidents are automatically cleared in FortiSIEM.

Version Information:

Applies to: FortiSIEM version 5.1 and above.

Prerequisites:

• Ensure that the field Source Data in the Alerts module is named as sourcedata as shown in the following image:
  This field is required to be set as above so that the incident data from FortiSIEM can be added to this field in the JSON format.
• Ensure that the field Closed By in the Alerts module is named as closedby, the Field Type is set as Lookup (One to Many or One to One), and its related module is set as People, as shown in the following image:
  Ensure that the Closed By field is set as above and is populated while closing the alert since the details of the user who closes the alert can be synched back into the External User field in the FortiSIEM incident.

FortiSIEM App: Installation and Configuration

Installing the FortiSIEM App

1. Download and copy the install-fortisiem-app.sh script that has been attached to this article and save it to an appropriate location on your FortiSIEM system.
   Important: After you have downloaded the install-fortisiem-app.sh script, verify the MD5 of the install-fortisiem-app.sh script file. The MD5 of this file must be: b916ad06400497fb5fd35e088f5cc1e9
2. SSH to your FortiSIEM system as a root user.
3. Change the permission of the install-fortisiem-app.sh script to an executable:
   chmod +x install-fortisiem-app.sh
4. To install the FortiSIEM app, run the install-fortisiem-app.sh script.
   Note: After you have run the install-fortisiem-app.sh script, you will require to wait for a few minutes before you can log into FortiSIEM as some of the services are restarted. A few minutes are required to start all the services.

Configuring the FortiSIEM App

1. Login to your FortiSIEM system.
2. Click the Admin tab and then select the General Setting option from the left navigation and click the Integrations tab, which will display the Integrations Policy screen as shown in the following image:
   
3. On the Integrations Policy screen, click the Add button, which will display a form as shown in the following image:
   
4. In the Integrations Policy form fill in the following details for Outbound integration:
   1. From the Type drop-down list, select Incident.
   2. From the Direction drop-down list, select Outbound for outbound integration.
   3. In the Vendor field, type CyberSponse.
   4. In the Instance field, type the name of the instance that you are trying to connect to and identify.
   5. In the Plugin Name field, type com.accelops.phoenix.cybersponse.CybersponseIntegrationServiceImpl
   6. In the Host/URL field, type the URL/IP of your FortiSOAR™ instance
   7. In the Username field, type the username that you use to login to your FortiSOAR™ instance.
   8. In the Password field, type the password that you use to login to your FortiSOAR™ instance.
   9. In the Max Incidents field, specify the maximum number of items that can be synched to the external system at one time.
   10. From the Run for drop-down list, select the organization(s) for which you want to run this integration.
   11. To save this outbound integration policy, click Save.
5. Similarly, you require to create an Inbound integration policy, by selecting Inbound from the Direction drop-down list in the Integrations Policy form and entering all the required details. Ensure that you select the same vendor and instance as you have specified in step 4, i.e., while configuring your outbound integration.
   

Configuring the outbound/inbound integrations

After you have completed creating your outbound and inbound integration policies, you must configure the outbound/inbound integrations as follows:

Configuring Outbound integrations:

1. Login to your FortiSIEM system.
2. Click the Analytics tab and then select the Incident Notification Policy option from the left navigation.
3. On the Incident Notification Policy screen, click New, which will display a form as shown in the following image:
   
4. In the Notification Policy form select the Invoke an integration policy checkbox, and select the Outbound integration policy that you have created.
5. Select all other parameters based on your requirements and click on Save.
   This configures your outbound integration.

Configuring Inbound integrations:

1. Login to your FortiSIEM system.
2. Click the Admin tab and then select the General Setting option from the left navigation and click the Integrations > Schedule, which will display the Integrations Policy Schedules screen as shown in the following image:
   
3. Click the Add button, and you will be able to view a list of all the inbound Integrations policy that you have configured.
4. Select the appropriate inbound integration policy, and specify the schedule for selected inbound integration.
5. Click OK to schedule the inbound integration and the frequency of polling the external ticket status.

Disabling the configured outbound and inbound integration on the FortiSIEM App

1. To disable the outbound flow of incidents from FortiSIEM, do the following:
   1. Login to your FortiSIEM system.
   2. Click the Analytics tab and then select the Incident Notification Policy option from the left navigation.
   3. Select the configured policy and click Edit, which will display the policy screen.
   4. On the policy screen, clear the Enable checkbox and click Save to disable your outbound integration.
2. To disable the inbound synchronization of incidents between FortiSOAR™ and FortiSIEM, do the following:
   1. Login to your FortiSIEM system.
   2. Click the Admin tab and then select the General Setting option from the left navigation and click the Integrations > Schedule, which will display the Integrations Policy Schedules screen.
   3. Select the policy that you want to remove from the Integration Policy column and click Delete to disable your inbound scheduler.

FortiSIEM App: Known Issues

• If you clear an incident in FortiSIEM the same is not reflected in FortiSOAR™. This is because currently the FortiSIEM app only synchronizes open tickets from FortiSIEM

FortiSIEM v1.0.0 Application