NAME

SBOM::CycloneDX::ExternalReference - External Reference

SYNOPSIS

SBOM::CycloneDX::ExternalReference->new();

DESCRIPTION

SBOM::CycloneDX::ExternalReference provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.

METHODS

SBOM::CycloneDX::ExternalReference inherits all methods from SBOM::CycloneDX::Base and implements the following new ones.

SBOM::CycloneDX::ExternalReference->new( %PARAMS )

Properties:

comment, A comment describing the external reference

hashes, The hashes of the external reference (if applicable).

* properties, Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. See SBOM::CycloneDX::Property

type, Specifies the type of external reference.

url, The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230 - https://www.ietf.org/rfc/rfc7230.txt), mailto (RFC-2368 - https://www.ietf.org/rfc/rfc2368.txt), tel (RFC-3966 - https://www.ietf.org/rfc/rfc3966.txt), and dns (RFC-4501 - https://www.ietf.org/rfc/rfc4501.txt). External references may also include formally registered URNs such as CycloneDX BOM-Link (https://cyclonedx.org/capabilities/bomlink/) to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.

$external_reference->comment

$external_reference->hashes

$external_reference->properties

$external_reference->type

$external_reference->url

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/giterlizzi/perl-SBOM-CycloneDX/issues. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/giterlizzi/perl-SBOM-CycloneDX

git clone https://github.com/giterlizzi/perl-SBOM-CycloneDX.git

AUTHOR

• Giuseppe Di Terlizzi <gdt@cpan.org>

LICENSE AND COPYRIGHT

This software is copyright (c) 2025-2026 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.