Admin Guide

Synapse-NIST-NVD Admin Guide

Configuration

Synapse-NIST-NVD does not require an API key, however using one significantly increases the rate limit. For information on how to sign up, please visit the NVD API documentation.

Configurations are stored in synapse-nist-nvd vaults and are managed with the nist.nvd.config.* commands. A global configuration named default is created when the Power-Up is loaded.

Setting API key for global use

To set the API key on the global configuration:

> nist.nvd.config.update default --apikey myapikey --no-check-apikey
Updated Synapse-NIST-NVD config "default"

The API key is verified against the NVD API, using the proxy and SSL settings of the configuration, when a configuration is created or updated. The --no-check-apikey option skips this verification.

Using per-user API keys

A user may create their own configuration. A configuration created by a user takes precedence over the global configuration when that user runs a command:

> nist.nvd.config.add myconfig --apikey myapikey --no-check-apikey --scope self
Synapse-NIST-NVD config "myconfig" added

Creating a configuration for role-based use

Add an unscoped configuration:

> nist.nvd.config.add myunscoped --apikey myapikey --no-check-apikey --scope unscoped
Synapse-NIST-NVD config "myunscoped" added

Grant another user admin permissions to the new configuration:

> nist.nvd.config.update myunscoped --perm user visi admin
Updated Synapse-NIST-NVD config "myunscoped"

Grant a role read permissions to the new configuration:

> nist.nvd.config.update myunscoped --perm role ninjas read
Updated Synapse-NIST-NVD config "myunscoped"

An unscoped configuration may be used with the --config option of the nist.nvd.cves.search, nist.nvd.cves.feed, and nist.nvd.cve.byid commands.

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.nist-nvd.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-NIST-NVD does not have any dependencies.

Permissions

Package (synapse-nist-nvd) defines the following permissions:
power-ups.nist-nvd.user          : Controls user access to Synapse-NIST-NVD. ( default: false )
power-ups.nist-nvd.admin         : Controls access to Synapse-NIST-NVD admin options. ( default: false )

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

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

or:

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

The power-ups.nist-nvd.admin permission grants access to all Synapse-NIST-NVD commands and is required to run nist.nvd.config.migrate.

Exported APIs

Synapse-NIST-NVD does not currently export any APIs.

Workflows

Synapse-NIST-NVD provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-NIST-NVD does not provide any node actions in Optic.