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.setup.apikey myapikey
Setting PolySwarm API key for all users.

Using per-user API keys

A user may set-up their own API key:

> polyswarm.setup.apikey --self myapikey
Setting PolySwarm API key for the current user.

Permissions

Package (synapse-polyswarm) defines the following permissions:
power-ups.polyswarm.user         : Controls user access to Synapse-PolySwarm. ( 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

Onload Events

Synapse-PolySwarm uses the onload event to run required data migrations.

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.