Skip to content

Commit df13e27

Browse files
Merge pull request #189 from CycloneDX/v1.5-dev-external-references
Added additional external references
2 parents 5a579c6 + 3a61993 commit df13e27

File tree

3 files changed

+113
-1
lines changed

3 files changed

+113
-1
lines changed

schema/bom-1.5.proto

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,34 @@ enum ExternalReferenceType {
195195
EXTERNAL_REFERENCE_TYPE_BUILD_SYSTEM = 14;
196196
// 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.
197197
EXTERNAL_REFERENCE_TYPE_SECURITY_CONTACT = 15;
198+
// Human or machine-readable statements containing facts, evidence, or testimony
199+
EXTERNAL_REFERENCE_TYPE_ATTESTATION = 16;
200+
// An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format
201+
EXTERNAL_REFERENCE_TYPE_THREAT_MODEL = 17;
202+
// 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
203+
EXTERNAL_REFERENCE_TYPE_DISTRIBUTION_INTAKE = 18;
204+
// 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
205+
EXTERNAL_REFERENCE_TYPE_VULNERABILITY_ASSERTION = 19;
206+
// 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
207+
EXTERNAL_REFERENCE_TYPE_EXPLOITABILITY_STATEMENT = 20;
208+
// Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test
209+
EXTERNAL_REFERENCE_TYPE_PENTEST_REPORT = 21;
210+
// 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
211+
EXTERNAL_REFERENCE_TYPE_STATIC_ANALYSIS_REPORT = 22;
212+
// Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations
213+
EXTERNAL_REFERENCE_TYPE_DYNAMIC_ANALYSIS_REPORT = 23;
214+
// Report generated by analyzing the call stack of a running application
215+
EXTERNAL_REFERENCE_TYPE_RUNTIME_ANALYSIS_REPORT = 24;
216+
// Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis
217+
EXTERNAL_REFERENCE_TYPE_COMPONENT_ANALYSIS_REPORT = 25;
218+
// Report containing a formal assessment of an organization, business unit, or team against a maturity model
219+
EXTERNAL_REFERENCE_TYPE_MATURITY_REPORT = 26;
220+
// Industry, regulatory, or other certification from an accredited (if applicable) certification body
221+
EXTERNAL_REFERENCE_TYPE_CERTIFICATION_REPORT = 27;
222+
// Report or system in which quality metrics can be obtained
223+
EXTERNAL_REFERENCE_TYPE_QUALITY_METRICS = 28;
224+
// Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)
225+
EXTERNAL_REFERENCE_TYPE_CODIFIED_INFRASTRUCTURE = 29;
198226
}
199227

200228
enum HashAlg {

schema/bom-1.5.schema.json

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1028,7 +1028,7 @@
10281028
"type": {
10291029
"type": "string",
10301030
"title": "Type",
1031-
"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* __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* __other__ = Use this if no other types accurately describe the purpose of the external reference",
1031+
"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* __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* __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",
10321032
"enum": [
10331033
"vcs",
10341034
"issue-tracker",
@@ -1041,11 +1041,25 @@
10411041
"documentation",
10421042
"support",
10431043
"distribution",
1044+
"distribution-intake",
10441045
"license",
10451046
"build-meta",
10461047
"build-system",
10471048
"release-notes",
10481049
"security-contact",
1050+
"attestation",
1051+
"threat-model",
1052+
"vulnerability-assertion",
1053+
"exploitability-statement",
1054+
"pentest-report",
1055+
"static-analysis-report",
1056+
"dynamic-analysis-report",
1057+
"runtime-analysis-report",
1058+
"component-analysis-report",
1059+
"maturity-report",
1060+
"certification-report",
1061+
"codified-infrastructure",
1062+
"quality-metrics",
10491063
"other"
10501064
]
10511065
},

schema/bom-1.5.xsd

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,6 +1002,11 @@ limitations under the License.
10021002
<xs:documentation>Direct or repository download location</xs:documentation>
10031003
</xs:annotation>
10041004
</xs:enumeration>
1005+
<xs:enumeration value="distribution-intake">
1006+
<xs:annotation>
1007+
<xs:documentation>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</xs:documentation>
1008+
</xs:annotation>
1009+
</xs:enumeration>
10051010
<xs:enumeration value="license">
10061011
<xs:annotation>
10071012
<xs:documentation>The URL to the license file. If a license URL has been defined in the license
@@ -1028,6 +1033,71 @@ limitations under the License.
10281033
<xs:documentation>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.</xs:documentation>
10291034
</xs:annotation>
10301035
</xs:enumeration>
1036+
<xs:enumeration value="attestation">
1037+
<xs:annotation>
1038+
<xs:documentation>Human or machine-readable statements containing facts, evidence, or testimony</xs:documentation>
1039+
</xs:annotation>
1040+
</xs:enumeration>
1041+
<xs:enumeration value="threat-model">
1042+
<xs:annotation>
1043+
<xs:documentation>An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format</xs:documentation>
1044+
</xs:annotation>
1045+
</xs:enumeration>
1046+
<xs:enumeration value="vulnerability-assertion">
1047+
<xs:annotation>
1048+
<xs:documentation>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.</xs:documentation>
1049+
</xs:annotation>
1050+
</xs:enumeration>
1051+
<xs:enumeration value="exploitability-statement">
1052+
<xs:annotation>
1053+
<xs:documentation>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.</xs:documentation>
1054+
</xs:annotation>
1055+
</xs:enumeration>
1056+
<xs:enumeration value="pentest-report">
1057+
<xs:annotation>
1058+
<xs:documentation>Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test</xs:documentation>
1059+
</xs:annotation>
1060+
</xs:enumeration>
1061+
<xs:enumeration value="static-analysis-report">
1062+
<xs:annotation>
1063+
<xs:documentation>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</xs:documentation>
1064+
</xs:annotation>
1065+
</xs:enumeration>
1066+
<xs:enumeration value="dynamic-analysis-report">
1067+
<xs:annotation>
1068+
<xs:documentation>Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations</xs:documentation>
1069+
</xs:annotation>
1070+
</xs:enumeration>
1071+
<xs:enumeration value="runtime-analysis-report">
1072+
<xs:annotation>
1073+
<xs:documentation>Report generated by analyzing the call stack of a running application</xs:documentation>
1074+
</xs:annotation>
1075+
</xs:enumeration>
1076+
<xs:enumeration value="component-analysis-report">
1077+
<xs:annotation>
1078+
<xs:documentation>Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis</xs:documentation>
1079+
</xs:annotation>
1080+
</xs:enumeration>
1081+
<xs:enumeration value="maturity-report">
1082+
<xs:annotation>
1083+
<xs:documentation>Report containing a formal assessment of an organization, business unit, or team against a maturity model</xs:documentation>
1084+
</xs:annotation>
1085+
</xs:enumeration>
1086+
<xs:enumeration value="certification-report">
1087+
<xs:annotation>
1088+
<xs:documentation>Industry, regulatory, or other certification from an accredited (if applicable) certification body</xs:documentation>
1089+
</xs:annotation>
1090+
</xs:enumeration>
1091+
<xs:enumeration value="quality-metrics">
1092+
<xs:annotation>
1093+
<xs:documentation>Report or system in which quality metrics can be obtained</xs:documentation>
1094+
</xs:annotation>
1095+
</xs:enumeration>
1096+
<xs:enumeration value="codified-infrastructure">
1097+
<xs:annotation>
1098+
<xs:documentation>Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)</xs:documentation>
1099+
</xs:annotation>
1100+
</xs:enumeration>
10311101
<xs:enumeration value="other">
10321102
<xs:annotation>
10331103
<xs:documentation>Use this if no other types accurately describe the purpose of the external reference</xs:documentation>

0 commit comments

Comments
 (0)