Admin Guide

Synapse-PolySwarm Admin Guide

Configuration

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

Setting API key for global use

To set-up a global API key:

> polyswarm.config.add default myapikey
Synapse-PolySwarm config "default" added

Creating a configuration for role-based use

Add an unscoped configuration:

> polyswarm.config.add myunscoped myapikey --scope unscoped
Synapse-PolySwarm config "myunscoped" added

Grant another user admin permissions to the new configuration:

> polyswarm.config.update myunscoped --perm user visi admin
Updated Synapse-PolySwarm config "myunscoped"

Grant a role read permissions to the new configuration:

> polyswarm.config.update myunscoped --perm role ninjas read
Updated Synapse-PolySwarm config "myunscoped"

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

Setting the tag prefix

The tag prefix used when recording data from PolySwarm defaults to rep.polyswarm. It may be set per configuration using the --tag-prefix option to polyswarm.config.add or polyswarm.config.update, or for all configurations using polyswarm.config.migrate:

> polyswarm.config.migrate --tag-prefix my.tagpref
Updated Synapse-PolySwarm config "synapse-polyswarm:myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.polyswarm.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-polyswarm) defines the following permissions:
power-ups.polyswarm.user         : Controls user access to Synapse-PolySwarm. ( default: false )
power-ups.polyswarm.admin        : Controls access to Synapse-PolySwarm admin options. ( default: false )

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

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

or:

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

Workflows

Synapse-PolySwarm provides the following workflows in Optic:

Title: Configuration

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

On-demand Migrations

AV Hit Migration

The previously available migrateAvHit() function in the polyswarm module has been deprecated. It does not perform any migrations and will simply print a warning message indicating that the it:av:filehit migration is now automatic.