Package Documentation

Storm Package: synapse-certspotter

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

Storm Commands

This package implements the following Storm Commands.

certspotter.certs

Query Cert Spotter for certificates by domain.

More detailed description talking about what kind of input the command takes
and what it does with it.

Examples:

  // Query the certificates for vertex.link, and also search for associated subdomains
  inet:fqdn=vertex.link | certspotter.certs --include-subdomains

  // Query the certificates and match wildcard certificates
  inet:fqdn=vertex.link | certspotter.certs --match-wildcards

  // Query the certificates and yield out the results
  inet:fqdn=vertex.link | certspotter.certs --yield | limit 10


Usage: certspotter.certs [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size (per-node).
  --yield                     : Yield the newly created nodes.
  --asof <asof>               : This argument is deprecated and no longer has any effect.
  --include-subdomains        : Also search for subdomains of the incoming domains.
  --match-wildcards           : Also return wildcard certificates.

certspotter.setup.apikey

Set the CertSpotter API key.


Usage: certspotter.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set the key as a user variable. If not used, the key is set globally.

Arguments:

  <apikey>                    : The CertSpotter API key string.

certspotter.subdomains

Query Cert Spotter to discover subdomains.

More detailed description talking about what kind of input the command takes
and what it does with it.

Examples:

  // Query Cert Spotter for subdomains of vertex.link
  inet:fqdn=vertex.link | certspotter.subdomains

  // Query Cert Spotter for subdomains of vertex.link
  inet:fqdn=vertex.link | certspotter.subdomains --yield --debug


Usage: certspotter.subdomains [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size.
  --yield                     : Yield the newly created nodes.
  --asof <asof>               : This argument is deprecated and no longer has any effect.

Storm Modules

This package does not export any Storm APIs.