File Coverage

blib/lib/STIX/Common/Bundle.pm

Criterion	Covered	Total	%
statement	38	38	100.0
branch			n/a
condition			n/a
subroutine	13	13	100.0
pod			n/a
total	51	51	100.0

package STIX::Common::Bundle;

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

use STIX::Common::List;
use Types::Standard qw(StrMatch InstanceOf);
use Types::TypeTiny qw(ArrayLike);
use UUID::Tiny      qw(:std);

use Moo;
use namespace::autoclean;

extends 'STIX::Object';

use constant SCHEMA =>
    'http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/bundle.json';

use constant PROPERTIES => qw(type id objects);

use constant STIX_OBJECT_TYPE => 'bundle';

has type => (is => 'ro', default => 'bundle');

has objects => (is => 'rw', isa => ArrayLike [InstanceOf ['STIX::Object']], default => sub { STIX::Common::List->new });

has id => (
    is  => 'rw',
    isa => StrMatch [
        qr{^[a-z][a-z0-9-]+[a-z0-9]--[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$}
    ],
    lazy    => 1,
    default => sub { shift->generate_id }
);

1;

=encoding utf-8

=head1 NAME

STIX::Common::Bundle - STIX Bundle

=head1 SYNOPSIS

    use STIX::Common::Bundle;

    my $bundle = STIX::Common::Bundle->new(
        objects => [
            STIX::Vulnerability->new( ... ),
            STIX::Sighting->new( ... ),
            STIX::Common::Relationship->new( ... )
        ]
    );

    # append new STIX object
    push @{ $bundle->objects }, STIX::Incident->new( ... );

    # append new STIX object using STIX::Common::List->push
    $bundle->objects->push( STIX::Indicator->new( ... ) );


=head1 DESCRIPTION

A Bundle is a collection of arbitrary STIX Objects and Marking Definitions
grouped together in a single container.


=head2 METHODS

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

=over

=item STIX::Common::Bundle->new(%properties)

Create a new instance of L.

=item $bundle->id

An identifier for this bundle. The id field for the Bundle is designed to
help tools that may need it for processing, but tools are not required to
store or track it.

=item $bundle->objects

Specifies a set of one or more STIX Objects.

=item $bundle->type

The type of this object, which MUST be the literal C.

=back


=head2 HELPERS

=over

=item $bundle->TO_JSON

Helper for JSON encoders.

=item $bundle->to_hash

Return the object HASH.

=item $bundle->to_string

Encode the object in JSON.

=item $bundle->validate

Validate the object using JSON Schema (see L).

=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-STIX.git


=head1 AUTHOR

=over 4

=item * Giuseppe Di Terlizzi

=back


=head1 LICENSE AND COPYRIGHT

This software is copyright (c) 2024 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