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.config.add default mytoken
Synapse-Vulncheck config "default" added

Creating a configuration for role-based use

Add an unscoped configuration:

> vulncheck.config.add myunscoped mytoken --scope unscoped
Synapse-Vulncheck config "myunscoped" added

Grant another user admin permissions to the new configuration:

> vulncheck.config.update myunscoped --perm user visi admin
Updated Synapse-Vulncheck config "myunscoped"

Grant a role read permissions to the new configuration:

> vulncheck.config.update myunscoped --perm role ninjas read
Updated Synapse-Vulncheck config "myunscoped"

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

Overriding the proxy configuration

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

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 )
power-ups.vulncheck.admin        : Controls access to Synapse-Vulncheck admin options. ( 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

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

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