NAME

       CSAF::ROLIE::Feed - Build ROLIE (Resource-Oriented Lightweight Information Exchange) feed

SYNOPSIS

           use CSAF::ROLIE::Feed;

           my $rolie = CSAF::ROLIE::Feed->new;

           $rolie->options->configure(
               feed_id    => 'acme-csaf-feed-tlp-white',
               feed_title => 'ACME Security Advisory CSAF feed (TLP:WHITE)'
               base_url   => 'https://security.acme.tld/advisories/csaf'
           );

           # Add CSAF document entry
           $rolie->add_entry($csaf);

           if ($rolie->write) {
               say "ROLIE feed created";
           }

DESCRIPTION

       CSAF::ROLIE::Feed build a ROLIE (Resource-Oriented Lightweight Information Exchange) feed using the CSAF
       documents.

       <https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html>

       The Resource Oriented Lightweight Information Exchange (ROLIE) is standard (RFC-8322) for exchanging
       security automation information between two machines, or between a machine and a human operator.

       <https://tools.ietf.org/html/rfc8322>

   ATTRIBUTES
       id  Feed ID

       title
           Feed title

       link
       category
           Feed category

       entry
           Feed entries

       updated
           Feed last update

   METHODS
       $rolie->options
           Change the default options for CSAF::Options::ROLIE configurator.

               $rolie->options->configure(
                   feed_title => 'ACME Security Advisory CSAF feed (TLP:WHITE)'
                   base_url   => 'https://security.acme.tld/advisories/csaf'
               );

       $rolie->add_entry ( $csaf, [ $options ])
           Add  a  CSAF  document  to  the  ROLIE  feed and provide a $options hash to include the integrity and
           signature files.

               $rolie->add_entry($csaf, {
                   integrity => {
                       sha256 => 0,
                       sha512 => 1
                   },
                   signature => 1
               });

       $rolie->from_csaf_directory ( [$path] )
           Create ROLIE feed from the provided CSAF directory in $path. If $path is not specified, the name will
           be taken from the "csaf_directory" option in CSAF::Options::ROLIE.

               $rolie->from_csaf_directory('/var/www/html/advisories/csaf');
               $rolie->write;

       $rolie->from_file ( $path )
           Import ROLIE feed from the provided file.

       $rolie->import_entry_from_file ( $path )
           Import only the entries from provided ROLIE feed file.

       $rolie->render
           Render a ROLIE feed in JSON.

               $rolie->render;

       $rolie->write ( [$path] )
           Render and write a ROLIE feed.  If  $path  is  not  specified,  the  name  will  be  taken  from  the
           "feed_filename" option in CSAF::Options::ROLIE (default "csaf-feed-tlp-white.json").

               $rolie->write('acme-csaf-feed-tlp-white.json');

       $rolie->TO_JSON

SUPPORT

   Bugs / Feature Requests
       Please     report    any    bugs    or    feature    requests    through    the    issue    tracker    at
       <https://github.com/giterlizzi/perl-CSAF/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-CSAF>

           git clone https://github.com/giterlizzi/perl-CSAF.git

AUTHOR

       •   Giuseppe Di Terlizzi <gdt@cpan.org>

LICENSE AND COPYRIGHT

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

perl v5.40.1                                       2025-07-04                             CSAF::ROLIE::Feed(3pm)