Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

PassiveTotal simplifies the event investigation process and provides analysts access to a consolidated platform of data necessary to accurately understand, triage, and address security events.

This document provides information about the PassiveTotal connector, which facilitates automated interactions, with a PassiveTotal server using FortiSOAR™ playbooks. Add the PassiveTotal connector as a step in FortiSOAR™ playbooks and perform automated operations such as retrieving reputation and WhoIs information and for IP address and domain names you have specified.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

PassiveTotal Version Tested on: 2.3.0

Authored By: Fortinet

Certified: Yes

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-passivetotal

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

Prerequisites to configuring the connector

  • You must have the URL of the PassiveTotal server to which you will connect and perform the automated operations and credentials 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 PassiveTotal connector row, and in the Configuration tab enter the required configuration details.

 

Parameter Description
Server URL URL of the PassiveTotal server to which you will connect and perform the automated operations.
Username Username to access the PassiveTotal server to which you will connect and perform the automated operations.
API Key API Key of the PassiveTotal server to which you will connect and 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 IP Reputation Retrieves the reputation of the IP address that you have specified from the PassiveTotal server. get_ip_reputation
Investigation
Get Domain Reputation Retrieves the reputation of the domain name that you have specified from the PassiveTotal server. get_domain_reputation
Investigation
WHOIS IP Retrieves WhoIs information for the IP address that you have specified from the PassiveTotal server. get_ip_whois
Investigation
WHOIS Domain Retrieves WhoIs information for the domain name that you have specified from the PassiveTotal server. get_domain_whois
Investigation
Get Domain Classification Retrieves classification status for the domain name that you have specified from the PassiveTotal server. get_domain_info
Investigation
Get Account Information Retrieves account information from the PassiveTotal server. get_user_info
Investigation
Get Sub Domains Retrieves all subdomains based on the query that you have specified from the PassiveTotal server.
Note: You can specify an IP address or a Domain name in the query.
get_domain_info
Investigation
Get Malware Data Retrieves malware data based on the query that you have specified from the PassiveTotal server.
Note: You can specify an IP address or a Domain name in the query.
get_malware_data
Investigation
Search WHOIS Searches for WhoIS records by field and by using a query on the PassiveTotal server.
For example, if you choose the Email field and provide a valid email id as the query value, then this operation will return all WhoIs records that match the specified query and field.
whois_info
Investigation

 

operation: Get IP Reputation

Input parameters

 

Parameter Description
IP Address IP address whose reputation information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains reputation information for the IP address that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get IP Reputation operation

operation: Get Domain Reputation

Input parameters

 

Parameter Description
Domain Domain name whose reputation information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains reputation information for the domain name that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Domain  Reputation operation

operation: WHOIS IP

Input parameters

 

Parameter Description
IP Address IP address whose WhoIs information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains WhoIs information for the IP address that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the WHOIS IP operation

operation: WHOIS Domain

Input parameters

 

Parameter Description
Domain Domain name whose WhoIs information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains WhoIs information for the domain name that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the WHOIS Domain operation

operation: Get Account Information

Input parameters

None.

Output

The JSON output contains the information of all the user accounts currently present on the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Account Information operation

operation: Get Sub Domains

Input parameters

 

Parameter Description
Query Query containing the IP address or Domain name whose associated subdomains you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains all the subdomains that are match the query (IP address or domain name) that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Sub Domains operation

operation: Get Malware Data

Input parameters

 

Parameter Description
Query Query containing the IP address or Domain name whose associated malware data you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains all the malware data that are match the query (IP address or domain name) that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Malware Data operation

operation: Search WHOIS

Input parameters

 

Parameter Description
Field Field that you want to search for in WhoIs records in the PassiveTotal server.
You can choose from the following fields: Email, Domain, Name, Organization, Address, Phone, or Nameserver.
Query Specify the value of the field that you have specified as the query value.
For example, if you have selected Email as the field, then specify a valid email ID as the query value. This operation will then search from that email ID across WhoIs records in the PassiveTotal server and will return all WhoIs records that match the specified query and field.

 

Output

The JSON output contains the all WhoIs records that match the specified query and field, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Search WHOIS operation

Included playbooks

The Sample - PassiveTotal - 1.0.0 playbook collection comes bundled with the PassiveTotal 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 PassiveTotal connector.

  • Get Account Information
  • Get Domain Classification
  • Get Domain Reputation
  • Get IP Reputation
  • Get Malware Data
  • Get Sub Domains
  • Search WHOIS
  • WHOIS Domain
  • WHOIS IP

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.

About the connector

PassiveTotal simplifies the event investigation process and provides analysts access to a consolidated platform of data necessary to accurately understand, triage, and address security events.

This document provides information about the PassiveTotal connector, which facilitates automated interactions, with a PassiveTotal server using FortiSOAR™ playbooks. Add the PassiveTotal connector as a step in FortiSOAR™ playbooks and perform automated operations such as retrieving reputation and WhoIs information and for IP address and domain names you have specified.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

PassiveTotal Version Tested on: 2.3.0

Authored By: Fortinet

Certified: Yes

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-passivetotal

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

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™ , on the Connectors page, click the PassiveTotal connector row, and in the Configuration tab enter the required configuration details.

 

Parameter Description
Server URL URL of the PassiveTotal server to which you will connect and perform the automated operations.
Username Username to access the PassiveTotal server to which you will connect and perform the automated operations.
API Key API Key of the PassiveTotal server to which you will connect and 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 IP Reputation Retrieves the reputation of the IP address that you have specified from the PassiveTotal server. get_ip_reputation
Investigation
Get Domain Reputation Retrieves the reputation of the domain name that you have specified from the PassiveTotal server. get_domain_reputation
Investigation
WHOIS IP Retrieves WhoIs information for the IP address that you have specified from the PassiveTotal server. get_ip_whois
Investigation
WHOIS Domain Retrieves WhoIs information for the domain name that you have specified from the PassiveTotal server. get_domain_whois
Investigation
Get Domain Classification Retrieves classification status for the domain name that you have specified from the PassiveTotal server. get_domain_info
Investigation
Get Account Information Retrieves account information from the PassiveTotal server. get_user_info
Investigation
Get Sub Domains Retrieves all subdomains based on the query that you have specified from the PassiveTotal server.
Note: You can specify an IP address or a Domain name in the query.
get_domain_info
Investigation
Get Malware Data Retrieves malware data based on the query that you have specified from the PassiveTotal server.
Note: You can specify an IP address or a Domain name in the query.
get_malware_data
Investigation
Search WHOIS Searches for WhoIS records by field and by using a query on the PassiveTotal server.
For example, if you choose the Email field and provide a valid email id as the query value, then this operation will return all WhoIs records that match the specified query and field.
whois_info
Investigation

 

operation: Get IP Reputation

Input parameters

 

Parameter Description
IP Address IP address whose reputation information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains reputation information for the IP address that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get IP Reputation operation

operation: Get Domain Reputation

Input parameters

 

Parameter Description
Domain Domain name whose reputation information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains reputation information for the domain name that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Domain  Reputation operation

operation: WHOIS IP

Input parameters

 

Parameter Description
IP Address IP address whose WhoIs information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains WhoIs information for the IP address that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the WHOIS IP operation

operation: WHOIS Domain

Input parameters

 

Parameter Description
Domain Domain name whose WhoIs information you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains WhoIs information for the domain name that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the WHOIS Domain operation

operation: Get Account Information

Input parameters

None.

Output

The JSON output contains the information of all the user accounts currently present on the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Account Information operation

operation: Get Sub Domains

Input parameters

 

Parameter Description
Query Query containing the IP address or Domain name whose associated subdomains you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains all the subdomains that are match the query (IP address or domain name) that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Sub Domains operation

operation: Get Malware Data

Input parameters

 

Parameter Description
Query Query containing the IP address or Domain name whose associated malware data you want to retrieve from the PassiveTotal server.

 

Output

The JSON output contains all the malware data that are match the query (IP address or domain name) that you have specified, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Get Malware Data operation

operation: Search WHOIS

Input parameters

 

Parameter Description
Field Field that you want to search for in WhoIs records in the PassiveTotal server.
You can choose from the following fields: Email, Domain, Name, Organization, Address, Phone, or Nameserver.
Query Specify the value of the field that you have specified as the query value.
For example, if you have selected Email as the field, then specify a valid email ID as the query value. This operation will then search from that email ID across WhoIs records in the PassiveTotal server and will return all WhoIs records that match the specified query and field.

 

Output

The JSON output contains the all WhoIs records that match the specified query and field, retrieved from the PassiveTotal server.

Following image displays a sample output:

Sample output of the Search WHOIS operation

Included playbooks

The Sample - PassiveTotal - 1.0.0 playbook collection comes bundled with the PassiveTotal 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 PassiveTotal 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.