File Coverage

blib/lib/SBOM/CycloneDX/Declarations/Signatory.pm

Criterion	Covered	Total	%
statement	23	36	63.8
branch	0	14	0.0
condition	0	9	0.0
subroutine	8	10	80.0
pod	1	2	50.0
total	32	71	45.0

package SBOM::CycloneDX::Declarations::Signatory;

use 5.010001;
use strict;
use warnings;
use utf8;

use SBOM::CycloneDX::List;

use Types::Standard qw(InstanceOf HashRef Str);

use Moo;
use namespace::autoclean;

extends 'SBOM::CycloneDX::Base';

sub BUILD {
    my ($self, $args) = @_;

    if (exists $args->{signature} and exists $args->{organization} and exists $args->{external_reference}) {
        Carp::croak('"signature", "organization" and "external_reference" cannot be used at the same time');
    }

    if (!exists $args->{signature} and (not exists $args->{organization} or not exists $args->{external_reference})) {
        Carp::croak('"organization" and "external_reference" are required');
    }

}

has name               => (is => 'rw', isa => Str);
has role               => (is => 'rw', isa => Str);
has signature          => (is => 'rw', isa => HashRef);
has organization       => (is => 'rw', isa => InstanceOf ['SBOM::CycloneDX::OrganizationalEntity']);
has external_reference => (is => 'rw', isa => InstanceOf ['SBOM::CycloneDX::ExternalReference']);


sub TO_JSON {

    my $self = shift;

    my $json = {};

    $json->{name}              = $self->name               if $self->name;
    $json->{role}              = $self->role               if $self->role;
    $json->{signature}         = $self->signature          if $self->signature;
    $json->{organization}      = $self->organization       if $self->organization;
    $json->{externalReference} = $self->external_reference if $self->external_reference;

    return $json;

}

1;

=encoding utf-8

=head1 NAME

SBOM::CycloneDX::Declarations::Signatory - Signatory

=head1 SYNOPSIS

    SBOM::CycloneDX::Declarations::Signatory->new();


=head1 DESCRIPTION

L provide the signatory authorized on
behalf of an organization to assert validity of this document.

=head2 METHODS

L inherits all methods from L
and implements the following new ones.

=over

=item SBOM::CycloneDX::Declarations::Signatory->new( %PARAMS )

Properties:

=over

=item * C, External references 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.

=item * C, The signatory's name.

=item * C, The signatory's organization.

=item * C, The signatory's role within an organization.

=item * C, Enveloped signature in JSON Signature Format (JSF)
(L).

=back

=item $signatory->external_reference

=item $signatory->name

=item $signatory->organization

=item $signatory->role

=item $signatory->signature

=back


=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L.
You will be notified automatically of any progress on your issue.

=head2 Source Code

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

L

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


=head1 AUTHOR

=over 4

=item * Giuseppe Di Terlizzi

=back


=head1 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.

=cut