Skip to content

Commit cdcd201

Browse files
authored
Merge branch 'v1.5-dev' into v1.5-explicit-bomlink
2 parents 4965ffc + 8b43f29 commit cdcd201

9 files changed

+51
-5
lines changed

schema/bom-1.5.proto

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,8 @@ enum ExternalReferenceType {
251251
EXTERNAL_REFERENCE_TYPE_CODIFIED_INFRASTRUCTURE = 31;
252252
// A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency.
253253
EXTERNAL_REFERENCE_TYPE_MODEL_CARD = 32;
254+
// Plans of Action and Milestones (POAM) compliment an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".
255+
EXTERNAL_REFERENCE_TYPE_POAM = 33;
254256
}
255257

256258
enum HashAlg {
@@ -461,6 +463,8 @@ message OrganizationalContact {
461463
optional string email = 2;
462464
// The phone number of the contact.
463465
optional string phone = 3;
466+
// An optional identifier which can be used to reference the object elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
467+
optional string bom_ref = 4;
464468
}
465469

466470
message OrganizationalEntity {
@@ -470,6 +474,8 @@ message OrganizationalEntity {
470474
repeated string url = 2;
471475
// A contact person at the organization. Multiple contacts are allowed.
472476
repeated OrganizationalContact contact = 3;
477+
// An optional identifier which can be used to reference the object elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
478+
optional string bom_ref = 4;
473479
}
474480

475481
enum PatchClassification {

schema/bom-1.5.schema.json

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,11 @@
312312
"description": "",
313313
"additionalProperties": false,
314314
"properties": {
315+
"bom-ref": {
316+
"$ref": "#/definitions/refType",
317+
"title": "BOM Reference",
318+
"description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
319+
},
315320
"name": {
316321
"type": "string",
317322
"title": "Name",
@@ -344,6 +349,11 @@
344349
"description": "",
345350
"additionalProperties": false,
346351
"properties": {
352+
"bom-ref": {
353+
"$ref": "#/definitions/refType",
354+
"title": "BOM Reference",
355+
"description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
356+
},
347357
"name": {
348358
"type": "string",
349359
"title": "Name",
@@ -1138,7 +1148,7 @@
11381148
"type": {
11391149
"type": "string",
11401150
"title": "Type",
1141-
"description": "Specifies the type of external reference.\n\n* __vcs__ = Version Control System\n* __issue-tracker__ = Issue or defect tracking system, or an Application Lifecycle Management (ALM) system\n* __website__ = Website\n* __advisories__ = Security advisories\n* __bom__ = Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc)\n* __mailing-list__ = Mailing list or discussion group\n* __social__ = Social media account\n* __chat__ = Real-time chat platform\n* __documentation__ = Documentation, guides, or how-to instructions\n* __support__ = Community or commercial support\n* __distribution__ = Direct or repository download location\n* __distribution-intake__ = The location where a component was published to. This is often the same as \"distribution\" but may also include specialized publishing processes that act as an intermediary\n* __license__ = The URL to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness\n* __build-meta__ = Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)\n* __build-system__ = URL to an automated build system\n* __release-notes__ = URL to release notes\n* __security-contact__ = Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501]) that specifies the records containing DNS Security TXT\n* __model-card__ = A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets \n* __attestation__ = Human or machine-readable statements containing facts, evidence, or testimony\n* __threat-model__ = An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format\n* __adversary-model__ = The defined assumptions, goals, and capabilities of an adversary.\n* __risk-assessment__ = Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.\n* __vulnerability-assertion__ = A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.\n* __exploitability-statement__ = A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.\n* __pentest-report__ = Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test\n* __static-analysis-report__ = SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code\n* __dynamic-analysis-report__ = Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations\n* __runtime-analysis-report__ = Report generated by analyzing the call stack of a running application\n* __component-analysis-report__ = Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis\n* __maturity-report__ = Report containing a formal assessment of an organization, business unit, or team against a maturity model\n* __certification-report__ = Industry, regulatory, or other certification from an accredited (if applicable) certification body\n* __quality-metrics__ = Report or system in which quality metrics can be obtained\n* __codified-infrastructure__ = Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)\n* __other__ = Use this if no other types accurately describe the purpose of the external reference",
1151+
"description": "Specifies the type of external reference.\n\n* __vcs__ = Version Control System\n* __issue-tracker__ = Issue or defect tracking system, or an Application Lifecycle Management (ALM) system\n* __website__ = Website\n* __advisories__ = Security advisories\n* __bom__ = Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc)\n* __mailing-list__ = Mailing list or discussion group\n* __social__ = Social media account\n* __chat__ = Real-time chat platform\n* __documentation__ = Documentation, guides, or how-to instructions\n* __support__ = Community or commercial support\n* __distribution__ = Direct or repository download location\n* __distribution-intake__ = The location where a component was published to. This is often the same as \"distribution\" but may also include specialized publishing processes that act as an intermediary\n* __license__ = The URL to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness\n* __build-meta__ = Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)\n* __build-system__ = URL to an automated build system\n* __release-notes__ = URL to release notes\n* __security-contact__ = Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501]) that specifies the records containing DNS Security TXT\n* __model-card__ = A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets \n* __attestation__ = Human or machine-readable statements containing facts, evidence, or testimony\n* __threat-model__ = An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format\n* __adversary-model__ = The defined assumptions, goals, and capabilities of an adversary.\n* __risk-assessment__ = Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.\n* __vulnerability-assertion__ = A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.\n* __exploitability-statement__ = A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.\n* __pentest-report__ = Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test\n* __static-analysis-report__ = SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code\n* __dynamic-analysis-report__ = Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations\n* __runtime-analysis-report__ = Report generated by analyzing the call stack of a running application\n* __component-analysis-report__ = Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis\n* __maturity-report__ = Report containing a formal assessment of an organization, business unit, or team against a maturity model\n* __certification-report__ = Industry, regulatory, or other certification from an accredited (if applicable) certification body\n* __quality-metrics__ = Report or system in which quality metrics can be obtained\n* __codified-infrastructure__ = Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)\n* __poam__ = Plans of Action and Milestones (POAM) compliment an \"attestation\" external reference. POAM is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".* __other__ = Use this if no other types accurately describe the purpose of the external reference",
11421152
"enum": [
11431153
"vcs",
11441154
"issue-tracker",
@@ -1173,6 +1183,7 @@
11731183
"certification-report",
11741184
"codified-infrastructure",
11751185
"quality-metrics",
1186+
"poam",
11761187
"other"
11771188
]
11781189
},

schema/bom-1.5.xsd

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,14 @@ limitations under the License.
307307
</xs:annotation>
308308
</xs:any>
309309
</xs:sequence>
310+
<xs:attribute name="bom-ref" type="bom:refType">
311+
<xs:annotation>
312+
<xs:documentation>
313+
An optional identifier which can be used to reference the object elsewhere in the BOM.
314+
Uniqueness is enforced within all elements and children of the root-level bom element.
315+
</xs:documentation>
316+
</xs:annotation>
317+
</xs:attribute>
310318
<xs:anyAttribute namespace="##other" processContents="lax">
311319
<xs:annotation>
312320
<xs:documentation>User-defined attributes may be used on this element as long as they
@@ -388,6 +396,14 @@ limitations under the License.
388396
</xs:annotation>
389397
</xs:any>
390398
</xs:sequence>
399+
<xs:attribute name="bom-ref" type="bom:refType">
400+
<xs:annotation>
401+
<xs:documentation>
402+
An optional identifier which can be used to reference the object elsewhere in the BOM.
403+
Uniqueness is enforced within all elements and children of the root-level bom element.
404+
</xs:documentation>
405+
</xs:annotation>
406+
</xs:attribute>
391407
<xs:anyAttribute namespace="##other" processContents="lax">
392408
<xs:annotation>
393409
<xs:documentation>User-defined attributes may be used on this element as long as they
@@ -1324,6 +1340,11 @@ limitations under the License.
13241340
<xs:documentation>Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)</xs:documentation>
13251341
</xs:annotation>
13261342
</xs:enumeration>
1343+
<xs:enumeration value="poam">
1344+
<xs:annotation>
1345+
<xs:documentation>Plans of Action and Milestones (POAM) compliment an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".</xs:documentation>
1346+
</xs:annotation>
1347+
</xs:enumeration>
13271348
<xs:enumeration value="other">
13281349
<xs:annotation>
13291350
<xs:documentation>Use this if no other types accurately describe the purpose of the external reference</xs:documentation>

tools/src/test/resources/1.5/valid-metadata-manufacture-1.5.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55
"version": 1,
66
"metadata": {
77
"manufacture": {
8+
"bom-ref": "manufacturer-1",
89
"name": "Acme, Inc.",
910
"url": [
1011
"https://example.com"
1112
],
1213
"contact": [
1314
{
15+
"bom-ref": "contact-1",
1416
"name": "Acme Professional Services",
1517
"email": "[email protected]"
1618
}

tools/src/test/resources/1.5/valid-metadata-manufacture-1.5.textproto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ metadata {
88
contact {
99
name: "Acme Professional Services"
1010
11+
bom_ref: "contact-1"
1112
}
13+
bom_ref: "manufacturer-1"
1214
}
1315
}

tools/src/test/resources/1.5/valid-metadata-manufacture-1.5.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?xml version="1.0"?>
22
<bom serialNumber="urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79" version="1" xmlns="http://cyclonedx.org/schema/bom/1.5">
33
<metadata>
4-
<manufacture>
4+
<manufacture bom-ref="manufacturer-1">
55
<name>Acme, Inc.</name>
66
<url>https://example.com</url>
7-
<contact>
7+
<contact bom-ref="contact-1">
88
<name>Acme Professional Services</name>
99
<email>[email protected]</email>
1010
</contact>

tools/src/test/resources/1.5/valid-metadata-supplier-1.5.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55
"version": 1,
66
"metadata": {
77
"supplier": {
8+
"bom-ref": "supplier-1",
89
"name": "Acme, Inc.",
910
"url": [
1011
"https://example.com"
1112
],
1213
"contact": [
1314
{
15+
"bom-ref": "contact-1",
1416
"name": "Acme Distribution",
1517
"email": "[email protected]"
1618
}

tools/src/test/resources/1.5/valid-metadata-supplier-1.5.textproto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ metadata {
88
contact {
99
name: "Acme Distribution"
1010
11+
bom_ref: "contact-1"
1112
}
13+
bom_ref: "supplier-1"
1214
}
1315
}

tools/src/test/resources/1.5/valid-metadata-supplier-1.5.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?xml version="1.0"?>
22
<bom serialNumber="urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79" version="1" xmlns="http://cyclonedx.org/schema/bom/1.5">
33
<metadata>
4-
<supplier>
4+
<supplier bom-ref="supplier-1">
55
<name>Acme, Inc.</name>
66
<url>https://example.com</url>
7-
<contact>
7+
<contact bom-ref="contact-1">
88
<name>Acme Distribution</name>
99
<email>[email protected]</email>
1010
</contact>

0 commit comments

Comments
 (0)