idnits 2.17.00 (12 Aug 2021) /tmp/idnits20865/draft-ietf-sacm-coswid-20.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 document date (26 January 2022) is 115 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 2030, but not defined == Missing Reference: 'RFC-AAAA' is mentioned on line 2712, but not defined -- Duplicate reference: RFC8126, mentioned in 'RFC8126', was also mentioned in 'BCP26'. -- 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 (-15) exists of draft-ietf-rats-architecture-14 Summary: 0 errors (**), 0 flaws (~~), 5 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: 30 July 2022 National Security Agency 6 C. Schmidt 7 The MITRE Corporation 8 D. Waltermire 9 NIST 10 26 January 2022 12 Concise Software Identification Tags 13 draft-ietf-sacm-coswid-20 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 30 July 2022. 44 Copyright Notice 46 Copyright (c) 2022 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 Revised BSD License text as 55 described in Section 4.e of the Trust Legal Provisions and are 56 provided without warranty as described in the Revised 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 . . . . . . . . . . . . . . . . . . . . . 42 85 4.5. Link Use Values . . . . . . . . . . . . . . . . . . . . . 44 86 5. URI Schemes . . . . . . . . . . . . . . . . . . . . . . . . . 45 87 5.1. "swid" URI Scheme . . . . . . . . . . . . . . . . . . . . 45 88 5.2. "swidpath" URI Scheme . . . . . . . . . . . . . . . . . . 46 89 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 46 90 6.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 47 91 6.2. Software Tag Values Registries . . . . . . . . . . . . . 50 92 6.2.1. Registration Procedures . . . . . . . . . . . . . . . 50 93 6.2.2. Private Use of Index and Name Values . . . . . . . . 50 94 6.2.3. Expert Review Guidelines . . . . . . . . . . . . . . 51 95 6.2.4. Software Tag Version Scheme Values Registry . . . . . 51 96 6.2.5. Software Tag Entity Role Values Registry . . . . . . 53 97 6.2.6. Software Tag Link Ownership Values Registry . . . . . 54 98 6.2.7. Software Tag Link Relationship Values Registry . . . 55 99 6.2.8. Software Tag Link Use Values Registry . . . . . . . . 58 100 6.3. swid+cbor Media Type Registration . . . . . . . . . . . . 59 101 6.4. CoAP Content-Format Registration . . . . . . . . . . . . 60 102 6.5. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 60 103 6.6. URI Scheme Registrations . . . . . . . . . . . . . . . . 60 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 . . . . . . . . . . . . . . . . . . . . . 62 108 8. Tagged CoSWID Tags . . . . . . . . . . . . . . . . . . . . . 65 109 9. Security Considerations . . . . . . . . . . . . . . . . . . . 65 110 10. Privacy Consideration . . . . . . . . . . . . . . . . . . . . 68 111 11. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 69 112 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 74 113 12.1. Normative References . . . . . . . . . . . . . . . . . . 74 114 12.2. Informative References . . . . . . . . . . . . . . . . . 77 115 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 78 116 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . 78 117 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 78 119 1. Introduction 121 SWID tags, as defined in ISO-19770-2:2015 [SWID], provide a 122 standardized XML-based record format that identifies and describes a 123 specific release of software, a patch, or an installation bundle, 124 which are referred to as software components in this document. 125 Different software components, and even different releases of a 126 particular software component, each have a different SWID tag record 127 associated with them. SWID tags are meant to be flexible and able to 128 express a broad set of metadata about a software component. 130 SWID tags are used to support a number of processes including but not 131 limited to: 133 * Software Inventory Management, a part of a Software Asset 134 Management [SAM] process, which requires an accurate list of 135 discernible deployed software components. 137 * Vulnerability Assessment, which requires a semantic link between 138 standardized vulnerability descriptions and software components 139 installed on IT-assets [X.1520]. 141 * Remote Attestation, which requires a link between reference 142 integrity measurements (RIM) and Attester-produced event logs that 143 complement attestation Evidence [I-D.ietf-rats-architecture]. 145 While there are very few required fields in SWID tags, there are many 146 optional fields that support different uses. A SWID tag consisting 147 of only required fields might be a few hundred bytes in size; 148 however, a tag containing many of the optional fields can be many 149 orders of magnitude larger. Thus, real-world instances of SWID tags 150 can be fairly large, and the communication of SWID tags in usage 151 scenarios, such as those described earlier, can cause a large amount 152 of data to be transported. This can be larger than acceptable for 153 constrained devices and networks. Concise SWID (CoSWID) tags 154 significantly reduce the amount of data transported as compared to a 155 typical SWID tag through the use of the Concise Binary Object 156 Representation (CBOR) [RFC8949]. 158 Size comparisons between XML SWID and CoSWID mainly depend on domain- 159 specific applications and the complexity of attributes used in 160 instances. While the values stored in CoSWID are often unchanged and 161 therefore not reduced in size compared to an XML SWID, the 162 scaffolding that the CoSWID encoding represents is significantly 163 smaller by taking up 10 percent or less in size. This effect is 164 visible in instances sizes, which can benefit from a 50 percent to 85 165 percent reduction of size in generic usage scenarios. Additional 166 size reduction is enabled with respect to the memory footprint of XML 167 parsing/validation as well as the reduction of stack sizes where XML 168 processing is now obsolete. 170 In a CoSWID, the human-readable labels of SWID data items are 171 replaced with more concise integer labels (indices). This approach 172 allows SWID and CoSWID to share a common implicit information model, 173 with CoSWID providing an alternate data model [RFC3444]. While SWID 174 and CoSWID are intended to share the same implicit information model, 175 this specification does not define this information model, or a 176 mapping between the the two data formats. While an attempt to align 177 SWID and CoSWID tags has been made here, future revisions of ISO/IEC 178 19770-2:2015 or this specification might cause this implicit 179 information model to diverge, since these specifications are 180 maintained by different standards groups. 182 The use of CBOR to express SWID information in CoSWID tags allows 183 both CoSWID and SWID tags to be part of an enterprise security 184 solution for a wider range of endpoints and environments. 186 1.1. The SWID and CoSWID Tag Lifecycle 188 In addition to defining the format of a SWID tag record, ISO/IEC 189 19770-2:2015 defines requirements concerning the SWID tag lifecycle. 190 Specifically, when a software component is installed on an endpoint, 191 that software component's SWID tag is also installed. Likewise, when 192 the software component is uninstalled or replaced, the SWID tag is 193 deleted or replaced, as appropriate. As a result, ISO/IEC 194 19770-2:2015 describes a system wherein there is a correspondence 195 between the set of installed software components on an endpoint, and 196 the presence of the corresponding SWID tags for these components on 197 that endpoint. CoSWIDs share the same lifecycle requirements as a 198 SWID tag. 200 The SWID specification and supporting guidance provided in NIST 201 Internal Report (NISTIR) 8060: Guidelines for the Creation of 202 Interoperable SWID Tags [SWID-GUIDANCE] defines four types of SWID 203 tags: primary, patch, corpus, and supplemental. The following text 204 is paraphrased from these sources. 206 1. Primary Tag - A SWID or CoSWID tag that identifies and describes 207 an installed software component on an endpoint. A primary tag is 208 intended to be installed on an endpoint along with the 209 corresponding software component. 211 2. Patch Tag - A SWID or CoSWID tag that identifies and describes an 212 installed patch that has made incremental changes to a software 213 component installed on an endpoint. A patch tag is intended to 214 be installed on an endpoint along with the corresponding software 215 component patch. 217 3. Corpus Tag - A SWID or CoSWID tag that identifies and describes 218 an installable software component in its pre-installation state. 219 A corpus tag can be used to represent metadata about an 220 installation package or installer for a software component, a 221 software update, or a patch. 223 4. Supplemental Tag - A SWID or CoSWID tag that allows additional 224 information to be associated with a referenced SWID tag. This 225 allows tools and users to record their own metadata about a 226 software component without modifying CoSWID primary or patch tags 227 created by a software provider. 229 The type of a tag is determined by specific data elements, which are 230 discussed in Section 3, which also provides normative language for 231 CoSWID semantics that implement this lifecycle. The following 232 information helps to explain how these semantics apply to use of a 233 CoSWID tag. 235 Corpus, primary, and patch tags have similar functions in that 236 they describe the existence and/or presence of different types of 237 software components (e.g., software installers, software 238 installations, software patches), and, potentially, different 239 states of these software components. Supplemental tags have the 240 same structure as other tags, but are used to provide information 241 not contained in the referenced corpus, primary, and patch tags. 242 All four tag types come into play at various points in the 243 software lifecycle and support software management processes that 244 depend on the ability to accurately determine where each software 245 component is in its lifecycle. 247 +------------+ 248 v | 249 Software Software Software Software Software 250 Deployment -> Installation -> Patching -> Upgrading -> Removal 252 Corpus Primary Primary xPrimary xPrimary 253 Supplemental Supplemental Supplemental xSupplemental xSupplemental 254 Patch xPatch 255 Primary 256 Supplemental 258 Figure 1: Use of Tag Types in the Software Lifecycle 260 Figure 1 illustrates the steps in the software lifecycle and the 261 relationships among those lifecycle events supported by the four 262 types of SWID and CoSWID tags. A detailed description of the four 263 tags types is provided in Section 2.3. The figure identifies the 264 types of tags that are used in each lifecycle event. 266 There are many ways in which software tags might be managed for the 267 host the software is installed on. For example, software tags could 268 be made available on the host or to an external software manager when 269 storage is limited on the host. 271 In these cases the host or external software manager is responsible 272 for management of the tags, including deployment and removal of the 273 tags as indicated by the above lifecycle. Tags are deployed and 274 previously deployed tags that are typically removed (indicated by an 275 "x" prefix) at each lifecycle stage, as follows: 277 - Software Deployment. Before the software component is 278 installed (i.e., pre-installation), and while the product is 279 being deployed, a corpus tag provides information about the 280 installation files and distribution media (e.g., CD/DVD, 281 distribution package). 283 Corpus tags are not actually deployed on the target system but are 284 intended to support deployment procedures and their dependencies at 285 install-time, such as to verify the installation media. 287 - Software Installation. A primary tag will be installed with 288 the software component (or subsequently created) to uniquely 289 identify and describe the software component. Supplemental 290 tags are created to augment primary tags with additional site- 291 specific or extended information. While not illustrated in the 292 figure, patch tags can also be installed during software 293 installation to provide information about software fixes 294 deployed along with the base software installation. 296 - Software Patching. A new patch tag is provided, when a patch 297 is applied to the software component, supplying details about 298 the patch and its dependencies. While not illustrated in the 299 figure, a corpus tag can also provide information about the 300 patch installer and patching dependencies that need to be 301 installed before the patch. 303 - Software Upgrading. As a software component is upgraded to a 304 new version, new primary and supplemental tags replace existing 305 tags, enabling timely and accurate tracking of updates to 306 software inventory. While not illustrated in the figure, a 307 corpus tag can also provide information about the upgrade 308 installer and dependencies that need to be installed before the 309 upgrade. 311 Note: In the context of software tagging software patching and 312 updating differ in an important way. When installing a patch, a set 313 of file modifications are made to pre-installed software which do not 314 alter the version number or the descriptive metadata of an installed 315 software component. An update can also make a set of file 316 modifications, but the version number or the descriptive metadata of 317 an installed software component are changed. 319 - Software Removal. Upon removal of the software component, 320 relevant SWID tags are removed. This removal event can trigger 321 timely updates to software inventory reflecting the removal of 322 the product and any associated patch or supplemental tags. 324 As illustrated in the figure, supplemental tags can be associated 325 with any corpus, primary, or patch tag to provide additional metadata 326 about an installer, installed software, or installed patch 327 respectively. 329 Understanding the use of CoSWIDs in the software lifecycle provides a 330 basis for understanding the information provided in a CoSWID and the 331 associated semantics of this information. Each of the different SWID 332 and CoSWID tag types provide different sets of information. For 333 example, a "corpus tag" is used to describe a software component's 334 installation image on an installation media, while a "patch tag" is 335 meant to describe a patch that modifies some other software 336 component. 338 1.2. Concise SWID Format 340 This document defines the CoSWID tag format, which is based on CBOR. 341 CBOR-based CoSWID tags offer a more concise representation of SWID 342 information as compared to the XML-based SWID tag representation in 343 ISO-19770-2:2015. The structure of a CoSWID is described via the 344 Concise Data Definition Language (CDDL) [RFC8610]. The resulting 345 CoSWID data definition is aligned to the information able to be 346 expressed with the XML schema definition of ISO-19770-2:2015 [SWID]. 347 This alignment allows both SWID and CoSWID tags to represent a common 348 set of software component information and allows CoSWID tags to 349 support the same uses as a SWID tag. 351 The vocabulary, i.e., the CDDL names of the types and members used in 352 the CoSWID CDDL specification, are mapped to more concise labels 353 represented as small integer values (indices). The names used in the 354 CDDL specification and the mapping to the CBOR representation using 355 integer indices is based on the vocabulary of the XML attribute and 356 element names defined in ISO/IEC 19770-2:2015. 358 1.3. Requirements Notation 360 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 361 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 362 "OPTIONAL" in this document are to be interpreted as described in 363 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 364 capitals, as shown here. 366 2. Concise SWID Data Definition 368 The following describes the general rules and processes for encoding 369 data using CDDL representation. Prior familiarity with CBOR and CDDL 370 concepts will be helpful in understanding this CoSWID specification. 372 This section describes the conventions by which a CoSWID is 373 represented in the CDDL structure. The CamelCase [CamelCase] 374 notation used in the XML schema definition is changed to a hyphen- 375 separated notation [KebabCase] (e.g. ResourceCollection is named 376 resource-collection) in the CoSWID CDDL specification. This 377 deviation from the original notation used in the XML representation 378 reduces ambiguity when referencing certain attributes in 379 corresponding textual descriptions. An attribute referred to by its 380 name in CamelCase notation explicitly relates to XML SWID tags; an 381 attribute referred to by its name in KebabCase notation explicitly 382 relates to CBOR CoSWID tags. This approach simplifies the 383 composition of further work that reference both XML SWID and CBOR 384 CoSWID documents. 386 In most cases, mapping attribute names between SWID and CoSWID can be 387 done automatically by converting between CamelCase and KebabCase 388 attribute names. However, some CoSWID CDDL attribute names show 389 greater variation relative to their corresponding SWID XML Schema 390 attributes. This is done when the change improves clarity in the 391 CoSWID specification. For example the "name" and "version" SWID 392 fields corresponds to the "software-name" and "software-version" 393 CoSWID fields, respectively. As such, it is not always possible to 394 mechanically translate between corresponding attribute names in the 395 two formats. In such cases, a manual mapping will need to be used. 396 These cases are specifically noted in this and subsequent sections 397 using an [W3C.REC-xpath20-20101214] where a manual mapping is needed. 399 The 57 human-readable text labels of the CDDL-based CoSWID vocabulary 400 are mapped to integer indices via a block of rules at the bottom of 401 the definition. This allows a more concise integer-based form to be 402 stored or transported, as compared to the less efficient text-based 403 form of the original vocabulary. 405 Through use of CDDL-based integer labels, CoSWID allows for future 406 expansion in subsequent revisions of this specification and through 407 extensions (see Section 2.2). New constructs can be associated with 408 a new integer index. A deprecated construct can be replaced by a new 409 construct with a new integer index. An implementation can use these 410 integer indexes to identify the construct to parse. The CoSWID Items 411 registry, defined in Section 6.1, is used to ensure that new 412 constructs are assigned a unique index value on a first-come, first- 413 served basis. This approach avoids the need to have an explicit 414 CoSWID version. 416 The root of the CDDL specification provided by this document is the 417 rule coswid (as defined in Section 8): 419 start = coswid 421 In CBOR, an array is encoded using bytes that identify the array, and 422 the array's length or stop point (see [RFC8949]). To make items that 423 support 1 or more values, the following CDDL notation is used. 425 _name_ = (_label_ => _data_ / [ 2* _data_ ]) 427 The CDDL rule above allows either a single data item or an array of 2 428 or more data values to be provided. When a singleton data value is 429 provided, the CBOR markers for the array, array length, and stop 430 point are not needed, saving bytes. When two or more data values are 431 provided, these values are encoded as an array. This modeling 432 pattern is used frequently in the CoSWID CDDL specification to allow 433 for more efficient encoding of singleton values. 435 Usage of this construct can be simplified using 437 one-or-more = T / [ 2* T ] 439 simplifying the above example to 441 _name_ = (_label_ => one-or-more<_data_>) 443 The following subsections describe the different parts of the CoSWID 444 model. 446 2.1. Character Encoding 448 The CDDL "text" type is represented in CBOR as a major type 3, which 449 represents "a string of Unicode characters that [are] encoded as 450 UTF-8 [RFC3629]" (see Section 3.1 of [RFC8949]). Thus both SWID and 451 CoSWID use UTF-8 for the encoding of characters in text strings. 453 To ensure that UTF-8 character strings are able to be encoded/decoded 454 and exchanged interoperably, text strings in CoSWID MUST be encoded 455 consistent with the Net-Unicode definition defined in [RFC5198]. 457 All names registered with IANA according to requirements in 458 Section 6.2 also MUST be valid according to the XML Schema NMTOKEN 459 data type (see [W3C.REC-xmlschema-2-20041028] Section 3.3.4) to 460 ensure compatibility with the SWID specification where these names 461 are used. 463 2.2. Concise SWID Extensions 465 The CoSWID specification contains two features that are not included 466 in the SWID specification on which it is based. These features are: 468 * The explicit definition of types for some attributes in the ISO- 469 19770-2:2015 XML representation that are typically represented by 470 the "any attribute" in the SWID model. These are covered in 471 Section 2.5. 473 * The inclusion of extension points in the CoSWID specification 474 using CDDL sockets (see [RFC8610] Section 3.9). The use of CDDL 475 sockets allow for well-formed extensions to be defined in 476 supplementary CDDL descriptions that support additional uses of 477 CoSWID tags that go beyond the original scope of ISO-19770-2:2015 478 tags. This extension mechanism can also be used to update the 479 CoSWID format as revisions to ISO-19770-2 are published. 481 The following CDDL sockets (extension points) are defined in this 482 document, which allow the addition of new information structures to 483 their respective CDDL groups. 485 +=====================+===========================+===============+ 486 | Map Name | CDDL Socket | Defined in | 487 +=====================+===========================+===============+ 488 | concise-swid-tag | $$coswid-extension | Section 2.3 | 489 +---------------------+---------------------------+---------------+ 490 | entity-entry | $$entity-extension | Section 2.6 | 491 +---------------------+---------------------------+---------------+ 492 | link-entry | $$link-extension | Section 2.7 | 493 +---------------------+---------------------------+---------------+ 494 | software-meta-entry | $$software-meta-extension | Section 2.8 | 495 +---------------------+---------------------------+---------------+ 496 | file-entry | $$file-extension | Section 2.9.2 | 497 +---------------------+---------------------------+---------------+ 498 | directory-entry | $$directory-extension | Section 2.9.2 | 499 +---------------------+---------------------------+---------------+ 500 | process-entry | $$process-extension | Section 2.9.2 | 501 +---------------------+---------------------------+---------------+ 502 | resource-entry | $$resource-extension | Section 2.9.2 | 503 +---------------------+---------------------------+---------------+ 504 | payload-entry | $$payload-extension | Section 2.9.3 | 505 +---------------------+---------------------------+---------------+ 506 | evidence-entry | $$evidence-extension | Section 2.9.4 | 507 +---------------------+---------------------------+---------------+ 509 Table 1: CoSWID CDDL Group Extension Points 511 The CoSWID Items Registry defined in Section 6.1 provides a 512 registration mechanism allowing new items, and their associated index 513 values, to be added to the CoSWID model through the use of the CDDL 514 sockets described in the table above. This registration mechanism 515 provides for well-known index values for data items in CoSWID 516 extensions, allowing these index values to be recognized by 517 implementations supporting a given extension. 519 The following additional CDDL sockets are defined in this document to 520 allow for adding new values to corresponding type-choices (i.e. to 521 represent enumerations) via custom CDDL specifications. 523 +==================+=================+=============+ 524 | Enumeration Name | CDDL Socket | Defined in | 525 +==================+=================+=============+ 526 | version-scheme | $version-scheme | Section 4.1 | 527 +------------------+-----------------+-------------+ 528 | role | $role | Section 4.2 | 529 +------------------+-----------------+-------------+ 530 | ownership | $ownership | Section 4.3 | 531 +------------------+-----------------+-------------+ 532 | rel | $rel | Section 4.4 | 533 +------------------+-----------------+-------------+ 534 | use | $use | Section 4.5 | 535 +------------------+-----------------+-------------+ 537 Table 2: CoSWID CDDL Enumeration Extension Points 539 A number of CoSWID value registries are also defined in Section 6.2 540 that allow new values to be registered with IANA for the enumerations 541 above. This registration mechanism supports the definition of new 542 well-known index values and names for new enumeration values used by 543 CoSWID, which can also be used by other software tagging 544 specifications. This registration mechanism allows new standardized 545 enumerated values to be shared between multiple tagging 546 specifications (and associated implementations) over time. 548 2.3. The concise-swid-tag Map 550 The CDDL specification for the root concise-swid-tag map is as 551 follows and this rule and its constraints MUST be followed when 552 creating or validating a CoSWID tag: 554 concise-swid-tag = { 555 tag-id => text / bstr .size 16, 556 tag-version => integer, 557 ? corpus => bool, 558 ? patch => bool, 559 ? supplemental => bool, 560 software-name => text, 561 ? software-version => text, 562 ? version-scheme => $version-scheme, 563 ? media => text, 564 ? software-meta => one-or-more, 565 entity => one-or-more, 566 ? link => one-or-more, 567 ? payload-or-evidence, 568 * $$coswid-extension, 569 global-attributes, 570 } 572 payload-or-evidence //= ( payload => payload-entry ) 573 payload-or-evidence //= ( evidence => evidence-entry ) 575 tag-id = 0 576 software-name = 1 577 entity = 2 578 evidence = 3 579 link = 4 580 software-meta = 5 581 payload = 6 582 corpus = 8 583 patch = 9 584 media = 10 585 supplemental = 11 586 tag-version = 12 587 software-version = 13 588 version-scheme = 14 590 $version-scheme /= multipartnumeric 591 $version-scheme /= multipartnumeric-suffix 592 $version-scheme /= alphanumeric 593 $version-scheme /= decimal 594 $version-scheme /= semver 595 $version-scheme /= int / text 596 multipartnumeric = 1 597 multipartnumeric-suffix = 2 598 alphanumeric = 3 599 decimal = 4 600 semver = 16384 601 The following describes each member of the concise-swid-tag root map. 603 * global-attributes: A list of items including an optional language 604 definition to support the processing of text-string values and an 605 unbounded set of any-attribute items. Described in Section 2.5. 607 * tag-id (index 0): A 16 byte binary string or textual identifier 608 uniquely referencing a software component. The tag identifier 609 MUST be globally unique. Failure to ensure global uniqueness can 610 create ambiguity in tag use since the tag-id serves as the global 611 key for matching and lookups. If represented as a 16 byte binary 612 string, the identifier MUST be a valid universally unique 613 identifier as defined by [RFC4122]. There are no strict 614 guidelines on how this identifier is structured, but examples 615 include a 16 byte GUID (e.g. class 4 UUID) [RFC4122], or a text 616 string appended to a DNS domain name to ensure uniqueness across 617 organizations. 619 * tag-version (index 12): An integer value that indicate the 620 specific release revision of the tag. Typically, the initial 621 value of this field is set to 0 and the value is monotonically 622 increased for subsequent tags produced for the same software 623 component release. This value allows a CoSWID tag producer to 624 correct an incorrect tag previously released without indicating a 625 change to the underlying software component the tag represents. 626 For example, the tag version could be changed to add new metadata, 627 to correct a broken link, to add a missing payload entry, etc. 628 When producing a revised tag, the new tag-version value MUST be 629 greater than the old tag-version value. 631 * corpus (index 8): A boolean value that indicates if the tag 632 identifies and describes an installable software component in its 633 pre-installation state. Installable software includes a 634 installation package or installer for a software component, a 635 software update, or a patch. If the CoSWID tag represents 636 installable software, the corpus item MUST be set to "true". If 637 not provided, the default value MUST be considered "false". 639 * patch (index 9): A boolean value that indicates if the tag 640 identifies and describes an installed patch that has made 641 incremental changes to a software component installed on an 642 endpoint. If a CoSWID tag is for a patch, the patch item MUST be 643 set to "true". If not provided, the default value MUST be 644 considered "false". A patch item's value MUST NOT be set to 645 "true" if the installation of the associated software package 646 changes the version of a software component. 648 * supplemental (index 11): A boolean value that indicates if the tag 649 is providing additional information to be associated with another 650 referenced SWID or CoSWID tag. This allows tools and users to 651 record their own metadata about a software component without 652 modifying SWID primary or patch tags created by a software 653 provider. If a CoSWID tag is a supplemental tag, the supplemental 654 item MUST be set to "true". If not provided, the default value 655 MUST be considered "false". 657 * software-name (index 1): This textual item provides the software 658 component's name. This name is likely the same name that would 659 appear in a package management tool. This item maps to 660 '/SoftwareIdentity/@name' in [SWID]. 662 * software-version (index 13): A textual value representing the 663 specific release or development version of the software component. 664 This item maps to '/SoftwareIdentity/@version' in [SWID]. 666 * version-scheme (index 14): An integer or textual value 667 representing the versioning scheme used for the software-version 668 item. If an integer value is used it MUST be an index value in 669 the range -256 to 65535. Integer values in the range -256 to -1 670 are reserved for testing and use in closed environments (see 671 Section 6.2.2). Integer values in the range 0 to 65535 correspond 672 to registered entries in the IANA "Software Tag Version Scheme 673 Values" registry (see Section 6.2.4. If a string value is used it 674 MUST be a private use name as defined in Section 6.2.2. String 675 values based on a Version Scheme Name from the IANA "Software Tag 676 Version Scheme Values" registry MUST NOT be used, as these values 677 are less concise than their index value equivalent. 679 * media (index 10): This text value is a hint to the tag consumer to 680 understand what target platform this tag applies to. This item 681 item MUST be formatted as a query as defined by the W3C Media 682 Queries Recommendation (see [W3C.REC-css3-mediaqueries-20120619]). 683 Support for media queries are included here for interoperability 684 with [SWID], which does not provide any further requirements for 685 media query use. Thus, this specification does not clarify how a 686 media query is to be used for a CoSWID. 688 * software-meta (index 5): An open-ended map of key/value data 689 pairs. A number of predefined keys can be used within this item 690 providing for common usage and semantics across the industry. Use 691 of this map allows any additional attribute to be included in the 692 tag. It is expected that industry groups will use a common set of 693 attribute names to allow for interoperability within their 694 communities. Described in Section 2.8. This item maps to 695 '/SoftwareIdentity/Meta' in [SWID]. 697 * entity (index 2): Provides information about one or more 698 organizations responsible for producing the CoSWID tag, and 699 producing or releasing the software component referenced by this 700 CoSWID tag. Described in Section 2.6. 702 * link (index 4): Provides a means to establish relationship arcs 703 between the tag and another items. A given link can be used to 704 establish the relationship between tags or to reference another 705 resource that is related to the CoSWID tag, e.g. vulnerability 706 database association, ROLIE feed [RFC8322], MUD resource 707 [RFC8520], software download location, etc). This is modeled 708 after the HTML "link" element. Described in Section 2.7. 710 * payload (index 6): This item represents a collection of software 711 artifacts (described by child items) that compose the target 712 software. For example, these artifacts could be the files 713 included with an installer for a corpus tag or installed on an 714 endpoint when the software component is installed for a primary or 715 patch tag. The artifacts listed in a payload may be a superset of 716 the software artifacts that are actually installed. Based on user 717 selections at install time, an installation might not include 718 every artifact that could be created or executed on the endpoint 719 when the software component is installed or run. Described in 720 Section 2.9.3. 722 * evidence (index 3): This item can be used to record the results of 723 a software discovery process used to identify untagged software on 724 an endpoint or to represent indicators for why software is 725 believed to be installed on the endpoint. In either case, a 726 CoSWID tag can be created by the tool performing an analysis of 727 the software components installed on the endpoint. Described in 728 Section 2.9.4. 730 * $$coswid-extension: This CDDL socket is used to add new 731 information structures to the concise-swid-tag root map. See 732 Section 2.2. 734 2.4. concise-swid-tag Co-Constraints 736 The following co-constraints apply to the information provided in the 737 concise-swid-tag group. 739 * The patch and supplemental items MUST NOT both be set to "true". 741 * If the patch item is set to "true", the tag SHOULD contain at 742 least one link item (see Section 2.7) with both the rel item value 743 of "patches" and an href item specifying an association with the 744 software that was patched. 746 * If the supplemental item is set to "true", the tag SHOULD contain 747 at least one link item with both the rel item value of 748 "supplemental" and an href item specifying an association with the 749 software that is supplemented. 751 * If all of the corpus, patch, and supplemental items are "false", 752 or if the corpus item is set to "true", then a software-version 753 item MUST be included with a value set to the version of the 754 software component. This ensures that primary and corpus tags 755 have an identifiable software version. 757 2.5. The global-attributes Group 759 The global-attributes group provides a list of items, including an 760 optional language definition to support the processing of text-string 761 values, and an unbounded set of any-attribute items allowing for 762 additional items to be provided as a general point of extension in 763 the model. 765 The CDDL for the global-attributes follows: 767 global-attributes = ( 768 ? lang => text, 769 * any-attribute, 770 ) 772 any-attribute = ( 773 label => one-or-more / one-or-more 774 ) 776 label = text / int 778 The following describes each child item of this group. 780 * lang (index 15): A textual language tag that conforms with IANA 781 "Language Subtag Registry" [RFC5646]. The context of the 782 specified language applies to all sibling and descendant textual 783 values, unless a descendant object has defined a different 784 language tag. Thus, a new context is established when a 785 descendant object redefines a new language tag. All textual 786 values within a given context MUST be considered expressed in the 787 specified language. 789 * any-attribute: This sub-group provides a means to include 790 arbitrary information via label/index ("key") value pairs. Labels 791 can be either a single integer or text string. Values can be a 792 single integer, a text string, or an array of integers or text 793 strings. 795 2.6. The entity-entry Map 797 The CDDL for the entity-entry map follows: 799 entity-entry = { 800 entity-name => text, 801 ? reg-id => any-uri, 802 role => one-or-more<$role>, 803 ? thumbprint => hash-entry, 804 * $$entity-extension, 805 global-attributes, 806 } 808 entity-name = 31 809 reg-id = 32 810 role = 33 811 thumbprint = 34 813 $role /= tag-creator 814 $role /= software-creator 815 $role /= aggregator 816 $role /= distributor 817 $role /= licensor 818 $role /= maintainer 819 $role /= int / text 820 tag-creator=1 821 software-creator=2 822 aggregator=3 823 distributor=4 824 licensor=5 825 maintainer=6 827 The following describes each child item of this group. 829 * global-attributes: The global-attributes group described in 830 Section 2.5. 832 * entity-name (index 31): The textual name of the organizational 833 entity claiming the roles specified by the role item for the 834 CoSWID tag. This item maps to '/SoftwareIdentity/Entity/@name' in 835 [SWID]. 837 * reg-id (index 32): The registration id value is intended to 838 uniquely identify a naming authority in a given scope (e.g. 839 global, organization, vendor, customer, administrative domain, 840 etc.) for the referenced entity. The value of a registration ID 841 MUST be a RFC 3986 URI. The scope will usually be the scope of an 842 organization. 844 * role (index 33): An integer or textual value representing the 845 relationship(s) between the entity, and this tag or the referenced 846 software component. If an integer value is used it MUST be an 847 index value in the range -256 to 255. Integer values in the range 848 -256 to -1 are reserved for testing and use in closed environments 849 (see Section 6.2.2). Integer values in the range 0 to 255 850 correspond to registered entries in the IANA "Software Tag Entity 851 Role Values" registry (see Section 6.2.5. If a string value is 852 used it MUST be a private use name as defined in Section 6.2.2. 853 String values based on a Role Name from the IANA "Software Tag 854 Entity Role Values" registry MUST NOT be used, as these values are 855 less concise than their index value equivalent. 857 The following additional requirements exist for the use of the 858 "role" item: 860 - An entity item MUST be provided with the role of "tag-creator" 861 for every CoSWID tag. This indicates the organization that 862 created the CoSWID tag. 864 - An entity item SHOULD be provided with the role of "software- 865 creator" for every CoSWID tag, if this information is known to 866 the tag creator. This indicates the organization that created 867 the referenced software component. 869 * thumbprint (index 34): The value of the thumbprint item provides a 870 hash (i.e. the thumbprint) of the signing entity's public key 871 certificate. This provides an indicator of which entity signed 872 the CoSWID tag, which will typically be the tag creator. See 873 Section 2.9.1 for more details on the use of the hash-entry data 874 structure. 876 * $$entity-extension: This CDDL socket can be used to extend the 877 entity-entry group model. See Section 2.2. 879 2.7. The link-entry Map 881 The CDDL for the link-entry map follows: 883 link-entry = { 884 ? artifact => text, 885 href => any-uri, 886 ? media => text, 887 ? ownership => $ownership, 888 rel => $rel, 889 ? media-type => text, 890 ? use => $use, 891 * $$link-extension, 892 global-attributes, 893 } 895 media = 10 896 artifact = 37 897 href = 38 898 ownership = 39 899 rel = 40 900 media-type = 41 901 use = 42 903 $ownership /= shared 904 $ownership /= private 905 $ownership /= abandon 906 $ownership /= int / text 907 shared=1 908 private=2 909 abandon=3 911 $rel /= ancestor 912 $rel /= component 913 $rel /= feature 914 $rel /= installationmedia 915 $rel /= packageinstaller 916 $rel /= parent 917 $rel /= patches 918 $rel /= requires 919 $rel /= see-also 920 $rel /= supersedes 921 $rel /= supplemental 922 $rel /= -356..65536 / text 923 ancestor=1 924 component=2 925 feature=3 926 installationmedia=4 927 packageinstaller=5 928 parent=6 929 patches=7 930 requires=8 931 see-also=9 932 supersedes=10 933 supplemental=11 935 $use /= optional 936 $use /= required 937 $use /= recommended 938 $use /= int / text 939 optional=1 940 required=2 941 recommended=3 943 The following describes each member of this map. 945 * global-attributes: The global-attributes group described in 946 Section 2.5. 948 * artifact (index: 37): To be used with rel="installation-media", 949 this item's value provides the path to the installer executable or 950 script that can be run to launch the referenced installation. 951 Links with the same artifact name MUST be considered mirrors of 952 each other, allowing the installation media to be acquired from 953 any of the described sources. 955 * href (index 38): A URI-reference [RFC3986] for the referenced 956 resource. The "href" item's value can be, but is not limited to, 957 the following (which is a slightly modified excerpt from [SWID]): 959 - If no URI scheme is provided, then the URI-reference is a 960 relative reference relative to the URI of the CoSWID tag. For 961 example, "./folder/supplemental.coswid". 963 - a physical resource location with any acceptable URI scheme 964 (e.g., file:// http:// https:// ftp://) 966 - a URI with "swid:" as the scheme refers to another SWID or 967 CoSWID by the referenced tag's tag-id. This URI needs to be 968 resolved in the context of the endpoint by software that can 969 lookup other SWID or CoSWID tags. For example, "swid:2df9de35- 970 0aff-4a86-ace6-f7dddd1ade4c" references the tag with the tag-id 971 value "2df9de35-0aff-4a86-ace6-f7dddd1ade4c". 973 - a URI with "swidpath:" as the scheme, which refers to another 974 software tag via an XPATH query [W3C.REC-xpath20-20101214]. 975 This scheme is provided for compatibility with [SWID]. This 976 specification does not define how to resolve an XPATH query in 977 the context of CBOR. 979 * media (index 10): A hint to the consumer of the link to what 980 target platform the link is applicable to. This item represents a 981 query as defined by the W3C Media Queries Recommendation (see 982 [W3C.REC-css3-mediaqueries-20120619]). As highlighted in media 983 defined in Section 2.3, support for media queries are included 984 here for interoperability with [SWID], which does not provide any 985 further requirements for media query use. Thus, this 986 specification does not clarify how a media query is to be used for 987 a CoSWID. 989 * ownership (index 39): An integer or textual value used when the 990 "href" item references another software component to indicate the 991 degree of ownership between the software component referenced by 992 the CoSWID tag and the software component referenced by the link. 993 If an integer value is used it MUST be an index value in the range 994 -256 to 255. Integer values in the range -256 to -1 are reserved 995 for testing and use in closed environments (see Section 6.2.2). 996 Integer values in the range 0 to 255 correspond to registered 997 entries in the IANA "Software Tag Link Ownership Values" registry 998 (see Section 6.2.6. If a string value is used it MUST be a 999 private use name as defined in Section 6.2.2. String values based 1000 on a Ownership Type Name from the IANA "Software Tag Link 1001 Ownership Values" registry MUST NOT be used, as these values are 1002 less concise than their index value equivalent. 1004 * rel (index 40): An integer or textual value that identifies the 1005 relationship between this CoSWID and the target resource 1006 identified by the "href" item. If an integer value is used it 1007 MUST be an index value in the range -256 to 65535. Integer values 1008 in the range -256 to -1 are reserved for testing and use in closed 1009 environments (see Section 6.2.2). Integer values in the range 0 1010 to 65535 correspond to registered entries in the IANA "Software 1011 Tag Link Relationship Values" registry (see Section 6.2.7. If a 1012 string value is used it MUST be either a private use name as 1013 defined in Section 6.2.2 or a "Relation Name" from the IANA "Link 1014 Relation Types" registry: https://www.iana.org/assignments/link- 1015 relations/link-relations.xhtml as defined by [RFC8288]. When a 1016 string value defined in the IANA "Software Tag Link Relationship 1017 Values" registry matches a Relation Name defined in the IANA "Link 1018 Relation Types" registry, the index value in the IANA "Software 1019 Tag Link Relationship Values" registry MUST be used instead, as 1020 this relationship has a specialized meaning in the context of a 1021 CoSWID tag. String values based on a Relationship Type Name from 1022 the IANA "Software Tag Link Relationship Values" registry MUST NOT 1023 be used, as these values are less concise than their index value 1024 equivalent. 1026 * media-type (index 41): A link can point to arbitrary resources on 1027 the endpoint, local network, or Internet using the href item. Use 1028 of this item supplies the resource consumer with a hint of what 1029 type of resource to expect. Media types are identified by 1030 referencing a "Name" from the IANA "Media Types" registry: 1031 http://www.iana.org/assignments/media-types/media-types.xhtml. 1032 This item maps to '/SoftwareIdentity/Link/@type' in [SWID]. 1034 * use (index 42): An integer or textual value used to determine if 1035 the referenced software component has to be installed before 1036 installing the software component identified by the COSWID tag. 1038 If an integer value is used it MUST be an index value in the range 1039 -256 to 255. Integer values in the range -256 to -1 are reserved 1040 for testing and use in closed environments (see Section 6.2.2). 1041 Integer values in the range 0 to 255 correspond to registered 1042 entries in the IANA "Link Use Values" registry (see Section 6.2.8. 1043 If a string value is used it MUST be a private use name as defined 1044 in Section 6.2.2. String values based on an Link Use Type Name 1045 from the IANA "Software Tag Link Use Values" registry MUST NOT be 1046 used, as these values are less concise than their index value 1047 equivalent. 1049 * $$link-extension: This CDDL socket can be used to extend the link- 1050 entry map model. See Section 2.2. 1052 2.8. The software-meta-entry Map 1054 The CDDL for the software-meta-entry map follows: 1056 software-meta-entry = { 1057 ? activation-status => text, 1058 ? channel-type => text, 1059 ? colloquial-version => text, 1060 ? description => text, 1061 ? edition => text, 1062 ? entitlement-data-required => bool, 1063 ? entitlement-key => text, 1064 ? generator => text, 1065 ? persistent-id => text, 1066 ? product => text, 1067 ? product-family => text, 1068 ? revision => text, 1069 ? summary => text, 1070 ? unspsc-code => text, 1071 ? unspsc-version => text, 1072 * $$software-meta-extension, 1073 global-attributes, 1074 } 1076 activation-status = 43 1077 channel-type = 44 1078 colloquial-version = 45 1079 description = 46 1080 edition = 47 1081 entitlement-data-required = 48 1082 entitlement-key = 49 1083 generator = 50 1084 persistent-id = 51 1085 product = 52 1086 product-family = 53 1087 revision = 54 1088 summary = 55 1089 unspsc-code = 56 1090 unspsc-version = 57 1092 The following describes each child item of this group. 1094 * global-attributes: The global-attributes group described in 1095 Section 2.5. 1097 * activation-status (index 43): A textual value that identifies how 1098 the software component has been activated, which might relate to 1099 specific terms and conditions for its use (e.g. Trial, 1100 Serialized, Licensed, Unlicensed, etc) and relate to an 1101 entitlement. This attribute is typically used in supplemental 1102 tags as it contains information that might be selected during a 1103 specific install. 1105 * channel-type (index 44): A textual value that identifies which 1106 sales, licensing, or marketing channel the software component has 1107 been targeted for (e.g. Volume, Retail, OEM, Academic, etc). 1108 This attribute is typically used in supplemental tags as it 1109 contains information that might be selected during a specific 1110 install. 1112 * colloquial-version (index 45): A textual value for the software 1113 component's informal or colloquial version. Examples may include 1114 a year value, a major version number, or similar value that are 1115 used to identify a group of specific software component releases 1116 that are part of the same release/support cycle. This version can 1117 be the same through multiple releases of a software component, 1118 while the software-version specified in the concise-swid-tag group 1119 is much more specific and will change for each software component 1120 release. This version is intended to be used for string 1121 comparison only and is not intended to be used to determine if a 1122 specific value is earlier or later in a sequence. 1124 * description (index 46): A textual value that provides a detailed 1125 description of the software component. This value MAY be multiple 1126 paragraphs separated by CR LF characters as described by 1127 [RFC5198]. 1129 * edition (index 47): A textual value indicating that the software 1130 component represents a functional variation of the code base used 1131 to support multiple software components. For example, this item 1132 can be used to differentiate enterprise, standard, or professional 1133 variants of a software component. 1135 * entitlement-data-required (index 48): A boolean value that can be 1136 used to determine if accompanying proof of entitlement is needed 1137 when a software license reconciliation process is performed. 1139 * entitlement-key (index 49): A vendor-specific textual key that can 1140 be used to identify and establish a relationship to an 1141 entitlement. Examples of an entitlement-key might include a 1142 serial number, product key, or license key. For values that 1143 relate to a given software component install (i.e., license key), 1144 a supplemental tag will typically contain this information. In 1145 other cases, where a general-purpose key can be provided that 1146 applies to all possible installs of the software component on 1147 different endpoints, a primary tag will typically contain this 1148 information. 1150 * generator (index 50): The name (or tag-id) of the software 1151 component that created the CoSWID tag. If the generating software 1152 component has a SWID or CoSWID tag, then the tag-id for the 1153 generating software component SHOULD be provided. 1155 * persistent-id (index 51): A globally unique identifier used to 1156 identify a set of software components that are related. Software 1157 components sharing the same persistent-id can be different 1158 versions. This item can be used to relate software components, 1159 released at different points in time or through different release 1160 channels, that may not be able to be related through use of the 1161 link item. 1163 * product (index 52): A basic name for the software component that 1164 can be common across multiple tagged software components (e.g., 1165 Apache HTTPD). 1167 * product-family (index 53): A textual value indicating the software 1168 components overall product family. This should be used when 1169 multiple related software components form a larger capability that 1170 is installed on multiple different endpoints. For example, some 1171 software families may consist of server, client, and shared 1172 service components that are part of a larger capability. Email 1173 systems, enterprise applications, backup services, web 1174 conferencing, and similar capabilities are examples of families. 1175 Use of this item is not intended to represent groups of software 1176 that are bundled or installed together. The persistent-id or link 1177 items SHOULD be used to relate bundled software components. 1179 * revision (index 54): A string value indicating an informal or 1180 colloquial release version of the software. This value can 1181 provide a different version value as compared to the software- 1182 version specified in the concise-swid-tag group. This is useful 1183 when one or more releases need to have an informal version label 1184 that differs from the specific exact version value specified by 1185 software-version. Examples can include SP1, RC1, Beta, etc. 1187 * summary (index 55): A short description of the software component. 1188 This MUST be a single sentence suitable for display in a user 1189 interface. 1191 * unspsc-code (index 56): An 8 digit UNSPSC classification code for 1192 the software component as defined by the United Nations Standard 1193 Products and Services Code (UNSPSC, [UNSPSC]). 1195 * unspsc-version (index 57): The version of UNSPSC used to define 1196 the unspsc-code value. 1198 * $$meta-extension: This CDDL socket can be used to extend the 1199 software-meta-entry group model. See Section 2.2. 1201 2.9. The Resource Collection Definition 1203 2.9.1. The hash-entry Array 1205 CoSWID adds explicit support for the representation of hash entries 1206 using algorithms that are registered in the IANA "Named Information 1207 Hash Algorithm Registry" [IANA.named-information] using the hash 1208 member (index 7) and the corresponding hash-entry type. This is the 1209 equivalent of the namespace qualified "hash" attribute in [SWID]. 1211 hash-entry = [ 1212 hash-alg-id: int, 1213 hash-value: bytes, 1214 ] 1216 The number used as a value for hash-alg-id is an integer-based hash 1217 algorithm identifier who's value MUST refer to an ID in the IANA 1218 "Named Information Hash Algorithm Registry" [IANA.named-information] 1219 with a Status of "current"; other hash algorithms MUST NOT be used. 1220 If the hash-alg-id is not known, then the integer value "0" MUST be 1221 used. This ensures parity between the SWID tag specification [SWID], 1222 which does not allow an algorithm to be identified for this field. 1224 The hash-value MUST represent the raw hash value in byte 1225 representation (in contrast to, e.g., base64 encoded byte 1226 representation) of the byte string that represents the hashed 1227 resource generated using the hash algorithm indicated by the hash- 1228 alg-id. 1230 2.9.2. The resource-collection Group 1232 A list of items both used in evidence (created by a software 1233 discovery process) and payload (installed in an endpoint) content of 1234 a CoSWID tag document to structure and differentiate the content of 1235 specific CoSWID tag types. Potential content includes directories, 1236 files, processes, or resources. 1238 The CDDL for the resource-collection group follows: 1240 path-elements-group = ( ? directory => one-or-more, 1241 ? file => one-or-more, 1242 ) 1244 resource-collection = ( 1245 path-elements-group, 1246 ? process => one-or-more, 1247 ? resource => one-or-more, 1248 * $$resource-collection-extension, 1249 ) 1251 filesystem-item = ( 1252 ? key => bool, 1253 ? location => text, 1254 fs-name => text, 1255 ? root => text, 1256 ) 1258 file-entry = { 1259 filesystem-item, 1260 ? size => uint, 1261 ? file-version => text, 1262 ? hash => hash-entry, 1263 * $$file-extension, 1264 global-attributes, 1265 } 1267 directory-entry = { 1268 filesystem-item, 1269 ? path-elements => { path-elements-group }, 1270 * $$directory-extension, 1271 global-attributes, 1272 } 1274 process-entry = { 1275 process-name => text, 1276 ? pid => integer, 1277 * $$process-extension, 1278 global-attributes, 1279 } 1281 resource-entry = { 1282 type => text, 1283 * $$resource-extension, 1284 global-attributes, 1285 } 1287 directory = 16 1288 file = 17 1289 process = 18 1290 resource = 19 1291 size = 20 1292 file-version = 21 1293 key = 22 1294 location = 23 1295 fs-name = 24 1296 root = 25 1297 path-elements = 26 1298 process-name = 27 1299 pid = 28 1300 type = 29 1302 The following describes each member of the groups and maps 1303 illustrated above. 1305 * filesystem-item: A list of common items used for representing the 1306 filesystem root, relative location, name, and significance of a 1307 file or directory item. 1309 * global-attributes: The global-attributes group described in 1310 Section 2.5. 1312 * directory (index 16): A directory item allows child directory and 1313 file items to be defined within a directory hierarchy for the 1314 software component. 1316 * file (index 17): A file item allows details about a file to be 1317 provided for the software component. 1319 * process (index 18): A process item allows details to be provided 1320 about the runtime behavior of the software component, such as 1321 information that will appear in a process listing on an endpoint. 1323 * resource (index 19): A resource item can be used to provide 1324 details about an artifact or capability expected to be found on an 1325 endpoint or evidence collected related to the software component. 1326 This can be used to represent concepts not addressed directly by 1327 the directory, file, or process items. Examples include: registry 1328 keys, bound ports, etc. The equivalent construct in [SWID] is 1329 currently under specified. As a result, this item might be 1330 further defined through extension in the future. 1332 * size (index 20): The file's size in bytes. 1334 * file-version (index 21): The file's version as reported by 1335 querying information on the file from the operating system. This 1336 item maps to '/SoftwareIdentity/(Payload|Evidence)/File/@version' 1337 in [SWID]. 1339 * hash (index 7): A hash of the file as described in Section 2.9.1. 1341 * key (index 22): A boolean value indicating if a file or directory 1342 is significant or required for the software component to execute 1343 or function properly. These are files or directories that can be 1344 used to affirmatively determine if the software component is 1345 installed on an endpoint. 1347 * location (index 23): The filesystem path where a file is expected 1348 to be located when installed or copied. The location MUST be 1349 either relative to the location of the parent directory item 1350 (preferred) or relative to the location of the CoSWID tag if no 1351 parent is defined. The location MUST NOT include a file's name, 1352 which is provided by the fs-name item. 1354 * fs-name (index 24): The name of the directory or file without any 1355 path information. This aligns with a file "name" in [SWID]. This 1356 item maps to 1357 '/SoftwareIdentity/(Payload|Evidence)/(File|Directory)/@name' in 1358 [SWID]. 1360 * root (index 25): A filesystem-specific name for the root of the 1361 filesystem. The location item is considered relative to this 1362 location if specified. If not provided, the value provided by the 1363 location item is expected to be relative to its parent or the 1364 location of the CoSWID tag if no parent is provided. 1366 * path-elements (index 26): This group allows a hierarchy of 1367 directory and file items to be defined in payload or evidence 1368 items. This is a construction within the CDDL definition of 1369 CoSWID to support shared syntax and does not appear in [SWID]. 1371 * process-name (index 27): The software component's process name as 1372 it will appear in an endpoint's process list. This aligns with a 1373 process "name" in [SWID]. This item maps to 1374 '/SoftwareIdentity/(Payload|Evidence)/Process/@name' in [SWID]. 1376 * pid (index 28): The process ID identified for a running instance 1377 of the software component in the endpoint's process list. This is 1378 used as part of the evidence item. 1380 * type (index 29): A string indicating the type of resource. 1382 * $$resource-collection-extension: This CDDL socket can be used to 1383 extend the resource-collection group model. This can be used to 1384 add new specialized types of resources. See Section 2.2. 1386 * $$file-extension: This CDDL socket can be used to extend the file- 1387 entry group model. See Section 2.2. 1389 * $$directory-extension: This CDDL socket can be used to extend the 1390 directory-entry group model. See Section 2.2. 1392 * $$process-extension: This CDDL socket can be used to extend the 1393 process-entry group model. See Section 2.2. 1395 * $$resource-extension: This CDDL socket can be used to extend the 1396 resource-entry group model. See Section 2.2. 1398 2.9.3. The payload-entry Map 1400 The CDDL for the payload-entry map follows: 1402 payload-entry = { 1403 resource-collection, 1404 * $$payload-extension, 1405 global-attributes, 1406 } 1408 The following describes each child item of this group. 1410 * global-attributes: The global-attributes group described in 1411 Section 2.5. 1413 * resource-collection: The resource-collection group described in 1414 Section 2.9.2. 1416 * $$payload-extension: This CDDL socket can be used to extend the 1417 payload-entry group model. See Section 2.2. 1419 2.9.4. The evidence-entry Map 1421 The CDDL for the evidence-entry map follows: 1423 evidence-entry = { 1424 resource-collection, 1425 ? date => integer-time, 1426 ? device-id => text, 1427 * $$evidence-extension, 1428 global-attributes, 1429 } 1431 date = 35 1432 device-id = 36 1434 The following describes each child item of this group. 1436 * global-attributes: The global-attributes group described in 1437 Section 2.5. 1439 * resource-collection: The resource-collection group described in 1440 Section 2.9.2. 1442 * date (index 35): The date and time the information was collected 1443 pertaining to the evidence item. 1445 * device-id (index 36): The endpoint's string identifier from which 1446 the evidence was collected. 1448 * $$evidence-extension: This CDDL socket can be used to extend the 1449 evidence-entry group model. See Section 2.2. 1451 2.10. Full CDDL Specification 1453 In order to create a valid CoSWID document the structure of the 1454 corresponding CBOR message MUST adhere to the following CDDL 1455 specification. 1457 1458 concise-swid-tag = { 1459 tag-id => text / bstr .size 16, 1460 tag-version => integer, 1461 ? corpus => bool, 1462 ? patch => bool, 1463 ? supplemental => bool, 1464 software-name => text, 1465 ? software-version => text, 1466 ? version-scheme => $version-scheme, 1467 ? media => text, 1468 ? software-meta => one-or-more, 1469 entity => one-or-more, 1470 ? link => one-or-more, 1471 ? payload-or-evidence, 1472 * $$coswid-extension, 1473 global-attributes, 1474 } 1476 payload-or-evidence //= ( payload => payload-entry ) 1477 payload-or-evidence //= ( evidence => evidence-entry ) 1479 any-uri = uri 1480 label = text / int 1482 $version-scheme /= multipartnumeric 1483 $version-scheme /= multipartnumeric-suffix 1484 $version-scheme /= alphanumeric 1485 $version-scheme /= decimal 1486 $version-scheme /= semver 1487 $version-scheme /= int / text 1489 any-attribute = ( 1490 label => one-or-more / one-or-more 1491 ) 1493 one-or-more = T / [ 2* T ] 1495 global-attributes = ( 1496 ? lang => text, 1497 * any-attribute, 1498 ) 1500 hash-entry = [ 1501 hash-alg-id: int, 1502 hash-value: bytes, 1503 ] 1505 entity-entry = { 1506 entity-name => text, 1507 ? reg-id => any-uri, 1508 role => one-or-more<$role>, 1509 ? thumbprint => hash-entry, 1510 * $$entity-extension, 1511 global-attributes, 1512 } 1514 $role /= tag-creator 1515 $role /= software-creator 1516 $role /= aggregator 1517 $role /= distributor 1518 $role /= licensor 1519 $role /= maintainer 1520 $role /= int / text 1522 link-entry = { 1523 ? artifact => text, 1524 href => any-uri, 1525 ? media => text, 1526 ? ownership => $ownership, 1527 rel => $rel, 1528 ? media-type => text, 1529 ? use => $use, 1530 * $$link-extension, 1531 global-attributes, 1533 } 1535 $ownership /= shared 1536 $ownership /= private 1537 $ownership /= abandon 1538 $ownership /= int / text 1540 $rel /= ancestor 1541 $rel /= component 1542 $rel /= feature 1543 $rel /= installationmedia 1544 $rel /= packageinstaller 1545 $rel /= parent 1546 $rel /= patches 1547 $rel /= requires 1548 $rel /= see-also 1549 $rel /= supersedes 1550 $rel /= supplemental 1551 $rel /= -256..64436 / text 1553 $use /= optional 1554 $use /= required 1555 $use /= recommended 1556 $use /= int / text 1558 software-meta-entry = { 1559 ? activation-status => text, 1560 ? channel-type => text, 1561 ? colloquial-version => text, 1562 ? description => text, 1563 ? edition => text, 1564 ? entitlement-data-required => bool, 1565 ? entitlement-key => text, 1566 ? generator => text, 1567 ? persistent-id => text, 1568 ? product => text, 1569 ? product-family => text, 1570 ? revision => text, 1571 ? summary => text, 1572 ? unspsc-code => text, 1573 ? unspsc-version => text, 1574 * $$software-meta-extension, 1575 global-attributes, 1576 } 1578 path-elements-group = ( ? directory => one-or-more, 1579 ? file => one-or-more, 1580 ) 1582 resource-collection = ( 1583 path-elements-group, 1584 ? process => one-or-more, 1585 ? resource => one-or-more, 1586 * $$resource-collection-extension, 1587 ) 1589 file-entry = { 1590 filesystem-item, 1591 ? size => uint, 1592 ? file-version => text, 1593 ? hash => hash-entry, 1594 * $$file-extension, 1595 global-attributes, 1596 } 1598 directory-entry = { 1599 filesystem-item, 1600 ? path-elements => { path-elements-group }, 1601 * $$directory-extension, 1602 global-attributes, 1603 } 1605 process-entry = { 1606 process-name => text, 1607 ? pid => integer, 1608 * $$process-extension, 1609 global-attributes, 1610 } 1612 resource-entry = { 1613 type => text, 1614 * $$resource-extension, 1615 global-attributes, 1616 } 1618 filesystem-item = ( 1619 ? key => bool, 1620 ? location => text, 1621 fs-name => text, 1622 ? root => text, 1623 ) 1625 payload-entry = { 1626 resource-collection, 1627 * $$payload-extension, 1628 global-attributes, 1629 } 1630 evidence-entry = { 1631 resource-collection, 1632 ? date => integer-time, 1633 ? device-id => text, 1634 * $$evidence-extension, 1635 global-attributes, 1636 } 1638 integer-time = #6.1(int) 1640 ; "global map member" integer indexes 1641 tag-id = 0 1642 software-name = 1 1643 entity = 2 1644 evidence = 3 1645 link = 4 1646 software-meta = 5 1647 payload = 6 1648 hash = 7 1649 corpus = 8 1650 patch = 9 1651 media = 10 1652 supplemental = 11 1653 tag-version = 12 1654 software-version = 13 1655 version-scheme = 14 1656 lang = 15 1657 directory = 16 1658 file = 17 1659 process = 18 1660 resource = 19 1661 size = 20 1662 file-version = 21 1663 key = 22 1664 location = 23 1665 fs-name = 24 1666 root = 25 1667 path-elements = 26 1668 process-name = 27 1669 pid = 28 1670 type = 29 1671 entity-name = 31 1672 reg-id = 32 1673 role = 33 1674 thumbprint = 34 1675 date = 35 1676 device-id = 36 1677 artifact = 37 1678 href = 38 1679 ownership = 39 1680 rel = 40 1681 media-type = 41 1682 use = 42 1683 activation-status = 43 1684 channel-type = 44 1685 colloquial-version = 45 1686 description = 46 1687 edition = 47 1688 entitlement-data-required = 48 1689 entitlement-key = 49 1690 generator = 50 1691 persistent-id = 51 1692 product = 52 1693 product-family = 53 1694 revision = 54 1695 summary = 55 1696 unspsc-code = 56 1697 unspsc-version = 57 1699 ; "version-scheme" integer indexes 1700 multipartnumeric = 1 1701 multipartnumeric-suffix = 2 1702 alphanumeric = 3 1703 decimal = 4 1704 semver = 16384 1706 ; "role" integer indexes 1707 tag-creator=1 1708 software-creator=2 1709 aggregator=3 1710 distributor=4 1711 licensor=5 1712 maintainer=6 1714 ; "ownership" integer indexes 1715 shared=1 1716 private=2 1717 abandon=3 1719 ; "rel" integer indexes 1720 ancestor=1 1721 component=2 1722 feature=3 1723 installationmedia=4 1724 packageinstaller=5 1725 parent=6 1726 patches=7 1727 requires=8 1728 see-also=9 1729 supersedes=10 1730 ; supplemental=11 ; this is already defined earlier 1732 ; "use" integer indexes 1733 optional=1 1734 required=2 1735 recommended=3 1736 1738 3. Determining the Type of CoSWID 1740 The operational model for SWID and CoSWID tags was introduced in 1741 Section 1.1, which described four different CoSWID tag types. The 1742 following additional rules apply to the use of CoSWID tags to ensure 1743 that created tags properly identify the tag type. 1745 The first matching rule MUST determine the type of the CoSWID tag. 1747 1. Primary Tag: A CoSWID tag MUST be considered a primary tag if the 1748 corpus, patch, and supplemental items are "false". 1750 2. Supplemental Tag: A CoSWID tag MUST be considered a supplemental 1751 tag if the supplemental item is set to "true". 1753 3. Corpus Tag: A CoSWID tag MUST be considered a corpus tag if the 1754 corpus item is "true". 1756 4. Patch Tag: A CoSWID tag MUST be considered a patch tag if the 1757 patch item is "true". 1759 Note: Multiple of the corpus, patch, and supplemental items can have 1760 values set as "true". The rules above provide a means to determine 1761 the tag's type in such a case. For example, a SWID or CoSWID tag for 1762 a patch installer might have both corpus and patch items set to 1763 "true". In such a case, the tag is a "Corpus Tag". The tag 1764 installed by this installer would have only the patch item set to 1765 "true", making the installed tag type a "Patch Tag". 1767 4. CoSWID Indexed Label Values 1768 4.1. Version Scheme 1770 The following table contains a set of values for use in the concise- 1771 swid-tag group's version-scheme item. These values match the version 1772 schemes defined in the ISO/IEC 19770-2:2015 [SWID] specification. 1773 Index value indicates the value to use as the version-scheme item's 1774 value. The Version Scheme Name provides human-readable text for the 1775 value. The Definition describes the syntax of allowed values for 1776 each entry. 1778 +=======+=========================+================================+ 1779 | Index | Version Scheme Name | Definition | 1780 +=======+=========================+================================+ 1781 | 1 | multipartnumeric | Numbers separated by dots, | 1782 | | | where the numbers are | 1783 | | | interpreted as integers (e.g., | 1784 | | | 1.2.3, 1.4.5, 1.2.3.4.5.6.7) | 1785 +-------+-------------------------+--------------------------------+ 1786 | 2 | multipartnumeric+suffix | Numbers separated by dots, | 1787 | | | where the numbers are | 1788 | | | interpreted as integers with | 1789 | | | an additional textual suffix | 1790 | | | (e.g., 1.2.3a) | 1791 +-------+-------------------------+--------------------------------+ 1792 | 3 | alphanumeric | Strictly a string, sorting is | 1793 | | | done alphanumerically | 1794 +-------+-------------------------+--------------------------------+ 1795 | 4 | decimal | A floating point number (e.g., | 1796 | | | 1.25 is less than 1.3) | 1797 +-------+-------------------------+--------------------------------+ 1798 | 16384 | semver | A semantic version as defined | 1799 | | | by [SWID]. Also see the | 1800 | | | [SEMVER] specification for | 1801 | | | more information | 1802 +-------+-------------------------+--------------------------------+ 1804 Table 3: Version Scheme Values 1806 The values above are registered in the IANA "Software Tag Version 1807 Scheme Values" registry defined in Section Section 6.2.4. Additional 1808 entries will likely be registered over time in this registry. 1810 These version schemes have partially overlapping value spaces. The 1811 following guidelines help to ensure that the most specific version- 1812 scheme is used: 1814 * "decimal" and "multipartnumeric" partially overlap in their value 1815 space when a value matches a decimal number. When a corresponding 1816 software-version item's value falls within this overlapping value 1817 space, the "decimal" version scheme SHOULD be used. 1819 * "multipartnumeric" and "semver" partially overlap in their value 1820 space when a "multipartnumeric" value matches the semantic 1821 versioning syntax. When a corresponding software-version item's 1822 value falls within this overlapping value space, the "semver" 1823 version scheme SHOULD be used. 1825 * "alphanumeric" and other version schemes might overlap in their 1826 value space. When a corresponding software-version item's value 1827 falls within this overlapping value space, the other version 1828 scheme SHOULD be used instead of "alphanumeric". 1830 4.2. Entity Role Values 1832 The following table indicates the index value to use for the entity- 1833 entry group's role item (see Section 2.6). These values match the 1834 entity roles defined in the ISO/IEC 19770-2:2015 [SWID] 1835 specification. The "Index" value indicates the value to use as the 1836 role item's value. The "Role Name" provides human-readable text for 1837 the value. The "Definition" describes the semantic meaning of each 1838 entry. 1840 +=======+=================+========================================+ 1841 | Index | Role Name | Definition | 1842 +=======+=================+========================================+ 1843 | 1 | tagCreator | The person or organization that | 1844 | | | created the containing SWID or CoSWID | 1845 | | | tag | 1846 +-------+-----------------+----------------------------------------+ 1847 | 2 | softwareCreator | The person or organization entity that | 1848 | | | created the software component. | 1849 +-------+-----------------+----------------------------------------+ 1850 | 3 | aggregator | From [SWID], "An organization or | 1851 | | | system that encapsulates software from | 1852 | | | their own and/or other organizations | 1853 | | | into a different distribution process | 1854 | | | (as in the case of virtualization), or | 1855 | | | as a completed system to accomplish a | 1856 | | | specific task (as in the case of a | 1857 | | | value added reseller)." | 1858 +-------+-----------------+----------------------------------------+ 1859 | 4 | distributor | From [SWID], "An entity that furthers | 1860 | | | the marketing, selling and/or | 1861 | | | distribution of software from the | 1862 | | | original place of manufacture to the | 1863 | | | ultimate user without modifying the | 1864 | | | software, its packaging or its | 1865 | | | labelling." | 1866 +-------+-----------------+----------------------------------------+ 1867 | 5 | licensor | From [SAM] as "software licensor", a | 1868 | | | "person or organization who owns or | 1869 | | | holds the rights to issue a software | 1870 | | | license for a specific software | 1871 | | | [component]" | 1872 +-------+-----------------+----------------------------------------+ 1873 | 6 | maintainer | The person or organization that is | 1874 | | | responsible for coordinating and | 1875 | | | making updates to the source code for | 1876 | | | the software component. This SHOULD | 1877 | | | be used when the "maintainer" is a | 1878 | | | different person or organization than | 1879 | | | the original "softwareCreator". | 1880 +-------+-----------------+----------------------------------------+ 1882 Table 4: Entity Role Values 1884 The values above are registered in the IANA "Software Tag Entity Role 1885 Values" registry defined in Section 6.2.5. Additional values will 1886 likely be registered over time. 1888 4.3. Link Ownership Values 1890 The following table indicates the index value to use for the link- 1891 entry group's ownership item (see Section 2.7). These values match 1892 the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID] 1893 specification. The "Index" value indicates the value to use as the 1894 link-entry group ownership item's value. The "Ownership Type" 1895 provides human-readable text for the value. The "Definition" 1896 describes the semantic meaning of each entry. 1898 +=======+===========+===============================================+ 1899 | Index | Ownership | Definition | 1900 | | Type | | 1901 +=======+===========+===============================================+ 1902 | 1 | abandon | If the software component referenced by the | 1903 | | | CoSWID tag is uninstalled, then the | 1904 | | | referenced software SHOULD NOT be | 1905 | | | uninstalled | 1906 +-------+-----------+-----------------------------------------------+ 1907 | 2 | private | If the software component referenced by the | 1908 | | | CoSWID tag is uninstalled, then the | 1909 | | | referenced software SHOULD be uninstalled as | 1910 | | | well. | 1911 +-------+-----------+-----------------------------------------------+ 1912 | 3 | shared | If the software component referenced by the | 1913 | | | CoSWID tag is uninstalled, then the | 1914 | | | referenced software SHOULD be uninstalled if | 1915 | | | no other components sharing the software. | 1916 +-------+-----------+-----------------------------------------------+ 1918 Table 5: Link Ownership Values 1920 The values above are registered in the IANA "Software Tag Link 1921 Ownership Values" registry defined in Section 6.2.6. Additional 1922 values will likely be registered over time. 1924 4.4. Link Rel Values 1926 The following table indicates the index value to use for the link- 1927 entry group's rel item (see Section 2.7). These values match the 1928 link rel values defined in the ISO/IEC 19770-2:2015 [SWID] 1929 specification. The "Index" value indicates the value to use as the 1930 link-entry group ownership item's value. The "Relationship Type" 1931 provides human-readable text for the value. The "Definition" 1932 describes the semantic meaning of each entry. 1934 +=======+===================+=======================================+ 1935 | Index | Relationship Type | Definition | 1936 +=======+===================+=======================================+ 1937 | 1 | ancestor | The link references a software | 1938 | | | tag for a previous release of | 1939 | | | this software. This can be | 1940 | | | useful to define an upgrade path. | 1941 +-------+-------------------+---------------------------------------+ 1942 | 2 | component | The link references a software | 1943 | | | tag for a separate component of | 1944 | | | this software. | 1945 +-------+-------------------+---------------------------------------+ 1946 | 3 | feature | The link references a | 1947 | | | configurable feature of this | 1948 | | | software that can be enabled or | 1949 | | | disabled without changing the | 1950 | | | installed files. | 1951 +-------+-------------------+---------------------------------------+ 1952 | 4 | installationmedia | The link references the | 1953 | | | installation package that can be | 1954 | | | used to install this software. | 1955 +-------+-------------------+---------------------------------------+ 1956 | 5 | packageinstaller | The link references the | 1957 | | | installation software needed to | 1958 | | | install this software. | 1959 +-------+-------------------+---------------------------------------+ 1960 | 6 | parent | The link references a software | 1961 | | | tag that is the parent of the | 1962 | | | referencing tag. This | 1963 | | | relationship can be used when | 1964 | | | multiple software components are | 1965 | | | part of a software bundle, where | 1966 | | | the "parent" is the software tag | 1967 | | | for the bundle, and each child is | 1968 | | | a "component". In such a case, | 1969 | | | each child component can provide | 1970 | | | a "parent" link relationship to | 1971 | | | the bundle's software tag, and | 1972 | | | the bundle can provide a | 1973 | | | "component" link relationship to | 1974 | | | each child software component. | 1975 +-------+-------------------+---------------------------------------+ 1976 | 7 | patches | The link references a software | 1977 | | | tag that the referencing software | 1978 | | | patches. Typically only used for | 1979 | | | patch tags (see Section 1.1). | 1980 +-------+-------------------+---------------------------------------+ 1981 | 8 | requires | The link references a | 1982 | | | prerequisite for installing this | 1983 | | | software. A patch tag (see | 1984 | | | Section 1.1) can use this to | 1985 | | | represent base software or | 1986 | | | another patch that needs to be | 1987 | | | installed first. | 1988 +-------+-------------------+---------------------------------------+ 1989 | 9 | see-also | The link references other | 1990 | | | software that may be of interest | 1991 | | | that relates to this software. | 1992 +-------+-------------------+---------------------------------------+ 1993 | 10 | supersedes | The link references another | 1994 | | | software that this software | 1995 | | | replaces. A patch tag (see | 1996 | | | Section 1.1) can use this to | 1997 | | | represent another patch that this | 1998 | | | patch incorporates or replaces. | 1999 +-------+-------------------+---------------------------------------+ 2000 | 11 | supplemental | The link references a software | 2001 | | | tag that the referencing tag | 2002 | | | supplements. Used on | 2003 | | | supplemental tags (see | 2004 | | | Section 1.1). | 2005 +-------+-------------------+---------------------------------------+ 2007 Table 6: Link Relationship Values 2009 The values above are registered in the IANA "Software Tag Link 2010 Relationship Values" registry defined in Section 6.2.7. Additional 2011 values will likely be registered over time. 2013 4.5. Link Use Values 2015 The following table indicates the index value to use for the link- 2016 entry group's use item (see Section 2.7). These values match the 2017 link use values defined in the ISO/IEC 19770-2:2015 [SWID] 2018 specification. The "Index" value indicates the value to use as the 2019 link-entry group use item's value. The "Use Type" provides human- 2020 readable text for the value. The "Definition" describes the semantic 2021 meaning of each entry. 2023 +=======+=============+========================================+ 2024 | Index | Use Type | Definition | 2025 +=======+=============+========================================+ 2026 | 1 | optional | From [SWID], "Not absolutely required; | 2027 | | | the [Link]'d software is installed | 2028 | | | only when specified." | 2029 +-------+-------------+----------------------------------------+ 2030 | 2 | required | From [SWID], "The [Link]'d software is | 2031 | | | absolutely required for an operation | 2032 | | | software installation." | 2033 +-------+-------------+----------------------------------------+ 2034 | 3 | recommended | From [SWID], "Not absolutely required; | 2035 | | | the [Link]'d software is installed | 2036 | | | unless specified otherwise." | 2037 +-------+-------------+----------------------------------------+ 2039 Table 7: Link Use Values 2041 The values above are registered in the IANA "Software Tag Link Use 2042 Values" registry defined in Section 6.2.8. Additional values will 2043 likely be registered over time. 2045 5. URI Schemes 2047 This specification defines the following URI schemes for use in 2048 CoSWID and to provide interoperability with schemes used in [SWID]. 2050 Note: These URI schemes are used in [SWID] without an IANA 2051 registration. The present specification ensures that these URI 2052 schemes are properly defined going forward. 2054 5.1. "swid" URI Scheme 2056 There is a need for a scheme name that can be used in URIs that point 2057 to a specific software tag by that tag's tag-id, such as the use of 2058 the link entry as described in Section 2.7) of this document. Since 2059 this scheme is used both in a standards track document and an ISO 2060 standard, this scheme needs to be used without fear of conflicts with 2061 current or future actual schemes. In Section 6.6.1, the scheme 2062 "swid" is registered as a 'permanent' scheme for that purpose. 2064 URIs specifying the "swid" scheme are used to reference a software 2065 tag by its tag-id. A tag-id referenced in this way can be used to 2066 identify the tag resource in the context of where it is referenced 2067 from. For example, when a tag is installed on a given device, that 2068 tag can reference related tags on the same device using URIs with 2069 this scheme. 2071 For URIs that use the "swid" scheme, the scheme specific part MUST 2072 consist of a referenced software tag's tag-id. This tag-id MUST be 2073 URI encoded according to [RFC3986] Section 2.1. 2075 The following expression is a valid example: 2077 swid:2df9de35-0aff-4a86-ace6-f7dddd1ade4c 2079 5.2. "swidpath" URI Scheme 2081 There is a need for a scheme name that can be used in URIs to 2082 identify a collection of specific software tags with data elements 2083 that match an XPath expression, such as the use of the link entry as 2084 described in Section 2.7) of this document. Since this scheme is 2085 used both in a standards track document and an ISO standard, this 2086 scheme needs to be used without fear of conflicts with current or 2087 future actual schemes. In Section 6.6.2, the scheme "swidpath" is 2088 hereby registered as a 'permanent' scheme for that purpose. 2090 URIs specifying the "swidpath" scheme are used to reference the data 2091 that must be found in a given software tag for that tag to be 2092 considered a matching tag to be included in the identified tag 2093 collection. Tags to be evaluated include all tags in the context of 2094 where the tag is referenced from. For example, when a tag is 2095 installed on a given device, that tag can reference related tags on 2096 the same device using a URI with this scheme. 2098 For URIs that use the "swidpath" scheme, the requirements apply. 2100 The scheme specific part MUST be an XPath expression as defined by 2101 [W3C.REC-xpath20-20101214]. The included XPath expression will be 2102 URI encoded according to [RFC3986] Section 2.1. 2104 This XPath is evaluated over SWID or CoSWID tags found on a system. 2105 A given tag MUST be considered a match if the XPath evaluation result 2106 value has an effective boolean value of "true" according to 2107 [W3C.REC-xpath20-20101214] Section 2.4.3. 2109 6. IANA Considerations 2111 This document has a number of IANA considerations, as described in 2112 the following subsections. In summary, 6 new registries are 2113 established with this request, with initial entries provided for each 2114 registry. New values for 5 other registries are also requested. 2116 6.1. CoSWID Items Registry 2118 This registry uses integer values as index values in CBOR maps. 2120 This document defines a new registry titled "CoSWID Items". Future 2121 registrations for this registry are to be made based on [RFC8126] as 2122 follows: 2124 +==================+=====================================+ 2125 | Range | Registration Procedures | 2126 +==================+=====================================+ 2127 | 0-32767 | Standards Action with Expert Review | 2128 +------------------+-------------------------------------+ 2129 | 32768-4294967295 | Specification Required | 2130 +------------------+-------------------------------------+ 2132 Table 8: CoSWID Items Registration Procedures 2134 All negative values are reserved for Private Use. 2136 Initial registrations for the "CoSWID Items" registry are provided 2137 below. Assignments consist of an integer index value, the item name, 2138 and a reference to the defining specification. 2140 +===============+===========================+===============+ 2141 | Index | Item Name | Specification | 2142 +===============+===========================+===============+ 2143 | 0 | tag-id | RFC-AAAA | 2144 +---------------+---------------------------+---------------+ 2145 | 1 | software-name | RFC-AAAA | 2146 +---------------+---------------------------+---------------+ 2147 | 2 | entity | RFC-AAAA | 2148 +---------------+---------------------------+---------------+ 2149 | 3 | evidence | RFC-AAAA | 2150 +---------------+---------------------------+---------------+ 2151 | 4 | link | RFC-AAAA | 2152 +---------------+---------------------------+---------------+ 2153 | 5 | software-meta | RFC-AAAA | 2154 +---------------+---------------------------+---------------+ 2155 | 6 | payload | RFC-AAAA | 2156 +---------------+---------------------------+---------------+ 2157 | 7 | hash | RFC-AAAA | 2158 +---------------+---------------------------+---------------+ 2159 | 8 | corpus | RFC-AAAA | 2160 +---------------+---------------------------+---------------+ 2161 | 9 | patch | RFC-AAAA | 2162 +---------------+---------------------------+---------------+ 2163 | 10 | media | RFC-AAAA | 2164 +---------------+---------------------------+---------------+ 2165 | 11 | supplemental | RFC-AAAA | 2166 +---------------+---------------------------+---------------+ 2167 | 12 | tag-version | RFC-AAAA | 2168 +---------------+---------------------------+---------------+ 2169 | 13 | software-version | RFC-AAAA | 2170 +---------------+---------------------------+---------------+ 2171 | 14 | version-scheme | RFC-AAAA | 2172 +---------------+---------------------------+---------------+ 2173 | 15 | lang | RFC-AAAA | 2174 +---------------+---------------------------+---------------+ 2175 | 16 | directory | RFC-AAAA | 2176 +---------------+---------------------------+---------------+ 2177 | 17 | file | RFC-AAAA | 2178 +---------------+---------------------------+---------------+ 2179 | 18 | process | RFC-AAAA | 2180 +---------------+---------------------------+---------------+ 2181 | 19 | resource | RFC-AAAA | 2182 +---------------+---------------------------+---------------+ 2183 | 20 | size | RFC-AAAA | 2184 +---------------+---------------------------+---------------+ 2185 | 21 | file-version | RFC-AAAA | 2186 +---------------+---------------------------+---------------+ 2187 | 22 | key | RFC-AAAA | 2188 +---------------+---------------------------+---------------+ 2189 | 23 | location | RFC-AAAA | 2190 +---------------+---------------------------+---------------+ 2191 | 24 | fs-name | RFC-AAAA | 2192 +---------------+---------------------------+---------------+ 2193 | 25 | root | RFC-AAAA | 2194 +---------------+---------------------------+---------------+ 2195 | 26 | path-elements | RFC-AAAA | 2196 +---------------+---------------------------+---------------+ 2197 | 27 | process-name | RFC-AAAA | 2198 +---------------+---------------------------+---------------+ 2199 | 28 | pid | RFC-AAAA | 2200 +---------------+---------------------------+---------------+ 2201 | 29 | type | RFC-AAAA | 2202 +---------------+---------------------------+---------------+ 2203 | 31 | entity-name | RFC-AAAA | 2204 +---------------+---------------------------+---------------+ 2205 | 32 | reg-id | RFC-AAAA | 2206 +---------------+---------------------------+---------------+ 2207 | 33 | role | RFC-AAAA | 2208 +---------------+---------------------------+---------------+ 2209 | 34 | thumbprint | RFC-AAAA | 2210 +---------------+---------------------------+---------------+ 2211 | 35 | date | RFC-AAAA | 2212 +---------------+---------------------------+---------------+ 2213 | 36 | device-id | RFC-AAAA | 2214 +---------------+---------------------------+---------------+ 2215 | 37 | artifact | RFC-AAAA | 2216 +---------------+---------------------------+---------------+ 2217 | 38 | href | RFC-AAAA | 2218 +---------------+---------------------------+---------------+ 2219 | 39 | ownership | RFC-AAAA | 2220 +---------------+---------------------------+---------------+ 2221 | 40 | rel | RFC-AAAA | 2222 +---------------+---------------------------+---------------+ 2223 | 41 | media-type | RFC-AAAA | 2224 +---------------+---------------------------+---------------+ 2225 | 42 | use | RFC-AAAA | 2226 +---------------+---------------------------+---------------+ 2227 | 43 | activation-status | RFC-AAAA | 2228 +---------------+---------------------------+---------------+ 2229 | 44 | channel-type | RFC-AAAA | 2230 +---------------+---------------------------+---------------+ 2231 | 45 | colloquial-version | RFC-AAAA | 2232 +---------------+---------------------------+---------------+ 2233 | 46 | description | RFC-AAAA | 2234 +---------------+---------------------------+---------------+ 2235 | 47 | edition | RFC-AAAA | 2236 +---------------+---------------------------+---------------+ 2237 | 48 | entitlement-data-required | RFC-AAAA | 2238 +---------------+---------------------------+---------------+ 2239 | 49 | entitlement-key | RFC-AAAA | 2240 +---------------+---------------------------+---------------+ 2241 | 50 | generator | RFC-AAAA | 2242 +---------------+---------------------------+---------------+ 2243 | 51 | persistent-id | RFC-AAAA | 2244 +---------------+---------------------------+---------------+ 2245 | 52 | product | RFC-AAAA | 2246 +---------------+---------------------------+---------------+ 2247 | 53 | product-family | RFC-AAAA | 2248 +---------------+---------------------------+---------------+ 2249 | 54 | revision | RFC-AAAA | 2250 +---------------+---------------------------+---------------+ 2251 | 55 | summary | RFC-AAAA | 2252 +---------------+---------------------------+---------------+ 2253 | 56 | unspsc-code | RFC-AAAA | 2254 +---------------+---------------------------+---------------+ 2255 | 57 | unspsc-version | RFC-AAAA | 2256 +---------------+---------------------------+---------------+ 2257 | 58-4294967295 | Unassigned | | 2258 +---------------+---------------------------+---------------+ 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. 2265 While neither the CoSWID nor SWID specification is subordinate to the 2266 other and will evolve as their respective standards group chooses, 2267 there is value in supporting alignment between the two standards. 2268 Shared use of common code points, as spelled out in these registries, 2269 will facilitate this alignment, hence the intent for shared use of 2270 these registries and the decision to use "swid" (rather than 2271 "coswid") in registry names. 2273 6.2.1. Registration Procedures 2275 The following registries allow for the registration of index values 2276 and names. New registrations will be permitted through either a 2277 Standards Action with Expert Review policy or a Specification 2278 Required policy [BCP26]. New index values will be provided on a 2279 First Come First Served as defined by [BCP26]. 2281 The following registries also reserve the integer-based index values 2282 in the range of -1 to -256 for private use as defined by [BCP26] in 2283 Section 4.1. This allows values -1 to -24 to be expressed as a 2284 single uint_8t in CBOR, and values -25 to -256 to be expressed using 2285 an additional uint_8t in CBOR. 2287 6.2.2. Private Use of Index and Name Values 2289 The integer-based index values in the private use range (-1 to -256) 2290 are intended for testing purposes and closed environments; values in 2291 other ranges SHOULD NOT be assigned for testing. 2293 For names that correspond to private use index values, an 2294 Internationalized Domain Name prefix MUST be used to prevent name 2295 conflicts using the form: 2297 domain.prefix-name 2299 Where "domain.prefix" MUST be a valid Internationalized Domain Name 2300 as defined by [RFC5892], and "name" MUST be a unique name within the 2301 namespace defined by the "domain.prefix". Use of a prefix in this 2302 way allows for a name to be used initially in the private use range, 2303 and to be registered at a future point in time. This is consistent 2304 with the guidance in [BCP178]. 2306 6.2.3. Expert Review Guidelines 2308 Designated experts MUST ensure that new registration requests meet 2309 the following additional guidelines: 2311 * The requesting specification MUST provide a clear semantic 2312 definition for the new entry. This definition MUST clearly 2313 differentiate the requested entry from other previously registered 2314 entries. 2316 * The requesting specification MUST describe the intended use of the 2317 entry, including any co-constraints that exist between the use of 2318 the entry's index value or name, and other values defined within 2319 the SWID/CoSWID model. 2321 * Index values and names outside the private use space MUST NOT be 2322 used without registration. This is considered squatting and 2323 SHOULD be avoided. Designated experts MUST ensure that reviewed 2324 specifications register all appropriate index values and names. 2326 * Standards track documents MAY include entries registered in the 2327 range reserved for entries under the Specification Required 2328 policy. This can occur when a standards track document provides 2329 further guidance on the use of index values and names that are in 2330 common use, but were not registered with IANA. This situation 2331 SHOULD be avoided. 2333 * All registered names MUST be valid according to the XML Schema 2334 NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] 2335 Section 3.3.4). This ensures that registered names are compatible 2336 with the SWID format [SWID] where they are used. 2338 * Registration of vanity names SHOULD be discouraged. The 2339 requesting specification MUST provide a description of how a 2340 requested name will allow for use by multiple stakeholders. 2342 6.2.4. Software Tag Version Scheme Values Registry 2344 This document establishes a new registry titled "Software Tag Version 2345 Scheme Values". This registry provides index values for use as 2346 version-scheme item values in this document and version scheme names 2347 for use in [SWID]. 2349 [TO BE REMOVED: This registration should take place at the following 2350 location: https://www.iana.org/assignments/swid] 2352 This registry uses the registration procedures defined in 2353 Section 6.2.1 with the following associated ranges: 2355 +=============+=====================================+ 2356 | Range | Registration Procedures | 2357 +=============+=====================================+ 2358 | 0-16383 | Standards Action with Expert Review | 2359 +-------------+-------------------------------------+ 2360 | 16384-65535 | Specification Required | 2361 +-------------+-------------------------------------+ 2363 Table 10: CoSWID Version Scheme Registration 2364 Procedures 2366 Assignments MUST consist of an integer Index value, the Version 2367 Scheme Name, and a reference to the defining specification. 2369 Initial registrations for the "Software Tag Version Scheme Values" 2370 registry are provided below, which are derived from the textual 2371 version scheme names defined in [SWID]. 2373 +=============+=========================+=================+ 2374 | Index | Version Scheme Name | Specification | 2375 +=============+=========================+=================+ 2376 | 0 | Reserved | | 2377 +-------------+-------------------------+-----------------+ 2378 | 1 | multipartnumeric | See Section 4.1 | 2379 +-------------+-------------------------+-----------------+ 2380 | 2 | multipartnumeric+suffix | See Section 4.1 | 2381 +-------------+-------------------------+-----------------+ 2382 | 3 | alphanumeric | See Section 4.1 | 2383 +-------------+-------------------------+-----------------+ 2384 | 4 | decimal | See Section 4.1 | 2385 +-------------+-------------------------+-----------------+ 2386 | 5-16383 | Unassigned | | 2387 +-------------+-------------------------+-----------------+ 2388 | 16384 | semver | See Section 4.1 | 2389 +-------------+-------------------------+-----------------+ 2390 | 16385-65535 | Unassigned | | 2391 +-------------+-------------------------+-----------------+ 2393 Table 11: CoSWID Version Scheme Initial Registrations 2395 Registrations MUST conform to the expert review guidelines defined in 2396 Section 6.2.3. 2398 Designated experts MUST also ensure that newly requested entries 2399 define a value space for the corresponding version item that is 2400 unique from other previously registered entries. Note: The initial 2401 registrations violate this requirement, but are included for 2402 backwards compatibility with [SWID]. Guidelines on how to deconflict 2403 these value spaces are defined in Section 4.1. 2405 6.2.5. Software Tag Entity Role Values Registry 2407 This document establishes a new registry titled "Software Tag Entity 2408 Role Values". This registry provides index values for use as entity- 2409 entry role item values in this document and entity role names for use 2410 in [SWID]. 2412 [TO BE REMOVED: This registration should take place at the following 2413 location: https://www.iana.org/assignments/swid] 2415 This registry uses the registration procedures defined in 2416 Section 6.2.1 with the following associated ranges: 2418 +=========+=====================================+ 2419 | Range | Registration Procedures | 2420 +=========+=====================================+ 2421 | 0-127 | Standards Action with Expert Review | 2422 +---------+-------------------------------------+ 2423 | 128-255 | Specification Required | 2424 +---------+-------------------------------------+ 2426 Table 12: CoSWID Entity Role Registration 2427 Procedures 2429 Assignments consist of an integer Index value, a Role Name, and a 2430 reference to the defining specification. 2432 Initial registrations for the "Software Tag Entity Role Values" 2433 registry are provided below, which are derived from the textual 2434 entity role names defined in [SWID]. 2436 +=======+=================+=================+ 2437 | Index | Role Name | Specification | 2438 +=======+=================+=================+ 2439 | 0 | Reserved | | 2440 +-------+-----------------+-----------------+ 2441 | 1 | tagCreator | See Section 4.2 | 2442 +-------+-----------------+-----------------+ 2443 | 2 | softwareCreator | See Section 4.2 | 2444 +-------+-----------------+-----------------+ 2445 | 3 | aggregator | See Section 4.2 | 2446 +-------+-----------------+-----------------+ 2447 | 4 | distributor | See Section 4.2 | 2448 +-------+-----------------+-----------------+ 2449 | 5 | licensor | See Section 4.2 | 2450 +-------+-----------------+-----------------+ 2451 | 6 | maintainer | See Section 4.2 | 2452 +-------+-----------------+-----------------+ 2453 | 7-255 | Unassigned | | 2454 +-------+-----------------+-----------------+ 2456 Table 13: CoSWID Entity Role Initial 2457 Registrations 2459 Registrations MUST conform to the expert review guidelines defined in 2460 Section 6.2.3. 2462 6.2.6. Software Tag Link Ownership Values Registry 2464 This document establishes a new registry titled "Software Tag Link 2465 Ownership Values". This registry provides index values for use as 2466 link-entry ownership item values in this document and link ownership 2467 names for use in [SWID]. 2469 [TO BE REMOVED: This registration should take place at the following 2470 location: https://www.iana.org/assignments/swid] 2472 This registry uses the registration procedures defined in 2473 Section 6.2.1 with the following associated ranges: 2475 +=========+=====================================+ 2476 | Range | Registration Procedures | 2477 +=========+=====================================+ 2478 | 0-127 | Standards Action with Expert Review | 2479 +---------+-------------------------------------+ 2480 | 128-255 | Specification Required | 2481 +---------+-------------------------------------+ 2483 Table 14: CoSWID Link Ownership Registration 2484 Procedures 2486 Assignments consist of an integer Index value, an Ownership Type 2487 Name, and a reference to the defining specification. 2489 Initial registrations for the "Software Tag Link Ownership Values" 2490 registry are provided below, which are derived from the textual 2491 entity role names defined in [SWID]. 2493 +=======+=====================+=================+ 2494 | Index | Ownership Type Name | Definition | 2495 +=======+=====================+=================+ 2496 | 0 | Reserved | | 2497 +-------+---------------------+-----------------+ 2498 | 1 | abandon | See Section 4.3 | 2499 +-------+---------------------+-----------------+ 2500 | 2 | private | See Section 4.3 | 2501 +-------+---------------------+-----------------+ 2502 | 3 | shared | See Section 4.3 | 2503 +-------+---------------------+-----------------+ 2504 | 4-255 | Unassigned | | 2505 +-------+---------------------+-----------------+ 2507 Table 15: CoSWID Link Ownership Inital 2508 Registrations 2510 Registrations MUST conform to the expert review guidelines defined in 2511 Section 6.2.3. 2513 6.2.7. Software Tag Link Relationship Values Registry 2515 This document establishes a new registry titled "Software Tag Link 2516 Relationship Values". This registry provides index values for use as 2517 link-entry rel item values in this document and link ownership names 2518 for use in [SWID]. 2520 [TO BE REMOVED: This registration should take place at the following 2521 location: https://www.iana.org/assignments/swid] 2522 This registry uses the registration procedures defined in 2523 Section 6.2.1 with the following associated ranges: 2525 +=============+=====================================+ 2526 | Range | Registration Procedures | 2527 +=============+=====================================+ 2528 | 0-32767 | Standards Action with Expert Review | 2529 +-------------+-------------------------------------+ 2530 | 32768-65535 | Specification Required | 2531 +-------------+-------------------------------------+ 2533 Table 16: CoSWID Link Relationship Registration 2534 Procedures 2536 Assignments consist of an integer Index value, the Relationship Type 2537 Name, and a reference to the defining specification. 2539 Initial registrations for the "Software Tag Link Relationship Values" 2540 registry are provided below, which are derived from the link 2541 relationship values defined in [SWID]. 2543 +==========+========================+=================+ 2544 | Index | Relationship Type Name | Specification | 2545 +==========+========================+=================+ 2546 | 0 | Reserved | | 2547 +----------+------------------------+-----------------+ 2548 | 1 | ancestor | See Section 4.4 | 2549 +----------+------------------------+-----------------+ 2550 | 2 | component | See Section 4.4 | 2551 +----------+------------------------+-----------------+ 2552 | 3 | feature | See Section 4.4 | 2553 +----------+------------------------+-----------------+ 2554 | 4 | installationmedia | See Section 4.4 | 2555 +----------+------------------------+-----------------+ 2556 | 5 | packageinstaller | See Section 4.4 | 2557 +----------+------------------------+-----------------+ 2558 | 6 | parent | See Section 4.4 | 2559 +----------+------------------------+-----------------+ 2560 | 7 | patches | See Section 4.4 | 2561 +----------+------------------------+-----------------+ 2562 | 8 | requires | See Section 4.4 | 2563 +----------+------------------------+-----------------+ 2564 | 9 | see-also | See Section 4.4 | 2565 +----------+------------------------+-----------------+ 2566 | 10 | supersedes | See Section 4.4 | 2567 +----------+------------------------+-----------------+ 2568 | 11 | supplemental | See Section 4.4 | 2569 +----------+------------------------+-----------------+ 2570 | 12-65535 | Unassigned | | 2571 +----------+------------------------+-----------------+ 2573 Table 17: CoSWID Link Relationship Initial 2574 Registrations 2576 Registrations MUST conform to the expert review guidelines defined in 2577 Section 6.2.3. 2579 Designated experts MUST also ensure that a newly requested entry 2580 documents the URI schemes allowed to be used in an href associated 2581 with the link relationship and the expected resolution behavior of 2582 these URI schemes. This will help to ensure that applications 2583 processing software tags are able to interoperate when resolving 2584 resources referenced by a link of a given type. 2586 6.2.8. Software Tag Link Use Values Registry 2588 This document establishes a new registry titled "Software Tag Link 2589 Use Values". This registry provides index values for use as link- 2590 entry use item values in this document and link use names for use in 2591 [SWID]. 2593 [TO BE REMOVED: This registration should take place at the following 2594 location: https://www.iana.org/assignments/swid] 2596 This registry uses the registration procedures defined in 2597 Section 6.2.1 with the following associated ranges: 2599 +=========+=====================================+ 2600 | Range | Registration Procedures | 2601 +=========+=====================================+ 2602 | 0-127 | Standards Action with Expert Review | 2603 +---------+-------------------------------------+ 2604 | 128-255 | Specification Required | 2605 +---------+-------------------------------------+ 2607 Table 18: CoSWID Link Use Registration Procedures 2609 Assignments consist of an integer Index value, the Link Use Type 2610 Name, and a reference to the defining specification. 2612 Initial registrations for the "Software Tag Link Use Values" registry 2613 are provided below, which are derived from the link relationship 2614 values defined in [SWID]. 2616 +=======+====================+=================+ 2617 | Index | Link Use Type Name | Specification | 2618 +=======+====================+=================+ 2619 | 0 | Reserved | | 2620 +-------+--------------------+-----------------+ 2621 | 1 | optional | See Section 4.5 | 2622 +-------+--------------------+-----------------+ 2623 | 2 | required | See Section 4.5 | 2624 +-------+--------------------+-----------------+ 2625 | 3 | recommended | See Section 4.5 | 2626 +-------+--------------------+-----------------+ 2627 | 4-255 | Unassigned | | 2628 +-------+--------------------+-----------------+ 2630 Table 19: CoSWID Link Use Initial Registrations 2632 Registrations MUST conform to the expert review guidelines defined in 2633 Section 6.2.3. 2635 6.3. swid+cbor Media Type Registration 2637 IANA is requested to add the following to the IANA "Media Types" 2638 registry [IANA.media-types]. 2640 Type name: application 2642 Subtype name: swid+cbor 2644 Required parameters: none 2646 Optional parameters: none 2648 Encoding considerations: Must be encoded as using [RFC8949]. See 2649 RFC-AAAA for details. 2651 Security considerations: See Section 9 of RFC-AAAA. 2653 Interoperability considerations: Applications MAY ignore any key 2654 value pairs that they do not understand. This allows backwards 2655 compatible extensions to this specification. 2657 Published specification: RFC-AAAA 2659 Applications that use this media type: The type is used by software 2660 asset management systems, vulnerability assessment systems, and in 2661 applications that use remote integrity verification. 2663 Fragment identifier considerations: Fragment identification for 2664 application/swid+cbor is supported by using fragment identifiers as 2665 specified by Section 9.5 of [RFC8949]. 2667 Additional information: 2669 Magic number(s): first five bytes in hex: da 53 57 49 44 2671 File extension(s): coswid 2673 Macintosh file type code(s): none 2675 Macintosh Universal Type Identifier code: org.ietf.coswid conforms to 2676 public.data 2678 Person & email address to contact for further information: IESG 2679 2681 Intended usage: COMMON 2682 Restrictions on usage: None 2684 Author: Henk Birkholz 2686 Change controller: IESG 2688 6.4. CoAP Content-Format Registration 2690 IANA is requested to assign a CoAP Content-Format ID for the CoSWID 2691 media type in the "CoAP Content-Formats" sub-registry, from the "IETF 2692 Review or IESG Approval" space (256..999), within the "CoRE 2693 Parameters" registry [RFC7252] [IANA.core-parameters]: 2695 +=======================+==========+======+===========+ 2696 | Media type | Encoding | ID | Reference | 2697 +=======================+==========+======+===========+ 2698 | application/swid+cbor | - | TBD1 | RFC-AAAA | 2699 +-----------------------+----------+------+-----------+ 2701 Table 20: CoAP Content-Format IDs 2703 6.5. CBOR Tag Registration 2705 IANA is requested to allocate a tag in the "CBOR Tags" registry 2706 [IANA.cbor-tags], preferably with the specific value requested: 2708 +============+===========+=============================+ 2709 | Tag | Data Item | Semantics | 2710 +============+===========+=============================+ 2711 | 1398229316 | map | Concise Software Identifier | 2712 | | | (CoSWID) [RFC-AAAA] | 2713 +------------+-----------+-----------------------------+ 2715 Table 21: CoSWID CBOR Tag 2717 6.6. URI Scheme Registrations 2719 The ISO 19770-2:2015 SWID specification describes use of the "swid" 2720 and "swidpath" URI schemes, which are currently in use in 2721 implementations. This document continues this use for CoSWID. The 2722 following subsections provide registrations for these schemes in to 2723 ensure that a permanent registration exists for these schemes that is 2724 suitable for use in the SWID and CoSWID specifications. 2726 URI schemes are registered within the "Uniform Resource Identifier 2727 (URI) Schemes" registry maintained at [IANA.uri-schemes]. 2729 6.6.1. URI-scheme swid 2731 IANA is requested to register the URI scheme "swid". This 2732 registration request complies with [RFC7595]. 2734 Scheme name: 2735 swid 2737 Status: 2738 Permanent 2740 Applications/protocols that use this scheme name: 2741 Applications that require Software-IDs (SWIDs) or Concise 2742 Software-IDs (CoSWIDs); see Section 5.1 of RFC-AAAA. 2744 Contact: 2745 IETF Chair 2747 Change controller: 2748 IESG 2750 Reference: 2751 Section 5.1 in RFC-AAAA 2753 6.6.2. URI-scheme swidpath 2755 IANA is requested to register the URI scheme "swidpath". This 2756 registration request complies with [RFC7595]. 2758 Scheme name: 2759 swidpath 2761 Status: 2762 Permanent 2764 Applications/protocols that use this scheme name: 2765 Applications that require Software-IDs (SWIDs) or Concise 2766 Software-IDs (CoSWIDs); see Section 5.2 of RFC-AAAA. 2768 Contact: 2769 IETF Chair 2771 Change controller: 2772 IESG 2774 Reference: 2775 Section 5.2 in RFC-AAAA 2777 6.7. CoSWID Model for use in SWIMA Registration 2779 The Software Inventory Message and Attributes (SWIMA) for PA-TNC 2780 specification [RFC8412] defines a standardized method for collecting 2781 an endpoint device's software inventory. A CoSWID can provide 2782 evidence of software installation which can then be used and 2783 exchanged with SWIMA. This registration adds a new entry to the IANA 2784 "Software Data Model Types" registry defined by [RFC8412] 2785 [IANA.pa-tnc-parameters] to support CoSWID use in SWIMA as follows: 2787 Pen: 0 2789 Integer: TBD2 2791 Name: Concise Software Identifier (CoSWID) 2793 Reference: RFC-AAAA 2795 Deriving Software Identifiers: 2797 A Software Identifier generated from a CoSWID tag is expressed as a 2798 concatenation of the form in [RFC5234] as follows: 2800 TAG_CREATOR_REGID "_" "_" UNIQUE_ID 2802 Where TAG_CREATOR_REGID is the reg-id item value of the tag's entity 2803 item having the role value of 1 (corresponding to "tag creator"), and 2804 the UNIQUE_ID is the same tag's tag-id item. If the tag-id item's 2805 value is expressed as a 16 byte binary string, the UNIQUE_ID MUST be 2806 represented using the UUID string representation defined in [RFC4122] 2807 including the "urn:uuid:" prefix. 2809 The TAG_CREATOR_REGID and the UNIQUE_ID are connected with a double 2810 underscore (_), without any other connecting character or whitespace. 2812 7. Signed CoSWID Tags 2814 SWID tags, as defined in the ISO-19770-2:2015 XML schema, can include 2815 cryptographic signatures to protect the integrity of the SWID tag. 2816 In general, tags are signed by the tag creator (typically, although 2817 not exclusively, the vendor of the software component that the SWID 2818 tag identifies). Cryptographic signatures can make any modification 2819 of the tag detectable, which is especially important if the integrity 2820 of the tag is important, such as when the tag is providing reference 2821 integrity measurements for files. The ISO-19770-2:2015 XML schema 2822 uses XML DSIG to support cryptographic signatures. 2824 Signing CoSWID tags follows the procedures defined in CBOR Object 2825 Signing and Encryption [RFC8152]. A CoSWID tag MUST be wrapped in a 2826 COSE Single Signer Data Object (COSE_Sign1) that contains a single 2827 signature and MUST be signed by the tag creator. The following CDDL 2828 specification defines a restrictive subset of COSE header parameters 2829 that MUST be used in the protected header. 2831 2832 COSE-Sign1-coswid = [ 2833 protected: bstr .cbor protected-signed-coswid-header, 2834 unprotected: unprotected-signed-coswid-header, 2835 payload: bstr .cbor payload, 2836 signature: bstr, 2837 ] 2839 cose-label = int / tstr 2840 cose-values = any 2842 protected-signed-coswid-header = { 2843 1 => int, ; algorithm identifier 2844 3 => "application/swid+cbor", 2845 4 => bstr, ; key identifier 2846 * cose-label => cose-values, 2847 } 2849 unprotected-signed-coswid-header = { 2850 * cose-label => cose-values, 2851 } 2852 2854 The COSE_Sign structure that allows for more than one signature to be 2855 applied to a CoSWID tag MAY be used. The corresponding usage 2856 scenarios are domain-specific and require well-specified application 2857 guidance. 2859 2860 COSE-Sign-coswid = [ 2861 protected: bstr .cbor protected-signed-coswid-header1, 2862 unprotected: unprotected-signed-coswid-header, 2863 payload: bstr .cbor payload, 2864 signature: [ * COSE_Signature ], 2865 ] 2867 protected-signed-coswid-header1 = { 2868 3 => "application/swid+cbor", 2869 * cose-label => cose-values, 2870 } 2872 protected-signature-coswid-header = { 2873 1 => int, ; algorithm identifier 2874 4 => bstr, ; key identifier 2875 * cose-label => cose-values, 2876 } 2878 unprotected-sign-coswid-header = { 2879 * cose-label => cose-values, 2880 } 2882 COSE_Signature = [ 2883 protected: bstr .cbor protected-signature-coswid-header, 2884 unprotected: unprotected-sign-coswid-header, 2885 signature : bstr 2886 ] 2887 2889 Additionally, the COSE Header counter signature MAY be used as an 2890 attribute in the unprotected header map of the COSE envelope of a 2891 CoSWID. The application of counter signing enables second parties to 2892 provide a signature on a signature allowing for a proof that a 2893 signature existed at a given time (i.e., a timestamp). 2895 A CoSWID SHOULD be signed, using the above mechanism, to protect the 2896 integrity of the CoSWID tag. See the security considerations (in 2897 Section 9) for more information on why a signed CoSWID is valuable in 2898 most cases. 2900 8. Tagged CoSWID Tags 2902 This specification allows for tagged and untagged CBOR data items 2903 that are CoSWID tags. Consecutively, the CBOR tag for CoSWID tags 2904 defined in Table 21 SHOULD be used in conjunction with CBOR data 2905 items that are a CoSWID tags. Other CBOR tags MUST NOT be used with 2906 a CBOR data item that is a CoSWID tag. If tagged, both signed and 2907 unsigned CoSWID tags MUST use the CoSWID CBOR tag. In case a signed 2908 CoSWID is tagged, a CoSWID CBOR tag MUST be appended before the COSE 2909 envelope whether it is a COSE_Untagged_Message or a 2910 COSE_Tagged_Message. In case an unsigned CoSWID is tagged, a CoSWID 2911 CBOR tag MUST be appended before the CBOR data item that is the 2912 CoSWID tag. 2914 2915 coswid = unsigned-coswid / signed-coswid 2916 unsigned-coswid = concise-swid-tag / tagged-coswid 2917 signed-coswid1 = signed-coswid-for 2918 signed-coswid = signed-coswid1 / tagged-coswid 2920 tagged-coswid = #6.1398229316(T) 2922 signed-coswid-for = #6.18(COSE-Sign1-coswid) 2923 / #6.98(COSE-Sign-coswid) 2924 2926 This specification allows for a tagged CoSWID tag to reside in a COSE 2927 envelope that is also tagged with a CoSWID CBOR tag. In cases where 2928 a tag creator is not a signer (e.g., hand-offs between entities in a 2929 trusted portion of a supply-chain), retaining CBOR tags attached to 2930 unsigned CoSWID tags can be of great use. Nevertheless, redundant 2931 use of tags SHOULD be avoided when possible. 2933 9. Security Considerations 2935 The following security considerations for use of CoSWID tags focus 2936 on: 2938 * ensuring the integrity and authenticity of a CoSWID tag 2940 * the application of CoSWID tags to address security challenges 2941 related to unmanaged or unpatched software 2943 * reducing the potential for unintended disclosure of a device's 2944 software load 2946 A tag is considered "authoritative" if the CoSWID tag was created by 2947 the software provider. An authoritative CoSWID tag contains 2948 information about a software component provided by the supplier of 2949 the software component, who is expected to be an expert in their own 2950 software. Thus, authoritative CoSWID tags can represent 2951 authoritative information about the software component. The degree 2952 to which this information can be trusted depends on the tag's chain 2953 of custody and the ability to verify a signature provided by the 2954 supplier if present in the CoSWID tag. The provisioning and 2955 validation of CoSWID tags are handled by local policy and is outside 2956 the scope of this document. 2958 A signed CoSWID tag (see Section 7) whose signature has been 2959 validated can be relied upon to be unchanged since it was signed. By 2960 contrast, the data contained in unsigned tags can be altered by any 2961 user or process with write-access to the tag. To support signature 2962 validation, there is the need associate the right key with the 2963 software provider or party originating the signature. This operation 2964 is application specific and needs to be addressed by the application 2965 or a user of the application; a specific approach for which is out- 2966 of-scope for this document. 2968 When an authoritative tag is signed, the originator of the signature 2969 can be verified. A trustworthy association between the signature and 2970 the originator of the signature can be established via trust anchors. 2971 A certification path between a trust anchor and a certificate 2972 including a public key enabling the validation of a tag signature can 2973 realize the assessment of trustworthiness of an authoritative tag. 2974 Verifying that the software provider is the signer is a different 2975 matter. This requires an association between the signature and the 2976 tag's entity item associated corresponding to the software provider. 2977 No mechanism is defined in this draft to make this association; 2978 therefore, this association will need to be handled by local policy. 2980 Loss of control of signing credentials used to sign CoSWID tags would 2981 create doubt about the authenticity and integrity of any CoSWID tags 2982 signed using the compromised keys. In such cases, the legitimate tag 2983 signer (namely, the software provider for an authoritative CoSWID 2984 tag) can employ uncompromised signing credentials to create a new 2985 signature on the original tag. The tag version number would not be 2986 incremented since the tag itself was not modified. Consumers of 2987 CoSWID tags would need to validate the tag using the new credentials 2988 and would also need to revoke certificates associated with the 2989 compromised credentials to avoid validating tags signed with them. 2990 The process for doing this is beyond the scope of this specification. 2992 CoSWID tags are intended to contain public information about software 2993 components and, as such, the contents of a CoSWID tag does not need 2994 to be protected against unintended disclosure on an endpoint. 2996 CoSWID tags are intended to be easily discoverable by authorized 2997 applications and users on an endpoint in order to make it easy to 2998 determine the tagged software load. Access to the collection of an 2999 endpoint's CoSWID tags needs to be appropriately controlled to 3000 authorized applications and users using an appropriate access control 3001 mechanism. 3003 Since the tag-id of a CoSWID tag can be used as a global index value, 3004 failure to ensure the tag-id's uniqueness can cause collisions or 3005 ambiguity in CoSWID tags that are retrieved or processed using this 3006 identifier. CoSWID is designed to not require a registry of 3007 identifiers. As a result, CoSWID requires the tag creator employ a 3008 method of generating a unique tag identifier. Specific methods of 3009 generating a unique identifier are beyond the scope of this 3010 specification. A collision in tag-ids may result in false positives/ 3011 negatives in software integrity checks or mis-identification of 3012 installed software, undermining CoSWID use cases such as 3013 vulnerability identification, software inventory, etc. If such a 3014 collision is detected, then the tag consumer should contact the 3015 maintainer of the CoSWID to have them issue a correction addressing 3016 the collision. 3018 CoSWID tags are designed to be easily added and removed from an 3019 endpoint along with the installation or removal of software 3020 components. On endpoints where addition or removal of software 3021 components is tightly controlled, the addition or removal of CoSWID 3022 tags can be similarly controlled. On more open systems, where many 3023 users can manage the software inventory, CoSWID tags can be easier to 3024 add or remove. On such systems, it can be possible to add or remove 3025 CoSWID tags in a way that does not reflect the actual presence or 3026 absence of corresponding software components. Similarly, not all 3027 software products automatically install CoSWID tags, so products can 3028 be present on an endpoint without providing a corresponding CoSWID 3029 tag. As such, any collection of CoSWID tags cannot automatically be 3030 assumed to represent either a complete or fully accurate 3031 representation of the software inventory of the endpoint. However, 3032 especially on endpoint devices that more strictly control the ability 3033 to add or remove applications, CoSWID tags are an easy way to provide 3034 a preliminary understanding of that endpoint's software inventory. 3036 Any report of an endpoint's CoSWID tag collection provides 3037 information about the software inventory of that endpoint. If such a 3038 report is exposed to an attacker, this can tell them which software 3039 products and versions thereof are present on the endpoint. By 3040 examining this list, the attacker might learn of the presence of 3041 applications that are vulnerable to certain types of attacks. As 3042 noted earlier, CoSWID tags are designed to be easily discoverable by 3043 an endpoint, but this does not present a significant risk since an 3044 attacker would already need to have access to the endpoint to view 3045 that information. However, when the endpoint transmits its software 3046 inventory to another party, or that inventory is stored on a server 3047 for later analysis, this can potentially expose this information to 3048 attackers who do not yet have access to the endpoint. For this 3049 reason, it is important to protect the confidentiality of CoSWID tag 3050 information that has been collected from an endpoint in transit and 3051 at rest, not because those tags individually contain sensitive 3052 information, but because the collection of CoSWID tags and their 3053 association with an endpoint reveals information about that 3054 endpoint's attack surface. 3056 Finally, both the ISO-19770-2:2015 XML schema SWID definition and the 3057 CoSWID CDDL specification allow for the construction of "infinite" 3058 tags with link item loops or tags that contain malicious content with 3059 the intent of creating non-deterministic states during validation or 3060 processing of those tags. While software providers are unlikely to 3061 do this, CoSWID tags can be created by any party and the CoSWID tags 3062 collected from an endpoint could contain a mixture of vendor and non- 3063 vendor created tags. For this reason, a CoSWID tag might contain 3064 potentially malicious content. Input sanitization, loop detection, 3065 and signature verification are ways that implementations can address 3066 this concern. 3068 10. Privacy Consideration 3070 As noted in Section 9, collected information about an endpoint's 3071 software load, such as what might be represented by an endpoint's 3072 CoSWID tag collection, could be used to identify vulnerable software 3073 for attack. Collections of endpoint software information also can 3074 have privacy implications for users. The set of application a user 3075 installs can give clues to personal matters such as political 3076 affiliation, banking and investments, gender, sexual orientation, 3077 medical concerns, etc. While the collection of CoSWID tags on an 3078 endpoint wouldn't increase the privacy risk (since a party able to 3079 view those tags could also view the applications themselves), if 3080 those CoSWID tags are gathered and stored in a repository somewhere, 3081 visibility into the repository now also gives visibility into a 3082 user's application collection. For this reason, repositories of 3083 collected CoSWID tags not only need to be protected against 3084 collection by malicious parties, but even authorized parties will 3085 need to be vetted and made aware of privacy responsibilities 3086 associated with having access to this information. Likewise, users 3087 should be made aware that their software inventories are being 3088 collected from endpoints. Furthermore, when collected and stored by 3089 authorized parties or systems, the inventory data needs to be 3090 protected as both security and privacy sensitive information. 3092 11. Change Log 3094 This section is to be removed before publishing as an RFC. 3096 [THIS SECTION TO BE REMOVED BY THE RFC EDITOR.] 3098 Changes from version 12 to version 14: 3100 * Moved key identifier to protected COSE header 3102 * Fixed index reference for hash 3104 * Removed indirection of CDDL type definition for filesystem-item 3106 * Fixed quantity of resource and process 3108 * Updated resource-collection 3110 * Renamed socket name in software-meta to be consistent in naming 3112 * Aligned excerpt examples in I-D text with full CDDL 3114 * Fixed titles where title was referring to group instead of map 3116 * Added missing date in SEMVER 3118 * Fixed root cardinality for file and directory, etc. 3120 * Transformed path-elements-entry from map to group for re-usability 3122 * Scrubbed IANA Section 3124 * Removed redundant supplemental rule 3126 * Aligned discrepancy with ISO spec. 3128 * Addressed comments on typos. 3130 * Fixed kramdown nits and BCP reference. 3132 * Addressed comments from WGLC reviewers. 3134 Changes in version 12: 3136 * Addressed a bunch of minor editorial issues based on WGLC 3137 feedback. 3139 * Added text about the use of UTF-8 in CoSWID. 3141 * Adjusted tag-id to allow for a UUID to be provided as a bstr. 3143 * Cleaned up descriptions of index ranges throughout the document, 3144 removing discussion of 8 bit, 16 bit, etc. 3146 * Adjusted discussion of private use ranges to use negative integer 3147 values and to be more clear throughout the document. 3149 * Added discussion around resolving overlapping value spaces for 3150 version schemes. 3152 * Added a set of expert review guidelines for new IANA registries 3153 created by this document. 3155 * Added new registrations for the "swid" and "swidpath" URI schemes, 3156 and for using CoSWID with SWIMA. 3158 Changes from version 03 to version 11: 3160 * Reduced representation complexity of the media-entry type and 3161 removed the Section describing the older data structure. 3163 * Added more signature schemes from COSE 3165 * Included a minimal required set of normative language 3167 * Reordering of attribute name to integer label by priority 3168 according to semantics. 3170 * Added an IANA registry for CoSWID items supporting future 3171 extension. 3173 * Cleaned up IANA registrations, fixing some inconsistencies in the 3174 table labels. 3176 * Added additional CDDL sockets for resource collection entries 3177 providing for additional extension points to address future SWID/ 3178 CoSWID extensions. 3180 * Updated Section on extension points to address new CDDL sockets 3181 and to reference the new IANA registry for items. 3183 * Removed unused references and added new references to address 3184 placeholder comments. 3186 * Added table with semantics for the link ownership item. 3188 * Clarified language, made term use more consistent, fixed 3189 references, and replacing lowercase RFC2119 keywords. 3191 Changes from version 02 to version 03: 3193 * Updated core CDDL including the CDDL design pattern according to 3194 RFC 8428. 3196 Changes from version 01 to version 02: 3198 * Enforced a more strict separation between the core CoSWID 3199 definition and additional usage by moving content to corresponding 3200 appendices. 3202 * Removed artifacts inherited from the reference schema provided by 3203 ISO (e.g. NMTOKEN(S)) 3205 * Simplified the core data definition by removing group and type 3206 choices where possible 3208 * Minor reordering of map members 3210 * Added a first extension point to address requested flexibility for 3211 extensions beyond the any-element 3213 Changes from version 00 to version 01: 3215 * Ambiguity between evidence and payload eliminated by introducing 3216 explicit members (while still 3218 * allowing for "empty" SWID tags) 3220 * Added a relatively restrictive COSE envelope using cose_sign1 to 3221 define signed CoSWID (single signer only, at the moment) 3223 * Added a definition how to encode hashes that can be stored in the 3224 any-member using existing IANA tables to reference hash-algorithms 3226 Changes since adopted as a WG I-D -00: 3228 * Removed redundant any-attributes originating from the ISO- 3229 19770-2:2015 XML schema definition 3231 * Fixed broken multi-map members 3233 * Introduced a more restrictive item (any-element-map) to represent 3234 custom maps, increased restriction on types for the any-attribute, 3235 accordingly 3237 * Fixed X.1520 reference 3239 * Minor type changes of some attributes (e.g. NMTOKENS) 3241 * Added semantic differentiation of various name types (e,g. fs- 3242 name) 3244 Changes from version 06 to version 07: 3246 * Added type choices/enumerations based on textual definitions in 3247 19770-2:2015 3249 * Added value registry request 3251 * Added media type registration request 3253 * Added content format registration request 3255 * Added CBOR tag registration request 3257 * Removed RIM appendix to be addressed in complementary draft 3259 * Removed CWT appendix 3261 * Flagged firmware resource collection appendix for revision 3263 * Made use of terminology more consistent 3265 * Better defined use of extension points in the CDDL 3267 * Added definitions for indexed values 3269 * Added IANA registry for Link use indexed values 3271 Changes from version 05 to version 06: 3273 * Improved quantities 3275 * Included proposals for implicit enumerations that were NMTOKENS 3277 * Added extension points 3278 * Improved exemplary firmware-resource extension 3280 Changes from version 04 to version 05: 3282 * Clarified language around SWID and CoSWID to make more consistent 3283 use of these terms. 3285 * Added language describing CBOR optimizations for single vs. arrays 3286 in the model front matter. 3288 * Fixed a number of grammatical, spelling, and wording issues. 3290 * Documented extension points that use CDDL sockets. 3292 * Converted IANA registration tables to markdown tables, reserving 3293 the 0 value for use when a value is not known. 3295 * Updated a number of references to their current versions. 3297 Changes from version 03 to version 04: 3299 * Re-index label values in the CDDL. 3301 * Added a Section describing the CoSWID model in detail. 3303 * Created IANA registries for entity-role and version-scheme 3305 Changes from version 02 to version 03: 3307 * Updated CDDL to allow for a choice between a payload or evidence 3309 * Re-index label values in the CDDL. 3311 * Added item definitions 3313 * Updated references for COSE, CBOR Web Token, and CDDL. 3315 Changes from version 01 to version 02: 3317 * Added extensions for Firmware and CoSWID use as Reference 3318 Integrity Measurements (CoSWID RIM) 3320 * Changes meta handling in CDDL from use of an explicit use of items 3321 to a more flexible unconstrained collection of items. 3323 * Added Sections discussing use of COSE Signatures and CBOR Web 3324 Tokens 3326 Changes from version 00 to version 01: 3328 * Added CWT usage for absolute SWID paths on a device 3330 * Fixed cardinality of type-choices including arrays 3332 * Included first iteration of firmware resource-collection 3334 12. References 3336 12.1. Normative References 3338 [BCP178] Saint-Andre, P., Crocker, D., and M. Nottingham, 3339 "Deprecating the "X-" Prefix and Similar Constructs in 3340 Application Protocols", BCP 178, RFC 6648, 3341 DOI 10.17487/RFC6648, June 2012, 3342 . 3344 [BCP26] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 3345 Writing an IANA Considerations Section in RFCs", BCP 26, 3346 RFC 8126, DOI 10.17487/RFC8126, June 2017, 3347 . 3349 [IANA.cbor-tags] 3350 IANA, "Concise Binary Object Representation (CBOR) Tags", 3351 . 3353 [IANA.core-parameters] 3354 IANA, "Constrained RESTful Environments (CoRE) 3355 Parameters", 3356 . 3358 [IANA.media-types] 3359 IANA, "Media Types", 3360 . 3362 [IANA.named-information] 3363 IANA, "Named Information", 3364 . 3366 [IANA.pa-tnc-parameters] 3367 IANA, "Posture Attribute (PA) Protocol Compatible with 3368 Trusted Network Connect (TNC) Parameters", 3369 . 3371 [IANA.uri-schemes] 3372 IANA, "Uniform Resource Identifier (URI) Schemes", 3373 . 3375 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 3376 Requirement Levels", BCP 14, RFC 2119, 3377 DOI 10.17487/RFC2119, March 1997, 3378 . 3380 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 3381 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 3382 2003, . 3384 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 3385 Resource Identifier (URI): Generic Syntax", STD 66, 3386 RFC 3986, DOI 10.17487/RFC3986, January 2005, 3387 . 3389 [RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network 3390 Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008, 3391 . 3393 [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 3394 Specifications: ABNF", STD 68, RFC 5234, 3395 DOI 10.17487/RFC5234, January 2008, 3396 . 3398 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 3399 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 3400 September 2009, . 3402 [RFC5892] Faltstrom, P., Ed., "The Unicode Code Points and 3403 Internationalized Domain Names for Applications (IDNA)", 3404 RFC 5892, DOI 10.17487/RFC5892, August 2010, 3405 . 3407 [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained 3408 Application Protocol (CoAP)", RFC 7252, 3409 DOI 10.17487/RFC7252, June 2014, 3410 . 3412 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 3413 Writing an IANA Considerations Section in RFCs", BCP 26, 3414 RFC 8126, DOI 10.17487/RFC8126, June 2017, 3415 . 3417 [RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)", 3418 RFC 8152, DOI 10.17487/RFC8152, July 2017, 3419 . 3421 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 3422 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 3423 May 2017, . 3425 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 3426 DOI 10.17487/RFC8288, October 2017, 3427 . 3429 [RFC8412] Schmidt, C., Haynes, D., Coffin, C., Waltermire, D., and 3430 J. Fitzgerald-McKay, "Software Inventory Message and 3431 Attributes (SWIMA) for PA-TNC", RFC 8412, 3432 DOI 10.17487/RFC8412, July 2018, 3433 . 3435 [RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data 3436 Definition Language (CDDL): A Notational Convention to 3437 Express Concise Binary Object Representation (CBOR) and 3438 JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610, 3439 June 2019, . 3441 [RFC8949] Bormann, C. and P. Hoffman, "Concise Binary Object 3442 Representation (CBOR)", STD 94, RFC 8949, 3443 DOI 10.17487/RFC8949, December 2020, 3444 . 3446 [SAM] "Information technology - Software asset management - Part 3447 5: Overview and vocabulary", ISO/IEC 19770-5:2015, 15 3448 November 2013. 3450 [SEMVER] Preston-Werner, T., "Semantic Versioning 2.0.0", 3451 . 3453 [SWID] "Information technology - Software asset management - Part 3454 2: Software identification tag", ISO/IEC 19770-2:2015, 1 3455 October 2015. 3457 [UNSPSC] "United Nations Standard Products and Services Code", 26 3458 October 2020, . 3460 [W3C.REC-css3-mediaqueries-20120619] 3461 Rivoal, F., "Media Queries", World Wide Web Consortium 3462 Recommendation REC-css3-mediaqueries-20120619, 19 June 3463 2012, . 3466 [W3C.REC-xmlschema-2-20041028] 3467 Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes 3468 Second Edition", World Wide Web Consortium Recommendation 3469 REC-xmlschema-2-20041028, 28 October 2004, 3470 . 3472 [W3C.REC-xpath20-20101214] 3473 Berglund, A., Boag, S., Chamberlin, D., Fernandez, M., 3474 Kay, M., Robie, J., and J. Simeon, "XML Path Language 3475 (XPath) 2.0 (Second Edition)", World Wide Web Consortium 3476 Recommendation REC-xpath20-20101214, 14 December 2010, 3477 . 3479 [X.1520] "Recommendation ITU-T X.1520 (2014), Common 3480 vulnerabilities and exposures", 20 April 2011. 3482 12.2. Informative References 3484 [CamelCase] 3485 "UpperCamelCase", 29 August 2014, 3486 . 3488 [I-D.ietf-rats-architecture] 3489 Birkholz, H., Thaler, D., Richardson, M., Smith, N., and 3490 W. Pan, "Remote Attestation Procedures Architecture", Work 3491 in Progress, Internet-Draft, draft-ietf-rats-architecture- 3492 14, 9 December 2021, . 3495 [KebabCase] 3496 "KebabCase", 18 December 2014, 3497 . 3499 [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between 3500 Information Models and Data Models", RFC 3444, 3501 DOI 10.17487/RFC3444, January 2003, 3502 . 3504 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 3505 Unique IDentifier (UUID) URN Namespace", RFC 4122, 3506 DOI 10.17487/RFC4122, July 2005, 3507 . 3509 [RFC7595] Thaler, D., Ed., Hansen, T., and T. Hardie, "Guidelines 3510 and Registration Procedures for URI Schemes", BCP 35, 3511 RFC 7595, DOI 10.17487/RFC7595, June 2015, 3512 . 3514 [RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource- 3515 Oriented Lightweight Information Exchange (ROLIE)", 3516 RFC 8322, DOI 10.17487/RFC8322, February 2018, 3517 . 3519 [RFC8520] Lear, E., Droms, R., and D. Romascanu, "Manufacturer Usage 3520 Description Specification", RFC 8520, 3521 DOI 10.17487/RFC8520, March 2019, 3522 . 3524 [SWID-GUIDANCE] 3525 Waltermire, D., Cheikes, B.A., Feldman, L., and G. Witte, 3526 "Guidelines for the Creation of Interoperable Software 3527 Identification (SWID) Tags", NISTIR 8060, April 2016, 3528 . 3530 Acknowledgments 3532 This document draws heavily on the concepts defined in the ISO/IEC 3533 19770-2:2015 specification. The authors of this document are 3534 grateful for the prior work of the 19770-2 contributors. 3536 We are also grateful to the careful reviews provided by ... 3538 Contributors 3540 Carsten Bormann 3541 Universität Bremen TZI 3542 Postfach 330440 3543 D-28359 Bremen 3544 Germany 3546 Phone: +49-421-218-63921 3547 Email: cabo@tzi.org 3549 Carsten Bormann contributed to the CDDL specifications and the IANA 3550 considerations. 3552 Authors' Addresses 3554 Henk Birkholz 3555 Fraunhofer SIT 3556 Rheinstrasse 75 3557 64295 Darmstadt 3558 Germany 3560 Email: henk.birkholz@sit.fraunhofer.de 3561 Jessica Fitzgerald-McKay 3562 National Security Agency 3563 9800 Savage Road 3564 Ft. Meade, Maryland 3565 United States of America 3567 Email: jmfitz2@cyber.nsa.gov 3569 Charles Schmidt 3570 The MITRE Corporation 3571 202 Burlington Road 3572 Bedford, Massachusetts 01730 3573 United States of America 3575 Email: cmschmidt@mitre.org 3577 David Waltermire 3578 National Institute of Standards and Technology 3579 100 Bureau Drive 3580 Gaithersburg, Maryland 20877 3581 United States of America 3583 Email: david.waltermire@nist.gov