Reference¶

Code¶

GreyNoise API client and tools.

greynoise.api¶

GreyNoise API client.

class greynoise.api.GreyNoise(api_key=None, timeout=7)[source]¶

GreyNoise API client.

Parameters

api_key (str) – Key use to access the API.
timeout (int) – API requests timeout in seconds.

_request(endpoint, params=None, json=None)[source]¶

Handle the requesting of information from the API.

Parameters

endpoint (str) – Endpoint to send the request to.
params – Request parameters.
json (dict) – Request’s JSON payload.

Returns

Response’s JSON payload

Return type

dict

Raises

RequestFailure – when HTTP status code is not 2xx

get_actors()[source]¶

Get the names and IP addresses of actors scanning the Internet.

Returns: Most labeled actors scanning the intenet.
Return type: list

get_context(ip_address)[source]¶

Get context associated with an IP address.

Parameters: ip_address – IP address to use in the look-up.
Returns: Context for the IP address.
Return type: dict

get_noise_status(ip_address)[source]¶

Get activity associated with an IP address.

Parameters: ip_address – IP address to use in the look-up.
Returns: Activity metadata for the IP address.
Return type: dict

get_noise_status_bulk(ip_addresses)[source]¶

Get activity associated with multiple IP addresses.

Parameters: ip_addresses (list) – IP addresses to use in the look-up.
Returns: Bulk status information for IP addresses.
Return type: dict

run_query(query)[source]¶: Run GNQL query.

run_stats_query(query)[source]¶: Run GNQL stats query.

greynoise.cli¶

GreyNoise command line Interface.

greynoise.cli.formatter¶

Output formatters.

greynoise.cli.formatter.actors_formatter(actors, verbose)[source]¶: Convert actors result into human-readable text.

greynoise.cli.formatter.colored_output(function)[source]¶

Decorator that converts ansi markup into ansi escape sequences.

Parameters: function (callable) – Function that will return text using ansi markup.
Returns: Wrapped function that converts markup into escape sequences.
Return type: callable

greynoise.cli.formatter.get_location(metadata)[source]¶: Get location from ip context metadata.

greynoise.cli.formatter.gnql_query_formatter(results, verbose)[source]¶: Convert GNQL query result into human-readable text.

greynoise.cli.formatter.gnql_stats_formatter(results, verbose)[source]¶: Convert GNQL stats result into human-readable text.

greynoise.cli.formatter.ip_context_formatter(results, verbose)[source]¶: Convert IP context result into human-readable text.

greynoise.cli.formatter.ip_quick_check_formatter(results, verbose)[source]¶: Convert IP quick check result into human-readable text.

greynoise.cli.formatter.json_formatter(result, _verbose)[source]¶: Format result as json.

greynoise.cli.parameter¶

Command line parameter types.

greynoise.cli.parameter.ip_address_parameter(_context, _parameter, value)[source]¶

IPv4 address passed from the command line.

Parameters: value (str) – IPv4 address value
Raises: click.BadParameter – when IP address value is invalid

greynoise.cli.parameter.ip_addresses_parameter(_context, _parameter, values)[source]¶

IPv4 addresses passed from the command line.

Parameters: values – IPv4 address values
Raises: click.BadParameter – when any IP address value is invalid

greynoise.cli.subcommand¶

CLI subcommands.

greynoise.cli.subcommand.echo_result(function)[source]¶

Decorator that prints subcommand results correctly formatted.

Parameters: function (callable) – Subcommand that returns a result from the API.
Returns: Wrapped function that prints subcommand results
Return type: callable

greynoise.cli.subcommand.handle_exceptions(function)[source]¶

Print error and exit on API client exception.

Parameters: function (callable) – Subcommand that returns a result from the API.
Returns: Wrapped function that prints subcommand results
Return type: callable

greynoise.util¶

Utility functions.

greynoise.util.load_config()[source]¶

Load configuration.

Returns: Current configuration based on configuration file and environment variables.
Return type: dict

greynoise.util.save_config(config)[source]¶

Save configuration.

Parameters: config (dict) – Data to be written to the configuration file.

greynoise.util.validate_ip(ip_address, strict=True)[source]¶

Check if the IPv4 address is valid.

Parameters

ip_address (str) – IPv4 address value to validate.
strict (bool) – Whether to raise exception if validation fails.

Raises

ValueError – When validation fails and strict is set to True.

CLI¶

greynoise¶

Entry point for the greynoise CLI.

param argv: Command line arguments
type: list

greynoise [OPTIONS] COMMAND [ARGS]...

Options

-k, --api-key <api_key>¶: Key to include in API requests

-f, --format <output_format>¶

Output format

Options: json|txt|xml

-i, --input <input_file>¶: Input file

-v, --verbose¶: Verbose output

actors¶

Run actors query.

greynoise actors [OPTIONS]

gnql¶

GNQL queries.

greynoise gnql [OPTIONS] COMMAND [ARGS]...

query¶

Run GNQL query.

greynoise gnql query [OPTIONS] [QUERY]

Arguments

QUERY¶: Optional argument

stats¶

Run GNQL stats query.

greynoise gnql stats [OPTIONS] [QUERY]

Arguments

QUERY¶: Optional argument

ip¶

IP lookup.

greynoise ip [OPTIONS] COMMAND [ARGS]...

context¶

Run IP context query.

greynoise ip context [OPTIONS] [IP_ADDRESS]

Arguments

IP_ADDRESS¶: Optional argument

quick-check¶

Run IP quick check query.

greynoise ip quick-check [OPTIONS] [IP_ADDRESS]...

Arguments

IP_ADDRESS¶: Optional argument(s)

setup¶

Configure API key.

greynoise setup [OPTIONS]

Options

-k, --api-key <api_key>¶: Key to include in API requests [required]