Draft: draft-ietf-sacm-coswid

Commentary: Requesting changes posted as  be merged into this repo .
Paragraph (version A):
This document defines a concise representation of ISO 19770-2:2015
Software Identifiers (SWID tags) that is interoperable with the XML
schema definition of ISO 19770-2:2015 and augmented for application
in Constrained-Node Networks.  Next to the inherent capability of
SWID tags to express arbitrary context information, CoSWID support
the definition of additional semantics via well-defined data
definitions incorporated by extension points.
Paragraph (version B):
This document defines a concise representation of ISO/IEC
19770-2:2015 Software Identifiers (SWID tags) that is interoperable
with the XML schema definition of ISO/IEC 19770-2:2015 and augmented
for application in Constrained-Node Networks.  Next to the inherent
capability of SWID tags to express arbitrary context information,
CoSWID support the definition of additional semantics via well-
defined data definitions incorporated by extension points.
Paragraph (version A):
SWID tags, as defined in ISO-19770-2:2015 SWID, provide a
standardized format for a record that identifies and describes a
specific release of a software product.  Different software products,
and even different releases of a particular software product, each
have a different SWID tag record associated with them.  In addition
to defining the format of these records, ISO-19770-2:2015 defines
requirements concerning the SWID tag life-cycle.  Specifically, when
a software product is installed on an endpoint, that product's SWID
tag is also installed.  Likewise, when the product is uninstalled or
replaced, the SWID tag is deleted or replaced, as appropriate.  As a
result, ISO-19770-2:2015 describes a system wherein there is a
correspondence between the set of installed software products on an
endpoint, and the presence on that endpoint of the SWID tags
corresponding to those products.
Paragraph (version A):
SWID tags are meant to be flexible and able to express a broad set of
metadata about a software product.  Moreover, there are multiple
types of SWID tags, each providing different types of information.
For example, a "corpus tag" is used to describe an application's
installation image on an installation media, while a "patch tag" is
meant to describe a patch that modifies some other application.
While there are very few required fields in SWID tags, there are many
optional fields that support different uses of these different types
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
optional fields could be many orders of magnitude larger.
Paragraph (version A):
This document defines a more concise representation of SWID tags in
the Concise Binary Object Representation (CBOR) RFC7049.  This is
described via the Concise Data Definition Language (CDDL) I-
D.greevenbosch-appsawg-cbor-cddl.  The resulting Concise SWID data
definition is interoperable with the XML schema definition of ISO-
19770-2:2015 SWID.  The vocabulary, i.e., the CDDL names of the types
and members used in the CoSWID data definition, is mapped to more
concise labels represented as small integers.  The names used in the
CDDL data definition and the mapping to the CBOR representation using
integer labels is based on the vocabulary of the XML attribute and
element names defined in ISO-19770-2:2015.
Paragraph (version B):
SWID tags, as defined in ISO-19770-2:2015 SWID, provide a
standardized format for a record that identifies and describes a
specific release of a software component.  Different software
components, and even different releases of a particular software
component, each have a different SWID tag record associated with
them.  SWID tags are meant to be flexible and able to express a broad
set of metadata about a software component.
Paragraph (version A):
This document specifies a standard equivalent to the ISO-19770-2:2015
standard.  The corresponding CoSWID data definition includes two
kinds of augmentation.
Paragraph (version B):
In addition to defining the format of these records, ISO/IEC
19770-2:2015 defines requirements concerning the SWID tag life-cycle.
Specifically, when a software component is installed on an endpoint,
that product's SWID tag is also installed.  Likewise, when the
product is uninstalled or replaced, the SWID tag is deleted or
replaced, as appropriate.  As a result, ISO/IEC 19770-2:2015
describes a system wherein there is a correspondence between the set
of installed software products on an endpoint, and the presence on
that endpoint of the SWID tags corresponding to those products.
Paragraph (version B):
The following is an excerpt (with some modifications and reordering)
from NIST Interagency Report (NISTIR) 8060: Guidelines for the
Creation of Interoperable SWID Tags SWID-GUIDANCE, which describes
the tag types used within the lifecycle defined in ISO-19770-2:2015.
Paragraph (version B):
The SWID specification defines four types of SWID tags: primary,
patch, corpus, and supplemental.
Paragraph (version B):
Primary Tag - A SWID tag that identifies and describes a
software component is installed on a computing device.
Paragraph (version B):
Patch Tag - A SWID tag that identifies and describes an
installed patch which has made incremental changes to a
software component installed on a computing device.
Paragraph (version B):
Corpus Tag - A SWID tag that identifies and describes an
installable software component in its pre-installation state.
A corpus tag can be used to represent metadata about an
installation package or installer for a software component, a
software update, or a patch.
Paragraph (version B):
Supplemental Tag - A SWID tag that allows additional
information to be associated with a referenced SWID tag.  This
helps to ensure that SWID Primary and Patch Tags provided by a
software provider are not modified by software management
tools, while allowing these tools to provide their own software
metadata.
Paragraph (version B):
Corpus, primary, and patch tags have similar functions in that
they describe the existence and/or presence of different types of
software (e.g., software installers, software installations,
software patches), and, potentially, different states of software
components.  In contrast, supplemental tags furnish additional
information not contained in corpus, primary, or patch tags.  All
four tag types come into play at various points in the software
lifecycle, and support software management processes that depend
on the ability to accurately determine where each software
component is in its lifecycle.
Paragraph (version B):
The figure above illustrates the steps in the software lifecycle
and the relationships among those lifecycle events supported by
the four types of SWID tags, as follows: - Software Deployment.
Before the software component is installed (i.e., pre-
installation), and while the product is being deployed, a corpus
tag provides information about the installation files and
distribution media (e.g., CD/DVD, distribution package).  -
Software Installation.  A primary tag will be installed with the
software component (or subsequently created) to uniquely identify
and describe the software component.  Supplemental tags are
created to augment primary tags with additional site-specific or
extended information.  While not illustrated in the figure, patch
tags may also be installed during software installation to provide
information about software fixes deployed along with the base
software installation.  - Software Patching.  When a new patch is
applied to the software component, a new patch tag is provided,
supplying details about the patch and its dependencies.  While not
illustrated in the figure, a corpus tag can also provide
information about the patch installer, and patching dependencies
that need to be installed before the patch.  - Software Upgrading.
As a software component is upgraded to a new version, new primary
and supplemental tags replace existing tags, enabling timely and
accurate tracking of updates to software inventory.  While not
illustrated in the figure, a corpus tag can also provide
information about the upgrade installer, and dependencies that
need to be installed before the upgrade.  - Software Removal.
Upon removal of the software component, relevant SWID tags are
removed.  This removal event can trigger timely updates to
software inventory reflecting the removal of the product and any
associated patch or supplemental tags.
Paragraph (version B):
Note: While not fully illustrated in the figure, supplemental tags
can be associated with any corpus, primary, or patch tag to provide
additional metadata about an installer, installed software, or
installed patch respectively.
Paragraph (version B):
Each of the different SWID tag types of SWID tags provide different
types of information.  For example, a "corpus tag" is used to
describe an application's installation image on an installation
media, while a "patch tag" is meant to describe a patch that modifies
some other application.  While there are very few required fields in
SWID tags, there are many optional fields that support different uses
of these different types 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 optional fields could be many orders of
magnitude larger.
Paragraph (version B):
This document defines a more concise representation of SWID tags in
the Concise Binary Object Representation (CBOR) RFC7049.  This is
described via the Concise Data Definition Language (CDDL) I-
D.greevenbosch-appsawg-cbor-cddl.  The resulting Concise SWID data
definition is interoperable with the XML schema definition of ISO-
19770-2:2015 SWID.  The vocabulary, i.e., the CDDL names of the types
and members used in the CoSWID data definition, is mapped to more
concise labels represented as small integers.  The names used in the
CDDL data definition and the mapping to the CBOR representation using
integer labels is based on the vocabulary of the XML attribute and
element names defined in ISO/IEC 19770-2:2015.
Paragraph (version B):
This document specifies a standardized equivalent to the ISO-
19770-2:2015 standard.  The corresponding CoSWID data definition
includes two kinds of augmentation.
Paragraph (version A):
The following is a CDDL representation of the ISO-19770-2:2015 SWID
XML schema definition of SWID tags.  This representation includes
every SWID tag fields and attribute and thus supports all SWID tag
use cases.  The CamelCase notation used in the XML schema definition
is changed to a hyphen-separated notation (e.g.  ResourceCollection
is named resource-collection in the CoSWID data definition).  This
deviation from the original notation used in the XML representation
reduces ambiguity when referencing certain attributes in
corresponding textual descriptions.  An attribute referred by its
name in CamelCase notation explicitly relates to XML SWID tags, an
attribute referred by its name in hyphen-separated notation
explicitly relates to CoSWID tags.  This approach simplifies the
composition of further work that reference both XML SWID and CoSWID
documents.
Paragraph (version A):
Human-readable names of members in the CDDL data definition are
mapped to integer indices via a block of rules at the bottom of the
definition.  The 66 character strings of the SWID vocabulary that
would have to be stored or transported in full if using the original
vocabulary are replaced.
Paragraph (version B):
The following is a CDDL representation of the ISO/IEC 19770-2:2015
SWID XML schema definition of SWID tags.  This representation
includes every SWID tag field and attribute and thus supports all
SWID tag use cases.  The CamelCase notation used in the XML schema
definition is changed to a hyphen-separated notation (e.g.
ResourceCollection is named resource-collection in the CoSWID data
definition).  This deviation from the original notation used in the
XML representation reduces ambiguity when referencing certain
attributes in corresponding textual descriptions.  An attribute
referred by its name in CamelCase notation explicitly relates to XML
SWID tags, an attribute referred by its name in hyphen-separated
notation explicitly relates to CoSWID tags.  This approach simplifies
the composition of further work that reference both XML SWID and
CoSWID documents.
Paragraph (version B):
Human-readable names of members in the CDDL data definition are
mapped to integer indices via a block of rules at the bottom of the
definition.  The 67 character strings of the SWID vocabulary that
would have to be stored or transported in full if using the original
vocabulary are replaced.
Paragraph (version A):
Yet to be written still...
Paragraph (version B):
The following subsections describe the different parts of the CoSWID
model.
Paragraph (version B):
The items are ordered ensure that tag metadata appears first,
followed by general software metadata, entity information, link
relations, and finally payload or evidence data.  This ordering
attempts to provide the most significant metadata that a parser may
need first, followed by metadata that may support more specific use-
applications.  The following describes each child item of the
concise-software-identity model.
Paragraph (version B):
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.  Described in model-global-
attributes.
Paragraph (version B):
tag-id (label 0): An textual 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).
Paragraph (version B):
tag-version (label 12): An integer value that indicates if a
specific release of a software component has more than one tag
that can represent that specific release.  A typical use of this
field may be to set an initial value to 0 and to monotonically
increase the value for subsequent tags produced for the specific
release.  A change in the value of this field 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.
Paragraph (version B):
corpus (label 8): A boolean value that indicates if the tag
identifies and describes an installable software component in its
pre-installation state.  Installable software includes a
installation package or installer for a software component, a
software update, or a patch.  If the Concise SWID tag represents
installable software, the corpus item MUST be set to "true".  If
not provided the default value MUST be considered "false".
Paragraph (version B):
patch (label 9): A boolean value that indicates if the tag
identifies and describes an installed patch which has made
incremental changes to a software component installed on a
computing device.  Typically, an installed patch has made a set of
file modifications to pre-installed software, and does not alter
the version number or the descriptive metadata of an installed
software product.  If a Concise SWID tag is for a patch, it MUST
contain the patch item and its value MUST be set to "true".  If
not provided the default value MUST be considered "false".
Paragraph (version B):
supplemental (label 11): A boolean value that indicates if the tag
is providing additional information to be associated with another
referenced SWID tag.  Tags using this item help to ensure that
primary and patch tags provided by a software provider are not
modified by software management tools, while allowing these tools
to provide their own software metadata for a software component.
If a Concise SWID tag is a supplemntal tag, it MUST contain the
supplemental item and its value MUST be set to "true".  If not
provided the default value MUST be considered "false".
Paragraph (version B):
swid-name (label 1): This textual item provides the software
component name as it would typically be referenced.  For example,
what would be seen in the add/remove software dialog in an
operating system, or what is specified as the name of a packaged
software component or a patch identifier name.
Paragraph (version B):
software-version (label 13): A textual value representing the
specific underlying release or development version of the software
component.
Paragraph (version B):
version-scheme (label 14): An 8-bit integer or textual value
representing the versioning scheme used for the software-version
item.  If an integer value is used it MUST be a value from the
registry (see section iana-version-scheme or a value in the
private use range: 32768-65,535.
Paragraph (version B):
media (label 10): 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.
Paragraph (version B):
software-meta-entry (label 5): 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.  Described in model-software-meta.
Paragraph (version B):
entity-entry (label 2): Specifies the organizations related to the
software component referenced by this CoSWID tag.  Described in
model-entity.
Paragraph (version B):
link-entry (label 4): 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.  Described in model-link.
Paragraph (version B):
payload-entry (label 6): 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).  Described in
model-payload.
Paragraph (version B):
evidence-entry (label 3): 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.
Described in model-evidence.
Paragraph (version B):
any-element-entry (label 7): 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.  Described in model-any-element.
Paragraph (version B):
Primary Tag: A CoSWID tag MUST be considered a primary tag if the
corpus, patch, and supplemental items are "false".
Paragraph (version B):
Patch Tag: A CoSWID tag MUST be considered a patch tag if the
patch item is "true".
Paragraph (version B):
Corpus Tag: A CoSWID tag MUST be considered a corpus tag if the
corpus item is "true".
Paragraph (version B):
Supplemental Tag: A CoSWID tag MUST be considered a supplemental
tag if the supplemental item is set to "true".
Paragraph (version B):
If multiple of the corpus, patch, and supplemental items are "true",
then the containing tag MUST be considered an unsupported tag type.
Paragraph (version B):
If the patch does modify the version number or the descriptive
metadata of the software, then a new tag representing these details
SHOULD be installed, and the old tag SHOULD be removed.
Paragraph (version B):
Only one of the corpus, patch, and supplemental items MUST be set
to "true", or all of the corpus, patch, and supplemental items
MUST be set to "false" or be omitted.
Paragraph (version B):
If the patch item is set to "true", the the tag SHOULD contain at
least one link with the rel(ation) item value of "patches" and an
href item specifying an association with the software that was
patched.
Paragraph (version B):
If the supplemental item is set to "true", the the tag SHOULD
contain at least one link with the rel(ation) item value of
"suplements" and an href item specifying an association with the
software that is supplemented.
Paragraph (version B):
If all of the corpus, patch, and supplemental items are "false",
or if the corpus item is set to "true", then a software-version
item MUST be included with a value set to the version of the
software component.  This ensure that primary and corpus tags have
an identifiable software version.
Paragraph (version B):
The global-attributes group provides 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 allowing for
additional items to be provided as a general point of extension in
the model.
Paragraph (version B):
lang (index 15): A language tag or corresponding IANA index
integer that conforms with IANA Language Subtag Registry RFC5646.
Paragraph (version B):
any-attribute: This sub-group provides a means to include
arbitrary information via label (key) item value pairs where both
keys and values can be either a single integer or text string, or
an array of integers or text strings.
Paragraph (version B):
entity-name (index 32): The text-string name of the organization
claiming a particular role in the CoSWID tag.
Paragraph (version B):
reg-id (index 32): 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.
Paragraph (version B):
role (index 33): The relationship(s) 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.
Paragraph (version B):
thumbprint (index 34): This value provides a hexadecimal string
that contains a hash (i.e. the thumbprint) of the signing entities
certificate(s). .
Paragraph (version B):
extended-data (index 30): An open-ended collection of elements
that can be used to attach arbitrary metadata to an entity item.
Paragraph (version B):
artifact (index: 37): 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).
Paragraph (version B):
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,
Paragraph (version B):
swidpath://SoftwareIdentity[Entity/@regid='http://contoso.com']
would retrieve all CoSWID tags that include an entity where the
regid was "Contoso".
Paragraph (version B):
swidpath://SoftwareIdentity[Meta/@persistentId='b0c55172-38e9-
4e36-be86-92206ad8eddb'] would retrieve CoSWID tags that
matched the persistent-id.
Paragraph (version B):
media (index 10): See media defined in model-concise-software-
identity.
Paragraph (version B):
rel (index 40): 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.
Paragraph (version B):
media-type (index 41): 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.
Paragraph (version B):
use (index 42): Determines if the target software is a hard
requirement or not.  Valid enumerations are: required,
recommended, optional.
Paragraph (version B):
activation-status (index 43): Identification of the activation
status of this software title (e.g.  Trial, Serialized, Licensed,
Unlicensed, etc).  Typically, this is used in supplemental tags.
Paragraph (version B):
channel-type (index 44): Provides information on which channel
this particular software was targeted for (e.g.  Volume, Retail,
OEM, Academic, etc).  Typically used in supplemental tags.
Paragraph (version B):
colloquial-version (index 45): 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 component 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).
Paragraph (version B):
description (index 46): A longer, detailed description of the
software.  This description can be multiple sentences
(differentiated from summary, which is a very short, one-sentence
description).
Paragraph (version B):
edition (index 47): The variation of the product (Extended,
Enterprise, Professional, Standard etc).
Paragraph (version B):
entitlement-data-required (index 48): An indicator to determine if
there should be accompanying proof of entitlement when a software
license reconciliation is completed.
Paragraph (version B):
entitlement-key (index 49): A vendor-specific textual key that can
be used to reconcile the validity of an entitlement. (e.g. serial
number, product or license key).
Paragraph (version B):
generator (index 50): 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.
Paragraph (version B):
persistent-id (index 51): 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).
Paragraph (version B):
product (index 52): The base name of the product (e.g. ).
Paragraph (version B):
product-family (index 53): 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.
Paragraph (version B):
revision (index 54): 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.
Paragraph (version B):
summary (index 55): A short (one-sentence) description of the
software.
Paragraph (version B):
unspsc-code (index 56): An 8 digit code that provides UNSPSC
classification of the software component this SWID tag identifies.
For more information see, http://www.unspsc.org/.
Paragraph (version B):
unspsc-version (index 57): The version of the UNSPSC code used to
define the UNSPSC code value.  For more information see,
http://www.unspsc.org/.
Paragraph (version B):
CoSWID add explicit support for the representation of hash entries
using algorithms that are registered at the Named Information Hash
Algorithm Registry via the hash-entry member (label 58).
Paragraph (version B):
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
NOT be used.  The hash-value MUST represent the raw hash value of the
hashed resource generated using the hash algorithm indicated by the
hash-alg-id.
Paragraph (version B):
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.
Paragraph (version B):
The following describes each child item or group for these groups.
Paragraph (version B):
filesystem-item: 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.
Paragraph (version B):
directory-entry (index 16): A directory item allows one or more
directories to be defined in the file structure.
Paragraph (version B):
file-entry (index 17): A file element that allows one or more
files to be specified for a given location.
Paragraph (version B):
process-entry (index 18): Provides process (software component in
execution) information for data that will show up in a devices
process table.
Paragraph (version B):
resource-entry (index 19): 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.
Paragraph (version B):
size (index 20): The file size in bytes of the file.
Paragraph (version B):
file-version (index 21): The version of the file.
Paragraph (version B):
key (index 22): 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.
Paragraph (version B):
location (index 23): 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
from the location represented by the root item.
Paragraph (version B):
fs-name (index 24): The file name or directory name without any
path characters.
Paragraph (version B):
root (index 25): 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.
Paragraph (version B):
path-elements (index 26): Provides the ability to apply a
directory structure to the path expressions for files defined in a
payload or evidence item.
Paragraph (version B):
process-name (index 27): The process name as it will be found in
the system entity's process table.
Paragraph (version B):
pid (index 28): The process ID for the process in execution that
can be included in the process item as part of an evidence tag.
Paragraph (version B):
type (index 29): The type of resource represented via a text-
string (typically, registry-key, port or root-uri).
Paragraph (version B):
date (index 35): The date and time evidence represented by an
evidence item was gathered.
Paragraph (version B):
device-id (index 36): A text-string identifier for a device
evidence was gathered from.
Paragraph (version B):
The following are an initial set of values for use in the version-
scheme item for the version schemes defined in the ISO/IEC
19770-2:2015 SWID specification.  Index value in parens indicates the
index value to use in the version-scheme item.
Paragraph (version B):
The values above are registered in the "SWID/CoSWID Version Schema
Values" registry defined in section iana-version-scheme.  Additional
valid values will likely be registered over time in this registry.
Paragraph (version B):
The following table indicates the index value to use for the entity
roles defined in the ISO/IEC 19770-2:2015 SWID specification.
Paragraph (version B):
The values above are registered in the "SWID/CoSWID Entity Role
Values" registry defined in section iana-entity-role.  Additional
valid values will likely be registered over time.  Additionally, the
index values 226 through 255 have been reserved for private use.
Paragraph (version A):
SWID tags contain public information about software products and, as
such, do not need to be protected against disclosure on an endpoint.
Similarly, SWID tags are intended to be easily discoverable by
applications and users on an endpoint in order to make it easy to
identify and collect all of an endpoint's SWID tags.  As such, any
security considerations regarding SWID tags focus on the application
of SWID tags to address security challenges, and the possible
disclosure of the results of those applications.
Paragraph (version B):
This document has a number of IANA considerations, as described in
the following subsections.
Paragraph (version B):
This document uses unsigned 16-bit index values to version-scheme
item values.  The initial set of version-scheme values are derived
from the textual version scheme names defined in the ISO/IEC
19770-2:2015 specification SWID.
Paragraph (version B):
Initial registrations for the SWID/CoSWID Version Schema Values
registry are provided below.
Paragraph (version B):
This document uses unsigned 8-bit index values to represent entity-
role values.  The initial set of Entity roles are derived from the
textual role names defined in the ISO/IEC 19770-2:2015 specification
SWID.
Paragraph (version B):
Initial registrations for the SWID/CoSWID Entity Role Values registry
are provided below.
Paragraph (version B):
SWID tags contain public information about software components and,
as such, do not need to be protected against disclosure on an
endpoint.  Similarly, SWID tags are intended to be easily
discoverable by applications and users on an endpoint in order to
make it easy to identify and collect all of an endpoint's SWID tags.
As such, any security considerations regarding SWID tags focus on the
application of SWID tags to address security challenges, and the
possible disclosure of the results of those applications.
Paragraph (version A):
SWID tags are designed to be easily added and removed from an
endpoint along with the installation or removal of software products.
On endpoints where addition or removal of software products is
tightly controlled, the addition or removal of SWID tags can be
similarly controlled.  On more open systems, where many users can
manage the software inventory, SWID tags may be easier to add or
remove.  On such systems, it may be possible to add or remove SWID
tags in a way that does not reflect the actual presence or absence of
corresponding software products.  Similarly, not all software
products automatically install SWID tags, so products may be present
on an endpoint without providing a corresponding SWID tag.  As such,
any collection of SWID tags cannot automatically be assumed to
represent either a complete or fully accurate representation of the
software inventory of the endpoint.  However, especially on devices
that more strictly control the ability to add or remove applications,
SWID tags are an easy way to provide an preliminary understanding of
that endpoint's software inventory.
Paragraph (version B):
SWID tags are designed to be easily added and removed from an
endpoint along with the installation or removal of software
components.  On endpoints where addition or removal of software
components is tightly controlled, the addition or removal of SWID
tags can be similarly controlled.  On more open systems, where many
users can manage the software inventory, SWID tags may be easier to
add or remove.  On such systems, it may be possible to add or remove
SWID tags in a way that does not reflect the actual presence or
absence of corresponding software components.  Similarly, not all
software products automatically install SWID tags, so products may be
present on an endpoint without providing a corresponding SWID tag.
As such, any collection of SWID tags cannot automatically be assumed
to represent either a complete or fully accurate representation of
the software inventory of the endpoint.  However, especially on
devices that more strictly control the ability to add or remove
applications, SWID tags are an easy way to provide an preliminary
understanding of that endpoint's software inventory.
Paragraph (version B):
Added a section describing the CoSWID model in detail.
Paragraph (version B):
Updated references for COSE, CBOR Web Token, and CDDL.
Paragraph (version B):
Changes meta handling in CDDL from use of an explicit use of items
to a more flexible unconstrained collection of items.