Admin Guide

Synapse-VXIntel Admin Guide

Configuration

Synapse-VXIntel requires an API key. To create one, please visit the VXIntel site.

Setting an API key for global use

To set-up a global API key:

> vxintel.config.add default myapikey
Synapse-VXIntel config "default" added

Creating a configuration for role-based use

Add an unscoped configuration:

> vxintel.config.add myunscoped myapikey --scope unscoped
Synapse-VXIntel config "myunscoped" added

Grant another user admin permissions to the new configuration:

> vxintel.config.update myunscoped --perm user visi admin
Updated Synapse-VXIntel config "myunscoped"

Grant a role read permissions to the new configuration:

> vxintel.config.update myunscoped --perm role ninjas read
Updated Synapse-VXIntel config "myunscoped"

Users may select a configuration other than their default by passing --config <name> to the Synapse-VXIntel commands.

The Storm Dmon which downloads the files queued by vxintel.files.daily uses the configuration that was selected when the files were queued. Files queued by a previous version of Synapse-VXIntel use the global configuration.

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.vxintel.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.

Permissions

Package (synapse-vxintel) defines the following permissions:
power-ups.vxintel.user           : Allows a user to issue queries to the VXIntel API. ( default: false )
power-ups.vxintel.admin          : Controls access to Synapse-VXIntel admin options. ( default: false )

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

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

or:

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

Exported APIs

Synapse-VXIntel does not currently export any APIs.

Workflows

Synapse-VXIntel provides the following workflows in Optic:

Title: Configuration

The Configuration workflow may be used to manage Synapse-VXIntel configurations from Optic.

Node Actions

Synapse-VXIntel provides the following node actions in Optic:

Name : download
Desc : download file bytes
Forms: file:bytes, hash:md5, hash:sha1, hash:sha256