CSAF::...:Writer(3pm)

πŸ“¦
version 0.26 Β· 2 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– CSAF::Options::Writer β€” the configurator bestie πŸ’–

okay so picture this: you're out here writing CSAF documents and you need to tell the writer how to behave, and that's literally this module. It lives in the CSAF::...:Writer(3pm) corner of your Perl docs β€” the user-contributed perl documentation zone, iykyk ✨


🌸 NAME 🌸

CSAF::Options::Writer β€” the CSAF::Writer configurator, no cap πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

use CSAF::Options::Writer;
my $options = CSAF::Options::Writer->new( );

$options->configure(
    create_sha256_integrity => 0,
    create_gpg_signature    => 1,
    update_index            => 1,
    update_changes          => 1
);

if (my $passphrase = get_passphrase_from_stdin) {
    $options->gpg_passphrase($passphrase);
}

like... you make the object, you configure it, and if you've got a passphrase coming in from stdin you hand it over too. periodt πŸ’…


✨ DESCRIPTION ✨

CSAF::Options::Writer is the configurator of CSAF::Writer. it's giving "personal assistant for your writer object" honestly 🫢

πŸ’œ METHODS πŸ’œ

CSAF::Options::Writer inherits all methods from CSAF::Util::Options. every single one. it's a whole family tree, iconic behavior 🌈

πŸ‘‘ ATTRIBUTES πŸ‘‘

  • update_index β€” creates and updates the index.txt file. default is TRUE βœ…
  • update_changes β€” creates and updates the changes.csv file. default is TRUE βœ…
  • create_sha256_integrity β€” creates a SHA256 integrity file, *.sha256, for the CSAF document you provided. default is TRUE πŸ”₯
  • create_sha512_integrity β€” creates a SHA512 integrity file, *.sha512, for the CSAF document you provided. default is TRUE πŸ”₯
  • create_gpg_signature β€” signs the CSAF document with GPG and creates the signature file *.sha256. default is FALSE πŸ™ˆ
  • gpg_key β€” specify the default GPG key πŸ”‘
  • gpg_passphrase β€” specify the passphrase for the GPG key you provided 🀫

🩷 SUPPORT 🩷

πŸ› Bugs / Feature Requests πŸ›

bestie if something's broken or you're dreaming up a feature, please please report it through the issue tracker at <https://github.com/giterlizzi/perl-CSAF/issues>. you'll get notified automatically about any progress on your issue β€” like a little notification ping, we love that for you πŸ’–

πŸ“¦ Source Code πŸ“¦

this is open source software. the code repository is available for public review and contribution under the terms of the license. go wild, contribute, slay ✨

<https://github.com/giterlizzi/perl-CSAF>

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

🌟 AUTHOR 🌟

  • Giuseppe Di Terlizzi <gdt@cpan.org>

this software is copyright (c) 2023-2025 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. fr fr, go forth and redistribute 🌈


shoutout to perl v5.40.1, dated 2025-09-03 β€” that's the version and the date this page came from, and yes we're thanking them by name πŸŽ€ bye bestie, go configure something gorgeous πŸ’…πŸ’–
πŸ“¦ where this page comes from