Package Documentation
Storm Package: synapse-nist-nvd
The following Commands are available from this package. This documentation is generated for version 4.0.0 of the package.
Storm Commands
This package implements the following Storm Commands.
nist.nvd.config.add
Add a Synapse-NIST-NVD configuration.
NOTE: If an API key is not set requests will be subject to public rate-limiting
NOTE: A global configuration named "default" is created when the Power-Up is loaded.
Only one global configuration may exist, so use nist.nvd.config.update to set the
API key on the "default" configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add an unscoped configuration
nist.nvd.config.add myconfig --apikey myapikey1234 --scope unscoped
// Add a configuration for the current user
nist.nvd.config.add --scope self myconfig --apikey myapikey5678
Usage: nist.nvd.config.add [options] <name>
Options:
--help : Display the command usage.
--apikey <apikey> : The NIST NVD API key string. (default: None)
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
--no-check-apikey : Do not verify the API key against the NIST NVD API.
Arguments:
<name> : A unique name for the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.config.del
Delete a Synapse-NIST-NVD configuration.
Examples:
// Delete the "myconfig" configuration
nist.nvd.config.del myconfig
Usage: nist.nvd.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.config.list
Display the list of Synapse-NIST-NVD configurations you have access to.
Usage: nist.nvd.config.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.config.migrate
Migrate options for all Synapse-NIST-NVD configurations.
Examples:
// Disable SSL certificate verification on all configurations
nist.nvd.config.migrate --ssl-verify (false)
Usage: nist.nvd.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.admin
nist.nvd.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
nist.nvd.config.show
// Show a configuration by name
nist.nvd.config.show myconfig
Usage: nist.nvd.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.config.update
Update the configuration of a defined Synapse-NIST-NVD configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the API key on the global "default" configuration
nist.nvd.config.update default --apikey myapikey1234
// Set the permission level for user "myuser" to "admin" on the "myconfig"
// configuration
nist.nvd.config.update myconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "myconfig" configuration
nist.nvd.config.update myconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "myconfig"
nist.nvd.config.update myconfig --ssl-verify (false)
// Change the name of the "myconfig" configuration to "otherconfig"
nist.nvd.config.update myconfig --name otherconfig
Usage: nist.nvd.config.update [options] <config>
Options:
--help : Display the command usage.
--apikey <apikey> : The NIST NVD API key string. An empty string removes the key. (default: None)
--perm <perm> : Set the permission level for a user or role on this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level, or None to remove the permission.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--name <name> : Rename the configuration. (default: None)
--no-check-apikey : Do not verify the API key against the NIST NVD API.
Arguments:
<config> : The name of the configuration to modify.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.cve.byid
Ingest a CVE record by CVE id.
This command takes risk:vuln and it:sec:cve nodes as input and queries
the NIST NVD API for the corresponding CVE record.
Examples:
// Enrich an it:sec:cve node
it:sec:cve=CVE-2020-0001 | nist.nvd.cve.byid --yield
Usage: nist.nvd.cve.byid [options]
Options:
--help : Display the command usage.
--config <config> : Override the default config with the provided name.
--debug : Show verbose debug output.
--yield : Yield the newly created nodes.
Inputs:
it:sec:cve : it:sec:cve nodes
risk:vuln : risk:vuln nodes
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.cves.feed
Ingest a feed of CVE records.
This command will automatically store progress of the ingest,
starting first with an offset to load all records and then proceeding
to use the modified date. Progress is stored on a meta:feed node in the
view the command runs in, which is linked to each ingested risk:vuln
node with a -(found)> edge.
It is recommended to create a single cron job to run this command
so that results are contiguous in the view it is running.
Per NIST NVD guidelines the cron job should not be run more than once
every 2 hours.
Examples:
// Ingest all CVE records
nist.nvd.cves.feed
// Create a cron job to ingest new results every day
cron.add --name nist.nvd.cves.feed --hour 3 { nist.nvd.cves.feed }
// Reset the stored progress and ingest records from index 0
nist.nvd.cves.feed --reset-last
Usage: nist.nvd.cves.feed [options]
Options:
--help : Display the command usage.
--config <config> : Override the default config with the provided name.
--debug : Show verbose debug output.
--yield : Yield the newly created nodes.
--reset-last : Reset the stored progress offset.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
nist.nvd.cves.search
Search for CVE records.
This command will also create an it:exec:query node to represent the
query syntax and link resulting nodes to it via -(found)> edges.
Examples:
// Search for CVEs with 'log4j' in their description and yield risk:vuln nodes
nist.nvd.cves.search log4j --yield
Usage: nist.nvd.cves.search [options] <query>
Options:
--help : Display the command usage.
--config <config> : Override the default config with the provided name.
--debug : Show verbose debug output.
--size <size> : Limit the number of results ingested to the given size.
--yield : Yield the newly created nodes.
--published <published> : Search for CVEs published in a specific date range (120 days max).
--modified <modified> : Search for CVEs modified in a specific date range (120 days max).
--cpe <cpe> : Search for CVEs associated with a specific CPE.
--cwe <cwe> : Search for CVEs which include a specific CWE.
--cveTag <cveTag> : Search for CVEs with specific tags.
Arguments:
[query] : Keywords to search for in CVE descriptions.
The command is accessible to users with one or more of the following permissions:
power-ups.nist-nvd.adminpower-ups.nist-nvd.user
Storm Modules
This package does not export any Storm APIs.