Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 5.8 KB

README.md

File metadata and controls

101 lines (72 loc) · 5.8 KB
Raw

node-dependency-track-upload

Build Status Quality Gate License

Node.js plugin to integrate with Dependency-Track server to submit dependency manifests and gather project metrics.

Features

  1. upload a CycloneDX Software Bill-of-Materials (SBOM) file to Dependency-Track and create the project if needed
  2. get a list of projects, their version, UUID and known vulnerabilities

Requirements

Install

npm install -g @cyclonedx/bom @sephiroth-j/node-dependency-track-upload

Usage

Configuration

Add the base URL to the Dependency-Track server and an API key to your npm config (.npmrc). This is the recommended way but both values can be provided as command line arguments as well (see below).

npm config set @sephiroth-j/node-dependency-track-upload:url http://localhost:8081
npm config set @sephiroth-j/node-dependency-track-upload:apiKey CO7aEO5FzHbRh8dyqBdrK9tWTClf8NYR

Dependency-Track Permissions

The following permissions for the given API key are required:

  • BOM_UPLOAD: for uploading a bom file
  • VIEW_PORTFOLIO: for project listing
  • VULNERABILITY_ANALYSIS: to run an analysis e.g. after uploading a bom
  • PROJECT_CREATION_UPLOAD: for automatic creation of project during the upload process. Without, the UUID of the project must be provided for uploading a bom!

Commands and Options

In general, the working directory when executing the command should be your project root directory with the package.json.

Global Options

  • --url: specify an alternate url to the Dependency-Track server
  • --api-key: specify an alternate API key
  • -h, --help: show global help or for a command using <command> --help
  • -v, --version: show version

list-projects

Get a list of known projects and the numbers of their known vulnerabilities (critical, high, medium, low, info). The list can be limited to active projects only (off by default) and to projects where the name contains a given string.

By default the output is an ASCII table. This can be disabled by giving the option --no-table.

The output is sorted by project name in ascending order and by version in descending order (according to semver).

Output Examples

# output as table
$ dtrack-upload list-projects
┌───────────────────────┬────────────┬───────────────────────┬─────────────────┐
│ Project Name          │ Version    │ UUID                  │ Vulnerabilities │
├───────────────────────┼────────────┼───────────────────────┼─────────────────┤
│ @sephiroth-j/node-dep │ 0.1.1-beta │ 86d7c51c-fbe9-4a5e-98 │ 0/0/0/0/0       │
│ endency-track-upload  │            │ 0a-e904135057a7       │                 │
├───────────────────────┼────────────┼───────────────────────┼─────────────────┤
│ @sephiroth-j/node-dep │ 0.1.0-beta │ 74fc22e1-b126-40a7-a0 │ 0/0/0/0/0       │
│ endency-track-upload  │            │ bb-26ccfb2814bc       │                 │
└───────────────────────┴────────────┴───────────────────────┴─────────────────┘

# plain output
$ dtrack-upload list-projects --no-table
@sephiroth-j/node-dependency-track-upload, 0.1.1-beta, 86d7c51c-fbe9-4a5e-980a-e904135057a7, 0/0/0/0/0
@sephiroth-j/node-dependency-track-upload, 0.1.0-beta, 74fc22e1-b126-40a7-a0bb-26ccfb2814bc, 0/0/0/0/0

Filtering by name is done with the option --filter followed by the search string, e.g. dtrack-upload list-projects --filter foo.

Hiding inactive projects can be done with the option --active-only.

upload-bom

Upload a CycloneDX Software Bill-of-Materials (SBOM) file to Dependency-Track and create the project if needed.

The default name for the bom file is bom.xml and it is assumed to be located in the current working directory (just as the package.json). An alternative name/path can be provided with the option -b, --bom. Likewise it is possible to specify an alternative path to the package.json using the option --pj, --package-json.

If the package.json was not found, the name and the version of the project can be given using the options --pn, project-name and --pv, --project-version.

Use the option -p, --project-id to specify the UUID the project directly.

Upload Examples

# using default options and settings provided in .npmrc
$ dtrack-upload upload-bom

# with alternative path to bom and package.json
$ dtrack-upload upload-bom --bom sub/dir/foo.xml --package-json sub/dir/package.json

# giving the UUID
$ dtrack-upload upload-bom -p 1aec8e9d-3024-42fd-ad28-2a35bcb8d282