Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Censys is a new search engine for devices exposed on the Internet. Experts can use it to assess the security they implement.

This document provides information about the Censys connector, which facilitates automated interactions with Censys using FortiSOAR™ playbooks. Add the Censys connector as a step in FortiSOAR™ playbooks and perform automated operations, such as looking an IP address, domain, or certificate on Censys.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

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

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the URL of Censys server to which you will connect and perform 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, select the Censys connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the Censys API server to which you will connect and perform the automated operation.
Customer Key Secret key to access the Censys API.
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 and onward:

Function Description Annotation and Category
Lookup Certificate Lookup a certificate on Censys. lookup_cert
Investigation
Lookup Domain Lookup a domain on Censys. lookup_domain
Investigation
Lookup IP Address Lookup an IP Address on Censys. lookup_ip
Investigation

operation: Lookup Certificate

Input parameters

Parameter Description
Certificate SHA256 certificate that you want to search and retrieve information from Censys.

Output

The output contains the following populated JSON schema:
{
     "status_code": "integer",
     "response": {}
}

operation: Lookup Domain

Input parameters

Parameter Description
Domain Domain which you want to search and retrieve information from Censys.

Output

The output contains the following populated JSON schema:
{
     "status_code": "integer",
     "response": {}
}

operation: Lookup IP Address

Input parameters

Parameter Description
IP Address IP Address which you want to search and retrieve information from Censys.

Output

The output contains the following populated JSON schema:
{
     "status_code": "integer",
     "response": {}
}

Included playbooks

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

  • Lookup Certificate
  • Lookup Domain
  • Lookup IP Address

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

Censys is a new search engine for devices exposed on the Internet. Experts can use it to assess the security they implement.

This document provides information about the Censys connector, which facilitates automated interactions with Censys using FortiSOAR™ playbooks. Add the Censys connector as a step in FortiSOAR™ playbooks and perform automated operations, such as looking an IP address, domain, or certificate on Censys.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

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

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, select the Censys connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the Censys API server to which you will connect and perform the automated operation.
Customer Key Secret key to access the Censys API.
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 and onward:

Function Description Annotation and Category
Lookup Certificate Lookup a certificate on Censys. lookup_cert
Investigation
Lookup Domain Lookup a domain on Censys. lookup_domain
Investigation
Lookup IP Address Lookup an IP Address on Censys. lookup_ip
Investigation

operation: Lookup Certificate

Input parameters

Parameter Description
Certificate SHA256 certificate that you want to search and retrieve information from Censys.

Output

The output contains the following populated JSON schema:
{
     "status_code": "integer",
     "response": {}
}

operation: Lookup Domain

Input parameters

Parameter Description
Domain Domain which you want to search and retrieve information from Censys.

Output

The output contains the following populated JSON schema:
{
     "status_code": "integer",
     "response": {}
}

operation: Lookup IP Address

Input parameters

Parameter Description
IP Address IP Address which you want to search and retrieve information from Censys.

Output

The output contains the following populated JSON schema:
{
     "status_code": "integer",
     "response": {}
}

Included playbooks

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