-
-
Notifications
You must be signed in to change notification settings - Fork 57
/
bom-1.4.schema.json
1697 lines (1695 loc) · 70.6 KB
/
bom-1.4.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": "http://json-schema.org/draft-07/schema#",
"$id": "http://cyclonedx.org/schema/bom-1.4.schema.json",
"type": "object",
"title": "CycloneDX Software Bill of Materials Standard",
"$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
"required": [
"bomFormat",
"specVersion",
"version"
],
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string",
"enum": [
"http://cyclonedx.org/schema/bom-1.4.schema.json"
]
},
"bomFormat": {
"type": "string",
"title": "BOM Format",
"description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces. This value MUST be \"CycloneDX\".",
"enum": [
"CycloneDX"
]
},
"specVersion": {
"type": "string",
"title": "CycloneDX Specification Version",
"description": "The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).",
"examples": ["1.4"]
},
"serialNumber": {
"type": "string",
"title": "BOM Serial Number",
"description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. Use of serial numbers are RECOMMENDED.",
"examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"version": {
"type": "integer",
"title": "BOM Version",
"description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.",
"default": 1,
"examples": [1]
},
"metadata": {
"$ref": "#/definitions/metadata",
"title": "BOM Metadata",
"description": "Provides additional information about a BOM."
},
"components": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/component"},
"uniqueItems": true,
"title": "Components",
"description": "A list of software and hardware components."
},
"services": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/service"},
"uniqueItems": true,
"title": "Services",
"description": "A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services."
},
"externalReferences": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/externalReference"},
"title": "External References",
"description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
},
"dependencies": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/dependency"},
"uniqueItems": true,
"title": "Dependencies",
"description": "Provides the ability to document dependency relationships."
},
"compositions": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/compositions"},
"uniqueItems": true,
"title": "Compositions",
"description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness."
},
"vulnerabilities": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/vulnerability"},
"uniqueItems": true,
"title": "Vulnerabilities",
"description": "Vulnerabilities identified in components or services."
},
"signature": {
"$ref": "#/definitions/signature",
"title": "Signature",
"description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
}
},
"definitions": {
"refType": {
"$comment": "Identifier-DataType for interlinked elements.",
"type": "string"
},
"metadata": {
"type": "object",
"title": "BOM Metadata Object",
"additionalProperties": false,
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The date and time (timestamp) when the BOM was created."
},
"tools": {
"type": "array",
"title": "Creation Tools",
"description": "The tool(s) used in the creation of the BOM.",
"additionalItems": false,
"items": {"$ref": "#/definitions/tool"}
},
"authors" :{
"type": "array",
"title": "Authors",
"description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
"additionalItems": false,
"items": {"$ref": "#/definitions/organizationalContact"}
},
"component": {
"title": "Component",
"description": "The component that the BOM describes.",
"$ref": "#/definitions/component"
},
"manufacture": {
"title": "Manufacture",
"description": "The organization that manufactured the component that the BOM describes.",
"$ref": "#/definitions/organizationalEntity"
},
"supplier": {
"title": "Supplier",
"description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
"$ref": "#/definitions/organizationalEntity"
},
"licenses": {
"type": "array",
"title": "BOM License(s)",
"additionalItems": false,
"items": {"$ref": "#/definitions/licenseChoice"}
},
"properties": {
"type": "array",
"title": "Properties",
"description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
"additionalItems": false,
"items": {"$ref": "#/definitions/property"}
}
}
},
"tool": {
"type": "object",
"title": "Tool",
"description": "Information about the automated or manual tool used",
"additionalProperties": false,
"properties": {
"vendor": {
"type": "string",
"title": "Tool Vendor",
"description": "The name of the vendor who created the tool"
},
"name": {
"type": "string",
"title": "Tool Name",
"description": "The name of the tool"
},
"version": {
"type": "string",
"title": "Tool Version",
"description": "The version of the tool"
},
"hashes": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/hash"},
"title": "Hashes",
"description": "The hashes of the tool (if applicable)."
},
"externalReferences": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/externalReference"},
"title": "External References",
"description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
}
}
},
"organizationalEntity": {
"type": "object",
"title": "Organizational Entity Object",
"description": "",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the organization",
"examples": [
"Example Inc."
]
},
"url": {
"type": "array",
"items": {
"type": "string",
"format": "iri-reference"
},
"title": "URL",
"description": "The URL of the organization. Multiple URLs are allowed.",
"examples": ["https://example.com"]
},
"contact": {
"type": "array",
"title": "Contact",
"description": "A contact at the organization. Multiple contacts are allowed.",
"additionalItems": false,
"items": {"$ref": "#/definitions/organizationalContact"}
}
}
},
"organizationalContact": {
"type": "object",
"title": "Organizational Contact Object",
"description": "",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of a contact",
"examples": ["Contact name"]
},
"email": {
"type": "string",
"format": "idn-email",
"title": "Email Address",
"description": "The email address of the contact.",
"examples": ["firstname.lastname@example.com"]
},
"phone": {
"type": "string",
"title": "Phone",
"description": "The phone number of the contact.",
"examples": ["800-555-1212"]
}
}
},
"component": {
"type": "object",
"title": "Component Object",
"required": [
"type",
"name"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"application",
"framework",
"library",
"container",
"operating-system",
"device",
"firmware",
"file"
],
"title": "Component Type",
"description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component. Types include:\n\n* __application__ = A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.\n* __framework__ = A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.\n* __library__ = A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing))\n for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is RECOMMENDED.\n* __container__ = A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization)\n* __operating-system__ = A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system)\n* __device__ = A hardware device such as a processor, or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself, and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device.\n* __firmware__ = A special type of software that provides low-level control over a devices hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware)\n* __file__ = A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.",
"examples": ["library"]
},
"mime-type": {
"type": "string",
"title": "Mime-Type",
"description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
"examples": ["image/jpeg"],
"pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
},
"bom-ref": {
"$ref": "#/definitions/refType",
"title": "BOM Reference",
"description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
},
"supplier": {
"title": "Component Supplier",
"description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
"$ref": "#/definitions/organizationalEntity"
},
"author": {
"type": "string",
"title": "Component Author",
"description": "The person(s) or organization(s) that authored the component",
"examples": ["Acme Inc"]
},
"publisher": {
"type": "string",
"title": "Component Publisher",
"description": "The person(s) or organization(s) that published the component",
"examples": ["Acme Inc"]
},
"group": {
"type": "string",
"title": "Component Group",
"description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
"examples": ["com.acme"]
},
"name": {
"type": "string",
"title": "Component Name",
"description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
"examples": ["tomcat-catalina"]
},
"version": {
"type": "string",
"title": "Component Version",
"description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
"examples": ["9.0.14"]
},
"description": {
"type": "string",
"title": "Component Description",
"description": "Specifies a description for the component"
},
"scope": {
"type": "string",
"enum": [
"required",
"optional",
"excluded"
],
"title": "Component Scope",
"description": "Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.",
"default": "required"
},
"hashes": {
"type": "array",
"title": "Component Hashes",
"additionalItems": false,
"items": {"$ref": "#/definitions/hash"}
},
"licenses": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/licenseChoice"},
"title": "Component License(s)"
},
"copyright": {
"type": "string",
"title": "Component Copyright",
"description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.",
"examples": ["Acme Inc"]
},
"cpe": {
"type": "string",
"title": "Component Common Platform Enumeration (CPE)",
"description": "Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe)",
"examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
},
"purl": {
"type": "string",
"title": "Component Package URL (purl)",
"description": "Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec)",
"examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"]
},
"swid": {
"$ref": "#/definitions/swid",
"title": "SWID Tag",
"description": "Specifies metadata and content for [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html)."
},
"modified": {
"type": "boolean",
"title": "Component Modified From Original",
"description": "[Deprecated] - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
},
"pedigree": {
"type": "object",
"title": "Component Pedigree",
"description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
"additionalProperties": false,
"properties": {
"ancestors": {
"type": "array",
"title": "Ancestors",
"description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
"additionalItems": false,
"items": {"$ref": "#/definitions/component"}
},
"descendants": {
"type": "array",
"title": "Descendants",
"description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
"additionalItems": false,
"items": {"$ref": "#/definitions/component"}
},
"variants": {
"type": "array",
"title": "Variants",
"description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
"additionalItems": false,
"items": {"$ref": "#/definitions/component"}
},
"commits": {
"type": "array",
"title": "Commits",
"description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
"additionalItems": false,
"items": {"$ref": "#/definitions/commit"}
},
"patches": {
"type": "array",
"title": "Patches",
"description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
"additionalItems": false,
"items": {"$ref": "#/definitions/patch"}
},
"notes": {
"type": "string",
"title": "Notes",
"description": "Notes, observations, and other non-structured commentary describing the components pedigree."
}
}
},
"externalReferences": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/externalReference"},
"title": "External References",
"description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
},
"components": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/component"},
"uniqueItems": true,
"title": "Components",
"description": "A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains."
},
"evidence": {
"$ref": "#/definitions/componentEvidence",
"title": "Evidence",
"description": "Provides the ability to document evidence collected through various forms of extraction or analysis."
},
"releaseNotes": {
"$ref": "#/definitions/releaseNotes",
"title": "Release notes",
"description": "Specifies optional release notes."
},
"properties": {
"type": "array",
"title": "Properties",
"description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
"additionalItems": false,
"items": {"$ref": "#/definitions/property"}
},
"signature": {
"$ref": "#/definitions/signature",
"title": "Signature",
"description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
}
}
},
"swid": {
"type": "object",
"title": "SWID Tag",
"description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
"required": [
"tagId",
"name"
],
"additionalProperties": false,
"properties": {
"tagId": {
"type": "string",
"title": "Tag ID",
"description": "Maps to the tagId of a SoftwareIdentity."
},
"name": {
"type": "string",
"title": "Name",
"description": "Maps to the name of a SoftwareIdentity."
},
"version": {
"type": "string",
"title": "Version",
"default": "0.0",
"description": "Maps to the version of a SoftwareIdentity."
},
"tagVersion": {
"type": "integer",
"title": "Tag Version",
"default": 0,
"description": "Maps to the tagVersion of a SoftwareIdentity."
},
"patch": {
"type": "boolean",
"title": "Patch",
"default": false,
"description": "Maps to the patch of a SoftwareIdentity."
},
"text": {
"title": "Attachment text",
"description": "Specifies the metadata and content of the SWID tag.",
"$ref": "#/definitions/attachment"
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL to the SWID file.",
"format": "iri-reference"
}
}
},
"attachment": {
"type": "object",
"title": "Attachment",
"description": "Specifies the metadata and content for an attachment.",
"required": [
"content"
],
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string",
"title": "Content-Type",
"description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
"default": "text/plain"
},
"encoding": {
"type": "string",
"title": "Encoding",
"description": "Specifies the optional encoding the text is represented in.",
"enum": [
"base64"
]
},
"content": {
"type": "string",
"title": "Attachment Text",
"description": "The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text."
}
}
},
"hash": {
"type": "object",
"title": "Hash Objects",
"required": [
"alg",
"content"
],
"additionalProperties": false,
"properties": {
"alg": {
"$ref": "#/definitions/hash-alg"
},
"content": {
"$ref": "#/definitions/hash-content"
}
}
},
"hash-alg": {
"type": "string",
"enum": [
"MD5",
"SHA-1",
"SHA-256",
"SHA-384",
"SHA-512",
"SHA3-256",
"SHA3-384",
"SHA3-512",
"BLAKE2b-256",
"BLAKE2b-384",
"BLAKE2b-512",
"BLAKE3"
],
"title": "Hash Algorithm"
},
"hash-content": {
"type": "string",
"title": "Hash Content (value)",
"examples": ["3942447fac867ae5cdb3229b658f4d48"],
"pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
},
"license": {
"type": "object",
"title": "License Object",
"oneOf": [
{
"required": ["id"]
},
{
"required": ["name"]
}
],
"additionalProperties": false,
"properties": {
"id": {
"$ref": "spdx.schema.json",
"title": "License ID (SPDX)",
"description": "A valid SPDX license ID",
"examples": ["Apache-2.0"]
},
"name": {
"type": "string",
"title": "License Name",
"description": "If SPDX does not define the license used, this field may be used to provide the license name",
"examples": ["Acme Software License"]
},
"text": {
"title": "License text",
"description": "An optional way to include the textual content of a license.",
"$ref": "#/definitions/attachment"
},
"url": {
"type": "string",
"title": "License URL",
"description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
"examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
"format": "iri-reference"
}
}
},
"licenseChoice": {
"type": "object",
"title": "License(s)",
"additionalProperties": false,
"properties": {
"license": {
"$ref": "#/definitions/license"
},
"expression": {
"type": "string",
"title": "SPDX License Expression",
"examples": [
"Apache-2.0 AND (MIT OR GPL-2.0-only)",
"GPL-3.0-only WITH Classpath-exception-2.0"
]
}
},
"oneOf":[
{
"required": ["license"]
},
{
"required": ["expression"]
}
]
},
"commit": {
"type": "object",
"title": "Commit",
"description": "Specifies an individual commit",
"additionalProperties": false,
"properties": {
"uid": {
"type": "string",
"title": "UID",
"description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
"format": "iri-reference"
},
"author": {
"title": "Author",
"description": "The author who created the changes in the commit",
"$ref": "#/definitions/identifiableAction"
},
"committer": {
"title": "Committer",
"description": "The person who committed or pushed the commit",
"$ref": "#/definitions/identifiableAction"
},
"message": {
"type": "string",
"title": "Message",
"description": "The text description of the contents of the commit"
}
}
},
"patch": {
"type": "object",
"title": "Patch",
"description": "Specifies an individual patch",
"required": [
"type"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"unofficial",
"monkey",
"backport",
"cherry-pick"
],
"title": "Type",
"description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.\n\n* __unofficial__ = A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch)\n* __monkey__ = A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch)\n* __backport__ = A patch which takes code from a newer version of software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting)\n* __cherry-pick__ = A patch created by selectively applying commits from other versions or branches of the same software."
},
"diff": {
"title": "Diff",
"description": "The patch file (or diff) that show changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)",
"$ref": "#/definitions/diff"
},
"resolves": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/issue"},
"title": "Resolves",
"description": "A collection of issues the patch resolves"
}
}
},
"diff": {
"type": "object",
"title": "Diff",
"description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
"additionalProperties": false,
"properties": {
"text": {
"title": "Diff text",
"description": "Specifies the optional text of the diff",
"$ref": "#/definitions/attachment"
},
"url": {
"type": "string",
"title": "URL",
"description": "Specifies the URL to the diff",
"format": "iri-reference"
}
}
},
"issue": {
"type": "object",
"title": "Diff",
"description": "An individual issue that has been resolved.",
"required": [
"type"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"defect",
"enhancement",
"security"
],
"title": "Type",
"description": "Specifies the type of issue"
},
"id": {
"type": "string",
"title": "ID",
"description": "The identifier of the issue assigned by the source of the issue"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the issue"
},
"description": {
"type": "string",
"title": "Description",
"description": "A description of the issue"
},
"source": {
"type": "object",
"title": "Source",
"description": "The source of the issue where it is documented",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'"
},
"url": {
"type": "string",
"title": "URL",
"description": "The url of the issue documentation as provided by the source",
"format": "iri-reference"
}
}
},
"references": {
"type": "array",
"items": {
"type": "string",
"format": "iri-reference"
},
"title": "References",
"description": "A collection of URL's for reference. Multiple URLs are allowed.",
"examples": ["https://example.com"]
}
}
},
"identifiableAction": {
"type": "object",
"title": "Identifiable Action",
"description": "Specifies an individual commit",
"additionalProperties": false,
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The timestamp in which the action occurred"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the individual who performed the action"
},
"email": {
"type": "string",
"format": "idn-email",
"title": "E-mail",
"description": "The email address of the individual who performed the action"
}
}
},
"externalReference": {
"type": "object",
"title": "External Reference",
"description": "Specifies an individual external reference",
"required": [
"url",
"type"
],
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "The URL to the external reference",
"format": "iri-reference"
},
"comment": {
"type": "string",
"title": "Comment",
"description": "An optional comment describing the external reference"
},
"type": {
"type": "string",
"title": "Type",
"description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.",
"enum": [
"vcs",
"issue-tracker",
"website",
"advisories",
"bom",
"mailing-list",
"social",
"chat",
"documentation",
"support",
"distribution",
"license",
"build-meta",
"build-system",
"release-notes",
"other"
]
},
"hashes": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/hash"},
"title": "Hashes",
"description": "The hashes of the external reference (if applicable)."
}
}
},
"dependency": {
"type": "object",
"title": "Dependency",
"description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.",
"required": [
"ref"
],
"additionalProperties": false,
"properties": {
"ref": {
"$ref": "#/definitions/refType",
"title": "Reference",
"description": "References a component by the components bom-ref attribute"
},
"dependsOn": {
"type": "array",
"uniqueItems": true,
"additionalItems": false,
"items": {
"$ref": "#/definitions/refType"
},
"title": "Depends On",
"description": "The bom-ref identifiers of the components that are dependencies of this dependency object."
}
}
},
"service": {
"type": "object",
"title": "Service Object",
"required": [
"name"
],
"additionalProperties": false,
"properties": {
"bom-ref": {
"$ref": "#/definitions/refType",
"title": "BOM Reference",
"description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
},
"provider": {
"title": "Provider",
"description": "The organization that provides the service.",
"$ref": "#/definitions/organizationalEntity"
},
"group": {
"type": "string",
"title": "Service Group",
"description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
"examples": ["com.acme"]
},
"name": {
"type": "string",
"title": "Service Name",
"description": "The name of the service. This will often be a shortened, single name of the service.",
"examples": ["ticker-service"]
},
"version": {
"type": "string",
"title": "Service Version",
"description": "The service version.",
"examples": ["1.0.0"]
},
"description": {
"type": "string",
"title": "Service Description",
"description": "Specifies a description for the service"
},
"endpoints": {
"type": "array",
"items": {
"type": "string",
"format": "iri-reference"
},
"title": "Endpoints",
"description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
"examples": ["https://example.com/api/v1/ticker"]
},
"authenticated": {
"type": "boolean",
"title": "Authentication Required",
"description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
},
"x-trust-boundary": {
"type": "boolean",
"title": "Crosses Trust Boundary",
"description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
},
"data": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/dataClassification"},
"title": "Data Classification",
"description": "Specifies the data classification."
},
"licenses": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/licenseChoice"},
"title": "Component License(s)"
},
"externalReferences": {
"type": "array",
"additionalItems": false,
"items": {"$ref": "#/definitions/externalReference"},
"title": "External References",
"description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."