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:
-
Is this system susceptible to a particular vulnerability?
-
Which devices in a particular environment contain vulnerabilities that require some action?
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, and applies information provided by the manufacturer through this mechanism to produce a vulnerability report. That report may be used to indicate what, if any, versions of software correct that vulnerability or whether the system exercises the vulnerable code at all.
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 [
RFC 8520]. 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:
-
A network-layer management system retrieving information from an Internet of Things (IoT) device as part of its ongoing life cycle. Such devices may or may not have query interfaces available.
-
An application-layer management system retrieving vulnerability or SBOM information in order to evaluate the posture of an application server of some form. These application servers may themselves be containers or hypervisors. Discovery of the topology of a server is beyond the scope of this memo.
To satisfy these two key use cases, objects may be found in one of three methods:
-
on the devices themselves
-
on a website (e.g., via a URI)
-
through some form of out-of-band contact with the supplier
Using the first method, devices will have interfaces that permit direct retrieval. Examples of these interfaces might be an HTTP [
RFC 9110] or Constrained Application Protocol (CoAP) [
RFC 7252] 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-layer discovery, this memo defines a well-known URI [
RFC 8615]. Management or orchestration tools can query this well-known URI to retrieve a system's SBOM information. Further queries may be necessary based on the content and structure of the response.
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/{someformat}+json-seq. It is left to those supporting those formats to make the appropriate registrations in this case.
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.