Skip to content

Commit 094130b

Browse files
committed
Add tea-collection external reference type
Adds a new type to reference a [TEA Collection object](https://github.com/CycloneDX/transparency-exchange-api/blob/main/tea-collection/tea-collection.md). A Transparency Exchange API Collection for the most part is a replacement of the `externalReferences` object, but provides a **versioned** and modifiable view of all security-related documents for a given CycloneDX Component. Signed-off-by: Piotr P. Karwasz <[email protected]>
1 parent cb2a539 commit 094130b

File tree

6 files changed

+18
-0
lines changed

6 files changed

+18
-0
lines changed

schema/bom-1.7.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,8 @@ enum ExternalReferenceType {
320320
EXTERNAL_REFERENCE_TYPE_RFC_9116 = 41;
321321
// Reference to release notes
322322
EXTERNAL_REFERENCE_TYPE_RELEASE_NOTES = 42;
323+
// The URL to the latest TEA Collection on a Transparency Exchange API server.
324+
EXTERNAL_REFERENCE_TYPE_TEA_COLLECTION = 43;
323325
}
324326

325327
enum HashAlg {

schema/bom-1.7.schema.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1805,6 +1805,7 @@
18051805
"electronic-signature",
18061806
"digital-signature",
18071807
"rfc-9116",
1808+
"tea-collection",
18081809
"other"
18091810
],
18101811
"meta:enum": {
@@ -1850,6 +1851,7 @@
18501851
"electronic-signature": "An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.",
18511852
"digital-signature": "A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.",
18521853
"rfc-9116": "Document that complies with [RFC 9116](https://www.ietf.org/rfc/rfc9116.html) (A File Format to Aid in Security Vulnerability Disclosure)",
1854+
"tea-collection": "The URL to the latest TEA Collection on a Transparency Exchange API server.",
18531855
"other": "Use this if no other types accurately describe the purpose of the external reference."
18541856
}
18551857
},

schema/bom-1.7.xsd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1578,6 +1578,11 @@ limitations under the License.
15781578
<xs:documentation>Document that complies with RFC-9116 (A File Format to Aid in Security Vulnerability Disclosure)</xs:documentation>
15791579
</xs:annotation>
15801580
</xs:enumeration>
1581+
<xs:enumeration value="tea-collection">
1582+
<xs:annotation>
1583+
<xs:documentation>The URL to the latest TEA Collection on a Transparency Exchange API server.</xs:documentation>
1584+
</xs:annotation>
1585+
</xs:enumeration>
15811586
<xs:enumeration value="other">
15821587
<xs:annotation>
15831588
<xs:documentation>Use this if no other types accurately describe the purpose of the external reference</xs:documentation>

tools/src/test/resources/1.7/valid-external-reference-1.7.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,10 @@
208208
"type": "rfc-9116",
209209
"url": "http://example.com/extref/rfc-9116"
210210
},
211+
{
212+
"type": "tea-collection",
213+
"url": "https://example.com/tea/v1/release/3f92c28c-13c9-4e32-8d5b-5f8ae77ef265/collection"
214+
},
211215
{
212216
"type": "other",
213217
"url": "http://example.com/extref/other"

tools/src/test/resources/1.7/valid-external-reference-1.7.textproto

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,10 @@ components {
202202
type: EXTERNAL_REFERENCE_TYPE_RFC_9116
203203
url: "http://example.com/extref/rfc-9116"
204204
}
205+
external_references {
206+
type: EXTERNAL_REFERENCE_TYPE_TEA_COLLECTION
207+
url: "https://example.com/tea/v1/release/3f92c28c-13c9-4e32-8d5b-5f8ae77ef265/collection"
208+
}
205209
external_references {
206210
type: EXTERNAL_REFERENCE_TYPE_OTHER
207211
url: "http://example.com/extref/other"

tools/src/test/resources/1.7/valid-external-reference-1.7.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
<reference type="electronic-signature"><url>http://example.com/extref/electronic-signature</url></reference>
7171
<reference type="digital-signature"><url>http://example.com/extref/digital-signature</url></reference>
7272
<reference type="rfc-9116"><url>http://example.com/extref/rfc-9116</url></reference>
73+
<reference type="tea-collection"><url>https://example.com/tea/v1/release/3f92c28c-13c9-4e32-8d5b-5f8ae77ef265/collection</url></reference>
7374
<reference type="other"><url>http://example.com/extref/other</url></reference>
7475
</externalReferences>
7576
</component>

0 commit comments

Comments
 (0)