idnits 2.17.1 draft-ietf-sacm-coswid-18.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: ---------------------------------------------------------------------------- == There is 1 instance of lines with non-ascii characters in the document. 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 (12 July 2021) is 1012 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 2027, but not defined == Missing Reference: 'RFC-AAAA' is mentioned on line 2710, but not defined -- 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-12 Summary: 1 error (**), 0 flaws (~~), 6 warnings (==), 6 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: 13 January 2022 National Security Agency 6 C. Schmidt 7 The MITRE Corporation 8 D. Waltermire 9 NIST 10 12 July 2021 12 Concise Software Identification Tags 13 draft-ietf-sacm-coswid-18 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 13 January 2022. 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 . . . . . . . . . . . . . . . . . . . . 46 88 5.2. "swidpath" URI Scheme . . . . . . . . . . . . . . . . . . 46 89 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 47 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 . . . . . . . . . . . . . . 51 95 6.2.4. Software Tag Version Scheme Values Registry . . . . . 52 96 6.2.5. Software Tag Entity Role Values Registry . . . . . . 53 97 6.2.6. Software Tag Link Ownership Values Registry . . . . . 55 98 6.2.7. Software Tag Link Relationship Values Registry . . . 56 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. URI-scheme swid . . . . . . . . . . . . . . . . . . . 61 105 6.6.2. URI-scheme swidpath . . . . . . . . . . . . . . . . . 61 106 6.7. CoSWID Model for use in SWIMA Registration . . . . . . . 62 107 7. Signed CoSWID Tags . . . . . . . . . . . . . . . . . . . . . 63 108 8. Tagged CoSWID Tags . . . . . . . . . . . . . . . . . . . . . 65 109 9. Security Considerations . . . . . . . . . . . . . . . . . . . 65 110 10. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 68 111 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 73 112 11.1. Normative References . . . . . . . . . . . . . . . . . . 73 113 11.2. Informative References . . . . . . . . . . . . . . . . . 76 114 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 77 115 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . 77 116 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 77 118 1. Introduction 120 SWID tags, as defined in ISO-19770-2:2015 [SWID], provide a 121 standardized XML-based record format that identifies and describes a 122 specific release of software, a patch, or an installation bundle, 123 which are referred to as software components in this document. 124 Different software components, and even different releases of a 125 particular software component, each have a different SWID tag record 126 associated with them. SWID tags are meant to be flexible and able to 127 express a broad set of metadata about a software component. 129 SWID tags are used to support a number of processes including but not 130 limited to: 132 * Software Inventory Management, a part of a Software Asset 133 Management [SAM] process, which requires an accurate list of 134 discernible deployed software components. 136 * Vulnerability Assessment, which requires a semantic link between 137 standardized vulnerability descriptions and software components 138 installed on IT-assets [X.1520]. 140 * Remote Attestation, which requires a link between reference 141 integrity measurements (RIM) and Attester-produced event logs that 142 complement attestation Evidence [I-D.ietf-rats-architecture]. 144 While there are very few required fields in SWID tags, there are many 145 optional fields that support different uses. A SWID tag consisting 146 of only required fields might be a few hundred bytes in size; 147 however, a tag containing many of the optional fields can be many 148 orders of magnitude larger. Thus, real-world instances of SWID tags 149 can be fairly large, and the communication of SWID tags in usage 150 scenarios, such as those described earlier, can cause a large amount 151 of data to be transported. This can be larger than acceptable for 152 constrained devices and networks. Concise SWID (CoSWID) tags 153 significantly reduce the amount of data transported as compared to a 154 typical SWID tag through the use of the Concise Binary Object 155 Representation (CBOR) [RFC8949]. 157 Size comparisons between XML SWID and CoSWID mainly depend on domain- 158 specific applications and the complexity of attributes used in 159 instances. While the values stored in CoSWID are often unchanged and 160 therefore not reduced in size compared to an XML SWID, the 161 scaffolding that the CoSWID encoding represents is significantly 162 smaller by taking up 10 percent or less in size. This effect is 163 visible in instances sizes, which can benefit from a 50 percent to 85 164 percent reduction of size in generic usage scenarios. Additional 165 size reduction is enabled with respect to the memory footprint of XML 166 parsing/validation as well as the reduction of stack sizes where XML 167 processing is now obsolete. 169 In a CoSWID, the human-readable labels of SWID data items are 170 replaced with more concise integer labels (indices). This approach 171 allows SWID and CoSWID to share a common implicit information model, 172 with CoSWID providing an alternate data model [RFC3444]. While SWID 173 and CoSWID are intended to share the same implicit information model, 174 this specification does not define this information model, or a 175 mapping between the the two data formats. While an attempt to align 176 SWID and CoSWID tags has been made here, future revisions of ISO/IEC 177 19770-2:2015 or this specification might cause this implicit 178 information model to diverge, since these specifications are 179 maintained by different standards groups. 181 The use of CBOR to express SWID information in CoSWID tags allows 182 both CoSWID and SWID tags to be part of an enterprise security 183 solution for a wider range of endpoints and environments. 185 1.1. The SWID and CoSWID Tag Lifecycle 187 In addition to defining the format of a SWID tag record, ISO/IEC 188 19770-2:2015 defines requirements concerning the SWID tag lifecycle. 189 Specifically, when a software component is installed on an endpoint, 190 that software component's SWID tag is also installed. Likewise, when 191 the software component is uninstalled or replaced, the SWID tag is 192 deleted or replaced, as appropriate. As a result, ISO/IEC 193 19770-2:2015 describes a system wherein there is a correspondence 194 between the set of installed software components on an endpoint, and 195 the presence of the corresponding SWID tags for these components on 196 that endpoint. CoSWIDs share the same lifecycle requirements as a 197 SWID tag. 199 The SWID specification and supporting guidance provided in NIST 200 Internal Report (NISTIR) 8060: Guidelines for the Creation of 201 Interoperable SWID Tags [SWID-GUIDANCE] defines four types of SWID 202 tags: primary, patch, corpus, and supplemental. The following text 203 is paraphrased from these sources. 205 1. Primary Tag - A SWID or CoSWID tag that identifies and describes 206 an installed software component on an endpoint. A primary tag is 207 intended to be installed on an endpoint along with the 208 corresponding software component. 210 2. Patch Tag - A SWID or CoSWID tag that identifies and describes an 211 installed patch that has made incremental changes to a software 212 component installed on an endpoint. A patch tag is intended to 213 be installed on an endpoint along with the corresponding software 214 component patch. 216 3. Corpus Tag - A SWID or CoSWID tag that identifies and describes 217 an installable software component in its pre-installation state. 218 A corpus tag can be used to represent metadata about an 219 installation package or installer for a software component, a 220 software update, or a patch. 222 4. Supplemental Tag - A SWID or CoSWID tag that allows additional 223 information to be associated with a referenced SWID tag. This 224 allows tools and users to record their own metadata about a 225 software component without modifying SWID primary or patch tags 226 created by a software provider. 228 The type of a tag is determined by specific data elements, which are 229 discussed in Section 3, which also provides normative language for 230 CoSWID semantics that implement this lifecycle. The following 231 information helps to explain how these semantics apply to use of a 232 CoSWID tag. 234 Corpus, primary, and patch tags have similar functions in that 235 they describe the existence and/or presence of different types of 236 software components (e.g., software installers, software 237 installations, software patches), and, potentially, different 238 states of these software components. Supplemental tags have the 239 same structure as other tags, but are used to provide information 240 not contained in the referenced corpus, primary, and patch tags. 241 All four tag types come into play at various points in the 242 software lifecycle and support software management processes that 243 depend on the ability to accurately determine where each software 244 component is in its lifecycle. 246 +------------+ 247 v | 248 Software Software Software Software Software 249 Deployment -> Installation -> Patching -> Upgrading -> Removal 251 Corpus Primary Primary xPrimary xPrimary 252 Supplemental Supplemental Supplemental xSupplemental xSupplemental 253 Patch xPatch 254 Primary 255 Supplemental 257 Figure 1: Use of Tag Types in the Software Lifecycle 259 Figure 1 illustrates the steps in the software lifecycle and the 260 relationships among those lifecycle events supported by the four 261 types of SWID and CoSWID tags. A detailed description of the four 262 tags types is provided in Section 2.3. The figure identifies the 263 types of tags that are used in each lifecycle event. 265 There are many ways in which software tags might be managed for the 266 host the software is installed on. For example, software tags could 267 be made available on the host or to an external software manager when 268 storage is limited on the host. 270 In these cases the host or external software manager is responsible 271 for management of the tags, including deployment and removal of the 272 tags as indicated by the above lifecycle. Tags are deployed and 273 previously deployed tags that are typically removed (indicated by an 274 "x" prefix) at each lifecycle stage, as follows: 276 - Software Deployment. Before the software component is 277 installed (i.e., pre-installation), and while the product is 278 being deployed, a corpus tag provides information about the 279 installation files and distribution media (e.g., CD/DVD, 280 distribution package). 282 Corpus tags are not actually deployed on the target system but are 283 intended to support deployment procedures and their dependencies at 284 install-time, such as to verify the installation media. 286 - Software Installation. A primary tag will be installed with 287 the software component (or subsequently created) to uniquely 288 identify and describe the software component. Supplemental 289 tags are created to augment primary tags with additional site- 290 specific or extended information. While not illustrated in the 291 figure, patch tags can also be installed during software 292 installation to provide information about software fixes 293 deployed along with the base software installation. 295 - Software Patching. A new patch tag is provided, when a patch 296 is applied to the software component, supplying details about 297 the patch and its dependencies. While not illustrated in the 298 figure, a corpus tag can also provide information about the 299 patch installer and patching dependencies that need to be 300 installed before the patch. 302 - Software Upgrading. As a software component is upgraded to a 303 new version, new primary and supplemental tags replace existing 304 tags, enabling timely and accurate tracking of updates to 305 software inventory. While not illustrated in the figure, a 306 corpus tag can also provide information about the upgrade 307 installer and dependencies that need to be installed before the 308 upgrade. 310 Note: In the context of software tagging software patching and 311 updating differ in an important way. When installing a patch, a set 312 of file modifications are made to pre-installed software which do not 313 alter the version number or the descriptive metadata of an installed 314 software component. An update can also make a set of file 315 modifications, but the version number or the descriptive metadata of 316 an installed software component are changed. 318 - Software Removal. Upon removal of the software component, 319 relevant SWID tags are removed. This removal event can trigger 320 timely updates to software inventory reflecting the removal of 321 the product and any associated patch or supplemental tags. 323 As illustrated in the figure, supplemental tags can be associated 324 with any corpus, primary, or patch tag to provide additional metadata 325 about an installer, installed software, or installed patch 326 respectively. 328 Understanding the use of CoSWIDs in the software lifecycle provides a 329 basis for understanding the information provided in a CoSWID and the 330 associated semantics of this information. Each of the different SWID 331 and CoSWID tag types provide different sets of information. For 332 example, a "corpus tag" is used to describe a software component's 333 installation image on an installation media, while a "patch tag" is 334 meant to describe a patch that modifies some other software 335 component. 337 1.2. Concise SWID Format 339 This document defines the CoSWID tag format, which is based on CBOR. 340 CBOR-based CoSWID tags offer a more concise representation of SWID 341 information as compared to the XML-based SWID tag representation in 342 ISO-19770-2:2015. The structure of a CoSWID is described via the 343 Concise Data Definition Language (CDDL) [RFC8610]. The resulting 344 CoSWID data definition is aligned to the information able to be 345 expressed with the XML schema definition of ISO-19770-2:2015 [SWID]. 346 This alignment allows both SWID and CoSWID tags to represent a common 347 set of software component information and allows CoSWID tags to 348 support the same uses as a SWID tag. 350 The vocabulary, i.e., the CDDL names of the types and members used in 351 the CoSWID CDDL specification, are mapped to more concise labels 352 represented as small integer values (indices). The names used in the 353 CDDL specification and the mapping to the CBOR representation using 354 integer indices is based on the vocabulary of the XML attribute and 355 element names defined in ISO/IEC 19770-2:2015. 357 1.3. Requirements Notation 359 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 360 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 361 "OPTIONAL" in this document are to be interpreted as described in 362 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 363 capitals, as shown here. 365 2. Concise SWID Data Definition 367 The following describes the general rules and processes for encoding 368 data using CDDL representation. Prior familiarity with CBOR and CDDL 369 concepts will be helpful in understanding this CoSWID specification. 371 This section describes the conventions by which a CoSWID is 372 represented in the CDDL structure. The CamelCase [CamelCase] 373 notation used in the XML schema definition is changed to a hyphen- 374 separated notation [KebabCase] (e.g. ResourceCollection is named 375 resource-collection) in the CoSWID CDDL specification. This 376 deviation from the original notation used in the XML representation 377 reduces ambiguity when referencing certain attributes in 378 corresponding textual descriptions. An attribute referred to by its 379 name in CamelCase notation explicitly relates to XML SWID tags; an 380 attribute referred to by its name in KebabCase notation explicitly 381 relates to CBOR CoSWID tags. This approach simplifies the 382 composition of further work that reference both XML SWID and CBOR 383 CoSWID documents. 385 In most cases, mapping attribute names between SWID and CoSWID can be 386 done automatically by converting between CamelCase and KebabCase 387 attribute names. However, some CoSWID CDDL attribute names show 388 greater variation relative to their corresponding SWID XML Schema 389 attributes. This is done when the change improves clarity in the 390 CoSWID specification. For example the "name" and "version" SWID 391 fields corresponds to the "software-name" and "software-version" 392 CoSWID fields, respectively. As such, it is not always possible to 393 mechanically translate between corresponding attribute names in the 394 two formats. In such cases, a manual mapping will need to be used. 395 These cases are specifically noted in this and subsequent sections 396 using an [W3C.REC-xpath20-20101214] where a manual mapping is needed. 398 The 57 human-readable text labels of the CDDL-based CoSWID vocabulary 399 are mapped to integer indices via a block of rules at the bottom of 400 the definition. This allows a more concise integer-based form to be 401 stored or transported, as compared to the less efficient text-based 402 form of the original vocabulary. 404 Through use of CDDL-based integer labels, CoSWID allows for future 405 expansion in subsequent revisions of this specification and through 406 extensions (see Section 2.2). New constructs can be associated with 407 a new integer index. A deprecated construct can be replaced by a new 408 construct with a new integer index. An implementation can use these 409 integer indexes to identify the construct to parse. The CoSWID Items 410 registry, defined in Section 6.1, is used to ensure that new 411 constructs are assigned a unique index value on a first-come, first- 412 served basis. This approach avoids the need to have an explicit 413 CoSWID version. 415 The root of the CDDL specification provided by this document is the 416 rule "coswid" (as defined in Section 8): 418 start = coswid 420 In CBOR, an array is encoded using bytes that identify the array, and 421 the array's length or stop point (see [RFC8949]). To make items that 422 support 1 or more values, the following CDDL notation is used. 424 _name_ = (_label_ => _data_ / [ 2* _data_ ]) 426 The CDDL rule above allows either a single data item or an array of 2 427 or more data values to be provided. When a singleton data value is 428 provided, the CBOR markers for the array, array length, and stop 429 point are not needed, saving bytes. When two or more data values are 430 provided, these values are encoded as an array. This modeling 431 pattern is used frequently in the CoSWID CDDL specification to allow 432 for more efficient encoding of singleton values. 434 Usage of this construct can be simplified using 436 one-or-more = T / [ 2* T ] 438 simplifying the above example to 440 _name_ = (_label_ => one-or-more<_data_>) 442 The following subsections describe the different parts of the CoSWID 443 model. 445 2.1. Character Encoding 447 The CDDL "text" type is represented in CBOR as a major type 3, which 448 represents "a string of Unicode characters that [are] encoded as 449 UTF-8 [RFC3629]" (see Section 3.1 of [RFC8949]). Thus both SWID and 450 CoSWID use UTF-8 for the encoding of characters in text strings. 452 To ensure that UTF-8 character strings are able to be encoded/decoded 453 and exchanged interoperably, text strings in CoSWID MUST be encoded 454 consistent with the Net-Unicode definition defined in [RFC5198]. 456 All names registered with IANA according to requirements in 457 Section 6.2 also MUST be valid according to the XML Schema NMToken 458 data type (see [W3C.REC-xmlschema-2-20041028] Section 3.3.4) to 459 ensure compatibility with the SWID specification where these names 460 are used. 462 2.2. Concise SWID Extensions 464 The CoSWID specification contains two features that are not included 465 in the SWID specification on which it is based. These features are: 467 * The explicit definition of types for some attributes in the ISO- 468 19770-2:2015 XML representation that are typically represented by 469 the "any attribute" in the SWID model. These are covered in 470 Section 2.5. 472 * The inclusion of extension points in the CoSWID specification 473 using CDDL sockets (see [RFC8610] Section 3.9). The use of CDDL 474 sockets allow for well-formed extensions to be defined in 475 supplementary CDDL descriptions that support additional uses of 476 CoSWID tags that go beyond the original scope of ISO-19770-2:2015 477 tags. This extension mechanism can also be used to update the 478 CoSWID format as revisions to ISO-19770-2 are published. 480 The following CDDL sockets (extension points) are defined in this 481 document, which allow the addition of new information structures to 482 their respective CDDL groups. 484 +=====================+===========================+===============+ 485 | Map Name | CDDL Socket | Defined in | 486 +=====================+===========================+===============+ 487 | concise-swid-tag | $$coswid-extension | Section 2.3 | 488 +---------------------+---------------------------+---------------+ 489 | entity-entry | $$entity-extension | Section 2.6 | 490 +---------------------+---------------------------+---------------+ 491 | link-entry | $$link-extension | Section 2.7 | 492 +---------------------+---------------------------+---------------+ 493 | software-meta-entry | $$software-meta-extension | Section 2.8 | 494 +---------------------+---------------------------+---------------+ 495 | file-entry | $$file-extension | Section 2.9.2 | 496 +---------------------+---------------------------+---------------+ 497 | directory-entry | $$directory-extension | Section 2.9.2 | 498 +---------------------+---------------------------+---------------+ 499 | process-entry | $$process-extension | Section 2.9.2 | 500 +---------------------+---------------------------+---------------+ 501 | resource-entry | $$resource-extension | Section 2.9.2 | 502 +---------------------+---------------------------+---------------+ 503 | payload-entry | $$payload-extension | Section 2.9.3 | 504 +---------------------+---------------------------+---------------+ 505 | evidence-entry | $$evidence-extension | Section 2.9.4 | 506 +---------------------+---------------------------+---------------+ 508 Table 1: CoSWID CDDL Group Extension Points 510 The CoSWID Items Registry defined in Section 6.1 provides a 511 registration mechanism allowing new items, and their associated index 512 values, to be added to the CoSWID model through the use of the CDDL 513 sockets described in the table above. This registration mechanism 514 provides for well-known index values for data items in CoSWID 515 extensions, allowing these index values to be recognized by 516 implementations supporting a given extension. 518 The following additional CDDL sockets are defined in this document to 519 allow for adding new values to corresponding type-choices (i.e. to 520 represent enumerations) via custom CDDL specifications. 522 +==================+=================+=============+ 523 | Enumeration Name | CDDL Socket | Defined in | 524 +==================+=================+=============+ 525 | version-scheme | $version-scheme | Section 4.1 | 526 +------------------+-----------------+-------------+ 527 | role | $role | Section 4.2 | 528 +------------------+-----------------+-------------+ 529 | ownership | $ownership | Section 4.3 | 530 +------------------+-----------------+-------------+ 531 | rel | $rel | Section 4.4 | 532 +------------------+-----------------+-------------+ 533 | use | $use | Section 4.5 | 534 +------------------+-----------------+-------------+ 536 Table 2: CoSWID CDDL Enumeration Extension Points 538 A number of CoSWID value registries are also defined in Section 6.2 539 that allow new values to be registered with IANA for the enumerations 540 above. This registration mechanism supports the definition of new 541 well-known index values and names for new enumeration values used by 542 CoSWID, which can also be used by other software tagging 543 specifications. This registration mechanism allows new standardized 544 enumerated values to be shared between multiple tagging 545 specifications (and associated implementations) over time. 547 2.3. The concise-swid-tag Map 549 The CDDL specification for the root concise-swid-tag map is as 550 follows and this rule and its constraints MUST be followed when 551 creating or validating a CoSWID tag: 553 concise-swid-tag = { 554 tag-id => text / bstr .size 16, 555 tag-version => integer, 556 ? corpus => bool, 557 ? patch => bool, 558 ? supplemental => bool, 559 software-name => text, 560 ? software-version => text, 561 ? version-scheme => $version-scheme, 562 ? media => text, 563 ? software-meta => one-or-more, 564 entity => one-or-more, 565 ? link => one-or-more, 566 ? payload-or-evidence, 567 * $$coswid-extension, 568 global-attributes, 569 } 571 payload-or-evidence //= ( payload => payload-entry ) 572 payload-or-evidence //= ( evidence => evidence-entry ) 574 tag-id = 0 575 software-name = 1 576 entity = 2 577 evidence = 3 578 link = 4 579 software-meta = 5 580 payload = 6 581 corpus = 8 582 patch = 9 583 media = 10 584 supplemental = 11 585 tag-version = 12 586 software-version = 13 587 version-scheme = 14 589 $version-scheme /= multipartnumeric 590 $version-scheme /= multipartnumeric-suffix 591 $version-scheme /= alphanumeric 592 $version-scheme /= decimal 593 $version-scheme /= semver 594 $version-scheme /= int / text 595 multipartnumeric = 1 596 multipartnumeric-suffix = 2 597 alphanumeric = 3 598 decimal = 4 599 semver = 16384 600 The following describes each member of the concise-swid-tag root map. 602 * global-attributes: A list of items including an optional language 603 definition to support the processing of text-string values and an 604 unbounded set of any-attribute items. Described in Section 2.5. 606 * tag-id (index 0): A 16 byte binary string or textual identifier 607 uniquely referencing a software component. The tag identifier 608 MUST be globally unique. If represented as a 16 byte binary 609 string, the identifier MUST be a valid universally unique 610 identifier as defined by [RFC4122]. There are no strict 611 guidelines on how this identifier is structured, but examples 612 include a 16 byte GUID (e.g. class 4 UUID) [RFC4122], or a text 613 string appended to a DNS domain name to ensure uniqueness across 614 organizations. 616 * tag-version (index 12): An integer value that indicate the 617 specific release revision of the tag. Typically, the initial 618 value of this field is set to 0 and the value is monotonically 619 increased for subsequent tags produced for the same software 620 component release. This value allows a CoSWID tag producer to 621 correct an incorrect tag previously released without indicating a 622 change to the underlying software component the tag represents. 623 For example, the tag version could be changed to add new metadata, 624 to correct a broken link, to add a missing payload entry, etc. 625 When producing a revised tag, the new tag-version value MUST be 626 greater than the old tag-version value. 628 * corpus (index 8): A boolean value that indicates if the tag 629 identifies and describes an installable software component in its 630 pre-installation state. Installable software includes a 631 installation package or installer for a software component, a 632 software update, or a patch. If the CoSWID tag represents 633 installable software, the corpus item MUST be set to "true". If 634 not provided, the default value MUST be considered "false". 636 * patch (index 9): A boolean value that indicates if the tag 637 identifies and describes an installed patch that has made 638 incremental changes to a software component installed on an 639 endpoint. If a CoSWID tag is for a patch, the patch item MUST be 640 set to "true". If not provided, the default value MUST be 641 considered "false". A patch item's value MUST NOT be set to 642 "true" if the installation of the associated software package 643 changes the version of a software component. 645 * supplemental (index 11): A boolean value that indicates if the tag 646 is providing additional information to be associated with another 647 referenced SWID or CoSWID tag. This allows tools and users to 648 record their own metadata about a software component without 649 modifying SWID primary or patch tags created by a software 650 provider. If a CoSWID tag is a supplemental tag, the supplemental 651 item MUST be set to "true". If not provided, the default value 652 MUST be considered "false". 654 * software-name (index 1): This textual item provides the software 655 component's name. This name is likely the same name that would 656 appear in a package management tool. This item maps to 657 '/SoftwareIdentity/@name' in [SWID]. 659 * software-version (index 13): A textual value representing the 660 specific release or development version of the software component. 661 This item maps to '/SoftwareIdentity/@version' in [SWID]. 663 * version-scheme (index 14): An integer or textual value 664 representing the versioning scheme used for the software-version 665 item. If an integer value is used it MUST be an index value in 666 the range -256 to 65535. Integer values in the range -256 to -1 667 are reserved for testing and use in closed environments (see 668 Section 6.2.2). Integer values in the range 0 to 65535 correspond 669 to registered entries in the IANA "Software Tag Version Scheme 670 Values" registry (see Section 6.2.4. If a string value is used it 671 MUST be a private use name as defined in Section 6.2.2. String 672 values based on a Version Scheme Name from the IANA "Software Tag 673 Version Scheme Values" registry MUST NOT be used, as these values 674 are less concise than their index value equivalent. 676 * media (index 10): This text value is a hint to the tag consumer to 677 understand what target platform this tag applies to. This item 678 item MUST be formatted as a query as defined by the W3C Media 679 Queries Recommendation (see [W3C.REC-css3-mediaqueries-20120619]). 680 Support for media queries are included here for interoperability 681 with [SWID], which does not provide any further requirements for 682 media query use. Thus, this specification does not clarify how a 683 media query is to be used for a CoSWID. 685 * software-meta (index 5): An open-ended map of key/value data 686 pairs. A number of predefined keys can be used within this item 687 providing for common usage and semantics across the industry. Use 688 of this map allows any additional attribute to be included in the 689 tag. It is expected that industry groups will use a common set of 690 attribute names to allow for interoperability within their 691 communities. Described in Section 2.8. This item maps to 692 '/SoftwareIdentity/Meta' in [SWID]. 694 * entity (index 2): Provides information about one or more 695 organizations responsible for producing the CoSWID tag, and 696 producing or releasing the software component referenced by this 697 CoSWID tag. Described in Section 2.6. 699 * link (index 4): Provides a means to establish relationship arcs 700 between the tag and another items. A given link can be used to 701 establish the relationship between tags or to reference another 702 resource that is related to the CoSWID tag, e.g. vulnerability 703 database association, ROLIE feed [RFC8322], MUD resource 704 [RFC8520], software download location, etc). This is modeled 705 after the HTML "link" element. Described in Section 2.7. 707 * payload (index 6): This item represents a collection of software 708 artifacts (described by child items) that compose the target 709 software. For example, these artifacts could be the files 710 included with an installer for a corpus tag or installed on an 711 endpoint when the software component is installed for a primary or 712 patch tag. The artifacts listed in a payload may be a superset of 713 the software artifacts that are actually installed. Based on user 714 selections at install time, an installation might not include 715 every artifact that could be created or executed on the endpoint 716 when the software component is installed or run. Described in 717 Section 2.9.3. 719 * evidence (index 3): This item can be used to record the results of 720 a software discovery process used to identify untagged software on 721 an endpoint or to represent indicators for why software is 722 believed to be installed on the endpoint. In either case, a 723 CoSWID tag can be created by the tool performing an analysis of 724 the software components installed on the endpoint. Described in 725 Section 2.9.4. 727 * $$coswid-extension: This CDDL socket is used to add new 728 information structures to the concise-swid-tag root map. See 729 Section 2.2. 731 2.4. concise-swid-tag Co-Constraints 733 The following co-constraints apply to the information provided in the 734 concise-swid-tag group. 736 * The patch and supplemental items MUST NOT both be set to "true". 738 * If the patch item is set to "true", the tag SHOULD contain at 739 least one link item (see Section 2.7) with both the rel item value 740 of "patches" and an href item specifying an association with the 741 software that was patched. 743 * If the supplemental item is set to "true", the tag SHOULD contain 744 at least one link item with both the rel item value of 745 "supplemental" and an href item specifying an association with the 746 software that is supplemented. 748 * If all of the corpus, patch, and supplemental items are "false", 749 or if the corpus item is set to "true", then a software-version 750 item MUST be included with a value set to the version of the 751 software component. This ensures that primary and corpus tags 752 have an identifiable software version. 754 2.5. The global-attributes Group 756 The global-attributes group provides a list of items, including an 757 optional language definition to support the processing of text-string 758 values, and an unbounded set of any-attribute items allowing for 759 additional items to be provided as a general point of extension in 760 the model. 762 The CDDL for the global-attributes follows: 764 global-attributes = ( 765 ? lang => text, 766 * any-attribute, 767 ) 769 any-attribute = ( 770 label => one-or-more / one-or-more 771 ) 773 label = text / int 775 The following describes each child item of this group. 777 * lang (index 15): A textual language tag that conforms with IANA 778 "Language Subtag Registry" [RFC5646]. The context of the 779 specified language applies to all sibling and descendant textual 780 values, unless a descendant object has defined a different 781 language tag. Thus, a new context is established when a 782 descendant object redefines a new language tag. All textual 783 values within a given context MUST be considered expressed in the 784 specified language. 786 * any-attribute: This sub-group provides a means to include 787 arbitrary information via label/index ("key") value pairs. Labels 788 can be either a single integer or text string. Values can be a 789 single integer, a text string, or an array of integers or text 790 strings. 792 2.6. The entity-entry Map 794 The CDDL for the entity-entry map follows: 796 entity-entry = { 797 entity-name => text, 798 ? reg-id => any-uri, 799 role => one-or-more<$role>, 800 ? thumbprint => hash-entry, 801 * $$entity-extension, 802 global-attributes, 803 } 805 entity-name = 31 806 reg-id = 32 807 role = 33 808 thumbprint = 34 810 $role /= tag-creator 811 $role /= software-creator 812 $role /= aggregator 813 $role /= distributor 814 $role /= licensor 815 $role /= maintainer 816 $role /= int / text 817 tag-creator=1 818 software-creator=2 819 aggregator=3 820 distributor=4 821 licensor=5 822 maintainer=6 824 The following describes each child item of this group. 826 * global-attributes: The global-attributes group described in 827 Section 2.5. 829 * entity-name (index 31): The textual name of the organizational 830 entity claiming the roles specified by the role item for the 831 CoSWID tag. This item maps to '/SoftwareIdentity/Entity/@name' in 832 [SWID]. 834 * reg-id (index 32): The registration id value is intended to 835 uniquely identify a naming authority in a given scope (e.g. 836 global, organization, vendor, customer, administrative domain, 837 etc.) for the referenced entity. The value of a registration ID 838 MUST be a RFC 3986 URI. The scope SHOULD be the scope of an 839 organization. 841 * role (index 33): An integer or textual value representing the 842 relationship(s) between the entity, and this tag or the referenced 843 software component. If an integer value is used it MUST be an 844 index value in the range -256 to 255. Integer values in the range 845 -256 to -1 are reserved for testing and use in closed environments 846 (see Section 6.2.2). Integer values in the range 0 to 255 847 correspond to registered entries in the IANA "Software Tag Entity 848 Role Values" registry (see Section 6.2.5. If a string value is 849 used it MUST be a private use name as defined in Section 6.2.2. 850 String values based on a Role Name from the IANA "Software Tag 851 Entity Role Values" registry MUST NOT be used, as these values are 852 less concise than their index value equivalent. 854 The following additional requirements exist for the use of the 855 "role" item: 857 - An entity item MUST be provided with the role of "tag-creator" 858 for every CoSWID tag. This indicates the organization that 859 created the CoSWID tag. 861 - An entity item SHOULD be provided with the role of "software- 862 creator" for every CoSWID tag, if this information is known to 863 the tag creator. This indicates the organization that created 864 the referenced software component. 866 * thumbprint (index 34): The value of the thumbprint item provides a 867 hash (i.e. the thumbprint) of the signing entity's public key 868 certificate. This provides an indicator of which entity signed 869 the CoSWID tag, which will typically be the tag creator. See 870 Section 2.9.1 for more details on the use of the hash-entry data 871 structure. 873 * $$entity-extension: This CDDL socket can be used to extend the 874 entity-entry group model. See Section 2.2. 876 2.7. The link-entry Map 878 The CDDL for the link-entry map follows: 880 link-entry = { 881 ? artifact => text, 882 href => any-uri, 883 ? media => text, 884 ? ownership => $ownership, 885 rel => $rel, 886 ? media-type => text, 887 ? use => $use, 888 * $$link-extension, 889 global-attributes, 890 } 892 media = 10 893 artifact = 37 894 href = 38 895 ownership = 39 896 rel = 40 897 media-type = 41 898 use = 42 900 $ownership /= shared 901 $ownership /= private 902 $ownership /= abandon 903 $ownership /= int / text 904 shared=1 905 private=2 906 abandon=3 908 $rel /= ancestor 909 $rel /= component 910 $rel /= feature 911 $rel /= installationmedia 912 $rel /= packageinstaller 913 $rel /= parent 914 $rel /= patches 915 $rel /= requires 916 $rel /= see-also 917 $rel /= supersedes 918 $rel /= supplemental 919 $rel /= -356..65536 / text 920 ancestor=1 921 component=2 922 feature=3 923 installationmedia=4 924 packageinstaller=5 925 parent=6 926 patches=7 927 requires=8 928 see-also=9 929 supersedes=10 930 supplemental=11 932 $use /= optional 933 $use /= required 934 $use /= recommended 935 $use /= int / text 936 optional=1 937 required=2 938 recommended=3 940 The following describes each member of this map. 942 * global-attributes: The global-attributes group described in 943 Section 2.5. 945 * artifact (index: 37): To be used with rel="installation-media", 946 this item's value provides the path to the installer executable or 947 script that can be run to launch the referenced installation. 948 Links with the same artifact name MUST be considered mirrors of 949 each other, allowing the installation media to be acquired from 950 any of the described sources. 952 * href (index 38): A URI-reference [RFC3986] for the referenced 953 resource. The "href" item's value can be, but is not limited to, 954 the following (which is a slightly modified excerpt from [SWID]): 956 - If no URI scheme is provided, then the URI-reference is a 957 relative reference relative to the URI of the CoSWID tag. For 958 example, "./folder/supplemental.coswid". 960 - a physical resource location with any acceptable URI scheme 961 (e.g., file:// http:// https:// ftp://) 963 - a URI with "swid:" as the scheme refers to another SWID or 964 CoSWID by the referenced tag's tag-id. This URI needs to be 965 resolved in the context of the endpoint by software that can 966 lookup other SWID or CoSWID tags. For example, "swid:2df9de35- 967 0aff-4a86-ace6-f7dddd1ade4c" references the tag with the tag-id 968 value "2df9de35-0aff-4a86-ace6-f7dddd1ade4c". 970 - a URI with "swidpath:" as the scheme, which refers to another 971 software tag via an XPATH query [W3C.REC-xpath20-20101214]. 972 This scheme is provided for compatibility with [SWID]. This 973 specification does not define how to resolve an XPATH query in 974 the context of CBOR. 976 * media (index 10): A hint to the consumer of the link to what 977 target platform the link is applicable to. This item represents a 978 query as defined by the W3C Media Queries Recommendation (see 979 [W3C.REC-css3-mediaqueries-20120619]). See also media defined in 980 Section 2.3. 982 * ownership (index 39): An integer or textual value used when the 983 "href" item references another software component to indicate the 984 degree of ownership between the software component referenced by 985 the COSWID tag and the software component referenced by the link. 986 If an integer value is used it MUST be an index value in the range 987 -256 to 255. Integer values in the range -256 to -1 are reserved 988 for testing and use in closed environments (see Section 6.2.2). 989 Integer values in the range 0 to 255 correspond to registered 990 entries in the IANA "Software Tag Link Ownership Values" registry 991 (see Section 6.2.6. If a string value is used it MUST be a 992 private use name as defined in Section 6.2.2. String values based 993 on a Ownership Type Name from the IANA "Software Tag Link 994 Ownership Values" registry MUST NOT be used, as these values are 995 less concise than their index value equivalent. 997 * rel (index 40): An integer or textual value that identifies the 998 relationship between this CoSWID and the target resource 999 identified by the "href" item. If an integer value is used it 1000 MUST be an index value in the range -256 to 65535. Integer values 1001 in the range -256 to -1 are reserved for testing and use in closed 1002 environments (see Section 6.2.2). Integer values in the range 0 1003 to 65535 correspond to registered entries in the IANA "Software 1004 Tag Link Relationship Values" registry (see Section 6.2.7. If a 1005 string value is used it MUST be either a private use name as 1006 defined in Section 6.2.2 or a "Relation Name" from the IANA "Link 1007 Relation Types" registry: https://www.iana.org/assignments/link- 1008 relations/link-relations.xhtml as defined by [RFC8288]. When a 1009 string value defined in the IANA "Software Tag Link Relationship 1010 Values" registry matches a Relation Name defined in the IANA "Link 1011 Relation Types" registry, the index value in the IANA "Software 1012 Tag Link Relationship Values" registry MUST be used instead, as 1013 this relationship has a specialized meaning in the context of a 1014 CoSWID tag. String values based on a Relationship Type Name from 1015 the IANA "Software Tag Link Relationship Values" registry MUST NOT 1016 be used, as these values are less concise than their index value 1017 equivalent. 1019 * media-type (index 41): A link can point to arbitrary resources on 1020 the endpoint, local network, or Internet using the href item. Use 1021 of this item supplies the resource consumer with a hint of what 1022 type of resource to expect. Media types are identified by 1023 referencing a "Name" from the IANA "Media Types" registry: 1024 http://www.iana.org/assignments/media-types/media-types.xhtml. 1025 This item maps to '/SoftwareIdentity/Link/@type' in [SWID]. 1027 * use (index 42): An integer or textual value used to determine if 1028 the referenced software component has to be installed before 1029 installing the software component identified by the COSWID tag. 1030 If an integer value is used it MUST be an index value in the range 1031 -256 to 255. Integer values in the range -256 to -1 are reserved 1032 for testing and use in closed environments (see Section 6.2.2). 1034 Integer values in the range 0 to 255 correspond to registered 1035 entries in the IANA "Link Use Values" registry (see Section 6.2.8. 1036 If a string value is used it MUST be a private use name as defined 1037 in Section 6.2.2. String values based on an Link Use Type Name 1038 from the IANA "Software Tag Link Use Values" registry MUST NOT be 1039 used, as these values are less concise than their index value 1040 equivalent. 1042 * $$link-extension: This CDDL socket can be used to extend the link- 1043 entry map model. See Section 2.2. 1045 2.8. The software-meta-entry Map 1047 The CDDL for the software-meta-entry map follows: 1049 software-meta-entry = { 1050 ? activation-status => text, 1051 ? channel-type => text, 1052 ? colloquial-version => text, 1053 ? description => text, 1054 ? edition => text, 1055 ? entitlement-data-required => bool, 1056 ? entitlement-key => text, 1057 ? generator => text, 1058 ? persistent-id => text, 1059 ? product => text, 1060 ? product-family => text, 1061 ? revision => text, 1062 ? summary => text, 1063 ? unspsc-code => text, 1064 ? unspsc-version => text, 1065 * $$software-meta-extension, 1066 global-attributes, 1067 } 1069 activation-status = 43 1070 channel-type = 44 1071 colloquial-version = 45 1072 description = 46 1073 edition = 47 1074 entitlement-data-required = 48 1075 entitlement-key = 49 1076 generator = 50 1077 persistent-id = 51 1078 product = 52 1079 product-family = 53 1080 revision = 54 1081 summary = 55 1082 unspsc-code = 56 1083 unspsc-version = 57 1085 The following describes each child item of this group. 1087 * global-attributes: The global-attributes group described in 1088 Section 2.5. 1090 * activation-status (index 43): A textual value that identifies how 1091 the software component has been activated, which might relate to 1092 specific terms and conditions for its use (e.g. Trial, 1093 Serialized, Licensed, Unlicensed, etc) and relate to an 1094 entitlement. This attribute is typically used in supplemental 1095 tags as it contains information that might be selected during a 1096 specific install. 1098 * channel-type (index 44): A textual value that identifies which 1099 sales, licensing, or marketing channel the software component has 1100 been targeted for (e.g. Volume, Retail, OEM, Academic, etc). 1101 This attribute is typically used in supplemental tags as it 1102 contains information that might be selected during a specific 1103 install. 1105 * colloquial-version (index 45): A textual value for the software 1106 component's informal or colloquial version. Examples may include 1107 a year value, a major version number, or similar value that are 1108 used to identify a group of specific software component releases 1109 that are part of the same release/support cycle. This version can 1110 be the same through multiple releases of a software component, 1111 while the software-version specified in the concise-swid-tag group 1112 is much more specific and will change for each software component 1113 release. This version is intended to be used for string 1114 comparison only and is not intended to be used to determine if a 1115 specific value is earlier or later in a sequence. 1117 * description (index 46): A textual value that provides a detailed 1118 description of the software component. This value MAY be multiple 1119 paragraphs separated by CR LF characters as described by 1120 [RFC5198]. 1122 * edition (index 47): A textual value indicating that the software 1123 component represents a functional variation of the code base used 1124 to support multiple software components. For example, this item 1125 can be used to differentiate enterprise, standard, or professional 1126 variants of a software component. 1128 * entitlement-data-required (index 48): A boolean value that can be 1129 used to determine if accompanying proof of entitlement is needed 1130 when a software license reconciliation process is performed. 1132 * entitlement-key (index 49): A vendor-specific textual key that can 1133 be used to identify and establish a relationship to an 1134 entitlement. Examples of an entitlement-key might include a 1135 serial number, product key, or license key. For values that 1136 relate to a given software component install (i.e., license key), 1137 a supplemental tag will typically contain this information. In 1138 other cases, where a general-purpose key can be provided that 1139 applies to all possible installs of the software component on 1140 different endpoints, a primary tag will typically contain this 1141 information. 1143 * generator (index 50): The name (or tag-id) of the software 1144 component that created the CoSWID tag. If the generating software 1145 component has a SWID or CoSWID tag, then the tag-id for the 1146 generating software component SHOULD be provided. 1148 * persistent-id (index 51): A globally unique identifier used to 1149 identify a set of software components that are related. Software 1150 components sharing the same persistent-id can be different 1151 versions. This item can be used to relate software components, 1152 released at different points in time or through different release 1153 channels, that may not be able to be related through use of the 1154 link item. 1156 * product (index 52): A basic name for the software component that 1157 can be common across multiple tagged software components (e.g., 1158 Apache HTTPD). 1160 * product-family (index 53): A textual value indicating the software 1161 components overall product family. This should be used when 1162 multiple related software components form a larger capability that 1163 is installed on multiple different endpoints. For example, some 1164 software families may consist of server, client, and shared 1165 service components that are part of a larger capability. Email 1166 systems, enterprise applications, backup services, web 1167 conferencing, and similar capabilities are examples of families. 1168 Use of this item is not intended to represent groups of software 1169 that are bundled or installed together. The persistent-id or link 1170 items SHOULD be used to relate bundled software components. 1172 * revision (index 54): A string value indicating an informal or 1173 colloquial release version of the software. This value can 1174 provide a different version value as compared to the software- 1175 version specified in the concise-swid-tag group. This is useful 1176 when one or more releases need to have an informal version label 1177 that differs from the specific exact version value specified by 1178 software-version. Examples can include SP1, RC1, Beta, etc. 1180 * summary (index 55): A short description of the software component. 1181 This MUST be a single sentence suitable for display in a user 1182 interface. 1184 * unspsc-code (index 56): An 8 digit UNSPSC classification code for 1185 the software component as defined by the United Nations Standard 1186 Products and Services Code (UNSPSC, [UNSPSC]). 1188 * unspsc-version (index 57): The version of UNSPSC used to define 1189 the unspsc-code value. 1191 * $$meta-extension: This CDDL socket can be used to extend the 1192 software-meta-entry group model. See Section 2.2. 1194 2.9. The Resource Collection Definition 1196 2.9.1. The hash-entry Array 1198 CoSWID adds explicit support for the representation of hash entries 1199 using algorithms that are registered in the IANA "Named Information 1200 Hash Algorithm Registry" [IANA.named-information] using the hash 1201 member (index 7) and the corresponding hash-entry type. This is the 1202 equivalent of the namespace qualified "hash" attribute in [SWID]. 1204 hash-entry = [ 1205 hash-alg-id: int, 1206 hash-value: bytes, 1207 ] 1209 The number used as a value for hash-alg-id is an integer-based hash 1210 algorithm identifier who's value MUST refer to an ID in the IANA 1211 "Named Information Hash Algorithm Registry" [IANA.named-information] 1212 with a Status of "current"; other hash algorithms MUST NOT be used. 1213 If the hash-alg-id is not known, then the integer value "0" MUST be 1214 used. This ensures parity between the SWID tag specification [SWID], 1215 which does not allow an algorithm to be identified for this field. 1217 The hash-value byte string value MUST represent the raw hash value of 1218 the hashed resource generated using the hash algorithm indicated by 1219 the hash-alg-id. 1221 2.9.2. The resource-collection Group 1223 A list of items both used in evidence (created by a software 1224 discovery process) and payload (installed in an endpoint) content of 1225 a CoSWID tag document to structure and differentiate the content of 1226 specific CoSWID tag types. Potential content includes directories, 1227 files, processes, or resources. 1229 The CDDL for the resource-collection group follows: 1231 path-elements-group = ( ? directory => one-or-more, 1232 ? file => one-or-more, 1233 ) 1235 resource-collection = ( 1236 path-elements-group, 1237 ? process => one-or-more, 1238 ? resource => one-or-more, 1239 * $$resource-collection-extension, 1240 ) 1242 filesystem-item = ( 1243 ? key => bool, 1244 ? location => text, 1245 fs-name => text, 1246 ? root => text, 1247 ) 1249 file-entry = { 1250 filesystem-item, 1251 ? size => uint, 1252 ? file-version => text, 1253 ? hash => hash-entry, 1254 * $$file-extension, 1255 global-attributes, 1256 } 1258 directory-entry = { 1259 filesystem-item, 1260 ? path-elements => { path-elements-group }, 1261 * $$directory-extension, 1262 global-attributes, 1263 } 1265 process-entry = { 1266 process-name => text, 1267 ? pid => integer, 1268 * $$process-extension, 1269 global-attributes, 1270 } 1272 resource-entry = { 1273 type => text, 1274 * $$resource-extension, 1275 global-attributes, 1276 } 1278 directory = 16 1279 file = 17 1280 process = 18 1281 resource = 19 1282 size = 20 1283 file-version = 21 1284 key = 22 1285 location = 23 1286 fs-name = 24 1287 root = 25 1288 path-elements = 26 1289 process-name = 27 1290 pid = 28 1291 type = 29 1293 The following describes each member of the groups and maps 1294 illustrated above. 1296 * filesystem-item: A list of common items used for representing the 1297 filesystem root, relative location, name, and significance of a 1298 file or directory item. 1300 * global-attributes: The global-attributes group described in 1301 Section 2.5. 1303 * directory (index 16): A directory item allows child directory and 1304 file items to be defined within a directory hierarchy for the 1305 software component. 1307 * file (index 17): A file item allows details about a file to be 1308 provided for the software component. 1310 * process (index 18): A process item allows details to be provided 1311 about the runtime behavior of the software component, such as 1312 information that will appear in a process listing on an endpoint. 1314 * resource (index 19): A resource item can be used to provide 1315 details about an artifact or capability expected to be found on an 1316 endpoint or evidence collected related to the software component. 1317 This can be used to represent concepts not addressed directly by 1318 the directory, file, or process items. Examples include: registry 1319 keys, bound ports, etc. The equivalent construct in [SWID] is 1320 currently under specified. As a result, this item might be 1321 further defined through extension in the future. 1323 * size (index 20): The file's size in bytes. 1325 * file-version (index 21): The file's version as reported by 1326 querying information on the file from the operating system. This 1327 item maps to '/SoftwareIdentity/(Payload|Evidence)/File/@version' 1328 in [SWID]. 1330 * hash (index 7): A hash of the file as described in Section 2.9.1. 1332 * key (index 22): A boolean value indicating if a file or directory 1333 is significant or required for the software component to execute 1334 or function properly. These are files or directories that can be 1335 used to affirmatively determine if the software component is 1336 installed on an endpoint. 1338 * location (index 23): The filesystem path where a file is expected 1339 to be located when installed or copied. The location MUST be 1340 either relative to the location of the parent directory item 1341 (preferred) or relative to the location of the CoSWID tag if no 1342 parent is defined. The location MUST NOT include a file's name, 1343 which is provided by the fs-name item. 1345 * fs-name (index 24): The name of the directory or file without any 1346 path information. This aligns with a file "name" in [SWID]. This 1347 item maps to 1348 '/SoftwareIdentity/(Payload|Evidence)/(File|Directory)/@name' in 1349 [SWID]. 1351 * root (index 25): A filesystem-specific name for the root of the 1352 filesystem. The location item is considered relative to this 1353 location if specified. If not provided, the value provided by the 1354 location item is expected to be relative to its parent or the 1355 location of the CoSWID tag if no parent is provided. 1357 * path-elements (index 26): This group allows a hierarchy of 1358 directory and file items to be defined in payload or evidence 1359 items. This is a construction within the CDDL definition of 1360 CoSWID to support shared syntax and does not appear in [SWID]. 1362 * process-name (index 27): The software component's process name as 1363 it will appear in an endpoint's process list. This aligns with a 1364 process "name" in [SWID]. This item maps to 1365 '/SoftwareIdentity/(Payload|Evidence)/Process/@name' in [SWID]. 1367 * pid (index 28): The process ID identified for a running instance 1368 of the software component in the endpoint's process list. This is 1369 used as part of the evidence item. 1371 * type (index 29): A string indicating the type of resource. 1373 * $$resource-collection-extension: This CDDL socket can be used to 1374 extend the resource-collection group model. This can be used to 1375 add new specialized types of resources. See Section 2.2. 1377 * $$file-extension: This CDDL socket can be used to extend the file- 1378 entry group model. See Section 2.2. 1380 * $$directory-extension: This CDDL socket can be used to extend the 1381 directory-entry group model. See Section 2.2. 1383 * $$process-extension: This CDDL socket can be used to extend the 1384 process-entry group model. See Section 2.2. 1386 * $$resource-extension: This CDDL socket can be used to extend the 1387 resource-entry group model. See Section 2.2. 1389 2.9.3. The payload-entry Map 1391 The CDDL for the payload-entry map follows: 1393 payload-entry = { 1394 resource-collection, 1395 * $$payload-extension, 1396 global-attributes, 1397 } 1399 The following describes each child item of this group. 1401 * global-attributes: The global-attributes group described in 1402 Section 2.5. 1404 * resource-collection: The resource-collection group described in 1405 Section 2.9.2. 1407 * $$payload-extension: This CDDL socket can be used to extend the 1408 payload-entry group model. See Section 2.2. 1410 2.9.4. The evidence-entry Map 1412 The CDDL for the evidence-entry map follows: 1414 evidence-entry = { 1415 resource-collection, 1416 ? date => integer-time, 1417 ? device-id => text, 1418 * $$evidence-extension, 1419 global-attributes, 1420 } 1422 date = 35 1423 device-id = 36 1425 The following describes each child item of this group. 1427 * global-attributes: The global-attributes group described in 1428 Section 2.5. 1430 * resource-collection: The resource-collection group described in 1431 Section 2.9.2. 1433 * date (index 35): The date and time the information was collected 1434 pertaining to the evidence item. 1436 * device-id (index 36): The endpoint's string identifier from which 1437 the evidence was collected. 1439 * $$evidence-extension: This CDDL socket can be used to extend the 1440 evidence-entry group model. See Section 2.2. 1442 2.10. Full CDDL Specification 1444 In order to create a valid CoSWID document the structure of the 1445 corresponding CBOR message MUST adhere to the following CDDL 1446 specification. 1448 1449 concise-swid-tag = { 1450 tag-id => text / bstr .size 16, 1451 tag-version => integer, 1452 ? corpus => bool, 1453 ? patch => bool, 1454 ? supplemental => bool, 1455 software-name => text, 1456 ? software-version => text, 1457 ? version-scheme => $version-scheme, 1458 ? media => text, 1459 ? software-meta => one-or-more, 1460 entity => one-or-more, 1461 ? link => one-or-more, 1462 ? payload-or-evidence, 1463 * $$coswid-extension, 1464 global-attributes, 1465 } 1467 payload-or-evidence //= ( payload => payload-entry ) 1468 payload-or-evidence //= ( evidence => evidence-entry ) 1470 any-uri = uri 1471 label = text / int 1473 $version-scheme /= multipartnumeric 1474 $version-scheme /= multipartnumeric-suffix 1475 $version-scheme /= alphanumeric 1476 $version-scheme /= decimal 1477 $version-scheme /= semver 1478 $version-scheme /= int / text 1480 any-attribute = ( 1481 label => one-or-more / one-or-more 1482 ) 1484 one-or-more = T / [ 2* T ] 1486 global-attributes = ( 1487 ? lang => text, 1488 * any-attribute, 1489 ) 1491 hash-entry = [ 1492 hash-alg-id: int, 1493 hash-value: bytes, 1494 ] 1496 entity-entry = { 1497 entity-name => text, 1498 ? reg-id => any-uri, 1499 role => one-or-more<$role>, 1500 ? thumbprint => hash-entry, 1501 * $$entity-extension, 1502 global-attributes, 1503 } 1505 $role /= tag-creator 1506 $role /= software-creator 1507 $role /= aggregator 1508 $role /= distributor 1509 $role /= licensor 1510 $role /= maintainer 1511 $role /= int / text 1513 link-entry = { 1514 ? artifact => text, 1515 href => any-uri, 1516 ? media => text, 1517 ? ownership => $ownership, 1518 rel => $rel, 1519 ? media-type => text, 1520 ? use => $use, 1521 * $$link-extension, 1522 global-attributes, 1524 } 1526 $ownership /= shared 1527 $ownership /= private 1528 $ownership /= abandon 1529 $ownership /= int / text 1531 $rel /= ancestor 1532 $rel /= component 1533 $rel /= feature 1534 $rel /= installationmedia 1535 $rel /= packageinstaller 1536 $rel /= parent 1537 $rel /= patches 1538 $rel /= requires 1539 $rel /= see-also 1540 $rel /= supersedes 1541 $rel /= supplemental 1542 $rel /= -256..64436 / text 1544 $use /= optional 1545 $use /= required 1546 $use /= recommended 1547 $use /= int / text 1549 software-meta-entry = { 1550 ? activation-status => text, 1551 ? channel-type => text, 1552 ? colloquial-version => text, 1553 ? description => text, 1554 ? edition => text, 1555 ? entitlement-data-required => bool, 1556 ? entitlement-key => text, 1557 ? generator => text, 1558 ? persistent-id => text, 1559 ? product => text, 1560 ? product-family => text, 1561 ? revision => text, 1562 ? summary => text, 1563 ? unspsc-code => text, 1564 ? unspsc-version => text, 1565 * $$software-meta-extension, 1566 global-attributes, 1567 } 1569 path-elements-group = ( ? directory => one-or-more, 1570 ? file => one-or-more, 1571 ) 1573 resource-collection = ( 1574 path-elements-group, 1575 ? process => one-or-more, 1576 ? resource => one-or-more, 1577 * $$resource-collection-extension, 1578 ) 1580 file-entry = { 1581 filesystem-item, 1582 ? size => uint, 1583 ? file-version => text, 1584 ? hash => hash-entry, 1585 * $$file-extension, 1586 global-attributes, 1587 } 1589 directory-entry = { 1590 filesystem-item, 1591 ? path-elements => { path-elements-group }, 1592 * $$directory-extension, 1593 global-attributes, 1594 } 1596 process-entry = { 1597 process-name => text, 1598 ? pid => integer, 1599 * $$process-extension, 1600 global-attributes, 1601 } 1603 resource-entry = { 1604 type => text, 1605 * $$resource-extension, 1606 global-attributes, 1607 } 1609 filesystem-item = ( 1610 ? key => bool, 1611 ? location => text, 1612 fs-name => text, 1613 ? root => text, 1614 ) 1616 payload-entry = { 1617 resource-collection, 1618 * $$payload-extension, 1619 global-attributes, 1620 } 1621 evidence-entry = { 1622 resource-collection, 1623 ? date => integer-time, 1624 ? device-id => text, 1625 * $$evidence-extension, 1626 global-attributes, 1627 } 1629 integer-time = #6.1(int) 1631 ; "global map member" integer indexes 1632 tag-id = 0 1633 software-name = 1 1634 entity = 2 1635 evidence = 3 1636 link = 4 1637 software-meta = 5 1638 payload = 6 1639 hash = 7 1640 corpus = 8 1641 patch = 9 1642 media = 10 1643 supplemental = 11 1644 tag-version = 12 1645 software-version = 13 1646 version-scheme = 14 1647 lang = 15 1648 directory = 16 1649 file = 17 1650 process = 18 1651 resource = 19 1652 size = 20 1653 file-version = 21 1654 key = 22 1655 location = 23 1656 fs-name = 24 1657 root = 25 1658 path-elements = 26 1659 process-name = 27 1660 pid = 28 1661 type = 29 1662 entity-name = 31 1663 reg-id = 32 1664 role = 33 1665 thumbprint = 34 1666 date = 35 1667 device-id = 36 1668 artifact = 37 1669 href = 38 1670 ownership = 39 1671 rel = 40 1672 media-type = 41 1673 use = 42 1674 activation-status = 43 1675 channel-type = 44 1676 colloquial-version = 45 1677 description = 46 1678 edition = 47 1679 entitlement-data-required = 48 1680 entitlement-key = 49 1681 generator = 50 1682 persistent-id = 51 1683 product = 52 1684 product-family = 53 1685 revision = 54 1686 summary = 55 1687 unspsc-code = 56 1688 unspsc-version = 57 1690 ; "version-scheme" integer indexes 1691 multipartnumeric = 1 1692 multipartnumeric-suffix = 2 1693 alphanumeric = 3 1694 decimal = 4 1695 semver = 16384 1697 ; "role" integer indexes 1698 tag-creator=1 1699 software-creator=2 1700 aggregator=3 1701 distributor=4 1702 licensor=5 1703 maintainer=6 1705 ; "ownership" integer indexes 1706 shared=1 1707 private=2 1708 abandon=3 1710 ; "rel" integer indexes 1711 ancestor=1 1712 component=2 1713 feature=3 1714 installationmedia=4 1715 packageinstaller=5 1716 parent=6 1717 patches=7 1718 requires=8 1719 see-also=9 1720 supersedes=10 1721 ; supplemental=11 ; this is already defined earlier 1723 ; "use" integer indexes 1724 optional=1 1725 required=2 1726 recommended=3 1727 1729 3. Determining the Type of CoSWID 1731 The operational model for SWID and CoSWID tags was introduced in 1732 Section 1.1, which described four different CoSWID tag types. The 1733 following additional rules apply to the use of CoSWID tags to ensure 1734 that created tags properly identify the tag type. 1736 The first matching rule MUST determine the type of the CoSWID tag. 1738 1. Primary Tag: A CoSWID tag MUST be considered a primary tag if the 1739 corpus, patch, and supplemental items are "false". 1741 2. Supplemental Tag: A CoSWID tag MUST be considered a supplemental 1742 tag if the supplemental item is set to "true". 1744 3. Corpus Tag: A CoSWID tag MUST be considered a corpus tag if the 1745 corpus item is "true". 1747 4. Patch Tag: A CoSWID tag MUST be considered a patch tag if the 1748 patch item is "true". 1750 Note: Multiple of the corpus, patch, and supplemental items can have 1751 values set as "true". The rules above provide a means to determine 1752 the tag's type in such a case. For example, a SWID or CoSWID tag for 1753 a patch installer might have both corpus and patch items set to 1754 "true". In such a case, the tag is a "Corpus Tag". The tag 1755 installed by this installer would have only the patch item set to 1756 "true", making the installed tag type a "Patch Tag". 1758 4. CoSWID Indexed Label Values 1759 4.1. Version Scheme 1761 The following table contains a set of values for use in the concise- 1762 swid-tag group's version-scheme item. These values match the version 1763 schemes defined in the ISO/IEC 19770-2:2015 [SWID] specification. 1764 Index value indicates the value to use as the version-scheme item's 1765 value. The Version Scheme Name provides human-readable text for the 1766 value. The Definition describes the syntax of allowed values for 1767 each entry. 1769 +=======+=========================+================================+ 1770 | Index | Version Scheme Name | Definition | 1771 +=======+=========================+================================+ 1772 | 1 | multipartnumeric | Numbers separated by dots, | 1773 | | | where the numbers are | 1774 | | | interpreted as integers (e.g., | 1775 | | | 1.2.3, 1.4.5, 1.2.3.4.5.6.7) | 1776 +-------+-------------------------+--------------------------------+ 1777 | 2 | multipartnumeric+suffix | Numbers separated by dots, | 1778 | | | where the numbers are | 1779 | | | interpreted as integers with | 1780 | | | an additional textual suffix | 1781 | | | (e.g., 1.2.3a) | 1782 +-------+-------------------------+--------------------------------+ 1783 | 3 | alphanumeric | Strictly a string, sorting is | 1784 | | | done alphanumerically | 1785 +-------+-------------------------+--------------------------------+ 1786 | 4 | decimal | A floating point number (e.g., | 1787 | | | 1.25 is less than 1.3) | 1788 +-------+-------------------------+--------------------------------+ 1789 | 16384 | semver | A semantic version as defined | 1790 | | | by [SWID]. Also see the | 1791 | | | [SEMVER] specification for | 1792 | | | more information | 1793 +-------+-------------------------+--------------------------------+ 1795 Table 3: Version Scheme Values 1797 The values above are registered in the IANA "Software Tag Version 1798 Scheme Values" registry defined in Section Section 6.2.4. Additional 1799 entries will likely be registered over time in this registry. 1801 These version schemes have partially overlapping value spaces. The 1802 following guidelines help to ensure that the most specific version- 1803 scheme is used: 1805 * "decimal" and "multipartnumeric" partially overlap in their value 1806 space when a value matches a decimal number. When a corresponding 1807 software-version item's value falls within this overlapping value 1808 space, the "decimal" version scheme SHOULD be used. 1810 * "multipartnumeric" and "semver" partially overlap in their value 1811 space when a "multipartnumeric" value matches the semantic 1812 versioning syntax. When a corresponding software-version item's 1813 value falls within this overlapping value space, the "semver" 1814 version scheme SHOULD be used. 1816 * "alphanumeric" and other version schemes might overlap in their 1817 value space. When a corresponding software-version item's value 1818 falls within this overlapping value space, the other version 1819 scheme SHOULD be used instead of "alphanumeric". 1821 4.2. Entity Role Values 1823 The following table indicates the index value to use for the entity- 1824 entry group's role item (see Section 2.6). These values match the 1825 entity roles defined in the ISO/IEC 19770-2:2015 [SWID] 1826 specification. The "Index" value indicates the value to use as the 1827 role item's value. The "Role Name" provides human-readable text for 1828 the value. The "Definition" describes the semantic meaning of each 1829 entry. 1831 +=======+=================+========================================+ 1832 | Index | Role Name | Definition | 1833 +=======+=================+========================================+ 1834 | 1 | tagCreator | The person or organization that | 1835 | | | created the containing SWID or CoSWID | 1836 | | | tag | 1837 +-------+-----------------+----------------------------------------+ 1838 | 2 | softwareCreator | The person or organization entity that | 1839 | | | created the software component. | 1840 +-------+-----------------+----------------------------------------+ 1841 | 3 | aggregator | From [SWID], "An organization or | 1842 | | | system that encapsulates software from | 1843 | | | their own and/or other organizations | 1844 | | | into a different distribution process | 1845 | | | (as in the case of virtualization), or | 1846 | | | as a completed system to accomplish a | 1847 | | | specific task (as in the case of a | 1848 | | | value added reseller)." | 1849 +-------+-----------------+----------------------------------------+ 1850 | 4 | distributor | From [SWID], "An entity that furthers | 1851 | | | the marketing, selling and/or | 1852 | | | distribution of software from the | 1853 | | | original place of manufacture to the | 1854 | | | ultimate user without modifying the | 1855 | | | software, its packaging or its | 1856 | | | labelling." | 1857 +-------+-----------------+----------------------------------------+ 1858 | 5 | licensor | From [SAM] as "software licensor", a | 1859 | | | "person or organization who owns or | 1860 | | | holds the rights to issue a software | 1861 | | | license for a specific software | 1862 | | | [component]" | 1863 +-------+-----------------+----------------------------------------+ 1864 | 6 | maintainer | The person or organization that is | 1865 | | | responsible for coordinating and | 1866 | | | making updates to the source code for | 1867 | | | the software component. This SHOULD | 1868 | | | be used when the "maintainer" is a | 1869 | | | different person or organization than | 1870 | | | the original "softwareCreator". | 1871 +-------+-----------------+----------------------------------------+ 1873 Table 4: Entity Role Values 1875 The values above are registered in the IANA "Software Tag Entity Role 1876 Values" registry defined in Section 6.2.5. Additional values will 1877 likely be registered over time. Additionally, the index values 128 1878 through 255 and the name prefix "x_" have been reserved for private 1879 use. 1881 4.3. Link Ownership Values 1883 The following table indicates the index value to use for the link- 1884 entry group's ownership item (see Section 2.7). These values match 1885 the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID] 1886 specification. The "Index" value indicates the value to use as the 1887 link-entry group ownership item's value. The "Ownership Type" 1888 provides human-readable text for the value. The "Definition" 1889 describes the semantic meaning of each entry. 1891 +=======+===========+===============================================+ 1892 | Index | Ownership | Definition | 1893 | | Type | | 1894 +=======+===========+===============================================+ 1895 | 1 | abandon | If the software component referenced by the | 1896 | | | CoSWID tag is uninstalled, then the | 1897 | | | referenced software SHOULD NOT be | 1898 | | | uninstalled | 1899 +-------+-----------+-----------------------------------------------+ 1900 | 2 | private | If the software component referenced by the | 1901 | | | CoSWID tag is uninstalled, then the | 1902 | | | referenced software SHOULD be uninstalled as | 1903 | | | well. | 1904 +-------+-----------+-----------------------------------------------+ 1905 | 3 | shared | If the software component referenced by the | 1906 | | | CoSWID tag is uninstalled, then the | 1907 | | | referenced software SHOULD be uninstalled if | 1908 | | | no other components sharing the software. | 1909 +-------+-----------+-----------------------------------------------+ 1911 Table 5: Link Ownership Values 1913 The values above are registered in the IANA "Software Tag Link 1914 Ownership Values" registry defined in Section 6.2.6. Additional 1915 values will likely be registered over time. Additionally, the index 1916 values 128 through 255 and the name prefix "x_" have been reserved 1917 for private use. 1919 4.4. Link Rel Values 1921 The following table indicates the index value to use for the link- 1922 entry group's rel item (see Section 2.7). These values match the 1923 link rel values defined in the ISO/IEC 19770-2:2015 [SWID] 1924 specification. The "Index" value indicates the value to use as the 1925 link-entry group ownership item's value. The "Relationship Type" 1926 provides human-readable text for the value. The "Definition" 1927 describes the semantic meaning of each entry. 1929 +=======+===================+=======================================+ 1930 | Index | Relationship Type | Definition | 1931 +=======+===================+=======================================+ 1932 | 1 | ancestor | The link references a software | 1933 | | | tag for a previous release of | 1934 | | | this software. This can be | 1935 | | | useful to define an upgrade path. | 1936 +-------+-------------------+---------------------------------------+ 1937 | 2 | component | The link references a software | 1938 | | | tag for a separate component of | 1939 | | | this software. | 1940 +-------+-------------------+---------------------------------------+ 1941 | 3 | feature | The link references a | 1942 | | | configurable feature of this | 1943 | | | software that can be enabled or | 1944 | | | disabled without changing the | 1945 | | | installed files. | 1946 +-------+-------------------+---------------------------------------+ 1947 | 4 | installationmedia | The link references the | 1948 | | | installation package that can be | 1949 | | | used to install this software. | 1950 +-------+-------------------+---------------------------------------+ 1951 | 5 | packageinstaller | The link references the | 1952 | | | installation software needed to | 1953 | | | install this software. | 1954 +-------+-------------------+---------------------------------------+ 1955 | 6 | parent | The link references a software | 1956 | | | tag that is the parent of the | 1957 | | | referencing tag. This | 1958 | | | relationship can be used when | 1959 | | | multiple software components are | 1960 | | | part of a software bundle, where | 1961 | | | the "parent" is the software tag | 1962 | | | for the bundle, and each child is | 1963 | | | a "component". In such a case, | 1964 | | | each child component can provide | 1965 | | | a "parent" link relationship to | 1966 | | | the bundle's software tag, and | 1967 | | | the bundle can provide a | 1968 | | | "component" link relationship to | 1969 | | | each child software component. | 1970 +-------+-------------------+---------------------------------------+ 1971 | 7 | patches | The link references a software | 1972 | | | tag that the referencing software | 1973 | | | patches. Typically only used for | 1974 | | | patch tags (see Section 1.1). | 1975 +-------+-------------------+---------------------------------------+ 1976 | 8 | requires | The link references a | 1977 | | | prerequisite for installing this | 1978 | | | software. A patch tag (see | 1979 | | | Section 1.1) can use this to | 1980 | | | represent base software or | 1981 | | | another patch that needs to be | 1982 | | | installed first. | 1983 +-------+-------------------+---------------------------------------+ 1984 | 9 | see-also | The link references other | 1985 | | | software that may be of interest | 1986 | | | that relates to this software. | 1987 +-------+-------------------+---------------------------------------+ 1988 | 10 | supersedes | The link references another | 1989 | | | software that this software | 1990 | | | replaces. A patch tag (see | 1991 | | | Section 1.1) can use this to | 1992 | | | represent another patch that this | 1993 | | | patch incorporates or replaces. | 1994 +-------+-------------------+---------------------------------------+ 1995 | 11 | supplemental | The link references a software | 1996 | | | tag that the referencing tag | 1997 | | | supplements. Used on | 1998 | | | supplemental tags (see | 1999 | | | Section 1.1). | 2000 +-------+-------------------+---------------------------------------+ 2002 Table 6: Link Relationship Values 2004 The values above are registered in the IANA "Software Tag Link 2005 Relationship Values" registry defined in Section 6.2.7. Additional 2006 values will likely be registered over time. Additionally, the index 2007 values 32768 through 65535 and the name prefix "x_" have been 2008 reserved for private use. 2010 4.5. Link Use Values 2012 The following table indicates the index value to use for the link- 2013 entry group's use item (see Section 2.7). These values match the 2014 link use values defined in the ISO/IEC 19770-2:2015 [SWID] 2015 specification. The "Index" value indicates the value to use as the 2016 link-entry group use item's value. The "Use Type" provides human- 2017 readable text for the value. The "Definition" describes the semantic 2018 meaning of each entry. 2020 +=======+=============+========================================+ 2021 | Index | Use Type | Definition | 2022 +=======+=============+========================================+ 2023 | 1 | optional | From [SWID], "Not absolutely required; | 2024 | | | the [Link]'d software is installed | 2025 | | | only when specified." | 2026 +-------+-------------+----------------------------------------+ 2027 | 2 | required | From [SWID], "The [Link]'d software is | 2028 | | | absolutely required for an operation | 2029 | | | software installation." | 2030 +-------+-------------+----------------------------------------+ 2031 | 3 | recommended | From [SWID], "Not absolutely required; | 2032 | | | the [Link]'d software is installed | 2033 | | | unless specified otherwise." | 2034 +-------+-------------+----------------------------------------+ 2036 Table 7: Link Use Values 2038 The values above are registered in the IANA "Software Tag Link Use 2039 Values" registry defined in Section 6.2.8. Additional values will 2040 likely be registered over time. Additionally, the index values 128 2041 through 255 and the name prefix "x_" have been reserved for private 2042 use. 2044 5. URI Schemes 2046 This specification defines the following URI schemes for use in 2047 CoSWID and to provide interoperability with schemes used in [SWID]. 2049 Note: These URI schemes are used in [SWID] without an IANA 2050 registration. The present specification ensures that these URI 2051 schemes are properly defined going forward. 2053 5.1. "swid" URI Scheme 2055 There is a need for a scheme name that can be used in URIs that point 2056 to a specific software tag by that tag's tag-id, such as the use of 2057 the link entry as described in Section 2.7) of this document. Since 2058 this scheme is used both in a standards track document and an ISO 2059 standard, this scheme needs to be used without fear of conflicts with 2060 current or future actual schemes. In Section 6.6.1, the scheme 2061 "swid" is registered as a 'permanent' scheme for that purpose. 2063 URIs specifying the "swid" scheme are used to reference a software 2064 tag by its tag-id. A tag-id referenced in this way can be used to 2065 identify the tag resource in the context of where it is referenced 2066 from. For example, when a tag is installed on a given device, that 2067 tag can reference related tags on the same device using URIs with 2068 this scheme. 2070 For URIs that use the "swid" scheme, the scheme specific part MUST 2071 consist of a referenced software tag's tag-id. This tag-id MUST be 2072 URI encoded according to [RFC3986] Section 2.1. 2074 The following expression is a valid example: 2076 swid:2df9de35-0aff-4a86-ace6-f7dddd1ade4c 2078 5.2. "swidpath" URI Scheme 2080 There is a need for a scheme name that can be used in URIs to 2081 identify a collection of specific software tags with data elements 2082 that match an XPath expression, such as the use of the link entry as 2083 described in Section 2.7) of this document. Since this scheme is 2084 used both in a standards track document and an ISO standard, this 2085 scheme needs to be used without fear of conflicts with current or 2086 future actual schemes. In Section 6.6.2, the scheme "swidpath" is 2087 hereby registered as a 'permanent' scheme for that purpose. 2089 URIs specifying the "swidpath" scheme are used to reference the data 2090 that must be found in a given software tag for that tag to be 2091 considered a matching tag to be included in the identified tag 2092 collection. Tags to be evaluated include all tags in the context of 2093 where the tag is referenced from. For example, when a tag is 2094 installed on a given device, that tag can reference related tags on 2095 the same device using a URI with this scheme. 2097 For URIs that use the "swidpath" scheme, the requirements apply. 2099 The scheme specific part MUST be an XPath expression as defined by 2100 [W3C.REC-xpath20-20101214]. The included XPath expression will be 2101 URI encoded according to [RFC3986] Section 2.1. 2103 This XPath is evaluated over SWID tags found on a system. A given 2104 tag MUST be considered a match if the XPath evaluation result value 2105 has an effective boolean value of "true" according to 2106 [W3C.REC-xpath20-20101214] Section 2.4.3. 2108 6. IANA Considerations 2110 This document has a number of IANA considerations, as described in 2111 the following subsections. In summary, 6 new registries are 2112 established with this request, with initial entries provided for each 2113 registry. New values for 5 other registries are also requested. 2115 6.1. CoSWID Items Registry 2117 This registry uses integer values as index values in CBOR maps. 2119 This document defines a new registry titled "CoSWID Items". Future 2120 registrations for this registry are to be made based on [RFC8126] as 2121 follows: 2123 +==================+=========================+ 2124 | Range | Registration Procedures | 2125 +==================+=========================+ 2126 | 0-32767 | Standards Action | 2127 +------------------+-------------------------+ 2128 | 32768-4294967295 | Specification Required | 2129 +------------------+-------------------------+ 2131 Table 8: CoSWID Items Registration Procedures 2133 All negative values are reserved for Private Use. 2135 Initial registrations for the "CoSWID Items" registry are provided 2136 below. Assignments consist of an integer index value, the item name, 2137 and a reference to the defining specification. 2139 +===============+===========================+===============+ 2140 | Index | Item Name | Specification | 2141 +===============+===========================+===============+ 2142 | 0 | tag-id | RFC-AAAA | 2143 +---------------+---------------------------+---------------+ 2144 | 1 | software-name | RFC-AAAA | 2145 +---------------+---------------------------+---------------+ 2146 | 2 | entity | RFC-AAAA | 2147 +---------------+---------------------------+---------------+ 2148 | 3 | evidence | RFC-AAAA | 2149 +---------------+---------------------------+---------------+ 2150 | 4 | link | RFC-AAAA | 2151 +---------------+---------------------------+---------------+ 2152 | 5 | software-meta | RFC-AAAA | 2153 +---------------+---------------------------+---------------+ 2154 | 6 | payload | RFC-AAAA | 2155 +---------------+---------------------------+---------------+ 2156 | 7 | hash | RFC-AAAA | 2157 +---------------+---------------------------+---------------+ 2158 | 8 | corpus | RFC-AAAA | 2159 +---------------+---------------------------+---------------+ 2160 | 9 | patch | RFC-AAAA | 2161 +---------------+---------------------------+---------------+ 2162 | 10 | media | RFC-AAAA | 2163 +---------------+---------------------------+---------------+ 2164 | 11 | supplemental | RFC-AAAA | 2165 +---------------+---------------------------+---------------+ 2166 | 12 | tag-version | RFC-AAAA | 2167 +---------------+---------------------------+---------------+ 2168 | 13 | software-version | RFC-AAAA | 2169 +---------------+---------------------------+---------------+ 2170 | 14 | version-scheme | RFC-AAAA | 2171 +---------------+---------------------------+---------------+ 2172 | 15 | lang | RFC-AAAA | 2173 +---------------+---------------------------+---------------+ 2174 | 16 | directory | RFC-AAAA | 2175 +---------------+---------------------------+---------------+ 2176 | 17 | file | RFC-AAAA | 2177 +---------------+---------------------------+---------------+ 2178 | 18 | process | RFC-AAAA | 2179 +---------------+---------------------------+---------------+ 2180 | 19 | resource | RFC-AAAA | 2181 +---------------+---------------------------+---------------+ 2182 | 20 | size | RFC-AAAA | 2183 +---------------+---------------------------+---------------+ 2184 | 21 | file-version | RFC-AAAA | 2185 +---------------+---------------------------+---------------+ 2186 | 22 | key | RFC-AAAA | 2187 +---------------+---------------------------+---------------+ 2188 | 23 | location | RFC-AAAA | 2189 +---------------+---------------------------+---------------+ 2190 | 24 | fs-name | RFC-AAAA | 2191 +---------------+---------------------------+---------------+ 2192 | 25 | root | RFC-AAAA | 2193 +---------------+---------------------------+---------------+ 2194 | 26 | path-elements | RFC-AAAA | 2195 +---------------+---------------------------+---------------+ 2196 | 27 | process-name | RFC-AAAA | 2197 +---------------+---------------------------+---------------+ 2198 | 28 | pid | RFC-AAAA | 2199 +---------------+---------------------------+---------------+ 2200 | 29 | type | RFC-AAAA | 2201 +---------------+---------------------------+---------------+ 2202 | 31 | entity-name | RFC-AAAA | 2203 +---------------+---------------------------+---------------+ 2204 | 32 | reg-id | RFC-AAAA | 2205 +---------------+---------------------------+---------------+ 2206 | 33 | role | RFC-AAAA | 2207 +---------------+---------------------------+---------------+ 2208 | 34 | thumbprint | RFC-AAAA | 2209 +---------------+---------------------------+---------------+ 2210 | 35 | date | RFC-AAAA | 2211 +---------------+---------------------------+---------------+ 2212 | 36 | device-id | RFC-AAAA | 2213 +---------------+---------------------------+---------------+ 2214 | 37 | artifact | RFC-AAAA | 2215 +---------------+---------------------------+---------------+ 2216 | 38 | href | RFC-AAAA | 2217 +---------------+---------------------------+---------------+ 2218 | 39 | ownership | RFC-AAAA | 2219 +---------------+---------------------------+---------------+ 2220 | 40 | rel | RFC-AAAA | 2221 +---------------+---------------------------+---------------+ 2222 | 41 | media-type | RFC-AAAA | 2223 +---------------+---------------------------+---------------+ 2224 | 42 | use | RFC-AAAA | 2225 +---------------+---------------------------+---------------+ 2226 | 43 | activation-status | RFC-AAAA | 2227 +---------------+---------------------------+---------------+ 2228 | 44 | channel-type | RFC-AAAA | 2229 +---------------+---------------------------+---------------+ 2230 | 45 | colloquial-version | RFC-AAAA | 2231 +---------------+---------------------------+---------------+ 2232 | 46 | description | RFC-AAAA | 2233 +---------------+---------------------------+---------------+ 2234 | 47 | edition | RFC-AAAA | 2235 +---------------+---------------------------+---------------+ 2236 | 48 | entitlement-data-required | RFC-AAAA | 2237 +---------------+---------------------------+---------------+ 2238 | 49 | entitlement-key | RFC-AAAA | 2239 +---------------+---------------------------+---------------+ 2240 | 50 | generator | RFC-AAAA | 2241 +---------------+---------------------------+---------------+ 2242 | 51 | persistent-id | RFC-AAAA | 2243 +---------------+---------------------------+---------------+ 2244 | 52 | product | RFC-AAAA | 2245 +---------------+---------------------------+---------------+ 2246 | 53 | product-family | RFC-AAAA | 2247 +---------------+---------------------------+---------------+ 2248 | 54 | revision | RFC-AAAA | 2249 +---------------+---------------------------+---------------+ 2250 | 55 | summary | RFC-AAAA | 2251 +---------------+---------------------------+---------------+ 2252 | 56 | unspsc-code | RFC-AAAA | 2253 +---------------+---------------------------+---------------+ 2254 | 57 | unspsc-version | RFC-AAAA | 2255 +---------------+---------------------------+---------------+ 2256 | 58-4294967295 | Unassigned | | 2257 +---------------+---------------------------+---------------+ 2259 Table 9: CoSWID Items Inital Registrations 2261 6.2. Software Tag Values Registries 2263 The following IANA registries provide a mechanism for new values to 2264 be added over time to common enumerations used by SWID and CoSWID. 2266 6.2.1. Registration Procedures 2268 The following registries allow for the registration of index values 2269 and names. New registrations will be permitted through either the 2270 Standards Action policy or the Specification Required policy [BCP26]. 2271 New index values will be provided on a First Come First Served as 2272 defined by [BCP26]. 2274 The following registries also reserve the integer-based index values 2275 in the range of -1 to -256 for private use as defined by [BCP26] in 2276 Section 4.1. This allows values -1 to -24 to be expressed as a 2277 single uint_8t in CBOR, and values -25 to -256 to be expressed using 2278 an additional uint_8t in CBOR. 2280 6.2.2. Private Use of Index and Name Values 2282 The integer-based index values in the private use range (-1 to -256) 2283 are intended for testing purposes and closed environments; values in 2284 other ranges SHOULD NOT be assigned for testing. 2286 For names that correspond to private use index values, an 2287 Internationalized Domain Name prefix MUST be used to prevent name 2288 conflicts using the form: 2290 "domain.prefix-name" 2291 Where "domain.prefix" MUST be a valid Internationalized Domain Name 2292 as defined by [RFC5892], and "name" MUST be a unique name within the 2293 namespace defined by the "domain.prefix". Use of a prefix in this 2294 way allows for a name to be used initially in the private use range, 2295 and to be registered at a future point in time. This is consistent 2296 with the guidance in [BCP178]. 2298 6.2.3. Expert Review Guidelines 2300 Designated experts MUST ensure that new registration requests meet 2301 the following additional guidelines: 2303 * The requesting specification MUST provide a clear semantic 2304 definition for the new entry. This definition MUST clearly 2305 differentiate the requested entry from other previously registered 2306 entries. 2308 * The requesting specification MUST describe the intended use of the 2309 entry, including any co-constraints that exist between the use of 2310 the entry's index value or name, and other values defined within 2311 the SWID/CoSWID model. 2313 * Index values and names outside the private use space MUST NOT be 2314 used without registration. This is considered squatting and 2315 SHOULD be avoided. Designated experts MUST ensure that reviewed 2316 specifications register all appropriate index values and names. 2318 * Standards track documents MAY include entries registered in the 2319 range reserved for entries under the Specification Required 2320 policy. This can occur when a standards track document provides 2321 further guidance on the use of index values and names that are in 2322 common use, but were not registered with IANA. This situation 2323 SHOULD be avoided. 2325 * All registered names MUST be valid according to the XML Schema 2326 NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] 2327 Section 3.3.4). This ensures that registered names are compatible 2328 with the SWID format [SWID] where they are used. 2330 * Registration of vanity names SHOULD be discouraged. The 2331 requesting specification MUST provide a description of how a 2332 requested name will allow for use by multiple stakeholders. 2334 6.2.4. Software Tag Version Scheme Values Registry 2336 This document establishes a new registry titled "Software Tag Version 2337 Scheme Values". This registry provides index values for use as 2338 version-scheme item values in this document and version scheme names 2339 for use in [SWID]. 2341 [TO BE REMOVED: This registration should take place at the following 2342 location: https://www.iana.org/assignments/swid] 2344 This registry uses the registration procedures defined in 2345 Section 6.2.1 with the following associated ranges: 2347 +=============+=========================+ 2348 | Range | Registration Procedures | 2349 +=============+=========================+ 2350 | 0-16383 | Standards Action | 2351 +-------------+-------------------------+ 2352 | 16384-65535 | Specification Required | 2353 +-------------+-------------------------+ 2355 Table 10: CoSWID Version Scheme 2356 Registration Procedures 2358 Assignments MUST consist of an integer Index value, the Version 2359 Scheme Name, and a reference to the defining specification. 2361 Initial registrations for the "Software Tag Version Scheme Values" 2362 registry are provided below, which are derived from the textual 2363 version scheme names defined in [SWID]. 2365 +=============+=========================+=================+ 2366 | Index | Version Scheme Name | Specification | 2367 +=============+=========================+=================+ 2368 | 0 | Reserved | | 2369 +-------------+-------------------------+-----------------+ 2370 | 1 | multipartnumeric | See Section 4.1 | 2371 +-------------+-------------------------+-----------------+ 2372 | 2 | multipartnumeric+suffix | See Section 4.1 | 2373 +-------------+-------------------------+-----------------+ 2374 | 3 | alphanumeric | See Section 4.1 | 2375 +-------------+-------------------------+-----------------+ 2376 | 4 | decimal | See Section 4.1 | 2377 +-------------+-------------------------+-----------------+ 2378 | 5-16383 | Unassigned | | 2379 +-------------+-------------------------+-----------------+ 2380 | 16384 | semver | See Section 4.1 | 2381 +-------------+-------------------------+-----------------+ 2382 | 16385-65535 | Unassigned | | 2383 +-------------+-------------------------+-----------------+ 2385 Table 11: CoSWID Version Scheme Initial Registrations 2387 Registrations MUST conform to the expert review guidelines defined in 2388 Section 6.2.3. 2390 Designated experts MUST also ensure that newly requested entries 2391 define a value space for the corresponding version item that is 2392 unique from other previously registered entries. Note: The initial 2393 registrations violate this requirement, but are included for 2394 backwards compatibility with [SWID]. Guidelines on how to deconflict 2395 these value spaces are defined in Section 4.1. 2397 6.2.5. Software Tag Entity Role Values Registry 2399 This document establishes a new registry titled "Software Tag Entity 2400 Role Values". This registry provides index values for use as entity- 2401 entry role item values in this document and entity role names for use 2402 in [SWID]. 2404 [TO BE REMOVED: This registration should take place at the following 2405 location: https://www.iana.org/assignments/swid] 2407 This registry uses the registration procedures defined in 2408 Section 6.2.1 with the following associated ranges: 2410 +=========+=========================+ 2411 | Range | Registration Procedures | 2412 +=========+=========================+ 2413 | 0-127 | Standards Action | 2414 +---------+-------------------------+ 2415 | 128-255 | Specification Required | 2416 +---------+-------------------------+ 2418 Table 12: CoSWID Entity Role 2419 Registration Procedures 2421 Assignments consist of an integer Index value, a Role Name, and a 2422 reference to the defining specification. 2424 Initial registrations for the "Software Tag Entity Role Values" 2425 registry are provided below, which are derived from the textual 2426 entity role names defined in [SWID]. 2428 +=======+=================+=================+ 2429 | Index | Role Name | Specification | 2430 +=======+=================+=================+ 2431 | 0 | Reserved | | 2432 +-------+-----------------+-----------------+ 2433 | 1 | tagCreator | See Section 4.2 | 2434 +-------+-----------------+-----------------+ 2435 | 2 | softwareCreator | See Section 4.2 | 2436 +-------+-----------------+-----------------+ 2437 | 3 | aggregator | See Section 4.2 | 2438 +-------+-----------------+-----------------+ 2439 | 4 | distributor | See Section 4.2 | 2440 +-------+-----------------+-----------------+ 2441 | 5 | licensor | See Section 4.2 | 2442 +-------+-----------------+-----------------+ 2443 | 6 | maintainer | See Section 4.2 | 2444 +-------+-----------------+-----------------+ 2445 | 7-255 | Unassigned | | 2446 +-------+-----------------+-----------------+ 2448 Table 13: CoSWID Entity Role Initial 2449 Registrations 2451 Registrations MUST conform to the expert review guidelines defined in 2452 Section 6.2.3. 2454 6.2.6. Software Tag Link Ownership Values Registry 2456 This document establishes a new registry titled "Software Tag Link 2457 Ownership Values". This registry provides index values for use as 2458 link-entry ownership item values in this document and link ownership 2459 names for use in [SWID]. 2461 [TO BE REMOVED: This registration should take place at the following 2462 location: https://www.iana.org/assignments/swid] 2464 This registry uses the registration procedures defined in 2465 Section 6.2.1 with the following associated ranges: 2467 +=========+=========================+ 2468 | Range | Registration Procedures | 2469 +=========+=========================+ 2470 | 0-127 | Standards Action | 2471 +---------+-------------------------+ 2472 | 128-255 | Specification Required | 2473 +---------+-------------------------+ 2475 Table 14: CoSWID Link Ownership 2476 Registration Procedures 2478 Assignments consist of an integer Index value, an Ownership Type 2479 Name, and a reference to the defining specification. 2481 Initial registrations for the "Software Tag Link Ownership Values" 2482 registry are provided below, which are derived from the textual 2483 entity role names defined in [SWID]. 2485 +=======+=====================+=================+ 2486 | Index | Ownership Type Name | Definition | 2487 +=======+=====================+=================+ 2488 | 0 | Reserved | | 2489 +-------+---------------------+-----------------+ 2490 | 1 | abandon | See Section 4.3 | 2491 +-------+---------------------+-----------------+ 2492 | 2 | private | See Section 4.3 | 2493 +-------+---------------------+-----------------+ 2494 | 3 | shared | See Section 4.3 | 2495 +-------+---------------------+-----------------+ 2496 | 4-255 | Unassigned | | 2497 +-------+---------------------+-----------------+ 2499 Table 15: CoSWID Link Ownership Inital 2500 Registrations 2502 Registrations MUST conform to the expert review guidelines defined in 2503 Section 6.2.3. 2505 6.2.7. Software Tag Link Relationship Values Registry 2507 This document establishes a new registry titled "Software Tag Link 2508 Relationship Values". This registry provides index values for use as 2509 link-entry rel item values in this document and link ownership names 2510 for use in [SWID]. 2512 [TO BE REMOVED: This registration should take place at the following 2513 location: https://www.iana.org/assignments/swid] 2515 This registry uses the registration procedures defined in 2516 Section 6.2.1 with the following associated ranges: 2518 +=============+=========================+ 2519 | Range | Registration Procedures | 2520 +=============+=========================+ 2521 | 0-32767 | Standards Action | 2522 +-------------+-------------------------+ 2523 | 32768-65535 | Specification Required | 2524 +-------------+-------------------------+ 2526 Table 16: CoSWID Link Relationship 2527 Registration Procedures 2529 Assignments consist of an integer Index value, the Relationship Type 2530 Name, and a reference to the defining specification. 2532 Initial registrations for the "Software Tag Link Relationship Values" 2533 registry are provided below, which are derived from the link 2534 relationship values defined in [SWID]. 2536 +==========+========================+=================+ 2537 | Index | Relationship Type Name | Specification | 2538 +==========+========================+=================+ 2539 | 0 | Reserved | | 2540 +----------+------------------------+-----------------+ 2541 | 1 | ancestor | See Section 4.4 | 2542 +----------+------------------------+-----------------+ 2543 | 2 | component | See Section 4.4 | 2544 +----------+------------------------+-----------------+ 2545 | 3 | feature | See Section 4.4 | 2546 +----------+------------------------+-----------------+ 2547 | 4 | installationmedia | See Section 4.4 | 2548 +----------+------------------------+-----------------+ 2549 | 5 | packageinstaller | See Section 4.4 | 2550 +----------+------------------------+-----------------+ 2551 | 6 | parent | See Section 4.4 | 2552 +----------+------------------------+-----------------+ 2553 | 7 | patches | See Section 4.4 | 2554 +----------+------------------------+-----------------+ 2555 | 8 | requires | See Section 4.4 | 2556 +----------+------------------------+-----------------+ 2557 | 9 | see-also | See Section 4.4 | 2558 +----------+------------------------+-----------------+ 2559 | 10 | supersedes | See Section 4.4 | 2560 +----------+------------------------+-----------------+ 2561 | 11 | supplemental | See Section 4.4 | 2562 +----------+------------------------+-----------------+ 2563 | 12-65535 | Unassigned | | 2564 +----------+------------------------+-----------------+ 2566 Table 17: CoSWID Link Relationship Initial 2567 Registrations 2569 Registrations MUST conform to the expert review guidelines defined in 2570 Section 6.2.3. 2572 Designated experts MUST also ensure that a newly requested entry 2573 documents the URI schemes allowed to be used in an href associated 2574 with the link relationship and the expected resolution behavior of 2575 these URI schemes. This will help to ensure that applications 2576 processing software tags are able to interoperate when resolving 2577 resources referenced by a link of a given type. 2579 6.2.8. Software Tag Link Use Values Registry 2581 This document establishes a new registry titled "Software Tag Link 2582 Use Values". This registry provides index values for use as link- 2583 entry use item values in this document and link use names for use in 2584 [SWID]. 2586 [TO BE REMOVED: This registration should take place at the following 2587 location: https://www.iana.org/assignments/swid] 2589 This registry uses the registration procedures defined in 2590 Section 6.2.1 with the following associated ranges: 2592 +=========+=========================+ 2593 | Range | Registration Procedures | 2594 +=========+=========================+ 2595 | 0-127 | Standards Action | 2596 +---------+-------------------------+ 2597 | 128-255 | Specification Required | 2598 +---------+-------------------------+ 2600 Table 18: CoSWID Link Use 2601 Registration Procedures 2603 Assignments consist of an integer Index value, the Link Use Type 2604 Name, and a reference to the defining specification. 2606 Initial registrations for the "Software Tag Link Use Values" registry 2607 are provided below, which are derived from the link relationship 2608 values defined in [SWID]. 2610 +=======+====================+=================+ 2611 | Index | Link Use Type Name | Specification | 2612 +=======+====================+=================+ 2613 | 0 | Reserved | | 2614 +-------+--------------------+-----------------+ 2615 | 1 | optional | See Section 4.5 | 2616 +-------+--------------------+-----------------+ 2617 | 2 | required | See Section 4.5 | 2618 +-------+--------------------+-----------------+ 2619 | 3 | recommended | See Section 4.5 | 2620 +-------+--------------------+-----------------+ 2621 | 4-255 | Unassigned | | 2622 +-------+--------------------+-----------------+ 2624 Table 19: CoSWID Link Use Initial Registrations 2626 Registrations MUST conform to the expert review guidelines defined in 2627 Section 6.2.3. 2629 6.3. swid+cbor Media Type Registration 2631 *_TODO: Per Section 5.1 of RFC6838, was a message sent to media- 2632 types@iana.org for preliminary review? I didn't see it on that 2633 mailing list (did I miss it?). Please kick that off._* 2635 IANA is requested to add the following to the IANA "Media Types" 2636 registry [IANA.media-types]. 2638 Type name: application 2640 Subtype name: swid+cbor 2642 Required parameters: none 2644 Optional parameters: none 2646 Encoding considerations: Must be encoded as using [RFC8949]. See 2647 RFC-AAAA for details. 2649 Security considerations: See Section 9 of RFC-AAAA. 2651 Interoperability considerations: Applications MAY ignore any key 2652 value pairs that they do not understand. This allows backwards 2653 compatible extensions to this specification. 2655 Published specification: RFC-AAAA 2657 Applications that use this media type: The type is used by software 2658 asset management systems, vulnerability assessment systems, and in 2659 applications that use remote integrity verification. 2661 Fragment identifier considerations: Fragment identification for 2662 application/swid+cbor is supported by using fragment identifiers as 2663 specified by Section 9.5 of [RFC8949]. 2665 Additional information: 2667 Magic number(s): first five bytes in hex: da 53 57 49 44 2669 File extension(s): coswid 2671 Macintosh file type code(s): none 2672 Macintosh Universal Type Identifier code: org.ietf.coswid conforms to 2673 public.data 2675 Person & email address to contact for further information: Henk 2676 Birkholz 2678 Intended usage: COMMON 2680 Restrictions on usage: None 2682 Author: Henk Birkholz 2684 Change controller: IESG 2686 6.4. CoAP Content-Format Registration 2688 IANA is requested to assign a CoAP Content-Format ID for the CoSWID 2689 media type in the "CoAP Content-Formats" sub-registry, from the "IETF 2690 Review or IESG Approval" space (256..999), within the "CoRE 2691 Parameters" registry [RFC7252] [IANA.core-parameters]: 2693 +=======================+==========+======+===========+ 2694 | Media type | Encoding | ID | Reference | 2695 +=======================+==========+======+===========+ 2696 | application/swid+cbor | - | TBD1 | RFC-AAAA | 2697 +-----------------------+----------+------+-----------+ 2699 Table 20: CoAP Content-Format IDs 2701 6.5. CBOR Tag Registration 2703 IANA is requested to allocate a tag in the "CBOR Tags" registry 2704 [IANA.cbor-tags], preferably with the specific value requested: 2706 +============+===========+=============================+ 2707 | Tag | Data Item | Semantics | 2708 +============+===========+=============================+ 2709 | 1398229316 | map | Concise Software Identifier | 2710 | | | (CoSWID) [RFC-AAAA] | 2711 +------------+-----------+-----------------------------+ 2713 Table 21: CoSWID CBOR Tag 2715 6.6. URI Scheme Registrations 2717 The ISO 19770-2:2015 SWID specification describes use of the "swid" 2718 and "swidpath" URI schemes, which are currently in use in 2719 implementations. This document continues this use for CoSWID. The 2720 following subsections provide registrations for these schemes in to 2721 ensure that a permanent registration exists for these schemes that is 2722 suitable for use in the SWID and CoSWID specifications. 2724 URI schemes are registered within the "Uniform Resource Identifier 2725 (URI) Schemes" registry maintained at [IANA.uri-schemes]. 2727 6.6.1. URI-scheme swid 2729 IANA is requested to register the URI scheme "swid". This 2730 registration request complies with [RFC7595]. 2732 Scheme name: 2733 swid 2735 Status: 2736 Permanent 2738 Applications/protocols that use this scheme name: 2739 Applications that require Software-IDs (SWIDs) or Concise 2740 Software-IDs (CoSWIDs); see Section 5.1 of RFC-AAAA. 2742 Contact: 2743 IETF Chair 2745 Change controller: 2746 IESG 2748 Reference: 2749 Section 5.1 in RFC-AAAA 2751 6.6.2. URI-scheme swidpath 2753 IANA is requested to register the URI scheme "swidpath". This 2754 registration request complies with [RFC7595]. 2756 Scheme name: 2757 swidpath 2759 Status: 2760 Permanent 2762 Applications/protocols that use this scheme name: 2764 Applications that require Software-IDs (SWIDs) or Concise 2765 Software-IDs (CoSWIDs); see Section 5.2 of RFC-AAAA. 2767 Contact: 2768 IETF Chair 2770 Change controller: 2771 IESG 2773 Reference: 2774 Section 5.2 in RFC-AAAA 2776 6.7. CoSWID Model for use in SWIMA Registration 2778 The Software Inventory Message and Attributes (SWIMA) for PA-TNC 2779 specification [RFC8412] defines a standardized method for collecting 2780 an endpoint device's software inventory. A CoSWID can provide 2781 evidence of software installation which can then be used and 2782 exchanged with SWIMA. This registration adds a new entry to the IANA 2783 "Software Data Model Types" registry defined by [RFC8412] 2784 [IANA.pa-tnc-parameters] to support CoSWID use in SWIMA as follows: 2786 Pen: 0 2788 Integer: TBD2 2790 Name: Concise Software Identifier (CoSWID) 2792 Reference: RFC-AAAA 2794 Deriving Software Identifiers: 2796 A Software Identifier generated from a CoSWID tag is expressed as a 2797 concatenation of the form in [RFC5234] as follows: 2799 TAG_CREATOR_REGID "_" "_" UNIQUE_ID 2801 Where TAG_CREATOR_REGID is the reg-id item value of the tag's entity 2802 item having the role value of 1 (corresponding to "tag creator"), and 2803 the UNIQUE_ID is the same tag's tag-id item. If the tag-id item's 2804 value is expressed as a 16 byte binary string, the UNIQUE_ID MUST be 2805 represented using the UUID string representation defined in [RFC4122] 2806 including the "urn:uuid:" prefix. 2808 The TAG_CREATOR_REGID and the UNIQUE_ID are connected with a double 2809 underscore (_), without any other connecting character or whitespace. 2811 7. Signed CoSWID Tags 2813 SWID tags, as defined in the ISO-19770-2:2015 XML schema, can include 2814 cryptographic signatures to protect the integrity of the SWID tag. 2815 In general, tags are signed by the tag creator (typically, although 2816 not exclusively, the vendor of the software component that the SWID 2817 tag identifies). Cryptographic signatures can make any modification 2818 of the tag detectable, which is especially important if the integrity 2819 of the tag is important, such as when the tag is providing reference 2820 integrity measurements for files. The ISO-19770-2:2015 XML schema 2821 uses XML DSIG to support cryptographic signatures. 2823 Signing CoSWID tags follows the procedures defined in CBOR Object 2824 Signing and Encryption [RFC8152]. A CoSWID tag MUST be wrapped in a 2825 COSE Single Signer Data Object (COSE_Sign1) that contains a single 2826 signature and MUST be signed by the tag creator. The following CDDL 2827 specification defines a restrictive subset of COSE header parameters 2828 that MUST be used in the protected header. 2830 2831 COSE-Sign1-coswid = [ 2832 protected: bstr .cbor protected-signed-coswid-header, 2833 unprotected: unprotected-signed-coswid-header, 2834 payload: bstr .cbor payload, 2835 signature: bstr, 2836 ] 2838 cose-label = int / tstr 2839 cose-values = any 2841 protected-signed-coswid-header = { 2842 1 => int, ; algorithm identifier 2843 3 => "application/swid+cbor", 2844 4 => bstr, ; key identifier 2845 * cose-label => cose-values, 2846 } 2848 unprotected-signed-coswid-header = { 2849 * cose-label => cose-values, 2850 } 2851 2853 The COSE_Sign structure that allows for more than one signature to be 2854 applied to a CoSWID tag MAY be used. The corresponding usage 2855 scenarios are domain-specific and require well-specified application 2856 guidance. 2858 2859 COSE-Sign-coswid = [ 2860 protected: bstr .cbor protected-signed-coswid-header1, 2861 unprotected: unprotected-signed-coswid-header, 2862 payload: bstr .cbor payload, 2863 signature: [ * COSE_Signature ], 2864 ] 2866 protected-signed-coswid-header1 = { 2867 3 => "application/swid+cbor", 2868 * cose-label => cose-values, 2869 } 2871 protected-signature-coswid-header = { 2872 1 => int, ; algorithm identifier 2873 4 => bstr, ; key identifier 2874 * cose-label => cose-values, 2875 } 2877 unprotected-sign-coswid-header = { 2878 * cose-label => cose-values, 2879 } 2881 COSE_Signature = [ 2882 protected: bstr .cbor protected-signature-coswid-header, 2883 unprotected: unprotected-sign-coswid-header, 2884 signature : bstr 2885 ] 2886 2888 Additionally, the COSE Header counter signature MAY be used as an 2889 attribute in the unprotected header map of the COSE envelope of a 2890 CoSWID. The application of counter signing enables second parties to 2891 provide a signature on a signature allowing for a proof that a 2892 signature existed at a given time (i.e., a timestamp). 2894 A CoSWID SHOULD be signed, using the above mechanism, to protect the 2895 integrity of the CoSWID tag. See the security considerations (in 2896 Section 9) for more information on why a signed CoSWID is valuable in 2897 most cases. 2899 8. Tagged CoSWID Tags 2901 This specification allows for tagged and untagged CBOR data items 2902 that are CoSWID tags. Consecutively, the CBOR tag for CoSWID tags 2903 defined in Table 21 SHOULD be used in conjunction with CBOR data 2904 items that are a CoSWID tags. Other CBOR tags MUST NOT be used with 2905 a CBOR data item that is a CoSWID tag. If tagged, both signed and 2906 unsigned CoSWID tags MUST use the CoSWID CBOR tag. In case a signed 2907 CoSWID is tagged, a CoSWID CBOR tag MUST be appended before the COSE 2908 envelope whether it is a COSE_Untagged_Message or a 2909 COSE_Tagged_Message. In case an unsigned CoSWID is tagged, a CoSWID 2910 CBOR tag MUST be appended before the CBOR data item that is the 2911 CoSWID tag. 2913 2914 coswid = unsigned-coswid / signed-coswid 2915 unsigned-coswid = concise-swid-tag / tagged-coswid 2916 signed-coswid1 = signed-coswid-for 2917 signed-coswid = signed-coswid1 / tagged-coswid 2919 tagged-coswid = #6.1398229316(T) 2921 signed-coswid-for = #6.18(COSE-Sign1-coswid) 2922 / #6.98(COSE-Sign-coswid) 2923 2925 This specification allows for a tagged CoSWID tag to reside in a COSE 2926 envelope that is also tagged with a CoSWID CBOR tag. In cases where 2927 a tag creator is not a signer (e.g., hand-offs between entities in a 2928 trusted portion of a supply-chain), retaining CBOR tags attached to 2929 unsigned CoSWID tags can be of great use. Nevertheless, redundant 2930 use of tags SHOULD be avoided when possible. 2932 9. Security Considerations 2934 The following security considerations for use of CoSWID tags focus 2935 on: 2937 * ensuring the integrity and authenticity of a CoSWID tag 2939 * the application of CoSWID tags to address security challenges 2940 related to unmanaged or unpatched software 2942 * reducing the potential for unintended disclosure of a device's 2943 software load 2945 A tag is considered "authoritative" if the CoSWID tag was created by 2946 the software provider. An authoritative CoSWID tag contains 2947 information about a software component provided by the supplier of 2948 the software component, who is expected to be an expert in their own 2949 software. Thus, authoritative CoSWID tags can represent 2950 authoritative information about the software component. The degree 2951 to which this information can be trusted depends on the tag's chain 2952 of custody and the ability to verify a signature provided by the 2953 supplier if present in the CoSWID tag. The provisioning and 2954 validation of CoSWID tags are handled by local policy and is outside 2955 the scope of this document. 2957 A signed CoSWID tag (see Section 7) whose signature has been 2958 validated can be relied upon to be unchanged since it was signed. By 2959 contrast, the data contained in unsigned tags can be altered by any 2960 user or process with write-access to the tag. To support signature 2961 validation, there is the need associate the right key with the 2962 software provider or party originating the signature. This operation 2963 is application specific and needs to be addressed by the application 2964 or a user of the application; a specific approach for which is out- 2965 of-scope for this document. 2967 When an authoritative tag is signed, the originator of the signature 2968 can be verified. A trustworthy association between the signature and 2969 the originator of the signature can be established via trust anchors. 2970 A certification path between a trust anchor and a certificate 2971 including a public key enabling the validation of a tag signature can 2972 realize the assessment of trustworthiness of an authoritative tag. 2973 Verifying that the software provider is the signer is a different 2974 matter. This requires an association between the signature and the 2975 tag's entity item associated corresponding to the software provider. 2976 No mechanism is defined in this draft to make this association; 2977 therefore, this association will need to be handled by local policy. 2979 CoSWID tags are intended to contain public information about software 2980 components and, as such, the contents of a CoSWID tag does not need 2981 to be protected against unintended disclosure on an endpoint. 2983 CoSWID tags are intended to be easily discoverable by authorized 2984 applications and users on an endpoint in order to make it easy to 2985 determine the tagged software load. Access to the collection of an 2986 endpoint's SWID tags needs to be appropriately controlled to 2987 authorized applications and users using an appropriate access control 2988 mechanism. 2990 CoSWID tags are designed to be easily added and removed from an 2991 endpoint along with the installation or removal of software 2992 components. On endpoints where addition or removal of software 2993 components is tightly controlled, the addition or removal of SWID 2994 tags can be similarly controlled. On more open systems, where many 2995 users can manage the software inventory, CoSWID tags can be easier to 2996 add or remove. On such systems, it can be possible to add or remove 2997 CoSWID tags in a way that does not reflect the actual presence or 2998 absence of corresponding software components. Similarly, not all 2999 software products automatically install CoSWID tags, so products can 3000 be present on an endpoint without providing a corresponding SWID tag. 3001 As such, any collection of CoSWID tags cannot automatically be 3002 assumed to represent either a complete or fully accurate 3003 representation of the software inventory of the endpoint. However, 3004 especially on endpoint devices that more strictly control the ability 3005 to add or remove applications, CoSWID tags are an easy way to provide 3006 an preliminary understanding of that endpoint's software inventory. 3008 Any report of an endpoint's CoSWID tag collection provides 3009 information about the software inventory of that endpoint. If such a 3010 report is exposed to an attacker, this can tell them which software 3011 products and versions thereof are present on the endpoint. By 3012 examining this list, the attacker might learn of the presence of 3013 applications that are vulnerable to certain types of attacks. As 3014 noted earlier, CoSWID tags are designed to be easily discoverable by 3015 an endpoint, but this does not present a significant risk since an 3016 attacker would already need to have access to the endpoint to view 3017 that information. However, when the endpoint transmits its software 3018 inventory to another party, or that inventory is stored on a server 3019 for later analysis, this can potentially expose this information to 3020 attackers who do not yet have access to the endpoint. For this 3021 reason, it is important to protect the confidentiality of CoSWID tag 3022 information that has been collected from an endpoint in transit and 3023 at rest, not because those tags individually contain sensitive 3024 information, but because the collection of CoSWID tags and their 3025 association with an endpoint reveals information about that 3026 endpoint's attack surface. 3028 Finally, both the ISO-19770-2:2015 XML schema SWID definition and the 3029 CoSWID CDDL specification allow for the construction of "infinite" 3030 tags with link item loops or tags that contain malicious content with 3031 the intent of creating non-deterministic states during validation or 3032 processing of those tags. While software providers are unlikely to 3033 do this, CoSWID tags can be created by any party and the CoSWID tags 3034 collected from an endpoint could contain a mixture of vendor and non- 3035 vendor created tags. For this reason, a CoSWID tag might contain 3036 potentially malicious content. Input sanitization, loop detection, 3037 and signature verification are ways that implementations can address 3038 this concern. 3040 10. Change Log 3042 This section is to be removed before publishing as an RFC. 3044 [THIS SECTION TO BE REMOVED BY THE RFC EDITOR.] 3046 Changes from version 12 to version 14: 3048 * Moved key identifier to protected COSE header 3050 * Fixed index reference for hash 3052 * Removed indirection of CDDL type definition for filesystem-item 3054 * Fixed quantity of resource and process 3056 * Updated resource-collection 3058 * Renamed socket name in software-meta to be consistent in naming 3060 * Aligned excerpt examples in I-D text with full CDDL 3062 * Fixed titles where title was referring to group instead of map 3064 * Added missing date in SEMVER 3066 * Fixed root cardinality for file and directory, etc. 3068 * Transformed path-elements-entry from map to group for re-usability 3070 * Scrubbed IANA Section 3072 * Removed redundant supplemental rule 3074 * Aligned discrepancy with ISO spec. 3076 * Addressed comments on typos. 3078 * Fixed kramdown nits and BCP reference. 3080 * Addressed comments from WGLC reviewers. 3082 Changes in version 12: 3084 * Addressed a bunch of minor editorial issues based on WGLC 3085 feedback. 3087 * Added text about the use of UTF-8 in CoSWID. 3089 * Adjusted tag-id to allow for a UUID to be provided as a bstr. 3091 * Cleaned up descriptions of index ranges throughout the document, 3092 removing discussion of 8 bit, 16 bit, etc. 3094 * Adjusted discussion of private use ranges to use negative integer 3095 values and to be more clear throughout the document. 3097 * Added discussion around resolving overlapping value spaces for 3098 version schemes. 3100 * Added a set of expert review guidelines for new IANA registries 3101 created by this document. 3103 * Added new registrations for the "swid" and "swidpath" URI schemes, 3104 and for using CoSWID with SWIMA. 3106 Changes from version 03 to version 11: 3108 * Reduced representation complexity of the media-entry type and 3109 removed the Section describing the older data structure. 3111 * Added more signature schemes from COSE 3113 * Included a minimal required set of normative language 3115 * Reordering of attribute name to integer label by priority 3116 according to semantics. 3118 * Added an IANA registry for CoSWID items supporting future 3119 extension. 3121 * Cleaned up IANA registrations, fixing some inconsistencies in the 3122 table labels. 3124 * Added additional CDDL sockets for resource collection entries 3125 providing for additional extension points to address future SWID/ 3126 CoSWID extensions. 3128 * Updated Section on extension points to address new CDDL sockets 3129 and to reference the new IANA registry for items. 3131 * Removed unused references and added new references to address 3132 placeholder comments. 3134 * Added table with semantics for the link ownership item. 3136 * Clarified language, made term use more consistent, fixed 3137 references, and replacing lowercase RFC2119 keywords. 3139 Changes from version 02 to version 03: 3141 * Updated core CDDL including the CDDL design pattern according to 3142 RFC 8428. 3144 Changes from version 01 to version 02: 3146 * Enforced a more strict separation between the core CoSWID 3147 definition and additional usage by moving content to corresponding 3148 appendices. 3150 * Removed artifacts inherited from the reference schema provided by 3151 ISO (e.g. NMTOKEN(S)) 3153 * Simplified the core data definition by removing group and type 3154 choices where possible 3156 * Minor reordering of map members 3158 * Added a first extension point to address requested flexibility for 3159 extensions beyond the any-element 3161 Changes from version 00 to version 01: 3163 * Ambiguity between evidence and payload eliminated by introducing 3164 explicit members (while still 3166 * allowing for "empty" SWID tags) 3168 * Added a relatively restrictive COSE envelope using cose_sign1 to 3169 define signed CoSWID (single signer only, at the moment) 3171 * Added a definition how to encode hashes that can be stored in the 3172 any-member using existing IANA tables to reference hash-algorithms 3174 Changes since adopted as a WG I-D -00: 3176 * Removed redundant any-attributes originating from the ISO- 3177 19770-2:2015 XML schema definition 3179 * Fixed broken multi-map members 3181 * Introduced a more restrictive item (any-element-map) to represent 3182 custom maps, increased restriction on types for the any-attribute, 3183 accordingly 3185 * Fixed X.1520 reference 3187 * Minor type changes of some attributes (e.g. NMTOKENS) 3189 * Added semantic differentiation of various name types (e,g. fs- 3190 name) 3192 Changes from version 06 to version 07: 3194 * Added type choices/enumerations based on textual definitions in 3195 19770-2:2015 3197 * Added value registry request 3199 * Added media type registration request 3201 * Added content format registration request 3203 * Added CBOR tag registration request 3205 * Removed RIM appendix to be addressed in complementary draft 3207 * Removed CWT appendix 3209 * Flagged firmware resource collection appendix for revision 3211 * Made use of terminology more consistent 3213 * Better defined use of extension points in the CDDL 3215 * Added definitions for indexed values 3217 * Added IANA registry for Link use indexed values 3219 Changes from version 05 to version 06: 3221 * Improved quantities 3223 * Included proposals for implicit enumerations that were NMTOKENS 3225 * Added extension points 3227 * Improved exemplary firmware-resource extension 3229 Changes from version 04 to version 05: 3231 * Clarified language around SWID and CoSWID to make more consistent 3232 use of these terms. 3234 * Added language describing CBOR optimizations for single vs. arrays 3235 in the model front matter. 3237 * Fixed a number of grammatical, spelling, and wording issues. 3239 * Documented extension points that use CDDL sockets. 3241 * Converted IANA registration tables to markdown tables, reserving 3242 the 0 value for use when a value is not known. 3244 * Updated a number of references to their current versions. 3246 Changes from version 03 to version 04: 3248 * Re-index label values in the CDDL. 3250 * Added a Section describing the CoSWID model in detail. 3252 * Created IANA registries for entity-role and version-scheme 3254 Changes from version 02 to version 03: 3256 * Updated CDDL to allow for a choice between a payload or evidence 3258 * Re-index label values in the CDDL. 3260 * Added item definitions 3262 * Updated references for COSE, CBOR Web Token, and CDDL. 3264 Changes from version 01 to version 02: 3266 * Added extensions for Firmware and CoSWID use as Reference 3267 Integrity Measurements (CoSWID RIM) 3269 * Changes meta handling in CDDL from use of an explicit use of items 3270 to a more flexible unconstrained collection of items. 3272 * Added Sections discussing use of COSE Signatures and CBOR Web 3273 Tokens 3275 Changes from version 00 to version 01: 3277 * Added CWT usage for absolute SWID paths on a device 3279 * Fixed cardinality of type-choices including arrays 3281 * Included first iteration of firmware resource-collection 3283 11. References 3285 11.1. Normative References 3287 [BCP178] Saint-Andre, P., Crocker, D., and M. Nottingham, 3288 "Deprecating the "X-" Prefix and Similar Constructs in 3289 Application Protocols", BCP 178, RFC 6648, 3290 DOI 10.17487/RFC6648, June 2012, 3291 . 3293 [BCP26] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 3294 Writing an IANA Considerations Section in RFCs", BCP 26, 3295 RFC 8126, DOI 10.17487/RFC8126, June 2017, 3296 . 3298 [IANA.cbor-tags] 3299 IANA, "Concise Binary Object Representation (CBOR) Tags", 3300 . 3302 [IANA.core-parameters] 3303 IANA, "Constrained RESTful Environments (CoRE) 3304 Parameters", 3305 . 3307 [IANA.media-types] 3308 IANA, "Media Types", 3309 . 3311 [IANA.named-information] 3312 IANA, "Named Information", 3313 . 3315 [IANA.pa-tnc-parameters] 3316 IANA, "Posture Attribute (PA) Protocol Compatible with 3317 Trusted Network Connect (TNC) Parameters", 3318 . 3320 [IANA.uri-schemes] 3321 IANA, "Uniform Resource Identifier (URI) Schemes", 3322 . 3324 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 3325 Requirement Levels", BCP 14, RFC 2119, 3326 DOI 10.17487/RFC2119, March 1997, 3327 . 3329 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 3330 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 3331 2003, . 3333 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 3334 Resource Identifier (URI): Generic Syntax", STD 66, 3335 RFC 3986, DOI 10.17487/RFC3986, January 2005, 3336 . 3338 [RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network 3339 Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008, 3340 . 3342 [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 3343 Specifications: ABNF", STD 68, RFC 5234, 3344 DOI 10.17487/RFC5234, January 2008, 3345 . 3347 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 3348 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 3349 September 2009, . 3351 [RFC5892] Faltstrom, P., Ed., "The Unicode Code Points and 3352 Internationalized Domain Names for Applications (IDNA)", 3353 RFC 5892, DOI 10.17487/RFC5892, August 2010, 3354 . 3356 [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained 3357 Application Protocol (CoAP)", RFC 7252, 3358 DOI 10.17487/RFC7252, June 2014, 3359 . 3361 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 3362 Writing an IANA Considerations Section in RFCs", BCP 26, 3363 RFC 8126, DOI 10.17487/RFC8126, June 2017, 3364 . 3366 [RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)", 3367 RFC 8152, DOI 10.17487/RFC8152, July 2017, 3368 . 3370 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 3371 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 3372 May 2017, . 3374 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 3375 DOI 10.17487/RFC8288, October 2017, 3376 . 3378 [RFC8412] Schmidt, C., Haynes, D., Coffin, C., Waltermire, D., and 3379 J. Fitzgerald-McKay, "Software Inventory Message and 3380 Attributes (SWIMA) for PA-TNC", RFC 8412, 3381 DOI 10.17487/RFC8412, July 2018, 3382 . 3384 [RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data 3385 Definition Language (CDDL): A Notational Convention to 3386 Express Concise Binary Object Representation (CBOR) and 3387 JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610, 3388 June 2019, . 3390 [RFC8949] Bormann, C. and P. Hoffman, "Concise Binary Object 3391 Representation (CBOR)", STD 94, RFC 8949, 3392 DOI 10.17487/RFC8949, December 2020, 3393 . 3395 [SAM] "Information technology - Software asset management - Part 3396 5: Overview and vocabulary", ISO/IEC 19770-5:2015, 15 3397 November 2013. 3399 [SEMVER] Preston-Werner, T., "Semantic Versioning 2.0.0", 3400 . 3402 [SWID] "Information technology - Software asset management - Part 3403 2: Software identification tag", ISO/IEC 19770-2:2015, 1 3404 October 2015. 3406 [UNSPSC] "United Nations Standard Products and Services Code", 26 3407 October 2020, . 3409 [W3C.REC-css3-mediaqueries-20120619] 3410 Rivoal, F., "Media Queries", World Wide Web Consortium 3411 Recommendation REC-css3-mediaqueries-20120619, 19 June 3412 2012, . 3415 [W3C.REC-xmlschema-2-20041028] 3416 Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes 3417 Second Edition", World Wide Web Consortium Recommendation 3418 REC-xmlschema-2-20041028, 28 October 2004, 3419 . 3421 [W3C.REC-xpath20-20101214] 3422 Berglund, A., Boag, S., Chamberlin, D., Fernandez, M., 3423 Kay, M., Robie, J., and J. Simeon, "XML Path Language 3424 (XPath) 2.0 (Second Edition)", World Wide Web Consortium 3425 Recommendation REC-xpath20-20101214, 14 December 2010, 3426 . 3428 [X.1520] "Recommendation ITU-T X.1520 (2014), Common 3429 vulnerabilities and exposures", 20 April 2011. 3431 11.2. Informative References 3433 [CamelCase] 3434 "UpperCamelCase", 29 August 2014, 3435 . 3437 [I-D.ietf-rats-architecture] 3438 Birkholz, H., Thaler, D., Richardson, M., Smith, N., and 3439 W. Pan, "Remote Attestation Procedures Architecture", Work 3440 in Progress, Internet-Draft, draft-ietf-rats-architecture- 3441 12, 23 April 2021, . 3444 [KebabCase] 3445 "KebabCase", 18 December 2014, 3446 . 3448 [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between 3449 Information Models and Data Models", RFC 3444, 3450 DOI 10.17487/RFC3444, January 2003, 3451 . 3453 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 3454 Unique IDentifier (UUID) URN Namespace", RFC 4122, 3455 DOI 10.17487/RFC4122, July 2005, 3456 . 3458 [RFC7595] Thaler, D., Ed., Hansen, T., and T. Hardie, "Guidelines 3459 and Registration Procedures for URI Schemes", BCP 35, 3460 RFC 7595, DOI 10.17487/RFC7595, June 2015, 3461 . 3463 [RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource- 3464 Oriented Lightweight Information Exchange (ROLIE)", 3465 RFC 8322, DOI 10.17487/RFC8322, February 2018, 3466 . 3468 [RFC8520] Lear, E., Droms, R., and D. Romascanu, "Manufacturer Usage 3469 Description Specification", RFC 8520, 3470 DOI 10.17487/RFC8520, March 2019, 3471 . 3473 [SWID-GUIDANCE] 3474 Waltermire, D., Cheikes, B.A., Feldman, L., and G. Witte, 3475 "Guidelines for the Creation of Interoperable Software 3476 Identification (SWID) Tags", NISTIR 8060, April 2016, 3477 . 3479 Acknowledgments 3481 This document draws heavily on the concepts defined in the ISO/IEC 3482 19770-2:2015 specification. The authors of this document are 3483 grateful for the prior work of the 19770-2 contributors. 3485 We are also grateful to the careful reviews provided by ... 3487 Contributors 3489 Carsten Bormann 3490 Universität Bremen TZI 3491 Postfach 330440 3492 D-28359 Bremen 3493 Germany 3495 Phone: +49-421-218-63921 3496 Email: cabo@tzi.org 3498 Authors' Addresses 3500 Henk Birkholz 3501 Fraunhofer SIT 3502 Rheinstrasse 75 3503 64295 Darmstadt 3504 Germany 3506 Email: henk.birkholz@sit.fraunhofer.de 3508 Jessica Fitzgerald-McKay 3509 National Security Agency 3510 9800 Savage Road 3511 Ft. Meade, Maryland 3512 United States of America 3513 Email: jmfitz2@cyber.nsa.gov 3515 Charles Schmidt 3516 The MITRE Corporation 3517 202 Burlington Road 3518 Bedford, Massachusetts 01730 3519 United States of America 3521 Email: cmschmidt@mitre.org 3523 David Waltermire 3524 National Institute of Standards and Technology 3525 100 Bureau Drive 3526 Gaithersburg, Maryland 20877 3527 United States of America 3529 Email: david.waltermire@nist.gov