Admin Guide

Synapse-Efflux Admin Guide

Configuration

Synapse-Efflux requires a Efflux API key. For information on how to sign up, please contact Efflux directly.

Setting API key for global use

To set-up a global API key:

> efflux.setup.apikey myapikey
Setting Efflux API key for all users.

Using per-user API keys

A user may set-up their own API key:

> efflux.setup.apikey --self myapikey
Setting Efflux API key for the current user.

Dependencies

Synapse-Efflux does not have any dependencies.

Permissions

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

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

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

or:

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

Workflows

Synapse-Efflux provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-Efflux provides the following node actions in Optic:

Name : scan (tcp)
Desc : Submit a set of nodes for scanning using TCP via the Efflux API.
Forms: inet:ipv4, inet:ipv6, inet:cidr4, inet:cidr6, inet:url, inet:fqdn, it:sec:cve

Name : scan (udp)
Desc : Submit a set of nodes for scanning using UDP via the Efflux API.
Forms: inet:ipv4, inet:ipv6, inet:cidr4, inet:cidr6, inet:url, inet:fqdn, it:sec:cve

Onload Events

Synapse-Efflux does not use any onload events.