Admin Guide

Synapse-Vulncheck Admin Guide

Configuration

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

Setting API key for global use

To set-up a global API key:

> vulncheck.setup.apikey mytoken
Setting Vulncheck API token for all users.

Using per-user API keys

A user may set-up their own API key:

> vulncheck.setup.apikey --self mytoken
Setting Vulncheck API token for the current user.

Dependencies

Synapse-Vulncheck does not have any dependencies.

Permissions

Package (synapse-vulncheck) defines the following permissions:
power-ups.vulncheck.user         : Controls user access to Synapse-Vulncheck. ( default: false )

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

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

or:

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

Exported APIs

Synapse-Vulncheck does not currently export any APIs.

Workflows

Synapse-Vulncheck provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-Vulncheck provides the following node actions in Optic:

Name : vulncheck.enrich
Desc : Enrich nodes using Synapse-Vulncheck
Forms: risk:vuln, it:sec:cve

Onload Events

Synapse-Vulncheck does not use any onload events.