draft-ietf-sacm-coswid-02.txt   draft-ietf-sacm-coswid-03.txt 
SACM Working Group H. Birkholz SACM Working Group H. Birkholz
Internet-Draft Fraunhofer SIT Internet-Draft Fraunhofer SIT
Intended status: Standards Track J. Fitzgerald-McKay Intended status: Standards Track J. Fitzgerald-McKay
Expires: January 5, 2018 Department of Defense Expires: July 8, 2018 Department of Defense
C. Schmidt C. Schmidt
The MITRE Corporation The MITRE Corporation
D. Waltermire D. Waltermire
NIST NIST
July 04, 2017 January 04, 2018
Concise Software Identifiers Concise Software Identifiers
draft-ietf-sacm-coswid-02 draft-ietf-sacm-coswid-03
Abstract Abstract
This document defines a concise representation of ISO 19770-2:2015 This document defines a concise representation of ISO 19770-2:2015
Software Identifiers (SWID tags) that is interoperable with the XML Software Identifiers (SWID tags) that is interoperable with the XML
schema definition of ISO 19770-2:2015 and augmented for application schema definition of ISO 19770-2:2015 and augmented for application
in Constrained-Node Networks. Next to the inherent capability of in Constrained-Node Networks. Next to the inherent capability of
SWID tags to express arbitrary context information, CoSWID support SWID tags to express arbitrary context information, CoSWID support
the definition of additional semantics via well-defined data the definition of additional semantics via well-defined data
definitions incorporated by extension points. definitions incorporated by extension points.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 5, 2018. This Internet-Draft will expire on July 8, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
skipping to change at page 2, line 28 skipping to change at page 2, line 28
3. Description of the SWID Attribute Vocabulary Definition . . . 9 3. Description of the SWID Attribute Vocabulary Definition . . . 9
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
5. Security Considerations . . . . . . . . . . . . . . . . . . . 9 5. Security Considerations . . . . . . . . . . . . . . . . . . . 9
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 11 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 11
7. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 11 7. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 11
8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 12 8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 12
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 12 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 12
9.1. Normative References . . . . . . . . . . . . . . . . . . 12 9.1. Normative References . . . . . . . . . . . . . . . . . . 12
9.2. Informative References . . . . . . . . . . . . . . . . . 13 9.2. Informative References . . . . . . . . . . . . . . . . . 13
Appendix A. Explicit file-hash Type Used in Concise SWID Tags Appendix A. Explicit file-hash Type Used in Concise SWID Tags
(label 56) . . . . . . . . . . . . . . . . . . . . . 13 (label 56) . . . . . . . . . . . . . . . . . . . . . 14
Appendix B. CoSWID Attributes for Firmware (label 57) . . . . . 14 Appendix B. CoSWID Attributes for Firmware (label 57) . . . . . 14
Appendix C. Signed Concise SWID Tags using COSE . . . . . . . . 16 Appendix C. Signed Concise SWID Tags using COSE . . . . . . . . 16
Appendix D. CoSWID used as Reference Integrity Measurements Appendix D. CoSWID used as Reference Integrity Measurements
(CoSWID RIM) . . . . . . . . . . . . . . . . . . . . 17 (CoSWID RIM) . . . . . . . . . . . . . . . . . . . . 17
Appendix E. CBOR Web Token for Concise SWID Tags . . . . . . . . 18 Appendix E. CBOR Web Token for Concise SWID Tags . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18 Appendix F. Group Definitions . . . . . . . . . . . . . . . . . 18
Appendix G. Item Definitions . . . . . . . . . . . . . . . . . . 19
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 26
1. Introduction 1. Introduction
SWID tags have several use-applications including but not limited to: SWID tags have several use-applications including but not limited to:
o Software Inventory Management, a part of the Software Asset o Software Inventory Management, a part of the Software Asset
Management [SAM] process, which requires an accurate list of Management [SAM] process, which requires an accurate list of
discernible deployed software components. discernible deployed software components.
o Vulnerability Assessment, which requires a semantic link between o Vulnerability Assessment, which requires a semantic link between
skipping to change at page 3, line 35 skipping to change at page 3, line 35
meant to describe a patch that modifies some other application. meant to describe a patch that modifies some other application.
While there are very few required fields in SWID tags, there are many While there are very few required fields in SWID tags, there are many
optional fields that support different uses of these different types optional fields that support different uses of these different types
of tags. While a SWID tag that consisted only of required fields of tags. While a SWID tag that consisted only of required fields
could be a few hundred bytes in size, a tag containing many of the could be a few hundred bytes in size, a tag containing many of the
optional fields could be many orders of magnitude larger. optional fields could be many orders of magnitude larger.
This document defines a more concise representation of SWID tags in This document defines a more concise representation of SWID tags in
the Concise Binary Object Representation (CBOR) [RFC7049]. This is the Concise Binary Object Representation (CBOR) [RFC7049]. This is
described via the Concise Data Definition Language (CDDL) described via the Concise Data Definition Language (CDDL)
[I-D.greevenbosch-appsawg-cbor-cddl]. The resulting Concise SWID [I-D.ietf-cbor-cddl]. The resulting Concise SWID data definition is
data definition is interoperable with the XML schema definition of interoperable with the XML schema definition of ISO-19770-2:2015
ISO-19770-2:2015 [SWID]. The vocabulary, i.e., the CDDL names of the [SWID]. The vocabulary, i.e., the CDDL names of the types and
types and members used in the CoSWID data definition, is mapped to members used in the CoSWID data definition, is mapped to more concise
more concise labels represented as small integers. The names used in labels represented as small integers. The names used in the CDDL
the CDDL data definition and the mapping to the CBOR representation data definition and the mapping to the CBOR representation using
using integer labels is based on the vocabulary of the XML attribute integer labels is based on the vocabulary of the XML attribute and
and element names defined in ISO-19770-2:2015. element names defined in ISO-19770-2:2015.
Real-world instances of SWID tags can be fairly large, and the Real-world instances of SWID tags can be fairly large, and the
communication of SWID tags in use-applications such as those communication of SWID tags in use-applications such as those
described earlier can cause a large amount of data to be transported. described earlier can cause a large amount of data to be transported.
This can be larger than acceptable for constrained devices and This can be larger than acceptable for constrained devices and
networks. CoSWID tags significantly reduce the amount of data networks. CoSWID tags significantly reduce the amount of data
transported as compared to a typical SWID tag. This reduction is transported as compared to a typical SWID tag. This reduction is
enable through the use of CBOR, which maps human-readable labels of enable through the use of CBOR, which maps human-readable labels of
that content to more concise integer labels (indices). This allows that content to more concise integer labels (indices). This allows
SWID tags to be part of an enterprise security solution for a wider SWID tags to be part of an enterprise security solution for a wider
skipping to change at page 5, line 24 skipping to change at page 5, line 24
CoSWID tag in. CoSWID tag in.
In order to create a valid CoSWID document the structure of the In order to create a valid CoSWID document the structure of the
corresponding CBOR message MUST adhere to the following CDDL data corresponding CBOR message MUST adhere to the following CDDL data
definition. definition.
<CODE BEGINS> <CODE BEGINS>
concise-software-identity = { concise-software-identity = {
global-attributes, global-attributes,
? entity-entry, ? entity-entry,
? evidence-entry, ? payload-xor-evidence-entry,
? link-entry, ? link-entry,
? software-meta-entry, ? software-meta-entry,
? payload-entry, ; ? payload-entry,
? any-element-entry, ? any-element-entry,
? corpus, ? corpus,
? patch, ? patch,
? media, ? media,
swid-name, swid-name,
? supplemental, ? supplemental,
tag-id, tag-id,
? tag-version, ? tag-version,
? version, ? software-version,
? version-scheme, ? version-scheme,
} }
any-uri = text any-uri = text
label = text / int label = text / int
any-attribute = ( any-attribute = (
label => text / int / [ 2* text ] / [ 2* int ] label => text / int / [ 2* text ] / [ 2* int ]
) )
skipping to change at page 6, line 19 skipping to change at page 6, line 19
? directory-entry, ? directory-entry,
? file-entry, ? file-entry,
? process-entry, ? process-entry,
? resource-entry ? resource-entry
* $$resource-extension * $$resource-extension
) )
file = { file = {
filesystem-item, filesystem-item,
? size, ? size,
? version, ? file-version,
? file-hash, ? file-hash,
} }
filesystem-item = ( filesystem-item = (
global-attributes, global-attributes,
? key, ? key,
? location, ? location,
fs-name, fs-name,
? root, ? root,
) )
skipping to change at page 7, line 19 skipping to change at page 7, line 19
global-attributes, global-attributes,
resource-collection, resource-collection,
? date, ? date,
? device-id, ? device-id,
} }
link = { link = {
global-attributes, global-attributes,
? artifact, ? artifact,
href, href,
? media, ? media-type,
? ownership, ? ownership,
rel, rel,
? type, ? type,
? use, ? use,
} }
software-meta = { software-meta = {
global-attributes, global-attributes,
? activation-status, ? activation-status,
? channel-type, ? channel-type,
skipping to change at page 7, line 50 skipping to change at page 7, line 50
? summary, ? summary,
? unspsc-code, ? unspsc-code,
? unspsc-version, ? unspsc-version,
} }
payload = { payload = {
global-attributes, global-attributes,
resource-collection, resource-collection,
} }
payload-xor-evidence-entry = ((3: evidence) // (6: payload))
tag-id = (0: text) tag-id = (0: text)
swid-name = (1: text) swid-name = (1: text)
entity-entry = (2: entity / [ 2* entity ]) entity-entry = (2: entity / [ 2* entity ])
evidence-entry = (3: evidence) evidence-entry = (3: evidence)
link-entry = (4: link / [ 2* link ]) link-entry = (4: link / [ 2* link ])
software-meta-entry = (5: software-meta / [ 2* software-meta ]) software-meta-entry = (5: software-meta / [ 2* software-meta ])
payload-entry = (6: payload) payload-entry = (6: payload)
any-element-entry = (7: any-element-map / [ 2* any-element-map ]) any-element-entry = (7: any-element-map / [ 2* any-element-map ])
corpus = (8: bool) corpus = (8: bool)
patch = (9: bool) patch = (9: bool)
media = (10: text) media = (10: text)
supplemental = (11: bool) supplemental = (11: bool)
tag-version = (12: integer) tag-version = (12: integer)
version = (13: text) software-version = (13: text)
version-scheme = (14: text) version-scheme = (14: text)
lang = (15: text) lang = (15: text)
directory-entry = (16: directory / [ 2* directory ]) directory-entry = (16: directory / [ 2* directory ])
file-entry = (17: file / [ 2* file ]) file-entry = (17: file / [ 2* file ])
process-entry = (18: process / [ 2* process ]) process-entry = (18: process / [ 2* process ])
resource-entry = (19: resource / [ 2* resource ]) resource-entry = (19: resource / [ 2* resource ])
size = (20: integer) size = (20: integer)
key = (21: bool) file-version = (21: text)
location = (22: text) key = (22: bool)
fs-name = (23: text) location = (23: text)
root = (24: text) fs-name = (24: text)
path-elements = (25: { * file-entry, root = (25: text)
path-elements = (26: { * file-entry,
* directory-entry, * directory-entry,
} }
) )
process-name = (26: text) process-name = (27: text)
pid = (27: integer) pid = (28: integer)
type = (28: text) type = (29: text)
extended-data = (29: any-element-map / [ 2* any-element-map ]) extended-data = (30: any-element-map / [ 2* any-element-map ])
entity-name = (30: text) entity-name = (31: text)
reg-id = (31: any-uri) reg-id = (32: any-uri)
role = (32: text / [2* text]) role = (33: text / [2* text])
thumbprint = (33: text) thumbprint = (34: text)
date = (34: time) date = (35: time)
device-id = (35: text) device-id = (36: text)
artifact = (36: text) artifact = (37: text)
href = (37: any-uri) href = (38: any-uri)
ownership = (38: "shared" / "private" / "abandon") ownership = (39: "shared" / "private" / "abandon")
rel = (39: text) rel = (40: text)
use = (40: "optional" / "required" / "recommended") media-type = (41: text)
activation-status = (41: text) use = (42: "optional" / "required" / "recommended")
channel-type = (42: text) activation-status = (43: text)
colloquial-version = (43: text) channel-type = (44: text)
description = (44: text) colloquial-version = (45: text)
edition = (45: text) description = (46: text)
entitlement-data-required = (46: bool) edition = (47: text)
entitlement-key = (47: text) entitlement-data-required = (48: bool)
generator = (48: text) entitlement-key = (49: text)
persistent-id = (49: text) generator = (50: text)
product = (50: text) persistent-id = (51: text)
product-family = (51: text) product = (52: text)
revision = (52: text) product-family = (53: text)
summary = (53: text) revision = (54: text)
unspsc-code = (54: text) summary = (55: text)
unspsc-version = (55: text) unspsc-code = (56: text)
file-hash = (56: [ hash-alg-id: int, unspsc-version = (57: text)
file-hash = (58: [ hash-alg-id: int,
hash-value: bstr, hash-value: bstr,
] ]
) )
<CODE ENDS> <CODE ENDS>
3. Description of the SWID Attribute Vocabulary Definition 3. Description of the SWID Attribute Vocabulary Definition
Yet to be written still... Yet to be written still...
4. IANA Considerations 4. IANA Considerations
skipping to change at page 12, line 28 skipping to change at page 12, line 30
extensions beyond the any-element extensions beyond the any-element
8. Contributors 8. Contributors
9. References 9. References
9.1. Normative References 9.1. Normative References
[I-D.ietf-ace-cbor-web-token] [I-D.ietf-ace-cbor-web-token]
Jones, M., Wahlstroem, E., Erdtman, S., and H. Tschofenig, Jones, M., Wahlstroem, E., Erdtman, S., and H. Tschofenig,
"CBOR Web Token (CWT)", draft-ietf-ace-cbor-web-token-07 "CBOR Web Token (CWT)", draft-ietf-ace-cbor-web-token-10
(work in progress), July 2017. (work in progress), December 2017.
[I-D.ietf-cose-msg]
Schaad, J., "CBOR Object Signing and Encryption (COSE)",
draft-ietf-cose-msg-24 (work in progress), November 2016.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC4108] Housley, R., "Using Cryptographic Message Syntax (CMS) to [RFC4108] Housley, R., "Using Cryptographic Message Syntax (CMS) to
Protect Firmware Packages", RFC 4108, Protect Firmware Packages", RFC 4108,
DOI 10.17487/RFC4108, August 2005, DOI 10.17487/RFC4108, August 2005,
<http://www.rfc-editor.org/info/rfc4108>. <https://www.rfc-editor.org/info/rfc4108>.
[RFC4949] Shirey, R., "Internet Security Glossary, Version 2", [RFC4949] Shirey, R., "Internet Security Glossary, Version 2",
FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007, FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007,
<http://www.rfc-editor.org/info/rfc4949>. <https://www.rfc-editor.org/info/rfc4949>.
[RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object [RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object
Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049,
October 2013, <http://www.rfc-editor.org/info/rfc7049>. October 2013, <https://www.rfc-editor.org/info/rfc7049>.
[RFC7228] Bormann, C., Ersue, M., and A. Keranen, "Terminology for [RFC7228] Bormann, C., Ersue, M., and A. Keranen, "Terminology for
Constrained-Node Networks", RFC 7228, Constrained-Node Networks", RFC 7228,
DOI 10.17487/RFC7228, May 2014, DOI 10.17487/RFC7228, May 2014,
<http://www.rfc-editor.org/info/rfc7228>. <https://www.rfc-editor.org/info/rfc7228>.
[RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)",
RFC 8152, DOI 10.17487/RFC8152, July 2017,
<https://www.rfc-editor.org/info/rfc8152>.
[SAM] "Information technology - Software asset management - Part [SAM] "Information technology - Software asset management - Part
5: Overview and vocabulary", ISO/IEC 19770-5:2013, 5: Overview and vocabulary", ISO/IEC 19770-5:2013,
November 2013. November 2013.
[SWID] "Information technology - Software asset management - Part [SWID] "Information technology - Software asset management - Part
2: Software identification tag'", ISO/IEC 19770-2:2015, 2: Software identification tag'", ISO/IEC 19770-2:2015,
October 2015. October 2015.
[X.1520] "Recommendation ITU-T X.1520 (2014), Common [X.1520] "Recommendation ITU-T X.1520 (2014), Common
skipping to change at page 13, line 33 skipping to change at page 13, line 37
[I-D.banghart-sacm-rolie-softwaredescriptor] [I-D.banghart-sacm-rolie-softwaredescriptor]
Waltermire, D. and S. Banghart, "Definition of the ROLIE Waltermire, D. and S. Banghart, "Definition of the ROLIE
Software Descriptor Extension", draft-banghart-sacm-rolie- Software Descriptor Extension", draft-banghart-sacm-rolie-
softwaredescriptor-01 (work in progress), May 2017. softwaredescriptor-01 (work in progress), May 2017.
[I-D.birkholz-tuda] [I-D.birkholz-tuda]
Fuchs, A., Birkholz, H., McDonald, I., and C. Bormann, Fuchs, A., Birkholz, H., McDonald, I., and C. Bormann,
"Time-Based Uni-Directional Attestation", draft-birkholz- "Time-Based Uni-Directional Attestation", draft-birkholz-
tuda-04 (work in progress), March 2017. tuda-04 (work in progress), March 2017.
[I-D.greevenbosch-appsawg-cbor-cddl] [I-D.ietf-cbor-cddl]
Birkholz, H., Vigano, C., and C. Bormann, "CBOR data Birkholz, H., Vigano, C., and C. Bormann, "Concise data
definition language (CDDL): a notational convention to definition language (CDDL): a notational convention to
express CBOR data structures", draft-greevenbosch-appsawg- express CBOR data structures", draft-ietf-cbor-cddl-00
cbor-cddl-10 (work in progress), March 2017. (work in progress), July 2017.
[I-D.ietf-sacm-terminology] [I-D.ietf-sacm-terminology]
Birkholz, H., Lu, J., Strassner, J., and N. Cam-Winget, Birkholz, H., Lu, J., Strassner, J., Cam-Winget, N., and
"Security Automation and Continuous Monitoring (SACM) A. Montville, "Security Automation and Continuous
Terminology", draft-ietf-sacm-terminology-12 (work in Monitoring (SACM) Terminology", draft-ietf-sacm-
progress), March 2017. terminology-14 (work in progress), December 2017.
Appendix A. Explicit file-hash Type Used in Concise SWID Tags (label Appendix A. Explicit file-hash Type Used in Concise SWID Tags (label
56) 56)
CoSWID add explicit support for the representation of file-hashes CoSWID add explicit support for the representation of file-hashes
using algorithms that are registered at the Named Information Hash using algorithms that are registered at the Named Information Hash
Algorithm Registry via the file-hash member (label 56). Algorithm Registry via the file-hash member (label 56).
file-hash = (56: [ hash-alg-id: int, hash-value: bstr ] ) file-hash = (56: [ hash-alg-id: int, hash-value: bstr ] )
The number used as a value for hash-alg-id MUST refer the ID in the The number used as a value for hash-alg-id MUST refer the ID in the
Named Information Hash Algorithm table; other hash algorithms MUST Named Information Hash Algorithm table; other hash algorithms MUST
NOT be used. The hash-value MUST represent the raw hash value of the NOT be used. The hash-value MUST represent the raw hash value of the
file-entry the file-hash type is included in. file-entry the file-hash type is included in.
Appendix B. CoSWID Attributes for Firmware (label 57) Appendix B. CoSWID Attributes for Firmware (label 57)
The ISO-19770-2:2015 specification of SWID tags assumes the existence The ISO-19770-2:2015 specification of SWID tags assumes the existence
of a file system a software component is installed and stored in. In of a file system a software component is installed and stored in. In
the case of constrained-node networks [RFC7228] or network equipment the case of constrained-node networks [RFC7228] or network equipment
skipping to change at page 15, line 18 skipping to change at page 15, line 20
firmware = { firmware = {
firmware-name, ; inherited from RFC4108 firmware-name, ; inherited from RFC4108
? firmware-version, ? firmware-version,
? firmware-package-identifier, ; inherited from RFC4108 ? firmware-package-identifier, ; inherited from RFC4108
? dependency, ; inherited from RFC4108 ? dependency, ; inherited from RFC4108
? component-index, ; equivalent to RFC4108 fwPkgType ? component-index, ; equivalent to RFC4108 fwPkgType
? block-device-identifier, ? block-device-identifier,
? target-hardware-identifier, ; an RFC4108 alternative to model-label ? target-hardware-identifier, ; an RFC4108 alternative to model-label
model-label, model-label,
? firmware-hash, ; a hash for a single, incl. NI hash-algo index ? firmware-hash, ; a hash for a single, incl. NI hash-algo index
? cms-firmware-package, ; RCF4108, experimental, this is an actual firmware blob! ? firmware-package, ; RCF4108, experimental, this is an actual firmware blob!
} }
firmware-entry = (57: firmware / [ 2* firmware ]) firmware-entry = (57: firmware / [ 2* firmware ])
firmware-hash = (58: [ hash-alg-id: int, firmware-hash = (58: [ hash-alg-id: int,
hash-value: bstr, hash-value: bstr,
] ]
) )
firmware-name = (59 : text) firmware-name = (59 : text)
firmware-version = (60 : text / int) firmware-version = (60 : text / int)
component-index = (61 : int) component-index = (61 : int)
model-label = (62: text / int) model-label = (62: text / int)
block-device-identifier = (63 : text / int) block-device-identifier = (63 : text / int)
cms-firmware-package = (64: bstr) firmware-package = (64: bstr)
firmware-package-identifier = (65: text) firmware-package-identifier = (65: text)
target-hardware-identifier = (66: text) target-hardware-identifier = (66: text)
dependency = (67: { ? firmware-name, dependency = (67: { ? firmware-name,
? firmware-version, ? firmware-version,
? firmware-package-identifier, ? firmware-package-identifier,
} }
) )
<CODE ENDS> <CODE ENDS>
The members of the firmware group that constitutes the content of the The members of the firmware group that constitutes the content of the
skipping to change at page 16, line 26 skipping to change at page 16, line 31
In general, tags are signed by the tag creator (typically, although In general, tags are signed by the tag creator (typically, although
not exclusively, the vendor of the software product that the SWID tag not exclusively, the vendor of the software product that the SWID tag
identifies). Cryptographic signatures can make any modification of identifies). Cryptographic signatures can make any modification of
the tag detectable, which is especially important if the integrity of the tag detectable, which is especially important if the integrity of
the tag is important, such as when the tag is providing reference the tag is important, such as when the tag is providing reference
integrity measurments for files. integrity measurments for files.
The ISO-19770-2:2015 XML schema uses XML DSIG to support The ISO-19770-2:2015 XML schema uses XML DSIG to support
cryptographic signatures. CoSWID tags require a different signature cryptographic signatures. CoSWID tags require a different signature
scheme than this. COSE (CBOR Object Signing and Encryption) provides scheme than this. COSE (CBOR Object Signing and Encryption) provides
the required mechanism [I-D.ietf-cose-msg]. Concise SWID can be the required mechanism [RFC8152]. Concise SWID can be wrapped in a
wrapped in a COSE Single Signer Data Object (cose-sign1) that COSE Single Signer Data Object (cose-sign1) that contains a single
contains a single signature. The following CDDL defines a more signature. The following CDDL defines a more restrictive subset of
restrictive subset of header attributes allowed by COSE tailored to header attributes allowed by COSE tailored to suit the requirements
suit the requirements of Concise SWID. of Concise SWID.
<CODE BEGINS> <CODE BEGINS>
signed-coswid = #6.997(COSE-Sign1-coswid) ; see TBS7 in current COSE I-D signed-coswid = #6.997(COSE-Sign1-coswid) ; see TBS7 in current COSE I-D
label = int / tstr ; see COSE I-D 1.4. label = int / tstr ; see COSE I-D 1.4.
values = any ; see COSE I-D 1.4. values = any ; see COSE I-D 1.4.
unprotected-signed-coswid-header = { unprotected-signed-coswid-header = {
1 => int, ; algorithm identifier 1 => int, ; algorithm identifier
3 => "application/coswid", ; request for CoAP IANA registry to become an int 3 => "application/coswid", ; request for CoAP IANA registry to become an int
skipping to change at page 18, line 23 skipping to change at page 18, line 23
in the corresponding CoSWID tag. The absolute path of an evidence in the corresponding CoSWID tag. The absolute path of an evidence
CoSWID tag can be included as a claim in the header of a CBOR Web CoSWID tag can be included as a claim in the header of a CBOR Web
Token [I-D.ietf-ace-cbor-web-token]. Depending on the source of the Token [I-D.ietf-ace-cbor-web-token]. Depending on the source of the
token, the claim can be in the protected or unprotected header token, the claim can be in the protected or unprotected header
portion. portion.
<CODE BEGINS> <CODE BEGINS>
CDDL TBD CDDL TBD
<CODE ENDS> <CODE ENDS>
Appendix F. Group Definitions
These groups are intermediate CDDL data definitions that are reused
in several items in the CoSWID CDDL data definition.
o resource-collection group: A list of items both used in evidence
(discovered by an inventory process) and payload (installed in a
system entity) content of a CoSWID tag document to structure and
differentiate the content of specific CoSWID tag types. Potential
content includes directories, files, processes, resources or
firmwares.
o filesystem group: A list of items both used in representing the
nodes of a file-system hierarchy, i.e. directory items that allow
one or more directories to be defined in the file structure, and
file items that allow one or more files to be specified for a
given location.
o global-attributes: A list of items including an optional language
definition to support the processing of text-string values and an
unbounded set of any-attribute items.
o any-attribute: A specific rule providing a restricted frame to
include arbitrary information via members that constitute key
value(s) pairs where both keys and values can be integers or text-
strings.
Appendix G. Item Definitions
This Appendix includes the description of every primitive and non-
primitive type the concise-software-identifier is composed of. Every
integer label included at the end of the CDDL data definition is
addressed in this section.
1. tag-id: An identifier uniquely referencing a (composite)
software component. The tag identifier is intended to be
globally unique. There are no strict guidelines on how this
identifier is structured, but examples include a 16 byte GUID
(e.g. class 4 UUID).
2. swid-name: This item provides the software component name as it
would typically be referenced. For example, what would be seen
in the add/remove dialog on a Windows device, or what is
specified as the name of a packaged software product or a patch
identifier name on a Linux device.
3. entity: Specifies the organizations related to the software
component referenced by this CoSWID tag.
4. evidence: This item is used to provide results from a scan of a
system where software that does not have a CoSWID tag is
discovered. This information is not provided by the software-
creator, and is instead created when a system is being scanned
and the evidence for why software is believed to be installed on
the device is provided in the evidence item.
5. link: A reference to any another item (can include details that
are related to the CoSWID tag such as details on where specific
resources can be found, e.g. vulnerability database
associations, ROLIE feeds, MUD files, etc). This is modeled
directly to match the HTML [LINK] element; it is critical for
streamlining software discovery scenarios to ensure their
consistency.
6. software-meta: An open-ended collection of key/value data
related to this CoSWID. The attributes included in this Element
are predefined attributes to ensure common usage across the
industry. The schema allows for any additional attribute to be
included in a CoSWID tag, though it is recommended that industry
norms for new attributes are defined and followed to the degree
possible.
7. payload: The items that may be installed on a system entity when
the software component is installed. Note that payload may be a
superset of the items installed and - depending on optimization
mechanisms in respect to that system entity - may or may not
include every item that could be created or executed on the
corresponding system entitiy when software components are
installed. In general, payload will be used to indicate the
files that may be installed with a software component.
Therefore payload will often be a superset of those files (i.e.
if a particular optional sub-component is not installed, the
files associated with that software component may be included in
payload, but not installed in the system entity).
8. any-element: A default map that can contain arbitrary map
members and even nested maps (which would be also any-elements).
In essence, the any-element allows items not defined in this
CDDL data definition to be included in a Concise Software
Identifier.
9. corpus: Set to true, if this attribute specifies that this SWID
tag is a collection of information that describes the pre-
installation data of software component.
10. patch: A set of files that is intended to modify an existing set
of files (including configuration files, scripts and
corresponding environment variables that are create by the OS
for the runtime environment) that composes a software component.
A software component patch does neither alter the version number
(see 13) nor the release details (descriptive english text, see
44) of a software components. [revision 52?]. If a Concise SWID
tag is a patch, it MUST contain the patch item and its value
MUST be set to true. It is recommended but not required to
include a rel(ation) item in a patch CoSWID. If a CoSWID
includes a patch member, but not a rel member, it is implied
that it SHOULD be installed independently of any other CoSWID
tag document - even if an effective but not explicit
relationship exists.
11. media: This text value is a hint to the tag consumer to
understand what this SWID tag applies to. This item can also be
included in the link item to represent a attributes defined by
the W3C Media Queries Recommendation (see http://www.w3.org/TR/
css3-mediaqueries/). A hint to the consumer of the link to what
the target item is applicable for.
12. supplemental: Specifies that this tag provides supplemental tag
data that can be merged with primary tag data to create a
complete record of the software information. Supplemental tags
will often be provided at install time and may be provided by
different entities (such as the tag consumer, or a Value Added
Reseller).
13. tag-version: This item indicates if a specific release of a
software component has more than one tag that can represent that
specific release. This may be the case if a CoSWID tag producer
creates and releases an incorrect tag that they subsequently
want to fix, but with no underlying changes to the product the
CoSWID tag represents. This could happen if, for example, a
patch is distributed that has a link reference that does not
cover all the various software releases it can patch. A newer
CoSWID tag for that patch can be generated and the tag-version
value incremented to indicate that the data is updated.
14. software-version: Underlying development version for the
software component.
15. version-scheme: Scheme used for the version number. Valid
enumerations are : * alphanumeric: strictly a string, sorting
alphanumerically * decimal: a floating point number (i.e., 1.25
is less than 1.3 ) * multipartnumeric: numbers separated via
dots, where the numbers are * interpreted as integers (ie, 1.2.3
, 1.4.5.6 , 1.2.3.4.5.6.7). This string * convention is similar
to OIDs. * multipartnumeric+suffix: numbers separated via dots,
where the numbers are * interpreted as integers with an
additional string suffix (e.g., 1.2.3a). * semver: a string as
defined by the semver.org spec [FiXME: reference] * unknown: the
last resort choice, no attempt should be made to order these
16. lang: An RFC5646 conferment language tag or corresponding IANA
index integer.
17. directory: A directory item allows one or more directories to be
defined in the file structure.
18. file: A file element that allows one or more files to be
specified for a given location.
19. process: Provides process (software component in execution)
information for data that will show up in a devices process
table.
20. resource: A set of items that can be used to provide arbitrary
resource information about an application installed on a system
entity, or evidence collected from a system entity.
21. size: The file size in bytes of the file.
22. file-version The file version.
23. key: Files that are considered important or required for the use
of a software component. Typical key files would be those
which, if not available on a system entity, would cause the
software component not to execute or function properly. Key
files will typically be used to validate that a software
component referenced by the CoSWID tag document is actually
installed on a specific system entity.
24. location: The directory or location where a file was found or
can expected to be located. This text-string is intended to
include the filename itself. This SHOULD be the relative path
represented by the root item.
25. fs-name: The file name or directory name without any path
characters.
26. root: A system-specific root folder that the location item is an
offset from. If this is not specified the assumption is the
root is the same folder as the location of the CoSWID tag. The
text-string value represents a path expression relative to the
CoSWID tag document location in the (composite) file-system
hierarchy.
27. path-elements: Provides the ability to apply a directory
structure to the path expressions for files defined in a payload
or evidence item.
28. process-name: The process name as it will be found in the system
entity's process table.
29. pid: The process ID for the process in execution that can be
included in the process item as part of an evidence tag.
30. type: The type of resource represented via a text-string
(typically, registry-key, port or root-uri)
31. extended-data: An open-ended collection of elements that can be
used to attach arbitrary metadata to an entity item.
32. entity-name: The text-string name of the organization claiming a
particular role in the CoSWID tag.
33. reg-id: The registration id is intended to uniquely identify a
naming authority in a given scope (e.g. global, organization,
vendor, customer, administrative domain, etc.) that is implied
by the referenced naming authority. The value of an
registration ID MUST be a RFC 3986 URI. The scope SHOULD be the
scope of an organization. In a given scope, the registration id
MUST be used consistently.
34. role: The relationship between this organization and this tag.
The role of tag creator is required for every CoSWID tag. The
role of an entity may include any role value, but the per-
defined roles include: "aggregator", "distributor", "licensor",
"software-creator", "tag-creator". The enumerations of this
will include a request to IANA in order to be reference-able via
an integer index.
35. thumbprint: This value provides a hexadecimal string that
contains a hash (i.e. the thumbprint) of the signing entities
certificate [s] [FIXME: this requires the same structure as
file-hash?].
36. date: The sate and time evidence represented by an evidence item
was gathered.
37. device-id: A text-string identifier for a device evidence was
gathered from.
38. artifact: For installation media (rel="installation-media") -
dictates the canonical name for the file. Items with the same
artifact name should be considered mirrors of each other (so
download from wherever works).
39. href: The link to the item being referenced. The href can point
to several different things, and can be any of the following: *
a relative uri (no scheme), which is interpreted depending on
context (for example, "./folder/supplemental.coswid") * a
physical file location with any system-acceptable URI scheme
(e.g., file:// http:// https:// ftp://) * an URI with "coswid:"
as the scheme, which refers to another CoSWID by tag-id. This
URI would need to be resolved in the context of the system by
software that can lookup other CoSWID tags (for example, *
"coswid:2df9de35-0aff-4a86-ace6-f7dddd1ade4c"). an URI with
"swidpath:" as the scheme, which refers to another CoSIWD via an
XPATH query. This URI would need to be resolved in the context
of the system entity via dedicated software components that can
lookup other CoSWID tags and select the appropriate tag based on
an XPATH query. Examples include: *
swidpath://SoftwareIdentity[Entity/@regid='http://contoso.com']
would * retrieve all CoSWID tags that include an entity where
the regid was * "Contoso". * swidpath://SoftwareIdentity[Meta/@
persistentId='b0c55172-38e9-4e36-be86-92206ad8eddb'] * would
retrieve CoSWID tags that matched the persistent-id. See XPATH
query standard : http://www.w3.org/TR/xpath20/ [FIXME: Concise
XPATH representation is covered in the YANG-CBOR I-D]
40. ownership: Determines the relative strength of ownership of the
software components. Valid enumerations are: abandon, private,
shared
41. rel: The relationship between this CoSWID and the target file.
Relationships can be identified by referencing the IANA
registration library: https://www.iana.org/assignments/link-
relations/link-relations.xhtml.
42. media-type: The IANA MediaType for the target file; this
provides the consumer with intelligence of what to expect. See
http://www.iana.org/assignments/media-types/media-types.xhtml
for more details on link type.
43. use: Determines if the target software is a hard requirement or
not. Valid enumerations are: required, recommended, optional,
44. activation-status: Identification of the activation status of
this software title (e.g. Trial, Serialized, Licensed,
Unlicensed, etc). Typically, this is used in supplemental tags.
45. channel-type: Provides information on which channel this
particular software was targeted for (e.g. Volume, Retail, OEM,
Academic, etc). Typically used in supplemental tags.
46. colloquial-version: The informal or colloquial version of the
product (i.e. 2013). Note that this version may be the same
through multiple releases of a software product where the
version specified in entity is much more specific and will
change for each software release. Note that this representation
of version is typically used to identify a group of specific
software releases that are part of the same release/support
infrastructure (i.e. Fabrikam Office 2013). This version is
used for string comparisons only and is not compared to be an
earlier or later release (that is done via the entity version
[FIXME: consistency).
47. description: A longer, detailed description of the software.
This description can be multiple sentences (differentiated from
summary, which is a very short, one-sentence description).
48. edition: The variation of the product (Extended, Enterprise,
Professional, Standard etc).
49. entitlement-data-required: An indicator to determine if there
should be accompanying proof of entitlement when a software
license reconciliation is completed.
50. entitlement-key: A vendor-specific textual key that can be used
to reconcile the validity of an entitlement. (e.g. serial
number, product or license key).
51. generator: The name of the software tool that created a CoSWID
tag. This item is typically used if tags are created on the fly
or via a catalog-based analysis for data found on a computing
device.
52. persistent-id: A GUID used to represent products installed where
the product are related, but may be different versions. For
example, an "upgradeCode" (see http://msdn.microsoft.com/en-
us/library/aa372375(v=vs.85).aspx as an reference for this
example).
53. product: The base name of the product (e.g. [FIXME: what are
appropriate examples?].
54. product-family: The overall product family this software belongs
to. Product family is not used to identify that a product is
part of a suite, but is instead used when a set of products that
are all related may be installed on multiple different devices.
For example, an enterprise backup system may consist of a backup
services, multiple different backup services that support mail
services, databases and ERP systems, as well as individual
software components that backup client system entities. In such
an usage scenario, all software components that are part of the
backup system would have the same product-family name so they
can be grouped together in respect to reporting systems.
55. revision: The informal or colloquial representation of the sub-
version of the given product (ie, SP1, R2, RC1, Beta 2, etc).
Note that the version will provide very exact version details,
the revision is intended for use in environments where reporting
on the informal or colloquial representation of the software is
important (for example, if for a certain business process, an
organization recognizes that it must have, for example
"ServicePack 1" or later of a specific product installed on all
devices, they can use the revision data value to quickly
identify any devices that do not meet this requirement).
Depending on how a software organizations distributes revisions,
this value could be specified in a primary (if distributed as an
upgrade) or supplemental (if distributed as a patch) CoSWID tag.
56. summary: A short (one-sentence) description of the software.
57. unspsc-code: An 8 digit code that provides UNSPSC classification
of the software product this SWID tag identifies. For more
information see, http://www.unspsc.org/.
58. unspsc-version: The version of the UNSPSC code used to define
the UNSPSC code value. For more information see,
http://www.unspsc.org/.
Authors' Addresses Authors' Addresses
Henk Birkholz Henk Birkholz
Fraunhofer SIT Fraunhofer SIT
Rheinstrasse 75 Rheinstrasse 75
Darmstadt 64295 Darmstadt 64295
Germany Germany
Email: henk.birkholz@sit.fraunhofer.de Email: henk.birkholz@sit.fraunhofer.de
 End of changes. 33 change blocks. 
85 lines changed or deleted 461 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/