idnits 2.17.1 draft-ietf-sacm-coswid-12.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'SHOULD not' in this paragraph: +-------+-----------+-----------------------------------------------+ | Index | Ownership | Definition | | | Type | | +-------+-----------+-----------------------------------------------+ | 1 | abandon | If the software component referenced by the | | | | CoSWID tag is uninstalled, then the | | | | referenced software SHOULD not be uninstalled | | | | | | 2 | private | If the software component referenced by the | | | | CoSWID tag is uninstalled, then the | | | | referenced software SHOULD be uninstalled as | | | | well. | | | | | | 3 | shared | If the software component referenced by the | | | | CoSWID tag is uninstalled, then the | | | | referenced software SHOULD be uninstalled if | | | | no other components sharing the software. | +-------+-----------+-----------------------------------------------+ -- The document date (July 25, 2019) is 1737 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 1915, but not defined == Missing Reference: 'RFC-AAAA' is mentioned on line 2521, but not defined ** Obsolete normative reference: RFC 7049 (Obsoleted by RFC 8949) -- Duplicate reference: RFC8126, mentioned in 'RFC8126', was also mentioned in 'BCP26'. ** Obsolete normative reference: RFC 8152 (Obsoleted by RFC 9052, RFC 9053) -- Possible downref: Non-RFC (?) normative reference: ref. 'SAM' -- Possible downref: Non-RFC (?) normative reference: ref. 'SEMVER' -- Possible downref: Non-RFC (?) normative reference: ref. 'SWID' == Outdated reference: A later version (-07) exists of draft-birkholz-rats-tuda-00 Summary: 2 errors (**), 0 flaws (~~), 6 warnings (==), 5 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: January 26, 2020 Department of Defense 6 C. Schmidt 7 The MITRE Corporation 8 D. Waltermire 9 NIST 10 July 25, 2019 12 Concise Software Identification Tags 13 draft-ietf-sacm-coswid-12 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 the same features 23 as SWID tags, as well as additional semantics that allow CoSWIDs to 24 describe additional types of information, all in a more memory 25 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 January 26, 2020. 44 Copyright Notice 46 Copyright (c) 2019 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 51 (https://trustee.ietf.org/license-info) in effect on the date of 52 publication of this document. Please review these documents 53 carefully, as they describe your rights and restrictions with respect 54 to this document. Code Components extracted from this document must 55 include Simplified BSD License text as described in Section 4.e of 56 the Trust Legal Provisions and are provided without warranty as 57 described in the Simplified BSD License. 59 Table of Contents 61 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 62 1.1. The SWID and CoSWID Tag Lifecycle . . . . . . . . . . . . 4 63 1.2. Concise SWID Format . . . . . . . . . . . . . . . . . . . 7 64 1.3. Requirements Notation . . . . . . . . . . . . . . . . . . 7 65 2. Concise SWID Data Definition . . . . . . . . . . . . . . . . 7 66 2.1. Character Encoding . . . . . . . . . . . . . . . . . . . 8 67 2.2. Concise SWID Extensions . . . . . . . . . . . . . . . . . 9 68 2.3. The concise-swid-tag Group . . . . . . . . . . . . . . . 11 69 2.4. concise-swid-tag Co-constraints . . . . . . . . . . . . . 15 70 2.5. The global-attributes Group . . . . . . . . . . . . . . . 16 71 2.6. The entity-entry Group . . . . . . . . . . . . . . . . . 17 72 2.7. The link-entry Map . . . . . . . . . . . . . . . . . . . 18 73 2.8. The software-meta-entry Map . . . . . . . . . . . . . . . 22 74 2.9. The Resource Collection Definition . . . . . . . . . . . 26 75 2.9.1. The hash-entry Array . . . . . . . . . . . . . . . . 26 76 2.9.2. The resource-collection Group . . . . . . . . . . . . 26 77 2.9.3. The payload-entry Group . . . . . . . . . . . . . . . 29 78 2.9.4. The evidence-entry Group . . . . . . . . . . . . . . 30 79 2.10. Full CDDL Definition . . . . . . . . . . . . . . . . . . 30 80 3. Determining the Type of CoSWID . . . . . . . . . . . . . . . 36 81 4. CoSWID Indexed Label Values . . . . . . . . . . . . . . . . . 37 82 4.1. Version Scheme . . . . . . . . . . . . . . . . . . . . . 37 83 4.2. Entity Role Values . . . . . . . . . . . . . . . . . . . 38 84 4.3. Link Ownership Values . . . . . . . . . . . . . . . . . . 39 85 4.4. Link Rel Values . . . . . . . . . . . . . . . . . . . . . 40 86 4.5. Link Use Values . . . . . . . . . . . . . . . . . . . . . 42 87 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 43 88 5.1. CoSWID Items Registry . . . . . . . . . . . . . . . . . . 43 89 5.2. SWID/CoSWID Value Registries . . . . . . . . . . . . . . 46 90 5.2.1. Registration Proceedures . . . . . . . . . . . . . . 46 91 5.2.2. Private Use of Index and Name Values . . . . . . . . 46 92 5.2.3. Expert Review Guidelines . . . . . . . . . . . . . . 47 93 5.2.4. SWID/CoSWID Version Scheme Value Registry . . . . . . 47 94 5.2.5. SWID/CoSWID Entity Role Value Registry . . . . . . . 49 95 5.2.6. SWID/CoSWID Link Ownership Value Registry . . . . . . 50 96 5.2.7. SWID/CoSWID Link Relationship Value Registry . . . . 51 97 5.2.8. SWID/CoSWID Link Use Value Registry . . . . . . . . . 53 98 5.3. swid+cbor Media Type Registration . . . . . . . . . . . . 54 99 5.4. CoAP Content-Format Registration . . . . . . . . . . . . 55 100 5.5. CBOR Tag Registration . . . . . . . . . . . . . . . . . . 55 101 5.6. URI Scheme Registrations . . . . . . . . . . . . . . . . 55 102 5.6.1. "swid" URI Scheme Registration . . . . . . . . . . . 56 103 5.6.2. "swidpath" URI Scheme Registration . . . . . . . . . 56 104 5.7. CoSWID Model for use in SWIMA Registration . . . . . . . 57 105 6. Security Considerations . . . . . . . . . . . . . . . . . . . 58 106 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 60 107 8. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 60 108 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 64 109 9.1. Normative References . . . . . . . . . . . . . . . . . . 64 110 9.2. Informative References . . . . . . . . . . . . . . . . . 66 111 Appendix A. Signed Concise SWID Tags using COSE . . . . . . . . 67 112 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 68 114 1. Introduction 116 SWID tags, as defined in ISO-19770-2:2015 [SWID], provide a 117 standardized XML-based record format that identifies and describes a 118 specific release of software, a patch, or an installation bundle, 119 which are referred to as software components in this document. 120 Different software components, and even different releases of a 121 particular software component, each have a different SWID tag record 122 associated with them. SWID tags are meant to be flexible and able to 123 express a broad set of metadata about a software component. 125 SWID tags are used to support a number of processes including but not 126 limited to: 128 o Software Inventory Management, a part of a Software Asset 129 Management [SAM] process, which requires an accurate list of 130 discernible deployed software components. 132 o Vulnerability Assessment, which requires a semantic link between 133 standardized vulnerability descriptions and software components 134 installed on IT-assets [X.1520]. 136 o Remote Attestation, which requires a link between reference 137 integrity measurements (RIM) and security logs of measured 138 software components [I-D.birkholz-rats-tuda]. 140 While there are very few required fields in SWID tags, there are many 141 optional fields that support different uses. A SWID tag consisting 142 of only required fields might be a few hundred bytes in size; 143 however, a tag containing many of the optional fields can be many 144 orders of magnitude larger. Thus, real-world instances of SWID tags 145 can be fairly large, and the communication of SWID tags in usage 146 scenarios, such as those described earlier, can cause a large amount 147 of data to be transported. This can be larger than acceptable for 148 constrained devices and networks. Concise SWID (CoSWID) tags 149 significantly reduce the amount of data transported as compared to a 150 typical SWID tag. This reduction is enabled through the use of the 151 Concise Binary Object Representation (CBOR) [RFC7049], which maps the 152 human-readable labels of SWID data items to more concise integer 153 labels (indices). The use of CBOR to express SWID information in 154 CoSWID tags allows both CoSWID and SWID tags to be part of an 155 enterprise security solution for a wider range of endpoints and 156 environments. 158 1.1. The SWID and CoSWID Tag Lifecycle 160 In addition to defining the format of a SWID tag record, ISO/IEC 161 19770-2:2015 defines requirements concerning the SWID tag lifecycle. 162 Specifically, when a software component is installed on an endpoint, 163 that software component's SWID tag is also installed. Likewise, when 164 the software component is uninstalled or replaced, the SWID tag is 165 deleted or replaced, as appropriate. As a result, ISO/IEC 166 19770-2:2015 describes a system wherein there is a correspondence 167 between the set of installed software components on an endpoint, and 168 the presence of the corresponding SWID tags for these components on 169 that endpoint. CoSWIDs share the same lifecycle requirements as a 170 SWID tag. 172 The SWID specification and supporting guidance provided in NIST 173 Internal Report (NISTIR) 8060: Guidelines for the Creation of 174 Interoperable SWID Tags [SWID-GUIDANCE] defines four types of SWID 175 tags: primary, patch, corpus, and supplemental. The following text 176 is paraphrased from these sources. 178 1. Primary Tag - A SWID or CoSWID tag that identifies and describes 179 an installed software component on an endpoint. A primary tag is 180 intended to be installed on an endpoint along with the 181 corresponding software component. 183 2. Patch Tag - A SWID or CoSWID tag that identifies and describes an 184 installed patch that has made incremental changes to a software 185 component installed on an endpoint. A patch tag is intended to 186 be installed on an endpoint along with the corresponding software 187 component patch. 189 3. Corpus Tag - A SWID or CoSWID tag that identifies and describes 190 an installable software component in its pre-installation state. 191 A corpus tag can be used to represent metadata about an 192 installation package or installer for a software component, a 193 software update, or a patch. 195 4. Supplemental Tag - A SWID or CoSWID tag that allows additional 196 information to be associated with a referenced SWID tag. This 197 allows tools and users to record their own metadata about a 198 software component without modifying SWID primary or patch tags 199 created by a software provider. 201 The type of a tag is determined by specific data elements, which are 202 discussed in Section 3. 204 Corpus, primary, and patch tags have similar functions in that 205 they describe the existence and/or presence of different types of 206 software components (e.g., software installers, software 207 installations, software patches), and, potentially, different 208 states of these software components. Supplemental tags have the 209 same structure as other tags, but are used to provide information 210 not contained in the referenced corpus, primary, and patch tags. 211 All four tag types come into play at various points in the 212 software lifecycle and support software management processes that 213 depend on the ability to accurately determine where each software 214 component is in its lifecycle. 216 +------------+ 217 v | 218 Software Software Software Software Software 219 Deployment -> Installation -> Patching -> Upgrading -> Removal 221 Corpus Primary Primary xPrimary xPrimary 222 Supplemental Supplemental Supplemental xSupplemental xSuplemental 223 Patch xPatch 224 Primary 225 Supplemental 227 Figure 1: Use of Tag Types in the Software Lifecycle 229 Figure 1 illustrates the steps in the software lifecycle and the 230 relationships among those lifecycle events supported by the four 231 types of SWID and CoSWID tags. The figure identifies the types of 232 tags that can be deployed and previously deployed tags that are 233 typically removed (indicated by an "x" prefix) at each lifecycle 234 stage, as follows: 236 * Software Deployment. Before the software component is 237 installed (i.e., pre-installation), and while the product is 238 being deployed, a corpus tag provides information about the 239 installation files and distribution media (e.g., CD/DVD, 240 distribution package). 242 * Software Installation. A primary tag will be installed with 243 the software component (or subsequently created) to uniquely 244 identify and describe the software component. Supplemental 245 tags are created to augment primary tags with additional site- 246 specific or extended information. While not illustrated in the 247 figure, patch tags can also be installed during software 248 installation to provide information about software fixes 249 deployed along with the base software installation. 251 * Software Patching. When a new patch is applied to the software 252 component a new patch tag is provided, supplying details about 253 the patch and its dependencies. While not illustrated in the 254 figure, a corpus tag can also provide information about the 255 patch installer and patching dependencies that need to be 256 installed before the patch. 258 * Software Upgrading. As a software component is upgraded to a 259 new version, new primary and supplemental tags replace existing 260 tags, enabling timely and accurate tracking of updates to 261 software inventory. While not illustrated in the figure, a 262 corpus tag can also provide information about the upgrade 263 installer and dependencies that need to be installed before the 264 upgrade. 266 * Software Removal. Upon removal of the software component, 267 relevant SWID tags are removed. This removal event can trigger 268 timely updates to software inventory reflecting the removal of 269 the product and any associated patch or supplemental tags. 271 As illustrated in the figure, supplemental tags can be associated 272 with any corpus, primary, or patch tag to provide additional metadata 273 about an installer, installed software, or installed patch 274 respectively. 276 Understanding the use of CoSWIDs in the software lifecycle provides a 277 basis for understanding the information provided in a CoSWID and the 278 associated semantics of this information. Each of the different SWID 279 and CoSWID tag types provide different sets of information. For 280 example, a "corpus tag" is used to describe a software component's 281 installation image on an installation media, while a "patch tag" is 282 meant to describe a patch that modifies some other software 283 component. 285 1.2. Concise SWID Format 287 This document defines the CoSWID tag format, which is based on CBOR. 288 CBOR-based CoSWID tags offer a more concise representation of SWID 289 information as compared to the XML-based SWID tag representation in 290 ISO-19770-2:2015. The structure of a CoSWID is described via the 291 Concise Data Definition Language (CDDL) [RFC8610]. The resulting 292 CoSWID data definition is aligned to the information able to be 293 expressed with the XML schema definition of ISO-19770-2:2015 [SWID]. 294 This alignment allows both SWID and CoSWID tags to represent a common 295 set of software component information and allows CoSWID tags to 296 support the same uses as a SWID tag. To achieve this end, the CDDL 297 representation includes every SWID tag field and attribute. 299 The vocabulary, i.e., the CDDL names of the types and members used in 300 the CoSWID data definition, are mapped to more concise labels 301 represented as small integer values. The names used in the CDDL data 302 definition and the mapping to the CBOR representation using integer 303 labels is based on the vocabulary of the XML attribute and element 304 names defined in ISO/IEC 19770-2:2015. 306 1.3. Requirements Notation 308 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 309 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 310 "OPTIONAL" in this document are to be interpreted as described in 311 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 312 capitals, as shown here. 314 2. Concise SWID Data Definition 316 The following describes the general rules and processes for encoding 317 data using CDDL representation. Prior familiarity with CBOR and CDDL 318 concepts will be helpful in understanding this CoSWID data 319 definition. 321 This section describes the rules by which SWID tag XML is represented 322 in the CoSWID CDDL structure. The CamelCase [CamelCase] notation 323 used in the XML schema definition is changed to a hyphen-separated 324 notation [KebabCase] (e.g. ResourceCollection is named resource- 325 collection) in the CoSWID data definition. This deviation from the 326 original notation used in the XML representation reduces ambiguity 327 when referencing certain attributes in corresponding textual 328 descriptions. An attribute referred to by its name in CamelCase 329 notation explicitly relates to XML SWID tags; an attribute referred 330 to by its name in KebabCase notation explicitly relates to CBOR 331 CoSWID tags. This approach simplifies the composition of further 332 work that reference both XML SWID and CBOR CoSWID documents. 334 In most cases, mapping attribute names between SWID and CoSWID can be 335 done automatically by converting between CamelCase and KebabCase 336 attribute names. However, some CoSWID CDDL attribute names show 337 greater variation relative to their corresponding SWID XML Schema 338 attributes. This is done when the change improves clarity in the 339 specification. For example the "name" and "version" SWID fields 340 corresponds to the "software-name" and "software-version" CoSWID 341 fields, respectively. As such, it is not always possible to 342 mechanically translate between corresponding attribute names in the 343 two formats. In such cases, a manual mapping will need to be used. 345 The 57 human-readable text labels of the CDDL-based CoSWID vocabulary 346 are mapped to integer indices via a block of rules at the bottom of 347 the definition. This allows a more concise integer-based form to be 348 stored or transported, as compared to the less efficient text-based 349 form of the original vocabulary. 351 In CBOR, an array is encoded using bytes that identify the array, and 352 the array's length or stop point (see [RFC7049]). To make items that 353 support 1 or more values, the following CDDL notion is used. 355 _name_ = (_label_: _data_ / [ 2* _data_ ]) 357 The CDDL rule above allows either a single data item or an array of 2 358 or more data values to be provided. When a singleton data value is 359 provided, the CBOR markers for the array, array length, and stop 360 point are not needed, saving bytes. When two or more data values are 361 provided, these values are encoded as an array. This modeling 362 pattern is used frequently in the CoSWID CDDL data definition to 363 allow for more efficient encoding of singleton values. 365 The following subsections describe the different parts of the CoSWID 366 model. 368 2.1. Character Encoding 370 The CDDL "text" type is represented in CBOR as a major type 3, which 371 represents "a string of Unicode characters that [are] encoded as 372 UTF-8 [RFC3629]" (see [RFC7049] section 2.1). Thus both SWID and 373 CoSWID use UTF-8 for the encoding of characters in text strings. 375 To ensure that UTF-8 character strings are able to be encodes/decoded 376 and exchanged interoperably, text strings in CoSWID MUST be encoded 377 consistent with the Net-Unicode definition defined in [RFC5198]. 379 All names registered with IANA according to requirements in section 380 Section 5.2 also need to be valid according to the XML Schema NMToken 381 data type (see [W3C.REC-xmlschema-2-20041028] section 3.3.4) to 382 ensure compatibility with the SWID specification where these names 383 are used. 385 2.2. Concise SWID Extensions 387 The CoSWID data definition contains two features that are not 388 included in the SWID data definition on which it is based. These 389 features are: 391 o The explicit definition of types for some attributes in the ISO- 392 19770-2:2015 XML representation that are typically represented by 393 the "any attribute" in the SWID model. These are covered in 394 Section 2.5. 396 o The inclusion of extension points in the CoSWID data definition 397 using CDDL sockets (see [RFC8610] section 3.9). The use of CDDL 398 sockets allow for well-formed extensions to be defined in 399 supplementary CDDL descriptions that support additional uses of 400 CoSWID tags that go beyond the original scope of ISO-19770-2:2015 401 tags. This extension mechanism can also be used to update the 402 CoSWID format as revisions to ISO-19770-2 are published. 404 The following CDDL sockets (extension points) are defined in this 405 document, which allow the addition of new information structures to 406 their respective CDDL groups. 408 +---------------------+-----------------------+---------------+ 409 | Map Name | CDDL Socket | Defined in | 410 +---------------------+-----------------------+---------------+ 411 | concise-swid-tag | $$coswid-extension | Section 2.3 | 412 | | | | 413 | entity-entry | $$entity-extension | Section 2.6 | 414 | | | | 415 | link-entry | $$link-extension | Section 2.7 | 416 | | | | 417 | software-meta-entry | $$meta-extension | Section 2.8 | 418 | | | | 419 | file-entry | $$file-extension | Section 2.9.2 | 420 | | | | 421 | directory-entry | $$directory-extension | Section 2.9.2 | 422 | | | | 423 | process-entry | $$process-extension | Section 2.9.2 | 424 | | | | 425 | resource-entry | $$resource-extension | Section 2.9.2 | 426 | | | | 427 | payload-entry | $$payload-extension | Section 2.9.3 | 428 | | | | 429 | evidence-entry | $$evidence-extension | Section 2.9.4 | 430 +---------------------+-----------------------+---------------+ 432 Table 1: CoSWID CDDL Group Extension Points 434 The CoSWID Items Registry defined in Section 5.1 provides a 435 registration mechanism allowing new items, and their associated index 436 values, to be added to the CoSWID model through the use of the CDDL 437 sockets described in the table above. This registration mechanism 438 provides for well-known index values for data items in CoSWID 439 extensions, allowing these index values to be recognized by 440 implementations supporting a given extension. 442 The following additional CDDL sockets are defined in this document to 443 allow for adding new values to corresponding type-choices (i.e. to 444 represent enumerations) via custom CDDL data definitions. 446 +------------------+-----------------+-------------+ 447 | Enumeration Name | CDDL Socket | Defined in | 448 +------------------+-----------------+-------------+ 449 | version-scheme | $version-scheme | Section 4.1 | 450 | | | | 451 | role | $role | Section 4.2 | 452 | | | | 453 | ownership | $ownership | Section 4.3 | 454 | | | | 455 | rel | $rel | Section 4.4 | 456 | | | | 457 | use | $use | Section 4.5 | 458 +------------------+-----------------+-------------+ 460 Table 2: CoSWID CDDL Enumeration Extension Points 462 A number of SWID/CoSWID value registries are also defined in 463 Section 5.2 that allow new values to be registered with IANA for the 464 enumerations above. This registration mechanism supports the 465 definition of new well-known index values and names for new 466 enumeration values used by both SWID and CoSWID. This registration 467 mechanism allows new standardized enumerated values to be shared 468 between both specifications (and implementations) over time, and 469 references to the IANA registries will be added to the next revision 470 of [SWID]. 472 2.3. The concise-swid-tag Group 474 The CDDL data definition for the root concise-swid-tag map is as 475 follows and this rule and its constraints MUST be followed when 476 creating or validating a CoSWID tag: 478 concise-swid-tag = { 479 global-attributes, 480 tag-id => text / bstr .size 16, 481 tag-version => integer, 482 ? corpus => bool, 483 ? patch => bool, 484 ? supplemental => bool, 485 software-name => text, 486 ? software-version => text, 487 ? version-scheme => $version-scheme, 488 ? media => text, 489 ? software-meta => software-meta-entry / [ 2* software-meta-entry ], 490 entity => entity-entry / [ 2* entity-entry ], 491 ? link => link-entry / [ 2* link-entry ], 492 ? (( payload => payload-entry ) // ( evidence => evidence-entry )), 493 * $$coswid-extension 494 } 496 tag-id = 0 497 software-name = 1 498 entity = 2 499 evidence = 3 500 link = 4 501 software-meta = 5 502 payload = 6 503 corpus = 8 504 patch = 9 505 media = 10 506 supplemental = 11 507 tag-version = 12 508 software-version = 13 509 version-scheme = 14 511 $version-scheme /= multipartnumeric 512 $version-scheme /= multipartnumeric-suffix 513 $version-scheme /= alphanumeric 514 $version-scheme /= decimal 515 $version-scheme /= semver 516 $version-scheme /= uint / text 517 multipartnumeric = 1 518 multipartnumeric-suffix = 2 519 alphanumeric = 3 520 decimal = 4 521 semver = 16384 523 The following describes each member of the concise-swid-tag root map. 525 o global-attributes: A list of items including an optional language 526 definition to support the processing of text-string values and an 527 unbounded set of any-attribute items. Described in Section 2.5. 529 o tag-id (index 0): A 16 byte binary string or textual identifier 530 uniquely referencing a software component. The tag identifier 531 MUST be globally unique. If represented as a 16 byte binary 532 string, the identifier MUST be a valid universally unique 533 identifier as defined by [RFC4122]. There are no strict 534 guidelines on how this identifier is structured, but examples 535 include a 16 byte GUID (e.g. class 4 UUID) [RFC4122], or a text 536 string appended to a DNS domain name to ensure uniqueness across 537 organizations. 539 o tag-version (index 12): An integer value that indicate the 540 specific release revision of the tag. Typically, the initial 541 value of this field is set to 0 and the value is monotonically 542 increased for subsequent tags produced for the same software 543 component release. This value allows a CoSWID tag producer to 544 correct an incorrect tag previously released without indicating a 545 change to the underlying software component the tag represents. 546 For example, the tag version could be changed to add new metadata, 547 to correct a broken link, to add a missing payload entry, etc. 548 When producing a revised tag, the new tag-version value MUST be 549 greater than the old tag-version value. 551 o corpus (index 8): A boolean value that indicates if the tag 552 identifies and describes an installable software component in its 553 pre-installation state. Installable software includes a 554 installation package or installer for a software component, a 555 software update, or a patch. If the CoSWID tag represents 556 installable software, the corpus item MUST be set to "true". If 557 not provided, the default value MUST be considered "false". 559 o patch (index 9): A boolean value that indicates if the tag 560 identifies and describes an installed patch that has made 561 incremental changes to a software component installed on an 562 endpoint. Typically, an installed patch has made a set of file 563 modifications to pre-installed software and does not alter the 564 version number or the descriptive metadata of an installed 565 software component. If a CoSWID tag is for a patch, the patch 566 item MUST be set to "true". If not provided, the default value 567 MUST be considered "false". 569 Note: If the software component's version number is modified, then 570 the correct course of action would be to replace the previous 571 primary tag for the component with a new primary tag that 572 reflected this new version. In such a case, the new tag would 573 have a patch item value of "false" or would omit this item 574 completely. 576 o supplemental (index 11): A boolean value that indicates if the tag 577 is providing additional information to be associated with another 578 referenced SWID or CoSWID tag. This allows tools and users to 579 record their own metadata about a software component without 580 modifying SWID primary or patch tags created by a software 581 provider. If a CoSWID tag is a supplemental tag, the supplemental 582 item MUST be set to "true". If not provided, the default value 583 MUST be considered "false". 585 o software-name (index 1): This textual item provides the software 586 component's name. This name is likely the same name that would 587 appear in a package management tool. 589 o software-version (index 13): A textual value representing the 590 specific release or development version of the software component. 592 o version-scheme (index 14): An integer or textual value 593 representing the versioning scheme used for the software-version 594 item. If an integer value is used it MUST be an index value in 595 the range -256 to 65535. Integer values in the range -256 to -1 596 are reserved for testing and use in closed environments (see 597 section Section 5.2.2). Integer values in the range 0 to 65535 598 correspond to registered entries in the IANA "SWID/CoSWID Version 599 Scheme Value" registry (see section Section 5.2.4. If a string 600 value is used it MUST be a private use name as defined in section 601 Section 5.2.2. String values based on a Version Scheme Name from 602 the IANA "SWID/CoSWID Version Scheme Value" registry MUST NOT be 603 used, as these values are less concise than their index value 604 equivalent. 606 o media (index 10): This text value is a hint to the tag consumer to 607 understand what target platform this tag applies to. This item 608 represents a query as defined by the W3C Media Queries 609 Recommendation (see [W3C.REC-css3-mediaqueries-20120619]). 611 o software-meta (index 5): An open-ended map of key/value data 612 pairs. A number of predefined keys can be used within this item 613 providing for common usage and semantics across the industry. Use 614 of this map allows any additional attribute to be included in the 615 tag. It is expected that industry groups will use a common set of 616 attribute names to allow for interoperability within their 617 communities. Described in Section 2.8. 619 o entity (index 2): Provides information about one or more 620 organizations responsible for producing the CoSWID tag, and 621 producing or releasing the software component referenced by this 622 CoSWID tag. Described in Section 2.6. 624 o link (index 4): Provides a means to establish relationship arcs 625 between the tag and another items. A given link can be used to 626 establish the relationship between tags or to reference another 627 resource that is related to the CoSWID tag, e.g. vulnerability 628 database association, ROLIE feed [RFC8322], MUD resource 629 [RFC8520], software download location, etc). This is modeled 630 after the HTML "link" element. Described in Section 2.7. 632 o payload (index 6): This item represents a collection of software 633 artifacts (described by child items) that compose the target 634 software. For example, these artifacts could be the files 635 included with an installer for a corpus tag or installed on an 636 endpoint when the software component is installed for a primary or 637 patch tag. The artifacts listed in a payload may be a superset of 638 the software artifacts that are actually installed. Based on user 639 selections at install time, an installation might not include 640 every artifact that could be created or executed on the endpoint 641 when the software component is installed or run. Described in 642 Section 2.9.3. 644 o evidence-entry (index 3): This item can be used to record the 645 results of a software discovery process used to identify untagged 646 software on an endpoint or to represent indicators for why 647 software is believed to be installed on the endpoint. In either 648 case, a CoSWID tag can be created by the tool performing an 649 analysis of the software components installed on the endpoint. 650 Described in Section 2.9.4. 652 o $$coswid-extension: This CDDL socket is used to add new 653 information structures to the concise-swid-tag root map. See 654 Section 2.2. 656 2.4. concise-swid-tag Co-constraints 658 The following co-constraints apply to the information provided in the 659 concise-swid-tag group. 661 o The patch and supplemental items MUST NOT both be set to "true". 663 o If the patch item is set to "true", the tag SHOULD contain at 664 least one link item (see section Section 2.7) with both the 665 rel(ation) item value of "patches" and an href item specifying an 666 association with the software that was patched. 668 o If the supplemental item is set to "true", the tag SHOULD contain 669 at least one link item with both the rel(ation) item value of 670 "supplements" and an href item specifying an association with the 671 software that is supplemented. 673 o If all of the corpus, patch, and supplemental items are "false", 674 or if the corpus item is set to "true", then a software-version 675 item MUST be included with a value set to the version of the 676 software component. This ensures that primary and corpus tags 677 have an identifiable software version. 679 2.5. The global-attributes Group 681 The global-attributes group provides a list of items, including an 682 optional language definition to support the processing of text-string 683 values, and an unbounded set of any-attribute items allowing for 684 additional items to be provided as a general point of extension in 685 the model. 687 The CDDL for the global-attributes follows: 689 global-attributes = ( 690 ? lang, 691 * any-attribute, 692 ) 694 any-attribute = ( 695 label => text / int / [ 2* text ] / [ 2* int ] 696 ) 698 label = text / int 700 The following describes each child item of this group. 702 o lang (index 15): A textual language tag that conforms with IANA 703 "Language Subtag Registry" [RFC5646]. The context of the 704 specified language applies to all sibling and descendant textual 705 values, unless a descendant object has defined a different 706 language tag. Thus, a new context is established when a 707 descendant object redefines a new language tag. All textual 708 values within a given context MUST be considered expressed in the 709 specified language. 711 o any-attribute: This sub-group provides a means to include 712 arbitrary information via label ("key") value pairs. Labels can 713 be either a single integer or text string. Values can be a single 714 integer, a text string, or an array of integers or text strings. 716 2.6. The entity-entry Group 718 The CDDL for the entity-entry group follows: 720 entity-entry = { 721 global-attributes, 722 entity-name => text, 723 ? reg-id => any-uri, 724 role => $role / [ 2* $role ], 725 ? thumbprint => hash-entry, 726 * $$entity-extension, 727 } 728 entity-name = 31 729 reg-id = 32 730 role = 33 731 thumbprint = 34 733 $role /= tag-creator 734 $role /= software-creator 735 $role /= aggregator 736 $role /= distributor 737 $role /= licensor 738 $role /= uint / text 739 tag-creator=1 740 software-creator=2 741 aggregator=3 742 distributor=4 743 licensor=5 745 The following describes each child item of this group. 747 o global-attributes: The global-attributes group described in 748 Section 2.5. 750 o entity-name (index 32): The textual name of the organizational 751 entity claiming the roles specified by the role item for the 752 CoSWID tag. 754 o reg-id (index 32): The registration id value is intended to 755 uniquely identify a naming authority in a given scope (e.g. 756 global, organization, vendor, customer, administrative domain, 757 etc.) for the referenced entity. The value of an registration ID 758 MUST be a RFC 3986 URI. The scope SHOULD be the scope of an 759 organization. In a given scope, the registration id MUST be used 760 consistently for CoSWID tag production. 762 o role (index 33): An integer or textual value representing the 763 relationship(s) between the entity, and this tag or the referenced 764 software component. If an integer value is used it MUST be an 765 index value in the range -256 to 255. Integer values in the range 766 -256 to -1 are reserved for testing and use in closed environments 767 (see section Section 5.2.2). Integer values in the range 0 to 255 768 correspond to registered entries in the IANA "SWID/CoSWID Entity 769 Role Value" registry (see section Section 5.2.5. If a string 770 value is used it MUST be a private use name as defined in section 771 Section 5.2.2. String values based on a Role Name from the IANA 772 "SWID/CoSWID Entity Role Value" registry MUST NOT be used, as 773 these values are less concise than their index value equivalent. 775 The following additional requirements exist for the use of the 776 "role" item: 778 * An entity item MUST be provided with the role of "tag-creator" 779 for every CoSWID tag. This indicates the organization that 780 created the CoSWID tag. 782 * An entity item SHOULD be provided with the role of "software- 783 creator" for every CoSWID tag, if this information is known to 784 the tag creator. This indicates the organization that created 785 the referenced software component. 787 o thumbprint (index 34): The value of the thumbprint item provides 788 an integer-based hash algorithm identifier (hash-alg-id) and a 789 byte string value (hash-value) that contains the corresponding 790 hash value (i.e. the thumbprint) of the signing entity's public 791 key certificate. This provides an indicator of which entity 792 signed the CoSWID tag, which will typically be the tag creator. 793 If the hash-alg-id is not known, then the integer value "0" MUST 794 be used. This ensures parity between the SWID tag specification 795 [SWID], which does not allow an algorithm to be identified for 796 this field. See Section 2.9.1 for more details on the use of the 797 hash-entry data structure. 799 o $$entity-extension: This CDDL socket can be used to extend the 800 entity-entry group model. See Section 2.2. 802 2.7. The link-entry Map 804 The CDDL for the link-entry map follows: 806 link-entry = { 807 global-attributes, 808 ? artifact => text, 809 href => any-uri, 810 ? media => text, 811 ? ownership => $ownership, 812 rel => $rel, 813 ? media-type => text, 814 ? use => $use, 815 * $$link-extension, 816 } 817 media = 10 818 artifact = 37 819 href = 38 820 ownership = 39 821 rel = 40 822 media-type = 41 823 use = 42 825 $ownership /= shared 826 $ownership /= private 827 $ownership /= abandon 828 $ownership /= uint / text 829 shared=1 830 private=2 831 abandon=3 833 $rel /= ancestor 834 $rel /= component 835 $rel /= feature 836 $rel /= installationmedia 837 $rel /= packageinstaller 838 $rel /= parent 839 $rel /= patches 840 $rel /= requires 841 $rel /= see-also 842 $rel /= supersedes 843 $rel /= supplemental 844 $rel /= uint / text 845 ancestor=1 846 component=2 847 feature=3 848 installationmedia=4 849 packageinstaller=5 850 parent=6 851 patches=7 852 requires=8 853 see-also=9 854 supersedes=10 855 supplemental=11 857 $use /= optional 858 $use /= required 859 $use /= recommended 860 $use /= uint / text 861 optional=1 862 required=2 863 recommended=3 865 The following describes each member of this map. 867 o global-attributes: The global-attributes group described in 868 Section 2.5. 870 o artifact (index: 37): To be used with rel="installation-media", 871 this item's value provides the path to the installer executable or 872 script that can be run to launch the referenced installation. 873 Links with the same artifact name MUST be considered mirrors of 874 each other, allowing the installation media to be acquired from 875 any of the described sources. 877 o href (index 38): A URI for the referenced resource. The "href" 878 item's value can be, but is not limited to, the following (which 879 is a slightly modified excerpt from [SWID]): 881 * If no URI scheme is provided, then the URI is to be interpreted 882 as being relative to the URI of the CoSWID tag. For example, 883 "./folder/supplemental.coswid". 885 * a physical resource location with any acceptable URI scheme 886 (e.g., file:// http:// https:// ftp://) 888 * a URI with "swid:" as the scheme refers to another SWID or 889 CoSWID by the referenced tag's tag-id. This URI needs to be 890 resolved in the context of the endpoint by software that can 891 lookup other SWID or CoSWID tags. For example, "swid:2df9de35- 892 0aff-4a86-ace6-f7dddd1ade4c" references the tag with the tag-id 893 value "2df9de35-0aff-4a86-ace6-f7dddd1ade4c". 895 * a URI with "swidpath:" as the scheme, which refers to another 896 CoSIWD via an XPATH query. This URI would need to be resolved 897 in the context of the system entity via software components 898 that can lookup other CoSWID tags and select the appropriate 899 tag based on an XPATH query [W3C.REC-xpath20-20101214]. 901 Examples include: 903 + swidpath://SoftwareIdentity[Entity/@regid='http://contoso.co 904 m'] would retrieve all SWID or CoSWID tags that include an 905 entity where the regid is "Contoso" 907 + swidpath://SoftwareIdentity[Meta/@persistentId='b0c55172-38e 908 9-4e36-be86-92206ad8eddb'] would match all SWID or CoSWID 909 tags with the persistent-id value 910 "b0c55172-38e9-4e36-be86-92206ad8eddb" 912 o media (index 10): A hint to the consumer of the link to what 913 target platform the link is applicable to. This item represents a 914 query as defined by the W3C Media Queries Recommendation (see 915 [W3C.REC-css3-mediaqueries-20120619]). See also media defined in 916 Section 2.3. 918 o ownership (index 39): An integer or textual value used when the 919 "href" item references another software component to indicate the 920 degree of ownership between the software component referenced by 921 the COSWID tag and the software component referenced by the link. 922 If an integer value is used it MUST be an index value in the range 923 -256 to 255. Integer values in the range -256 to -1 are reserved 924 for testing and use in closed environments (see section 925 Section 5.2.2). Integer values in the range 0 to 255 correspond 926 to registered entries in the IANA "SWID/CoSWID Link Ownership 927 Value" registry (see section Section 5.2.6. If a string value is 928 used it MUST be a private use name as defined in section 929 Section 5.2.2. String values based on a Ownership Type Name from 930 the IANA "SWID/CoSWID Link Ownership Value" registry MUST NOT be 931 used, as these values are less concise than their index value 932 equivalent. 934 o rel (index 40): An integer or textual value that identifies the 935 relationship between this CoSWID and the target resource 936 identified by the "href" item. If an integer value is used it 937 MUST be an index value in the range -256 to 65535. Integer values 938 in the range -256 to -1 are reserved for testing and use in closed 939 environments (see section Section 5.2.2). Integer values in the 940 range 0 to 65535 correspond to registered entries in the IANA 941 "SWID/CoSWID Link Relationship Value" registry (see section 942 Section 5.2.7. If a string value is used it MUST be either a 943 private use name as defined in section Section 5.2.2 or a 944 "Relation Name" from the IANA "Link Relation Types" registry: 945 https://www.iana.org/assignments/link-relations/link- 946 relations.xhtml as defined by [RFC8288]. When a string value 947 defined in the IANA "SWID/CoSWID Link Relationship Value" registry 948 matches a Relation Name defined in the IANA "Link Relation Types" 949 registry, the index value in the IANA "SWID/CoSWID Link 950 Relationship Value" registry MUST be used instead, as this 951 relationship has a specialized meaning in the context of a SWID/ 952 CoSWID tag. String values based on a Relationship Type Name from 953 the IANA "SWID/CoSWID Link Relationship Value" registry MUST NOT 954 be used, as these values are less concise than their index value 955 equivalent. 957 o media-type (index 41): A link can point to arbitrary resources on 958 the endpoint, local network, or Internet using the href item. Use 959 of this item supplies the resource consumer with a hint of what 960 type of resource to expect. Media types are identified by 961 referencing a "Name" from the IANA "Media Types" registry: 962 http://www.iana.org/assignments/media-types/media-types.xhtml. 964 o use (index 42): An integer or textual value used to determine if 965 the referenced software component has to be installed before 966 installing the software component identified by the COSWID tag. 967 If an integer value is used it MUST be an index value in the range 968 -256 to 255. Integer values in the range -256 to -1 are reserved 969 for testing and use in closed environments (see section 970 Section 5.2.2). Integer values in the range 0 to 255 correspond 971 to registered entries in the IANA "Link Use Value Value" registry 972 (see section Section 5.2.8. If a string value is used it MUST be 973 a private use name as defined in section Section 5.2.2. String 974 values based on an Link Use Type Name from the IANA "SWID/CoSWID 975 Link Use Value" registry MUST NOT be used, as these values are 976 less concise than their index value equivalent. 978 o $$link-extension: This CDDL socket can be used to extend the link- 979 entry map model. See Section 2.2. 981 2.8. The software-meta-entry Map 983 The CDDL for the software-meta-entry map follows: 985 software-meta-entry = { 986 global-attributes, 987 ? activation-status => text, 988 ? channel-type => text, 989 ? colloquial-version => text, 990 ? description => text, 991 ? edition => text, 992 ? entitlement-data-required => bool, 993 ? entitlement-key => text, 994 ? generator => text, 995 ? persistent-id => text, 996 ? product => text, 997 ? product-family => text, 998 ? revision => text, 999 ? summary => text, 1000 ? unspsc-code => text, 1001 ? unspsc-version => text, 1002 * $$meta-extension, 1003 } 1004 activation-status = 43 1005 channel-type = 44 1006 colloquial-version = 45 1007 description = 46 1008 edition = 47 1009 entitlement-data-required = 48 1010 entitlement-key = 49 1011 generator = 50 1012 persistent-id = 51 1013 product = 52 1014 product-family = 53 1015 revision = 54 1016 summary = 55 1017 unspsc-code = 56 1018 unspsc-version = 57 1020 The following describes each child item of this group. 1022 o global-attributes: The global-attributes group described in 1023 Section 2.5. 1025 o activation-status (index 43): A textual value that identifies how 1026 the software component has been activated, which might relate to 1027 specific terms and conditions for its use (e.g. Trial, 1028 Serialized, Licensed, Unlicensed, etc) and relate to an 1029 entitlement. This attribute is typically used in supplemental 1030 tags as it contains information that might be selected during a 1031 specific install. 1033 o channel-type (index 44): A textual value that identfies which 1034 sales, licensing, or marketing channel the software component has 1035 been targeted for (e.g. Volume, Retail, OEM, Academic, etc). 1036 This attribute is typically used in supplemental tags as it 1037 contains information that might be selected during a specific 1038 install. 1040 o colloquial-version (index 45): A textual value for the software 1041 component's informal or colloquial version. Examples may include 1042 a year value, a major version number, or similar value that are 1043 used to identify a group of specific software component releases 1044 that are part of the same release/support cycle. This version can 1045 be the same through multiple releases of a software component, 1046 while the software-version specified in the concise-swid-tag group 1047 is much more specific and will change for each software component 1048 release. This version is intended to be used for string 1049 comparison only and is not intended to be used to determine if a 1050 specific value is earlier or later in a sequence. 1052 o description (index 46): A textual value that provides a detailed 1053 description of the software component. This value MAY be multiple 1054 paragraphs separated by CR LF characters as described by 1055 [RFC5198]. 1057 o edition (index 47): A textual value indicating that the software 1058 component represents a functional variation of the code base used 1059 to support multiple software components. For example, this item 1060 can be used to differentiate enterprise, standard, or professional 1061 variants of a software component. 1063 o entitlement-data-required (index 48): A boolean value that can be 1064 used to determine if accompanying proof of entitlement is needed 1065 when a software license reconciliation process is performed. 1067 o entitlement-key (index 49): A vendor-specific textual key that can 1068 be used to identify and establish a relationship to an 1069 entitlement. Examples of an entitlement-key might include a 1070 serial number, product key, or license key. For values that 1071 relate to a given software component install (i.e., license key), 1072 a supplemental tag will typically contain this information. In 1073 other cases, where a general-purpose key can be provided that 1074 applies to all possible installs of the software component on 1075 different endpoints, a primary tag will typically contain this 1076 information. 1078 o generator (index 50): The name (or tag-id) of the software 1079 component that created the CoSWID tag. If the generating software 1080 component has a SWID or CoSWID tag, then the tag-id for the 1081 generating software component SHOULD be provided. 1083 o persistent-id (index 51): A globally unique identifier used to 1084 identify a set of software components that are related. Software 1085 components sharing the same persistent-id can be different 1086 versions. This item can be used to relate software components, 1087 released at different points in time or through different release 1088 channels, that may not be able to be related through use of the 1089 link item. 1091 o product (index 52): A basic name for the software component that 1092 can be common across multiple tagged software components (e.g., 1093 Apache HTTPD). 1095 o product-family (index 53): A textual value indicating the software 1096 components overall product family. This should be used when 1097 multiple related software components form a larger capability that 1098 is installed on multiple different endpoints. For example, some 1099 software families may consist of server, client, and shared 1100 service components that are part of a larger capability. Email 1101 systems, enterprise applications, backup services, web 1102 conferencing, and similar capabilities are examples of families. 1103 Use of this item is not intended to represent groups of software 1104 that are bundled or installed together. The persistent-id or link 1105 items SHOULD be used to relate bundled software components. 1107 o revision (index 54): A string value indicating an informal or 1108 colloquial release version of the software. This value can 1109 provide a different version value as compared to the software- 1110 version specified in the concise-swid-tag group. This is useful 1111 when one or more releases need to have an informal version label 1112 that differs from the specific exact version value specified by 1113 software-version. Examples can include SP1, RC1, Beta, etc. 1115 o summary (index 55): A short description of the software component. 1116 This MUST be a single sentence suitable for display in a user 1117 interface. 1119 o unspsc-code (index 56): An 8 digit UNSPSC classification code for 1120 the software component. For more information see 1121 https://www.unspsc.org/. 1123 o unspsc-version (index 57): The version of UNSPSC used to define 1124 the unspsc-code value. 1126 o $$meta-extension: This CDDL socket can be used to extend the 1127 software-meta-entry group model. See Section 2.2. 1129 2.9. The Resource Collection Definition 1131 2.9.1. The hash-entry Array 1133 CoSWID adds explicit support for the representation of hash entries 1134 using algorithms that are registered in the IANA "Named Information 1135 Hash Algorithm Registry" using the hash-entry member (label 58). 1137 hash-entry = [ hash-alg-id: int, hash-value: bytes ] 1139 The number used as a value for hash-alg-id MUST refer an ID in the 1140 "Named Information Hash Algorithm Registry" (see 1141 https://www.iana.org/assignments/named-information/named- 1142 information.xhtml); other hash algorithms MUST NOT be used. The 1143 hash-value MUST represent the raw hash value of the hashed resource 1144 generated using the hash algorithm indicated by the hash-alg-id. 1146 2.9.2. The resource-collection Group 1148 A list of items both used in evidence (created by a software 1149 discovery process) and payload (installed in an endpoint) content of 1150 a CoSWID tag document to structure and differentiate the content of 1151 specific CoSWID tag types. Potential content includes directories, 1152 files, processes, or resources. 1154 The CDDL for the resource-collection group follows: 1156 resource-collection = ( 1157 ? directory => directory-entry, 1158 ? file => file-entry, 1159 ? process => process-entry, 1160 ? resource => resource-entry, 1161 ) 1163 filesystem-item = ( 1164 global-attributes, 1165 ? key => bool, 1166 ? location => text, 1167 fs-name => text, 1168 ? root => text, 1169 ) 1171 path-elements-entry = [ [ * file-entry ], 1172 [ * directory-entry ], 1173 ] 1175 file-entry = { 1176 filesystem-item, 1177 ? size => integer, 1178 ? file-version => text, 1179 ? hash => hash-entry, 1180 * $$file-extension 1181 } 1183 directory-entry = { 1184 filesystem-item, 1185 path-elements => path-elements-entry, 1186 * $$directory-extension 1187 } 1189 process-entry = { 1190 global-attributes, 1191 process-name => text, 1192 ? pid => integer, 1193 * $$process-extension 1194 } 1196 resource-entry = { 1197 global-attributes, 1198 type => text, 1199 * $$resource-extension 1200 } 1202 directory = 16 1203 file = 17 1204 process = 18 1205 resource = 19 1206 size = 20 1207 file-version = 21 1208 key = 22 1209 location = 23 1210 fs-name = 24 1211 root = 25 1212 path-elements = 26 1213 process-name = 27 1214 pid = 28 1215 type = 29 1217 The following describes each member of the groups and maps 1218 illustrated above. 1220 o filesystem-item: A list of common items used for representing the 1221 filesystem root, relative location, name, and significance of a 1222 file or directory item. 1224 o global-attributes: The global-attributes group described in 1225 Section 2.5. 1227 o directory (index 16): A directory item allows child directory and 1228 file items to be defined within a directory hierarchy for the 1229 software component. 1231 o file (index 17): A file item allows details about a file to be 1232 provided for the software component. 1234 o process (index 18): A process item allows details to be provided 1235 about the runtime behavior of the software component, such as 1236 information that will appear in a process listing on an endpoint. 1238 o resource (index 19): A resource item can be used to provide 1239 details about an artifact or capability expected to be found on an 1240 endpoint or evidence collected related to the software component. 1241 This can be used to represent concepts not addressed directly by 1242 the directory, file, or process items. Examples include: registry 1243 keys, bound ports, etc. The equivalent construct in [SWID] is 1244 currently under specified. As a result, this item might be 1245 further defined through extension in the future. 1247 o size (index 20): The file's size in bytes. 1249 o file-version (index 21): The file's version as reported by 1250 querying information on the file from the operating system. 1252 o key (index 22): A boolean value indicating if a file or directory 1253 is significant or required for the software component to execute 1254 or function properly. These are files or directories that can be 1255 used to affirmatively determine if the software component is 1256 installed on an endpoint. 1258 o location (index 23): The filesystem path where a file is expected 1259 to be located when installed or copied. The location MUST be 1260 either relative to the location of the parent directory item 1261 (preferred) or relative to the location of the CoSWID tag if no 1262 parent is defined. The location MUST NOT include a file's name, 1263 which is provided by the fs-name item. 1265 o fs-name (index 24): The name of the directory or file without any 1266 path information. 1268 o root (index 25): A filesystem-specific name for the root of the 1269 filesystem. The location item is considered relative to this 1270 location if specified. If not provided, the value provided by the 1271 location item is expected to be relative to its parent or the 1272 location of the CoSWID tag if no parent is provided. 1274 o path-elements (index 26): This group allows a hierarchy of 1275 directory and file items to be defined in payload or evidence 1276 items. 1278 o process-name (index 27): The software component's process name as 1279 it will appear in an endpoint's process list. 1281 o pid (index 28): The process ID identified for a running instance 1282 of the software component in the endpoint's process list. This is 1283 used as part of the evidence item. 1285 o type (index 29): A string indicating the type of resource. 1287 o $$resource-collection-extension: This CDDL socket can be used to 1288 extend the resource-collection group model. This can be used to 1289 add new specialized types of resources. See Section 2.2. 1291 o $$file-extension: This CDDL socket can be used to extend the file- 1292 entry group model. See Section 2.2. 1294 o $$directory-extension: This CDDL socket can be used to extend the 1295 directory-entry group model. See Section 2.2. 1297 o $$process-extension: This CDDL socket can be used to extend the 1298 process-entry group model. See Section 2.2. 1300 o $$resource-extension: This CDDL socket can be used to extend the 1301 group model. See Section 2.2. 1303 o $$-extension: This CDDL socket can be used to extend the resource- 1304 entry group model. See Section 2.2. 1306 2.9.3. The payload-entry Group 1308 The CDDL for the payload-entry group follows: 1310 payload-entry = { 1311 global-attributes, 1312 resource-collection, 1313 * $$payload-extension 1314 } 1316 The following describes each child item of this group. 1318 o global-attributes: The global-attributes group described in 1319 Section 2.5. 1321 o resource-collection: The resource-collection group described in 1322 Section 2.9.2. 1324 o $$payload-extension: This CDDL socket can be used to extend the 1325 payload-entry group model. See Section 2.2. 1327 2.9.4. The evidence-entry Group 1329 The CDDL for the evidence-entry group follows: 1331 evidence-entry = { 1332 global-attributes, 1333 resource-collection, 1334 ? date => time, 1335 ? device-id => text, 1336 * $$evidence-extension 1337 } 1338 date = 35 1339 device-id = 36 1341 The following describes each child item of this group. 1343 o global-attributes: The global-attributes group described in 1344 Section 2.5. 1346 o resource-collection: The resource-collection group described in 1347 Section 2.9.2. 1349 o date (index 35): The date and time the information was collected 1350 pertaining to the evidence item. 1352 o device-id (index 36): The endpoint's string identifier from which 1353 the evidence was collected. 1355 o $$evidence-extension: This CDDL socket can be used to extend the 1356 evidence-entry group model. See Section 2.2. 1358 2.10. Full CDDL Definition 1360 In order to create a valid CoSWID document the structure of the 1361 corresponding CBOR message MUST adhere to the following CDDL data 1362 definition. 1364 concise-swid-tag = { 1365 global-attributes, 1366 tag-id => text / bstr .size 16, 1367 tag-version => integer, 1368 ? corpus => bool, 1369 ? patch => bool, 1370 ? supplemental => bool, 1371 software-name => text, 1372 ? software-version => text, 1373 ? version-scheme => $version-scheme, 1374 ? media => text, 1375 ? software-meta => software-meta-entry / [ 2* software-meta-entry ], 1376 entity => entity-entry / [ 2* entity-entry ], 1377 ? link => link-entry / [ 2* link-entry ], 1378 ? (( payload => payload-entry ) // ( evidence => evidence-entry )), 1379 * $$coswid-extension 1380 } 1382 any-uri = text 1383 label = text / int 1385 $version-scheme /= multipartnumeric 1386 $version-scheme /= multipartnumeric-suffix 1387 $version-scheme /= alphanumeric 1388 $version-scheme /= decimal 1389 $version-scheme /= semver 1390 $version-scheme /= uint / text 1392 any-attribute = ( 1393 label => text / int / [ 2* text ] / [ 2* int ] 1394 ) 1396 global-attributes = ( 1397 ? lang => text, 1398 * any-attribute, 1399 ) 1401 hash-entry = [ hash-alg-id: int, 1402 hash-value: bytes ] 1404 entity-entry = { 1405 global-attributes, 1406 entity-name => text, 1407 ? reg-id => any-uri, 1408 role => $role / [ 2* $role ], 1409 ? thumbprint => hash-entry, 1410 * $$entity-extension, 1411 } 1413 $role /= tag-creator 1414 $role /= software-creator 1415 $role /= aggregator 1416 $role /= distributor 1417 $role /= licensor 1418 $role /= uint / text 1420 link-entry = { 1421 global-attributes, 1422 ? artifact => text, 1423 href => any-uri, 1424 ? media => text, 1425 ? ownership => $ownership, 1426 rel => $rel, 1427 ? media-type => text, 1428 ? use => $use, 1429 * $$link-extension 1430 } 1432 $ownership /= shared 1433 $ownership /= private 1434 $ownership /= abandon 1435 $ownership /= uint / text 1437 $rel /= ancestor 1438 $rel /= component 1439 $rel /= feature 1440 $rel /= installationmedia 1441 $rel /= packageinstaller 1442 $rel /= parent 1443 $rel /= patches 1444 $rel /= requires 1445 $rel /= see-also 1446 $rel /= supersedes 1447 $rel /= supplemental 1448 $rel /= uint / text 1450 $use /= optional 1451 $use /= required 1452 $use /= recommended 1453 $use /= uint / text 1455 software-meta-entry = { 1456 global-attributes, 1457 ? activation-status => text, 1458 ? channel-type => text, 1459 ? colloquial-version => text, 1460 ? description => text, 1461 ? edition => text, 1462 ? entitlement-data-required => bool, 1463 ? entitlement-key => text, 1464 ? generator => text, 1465 ? persistent-id => text, 1466 ? product => text, 1467 ? product-family => text, 1468 ? revision => text, 1469 ? summary => text, 1470 ? unspsc-code => text, 1471 ? unspsc-version => text, 1472 * $$meta-extension, 1473 } 1475 resource-collection = ( 1476 ? directory => directory-entry, 1477 ? file => file-entry, 1478 ? process => process-entry, 1479 ? resource => resource-entry, 1480 * $$resource-collection-extension 1481 ) 1483 file-entry = { 1484 filesystem-item, 1485 ? size => integer, 1486 ? file-version => text, 1487 ? hash => hash-entry, 1488 * $$file-extension 1489 } 1491 path-elements-entry = [ [ * file-entry ], 1492 [ * directory-entry ], 1493 ] 1495 directory-entry = { 1496 filesystem-item, 1497 path-elements => path-elements-entry, 1498 * $$directory-extension 1499 } 1501 process-entry = { 1502 global-attributes, 1503 process-name => text, 1504 ? pid => integer, 1505 * $$process-extension 1506 } 1508 resource-entry = { 1509 global-attributes, 1510 type => text, 1511 * $$resource-extension 1512 } 1514 filesystem-item = ( 1515 global-attributes, 1516 ? key => bool, 1517 ? location => text, 1518 fs-name => text, 1519 ? root => text, 1520 ) 1522 payload-entry = { 1523 global-attributes, 1524 resource-collection, 1525 * $$payload-extension 1526 } 1528 evidence-entry = { 1529 global-attributes, 1530 resource-collection, 1531 ? date => time, 1532 ? device-id => text, 1533 * $$evidence-extension 1534 } 1536 ; "global map member" integer indexes 1537 tag-id = 0 1538 software-name = 1 1539 entity = 2 1540 evidence = 3 1541 link = 4 1542 software-meta = 5 1543 payload = 6 1544 hash = 7 1545 corpus = 8 1546 patch = 9 1547 media = 10 1548 supplemental = 11 1549 tag-version = 12 1550 software-version = 13 1551 version-scheme = 14 1552 lang = 15 1553 directory = 16 1554 file = 17 1555 process = 18 1556 resource = 19 1557 size = 20 1558 file-version = 21 1559 key = 22 1560 location = 23 1561 fs-name = 24 1562 root = 25 1563 path-elements = 26 1564 process-name = 27 1565 pid = 28 1566 type = 29 1567 entity-name = 31 1568 reg-id = 32 1569 role = 33 1570 thumbprint = 34 1571 date = 35 1572 device-id = 36 1573 artifact = 37 1574 href = 38 1575 ownership = 39 1576 rel = 40 1577 media-type = 41 1578 use = 42 1579 activation-status = 43 1580 channel-type = 44 1581 colloquial-version = 45 1582 description = 46 1583 edition = 47 1584 entitlement-data-required = 48 1585 entitlement-key = 49 1586 generator = 50 1587 persistent-id = 51 1588 product = 52 1589 product-family = 53 1590 revision = 54 1591 summary = 55 1592 unspsc-code = 56 1593 unspsc-version = 57 1595 ; "version-scheme" integer indexes 1596 multipartnumeric = 1 1597 multipartnumeric-suffix = 2 1598 alphanumeric = 3 1599 decimal = 4 1600 semver = 16384 1602 ; "role" integer indexes 1603 tag-creator=1 1604 software-creator=2 1605 aggregator=3 1606 distributor=4 1607 licensor=5 1609 ; ownership integer indexes 1610 shared=1 1611 private=2 1612 abandon=3 1614 ; "rel" integer indexes 1615 ancestor=1 1616 component=2 1617 feature=3 1618 installationmedia=4 1619 packageinstaller=5 1620 parent=6 1621 patches=7 1622 requires=8 1623 see-also=9 1624 supersedes=10 1625 supplemental=11 1627 ; "use" integer indexes 1628 optional=1 1629 required=2 1630 recommended=3 1632 3. Determining the Type of CoSWID 1634 The operational model for SWID and CoSWID tags was introduced in 1635 Section 1.1, which described four different CoSWID tag types. The 1636 following additional rules apply to the use of CoSWID tags to ensure 1637 that created tags properly identify the tag type. 1639 The first matching rule MUST determine the type of the CoSWID tag. 1641 1. Primary Tag: A CoSWID tag MUST be considered a primary tag if the 1642 corpus, patch, and supplemental items are "false". 1644 2. Supplemental Tag: A CoSWID tag MUST be considered a supplemental 1645 tag if the supplemental item is set to "true". 1647 3. Corpus Tag: A CoSWID tag MUST be considered a corpus tag if the 1648 corpus item is "true". 1650 4. Patch Tag: A CoSWID tag MUST be considered a patch tag if the 1651 patch item is "true". 1653 Note: Multiple of the corpus, patch, and supplemental items can have 1654 values set as "true". The rules above provide a means to determine 1655 the tag's type in such a case. For example, a SWID or CoSWID tag for 1656 a patch installer might have both corpus and patch items set to 1657 "true". In such a case, the tag is a "Corpus Tag". The tag 1658 installed by this installer would have only the patch item set to 1659 "true", making the installed tag type a "Patch Tag". 1661 4. CoSWID Indexed Label Values 1663 4.1. Version Scheme 1665 The following table contains a set of values for use in the concise- 1666 swid-tag group's version-scheme item. These values match the version 1667 schemes defined in the ISO/IEC 19770-2:2015 [SWID] specification. 1668 Index value indicates the value to use as the version-scheme item's 1669 value. The Version Scheme Name provides human-readable text for the 1670 value. The Definition describes the syntax of allowed values for 1671 each entry. 1673 +-------+-------------------------+---------------------------------+ 1674 | Index | Version Scheme Name | Definition | 1675 +-------+-------------------------+---------------------------------+ 1676 | 1 | multipartnumeric | Numbers separated by dots, | 1677 | | | where the numbers are | 1678 | | | interpreted as integers (e.g., | 1679 | | | 1.2.3, 1.4.5, 1.2.3.4.5.6.7) | 1680 | | | | 1681 | 2 | multipartnumeric+suffix | Numbers separated by dots, | 1682 | | | where the numbers are | 1683 | | | interpreted as integers with an | 1684 | | | additional textual suffix | 1685 | | | (e.g., 1.2.3a) | 1686 | | | | 1687 | 3 | alphanumeric | Strictly a string, sorting is | 1688 | | | done alphanumerically | 1689 | | | | 1690 | 4 | decimal | A floating point number (e.g., | 1691 | | | 1.25 is less than 1.3) | 1692 | | | | 1693 | 16384 | semver | Follows the [SEMVER] | 1694 | | | specification | 1695 +-------+-------------------------+---------------------------------+ 1697 Table 3: Version Scheme Values 1699 The values above are registered in the IANA "SWID/CoSWID Version 1700 Scheme Value" registry defined in section Section 5.2.4. Additional 1701 entries will likely be registered over time in this registry. 1703 These version schemes have partially overlapping value spaces. The 1704 following gudelines help to ensure that the most specific version- 1705 scheme is used: 1707 o "decimal" and "multipartnumeric" partially overlap in their value 1708 space when a value matches a decimal number . When a corresponding 1709 software-version item's value falls within this overlapping value 1710 space, the "decimal" version scheme SHOULD be used. 1712 o "multipartnumeric" and "semver" partially overlap in their value 1713 space when a "multipartnumeric" value matches the semantic 1714 versioning syntax. When a corresponding software-version item's 1715 value falls within this overlapping value space, the "semver" 1716 version scheme SHOULD be used. 1718 o "alphanumeric" and other version schemes might overlap in their 1719 value space. When a corresponding software-version item's value 1720 falls within this overlapping value space, the other version 1721 scheme SHOULD be used instead of "alphanumeric". 1723 4.2. Entity Role Values 1725 The following table indicates the index value to use for the entity- 1726 entry group's role item (see Section 2.6). These values match the 1727 entity roles defined in the ISO/IEC 19770-2:2015 [SWID] 1728 specification. The "Index" value indicates the value to use as the 1729 role item's value. The "Role Name" provides human-readable text for 1730 the value. The "Definition" describes the semantic meaning of each 1731 entry. 1733 +-------+-----------------+-----------------------------------------+ 1734 | Index | Role Name | Definition | 1735 +-------+-----------------+-----------------------------------------+ 1736 | 1 | tagCreator | The person or organization that created | 1737 | | | the containing SWID or CoSWID tag | 1738 | | | | 1739 | 2 | softwareCreator | The person or organization entity that | 1740 | | | created the software component. | 1741 | | | | 1742 | 3 | aggregator | From [SWID], "An organization or system | 1743 | | | that encapsulates software from their | 1744 | | | own and/or other organizations into a | 1745 | | | different distribution process (as in | 1746 | | | the case of virtualization), or as a | 1747 | | | completed system to accomplish a | 1748 | | | specific task (as in the case of a | 1749 | | | value added reseller)." | 1750 | | | | 1751 | 4 | distributor | From [SWID], "An entity that furthers | 1752 | | | the marketing, selling and/or | 1753 | | | distribution of software from the | 1754 | | | original place of manufacture to the | 1755 | | | ultimate user without modifying the | 1756 | | | software, its packaging or its | 1757 | | | labelling." | 1758 | | | | 1759 | 5 | licensor | From [SAM] as "software licensor", a | 1760 | | | "person or organization who owns or | 1761 | | | holds the rights to issue a software | 1762 | | | license for a specific software | 1763 | | | [component]" | 1764 +-------+-----------------+-----------------------------------------+ 1766 Table 4: Entity Role Values 1768 The values above are registered in the IANA "SWID/CoSWID Entity Role 1769 Value" registry defined in section Section 5.2.5. Additional values 1770 will likely be registered over time. Additionally, the index values 1771 128 through 255 and the name prefix "x_" have been reserved for 1772 private use. 1774 4.3. Link Ownership Values 1776 The following table indicates the index value to use for the link- 1777 entry group's ownership item (see Section 2.7). These values match 1778 the link ownership values defined in the ISO/IEC 19770-2:2015 [SWID] 1779 specification. The "Index" value indicates the value to use as the 1780 link-entry group ownership item's value. The "Ownership Type" 1781 provides human-readable text for the value. The "Definition" 1782 describes the semantic meaning of each entry. 1784 +-------+-----------+-----------------------------------------------+ 1785 | Index | Ownership | Definition | 1786 | | Type | | 1787 +-------+-----------+-----------------------------------------------+ 1788 | 1 | abandon | If the software component referenced by the | 1789 | | | CoSWID tag is uninstalled, then the | 1790 | | | referenced software SHOULD not be uninstalled | 1791 | | | | 1792 | 2 | private | If the software component referenced by the | 1793 | | | CoSWID tag is uninstalled, then the | 1794 | | | referenced software SHOULD be uninstalled as | 1795 | | | well. | 1796 | | | | 1797 | 3 | shared | If the software component referenced by the | 1798 | | | CoSWID tag is uninstalled, then the | 1799 | | | referenced software SHOULD be uninstalled if | 1800 | | | no other components sharing the software. | 1801 +-------+-----------+-----------------------------------------------+ 1803 Table 5: Link Ownership Values 1805 The values above are registered in the IANA "SWID/CoSWID Link 1806 Ownership Value" registry defined in section Section 5.2.6. 1807 Additional values will likely be registered over time. Additionally, 1808 the index values 128 through 255 and the name prefix "x_" have been 1809 reserved for private use. 1811 4.4. Link Rel Values 1813 The following table indicates the index value to use for the link- 1814 entry group's rel item (see Section 2.7). These values match the 1815 link rel values defined in the ISO/IEC 19770-2:2015 [SWID] 1816 specification. The "Index" value indicates the value to use as the 1817 link-entry group ownership item's value. The "Relationship Type" 1818 provides human-readable text for the value. The "Definition" 1819 describes the semantic meaning of each entry. 1821 +-------+-------------------+---------------------------------------+ 1822 | Index | Relationship Type | Definition | 1823 +-------+-------------------+---------------------------------------+ 1824 | 1 | ancestor | The link references a SWID/CoSWID tag | 1825 | | | for a previous release of this | 1826 | | | software. This can be useful to | 1827 | | | define an upgrade path. | 1828 | | | | 1829 | 2 | component | The link references a SWID/CoSWID tag | 1830 | | | for a separate component of this | 1831 | | | software. | 1832 | | | | 1833 | 3 | feature | The link references a configurable | 1834 | | | feature of this software that can be | 1835 | | | enabled or disabled without changing | 1836 | | | the installed files. | 1837 | | | | 1838 | 4 | installationmedia | The link references the installation | 1839 | | | package that can be used to install | 1840 | | | this software. | 1841 | | | | 1842 | 5 | packageinstaller | The link references the installation | 1843 | | | software needed to install this | 1844 | | | software. | 1845 | | | | 1846 | 6 | parent | The link references a SWID/CoSWID tag | 1847 | | | that is the parent of this | 1848 | | | SWID/CoSWID tag. This relationship | 1849 | | | can be used when multiple software | 1850 | | | components are part of a software | 1851 | | | bundle, where the "parent" is the | 1852 | | | SWID/CoSWID tag for the bundle, and | 1853 | | | each child is a "component". In such | 1854 | | | a case, each child component can | 1855 | | | provide a "parent" link relationship | 1856 | | | to the bundle's SWID/CoSWID tag, and | 1857 | | | the bundle can provide a "component" | 1858 | | | link relationship to each child | 1859 | | | software component. | 1860 | | | | 1861 | 7 | patches | The link references a SWID/CoSWID tag | 1862 | | | that this software patches. Typically | 1863 | | | only used for patch SWID/CoSWID tags | 1864 | | | (see Section 1.1). | 1865 | | | | 1866 | 8 | requires | The link references a prerequisite | 1867 | | | for installing this software. A patch | 1868 | | | SWID/CoSWID tag (see Section 1.1) can | 1869 | | | use this to represent base software | 1870 | | | or another patch that needs to be | 1871 | | | installed first. | 1872 | | | | 1873 | 9 | see-also | The link references other software | 1874 | | | that may be of interest that relates | 1875 | | | to this software. | 1876 | | | | 1877 | 10 | supersedes | The link references another software | 1878 | | | that this software replaces. A patch | 1879 | | | SWID/CoSWID tag (see Section 1.1) can | 1880 | | | use this to represent another patch | 1881 | | | that this patch incorporates or | 1882 | | | replaces. | 1883 | | | | 1884 | 11 | supplemental | The link references a SWID/CoSWID tag | 1885 | | | that this tag supplements. Used on | 1886 | | | supplemental SWID/CoSWID tags (see | 1887 | | | Section 1.1). | 1888 +-------+-------------------+---------------------------------------+ 1890 Table 6: Link Relationship Values 1892 The values above are registered in the IANA "SWID/CoSWID Link 1893 Relationship Value" registry defined in section Section 5.2.7. 1894 Additional values will likely be registered over time. Additionally, 1895 the index values 32768 through 65535 and the name prefix "x_" have 1896 been reserved for private use. 1898 4.5. Link Use Values 1900 The following table indicates the index value to use for the link- 1901 entry group's use item (see Section 2.7). These values match the 1902 link use values defined in the ISO/IEC 19770-2:2015 [SWID] 1903 specification. The "Index" value indicates the value to use as the 1904 link-entry group use item's value. The "Use Type" provides human- 1905 readable text for the value. The "Definition" describes the semantic 1906 meaning of each entry. 1908 +-------+-------------+---------------------------------------------+ 1909 | Index | Use Type | Definition | 1910 +-------+-------------+---------------------------------------------+ 1911 | 1 | optional | From [SWID], "Not absolutely required; the | 1912 | | | [Link]'d software is installed only when | 1913 | | | specified." | 1914 | | | | 1915 | 2 | required | From [SWID], "The [Link]'d software is | 1916 | | | absolutely required for an operation | 1917 | | | software installation." | 1918 | | | | 1919 | 3 | recommended | From [SWID], "Not absolutely required; the | 1920 | | | [Link]'d software is installed unless | 1921 | | | specified otherwise." | 1922 +-------+-------------+---------------------------------------------+ 1924 Table 7: Link Use Values 1926 The values above are registered in the IANA "SWID/CoSWID Link Use 1927 Value" registry defined in section Section 5.2.8. Additional values 1928 will likely be registered over time. Additionally, the index values 1929 128 through 255 and the name prefix "x_" have been reserved for 1930 private use. 1932 5. IANA Considerations 1934 This document has a number of IANA considerations, as described in 1935 the following subsections. 1937 5.1. CoSWID Items Registry 1939 This document uses integer values as index values in CBOR maps. 1941 This document defines a new registry titled "CoSWID Items". Future 1942 registrations for this registry are to be made based on [RFC8126] as 1943 follows: 1945 +------------------+-------------------------+ 1946 | Range | Registration Procedures | 1947 +------------------+-------------------------+ 1948 | 0-32767 | Standards Action | 1949 | | | 1950 | 32768-4294967295 | Specification Required | 1951 +------------------+-------------------------+ 1953 Table 8: CoSWID Items Registration Proceedures 1955 All negative values are reserved for Private Use. 1957 Initial registrations for the "CoSWID Items" registry are provided 1958 below. Assignments consist of an integer index value, the item name, 1959 and a reference to the defining specification. 1961 +---------------+---------------------------+---------------+ 1962 | Index | Item Name | Specification | 1963 +---------------+---------------------------+---------------+ 1964 | 0 | tag-id | RFC-AAAA | 1965 | | | | 1966 | 1 | software-name | RFC-AAAA | 1967 | | | | 1968 | 2 | entity | RFC-AAAA | 1969 | | | | 1970 | 3 | evidence | RFC-AAAA | 1971 | | | | 1972 | 4 | link | RFC-AAAA | 1973 | | | | 1974 | 5 | software-meta | RFC-AAAA | 1975 | | | | 1976 | 6 | payload | RFC-AAAA | 1977 | | | | 1978 | 7 | hash | RFC-AAAA | 1979 | | | | 1980 | 8 | corpus | RFC-AAAA | 1981 | | | | 1982 | 9 | patch | RFC-AAAA | 1983 | | | | 1984 | 10 | media | RFC-AAAA | 1985 | | | | 1986 | 11 | supplemental | RFC-AAAA | 1987 | | | | 1988 | 12 | tag-version | RFC-AAAA | 1989 | | | | 1990 | 13 | software-version | RFC-AAAA | 1991 | | | | 1992 | 14 | version-scheme | RFC-AAAA | 1993 | | | | 1994 | 15 | lang | RFC-AAAA | 1995 | | | | 1996 | 16 | directory | RFC-AAAA | 1997 | | | | 1998 | 17 | file | RFC-AAAA | 1999 | | | | 2000 | 18 | process | RFC-AAAA | 2001 | | | | 2002 | 19 | resource | RFC-AAAA | 2003 | | | | 2004 | 20 | size | RFC-AAAA | 2005 | | | | 2006 | 21 | file-version | RFC-AAAA | 2007 | | | | 2008 | 22 | key | RFC-AAAA | 2009 | | | | 2010 | 23 | location | RFC-AAAA | 2011 | | | | 2012 | 24 | fs-name | RFC-AAAA | 2013 | | | | 2014 | 25 | root | RFC-AAAA | 2015 | | | | 2016 | 26 | path-elements | RFC-AAAA | 2017 | | | | 2018 | 27 | process-name | RFC-AAAA | 2019 | | | | 2020 | 28 | pid | RFC-AAAA | 2021 | | | | 2022 | 29 | type | RFC-AAAA | 2023 | | | | 2024 | 31 | entity-name | RFC-AAAA | 2025 | | | | 2026 | 32 | reg-id | RFC-AAAA | 2027 | | | | 2028 | 33 | role | RFC-AAAA | 2029 | | | | 2030 | 34 | thumbprint | RFC-AAAA | 2031 | | | | 2032 | 35 | date | RFC-AAAA | 2033 | | | | 2034 | 36 | device-id | RFC-AAAA | 2035 | | | | 2036 | 37 | artifact | RFC-AAAA | 2037 | | | | 2038 | 38 | href | RFC-AAAA | 2039 | | | | 2040 | 39 | ownership | RFC-AAAA | 2041 | | | | 2042 | 40 | rel | RFC-AAAA | 2043 | | | | 2044 | 41 | media-type | RFC-AAAA | 2045 | | | | 2046 | 42 | use | RFC-AAAA | 2047 | | | | 2048 | 43 | activation-status | RFC-AAAA | 2049 | | | | 2050 | 44 | channel-type | RFC-AAAA | 2051 | | | | 2052 | 45 | colloquial-version | RFC-AAAA | 2053 | | | | 2054 | 46 | description | RFC-AAAA | 2055 | | | | 2056 | 47 | edition | RFC-AAAA | 2057 | | | | 2058 | 48 | entitlement-data-required | RFC-AAAA | 2059 | | | | 2060 | 49 | entitlement-key | RFC-AAAA | 2061 | | | | 2062 | 50 | generator | RFC-AAAA | 2063 | | | | 2064 | 51 | persistent-id | RFC-AAAA | 2065 | | | | 2066 | 52 | product | RFC-AAAA | 2067 | | | | 2068 | 53 | product-family | RFC-AAAA | 2069 | | | | 2070 | 54 | revision | RFC-AAAA | 2071 | | | | 2072 | 55 | summary | RFC-AAAA | 2073 | | | | 2074 | 56 | unspsc-code | RFC-AAAA | 2075 | | | | 2076 | 57 | unspsc-version | RFC-AAAA | 2077 | | | | 2078 | 58-4294967295 | Unassigned | | 2079 +---------------+---------------------------+---------------+ 2081 Table 9: CoSWID Items Inital Registrations 2083 5.2. SWID/CoSWID Value Registries 2085 The following IANA registries provide a mechanism for new values to 2086 be added over time to common enumerations used by SWID and CoSWID. 2088 5.2.1. Registration Proceedures 2090 The following registries allow for the registration of index values 2091 and names. New registrations will be permitted through either the 2092 Standards Action policy or the Specification Required policy [BCP26]. 2093 The latter SHOULD be used only for registrations requested by SDOs 2094 outside the IETF. New index values will be provided on a First Come 2095 First Served as defined by [BCP26]. 2097 The following registries also reserve the integer-based index values 2098 in the range of -1 to -256 for private use as defined by [BCP26] in 2099 section 4.1. This allows values -1 to -24 to be expressed as a 2100 single uint_8t in CBOR, and values -25 to -256 to be expressed using 2101 an additional uint_8t in CBOR. 2103 5.2.2. Private Use of Index and Name Values 2105 The integer-based index values in the private use range (-1 to -256) 2106 are intended for testing purposes and closed environments; values in 2107 other ranges SHOULD NOT be assigned for testing. 2109 For names that correspond to private use index values, an 2110 Internationalized Domain Name prefix MUST be used to prevent name 2111 conflicts using the form: 2113 "domain.prefix-name " 2115 Where "domain.prefix" MUST be a valid Internationalized Domain Name 2116 as defined by [RFC5892], and "name" MUST be a unique name within the 2117 namespace defined by the "domain.prefix". Use of a prefix in this 2118 way allows for a name to be used initially in the private use range, 2119 and to be registered at a future point in time. This is consistent 2120 with the guidance in [BCP178]. 2122 5.2.3. Expert Review Guidelines 2124 Designated experts MUST ensure that new registration requests meet 2125 the following additional guidelines: 2127 o The requesting specification MUST provide a clear semantic 2128 definition for the new entry. This definition MUST clearly 2129 differentiate the requested entry from other previously registered 2130 entries. 2132 o The requesting specification MUST describe the intended use of the 2133 entry, including any co-constraints that exist between the use of 2134 the entry's index value or name, and other values defined within 2135 the SWID/CoSWID model. 2137 o Index values and names outside the private use space MUST NOT be 2138 used without registration. This is considered squatting and 2139 SHOULD be avoided. Designated experts MUST ensure that reviewed 2140 specifications register all appropriate index values and names. 2142 o Standards track documents MAY include entries registered in the 2143 range reserved for entries under the Specification Required 2144 policy. This can occur when a standards track document provides 2145 further guidance on the use of index values and names that are in 2146 common use, but were not registered with IANA. This situation 2147 SHOULD be avoided. 2149 o All registered names MUST be valid according to the XML Schema 2150 NMTOKEN data type (see [W3C.REC-xmlschema-2-20041028] section 2151 3.3.4). This ensures that registered names are compatible with 2152 the SWID format [SWID] where they are used. 2154 o Registration of vanity names SHOULD be discouraged. The 2155 requesting specification MUST provide a description of how a 2156 requested name will allow for use by multiple stakeholders. 2158 5.2.4. SWID/CoSWID Version Scheme Value Registry 2160 This document defines a new a new registry titled "SWID/CoSWID 2161 Version Scheme Values". This registry provides index values for use 2162 as version-scheme item values in this document and version scheme 2163 names for use in [SWID]. 2165 [TO BE REMOVED: This registration should take place at the following 2166 location: https://www.iana.org/assignments/swid] 2168 This registry uses the registration proceedures defined in 2169 Section 5.2.1 with the following associated ranges: 2171 +-------------+-------------------------+ 2172 | Range | Registration Procedures | 2173 +-------------+-------------------------+ 2174 | 0-16383 | Standards Action | 2175 | | | 2176 | 16384-65535 | Specification Required | 2177 +-------------+-------------------------+ 2179 Table 10: CoSWID Version Scheme Registration Proceedures 2181 Assignments MUST consist of an integer Index value, the Version 2182 Scheme Name, and a reference to the defining specification. 2184 Initial registrations for the "SWID/CoSWID Version Scheme Value" 2185 registry are provided below, which are derived from the textual 2186 version scheme names defined in [SWID]. 2188 +-------------+-------------------------+-----------------+ 2189 | Index | Version Scheme Name | Specification | 2190 +-------------+-------------------------+-----------------+ 2191 | 0 | Reserved | | 2192 | | | | 2193 | 1 | multipartnumeric | See Section 4.1 | 2194 | | | | 2195 | 2 | multipartnumeric+suffix | See Section 4.1 | 2196 | | | | 2197 | 3 | alphanumeric | See Section 4.1 | 2198 | | | | 2199 | 4 | decimal | See Section 4.1 | 2200 | | | | 2201 | 5-16383 | Unassigned | | 2202 | | | | 2203 | 16384 | semver | [SEMVER] | 2204 | | | | 2205 | 16385-65535 | Unassigned | | 2206 +-------------+-------------------------+-----------------+ 2208 Table 11: CoSWID Version Scheme Inital Registrations 2210 Registrations MUST conform to the expert review guidelines defined in 2211 Section 5.2.3. 2213 Designated experts MUST also ensure that newly requested entries 2214 define a value space for the corresponding version item that is 2215 unique from other previously registered entries. Note: The inital 2216 registrations violate this requirement, but are included for 2217 backwards compatibility with [SWID]. Guidelines on how to deconflict 2218 these value spaces are defined in section Section 4.1. 2220 5.2.5. SWID/CoSWID Entity Role Value Registry 2222 This document defines a new a new registry titled "SWID/CoSWID Entity 2223 Role Values". This registry provides index values for use as entity- 2224 entry role item values in this document and entity role names for use 2225 in [SWID]. 2227 [TO BE REMOVED: This registration should take place at the following 2228 location: https://www.iana.org/assignments/swid] 2230 This registry uses the registration proceedures defined in 2231 Section 5.2.1 with the following associated ranges: 2233 +---------+-------------------------+ 2234 | Range | Registration Procedures | 2235 +---------+-------------------------+ 2236 | 0-127 | Standards Action | 2237 | | | 2238 | 128-255 | Specification Required | 2239 +---------+-------------------------+ 2241 Table 12: CoSWID Entity Role Registration Proceedures 2243 Assignments consist of an integer Index value, a Role Name, and a 2244 reference to the defining specification. 2246 Initial registrations for the "SWID/CoSWID Entity Role Value" 2247 registry are provided below, which are derived from the textual 2248 entity role names defined in [SWID]. 2250 +-------+-----------------+-----------------+ 2251 | Index | Role Name | Specification | 2252 +-------+-----------------+-----------------+ 2253 | 0 | Reserved | | 2254 | | | | 2255 | 1 | tagCreator | See Section 4.2 | 2256 | | | | 2257 | 2 | softwareCreator | See Section 4.2 | 2258 | | | | 2259 | 3 | aggregator | See Section 4.2 | 2260 | | | | 2261 | 4 | distributor | See Section 4.2 | 2262 | | | | 2263 | 5 | licensor | See Section 4.2 | 2264 | | | | 2265 | 6-255 | Unassigned | | 2266 +-------+-----------------+-----------------+ 2268 Table 13: CoSWID Entity Role Inital Registrations 2270 Registrations MUST conform to the expert review guidlines defined in 2271 Section 5.2.3. 2273 5.2.6. SWID/CoSWID Link Ownership Value Registry 2275 This document defines a new a new registry titled "SWID/CoSWID Link 2276 Ownership Values". This registry provides index values for use as 2277 link-entry ownership item values in this document and link ownership 2278 names for use in [SWID]. 2280 [TO BE REMOVED: This registration should take place at the following 2281 location: https://www.iana.org/assignments/swid] 2283 This registry uses the registration proceedures defined in 2284 Section 5.2.1 with the following associated ranges: 2286 +---------+-------------------------+ 2287 | Range | Registration Procedures | 2288 +---------+-------------------------+ 2289 | 0-127 | Standards Action | 2290 | | | 2291 | 128-255 | Specification Required | 2292 +---------+-------------------------+ 2294 Table 14: CoSWID Link Ownership Registration Proceedures 2296 Assignments consist of an integer Index value, an Ownership Type 2297 Name, and a reference to the defining specification. 2299 Initial registrations for the "SWID/CoSWID Link Ownership Value" 2300 registry are provided below, which are derived from the textual 2301 entity role names defined in [SWID]. 2303 +-------+---------------------+-----------------+ 2304 | Index | Ownership Type Name | Definition | 2305 +-------+---------------------+-----------------+ 2306 | 0 | Reserved | | 2307 | | | | 2308 | 1 | abandon | See Section 4.3 | 2309 | | | | 2310 | 2 | private | See Section 4.3 | 2311 | | | | 2312 | 3 | shared | See Section 4.3 | 2313 | | | | 2314 | 4-255 | Unassigned | | 2315 +-------+---------------------+-----------------+ 2317 Table 15: CoSWID Link Ownership Inital Registrations 2319 Registrations MUST conform to the expert review guidlines defined in 2320 Section 5.2.3. 2322 5.2.7. SWID/CoSWID Link Relationship Value Registry 2324 This document defines a new a new registry titled "SWID/CoSWID Link 2325 Relationship Values". This registry provides index values for use as 2326 link-entry rel item values in this document and link ownership names 2327 for use in [SWID]. 2329 [TO BE REMOVED: This registration should take place at the following 2330 location: https://www.iana.org/assignments/swid] 2332 This registry uses the registration proceedures defined in 2333 Section 5.2.1 with the following associated ranges: 2335 +-------------+-------------------------+ 2336 | Range | Registration Procedures | 2337 +-------------+-------------------------+ 2338 | 0-32767 | Standards Action | 2339 | | | 2340 | 32768-65535 | Specification Required | 2341 +-------------+-------------------------+ 2343 Table 16: CoSWID Link Relationship Registration Proceedures 2345 Assignments consist of an integer Index value, the Relationship Type 2346 Name, and a reference to the defining specification. 2348 Initial registrations for the "SWID/CoSWID Link Relationship Value" 2349 registry are provided below, which are derived from the link 2350 relationship values defined in [SWID]. 2352 +----------+------------------------+-----------------+ 2353 | Index | Relationship Type Name | Specification | 2354 +----------+------------------------+-----------------+ 2355 | 0 | Reserved | | 2356 | | | | 2357 | 1 | ancestor | See Section 4.4 | 2358 | | | | 2359 | 2 | component | See Section 4.4 | 2360 | | | | 2361 | 3 | feature | See Section 4.4 | 2362 | | | | 2363 | 4 | installationmedia | See Section 4.4 | 2364 | | | | 2365 | 5 | packageinstaller | See Section 4.4 | 2366 | | | | 2367 | 6 | parent | See Section 4.4 | 2368 | | | | 2369 | 7 | patches | See Section 4.4 | 2370 | | | | 2371 | 8 | requires | See Section 4.4 | 2372 | | | | 2373 | 9 | see-also | See Section 4.4 | 2374 | | | | 2375 | 10 | supersedes | See Section 4.4 | 2376 | | | | 2377 | 11 | supplemental | See Section 4.4 | 2378 | | | | 2379 | 12-65535 | Unassigned | | 2380 +----------+------------------------+-----------------+ 2382 Table 17: CoSWID Link Relationship Inital Registrations 2384 Registrations MUST conform to the expert review guidlines defined in 2385 Section 5.2.3. 2387 Designated experts MUST also ensure that a newly requested entry 2388 documents the URI schemes allowed to be used in an href associated 2389 with the link relationship and the expected resolution behavior of 2390 these URI schemes. This will help to ensure that SWID/CoSWID 2391 applications are able to interoperate when resolving resources 2392 referenced by a link of a given type. 2394 5.2.8. SWID/CoSWID Link Use Value Registry 2396 This document defines a new a new registry titled "SWID/CoSWID Link 2397 Use Values". This registry provides index values for use as link- 2398 entry use item values in this document and link use names for use in 2399 [SWID]. 2401 [TO BE REMOVED: This registration should take place at the following 2402 location: https://www.iana.org/assignments/swid] 2404 This registry uses the registration proceedures defined in 2405 Section 5.2.1 with the following associated ranges: 2407 +---------+-------------------------+ 2408 | Range | Registration Procedures | 2409 +---------+-------------------------+ 2410 | 0-127 | Standards Action | 2411 | | | 2412 | 128-255 | Specification Required | 2413 +---------+-------------------------+ 2415 Table 18: CoSWID Link Use Registration Proceedures 2417 Assignments consist of an integer Index value, the Link Use Type 2418 Name, and a reference to the defining specification. 2420 Initial registrations for the "SWID/CoSWID Link Use Value" registry 2421 are provided below, which are derived from the link relationship 2422 values defined in [SWID]. 2424 +-------+--------------------+-----------------+ 2425 | Index | Link Use Type Name | Specification | 2426 +-------+--------------------+-----------------+ 2427 | 0 | Reserved | | 2428 | | | | 2429 | 1 | optional | See Section 4.5 | 2430 | | | | 2431 | 2 | required | See Section 4.5 | 2432 | | | | 2433 | 3 | recommended | See Section 4.5 | 2434 | | | | 2435 | 4-255 | Unassigned | | 2436 +-------+--------------------+-----------------+ 2438 Table 19: CoSWID Link Use Inital Registrations 2440 Registrations MUST conform to the expert review guidlines defined in 2441 Section 5.2.3. 2443 5.3. swid+cbor Media Type Registration 2445 IANA is requested to add the following to the IANA "Media Types" 2446 registry. 2448 Type name: application 2450 Subtype name: swid+cbor 2452 Required parameters: none 2454 Optional parameters: none 2456 Encoding considerations: Must be encoded as using [RFC7049]. See 2457 RFC-AAAA for details. 2459 Security considerations: See Section 6 of RFC-AAAA. 2461 Interoperability considerations: Applications MAY ignore any key 2462 value pairs that they do not understand. This allows backwards 2463 compatible extensions to this specification. 2465 Published specification: RFC-AAAA 2467 Applications that use this media type: The type is used by software 2468 asset management systems, vulnerability assessment systems, and in 2469 applications that use remote integrity verification. 2471 Fragment identifier considerations: Fragment identification for 2472 application/swid+cbor is supported by using fragment identifiers as 2473 specified by RFC-7049 section 7.5. 2475 Additional information: 2477 Magic number(s): first five bytes in hex: da 53 57 49 44 2479 File extension(s): coswid 2481 Macintosh file type code(s): none 2483 Macintosh Universal Type Identifier code: org.ietf.coswid conforms to 2484 public.data 2486 Person & email address to contact for further information: Henk 2487 Birkholz 2489 Intended usage: COMMON 2490 Restrictions on usage: None 2492 Author: Henk Birkholz 2494 Change controller: IESG 2496 5.4. CoAP Content-Format Registration 2498 IANA is requested to assign a CoAP Content-Format ID for the CoSWID 2499 media type in the "CoAP Content-Formats" sub-registry, from the "IETF 2500 Review or IESG Approval" space (256..999), within the "CoRE 2501 Parameters" registry [RFC7252]: 2503 +-----------------------+----------+------+-----------+ 2504 | Media type | Encoding | ID | Reference | 2505 +-----------------------+----------+------+-----------+ 2506 | application/swid+cbor | - | TBD1 | RFC-AAAA | 2507 +-----------------------+----------+------+-----------+ 2509 Table 20: CoAP Content-Format IDs 2511 5.5. CBOR Tag Registration 2513 IANA is requested to allocate a tag in the "CBOR Tags" registry, 2514 preferably with the specific value requested: 2516 +------------+----------+-------------------------------------------+ 2517 | Tag | Data | Semantics | 2518 | | Item | | 2519 +------------+----------+-------------------------------------------+ 2520 | 1398229316 | map | Concise Software Identifier (CoSWID) | 2521 | | | [RFC-AAAA] | 2522 +------------+----------+-------------------------------------------+ 2524 Table 21: CoSWID CBOR Tag 2526 5.6. URI Scheme Registrations 2528 The ISO 19770-2:2015 SWID specification describes use of the "swid" 2529 and "swidpath" URI schemes, which are currently in use in 2530 implementations. This document continues this use for CoSWID. The 2531 following subsections provide registrations for these schemes in to 2532 ensure that a permanent registration exists for these schemes that is 2533 suitable for use in the SWID and CoSWID specifications. 2535 5.6.1. "swid" URI Scheme Registration 2537 SWID or CoSWID by the referenced tag's tag-id. This URI needs to be 2538 resolved in the context of the endpoint by software that can lookup 2539 other SWID or CoSWID tags. For example, "swid:2df9de35-0aff- 2540 4a86-ace6-f7dddd1ade4c" references the tag with the tag-id value 2541 "2df9de35-0aff-4a86-ace6-f7dddd1ade4c". 2543 There is a need for a scheme name that can be used in URIs that point 2544 to a specific SWID/CoSWID tag by that tag's tag-id, such as the use 2545 of the link entry as described in section Section 2.7) of this 2546 document. Since this scheme is used in a standards track document 2547 and an ISO standard, this scheme needs to be used without fear of 2548 conflicts with current or future actual schemes. The scheme "swid" 2549 is hereby registered as a 'permanent' scheme for that purpose. 2551 The "swid" scheme is specified as follows: 2553 Scheme syntax: The scheme speific part consists of a SWID or CoSWID 2554 tag's tag-id that is URI encoded according to [RFC3986] section 2.1. 2555 The following expression is a valid example: 2557 2559 Scheme semantics: URIs in the "swid" scheme are to be used to 2560 reference a SWID or CoSWID tag by its tag-id. A tag-id referenced in 2561 this way can be used to indentify the tag resource in the context of 2562 where it is referenced from. For example, when a tag is installed on 2563 a given device, that tag can reference related tags on the same 2564 device using this URI scheme. 2566 Encoding considerations: See Section 2.5 of [RFC3986] for guidelines. 2568 Interoperability considerations: None. 2570 Security considerations: None. 2572 5.6.2. "swidpath" URI Scheme Registration 2574 There is a need for a scheme name that can be used in URIs to 2575 indentify a collection of specific SWID/CoSWID tags with data 2576 elements that match an XPath expression, such as the use of the link 2577 entry as described in section Section 2.7) of this document. Since 2578 this scheme is used in a standards track document and an ISO 2579 standard, this scheme needs to be used without fear of conflicts with 2580 current or future actual schemes. The scheme "swidpath" is hereby 2581 registered as a 'permanent' scheme for that purpose. 2583 The "swidpath" scheme is specified as follows: 2585 Scheme syntax: The scheme speific part consists of an XPath 2586 expression as defined by [W3C.REC-xpath20-20101214]. The included 2587 XPath expression will be URI encoded according to [RFC3986] section 2588 2.1. 2590 Scheme semantics: URIs in the "swidpath" scheme are to be used 2591 specify the data that must be found in a given SWID/CoSWID tag for 2592 that tag to be considered a matching tag to be included in the 2593 identified tag collection. Tags to be evaluated include all tags in 2594 the context of where the tag is referenced from. For example, when a 2595 tag is installed on a given device, that tag can reference related 2596 tags on the same device using this URI scheme. A tag is matching if 2597 the XPath evaluation result value has an effective boolean value of 2598 "true" according to [W3C.REC-xpath20-20101214] section 2.4.3. rence 2599 related tags on the same device using this URI scheme. 2601 Encoding considerations: See Section 2.5 of [RFC3986] for guidelines. 2603 Interoperability considerations: None. 2605 Security considerations: None. 2607 5.7. CoSWID Model for use in SWIMA Registration 2609 The Software Inventory Message and Attributes (SWIMA) for PA-TNC 2610 specification [RFC8412] defines a standardized method for collecting 2611 an endpoint device's software inventory. A CoSWID can provide 2612 evidence of software installation which can then be used and 2613 exchanged with SWIMA. This registration adds a new entry to the IANA 2614 "Software Data Model Types" registry defined by [RFC8412] to support 2615 CoSWID use in SWIMA as follows: 2617 Pen: 0 2619 Integer: TBD2 2621 Name: Concise Software Identifier (CoSWID) 2623 Defining Specification: RFC-AAAA 2625 Deriving Software Identifiers: 2627 A Software Identifier generated from a CoSWID tag is expressed as a 2628 concatenation of the form: 2630 TAG_CREATOR_REGID "_" "_" UNIQUE_ID 2631 Where TAG_CREATOR_REGID is the reg-id ietm value of the tag's entity 2632 item having the role value of 1 (corresponding to "tag creator"), and 2633 the UNIQUE_ID is the same tag's tag-id item. If the tag-id item's 2634 value is expressed as a 16 byte binary string, the UNIQUE_ID MUST be 2635 represented using the UUID string representation defined in [RFC4122] 2636 including the "urn:uuid:" prefix. 2638 The TAG_CREATOR_REGID and the UNIQUE_ID are connected with a double 2639 underscore (_), without any other connecting character or whitespace. 2641 6. Security Considerations 2643 SWID and CoSWID tags contain public information about software 2644 components and, as such, do not need to be protected against 2645 disclosure on an endpoint. Similarly, SWID/CoSWID tags are intended 2646 to be easily discoverable by applications and users on an endpoint in 2647 order to make it easy to identify and collect all of an endpoint's 2648 SWID tags. As such, any security considerations regarding SWID/ 2649 CoSWID tags focus on the application of SWID/CoSWID tags to address 2650 security challenges, and the possible disclosure of the results of 2651 those applications. 2653 A tag is considered "authoritative" if the SWID/CoSWID tag was 2654 created by the software provider. An authoritative SWID/CoSWID tag 2655 contains information about a software component provided by the 2656 maintainer of the software component, who is expected to be an expert 2657 in their own software. Thus, authoritative SWID/CoSWID tags can be 2658 trusted to represent authoritative information about the software 2659 component. 2661 A signed SWID/CoSWID tag (see Appendix A) whose signature has been 2662 validated can be relied upon to be unchanged since it was signed. By 2663 contrast, the data contained in unsigned tags cannot be trusted to be 2664 unmodified. 2666 When an authoritative tag is signed, the software provider can be 2667 authenticated as the originator of the signature. Having a signed 2668 authoritative SWID/CoSWID tag can be useful when the information in 2669 the tag needs to be trusted, such as when the tag is being used to 2670 convey reference integrity measurements for software components. 2672 SWID/CoSWID tags are designed to be easily added and removed from an 2673 endpoint along with the installation or removal of software 2674 components. On endpoints where addition or removal of software 2675 components is tightly controlled, the addition or removal of SWID 2676 tags can be similarly controlled. On more open systems, where many 2677 users can manage the software inventory, SWID/CoSWID tags can be 2678 easier to add or remove. On such systems, it can be possible to add 2679 or remove SWID/CoSWID tags in a way that does not reflect the actual 2680 presence or absence of corresponding software components. Similarly, 2681 not all software products automatically install SWID/CoSWID tags, so 2682 products can be present on an endpoint without providing a 2683 corresponding SWID tag. As such, any collection of SWID/CoSWID tags 2684 cannot automatically be assumed to represent either a complete or 2685 fully accurate representation of the software inventory of the 2686 endpoint. However, especially on endpoint devices that more strictly 2687 control the ability to add or remove applications, SWID/CoSWID tags 2688 are an easy way to provide an preliminary understanding of that 2689 endpoint's software inventory. 2691 Any report of an endpoint's SWID/CoSWID tag collection provides 2692 information about the software inventory of that endpoint. If such a 2693 report is exposed to an attacker, this can tell them which software 2694 products and versions thereof are present on the endpoint. By 2695 examining this list, the attacker might learn of the presence of 2696 applications that are vulnerable to certain types of attacks. As 2697 noted earlier, SWID/CoSWID tags are designed to be easily 2698 discoverable by an endpoint, but this does not present a significant 2699 risk since an attacker would already need to have access to the 2700 endpoint to view that information. However, when the endpoint 2701 transmits its software inventory to another party, or that inventory 2702 is stored on a server for later analysis, this can potentially expose 2703 this information to attackers who do not yet have access to the 2704 endpoint. For this reason, it is important to protect the 2705 confidentiality of SWID/CoSWID tag information that has been 2706 collected from an endpoint, not because those tags individually 2707 contain sensitive information, but because the collection of SWID/ 2708 CoSWID tags and their association with an endpoint reveals 2709 information about that endpoint's attack surface. 2711 Finally, both the ISO-19770-2:2015 XML schema SWID definition and the 2712 CoSWID data definition allow for the construction of "infinite" tags 2713 with link item loops or tags that contain malicious content with the 2714 intent of creating non-deterministic states during validation or 2715 processing of those tags. While software providers are unlikely to 2716 do this, SWID/CoSWID tags can be created by any party and the SWID/ 2717 CoSWID tags collected from an endpoint could contain a mixture of 2718 vendor and non-vendor created tags. For this reason, tools that 2719 consume SWID/CoSWID tags ought to treat the tag contents as 2720 potentially malicious and employ input sanitizing and loop detection 2721 on the tags they ingest. 2723 7. Acknowledgments 2725 This document draws heavily on the concepts defined in the ISO/IEC 2726 19770-2:2015 specification. The authors of this document are 2727 grateful for the prior work of the 19770-2 contributors. 2729 We are also grateful to the careful reviews provided by ... 2731 8. Change Log 2733 [THIS SECTION TO BE REMOVED BY THE RFC EDITOR.] 2735 Changes from version 03 to version 11: 2737 o Reduced representation complexity of the media-entry type and 2738 removed the section describing the older data structure. 2740 o Added more signature schemes from COSE 2742 o Included a minimal required set of normative language 2744 o Reordering of attribute name to integer label by priority 2745 according to semantics. 2747 o Added an IANA registry for CoSWID items supporting future 2748 extension. 2750 o Cleaned up IANA registrations, fixing some inconsistencies in the 2751 table labels. 2753 o Added additional CDDL sockets for resource collection entries 2754 providing for additional extension points to address future SWID/ 2755 CoSWID extensions. 2757 o Updated section on extension points to address new CDDL sockets 2758 and to reference the new IANA registry for items. 2760 o Removed unused references and added new references to address 2761 placeholder comments. 2763 o Added table with semantics for the link ownership item. 2765 o Clarified language, made term use more consistent, fixed 2766 references, and replacing lowercase RFC2119 keywords. 2768 Changes from version 02 to version 03: 2770 o Updated core CDDL including the CDDL design pattern according to 2771 RFC 8428. 2773 Changes from version 01 to version 02: 2775 o Enforced a more strict separation between the core CoSWID 2776 definition and additional usage by moving content to corresponding 2777 appendices. 2779 o Removed artifacts inherited from the reference schema provided by 2780 ISO (e.g. NMTOKEN(S)) 2782 o Simplified the core data definition by removing group and type 2783 choices where possible 2785 o Minor reordering of map members 2787 o Added a first extension point to address requested flexibility for 2788 extensions beyond the any-element 2790 Changes from version 00 to version 01: 2792 o Ambiguity between evidence and payload eliminated by introducing 2793 explicit members (while still 2795 o allowing for "empty" SWID tags) 2797 o Added a relatively restrictive COSE envelope using cose_sign1 to 2798 define signed CoSWID (single signer only, at the moment) 2800 o Added a definition how to encode hashes that can be stored in the 2801 any-member using existing IANA tables to reference hash-algorithms 2803 Changes since adopted as a WG I-D -00: 2805 o Removed redundant any-attributes originating from the ISO- 2806 19770-2:2015 XML schema definition 2808 o Fixed broken multi-map members 2810 o Introduced a more restrictive item (any-element-map) to represent 2811 custom maps, increased restriction on types for the any-attribute, 2812 accordingly 2814 o Fixed X.1520 reference 2816 o Minor type changes of some attributes (e.g. NMTOKENS) 2817 o Added semantic differentiation of various name types (e,g. fs- 2818 name) 2820 Changes from version 06 to version 07: 2822 o Added type choices/enumerations based on textual definitions in 2823 19770-2:2015 2825 o Added value registry request 2827 o Added media type registration request 2829 o Added content format registration request 2831 o Added CBOR tag registration request 2833 o Removed RIM appedix to be addressed in complementary draft 2835 o Removed CWT appendix 2837 o Flagged firmware resource colletion appendix for revision 2839 o Made use of terminology more consistent 2841 o Better defined use of extension points in the CDDL 2843 o Added definitions for indexed values 2845 o Added IANA registry for Link use indexed values 2847 Changes from version 05 to version 06: 2849 o Improved quantities 2851 o Included proposals for implicet enumerations that were NMTOKENS 2853 o Added extension points 2855 o Improved exemplary firmware-resource extension 2857 Changes from version 04 to version 05: 2859 o Clarified language around SWID and CoSWID to make more consistent 2860 use of these terms. 2862 o Added language describing CBOR optimizations for single vs. arrays 2863 in the model front matter. 2865 o Fixed a number of grammatical, spelling, and wording issues. 2867 o Documented extension points that use CDDL sockets. 2869 o Converted IANA registration tables to markdown tables, reserving 2870 the 0 value for use when a value is not known. 2872 o Updated a number of references to their current versions. 2874 Changes from version 03 to version 04: 2876 o Re-index label values in the CDDL. 2878 o Added a section describing the CoSWID model in detail. 2880 o Created IANA registries for entity-role and version-scheme 2882 Changes from version 02 to version 03: 2884 o Updated CDDL to allow for a choice between a payload or evidence 2886 o Re-index label values in the CDDL. 2888 o Added item definitions 2890 o Updated references for COSE, CBOR Web Token, and CDDL. 2892 Changes from version 01 to version 02: 2894 o Added extensions for Firmware and CoSWID use as Reference 2895 Integrity Measurements (CoSWID RIM) 2897 o Changes meta handling in CDDL from use of an explicit use of items 2898 to a more flexible unconstrained collection of items. 2900 o Added sections discussing use of COSE Signatures and CBOR Web 2901 Tokens 2903 Changes from version 00 to version 01: 2905 o Added CWT usage for absolute SWID paths on a device 2907 o Fixed cardinality of type-choices including arrays 2909 o Included first iteration of firmware resource-collection 2911 9. References 2913 9.1. Normative References 2915 [BCP178] Saint-Andre, P., Crocker, D., and M. Nottingham, 2916 "Deprecating the "X-" Prefix and Similar Constructs in 2917 Application Protocols", BCP 178, RFC 6648, 2918 DOI 10.17487/RFC6648, June 2012, 2919 . 2921 [BCP26] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 2922 Writing an IANA Considerations Section in RFCs", BCP 26, 2923 RFC 8126, DOI 10.17487/RFC8126, June 2017, 2924 . 2926 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2927 Requirement Levels", BCP 14, RFC 2119, 2928 DOI 10.17487/RFC2119, March 1997, 2929 . 2931 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 2932 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 2933 2003, . 2935 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2936 Resource Identifier (URI): Generic Syntax", STD 66, 2937 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2938 . 2940 [RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network 2941 Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008, 2942 . 2944 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2945 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2946 September 2009, . 2948 [RFC5892] Faltstrom, P., Ed., "The Unicode Code Points and 2949 Internationalized Domain Names for Applications (IDNA)", 2950 RFC 5892, DOI 10.17487/RFC5892, August 2010, 2951 . 2953 [RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object 2954 Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, 2955 October 2013, . 2957 [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained 2958 Application Protocol (CoAP)", RFC 7252, 2959 DOI 10.17487/RFC7252, June 2014, 2960 . 2962 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 2963 Writing an IANA Considerations Section in RFCs", BCP 26, 2964 RFC 8126, DOI 10.17487/RFC8126, June 2017, 2965 . 2967 [RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)", 2968 RFC 8152, DOI 10.17487/RFC8152, July 2017, 2969 . 2971 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2972 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2973 May 2017, . 2975 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2976 DOI 10.17487/RFC8288, October 2017, 2977 . 2979 [RFC8412] Schmidt, C., Haynes, D., Coffin, C., Waltermire, D., and 2980 J. Fitzgerald-McKay, "Software Inventory Message and 2981 Attributes (SWIMA) for PA-TNC", RFC 8412, 2982 DOI 10.17487/RFC8412, July 2018, 2983 . 2985 [RFC8610] Birkholz, H., Vigano, C., and C. Bormann, "Concise Data 2986 Definition Language (CDDL): A Notational Convention to 2987 Express Concise Binary Object Representation (CBOR) and 2988 JSON Data Structures", RFC 8610, DOI 10.17487/RFC8610, 2989 June 2019, . 2991 [SAM] "Information technology - Software asset management - Part 2992 5: Overview and vocabulary", ISO/IEC 19770-5:2015, 2993 November 2013. 2995 [SEMVER] Preston-Werner, T., "Semantic Versioning 2.0.0", n.d., 2996 . 2998 [SWID] "Information technology - Software asset management - Part 2999 2: Software identification tag", ISO/IEC 19770-2:2015, 3000 October 2015. 3002 [W3C.REC-css3-mediaqueries-20120619] 3003 Rivoal, F., "Media Queries", World Wide Web Consortium 3004 Recommendation REC-css3-mediaqueries-20120619, June 2012, 3005 . 3008 [W3C.REC-xmlschema-2-20041028] 3009 Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes 3010 Second Edition", World Wide Web Consortium Recommendation 3011 REC-xmlschema-2-20041028, October 2004, 3012 . 3014 [W3C.REC-xpath20-20101214] 3015 Berglund, A., Boag, S., Chamberlin, D., Fernandez, M., 3016 Kay, M., Robie, J., and J. Simeon, "XML Path Language 3017 (XPath) 2.0 (Second Edition)", World Wide Web Consortium 3018 Recommendation REC-xpath20-20101214, December 2010, 3019 . 3021 [X.1520] "Recommendation ITU-T X.1520 (2014), Common 3022 vulnerabilities and exposures", April 2011. 3024 9.2. Informative References 3026 [CamelCase] 3027 "UpperCamelCase", August 2014, 3028 . 3030 [I-D.birkholz-rats-tuda] 3031 Fuchs, A., Birkholz, H., McDonald, I., and C. Bormann, 3032 "Time-Based Uni-Directional Attestation", draft-birkholz- 3033 rats-tuda-00 (work in progress), March 2019. 3035 [KebabCase] 3036 "KebabCase", December 2014, 3037 . 3039 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 3040 Unique IDentifier (UUID) URN Namespace", RFC 4122, 3041 DOI 10.17487/RFC4122, July 2005, 3042 . 3044 [RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource- 3045 Oriented Lightweight Information Exchange (ROLIE)", 3046 RFC 8322, DOI 10.17487/RFC8322, February 2018, 3047 . 3049 [RFC8520] Lear, E., Droms, R., and D. Romascanu, "Manufacturer Usage 3050 Description Specification", RFC 8520, 3051 DOI 10.17487/RFC8520, March 2019, 3052 . 3054 [SWID-GUIDANCE] 3055 Waltermire, D., Cheikes, B., Feldman, L., and G. Witte, 3056 "Guidelines for the Creation of Interoperable Software 3057 Identification (SWID) Tags", NISTIR 8060, April 2016, 3058 . 3060 Appendix A. Signed Concise SWID Tags using COSE 3062 SWID tags, as defined in the ISO-19770-2:2015 XML schema, can include 3063 cryptographic signatures to protect the integrity of the SWID tag. 3064 In general, tags are signed by the tag creator (typically, although 3065 not exclusively, the vendor of the software component that the SWID 3066 tag identifies). Cryptographic signatures can make any modification 3067 of the tag detectable, which is especially important if the integrity 3068 of the tag is important, such as when the tag is providing reference 3069 integrity measurements for files. 3071 The ISO-19770-2:2015 XML schema uses XML DSIG to support 3072 cryptographic signatures. CoSWID tags require a different signature 3073 scheme than this. COSE (CBOR Object Signing and Encryption) provides 3074 the required mechanism [RFC8152]. Concise SWID can be wrapped in a 3075 COSE Single Signer Data Object (COSE_Sign1) that contains a single 3076 signature. The following CDDL defines a more restrictive subset of 3077 header attributes allowed by COSE tailored to suit the requirements 3078 of Concise SWID tags. 3080 3081 signed-coswid = #6.18(COSE-Sign1-coswid) 3083 cose-label = int / tstr 3084 cose-values = any 3086 protected-signed-coswid-header = { 3087 1 => int, ; algorithm identifier 3088 3 => "application/swid+cbor", 3089 * cose-label => cose-values, 3090 } 3092 unprotected-signed-coswid-header = { 3093 4 => bstr, ; key identifier 3094 * cose-label => cose-values, 3095 } 3097 COSE-Sign1-coswid = [ 3098 protected: bstr .cbor protected-signed-coswid-header, 3099 unprotected: unprotected-signed-coswid-header, 3100 payload: bstr .cbor concise-swid-tag, 3101 signature: bstr, 3102 ] 3103 3105 Optionally, the COSE_Sign structure that allows for more than one 3106 signature to be applied to a CoSWID tag MAY be used. The 3107 corresponding usage scenarios are domain-specific and require well- 3108 defined application guidance. Representation of the corresponding 3109 guidance is out-of-scope of this document. 3111 Additionally, the COSE Header counter signature MAY be used as an 3112 attribute in the unprotected header map of the COSE envelope of a 3113 CoSWID. The application of counter signing enables second parties to 3114 provide a signature on a signature allowing for a proof that a 3115 signature existed at a given time (i.e., a timestamp). 3117 Authors' Addresses 3119 Henk Birkholz 3120 Fraunhofer SIT 3121 Rheinstrasse 75 3122 Darmstadt 64295 3123 Germany 3125 Email: henk.birkholz@sit.fraunhofer.de 3126 Jessica Fitzgerald-McKay 3127 Department of Defense 3128 9800 Savage Road 3129 Ft. Meade, Maryland 3130 USA 3132 Email: jmfitz2@nsa.gov 3134 Charles Schmidt 3135 The MITRE Corporation 3136 202 Burlington Road 3137 Bedford, Maryland 01730 3138 USA 3140 Email: cmschmidt@mitre.org 3142 David Waltermire 3143 National Institute of Standards and Technology 3144 100 Bureau Drive 3145 Gaithersburg, Maryland 20877 3146 USA 3148 Email: david.waltermire@nist.gov