Admin Guide

Synapse-Doppel Admin Guide

Configuration

Synapse-Doppel requires a Doppel API key. For information on how to sign up, please visit the Doppel API documentation.

Setting the configuration for global use

To set-up a global configuration:

> doppel.config.add global_config global_apikey global_userkey
Synapse-Doppel config "global_config" added

Creating a configuration for role-based use

Add an unscoped configuration:

> doppel.config.add myunscoped myapikey myuserkey --scope unscoped
Synapse-Doppel config "myunscoped" added

Grant another user admin permissions to the new configuration:

> doppel.config.update myunscoped --perm user visi admin
Updated Synapse-Doppel config "myunscoped"

Grant a role read permissions to the new configuration:

> doppel.config.update myunscoped --perm role ninjas read
Updated Synapse-Doppel config "myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.doppel.admin or storm.lib.inet.http.proxy permission.

When the proxy configuration is set to (false) or a URL the permission will be checked when a configuration is created/updated, and when it is used to make an HTTP request.

Dependencies

Synapse-Doppel does not have any dependencies.

Permissions

Package (synapse-doppel) defines the following permissions:
power-ups.doppel.user            : Controls user access to Synapse-Doppel. ( default: false )
power-ups.doppel.admin           : Controls access to Synapse-Doppel admin options. ( default: false )

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

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

or:

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

Workflows

Synapse-Doppel provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-Doppel provides the following node actions in Optic:

Name : alert.get
Desc : Get/update the specified alert using Synapse-Doppel
Forms: risk:alert

Name : alerts
Desc : Get alerts for the URL using Synapse-Doppel
Forms: inet:url