class CycloneDX::BOM

• CycloneDX::BOM
• Reference
• Object

Overview

Represents a CycloneDX Bill of Materials (BOM). This class manages a collection of components and provides methods for serializing the BOM into different formats (JSON, XML, CSV).

Included Modules

• JSON::Serializable

Defined in:

Constant Summary

BOM_FORMAT = "CycloneDX"

BOM_VERSION = 1

SUPPORTED_VERSIONS = ["1.4", "1.5", "1.6", "1.7"]

XML_NAMESPACE = "http://cyclonedx.org/schema/bom"

Constructors

• .new(components : Array(Component), spec_version : String, metadata : Metadata | Nil = nil, dependencies : Array(Dependency) | Nil = nil, properties : Array(Property) | Nil = nil, vulnerabilities : Array(Vulnerability) | Nil = nil, services : Array(Service) | Nil = nil, compositions : Array(Composition) | Nil = nil, annotations : Array(Annotation) | Nil = nil, formulation : Array(Formula) | Nil = nil, declarations : Declarations | Nil = nil)

  Initializes a new CycloneDX BOM.

• .new(pull : JSON::PullParser)

Instance Method Summary

• #annotations : Array(Annotation) | Nil
• #bom_format : String

  Specifies the format of the BOM (always "CycloneDX" for JSON serialization).

• #bom_version : Int32

  The version of the BOM itself (not the spec version), typically 1.

• #components : Array(Component)

  An array of CycloneDX::Component objects included in the BOM.

• #compositions : Array(Composition) | Nil

  An array of CycloneDX::Composition objects for completeness assertions.

• #declarations : Declarations | Nil
• #dependencies : Array(Dependency) | Nil

  An array of CycloneDX::Dependency objects describing component relationships.

• #formulation : Array(Formula) | Nil
• #metadata : Metadata | Nil

  Metadata about the BOM.

• #properties : Array(Property) | Nil

  An array of CycloneDX::Property objects for extensibility.

• #serial_number : String

  The unique serial number of the BOM.

• #services : Array(Service) | Nil

  An array of CycloneDX::Service objects for SaaSBOM.

• #spec_version : String

  The CycloneDX specification version.

• #to_csv : String

  Serializes the BOM to CSV format.

• #to_xml : String

  Serializes the BOM to XML format.

• #vulnerabilities : Array(Vulnerability) | Nil

  An array of CycloneDX::Vulnerability objects for VDR/VEX.

Constructor Detail

Instance Method Detail