Admin Guide

Synapse-Joe-Sandbox Admin Guide

Configuration

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

Setting API key for global use

To set-up a global API key:

> joe.sandbox.setup.apikey myapikey
Setting Joe Sandbox API key for all users.

Using per-user API keys

A user may set-up their own API key:

> joe.sandbox.setup.apikey --self myapikey
Setting Joe Sandbox API key for the current user.

Setting a tag prefix for global use

Note: If not set, this will default to rep.joe.sandbox.

> joe.sandbox.setup.tagprefix my.prefix
Setting Joe Sandbox tag prefix to my.prefix.

Dependencies

Synapse-Joe-Sandbox does not have any dependencies.

Permissions

Package (synapse-joe-sandbox) defines the following permissions:
power-ups.joe-sandbox.user       : Controls user access to Synapse-Joe-Sandbox. ( default: false )

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

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

or:

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

Exported APIs

Synapse-Joe-Sandbox does not currently export any APIs.

Workflows

Synapse-Joe-Sandbox provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-Joe-Sandbox provides the following node actions in Optic:

Name : submit
Desc : Submit a sample to Joe Sandbox for analysis.
Forms: file:bytes, hash:sha256

Onload Events

Synapse-Joe-Sandbox does not use any onload events.