RFC 9472: A YANG Data Model for Reporting Software Bills of Materials (SBOMs) and Vulnerability Information
- E. Lear,
- S. Rose
Abstract
To improve cybersecurity posture, automation is necessary to locate
the software a device is using, whether that software has known
vulnerabilities
Status of This Memo
This is an Internet Standards Track document.¶
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.¶
Information about the current status of this document, any
errata, and how to provide feedback on it may be obtained at
https://
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://
1. Introduction
A number of activities have taken place to improve the visibility of what software is running on a system and what vulnerabilities that software may have [EO2021].¶
Put simply, this memo seeks to answer two classes of questions for tens of thousands of devices and a large variety of device types. Those questions are as follows:¶
This memo doesn't specify the format of this information but rather only how to locate and retrieve these objects. That is, the model is intended to facilitate discovery and on its own provides no access to the underlying data.¶
Software bills of materials (SBOMs) are descriptions of what software, including versioning and dependencies, a device contains. There are different SBOM formats such as Software Package Data Exchange [SPDX] or CycloneDX [CycloneDX15].¶
System vulnerabilities may be similarly described using several data formats, including the aforementioned CycloneDX, the Common Vulnerability Reporting Framework [CVRF], and the Common Security Advisory Format [CSAF]. This information is typically used to report the state of any known vulnerabilities on a system to administrators.¶
SBOM and vulnerability information can be used in concert with other
sources of vulnerability information. A network management tool could
discover that a system uses a particular set of software components,
searches a national vulnerability database to determine known
vulnerabilities
Both classes of information elements are optional under the model specified in this memo. One can provide only an SBOM, only vulnerability information, or both an SBOM and vulnerability information.¶
Note that SBOM formats may also carry other information, the most common being any licensing terms. Because this specification is neutral regarding content, it is left for format developers such as the Linux Foundation, OASIS, and ISO to decide what attributes they will support.¶
This memo does not specify how vulnerability information may be retrieved directly from the endpoint. That is because vulnerability information changes occur to software updates at different rates. However, some SBOM formats may also contain vulnerability information.¶
SBOMs and vulnerability information are advertised and retrieved through the use of a YANG augmentation of the Manufacturer User Description (MUD) model [RFC8520]. Note that the schema creates a grouping that can also be used independently of MUD. Moreover, other MUD features, such as access controls, needn't be present.¶
The mechanisms specified in this document are meant to address two use cases:¶
To satisfy these two key use cases, objects may be found in one of three methods:¶
Using the first method, devices will have interfaces that permit direct retrieval. Examples of these interfaces might be an HTTP [RFC9110] or Constrained Application Protocol (CoAP) [RFC7252] endpoint for retrieval. There may also be private interfaces as well.¶
Using the second method, when a device does not have an appropriate retrieval interface, but one is directly available from the manufacturer, a URI to that information is discovered through interfaces such as MUD via DHCP or bootstrapping and ownership transfer mechanisms.¶
Using the third method, a supplier may wish to make an SBOM or vulnerability information available under certain circumstances and may need to individually evaluate requests. The result of that evaluation might be the SBOM, the vulnerability itself, a restricted URL, or no access.¶
To enable application
1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
1.2. How This Information Is Retrieved
Section 4 describes a data model to extend the MUD file format to carry SBOM and vulnerability information. Section 1.5 of [RFC8520] describes mechanisms by which devices can emit a URL to point to this file. Additionally, devices can share this URL either through documentation or within a QR code on a box. Section 2 describes a well-known URL from which an SBOM could be served from the local device.¶
Note that vulnerability and SBOM information are likely to change at different rates. MUD's cache-validity node provides a way for manufacturers to control how often tooling should check for those changes through the cache-validity node.¶
1.3. Formats
There are multiple ways to express both SBOMs and vulnerability information. When these are retrieved either from the device or from a remote web server, tools will need to observe the Content-Type header to determine precisely which format is being transmitted. Because IoT devices in particular have limited capabilities, use of a specific Accept: header in HTTP or the Accept Option in CoAP is NOT RECOMMENDED. Instead, backend tooling is encouraged to support all known formats and SHOULD silently discard SBOM information sent with a media type that is not understood.¶
If multiple SBOMs are intended to be supported in the same file,
the media type should properly reflect that. For example, one might
make use of application
Some formats may support both vulnerability and software inventory information. When both vulnerability and software inventory information is available from the same URL, both sbom-url and members of the vuln-url list MUST indicate that. Network management systems MUST take note of when the SBOM and vulnerability information are accessible via the same resource and not retrieve the resource a second time.¶
2. The Well-Known Transparency Endpoint Set
A well-known endpoint is defined:¶
"
As discussed previously, the precise format of a response is based on the Content-Type provided.¶
3. The mud-transparency Extension
We now formally define the mud
First, the extension name "transparency" is listed in the "extensions" array of the MUD file. Note that this schema extension is intended to be used wherever it might be appropriate (e.g., not just with MUD).¶
Second, the "mud" container is augmented with a list of SBOM sources.¶
This is done as follows:¶
4. The mud-sbom Augmentation to the MUD YANG Data Model
This YANG module references [RFC6991], [RFC7231], [RFC7252], [RFC8520], and [RFC9110].¶
5. Examples
In this example MUD file that uses a cloud service, the modelX presents a location of the SBOM in a URL. Note that the Access Control Lists (ACLs) in a MUD file are NOT required, although they are a very good idea for IP-based devices.¶
5.1. Without ACLS
This first MUD file demonstrates how to get SBOM and vulnerability information without ACLs.¶
The second example demonstrates that just SBOM information is included from the cloud.¶
5.2. SBOM Located on the Device
In the next example, the SBOM is located on the device, and there is no vulnerability information provided.¶
In this example, the SBOM is retrieved from the device, while vulnerability information is available from the cloud. This is likely a common case because vendors may learn of vulnerability information more frequently than they update software.¶
5.3. Further Contact Required
In this example, the network manager must take further steps to retrieve SBOM information. Vulnerability information is still available.¶
5.4. With ACLS
Finally, here is a complete example where the device provides SBOM and vulnerability information as well as access control information.¶
At this point, the management system can attempt to retrieve the SBOM, determine which format is in use through the Content-Type header on the response to a GET request, independently repeat the process for vulnerability information, and apply ACLs as appropriate.¶
6. Security Considerations
This document describes a schema for discovering the location of information relating to software transparency and does not specify the access model for the information itself. In particular, the YANG module specified in this document is not necessarily intended to be accessed via regular network management protocols, such as NETCONF [RFC6241] or RESTCONF [RFC8040], and hence the regular security considerations for such usage are not considered here.¶
Below, we describe protections relating to both discovery and some advice on protecting the underlying SBOM and vulnerability information.¶
The model specifies both encrypted and unencrypted means to retrieve information. This is a matter of pragmatism. Unencrypted communications allow for manipulation of information being retrieved. Therefore, it is RECOMMENDED that implementations offer a means to configure endpoints so that they may make use of TLS or DTLS.¶
The ietf
If an attacker modifies the elements, they may misdirect automation to retrieve a different set of URLs than was intended by the designer. This in turn leads to two specific sets of risks:¶
To address either of these risks or any tampering of a URL:¶
SBOMs provide an inventory of software. Knowledge of which specific software is loaded on a system can aid an attacker in identifying an appropriate exploit for a known vulnerability or guide the development of novel exploit against this system. However, if software is available to an attacker, the attacker may already be able to derive this very same software inventory. When this information resides on the endpoint itself, the endpoint SHOULD NOT provide unrestricted access to the well-known URL by default.¶
Other servers that offer the data MAY restrict access to SBOM information using appropriate authorization semantics within HTTP. One way to do this would be to issue a certificate to the client for this purpose after a registration process has taken place. Another approach would involve the use of OAuth in combination. In particular, if a system attempts to retrieve an SBOM via HTTP or CoAP and the client is not authorized, the server MUST produce an appropriate error with instructions on how to register a particular client.¶
Another risk is a skew in the SBOM listing and the actual software
inventory of a device
To further mitigate attacks against a device, manufacturers SHOULD recommend network access controls.¶
Vulnerability information is generally made available to such databases as NIST's National Vulnerability Database [NISTNVD]. It is possible that vendors may wish to release information early to some customers. We do not discuss here whether that is a good idea, but if it is employed, then appropriate access controls and authorization SHOULD be applied to that information.¶
7. IANA Considerations
7.1. MUD Extension
IANA has added "transparency" to the "MUD Extensions" registry [RFC8520] as follows:¶
7.2. YANG Registration
IANA has registered the following YANG module in the "YANG Module Names" registry [RFC6020]:¶
- Name:
- ietf
-mud -transparency¶ - Namespace:
- urn
:ietf :params :xml :ns :yang :ietf -mud -transparency¶ - Maintained by IANA:
- N¶
- Prefix:
- mudtx¶
- Reference:
- RFC 9472¶
The following URI has been registered in the "IETF XML Registry" [RFC3688]:¶
8. References
8.1. Normative References
- [RFC2119]
-
Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10
.17487 , , <https:///RFC2119 www >..rfc -editor .org /info /rfc2119 - [RFC3688]
-
Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10
.17487 , , <https:///RFC3688 www >..rfc -editor .org /info /rfc3688 - [RFC6020]
-
Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10
.17487 , , <https:///RFC6020 www >..rfc -editor .org /info /rfc6020 - [RFC6241]
-
Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10
.17487 , , <https:///RFC6241 www >..rfc -editor .org /info /rfc6241 - [RFC6991]
-
Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10
.17487 , , <https:///RFC6991 www >..rfc -editor .org /info /rfc6991 - [RFC7231]
-
Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content", RFC 7231, DOI 10
.17487 , , <https:///RFC7231 www >..rfc -editor .org /info /rfc7231 - [RFC7252]
-
Shelby, Z., Hartke, K., and C. Bormann, "The Constrained Application Protocol (CoAP)", RFC 7252, DOI 10
.17487 , , <https:///RFC7252 www >..rfc -editor .org /info /rfc7252 - [RFC8040]
-
Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10
.17487 , , <https:///RFC8040 www >..rfc -editor .org /info /rfc8040 - [RFC8174]
-
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10
.17487 , , <https:///RFC8174 www >..rfc -editor .org /info /rfc8174 - [RFC8520]
-
Lear, E., Droms, R., and D. Romascanu, "Manufacturer Usage Description Specification", RFC 8520, DOI 10
.17487 , , <https:///RFC8520 www >..rfc -editor .org /info /rfc8520 - [RFC8615]
-
Nottingham, M., "Well-Known Uniform Resource Identifiers (URIs)", RFC 8615, DOI 10
.17487 , , <https:///RFC8615 www >..rfc -editor .org /info /rfc8615 - [RFC9110]
-
Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke, Ed., "HTTP Semantics", STD 97, RFC 9110, DOI 10
.17487 , , <https:///RFC9110 www >..rfc -editor .org /info /rfc9110
8.2. Informative References
- [CSAF]
-
Rock, L., Ed., Hagen, S., Ed., and T. Schmidt, Ed., "Common Security Advisory Framework Version 2.0", OASIS Standard, , <https://
docs >..oasis -open .org /csaf /csaf /v2 .0 /csaf -v2 .0 .html - [CVRF]
-
Hagen, S., Ed., "CSAF Common Vulnerability Reporting Framework (CVRF) Version 1.2", Committee Specification 01, , <https://
docs >..oasis -open .org /csaf /csaf -cvrf /v1 .2 /csaf -cvrf -v1 .2 .pdf - [CycloneDX15]
-
CycloneDX, "CycloneDX v1.5 JSON Reference", Version 1.5.0, <https://
cyclonedx >..org /docs /1 .5 /json - [EO2021]
- Biden, J., "Executive Order on Improving the Nation's Cybersecurity", EO 14028, .
- [NISTNVD]
-
NIST, "National Vulnerability Database", <https://
nvd >..nist .gov - [RFC8340]
-
Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10
.17487 , , <https:///RFC8340 www >..rfc -editor .org /info /rfc8340 - [SPDX]
-
The Linux Foundation, "The Software Package Data Exchange (SPDX) Specification", Version 2.3, , <https://
spdx >..github .io /spdx -spec /v2 .3 /
Acknowledgments
Thanks to Russ Housley, Dick Brooks, Tom Petch, and Nicolas Comstedt, who provided review comments.¶