Admin Guide

Synapse-GreyNoise Admin Guide

Configuration

Synapse-GreyNoise requires a GreyNoise API key to use most of the commands provided. Without an API key, the greynoise.community.ip command may still be used to query the free Community API.

For information on how to sign up for an API key, please visit the GreyNoise API documentation.

Setting API key for global use

To set-up a global API key:

> greynoise.setup.apikey myapikey
Setting Synapse-GreyNoise API key for all users.

Using per-user API keys

A user may set-up their own API key:

> greynoise.setup.apikey --self myapikey
Setting Synapse-GreyNoise API key for the current user.

Setting a tag prefix for global use

Note: If not set, this will default to rep.greynoise.

> greynoise.setup.tagprefix my.prefix
Setting Synapse-GreyNoise tag prefix to my.prefix.

Permissions

Package (synapse-greynoise) defines the following permissions:
power-ups.greynoise.user         : Controls user access to Synapse-GreyNoise. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.greynoise.user
Added rule power-ups.greynoise.user to user visi.

or:

> auth.role.addrule ninjas power-ups.greynoise.user
Added rule power-ups.greynoise.user to role ninjas.

Exported APIs

Synapse-GreyNoise does not currently export any APIs.

Node Actions

Synapse-GreyNoise provides the following node actions in Optic:

Name : Enterprise IP Lookup
Desc : Query the quickcheck API and conditionally RIOT/IP Context APIs.
Forms: inet:ipv4

Name : Community IP Lookup
Desc : Query the GreyNoise Community API for IP context data.
Forms: inet:ipv4

Onload Events

Synapse-GreyNoise does not use any onload events.