idnits 2.17.1 draft-ietf-sacm-coswid-17.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (22 February 2021) is 1159 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'Link' is mentioned on line 2008, but not defined == Missing Reference: 'RFC-AAAA' is mentioned on line 2673, but not defined -- Possible downref: Non-RFC (?) normative reference: ref. 'NIHAR' ** Obsolete normative reference: RFC 7049 (Obsoleted by RFC 8949) -- Duplicate reference: RFC8126, mentioned in 'RFC8126', was also mentioned in 'BCP26'. ** Obsolete normative reference: RFC 8152 (Obsoleted by RFC 9052, RFC 9053) -- Possible downref: Non-RFC (?) normative reference: ref. 'SAM' -- Possible downref: Non-RFC (?) normative reference: ref. 'SEMVER' -- Possible downref: Non-RFC (?) normative reference: ref. 'SWID' -- Possible downref: Non-RFC (?) normative reference: ref. 'UNSPSC' == Outdated reference: A later version (-22) exists of draft-ietf-rats-architecture-10 Summary: 2 errors (**), 0 flaws (~~), 5 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 SACM Working Group H. Birkholz 3 Internet-Draft Fraunhofer SIT 4 Intended status: Standards Track J. Fitzgerald-McKay 5 Expires: 26 August 2021 National Security Agency 6 C. Schmidt 7 The MITRE Corporation 8 D. Waltermire 9 NIST 10 22 February 2021 12 Concise Software Identification Tags 13 draft-ietf-sacm-coswid-17 15 Abstract 17 ISO/IEC 19770-2:2015 Software Identification (SWID) tags provide an 18 extensible XML-based structure to identify and describe individual 19 software components, patches, and installation bundles. SWID tag 20 representations can be too large for devices with network and storage 21 constraints. This document defines a concise representation of SWID 22 tags: Concise SWID (CoSWID) tags. CoSWID supports a similar set of 23 semantics and features as SWID tags, as well as new semantics that 24 allow CoSWIDs to describe additional types of information, all in a 25 more memory efficient format. 27 Status of This Memo 29 This Internet-Draft is submitted in full conformance with the 30 provisions of BCP 78 and BCP 79. 32 Internet-Drafts are working documents of the Internet Engineering 33 Task Force (IETF). Note that other groups may also distribute 34 working documents as Internet-Drafts. The list of current Internet- 35 Drafts is at https://datatracker.ietf.org/drafts/current/. 37 Internet-Drafts are draft documents valid for a maximum of six months 38 and may be updated, replaced, or obsoleted by other documents at any 39 time. It is inappropriate to use Internet-Drafts as reference 40 material or to cite them other than as "work in progress." 42 This Internet-Draft will expire on 26 August 2021. 44 Copyright Notice 46 Copyright (c) 2021 IETF Trust and the persons identified as the 47 document authors. All rights reserved. 49 This document is subject to BCP 78 and the IETF Trust's Legal 50 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 51 license-info) in effect on the date of publication of this document. 52 Please review these documents carefully, as they describe your rights 53 and restrictions with respect to this document. Code Components 54 extracted from this document must include Simplified BSD License text 55 as described in Section 4.e of the Trust Legal Provisions and are 56 provided without warranty as described in the Simplified BSD License. 58 Table of Contents 60 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 61 1.1. The SWID and CoSWID Tag Lifecycle . . . . . . . . . . . . 5 62 1.2. Concise SWID Format . . . . . . . . . . . . . . . . . . . 8 63 1.3. Requirements Notation . . . . . . . . . . . . . . . . . . 8 64 2. Concise SWID Data Definition . . . . . . . . . . . . . . . . 8 65 2.1. Character Encoding . . . . . . . . . . . . . . . . . . . 10 66 2.2. Concise SWID Extensions . . . . . . . . . . . . . . . . . 10 67 2.3. The concise-swid-tag Map . . . . . . . . . . . . . . . . 12 68 2.4. concise-swid-tag Co-Constraints . . . . . . . . . . . . . 16 69 2.5. The global-attributes Group . . . . . . . . . . . . . . . 17 70 2.6. The entity-entry Map . . . . . . . . . . . . . . . . . . 18 71 2.7. The link-entry Map . . . . . . . . . . . . . . . . . . . 19 72 2.8. The software-meta-entry Map . . . . . . . . . . . . . . . 23 73 2.9. The Resource Collection Definition . . . . . . . . . . . 27 74 2.9.1. The hash-entry Array . . . . . . . . . . . . . . . . 27 75 2.9.2. The resource-collection Group . . . . . . . . . . . . 27 76 2.9.3. The payload-entry Map . . . . . . . . . . . . . . . . 31 77 2.9.4. The evidence-entry Map . . . . . . . . . . . . . . . 31 78 2.10. Full CDDL Specification . . . . . . . . . . . . . . . . . 32 79 3. Determining the Type of CoSWID . . . . . . . . . . . . . . . 38 80 4. CoSWID Indexed Label Values . . . . . . . . . . . . . . . . . 38 81 4.1. Version Scheme . . . . . . . . . . . . . . . . . . . . . 39 82 4.2. Entity Role Values . . . . . . . . . . . . . . . . . . . 40 83 4.3. Link Ownership Values . . . . . . . . . . . . . . . . . . 42 84 4.4. Link Rel Values . . . . . . . . . . . . . . . . . . . . . 43 85 4.5. Link Use Values . . . . . . . . . . . . . . . . . . . . . 45 86 5. URI Schemes . . . . . . . . . . . . . . . . . . . . . . . . . 45 87 5.1. "swid" URI Scheme Specification . . . . . . . . . . . . . 46 88 5.2. "swidpath" URI Scheme Specification . . . . . . . . . . . 46 89 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 46 90 6.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 47 91 6.2. Software Tag Values Registries . . . . . . . . . . . . . 50 92 6.2.1. Registration Procedures . . . . . . . . . . . . . . . 50 93 6.2.2. Private Use of Index and Name Values . . . . . . . . 50 94 6.2.3. Expert Review Guidelines . . . . . . . . . . . . . . 50 95 6.2.4. Software Tag Version Scheme Values Registry . . . . . 51 96 6.2.5. Software Tag Entity Role Values Registry . . . . . . 53 97 6.2.6. Software Tag Link Ownership Values Registry . . . . . 54 98 6.2.7. Software Tag Link Relationship Values Registry . . . 55 99 6.2.8. Software Tag Link Use Values Registry . . . . . . . . 58 100 6.3. swid+cbor Media Type Registration . . . . . . . . . . . . 59 101 6.4. CoAP Content-Format Registration . . . . . . . . . . . . 60 102 6.5. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 60 103 6.6. URI Scheme Registrations . . . . . . . . . . . . . . . . 61 104 6.6.1. "swid" URI Scheme Registration . . . . . . . . . . . 61 105 6.6.2. "swidpath" URI Scheme Registration . . . . . . . . . 61 106 6.7. CoSWID Model for use in SWIMA Registration . . . . . . . 62 107 7. Signed CoSWID Tags . . . . . . . . . . . . . . . . . . . . . 63 108 8. Tagged CoSWID Tags . . . . . . . . . . . . . . . . . . . . . 64 109 9. Security Considerations . . . . . . . . . . . . . . . . . . . 65 110 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 67 111 11. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 67 112 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 72 113 12.1. Normative References . . . . . . . . . . . . . . . . . . 72 114 12.2. Informative References . . . . . . . . . . . . . . . . . 75 115 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 76 117 1. Introduction 119 SWID tags, as defined in ISO-19770-2:2015 [SWID], provide a 120 standardized XML-based record format that identifies and describes a 121 specific release of software, a patch, or an installation bundle, 122 which are referred to as software components in this document. 123 Different software components, and even different releases of a 124 particular software component, each have a different SWID tag record 125 associated with them. SWID tags are meant to be flexible and able to 126 express a broad set of metadata about a software component. 128 SWID tags are used to support a number of processes including but not 129 limited to: 131 * Software Inventory Management, a part of a Software Asset 132 Management [SAM] process, which requires an accurate list of 133 discernible deployed software components. 135 * Vulnerability Assessment, which requires a semantic link between 136 standardized vulnerability descriptions and software components 137 installed on IT-assets [X.1520]. 139 * Remote Attestation, which requires a link between reference 140 integrity measurements (RIM) and Attester-produced event logs that 141 complement attestation Evidence [I-D.ietf-rats-architecture]. 143 While there are very few required fields in SWID tags, there are many 144 optional fields that support different uses. A SWID tag consisting 145 of only required fields might be a few hundred bytes in size; 146 however, a tag containing many of the optional fields can be many 147 orders of magnitude larger. Thus, real-world instances of SWID tags 148 can be fairly large, and the communication of SWID tags in usage 149 scenarios, such as those described earlier, can cause a large amount 150 of data to be transported. This can be larger than acceptable for 151 constrained devices and networks. Concise SWID (CoSWID) tags 152 significantly reduce the amount of data transported as compared to a 153 typical SWID tag through the use of the Concise Binary Object 154 Representation (CBOR) [RFC7049]. 156 Size comparisons between XML SWID and CoSWID mainly depend on domain- 157 specific applications and the complexity of attributes used in 158 instances. While the values stored in CoSWID are often unchanged and 159 therefore not reduced in size compared to an XML SWID, the 160 scaffolding that the CoSWID encoding represents is significantly 161 smaller by taking up 10 percent or less in size. This effect is 162 visible in instances sizes, which can benefit from a 50 percent to 85 163 percent reduction of size in generic usage scenarios. Additional 164 size reduction is enabled with respect to the memory footprint of XML 165 parsing/validation as well as the reduction of stack sizes where XML 166 processing is now obsolete. 168 In a CoSWID, the human-readable labels of SWID data items are 169 replaced with more concise integer labels (indices). This approach 170 allows SWID and CoSWID to share a common implicit information model, 171 with CoSWID providing an alternate data model [RFC3444]. While SWID 172 and CoSWID are intended to share the same implicit information model, 173 this specification does not define this information model, or a 174 mapping between the the two data formats. While an attempt to align 175 SWID and CoSWID tags has been made here, future revisions of ISO/IEC 176 19770-2:2015 or this specification might cause this implicit 177 information model to diverge, since these specifications are 178 maintained by different standards groups. 180 The use of CBOR to express SWID information in CoSWID tags allows 181 both CoSWID and SWID tags to be part of an enterprise security 182 solution for a wider range of endpoints and environments. 184 1.1. The SWID and CoSWID Tag Lifecycle 186 In addition to defining the format of a SWID tag record, ISO/IEC 187 19770-2:2015 defines requirements concerning the SWID tag lifecycle. 188 Specifically, when a software component is installed on an endpoint, 189 that software component's SWID tag is also installed. Likewise, when 190 the software component is uninstalled or replaced, the SWID tag is 191 deleted or replaced, as appropriate. As a result, ISO/IEC 192 19770-2:2015 describes a system wherein there is a correspondence 193 between the set of installed software components on an endpoint, and 194 the presence of the corresponding SWID tags for these components on 195 that endpoint. CoSWIDs share the same lifecycle requirements as a 196 SWID tag. 198 The SWID specification and supporting guidance provided in NIST 199 Internal Report (NISTIR) 8060: Guidelines for the Creation of 200 Interoperable SWID Tags [SWID-GUIDANCE] defines four types of SWID 201 tags: primary, patch, corpus, and supplemental. The following text 202 is paraphrased from these sources. 204 1. Primary Tag - A SWID or CoSWID tag that identifies and describes 205 an installed software component on an endpoint. A primary tag is 206 intended to be installed on an endpoint along with the 207 corresponding software component. 209 2. Patch Tag - A SWID or CoSWID tag that identifies and describes an 210 installed patch that has made incremental changes to a software 211 component installed on an endpoint. A patch tag is intended to 212 be installed on an endpoint along with the corresponding software 213 component patch. 215 3. Corpus Tag - A SWID or CoSWID tag that identifies and describes 216 an installable software component in its pre-installation state. 217 A corpus tag can be used to represent metadata about an 218 installation package or installer for a software component, a 219 software update, or a patch. 221 4. Supplemental Tag - A SWID or CoSWID tag that allows additional 222 information to be associated with a referenced SWID tag. This 223 allows tools and users to record their own metadata about a 224 software component without modifying SWID primary or patch tags 225 created by a software provider. 227 The type of a tag is determined by specific data elements, which are 228 discussed in Section 3, which also provides normative language for 229 CoSWID semantics that implement this lifecycle. The following 230 information helps to explain how these semantics apply to use of a 231 CoSWID tag. 233 Corpus, primary, and patch tags have similar functions in that 234 they describe the existence and/or presence of different types of 235 software components (e.g., software installers, software 236 installations, software patches), and, potentially, different 237 states of these software components. Supplemental tags have the 238 same structure as other tags, but are used to provide information 239 not contained in the referenced corpus, primary, and patch tags. 240 All four tag types come into play at various points in the 241 software lifecycle and support software management processes that 242 depend on the ability to accurately determine where each software 243 component is in its lifecycle. 245 +------------+ 246 v | 247 Software Software Software Software Software 248 Deployment -> Installation -> Patching -> Upgrading -> Removal 250 Corpus Primary Primary xPrimary xPrimary 251 Supplemental Supplemental Supplemental xSupplemental xSupplemental 252 Patch xPatch 253 Primary 254 Supplemental 256 Figure 1: Use of Tag Types in the Software Lifecycle 258 Figure 1 illustrates the steps in the software lifecycle and the 259 relationships among those lifecycle events supported by the four 260 types of SWID and CoSWID tags. A detailed description of the four 261 tags types is provided in Section 2.3. The figure identifies the 262 types of tags that are used in each lifecycle event. 264 There are many ways in which software tags might be managed for the 265 host the software is installed on. For example, software tags could 266 be made available on the host or to an external software manager when 267 storage is limited on the host. 269 In these cases the host or external software manager is responsible 270 for management of the tags, including deployment and removal of the 271 tags as indicated by the above lifecycle. Tags are deployed and 272 previously deployed tags that are typically removed (indicated by an 273 "x" prefix) at each lifecycle stage, as follows: 275 - Software Deployment. Before the software component is 276 installed (i.e., pre-installation), and while the product is 277 being deployed, a corpus tag provides information about the 278 installation files and distribution media (e.g., CD/DVD, 279 distribution package). 281 Corpus tags are not actually deployed on the target system but are 282 intended to support deployment procedures and their dependencies at 283 install-time, such as to verify the installation media. 285 - Software Installation. A primary tag will be installed with 286 the software component (or subsequently created) to uniquely 287 identify and describe the software component. Supplemental 288 tags are created to augment primary tags with additional site- 289 specific or extended information. While not illustrated in the 290 figure, patch tags can also be installed during software 291 installation to provide information about software fixes 292 deployed along with the base software installation. 294 - Software Patching. A new patch tag is provided, when a patch 295 is applied to the software component, supplying details about 296 the patch and its dependencies. While not illustrated in the 297 figure, a corpus tag can also provide information about the 298 patch installer and patching dependencies that need to be 299 installed before the patch. 301 - Software Upgrading. As a software component is upgraded to a 302 new version, new primary and supplemental tags replace existing 303 tags, enabling timely and accurate tracking of updates to 304 software inventory. While not illustrated in the figure, a 305 corpus tag can also provide information about the upgrade 306 installer and dependencies that need to be installed before the 307 upgrade. 309 Note: In the context of software tagging software patching and 310 updating differ in an important way. When installing a patch, a set 311 of file modifications are made to pre-installed software which do not 312 alter the version number or the descriptive metadata of an installed 313 software component. An update can also make a set of file 314 modifications, but the version number or the descriptive metadata of 315 an installed software component are changed. 317 - Software Removal. Upon removal of the software component, 318 relevant SWID tags are removed. This removal event can trigger 319 timely updates to software inventory reflecting the removal of 320 the product and any associated patch or supplemental tags. 322 As illustrated in the figure, supplemental tags can be associated 323 with any corpus, primary, or patch tag to provide additional metadata 324 about an installer, installed software, or installed patch 325 respectively. 327 Understanding the use of CoSWIDs in the software lifecycle provides a 328 basis for understanding the information provided in a CoSWID and the 329 associated semantics of this information. Each of the different SWID 330 and CoSWID tag types provide different sets of information. For 331 example, a "corpus tag" is used to describe a software component's 332 installation image on an installation media, while a "patch tag" is 333 meant to describe a patch that modifies some other software 334 component. 336 1.2. Concise SWID Format 338 This document defines the CoSWID tag format, which is based on CBOR. 339 CBOR-based CoSWID tags offer a more concise representation of SWID 340 information as compared to the XML-based SWID tag representation in 341 ISO-19770-2:2015. The structure of a CoSWID is described via the 342 Concise Data Definition Language (CDDL) [RFC8610]. The resulting 343 CoSWID data definition is aligned to the information able to be 344 expressed with the XML schema definition of ISO-19770-2:2015 [SWID]. 345 This alignment allows both SWID and CoSWID tags to represent a common 346 set of software component information and allows CoSWID tags to 347 support the same uses as a SWID tag. 349 The vocabulary, i.e., the CDDL names of the types and members used in 350 the CoSWID CDDL specification, are mapped to more concise labels 351 represented as small integer values (indices). The names used in the 352 CDDL specification and the mapping to the CBOR representation using 353 integer indices is based on the vocabulary of the XML attribute and 354 element names defined in ISO/IEC 19770-2:2015. 356 1.3. Requirements Notation 358 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 359 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 360 "OPTIONAL" in this document are to be interpreted as described in 361 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 362 capitals, as shown here. 364 2. Concise SWID Data Definition 366 The following describes the general rules and processes for encoding 367 data using CDDL representation. Prior familiarity with CBOR and CDDL 368 concepts will be helpful in understanding this CoSWID specification. 370 This section describes the conventions by which a CoSWID is 371 represented in the CDDL structure. The CamelCase [CamelCase] 372 notation used in the XML schema definition is changed to a hyphen- 373 separated notation [KebabCase] (e.g. ResourceCollection is named 374 resource-collection) in the CoSWID CDDL specification. This 375 deviation from the original notation used in the XML representation 376 reduces ambiguity when referencing certain attributes in 377 corresponding textual descriptions. An attribute referred to by its 378 name in CamelCase notation explicitly relates to XML SWID tags; an 379 attribute referred to by its name in KebabCase notation explicitly 380 relates to CBOR CoSWID tags. This approach simplifies the 381 composition of further work that reference both XML SWID and CBOR 382 CoSWID documents. 384 In most cases, mapping attribute names between SWID and CoSWID can be 385 done automatically by converting between CamelCase and KebabCase 386 attribute names. However, some CoSWID CDDL attribute names show 387 greater variation relative to their corresponding SWID XML Schema 388 attributes. This is done when the change improves clarity in the 389 CoSWID specification. For example the "name" and "version" SWID 390 fields corresponds to the "software-name" and "software-version" 391 CoSWID fields, respectively. As such, it is not always possible to 392 mechanically translate between corresponding attribute names in the 393 two formats. In such cases, a manual mapping will need to be used. 394 These cases are specifically noted in this and subsequent sections 395 using an [W3C.REC-xpath20-20101214] where a manual mapping is needed. 397 The 57 human-readable text labels of the CDDL-based CoSWID vocabulary 398 are mapped to integer indices via a block of rules at the bottom of 399 the definition. This allows a more concise integer-based form to be 400 stored or transported, as compared to the less efficient text-based 401 form of the original vocabulary. 403 The root of the CDDL specification provided by this document is the 404 rule "coswid" (as defined in Section 8): 406 start = coswid 408 In CBOR, an array is encoded using bytes that identify the array, and 409 the array's length or stop point (see [RFC7049]). To make items that 410 support 1 or more values, the following CDDL notation is used. 412 _name_ = (_label_ => _data_ / [ 2* _data_ ]) 414 The CDDL rule above allows either a single data item or an array of 2 415 or more data values to be provided. When a singleton data value is 416 provided, the CBOR markers for the array, array length, and stop 417 point are not needed, saving bytes. When two or more data values are 418 provided, these values are encoded as an array. This modeling 419 pattern is used frequently in the CoSWID CDDL specification to allow 420 for more efficient encoding of singleton values. 422 Usage of this construct can be simplified using 423 one-or-more = T / [ 2* T ] 425 simplifying the above example to 427 _name_ = (_label_ => one-or-more<_data_>) 429 The following subsections describe the different parts of the CoSWID 430 model. 432 2.1. Character Encoding 434 The CDDL "text" type is represented in CBOR as a major type 3, which 435 represents "a string of Unicode characters that [are] encoded as 436 UTF-8 [RFC3629]" (see [RFC7049] Section 2.1). Thus both SWID and 437 CoSWID use UTF-8 for the encoding of characters in text strings. 439 To ensure that UTF-8 character strings are able to be encoded/decoded 440 and exchanged interoperably, text strings in CoSWID MUST be encoded 441 consistent with the Net-Unicode definition defined in [RFC5198]. 443 All names registered with IANA according to requirements in 444 Section 6.2 also MUST be valid according to the XML Schema NMToken 445 data type (see [W3C.REC-xmlschema-2-20041028] Section 3.3.4) to 446 ensure compatibility with the SWID specification where these names 447 are used. 449 2.2. Concise SWID Extensions 451 The CoSWID specification contains two features that are not included 452 in the SWID specification on which it is based. These features are: 454 * The explicit definition of types for some attributes in the ISO- 455 19770-2:2015 XML representation that are typically represented by 456 the "any attribute" in the SWID model. These are covered in 457 Section 2.5. 459 * The inclusion of extension points in the CoSWID specification 460 using CDDL sockets (see [RFC8610] Section 3.9). The use of CDDL 461 sockets allow for well-formed extensions to be defined in 462 supplementary CDDL descriptions that support additional uses of 463 CoSWID tags that go beyond the original scope of ISO-19770-2:2015 464 tags. This extension mechanism can also be used to update the 465 CoSWID format as revisions to ISO-19770-2 are published. 467 The following CDDL sockets (extension points) are defined in this 468 document, which allow the addition of new information structures to 469 their respective CDDL groups. 471 +=====================+===========================+===============+ 472 | Map Name | CDDL Socket | Defined in | 473 +=====================+===========================+===============+ 474 | concise-swid-tag | $$coswid-extension | Section 2.3 | 475 +---------------------+---------------------------+---------------+ 476 | entity-entry | $$entity-extension | Section 2.6 | 477 +---------------------+---------------------------+---------------+ 478 | link-entry | $$link-extension | Section 2.7 | 479 +---------------------+---------------------------+---------------+ 480 | software-meta-entry | $$software-meta-extension | Section 2.8 | 481 +---------------------+---------------------------+---------------+ 482 | file-entry | $$file-extension | Section 2.9.2 | 483 +---------------------+---------------------------+---------------+ 484 | directory-entry | $$directory-extension | Section 2.9.2 | 485 +---------------------+---------------------------+---------------+ 486 | process-entry | $$process-extension | Section 2.9.2 | 487 +---------------------+---------------------------+---------------+ 488 | resource-entry | $$resource-extension | Section 2.9.2 | 489 +---------------------+---------------------------+---------------+ 490 | payload-entry | $$payload-extension | Section 2.9.3 | 491 +---------------------+---------------------------+---------------+ 492 | evidence-entry | $$evidence-extension | Section 2.9.4 | 493 +---------------------+---------------------------+---------------+ 495 Table 1: CoSWID CDDL Group Extension Points 497 The CoSWID Items Registry defined in Section 6.1 provides a 498 registration mechanism allowing new items, and their associated index 499 values, to be added to the CoSWID model through the use of the CDDL 500 sockets described in the table above. This registration mechanism 501 provides for well-known index values for data items in CoSWID 502 extensions, allowing these index values to be recognized by 503 implementations supporting a given extension. 505 The following additional CDDL sockets are defined in this document to 506 allow for adding new values to corresponding type-choices (i.e. to 507 represent enumerations) via custom CDDL specifications. 509 +==================+=================+=============+ 510 | Enumeration Name | CDDL Socket | Defined in | 511 +==================+=================+=============+ 512 | version-scheme | $version-scheme | Section 4.1 | 513 +------------------+-----------------+-------------+ 514 | role | $role | Section 4.2 | 515 +------------------+-----------------+-------------+ 516 | ownership | $ownership | Section 4.3 | 517 +------------------+-----------------+-------------+ 518 | rel | $rel | Section 4.4 | 519 +------------------+-----------------+-------------+ 520 | use | $use | Section 4.5 | 521 +------------------+-----------------+-------------+ 523 Table 2: CoSWID CDDL Enumeration Extension Points 525 A number of CoSWID value registries are also defined in Section 6.2 526 that allow new values to be registered with IANA for the enumerations 527 above. This registration mechanism supports the definition of new 528 well-known index values and names for new enumeration values used by 529 CoSWID, which can also be used by other software tagging 530 specifications. This registration mechanism allows new standardized 531 enumerated values to be shared between multiple tagging 532 specifications (and associated implementations) over time. 534 2.3. The concise-swid-tag Map 536 The CDDL specification for the root concise-swid-tag map is as 537 follows and this rule and its constraints MUST be followed when 538 creating or validating a CoSWID tag: 540 concise-swid-tag = { 541 tag-id => text / bstr .size 16, 542 tag-version => integer, 543 ? corpus => bool, 544 ? patch => bool, 545 ? supplemental => bool, 546 software-name => text, 547 ? software-version => text, 548 ? version-scheme => $version-scheme, 549 ? media => text, 550 ? software-meta => one-or-more, 551 entity => one-or-more, 552 ? link => one-or-more, 553 ? payload-or-evidence, 554 * $$coswid-extension, 555 global-attributes, 556 } 558 payload-or-evidence //= ( payload => payload-entry ) 559 payload-or-evidence //= ( evidence => evidence-entry ) 561 tag-id = 0 562 software-name = 1 563 entity = 2 564 evidence = 3 565 link = 4 566 software-meta = 5 567 payload = 6 568 corpus = 8 569 patch = 9 570 media = 10 571 supplemental = 11 572 tag-version = 12 573 software-version = 13 574 version-scheme = 14 576 $version-scheme /= multipartnumeric 577 $version-scheme /= multipartnumeric-suffix 578 $version-scheme /= alphanumeric 579 $version-scheme /= decimal 580 $version-scheme /= semver 581 $version-scheme /= int / text 582 multipartnumeric = 1 583 multipartnumeric-suffix = 2 584 alphanumeric = 3 585 decimal = 4 586 semver = 16384 587 The following describes each member of the concise-swid-tag root map. 589 * global-attributes: A list of items including an optional language 590 definition to support the processing of text-string values and an 591 unbounded set of any-attribute items. Described in Section 2.5. 593 * tag-id (index 0): A 16 byte binary string or textual identifier 594 uniquely referencing a software component. The tag identifier 595 MUST be globally unique. If represented as a 16 byte binary 596 string, the identifier MUST be a valid universally unique 597 identifier as defined by [RFC4122]. There are no strict 598 guidelines on how this identifier is structured, but examples 599 include a 16 byte GUID (e.g. class 4 UUID) [RFC4122], or a text 600 string appended to a DNS domain name to ensure uniqueness across 601 organizations. 603 * tag-version (index 12): An integer value that indicate the 604 specific release revision of the tag. Typically, the initial 605 value of this field is set to 0 and the value is monotonically 606 increased for subsequent tags produced for the same software 607 component release. This value allows a CoSWID tag producer to 608 correct an incorrect tag previously released without indicating a 609 change to the underlying software component the tag represents. 610 For example, the tag version could be changed to add new metadata, 611 to correct a broken link, to add a missing payload entry, etc. 612 When producing a revised tag, the new tag-version value MUST be 613 greater than the old tag-version value. 615 * corpus (index 8): A boolean value that indicates if the tag 616 identifies and describes an installable software component in its 617 pre-installation state. Installable software includes a 618 installation package or installer for a software component, a 619 software update, or a patch. If the CoSWID tag represents 620 installable software, the corpus item MUST be set to "true". If 621 not provided, the default value MUST be considered "false". 623 * patch (index 9): A boolean value that indicates if the tag 624 identifies and describes an installed patch that has made 625 incremental changes to a software component installed on an 626 endpoint. If a CoSWID tag is for a patch, the patch item MUST be 627 set to "true". If not provided, the default value MUST be 628 considered "false". A patch item's value MUST NOT be set to 629 "true" if the installation of the associated software package 630 changes the version of a software component. 632 * supplemental (index 11): A boolean value that indicates if the tag 633 is providing additional information to be associated with another 634 referenced SWID or CoSWID tag. This allows tools and users to 635 record their own metadata about a software component without 636 modifying SWID primary or patch tags created by a software 637 provider. If a CoSWID tag is a supplemental tag, the supplemental 638 item MUST be set to "true". If not provided, the default value 639 MUST be considered "false". 641 * software-name (index 1): This textual item provides the software 642 component's name. This name is likely the same name that would 643 appear in a package management tool. This item maps to 644 '/SoftwareIdentity/@name' in [SWID]. 646 * software-version (index 13): A textual value representing the 647 specific release or development version of the software component. 648 This item maps to '/SoftwareIdentity/@version' in [SWID]. 650 * version-scheme (index 14): An integer or textual value 651 representing the versioning scheme used for the software-version 652 item. If an integer value is used it MUST be an index value in 653 the range -256 to 65535. Integer values in the range -256 to -1 654 are reserved for testing and use in closed environments (see 655 Section 6.2.2). Integer values in the range 0 to 65535 correspond 656 to registered entries in the IANA "Software Tag Version Scheme 657 Values" registry (see Section 6.2.4. If a string value is used it 658 MUST be a private use name as defined in Section 6.2.2. String 659 values based on a Version Scheme Name from the IANA "Software Tag 660 Version Scheme Values" registry MUST NOT be used, as these values 661 are less concise than their index value equivalent. 663 * media (index 10): This text value is a hint to the tag consumer to 664 understand what target platform this tag applies to. This item 665 item MUST be formatted as a query as defined by the W3C Media 666 Queries Recommendation (see [W3C.REC-css3-mediaqueries-20120619]). 667 Support for media queries are included here for interoperability 668 with [SWID], which does not provide any further requirements for 669 media query use. Thus, this specification does not clarify how a 670 media query is to be used for a CoSWID. 672 * software-meta (index 5): An open-ended map of key/value data 673 pairs. A number of predefined keys can be used within this item 674 providing for common usage and semantics across the industry. Use 675 of this map allows any additional attribute to be included in the 676 tag. It is expected that industry groups will use a common set of 677 attribute names to allow for interoperability within their 678 communities. Described in Section 2.8. This item maps to 679 '/SoftwareIdentity/Meta' in [SWID]. 681 * entity (index 2): Provides information about one or more 682 organizations responsible for producing the CoSWID tag, and 683 producing or releasing the software component referenced by this 684 CoSWID tag. Described in Section 2.6. 686 * link (index 4): Provides a means to establish relationship arcs 687 between the tag and another items. A given link can be used to 688 establish the relationship between tags or to reference another 689 resource that is related to the CoSWID tag, e.g. vulnerability 690 database association, ROLIE feed [RFC8322], MUD resource 691 [RFC8520], software download location, etc). This is modeled 692 after the HTML "link" element. Described in Section 2.7. 694 * payload (index 6): This item represents a collection of software 695 artifacts (described by child items) that compose the target 696 software. For example, these artifacts could be the files 697 included with an installer for a corpus tag or installed on an 698 endpoint when the software component is installed for a primary or 699 patch tag. The artifacts listed in a payload may be a superset of 700 the software artifacts that are actually installed. Based on user 701 selections at install time, an installation might not include 702 every artifact that could be created or executed on the endpoint 703 when the software component is installed or run. Described in 704 Section 2.9.3. 706 * evidence (index 3): This item can be used to record the results of 707 a software discovery process used to identify untagged software on 708 an endpoint or to represent indicators for why software is 709 believed to be installed on the endpoint. In either case, a 710 CoSWID tag can be created by the tool performing an analysis of 711 the software components installed on the endpoint. Described in 712 Section 2.9.4. 714 * $$coswid-extension: This CDDL socket is used to add new 715 information structures to the concise-swid-tag root map. See 716 Section 2.2. 718 2.4. concise-swid-tag Co-Constraints 720 The following co-constraints apply to the information provided in the 721 concise-swid-tag group. 723 * The patch and supplemental items MUST NOT both be set to "true". 725 * If the patch item is set to "true", the tag SHOULD contain at 726 least one link item (see Section 2.7) with both the rel item value 727 of "patches" and an href item specifying an association with the 728 software that was patched. 730 * If the supplemental item is set to "true", the tag SHOULD contain 731 at least one link item with both the rel item value of 732 "supplemental" and an href item specifying an association with the 733 software that is supplemented. 735 * If all of the corpus, patch, and supplemental items are "false", 736 or if the corpus item is set to "true", then a software-version 737 item MUST be included with a value set to the version of the 738 software component. This ensures that primary and corpus tags 739 have an identifiable software version. 741 2.5. The global-attributes Group 743 The global-attributes group provides a list of items, including an 744 optional language definition to support the processing of text-string 745 values, and an unbounded set of any-attribute items allowing for 746 additional items to be provided as a general point of extension in 747 the model. 749 The CDDL for the global-attributes follows: 751 global-attributes = ( 752 ? lang => text, 753 * any-attribute, 754 ) 756 any-attribute = ( 757 label => one-or-more / one-or-more 758 ) 760 label = text / int 762 The following describes each child item of this group. 764 * lang (index 15): A textual language tag that conforms with IANA 765 "Language Subtag Registry" [RFC5646]. The context of the 766 specified language applies to all sibling and descendant textual 767 values, unless a descendant object has defined a different 768 language tag. Thus, a new context is established when a 769 descendant object redefines a new language tag. All textual 770 values within a given context MUST be considered expressed in the 771 specified language. 773 * any-attribute: This sub-group provides a means to include 774 arbitrary information via label/index ("key") value pairs. Labels 775 can be either a single integer or text string. Values can be a 776 single integer, a text string, or an array of integers or text 777 strings. 779 2.6. The entity-entry Map 781 The CDDL for the entity-entry map follows: 783 entity-entry = { 784 entity-name => text, 785 ? reg-id => any-uri, 786 role => one-or-more<$role>, 787 ? thumbprint => hash-entry, 788 * $$entity-extension, 789 global-attributes, 790 } 792 entity-name = 31 793 reg-id = 32 794 role = 33 795 thumbprint = 34 797 $role /= tag-creator 798 $role /= software-creator 799 $role /= aggregator 800 $role /= distributor 801 $role /= licensor 802 $role /= maintainer 803 $role /= int / text 804 tag-creator=1 805 software-creator=2 806 aggregator=3 807 distributor=4 808 licensor=5 809 maintainer=6 811 The following describes each child item of this group. 813 * global-attributes: The global-attributes group described in 814 Section 2.5. 816 * entity-name (index 31): The textual name of the organizational 817 entity claiming the roles specified by the role item for the 818 CoSWID tag. This item maps to '/SoftwareIdentity/Entity/@name' in 819 [SWID]. 821 * reg-id (index 32): The registration id value is intended to 822 uniquely identify a naming authority in a given scope (e.g. 823 global, organization, vendor, customer, administrative domain, 824 etc.) for the referenced entity. The value of a registration ID 825 MUST be a RFC 3986 URI. The scope SHOULD be the scope of an 826 organization. 828 * role (index 33): An integer or textual value representing the 829 relationship(s) between the entity, and this tag or the referenced 830 software component. If an integer value is used it MUST be an 831 index value in the range -256 to 255. Integer values in the range 832 -256 to -1 are reserved for testing and use in closed environments 833 (see Section 6.2.2). Integer values in the range 0 to 255 834 correspond to registered entries in the IANA "Software Tag Entity 835 Role Values" registry (see Section 6.2.5. If a string value is 836 used it MUST be a private use name as defined in Section 6.2.2. 837 String values based on a Role Name from the IANA "Software Tag 838 Entity Role Values" registry MUST NOT be used, as these values are 839 less concise than their index value equivalent. 841 The following additional requirements exist for the use of the 842 "role" item: 844 - An entity item MUST be provided with the role of "tag-creator" 845 for every CoSWID tag. This indicates the organization that 846 created the CoSWID tag. 848 - An entity item SHOULD be provided with the role of "software- 849 creator" for every CoSWID tag, if this information is known to 850 the tag creator. This indicates the organization that created 851 the referenced software component. 853 * thumbprint (index 34): The value of the thumbprint item provides a 854 hash (i.e. the thumbprint) of the signing entity's public key 855 certificate. This provides an indicator of which entity signed 856 the CoSWID tag, which will typically be the tag creator. See 857 Section 2.9.1 for more details on the use of the hash-entry data 858 structure. 860 * $$entity-extension: This CDDL socket can be used to extend the 861 entity-entry group model. See Section 2.2. 863 2.7. The link-entry Map 865 The CDDL for the link-entry map follows: 867 link-entry = { 868 ? artifact => text, 869 href => any-uri, 870 ? media => text, 871 ? ownership => $ownership, 872 rel => $rel, 873 ? media-type => text, 874 ? use => $use, 875 * $$link-extension, 876 global-attributes, 877 } 879 media = 10 880 artifact = 37 881 href = 38 882 ownership = 39 883 rel = 40 884 media-type = 41 885 use = 42 887 $ownership /= shared 888 $ownership /= private 889 $ownership /= abandon 890 $ownership /= int / text 891 shared=1 892 private=2 893 abandon=3 895 $rel /= ancestor 896 $rel /= component 897 $rel /= feature 898 $rel /= installationmedia 899 $rel /= packageinstaller 900 $rel /= parent 901 $rel /= patches 902 $rel /= requires 903 $rel /= see-also 904 $rel /= supersedes 905 $rel /= supplemental 906 $rel /= -356..65536 / text 907 ancestor=1 908 component=2 909 feature=3 910 installationmedia=4 911 packageinstaller=5 912 parent=6 913 patches=7 914 requires=8 915 see-also=9 916 supersedes=10 917 supplemental=11 919 $use /= optional 920 $use /= required 921 $use /= recommended 922 $use /= int / text 923 optional=1 924 required=2 925 recommended=3 927 The following describes each member of this map. 929 * global-attributes: The global-attributes group described in 930 Section 2.5. 932 * artifact (index: 37): To be used with rel="installation-media", 933 this item's value provides the path to the installer executable or 934 script that can be run to launch the referenced installation. 935 Links with the same artifact name MUST be considered mirrors of 936 each other, allowing the installation media to be acquired from 937 any of the described sources. 939 * href (index 38): A URI-reference [RFC3986] for the referenced 940 resource. The "href" item's value can be, but is not limited to, 941 the following (which is a slightly modified excerpt from [SWID]): 943 - If no URI scheme is provided, then the URI-reference is a 944 relative reference relative to the URI of the CoSWID tag. For 945 example, "./folder/supplemental.coswid". 947 - a physical resource location with any acceptable URI scheme 948 (e.g., file:// http:// https:// ftp://) 950 - a URI with "swid:" as the scheme refers to another SWID or 951 CoSWID by the referenced tag's tag-id. This URI needs to be 952 resolved in the context of the endpoint by software that can 953 lookup other SWID or CoSWID tags. For example, "swid:2df9de35- 954 0aff-4a86-ace6-f7dddd1ade4c" references the tag with the tag-id 955 value "2df9de35-0aff-4a86-ace6-f7dddd1ade4c". 957 - a URI with "swidpath:" as the scheme, which refers to another 958 software tag via an XPATH query [W3C.REC-xpath20-20101214]. 959 This scheme is provided for compatibility with [SWID]. This 960 specification does not define how to resolve an XPATH query in 961 the context of CBOR. 963 * media (index 10): A hint to the consumer of the link to what 964 target platform the link is applicable to. This item represents a 965 query as defined by the W3C Media Queries Recommendation (see 966 [W3C.REC-css3-mediaqueries-20120619]). See also media defined in 967 Section 2.3. 969 * ownership (index 39): An integer or textual value used when the 970 "href" item references another software component to indicate the 971 degree of ownership between the software component referenced by 972 the COSWID tag and the software component referenced by the link. 973 If an integer value is used it MUST be an index value in the range 974 -256 to 255. Integer values in the range -256 to -1 are reserved 975 for testing and use in closed environments (see Section 6.2.2). 976 Integer values in the range 0 to 255 correspond to registered 977 entries in the IANA "Software Tag Link Ownership Values" registry 978 (see Section 6.2.6. If a string value is used it MUST be a 979 private use name as defined in Section 6.2.2. String values based 980 on a Ownership Type Name from the IANA "Software Tag Link 981 Ownership Values" registry MUST NOT be used, as these values are 982 less concise than their index value equivalent. 984 * rel (index 40): An integer or textual value that identifies the 985 relationship between this CoSWID and the target resource 986 identified by the "href" item. If an integer value is used it 987 MUST be an index value in the range -256 to 65535. Integer values 988 in the range -256 to -1 are reserved for testing and use in closed 989 environments (see Section 6.2.2). Integer values in the range 0 990 to 65535 correspond to registered entries in the IANA "Software 991 Tag Link Relationship Values" registry (see Section 6.2.7. If a 992 string value is used it MUST be either a private use name as 993 defined in Section 6.2.2 or a "Relation Name" from the IANA "Link 994 Relation Types" registry: https://www.iana.org/assignments/link- 995 relations/link-relations.xhtml as defined by [RFC8288]. When a 996 string value defined in the IANA "Software Tag Link Relationship 997 Values" registry matches a Relation Name defined in the IANA "Link 998 Relation Types" registry, the index value in the IANA "Software 999 Tag Link Relationship Values" registry MUST be used instead, as 1000 this relationship has a specialized meaning in the context of a 1001 CoSWID tag. String values based on a Relationship Type Name from 1002 the IANA "Software Tag Link Relationship Values" registry MUST NOT 1003 be used, as these values are less concise than their index value 1004 equivalent. 1006 * media-type (index 41): A link can point to arbitrary resources on 1007 the endpoint, local network, or Internet using the href item. Use 1008 of this item supplies the resource consumer with a hint of what 1009 type of resource to expect. Media types are identified by 1010 referencing a "Name" from the IANA "Media Types" registry: 1011 http://www.iana.org/assignments/media-types/media-types.xhtml. 1012 This item maps to '/SoftwareIdentity/Link/@type' in [SWID]. 1014 * use (index 42): An integer or textual value used to determine if 1015 the referenced software component has to be installed before 1016 installing the software component identified by the COSWID tag. 1017 If an integer value is used it MUST be an index value in the range 1018 -256 to 255. Integer values in the range -256 to -1 are reserved 1019 for testing and use in closed environments (see Section 6.2.2). 1021 Integer values in the range 0 to 255 correspond to registered 1022 entries in the IANA "Link Use Values" registry (see Section 6.2.8. 1023 If a string value is used it MUST be a private use name as defined 1024 in Section 6.2.2. String values based on an Link Use Type Name 1025 from the IANA "Software Tag Link Use Values" registry MUST NOT be 1026 used, as these values are less concise than their index value 1027 equivalent. 1029 * $$link-extension: This CDDL socket can be used to extend the link- 1030 entry map model. See Section 2.2. 1032 2.8. The software-meta-entry Map 1034 The CDDL for the software-meta-entry map follows: 1036 software-meta-entry = { 1037 ? activation-status => text, 1038 ? channel-type => text, 1039 ? colloquial-version => text, 1040 ? description => text, 1041 ? edition => text, 1042 ? entitlement-data-required => bool, 1043 ? entitlement-key => text, 1044 ? generator => text, 1045 ? persistent-id => text, 1046 ? product => text, 1047 ? product-family => text, 1048 ? revision => text, 1049 ? summary => text, 1050 ? unspsc-code => text, 1051 ? unspsc-version => text, 1052 * $$software-meta-extension, 1053 global-attributes, 1054 } 1056 activation-status = 43 1057 channel-type = 44 1058 colloquial-version = 45 1059 description = 46 1060 edition = 47 1061 entitlement-data-required = 48 1062 entitlement-key = 49 1063 generator = 50 1064 persistent-id = 51 1065 product = 52 1066 product-family = 53 1067 revision = 54 1068 summary = 55 1069 unspsc-code = 56 1070 unspsc-version = 57 1072 The following describes each child item of this group. 1074 * global-attributes: The global-attributes group described in 1075 Section 2.5. 1077 * activation-status (index 43): A textual value that identifies how 1078 the software component has been activated, which might relate to 1079 specific terms and conditions for its use (e.g. Trial, 1080 Serialized, Licensed, Unlicensed, etc) and relate to an 1081 entitlement. This attribute is typically used in supplemental 1082 tags as it contains information that might be selected during a 1083 specific install. 1085 * channel-type (index 44): A textual value that identifies which 1086 sales, licensing, or marketing channel the software component has 1087 been targeted for (e.g. Volume, Retail, OEM, Academic, etc). 1088 This attribute is typically used in supplemental tags as it 1089 contains information that might be selected during a specific 1090 install. 1092 * colloquial-version (index 45): A textual value for the software 1093 component's informal or colloquial version. Examples may include 1094 a year value, a major version number, or similar value that are 1095 used to identify a group of specific software component releases 1096 that are part of the same release/support cycle. This version can 1097 be the same through multiple releases of a software component, 1098 while the software-version specified in the concise-swid-tag group 1099 is much more specific and will change for each software component 1100 release. This version is intended to be used for string 1101 comparison only and is not intended to be used to determine if a 1102 specific value is earlier or later in a sequence. 1104 * description (index 46): A textual value that provides a detailed 1105 description of the software component. This value MAY be multiple 1106 paragraphs separated by CR LF characters as described by 1107 [RFC5198]. 1109 * edition (index 47): A textual value indicating that the software 1110 component represents a functional variation of the code base used 1111 to support multiple software components. For example, this item 1112 can be used to differentiate enterprise, standard, or professional 1113 variants of a software component. 1115 * entitlement-data-required (index 48): A boolean value that can be 1116 used to determine if accompanying proof of entitlement is needed 1117 when a software license reconciliation process is performed. 1119 * entitlement-key (index 49): A vendor-specific textual key that can 1120 be used to identify and establish a relationship to an 1121 entitlement. Examples of an entitlement-key might include a 1122 serial number, product key, or license key. For values that 1123 relate to a given software component install (i.e., license key), 1124 a supplemental tag will typically contain this information. In 1125 other cases, where a general-purpose key can be provided that 1126 applies to all possible installs of the software component on 1127 different endpoints, a primary tag will typically contain this 1128 information. 1130 * generator (index 50): The name (or tag-id) of the software 1131 component that created the CoSWID tag. If the generating software 1132 component has a SWID or CoSWID tag, then the tag-id for the 1133 generating software component SHOULD be provided. 1135 * persistent-id (index 51): A globally unique identifier used to 1136 identify a set of software components that are related. Software 1137 components sharing the same persistent-id can be different 1138 versions. This item can be used to relate software components, 1139 released at different points in time or through different release 1140 channels, that may not be able to be related through use of the 1141 link item. 1143 * product (index 52): A basic name for the software component that 1144 can be common across multiple tagged software components (e.g., 1145 Apache HTTPD). 1147 * product-family (index 53): A textual value indicating the software 1148 components overall product family. This should be used when 1149 multiple related software components form a larger capability that 1150 is installed on multiple different endpoints. For example, some 1151 software families may consist of server, client, and shared 1152 service components that are part of a larger capability. Email 1153 systems, enterprise applications, backup services, web 1154 conferencing, and similar capabilities are examples of families. 1155 Use of this item is not intended to represent groups of software 1156 that are bundled or installed together. The persistent-id or link 1157 items SHOULD be used to relate bundled software components. 1159 * revision (index 54): A string value indicating an informal or 1160 colloquial release version of the software. This value can 1161 provide a different version value as compared to the software- 1162 version specified in the concise-swid-tag group. This is useful 1163 when one or more releases need to have an informal version label 1164 that differs from the specific exact version value specified by 1165 software-version. Examples can include SP1, RC1, Beta, etc. 1167 * summary (index 55): A short description of the software component. 1168 This MUST be a single sentence suitable for display in a user 1169 interface. 1171 * unspsc-code (index 56): An 8 digit UNSPSC classification code for 1172 the software component as defined by the United Nations Standard 1173 Products and Services Code (UNSPSC, [UNSPSC]). 1175 * unspsc-version (index 57): The version of UNSPSC used to define 1176 the unspsc-code value. 1178 * $$meta-extension: This CDDL socket can be used to extend the 1179 software-meta-entry group model. See Section 2.2. 1181 2.9. The Resource Collection Definition 1183 2.9.1. The hash-entry Array 1185 CoSWID adds explicit support for the representation of hash entries 1186 using algorithms that are registered in the IANA "Named Information 1187 Hash Algorithm Registry" [NIHAR] using the hash member (index 7) and 1188 the corresponding hash-entry type. This is the equivalent of the 1189 namespace qualified "hash" attribute in [SWID]. 1191 hash-entry = [ 1192 hash-alg-id: int, 1193 hash-value: bytes, 1194 ] 1196 The number used as a value for hash-alg-id is an integer-based hash 1197 algorithm identifier who's value MUST refer to an ID in the IANA 1198 "Named Information Hash Algorithm Registry" [NIHAR] with a Status of 1199 "current"; other hash algorithms MUST NOT be used. If the hash-alg- 1200 id is not known, then the integer value "0" MUST be used. This 1201 ensures parity between the SWID tag specification [SWID], which does 1202 not allow an algorithm to be identified for this field. 1204 The hash-value byte string value MUST represent the raw hash value of 1205 the hashed resource generated using the hash algorithm indicated by 1206 the hash-alg-id. 1208 2.9.2. The resource-collection Group 1210 A list of items both used in evidence (created by a software 1211 discovery process) and payload (installed in an endpoint) content of 1212 a CoSWID tag document to structure and differentiate the content of 1213 specific CoSWID tag types. Potential content includes directories, 1214 files, processes, or resources. 1216 The CDDL for the resource-collection group follows: 1218 path-elements-group = ( ? directory => one-or-more, 1219 ? file => one-or-more, 1220 ) 1222 resource-collection = ( 1223 path-elements-group, 1224 ? process => one-or-more, 1225 ? resource => one-or-more, 1226 * $$resource-collection-extension, 1227 ) 1229 filesystem-item = ( 1230 ? key => bool, 1231 ? location => text, 1232 fs-name => text, 1233 ? root => text, 1234 ) 1236 file-entry = { 1237 filesystem-item, 1238 ? size => uint, 1239 ? file-version => text, 1240 ? hash => hash-entry, 1241 * $$file-extension, 1242 global-attributes, 1243 } 1245 directory-entry = { 1246 filesystem-item, 1247 ? path-elements => { path-elements-group }, 1248 * $$directory-extension, 1249 global-attributes, 1250 } 1252 process-entry = { 1253 process-name => text, 1254 ? pid => integer, 1255 * $$process-extension, 1256 global-attributes, 1257 } 1259 resource-entry = { 1260 type => text, 1261 * $$resource-extension, 1262 global-attributes, 1263 } 1265 directory = 16 1266 file = 17 1267 process = 18 1268 resource = 19 1269 size = 20 1270 file-version = 21 1271 key = 22 1272 location = 23 1273 fs-name = 24 1274 root = 25 1275 path-elements = 26 1276 process-name = 27 1277 pid = 28 1278 type = 29 1280 The following describes each member of the groups and maps 1281 illustrated above. 1283 * filesystem-item: A list of common items used for representing the 1284 filesystem root, relative location, name, and significance of a 1285 file or directory item. 1287 * global-attributes: The global-attributes group described in 1288 Section 2.5. 1290 * directory (index 16): A directory item allows child directory and 1291 file items to be defined within a directory hierarchy for the 1292 software component. 1294 * file (index 17): A file item allows details about a file to be 1295 provided for the software component. 1297 * process (index 18): A process item allows details to be provided 1298 about the runtime behavior of the software component, such as 1299 information that will appear in a process listing on an endpoint. 1301 * resource (index 19): A resource item can be used to provide 1302 details about an artifact or capability expected to be found on an 1303 endpoint or evidence collected related to the software component. 1304 This can be used to represent concepts not addressed directly by 1305 the directory, file, or process items. Examples include: registry 1306 keys, bound ports, etc. The equivalent construct in [SWID] is 1307 currently under specified. As a result, this item might be 1308 further defined through extension in the future. 1310 * size (index 20): The file's size in bytes. 1312 * file-version (index 21): The file's version as reported by 1313 querying information on the file from the operating system. This 1314 item maps to '/SoftwareIdentity/(Payload|Evidence)/File/@version' 1315 in [SWID]. 1317 * hash (index 7): A hash of the file as described in Section 2.9.1. 1319 * key (index 22): A boolean value indicating if a file or directory 1320 is significant or required for the software component to execute 1321 or function properly. These are files or directories that can be 1322 used to affirmatively determine if the software component is 1323 installed on an endpoint. 1325 * location (index 23): The filesystem path where a file is expected 1326 to be located when installed or copied. The location MUST be 1327 either relative to the location of the parent directory item 1328 (preferred) or relative to the location of the CoSWID tag if no 1329 parent is defined. The location MUST NOT include a file's name, 1330 which is provided by the fs-name item. 1332 * fs-name (index 24): The name of the directory or file without any 1333 path information. This aligns with a file "name" in [SWID]. This 1334 item maps to 1335 '/SoftwareIdentity/(Payload|Evidence)/(File|Directory)/@name' in 1336 [SWID]. 1338 * root (index 25): A filesystem-specific name for the root of the 1339 filesystem. The location item is considered relative to this 1340 location if specified. If not provided, the value provided by the 1341 location item is expected to be relative to its parent or the 1342 location of the CoSWID tag if no parent is provided. 1344 * path-elements (index 26): This group allows a hierarchy of 1345 directory and file items to be defined in payload or evidence 1346 items. This is a construction within the CDDL definition of 1347 CoSWID to support shared syntax and does not appear in [SWID]. 1349 * process-name (index 27): The software component's process name as 1350 it will appear in an endpoint's process list. This aligns with a 1351 process "name" in [SWID]. This item maps to 1352 '/SoftwareIdentity/(Payload|Evidence)/Process/@name' in [SWID]. 1354 * pid (index 28): The process ID identified for a running instance 1355 of the software component in the endpoint's process list. This is 1356 used as part of the evidence item. 1358 * type (index 29): A string indicating the type of resource. 1360 * $$resource-collection-extension: This CDDL socket can be used to 1361 extend the resource-collection group model. This can be used to 1362 add new specialized types of resources. See Section 2.2. 1364 * $$file-extension: This CDDL socket can be used to extend the file- 1365 entry group model. See Section 2.2. 1367 * $$directory-extension: This CDDL socket can be used to extend the 1368 directory-entry group model. See Section 2.2. 1370 * $$process-extension: This CDDL socket can be used to extend the 1371 process-entry group model. See Section 2.2. 1373 * $$resource-extension: This CDDL socket can be used to extend the 1374 resource-entry group model. See Section 2.2. 1376 2.9.3. The payload-entry Map 1378 The CDDL for the payload-entry map follows: 1380 payload-entry = { 1381 resource-collection, 1382 * $$payload-extension, 1383 global-attributes, 1384 } 1386 The following describes each child item of this group. 1388 * global-attributes: The global-attributes group described in 1389 Section 2.5. 1391 * resource-collection: The resource-collection group described in 1392 Section 2.9.2. 1394 * $$payload-extension: This CDDL socket can be used to extend the 1395 payload-entry group model. See Section 2.2. 1397 2.9.4. The evidence-entry Map 1399 The CDDL for the evidence-entry map follows: 1401 evidence-entry = { 1402 resource-collection, 1403 ? date => integer-time, 1404 ? device-id => text, 1405 * $$evidence-extension, 1406 global-attributes, 1407 } 1409 date = 35 1410 device-id = 36 1412 The following describes each child item of this group. 1414 * global-attributes: The global-attributes group described in 1415 Section 2.5. 1417 * resource-collection: The resource-collection group described in 1418 Section 2.9.2. 1420 * date (index 35): The date and time the information was collected 1421 pertaining to the evidence item. 1423 * device-id (index 36): The endpoint's string identifier from which 1424 the evidence was collected. 1426 * $$evidence-extension: This CDDL socket can be used to extend the 1427 evidence-entry group model. See Section 2.2. 1429 2.10. Full CDDL Specification 1431 In order to create a valid CoSWID document the structure of the 1432 corresponding CBOR message MUST adhere to the following CDDL 1433 specification. 1435 concise-swid-tag = { 1436 tag-id => text / bstr .size 16, 1437 tag-version => integer, 1438 ? corpus => bool, 1439 ? patch => bool, 1440 ? supplemental => bool, 1441 software-name => text, 1442 ? software-version => text, 1443 ? version-scheme => $version-scheme, 1444 ? media => text, 1445 ? software-meta => one-or-more, 1446 entity => one-or-more, 1447 ? link => one-or-more, 1448 ? payload-or-evidence, 1449 * $$coswid-extension, 1450 global-attributes, 1451 } 1453 payload-or-evidence //= ( payload => payload-entry ) 1454 payload-or-evidence //= ( evidence => evidence-entry ) 1456 any-uri = uri 1457 label = text / int 1459 $version-scheme /= multipartnumeric 1460 $version-scheme /= multipartnumeric-suffix 1461 $version-scheme /= alphanumeric 1462 $version-scheme /= decimal 1463 $version-scheme /= semver 1464 $version-scheme /= int / text 1466 any-attribute = ( 1467 label => one-or-more / one-or-more 1468 ) 1470 one-or-more = T / [ 2* T ] 1472 global-attributes = ( 1473 ? lang => text, 1474 * any-attribute, 1475 ) 1477 hash-entry = [ 1478 hash-alg-id: int, 1479 hash-value: bytes, 1480 ] 1482 entity-entry = { 1483 entity-name => text, 1484 ? reg-id => any-uri, 1485 role => one-or-more<$role>, 1486 ? thumbprint => hash-entry, 1487 * $$entity-extension, 1488 global-attributes, 1489 } 1491 $role /= tag-creator 1492 $role /= software-creator 1493 $role /= aggregator 1494 $role /= distributor 1495 $role /= licensor 1496 $role /= maintainer 1497 $role /= int / text 1499 link-entry = { 1500 ? artifact => text, 1501 href => any-uri, 1502 ? media => text, 1503 ? ownership => $ownership, 1504 rel => $rel, 1505 ? media-type => text, 1506 ? use => $use, 1507 * $$link-extension, 1508 global-attributes, 1509 } 1510 $ownership /= shared 1511 $ownership /= private 1512 $ownership /= abandon 1513 $ownership /= int / text 1515 $rel /= ancestor 1516 $rel /= component 1517 $rel /= feature 1518 $rel /= installationmedia 1519 $rel /= packageinstaller 1520 $rel /= parent 1521 $rel /= patches 1522 $rel /= requires 1523 $rel /= see-also 1524 $rel /= supersedes 1525 $rel /= supplemental 1526 $rel /= -256..64436 / text 1528 $use /= optional 1529 $use /= required 1530 $use /= recommended 1531 $use /= int / text 1533 software-meta-entry = { 1534 ? activation-status => text, 1535 ? channel-type => text, 1536 ? colloquial-version => text, 1537 ? description => text, 1538 ? edition => text, 1539 ? entitlement-data-required => bool, 1540 ? entitlement-key => text, 1541 ? generator => text, 1542 ? persistent-id => text, 1543 ? product => text, 1544 ? product-family => text, 1545 ? revision => text, 1546 ? summary => text, 1547 ? unspsc-code => text, 1548 ? unspsc-version => text, 1549 * $$software-meta-extension, 1550 global-attributes, 1551 } 1553 path-elements-group = ( ? directory => one-or-more, 1554 ? file => one-or-more, 1555 ) 1557 resource-collection = ( 1558 path-elements-group, 1559 ? process => one-or-more, 1560 ? resource => one-or-more, 1561 * $$resource-collection-extension, 1562 ) 1564 file-entry = { 1565 filesystem-item, 1566 ? size => uint, 1567 ? file-version => text, 1568 ? hash => hash-entry, 1569 * $$file-extension, 1570 global-attributes, 1571 } 1573 directory-entry = { 1574 filesystem-item, 1575 ? path-elements => { path-elements-group }, 1576 * $$directory-extension, 1577 global-attributes, 1578 } 1580 process-entry = { 1581 process-name => text, 1582 ? pid => integer, 1583 * $$process-extension, 1584 global-attributes, 1585 } 1587 resource-entry = { 1588 type => text, 1589 * $$resource-extension, 1590 global-attributes, 1591 } 1593 filesystem-item = ( 1594 ? key => bool, 1595 ? location => text, 1596 fs-name => text, 1597 ? root => text, 1598 ) 1600 payload-entry = { 1601 resource-collection, 1602 * $$payload-extension, 1603 global-attributes, 1604 } 1605 evidence-entry = { 1606 resource-collection, 1607 ? date => integer-time, 1608 ? device-id => text, 1609 * $$evidence-extension, 1610 global-attributes, 1611 } 1613 integer-time = #6.1(int) 1615 ; "global map member" integer indexes 1616 tag-id = 0 1617 software-name = 1 1618 entity = 2 1619 evidence = 3 1620 link = 4 1621 software-meta = 5 1622 payload = 6 1623 hash = 7 1624 corpus = 8 1625 patch = 9 1626 media = 10 1627 supplemental = 11 1628 tag-version = 12 1629 software-version = 13 1630 version-scheme = 14 1631 lang = 15 1632 directory = 16 1633 file = 17 1634 process = 18 1635 resource = 19 1636 size = 20 1637 file-version = 21 1638 key = 22 1639 location = 23 1640 fs-name = 24 1641 root = 25 1642 path-elements = 26 1643 process-name = 27 1644 pid = 28 1645 type = 29 1646 entity-name = 31 1647 reg-id = 32 1648 role = 33 1649 thumbprint = 34 1650 date = 35 1651 device-id = 36 1652 artifact = 37 1653 href = 38 1654 ownership = 39 1655 rel = 40 1656 media-type = 41 1657 use = 42 1658 activation-status = 43 1659 channel-type = 44 1660 colloquial-version = 45 1661 description = 46 1662 edition = 47 1663 entitlement-data-required = 48 1664 entitlement-key = 49 1665 generator = 50 1666 persistent-id = 51 1667 product = 52 1668 product-family = 53 1669 revision = 54 1670 summary = 55 1671 unspsc-code = 56 1672 unspsc-version = 57 1674 ; "version-scheme" integer indexes 1675 multipartnumeric = 1 1676 multipartnumeric-suffix = 2 1677 alphanumeric = 3 1678 decimal = 4 1679 semver = 16384 1681 ; "role" integer indexes 1682 tag-creator=1 1683 software-creator=2 1684 aggregator=3 1685 distributor=4 1686 licensor=5 1687 maintainer=6 1689 ; "ownership" integer indexes 1690 shared=1 1691 private=2 1692 abandon=3 1694 ; "rel" integer indexes 1695 ancestor=1 1696 component=2 1697 feature=3 1698 installationmedia=4 1699 packageinstaller=5 1700 parent=6 1701 patches=7 1702 requires=8 1703 see-also=9 1704 supersedes=10 1705 ; supplemental=11 ; this is already defined earlier 1707 ; "use" integer indexes 1708 optional=1 1709 required=2 1710 recommended=3 1712 3. Determining the Type of CoSWID 1714 The operational model for SWID and CoSWID tags was introduced in 1715 Section 1.1, which described four different CoSWID tag types. The 1716 following additional rules apply to the use of CoSWID tags to ensure 1717 that created tags properly identify the tag type. 1719 The first matching rule MUST determine the type of the CoSWID tag. 1721 1. Primary Tag: A CoSWID tag MUST be considered a primary tag if the 1722 corpus, patch, and supplemental items are "false". 1724 2. Supplemental Tag: A CoSWID tag MUST be considered a supplemental 1725 tag if the supplemental item is set to "true". 1727 3. Corpus Tag: A CoSWID tag MUST be considered a corpus tag if the 1728 corpus item is "true". 1730 4. Patch Tag: A CoSWID tag MUST be considered a patch tag if the 1731 patch item is "true". 1733 Note: Multiple of the corpus, patch, and supplemental items can have 1734 values set as "true". The rules above provide a means to determine 1735 the tag's type in such a case. For example, a SWID or CoSWID tag for 1736 a patch installer might have both corpus and patch items set to 1737 "true". In such a case, the tag is a "Corpus Tag". The tag 1738 installed by this installer would have only the patch item set to 1739 "true", making the installed tag type a "Patch Tag". 1741 4. CoSWID Indexed Label Values 1742 4.1. Version Scheme 1744 The following table contains a set of values for use in the concise- 1745 swid-tag group's version-scheme item. These values match the version 1746 schemes defined in the ISO/IEC 19770-2:2015 [SWID] specification. 1747 Index value indicates the value to use as the version-scheme item's 1748 value. The Version Scheme Name provides human-readable text for the 1749 value. The Definition describes the syntax of allowed values for 1750 each entry. 1752 +=======+=========================+================================+ 1753 | Index | Version Scheme Name | Definition | 1754 +=======+=========================+================================+ 1755 | 1 | multipartnumeric | Numbers separated by dots, | 1756 | | | where the numbers are | 1757 | | | interpreted as integers (e.g., | 1758 | | | 1.2.3, 1.4.5, 1.2.3.4.5.6.7) | 1759 +-------+-------------------------+--------------------------------+ 1760 | 2 | multipartnumeric+suffix | Numbers separated by dots, | 1761 | | | where the numbers are | 1762 | | | interpreted as integers with | 1763 | | | an additional textual suffix | 1764 | | | (e.g., 1.2.3a) | 1765 +-------+-------------------------+--------------------------------+ 1766 | 3 | alphanumeric | Strictly a string, sorting is | 1767 | | | done alphanumerically | 1768 +-------+-------------------------+--------------------------------+ 1769 | 4 | decimal | A floating point number (e.g., | 1770 | | | 1.25 is less than 1.3) | 1771 +-------+-------------------------+--------------------------------+ 1772 | 16384 | semver | Follows the [SEMVER] | 1773 | | | specification | 1774 +-------+-------------------------+--------------------------------+ 1776 Table 3: Version Scheme Values 1778 The values above are registered in the IANA "Software Tag Version 1779 Scheme Values" registry defined in Section Section 6.2.4. Additional 1780 entries will likely be registered over time in this registry. 1782 These version schemes have partially overlapping value spaces. The 1783 following guidelines help to ensure that the most specific version- 1784 scheme is used: 1786 * "decimal" and "multipartnumeric" partially overlap in their value 1787 space when a value matches a decimal number. When a corresponding 1788 software-version item's value falls within this overlapping value 1789 space, the "decimal" version scheme SHOULD be used. 1791 * "multipartnumeric" and "semver" partially overlap in their value 1792 space when a "multipartnumeric" value matches the semantic 1793 versioning syntax. When a corresponding software-version item's 1794 value falls within this overlapping value space, the "semver" 1795 version scheme SHOULD be used. 1797 * "alphanumeric" and other version schemes might overlap in their 1798 value space. When a corresponding software-version item's value 1799 falls within this overlapping value space, the other version 1800 scheme SHOULD be used instead of "alphanumeric". 1802 4.2. Entity Role Values 1804 The following table indicates the index value to use for the entity- 1805 entry group's role item (see Section 2.6). These values match the 1806 entity roles defined in the ISO/IEC 19770-2:2015 [SWID] 1807 specification. The "Index" value indicates the value to use as the 1808 role item's value. The "Role Name" provides human-readable text for 1809 the value. The "Definition" describes the semantic meaning of each 1810 entry. 1812 +=======+=================+========================================+ 1813 | Index | Role Name | Definition | 1814 +=======+=================+========================================+ 1815 | 1 | tagCreator | The person or organization that | 1816 | | | created the containing SWID or CoSWID | 1817 | | | tag | 1818 +-------+-----------------+----------------------------------------+ 1819 | 2 | softwareCreator | The person or organization entity that | 1820 | | | created the software component. | 1821 +-------+-----------------+----------------------------------------+ 1822 | 3 | aggregator | From [SWID], "An organization or | 1823 | | | system that encapsulates software from | 1824 | | | their own and/or other organizations | 1825 | | | into a different distribution process | 1826 | | | (as in the case of virtualization), or | 1827 | | | as a completed system to accomplish a | 1828 | | | specific task (as in the case of a | 1829 | | | value added reseller)." | 1830 +-------+-----------------+----------------------------------------+ 1831 | 4 | distributor | From [SWID], "An entity that furthers | 1832 | | | the marketing, selling and/or | 1833 | | | distribution of software from the | 1834 | | | original place of manufacture to the | 1835 | | | ultimate user without modifying the | 1836 | | | software, its packaging or its | 1837 | | | labelling." | 1838 +-------+-----------------+----------------------------------------+ 1839 | 5 | licensor | From [SAM] as "software licensor", a | 1840 | | | "person or organization who owns or | 1841 | | | holds the rights to issue a software | 1842 | | | license for a specific software | 1843 | | | [component]" | 1844 +-------+-----------------+----------------------------------------+ 1845 | 6 | maintainer | The person or organization that is | 1846 | | | responsible for coordinating and | 1847 | | | making updates to the source code for | 1848 | | | the software component. This SHOULD | 1849 | | | be used when the "maintainer" is a | 1850 | | | different person or organization than | 1851 | | | the original "softwareCreator". | 1852 +-------+-----------------+----------------------------------------+ 1854 Table 4: Entity Role Values 1856 The values above are registered in the IANA "Software Tag Entity Role 1857 Values" registry defined in Section 6.2.5. Additional values will 1858 likely be registered over time. Additionally, the index values 128 1859 through 255 and the name prefix "x_" have been reserved for private 1860 use. 1862 4.3. Link Ownership Values 1864 The following table indicates the index value to use for the link- 1865 entry group's ownership item (see Section 2.7). These values match 1866 the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID] 1867 specification. The "Index" value indicates the value to use as the 1868 link-entry group ownership item's value. The "Ownership Type" 1869 provides human-readable text for the value. The "Definition" 1870 describes the semantic meaning of each entry. 1872 +=======+===========+===============================================+ 1873 | Index | Ownership | Definition | 1874 | | Type | | 1875 +=======+===========+===============================================+ 1876 | 1 | abandon | If the software component referenced by the | 1877 | | | CoSWID tag is uninstalled, then the | 1878 | | | referenced software SHOULD NOT be | 1879 | | | uninstalled | 1880 +-------+-----------+-----------------------------------------------+ 1881 | 2 | private | If the software component referenced by the | 1882 | | | CoSWID tag is uninstalled, then the | 1883 | | | referenced software SHOULD be uninstalled as | 1884 | | | well. | 1885 +-------+-----------+-----------------------------------------------+ 1886 | 3 | shared | If the software component referenced by the | 1887 | | | CoSWID tag is uninstalled, then the | 1888 | | | referenced software SHOULD be uninstalled if | 1889 | | | no other components sharing the software. | 1890 +-------+-----------+-----------------------------------------------+ 1892 Table 5: Link Ownership Values 1894 The values above are registered in the IANA "Software Tag Link 1895 Ownership Values" registry defined in Section 6.2.6. Additional 1896 values will likely be registered over time. Additionally, the index 1897 values 128 through 255 and the name prefix "x_" have been reserved 1898 for private use. 1900 4.4. Link Rel Values 1902 The following table indicates the index value to use for the link- 1903 entry group's rel item (see Section 2.7). These values match the 1904 link rel values defined in the ISO/IEC 19770-2:2015 [SWID] 1905 specification. The "Index" value indicates the value to use as the 1906 link-entry group ownership item's value. The "Relationship Type" 1907 provides human-readable text for the value. The "Definition" 1908 describes the semantic meaning of each entry. 1910 +=======+===================+=======================================+ 1911 | Index | Relationship Type | Definition | 1912 +=======+===================+=======================================+ 1913 | 1 | ancestor | The link references a software | 1914 | | | tag for a previous release of | 1915 | | | this software. This can be | 1916 | | | useful to define an upgrade path. | 1917 +-------+-------------------+---------------------------------------+ 1918 | 2 | component | The link references a software | 1919 | | | tag for a separate component of | 1920 | | | this software. | 1921 +-------+-------------------+---------------------------------------+ 1922 | 3 | feature | The link references a | 1923 | | | configurable feature of this | 1924 | | | software that can be enabled or | 1925 | | | disabled without changing the | 1926 | | | installed files. | 1927 +-------+-------------------+---------------------------------------+ 1928 | 4 | installationmedia | The link references the | 1929 | | | installation package that can be | 1930 | | | used to install this software. | 1931 +-------+-------------------+---------------------------------------+ 1932 | 5 | packageinstaller | The link references the | 1933 | | | installation software needed to | 1934 | | | install this software. | 1935 +-------+-------------------+---------------------------------------+ 1936 | 6 | parent | The link references a software | 1937 | | | tag that is the parent of the | 1938 | | | referencing tag. This | 1939 | | | relationship can be used when | 1940 | | | multiple software components are | 1941 | | | part of a software bundle, where | 1942 | | | the "parent" is the software tag | 1943 | | | for the bundle, and each child is | 1944 | | | a "component". In such a case, | 1945 | | | each child component can provide | 1946 | | | a "parent" link relationship to | 1947 | | | the bundle's software tag, and | 1948 | | | the bundle can provide a | 1949 | | | "component" link relationship to | 1950 | | | each child software component. | 1951 +-------+-------------------+---------------------------------------+ 1952 | 7 | patches | The link references a software | 1953 | | | tag that the referencing software | 1954 | | | patches. Typically only used for | 1955 | | | patch tags (see Section 1.1). | 1956 +-------+-------------------+---------------------------------------+ 1957 | 8 | requires | The link references a | 1958 | | | prerequisite for installing this | 1959 | | | software. A patch tag (see | 1960 | | | Section 1.1) can use this to | 1961 | | | represent base software or | 1962 | | | another patch that needs to be | 1963 | | | installed first. | 1964 +-------+-------------------+---------------------------------------+ 1965 | 9 | see-also | The link references other | 1966 | | | software that may be of interest | 1967 | | | that relates to this software. | 1968 +-------+-------------------+---------------------------------------+ 1969 | 10 | supersedes | The link references another | 1970 | | | software that this software | 1971 | | | replaces. A patch tag (see | 1972 | | | Section 1.1) can use this to | 1973 | | | represent another patch that this | 1974 | | | patch incorporates or replaces. | 1975 +-------+-------------------+---------------------------------------+ 1976 | 11 | supplemental | The link references a software | 1977 | | | tag that the referencing tag | 1978 | | | supplements. Used on | 1979 | | | supplemental tags (see | 1980 | | | Section 1.1). | 1981 +-------+-------------------+---------------------------------------+ 1983 Table 6: Link Relationship Values 1985 The values above are registered in the IANA "Software Tag Link 1986 Relationship Values" registry defined in Section 6.2.7. Additional 1987 values will likely be registered over time. Additionally, the index 1988 values 32768 through 65535 and the name prefix "x_" have been 1989 reserved for private use. 1991 4.5. Link Use Values 1993 The following table indicates the index value to use for the link- 1994 entry group's use item (see Section 2.7). These values match the 1995 link use values defined in the ISO/IEC 19770-2:2015 [SWID] 1996 specification. The "Index" value indicates the value to use as the 1997 link-entry group use item's value. The "Use Type" provides human- 1998 readable text for the value. The "Definition" describes the semantic 1999 meaning of each entry. 2001 +=======+=============+========================================+ 2002 | Index | Use Type | Definition | 2003 +=======+=============+========================================+ 2004 | 1 | optional | From [SWID], "Not absolutely required; | 2005 | | | the [Link]'d software is installed | 2006 | | | only when specified." | 2007 +-------+-------------+----------------------------------------+ 2008 | 2 | required | From [SWID], "The [Link]'d software is | 2009 | | | absolutely required for an operation | 2010 | | | software installation." | 2011 +-------+-------------+----------------------------------------+ 2012 | 3 | recommended | From [SWID], "Not absolutely required; | 2013 | | | the [Link]'d software is installed | 2014 | | | unless specified otherwise." | 2015 +-------+-------------+----------------------------------------+ 2017 Table 7: Link Use Values 2019 The values above are registered in the IANA "Software Tag Link Use 2020 Values" registry defined in Section 6.2.8. Additional values will 2021 likely be registered over time. Additionally, the index values 128 2022 through 255 and the name prefix "x_" have been reserved for private 2023 use. 2025 5. URI Schemes 2027 This specification defines the following URI schemes for use in 2028 CoSWID and to provide interoperability with schemes used in {SWID}. 2030 Note: These schemes are used in {SWID} without an IANA registration. 2031 This specification ensures that these schemes are properly defined 2032 going forward. 2034 5.1. "swid" URI Scheme Specification 2036 URIs specifying the "swid" scheme are used to reference a software 2037 tag by its tag-id. A tag-id referenced in this way can be used to 2038 identify the tag resource in the context of where it is referenced 2039 from. For example, when a tag is installed on a given device, that 2040 tag can reference related tags on the same device using URIs with 2041 this scheme. 2043 For URIs that use the "swid" scheme, the scheme specific part MUST 2044 consist of a referenced software tag's tag-id. This tag-id MUST be 2045 URI encoded according to [RFC3986] Section 2.1. 2047 The following expression is a valid example: 2049 swid:2df9de35-0aff-4a86-ace6-f7dddd1ade4c 2051 5.2. "swidpath" URI Scheme Specification 2053 URIs specifying the "swidpath" scheme are used to reference the data 2054 that must be found in a given software tag for that tag to be 2055 considered a matching tag to be included in the identified tag 2056 collection. Tags to be evaluated include all tags in the context of 2057 where the tag is referenced from. For example, when a tag is 2058 installed on a given device, that tag can reference related tags on 2059 the same device using a URI with this scheme. 2061 For URIs that use the "swidpath" scheme, the requirements apply. 2063 The scheme specific part MUST be an XPath expression as defined by 2064 [W3C.REC-xpath20-20101214]. The included XPath expression will be 2065 URI encoded according to [RFC3986] Section 2.1. 2067 This XPath is evaluated over SWID tags found on a system. A given 2068 tag MUST be considered a match if the XPath evaluation result value 2069 has an effective boolean value of "true" according to 2070 [W3C.REC-xpath20-20101214] Section 2.4.3. 2072 6. IANA Considerations 2074 This document has a number of IANA considerations, as described in 2075 the following subsections. In summary, 6 new registries are 2076 established with this request, with initial entries provided for each 2077 registry. New values for 5 other registries are also requested. 2079 6.1. CoSWID Items Registry 2081 This registry uses integer values as index values in CBOR maps. 2083 This document defines a new registry titled "CoSWID Items". Future 2084 registrations for this registry are to be made based on [RFC8126] as 2085 follows: 2087 +==================+=========================+ 2088 | Range | Registration Procedures | 2089 +==================+=========================+ 2090 | 0-32767 | Standards Action | 2091 +------------------+-------------------------+ 2092 | 32768-4294967295 | Specification Required | 2093 +------------------+-------------------------+ 2095 Table 8: CoSWID Items Registration Procedures 2097 All negative values are reserved for Private Use. 2099 Initial registrations for the "CoSWID Items" registry are provided 2100 below. Assignments consist of an integer index value, the item name, 2101 and a reference to the defining specification. 2103 +===============+===========================+===============+ 2104 | Index | Item Name | Specification | 2105 +===============+===========================+===============+ 2106 | 0 | tag-id | RFC-AAAA | 2107 +---------------+---------------------------+---------------+ 2108 | 1 | software-name | RFC-AAAA | 2109 +---------------+---------------------------+---------------+ 2110 | 2 | entity | RFC-AAAA | 2111 +---------------+---------------------------+---------------+ 2112 | 3 | evidence | RFC-AAAA | 2113 +---------------+---------------------------+---------------+ 2114 | 4 | link | RFC-AAAA | 2115 +---------------+---------------------------+---------------+ 2116 | 5 | software-meta | RFC-AAAA | 2117 +---------------+---------------------------+---------------+ 2118 | 6 | payload | RFC-AAAA | 2119 +---------------+---------------------------+---------------+ 2120 | 7 | hash | RFC-AAAA | 2121 +---------------+---------------------------+---------------+ 2122 | 8 | corpus | RFC-AAAA | 2123 +---------------+---------------------------+---------------+ 2124 | 9 | patch | RFC-AAAA | 2125 +---------------+---------------------------+---------------+ 2126 | 10 | media | RFC-AAAA | 2127 +---------------+---------------------------+---------------+ 2128 | 11 | supplemental | RFC-AAAA | 2129 +---------------+---------------------------+---------------+ 2130 | 12 | tag-version | RFC-AAAA | 2131 +---------------+---------------------------+---------------+ 2132 | 13 | software-version | RFC-AAAA | 2133 +---------------+---------------------------+---------------+ 2134 | 14 | version-scheme | RFC-AAAA | 2135 +---------------+---------------------------+---------------+ 2136 | 15 | lang | RFC-AAAA | 2137 +---------------+---------------------------+---------------+ 2138 | 16 | directory | RFC-AAAA | 2139 +---------------+---------------------------+---------------+ 2140 | 17 | file | RFC-AAAA | 2141 +---------------+---------------------------+---------------+ 2142 | 18 | process | RFC-AAAA | 2143 +---------------+---------------------------+---------------+ 2144 | 19 | resource | RFC-AAAA | 2145 +---------------+---------------------------+---------------+ 2146 | 20 | size | RFC-AAAA | 2147 +---------------+---------------------------+---------------+ 2148 | 21 | file-version | RFC-AAAA | 2149 +---------------+---------------------------+---------------+ 2150 | 22 | key | RFC-AAAA | 2151 +---------------+---------------------------+---------------+ 2152 | 23 | location | RFC-AAAA | 2153 +---------------+---------------------------+---------------+ 2154 | 24 | fs-name | RFC-AAAA | 2155 +---------------+---------------------------+---------------+ 2156 | 25 | root | RFC-AAAA | 2157 +---------------+---------------------------+---------------+ 2158 | 26 | path-elements | RFC-AAAA | 2159 +---------------+---------------------------+---------------+ 2160 | 27 | process-name | RFC-AAAA | 2161 +---------------+---------------------------+---------------+ 2162 | 28 | pid | RFC-AAAA | 2163 +---------------+---------------------------+---------------+ 2164 | 29 | type | RFC-AAAA | 2165 +---------------+---------------------------+---------------+ 2166 | 31 | entity-name | RFC-AAAA | 2167 +---------------+---------------------------+---------------+ 2168 | 32 | reg-id | RFC-AAAA | 2169 +---------------+---------------------------+---------------+ 2170 | 33 | role | RFC-AAAA | 2171 +---------------+---------------------------+---------------+ 2172 | 34 | thumbprint | RFC-AAAA | 2173 +---------------+---------------------------+---------------+ 2174 | 35 | date | RFC-AAAA | 2175 +---------------+---------------------------+---------------+ 2176 | 36 | device-id | RFC-AAAA | 2177 +---------------+---------------------------+---------------+ 2178 | 37 | artifact | RFC-AAAA | 2179 +---------------+---------------------------+---------------+ 2180 | 38 | href | RFC-AAAA | 2181 +---------------+---------------------------+---------------+ 2182 | 39 | ownership | RFC-AAAA | 2183 +---------------+---------------------------+---------------+ 2184 | 40 | rel | RFC-AAAA | 2185 +---------------+---------------------------+---------------+ 2186 | 41 | media-type | RFC-AAAA | 2187 +---------------+---------------------------+---------------+ 2188 | 42 | use | RFC-AAAA | 2189 +---------------+---------------------------+---------------+ 2190 | 43 | activation-status | RFC-AAAA | 2191 +---------------+---------------------------+---------------+ 2192 | 44 | channel-type | RFC-AAAA | 2193 +---------------+---------------------------+---------------+ 2194 | 45 | colloquial-version | RFC-AAAA | 2195 +---------------+---------------------------+---------------+ 2196 | 46 | description | RFC-AAAA | 2197 +---------------+---------------------------+---------------+ 2198 | 47 | edition | RFC-AAAA | 2199 +---------------+---------------------------+---------------+ 2200 | 48 | entitlement-data-required | RFC-AAAA | 2201 +---------------+---------------------------+---------------+ 2202 | 49 | entitlement-key | RFC-AAAA | 2203 +---------------+---------------------------+---------------+ 2204 | 50 | generator | RFC-AAAA | 2205 +---------------+---------------------------+---------------+ 2206 | 51 | persistent-id | RFC-AAAA | 2207 +---------------+---------------------------+---------------+ 2208 | 52 | product | RFC-AAAA | 2209 +---------------+---------------------------+---------------+ 2210 | 53 | product-family | RFC-AAAA | 2211 +---------------+---------------------------+---------------+ 2212 | 54 | revision | RFC-AAAA | 2213 +---------------+---------------------------+---------------+ 2214 | 55 | summary | RFC-AAAA | 2215 +---------------+---------------------------+---------------+ 2216 | 56 | unspsc-code | RFC-AAAA | 2217 +---------------+---------------------------+---------------+ 2218 | 57 | unspsc-version | RFC-AAAA | 2219 +---------------+---------------------------+---------------+ 2220 | 58-4294967295 | Unassigned | | 2221 +---------------+---------------------------+---------------+ 2222 Table 9: CoSWID Items Inital Registrations 2224 6.2. Software Tag Values Registries 2226 The following IANA registries provide a mechanism for new values to 2227 be added over time to common enumerations used by SWID and CoSWID. 2229 6.2.1. Registration Procedures 2231 The following registries allow for the registration of index values 2232 and names. New registrations will be permitted through either the 2233 Standards Action policy or the Specification Required policy [BCP26]. 2234 New index values will be provided on a First Come First Served as 2235 defined by [BCP26]. 2237 The following registries also reserve the integer-based index values 2238 in the range of -1 to -256 for private use as defined by [BCP26] in 2239 Section 4.1. This allows values -1 to -24 to be expressed as a 2240 single uint_8t in CBOR, and values -25 to -256 to be expressed using 2241 an additional uint_8t in CBOR. 2243 6.2.2. Private Use of Index and Name Values 2245 The integer-based index values in the private use range (-1 to -256) 2246 are intended for testing purposes and closed environments; values in 2247 other ranges SHOULD NOT be assigned for testing. 2249 For names that correspond to private use index values, an 2250 Internationalized Domain Name prefix MUST be used to prevent name 2251 conflicts using the form: 2253 "domain.prefix-name" 2255 Where "domain.prefix" MUST be a valid Internationalized Domain Name 2256 as defined by [RFC5892], and "name" MUST be a unique name within the 2257 namespace defined by the "domain.prefix". Use of a prefix in this 2258 way allows for a name to be used initially in the private use range, 2259 and to be registered at a future point in time. This is consistent 2260 with the guidance in [BCP178]. 2262 6.2.3. Expert Review Guidelines 2264 Designated experts MUST ensure that new registration requests meet 2265 the following additional guidelines: 2267 * The requesting specification MUST provide a clear semantic 2268 definition for the new entry. This definition MUST clearly 2269 differentiate the requested entry from other previously registered 2270 entries. 2272 * The requesting specification MUST describe the intended use of the 2273 entry, including any co-constraints that exist between the use of 2274 the entry's index value or name, and other values defined within 2275 the SWID/CoSWID model. 2277 * Index values and names outside the private use space MUST NOT be 2278 used without registration. This is considered squatting and 2279 SHOULD be avoided. Designated experts MUST ensure that reviewed 2280 specifications register all appropriate index values and names. 2282 * Standards track documents MAY include entries registered in the 2283 range reserved for entries under the Specification Required 2284 policy. This can occur when a standards track document provides 2285 further guidance on the use of index values and names that are in 2286 common use, but were not registered with IANA. This situation 2287 SHOULD be avoided. 2289 * All registered names MUST be valid according to the XML Schema 2290 NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] 2291 Section 3.3.4). This ensures that registered names are compatible 2292 with the SWID format [SWID] where they are used. 2294 * Registration of vanity names SHOULD be discouraged. The 2295 requesting specification MUST provide a description of how a 2296 requested name will allow for use by multiple stakeholders. 2298 6.2.4. Software Tag Version Scheme Values Registry 2300 This document establishes a new registry titled "Software Tag Version 2301 Scheme Values". This registry provides index values for use as 2302 version-scheme item values in this document and version scheme names 2303 for use in [SWID]. 2305 [TO BE REMOVED: This registration should take place at the following 2306 location: https://www.iana.org/assignments/swid] 2308 This registry uses the registration procedures defined in 2309 Section 6.2.1 with the following associated ranges: 2311 +=============+=========================+ 2312 | Range | Registration Procedures | 2313 +=============+=========================+ 2314 | 0-16383 | Standards Action | 2315 +-------------+-------------------------+ 2316 | 16384-65535 | Specification Required | 2317 +-------------+-------------------------+ 2319 Table 10: CoSWID Version Scheme 2320 Registration Procedures 2322 Assignments MUST consist of an integer Index value, the Version 2323 Scheme Name, and a reference to the defining specification. 2325 Initial registrations for the "Software Tag Version Scheme Values" 2326 registry are provided below, which are derived from the textual 2327 version scheme names defined in [SWID]. 2329 +=============+=========================+=================+ 2330 | Index | Version Scheme Name | Specification | 2331 +=============+=========================+=================+ 2332 | 0 | Reserved | | 2333 +-------------+-------------------------+-----------------+ 2334 | 1 | multipartnumeric | See Section 4.1 | 2335 +-------------+-------------------------+-----------------+ 2336 | 2 | multipartnumeric+suffix | See Section 4.1 | 2337 +-------------+-------------------------+-----------------+ 2338 | 3 | alphanumeric | See Section 4.1 | 2339 +-------------+-------------------------+-----------------+ 2340 | 4 | decimal | See Section 4.1 | 2341 +-------------+-------------------------+-----------------+ 2342 | 5-16383 | Unassigned | | 2343 +-------------+-------------------------+-----------------+ 2344 | 16384 | semver | [SEMVER] | 2345 +-------------+-------------------------+-----------------+ 2346 | 16385-65535 | Unassigned | | 2347 +-------------+-------------------------+-----------------+ 2349 Table 11: CoSWID Version Scheme Initial Registrations 2351 Registrations MUST conform to the expert review guidelines defined in 2352 Section 6.2.3. 2354 Designated experts MUST also ensure that newly requested entries 2355 define a value space for the corresponding version item that is 2356 unique from other previously registered entries. Note: The initial 2357 registrations violate this requirement, but are included for 2358 backwards compatibility with [SWID]. Guidelines on how to deconflict 2359 these value spaces are defined in Section 4.1. 2361 6.2.5. Software Tag Entity Role Values Registry 2363 This document establishes a new registry titled "Software Tag Entity 2364 Role Values". This registry provides index values for use as entity- 2365 entry role item values in this document and entity role names for use 2366 in [SWID]. 2368 [TO BE REMOVED: This registration should take place at the following 2369 location: https://www.iana.org/assignments/swid] 2371 This registry uses the registration procedures defined in 2372 Section 6.2.1 with the following associated ranges: 2374 +=========+=========================+ 2375 | Range | Registration Procedures | 2376 +=========+=========================+ 2377 | 0-127 | Standards Action | 2378 +---------+-------------------------+ 2379 | 128-255 | Specification Required | 2380 +---------+-------------------------+ 2382 Table 12: CoSWID Entity Role 2383 Registration Procedures 2385 Assignments consist of an integer Index value, a Role Name, and a 2386 reference to the defining specification. 2388 Initial registrations for the "Software Tag Entity Role Values" 2389 registry are provided below, which are derived from the textual 2390 entity role names defined in [SWID]. 2392 +=======+=================+=================+ 2393 | Index | Role Name | Specification | 2394 +=======+=================+=================+ 2395 | 0 | Reserved | | 2396 +-------+-----------------+-----------------+ 2397 | 1 | tagCreator | See Section 4.2 | 2398 +-------+-----------------+-----------------+ 2399 | 2 | softwareCreator | See Section 4.2 | 2400 +-------+-----------------+-----------------+ 2401 | 3 | aggregator | See Section 4.2 | 2402 +-------+-----------------+-----------------+ 2403 | 4 | distributor | See Section 4.2 | 2404 +-------+-----------------+-----------------+ 2405 | 5 | licensor | See Section 4.2 | 2406 +-------+-----------------+-----------------+ 2407 | 6 | maintainer | See Section 4.2 | 2408 +-------+-----------------+-----------------+ 2409 | 7-255 | Unassigned | | 2410 +-------+-----------------+-----------------+ 2412 Table 13: CoSWID Entity Role Initial 2413 Registrations 2415 Registrations MUST conform to the expert review guidelines defined in 2416 Section 6.2.3. 2418 6.2.6. Software Tag Link Ownership Values Registry 2420 This document establishes a new registry titled "Software Tag Link 2421 Ownership Values". This registry provides index values for use as 2422 link-entry ownership item values in this document and link ownership 2423 names for use in [SWID]. 2425 [TO BE REMOVED: This registration should take place at the following 2426 location: https://www.iana.org/assignments/swid] 2428 This registry uses the registration procedures defined in 2429 Section 6.2.1 with the following associated ranges: 2431 +=========+=========================+ 2432 | Range | Registration Procedures | 2433 +=========+=========================+ 2434 | 0-127 | Standards Action | 2435 +---------+-------------------------+ 2436 | 128-255 | Specification Required | 2437 +---------+-------------------------+ 2439 Table 14: CoSWID Link Ownership 2440 Registration Procedures 2442 Assignments consist of an integer Index value, an Ownership Type 2443 Name, and a reference to the defining specification. 2445 Initial registrations for the "Software Tag Link Ownership Values" 2446 registry are provided below, which are derived from the textual 2447 entity role names defined in [SWID]. 2449 +=======+=====================+=================+ 2450 | Index | Ownership Type Name | Definition | 2451 +=======+=====================+=================+ 2452 | 0 | Reserved | | 2453 +-------+---------------------+-----------------+ 2454 | 1 | abandon | See Section 4.3 | 2455 +-------+---------------------+-----------------+ 2456 | 2 | private | See Section 4.3 | 2457 +-------+---------------------+-----------------+ 2458 | 3 | shared | See Section 4.3 | 2459 +-------+---------------------+-----------------+ 2460 | 4-255 | Unassigned | | 2461 +-------+---------------------+-----------------+ 2463 Table 15: CoSWID Link Ownership Inital 2464 Registrations 2466 Registrations MUST conform to the expert review guidelines defined in 2467 Section 6.2.3. 2469 6.2.7. Software Tag Link Relationship Values Registry 2471 This document establishes a new registry titled "Software Tag Link 2472 Relationship Values". This registry provides index values for use as 2473 link-entry rel item values in this document and link ownership names 2474 for use in [SWID]. 2476 [TO BE REMOVED: This registration should take place at the following 2477 location: https://www.iana.org/assignments/swid] 2478 This registry uses the registration procedures defined in 2479 Section 6.2.1 with the following associated ranges: 2481 +=============+=========================+ 2482 | Range | Registration Procedures | 2483 +=============+=========================+ 2484 | 0-32767 | Standards Action | 2485 +-------------+-------------------------+ 2486 | 32768-65535 | Specification Required | 2487 +-------------+-------------------------+ 2489 Table 16: CoSWID Link Relationship 2490 Registration Procedures 2492 Assignments consist of an integer Index value, the Relationship Type 2493 Name, and a reference to the defining specification. 2495 Initial registrations for the "Software Tag Link Relationship Values" 2496 registry are provided below, which are derived from the link 2497 relationship values defined in [SWID]. 2499 +==========+========================+=================+ 2500 | Index | Relationship Type Name | Specification | 2501 +==========+========================+=================+ 2502 | 0 | Reserved | | 2503 +----------+------------------------+-----------------+ 2504 | 1 | ancestor | See Section 4.4 | 2505 +----------+------------------------+-----------------+ 2506 | 2 | component | See Section 4.4 | 2507 +----------+------------------------+-----------------+ 2508 | 3 | feature | See Section 4.4 | 2509 +----------+------------------------+-----------------+ 2510 | 4 | installationmedia | See Section 4.4 | 2511 +----------+------------------------+-----------------+ 2512 | 5 | packageinstaller | See Section 4.4 | 2513 +----------+------------------------+-----------------+ 2514 | 6 | parent | See Section 4.4 | 2515 +----------+------------------------+-----------------+ 2516 | 7 | patches | See Section 4.4 | 2517 +----------+------------------------+-----------------+ 2518 | 8 | requires | See Section 4.4 | 2519 +----------+------------------------+-----------------+ 2520 | 9 | see-also | See Section 4.4 | 2521 +----------+------------------------+-----------------+ 2522 | 10 | supersedes | See Section 4.4 | 2523 +----------+------------------------+-----------------+ 2524 | 11 | supplemental | See Section 4.4 | 2525 +----------+------------------------+-----------------+ 2526 | 12-65535 | Unassigned | | 2527 +----------+------------------------+-----------------+ 2529 Table 17: CoSWID Link Relationship Initial 2530 Registrations 2532 Registrations MUST conform to the expert review guidelines defined in 2533 Section 6.2.3. 2535 Designated experts MUST also ensure that a newly requested entry 2536 documents the URI schemes allowed to be used in an href associated 2537 with the link relationship and the expected resolution behavior of 2538 these URI schemes. This will help to ensure that applications 2539 processing software tags are able to interoperate when resolving 2540 resources referenced by a link of a given type. 2542 6.2.8. Software Tag Link Use Values Registry 2544 This document establishes a new registry titled "Software Tag Link 2545 Use Values". This registry provides index values for use as link- 2546 entry use item values in this document and link use names for use in 2547 [SWID]. 2549 [TO BE REMOVED: This registration should take place at the following 2550 location: https://www.iana.org/assignments/swid] 2552 This registry uses the registration procedures defined in 2553 Section 6.2.1 with the following associated ranges: 2555 +=========+=========================+ 2556 | Range | Registration Procedures | 2557 +=========+=========================+ 2558 | 0-127 | Standards Action | 2559 +---------+-------------------------+ 2560 | 128-255 | Specification Required | 2561 +---------+-------------------------+ 2563 Table 18: CoSWID Link Use 2564 Registration Procedures 2566 Assignments consist of an integer Index value, the Link Use Type 2567 Name, and a reference to the defining specification. 2569 Initial registrations for the "Software Tag Link Use Values" registry 2570 are provided below, which are derived from the link relationship 2571 values defined in [SWID]. 2573 +=======+====================+=================+ 2574 | Index | Link Use Type Name | Specification | 2575 +=======+====================+=================+ 2576 | 0 | Reserved | | 2577 +-------+--------------------+-----------------+ 2578 | 1 | optional | See Section 4.5 | 2579 +-------+--------------------+-----------------+ 2580 | 2 | required | See Section 4.5 | 2581 +-------+--------------------+-----------------+ 2582 | 3 | recommended | See Section 4.5 | 2583 +-------+--------------------+-----------------+ 2584 | 4-255 | Unassigned | | 2585 +-------+--------------------+-----------------+ 2587 Table 19: CoSWID Link Use Initial Registrations 2589 Registrations MUST conform to the expert review guidelines defined in 2590 Section 6.2.3. 2592 6.3. swid+cbor Media Type Registration 2594 *_TODO: Per Section 5.1 of RFC6838, was a message sent to media- 2595 types@iana.org for preliminary review? I didn't see it on that 2596 mailing list (did I miss it?). Please kick that off._* 2598 IANA is requested to add the following to the IANA "Media Types" 2599 registry. 2601 Type name: application 2603 Subtype name: swid+cbor 2605 Required parameters: none 2607 Optional parameters: none 2609 Encoding considerations: Must be encoded as using [RFC7049]. See 2610 RFC-AAAA for details. 2612 Security considerations: See Section 9 of RFC-AAAA. 2614 Interoperability considerations: Applications MAY ignore any key 2615 value pairs that they do not understand. This allows backwards 2616 compatible extensions to this specification. 2618 Published specification: RFC-AAAA 2620 Applications that use this media type: The type is used by software 2621 asset management systems, vulnerability assessment systems, and in 2622 applications that use remote integrity verification. 2624 Fragment identifier considerations: Fragment identification for 2625 application/swid+cbor is supported by using fragment identifiers as 2626 specified by RFC7049 Section 7.5. 2628 Additional information: 2630 Magic number(s): first five bytes in hex: da 53 57 49 44 2632 File extension(s): coswid 2634 Macintosh file type code(s): none 2635 Macintosh Universal Type Identifier code: org.ietf.coswid conforms to 2636 public.data 2638 Person & email address to contact for further information: Henk 2639 Birkholz 2641 Intended usage: COMMON 2643 Restrictions on usage: None 2645 Author: Henk Birkholz 2647 Change controller: IESG 2649 6.4. CoAP Content-Format Registration 2651 IANA is requested to assign a CoAP Content-Format ID for the CoSWID 2652 media type in the "CoAP Content-Formats" sub-registry, from the "IETF 2653 Review or IESG Approval" space (256..999), within the "CoRE 2654 Parameters" registry [RFC7252]: 2656 +=======================+==========+======+===========+ 2657 | Media type | Encoding | ID | Reference | 2658 +=======================+==========+======+===========+ 2659 | application/swid+cbor | - | TBD1 | RFC-AAAA | 2660 +-----------------------+----------+------+-----------+ 2662 Table 20: CoAP Content-Format IDs 2664 6.5. CBOR Tag Registration 2666 IANA is requested to allocate a tag in the "CBOR Tags" registry, 2667 preferably with the specific value requested: 2669 +============+===========+=============================+ 2670 | Tag | Data Item | Semantics | 2671 +============+===========+=============================+ 2672 | 1398229316 | map | Concise Software Identifier | 2673 | | | (CoSWID) [RFC-AAAA] | 2674 +------------+-----------+-----------------------------+ 2676 Table 21: CoSWID CBOR Tag 2678 6.6. URI Scheme Registrations 2680 The ISO 19770-2:2015 SWID specification describes use of the "swid" 2681 and "swidpath" URI schemes, which are currently in use in 2682 implementations. This document continues this use for CoSWID. The 2683 following subsections provide registrations for these schemes in to 2684 ensure that a permanent registration exists for these schemes that is 2685 suitable for use in the SWID and CoSWID specifications. 2687 *_TODO: Per Step 3.2 of Section 7.2 of RFC7595, has this been sent to 2688 uri-review@ietf.org? I didn't see it on that mailing list (did I 2689 miss it?). Please kick that off._* 2691 6.6.1. "swid" URI Scheme Registration 2693 There is a need for a scheme name that can be used in URIs that point 2694 to a specific software tag by that tag's tag-id, such as the use of 2695 the link entry as described in Section 2.7) of this document. Since 2696 this scheme is used in a standards track document and an ISO 2697 standard, this scheme needs to be used without fear of conflicts with 2698 current or future actual schemes. The scheme "swid" is hereby 2699 registered as a 'permanent' scheme for that purpose. 2701 The "swid" scheme is specified as follows: 2703 Scheme name: swid 2705 Status: Permanent 2707 Applications/protocols that use this scheme name: See section 2708 Section 5.1. 2710 Contact: FIXME 2712 Change controller: FIXME 2714 References: FIXME 2716 6.6.2. "swidpath" URI Scheme Registration 2718 There is a need for a scheme name that can be used in URIs to 2719 identify a collection of specific software tags with data elements 2720 that match an XPath expression, such as the use of the link entry as 2721 described in Section 2.7) of this document. Since this scheme is 2722 used in a standards track document and an ISO standard, this scheme 2723 needs to be used without fear of conflicts with current or future 2724 actual schemes. The scheme "swidpath" is hereby registered as a 2725 'permanent' scheme for that purpose. 2727 The "swidpath" scheme is specified as follows: 2729 Scheme name: swidpath 2731 Status: Permanent 2733 Applications/protocols that use this scheme name: See section 2734 Section 5.2. 2736 Contact: FIXME 2738 Change controller: FIXME 2740 References: FIXME 2742 6.7. CoSWID Model for use in SWIMA Registration 2744 The Software Inventory Message and Attributes (SWIMA) for PA-TNC 2745 specification [RFC8412] defines a standardized method for collecting 2746 an endpoint device's software inventory. A CoSWID can provide 2747 evidence of software installation which can then be used and 2748 exchanged with SWIMA. This registration adds a new entry to the IANA 2749 "Software Data Model Types" registry defined by [RFC8412] to support 2750 CoSWID use in SWIMA as follows: 2752 Pen: 0 2754 Integer: TBD2 2756 Name: Concise Software Identifier (CoSWID) 2758 Reference: RFC-AAAA 2760 Deriving Software Identifiers: 2762 A Software Identifier generated from a CoSWID tag is expressed as a 2763 concatenation of the form in [RFC5234] as follows: 2765 TAG_CREATOR_REGID "_" "_" UNIQUE_ID 2767 Where TAG_CREATOR_REGID is the reg-id item value of the tag's entity 2768 item having the role value of 1 (corresponding to "tag creator"), and 2769 the UNIQUE_ID is the same tag's tag-id item. If the tag-id item's 2770 value is expressed as a 16 byte binary string, the UNIQUE_ID MUST be 2771 represented using the UUID string representation defined in [RFC4122] 2772 including the "urn:uuid:" prefix. 2774 The TAG_CREATOR_REGID and the UNIQUE_ID are connected with a double 2775 underscore (_), without any other connecting character or whitespace. 2777 7. Signed CoSWID Tags 2779 SWID tags, as defined in the ISO-19770-2:2015 XML schema, can include 2780 cryptographic signatures to protect the integrity of the SWID tag. 2781 In general, tags are signed by the tag creator (typically, although 2782 not exclusively, the vendor of the software component that the SWID 2783 tag identifies). Cryptographic signatures can make any modification 2784 of the tag detectable, which is especially important if the integrity 2785 of the tag is important, such as when the tag is providing reference 2786 integrity measurements for files. The ISO-19770-2:2015 XML schema 2787 uses XML DSIG to support cryptographic signatures. 2789 Signing CoSWID tags follows the procedues defined in CBOR Object 2790 Signing and Encryption [RFC8152]. A CoSWID tg MUST be wrapped in a 2791 COSE Single Signer Data Object (COSE_Sign1) that contains a single 2792 signature and MUST be signed by the tag creator. The following CDDL 2793 specification defines a restrictive subset of COSE header parameters 2794 that MUST be used in the protected header. 2796 COSE-Sign1-coswid = [ 2797 protected: bstr .cbor protected-signed-coswid-header, 2798 unprotected: unprotected-signed-coswid-header, 2799 payload: bstr .cbor payload, 2800 signature: bstr, 2801 ] 2803 cose-label = int / tstr 2804 cose-values = any 2806 protected-signed-coswid-header = { 2807 1 => int, ; algorithm identifier 2808 3 => "application/swid+cbor", 2809 4 => bstr, ; key identifier 2810 * cose-label => cose-values, 2811 } 2813 unprotected-signed-coswid-header = { 2814 * cose-label => cose-values, 2815 } 2817 The COSE_Sign structure that allows for more than one signature to be 2818 applied to a CoSWID tag MAY be used. The corresponding usage 2819 scenarios are domain-specific and require well-specified application 2820 guidance. 2822 COSE-Sign-coswid = [ 2823 protected: bstr .cbor protected-signed-coswid-header1, 2824 unprotected: unprotected-signed-coswid-header, 2825 payload: bstr .cbor payload, 2826 signature: [ * COSE_Signature ], 2827 ] 2829 protected-signed-coswid-header1 = { 2830 3 => "application/swid+cbor", 2831 * cose-label => cose-values, 2832 } 2834 protected-signature-coswid-header = { 2835 1 => int, ; algorithm identifier 2836 4 => bstr, ; key identifier 2837 * cose-label => cose-values, 2838 } 2840 unprotected-sign-coswid-header = { 2841 * cose-label => cose-values, 2842 } 2844 COSE_Signature = [ 2845 protected: bstr .cbor protected-signature-coswid-header, 2846 unprotected: unprotected-sign-coswid-header, 2847 signature : bstr 2848 ] 2850 Additionally, the COSE Header counter signature MAY be used as an 2851 attribute in the unprotected header map of the COSE envelope of a 2852 CoSWID. The application of counter signing enables second parties to 2853 provide a signature on a signature allowing for a proof that a 2854 signature existed at a given time (i.e., a timestamp). 2856 8. Tagged CoSWID Tags 2858 This specification allows for tagged and untagged CBOR data items 2859 that are CoSWID tags. Consecutively, the CBOR tag for CoSWID tags 2860 defined in Table 21 SHOULD be used in conjunction with CBOR data 2861 items that are a CoSWID tags. Other CBOR tags MUST NOT be used with 2862 a CBOR data item that is a CoSWID tag. If tagged, both signed and 2863 unsigned CoSWID tags MUST use the CoSWID CBOR tag. In case a signed 2864 CoSWID is tagged, a CoSWID CBOR tag MUST be appended before the COSE 2865 envelope whether it is a COSE_Untagged_Message or a 2866 COSE_Tagged_Message. In case an unsigned CoSWID is tagged, a CoSWID 2867 CBOR tag MUST be appended before the CBOR data item that is the 2868 CoSWID tag. 2870 coswid = unsigned-coswid / signed-coswid 2871 unsigned-coswid = concise-swid-tag / tagged-coswid 2872 signed-coswid1 = signed-coswid-for 2873 signed-coswid = signed-coswid1 / tagged-coswid 2875 tagged-coswid = #6.1398229316(T) 2877 signed-coswid-for = #6.18(COSE-Sign1-coswid) 2878 / #6.98(COSE-Sign-coswid) 2880 While this specification allows for a tagged CoSWID tag to reside in 2881 a COSE envelope that is also tagged with a CoSWID CBOR tag, redundant 2882 use of tags SHOULD be avoided. 2884 9. Security Considerations 2886 The following security considerations for use of CoSWID tags focus 2887 on: 2889 * ensuring the integrity and authenticity of a CoSWID tag 2891 * the application of CoSWID tags to address security challenges 2892 related to unmanaged or unpatched software 2894 * reducing the potential for unintended disclosure of a device's 2895 software load 2897 A tag is considered "authoritative" if the CoSWID tag was created by 2898 the software provider. An authoritative CoSWID tag contains 2899 information about a software component provided by the maintainer of 2900 the software component, who is expected to be an expert in their own 2901 software. Thus, authoritative CoSWID tags can be trusted to 2902 represent authoritative information about the software component. 2904 A signed CoSWID tag (see Section 7) whose signature has been 2905 validated can be relied upon to be unchanged since it was signed. By 2906 contrast, the data contained in unsigned tags cannot be trusted to be 2907 unmodified. 2909 When an authoritative tag is signed, the software provider can be 2910 authenticated as the originator of the signature. A trustworthy 2911 association between the signature and the originator of the signature 2912 can be established via trust anchors. A certification path between a 2913 trust anchor and a certificate including a pub-key enabling the 2914 validation of a tag signature can realize the assessment of 2915 trustworthiness of an authoritative tag. Having a signed 2916 authoritative CoSWID tag can be useful when the information in the 2917 tag needs to be trusted, such as when the tag is being used to convey 2918 reference integrity measurements for software components. 2920 CoSWID tags are intended to contain public information about software 2921 components and, as such, the contents of a CoSWID tag does not need 2922 to be protected against unintended disclosure on an endpoint. 2924 CoSWID tags are intended to be easily discoverable by authorized 2925 applications and users on an endpoint in order to make it easy to 2926 determine the tagged software load. Access to the collection of an 2927 endpoint's SWID tags needs to be appropriately controlled to 2928 authorized applications and users using an appropriate access control 2929 mechanism. 2931 CoSWID tags are designed to be easily added and removed from an 2932 endpoint along with the installation or removal of software 2933 components. On endpoints where addition or removal of software 2934 components is tightly controlled, the addition or removal of SWID 2935 tags can be similarly controlled. On more open systems, where many 2936 users can manage the software inventory, CoSWID tags can be easier to 2937 add or remove. On such systems, it can be possible to add or remove 2938 CoSWID tags in a way that does not reflect the actual presence or 2939 absence of corresponding software components. Similarly, not all 2940 software products automatically install CoSWID tags, so products can 2941 be present on an endpoint without providing a corresponding SWID tag. 2942 As such, any collection of CoSWID tags cannot automatically be 2943 assumed to represent either a complete or fully accurate 2944 representation of the software inventory of the endpoint. However, 2945 especially on endpoint devices that more strictly control the ability 2946 to add or remove applications, CoSWID tags are an easy way to provide 2947 an preliminary understanding of that endpoint's software inventory. 2949 Any report of an endpoint's CoSWID tag collection provides 2950 information about the software inventory of that endpoint. If such a 2951 report is exposed to an attacker, this can tell them which software 2952 products and versions thereof are present on the endpoint. By 2953 examining this list, the attacker might learn of the presence of 2954 applications that are vulnerable to certain types of attacks. As 2955 noted earlier, CoSWID tags are designed to be easily discoverable by 2956 an endpoint, but this does not present a significant risk since an 2957 attacker would already need to have access to the endpoint to view 2958 that information. However, when the endpoint transmits its software 2959 inventory to another party, or that inventory is stored on a server 2960 for later analysis, this can potentially expose this information to 2961 attackers who do not yet have access to the endpoint. For this 2962 reason, it is important to protect the confidentiality of CoSWID tag 2963 information that has been collected from an endpoint in transit and 2964 at rest, not because those tags individually contain sensitive 2965 information, but because the collection of CoSWID tags and their 2966 association with an endpoint reveals information about that 2967 endpoint's attack surface. 2969 Finally, both the ISO-19770-2:2015 XML schema SWID definition and the 2970 CoSWID CDDL specification allow for the construction of "infinite" 2971 tags with link item loops or tags that contain malicious content with 2972 the intent of creating non-deterministic states during validation or 2973 processing of those tags. While software providers are unlikely to 2974 do this, CoSWID tags can be created by any party and the CoSWID tags 2975 collected from an endpoint could contain a mixture of vendor and non- 2976 vendor created tags. For this reason, a CoSWID tag might contain 2977 potentially malicious content. Input sanitization and loop detection 2978 are two ways that implementations can address this concern. 2980 10. Acknowledgments 2982 This document draws heavily on the concepts defined in the ISO/IEC 2983 19770-2:2015 specification. The authors of this document are 2984 grateful for the prior work of the 19770-2 contributors. 2986 We are also grateful to the careful reviews provided by ... 2988 11. Change Log 2990 [THIS SECTION TO BE REMOVED BY THE RFC EDITOR.] 2992 Changes from version 12 to version 14: 2994 * Moved key identifier to protected COSE header 2996 * Fixed index reference for hash 2998 * Removed indirection of CDDL type definition for filesystem-item 3000 * Fixed quantity of resource and process 3002 * Updated resource-collection 3004 * Renamed socket name in software-meta to be consistent in naming 3005 * Aligned excerpt examples in I-D text with full CDDL 3007 * Fixed titels where title was referring to group instead of map 3009 * Added missig date in SEMVER 3011 * Fixed root cardinality for file and directory, etc. 3013 * Transformed path-elements-entry from map to group for re-usability 3015 * Scrubbed IANA Section 3017 * Removed redundant supplemental rule 3019 * Aligned discrepancy with ISO spec. 3021 * Addressed comments on typos. 3023 * Fixed kramdown nits and BCP reference. 3025 * Addressed comments from WGLC reviewers. 3027 Changes in version 12: 3029 * Addressed a bunch of minor editorial issues based on WGLC 3030 feedback. 3032 * Added text about the use of UTF-8 in CoSWID. 3034 * Adjusted tag-id to allow for a UUID to be provided as a bstr. 3036 * Cleaned up descriptions of index ranges throughout the document, 3037 removing discussion of 8 bit, 16 bit, etc. 3039 * Adjusted discussion of private use ranges to use negative integer 3040 values and to be more clear throughout the document. 3042 * Added discussion around resolving overlapping value spaces for 3043 version schemes. 3045 * Added a set of expert review guidelines for new IANA registries 3046 created by this document. 3048 * Added new registrations for the "swid" and "swidpath" URI schemes, 3049 and for using CoSWID with SWIMA. 3051 Changes from version 03 to version 11: 3053 * Reduced representation complexity of the media-entry type and 3054 removed the Section describing the older data structure. 3056 * Added more signature schemes from COSE 3058 * Included a minimal required set of normative language 3060 * Reordering of attribute name to integer label by priority 3061 according to semantics. 3063 * Added an IANA registry for CoSWID items supporting future 3064 extension. 3066 * Cleaned up IANA registrations, fixing some inconsistencies in the 3067 table labels. 3069 * Added additional CDDL sockets for resource collection entries 3070 providing for additional extension points to address future SWID/ 3071 CoSWID extensions. 3073 * Updated Section on extension points to address new CDDL sockets 3074 and to reference the new IANA registry for items. 3076 * Removed unused references and added new references to address 3077 placeholder comments. 3079 * Added table with semantics for the link ownership item. 3081 * Clarified language, made term use more consistent, fixed 3082 references, and replacing lowercase RFC2119 keywords. 3084 Changes from version 02 to version 03: 3086 * Updated core CDDL including the CDDL design pattern according to 3087 RFC 8428. 3089 Changes from version 01 to version 02: 3091 * Enforced a more strict separation between the core CoSWID 3092 definition and additional usage by moving content to corresponding 3093 appendices. 3095 * Removed artifacts inherited from the reference schema provided by 3096 ISO (e.g. NMTOKEN(S)) 3098 * Simplified the core data definition by removing group and type 3099 choices where possible 3101 * Minor reordering of map members 3103 * Added a first extension point to address requested flexibility for 3104 extensions beyond the any-element 3106 Changes from version 00 to version 01: 3108 * Ambiguity between evidence and payload eliminated by introducing 3109 explicit members (while still 3111 * allowing for "empty" SWID tags) 3113 * Added a relatively restrictive COSE envelope using cose_sign1 to 3114 define signed CoSWID (single signer only, at the moment) 3116 * Added a definition how to encode hashes that can be stored in the 3117 any-member using existing IANA tables to reference hash-algorithms 3119 Changes since adopted as a WG I-D -00: 3121 * Removed redundant any-attributes originating from the ISO- 3122 19770-2:2015 XML schema definition 3124 * Fixed broken multi-map members 3126 * Introduced a more restrictive item (any-element-map) to represent 3127 custom maps, increased restriction on types for the any-attribute, 3128 accordingly 3130 * Fixed X.1520 reference 3132 * Minor type changes of some attributes (e.g. NMTOKENS) 3134 * Added semantic differentiation of various name types (e,g. fs- 3135 name) 3137 Changes from version 06 to version 07: 3139 * Added type choices/enumerations based on textual definitions in 3140 19770-2:2015 3142 * Added value registry request 3144 * Added media type registration request 3146 * Added content format registration request 3148 * Added CBOR tag registration request 3149 * Removed RIM appendix to be addressed in complementary draft 3151 * Removed CWT appendix 3153 * Flagged firmware resource collection appendix for revision 3155 * Made use of terminology more consistent 3157 * Better defined use of extension points in the CDDL 3159 * Added definitions for indexed values 3161 * Added IANA registry for Link use indexed values 3163 Changes from version 05 to version 06: 3165 * Improved quantities 3167 * Included proposals for implicit enumerations that were NMTOKENS 3169 * Added extension points 3171 * Improved exemplary firmware-resource extension 3173 Changes from version 04 to version 05: 3175 * Clarified language around SWID and CoSWID to make more consistent 3176 use of these terms. 3178 * Added language describing CBOR optimizations for single vs. arrays 3179 in the model front matter. 3181 * Fixed a number of grammatical, spelling, and wording issues. 3183 * Documented extension points that use CDDL sockets. 3185 * Converted IANA registration tables to markdown tables, reserving 3186 the 0 value for use when a value is not known. 3188 * Updated a number of references to their current versions. 3190 Changes from version 03 to version 04: 3192 * Re-index label values in the CDDL. 3194 * Added a Section describing the CoSWID model in detail. 3196 * Created IANA registries for entity-role and version-scheme 3197 Changes from version 02 to version 03: 3199 * Updated CDDL to allow for a choice between a payload or evidence 3201 * Re-index label values in the CDDL. 3203 * Added item definitions 3205 * Updated references for COSE, CBOR Web Token, and CDDL. 3207 Changes from version 01 to version 02: 3209 * Added extensions for Firmware and CoSWID use as Reference 3210 Integrity Measurements (CoSWID RIM) 3212 * Changes meta handling in CDDL from use of an explicit use of items 3213 to a more flexible unconstrained collection of items. 3215 * Added Sections discussing use of COSE Signatures and CBOR Web 3216 Tokens 3218 Changes from version 00 to version 01: 3220 * Added CWT usage for absolute SWID paths on a device 3222 * Fixed cardinality of type-choices including arrays 3224 * Included first iteration of firmware resource-collection 3226 12. References 3228 12.1. Normative References 3230 [BCP178] Saint-Andre, P., Crocker, D., and M. Nottingham, 3231 "Deprecating the "X-" Prefix and Similar Constructs in 3232 Application Protocols", BCP 178, RFC 6648, 3233 DOI 10.17487/RFC6648, June 2012, 3234 . 3236 [BCP26] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 3237 Writing an IANA Considerations Section in RFCs", BCP 26, 3238 RFC 8126, DOI 10.17487/RFC8126, June 2017, 3239 . 3241 [NIHAR] "IANA Named Information Hash Algorithm Registry", n.d., 3242 . 3245 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 3246 Requirement Levels", BCP 14, RFC 2119, 3247 DOI 10.17487/RFC2119, March 1997, 3248 . 3250 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 3251 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 3252 2003, . 3254 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 3255 Resource Identifier (URI): Generic Syntax", STD 66, 3256 RFC 3986, DOI 10.17487/RFC3986, January 2005, 3257 . 3259 [RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network 3260 Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008, 3261 . 3263 [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 3264 Specifications: ABNF", STD 68, RFC 5234, 3265 DOI 10.17487/RFC5234, January 2008, 3266 . 3268 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 3269 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 3270 September 2009, . 3272 [RFC5892] Faltstrom, P., Ed., "The Unicode Code Points and 3273 Internationalized Domain Names for Applications (IDNA)", 3274 RFC 5892, DOI 10.17487/RFC5892, August 2010, 3275 . 3277 [RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object 3278 Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, 3279 October 2013, . 3281 [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained 3282 Application Protocol (CoAP)", RFC 7252, 3283 DOI 10.17487/RFC7252, June 2014, 3284 . 3286 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 3287 Writing an IANA Considerations Section in RFCs", BCP 26, 3288 RFC 8126, DOI 10.17487/RFC8126, June 2017, 3289 . 3291 [RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)", 3292 RFC 8152, DOI 10.17487/RFC8152, July 2017, 3293 . 3295 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 3296 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 3297 May 2017, . 3299 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 3300 DOI 10.17487/RFC8288, October 2017, 3301 . 3303 [RFC8412] Schmidt, C., Haynes, D., Coffin, C., Waltermire, D., and 3304 J. Fitzgerald-McKay, "Software Inventory Message and 3305 Attributes (SWIMA) for PA-TNC", RFC 8412, 3306 DOI 10.17487/RFC8412, July 2018, 3307 . 3309 [RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data 3310 Definition Language (CDDL): A Notational Convention to 3311 Express Concise Binary Object Representation (CBOR) and 3312 JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610, 3313 June 2019, . 3315 [SAM] "Information technology - Software asset management - Part 3316 5: Overview and vocabulary", ISO/IEC 19770-5:2015, 15 3317 November 2013. 3319 [SEMVER] Preston-Werner, T., "Semantic Versioning 2.0.0", 3320 . 3322 [SWID] "Information technology - Software asset management - Part 3323 2: Software identification tag", ISO/IEC 19770-2:2015, 1 3324 October 2015. 3326 [UNSPSC] "United Nations Standard Products and Services Code", 26 3327 October 2020, . 3329 [W3C.REC-css3-mediaqueries-20120619] 3330 Rivoal, F., "Media Queries", World Wide Web Consortium 3331 Recommendation REC-css3-mediaqueries-20120619, 19 June 3332 2012, . 3335 [W3C.REC-xmlschema-2-20041028] 3336 Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes 3337 Second Edition", World Wide Web Consortium Recommendation 3338 REC-xmlschema-2-20041028, 28 October 2004, 3339 . 3341 [W3C.REC-xpath20-20101214] 3342 Berglund, A., Boag, S., Chamberlin, D., Fernandez, M., 3343 Kay, M., Robie, J., and J. Simeon, "XML Path Language 3344 (XPath) 2.0 (Second Edition)", World Wide Web Consortium 3345 Recommendation REC-xpath20-20101214, 14 December 2010, 3346 . 3348 [X.1520] "Recommendation ITU-T X.1520 (2014), Common 3349 vulnerabilities and exposures", 20 April 2011. 3351 12.2. Informative References 3353 [CamelCase] 3354 "UpperCamelCase", 29 August 2014, 3355 . 3357 [I-D.ietf-rats-architecture] 3358 Birkholz, H., Thaler, D., Richardson, M., Smith, N., and 3359 W. Pan, "Remote Attestation Procedures Architecture", Work 3360 in Progress, Internet-Draft, draft-ietf-rats-architecture- 3361 10, 9 February 2021, . 3364 [KebabCase] 3365 "KebabCase", 18 December 2014, 3366 . 3368 [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between 3369 Information Models and Data Models", RFC 3444, 3370 DOI 10.17487/RFC3444, January 2003, 3371 . 3373 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 3374 Unique IDentifier (UUID) URN Namespace", RFC 4122, 3375 DOI 10.17487/RFC4122, July 2005, 3376 . 3378 [RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource- 3379 Oriented Lightweight Information Exchange (ROLIE)", 3380 RFC 8322, DOI 10.17487/RFC8322, February 2018, 3381 . 3383 [RFC8520] Lear, E., Droms, R., and D. Romascanu, "Manufacturer Usage 3384 Description Specification", RFC 8520, 3385 DOI 10.17487/RFC8520, March 2019, 3386 . 3388 [SWID-GUIDANCE] 3389 Waltermire, D., Cheikes, B.A., Feldman, L., and G. Witte, 3390 "Guidelines for the Creation of Interoperable Software 3391 Identification (SWID) Tags", NISTIR 8060, April 2016, 3392 . 3394 Authors' Addresses 3396 Henk Birkholz 3397 Fraunhofer SIT 3398 Rheinstrasse 75 3399 64295 Darmstadt 3400 Germany 3402 Email: henk.birkholz@sit.fraunhofer.de 3404 Jessica Fitzgerald-McKay 3405 National Security Agency 3406 9800 Savage Road 3407 Ft. Meade, Maryland 3408 United States of America 3410 Email: jmfitz2@cyber.nsa.gov 3412 Charles Schmidt 3413 The MITRE Corporation 3414 202 Burlington Road 3415 Bedford, Massachusetts 01730 3416 United States of America 3418 Email: cmschmidt@mitre.org 3420 David Waltermire 3421 National Institute of Standards and Technology 3422 100 Bureau Drive 3423 Gaithersburg, Maryland 20877 3424 United States of America 3426 Email: david.waltermire@nist.gov