Package Documentation

Storm Package: synapse-haveibeenpwned

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

Storm Commands

This package implements the following Storm Commands.

haveibeenpwned.breaches

Get the list of HaveIBeenPwned breaches.

NOTE: This command DOES NOT require an API key.

This command will synchronize the list of known breaches from
HaveIBeenPwned and yield ``risk:compromise`` nodes for each breach.

Examples:

  // Sync the list of known breaches, yielding the newly created nodes
  haveibeenpwned.breaches


Usage: haveibeenpwned.breaches [options]

Options:

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

haveibeenpwned.breaches.byemail

Query the HaveIBeenPwned API for breaches with the specified ``inet:email``.

Examples:

  // Get breaches associated with a particular email address
  inet:[email protected] | haveibeenpwned.breaches.byemail

  // Get breaches associated with all email addresses
  inet:email | haveibeenpwned.breaches.byemail


Usage: haveibeenpwned.breaches.byemail [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the linked risk:compromise nodes.

haveibeenpwned.setup.apikey

Manage the haveibeenpwned API key.

Examples

    // Set a global haveibeenpwned API key
    haveibeenpwned.setup.apikey abcd1234

    // Set a haveibeenpwned API key for the current user
    haveibeenpwned.setup.apikey --self abcd1234

    // Display the API key scope of the current key
    haveibeenpwned.setup.apikey --show-scope

    // Display the current API key.
    haveibeenpwned.setup.apikey --show-apikey

    // Remove the current global API key.
    haveibeenpwned.setup.apikey --remove

    // Remove the per-user API key for the current user.
    haveibeenpwned.setup.apikey --self --remove


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

Options:

  --help                      : Display the command usage.
  --self                      : Set or remove the key as a user variable. If not used, the key is set globally.
  --show-scope                : Display the API key scope in use (global vs self).
  --show-apikey               : Display the API key value (requires admin perms or a "self" scope key).
  --remove                    : Remove the configured API key. May be used with --self.

Arguments:

  [apikey]                    : The API key string.

Storm Modules

This package does not export any Storm APIs.