Admin Guide

Synapse-Volexity Admin Guide

Configuration

Synapse-Volexity requires a Volexity API username (email) and API key. For information on how to sign up, please visit the Volexity API documentation.

Setting the configuration for global use

To set-up a global configuration:

> volexity.config.add global_config user@example.com global_apikey
Synapse-Volexity config "global_config" added

Creating a configuration for role-based use

Add an unscoped configuration:

> volexity.config.add myunscoped user@example.com myapikey --scope unscoped
Synapse-Volexity config "myunscoped" added

Grant another user admin permissions to the new configuration:

> volexity.config.update myunscoped --perm user visi admin
Updated Synapse-Volexity config "myunscoped"

Grant a role read permissions to the new configuration:

> volexity.config.update myunscoped --perm role ninjas read
Updated Synapse-Volexity config "myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.volexity.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-Volexity optionally uses the synapse-fileparser Power-Up for parsing report PDFs and attachments. When synapse-fileparser is not installed, files are still stored in the Axon but not parsed.

Permissions

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

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

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

or:

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

Workflows

Synapse-Volexity provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-Volexity provides the following node actions in Optic:

Name : Enrich Report
Desc : Enrich the report using the Volexity Intel API.
Forms: media:news