< draft-ietf-sacm-coswid-09.txt   draft-ietf-sacm-coswid-10.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: November 13, 2019 Department of Defense Expires: December 26, 2019 Department of Defense
C. Schmidt C. Schmidt
The MITRE Corporation The MITRE Corporation
D. Waltermire D. Waltermire
NIST NIST
May 12, 2019 June 24, 2019
Concise Software Identification Tags Concise Software Identification Tags
draft-ietf-sacm-coswid-09 draft-ietf-sacm-coswid-10
Abstract Abstract
This document defines a concise representation of ISO/IEC This document defines a concise representation of ISO/IEC
19770-2:2015 Software Identification (SWID) tags that are 19770-2:2015 Software Identification (SWID) tags that are
interoperable with the XML schema definition of ISO/IEC 19770-2:2015. interoperable with the XML schema definition of ISO/IEC 19770-2:2015.
Next to the inherent capability of SWID tags to express arbitrary Next to the inherent capability of SWID tags to express arbitrary
context information, Concise SWID (CoSWID) tags support the context information, Concise SWID (CoSWID) tags support the
definition of additional semantics via well-defined data definitions definition of additional semantics via well-defined data definitions
incorporated by extension points. incorporated by extension points.
skipping to change at page 1, line 41 skipping to change at page 1, line 41
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 November 13, 2019. This Internet-Draft will expire on December 26, 2019.
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
skipping to change at page 2, line 23 skipping to change at page 2, line 23
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 . . . . . . . . . . . . . . . . . . . 6
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. Concise SWID Extensions . . . . . . . . . . . . . . . . . 8
2.2. The concise-swid-tag Group . . . . . . . . . . . . . . . 9 2.2. The concise-swid-tag Group . . . . . . . . . . . . . . . 9
2.3. concise-swid-tag Co-constraints . . . . . . . . . . . . . 13 2.3. concise-swid-tag Co-constraints . . . . . . . . . . . . . 13
2.4. The global-attributes Group . . . . . . . . . . . . . . . 14 2.4. The global-attributes Group . . . . . . . . . . . . . . . 14
2.5. The entity-entry Group . . . . . . . . . . . . . . . . . 14 2.5. The entity-entry Group . . . . . . . . . . . . . . . . . 15
2.6. The link-entry Map . . . . . . . . . . . . . . . . . . . 16 2.6. The link-entry Map . . . . . . . . . . . . . . . . . . . 17
2.7. The software-meta-entry Map . . . . . . . . . . . . . . . 19 2.7. The software-meta-entry Map . . . . . . . . . . . . . . . 21
2.8. The Resource Collection Definition . . . . . . . . . . . 22 2.8. The Resource Collection Definition . . . . . . . . . . . 24
2.8.1. The hash-entry Array . . . . . . . . . . . . . . . . 22 2.8.1. The hash-entry Array . . . . . . . . . . . . . . . . 24
2.8.2. The resource-collection Group . . . . . . . . . . . . 23 2.8.2. The resource-collection Group . . . . . . . . . . . . 24
2.8.3. The payload-entry Group . . . . . . . . . . . . . . . 26 2.8.3. The payload-entry Group . . . . . . . . . . . . . . . 27
2.8.4. The evidence-entry Group . . . . . . . . . . . . . . 26 2.8.4. The evidence-entry Group . . . . . . . . . . . . . . 28
2.9. Full CDDL Definition . . . . . . . . . . . . . . . . . . 27 2.9. Full CDDL Definition . . . . . . . . . . . . . . . . . . 28
3. Determining the Type of CoSWID . . . . . . . . . . . . . . . 33 3. Determining the Type of CoSWID . . . . . . . . . . . . . . . 34
4. CoSWID Indexed Label Values . . . . . . . . . . . . . . . . . 33 4. CoSWID Indexed Label Values . . . . . . . . . . . . . . . . . 34
4.1. Version Scheme . . . . . . . . . . . . . . . . . . . . . 33 4.1. Version Scheme . . . . . . . . . . . . . . . . . . . . . 34
4.2. Entity Role Values . . . . . . . . . . . . . . . . . . . 34 4.2. Entity Role Values . . . . . . . . . . . . . . . . . . . 35
4.3. Use Values . . . . . . . . . . . . . . . . . . . . . . . 35 4.3. Link Ownership Values . . . . . . . . . . . . . . . . . . 36
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 36 4.4. Link Rel Values . . . . . . . . . . . . . . . . . . . . . 37
5.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 36 4.5. Link Use Values . . . . . . . . . . . . . . . . . . . . . 39
5.2. SWID/CoSWID Version Schema Values Registry . . . . . . . 39 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 39
5.3. SWID/CoSWID Entity Role Values Registry . . . . . . . . . 40 5.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 39
5.4. SWID/CoSWID Link Use Values Registry . . . . . . . . . . 41 5.2. SWID/CoSWID Value Registries . . . . . . . . . . . . . . 42
5.5. swid+cbor Media Type Registration . . . . . . . . . . . . 42 5.2.1. SWID/CoSWID Version Scheme Value Registry . . . . . . 43
5.6. CoAP Content-Format Registration . . . . . . . . . . . . 43 5.2.2. SWID/CoSWID Entity Role Value Registry . . . . . . . 44
5.7. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 44 5.2.3. SWID/CoSWID Link Ownership Value Registry . . . . . . 45
6. Security Considerations . . . . . . . . . . . . . . . . . . . 44 5.2.4. SWID/CoSWID Link Relationship Value Registry . . . . 46
7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 46 5.2.5. SWID/CoSWID Link Use Value Registry . . . . . . . . . 47
8. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 46 5.3. swid+cbor Media Type Registration . . . . . . . . . . . . 48
9. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 50 5.4. CoAP Content-Format Registration . . . . . . . . . . . . 49
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 50 5.5. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 50
10.1. Normative References . . . . . . . . . . . . . . . . . . 50 6. Security Considerations . . . . . . . . . . . . . . . . . . . 50
10.2. Informative References . . . . . . . . . . . . . . . . . 51 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 52
8. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 52
Appendix A. Signed Concise SWID Tags using COSE . . . . . . . . 52 9. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 55
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 56
10.1. Normative References . . . . . . . . . . . . . . . . . . 56
10.2. Informative References . . . . . . . . . . . . . . . . . 57
Appendix A. Signed Concise SWID Tags using COSE . . . . . . . . 58
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 59
1. Introduction 1. Introduction
SWID tags have several use-applications including but not limited to: SWID tags have several use-applications including but not limited to:
o Software Inventory Management, a part of a Software Asset o Software Inventory Management, a part of a Software Asset
Management [SAM] process, which requires an accurate list of Management [SAM] process, which requires an accurate list of
discernible deployed software components. discernible deployed software components.
o Vulnerability Assessment, which requires a semantic link between o Vulnerability Assessment, which requires a semantic link between
skipping to change at page 3, line 38 skipping to change at page 3, line 42
component, each have a different SWID tag record associated with component, each have a different SWID tag record associated with
them. SWID tags are meant to be flexible and able to express a broad them. SWID tags are meant to be flexible and able to express a broad
set of metadata about a software component. set of metadata about a software component.
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 use scenarios. A SWID tag optional fields that support different use scenarios. A SWID tag
consisting of only required fields might be a few hundred bytes in consisting of only required fields might be a few hundred bytes in
size; however, a tag containing many of the optional fields can be size; however, a tag containing many of the optional fields can be
many orders of magnitude larger. Thus, real-world instances of SWID many orders of magnitude larger. Thus, real-world instances of SWID
tags can be fairly large, and the communication of SWID tags in use- tags can be fairly large, and the communication of SWID tags in use-
applications such as those described earlier can cause a large amount applications, such as those described earlier, can cause a large
of data to be transported. This can be larger than acceptable for amount of data to be transported. This can be larger than acceptable
constrained devices and networks. Concise SWID (CoSWID) tags for 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 CBOR,
which maps the human-readable labels of SWID data items to more which maps the human-readable labels of SWID data items to more
concise integer labels (indices). The use of CBOR to express SWID concise integer labels (indices). The use of CBOR to express SWID
information in CoSWID tags allows both CoSWID and SWID tags to be information in CoSWID tags allows both CoSWID and SWID tags to be
part of an enterprise security solution for a wider range of part of an enterprise security solution for a wider range of
endpoints and environments. endpoints and environments.
1.1. The SWID and CoSWID Tag Lifecycle 1.1. The SWID and CoSWID Tag Lifecycle
skipping to change at page 6, line 40 skipping to change at page 6, line 40
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, a more concise This document defines the CoSWID tag format, a more concise
representation of SWID information in the Concise Binary Object representation of SWID information in the Concise Binary Object
Representation (CBOR) [RFC7049]. The structure of a CoSWID is Representation (CBOR) [RFC7049]. The structure of a CoSWID is
described via the Concise Data Definition Language (CDDL) described via the Concise Data Definition Language (CDDL) [RFC8610].
[I-D.ietf-cbor-cddl]. The resulting CoSWID data definition is The resulting CoSWID data definition is aligned to the information
aligned to the information able to be expressed with the XML schema able to be expressed with the XML schema definition of ISO-
definition of ISO-19770-2:2015 [SWID]. This alignment allows both 19770-2:2015 [SWID]. This alignment allows both SWID and CoSWID tags
SWID and CoSWID tags to represent a common set of SWID information to represent a common set of SWID information and to support all SWID
and to support all SWID tag use cases. To achieve this end, the CDDL tag use cases. To achieve this end, the CDDL representation includes
representation includes every SWID tag field and attribute. 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 24 skipping to change at page 7, line 24
2. Concise SWID Data Definition 2. Concise SWID Data Definition
The following is a CDDL representation for a CoSWID tag. The The following is a CDDL representation for a CoSWID tag. The
CamelCase [CamelCase] notation used in the XML schema definition is CamelCase [CamelCase] notation used in the XML schema definition is
changed to a hyphen-separated notation [KebabCase] (e.g. changed to a hyphen-separated notation [KebabCase] (e.g.
ResourceCollection is named resource-collection) in the CoSWID data ResourceCollection is named resource-collection) in the CoSWID data
definition. In essence, [KebabCase] "looks-like-this". This definition. In essence, [KebabCase] "looks-like-this". This
deviation from the original notation used in the XML representation deviation from the original notation used in the XML representation
reduces ambiguity when referencing certain attributes in reduces ambiguity when referencing certain attributes in
corresponding textual descriptions. An attribute referred by its corresponding textual descriptions. An attribute referred to by its
name in CamelCase notation explicitly relates to XML SWID tags, an name in CamelCase notation explicitly relates to XML SWID tags; an
attribute referred by its name in KebabCase notation explicitly attribute referred to by its name in KebabCase notation explicitly
relates to CoSWID tags. This approach simplifies the composition of relates to CoSWID tags. This approach simplifies the composition of
further work that reference both XML SWID and CoSWID documents. further work that reference both XML SWID and CoSWID documents.
Human-readable labels of members in CDDL map data definitions are Human-readable labels of members in CDDL map data definitions are
mapped to integer indices via a block of rules at the bottom of the mapped to integer indices via a block of rules at the bottom of the
definition. The 57 character strings of the SWID vocabulary that definition. The 57 character strings of the SWID vocabulary are
would have to be stored or transported in full if using the original replacesm which would have to be stored or transported in full if
vocabulary are replaced. using 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 for a more efficient CBOR encoding of the The CDDL rule above allows for a more efficient CBOR encoding of the
data when a single value is used by avoiding the need to first encode data when a single value is used. This is accomplished by avoiding
the array. Conversely, an array is used for two or more values. the need to first encode the array. Conversely, hen two or more
This modeling pattern is used frequently in the CoSWID CDDL data values are encoded, the bytes identifing the array are used. This
definition in such cases. modeling pattern is used frequently in the CoSWID CDDL data
definition to allow for more effecient encoding of single 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. Concise SWID Extensions
The corresponding CoSWID data definition includes two kinds of The corresponding CoSWID data definition includes two kinds of
augmentation. augmentation.
o The explicit definition of types for attributes that are typically o The explicit definition of types for attributes that are typically
stored in the "any attribute" of an ISO-19770-2:2015 in XML stored in the "any attribute" of an ISO-19770-2:2015 in XML
representation. These are covered in Section 2.4. representation. These are covered in Section 2.4.
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 [I-D.ietf-cbor-cddl] section 3.9). The using CDDL sockets (see [RFC8610] section 3.9). The use of CDDL
use of CDDL sockets allow for well-formed extensions to be defined sockets allow for well-formed extensions to be defined in
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 |
skipping to change at page 8, line 50 skipping to change at page 8, line 50
| | | | | | | |
| process-entry | $$process-extension | Section 2.8.2 | | process-entry | $$process-extension | Section 2.8.2 |
| | | | | | | |
| resource-entry | $$resource-extension | Section 2.8.2 | | resource-entry | $$resource-extension | Section 2.8.2 |
| | | | | | | |
| payload-entry | $$payload-extension | Section 2.8.3 | | payload-entry | $$payload-extension | Section 2.8.3 |
| | | | | | | |
| evidence-entry | $$evidence-extension | Section 2.8.4 | | evidence-entry | $$evidence-extension | Section 2.8.4 |
+---------------------+-----------------------+---------------+ +---------------------+-----------------------+---------------+
The CoSWID Items Registry defined in Section 5.1 provides a
registration mechanism allowing new items, and their associated index
values, to be added to the CoSWID model through the use of the CDDL
sockets described above. This registration mechanism provides for
well-known index values for data items in CoSWID extensions, allowing
these index values to be recognized by implementations supporting a
given extension.
The following CDDL sockets defined in this document allow for adding The following CDDL sockets defined in this document allow for adding
new values to corresponding type-choices (i.e. to represent new values to corresponding type-choices (i.e. to represent
enumerations) via custom CDDL data definitions. enumerations) via custom CDDL data definitions.
+------------------+-----------------+-------------+ +------------------+-----------------+-------------+
| Enumeration Name | CDDL Socket | Defined in | | Enumeration Name | CDDL Socket | Defined in |
+------------------+-----------------+-------------+ +------------------+-----------------+-------------+
| version-scheme | $version-scheme | Section 4.1 | | version-scheme | $version-scheme | Section 4.1 |
| | | | | | | |
| role | $role | Section 4.2 | | role | $role | Section 4.2 |
| | | | | | | |
| ownership | $ownership | Section 2.6 | | ownership | $ownership | Section 4.3 |
| | | | | | | |
| rel | $rel | Section 4.3 | | rel | $rel | Section 4.4 |
| | | | | | | |
| use | $use | Section 2.6 | | use | $use | Section 4.5 |
+------------------+-----------------+-------------+ +------------------+-----------------+-------------+
The CoSWID Items Registry defined in Section 5.1 provides a A number of SWID/CoSWID value registries are also defined in
registration mechanism allowing new items, and their associated index Section 5.2 that allow new valid values to be registered with IANA
values, to be added to the CoSWID model through the use of the CDDL for the enumerations above. This registration mechanism supports the
sockets described above. This registration mechanism will provide definition of new well-known index values and names for new
for well-known index values for data items in CoSWID extensions, enumeration values used by SWID and CoSWID. This registration
allowing these index values to be recognized by implementations mechanism allows new standardized enumerated values to be shared
supporting a given extension. between both specifications (and implementations) over time.
2.2. The concise-swid-tag Group 2.2. 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,
tag-version => integer, tag-version => integer,
? corpus => bool, ? corpus => bool,
? patch => bool, ? patch => bool,
? supplemental => bool, ? supplemental => bool,
swid-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 ],
? link => link-entry / [ 2* link-entry ], ? link => link-entry / [ 2* link-entry ],
? (( payload => payload-entry ) // ( evidence => evidence-entry )), ? (( payload => payload-entry ) // ( evidence => evidence-entry )),
* $$coswid-extension * $$coswid-extension
} }
tag-id = 0 tag-id = 0
swid-name = 1 software-name = 1
entity = 2 entity = 2
evidence = 3 evidence = 3
link = 4 link = 4
software-meta = 5 software-meta = 5
payload = 6 payload = 6
corpus = 8 corpus = 8
patch = 9 patch = 9
media = 10 media = 10
supplemental = 11 supplemental = 11
tag-version = 12 tag-version = 12
skipping to change at page 11, line 16 skipping to change at page 11, line 16
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.4.
o tag-id (index 0): A textual identifier uniquely referencing a o tag-id (index 0): A textual identifier uniquely referencing a
(composite) software component. The tag identifier MUST be (composite) software component. The tag identifier MUST be
globally unique. There are no strict guidelines on how this globally unique. There are no strict guidelines on how this
identifier is structured, but examples include a 16 byte GUID identifier is structured, but examples include a 16 byte GUID
(e.g. class 4 UUID) [RFC4122], or a text string appended to a DNS (e.g. class 4 UUID) [RFC4122], or a text string appended to a DNS
domain name to ensure uniqueness across organizations. domain name to ensure uniqueness across organizations.
o tag-version (index 12): An integer value that indicates if a o tag-version (index 12): An integer value that indicate the
specific release of a software component has more than one tag specific release revision of the tag. Typically, the initial
that can represent that specific release. 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 is changed when a CoSWID tag component release. This value allows a CoSWID tag producer to
producer creates and releases an incorrect tag that they correct an incorrect tag previously released, without indicating a
subsequently want to fix, but no underlying changes have been made change to the underlying software component the tag represents.
to the product the CoSWID tag represents. This could happen if, For example, the tag version would be changed to add new metadata,
for example, a patch is distributed that has a link reference that to correct a broken link, to add a missing payload entry, etc.
does not cover all the various software releases it can patch. A When producing a revised tag, the new tag-version value MUST be
newer CoSWID tag for that patch can be generated and the tag- greater than the old tag-version value.
version value incremented to indicate that the data has been
updated.
o corpus (index 8): A boolean value that indicates if the tag o corpus (index 8): A boolean value that indicates if the tag
identifies and describes an installable software component in its identifies and describes an installable software component in its
pre-installation state. Installable software includes a pre-installation state. Installable software includes a
installation package or installer for a software component, a installation package or installer for a software component, a
software update, or a patch. If the CoSWID tag represents software update, or a patch. If the CoSWID tag represents
installable software, the corpus item MUST be set to "true". If installable software, the corpus item MUST be set to "true". If
not provided the default value MUST be considered "false". not provided the default value MUST be considered "false".
o patch (index 9): A boolean value that indicates if the tag o patch (index 9): A boolean value that indicates if the tag
skipping to change at page 12, line 10 skipping to change at page 12, line 7
o supplemental (index 11): A boolean value that indicates if the tag o supplemental (index 11): A boolean value that indicates if the tag
is providing additional information to be associated with another is providing additional information to be associated with another
referenced SWID or CoSWID tag. Tags using this item help to referenced SWID or CoSWID tag. Tags using this item help to
ensure that primary and patch tags provided by a software provider ensure that primary and patch tags provided by a software provider
are not modified by software management tools, while allowing are not modified by software management tools, while allowing
these tools to provide their own software metadata for a software these tools to provide their own software metadata for a software
component. If a CoSWID tag is a supplemental tag, the component. If a CoSWID tag is a supplemental tag, the
supplemental item MUST be set to "true". If not provided the supplemental item MUST be set to "true". If not provided the
default value MUST be considered "false". default value MUST be considered "false".
o swid-name (index 1): This textual item provides the software o software-name (index 1): This textual item provides the software
component name as it would typically be referenced. For example, component's name. This name is likely the same name that would
what would be seen in the add/remove software dialog in an appear in a package management tool.
operating system, or what is specified as the name of a packaged
software component or a patch identifier name.
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 8-bit 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 a value from the
SWID/CoSWID Version Schema Values Registry (see section SWID/CoSWID Version Scheme Value Registry (see section
Section 5.2 or a value in the private use range: 32768-65535. Section 5.2.1 or a value in the private use range: 32768-65535.
An initial set of pre-defined version-scheme index and text values
are defined in Section 4.1 that are based on the version-scheme
values defined in [SWID]. These pre-defined version-scheme values
are registered with IANA in the "SWID/CoSWID Version Scheme Value"
registry Section 5.2.1, and MAY 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 Version Scheme Value" registry.
* An index value in the range 32768 through 65535, 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 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 this tag applies to. This item represents a query understand what this tag applies to. This item represents a query
as defined by the W3C Media Queries Recommendation (see as defined by the W3C Media Queries Recommendation (see
[W3C.REC-css3-mediaqueries-20120619]). [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. The providing for common usage and semantics across the industry. Use
data definition of this entry allows for any additional attribute of this map allows any additional attribute to be included in the
to be included, though it is recommended that industry norms for tag. It is expected that industry groups will use a common set of
new attributes are defined and followed to the degree possible. attribute names to allow for interoperability within their
Described in Section 2.7. communities. Described in Section 2.7.
o entity (index 2): Provides information about one or more o entity (index 2): Provides information about one or more
organizations related to the CoSWID tag or the software component organizations responsible for producing the CoSWID tag, and
referenced by this CoSWID tag. Described in Section 2.5. producing or releasing the software component referenced by this
CoSWID tag. Described in Section 2.5.
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.6.
o payload (index 6): This item represents the software artifacts o payload (index 6): This item represents the software artifacts
that compose the target software. For example, the files included that compose the target software. For example, the files included
with an installer for a corpus tag or installed on an endpoint with an installer for a corpus tag or installed on an endpoint
when the software component is installed for a primary or patch when the software component is installed for a primary or patch
tag. Note that the payload can represent a superset of the tag. The artifacts listed in a payload may be a superset of the
software artifacts installed. Based on user selections at install software artifacts that are actually installed. Based on user
time, an installation might not include every artifact that could selections at install time, an installation might not include
be created or executed on the endpoint when the software component every artifact that could be created or executed on the endpoint
is installed (i.e. if a particular optional sub-component is not when the software component is installed or run. Described in
installed, the files associated with that software component might Section 2.8.3.
be included in payload, but not installed on the endpoint).
Described in Section 2.8.3.
o evidence (index 3): This item is used to provide results from a o evidence-entry (index 3): This item records the results of a
scan of a system where software that does not have a CoSWID tag is software discovery process used to identify untagged software on
discovered. In such a case, a CoSWID tag can be created by the an endpoint. This item provides a means to represent indicators
discovery process when the endpoint is scanned. This item for why software is believed to be installed on the endpoint. In
represents evidence for why software is believed to be installed such a case, a CoSWID tag is created when the endpoint is scanned
on the endpoint. Described in Section 2.8.4. by the tool performing the scan. Described in Section 2.8.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.1.
2.3. concise-swid-tag Co-constraints 2.3. concise-swid-tag Co-constraints
The following co-constraints apply to the information provided by in The following co-constraints apply to the information provided by in
the concise-swid-tag group. the concise-swid-tag group.
o Only one of the patch and supplemental items MUST be set to o The patch and supplemental items MUST NOT both be set to "true".
"true", or the patch and supplemental items MUST be set to "false"
or be omitted.
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 the rel(ation) item value of "patches" least one link item with the rel(ation) item value of "patches"
and an href item specifying an association with the software that and an href item specifying an association with the software that
was patched. 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 the rel(ation) item value of at least one link item with 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.
skipping to change at page 15, line 35 skipping to change at page 15, line 39
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.4.
o entity-name (index 32): The text-string name of the organization o entity-name (index 32): The textual name of the organizational
claiming a particular role, specified by the role item, in 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 this organization and o role (index 33): The relationship(s) between the entity, and this
this tag or the referenced software component. The role of an tag or the referenced software component. Use of index values
entity MAY include any role value, but the pre-defined roles instead of text for these pre-defined roles allows a CoSWID to be
include: "aggregator", "distributor", "licensor", "software- more concise.
creator", and "tag-creator". All pre-defined role index and text
values are defined in the IANA "SWID/CoSWID Entity Role Values"
registry Section 4.2. Use of index values instead of text for
these pre-defined roles allows a CoSWID to be more concise.
An entity item MUST be provided with the role of "tag-creator" for An initial set of pre-defined role index and text values are
every CoSWID tag. This indicates the organization that created defined in Section 4.2 that are based on the roles defined in
the CoSWID tag. [SWID]. These pre-defined roles are registered with IANA in the
"SWID/CoSWID Entity Role Value" registry Section 5.2.2, and MAY be
expanded in the future.
An entity item SHOULD be provided with the role of "software- The value of a role item MUST be one of the following:
creator" for every CoSWID tag, if this information is known to the
tag creator. This indicates the organization that created the * The index (preferred) or string value of a role from the IANA
referenced software component. 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
"role" item:
* An entity item MUST be provided with the role of "tag-creator"
for every CoSWID tag. This indicates the organization that
created the CoSWID tag.
* An entity item SHOULD be provided with the role of "software-
creator" for every CoSWID tag, if this information is known to
the tag creator. This indicates the organization that created
the referenced software component.
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
skipping to change at page 17, line 24 skipping to change at page 17, line 46
$rel /= ancestor $rel /= ancestor
$rel /= component $rel /= component
$rel /= feature $rel /= feature
$rel /= installationmedia $rel /= installationmedia
$rel /= packageinstaller $rel /= packageinstaller
$rel /= parent $rel /= parent
$rel /= patches $rel /= patches
$rel /= requires $rel /= requires
$rel /= see-also $rel /= see-also
$rel /= supersedes $rel /= supersedes
$rel /= rel-supplemental $rel /= supplemental
$rel /= uint / text $rel /= uint / text
ancestor=1 ancestor=1
component=2 component=2
feature=3 feature=3
installationmedia=4 installationmedia=4
packageinstaller=5 packageinstaller=5
parent=6 parent=6
patches=7 patches=7
requires=8 requires=8
see-also=9 see-also=9
supersedes=10 supersedes=10
rel-supplemental=11 supplemental=11
$use /= optional $use /= optional
$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.4.
o artifact (index 37): For installation media (rel="installation- o artifact (index: 37): To be used with rel="installation-media",
media"), this item value indicates the path of the installer this item value can provide the path to the installer executable
executable or script that can be run to launch the referenced or script that can be run to launch the referenced installation.
installation. Links with the same artifact name SHOULD be Links with the same artifact name MUST be considered mirrors of
considered mirrors of each other, allowing the installation media each other, allowing the installation media to be acquired from
to be acquired from any of the described sources. any of the described sources.
o href (index 38): A URI for the item being referenced. The "href" o href (index 38): A URI for the referenced resource. The "href"
item's value can point to several different things, and can be any item's value can be, but is not limited to, the following (which
of the following: 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 "coswid:" as the scheme, which refers to another * a URI with "coswid:" as the scheme, which refers to another
CoSWID by tag-id. This URI would need to be resolved in the CoSWID by tag-id. This URI would need to be resolved in the
skipping to change at page 18, line 50 skipping to change at page 19, line 21
entId='b0c55172-38e9-4e36-be86-92206ad8eddb'] would match entId='b0c55172-38e9-4e36-be86-92206ad8eddb'] would match
CoSWID tags with the persistent-id value CoSWID 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 the o media (index 10): A hint to the consumer of the link to what the
target item is applicable for. This item represents a query as target item is applicable for. This item represents a query as
defined by the W3C Media Queries Recommendation (see 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.2.
o ownership (index 39): Determines the relative strength of o ownership (index 39): Used when the "href" item references another
ownership between the software component referenced by the COSWID software component to indicate the degree of ownership between the
tag and the software component referenced by the link. Valid software component referenced by the COSWID tag and the software
enumerations are: abandon, private, shared. component referenced by the link.
The enumerated values have the following meanings: An initial set of pre-defined ownership index and text values are
defined in Section 4.3 that 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, and MAY be expanded in the future.
+-----------+-------------------------------------------------------+ The value of an ownership item MUST be one of the following:
| ownership | semantics |
+-----------+-------------------------------------------------------+
| abandon | If the software component referenced by the CoSWID |
| | tag is uninstalled, then the referenced software |
| | SHOULD not be uninstalled |
| | |
| private | If the software component referenced by the CoSWID |
| | tag is uninstalled, then the referenced software |
| | SHOULD be uninstalled too. |
| | |
| shared | If the software component referenced by the CoSWID |
| | tag is uninstalled, then the referenced software |
| | SHOULD be uninstalled if no other components sharing |
| | the software. |
+-----------+-------------------------------------------------------+
o rel (index 40): The relationship between this CoSWID and the * The index (preferred) or string value of a role from the IANA
target resource as defined by [RFC8288]. Relationships can be in the "SWID/CoSWID Link Ownership Value" registry.
identified by referencing a "Relation Name" from the IANA "Link
Relation Types" registry: https://www.iana.org/assignments/link-
relations/link-relations.xhtml.
o media-type (index 41): The media type for the target resource. * An index value in the range 128 through 255, to indicate that a
This provides the consumer with a hint of what type of resource to private use index value is used.
expect. Media types are identified by referencing a "Name" from
the IANA "Media Types" registry: http://www.iana.org/assignments/
media-types/media-types.xhtml.
o use (index 42): Determines if the target software is a hard * A string value prefixed with "x_", to indicate that a private
requirement or not to be installed before installing the tagged use string value is used.
software component. Valid enumerations are: required,
recommended, optional, which are defined in Section 4.3. o rel (index 40): Identifies the relationship between this CoSWID
and the target resource indicated by the "href" item.
An initial set of pre-defined rel index and text values are
defined in Section 4.4 that 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,
and MAY 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
use string value is used.
* A string value, as defined by [RFC8288], corresponding to a
"Relation Name" from the IANA "Link Relation Types" registry:
https://www.iana.org/assignments/link-relations/link-
relations.xhtml. 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 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.
o media-type (index 41): The media type for the target resource,
providing a resource consumer with a hint of what type of resource
to expect. Media types are identified by referencing a "Name"
from the IANA "Media Types" registry:
http://www.iana.org/assignments/media-types/media-types.xhtml.
o use (index 42): Determines if the referenced software component
has to be installed before installing the tagged software
component.
An initial set of pre-defined use index and text values are
defined in Section 4.5 that are based on the use values defined in
[SWID]. These pre-defined use values are registered with IANA in
the "SWID/CoSWID Link Use Value" registry Section 5.2.5, and MAY
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 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.1.
2.7. The software-meta-entry Map 2.7. 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,
skipping to change at page 20, line 45 skipping to change at page 22, line 5
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.4.
o activation-status (index 43): A textual value that identifies the o activation-status (index 43): A textual value that identifies how
activation status of this software title (e.g. Trial, Serialized, the software component has been activated, which might relate to
Licensed, Unlicensed, etc). Typically, this is used in specific terms and conditions for its use (e.g. Trial,
supplemental tags. Serialized, Licensed, Unlicensed, etc) and relate to an
entitlement. This attribute is typically used in supplemental
o channel-type (index 44): A textual value that provides information tags as it contains information that might be selected during a
on which channel this particular software was targeted for (e.g. specific install.
Volume, Retail, OEM, Academic, etc). Typically used in o channel-type (index 44): A textual value that identfies which
supplemental tags. sales, licensing, or marketing channel the software component has
been targeted for (e.g. Volume, Retail, OEM, Academic, etc).
This attribute is typically used in supplemental tags as it
contains information that might be selected during a specific
install.
o colloquial-version (index 45): A textual value for an informal or o colloquial-version (index 45): A textual value for the software
colloquial version of the product (i.e. 2013). Note that this component's informal or colloquial version. Examples may include
version can be the same through multiple releases of a software a year value, a major version number, or similar value that are
component, while the software-version specified in the concise- used to identify a group of specific software component releases
swid-tag group is much more specific and will change for each that are part of the same release/support cycle. This version can
software release. This representation of version is typically be the same through multiple releases of a software component,
used to identify a group of specific software releases that are while the software-version specified in the concise-swid-tag group
part of the same release/support infrastructure (i.e. Fabrikam is much more specific and will change for each software component
Office 2013). This version is used for string comparisons only release. This version is intended to be used for string
and is not compared to be an earlier or later release (that is comparison only, and is not intended to be used to determine if a
done via the concise-swid-tag group's software-version item). specific value is earlier or later in a sequence.
o description (index 46): A longer, detailed textual description of o description (index 46): A textual value that provides a detailed
the software. This description can be multiple sentences description of the software component, which can be multiple
(differentiated from summary, which is a very short, one-sentence sentences.
description).
o edition (index 47): A textual value indicating the variation of o edition (index 47): A textual value indicating that the software
the product (e.g., Extended, Enterprise, Professional, Standard, component represents a functional variation of the code base used
etc). to support multiple software components. For examplem, this item
can be used to differentiate enterprise, standard, or professional
variants of a software component.
o entitlement-data-required (index 48): A boolean indicator to o entitlement-data-required (index 48): A boolean value that proof
determine if accompanying proof of entitlement is needed when a of indicator to determine if accompanying proof of entitlement is
software license reconciliation is completed. needed 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 reconcile the validity of an entitlement. (e.g., serial be used to identify and establish a relationship to an
number, product or license key). entitlement. Examples of an entitlement-key might include a
serial number, product key, or license key). For values that
o generator (index 50): The name of the software tool that created relate to a given software component install (i.e., license key),
the CoSWID tag. a supplemental tag will typically contain this information. In
other cases where a general-purpose key can be provided that
o persistent-id (index 51): A GUID used to represent products applies to all possible installs of the software component on
installed where the products are related, but can be different different endpoints, a primary tag will typically contain this
versions. information.
o product (index 52): The base name of the product. o generator (index 50): The name (or tag-id) of the software
component that created the CoSWID tag. If the generating software
component has a SWID or CoSWID tag, then the tag-id for the
generating software component SHOULD be provided.
o product-family (index 53): A textual value indicating the overall o persistent-id (index 51): A GUID used to identify a related set of
product family this software belongs to. Product family is not software components. Software components sharing the same
used to identify that a product is part of a suite, but is instead persistent-id can be different versions.
used when a set of products that are all related can be installed
on multiple different endpoints. For example, an enterprise
backup system can consist of a backup services, multiple different
backup services that support mail services, databases and ERP
systems, as well as individual software components that backup
client system entities. In such an usage scenario, all software
components that are part of the backup system would have the same
product-family name so they can be grouped together in respect to
reporting systems.
o revision (index 54): A textual value indicating the informal or o product (index 52): A basic name for the software component that
colloquial representation of the sub-version of the given product can be common across multiple tagged software components (e.g.,
(ie, SP1, R2, RC1, Beta 2, etc). Note that the software-version Apache HTTPD).
specified in the concise-swid-tag group will provide very exact
version details. Conversely, the revision item is intended for
use in environments where reporting on the informal or colloquial
representation of the software is important. For example, when an
organization needs "ServicePack 1" or later of a specific product
installed on all devices, they can use the revision data value to
quickly identify any devices that do not meet this requirement.
Depending on how a software organizations distributes revisions, this o product-family (index 53): A textual value indicating the software
value could be specified in a primary (if distributed as an upgrade) components overall product family. This should be used when
or supplemental (if distributed as a patch) CoSWID tag. multiple related software components form a larger capability that
is installed on multiple different endpoints. For example, some
software families may consist of server, client, and shared
service components that are part of a larger capability. Email
systems, enterprise applications, backup services, web
conferencing, and similar capabilities are examples of families.
o summary (index 55): A short (one-sentence) description of the o revision (index 54): A string value indicating an informal or
software. colloquial release version of the software. This value can
provide a different version value as compared to the software-
version specified in the concise-swid-tag group. This is useful
when one or more releases need to have an informal version label
that differs from the specific exact version value specified by
software-version. Examples can include SP1, RC1, Beta, etc.
o unspsc-code (index 56): An 8 digit code that provides UNSPSC o summary (index 55): A short description of the software component.
classification of the software component this SWID tag identifies. This MUST be a single sentence suitable for display in a user
For more information see, http://www.unspsc.org/. interface.
o unspsc-version (index 57): The version of the UNSPSC code used to o unspsc-code (index 56): An 8 digit UNSPSC classification code for
define the UNSPSC code value. For more information see, the software component. For more information see,
http://www.unspsc.org/. http://www.unspsc.org/.
o unspsc-version (index 57): The version of UNSPSC used to define
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.1.
2.8. The Resource Collection Definition 2.8. The Resource Collection Definition
2.8.1. The hash-entry Array 2.8.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.8.2. The resource-collection Group
skipping to change at page 24, line 43 skipping to change at page 26, line 8
o filesystem-item: A list of items both used in representing the o filesystem-item: A list of items both used in representing the
nodes of a file-system hierarchy (i.e., directory items that allow nodes of a file-system hierarchy (i.e., directory items that allow
one or more directories to be defined in the file structure), and one or more directories to be defined in the file structure), and
file items that allow one or more files to be specified for a file items that allow one or more files to be specified for a
given location. given location.
o global-attributes: The global-attributes group described in o global-attributes: The global-attributes group described in
Section 2.4. Section 2.4.
o directory (index 16): A directory item allows one or more o directory (index 16): A directory item allows child directory and
directories to be defined in the file structure. file items to be defined within a directory hierarchy for the
software component.
o file (index 17): A file item that allows one or more files to be o file (index 17): A file item allows details about a file to be
specified for a given location. provided for the software component.
o process (index 18): Provides process (software component in o process (index 18): A process item allows details to be provided
execution) information for data that will show up in a devices about the runtime behavior of the software component, such as
process list. information that will appear in a process listing on a device.
o resource (index 19): A set of items that can be used to provide o resource (index 19): A resource item can be used to provide
arbitrary resource information about an application installed on details about a resource expected to be found on an endpoint, or
in endpoint, or evidence collected from an endpoint. evidence collected related to the software component.
o size (index 20): The size of the file in bytes. o size (index 20): The file's size in bytes.
o file-version (index 21): The version of the file. o file-version (index 21): The file's version as reported by
querying information on the file from the operating system.
o key (index 22): A boolean indicator for when files or directories o key (index 22): A boolean value indicating if a file or directory
are considered important or required for the use of the software is significant or required for the software component to execute
component referenced by the CoSWID. Typical key files or or function properly. These are files or directories that can be
directories would be those which, if not available on an endpoint, used to affirmatively determine if the software component is
would cause the software component not to execute or function installed on an endpoint.
properly. Key files or directories will typically be used to
validate that the software component referenced by the CoSWID tag
is actually installed on a specific endpoint.
o location (index 23): The location where a file was found or can o location (index 23): The filesystem path where a file is expected
expected to be located. This text-string is intended to include to be located when installed or copied. This path SHOULD be
the filename itself. This SHOULD be the relative path from the relative to the location of the parent directory item, or if no
location represented by the root item or if the root item is parent is defined, the location MUST be relative to the location
omitted be relative to the location of the CoSWID tag. of the CoSWID tag. The location MUST not include a file's name,
which is provided by the fs-name item.
o fs-name (index 24): The file name or directory name without any o fs-name (index 24): The name of the directory or file without any
path characters. path information.
o root (index 25): A system-specific root folder that the location o root (index 25): A filesystem-specific name for the root of the
item is an offset from. If this is not specified the assumption filesystem. The location item is considered relative to this
is the root is the same folder as the location of the CoSWID tag. location if specified. If not provided, the value provided by the
The text-string value represents a path expression relative to the location item is expected to be relative to its parent or the
CoSWID tag document location in the (composite) file-system location of the CoSWID tag if no parent is provided.
hierarchy.
o path-elements (index 26): This group provides the ability to apply o path-elements (index 26): This group provides the ability to
a directory structure to the path expressions for files defined in define a directory structure for files defined in payload or
a payload or evidence items. evidence items.
o process-name (index 27): The process name as it will be found in o process-name (index 27): The software component's process name as
the endpoint's process table. it will appear in an endpoint's process list.
o pid (index 28): The process ID for the process in execution that o pid (index 28): The process ID identified for a running instance
can be included in the process item as part of an evidence tag. of the software component in the endpoint's process list. This is
used as part of the evidence item.
o type (index 29): The type of resource represented via a text- o type (index 29): A string indicating the type of resource.
string (typically, registry-key, port or root-uri).
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.1.
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.1.
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.1.
skipping to change at page 27, line 23 skipping to change at page 28, line 27
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.4.
o resource-collection: The resource-collection group described in o resource-collection: The resource-collection group described in
Section 2.8.2. Section 2.8.2.
o date (index 35): The date and time evidence represented by an o date (index 35): The date and time the information was collected
evidence item was gathered. pertaining to the evidence item.
o device-id (index 36): A textual identifier for a device evidence o device-id (index 36): The endpoint's string identifier from which
was gathered from. 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.1.
2.9. Full CDDL Definition 2.9. 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,
tag-version => integer, tag-version => integer,
? corpus => bool, ? corpus => bool,
? patch => bool, ? patch => bool,
? supplemental => bool, ? supplemental => bool,
swid-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 ],
? link => link-entry / [ 2* link-entry ], ? link => link-entry / [ 2* link-entry ],
? (( payload => payload-entry ) // ( evidence => evidence-entry )), ? (( payload => payload-entry ) // ( evidence => evidence-entry )),
* $$coswid-extension * $$coswid-extension
} }
skipping to change at page 29, line 25 skipping to change at page 30, line 29
$rel /= ancestor $rel /= ancestor
$rel /= component $rel /= component
$rel /= feature $rel /= feature
$rel /= installationmedia $rel /= installationmedia
$rel /= packageinstaller $rel /= packageinstaller
$rel /= parent $rel /= parent
$rel /= patches $rel /= patches
$rel /= requires $rel /= requires
$rel /= see-also $rel /= see-also
$rel /= supersedes $rel /= supersedes
$rel /= rel-supplemental $rel /= supplemental
$rel /= uint / text $rel /= uint / text
$use /= optional $use /= optional
$use /= required $use /= required
$use /= recommended $use /= recommended
$use /= uint / text $use /= uint / text
software-meta-entry = { software-meta-entry = {
global-attributes, global-attributes,
? activation-status => text, ? activation-status => text,
skipping to change at page 31, line 19 skipping to change at page 32, line 24
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
} }
; "global map member" integer indexes ; "global map member" integer indexes
tag-id = 0 tag-id = 0
swid-name = 1 software-name = 1
entity = 2 entity = 2
evidence = 3 evidence = 3
link = 4 link = 4
software-meta = 5 software-meta = 5
payload = 6 payload = 6
hash = 7 hash = 7
corpus = 8 corpus = 8
patch = 9 patch = 9
media = 10 media = 10
supplemental = 11 supplemental = 11
skipping to change at page 33, line 10 skipping to change at page 34, line 15
ancestor=1 ancestor=1
component=2 component=2
feature=3 feature=3
installationmedia=4 installationmedia=4
packageinstaller=5 packageinstaller=5
parent=6 parent=6
patches=7 patches=7
requires=8 requires=8
see-also=9 see-also=9
supersedes=10 supersedes=10
rel-supplemental=11 supplemental=11
; "use" integer indexes ; "use" integer indexes
optional=1 optional=1
required=2 required=2
recommended=3 recommended=3
3. Determining the Type of CoSWID 3. Determining the Type of CoSWID
The operational model for SWID and CoSWID tags was introduced in The operational model for SWID and CoSWID tags was introduced in
Section 1.1, which described four different CoSWID tag types. The Section 1.1, which described four different CoSWID tag types. The
skipping to change at page 34, line 31 skipping to change at page 35, line 33
| | | 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 |
+-------+-------------------------+---------------------------------+ +-------+-------------------------+---------------------------------+
The values above are registered in the IANA "SWID/CoSWID Version The values above are registered in the IANA "SWID/CoSWID Version
Schema Values" registry defined in section Section 5.2. Additional Scheme Value" registry defined in section Section 5.2.1. Additional
entires will likely be registered over time in this registry. entires will likely be registered over time in this registry.
Additionally, the index values 32768 through 65535 have been reserved Additionally, the index values 32768 through 65535 have been reserved
for private use. for private use.
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.5). 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. Index value indicates the value to use as the role specification. The "Index" value indicates the value to use as the
item's value. The Role Name provides human-readable text for the role item's value. The "Role Name" provides human-readable text for
value. The Definition describes the semantic meaning of each entry. the value. The "Definition" describes the semantic meaning of each
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 |
| | | the containing SWID or CoSWID tag | | | | the containing SWID or CoSWID tag |
| | | | | | | |
| 2 | softwareCreator | From [SAM], "person or organization | | 2 | softwareCreator | From [SAM], "person or organization |
| | | that creates a software product (3.46) | | | | that creates a software product (3.46) |
| | | or package" | | | | or package" |
skipping to change at page 35, line 40 skipping to change at page 36, line 40
| | | labelling." | | | | labelling." |
| | | | | | | |
| 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 |
| | | package" | | | | package" |
+-------+-----------------+-----------------------------------------+ +-------+-----------------+-----------------------------------------+
The values above are registered in the IANA "SWID/CoSWID Entity Role The values above are registered in the IANA "SWID/CoSWID Entity Role
Values" registry defined in section Section 5.3. Additional valid Value" registry defined in section Section 5.2.2. Additional valid
values will likely be registered over time. Additionally, the index values will likely be registered over time. Additionally, the index
values 128 through 255 have been reserved for private use. values 128 through 255 have been reserved for private use.
4.3. Use Values 4.3. Link Ownership Values
The following table indicates the index value to use for the link-
entry group's ownership item (see Section 2.6). These values match
the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID]
specification. The "Index" value indicates the value to use as the
link-entry group ownership item's value. The "Ownership Type"
provides human-readable text for the value. The "Definition"
describes the semantic meaning of each entry.
+-------+-----------+-----------------------------------------------+
| Index | Ownership | Definition |
| | Type | |
+-------+-----------+-----------------------------------------------+
| 1 | abandon | If the software component referenced by the |
| | | CoSWID tag is uninstalled, then the |
| | | referenced software SHOULD not be uninstalled |
| | | |
| 2 | private | If the software component referenced by the |
| | | CoSWID tag is uninstalled, then the |
| | | referenced software SHOULD be uninstalled as |
| | | well. |
| | | |
| 3 | shared | If the software component referenced by the |
| | | CoSWID tag is uninstalled, then the |
| | | referenced software SHOULD be uninstalled if |
| | | no other components sharing the software. |
+-------+-----------+-----------------------------------------------+
The values above are registered in the IANA "SWID/CoSWID Link
Ownership Value" registry defined in section Section 5.2.3.
Additional valid values will likely be registered over time.
Additionally, the index values 128 through 255 have been reserved for
private use.
4.4. Link Rel Values
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
link rel values defined in the ISO/IEC 19770-2:2015 [SWID]
specification. The "Index" value indicates the value to use as the
link-entry group ownership item's value. The "Relationship Type"
provides human-readable text for the value. The "Definition"
describes the semantic meaning of each entry.
+-------+-------------------+---------------------------------------+
| Index | Relationship Type | Definition |
+-------+-------------------+---------------------------------------+
| 1 | ancestor | The link references a SWID/CoSWID tag |
| | | for an ancestor of this software. |
| | | This can be useful to define an |
| | | upgrade path. |
| | | |
| 2 | component | The link references a SWID/CoSWID tag |
| | | for a separate component of this |
| | | software. |
| | | |
| 3 | feature | The link references a configurable |
| | | feature of this software, that can be |
| | | enabled or disabled without changing |
| | | the installed files. |
| | | |
| 4 | installationmedia | The link references the installation |
| | | package that can be used to install |
| | | this software. |
| | | |
| 5 | packageinstaller | The link references the installation |
| | | software needed to install this |
| | | software. |
| | | |
| 6 | parent | The link references a SWID/CoSWID tag |
| | | that is the parent of this |
| | | SWID/CoSWID tag. |
| | | |
| 7 | patches | The link references a SWID/CoSWID tag |
| | | that this software patches. Typically |
| | | only used for patch SWID/CoSWID tags |
| | | (see Section 1.1). |
| | | |
| 8 | requires | The link references a prerequisite |
| | | for installing this software. A patch |
| | | SWID/CoSWID tag (see Section 1.1) can |
| | | use this to represent base software |
| | | or another patch that needs to be |
| | | installed first. |
| | | |
| 9 | see-also | The link references other software |
| | | that may be of interest that relates |
| | | to this software. |
| | | |
| 10 | supersedes | The link references another software |
| | | that this software replaces. A patch |
| | | SWID/CoSWID tag (see Section 1.1) can |
| | | use this to represent another patch |
| | | that this patch incorporates or |
| | | replaces. |
| | | |
| 11 | supplemental | The link references a SWID/CoSWID tag |
| | | that this tag supplements. Used on |
| | | supplemental SWID/CoSWID tags (see |
| | | Section 1.1). |
+-------+-------------------+---------------------------------------+
The values above are registered in the IANA "SWID/CoSWID Link
Relationship Value" registry defined in section Section 5.2.4.
Additional valid values will likely be registered over time.
Additionally, the index values 32768 through 65535 have been reserved
for private use.
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.6). 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. Index value indicates the value to use as the link- specification. The "Index" value indicates the value to use as the
entry group use item's value. The Use Type provides human-readable link-entry group use item's value. The "Use Type" provides human-
text for the value. The Definition describes the semantic meaning of readable text for the value. The "Definition" describes the semantic
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 |
| | | [Link]'d software is installed only when | | | | [Link]'d software is installed only when |
| | | specified." | | | | specified." |
| | | | | | | |
| 2 | required | From [SWID], "The [Link]'d software is | | 2 | required | From [SWID], "The [Link]'d software is |
| | | absolutely required for an operation | | | | absolutely required for an operation |
| | | 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." |
+-------+-------------+---------------------------------------------+ +-------+-------------+---------------------------------------------+
The values above are registered in the IANA "SWID/CoSWID Link Use The values above are registered in the IANA "SWID/CoSWID Link Use
Values" registry defined in section Section 5.4. Additional valid Value" registry defined in section Section 5.2.5. Additional valid
values will likely be registered over time. Additionally, the index values will likely be registered over time. Additionally, the index
values 128 through 255 have been reserved for private use. values 128 through 255 have been reserved for 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
skipping to change at page 37, line 10 skipping to change at page 40, line 24
Initial registrations for the "CoSWID Items" registry are provided Initial registrations for the "CoSWID Items" registry are provided
below. Assignments consist of an integer index value, the item name, below. Assignments consist of an integer index value, the item name,
and a reference to the defining specification. and a reference to the defining specification.
+---------------+---------------------------+---------------+ +---------------+---------------------------+---------------+
| Index | Item Name | Specification | | Index | Item Name | Specification |
+---------------+---------------------------+---------------+ +---------------+---------------------------+---------------+
| 0 | tag-id | RFC-AAAA | | 0 | tag-id | RFC-AAAA |
| | | | | | | |
| 1 | swid-name | RFC-AAAA | | 1 | software-name | RFC-AAAA |
| | | | | | | |
| 2 | entity | RFC-AAAA | | 2 | entity | RFC-AAAA |
| | | | | | | |
| 3 | evidence | RFC-AAAA | | 3 | evidence | RFC-AAAA |
| | | | | | | |
| 4 | link | RFC-AAAA | | 4 | link | RFC-AAAA |
| | | | | | | |
| 5 | software-meta | RFC-AAAA | | 5 | software-meta | RFC-AAAA |
| | | | | | | |
| 6 | payload | RFC-AAAA | | 6 | payload | RFC-AAAA |
skipping to change at page 39, line 28 skipping to change at page 42, line 42
| | | | | | | |
| 55 | summary | RFC-AAAA | | 55 | summary | RFC-AAAA |
| | | | | | | |
| 56 | unspsc-code | RFC-AAAA | | 56 | unspsc-code | RFC-AAAA |
| | | | | | | |
| 57 | unspsc-version | RFC-AAAA | | 57 | unspsc-version | RFC-AAAA |
| | | | | | | |
| 58-4294967295 | Unassigned | | | 58-4294967295 | Unassigned | |
+---------------+---------------------------+---------------+ +---------------+---------------------------+---------------+
5.2. SWID/CoSWID Version Schema Values Registry 5.2. SWID/CoSWID Value Registries
This document uses unsigned 16-bit index values to version-scheme The following IANA registries provide a mechanism for new valid
item values. The initial set of version-scheme values are derived values to be added over time to common enumerations used by SWID and
from the textual version scheme names defined in the ISO/IEC CoSWID.
5.2.1. SWID/CoSWID Version Scheme Value Registry
This document uses unsigned 16-bit index values to represent version-
scheme item values. The initial set of version-scheme values are
derived from the textual version scheme names defined in the ISO/IEC
19770-2:2015 specification [SWID]. 19770-2:2015 specification [SWID].
This document defines a new a new registry titled "SWID/CoSWID This document defines a new a new registry titled "SWID/CoSWID
Version Schema Values". Future registrations for this registry are Version Scheme Values". Future registrations for this registry are
to be made based on [RFC8126] as follows: to be made based on [RFC8126] as follows:
[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 | | Range | Registration Procedures |
+-------------+--------------------------+ +-------------+--------------------------+
| 0-16383 | Standards Action | | 0-16383 | Standards Action |
| | | | | |
| 16384-32767 | Specification Required | | 16384-32767 | Specification Required |
| | | | | |
| 32768-65535 | Reserved for Private Use | | 32768-65535 | Reserved for Private Use |
+-------------+--------------------------+ +-------------+--------------------------+
Initial registrations for the "SWID/CoSWID Version Schema Values" Initial registrations for the "SWID/CoSWID Version Scheme Value"
registry are provided below. Assignments consist of an integer index registry are provided below. Assignments consist of an integer Index
value, the version scheme name, and a reference to the defining value, the Version Scheme Name, and a reference to the defining
specification. 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 |
skipping to change at page 40, line 32 skipping to change at page 44, line 27
| | | | | | | |
| 5-16383 | Unassigned | | | 5-16383 | Unassigned | |
| | | | | | | |
| 16384 | semver | [SEMVER] | | 16384 | semver | [SEMVER] |
| | | | | | | |
| 16385-32767 | Unassigned | | | 16385-32767 | Unassigned | |
| | | | | | | |
| 32768-65535 | Reserved for Private Use | | | 32768-65535 | Reserved for Private Use | |
+-------------+--------------------------+-----------------+ +-------------+--------------------------+-----------------+
5.3. SWID/CoSWID Entity Role Values Registry 5.2.2. SWID/CoSWID Entity Role Value Registry
This document uses unsigned 8-bit index values to represent entity- This document uses unsigned 8-bit index values to represent entity-
role values. The initial set of Entity roles are derived from the entry role item values. The initial set of Entity roles are derived
textual role names defined in the ISO/IEC 19770-2:2015 specification from the textual role names defined in the ISO/IEC 19770-2:2015
[SWID]. 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". Future registrations for this registry are to be made
based on [RFC8126] as follows: based on [RFC8126] as follows:
[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 | | Range | Registration Procedures |
+---------+--------------------------+ +---------+--------------------------+
| 0-31 | Standards Action | | 0-31 | Standards Action |
| | | | | |
| 32-127 | Specification Required | | 32-127 | Specification Required |
| | | | | |
| 128-255 | Reserved for Private Use | | 128-255 | Reserved for Private Use |
+---------+--------------------------+ +---------+--------------------------+
skipping to change at page 41, line 14 skipping to change at page 45, line 5
+---------+--------------------------+ +---------+--------------------------+
| Range | Registration Procedures | | Range | Registration Procedures |
+---------+--------------------------+ +---------+--------------------------+
| 0-31 | Standards Action | | 0-31 | Standards Action |
| | | | | |
| 32-127 | Specification Required | | 32-127 | Specification Required |
| | | | | |
| 128-255 | Reserved for Private Use | | 128-255 | Reserved for Private Use |
+---------+--------------------------+ +---------+--------------------------+
Initial registrations for the "SWID/CoSWID Entity Role Values" Initial registrations for the "SWID/CoSWID Entity Role Value"
registry are provided below. Assignments consist of an integer index registry are provided below. Assignments consist of an integer Index
value, a role name, and a reference to the defining specification. value, a Role Name, and a reference to the defining specification.
+---------+--------------------------+-----------------+ +---------+--------------------------+-----------------+
| Index | Role Name | Specification | | Index | Role Name | Specification |
+---------+--------------------------+-----------------+ +---------+--------------------------+-----------------+
| 0 | Reserved | | | 0 | Reserved | |
| | | | | | | |
| 1 | tagCreator | See Section 4.2 | | 1 | tagCreator | See Section 4.2 |
| | | | | | | |
| 2 | softwareCreator | See Section 4.2 | | 2 | softwareCreator | See Section 4.2 |
| | | | | | | |
| 3 | aggregator | See Section 4.2 | | 3 | aggregator | See Section 4.2 |
| | | | | | | |
| 4 | distributor | See Section 4.2 | | 4 | distributor | See Section 4.2 |
| | | | | | | |
| 5 | licensor | See Section 4.2 | | 5 | licensor | See Section 4.2 |
| | | | | | | |
| 6-31 | Unassigned | | | 6-127 | Unassigned | |
| | | |
| 32-127 | Unassigned | |
| | | | | | | |
| 128-255 | Reserved for Private Use | | | 128-255 | Reserved for Private Use | |
+---------+--------------------------+-----------------+ +---------+--------------------------+-----------------+
5.4. SWID/CoSWID Link Use Values Registry 5.2.3. SWID/CoSWID Link Ownership Value Registry
This document uses unsigned 8-bit index values to represent link-use This document uses unsigned 8-bit index values to represent link-
values. The initial set of Link use values are derived from the entry ownership item values. The initial set of Link ownership
textual names defined in the ISO/IEC 19770-2:2015 specification values are derived from the textual ownership names defined in the
[SWID]. ISO/IEC 19770-2:2015 specification [SWID].
This document defines a new a new registry titled "SWID/CoSWID Link
Ownership Values". Future registrations for this registry are to be
made based on [RFC8126] as follows:
[TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid]
+---------+--------------------------+
| Range | Registration Procedures |
+---------+--------------------------+
| 0-31 | Standards Action |
| | |
| 32-127 | Specification Required |
| | |
| 128-255 | Reserved for Private Use |
+---------+--------------------------+
Initial registrations for the "SWID/CoSWID Link Ownership Value"
registry are provided below. Assignments consist of an integer Index
value, an Ownership Type Name, and a reference to the defining
specification.
+-------------+--------------------------+-----------------+
| Index | Ownership Type Name | Definition |
+-------------+--------------------------+-----------------+
| 0 | Reserved | |
| | | |
| 1 | abandon | See Section 4.3 |
| | | |
| 2 | private | See Section 4.3 |
| | | |
| 3 | shared | See Section 4.3 |
| | | |
| 4-16384 | Unassigned | |
| | | |
| 16385-32767 | Unassigned | |
| | | |
| 32768-65535 | Reserved for Private Use | |
+-------------+--------------------------+-----------------+
5.2.4. SWID/CoSWID Link Relationship Value Registry
This document uses unsigned 16-bit index values to represent link-
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
Relationship Values". Future registrations for this registry are to
be made based on [RFC8126] as follows:
[TO BE REMOVED: This registration should take place at the following
location: https://www.iana.org/assignments/swid]
+-------------+--------------------------+
| Range | Registration Procedures |
+-------------+--------------------------+
| 0-16383 | Standards Action |
| | |
| 16384-32767 | Specification Required |
| | |
| 32768-65535 | Reserved for Private Use |
+-------------+--------------------------+
Initial registrations for the "SWID/CoSWID Link Relationship Value"
registry are provided below. Assignments consist of an integer Index
value, the Relationship Type Name, and a reference to the defining
specification.
+-------------+--------------------------+-----------------+
| Index | Relationship Type Name | Specification |
+-------------+--------------------------+-----------------+
| 0 | Reserved | |
| | | |
| 1 | ancestor | See Section 4.4 |
| | | |
| 2 | component | See Section 4.4 |
| | | |
| 3 | feature | See Section 4.4 |
| | | |
| 4 | installationmedia | See Section 4.4 |
| | | |
| 5 | packageinstaller | See Section 4.4 |
| | | |
| 6 | parent | See Section 4.4 |
| | | |
| 7 | patches | See Section 4.4 |
| | | |
| 8 | requires | See Section 4.4 |
| | | |
| 9 | see-also | See Section 4.4 |
| | | |
| 10 | supersedes | See Section 4.4 |
| | | |
| 11 | supplemental | See Section 4.4 |
| | | |
| 12-16384 | Unassigned | |
| | | |
| 16385-32767 | Unassigned | |
| | | |
| 32768-65535 | Reserved for Private Use | |
+-------------+--------------------------+-----------------+
5.2.5. SWID/CoSWID Link Use Value Registry
This document uses unsigned 8-bit index values to represent link-
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". Future registrations for this registry are to be made
based on [RFC8126] as follows: based on [RFC8126] as follows:
[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 | | Range | Registration Procedures |
+---------+--------------------------+ +---------+--------------------------+
| 0-31 | Standards Action | | 0-31 | Standards Action |
| | | | | |
| 32-127 | Specification Required | | 32-127 | Specification Required |
| | | | | |
| 128-255 | Reserved for Private Use | | 128-255 | Reserved for Private Use |
+---------+--------------------------+ +---------+--------------------------+
Initial registrations for the "SWID/CoSWID Entity Role Values" Initial registrations for the "SWID/CoSWID Entity Role Value"
registry are provided below. Assignments consist of an integer index registry are provided below. Assignments consist of an integer Index
value, the link use name, and a reference to the defining value, the Link Use Type Name, and a reference to the defining
specification. specification.
+---------+--------------------------+-----------------+ +---------+--------------------------+-----------------+
| Index | Link Use Name | Specification | | Index | Link Use Type Name | Specification |
+---------+--------------------------+-----------------+ +---------+--------------------------+-----------------+
| 0 | Reserved | | | 0 | Reserved | |
| | | | | | | |
| 1 | optional | See Section 4.3 | | 1 | optional | See Section 4.5 |
| | | |
| 2 | required | See Section 4.3 |
| | | | | | | |
| 3 | recommended | See Section 4.3 | | 2 | required | See Section 4.5 |
| | | | | | | |
| 4-31 | Unassigned | | | 3 | recommended | See Section 4.5 |
| | | | | | | |
| 32-127 | Unassigned | | | 4-127 | Unassigned | |
| | | | | | | |
| 128-255 | Reserved for Private Use | | | 128-255 | Reserved for Private Use | |
+---------+--------------------------+-----------------+ +---------+--------------------------+-----------------+
5.5. swid+cbor Media Type Registration 5.3. swid+cbor Media Type Registration
IANA is requested add the following to the IANA "Media Types" IANA is requested add the following to the IANA "Media Types"
registry. registry.
Type name: application Type name: application
Subtype name: swid+cbor Subtype name: swid+cbor
Required parameters: none Required parameters: none
Optional parameters: none Optional parameters: none
Encoding considerations: Must be encoded as using [RFC7049]. See Encoding considerations: Must be encoded as using [RFC7049]. See
RFC-AAAA for details. RFC-AAAA for details.
Security considerations: See Section 6 of RFC-AAAA. Security considerations: See Section 6 of RFC-AAAA.
Interoperability considerations: Applications MAY ignore any key Interoperability considerations: Applications MAY ignore any key
value pairs that they do not understand. This allows backwards value pairs that they do not understand. This allows backwards
compatible extensions to this specification. compatible extensions to this specification.
Published specification: RFC-AAAA Published specification: RFC-AAAA
skipping to change at page 43, line 45 skipping to change at page 49, line 47
Birkholz <henk.birkholz@sit.fraunhofer.de> Birkholz <henk.birkholz@sit.fraunhofer.de>
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: None Restrictions on usage: None
Author: Henk Birkholz <henk.birkholz@sit.fraunhofer.de> Author: Henk Birkholz <henk.birkholz@sit.fraunhofer.de>
Change controller: IESG Change controller: IESG
5.6. CoAP Content-Format Registration 5.4. CoAP Content-Format Registration
IANA is requested to assign a CoAP Content-Format ID for the CoSWID IANA is requested to assign a CoAP Content-Format ID for the CoSWID
media type in the "CoAP Content-Formats" sub-registry, from the "IETF media type in the "CoAP Content-Formats" sub-registry, from the "IETF
Review or IESG Approval" space (256..999), within the "CoRE Review or IESG Approval" space (256..999), within the "CoRE
Parameters" registry [RFC7252]: Parameters" registry [RFC7252]:
+-----------------------+----------+------+-----------+ +-----------------------+----------+------+-----------+
| Media type | Encoding | ID | Reference | | Media type | Encoding | ID | Reference |
+-----------------------+----------+------+-----------+ +-----------------------+----------+------+-----------+
| application/swid+cbor | - | TBD1 | RFC-AAAA | | application/swid+cbor | - | TBD1 | RFC-AAAA |
+-----------------------+----------+------+-----------+ +-----------------------+----------+------+-----------+
Table 1: CoAP Content-Format IDs Table 1: CoAP Content-Format IDs
5.7. CBOR Tag Registration 5.5. CBOR Tag Registration
IANA is requested to allocate a tag in the "CBOR Tags" registry", IANA is requested to allocate a tag in the "CBOR Tags" registry",
preferably with the specific value requested: preferably with the specific value requested:
+------------+----------+-------------------------------------------+ +------------+----------+-------------------------------------------+
| Tag | Data | Semantics | | Tag | Data | Semantics |
| | Item | | | | Item | |
+------------+----------+-------------------------------------------+ +------------+----------+-------------------------------------------+
| 1398229316 | map | Concise Software Identifier (CoSWID) | | 1398229316 | map | Concise Software Identifier (CoSWID) |
| | | [RFC-AAAA] | | | | [RFC-AAAA] |
skipping to change at page 45, line 35 skipping to change at page 51, line 37
exposed to an attacker, this can tell them which software products exposed to an attacker, this can tell them which software products
and versions thereof are present on the endpoint. By examining this and versions thereof are present on the endpoint. By examining this
list, the attacker might learn of the presence of applications that list, the attacker might learn of the presence of applications that
are vulnerable to certain types of attacks. As noted earlier, SWID are vulnerable to certain types of attacks. As noted earlier, SWID
tags are designed to be easily discoverable by an endpoint, but this tags are designed to be easily discoverable by an endpoint, but this
does not present a significant risk since an attacker would already does not present a significant risk since an attacker would already
need to have access to the endpoint to view that information. need to have access to the endpoint to view that information.
However, when the endpoint transmits its software inventory to However, when the endpoint transmits its software inventory to
another party, or that inventory is stored on a server for later another party, or that inventory is stored on a server for later
analysis, this can potentially expose this information to attackers analysis, this can potentially expose this information to attackers
who do not yet have access to the endpoint. As such, it is important who do not yet have access to the endpoint. For this reason, it is
to protect the confidentiality of SWID tag information that has been important to protect the confidentiality of SWID tag information that
collected from an endpoint, not because those tags individually has been collected from an endpoint, not because those tags
contain sensitive information, but because the collection of SWID individually contain sensitive information, but because the
tags and their association with an endpoint reveals information about collection of SWID tags and their association with an endpoint
that endpoint's attack surface. reveals information about that endpoint's attack surface.
Finally, both the ISO-19770-2:2015 XML schema definition and the Finally, both the ISO-19770-2:2015 XML schema definition and the
Concise SWID data definition allow for the construction of "infinite" Concise SWID data definition allow for the construction of "infinite"
SWID tags or SWID tags that contain malicious content with the intent SWID tags or SWID tags that contain malicious content with the intent
if creating non-deterministic states during validation or processing if creating non-deterministic states during validation or processing
of SWID tags. While software product vendors are unlikely to do of SWID tags. While software product vendors are unlikely to do
this, SWID tags can be created by any party and the SWID tags this, SWID tags can be created by any party and the SWID tags
collected from an endpoint could contain a mixture of vendor and non- collected from an endpoint could contain a mixture of vendor and non-
vendor created tags. For this reason, tools that consume SWID tags vendor created tags. For this reason, tools that consume SWID tags
ought to treat the tag contents as potentially malicious and employ ought to treat the tag contents as potentially malicious and employ
skipping to change at page 46, line 44 skipping to change at page 52, line 46
and to reference the new IANA registry for items. and to reference the new IANA registry for items.
o Removed unused references and added new references to address o Removed unused references and added new references to address
placeholder comments. placeholder comments.
o Added table with semantics for the link ownership item. o Added table with semantics for the link ownership item.
o Clarified language, made term use more consistent, fixed o Clarified language, made term use more consistent, fixed
references, and replacing lowercase RFC2119 keywords. references, and replacing lowercase RFC2119 keywords.
o Added enumeration table
o Moved CBOR specific indexes to the end of the CDDL data definition
o Updated Examples
Changes from version 02 to version 03: Changes from version 02 to version 03:
o Updated core CDDL including the CDDL design pattern according to o Updated core CDDL including the CDDL design pattern according to
RFC 8428. RFC 8428.
Changes from version 01 to version 02: Changes from version 01 to version 02:
o Enforced a more strict separation between the core CoSWID o Enforced a more strict separation between the core CoSWID
definition and additional usage by moving content to corresponding definition and additional usage by moving content to corresponding
appendices. appendices.
skipping to change at page 50, line 46 skipping to change at page 56, line 43
<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>.
[RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data
Definition Language (CDDL): A Notational Convention to
Express Concise Binary Object Representation (CBOR) and
JSON Data Structures", RFC 8610, DOI 10.17487/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.
[SEMVER] Preston-Werner, T., "Semantic Versioning 2.0.0", n.d., [SEMVER] Preston-Werner, T., "Semantic Versioning 2.0.0", n.d.,
<https://semver.org/spec/v2.0.0.html>. <https://semver.org/spec/v2.0.0.html>.
[SWID] "Information technology - Software asset management - Part [SWID] "Information technology - Software asset management - Part
2: Software identification tag", ISO/IEC 19770-2:2015, 2: Software identification tag", ISO/IEC 19770-2:2015,
October 2015. October 2015.
skipping to change at page 51, line 42 skipping to change at page 57, line 45
[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.
[I-D.ietf-cbor-cddl]
Birkholz, H., Vigano, C., and C. Bormann, "Concise data
definition language (CDDL): a notational convention to
express CBOR and JSON data structures", draft-ietf-cbor-
cddl-08 (work in progress), March 2019.
[KebabCase] [KebabCase]
"KebabCase", December 2014, "KebabCase", December 2014,
<http://wiki.c2.com/?KebabCase>. <http://wiki.c2.com/?KebabCase>.
[RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
Unique IDentifier (UUID) URN Namespace", RFC 4122, Unique IDentifier (UUID) URN Namespace", RFC 4122,
DOI 10.17487/RFC4122, July 2005, DOI 10.17487/RFC4122, July 2005,
<https://www.rfc-editor.org/info/rfc4122>. <https://www.rfc-editor.org/info/rfc4122>.
[RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource- [RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource-
 End of changes. 110 change blocks. 
367 lines changed or deleted 666 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/