Class CycloneDXBom

A CycloneDX 1.5 Bill of Materials (BOM) document containing vulnerability data.

Hierarchy

  • CycloneDXBom

Constructors

constructor

Properties

additionalProperties? bomFormat components metadata specVersion version? vulnerabilities

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

bomFormat

bomFormat: string

The BOM format identifier. Must be CycloneDX.

components

components: CycloneDXComponent[]

The list of scanned software components. Cannot be empty.

metadata

metadata: CycloneDXMetadata

Metadata about the BOM, including the scanned asset and the scanner tool.

specVersion

specVersion: string

The CycloneDX specification version. Must be 1.5.

Optional version

version?: number

The version number of the BOM document.

vulnerabilities

vulnerabilities: CycloneDXVulnerability[]

The list of detected vulnerabilities. Cannot be empty.

Settings

Member Visibility

Theme

Generated using TypeDoc