]> CBOR Object Signing and Encryption (COSE) Key Thumbprint SECOM CO., LTD.
Japan isobekohei@gmail.com
University of Applied Sciences Bonn-Rhein-Sieg
Germany hannes.tschofenig@gmx.net
Transmute
United States of America orie@transmute.industries
SEC cose This specification defines a method for computing a hash value over a CBOR Object Signing and Encryption (COSE) Key. It specifies which fields within the COSE Key structure are included in the cryptographic hash computation, the process for creating a canonical representation of these fields, and how to hash the resulting byte sequence. The resulting hash value, referred to as a "thumbprint", can be used to identify or select the corresponding key.
Introduction This specification defines a method for applying a cryptographic hash function to a CBOR Object Signing and Encryption (COSE) Key structure , resulting in a hash value known as a "thumbprint". To achieve this, the document specifies which fields in the COSE Key structure are included in the hash computation, the process for creating a canonical form of these fields, and how to hash the resulting byte sequence. One of the primary use cases for this thumbprint is as a naming scheme for identifying or selecting the key, such as by using the COSE Key Thumbprint value as a "kid" (key ID). Another key use case involves key derivation functions that use the thumbprints of public keys from the endpoints, along with other application context, to derive a symmetric key. This specification outlines how thumbprints of COSE Keys are generated for both asymmetric and symmetric keys (see Sections and ). Additionally, it introduces a new CBOR Web Token (CWT) confirmation method, which has been added to the IANA "CWT Confirmation Methods" registry established by . For further details on the use of a confirmation claim in a CWT with a proof-of-possession key, refer to .
Terminology 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 BCP 14 when, and only when, they appear in all capitals, as shown here.
COSE Key Thumbprint The thumbprint of a COSE Key MUST be computed as follows:
  1. Construct a COSE_Key structure (see ) containing only the required parameters representing the key as described in of this document.
  2. Apply the deterministic encoding described in to the representation constructed in step 1.
  3. Hash the bytes produced in step 2 with a cryptographic hash function H. For example, SHA-256 may be used as a hash function.
The details of this computation are further described in subsequent sections. The SHA-256 hash algorithm MUST be supported; other algorithms MAY be supported.
Required COSE Key Parameters Only the required parameters of a key's representation are used when computing its COSE Key Thumbprint value. This section summarizes the required parameters. The "kty" (label: 1) element MUST be present for all key types, and the integer value specified in the IANA "COSE Key Types" registry MUST be used. The tstr data type is not used with the "kty" element. Many COSE Key parameters are specific to the chosen key type. The following subsections list the required parameters for commonly used key types.
Octet Key Pair (OKP) The required parameters for elliptic curve public keys that use the Octet Key Pair (OKP) key type, such as X25519, are:
  • "kty" (label: 1, data type: int, value: 1)
  • "crv" (label: -1, value: int)
  • "x" (label: -2, value: bstr)
Further details are described in .
Elliptic Curve Keys with X- and Y-Coordinates The required parameters for elliptic curve public keys that use the EC2 key type, such as NIST P-256, are:
  • "kty" (label: 1, data type: int, value: 2)
  • "crv" (label: -1, data type: int)
  • "x" (label: -2, data type: bstr)
  • "y" (label: -3, data type: bstr)
Further details are described in . Note: supports both compressed and uncompressed point representations. For interoperability, implementations adhering to this specification MUST use the uncompressed point representation. Therefore, the y-coordinate is expressed as a bstr. If an implementation uses the compressed point representation, it MUST first convert it to the uncompressed form for the purpose of thumbprint calculation.
RSA Public Keys The required parameters for an RSA public key are:
  • "kty" (label: 1, data type: int, value: 3)
  • "n" (label: -1, data type: bstr)
  • "e" (label: -2, data type: bstr)
Symmetric Keys The required parameters for a symmetric key are:
  • "kty" (label: 1, data type: int, value: 4)
  • "k" (label: -1, data type: bstr)
HSS-LMS Keys The required parameters for HSS-LMS keys are:
  • "kty" (label: 1, data type: int, value: 5)
  • "pub" (label: -1, data type: bstr)
Others As other key type values are defined, their defining specifications should be similarly consulted to determine which parameters, in addition to the "kty" element, are required.
Miscellaneous Considerations
Why Not Include Optional COSE Key Parameters? Optional parameters of COSE Keys are intentionally not included in the COSE Key Thumbprint computation so that their absence or presence in the COSE Key does not alter the resulting value. The COSE Key Thumbprint is a digest of the ordered essential parameters needed to represent a COSE Key, with all other parameters excluded. By excluding optional parameters, the COSE Key Thumbprint consistently refers to the key itself, not to a key with additional attributes. Different application contexts may include various optional attributes in the COSE Key structure. If these optional parameters were included in the thumbprint calculation, the resulting values could differ for the same key depending on the attributes present. Including only the required parameters ensures that the COSE Key Thumbprint remains consistent for a given key, regardless of any additional attributes. Different kinds of thumbprints could be defined by other specifications that might include some or all additional COSE Key parameters, if use cases arise where such different kinds of thumbprints would be useful.
Selection of Hash Function A specific hash function must be chosen by an application to compute the hash value of the hash input. For instance, SHA-256 may be used as the hash function. While SHA-256 is a good default choice at the time of writing, the preferred hash function may evolve as the cryptographic landscape develops. In many cases, only the party that generates the key needs to be aware of the hash function used. For example, the key producer might use the thumbprint value as a "kid" (key ID). In such scenarios, the consumer of the "kid" treats it as an opaque value solely for key selection. However, when multiple parties are involved in reproducing and comparing the COSE Key Thumbprint, it is crucial that they know and use the same hash function to ensure consistent results.
Thumbprints of Keys Not in COSE Key Format Keys that are in other formats can be represented as COSE Keys. The only prerequisites are that the COSE_Key representation of the key be defined and the party creating the COSE Key Thumbprint be in possession of the necessary key material.
Relationship to Digests of X.509 Values COSE Key Thumbprint values are computed on the COSE Key object containing only essential parameters in a specific order. Thus, they are more analogous to applications that use digests of X.509 Subject Public Key Info (SPKI) values, which are defined in , than to applications that use digests of complete certificate values, as the "x5t" (X.509 certificate SHA-1 thumbprint) value defined for X.509 certificate objects does. While logically equivalent to a digest of the SPKI representation of the key, a COSE Key Thumbprint is computed over the CBOR representation of that key rather than over an ASN.1 representation of it.
Relationship to JSON Web Key Thumbprints The ckt of a COSE Key, as described in , and the jkt of a JSON Web Key, as described in , are different even when the underlying cryptographic key material is the same. This document does not register a JWT confirmation method for using "ckt" as a confirmation method for a JWT or a CWT confirmation method for using "jkt" as a confirmation method for a CWT.
Confirmation Method introduces confirmation methods for use with CWTs with the addition of the "cnf" claim. CWTs are defined in . This specification adds a new confirmation method based on COSE Key Thumbprints. The proof-of-possession key is identified using the "ckt" member of the CWT confirmation claim "cnf". This member contains the value of the COSE Key Thumbprint encoded as a binary string. Instead of communicating the actual COSE Key, only the thumbprint is conveyed. This approach assumes that the recipient is able to obtain the identified COSE Key using the thumbprint contained in the "ckt" member. In this approach, the issuer of a CWT declares that the presenter possesses a particular key and that the recipient can cryptographically confirm the presenter's proof of possession of the key by including a "ckt" CWT confirmation method member in the CWT. The following example demonstrates the use of the "ckt" member in a CWT as part of the confirmation method (with line breaks inserted for editorial reasons): registers the "ckt" CWT confirmation method member. The "ckt" member is used in the "cnf" claim.
COSE Key Thumbprint URIs This specification defines Uniform Resource Identifiers (URIs) to represent a COSE Key Thumbprint value. The design follows the work of JSON Web Key (JWK) Thumbprint URIs, as specified in . This enables COSE Key Thumbprints to be used, for example, as key identifiers in contexts requiring URIs. This specification defines a URI prefix indicating that the portion of the URI following the prefix is a COSE Key Thumbprint. The following URI prefix is defined to indicate that the portion of the URI following the prefix is a COSE Key Thumbprint: urn:ietf:params:oauth:ckt To make the hash algorithm being used explicit in a URI, the prefix is followed by a hash algorithm identifier and a COSE Key Thumbprint value, each separated by a colon character to form a URI representing a COSE Key Thumbprint. Hash algorithm identifiers used in COSE Key Thumbprint URIs MUST be values from the "Hash Name String" column in the IANA "Named Information Hash Algorithm Registry" . COSE Key Thumbprint URIs with hash algorithm identifiers not found in this registry are not considered valid, and applications MUST detect and handle this error, should it occur. Since the URN is encoded as a string, the output of the COSE Key Thumbprint computation described in MUST be base64url encoded without padding. specifies base64url encoding as follows:
Base64 encoding using the URL- and filename-safe character set defined in Section of RFC 4648 , with all trailing '=' characters omitted (as permitted by ) and without the inclusion of any line breaks, whitespace, or other additional characters. Note that the base64url encoding of the empty octet sequence is the empty string. (See for notes on implementing base64url encoding without padding.)
The base64url encoding of the thumbprint shown in is shown below (with a line break added for readability purposes). SWvYr63zB-WwjGSwQhv53AFSijRKQ72oj63RZp2iU-w The full example of a COSE Key Thumbprint URI is shown below (with a line break added for readability). urn:ietf:params:oauth:ckt:sha-256: SWvYr63zB-WwjGSwQhv53AFSijRKQ72oj63RZp2iU-w Note that the use of oauth in the namespace is to align with JWK Thumbprint URIs as described in ; however, these URIs are intended for use with applications and specifications not necessarily related to OAuth.
Example This section demonstrates the COSE Key Thumbprint computation for the following example COSE Key containing an Elliptic Curve Cryptography (ECC) public key. For better readability, the example is first presented in CBOR diagnostic format (with the long line broken for display purposes only). The example above corresponds to the following CBOR encoding (with link breaks added for display purposes only): Not all of the parameters from the example above are used in the COSE Key Thumbprint computation because the required parameters of an elliptic curve public key are (as listed in ) "kty", "crv", "x", and "y". The resulting COSE Key structure, in CBOR diagnostic format with line breaks added for better readability, with the minimum parameters in the correct order are: In CBOR encoding, the result is (with line breaks added for display purposes only): Using SHA-256, the resulting thumbprint is:
Security Considerations A COSE Key Thumbprint will only uniquely identify a particular key if a single unambiguous COSE Key representation for that key is defined and used when computing the COSE Key Thumbprint. Key identifiers are not included in the thumbprint calculation (similarly to other optional parameters in the COSE_Key structure). If the inclusion of specific optional parameters in the thumbprint calculation is important for a particular application, this specification would not be suitable. While thumbprint values are useful for identifying legitimate keys, comparing thumbprint values is not a reliable means of excluding the use of particular keys (or transformations thereof). The reason is because an attacker may supply a key that is a transformation of a key in order for it to appear as a different key. For instance, if a legitimate RSA key uses a modulus value N and an attacker supplies a key with modulus 3*N, the modified key would still work about 1/3 of the time, but it would appear to be a different key. Producing thumbprints of symmetric keys needs to be done with care. Developers MUST ensure that the symmetric key has sufficient entropy to prevent attackers from precomputing tables of symmetric keys with their corresponding hash values. This can be prevented if the symmetric key is a randomly selected key of at least a 128-bit length. Thumbprints MUST NOT be used with passwords or other low-entropy secrets. If a developer is unable to determine whether all symmetric keys used in an application have sufficient entropy, then thumbprints of symmetric keys MUST NOT be used. In general, using thumbprints of symmetric keys should only be used in special applications. In most other deployment scenarios, it is more appropriate to utilize a different naming scheme for key identifiers.
IANA Considerations IANA has added the following entry to the "CWT Confirmation Methods" registry established by :
Confirmation Method Name:
ckt
Confirmation Method Description:
COSE Key SHA-256 Thumbprint
JWT Confirmation Method Name:
(none)
Confirmation Key:
5
Confirmation Value Type(s):
binary string
Change Controller:
IETF
Specification Document(s):
RFC 9679
Furthermore, IANA has added a value to the "OAuth URI" registry established by :
URN:
urn:ietf:params:oauth:ckt
Common Name:
COSE Key Thumbprint URI
Change Controller:
IETF
Specification Document(s):
RFC 9679
 References Normative References Informative References Named Information Hash Algorithm Registry IANA CWT Confirmation Methods IANA OAuth URI IANA
Acknowledgements We would like to thank the authors of for their work on the JWK Thumbprint specification. This document applies JWK Thumbprints to COSE Key structures. Additionally, we would like to thank , , , , , , , , , , , , and for their feedback.