Concise Software IdentifiersFraunhofer SITRheinstrasse 75Darmstadt64295Germanyhenk.birkholz@sit.fraunhofer.deDepartment of Defense9800 Savage RoadFt. MeadeMarylandUSAjmfitz2@nsa.govThe MITRE Corporation202 Burlington RoadBedfordMaryland01730USAcmschmidt@mitre.orgNational Institute of Standards and Technology100 Bureau DriveGaithersburgMaryland20877USAdavid.waltermire@nist.gov
Security
SACM Working GroupInternet-DraftThis 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.SWID tags have several use-applications including but not limited to:Software Inventory Management, a part of the Software Asset Management
process, which requires an accurate list of discernible deployed software
components.Vulnerability Assessment, which requires a semantic link between standardized
vulnerability descriptions and IT-assets .Remote Attestation, which requires a link between reference integrity
measurements (RIM) and security logs of measured software components
.SWID tags, as defined in ISO-19770-2:2015 , 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.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.This document defines a more concise representation of SWID tags in the Concise
Binary Object Representation (CBOR) . This is described via the Concise
Data Definition Language (CDDL) . The resulting Concise SWID data
definition is interoperable with the XML schema definition of ISO-19770-2:2015
. 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.Real-world instances of SWID tags can be fairly large, and the communication of
SWID tags in use-applications such as those described earlier can cause a large
amount of data to be transported. This can be larger than acceptable for
constrained devices and networks. CoSWID tags significantly reduce the amount of
data transported as compared to a typical SWID tag. This reduction is enable
through the use of CBOR, which maps human-readable labels of that content to
more concise integer labels (indices). This allows SWID tags to be part of an
enterprise security solution for a wider range of endpoints and environments.This document specifies a standard equivalent to the ISO-19770-2:2015 standard.
The corresponding CoSWID data definition includes two kinds of augmentation.the explicit definition of types for attributes that are typically stored in
the “any attribute” of an ISO-19770-2:2015 in XML representation. These are
covered in the main body of this document.the inclusion of extension points in the CoSWID data definition that allow for
additional uses of CoSWID tags that go beyond the original scope of
ISO-19770-2:2015 tags. These are covered in appendices to this document.The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and
“OPTIONAL” in this document are to be interpreted as described in RFC
2119, BCP 14 .The following is a CDDL representation of the ISO-19770-2:2015 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.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.Concise Software Identifiers are tailored to be used in the domain of constrained-node networks. A
typical endpoint is capable of storing the CoSWID tag of installed software, a constrained-node
might lack that capability. CoSWID address these constraints and the corresponding specification is
augmented to retain their usefulness in the thing-2-thing domain. Specific examples include, but are
not limited to limiting the scope of hash algorithms to the IANA Named Information tables or
including firmware attributes addressing devices that do not necessarily provide a file-system to
store a CoSWID tag in.In order to create a valid CoSWID document the structure of the corresponding CBOR message MUST
adhere to the following CDDL data definition.Yet to be written still…This document will include requests to IANA:Integer indices for SWID content attributes and information elements.Content-Type for CoAP to be used in COSE.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.A signed SWID tag whose signature is intact can be relied upon to be
unchanged since it was signed. If the SWID tag was created by the
software author, this generally means that it has undergone no change
since the software application with which the tag is associated was
installed. By implication, this means that the signed tag reflects
the software author’s understanding of the details of that software
product. This can be useful assurance when the information in the
tag needs to be trusted, such as when the tag is being used to convey
golden measurements. By contrast, the data contained in unsigned
tags cannot be trusted to be unmodified.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.Any report of an endpoint’s SWID tag collection provides
information about the software inventory of that endpoint. If such a
report is exposed to an attacker, this can tell them which software
products and versions thereof are present on the endpoint. By
examining this list, the attacker might learn of the presence of
applications that are vulnerable to certain types of attacks. As
noted earlier, SWID tags are designed to be easily discoverable by an
endpoint, but this does not present a significant risk since an
attacker would already need to have access to the endpoint to view
that information. However, when the endpoint transmits its software
inventory to another party, or that inventory is stored on a server
for later analysis, this can potentially expose this information to
attackers who do not yet have access to the endpoint. As such, it is
important to protect the confidentiality of SWID tag information that
has been collected from an endpoint, not because those tags
individually contain sensitive information, but because the
collection of SWID tags and their association with an endpoint
reveals information about that endpoint’s attack surface.Finally, both the ISO-19770-2:2015 XML schema definition and the
Concise SWID data definition allow for the construction of “infinite”
SWID tags or SWID tags that contain malicious content with the intend
if creating non-deterministic states during validation or processing of SWID tags. While software
product vendors are unlikely to do this, SWID tags can be created by any party and the SWID tags
collected from an endpoint could contain a mixture of vendor and non-vendor created tags. For this
reason, tools that consume SWID tags ought to treat the tag contents as potentially malicious and
should employ input sanitizing on the tags they ingest.Changes from version 00 to version 01:Added CWT usage for absolute SWID paths on a deviceFixed cardinality of type-choices including arraysIncluded first iteration of firmware resource-collectionChanges since adopted as a WG I-D -00:Removed redundant any-attributes originating from the ISO-19770-2:2015 XML schema definitionFixed broken multi-map membersIntroduced a more restrictive item (any-element-map) to represent custom maps, increased restriction on types for the any-attribute, accordinglyFixed X.1520 referenceMinor type changes of some attributes (e.g. NMTOKENS)Added semantic differentiation of various name types (e,g. fs-name)Changes from version 00 to version 01:Ambiguity between evidence and payload eliminated by introducing explicit members (while stillallowing for “empty” SWID tags)Added a relatively restrictive COSE envelope using cose_sign1 to define signed CoSWID (single signer only, at the moment)Added a definition how to encode hashes that can be stored in the any-member using existing IANA tables to reference hash-algorithmsChanges from version 01 to version 02:Enforced a more strict separation between the core CoSWID definition and additional usage by
moving content to corresponding appendices.Removed artifacts inherited from the reference schema provided by ISO (e.g. NMTOKEN(S))Simplified the core data definition by removing group and type choices where possibleMinor reordering of map membersAdded a first extension point to address requested flexibility for extensions beyond the
any-elementKey words for use in RFCs to Indicate Requirement LevelsIn many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.Using Cryptographic Message Syntax (CMS) to Protect Firmware PackagesThis document describes the use of the Cryptographic Message Syntax (CMS) to protect firmware packages, which provide object code for one or more hardware module components. CMS is specified in RFC 3852. A digital signature is used to protect the firmware package from undetected modification and to provide data origin authentication. Encryption is optionally used to protect the firmware package from disclosure, and compression is optionally used to reduce the size of the protected firmware package. A firmware package loading receipt can optionally be generated to acknowledge the successful loading of a firmware package. Similarly, a firmware package load error report can optionally be generated to convey the failure to load a firmware package. [STANDARDS-TRACK]Concise Binary Object Representation (CBOR)The Concise Binary Object Representation (CBOR) is a data format whose design goals include the possibility of extremely small code size, fairly small message size, and extensibility without the need for version negotiation. These design goals make it different from earlier binary serializations such as ASN.1 and MessagePack.Internet Security Glossary, Version 2This Glossary provides definitions, abbreviations, and explanations of terminology for information system security. The 334 pages of entries offer recommendations to improve the comprehensibility of written material that is generated in the Internet Standards Process (RFC 2026). The recommendations follow the principles that such writing should (a) use the same term or definition whenever the same concept is mentioned; (b) use terms in their plainest, dictionary sense; (c) use terms that are already well-established in open publications; and (d) avoid terms that either favor a particular vendor or favor a particular technology or mechanism over other, competing techniques that already exist or could be developed. This memo provides information for the Internet community.Terminology for Constrained-Node NetworksThe Internet Protocol Suite is increasingly used on small devices with severe constraints on power, memory, and processing resources, creating constrained-node networks. This document provides a number of basic terms that have been useful in the standardization work for constrained-node networks.Recommendation ITU-T X.1520 (2014), Common vulnerabilities and exposuresInformation technology - Software asset management - Part 5: Overview and vocabularyInformation technology - Software asset management - Part 2: Software identification tag'CBOR Object Signing and Encryption (COSE)Concise Binary Object Representation (CBOR) is a data format designed for small code size and small message size. There is a need for the ability to have basic security services defined for this data format. This document defines the CBOR Object Signing and Encryption (COSE) protocol. This specification describes how to create and process signatures, message authentication codes, and encryption using CBOR for serialization. This specification additionally describes how to represent cryptographic keys using CBOR.CBOR Web Token (CWT)CBOR Web Token (CWT) is a compact means of representing claims to be transferred between two parties. The claims in a CWT are encoded in the Concise Binary Object Representation (CBOR) and CBOR Object Signing and Encryption (COSE) is used for added application layer security protection. A claim is a piece of information asserted about a subject and is represented as a name/value pair consisting of a claim name and a claim value. CWT is derived from JSON Web Token (JWT) but uses CBOR rather than JSON.Concise data definition language (CDDL): a notational convention to express CBOR data structuresThis document proposes a notational convention to express CBOR data structures (RFC 7049). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR.Time-Based Uni-Directional AttestationThis memo documents the method and bindings used to conduct time- based uni-directional attestation between distinguishable endpoints over the network.Definition of the ROLIE Software Descriptor ExtensionThis document extends the Resource-Oriented Lightweight Information Exchange (ROLIE) core to add the information type category and related requirements needed to support Software Record and Software Inventory use cases. The 'software-descriptor' information type is defined as a ROLIE extension. Additional supporting requirements are also defined that describe the use of specific formats and link relations pertaining to the new information type.Security Automation and Continuous Monitoring (SACM) TerminologyThis memo documents terminology used in the documents produced by SACM (Security Automation and Continuous Monitoring).CoSWID add explicit support for the representation of file-hashes using algorithms that are
registered at the Named Information Hash Algorithm Registry via the file-hash member (label 56).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 file-entry the file-hash type is
included in.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 the case of constrained-node networks
or network equipment this assumption might not apply. Concise software instances in the
form of (modular) firmware are often stored directly on a block device that is a hardware component
of the constrained-node or network equipment. Multiple differentiable block devices or segmented
block devices that contain parts of modular firmware components (potentially each with their own
instance version) are already common at the time of this writing.The optional attributes that annotate a firmware package address specific characteristics of pieces
of firmware stored directly on a block-device in contrast to software deployed in a file-system.
In essence, trees of relative path-elements expressed by the directory and file structure in CoSWID
tags are typically unable to represent the location of a firmware on a constrained-node (small
thing). The composite nature of firmware and also the actual composition of small things require a
set of attributes to address the identification of the correct component in a composite thing for
each individual piece of firmware. A single component also potentially requires a number of distinct
firmware parts that might depend on each other (versions). These dependencies can be limited to the
scope of the component itself or extend to the scope of a larger composite device. In addition, it
might not be possible (or feasible) to store a CoSWID tag document (permanently) on a small thing
along with the corresponding piece of firmware.To address the specific characteristics of firmware, the extension point $$resource-extension is
used to allow for an additional type of resource description—firmware-entry—thereby increasing
the self-descriptiveness and flexibility of CoSWID. The optional use of the extension point
$$resource-extension in respect to firmware MUST adhere to the following CDDL data definition.The members of the firmware group that constitutes the content of the firmware-entry is
based on the metadata about firmware defined in . As with every semantic
differentiation that is supported by the resource-collection type, the use of firmware-entry is
optional. It is REQUIRED not to instantiate more than one firmware-entry, as the firmware group is
used in a map and therefore only allows for unique labels.The optional cms-firmware-package member allows to include the actual firmware in the CoSWID tag
that also expresses its metadata as a byte-string. This option enables a CoSWID tag to be used as a
container or wrapper that composes both firmware and its metadata in a single document (which again
can be signed, encrypted and/or compressed). In consequence, a CoSWID tag about firmware can be
conveyed as an identifying document across endpoints or used as a reference integrity
measurement as usual. Alternatively, it can also convey an actual piece of firmware, serve its
intended purpose as a SWID tag and then - due to the lack of a location to store it - be discarded.SWID tags, as defined in the ISO-19770-2:2015 XML schema, can include cryptographic signatures to
protect the integrity of the SWID tag. In general, tags are signed by the tag creator (typically,
although not exclusively, the vendor of the software product that the SWID tag identifies).
Cryptographic signatures can make any modification of the tag detectable, which is especially
important if the integrity of the tag is important, such as when the tag is providing reference
integrity measurments for files.The ISO-19770-2:2015 XML schema uses XML DSIG to support cryptographic signatures. CoSWID tags
require a different signature scheme than this. COSE (CBOR Object Signing and Encryption) provides the required mechanism . Concise SWID can be wrapped in a COSE Single Signer Data Object
(cose-sign1) that contains a single signature. The following CDDL defines a more restrictive subset
of header attributes allowed by COSE tailored to suit the requirements of Concise SWID.A vendor supplied signed CoSWID tag that includes hash-values for the files that compose a software
component can be used as a RIM (reference integrity measurement). A RIM is a type of declarative
guidance that can be used to assert the compliance of an endpoint by assessing the installed
software. In the context of remote attestation based on an attestation via hardware rooted trust,
a verifier can appraise the integrity of the conveyed measurements
of software components using a CoSWID RIM provided by a source, such as .
A group of SWID tags about the same (sub-)system, system entity, or (sub-)component (compare
). A RIMM manifest is a distinct document that is typically conveyed en-block and
constitutes declarative guidance in respect to a specific (target) endpoint (compare
).If multiple CoSWID compose a RIMM, the following CDDL data definition SHOULD be used.A typical requirement regarding specific instantiations of endpoints – and, as a result, specific
instantiations of software components - is a representation of the absolute path of a CoSWID tag
document in a file system in order to derive absolute paths of files represented 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 Token . Depending on the source of the token, the claim can be in
the protected or unprotected header portion.These groups are intermediate CDDL data definitions that are reused in several items in the CoSWID CDDL data definition.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.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.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.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.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.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).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.entity:
Specifies the organizations related to the software component referenced by this
CoSWID tag.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.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.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.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).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.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.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.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.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).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.software-version:
Underlying development version for the software component.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 theselang:
An RFC5646 conferment language tag or corresponding IANA index integer.directory:
A directory item allows one or more directories to be defined in the file
structure.file:
A file element that allows one or more files to be specified for a given
location.process:
Provides process (software component in execution) information for data that
will show up in a devices process table.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.size:
The file size in bytes of the file.file-version
The file version.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.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.fs-name:
The file name or directory name without any path characters.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.path-elements:
Provides the ability to apply a directory structure to the path expressions for
files defined in a payload or evidence item.process-name:
The process name as it will be found in the system entity’s process table.pid:
The process ID for the process in execution that can be included in the process
item as part of an evidence tag.type:
The type of resource represented via a text-string (typically, registry-key,
port or root-uri)extended-data:
An open-ended collection of elements that can be used to attach arbitrary
metadata to an entity item.entity-name:
The text-string name of the organization claiming a particular role in the CoSWID
tag.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.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.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?].date:
The sate and time evidence represented by an evidence item was gathered.device-id:
A text-string identifier for a device evidence was gathered from.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).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]ownership:
Determines the relative strength of ownership of the software components. Valid
enumerations are: abandon, private, sharedrel:
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.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.use:
Determines if the target software is a hard requirement or not. Valid
enumerations are: required, recommended, optional,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.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.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).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).edition:
The variation of the product (Extended, Enterprise, Professional, Standard etc).entitlement-data-required:
An indicator to determine if there should be accompanying proof of entitlement
when a software license reconciliation is completed.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).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.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).product:
The base name of the product (e.g. [FIXME: what are appropriate examples?].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.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.summary:
A short (one-sentence) description of the software.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/.unspsc-version:
The version of the UNSPSC code used to define the UNSPSC code value. For more information see, http://www.unspsc.org/.