draft-ietf-sacm-coswid-11.txt   draft-ietf-sacm-coswid-12.txt 
SACM Working Group H. Birkholz SACM Working Group H. Birkholz
Internet-Draft Fraunhofer SIT Internet-Draft Fraunhofer SIT
Intended status: Standards Track J. Fitzgerald-McKay Intended status: Standards Track J. Fitzgerald-McKay
Expires: December 29, 2019 Department of Defense Expires: January 26, 2020 Department of Defense
C. Schmidt C. Schmidt
The MITRE Corporation The MITRE Corporation
D. Waltermire D. Waltermire
NIST NIST
June 27, 2019 July 25, 2019
Concise Software Identification Tags Concise Software Identification Tags
draft-ietf-sacm-coswid-11 draft-ietf-sacm-coswid-12
Abstract Abstract
ISO/IEC 19770-2:2015 Software Identification (SWID) tags provide an ISO/IEC 19770-2:2015 Software Identification (SWID) tags provide an
extensible XML-based structure to identify and describe individual extensible XML-based structure to identify and describe individual
software components, patches, and installation bundles. SWID tag software components, patches, and installation bundles. SWID tag
representations can be too large for devices with network and storage representations can be too large for devices with network and storage
constraints. This document defines a concise representation of SWID constraints. This document defines a concise representation of SWID
tags: Concise SWID (CoSWID) tags. CoSWID supports the same features tags: Concise SWID (CoSWID) tags. CoSWID supports the same features
as SWID tags, as well as additional semantics that allow CoSWIDs to as SWID tags, as well as additional semantics that allow CoSWIDs to
skipping to change at page 1, line 43 skipping to change at page 1, line 43
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 29, 2019. This Internet-Draft will expire on January 26, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. The SWID and CoSWID Tag Lifecycle . . . . . . . . . . . . 4 1.1. The SWID and CoSWID Tag Lifecycle . . . . . . . . . . . . 4
1.2. Concise SWID Format . . . . . . . . . . . . . . . . . . . 6 1.2. Concise SWID Format . . . . . . . . . . . . . . . . . . . 7
1.3. Requirements Notation . . . . . . . . . . . . . . . . . . 7 1.3. Requirements Notation . . . . . . . . . . . . . . . . . . 7
2. Concise SWID Data Definition . . . . . . . . . . . . . . . . 7 2. Concise SWID Data Definition . . . . . . . . . . . . . . . . 7
2.1. Concise SWID Extensions . . . . . . . . . . . . . . . . . 8 2.1. Character Encoding . . . . . . . . . . . . . . . . . . . 8
2.2. The concise-swid-tag Group . . . . . . . . . . . . . . . 10 2.2. Concise SWID Extensions . . . . . . . . . . . . . . . . . 9
2.3. concise-swid-tag Co-constraints . . . . . . . . . . . . . 14 2.3. The concise-swid-tag Group . . . . . . . . . . . . . . . 11
2.4. The global-attributes Group . . . . . . . . . . . . . . . 15 2.4. concise-swid-tag Co-constraints . . . . . . . . . . . . . 15
2.5. The entity-entry Group . . . . . . . . . . . . . . . . . 16 2.5. The global-attributes Group . . . . . . . . . . . . . . . 16
2.6. The link-entry Map . . . . . . . . . . . . . . . . . . . 18 2.6. The entity-entry Group . . . . . . . . . . . . . . . . . 17
2.7. The software-meta-entry Map . . . . . . . . . . . . . . . 22 2.7. The link-entry Map . . . . . . . . . . . . . . . . . . . 18
2.8. The Resource Collection Definition . . . . . . . . . . . 25 2.8. The software-meta-entry Map . . . . . . . . . . . . . . . 22
2.8.1. The hash-entry Array . . . . . . . . . . . . . . . . 25 2.9. The Resource Collection Definition . . . . . . . . . . . 26
2.8.2. The resource-collection Group . . . . . . . . . . . . 25 2.9.1. The hash-entry Array . . . . . . . . . . . . . . . . 26
2.8.3. The payload-entry Group . . . . . . . . . . . . . . . 29 2.9.2. The resource-collection Group . . . . . . . . . . . . 26
2.8.4. The evidence-entry Group . . . . . . . . . . . . . . 29 2.9.3. The payload-entry Group . . . . . . . . . . . . . . . 29
2.9. Full CDDL Definition . . . . . . . . . . . . . . . . . . 30 2.9.4. The evidence-entry Group . . . . . . . . . . . . . . 30
3. Determining the Type of CoSWID . . . . . . . . . . . . . . . 35 2.10. Full CDDL Definition . . . . . . . . . . . . . . . . . . 30
4. CoSWID Indexed Label Values . . . . . . . . . . . . . . . . . 36 3. Determining the Type of CoSWID . . . . . . . . . . . . . . . 36
4.1. Version Scheme . . . . . . . . . . . . . . . . . . . . . 36 4. CoSWID Indexed Label Values . . . . . . . . . . . . . . . . . 37
4.2. Entity Role Values . . . . . . . . . . . . . . . . . . . 37 4.1. Version Scheme . . . . . . . . . . . . . . . . . . . . . 37
4.3. Link Ownership Values . . . . . . . . . . . . . . . . . . 38 4.2. Entity Role Values . . . . . . . . . . . . . . . . . . . 38
4.4. Link Rel Values . . . . . . . . . . . . . . . . . . . . . 39 4.3. Link Ownership Values . . . . . . . . . . . . . . . . . . 39
4.5. Link Use Values . . . . . . . . . . . . . . . . . . . . . 41 4.4. Link Rel Values . . . . . . . . . . . . . . . . . . . . . 40
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 42 4.5. Link Use Values . . . . . . . . . . . . . . . . . . . . . 42
5.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 42 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 43
5.2. SWID/CoSWID Value Registries . . . . . . . . . . . . . . 45 5.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 43
5.2.1. SWID/CoSWID Version Scheme Value Registry . . . . . . 45 5.2. SWID/CoSWID Value Registries . . . . . . . . . . . . . . 46
5.2.2. SWID/CoSWID Entity Role Value Registry . . . . . . . 46 5.2.1. Registration Proceedures . . . . . . . . . . . . . . 46
5.2.3. SWID/CoSWID Link Ownership Value Registry . . . . . . 48 5.2.2. Private Use of Index and Name Values . . . . . . . . 46
5.2.4. SWID/CoSWID Link Relationship Value Registry . . . . 49 5.2.3. Expert Review Guidelines . . . . . . . . . . . . . . 47
5.2.5. SWID/CoSWID Link Use Value Registry . . . . . . . . . 52 5.2.4. SWID/CoSWID Version Scheme Value Registry . . . . . . 47
5.3. swid+cbor Media Type Registration . . . . . . . . . . . . 53 5.2.5. SWID/CoSWID Entity Role Value Registry . . . . . . . 49
5.4. CoAP Content-Format Registration . . . . . . . . . . . . 54 5.2.6. SWID/CoSWID Link Ownership Value Registry . . . . . . 50
5.5. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 54 5.2.7. SWID/CoSWID Link Relationship Value Registry . . . . 51
5.2.8. SWID/CoSWID Link Use Value Registry . . . . . . . . . 53
6. Security Considerations . . . . . . . . . . . . . . . . . . . 55 5.3. swid+cbor Media Type Registration . . . . . . . . . . . . 54
7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 56 5.4. CoAP Content-Format Registration . . . . . . . . . . . . 55
8. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 56 5.5. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 55
9. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 60 5.6. URI Scheme Registrations . . . . . . . . . . . . . . . . 55
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 60 5.6.1. "swid" URI Scheme Registration . . . . . . . . . . . 56
10.1. Normative References . . . . . . . . . . . . . . . . . . 60 5.6.2. "swidpath" URI Scheme Registration . . . . . . . . . 56
10.2. Informative References . . . . . . . . . . . . . . . . . 62 5.7. CoSWID Model for use in SWIMA Registration . . . . . . . 57
Appendix A. Signed Concise SWID Tags using COSE . . . . . . . . 63 6. Security Considerations . . . . . . . . . . . . . . . . . . . 58
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 64 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 60
8. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 60
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 64
9.1. Normative References . . . . . . . . . . . . . . . . . . 64
9.2. Informative References . . . . . . . . . . . . . . . . . 66
Appendix A. Signed Concise SWID Tags using COSE . . . . . . . . 67
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 68
1. Introduction 1. Introduction
SWID tags, as defined in ISO-19770-2:2015 [SWID], provide a SWID tags, as defined in ISO-19770-2:2015 [SWID], provide a
standardized XML-based record format that identifies and describes a standardized XML-based record format that identifies and describes a
specific release of software, a patch, or an installation bundle, specific release of software, a patch, or an installation bundle,
which are referred to as software components in this document. which are referred to as software components in this document.
Different software components, and even different releases of a Different software components, and even different releases of a
particular software component, each have a different SWID tag record particular software component, each have a different SWID tag record
associated with them. SWID tags are meant to be flexible and able to associated with them. SWID tags are meant to be flexible and able to
skipping to change at page 3, line 51 skipping to change at page 4, line 9
While there are very few required fields in SWID tags, there are many While there are very few required fields in SWID tags, there are many
optional fields that support different uses. A SWID tag consisting optional fields that support different uses. A SWID tag consisting
of only required fields might be a few hundred bytes in size; of only required fields might be a few hundred bytes in size;
however, a tag containing many of the optional fields can be many however, a tag containing many of the optional fields can be many
orders of magnitude larger. Thus, real-world instances of SWID tags orders of magnitude larger. Thus, real-world instances of SWID tags
can be fairly large, and the communication of SWID tags in usage can be fairly large, and the communication of SWID tags in usage
scenarios, such as those described earlier, can cause a large amount scenarios, such as those described earlier, can cause a large amount
of data to be transported. This can be larger than acceptable for of data to be transported. This can be larger than acceptable for
constrained devices and networks. Concise SWID (CoSWID) tags constrained devices and networks. Concise SWID (CoSWID) tags
significantly reduce the amount of data transported as compared to a significantly reduce the amount of data transported as compared to a
typical SWID tag. This reduction is enabled through the use of CBOR, typical SWID tag. This reduction is enabled through the use of the
which maps the human-readable labels of SWID data items to more Concise Binary Object Representation (CBOR) [RFC7049], which maps the
concise integer labels (indices). The use of CBOR to express SWID human-readable labels of SWID data items to more concise integer
information in CoSWID tags allows both CoSWID and SWID tags to be labels (indices). The use of CBOR to express SWID information in
part of an enterprise security solution for a wider range of CoSWID tags allows both CoSWID and SWID tags to be part of an
endpoints and environments. enterprise security solution for a wider range of endpoints and
environments.
1.1. The SWID and CoSWID Tag Lifecycle 1.1. The SWID and CoSWID Tag Lifecycle
In addition to defining the format of a SWID tag record, ISO/IEC In addition to defining the format of a SWID tag record, ISO/IEC
19770-2:2015 defines requirements concerning the SWID tag lifecycle. 19770-2:2015 defines requirements concerning the SWID tag lifecycle.
Specifically, when a software component is installed on an endpoint, Specifically, when a software component is installed on an endpoint,
that software component's SWID tag is also installed. Likewise, when that software component's SWID tag is also installed. Likewise, when
the software component is uninstalled or replaced, the SWID tag is the software component is uninstalled or replaced, the SWID tag is
deleted or replaced, as appropriate. As a result, ISO/IEC deleted or replaced, as appropriate. As a result, ISO/IEC
19770-2:2015 describes a system wherein there is a correspondence 19770-2:2015 describes a system wherein there is a correspondence
skipping to change at page 5, line 35 skipping to change at page 5, line 43
Corpus Primary Primary xPrimary xPrimary Corpus Primary Primary xPrimary xPrimary
Supplemental Supplemental Supplemental xSupplemental xSuplemental Supplemental Supplemental Supplemental xSupplemental xSuplemental
Patch xPatch Patch xPatch
Primary Primary
Supplemental Supplemental
Figure 1: Use of Tag Types in the Software Lifecycle Figure 1: Use of Tag Types in the Software Lifecycle
Figure 1 illustrates the steps in the software lifecycle and the Figure 1 illustrates the steps in the software lifecycle and the
relationships among those lifecycle events supported by the four relationships among those lifecycle events supported by the four
types of SWID and CoSWID tags, as follows: types of SWID and CoSWID tags. The figure identifies the types of
tags that can be deployed and previously deployed tags that are
typically removed (indicated by an "x" prefix) at each lifecycle
stage, as follows:
* Software Deployment. Before the software component is * Software Deployment. Before the software component is
installed (i.e., pre-installation), and while the product is installed (i.e., pre-installation), and while the product is
being deployed, a corpus tag provides information about the being deployed, a corpus tag provides information about the
installation files and distribution media (e.g., CD/DVD, installation files and distribution media (e.g., CD/DVD,
distribution package). distribution package).
* Software Installation. A primary tag will be installed with * Software Installation. A primary tag will be installed with
the software component (or subsequently created) to uniquely the software component (or subsequently created) to uniquely
identify and describe the software component. Supplemental identify and describe the software component. Supplemental
skipping to change at page 6, line 41 skipping to change at page 7, line 7
basis for understanding the information provided in a CoSWID and the basis for understanding the information provided in a CoSWID and the
associated semantics of this information. Each of the different SWID associated semantics of this information. Each of the different SWID
and CoSWID tag types provide different sets of information. For and CoSWID tag types provide different sets of information. For
example, a "corpus tag" is used to describe a software component's example, a "corpus tag" is used to describe a software component's
installation image on an installation media, while a "patch tag" is installation image on an installation media, while a "patch tag" is
meant to describe a patch that modifies some other software meant to describe a patch that modifies some other software
component. component.
1.2. Concise SWID Format 1.2. Concise SWID Format
This document defines the CoSWID tag format, which is based on the This document defines the CoSWID tag format, which is based on CBOR.
Concise Binary Object Representation (CBOR) [RFC7049]. CBOR-based CBOR-based CoSWID tags offer a more concise representation of SWID
CoSWID tags offer a more concise representation of SWID information information as compared to the XML-based SWID tag representation in
as compared to the XML-based SWID tag representation in ISO- ISO-19770-2:2015. The structure of a CoSWID is described via the
19770-2:2015. The structure of a CoSWID is described via the Concise Concise Data Definition Language (CDDL) [RFC8610]. The resulting
Data Definition Language (CDDL) [RFC8610]. The resulting CoSWID data CoSWID data definition is aligned to the information able to be
definition is aligned to the information able to be expressed with expressed with the XML schema definition of ISO-19770-2:2015 [SWID].
the XML schema definition of ISO-19770-2:2015 [SWID]. This alignment This alignment allows both SWID and CoSWID tags to represent a common
allows both SWID and CoSWID tags to represent a common set of set of software component information and allows CoSWID tags to
software component information and allows CoSWID tags to support the support the same uses as a SWID tag. To achieve this end, the CDDL
same uses as a SWID tag. To achieve this end, the CDDL
representation includes every SWID tag field and attribute. representation includes every SWID tag field and attribute.
The vocabulary, i.e., the CDDL names of the types and members used in The vocabulary, i.e., the CDDL names of the types and members used in
the CoSWID data definition, are mapped to more concise labels the CoSWID data definition, are mapped to more concise labels
represented as small integer values. The names used in the CDDL data represented as small integer values. The names used in the CDDL data
definition and the mapping to the CBOR representation using integer definition and the mapping to the CBOR representation using integer
labels is based on the vocabulary of the XML attribute and element labels is based on the vocabulary of the XML attribute and element
names defined in ISO/IEC 19770-2:2015. names defined in ISO/IEC 19770-2:2015.
1.3. Requirements Notation 1.3. Requirements Notation
skipping to change at page 7, line 40 skipping to change at page 8, line 5
notation [KebabCase] (e.g. ResourceCollection is named resource- notation [KebabCase] (e.g. ResourceCollection is named resource-
collection) in the CoSWID data definition. This deviation from the collection) in the CoSWID data definition. This deviation from the
original notation used in the XML representation reduces ambiguity original notation used in the XML representation reduces ambiguity
when referencing certain attributes in corresponding textual when referencing certain attributes in corresponding textual
descriptions. An attribute referred to by its name in CamelCase descriptions. An attribute referred to by its name in CamelCase
notation explicitly relates to XML SWID tags; an attribute referred notation explicitly relates to XML SWID tags; an attribute referred
to by its name in KebabCase notation explicitly relates to CBOR to by its name in KebabCase notation explicitly relates to CBOR
CoSWID tags. This approach simplifies the composition of further CoSWID tags. This approach simplifies the composition of further
work that reference both XML SWID and CBOR CoSWID documents. work that reference both XML SWID and CBOR CoSWID documents.
Note that sometimes CoSWID CDDL attribute names show greater In most cases, mapping attribute names between SWID and CoSWID can be
variation than the described notation change relative to their done automatically by converting between CamelCase and KebabCase
corresponding SWID XML Schema attributes. This is done when the attribute names. However, some CoSWID CDDL attribute names show
change improves clarity in the specification. For example the "name" greater variation relative to their corresponding SWID XML Schema
and "version" SWID fields corresponds to the "software-name" and attributes. This is done when the change improves clarity in the
"software-version" CoSWID fields, respectively. As such, it is not specification. For example the "name" and "version" SWID fields
always possible to mechanically translate between corresponding corresponds to the "software-name" and "software-version" CoSWID
attribute names in the two formats. fields, respectively. As such, it is not always possible to
mechanically translate between corresponding attribute names in the
two formats. In such cases, a manual mapping will need to be used.
The 57 human-readable text labels of the CDDL-based CoSWID vocabulary The 57 human-readable text labels of the CDDL-based CoSWID vocabulary
are mapped to integer indices via a block of rules at the bottom of are mapped to integer indices via a block of rules at the bottom of
the definition. This allows a more concise integer-based form to be the definition. This allows a more concise integer-based form to be
stored or transported, as compared to the less efficient text-based stored or transported, as compared to the less efficient text-based
form of the original vocabulary. form of the original vocabulary.
In CBOR, an array is encoded using bytes that identify the array, and In CBOR, an array is encoded using bytes that identify the array, and
the array's length or stop point (see [RFC7049]). To make items that the array's length or stop point (see [RFC7049]). To make items that
support 1 or more values, the following CDDL notion is used. support 1 or more values, the following CDDL notion is used.
_name_ = (_label_: _data_ / [ 2* _data_ ]) _name_ = (_label_: _data_ / [ 2* _data_ ])
The CDDL rule above allows either a single data item or an array of 2 The CDDL rule above allows either a single data item or an array of 2
or more data values to be provided. When a singleton data value is or more data values to be provided. When a singleton data value is
provided, the CBOR markers for the array, array length, and stop provided, the CBOR markers for the array, array length, and stop
point are not needed saving bytes. When two or more data values are point are not needed, saving bytes. When two or more data values are
provided, these values are encoded as an array. This modeling provided, these values are encoded as an array. This modeling
pattern is used frequently in the CoSWID CDDL data definition to pattern is used frequently in the CoSWID CDDL data definition to
allow for more efficient encoding of singleton values. allow for more efficient encoding of singleton values.
The following subsections describe the different parts of the CoSWID The following subsections describe the different parts of the CoSWID
model. model.
2.1. Concise SWID Extensions 2.1. Character Encoding
The CDDL "text" type is represented in CBOR as a major type 3, which
represents "a string of Unicode characters that [are] encoded as
UTF-8 [RFC3629]" (see [RFC7049] section 2.1). Thus both SWID and
CoSWID use UTF-8 for the encoding of characters in text strings.
To ensure that UTF-8 character strings are able to be encodes/decoded
and exchanged interoperably, text strings in CoSWID MUST be encoded
consistent with the Net-Unicode definition defined in [RFC5198].
All names registered with IANA according to requirements in section
Section 5.2 also need to be valid according to the XML Schema NMToken
data type (see [W3C.REC-xmlschema-2-20041028] section 3.3.4) to
ensure compatibility with the SWID specification where these names
are used.
2.2. Concise SWID Extensions
The CoSWID data definition contains two features that are not The CoSWID data definition contains two features that are not
included in the SWID data definition on which it is based. These included in the SWID data definition on which it is based. These
features are: features are:
o The explicit definition of types for attributes that are typically o The explicit definition of types for some attributes in the ISO-
stored in the "any attribute" of an ISO-19770-2:2015 in XML 19770-2:2015 XML representation that are typically represented by
representation. These are covered in Section 2.4. the "any attribute" in the SWID model. These are covered in
Section 2.5.
o The inclusion of extension points in the CoSWID data definition o The inclusion of extension points in the CoSWID data definition
using CDDL sockets (see [RFC8610] section 3.9). The use of CDDL using CDDL sockets (see [RFC8610] section 3.9). The use of CDDL
sockets allow for well-formed extensions to be defined in sockets allow for well-formed extensions to be defined in
supplementary CDDL descriptions that support additional uses of supplementary CDDL descriptions that support additional uses of
CoSWID tags that go beyond the original scope of ISO-19770-2:2015 CoSWID tags that go beyond the original scope of ISO-19770-2:2015
tags. This extension mechanism can also be used to update the tags. This extension mechanism can also be used to update the
CoSWID format as revisions to ISO-19770-2 are published. CoSWID format as revisions to ISO-19770-2 are published.
The following CDDL sockets (extension points) are defined in this The following CDDL sockets (extension points) are defined in this
document, which allow the addition of new information structures to document, which allow the addition of new information structures to
their respective CDDL groups. their respective CDDL groups.
+---------------------+-----------------------+---------------+ +---------------------+-----------------------+---------------+
| Map Name | CDDL Socket | Defined in | | Map Name | CDDL Socket | Defined in |
+---------------------+-----------------------+---------------+ +---------------------+-----------------------+---------------+
| concise-swid-tag | $$coswid-extension | Section 2.2 | | concise-swid-tag | $$coswid-extension | Section 2.3 |
| | | | | | | |
| entity-entry | $$entity-extension | Section 2.5 | | entity-entry | $$entity-extension | Section 2.6 |
| | | | | | | |
| link-entry | $$link-extension | Section 2.6 | | link-entry | $$link-extension | Section 2.7 |
| | | | | | | |
| software-meta-entry | $$meta-extension | Section 2.7 | | software-meta-entry | $$meta-extension | Section 2.8 |
| | | | | | | |
| file-entry | $$file-extension | Section 2.8.2 | | file-entry | $$file-extension | Section 2.9.2 |
| | | | | | | |
| directory-entry | $$directory-extension | Section 2.8.2 | | directory-entry | $$directory-extension | Section 2.9.2 |
| | | | | | | |
| process-entry | $$process-extension | Section 2.8.2 | | process-entry | $$process-extension | Section 2.9.2 |
| | | | | | | |
| resource-entry | $$resource-extension | Section 2.8.2 | | resource-entry | $$resource-extension | Section 2.9.2 |
| | | | | | | |
| payload-entry | $$payload-extension | Section 2.8.3 | | payload-entry | $$payload-extension | Section 2.9.3 |
| | | | | | | |
| evidence-entry | $$evidence-extension | Section 2.8.4 | | evidence-entry | $$evidence-extension | Section 2.9.4 |
+---------------------+-----------------------+---------------+ +---------------------+-----------------------+---------------+
Table 1: CoSWID CDDL Group Extension Points Table 1: CoSWID CDDL Group Extension Points
The CoSWID Items Registry defined in Section 5.1 provides a The CoSWID Items Registry defined in Section 5.1 provides a
registration mechanism allowing new items, and their associated index registration mechanism allowing new items, and their associated index
values, to be added to the CoSWID model through the use of the CDDL values, to be added to the CoSWID model through the use of the CDDL
sockets described in the table above. This registration mechanism sockets described in the table above. This registration mechanism
provides for well-known index values for data items in CoSWID provides for well-known index values for data items in CoSWID
extensions, allowing these index values to be recognized by extensions, allowing these index values to be recognized by
skipping to change at page 10, line 31 skipping to change at page 11, line 31
A number of SWID/CoSWID value registries are also defined in A number of SWID/CoSWID value registries are also defined in
Section 5.2 that allow new values to be registered with IANA for the Section 5.2 that allow new values to be registered with IANA for the
enumerations above. This registration mechanism supports the enumerations above. This registration mechanism supports the
definition of new well-known index values and names for new definition of new well-known index values and names for new
enumeration values used by both SWID and CoSWID. This registration enumeration values used by both SWID and CoSWID. This registration
mechanism allows new standardized enumerated values to be shared mechanism allows new standardized enumerated values to be shared
between both specifications (and implementations) over time, and between both specifications (and implementations) over time, and
references to the IANA registries will be added to the next revision references to the IANA registries will be added to the next revision
of [SWID]. of [SWID].
2.2. The concise-swid-tag Group 2.3. The concise-swid-tag Group
The CDDL data definition for the root concise-swid-tag map is as The CDDL data definition for the root concise-swid-tag map is as
follows and this rule and its constraints MUST be followed when follows and this rule and its constraints MUST be followed when
creating or validating a CoSWID tag: creating or validating a CoSWID tag:
concise-swid-tag = { concise-swid-tag = {
global-attributes, global-attributes,
tag-id => text, tag-id => text / bstr .size 16,
tag-version => integer, tag-version => integer,
? corpus => bool, ? corpus => bool,
? patch => bool, ? patch => bool,
? supplemental => bool, ? supplemental => bool,
software-name => text, software-name => text,
? software-version => text, ? software-version => text,
? version-scheme => $version-scheme, ? version-scheme => $version-scheme,
? media => text, ? media => text,
? software-meta => software-meta-entry / [ 2* software-meta-entry ], ? software-meta => software-meta-entry / [ 2* software-meta-entry ],
entity => entity-entry / [ 2* entity-entry ], entity => entity-entry / [ 2* entity-entry ],
skipping to change at page 12, line 7 skipping to change at page 13, line 7
multipartnumeric = 1 multipartnumeric = 1
multipartnumeric-suffix = 2 multipartnumeric-suffix = 2
alphanumeric = 3 alphanumeric = 3
decimal = 4 decimal = 4
semver = 16384 semver = 16384
The following describes each member of the concise-swid-tag root map. The following describes each member of the concise-swid-tag root map.
o global-attributes: A list of items including an optional language o global-attributes: A list of items including an optional language
definition to support the processing of text-string values and an definition to support the processing of text-string values and an
unbounded set of any-attribute items. Described in Section 2.4. unbounded set of any-attribute items. Described in Section 2.5.
o tag-id (index 0): A textual identifier uniquely referencing a o tag-id (index 0): A 16 byte binary string or textual identifier
software component. The tag identifier MUST be globally unique. uniquely referencing a software component. The tag identifier
There are no strict guidelines on how this identifier is MUST be globally unique. If represented as a 16 byte binary
structured, but examples include a 16 byte GUID (e.g. class 4 string, the identifier MUST be a valid universally unique
UUID) [RFC4122], or a text string appended to a DNS domain name to identifier as defined by [RFC4122]. There are no strict
ensure uniqueness across organizations. guidelines on how this identifier is structured, but examples
include a 16 byte GUID (e.g. class 4 UUID) [RFC4122], or a text
string appended to a DNS domain name to ensure uniqueness across
organizations.
o tag-version (index 12): An integer value that indicate the o tag-version (index 12): An integer value that indicate the
specific release revision of the tag. Typically, the initial specific release revision of the tag. Typically, the initial
value of this field is set to 0 and the value is monotonically value of this field is set to 0 and the value is monotonically
increased for subsequent tags produced for the same software increased for subsequent tags produced for the same software
component release. This value allows a CoSWID tag producer to component release. This value allows a CoSWID tag producer to
correct an incorrect tag previously released without indicating a correct an incorrect tag previously released without indicating a
change to the underlying software component the tag represents. change to the underlying software component the tag represents.
For example, the tag version could be changed to add new metadata, For example, the tag version could be changed to add new metadata,
to correct a broken link, to add a missing payload entry, etc. to correct a broken link, to add a missing payload entry, etc.
skipping to change at page 13, line 21 skipping to change at page 14, line 23
item MUST be set to "true". If not provided, the default value item MUST be set to "true". If not provided, the default value
MUST be considered "false". MUST be considered "false".
o software-name (index 1): This textual item provides the software o software-name (index 1): This textual item provides the software
component's name. This name is likely the same name that would component's name. This name is likely the same name that would
appear in a package management tool. appear in a package management tool.
o software-version (index 13): A textual value representing the o software-version (index 13): A textual value representing the
specific release or development version of the software component. specific release or development version of the software component.
o version-scheme (index 14): An 8-bit integer or textual value o version-scheme (index 14): An integer or textual value
representing the versioning scheme used for the software-version representing the versioning scheme used for the software-version
item. If an integer value is used it MUST be a value from the item. If an integer value is used it MUST be an index value in
SWID/CoSWID Version Scheme Value Registry (see section the range -256 to 65535. Integer values in the range -256 to -1
Section 5.2.1 or a value in the private use range: 32768-65535. are reserved for testing and use in closed environments (see
section Section 5.2.2). Integer values in the range 0 to 65535
An initial set of version-scheme index and text values are defined in correspond to registered entries in the IANA "SWID/CoSWID Version
Section 4.1, and are based on the version-scheme values defined in Scheme Value" registry (see section Section 5.2.4. If a string
[SWID]. These pre-defined version-scheme values are registered with value is used it MUST be a private use name as defined in section
IANA in the "SWID/CoSWID Version Scheme Value" registry Section 5.2.2. String values based on a Version Scheme Name from
Section 5.2.1. The values in this registry will likely be expanded the IANA "SWID/CoSWID Version Scheme Value" registry MUST NOT be
in the future. used, as these values are less concise than their index value
equivalent.
The value of an version-scheme item MUST be one of the following:
o The index (preferred) or string value of a role from the IANA in
the "SWID/CoSWID Version Scheme Value" registry.
o An index value in the range 32768 through 65535, to indicate that
a private use index value is used.
o A string value prefixed with "x_", to indicate that a private use
string value is used.
o media (index 10): This text value is a hint to the tag consumer to o media (index 10): This text value is a hint to the tag consumer to
understand what target platform this tag applies to. This item understand what target platform this tag applies to. This item
represents a query as defined by the W3C Media Queries represents a query as defined by the W3C Media Queries
Recommendation (see [W3C.REC-css3-mediaqueries-20120619]). Recommendation (see [W3C.REC-css3-mediaqueries-20120619]).
o software-meta (index 5): An open-ended map of key/value data o software-meta (index 5): An open-ended map of key/value data
pairs. A number of predefined keys can be used within this item pairs. A number of predefined keys can be used within this item
providing for common usage and semantics across the industry. Use providing for common usage and semantics across the industry. Use
of this map allows any additional attribute to be included in the of this map allows any additional attribute to be included in the
tag. It is expected that industry groups will use a common set of tag. It is expected that industry groups will use a common set of
attribute names to allow for interoperability within their attribute names to allow for interoperability within their
communities. Described in Section 2.7. communities. Described in Section 2.8.
o entity (index 2): Provides information about one or more o entity (index 2): Provides information about one or more
organizations responsible for producing the CoSWID tag, and organizations responsible for producing the CoSWID tag, and
producing or releasing the software component referenced by this producing or releasing the software component referenced by this
CoSWID tag. Described in Section 2.5. CoSWID tag. Described in Section 2.6.
o link (index 4): Provides a means to establish relationship arcs o link (index 4): Provides a means to establish relationship arcs
between the tag and another items. A given link can be used to between the tag and another items. A given link can be used to
establish the relationship between tags or to reference another establish the relationship between tags or to reference another
resource that is related to the CoSWID tag, e.g. vulnerability resource that is related to the CoSWID tag, e.g. vulnerability
database association, ROLIE feed [RFC8322], MUD resource database association, ROLIE feed [RFC8322], MUD resource
[RFC8520], software download location, etc). This is modeled [RFC8520], software download location, etc). This is modeled
after the HTML "link" element. Described in Section 2.6. after the HTML "link" element. Described in Section 2.7.
o payload (index 6): This item represents a collection of software o payload (index 6): This item represents a collection of software
artifacts (described by child items) that compose the target artifacts (described by child items) that compose the target
software. For example, these artifacts could be the files software. For example, these artifacts could be the files
included with an installer for a corpus tag or installed on an included with an installer for a corpus tag or installed on an
endpoint when the software component is installed for a primary or endpoint when the software component is installed for a primary or
patch tag. The artifacts listed in a payload may be a superset of patch tag. The artifacts listed in a payload may be a superset of
the software artifacts that are actually installed. Based on user the software artifacts that are actually installed. Based on user
selections at install time, an installation might not include selections at install time, an installation might not include
every artifact that could be created or executed on the endpoint every artifact that could be created or executed on the endpoint
when the software component is installed or run. Described in when the software component is installed or run. Described in
Section 2.8.3. Section 2.9.3.
o evidence-entry (index 3): This item can be used to record the o evidence-entry (index 3): This item can be used to record the
results of a software discovery process used to identify untagged results of a software discovery process used to identify untagged
software on an endpoint or to represent indicators for why software on an endpoint or to represent indicators for why
software is believed to be installed on the endpoint. In either software is believed to be installed on the endpoint. In either
case, a CoSWID tag can be created by the tool performing an case, a CoSWID tag can be created by the tool performing an
analysis of the software components installed on the endpoint. analysis of the software components installed on the endpoint.
Described in Section 2.8.4. Described in Section 2.9.4.
o $$coswid-extension: This CDDL socket is used to add new o $$coswid-extension: This CDDL socket is used to add new
information structures to the concise-swid-tag root map. See information structures to the concise-swid-tag root map. See
Section 2.1. Section 2.2.
2.3. concise-swid-tag Co-constraints 2.4. concise-swid-tag Co-constraints
The following co-constraints apply to the information provided in the The following co-constraints apply to the information provided in the
concise-swid-tag group. concise-swid-tag group.
o The patch and supplemental items MUST NOT both be set to "true". o The patch and supplemental items MUST NOT both be set to "true".
o If the patch item is set to "true", the tag SHOULD contain at o If the patch item is set to "true", the tag SHOULD contain at
least one link item with both the rel(ation) item value of least one link item (see section Section 2.7) with both the
"patches" and an href item specifying an association with the rel(ation) item value of "patches" and an href item specifying an
software that was patched. association with the software that was patched.
o If the supplemental item is set to "true", the tag SHOULD contain o If the supplemental item is set to "true", the tag SHOULD contain
at least one link item with both the rel(ation) item value of at least one link item with both the rel(ation) item value of
"supplements" and an href item specifying an association with the "supplements" and an href item specifying an association with the
software that is supplemented. software that is supplemented.
o If all of the corpus, patch, and supplemental items are "false", o If all of the corpus, patch, and supplemental items are "false",
or if the corpus item is set to "true", then a software-version or if the corpus item is set to "true", then a software-version
item MUST be included with a value set to the version of the item MUST be included with a value set to the version of the
software component. This ensures that primary and corpus tags software component. This ensures that primary and corpus tags
have an identifiable software version. have an identifiable software version.
2.4. The global-attributes Group 2.5. The global-attributes Group
The global-attributes group provides a list of items, including an The global-attributes group provides a list of items, including an
optional language definition to support the processing of text-string optional language definition to support the processing of text-string
values, and an unbounded set of any-attribute items allowing for values, and an unbounded set of any-attribute items allowing for
additional items to be provided as a general point of extension in additional items to be provided as a general point of extension in
the model. the model.
The CDDL for the global-attributes follows: The CDDL for the global-attributes follows:
global-attributes = ( global-attributes = (
skipping to change at page 16, line 10 skipping to change at page 17, line 5
language tag. Thus, a new context is established when a language tag. Thus, a new context is established when a
descendant object redefines a new language tag. All textual descendant object redefines a new language tag. All textual
values within a given context MUST be considered expressed in the values within a given context MUST be considered expressed in the
specified language. specified language.
o any-attribute: This sub-group provides a means to include o any-attribute: This sub-group provides a means to include
arbitrary information via label ("key") value pairs. Labels can arbitrary information via label ("key") value pairs. Labels can
be either a single integer or text string. Values can be a single be either a single integer or text string. Values can be a single
integer, a text string, or an array of integers or text strings. integer, a text string, or an array of integers or text strings.
2.5. The entity-entry Group 2.6. The entity-entry Group
The CDDL for the entity-entry group follows: The CDDL for the entity-entry group follows:
entity-entry = { entity-entry = {
global-attributes, global-attributes,
entity-name => text, entity-name => text,
? reg-id => any-uri, ? reg-id => any-uri,
role => $role / [ 2* $role ], role => $role / [ 2* $role ],
? thumbprint => hash-entry, ? thumbprint => hash-entry,
* $$entity-extension, * $$entity-extension,
skipping to change at page 16, line 42 skipping to change at page 17, line 37
$role /= uint / text $role /= uint / text
tag-creator=1 tag-creator=1
software-creator=2 software-creator=2
aggregator=3 aggregator=3
distributor=4 distributor=4
licensor=5 licensor=5
The following describes each child item of this group. The following describes each child item of this group.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.5.
o entity-name (index 32): The textual name of the organizational o entity-name (index 32): The textual name of the organizational
entity claiming the roles specified by the role item for the entity claiming the roles specified by the role item for the
CoSWID tag. CoSWID tag.
o reg-id (index 32): The registration id value is intended to o reg-id (index 32): The registration id value is intended to
uniquely identify a naming authority in a given scope (e.g. uniquely identify a naming authority in a given scope (e.g.
global, organization, vendor, customer, administrative domain, global, organization, vendor, customer, administrative domain,
etc.) for the referenced entity. The value of an registration ID etc.) for the referenced entity. The value of an registration ID
MUST be a RFC 3986 URI. The scope SHOULD be the scope of an MUST be a RFC 3986 URI. The scope SHOULD be the scope of an
organization. In a given scope, the registration id MUST be used organization. In a given scope, the registration id MUST be used
consistently for CoSWID tag production. consistently for CoSWID tag production.
o role (index 33): The relationship(s) between the entity, and this o role (index 33): An integer or textual value representing the
tag or the referenced software component. Use of index values relationship(s) between the entity, and this tag or the referenced
instead of text for these pre-defined roles allows a CoSWID to be software component. If an integer value is used it MUST be an
more concise. index value in the range -256 to 255. Integer values in the range
-256 to -1 are reserved for testing and use in closed environments
An initial set of role index and text values are defined in (see section Section 5.2.2). Integer values in the range 0 to 255
Section 4.2, and are based on the roles defined in [SWID]. These correspond to registered entries in the IANA "SWID/CoSWID Entity
pre-defined roles are registered with IANA in the "SWID/CoSWID Role Value" registry (see section Section 5.2.5. If a string
Entity Role Value" registry Section 5.2.2. The values in this value is used it MUST be a private use name as defined in section
registry will likely be expanded in the future. Section 5.2.2. String values based on a Role Name from the IANA
"SWID/CoSWID Entity Role Value" registry MUST NOT be used, as
The value of a role item MUST be one of the following: these values are less concise than their index value equivalent.
* The index (preferred) or string value of a role from the IANA
in the "SWID/CoSWID Entity Role Value" registry.
* An index value in the range 128 through 255, to indicate that a
private use index value is used.
* A string value prefixed with "x_", to indicate that a private
use string value is used.
The following additional requirements exist for the use of the The following additional requirements exist for the use of the
"role" item: "role" item:
* An entity item MUST be provided with the role of "tag-creator" * An entity item MUST be provided with the role of "tag-creator"
for every CoSWID tag. This indicates the organization that for every CoSWID tag. This indicates the organization that
created the CoSWID tag. created the CoSWID tag.
* An entity item SHOULD be provided with the role of "software- * An entity item SHOULD be provided with the role of "software-
creator" for every CoSWID tag, if this information is known to creator" for every CoSWID tag, if this information is known to
skipping to change at page 17, line 50 skipping to change at page 18, line 36
o thumbprint (index 34): The value of the thumbprint item provides o thumbprint (index 34): The value of the thumbprint item provides
an integer-based hash algorithm identifier (hash-alg-id) and a an integer-based hash algorithm identifier (hash-alg-id) and a
byte string value (hash-value) that contains the corresponding byte string value (hash-value) that contains the corresponding
hash value (i.e. the thumbprint) of the signing entity's public hash value (i.e. the thumbprint) of the signing entity's public
key certificate. This provides an indicator of which entity key certificate. This provides an indicator of which entity
signed the CoSWID tag, which will typically be the tag creator. signed the CoSWID tag, which will typically be the tag creator.
If the hash-alg-id is not known, then the integer value "0" MUST If the hash-alg-id is not known, then the integer value "0" MUST
be used. This ensures parity between the SWID tag specification be used. This ensures parity between the SWID tag specification
[SWID], which does not allow an algorithm to be identified for [SWID], which does not allow an algorithm to be identified for
this field. See Section 2.8.1 for more details on the use of the this field. See Section 2.9.1 for more details on the use of the
hash-entry data structure. hash-entry data structure.
o $$entity-extension: This CDDL socket can be used to extend the o $$entity-extension: This CDDL socket can be used to extend the
entity-entry group model. See Section 2.1. entity-entry group model. See Section 2.2.
2.6. The link-entry Map 2.7. The link-entry Map
The CDDL for the link-entry map follows: The CDDL for the link-entry map follows:
link-entry = { link-entry = {
global-attributes, global-attributes,
? artifact => text, ? artifact => text,
href => any-uri, href => any-uri,
? media => text, ? media => text,
? ownership => $ownership, ? ownership => $ownership,
rel => $rel, rel => $rel,
skipping to change at page 19, line 25 skipping to change at page 20, line 12
$use /= required $use /= required
$use /= recommended $use /= recommended
$use /= uint / text $use /= uint / text
optional=1 optional=1
required=2 required=2
recommended=3 recommended=3
The following describes each member of this map. The following describes each member of this map.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.5.
o artifact (index: 37): To be used with rel="installation-media", o artifact (index: 37): To be used with rel="installation-media",
this item's value provides the path to the installer executable or this item's value provides the path to the installer executable or
script that can be run to launch the referenced installation. script that can be run to launch the referenced installation.
Links with the same artifact name MUST be considered mirrors of Links with the same artifact name MUST be considered mirrors of
each other, allowing the installation media to be acquired from each other, allowing the installation media to be acquired from
any of the described sources. any of the described sources.
o href (index 38): A URI for the referenced resource. The "href" o href (index 38): A URI for the referenced resource. The "href"
item's value can be, but is not limited to, the following (which item's value can be, but is not limited to, the following (which
is a slightly modified excerpt from [SWID]): is a slightly modified excerpt from [SWID]):
* If no URI scheme is provided, then the URI is to be interpreted * If no URI scheme is provided, then the URI is to be interpreted
as being relative to the URI of the CoSWID tag. For example, as being relative to the URI of the CoSWID tag. For example,
"./folder/supplemental.coswid". "./folder/supplemental.coswid".
* a physical resource location with any acceptable URI scheme * a physical resource location with any acceptable URI scheme
(e.g., file:// http:// https:// ftp://) (e.g., file:// http:// https:// ftp://)
* a URI with "swid:" as the scheme, which refers to another SWID * a URI with "swid:" as the scheme refers to another SWID or
or CoSWID by tag-id. This URI would need to be resolved in the CoSWID by the referenced tag's tag-id. This URI needs to be
context of the endpoint by software that can lookup other SWID resolved in the context of the endpoint by software that can
or CoSWID tags. For example, "swid:2df9de35-0aff- lookup other SWID or CoSWID tags. For example, "swid:2df9de35-
4a86-ace6-f7dddd1ade4c" references the tag with the tag-id 0aff-4a86-ace6-f7dddd1ade4c" references the tag with the tag-id
value "2df9de35-0aff-4a86-ace6-f7dddd1ade4c". value "2df9de35-0aff-4a86-ace6-f7dddd1ade4c".
* a URI with "swidpath:" as the scheme, which refers to another * a URI with "swidpath:" as the scheme, which refers to another
CoSIWD via an XPATH query. This URI would need to be resolved CoSIWD via an XPATH query. This URI would need to be resolved
in the context of the system entity via software components in the context of the system entity via software components
that can lookup other CoSWID tags and select the appropriate that can lookup other CoSWID tags and select the appropriate
tag based on an XPATH query [W3C.REC-xpath20-20101214]. tag based on an XPATH query [W3C.REC-xpath20-20101214].
Examples include: Examples include:
skipping to change at page 20, line 26 skipping to change at page 21, line 14
+ swidpath://SoftwareIdentity[Meta/@persistentId='b0c55172-38e + swidpath://SoftwareIdentity[Meta/@persistentId='b0c55172-38e
9-4e36-be86-92206ad8eddb'] would match all SWID or CoSWID 9-4e36-be86-92206ad8eddb'] would match all SWID or CoSWID
tags with the persistent-id value tags with the persistent-id value
"b0c55172-38e9-4e36-be86-92206ad8eddb" "b0c55172-38e9-4e36-be86-92206ad8eddb"
o media (index 10): A hint to the consumer of the link to what o media (index 10): A hint to the consumer of the link to what
target platform the link is applicable to. This item represents a target platform the link is applicable to. This item represents a
query as defined by the W3C Media Queries Recommendation (see query as defined by the W3C Media Queries Recommendation (see
[W3C.REC-css3-mediaqueries-20120619]). See also media defined in [W3C.REC-css3-mediaqueries-20120619]). See also media defined in
Section 2.2. Section 2.3.
o ownership (index 39): Used when the "href" item references another
software component to indicate the degree of ownership between the
software component referenced by the COSWID tag and the software
component referenced by the link.
An initial set of ownership index and text values are defined in
Section 4.3, and are based on the ownership values defined in
[SWID]. These pre-defined ownership values are registered with
IANA in the "SWID/CoSWID Link Ownership Value" registry
Section 5.2.3. The values in this registry will likely be
expanded in the future.
The value of an ownership item MUST be one of the following:
* The index (preferred) or string value of a role from the IANA
in the "SWID/CoSWID Link Ownership Value" registry.
* An index value in the range 128 through 255, to indicate that a
private use index value is used.
* A string value prefixed with "x_", to indicate that a private
use string value is used.
o rel (index 40): Identifies the relationship between this CoSWID
and the target resource indicated by the "href" item.
An initial set of rel index and text values are defined in
Section 4.4, and are based on the rel values defined in [SWID].
These pre-defined rel values are registered with IANA in the
"SWID/CoSWID Link Relationship Value" registry Section 5.2.4. The
values in this registry will likely be expanded in the future.
The value of a rel item MUST be one of the following:
* The index (preferred) or string value of a role from the IANA
in the "SWID/CoSWID Link Relationship Value" registry.
* An index value in the range 128 through 255, to indicate that a
private use index value is used.
* A string value prefixed with "x_", to indicate that a private o ownership (index 39): An integer or textual value used when the
use string value is used. "href" item references another software component to indicate the
degree of ownership between the software component referenced by
the COSWID tag and the software component referenced by the link.
If an integer value is used it MUST be an index value in the range
-256 to 255. Integer values in the range -256 to -1 are reserved
for testing and use in closed environments (see section
Section 5.2.2). Integer values in the range 0 to 255 correspond
to registered entries in the IANA "SWID/CoSWID Link Ownership
Value" registry (see section Section 5.2.6. If a string value is
used it MUST be a private use name as defined in section
Section 5.2.2. String values based on a Ownership Type Name from
the IANA "SWID/CoSWID Link Ownership Value" registry MUST NOT be
used, as these values are less concise than their index value
equivalent.
* A string value, as defined by [RFC8288], corresponding to a o rel (index 40): An integer or textual value that identifies the
"Relation Name" from the IANA "Link Relation Types" registry: relationship between this CoSWID and the target resource
https://www.iana.org/assignments/link-relations/link- identified by the "href" item. If an integer value is used it
relations.xhtml. When a string value defined in the IANA MUST be an index value in the range -256 to 65535. Integer values
"SWID/CoSWID Link Relationship Value" registry matches a in the range -256 to -1 are reserved for testing and use in closed
Relation Name defined in the IANA "Link Relation Types" environments (see section Section 5.2.2). Integer values in the
registry, the value in the IANA "SWID/CoSWID Link Relationship range 0 to 65535 correspond to registered entries in the IANA
Value" registry MUST be used instead, as this relationship has "SWID/CoSWID Link Relationship Value" registry (see section
a specialized meaning in the context of a SWID/CoSWID tag. Section 5.2.7. If a string value is used it MUST be either a
private use name as defined in section Section 5.2.2 or a
"Relation Name" from the IANA "Link Relation Types" registry:
https://www.iana.org/assignments/link-relations/link-
relations.xhtml as defined by [RFC8288]. When a string value
defined in the IANA "SWID/CoSWID Link Relationship Value" registry
matches a Relation Name defined in the IANA "Link Relation Types"
registry, the index value in the IANA "SWID/CoSWID Link
Relationship Value" registry MUST be used instead, as this
relationship has a specialized meaning in the context of a SWID/
CoSWID tag. String values based on a Relationship Type Name from
the IANA "SWID/CoSWID Link Relationship Value" registry MUST NOT
be used, as these values are less concise than their index value
equivalent.
o media-type (index 41): A link can point to arbitrary resources on o media-type (index 41): A link can point to arbitrary resources on
the endpoint, local network, or Internet using the href item. Use the endpoint, local network, or Internet using the href item. Use
of this item supplies the resource consumer with a hint of what of this item supplies the resource consumer with a hint of what
type of resource to expect. Media types are identified by type of resource to expect. Media types are identified by
referencing a "Name" from the IANA "Media Types" registry: referencing a "Name" from the IANA "Media Types" registry:
http://www.iana.org/assignments/media-types/media-types.xhtml. http://www.iana.org/assignments/media-types/media-types.xhtml.
o use (index 42): Determines if the referenced software component o use (index 42): An integer or textual value used to determine if
has to be installed before installing the software component the referenced software component has to be installed before
identified by the tag. installing the software component identified by the COSWID tag.
If an integer value is used it MUST be an index value in the range
An initial set of use index and text values are defined in -256 to 255. Integer values in the range -256 to -1 are reserved
Section 4.5, and are based on the use values defined in [SWID]. for testing and use in closed environments (see section
These pre-defined use values are registered with IANA in the Section 5.2.2). Integer values in the range 0 to 255 correspond
"SWID/CoSWID Link Use Value" registry Section 5.2.5. The values to registered entries in the IANA "Link Use Value Value" registry
in this registry will likely be expanded in the future. (see section Section 5.2.8. If a string value is used it MUST be
a private use name as defined in section Section 5.2.2. String
The value of an ownership item MUST be one of the following: values based on an Link Use Type Name from the IANA "SWID/CoSWID
Link Use Value" registry MUST NOT be used, as these values are
* The index (preferred) or string value of a role from the IANA less concise than their index value equivalent.
in the "SWID/CoSWID Link Use Value" registry.
* An index value in the range 128 through 255, to indicate that a
private use index value is used.
* A string value prefixed with "x_", to indicate that a private
use string value is used.
o $$link-extension: This CDDL socket can be used to extend the link- o $$link-extension: This CDDL socket can be used to extend the link-
entry map model. See Section 2.1. entry map model. See Section 2.2.
2.7. The software-meta-entry Map 2.8. The software-meta-entry Map
The CDDL for the software-meta-entry map follows: The CDDL for the software-meta-entry map follows:
software-meta-entry = { software-meta-entry = {
global-attributes, global-attributes,
? activation-status => text, ? activation-status => text,
? channel-type => text, ? channel-type => text,
? colloquial-version => text, ? colloquial-version => text,
? description => text, ? description => text,
? edition => text, ? edition => text,
skipping to change at page 23, line 4 skipping to change at page 23, line 39
entitlement-data-required = 48 entitlement-data-required = 48
entitlement-key = 49 entitlement-key = 49
generator = 50 generator = 50
persistent-id = 51 persistent-id = 51
product = 52 product = 52
product-family = 53 product-family = 53
revision = 54 revision = 54
summary = 55 summary = 55
unspsc-code = 56 unspsc-code = 56
unspsc-version = 57 unspsc-version = 57
The following describes each child item of this group. The following describes each child item of this group.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.5.
o activation-status (index 43): A textual value that identifies how o activation-status (index 43): A textual value that identifies how
the software component has been activated, which might relate to the software component has been activated, which might relate to
specific terms and conditions for its use (e.g. Trial, specific terms and conditions for its use (e.g. Trial,
Serialized, Licensed, Unlicensed, etc) and relate to an Serialized, Licensed, Unlicensed, etc) and relate to an
entitlement. This attribute is typically used in supplemental entitlement. This attribute is typically used in supplemental
tags as it contains information that might be selected during a tags as it contains information that might be selected during a
specific install. specific install.
o channel-type (index 44): A textual value that identfies which o channel-type (index 44): A textual value that identfies which
skipping to change at page 23, line 38 skipping to change at page 24, line 26
that are part of the same release/support cycle. This version can that are part of the same release/support cycle. This version can
be the same through multiple releases of a software component, be the same through multiple releases of a software component,
while the software-version specified in the concise-swid-tag group while the software-version specified in the concise-swid-tag group
is much more specific and will change for each software component is much more specific and will change for each software component
release. This version is intended to be used for string release. This version is intended to be used for string
comparison only and is not intended to be used to determine if a comparison only and is not intended to be used to determine if a
specific value is earlier or later in a sequence. specific value is earlier or later in a sequence.
o description (index 46): A textual value that provides a detailed o description (index 46): A textual value that provides a detailed
description of the software component. This value MAY be multiple description of the software component. This value MAY be multiple
sentences. paragraphs separated by CR LF characters as described by
[RFC5198].
o edition (index 47): A textual value indicating that the software o edition (index 47): A textual value indicating that the software
component represents a functional variation of the code base used component represents a functional variation of the code base used
to support multiple software components. For examplem, this item to support multiple software components. For example, this item
can be used to differentiate enterprise, standard, or professional can be used to differentiate enterprise, standard, or professional
variants of a software component. variants of a software component.
o entitlement-data-required (index 48): A boolean value that can be o entitlement-data-required (index 48): A boolean value that can be
used to determine if accompanying proof of entitlement is needed used to determine if accompanying proof of entitlement is needed
when a software license reconciliation process is performed. when a software license reconciliation process is performed.
o entitlement-key (index 49): A vendor-specific textual key that can o entitlement-key (index 49): A vendor-specific textual key that can
be used to identify and establish a relationship to an be used to identify and establish a relationship to an
entitlement. Examples of an entitlement-key might include a entitlement. Examples of an entitlement-key might include a
skipping to change at page 25, line 10 skipping to change at page 25, line 44
version specified in the concise-swid-tag group. This is useful version specified in the concise-swid-tag group. This is useful
when one or more releases need to have an informal version label when one or more releases need to have an informal version label
that differs from the specific exact version value specified by that differs from the specific exact version value specified by
software-version. Examples can include SP1, RC1, Beta, etc. software-version. Examples can include SP1, RC1, Beta, etc.
o summary (index 55): A short description of the software component. o summary (index 55): A short description of the software component.
This MUST be a single sentence suitable for display in a user This MUST be a single sentence suitable for display in a user
interface. interface.
o unspsc-code (index 56): An 8 digit UNSPSC classification code for o unspsc-code (index 56): An 8 digit UNSPSC classification code for
the software component. For more information see, the software component. For more information see
http://www.unspsc.org/. https://www.unspsc.org/.
o unspsc-version (index 57): The version of UNSPSC used to define o unspsc-version (index 57): The version of UNSPSC used to define
the unspsc-code value. the unspsc-code value.
o $$meta-extension: This CDDL socket can be used to extend the o $$meta-extension: This CDDL socket can be used to extend the
software-meta-entry group model. See Section 2.1. software-meta-entry group model. See Section 2.2.
2.8. The Resource Collection Definition 2.9. The Resource Collection Definition
2.8.1. The hash-entry Array 2.9.1. The hash-entry Array
CoSWID adds explicit support for the representation of hash entries CoSWID adds explicit support for the representation of hash entries
using algorithms that are registered in the IANA "Named Information using algorithms that are registered in the IANA "Named Information
Hash Algorithm Registry" using the hash-entry member (label 58). Hash Algorithm Registry" using the hash-entry member (label 58).
hash-entry = [ hash-alg-id: int, hash-value: bytes ] hash-entry = [ hash-alg-id: int, hash-value: bytes ]
The number used as a value for hash-alg-id MUST refer an ID in the The number used as a value for hash-alg-id MUST refer an ID in the
"Named Information Hash Algorithm Registry" (see "Named Information Hash Algorithm Registry" (see
https://www.iana.org/assignments/named-information/named- https://www.iana.org/assignments/named-information/named-
information.xhtml); other hash algorithms MUST NOT be used. The information.xhtml); other hash algorithms MUST NOT be used. The
hash-value MUST represent the raw hash value of the hashed resource hash-value MUST represent the raw hash value of the hashed resource
generated using the hash algorithm indicated by the hash-alg-id. generated using the hash algorithm indicated by the hash-alg-id.
2.8.2. The resource-collection Group 2.9.2. The resource-collection Group
A list of items both used in evidence (created by a software A list of items both used in evidence (created by a software
discovery process) and payload (installed in an endpoint) content of discovery process) and payload (installed in an endpoint) content of
a CoSWID tag document to structure and differentiate the content of a CoSWID tag document to structure and differentiate the content of
specific CoSWID tag types. Potential content includes directories, specific CoSWID tag types. Potential content includes directories,
files, processes, or resources. files, processes, or resources.
The CDDL for the resource-collection group follows: The CDDL for the resource-collection group follows:
resource-collection = ( resource-collection = (
skipping to change at page 27, line 18 skipping to change at page 28, line 6
type = 29 type = 29
The following describes each member of the groups and maps The following describes each member of the groups and maps
illustrated above. illustrated above.
o filesystem-item: A list of common items used for representing the o filesystem-item: A list of common items used for representing the
filesystem root, relative location, name, and significance of a filesystem root, relative location, name, and significance of a
file or directory item. file or directory item.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.5.
o directory (index 16): A directory item allows child directory and o directory (index 16): A directory item allows child directory and
file items to be defined within a directory hierarchy for the file items to be defined within a directory hierarchy for the
software component. software component.
o file (index 17): A file item allows details about a file to be o file (index 17): A file item allows details about a file to be
provided for the software component. provided for the software component.
o process (index 18): A process item allows details to be provided o process (index 18): A process item allows details to be provided
about the runtime behavior of the software component, such as about the runtime behavior of the software component, such as
skipping to change at page 28, line 21 skipping to change at page 29, line 7
o fs-name (index 24): The name of the directory or file without any o fs-name (index 24): The name of the directory or file without any
path information. path information.
o root (index 25): A filesystem-specific name for the root of the o root (index 25): A filesystem-specific name for the root of the
filesystem. The location item is considered relative to this filesystem. The location item is considered relative to this
location if specified. If not provided, the value provided by the location if specified. If not provided, the value provided by the
location item is expected to be relative to its parent or the location item is expected to be relative to its parent or the
location of the CoSWID tag if no parent is provided. location of the CoSWID tag if no parent is provided.
o path-elements (index 26): This group allows a heirarchy of o path-elements (index 26): This group allows a hierarchy of
directory and file items to be defined in payload or evidence directory and file items to be defined in payload or evidence
items. items.
o process-name (index 27): The software component's process name as o process-name (index 27): The software component's process name as
it will appear in an endpoint's process list. it will appear in an endpoint's process list.
o pid (index 28): The process ID identified for a running instance o pid (index 28): The process ID identified for a running instance
of the software component in the endpoint's process list. This is of the software component in the endpoint's process list. This is
used as part of the evidence item. used as part of the evidence item.
o type (index 29): A string indicating the type of resource. o type (index 29): A string indicating the type of resource.
o $$resource-collection-extension: This CDDL socket can be used to o $$resource-collection-extension: This CDDL socket can be used to
extend the resource-collection group model. This can be used to extend the resource-collection group model. This can be used to
add new specialized types of resources. See Section 2.1. add new specialized types of resources. See Section 2.2.
o $$file-extension: This CDDL socket can be used to extend the file- o $$file-extension: This CDDL socket can be used to extend the file-
entry group model. See Section 2.1. entry group model. See Section 2.2.
o $$directory-extension: This CDDL socket can be used to extend the o $$directory-extension: This CDDL socket can be used to extend the
directory-entry group model. See Section 2.1. directory-entry group model. See Section 2.2.
o $$process-extension: This CDDL socket can be used to extend the o $$process-extension: This CDDL socket can be used to extend the
process-entry group model. See Section 2.1. process-entry group model. See Section 2.2.
o $$resource-extension: This CDDL socket can be used to extend the o $$resource-extension: This CDDL socket can be used to extend the
group model. See Section 2.1. group model. See Section 2.2.
o $$-extension: This CDDL socket can be used to extend the resource- o $$-extension: This CDDL socket can be used to extend the resource-
entry group model. See Section 2.1. entry group model. See Section 2.2.
2.8.3. The payload-entry Group 2.9.3. The payload-entry Group
The CDDL for the payload-entry group follows: The CDDL for the payload-entry group follows:
payload-entry = { payload-entry = {
global-attributes, global-attributes,
resource-collection, resource-collection,
* $$payload-extension * $$payload-extension
} }
The following describes each child item of this group. The following describes each child item of this group.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.5.
o resource-collection: The resource-collection group described in o resource-collection: The resource-collection group described in
Section 2.8.2. Section 2.9.2.
o $$payload-extension: This CDDL socket can be used to extend the o $$payload-extension: This CDDL socket can be used to extend the
payload-entry group model. See Section 2.1. payload-entry group model. See Section 2.2.
2.8.4. The evidence-entry Group 2.9.4. The evidence-entry Group
The CDDL for the evidence-entry group follows: The CDDL for the evidence-entry group follows:
evidence-entry = { evidence-entry = {
global-attributes, global-attributes,
resource-collection, resource-collection,
? date => time, ? date => time,
? device-id => text, ? device-id => text,
* $$evidence-extension * $$evidence-extension
} }
date = 35 date = 35
device-id = 36 device-id = 36
The following describes each child item of this group. The following describes each child item of this group.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.5.
o resource-collection: The resource-collection group described in o resource-collection: The resource-collection group described in
Section 2.8.2. Section 2.9.2.
o date (index 35): The date and time the information was collected o date (index 35): The date and time the information was collected
pertaining to the evidence item. pertaining to the evidence item.
o device-id (index 36): The endpoint's string identifier from which o device-id (index 36): The endpoint's string identifier from which
the evidence was collected. the evidence was collected.
o $$evidence-extension: This CDDL socket can be used to extend the o $$evidence-extension: This CDDL socket can be used to extend the
evidence-entry group model. See Section 2.1. evidence-entry group model. See Section 2.2.
2.9. Full CDDL Definition 2.10. Full CDDL Definition
In order to create a valid CoSWID document the structure of the In order to create a valid CoSWID document the structure of the
corresponding CBOR message MUST adhere to the following CDDL data corresponding CBOR message MUST adhere to the following CDDL data
definition. definition.
concise-swid-tag = { concise-swid-tag = {
global-attributes, global-attributes,
tag-id => text, tag-id => text / bstr .size 16,
tag-version => integer, tag-version => integer,
? corpus => bool, ? corpus => bool,
? patch => bool, ? patch => bool,
? supplemental => bool, ? supplemental => bool,
software-name => text, software-name => text,
? software-version => text, ? software-version => text,
? version-scheme => $version-scheme, ? version-scheme => $version-scheme,
? media => text, ? media => text,
? software-meta => software-meta-entry / [ 2* software-meta-entry ], ? software-meta => software-meta-entry / [ 2* software-meta-entry ],
entity => entity-entry / [ 2* entity-entry ], entity => entity-entry / [ 2* entity-entry ],
skipping to change at page 37, line 10 skipping to change at page 37, line 30
Index value indicates the value to use as the version-scheme item's Index value indicates the value to use as the version-scheme item's
value. The Version Scheme Name provides human-readable text for the value. The Version Scheme Name provides human-readable text for the
value. The Definition describes the syntax of allowed values for value. The Definition describes the syntax of allowed values for
each entry. each entry.
+-------+-------------------------+---------------------------------+ +-------+-------------------------+---------------------------------+
| Index | Version Scheme Name | Definition | | Index | Version Scheme Name | Definition |
+-------+-------------------------+---------------------------------+ +-------+-------------------------+---------------------------------+
| 1 | multipartnumeric | Numbers separated by dots, | | 1 | multipartnumeric | Numbers separated by dots, |
| | | where the numbers are | | | | where the numbers are |
| | | interpreted as integers | | | | interpreted as integers (e.g., |
| | | (e.g.,1.2.3, 1.4.5, | | | | 1.2.3, 1.4.5, 1.2.3.4.5.6.7) |
| | | 1.2.3.4.5.6.7) |
| | | | | | | |
| 2 | multipartnumeric+suffix | Numbers separated by dots, | | 2 | multipartnumeric+suffix | Numbers separated by dots, |
| | | where the numbers are | | | | where the numbers are |
| | | interpreted as integers with an | | | | interpreted as integers with an |
| | | additional textual suffix | | | | additional textual suffix |
| | | (e.g., 1.2.3a) | | | | (e.g., 1.2.3a) |
| | | | | | | |
| 3 | alphanumeric | Strictly a string, sorting is | | 3 | alphanumeric | Strictly a string, sorting is |
| | | done alphanumerically | | | | done alphanumerically |
| | | | | | | |
| 4 | decimal | A floating point number (e.g., | | 4 | decimal | A floating point number (e.g., |
| | | 1.25 is less than 1.3) | | | | 1.25 is less than 1.3) |
| | | | | | | |
| 16384 | semver | Follows the [SEMVER] | | 16384 | semver | Follows the [SEMVER] |
| | | specification | | | | specification |
+-------+-------------------------+---------------------------------+ +-------+-------------------------+---------------------------------+
Table 3: Version Scheme Values Table 3: Version Scheme Values
The values above are registered in the IANA "SWID/CoSWID Version The values above are registered in the IANA "SWID/CoSWID Version
Scheme Value" registry defined in section Section 5.2.1. Additional Scheme Value" registry defined in section Section 5.2.4. Additional
values will likely be registered over time in this registry. entries will likely be registered over time in this registry.
Additionally, the index values 32768 through 65535 and the name
prefix "x_" have been reserved for private use. These version schemes have partially overlapping value spaces. The
following gudelines help to ensure that the most specific version-
scheme is used:
o "decimal" and "multipartnumeric" partially overlap in their value
space when a value matches a decimal number . When a corresponding
software-version item's value falls within this overlapping value
space, the "decimal" version scheme SHOULD be used.
o "multipartnumeric" and "semver" partially overlap in their value
space when a "multipartnumeric" value matches the semantic
versioning syntax. When a corresponding software-version item's
value falls within this overlapping value space, the "semver"
version scheme SHOULD be used.
o "alphanumeric" and other version schemes might overlap in their
value space. When a corresponding software-version item's value
falls within this overlapping value space, the other version
scheme SHOULD be used instead of "alphanumeric".
4.2. Entity Role Values 4.2. Entity Role Values
The following table indicates the index value to use for the entity- The following table indicates the index value to use for the entity-
entry group's role item (see Section 2.5). These values match the entry group's role item (see Section 2.6). These values match the
entity roles defined in the ISO/IEC 19770-2:2015 [SWID] entity roles defined in the ISO/IEC 19770-2:2015 [SWID]
specification. The "Index" value indicates the value to use as the specification. The "Index" value indicates the value to use as the
role item's value. The "Role Name" provides human-readable text for role item's value. The "Role Name" provides human-readable text for
the value. The "Definition" describes the semantic meaning of each the value. The "Definition" describes the semantic meaning of each
entry. entry.
+-------+-----------------+-----------------------------------------+ +-------+-----------------+-----------------------------------------+
| Index | Role Name | Definition | | Index | Role Name | Definition |
+-------+-----------------+-----------------------------------------+ +-------+-----------------+-----------------------------------------+
| 1 | tagCreator | The person or organization that created | | 1 | tagCreator | The person or organization that created |
skipping to change at page 38, line 41 skipping to change at page 39, line 41
| 5 | licensor | From [SAM] as "software licensor", a | | 5 | licensor | From [SAM] as "software licensor", a |
| | | "person or organization who owns or | | | | "person or organization who owns or |
| | | holds the rights to issue a software | | | | holds the rights to issue a software |
| | | license for a specific software | | | | license for a specific software |
| | | [component]" | | | | [component]" |
+-------+-----------------+-----------------------------------------+ +-------+-----------------+-----------------------------------------+
Table 4: Entity Role Values Table 4: Entity Role Values
The values above are registered in the IANA "SWID/CoSWID Entity Role The values above are registered in the IANA "SWID/CoSWID Entity Role
Value" registry defined in section Section 5.2.2. Additional values Value" registry defined in section Section 5.2.5. Additional values
will likely be registered over time. Additionally, the index values will likely be registered over time. Additionally, the index values
128 through 255 and the name prefix "x_" have been reserved for 128 through 255 and the name prefix "x_" have been reserved for
private use. private use.
4.3. Link Ownership Values 4.3. Link Ownership Values
The following table indicates the index value to use for the link- The following table indicates the index value to use for the link-
entry group's ownership item (see Section 2.6). These values match entry group's ownership item (see Section 2.7). These values match
the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID] the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID]
specification. The "Index" value indicates the value to use as the specification. The "Index" value indicates the value to use as the
link-entry group ownership item's value. The "Ownership Type" link-entry group ownership item's value. The "Ownership Type"
provides human-readable text for the value. The "Definition" provides human-readable text for the value. The "Definition"
describes the semantic meaning of each entry. describes the semantic meaning of each entry.
+-------+-----------+-----------------------------------------------+ +-------+-----------+-----------------------------------------------+
| Index | Ownership | Definition | | Index | Ownership | Definition |
| | Type | | | | Type | |
+-------+-----------+-----------------------------------------------+ +-------+-----------+-----------------------------------------------+
skipping to change at page 39, line 29 skipping to change at page 40, line 29
| | | | | | | |
| 3 | shared | If the software component referenced by the | | 3 | shared | If the software component referenced by the |
| | | CoSWID tag is uninstalled, then the | | | | CoSWID tag is uninstalled, then the |
| | | referenced software SHOULD be uninstalled if | | | | referenced software SHOULD be uninstalled if |
| | | no other components sharing the software. | | | | no other components sharing the software. |
+-------+-----------+-----------------------------------------------+ +-------+-----------+-----------------------------------------------+
Table 5: Link Ownership Values Table 5: Link Ownership Values
The values above are registered in the IANA "SWID/CoSWID Link The values above are registered in the IANA "SWID/CoSWID Link
Ownership Value" registry defined in section Section 5.2.3. Ownership Value" registry defined in section Section 5.2.6.
Additional values will likely be registered over time. Additionally, Additional values will likely be registered over time. Additionally,
the index values 128 through 255 and the name prefix "x_" have been the index values 128 through 255 and the name prefix "x_" have been
reserved for private use. reserved for private use.
4.4. Link Rel Values 4.4. Link Rel Values
The following table indicates the index value to use for the link- The following table indicates the index value to use for the link-
entry group's rel item (see Section 2.6). These values match the entry group's rel item (see Section 2.7). These values match the
link rel values defined in the ISO/IEC 19770-2:2015 [SWID] link rel values defined in the ISO/IEC 19770-2:2015 [SWID]
specification. The "Index" value indicates the value to use as the specification. The "Index" value indicates the value to use as the
link-entry group ownership item's value. The "Relationship Type" link-entry group ownership item's value. The "Relationship Type"
provides human-readable text for the value. The "Definition" provides human-readable text for the value. The "Definition"
describes the semantic meaning of each entry. describes the semantic meaning of each entry.
+-------+-------------------+---------------------------------------+ +-------+-------------------+---------------------------------------+
| Index | Relationship Type | Definition | | Index | Relationship Type | Definition |
+-------+-------------------+---------------------------------------+ +-------+-------------------+---------------------------------------+
| 1 | ancestor | The link references a SWID/CoSWID tag | | 1 | ancestor | The link references a SWID/CoSWID tag |
skipping to change at page 41, line 20 skipping to change at page 42, line 20
| | | | | | | |
| 11 | supplemental | The link references a SWID/CoSWID tag | | 11 | supplemental | The link references a SWID/CoSWID tag |
| | | that this tag supplements. Used on | | | | that this tag supplements. Used on |
| | | supplemental SWID/CoSWID tags (see | | | | supplemental SWID/CoSWID tags (see |
| | | Section 1.1). | | | | Section 1.1). |
+-------+-------------------+---------------------------------------+ +-------+-------------------+---------------------------------------+
Table 6: Link Relationship Values Table 6: Link Relationship Values
The values above are registered in the IANA "SWID/CoSWID Link The values above are registered in the IANA "SWID/CoSWID Link
Relationship Value" registry defined in section Section 5.2.4. Relationship Value" registry defined in section Section 5.2.7.
Additional values will likely be registered over time. Additionally, Additional values will likely be registered over time. Additionally,
the index values 32768 through 65535 and the name prefix "x_" have the index values 32768 through 65535 and the name prefix "x_" have
been reserved for private use. been reserved for private use.
4.5. Link Use Values 4.5. Link Use Values
The following table indicates the index value to use for the link- The following table indicates the index value to use for the link-
entry group's use item (see Section 2.6). These values match the entry group's use item (see Section 2.7). These values match the
link use values defined in the ISO/IEC 19770-2:2015 [SWID] link use values defined in the ISO/IEC 19770-2:2015 [SWID]
specification. The "Index" value indicates the value to use as the specification. The "Index" value indicates the value to use as the
link-entry group use item's value. The "Use Type" provides human- link-entry group use item's value. The "Use Type" provides human-
readable text for the value. The "Definition" describes the semantic readable text for the value. The "Definition" describes the semantic
meaning of each entry. meaning of each entry.
+-------+-------------+---------------------------------------------+ +-------+-------------+---------------------------------------------+
| Index | Use Type | Definition | | Index | Use Type | Definition |
+-------+-------------+---------------------------------------------+ +-------+-------------+---------------------------------------------+
| 1 | optional | From [SWID], "Not absolutely required; the | | 1 | optional | From [SWID], "Not absolutely required; the |
skipping to change at page 42, line 6 skipping to change at page 43, line 6
| | | software installation." | | | | software installation." |
| | | | | | | |
| 3 | recommended | From [SWID], "Not absolutely required; the | | 3 | recommended | From [SWID], "Not absolutely required; the |
| | | [Link]'d software is installed unless | | | | [Link]'d software is installed unless |
| | | specified otherwise." | | | | specified otherwise." |
+-------+-------------+---------------------------------------------+ +-------+-------------+---------------------------------------------+
Table 7: Link Use Values Table 7: Link Use Values
The values above are registered in the IANA "SWID/CoSWID Link Use The values above are registered in the IANA "SWID/CoSWID Link Use
Value" registry defined in section Section 5.2.5. Additional values Value" registry defined in section Section 5.2.8. Additional values
will likely be registered over time. Additionally, the index values will likely be registered over time. Additionally, the index values
128 through 255 and the name prefix "x_" have been reserved for 128 through 255 and the name prefix "x_" have been reserved for
private use. private use.
5. IANA Considerations 5. IANA Considerations
This document has a number of IANA considerations, as described in This document has a number of IANA considerations, as described in
the following subsections. the following subsections.
5.1. CoSWID Items Registry 5.1. CoSWID Items Registry
This document uses integer values as index values in CBOR maps. This document uses integer values as index values in CBOR maps.
This document defines a new a new registry titled "CoSWID Items". This document defines a new registry titled "CoSWID Items". Future
Future registrations for this registry are to be made based on registrations for this registry are to be made based on [RFC8126] as
[RFC8126] as follows: follows:
+------------------+-------------------------+ +------------------+-------------------------+
| Range | Registration Procedures | | Range | Registration Procedures |
+------------------+-------------------------+ +------------------+-------------------------+
| 0-32767 | Standards Action | | 0-32767 | Standards Action |
| | | | | |
| 32768-4294967295 | Specification Required | | 32768-4294967295 | Specification Required |
+------------------+-------------------------+ +------------------+-------------------------+
Table 8: CoSWID Items Registration Proceedures Table 8: CoSWID Items Registration Proceedures
skipping to change at page 45, line 22 skipping to change at page 46, line 22
| 58-4294967295 | Unassigned | | | 58-4294967295 | Unassigned | |
+---------------+---------------------------+---------------+ +---------------+---------------------------+---------------+
Table 9: CoSWID Items Inital Registrations Table 9: CoSWID Items Inital Registrations
5.2. SWID/CoSWID Value Registries 5.2. SWID/CoSWID Value Registries
The following IANA registries provide a mechanism for new values to The following IANA registries provide a mechanism for new values to
be added over time to common enumerations used by SWID and CoSWID. be added over time to common enumerations used by SWID and CoSWID.
5.2.1. SWID/CoSWID Version Scheme Value Registry 5.2.1. Registration Proceedures
This document uses unsigned 16-bit index values to represent version- The following registries allow for the registration of index values
scheme item values. The initial set of version-scheme values are and names. New registrations will be permitted through either the
derived from the textual version scheme names defined in the ISO/IEC Standards Action policy or the Specification Required policy [BCP26].
19770-2:2015 specification [SWID]. The latter SHOULD be used only for registrations requested by SDOs
outside the IETF. New index values will be provided on a First Come
First Served as defined by [BCP26].
The following registries also reserve the integer-based index values
in the range of -1 to -256 for private use as defined by [BCP26] in
section 4.1. This allows values -1 to -24 to be expressed as a
single uint_8t in CBOR, and values -25 to -256 to be expressed using
an additional uint_8t in CBOR.
5.2.2. Private Use of Index and Name Values
The integer-based index values in the private use range (-1 to -256)
are intended for testing purposes and closed environments; values in
other ranges SHOULD NOT be assigned for testing.
For names that correspond to private use index values, an
Internationalized Domain Name prefix MUST be used to prevent name
conflicts using the form:
"domain.prefix-name "
Where "domain.prefix" MUST be a valid Internationalized Domain Name
as defined by [RFC5892], and "name" MUST be a unique name within the
namespace defined by the "domain.prefix". Use of a prefix in this
way allows for a name to be used initially in the private use range,
and to be registered at a future point in time. This is consistent
with the guidance in [BCP178].
5.2.3. Expert Review Guidelines
Designated experts MUST ensure that new registration requests meet
the following additional guidelines:
o The requesting specification MUST provide a clear semantic
definition for the new entry. This definition MUST clearly
differentiate the requested entry from other previously registered
entries.
o The requesting specification MUST describe the intended use of the
entry, including any co-constraints that exist between the use of
the entry's index value or name, and other values defined within
the SWID/CoSWID model.
o Index values and names outside the private use space MUST NOT be
used without registration. This is considered squatting and
SHOULD be avoided. Designated experts MUST ensure that reviewed
specifications register all appropriate index values and names.
o Standards track documents MAY include entries registered in the
range reserved for entries under the Specification Required
policy. This can occur when a standards track document provides
further guidance on the use of index values and names that are in
common use, but were not registered with IANA. This situation
SHOULD be avoided.
o All registered names MUST be valid according to the XML Schema
NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section
3.3.4). This ensures that registered names are compatible with
the SWID format [SWID] where they are used.
o Registration of vanity names SHOULD be discouraged. The
requesting specification MUST provide a description of how a
requested name will allow for use by multiple stakeholders.
5.2.4. SWID/CoSWID Version Scheme Value Registry
This document defines a new a new registry titled "SWID/CoSWID This document defines a new a new registry titled "SWID/CoSWID
Version Scheme Values". Future registrations for this registry are Version Scheme Values". This registry provides index values for use
to be made based on [RFC8126] as follows: as version-scheme item values in this document and version scheme
names for use in [SWID].
[TO BE REMOVED: This registration should take place at the following [TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid] location: https://www.iana.org/assignments/swid]
+-------------+--------------------------+ This registry uses the registration proceedures defined in
| Range | Registration Procedures | Section 5.2.1 with the following associated ranges:
+-------------+--------------------------+
| 0-16383 | Standards Action | +-------------+-------------------------+
| | | | Range | Registration Procedures |
| 16384-32767 | Specification Required | +-------------+-------------------------+
| | | | 0-16383 | Standards Action |
| 32768-65535 | Reserved for Private Use | | | |
+-------------+--------------------------+ | 16384-65535 | Specification Required |
+-------------+-------------------------+
Table 10: CoSWID Version Scheme Registration Proceedures Table 10: CoSWID Version Scheme Registration Proceedures
Assignments MUST consist of an integer Index value, the Version
Scheme Name, and a reference to the defining specification.
Initial registrations for the "SWID/CoSWID Version Scheme Value" Initial registrations for the "SWID/CoSWID Version Scheme Value"
registry are provided below. Assignments consist of an integer Index registry are provided below, which are derived from the textual
value, the Version Scheme Name, and a reference to the defining version scheme names defined in [SWID].
specification.
+-------------+--------------------------+-----------------+ +-------------+-------------------------+-----------------+
| Index | Version Scheme Name | Specification | | Index | Version Scheme Name | Specification |
+-------------+--------------------------+-----------------+ +-------------+-------------------------+-----------------+
| 0 | Reserved | | | 0 | Reserved | |
| | | | | | | |
| 1 | multipartnumeric | See Section 4.1 | | 1 | multipartnumeric | See Section 4.1 |
| | | | | | | |
| 2 | multipartnumeric+suffix | See Section 4.1 | | 2 | multipartnumeric+suffix | See Section 4.1 |
| | | | | | | |
| 3 | alphanumeric | See Section 4.1 | | 3 | alphanumeric | See Section 4.1 |
| | | | | | | |
| 4 | decimal | See Section 4.1 | | 4 | decimal | See Section 4.1 |
| | | | | | | |
| 5-16383 | Unassigned | | | 5-16383 | Unassigned | |
| | | | | | | |
| 16384 | semver | [SEMVER] | | 16384 | semver | [SEMVER] |
| | | | | | | |
| 16385-32767 | Unassigned | | | 16385-65535 | Unassigned | |
| | | | +-------------+-------------------------+-----------------+
| 32768-65535 | Reserved for Private Use | |
+-------------+--------------------------+-----------------+
Table 11: CoSWID Version Scheme Inital Registrations Table 11: CoSWID Version Scheme Inital Registrations
Additional syntax requirements for registrations: Registrations MUST conform to the expert review guidelines defined in
Section 5.2.3.
o All registered names MUST be valid according to the XML Schema
NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section
3.3.4).
o The name prefix "x_" has been reserved for private use and NUST
NOT be used in a registered name.
5.2.2. SWID/CoSWID Entity Role Value Registry Designated experts MUST also ensure that newly requested entries
define a value space for the corresponding version item that is
unique from other previously registered entries. Note: The inital
registrations violate this requirement, but are included for
backwards compatibility with [SWID]. Guidelines on how to deconflict
these value spaces are defined in section Section 4.1.
This document uses unsigned 8-bit index values to represent entity- 5.2.5. SWID/CoSWID Entity Role Value Registry
entry role item values. The initial set of Entity roles are derived
from the textual role names defined in the ISO/IEC 19770-2:2015
specification [SWID].
This document defines a new a new registry titled "SWID/CoSWID Entity This document defines a new a new registry titled "SWID/CoSWID Entity
Role Values". Future registrations for this registry are to be made Role Values". This registry provides index values for use as entity-
based on [RFC8126] as follows: entry role item values in this document and entity role names for use
in [SWID].
[TO BE REMOVED: This registration should take place at the following [TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid] location: https://www.iana.org/assignments/swid]
+---------+--------------------------+
| Range | Registration Procedures |
+---------+--------------------------+
| 0-31 | Standards Action |
| | |
| 32-127 | Specification Required |
| | |
| 128-255 | Reserved for Private Use |
+---------+--------------------------+
Table 12: CoSWID Entity Role Registration Proceedures This registry uses the registration proceedures defined in
Section 5.2.1 with the following associated ranges:
Initial registrations for the "SWID/CoSWID Entity Role Value" +---------+-------------------------+
registry are provided below. Assignments consist of an integer Index | Range | Registration Procedures |
value, a Role Name, and a reference to the defining specification. +---------+-------------------------+
| 0-127 | Standards Action |
| | |
| 128-255 | Specification Required |
+---------+-------------------------+
+---------+--------------------------+-----------------+ Table 12: CoSWID Entity Role Registration Proceedures
| Index | Role Name | Specification |
+---------+--------------------------+-----------------+
| 0 | Reserved | |
| | | |
| 1 | tagCreator | See Section 4.2 |
| | | |
| 2 | softwareCreator | See Section 4.2 |
| | | |
| 3 | aggregator | See Section 4.2 |
| | | |
| 4 | distributor | See Section 4.2 |
| | | |
| 5 | licensor | See Section 4.2 |
| | | |
| 6-127 | Unassigned | |
| | | |
| 128-255 | Reserved for Private Use | |
+---------+--------------------------+-----------------+
Table 13: CoSWID Entity Role Inital Registrations Assignments consist of an integer Index value, a Role Name, and a
reference to the defining specification.
Additional syntax requirements for registrations: Initial registrations for the "SWID/CoSWID Entity Role Value"
registry are provided below, which are derived from the textual
entity role names defined in [SWID].
o All registered names MUST be valid according to the XML Schema +-------+-----------------+-----------------+
NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section | Index | Role Name | Specification |
3.3.4). +-------+-----------------+-----------------+
| 0 | Reserved | |
| | | |
| 1 | tagCreator | See Section 4.2 |
| | | |
| 2 | softwareCreator | See Section 4.2 |
| | | |
| 3 | aggregator | See Section 4.2 |
| | | |
| 4 | distributor | See Section 4.2 |
| | | |
| 5 | licensor | See Section 4.2 |
| | | |
| 6-255 | Unassigned | |
+-------+-----------------+-----------------+
o The name prefix "x_" has been reserved for private use and NUST Table 13: CoSWID Entity Role Inital Registrations
NOT be used in a registered name.
5.2.3. SWID/CoSWID Link Ownership Value Registry Registrations MUST conform to the expert review guidlines defined in
Section 5.2.3.
This document uses unsigned 8-bit index values to represent link- 5.2.6. SWID/CoSWID Link Ownership Value Registry
entry ownership item values. The initial set of Link ownership
values are derived from the textual ownership names defined in the
ISO/IEC 19770-2:2015 specification [SWID].
This document defines a new a new registry titled "SWID/CoSWID Link This document defines a new a new registry titled "SWID/CoSWID Link
Ownership Values". Future registrations for this registry are to be Ownership Values". This registry provides index values for use as
made based on [RFC8126] as follows: link-entry ownership item values in this document and link ownership
names for use in [SWID].
[TO BE REMOVED: This registration should take place at the following [TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid] location: https://www.iana.org/assignments/swid]
+---------+--------------------------+ This registry uses the registration proceedures defined in
| Range | Registration Procedures | Section 5.2.1 with the following associated ranges:
+---------+--------------------------+
| 0-31 | Standards Action | +---------+-------------------------+
| | | | Range | Registration Procedures |
| 32-127 | Specification Required | +---------+-------------------------+
| | | | 0-127 | Standards Action |
| 128-255 | Reserved for Private Use | | | |
+---------+--------------------------+ | 128-255 | Specification Required |
+---------+-------------------------+
Table 14: CoSWID Link Ownership Registration Proceedures Table 14: CoSWID Link Ownership Registration Proceedures
Assignments consist of an integer Index value, an Ownership Type
Name, and a reference to the defining specification.
Initial registrations for the "SWID/CoSWID Link Ownership Value" Initial registrations for the "SWID/CoSWID Link Ownership Value"
registry are provided below. Assignments consist of an integer Index registry are provided below, which are derived from the textual
value, an Ownership Type Name, and a reference to the defining entity role names defined in [SWID].
specification.
+-------------+--------------------------+-----------------+ +-------+---------------------+-----------------+
| Index | Ownership Type Name | Definition | | Index | Ownership Type Name | Definition |
+-------------+--------------------------+-----------------+ +-------+---------------------+-----------------+
| 0 | Reserved | | | 0 | Reserved | |
| | | | | | | |
| 1 | abandon | See Section 4.3 | | 1 | abandon | See Section 4.3 |
| | | | | | | |
| 2 | private | See Section 4.3 | | 2 | private | See Section 4.3 |
| | | | | | | |
| 3 | shared | See Section 4.3 | | 3 | shared | See Section 4.3 |
| | | | | | | |
| 4-16384 | Unassigned | | | 4-255 | Unassigned | |
| | | | +-------+---------------------+-----------------+
| 16385-32767 | Unassigned | |
| | | |
| 32768-65535 | Reserved for Private Use | |
+-------------+--------------------------+-----------------+
Table 15: CoSWID Link Ownership Inital Registrations Table 15: CoSWID Link Ownership Inital Registrations
Additional syntax requirements for registrations: Registrations MUST conform to the expert review guidlines defined in
Section 5.2.3.
o All registered names MUST be valid according to the XML Schema
NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section
3.3.4).
o The name prefix "x_" has been reserved for private use and NUST
NOT be used in a registered name.
5.2.4. SWID/CoSWID Link Relationship Value Registry
This document uses unsigned 16-bit index values to represent link- 5.2.7. SWID/CoSWID Link Relationship Value Registry
entry rel item values. The initial set of rel values are derived
from the textual rel names defined in the ISO/IEC 19770-2:2015
specification [SWID].
This document defines a new a new registry titled "SWID/CoSWID Link This document defines a new a new registry titled "SWID/CoSWID Link
Relationship Values". Future registrations for this registry are to Relationship Values". This registry provides index values for use as
be made based on [RFC8126] as follows: link-entry rel item values in this document and link ownership names
for use in [SWID].
[TO BE REMOVED: This registration should take place at the following [TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid] location: https://www.iana.org/assignments/swid]
+-------------+--------------------------+
| Range | Registration Procedures | This registry uses the registration proceedures defined in
+-------------+--------------------------+ Section 5.2.1 with the following associated ranges:
| 0-16383 | Standards Action |
| | | +-------------+-------------------------+
| 16384-32767 | Specification Required | | Range | Registration Procedures |
| | | +-------------+-------------------------+
| 32768-65535 | Reserved for Private Use | | 0-32767 | Standards Action |
+-------------+--------------------------+ | | |
| 32768-65535 | Specification Required |
+-------------+-------------------------+
Table 16: CoSWID Link Relationship Registration Proceedures Table 16: CoSWID Link Relationship Registration Proceedures
Assignments consist of an integer Index value, the Relationship Type
Name, and a reference to the defining specification.
Initial registrations for the "SWID/CoSWID Link Relationship Value" Initial registrations for the "SWID/CoSWID Link Relationship Value"
registry are provided below. Assignments consist of an integer Index registry are provided below, which are derived from the link
value, the Relationship Type Name, and a reference to the defining relationship values defined in [SWID].
specification.
+-------------+--------------------------+-----------------+ +----------+------------------------+-----------------+
| Index | Relationship Type Name | Specification | | Index | Relationship Type Name | Specification |
+-------------+--------------------------+-----------------+ +----------+------------------------+-----------------+
| 0 | Reserved | | | 0 | Reserved | |
| | | | | | | |
| 1 | ancestor | See Section 4.4 | | 1 | ancestor | See Section 4.4 |
| | | | | | | |
| 2 | component | See Section 4.4 | | 2 | component | See Section 4.4 |
| | | | | | | |
| 3 | feature | See Section 4.4 | | 3 | feature | See Section 4.4 |
| | | | | | | |
| 4 | installationmedia | See Section 4.4 | | 4 | installationmedia | See Section 4.4 |
| | | | | | | |
| 5 | packageinstaller | See Section 4.4 | | 5 | packageinstaller | See Section 4.4 |
| | | | | | | |
| 6 | parent | See Section 4.4 | | 6 | parent | See Section 4.4 |
| | | | | | | |
| 7 | patches | See Section 4.4 | | 7 | patches | See Section 4.4 |
| | | | | | | |
| 8 | requires | See Section 4.4 | | 8 | requires | See Section 4.4 |
| | | | | | | |
| 9 | see-also | See Section 4.4 | | 9 | see-also | See Section 4.4 |
| | | | | | | |
| 10 | supersedes | See Section 4.4 | | 10 | supersedes | See Section 4.4 |
| | | | | | | |
| 11 | supplemental | See Section 4.4 | | 11 | supplemental | See Section 4.4 |
| | | | | | | |
| 12-16384 | Unassigned | | | 12-65535 | Unassigned | |
| | | | +----------+------------------------+-----------------+
| 16385-32767 | Unassigned | |
| | | |
| 32768-65535 | Reserved for Private Use | |
+-------------+--------------------------+-----------------+
Table 17: CoSWID Link Relationship Inital Registrations Table 17: CoSWID Link Relationship Inital Registrations
Additional syntax requirements for registrations: Registrations MUST conform to the expert review guidlines defined in
Section 5.2.3.
o All registered names MUST be valid according to the XML Schema
NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section
3.3.4).
o The name prefix "x_" has been reserved for private use and NUST
NOT be used in a registered name.
5.2.5. SWID/CoSWID Link Use Value Registry Designated experts MUST also ensure that a newly requested entry
documents the URI schemes allowed to be used in an href associated
with the link relationship and the expected resolution behavior of
these URI schemes. This will help to ensure that SWID/CoSWID
applications are able to interoperate when resolving resources
referenced by a link of a given type.
This document uses unsigned 8-bit index values to represent link- 5.2.8. SWID/CoSWID Link Use Value Registry
entry use item values. The initial set of Link use values are
derived from the textual names defined in the ISO/IEC 19770-2:2015
specification [SWID].
This document defines a new a new registry titled "SWID/CoSWID Link This document defines a new a new registry titled "SWID/CoSWID Link
Use Values". Future registrations for this registry are to be made Use Values". This registry provides index values for use as link-
based on [RFC8126] as follows: entry use item values in this document and link use names for use in
[SWID].
[TO BE REMOVED: This registration should take place at the following [TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid] location: https://www.iana.org/assignments/swid]
+---------+--------------------------+ This registry uses the registration proceedures defined in
| Range | Registration Procedures | Section 5.2.1 with the following associated ranges:
+---------+--------------------------+
| 0-31 | Standards Action |
| | |
| 32-127 | Specification Required |
| | |
| 128-255 | Reserved for Private Use |
+---------+--------------------------+
Table 18: CoSWID Link Use Registration Proceedures +---------+-------------------------+
| Range | Registration Procedures |
+---------+-------------------------+
| 0-127 | Standards Action |
| | |
| 128-255 | Specification Required |
+---------+-------------------------+
Initial registrations for the "SWID/CoSWID Entity Role Value" Table 18: CoSWID Link Use Registration Proceedures
registry are provided below. Assignments consist of an integer Index
value, the Link Use Type Name, and a reference to the defining
specification.
+---------+--------------------------+-----------------+ Assignments consist of an integer Index value, the Link Use Type
| Index | Link Use Type Name | Specification | Name, and a reference to the defining specification.
+---------+--------------------------+-----------------+
| 0 | Reserved | |
| | | |
| 1 | optional | See Section 4.5 |
| | | |
| 2 | required | See Section 4.5 |
| | | |
| 3 | recommended | See Section 4.5 |
| | | |
| 4-127 | Unassigned | |
| | | |
| 128-255 | Reserved for Private Use | |
+---------+--------------------------+-----------------+
Table 19: CoSWID Link Use Inital Registrations Initial registrations for the "SWID/CoSWID Link Use Value" registry
are provided below, which are derived from the link relationship
values defined in [SWID].
Additional syntax requirements for registrations: +-------+--------------------+-----------------+
| Index | Link Use Type Name | Specification |
+-------+--------------------+-----------------+
| 0 | Reserved | |
| | | |
| 1 | optional | See Section 4.5 |
| | | |
| 2 | required | See Section 4.5 |
| | | |
| 3 | recommended | See Section 4.5 |
| | | |
| 4-255 | Unassigned | |
+-------+--------------------+-----------------+
o All registered names MUST be valid according to the XML Schema Table 19: CoSWID Link Use Inital Registrations
NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section
3.3.4).
o The name prefix "x_" has been reserved for private use and NUST Registrations MUST conform to the expert review guidlines defined in
NOT be used in a registered name. Section 5.2.3.
5.3. swid+cbor Media Type Registration 5.3. swid+cbor Media Type Registration
IANA is requested to add the following to the IANA "Media Types" IANA is requested to add the following to the IANA "Media Types"
registry. registry.
Type name: application Type name: application
Subtype name: swid+cbor Subtype name: swid+cbor
skipping to change at page 55, line 5 skipping to change at page 55, line 40
+------------+----------+-------------------------------------------+ +------------+----------+-------------------------------------------+
| Tag | Data | Semantics | | Tag | Data | Semantics |
| | Item | | | | Item | |
+------------+----------+-------------------------------------------+ +------------+----------+-------------------------------------------+
| 1398229316 | map | Concise Software Identifier (CoSWID) | | 1398229316 | map | Concise Software Identifier (CoSWID) |
| | | [RFC-AAAA] | | | | [RFC-AAAA] |
+------------+----------+-------------------------------------------+ +------------+----------+-------------------------------------------+
Table 21: CoSWID CBOR Tag Table 21: CoSWID CBOR Tag
5.6. URI Scheme Registrations
The ISO 19770-2:2015 SWID specification describes use of the "swid"
and "swidpath" URI schemes, which are currently in use in
implementations. This document continues this use for CoSWID. The
following subsections provide registrations for these schemes in to
ensure that a permanent registration exists for these schemes that is
suitable for use in the SWID and CoSWID specifications.
5.6.1. "swid" URI Scheme Registration
SWID or CoSWID by the referenced tag's tag-id. This URI needs to be
resolved in the context of the endpoint by software that can lookup
other SWID or CoSWID tags. For example, "swid:2df9de35-0aff-
4a86-ace6-f7dddd1ade4c" references the tag with the tag-id value
"2df9de35-0aff-4a86-ace6-f7dddd1ade4c".
There is a need for a scheme name that can be used in URIs that point
to a specific SWID/CoSWID tag by that tag's tag-id, such as the use
of the link entry as described in section Section 2.7) of this
document. Since this scheme is used in a standards track document
and an ISO standard, this scheme needs to be used without fear of
conflicts with current or future actual schemes. The scheme "swid"
is hereby registered as a 'permanent' scheme for that purpose.
The "swid" scheme is specified as follows:
Scheme syntax: The scheme speific part consists of a SWID or CoSWID
tag's tag-id that is URI encoded according to [RFC3986] section 2.1.
The following expression is a valid example:
<swid:2df9de35-0aff-4a86-ace6-f7dddd1ade4c>
Scheme semantics: URIs in the "swid" scheme are to be used to
reference a SWID or CoSWID tag by its tag-id. A tag-id referenced in
this way can be used to indentify the tag resource in the context of
where it is referenced from. For example, when a tag is installed on
a given device, that tag can reference related tags on the same
device using this URI scheme.
Encoding considerations: See Section 2.5 of [RFC3986] for guidelines.
Interoperability considerations: None.
Security considerations: None.
5.6.2. "swidpath" URI Scheme Registration
There is a need for a scheme name that can be used in URIs to
indentify a collection of specific SWID/CoSWID tags with data
elements that match an XPath expression, such as the use of the link
entry as described in section Section 2.7) of this document. Since
this scheme is used in a standards track document and an ISO
standard, this scheme needs to be used without fear of conflicts with
current or future actual schemes. The scheme "swidpath" is hereby
registered as a 'permanent' scheme for that purpose.
The "swidpath" scheme is specified as follows:
Scheme syntax: The scheme speific part consists of an XPath
expression as defined by [W3C.REC-xpath20-20101214]. The included
XPath expression will be URI encoded according to [RFC3986] section
2.1.
Scheme semantics: URIs in the "swidpath" scheme are to be used
specify the data that must be found in a given SWID/CoSWID tag for
that tag to be considered a matching tag to be included in the
identified tag collection. Tags to be evaluated include all tags in
the context of where the tag is referenced from. For example, when a
tag is installed on a given device, that tag can reference related
tags on the same device using this URI scheme. A tag is matching if
the XPath evaluation result value has an effective boolean value of
"true" according to [W3C.REC-xpath20-20101214] section 2.4.3. rence
related tags on the same device using this URI scheme.
Encoding considerations: See Section 2.5 of [RFC3986] for guidelines.
Interoperability considerations: None.
Security considerations: None.
5.7. CoSWID Model for use in SWIMA Registration
The Software Inventory Message and Attributes (SWIMA) for PA-TNC
specification [RFC8412] defines a standardized method for collecting
an endpoint device's software inventory. A CoSWID can provide
evidence of software installation which can then be used and
exchanged with SWIMA. This registration adds a new entry to the IANA
"Software Data Model Types" registry defined by [RFC8412] to support
CoSWID use in SWIMA as follows:
Pen: 0
Integer: TBD2
Name: Concise Software Identifier (CoSWID)
Defining Specification: RFC-AAAA
Deriving Software Identifiers:
A Software Identifier generated from a CoSWID tag is expressed as a
concatenation of the form:
TAG_CREATOR_REGID "_" "_" UNIQUE_ID
Where TAG_CREATOR_REGID is the reg-id ietm value of the tag's entity
item having the role value of 1 (corresponding to "tag creator"), and
the UNIQUE_ID is the same tag's tag-id item. If the tag-id item's
value is expressed as a 16 byte binary string, the UNIQUE_ID MUST be
represented using the UUID string representation defined in [RFC4122]
including the "urn:uuid:" prefix.
The TAG_CREATOR_REGID and the UNIQUE_ID are connected with a double
underscore (_), without any other connecting character or whitespace.
6. Security Considerations 6. Security Considerations
SWID and CoSWID tags contain public information about software SWID and CoSWID tags contain public information about software
components and, as such, do not need to be protected against components and, as such, do not need to be protected against
disclosure on an endpoint. Similarly, SWID/CoSWID tags are intended disclosure on an endpoint. Similarly, SWID/CoSWID tags are intended
to be easily discoverable by applications and users on an endpoint in to be easily discoverable by applications and users on an endpoint in
order to make it easy to identify and collect all of an endpoint's order to make it easy to identify and collect all of an endpoint's
SWID tags. As such, any security considerations regarding SWID/ SWID tags. As such, any security considerations regarding SWID/
CoSWID tags focus on the application of SWID/CoSWID tags to address CoSWID tags focus on the application of SWID/CoSWID tags to address
security challenges, and the possible disclosure of the results of security challenges, and the possible disclosure of the results of
those applications. those applications.
A signed SWID/CoSWID tag whose signature has been validated can be A tag is considered "authoritative" if the SWID/CoSWID tag was
relied upon to be unchanged since it was signed. If the SWID/CoSWID created by the software provider. An authoritative SWID/CoSWID tag
tag was created by the software provider, is signed, and the software contains information about a software component provided by the
provider can be authenticated as the originator of the signature, maintainer of the software component, who is expected to be an expert
then the tag can be considered authoritative. In this way, an in their own software. Thus, authoritative SWID/CoSWID tags can be
authoritative SWID/CoSWID tag contains information about a software trusted to represent authoritative information about the software
component provided by the maintainer of the software component, who component.
is expected to be an expert in their own software. Thus,
authoritative SWID/CoSWID tags can be trusted to represent A signed SWID/CoSWID tag (see Appendix A) whose signature has been
authoritative information about the software component. Having an validated can be relied upon to be unchanged since it was signed. By
authoritative SWID/CoSWID tag can be useful when the information in
the tag needs to be trusted, such as when the tag is being used to
convey reference integrity measurements for software components. By
contrast, the data contained in unsigned tags cannot be trusted to be contrast, the data contained in unsigned tags cannot be trusted to be
unmodified. unmodified.
When an authoritative tag is signed, the software provider can be
authenticated as the originator of the signature. Having a signed
authoritative SWID/CoSWID tag can be useful when the information in
the tag needs to be trusted, such as when the tag is being used to
convey reference integrity measurements for software components.
SWID/CoSWID tags are designed to be easily added and removed from an SWID/CoSWID tags are designed to be easily added and removed from an
endpoint along with the installation or removal of software endpoint along with the installation or removal of software
components. On endpoints where addition or removal of software components. On endpoints where addition or removal of software
components is tightly controlled, the addition or removal of SWID components is tightly controlled, the addition or removal of SWID
tags can be similarly controlled. On more open systems, where many tags can be similarly controlled. On more open systems, where many
users can manage the software inventory, SWID/CoSWID tags can be users can manage the software inventory, SWID/CoSWID tags can be
easier to add or remove. On such systems, it can be possible to add easier to add or remove. On such systems, it can be possible to add
or remove SWID/CoSWID tags in a way that does not reflect the actual or remove SWID/CoSWID tags in a way that does not reflect the actual
presence or absence of corresponding software components. Similarly, presence or absence of corresponding software components. Similarly,
not all software products automatically install SWID/CoSWID tags, so not all software products automatically install SWID/CoSWID tags, so
skipping to change at page 56, line 39 skipping to change at page 60, line 7
processing of those tags. While software providers are unlikely to processing of those tags. While software providers are unlikely to
do this, SWID/CoSWID tags can be created by any party and the SWID/ do this, SWID/CoSWID tags can be created by any party and the SWID/
CoSWID tags collected from an endpoint could contain a mixture of CoSWID tags collected from an endpoint could contain a mixture of
vendor and non-vendor created tags. For this reason, tools that vendor and non-vendor created tags. For this reason, tools that
consume SWID/CoSWID tags ought to treat the tag contents as consume SWID/CoSWID tags ought to treat the tag contents as
potentially malicious and employ input sanitizing and loop detection potentially malicious and employ input sanitizing and loop detection
on the tags they ingest. on the tags they ingest.
7. Acknowledgments 7. Acknowledgments
TBD This document draws heavily on the concepts defined in the ISO/IEC
19770-2:2015 specification. The authors of this document are
grateful for the prior work of the 19770-2 contributors.
We are also grateful to the careful reviews provided by ...
8. Change Log 8. Change Log
[THIS SECTION TO BE REMOVED BY THE RFC EDITOR.]
Changes from version 03 to version 11: Changes from version 03 to version 11:
o Reduced representation complexity of the media-entry type and o Reduced representation complexity of the media-entry type and
removed the section describing the older data structure. removed the section describing the older data structure.
o Added more signature schemes from COSE o Added more signature schemes from COSE
o Included a minimal required set of normative language o Included a minimal required set of normative language
o Reordering of attribute name to integer label by priority o Reordering of attribute name to integer label by priority
according to semantics. according to semantics.
o Added an IANA registry for CoSWID items supporting future o Added an IANA registry for CoSWID items supporting future
extension. extension.
o Cleaned up IANA registrations, fixing some inconsistencies in the o Cleaned up IANA registrations, fixing some inconsistencies in the
table labels. table labels.
o Added additional CDDL sockets for resource collection entries o Added additional CDDL sockets for resource collection entries
skipping to change at page 60, line 28 skipping to change at page 64, line 5
Tokens Tokens
Changes from version 00 to version 01: Changes from version 00 to version 01:
o Added CWT usage for absolute SWID paths on a device o Added CWT usage for absolute SWID paths on a device
o Fixed cardinality of type-choices including arrays o Fixed cardinality of type-choices including arrays
o Included first iteration of firmware resource-collection o Included first iteration of firmware resource-collection
9. Contributors 9. References
10. References 9.1. Normative References
10.1. Normative References [BCP178] Saint-Andre, P., Crocker, D., and M. Nottingham,
"Deprecating the "X-" Prefix and Similar Constructs in
Application Protocols", BCP 178, RFC 6648,
DOI 10.17487/RFC6648, June 2012,
<https://www.rfc-editor.org/info/rfc6648>.
[BCP26] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
2003, <https://www.rfc-editor.org/info/rfc3629>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
[RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network
Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008,
<https://www.rfc-editor.org/info/rfc5198>.
[RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646,
September 2009, <https://www.rfc-editor.org/info/rfc5646>. September 2009, <https://www.rfc-editor.org/info/rfc5646>.
[RFC5892] Faltstrom, P., Ed., "The Unicode Code Points and
Internationalized Domain Names for Applications (IDNA)",
RFC 5892, DOI 10.17487/RFC5892, August 2010,
<https://www.rfc-editor.org/info/rfc5892>.
[RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object [RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object
Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049,
October 2013, <https://www.rfc-editor.org/info/rfc7049>. October 2013, <https://www.rfc-editor.org/info/rfc7049>.
[RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained
Application Protocol (CoAP)", RFC 7252, Application Protocol (CoAP)", RFC 7252,
DOI 10.17487/RFC7252, June 2014, DOI 10.17487/RFC7252, June 2014,
<https://www.rfc-editor.org/info/rfc7252>. <https://www.rfc-editor.org/info/rfc7252>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
skipping to change at page 61, line 22 skipping to change at page 65, line 27
<https://www.rfc-editor.org/info/rfc8152>. <https://www.rfc-editor.org/info/rfc8152>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8288] Nottingham, M., "Web Linking", RFC 8288, [RFC8288] Nottingham, M., "Web Linking", RFC 8288,
DOI 10.17487/RFC8288, October 2017, DOI 10.17487/RFC8288, October 2017,
<https://www.rfc-editor.org/info/rfc8288>. <https://www.rfc-editor.org/info/rfc8288>.
[RFC8412] Schmidt, C., Haynes, D., Coffin, C., Waltermire, D., and
J. Fitzgerald-McKay, "Software Inventory Message and
Attributes (SWIMA) for PA-TNC", RFC 8412,
DOI 10.17487/RFC8412, July 2018,
<https://www.rfc-editor.org/info/rfc8412>.
[RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data [RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data
Definition Language (CDDL): A Notational Convention to Definition Language (CDDL): A Notational Convention to
Express Concise Binary Object Representation (CBOR) and Express Concise Binary Object Representation (CBOR) and
JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610, JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610,
June 2019, <https://www.rfc-editor.org/info/rfc8610>. June 2019, <https://www.rfc-editor.org/info/rfc8610>.
[SAM] "Information technology - Software asset management - Part [SAM] "Information technology - Software asset management - Part
5: Overview and vocabulary", ISO/IEC 19770-5:2015, 5: Overview and vocabulary", ISO/IEC 19770-5:2015,
November 2013. November 2013.
skipping to change at page 62, line 15 skipping to change at page 66, line 27
[W3C.REC-xpath20-20101214] [W3C.REC-xpath20-20101214]
Berglund, A., Boag, S., Chamberlin, D., Fernandez, M., Berglund, A., Boag, S., Chamberlin, D., Fernandez, M.,
Kay, M., Robie, J., and J. Simeon, "XML Path Language Kay, M., Robie, J., and J. Simeon, "XML Path Language
(XPath) 2.0 (Second Edition)", World Wide Web Consortium (XPath) 2.0 (Second Edition)", World Wide Web Consortium
Recommendation REC-xpath20-20101214, December 2010, Recommendation REC-xpath20-20101214, December 2010,
<http://www.w3.org/TR/2010/REC-xpath20-20101214>. <http://www.w3.org/TR/2010/REC-xpath20-20101214>.
[X.1520] "Recommendation ITU-T X.1520 (2014), Common [X.1520] "Recommendation ITU-T X.1520 (2014), Common
vulnerabilities and exposures", April 2011. vulnerabilities and exposures", April 2011.
10.2. Informative References 9.2. Informative References
[CamelCase] [CamelCase]
"UpperCamelCase", August 2014, "UpperCamelCase", August 2014,
<http://wiki.c2.com/?CamelCase>. <http://wiki.c2.com/?CamelCase>.
[I-D.birkholz-rats-tuda] [I-D.birkholz-rats-tuda]
Fuchs, A., Birkholz, H., McDonald, I., and C. Bormann, Fuchs, A., Birkholz, H., McDonald, I., and C. Bormann,
"Time-Based Uni-Directional Attestation", draft-birkholz- "Time-Based Uni-Directional Attestation", draft-birkholz-
rats-tuda-00 (work in progress), March 2019. rats-tuda-00 (work in progress), March 2019.
 End of changes. 148 change blocks. 
540 lines changed or deleted 747 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/