Package Documentation

Storm Package: synapse-whoxy

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

Storm Commands

This package implements the following Storm Commands.

whoxy.quota

Report the quota balances for the Whoxy API key.

Usage: whoxy.quota [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.

whoxy.setup.apikey

Set the Whoxy API key.

Usage: whoxy.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 Whoxy API key string.

whoxy.whois.history

Ingest Whoxy historical WHOIS records for an FQDN.

This command yields inet:whois:rec nodes,
and will also create inet:whois:contact and inet:whois:recns nodes.

Examples:

# Ingest historical records by inet:fqdn
inet:fqdn#foo | whoxy.whois.history


Usage: whoxy.whois.history [options]

Options:

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

whoxy.whois.lookup

Retrieve a live WHOIS record for an FQDN.

This command yields an inet:whois:rec node,
and will also create inet:whois:contact and inet:whois:recns nodes.

Examples:

# Ingest the record by inet:fqdn
inet:fqdn#foo | whoxy.whois.lookup


Usage: whoxy.whois.lookup [options]

Options:

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

whoxy.whois.reverse

Search Whoxy for WHOIS records by an identifier.

This command yields inet:whois:rec nodes,
and will also create inet:whois:contact and inet:whois:recns nodes.

The query argument can be used to search by a keyword
present at the start of the domain name.

NOTE - This command will also create an it:exec:query node to represent the
       query syntax and link resulting nodes to it via -(found)> edges.
       When an inbound node is provided it will also have a <(refs)- edge
       to the it:exec:query node.

Examples:

  # Search by domain owner name
  ps:contact#foo :name -> ps:name | whoxy.whois.reverse

  # Search by company / organization name
  ou:org#foo :name -> ou:name | whoxy.whois.reverse

  # Search by email address
  inet:email#foo | whoxy.whois.reverse

  # Search by domain name keyword
  whoxy.whois.reverse --query yahoo

  # Use node property to search by keyword
  inet:fqdn#foo | whoxy.whois.reverse --query :host


Usage: whoxy.whois.reverse [options]

Options:

  --help                      : Display the command usage.
  --query <query>             : Use the query string for a keyword search. (default: None)
  --debug                     : Show verbose debug output.
  --yield                     : Yield the newly created nodes.
  --size <size>               : Limit the number of results ingested to the given size (per-node).
  --asof <asof>               : This argument is deprecated and no longer has any effect.

Storm Modules

This package does not export any Storm APIs.