NPM

Collects NPM Packages.

Details

Transfer Tag

hoppr.core_plugins.collect_npm_plugin

Supported PURLs

npm

System Dependencies

NONE

Transfer File Example

---
schemaVersion: v1
kind: transfer

stages:
  collect:
    plugins:
    - name: "hoppr.core_plugins.collect_npm_plugin"
      config:
        process_timeout: 60

max_processes: 3

Configuration Options

Option	Details
process_timeout	Number of seconds to attempt collect before timeout. Default: 60

Proxy and Certificate Configuration

To configure proxies, set the following environment variables:

Environment Variable Name	Description
http_proxy	Proxy for the HTTP protocol.
https_proxy	Proxy for the HTTPS protocol.
no_proxy	Comma-separated list of domains where proxies won't be used.

Credentials Configuration

To specify credentials, you need a credentials file.

Sample credentials file:

---
schemaVersion: v1
kind: Credentials

metadata:
  name: Registry Credentials
  version: v1
  description: Sample credentials file

credential_required_services:
  - url: registry.gitlab.com
    user_env: CI_REGISTRY_USER
    pass_env: CI_REGISTRY_PASSWORD

SBOM Generation Tools

• syft (cli tool)
• cyclonedx-npm (cli tool)
• cyclonedx-node-js-generate-sbom (GitHub Action)

note

For more tools visit the CycloneDX Tool Center