1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
package CSAF;
use 5.010001;
use strict;
use warnings;
use utf8;
use CSAF::Builder;
use CSAF::Parser;
use CSAF::Renderer;
use CSAF::Validator;
use CSAF::Writer;
use CSAF::Document;
use overload '""' => \&to_string, fallback => 1;
use Moo;
our $VERSION = '0.26';
$VERSION =~ tr/_//d; ## no critic
our $CACHE = {};
sub BUILD {
my ($self, $args) = @_;
$self->{_} = CSAF::Document->new;
$CACHE = {};
$self->{builder} = CSAF::Builder->new(csaf => $self);
$self->{renderer} = CSAF::Renderer->new(csaf => $self);
$self->{validator} = CSAF::Validator->new(csaf => $self);
}
# CSAF document core properties
sub document { shift->{_}->document }
sub product_tree { shift->{_}->product_tree }
sub vulnerabilities { shift->{_}->vulnerabilities }
# Helper classes
sub builder { shift->{builder} }
sub renderer { shift->{renderer} }
sub validator { shift->{validator} }
sub writer { CSAF::Writer->new(csaf => shift, @_) }
# Helpers
sub build { shift->builder->build }
sub validate { shift->validator->validate(@_) }
sub render { shift->renderer->render(@_) }
sub from_string { CSAF::Parser->new(content => $_[1])->parse }
sub from_file { CSAF::Parser->new(file => $_[1])->parse }
sub from_hash { CSAF::Parser->new(data => $_[1])->parse }
sub to_string { shift->renderer->render }
sub TO_JSON { shift->builder->TO_JSON }
1;
__END__
=encoding utf-8
=head1 NAME
CSAF - Common Security Advisory Framework
=head1 SYNOPSIS
use CSAF;
my $csaf = CSAF->new;
$csaf->document->title('Base CSAF Document');
$csaf->document->category('csaf_security_advisory');
$csaf->document->publisher(
category => 'vendor',
name => 'CSAF',
namespace => 'https://csaf.io'
);
my $tracking = $csaf->document->tracking(
id => 'CSAF:2024-001',
status => 'final',
version => '1.0.0',
initial_release_date => 'now',
current_release_date => 'now'
);
$tracking->revision_history->add(
date => 'now',
summary => 'First release',
number => '1'
);
my @errors = $csaf->validate;
if (@errors) {
say $_ for (@errors);
Carp::croak "Validation errors";
}
# Save CSAF documents using the
$csaf->writer(directory => '/var/www/html/csaf')->write;
=head1 DESCRIPTION
The Common Security Advisory Framework (CSAF) Version 2.0 is the definitive
reference for the language which supports creation, update, and interoperable
exchange of security advisories as structured information on products,
vulnerabilities and the status of impact and remediation among interested
parties.
L<https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html>
=head2 CSAF PROPERTIES
These properties are inherited from L<CSAF::Document>.
=over
=item document
Return L<CSAF::Type::Document>.
=item product_tree
Return L<CSAF::Type::ProductTree>.
=item vulnerabilities
Return L<CSAF::Type::Vulnerabilities>.
=back
=head2 HELPERS
=over
=item TO_JSON
=item builder
Return L<CSAF::Builder>.
=item render
Alias for C<renderer-E<gt>render($format)>.
my $doc = $csaf->render('html');
=item renderer
Return L<CSAF::Renderer>.
my $doc = $csaf->renderer->render('html');
=item validate
Alias for C<validator-E<gt>validate>.
=item validator
Return L<CSAF::Validator>.
=item from_string
Parse CSAF document string and return L<CSAF>.
=item from_file
Parse CSAF document file and return L<CSAF>.
=item to_string
Render CSAF document.
my $json = $csaf->to_string;
=item writer
Return L<CSAF::Writer>.
=back
=head1 SUPPORT
=head2 Bugs / Feature Requests
Please report any bugs or feature requests through the issue tracker
at L<https://github.com/giterlizzi/perl-CSAF/issues>.
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<https://github.com/giterlizzi/perl-CSAF>
git clone https://github.com/giterlizzi/perl-CSAF.git
=head1 AUTHOR
=over 4
=item * Giuseppe Di Terlizzi <gdt@cpan.org>
=back
=head1 LICENSE AND COPYRIGHT
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.
=cut
|
