-
-
Notifications
You must be signed in to change notification settings - Fork 93
/
csaf_2.0_schema.json
1411 lines (1411 loc) · 55.7 KB
/
csaf_2.0_schema.json
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://docs.oasis-open.org/csaf/csaf/v2.0/csaf_json_schema.json",
"title": "Common Security Advisory Framework",
"description": "Representation of security advisory information as a JSON document.",
"type": "object",
"$defs": {
"acknowledgments_t": {
"title": "List of acknowledgments",
"description": "Contains a list of acknowledgment elements.",
"type": "array",
"minItems": 1,
"items": {
"title": "Acknowledgment",
"description": "Acknowledges contributions by describing those that contributed.",
"type": "object",
"minProperties": 1,
"properties": {
"names": {
"title": "List of acknowledged names",
"description": "Contains the names of contributors being recognized.",
"type": "array",
"minItems": 1,
"items": {
"title": "Name of the contributor",
"description": "Contains the name of a single contributor being recognized.",
"type": "string",
"minLength": 1,
"examples": [
"Albert Einstein",
"Johann Sebastian Bach"
]
}
},
"organization": {
"title": "Contributing organization",
"description": "Contains the name of a contributing organization being recognized.",
"type": "string",
"minLength": 1,
"examples": [
"CISA",
"Google Project Zero",
"Talos"
]
},
"summary": {
"title": "Summary of the acknowledgment",
"description": "SHOULD represent any contextual details the document producers wish to make known about the acknowledgment or acknowledged parties.",
"type": "string",
"minLength": 1,
"examples": [
"First analysis of Coordinated Multi-Stream Attack (CMSA)"
]
},
"urls": {
"title": "List of URLs",
"description": "Specifies a list of URLs or location of the reference to be acknowledged.",
"type": "array",
"minItems": 1,
"items": {
"title": "URL of acknowledgment",
"description": "Contains the URL or location of the reference to be acknowledged.",
"type": "string",
"format": "uri"
}
}
}
}
},
"branches_t": {
"title": "List of branches",
"description": "Contains branch elements as children of the current element.",
"type": "array",
"minItems": 1,
"items": {
"title": "Branch",
"description": "Is a part of the hierarchical structure of the product tree.",
"type": "object",
"maxProperties": 3,
"minProperties": 3,
"required": [
"category",
"name"
],
"properties": {
"branches": {
"$ref": "#/$defs/branches_t"
},
"category": {
"title": "Category of the branch",
"description": "Describes the characteristics of the labeled branch.",
"type": "string",
"enum": [
"architecture",
"host_name",
"language",
"legacy",
"patch_level",
"product_family",
"product_name",
"product_version",
"product_version_range",
"service_pack",
"specification",
"vendor"
]
},
"name": {
"title": "Name of the branch",
"description": "Contains the canonical descriptor or 'friendly name' of the branch.",
"type": "string",
"minLength": 1,
"examples": [
"10",
"365",
"Microsoft",
"Office",
"PCS 7",
"SIMATIC",
"Siemens",
"Windows"
]
},
"product": {
"$ref": "#/$defs/full_product_name_t"
}
}
}
},
"full_product_name_t": {
"title": "Full product name",
"description": "Specifies information about the product and assigns the product_id.",
"type": "object",
"required": [
"name",
"product_id"
],
"properties": {
"name": {
"title": "Textual description of the product",
"description": "The value should be the product’s full canonical name, including version number and other attributes, as it would be used in a human-friendly document.",
"type": "string",
"minLength": 1,
"examples": [
"Cisco AnyConnect Secure Mobility Client 2.3.185",
"Microsoft Host Integration Server 2006 Service Pack 1"
]
},
"product_id": {
"$ref": "#/$defs/product_id_t"
},
"product_identification_helper": {
"title": "Helper to identify the product",
"description": "Provides at least one method which aids in identifying the product in an asset database.",
"type": "object",
"minProperties": 1,
"properties": {
"cpe": {
"title": "Common Platform Enumeration representation",
"description": "The Common Platform Enumeration (CPE) attribute refers to a method for naming platforms external to this specification.",
"type": "string",
"pattern": "^(cpe:2\\.3:[aho\\*\\-](:(((\\?*|\\*?)([a-zA-Z0-9\\-\\._]|(\\\\[\\\\\\*\\?!\"#\\$%&'\\(\\)\\+,/:;<=>@\\[\\]\\^`\\{\\|\\}~]))+(\\?*|\\*?))|[\\*\\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[\\*\\-]))(:(((\\?*|\\*?)([a-zA-Z0-9\\-\\._]|(\\\\[\\\\\\*\\?!\"#\\$%&'\\(\\)\\+,/:;<=>@\\[\\]\\^`\\{\\|\\}~]))+(\\?*|\\*?))|[\\*\\-])){4})|([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9\\._\\-~%]*){0,6})$",
"minLength": 5
},
"hashes": {
"title": "List of hashes",
"description": "Contains a list of cryptographic hashes usable to identify files.",
"type": "array",
"minItems": 1,
"items": {
"title": "Cryptographic hashes",
"description": "Contains all information to identify a file based on its cryptographic hash values.",
"type": "object",
"required": [
"file_hashes",
"filename"
],
"properties": {
"file_hashes": {
"title": "List of file hashes",
"description": "Contains a list of cryptographic hashes for this file.",
"type": "array",
"minItems": 1,
"items": {
"title": "File hash",
"description": "Contains one hash value and algorithm of the file to be identified.",
"type": "object",
"required": [
"algorithm",
"value"
],
"properties": {
"algorithm": {
"title": "Algorithm of the cryptographic hash",
"description": "Contains the name of the cryptographic hash algorithm used to calculate the value.",
"type": "string",
"default": "sha256",
"minLength": 1,
"examples": [
"blake2b512",
"sha256",
"sha3-512",
"sha384",
"sha512"
]
},
"value": {
"title": "Value of the cryptographic hash",
"description": "Contains the cryptographic hash value in hexadecimal representation.",
"type": "string",
"pattern": "^[0-9a-fA-F]{32,}$",
"minLength": 32,
"examples": [
"37df33cb7464da5c7f077f4d56a32bc84987ec1d85b234537c1c1a4d4fc8d09dc29e2e762cb5203677bf849a2855a0283710f1f5fe1d6ce8d5ac85c645d0fcb3",
"4775203615d9534a8bfca96a93dc8b461a489f69124a130d786b42204f3341cc",
"9ea4c8200113d49d26505da0e02e2f49055dc078d1ad7a419b32e291c7afebbb84badfbd46dec42883bea0b2a1fa697c"
]
}
}
}
},
"filename": {
"title": "Filename",
"description": "Contains the name of the file which is identified by the hash values.",
"type": "string",
"minLength": 1,
"examples": [
"WINWORD.EXE",
"msotadddin.dll",
"sudoers.so"
]
}
}
}
},
"model_numbers": {
"title": "List of models",
"description": "Contains a list of full or abbreviated (partial) model numbers.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"title": "Model number",
"description": "Contains a full or abbreviated (partial) model number of the component to identify.",
"type": "string",
"minLength": 1
}
},
"purl": {
"title": "package URL representation",
"description": "The package URL (purl) attribute refers to a method for reliably identifying and locating software packages external to this specification.",
"type": "string",
"format": "uri",
"pattern": "^pkg:[A-Za-z\\.\\-\\+][A-Za-z0-9\\.\\-\\+]*/.+",
"minLength": 7
},
"sbom_urls": {
"title": "List of SBOM URLs",
"description": "Contains a list of URLs where SBOMs for this product can be retrieved.",
"type": "array",
"minItems": 1,
"items": {
"title": "SBOM URL",
"description": "Contains a URL of one SBOM for this product.",
"type": "string",
"format": "uri"
}
},
"serial_numbers": {
"title": "List of serial numbers",
"description": "Contains a list of full or abbreviated (partial) serial numbers.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"title": "Serial number",
"description": "Contains a full or abbreviated (partial) serial number of the component to identify.",
"type": "string",
"minLength": 1
}
},
"skus": {
"title": "List of stock keeping units",
"description": "Contains a list of full or abbreviated (partial) stock keeping units.",
"type": "array",
"minItems": 1,
"items": {
"title": "Stock keeping unit",
"description": "Contains a full or abbreviated (partial) stock keeping unit (SKU) which is used in the ordering process to identify the component.",
"type": "string",
"minLength": 1
}
},
"x_generic_uris": {
"title": "List of generic URIs",
"description": "Contains a list of identifiers which are either vendor-specific or derived from a standard not yet supported.",
"type": "array",
"minItems": 1,
"items": {
"title": "Generic URI",
"description": "Provides a generic extension point for any identifier which is either vendor-specific or derived from a standard not yet supported.",
"type": "object",
"required": [
"namespace",
"uri"
],
"properties": {
"namespace": {
"title": "Namespace of the generic URI",
"description": "Refers to a URL which provides the name and knowledge about the specification used or is the namespace in which these values are valid.",
"type": "string",
"format": "uri"
},
"uri": {
"title": "URI",
"description": "Contains the identifier itself.",
"type": "string",
"format": "uri"
}
}
}
}
}
}
}
},
"lang_t": {
"title": "Language type",
"description": "Identifies a language, corresponding to IETF BCP 47 / RFC 5646. See IETF language registry: https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry",
"type": "string",
"pattern": "^(([A-Za-z]{2,3}(-[A-Za-z]{3}(-[A-Za-z]{3}){0,2})?|[A-Za-z]{4,8})(-[A-Za-z]{4})?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-[A-WY-Za-wy-z0-9](-[A-Za-z0-9]{2,8})+)*(-[Xx](-[A-Za-z0-9]{1,8})+)?|[Xx](-[A-Za-z0-9]{1,8})+|[Ii]-[Dd][Ee][Ff][Aa][Uu][Ll][Tt]|[Ii]-[Mm][Ii][Nn][Gg][Oo])$",
"examples": [
"de",
"en",
"fr",
"frc",
"jp"
]
},
"notes_t": {
"title": "List of notes",
"description": "Contains notes which are specific to the current context.",
"type": "array",
"minItems": 1,
"items": {
"title": "Note",
"description": "Is a place to put all manner of text blobs related to the current context.",
"type": "object",
"required": [
"category",
"text"
],
"properties": {
"audience": {
"title": "Audience of note",
"description": "Indicates who is intended to read it.",
"type": "string",
"minLength": 1,
"examples": [
"all",
"executives",
"operational management and system administrators",
"safety engineers"
]
},
"category": {
"title": "Note category",
"description": "Contains the information of what kind of note this is.",
"type": "string",
"enum": [
"description",
"details",
"faq",
"general",
"legal_disclaimer",
"other",
"summary"
]
},
"text": {
"title": "Note content",
"description": "Holds the content of the note. Content varies depending on type.",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title of note",
"description": "Provides a concise description of what is contained in the text of the note.",
"type": "string",
"minLength": 1,
"examples": [
"Details",
"Executive summary",
"Technical summary",
"Impact on safety systems"
]
}
}
}
},
"product_group_id_t": {
"title": "Reference token for product group instance",
"description": "Token required to identify a group of products so that it can be referred to from other parts in the document. There is no predefined or required format for the product_group_id as long as it uniquely identifies a group in the context of the current document.",
"type": "string",
"minLength": 1,
"examples": [
"CSAFGID-0001",
"CSAFGID-0002",
"CSAFGID-0020"
]
},
"product_groups_t": {
"title": "List of product_group_ids",
"description": "Specifies a list of product_group_ids to give context to the parent item.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/$defs/product_group_id_t"
}
},
"product_id_t": {
"title": "Reference token for product instance",
"description": "Token required to identify a full_product_name so that it can be referred to from other parts in the document. There is no predefined or required format for the product_id as long as it uniquely identifies a product in the context of the current document.",
"type": "string",
"minLength": 1,
"examples": [
"CSAFPID-0004",
"CSAFPID-0008"
]
},
"products_t": {
"title": "List of product_ids",
"description": "Specifies a list of product_ids to give context to the parent item.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/$defs/product_id_t"
}
},
"references_t": {
"title": "List of references",
"description": "Holds a list of references.",
"type": "array",
"minItems": 1,
"items": {
"title": "Reference",
"description": "Holds any reference to conferences, papers, advisories, and other resources that are related and considered related to either a surrounding part of or the entire document and to be of value to the document consumer.",
"type": "object",
"required": [
"summary",
"url"
],
"properties": {
"category": {
"title": "Category of reference",
"description": "Indicates whether the reference points to the same document or vulnerability in focus (depending on scope) or to an external resource.",
"type": "string",
"default": "external",
"enum": [
"external",
"self"
]
},
"summary": {
"title": "Summary of the reference",
"description": "Indicates what this reference refers to.",
"type": "string",
"minLength": 1
},
"url": {
"title": "URL of reference",
"description": "Provides the URL for the reference.",
"type": "string",
"format": "uri"
}
}
}
},
"version_t": {
"title": "Version",
"description": "Specifies a version string to denote clearly the evolution of the content of the document. Format must be either integer or semantic versioning.",
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$|^((0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)$",
"examples": [
"1",
"4",
"0.9.0",
"1.4.3",
"2.40.0+21AF26D3"
]
}
},
"required": [
"document"
],
"properties": {
"document": {
"title": "Document level meta-data",
"description": "Captures the meta-data about this document describing a particular set of security advisories.",
"type": "object",
"required": [
"category",
"csaf_version",
"publisher",
"title",
"tracking"
],
"properties": {
"acknowledgments": {
"title": "Document acknowledgments",
"description": "Contains a list of acknowledgment elements associated with the whole document.",
"$ref": "#/$defs/acknowledgments_t"
},
"aggregate_severity": {
"title": "Aggregate severity",
"description": "Is a vehicle that is provided by the document producer to convey the urgency and criticality with which the one or more vulnerabilities reported should be addressed. It is a document-level metric and applied to the document as a whole — not any specific vulnerability. The range of values in this field is defined according to the document producer's policies and procedures.",
"type": "object",
"required": [
"text"
],
"properties": {
"namespace": {
"title": "Namespace of aggregate severity",
"description": "Points to the namespace so referenced.",
"type": "string",
"format": "uri"
},
"text": {
"title": "Text of aggregate severity",
"description": "Provides a severity which is independent of - and in addition to - any other standard metric for determining the impact or severity of a given vulnerability (such as CVSS).",
"type": "string",
"minLength": 1,
"examples": [
"Critical",
"Important",
"Moderate"
]
}
}
},
"category": {
"title": "Document category",
"description": "Defines a short canonical name, chosen by the document producer, which will inform the end user as to the category of document.",
"type": "string",
"pattern": "^[^\\s\\-_\\.](.*[^\\s\\-_\\.])?$",
"minLength": 1,
"examples": [
"csaf_base",
"csaf_security_advisory",
"csaf_vex",
"Example Company Security Notice"
]
},
"csaf_version": {
"title": "CSAF version",
"description": "Gives the version of the CSAF specification which the document was generated for.",
"type": "string",
"enum": [
"2.0"
]
},
"distribution": {
"title": "Rules for sharing document",
"description": "Describe any constraints on how this document might be shared.",
"type": "object",
"minProperties": 1,
"properties": {
"text": {
"title": "Textual description",
"description": "Provides a textual description of additional constraints.",
"type": "string",
"minLength": 1,
"examples": [
"Copyright 2021, Example Company, All Rights Reserved.",
"Distribute freely.",
"Share only on a need-to-know-basis only."
]
},
"tlp": {
"title": "Traffic Light Protocol (TLP)",
"description": "Provides details about the TLP classification of the document.",
"type": "object",
"required": [
"label"
],
"properties": {
"label": {
"title": "Label of TLP",
"description": "Provides the TLP label of the document.",
"type": "string",
"enum": [
"AMBER",
"GREEN",
"RED",
"WHITE"
]
},
"url": {
"title": "URL of TLP version",
"description": "Provides a URL where to find the textual description of the TLP version which is used in this document. Default is the URL to the definition by FIRST.",
"type": "string",
"default": "https://www.first.org/tlp/",
"format": "uri",
"examples": [
"https://www.us-cert.gov/tlp",
"https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Kritis/Merkblatt_TLP.pdf"
]
}
}
}
}
},
"lang": {
"title": "Document language",
"description": "Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.",
"$ref": "#/$defs/lang_t"
},
"notes": {
"title": "Document notes",
"description": "Holds notes associated with the whole document.",
"$ref": "#/$defs/notes_t"
},
"publisher": {
"title": "Publisher",
"description": "Provides information about the publisher of the document.",
"type": "object",
"required": [
"category",
"name",
"namespace"
],
"properties": {
"category": {
"title": "Category of publisher",
"description": "Provides information about the category of publisher releasing the document.",
"type": "string",
"enum": [
"coordinator",
"discoverer",
"other",
"translator",
"user",
"vendor"
]
},
"contact_details": {
"title": "Contact details",
"description": "Information on how to contact the publisher, possibly including details such as web sites, email addresses, phone numbers, and postal mail addresses.",
"type": "string",
"minLength": 1,
"examples": [
"Example Company can be reached at contact_us@example.com, or via our website at https://www.example.com/contact."
]
},
"issuing_authority": {
"title": "Issuing authority",
"description": "Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.",
"type": "string",
"minLength": 1
},
"name": {
"title": "Name of publisher",
"description": "Contains the name of the issuing party.",
"type": "string",
"minLength": 1,
"examples": [
"BSI",
"Cisco PSIRT",
"Siemens ProductCERT"
]
},
"namespace": {
"title": "Namespace of publisher",
"description": "Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party.",
"type": "string",
"format": "uri",
"examples": [
"https://csaf.io",
"https://www.example.com"
]
}
}
},
"references": {
"title": "Document references",
"description": "Holds a list of references associated with the whole document.",
"$ref": "#/$defs/references_t"
},
"source_lang": {
"title": "Source language",
"description": "If this copy of the document is a translation then the value of this property describes from which language this document was translated.",
"$ref": "#/$defs/lang_t"
},
"title": {
"title": "Title of this document",
"description": "This SHOULD be a canonical name for the document, and sufficiently unique to distinguish it from similar documents.",
"type": "string",
"minLength": 1,
"examples": [
"Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
"Example Company Cross-Site-Scripting Vulnerability in Example Generator"
]
},
"tracking": {
"title": "Tracking",
"description": "Is a container designated to hold all management attributes necessary to track a CSAF document as a whole.",
"type": "object",
"required": [
"current_release_date",
"id",
"initial_release_date",
"revision_history",
"status",
"version"
],
"properties": {
"aliases": {
"title": "Aliases",
"description": "Contains a list of alternate names for the same document.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"title": "Alternate name",
"description": "Specifies a non-empty string that represents a distinct optional alternative ID used to refer to the document.",
"type": "string",
"minLength": 1,
"examples": [
"CVE-2019-12345"
]
}
},
"current_release_date": {
"title": "Current release date",
"description": "The date when the current revision of this document was released",
"type": "string",
"format": "date-time"
},
"generator": {
"title": "Document generator",
"description": "Is a container to hold all elements related to the generation of the document. These items will reference when the document was actually created, including the date it was generated and the entity that generated it.",
"type": "object",
"required": [
"engine"
],
"properties": {
"date": {
"title": "Date of document generation",
"description": "This SHOULD be the current date that the document was generated. Because documents are often generated internally by a document producer and exist for a nonzero amount of time before being released, this field MAY be different from the Initial Release Date and Current Release Date.",
"type": "string",
"format": "date-time"
},
"engine": {
"title": "Engine of document generation",
"description": "Contains information about the engine that generated the CSAF document.",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"title": "Engine name",
"description": "Represents the name of the engine that generated the CSAF document.",
"type": "string",
"minLength": 1,
"examples": [
"Red Hat rhsa-to-cvrf",
"Secvisogram",
"TVCE"
]
},
"version": {
"title": "Engine version",
"description": "Contains the version of the engine that generated the CSAF document.",
"type": "string",
"minLength": 1,
"examples": [
"0.6.0",
"1.0.0-beta+exp.sha.a1c44f85",
"2"
]
}
}
}
}
},
"id": {
"title": "Unique identifier for the document",
"description": "The ID is a simple label that provides for a wide range of numbering values, types, and schemes. Its value SHOULD be assigned and maintained by the original document issuing authority.",
"type": "string",
"pattern": "^[\\S](.*[\\S])?$",
"minLength": 1,
"examples": [
"Example Company - 2019-YH3234",
"RHBA-2019:0024",
"cisco-sa-20190513-secureboot"
]
},
"initial_release_date": {
"title": "Initial release date",
"description": "The date when this document was first published.",
"type": "string",
"format": "date-time"
},
"revision_history": {
"title": "Revision history",
"description": "Holds one revision item for each version of the CSAF document, including the initial one.",
"type": "array",
"minItems": 1,
"items": {
"title": "Revision",
"description": "Contains all the information elements required to track the evolution of a CSAF document.",
"type": "object",
"required": [
"date",
"number",
"summary"
],
"properties": {
"date": {
"title": "Date of the revision",
"description": "The date of the revision entry",
"type": "string",
"format": "date-time"
},
"legacy_version": {
"title": "Legacy version of the revision",
"description": "Contains the version string used in an existing document with the same content.",
"type": "string",
"minLength": 1
},
"number": {
"$ref": "#/$defs/version_t"
},
"summary": {
"title": "Summary of the revision",
"description": "Holds a single non-empty string representing a short description of the changes.",
"type": "string",
"minLength": 1,
"examples": [
"Initial version."
]
}
}
}
},
"status": {
"title": "Document status",
"description": "Defines the draft status of the document.",
"type": "string",
"enum": [
"draft",
"final",
"interim"
]
},
"version": {
"$ref": "#/$defs/version_t"
}
}
}
}
},
"product_tree": {
"title": "Product tree",
"description": "Is a container for all fully qualified product names that can be referenced elsewhere in the document.",
"type": "object",
"minProperties": 1,
"properties": {
"branches": {
"$ref": "#/$defs/branches_t"
},
"full_product_names": {
"title": "List of full product names",
"description": "Contains a list of full product names.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/$defs/full_product_name_t"
}
},
"product_groups": {
"title": "List of product groups",
"description": "Contains a list of product groups.",
"type": "array",
"minItems": 1,
"items": {
"title": "Product group",
"description": "Defines a new logical group of products that can then be referred to in other parts of the document to address a group of products with a single identifier.",
"type": "object",
"required": [
"group_id",
"product_ids"
],
"properties": {
"group_id": {
"$ref": "#/$defs/product_group_id_t"
},
"product_ids": {
"title": "List of Product IDs",
"description": "Lists the product_ids of those products which known as one group in the document.",
"type": "array",
"minItems": 2,
"uniqueItems": true,
"items": {
"$ref": "#/$defs/product_id_t"
}
},
"summary": {
"title": "Summary of the product group",
"description": "Gives a short, optional description of the group.",
"type": "string",
"minLength": 1,
"examples": [
"Products supporting Modbus.",
"The x64 versions of the operating system."
]
}
}
}
},
"relationships": {
"title": "List of relationships",
"description": "Contains a list of relationships.",
"type": "array",
"minItems": 1,
"items": {
"title": "Relationship",
"description": "Establishes a link between two existing full_product_name_t elements, allowing the document producer to define a combination of two products that form a new full_product_name entry.",
"type": "object",
"required": [
"category",
"full_product_name",
"product_reference",
"relates_to_product_reference"
],
"properties": {
"category": {
"title": "Relationship category",
"description": "Defines the category of relationship for the referenced component.",
"type": "string",
"enum": [
"default_component_of",
"external_component_of",
"installed_on",
"installed_with",
"optional_component_of"
]
},
"full_product_name": {
"$ref": "#/$defs/full_product_name_t"
},
"product_reference": {
"title": "Product reference",
"description": "Holds a Product ID that refers to the Full Product Name element, which is referenced as the first element of the relationship.",
"$ref": "#/$defs/product_id_t"
},
"relates_to_product_reference": {
"title": "Relates to product reference",
"description": "Holds a Product ID that refers to the Full Product Name element, which is referenced as the second element of the relationship.",
"$ref": "#/$defs/product_id_t"
}
}
}
}
}
},
"vulnerabilities": {
"title": "Vulnerabilities",
"description": "Represents a list of all relevant vulnerability information items.",
"type": "array",
"minItems": 1,
"items": {
"title": "Vulnerability",
"description": "Is a container for the aggregation of all fields that are related to a single vulnerability in the document.",
"type": "object",
"minProperties": 1,
"properties": {
"acknowledgments": {
"title": "Vulnerability acknowledgments",
"description": "Contains a list of acknowledgment elements associated with this vulnerability item.",
"$ref": "#/$defs/acknowledgments_t"
},
"cve": {
"title": "CVE",
"description": "Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability.",
"type": "string",
"pattern": "^CVE-[0-9]{4}-[0-9]{4,}$"
},
"cwe": {
"title": "CWE",
"description": "Holds the MITRE standard Common Weakness Enumeration (CWE) for the weakness associated.",
"type": "object",
"required": [
"id",
"name"
],
"properties": {