Storm Package: synapse-rapid7-sonar-ssl

The following Commands are available from this package. This documentation is generated for version 3.15.0 of the package.

Storm Commands

This package implements the following Storm Commands.

rapid7.sonar.ssl.download

Download SonarSSL data files from Rapid7.

Usage: rapid7.sonar.ssl.download [options] <pattern>

Options:

  --help                      : Display the command usage.
  --yield                     : Yield the newly created nodes.
  --debug                     : Enable debug output.
  --size <size>               : Limit the total output. This may be per node. (default: None)
  --timeout <timeout>         : Specify a timeout in seconds to apply to each file download. (default: 0)

Arguments:

  <pattern>                   : Download files matching a specified pattern.

rapid7.sonar.ssl.enrich

Enrich nodes with Rapid7 SonarSSL data.

This command searches Rapid7 Sonar SSL data for records matching a specified name, IPv4,
or SHA1 hash.

The results of the query are used to create inet:ssl:cert nodes, with their .seen
property set to the timestamp of the matching record.

Examples:

    # Use inbound node to search
    inet:ipv4=1.2.3.4 | rapid7.sonar.ssl.enrich


Usage: rapid7.sonar.ssl.enrich [options]

Options:

  --help                      : Display the command usage.
  --yield                     : Yield the newly created nodes.
  --debug                     : Enable debug output.
  --size <size>               : Limit the total output per node. (default: None)

rapid7.sonar.ssl.files

List SonarSSL data files available for download from Rapid7.

Usage: rapid7.sonar.ssl.files [options]

Options:

  --help                      : Display the command usage.

rapid7.sonar.ssl.setup.apikey

Set your Rapid7 SonarSSL API key.

Usage: rapid7.sonar.ssl.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --show-apikey               : Display the API key value.
  --remove                    : Remove the configured API key.

Arguments:

  [apikey]                    : The Rapid7 SonarSSL API key string.

rapid7.sonar.ssl.stats

Display Rapid7 SonarSSL stats.

If no input is provided, this command will display the total count for each type of Rapid7
SonarSSL record currently indexed.

If a name, IPv4, or SHA1 hash is provided either by a relevant inbound node or command
argument parameter, this command retrieves the current count of matching Rapid7 SonarSSL
records.

Examples:

    # Display current index totals
    rapid7.sonar.ssl.stats

    # Use inbound node to query
    inet:ipv4=1.2.3.4 | rapid7.sonar.ssl.stats

    # Use command argument to query
    rapid7.sonar.ssl.stats --ipv4 1.2.3.4


Usage: rapid7.sonar.ssl.stats [options]

Options:

  --help                      : Display the command usage.
  --ipv4 <ipv4>               : Query records based on a specified IPv4 string
  --name <name>               : Query records based on a specified name
  --sha1 <sha1>               : Query records based on a specified SHA1 hash

Storm Modules

This package does not export any Storm APIs.