COSE Working Group | J. Schaad |
Internet-Draft | August Cellars |
Intended status: Informational | November 3, 2015 |
Expires: May 6, 2016 |
CBOR Encoded Message Syntax
draft-ietf-cose-msg-07
Concise Binary Object Representation (CBOR) is data format designed for small code size and small message size. There is a need for the ability to have the basic security services defined for this data format. This document specifies procesing for signatures, message authentication codes, and encryption using CBOR. This document also specifies a represention for cryptographic keys using CBOR.
The source for this draft is being maintained in GitHub. Suggested changes should be submitted as pull requests at <https://github.com/cose-wg/cose-spec>. Instructions are on that page as well. Editorial changes can be managed in GitHub, but any substantial issues need to be discussed on the COSE mailing list.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 6, 2016.
Copyright (c) 2015 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
There has been an increased focus on the small, constrained devices that make up the Internet of Things (IOT). One of the standards that has come out of this process is the Concise Binary Object Representation (CBOR). CBOR extended the data model of the JavaScript Object Notation (JSON) by allowing for binary data among other changes. CBOR is being adopted by several of the IETF working groups dealing with the IOT world as their encoding of data structures. CBOR was designed specifically to be both small in terms of messages transport and implementation size as well having a schema free decoder. A need exists to provide basic message security services for IOT and using CBOR as the message encoding format makes sense.
The JOSE working group produced a set of documents [RFC7515][RFC7516][RFC7517][RFC7518] using JSON [RFC7159] that specified how to process encryption, signatures and message authentication (MAC) operations, and how to encode keys using JSON. This document does the same work for use with the CBOR [RFC7049] document format. While there is a strong attempt to keep the flavor of the original JOSE documents, two considerations are taken into account:
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 [RFC2119].
When the words appear in lower case, their natural language meaning is used.
There currently is no standard CBOR grammar available for use by specifications. We therefore describe the CBOR structures in prose. There is a version of a CBOR grammar in the CBOR Data Definition Language (CDDL) [I-D.greevenbosch-appsawg-cbor-cddl]. An informational version of the CBOR grammar that reflects what is in the prose can be found in Appendix A. CDDL has not been fixed, so this grammar may will only work with the version of CDDL at the time of publishing.
The document was developed by first working on the grammar and then developing the prose to go with it. An artifact of this is that the prose was written using the primitive type strings defined by early versions CDDL. In this specification, the following primitive types are used:
Text from here to start of next section to be removed
NOTE: For the purposes of review, we are currently interlacing the CDDL grammar into the text of document. This is being done for simplicity of comparison of the grammar against the prose. The grammar will be removed to an appendix during WGLC.
start = COSE_Untagged_Message / COSE_Tagged_Message / COSE_Key / COSE_KeySet / Internal_Types
In JSON, maps are called objects and only have one kind of map key: a string. In COSE, we use both strings and integers (both negative and non-negative integers) as map keys. The integers are used for compactness of encoding and easy comparison. (Generally, in this document the value zero is going to be reserved and not used.) Since the work "key" is mainly used in its other meaning, as a cryptographic key, we use the term "label" for this usage as a map keys.
Text from here to start of next section to be removed
label = int / tstr values = any
In this document we use the following terminology: [CREF2]JLS: I have not gone through the document to determine what needs to be here yet. We mostly want to grab terms that are used in unusual ways or are not generally understood.
Byte is a synonym for octet.
Key management is used as a term to describe how a key at level n is obtained from level n+1 in encrypted and MACed messages. The term is also used to discuss key life cycle management, this document does not discuss key life cycle operations.
One of the issues that needs to be addressed is a requirement that a standard specify a set of algorithms that are required to be implemented. [CREF3]JLS: It would be possible to extend this section to talk about those decisions that an application needs to think about rather than just talking about MTI algorithms. This is done to promote interoperability as it provides a minimal set of algorithms that all devices can be sure will exist at both ends. However, we have elected not to specify a set of mandatory algorithms in this document.
It is expected that COSE is going to be used in a wide variety of applications and on a wide variety of devices. Many of the constrained devices are going to be setup to use a small fixed set of algorithms, and this set of algorithms may not match those available on a device. We therefore have deferred to the application protocols the decision of what to specify for mandatory algorithms.
Since the set of algorithms in an environment of constrained devices may depend on what the set of devices are and how long they have been in operation, we want to highlight that application protocols will need to specify some type of discovery method of algorithm capabilities. The discovery method may be as simple as requiring preconfiguration of the set of algorithms to providing a discovery method built into the protocol. S/MIME provided a number of different ways to approach the problem:
The COSE Message structure is designed so that there can be a large amount of common code when parsing and processing the different security messages. All of the message structures are built on a CBOR array type. The first three elements of the array contains the same basic information. The first element is a set of protected header information. The second element is a set of unprotected header information. The third element is the content of the message (either as plain text or encrypted). Elements after this point are dependent on the specific message type.
Identification of which message is present is done by one of two methods:
Text from here to start of next section to be removed
COSE_Untagged_Message = COSE_Sign / COSE_enveloped / COSE_encryptData / COSE_Mac COSE_Tagged_Message = COSE_Sign_Tagged / COSE_Enveloped_Tagged / COSE_EncryptedData_Tagged / COSE_Mac_Tagged
The structure of COSE has been designed to have two buckets of information that are not considered to be part of the payload itself, but are used for holding information about content, algorithms, keys, or evaluation hints for the processing of the layer. These two buckets are available for use in all of the structures in this document except for keys. While these buckets can be present, they may not all be usable in all instances. For example, while the protected bucket is defined as part of recipient structures, most of the algorithms that are used for recipients do not provide the necessary functionality to provide the needed protection and thus the bucket should not be used.
Both buckets are implemented as CBOR maps. The map key is a 'label' (Section 1.4). The value portion is dependent on the definition for the label. Both maps use the same set of label/value pairs. The integer and string values for labels has been divided into several sections with a standard range, a private range, and a range that is dependent on the algorithm selected. The defined labels can be found in the 'COSE Header Parameters' IANA registry (Section 15.2).
Two buckets are provided for each layer:
Only parameters that deal with the current layer are to be placed at that layer. As an example of this, the parameter 'content type' describes the content of the message being carried in the message. As such, this parameter is placed only in the content layer and is not placed in the recipient or signature layers. In principle, one should be able to process any given layer without reference to any other layer. (The only data that should need to cross layers is the cryptographic key.)
The buckets are present in all of the security objects defined in this document. The fields in order are the 'protected' bucket (as a CBOR 'bstr' type) and then the 'unprotected' bucket (as a CBOR 'map' type). The presence of both buckets is required. The parameters that go into the buckets come from the IANA "COSE Header Parameters" (Section 15.2). Some common parameters are defined in the next section, but a number of parameters are defined throughout this document.
Text from here to start of next section to be removed [CREF4]JLS: A completest version of this grammar would list the options available in the protected and unprotected headers. Do we want to head that direction?
header_map = {+ label => any } Headers = ( protected : bstr, ; Contains a header_map unprotected : header_map )
This section defines a set of common header parameters. A summary of those parameters can be found in Table 1. This table should be consulted to determine the value of label used as well as the type of the value.
The set of header parameters defined in this section are:
The header parameter values indicated by 'crit' can be processed by either the security library code or by an application using a security library, the only requirement is that the parameter is processed. If the 'crit' value list includes a value for which the parameter is not in the protected bucket, this is a fatal error in processing the message.
name | label | value type | value registry | description |
---|---|---|---|---|
alg | 1 | int / tstr | COSE Algorithm Registry | Integers are taken from table --POINT TO REGISTRY-- |
crit | 2 | [+ label] | COSE Header Label Registry | integer values are from -- POINT TO REGISTRY -- |
content type | 3 | tstr / int | CoAP Content-Formats or Media Types registry | Value is either a Media Type or an integer from the CoAP Content Format registry |
kid | 4 | bstr | key identifier | |
nonce | 5 | bstr | Nonce or Initialization Vector (IV) | |
counter signature | 6 | COSE_signature | CBOR encoded signature structure | |
creation time | * | uint | Time the content was created | |
sequence number | * | uint | Application specific Integer value |
OPEN ISSUES:
The signature structure allows for one or more signatures to be applied to a message payload. There are provisions for parameters about the content and parameters about the signature to be carried along with the signature itself. These parameters may be authenticated by the signature, or just present. Examples of parameters about the content would be the type of content, when the content was created, and who created the content. [CREF5]Hannes: Ensure that the list of examples only includes items that are implemented in this specification. Check the other places where such lists occur and ensure that they also follow this rule. Examples of parameters about the signature would be the algorithm and key used to create the signature, when the signature was created, and counter-signatures.
When more than one signature is present, the successful validation of one signature associated with a given signer is usually treated as a successful signature by that signer. However, there are some application environments where other rules are needed. An application that employs a rule other than one valid signature for each signer must specify those rules. Also, where simple matching of the signer identifier is not sufficient to determine whether the signatures were generated by the same signer, the application specification must describe how to determine which signatures were generated by the same signer. Support of different communities of recipients is the primary reason that signers choose to include more than one signature. For example, the COSE_Sign structure might include signatures generated with the RSA signature algorithm and with the Elliptic Curve Digital Signature Algorithm (ECDSA) signature algorithm. This allows recipients to verify the signature associated with one algorithm or the other. (The original source of this text is [RFC5652].) More detailed information on multiple signature evaluation can be found in [RFC5752].
The COSE_Sign structure is a CBOR array. The fields of the array in order are:
The COSE_signature structure is a CBOR array. The fields of the array in order are:
Text from here to start of next section to be removed
COSE_Sign_Tagged = #6.999(COSE_Sign) ; Replace 999 with TBD1 COSE_Sign = [ Headers, payload : bstr / nil, signatures : [+ COSE_signature] ] COSE_signature = [ Headers, signature : bstr ]
One of the features that we supply in the COSE document is the ability for applications to provide additional data to be authenticated as part of the security, but that is not carried as part of the COSE object. The primary reason for supporting this can be seen by looking at the CoAP message structure [RFC7252] where the facility exists for options to be carried before the payload. [CREF6]JLS: Don't talk about items which we do not define in this specification. An example of data that can be placed in this location would be transaction ids and nonces to check for replay protection. If the data is in the options section, then it is available for routers to help in performing the replay detection and prevention. However, it may also be desired to protect these values so that they cannot be modified in transit. This is the purpose of the externally supplied data field.
This document describes the process for using a byte array of externally supplied authenticated data, however the method of constructing the byte array is a function of the application. Applications that use this feature need to define how the externally supplied authenticated data is to be constructed. Such a construction needs to take into account the following issues:
In order to create a signature, a consistent byte stream is needed in order to process. This algorithm takes in the body information (COSE_Sign), the signer information (COSE_Signer), and the application data (External). This document uses a CBOR array to construct the byte stream to be processed. The fields of the array in order are:
How to compute a signature:
How to verify a signature:
In addition to performing the signature verification, one must also perform the appropriate checks to ensure that the key is correctly paired with the signing identity and that the appropriate authorization is done.
Text from here to start of next section to be removed
The COSE structure used to create the byte stream to be signed uses the following CDDL grammar structure:
Sig_structure = [ body_protected: bstr, sign_protected: bstr, external_aad: bstr, payload: bstr ]
Counter signatures provide a method of having a different signature occur on some piece of content. This is normally used to provide a signature on a signature allowing for a proof that a signature existed at a given time. In this document we allow for counter signatures to exist in a greater number of environments. A counter signature can exist, for example, on a COSE_encryptedData object and allow for a signature to be present on the encrypted content of a message.
The creation and validation of counter signatures over the different items relies on the fact that the structure all of our objects have the same structure. The first element may be a message type, this is followed by a set of protected attributes, a set of unprotected attributes and a body in that order. This means that the Sig_structure can be used for in a uniform manner to get the byte stream for processing a signature. If the counter signature is going to be computed over a COSE_encryptedData structure, the body_protected and payload items can be mapped into the Sig_structure in the same manner as from the COSE_Sign structure.
While one can create a counter signature for a COSE_Sign structure, there is not much of a point to doing so. It is equivalent to create a new COSE_signature structure and placing it in the signatures array. It is strongly suggested that it not be done, but it is not banned.
COSE supports two different encryption structures. COSE_enveloped is used when the key needs to be explicitly identified. This structure supports the use of recipient structures to allow for random content encryption keys to be used. COSE_encrypted is used when a recipient structure is not needed because the key to be used is known implicitly.
The enveloped structure allows for one or more recipients of a message. There are provisions for parameters about the content and parameters about the recipient information to be carried in the message. The parameters associated with the content can be authenticated by the content encryption algorithm. The parameters associated with the recipient can be authenticated by the recipient algorithm (when the algorithm supports it). Examples of parameters about the content are the type of the content, when the content was created, and the content encryption algorithm. Examples of parameters about the recipient are the recipient's key identifier, the recipient encryption algorithm.
In COSE, the same techniques and structures are used for encrypting both the plain text and the keys used to protect the text. This is different from the approach used by both [RFC5652] and [RFC7516] where different structures are used for the content layer and for the recipient layer.
The COSE_encrypt structure is a CBOR array. The fields of the array in order are:
The COSE_recipient structure is a CBOR array. The fields of the array in order are:
Text from here to start of next section to be removed
COSE_Enveloped_Tagged = #6.998(COSE_enveloped) ; Replace 998 with TBD32 COSE_enveloped = [ COSE_encrypt_fields recipients: [+COSE_recipient] ] COSE_encrypt_fields = ( Headers, ciphertext: bstr / nil, ) COSE_recipient = [ COSE_encrypt_fields ? recipients: [+COSE_recipient] ]
A typical encrypted message consists of an encrypted content and an encrypted CEK for one or more recipients. The content-encryption key is encrypted for each recipient, using a key specific to that recipient. The details of this encryption depends on which class the recipient algorithm falls into. Specific details on each of the classes can be found in Section 12. A short summary of the five recipient algorithm classes is:
The encrypted structure does not have the ability to specify recipients of the message. The structure assumes that the recipient of the object will already know the identity of the key to be used in order to decrypt the message. If a key needs to be identified to the recipient, the enveloped structure is used.
The CDDL grammar structure for encrypted data is:
COSE_EncryptedData_Tagged = #6.997(COSE_encryptData) ; Replace 997 with TBD3 COSE_encryptData = [ COSE_encrypt_fields ]
The COSE_encryptedData structure is a CBOR array. The fields of the array in order are:
The encryption algorithm for AEAD algorithms is fairly simple. In order to get a consistent encoding of the data to be authenticated, the Enc_structure is used to have canonical form of the AAD.
Text from here to start of next section to be removed
Enc_structure = [ protected: bstr, external_aad: bstr ]
In this section we describe the structure and methods to be used when doing MAC authentication in COSE. This document allows for the use of all of the same classes of recipient algorithms as are allowed for encryption.
When using MAC operations, there are two modes in which it can be used. The first is just a check that the content has not been changed since the MAC was computed. Any class of recipient algorithm can be used for this purpose. The second mode is to both check that the content has not been changed since the MAC was computed, and to use the recipient algorithm to verify who sent it. The classes of recipient algorithms that support this are those that use a pre-shared secret or do static-static key agreement (without the key wrap step). In both of these cases, the entity MACing the message can be validated by a key binding. (The binding of identity assumes that there are only two parties involved and you did not send the message yourself.)
The COSE_Mac structure is a CBOR array. The fields of the array in order are:
Text from here to start of next section to be removed
COSE_Mac_Tagged = #6.996(COSE_Mac) ; Replace 996 with TBD4 COSE_Mac = [ Headers, payload: bstr / nil, tag: bstr, recipients: [+COSE_recipient] ]
How to compute a MAC:
Text from here to start of next section to be removed
MAC_structure = [ protected: bstr, external_aad: bstr, payload: bstr ]
A COSE Key structure is built on a CBOR map object. The set of common parameters that can appear in a COSE Key can be found in the IANA registry 'COSE Key Common Parameter Registry' (Section 15.5). Additional parameters defined for specific key types can be found in the IANA registry 'COSE Key Type Parameters' (Section 15.6).
A COSE Key Set uses a CBOR array object as its underlying type. The values of the array elements are COSE Keys. A Key Set MUST have at least one element in the array.
The element "kty" is a required element in a COSE_Key map.
Text from here to start of next section to be removed
The CDDL grammar describing a COSE_Key and COSE_KeySet is: [CREF7]JLS: We can really simplify the grammar for COSE_Key to be just the kty (the one required field) and the generic item. The reason to do this is that it makes things simpler. The reason not to do this says that we really need to add a lot more items so that a grammar check can be done that is more tightly enforced.
COSE_Key = { key_kty => tstr / int, ? key_ops => [+ (tstr / int) ], ? key_alg => tstr / int, ? key_kid => bstr, * label => values } COSE_KeySet = [+COSE_Key]
This document defines a set of common parameters for a COSE Key object. Table 2 provides a summary of the parameters defined in this section. There are also a set of parameters that are defined for a specific key type. Key type specific parameters can be found in Section 13.
name | label | CBOR type | registry | description |
---|---|---|---|---|
kty | 1 | tstr / int | COSE General Values | Identification of the key type |
key_ops | 4 | [* (tstr/int)] | Restrict set of permissible operations | |
alg | 3 | tstr / int | COSE Algorithm Values | Key usage restriction to this algorithm |
kid | 2 | bstr | Key Identification value - match to kid in message | |
use | * | tstr | deprecated - don't use |
name | value | description |
---|---|---|
sign | 1 | The key is used to create signatures. Requires private key fields. |
verify | 2 | The key is used for verification of signatures. |
encrypt | 3 | The key is used for key transport encryption. |
decrypt | 4 | The key is used for key transport decryption. Requires private key fields. |
wrap key | 5 | The key is used for key wrapping. |
unwrap key | 6 | The key is used for key unwrapping. Requires private key fields. |
key agree | 7 | The key is used for key agreement. |
Text from here to start of next section to be removed
The following provides a CDDL fragment which duplicates the assignment labels from Table 2 and Table 3.
;key_labels key_kty=1 key_kid=2 key_alg=3 key_ops=4 ;key_ops values key_ops_values = (key_ops_sign:1, key_ops_verify:2, key_ops_encrypt:3, key_ops_decrypt:4, key_ops_wrap:5, key_ops_unwrap:6, key_ops_agree:7)
There are two basic signature algorithm structures that can be used. The first is the common signature with appendix. In this structure, the message content is processed and a signature is produced, the signature is called the appendix. This is the message structure used by our common algorithms such as ECDSA and RSASSA-PSS. (In fact the SSA in RSASSA-PSS stands for Signature Scheme with Appendix.) The basic structure becomes:
signature = Sign(message content, key) valid = Verification(message content, key, signature)
The second is a signature with message recovery. (An example of such an algorithm is [PVSig].) In this structure, the message content is processed, but part of it is included in the signature. Moving bytes of the message content into the signature allows for an effectively smaller signature, the signature size is still potentially large, but the message content is shrunk. This has implications for systems implementing these algorithms and for applications that use them. The first is that the message content is not fully available until after a signature has been validated. Until that point the part of the message contained inside of the signature is unrecoverable. The second is that the security analysis of the strength of the signature is very much based on the structure of the message content. Messages which are highly predictable require additional randomness to be supplied as part of the signature process. In the worst case, it becomes the same as doing a signature with appendix. Thirdly, in the event that multiple signatures are applied to a message, all of the signature algorithms are going to be required to consume the same number of bytes of message content.
signature, message sent = Sign(message content, key) valid, message content = Verification(message sent, key, signature)
At this time, only signatures with appendixes are defined for use with COSE, however considerable interest has been expressed in using a signature with message recovery algorithm due to the effective size reduction that is possible. Implementations will need to keep this in mind for later possible integration.
ECDSA [DSS] defines a signature algorithm using ECC.
The ECDSA signature algorithm is parameterized with a hash function (h). In the event that the length of the hash function output is greater than the group of the key, the left-most bytes of the hash output are used.
The algorithms defined in this document can be found in Table 4.
name | value | hash | description |
---|---|---|---|
ES256 | -7 | SHA-256 | ECDSA w/ SHA-256 |
ES384 | -8 | SHA-384 | ECDSA w/ SHA-384 |
ES512 | -9 | SHA-512 | ECDSA w/ SHA-512 |
This document defines ECDSA to work only with the curves P-256, P-384 and P-521. This document requires that the curves be encoded using the 'EC2' key type. Implementations need to check that the key type and curve are correct when creating and verifying a signature. Other documents can defined it to work with other curves and points in the future.
In order to promote interoperability, it is suggested that SHA-256 be used only with curve P-256, SHA-384 be used only with curve P-384 and SHA-512 be used with curve P-521. This is aligned with the recommendation in Section 4 of [RFC5480].
The signature algorithm results in a pair of integers (R, S). These integers will be of the same order as length of the key used for the signature process. The signature is encoded by converting the integers into byte strings of the same length as the key size. The length is rounded up to the nearest byte and is left padded with zero bits to get to the correct length. The two integers are then concatenated together to form a byte string that is the resulting signature.
Using the function defined in [RFC3447] the signature is:
Signature = I2OSP(R, n) | I2OSP(S, n)
where n = ceiling(key_length / 8)
The security strength of the signature is no greater than the minimum of the security strength associated with the bit length of the key and the security strength of the hash function.
System which have poor random number generation can leak their keys by signing two different messages with the same value 'k' (the per-message random value). [RFC6979] provides a method to deal with this problem by making 'k' be deterministic based on the message content rather than randomly generated. Applications that specify ECDSA should evaluate the ability to get good random number generation and require this when it is not possible. Note: Use of this technique a good idea even when good random number generation exists. Doing so both reduces the possibility of having the same value of 'k' in two signature operations, but allows for reproducible signature values which helps testing.
There are two substitution attacks that can theoretically be mounted against the ECDSA signature algorithm.
Message Authentication Codes (MACs) provide data authentication and integrity protection. They provide either no or very limited data origination. (One cannot, for example, be used to prove the identity of the sender to a third party.)
MACs use the same basic structure as signature with appendix algorithms. The message content is processed and an authentication code is produced. The authentication code is frequently called a tag. The basic structure becomes:
tag = MAC_Create(message content, key) valid = MAC_Verify(message content, key, tag)
MAC algorithms can be based on either a block cipher algorithm (i.e. AES-MAC) or a hash algorithm (i.e. HMAC). This document defines a MAC algorithm for each of these two constructions.
The Hash-base Message Authentication Code algorithm (HMAC) [RFC2104][RFC4231] was designed to deal with length extension attacks. The algorithm was also designed to allow for new hash algorithms to be directly plugged in without changes to the hash function. The HMAC design process has been vindicated as, while the security of hash algorithms such as MD5 has decreased over time, the security of HMAC combined with MD5 has not yet been shown to be compromised [RFC6151].
The HMAC algorithm is parameterized by an inner and outer padding, a hash function (h) and an authentication tag value length. For this specification, the inner and outer padding are fixed to the values set in [RFC2104]. The length of the authentication tag corresponds to the difficulty of producing a forgery. For use in constrained environments, we define a set of HMAC algorithms that are truncated. There are currently no known issues when truncating, however the security strength of the message tag is correspondingly reduced in strength. When truncating, the left-most tag length bits are kept and transmitted.
The algorithm defined in this document can be found in Table 5.
name | value | Hash | Length | description |
---|---|---|---|---|
HMAC 256/64 | * | SHA-256 | 64 | HMAC w/ SHA-256 truncated to 64 bits |
HMAC 256/256 | 4 | SHA-256 | 256 | HMAC w/ SHA-256 |
HMAC 384/384 | 5 | SHA-384 | 384 | HMAC w/ SHA-384 |
HMAC 512/512 | 6 | SHA-512 | 512 | HMAC w/ SHA-512 |
Some recipient algorithms carry the key while others derive a key from secret data. For those algorithms that carry the key (i.e. RSA-OAEP and AES-KeyWrap), the size of the HMAC key SHOULD be the same size as the underlying hash function. For those algorithms that derive the key, the derived key MUST be the same size as the underlying hash function.
If the key is obtained from a key structure, the key type MUST be 'Symmetric'. Implementations creating and validating MAC values MUST validate that the key type, key length, and algorithm are correct and appropriate for the entities involved.
HMAC has proved to be resistant to attack even when used with weakening hash algorithms. The current best method appears to be a brute force attack on the key. This means that key size is going to be directly related to the security of an HMAC operation.
AES-CBC-MAC is defined in [MAC].
AES-CBC-MAC is parameterized by the key length, the authentication tag length and the IV used. For all of these algorithms, the IV is fixed to all zeros. We provide an array of algorithms for various key lengths and tag lengths. The algorithms defined in this document are found in Table 6.
name | value | key length | tag length | description |
---|---|---|---|---|
AES-MAC 128/64 | * | 128 | 64 | AES-MAC 128 bit key, 64-bit tag |
AES-MAC 256/64 | * | 256 | 64 | AES-MAC 256 bit key, 64-bit tag |
AES-MAC 128/128 | * | 128 | 128 | AES-MAC 128 bit key, 128-bit tag |
AES-MAC 256/128 | * | 256 | 128 | AES-MAC 256 bit key, 128-bit tag |
Keys may be obtained either from a key structure or from a recipient structure. If the key obtained from a key structure, the key type MUST be 'Symmetric'. Implementations creating and validating MAC values MUST validate that the key type, key length and algorithm are correct and appropriate for the entities involved.
A number of attacks exist against CBC-MAC that need to be considered.
Content Encryption Algorithms provide data confidentiality for potentially large blocks of data using a symmetric key. They provide either no or very limited data origination. (One cannot, for example, be used to prove the identity of the sender to a third party.) The ability to provide data origination is linked to how the symmetric key is obtained.
We restrict the set of legal content encryption algorithms to those that support authentication both of the content and additional data. The encryption process will generate some type of authentication value, but that value may be either explicit or implicit in terms of the algorithm definition. For simplicity sake, the authentication code will normally be defined as being appended to the cipher text stream. The basic structure becomes:
ciphertext = Encrypt(message content, key, additional data) valid, message content = Decrypt(cipher text, key, additional data)
Most AEAD algorithms are logically defined as returning the message content only if the decryption is valid. Many but not all implementations will follow this convention. The message content MUST NOT be used if the decryption does not validate.
The GCM mode is a generic authenticated encryption block cipher mode defined in [AES-GCM]. The GCM mode is combined with the AES block encryption algorithm to define an AEAD cipher.
The GCM mode is parameterized with by the size of the authentication tag. The size of the authentication tag is limited to a small set of values. For this document however, the size of the authentication tag is fixed at 128 bits.
The set of algorithms defined in this document are in Table 7.
name | value | description |
---|---|---|
A128GCM | 1 | AES-GCM mode w/ 128-bit key |
A192GCM | 2 | AES-GCM mode w/ 192-bit key |
A256GCM | 3 | AES-GCM mode w/ 256-bit key |
Keys may be obtained either from a key structure or from a recipient structure. If the key obtained from a key structure, the key type MUST be 'Symmetric'. Implementations encrypting and decrrypting MUST validate that the key type, key length and algorithm are correct and appropriate for the entities involved.
When using AES-CCM, the following restrictions MUST be enforced:
Counter with CBC-MAC (CCM) is a generic authentication encryption block cipher mode defined in [RFC3610]. The CCM mode is combined with the AES block encryption algorithm to define a commonly used content encryption algorithm used in constrained devices.
The CCM mode has two parameter choices. The first choice is M, the size of the authentication field. The choice of the value for M involves a trade-off between message expansion and the probably that an attacker can undetectably modify a message. The second choice is L, the size of the length field. This value requires a trade-off between the maximum message size and the size of the Nonce.
It is unfortunate that the specification for CCM specified L and M as a count of bytes rather than a count of bits. This leads to possible misunderstandings where AES-CCM-8 is frequently used to refer to a version of CCM mode where the size of the authentication is 64 bits and not 8 bits. These values have traditionally been specified as bit counts rather than byte counts. This document will follow the tradition of using bit counts so that it is easier to compare the different algorithms presented in this document.
We define a matrix of algorithms in this document over the values of L and M. Constrained devices are usually operating in situations where they use short messages and want to avoid doing recipient specific cryptographic operations. This favors smaller values of M and larger values of L. Less constrained devices do will want to be able to user larger messages and are more willing to generate new keys for every operation. This favors larger values of M and smaller values of L. (The use of a large nonce means that random generation of both the key and the nonce will decrease the chances of repeating the pair on two different messages.)
The following values are used for L:
The following values are used for M:
name | value | L | M | k | description |
---|---|---|---|---|---|
AES-CCM-16-64-128 | 10 | 16 | 64 | 128 | AES-CCM mode 128-bit key, 64-bit tag, 13-byte nonce |
AES-CCM-16-64-256 | 11 | 16 | 64 | 256 | AES-CCM mode 256-bit key, 64-bit tag, 13-byte nonce |
AES-CCM-64-64-128 | 30 | 64 | 64 | 128 | AES-CCM mode 128-bit key, 64-bit tag, 7-byte nonce |
AES-CCM-64-64-256 | 31 | 64 | 64 | 256 | AES-CCM mode 256-bit key, 64-bit tag, 7-byte nonce |
AES-CCM-16-128-128 | 12 | 16 | 128 | 128 | AES-CCM mode 128-bit key, 128-bit tag, 13-byte nonce |
AES-CCM-16-128-256 | 13 | 16 | 128 | 256 | AES-CCM mode 256-bit key, 128-bit tag, 13-byte nonce |
AES-CCM-64-128-128 | 32 | 64 | 128 | 128 | AES-CCM mode 128-bit key, 128-bit tag, 7-byte nonce |
AES-CCM-64-128-256 | 33 | 64 | 128 | 256 | AES-CCM mode 256-bit key, 128-bit tag, 7-byte nonce |
Keys may be obtained either from a key structure or from a recipient structure. If the key obtained from a key structure, the key type MUST be 'Symmetric'. Implementations encrypting and decrrypting MUST validate that the key type, key length and algorithm are correct and appropriate for the entities involved.
When using AES-CCM, the following restrictions MUST be enforced:
[RFC3610] additionally calls out one other consideration of note. It is possible to do a pre-computation attack against the algorithm in cases where the portions encryption content is highly predictable. This reduces the security of the key size by half. Ways to deal with this attack include adding a random portion to the nonce value and/or increasing the key size used. Using a portion of the nonce for a random value will decrease the number of messages that a single key can be used for. Increasing the key size may require more resources in the constrained device. See sections 5 and 10 of [RFC3610] for more information.
ChaCha20 and Poly1305 combined together is a new AEAD mode that is defined in [RFC7539]. This is a new algorithm defined to be a cipher that is not AES and thus would not suffer from any future weaknesses found in AES. These cryptographic functions are designed to be fast in software-only implementations.
The ChaCha20/Poly1305 AEAD construction defined in [RFC7539] has no parameterization. It takes a 256-bit key and a 96-bit nonce as well as the plain text and additional data as inputs and produces the cipher text as an option. We define one algorithm identifier for this algorithm in Table 9.
name | value | description |
---|---|---|
ChaCha20/Poly1305 | 11 | ChaCha20/Poly1305 w/ 256-bit key |
Keys may be obtained either from a key structure or from a recipient structure. If the key obtained from a key structure, the key type MUST be 'Symmetric'. Implementations encrypting and decrrypting MUST validate that the key type, key length and algorithm are correct and appropriate for the entities involved.
The pair of key, nonce MUST be unique for every invocation of the algorithm. Nonce counters are considered to be an acceptable way of ensuring that they are unique.
Key Derivation Functions (KDFs) are used to take some secret value and generate a different one. The original secret values come in three basic flavors:
General KDF functions work well with the first type of secret, can do reasonable well with the second type of secret and generally do poorly with the last type of secret. None of the KDF functions in this section are designed to deal with the type of secrets that are used for passwords. Functions like PBSE2 [RFC2898] need to be used for that type of secret.
Many functions are going to handle the first two type of secrets differently. The KDF function defined in Section 11.1 can use different underlying constructions if the secret is uniformly random than if the secret is not uniformly random. This is reflected in the set of algorithms defined for HKDF.
When using KDF functions, one component that is generally included is context information. Context information is used to allow for different keying information to be derived from the same secret. The use of context based keying material is considered to be a good security practice. This document defines a single context structure and a single KDF function.
The HKDF key derivation algorithm is defined in [RFC5869].
The HKDF algorithm takes these inputs:
HKDF is defined to use HMAC as the underlying PRF. However, it is possible to use other functions in the same construct to provide a different KDF function that may be more appropriate in the constrained world. Specifically, one can use AES-CBC-MAC as the PRF for the expand step, but not for the extract step. When using a good random shared secret of the correct length, the extract step can be skipped. The extract cannot be skipped if the secret is not uniformly random, for example if it is the result of an ECDH key agreement step.
The algorithms defined in this document are found in Table 10.
name | hash | Skip extract | context |
---|---|---|---|
HKDF SHA-256 | SHA-256 | no | XXX |
HKDF SHA-512 | SHA-512 | no | XXX |
HKDF AES-MAC-128 | AES-CBC-128 | yes | HKDF using AES-MAC as the PRF w/ 128-bit key |
HKDF AES-MAC-256 | AES-CBC-128 | yes | HKDF using AES-MAC as the PRF w/ 256-bit key |
name | label | type | description |
---|---|---|---|
salt | -20 | bstr | Random salt |
The context information structure is used to ensure that the derived keying material is "bound" to the context of the transaction. The context information structure used here is based on that defined in [SP800-56A]. By using CBOR for the encoding of the context information structure, we automatically get the same type of type and length separation of fields that is obtained by the use of ASN.1. This means that there is no need to encode the lengths for the base elements as it is done by the JOSE encoding. [CREF8]Ilari: Look to see if we need to be clearer about how the fields defined in the table are transported and thus why they have labels.
The context information structure refers to PartyU and PartyV as the two parties which are doing the key derivation. Unless the application protocol defines differently, we assign PartyU to the entity that is creating the message and PartyV to the entity that is receiving the message. By doing this association, different keys will be derived for each direction as the context information is different in each direction.
Application protocols are free to define the roles differently. For example, they could assign the PartyU role to the entity that initiates the connection and allow directly sending multiple messages over the connection in both directions without changing the role information.
The use of a transaction identifier, either in one of the supplemental fields or as the salt if one is using HKDF, ensures that a unique key is generated for each set of transactions. Combining nonce fields with the transaction identifier provides a method so that a different key is used for each message in each direction.
The context structure is built from information that is known to both entities. Some of the information is known only to the two entities, some is implied based on the application and some is explicitly transported as part of the message. The information that can be carried in the message, parameters have been defined and can be found in Table 12. These parameters are designed to be placed in the unprotected bucket of the recipient structure. (They do not need to be in the protected bucket since they already are included in the cryptographic computation by virtue of being included in the context structure.)
We encode the context specific information using a CBOR array type. The fields in the array are:
name | label | type | description |
---|---|---|---|
PartyU identity | -21 | bstr | Party U identity Information |
PartyU nonce | -22 | bstr / int | Party U provided nonce |
PartyU other | -23 | bstr | Party U other provided information |
PartyV identity | -24 | bstr | Party V identity Information |
PartyV nonce | -25 | bstr / int | Party V provided nonce |
PartyV other | -26 | bstr | Party V other provided information |
Text from here to start of next section to be removed
COSE_KDF_Context = [ AlgorithmID : int / tstr, PartyUInfo : [ ? nonce : bstr / int, ? identity : bstr, ? other : bstr ], PartyVInfo : [ ? nonce : bstr, ? identity : bstr / tstr, ? other : bstr ], SuppPubInfo : [ keyDataLength : uint, protected : bstr, ? other : bstr ], ? SuppPrivInfo : bstr ]
Recipient algorithms can be defined into a number of different classes. COSE has the ability to support many classes of recipient algorithms. In this section, a number of classes are listed and then a set of algorithms are specified for each of the classes. The names of the recipient algorithm classes used here are the same as are defined in [RFC7516]. Other specifications use different terms for the recipient algorithm classes or do not support some of our recipient algorithm classes.
The direct encryption class algorithms share a secret between the sender and the recipient that is used either directly or after manipulation as the content key. When direct encryption mode is used, it MUST be the only mode used on the message.
The COSE_encrypt structure for the recipient is organized as follows:
This recipient algorithm is the simplest, the supplied key is directly used as the key for the next layer down in the message. There are no algorithm parameters defined for this algorithm. The algorithm identifier value is assigned in Table 13.
When this algorithm is used, the protected field MUST be zero length. The key type MUST be 'Symmetric'.
name | value | description |
---|---|---|
direct | -6 | Direct use of CEK |
This recipient algorithm has several potential problems that need to be considered:
These recipient algorithms take a common shared secret between the two parties and applies the HKDF function (Section 11.1) using the context structure defined in Section 11.2 to transform the shared secret into the necessary key. Either the 'salt' parameter of HKDF or the partyU 'nonce' parameter of the context structure MUST be present. This parameter can be generated either randomly or deterministically. The requirement is that it be a unique value for the key pair in question.
If the salt/nonce value is generated randomly, then it is suggested that the length of the random value be the same length as the hash function underlying HKDF. While there is no way to guarantee that it will be unique, there is a high probability that it will be unique. If the salt/nonce value is generated deterministically, it can be guaranteed to be unique and thus there is no length requirement.
A new IV must be used if the same key is used in more than one message. The IV can be modified in a predictable manner, a random manner or an unpredictable manner. One unpredictable manner that can be used is to use the HKDF function to generate the IV. If HKDF is used for generating the IV, the algorithm identifier is set to "IV-GENERATION".
When these algorithms are used, the key type MUST be 'symmetric'.
The set of algorithms defined in this document can be found in Table 14.
name | value | KDF | description |
---|---|---|---|
direct+HKDF-SHA-256 | * | HKDF SHA-256 | Shared secret w/ HKDF and SHA-256 |
direct+HKDF-SHA-512 | * | HKDF SHA-512 | Shared secret w/ HKDF and SHA-512 |
direct+HKDF-AES-128 | * | HKDF AES-MAC-128 | Shared secret w/ AES-MAC 128-bit key |
direct+HKDF-AES-256 | * | HKDF AES-MAC-256 | Shared secret w/ AES-MAC 256-bit key |
The shared secret needs to have some method to be regularly updated over time. The shared secret forms the basis of trust. Although not used directly, it should still be subject to scheduled rotation.
In key wrapping mode, the CEK is randomly generated and that key is then encrypted by a shared secret between the sender and the recipient. All of the currently defined key wrapping algorithms for JOSE (and thus for COSE) are AE algorithms. Key wrapping mode is considered to be superior to direct encryption if the system has any capability for doing random key generation. This is because the shared key is used to wrap random data rather than data has some degree of organization and may in fact be repeating the same content.
The COSE_encrypt structure for the recipient is organized as follows:
The AES Key Wrapping algorithm is defined in [RFC3394]. This algorithm uses an AES key to wrap a value that is a multiple of 64 bits. As such, it can be used to wrap a key for any of the content encryption algorithms defined in this document. The algorithm requires a single fixed parameter, the initial value. This is fixed to the value specified in Section 2.2.3.1 of [RFC3394]. There are no public parameters that vary on a per invocation basis.
Keys may be obtained either from a key structure or from a recipient structure. If the key obtained from a key structure, the key type MUST be 'Symmetric'. Implementations encrypting and decrrypting MUST validate that the key type, key length and algorithm are correct and appropriate for the entities involved.
name | value | key size | description |
---|---|---|---|
A128KW | -3 | 128 | AES Key Wrap w/ 128-bit key |
A192KW | -4 | 192 | AES Key Wrap w/ 192-bit key |
A256KW | -5 | 256 | AES Key Wrap w/ 256-bit key |
The shared secret need to have some method to be regularly updated over time. The shared secret is forming the basis of trust, although not used directly it should still be subject to scheduled rotation.
Key Encryption mode is also called key transport mode in some standards. Key Encryption mode differs from Key Wrap mode in that it uses an asymmetric encryption algorithm rather than a symmetric encryption algorithm to protect the key. This document defines one Key Encryption mode algorithm.
When using a key encryption algorithm, the COSE_encrypt structure for the recipient is organized as follows:
The 'direct key agreement' class of recipient algorithms uses a key agreement method to create a shared secret. A KDF is then applied to the shared secret to derive a key to be used in protecting the data. This key is normally used as a CEK or MAC key, but could be used for other purposes if more than two layers are in use (see Appendix B).
The most commonly used key agreement algorithm used is Diffie-Hellman, but other variants exist. Since COSE is designed for a store and forward environment rather than an on-line environment, many of the DH variants cannot be used as the receiver of the message cannot provide any key material. One side-effect of this is that perfect forward security is not achievable. A static key will always be used for the receiver of the COSE message.
Two variants of DH that are easily supported are:
In this specification, both variants are specified. This has been done to provide the weak data origination option for use with MAC operations.
When direct key agreement mode is used, there MUST be only one recipient in the message. This method creates the key directly and that makes it difficult to mix with additional recipients. If multiple recipients are needed, then the version with key wrap needs to be used.
The COSE_encrypt structure for the recipient is organized as follows:
The basic mathematics for Elliptic Curve Diffie-Hellman can be found in [RFC6090].
ECDH is parameterized by the following:
The set of direct ECDH algorithms defined in this document are found in Table 16.
name | value | KDF | Ephemeral-Static | Key Wrap | description |
---|---|---|---|---|---|
ECDH-ES + HKDF-256 | 50 | HKDF - SHA-256 | yes | none | ECDH ES w/ HKDF - generate key directly |
ECDH-ES + HKDF-512 | 51 | HKDF - SHA-256 | yes | none | ECDH ES w/ HKDF - generate key directly |
ECDH-SS + HKDF-256 | 52 | HKDF - SHA-256 | no | none | ECDH ES w/ HKDF - generate key directly |
ECDH-SS + HKDF-512 | 53 | HKDF - SHA-256 | no | none | ECDH ES w/ HKDF - generate key directly |
ECDH-ES+A128KW | 54 | HKDF - SHA-256 | yes | A128KW | ECDH ES w/ Concat KDF and AES Key wrap w/ 128 bit key |
ECDH-ES+A192KW | 55 | HKDF - SHA-256 | yes | A192KW | ECDH ES w/ Concat KDF and AES Key wrap w/ 192 bit key |
ECDH-ES+A256KW | 56 | HKDF - SHA-256 | yes | A256KW | ECDH ES w/ Concat KDF and AES Key wrap w/ 256 bit key |
ECDH-SS+A128KW | 57 | HKDF - SHA-256 | no | A128KW | ECDH SS w/ Concat KDF and AES Key wrap w/ 128 bit key |
ECDH-SS+A192KW | 58 | HKDF - SHA-256 | no | A192KW | ECDH SS w/ Concat KDF and AES Key wrap w/ 192 bit key |
ECDH-SS+A256KW | 59 | HKDF - SHA-256 | no | A256KW | ECDH SS w/ Concat KDF and AES Key wrap w/ 256 bit key |
name | label | type | algorithm | description |
---|---|---|---|---|
ephemeral key | -1 | COSE_Key | ECDH-ES | Ephemeral Public key for the sender |
static key | -2 | COSE_Key | ECDH-ES | Static Public key for the sender |
static key id | -3 | bstr | ECDH-SS | Static Public key identifier for the sender |
This document defines these algorithms to be used with the curves P-256, P-384, P-521. Implementations MUST verify that the key type and curve are correct. Different curves are restricted to different key types. Implementations MUST verify that the curve and algorithm are appropriate for the entities involved.
Key Agreement with Key Wrapping uses a randomly generated CEK. The CEK is then encrypted using a Key Wrapping algorithm and a key derived from the shared secret computed by the key agreement algorithm.
The COSE_encrypt structure for the recipient is organized as follows:
These algorithms are defined in Table 16.
The COSE_Key object defines a way to hold a single key object. It is still required that the members of individual key types be defined. This section of the document is where we define an initial set of members for specific key types.
For each of the key types, we define both public and private members. The public members are what is transmitted to others for their usage. We define private members mainly for the purpose of archival of keys by individuals. However, there are some circumstances in which private keys may be distributed by various entities in a protocol. Examples include: entities that have poor random number generation, centralized key creation for multi-cast type operations, and protocols in which a shared secret is used as a bearer token for authorization purposes.
Key types are identified by the 'kty' member of the COSE_Key object. In this document, we define four values for the member:
name | value | description |
---|---|---|
EC2 | 2 | Elliptic Curve Keys w/ X,Y Coordinate pair |
Symmetric | 4 | Symmetric Keys |
Reserved | 0 | This value is reserved |
Two different key structures could be defined for Elliptic Curve keys. One version uses both an x and a y coordinate, potentially with point compression. This is the traditional EC point representation that is used in [RFC5480]. The other version uses only the x coordinate as the y coordinate is either to be recomputed or not needed for the key agreement operation. Currently no algorithms are defined using this key structure.
name | key type | value | description |
---|---|---|---|
P-256 | EC2 | 1 | NIST P-256 also known as secp256r1 |
P-384 | EC2 | 2 | NIST P-384 also known as secp384r1 |
P-521 | EC2 | 3 | NIST P-521 also known as secp521r1 |
The traditional way of sending EC curves has been to send either both the x and y coordinates, or the x coordinate and a sign bit for the y coordinate. The latter encoding has not been recommended in the IETF due to potential IPR issues. However, for operations in constrained environments, the ability to shrink a message by not sending the y coordinate is potentially useful.
For EC keys with both coordinates, the 'kty' member is set to 2 (EC2). The key parameters defined in this section are summarized in Table 20. The members that are defined for this key type are:
For public keys, it is REQUIRED that 'crv', 'x' and 'y' be present in the structure. For private keys, it is REQUIRED that 'crv' and 'd' be present in the structure. For private keys, it is RECOMMENDED that 'x' and 'y' also be present, but they can be recomputed from the required elements and omitting them saves on space.
name | key type | value | type | description |
---|---|---|---|---|
crv | 2 | -1 | int / tstr | EC Curve identifier - Taken from the COSE General Registry |
x | 2 | -2 | bstr | X Coordinate |
y | 2 | -3 | bstr / bool | Y Coordinate |
d | 2 | -4 | bstr | Private key |
Occasionally it is required that a symmetric key be transported between entities. This key structure allows for that to happen.
For symmetric keys, the 'kty' member is set to 3 (Symmetric). The member that is defined for this key type is:
This key structure contains only private key information, care must be taken that it is never transmitted accidentally. For public keys, there are no required fields. For private keys, it is REQUIRED that 'k' be present in the structure.
name | key type | value | type | description |
---|---|---|---|---|
k | 4 | -1 | bstr | Key Value |
There has been an attempt to limit the number of places where the document needs to impose restrictions on how the CBOR Encoder needs to work. We have managed to narrow it down to the following restrictions:
It is requested that IANA assign the following tags from the "Concise Binary Object Representation (CBOR) Tags" registry. It is requested that the tags be assigned in the 24 to 255 value range.
The tags to be assigned are:
Tag Value | Data Item | Semantics |
---|---|---|
TBD1 | COSE_Sign | COSE Signed Data Object |
TBD2 | COSE_enveloped | COSE Enveloped Data Object |
TBD3 | COSE_encryptData | COSE Encrypted Data Object |
TBD4 | COSE_Mac | COSE Mac-ed Data Object |
TBD5 | COSE_Key, COSE_KeySet | COSE Key or COSE Key Set Object |
It is requested that IANA create a new registry entitled "COSE Header Parameters". The registery is to be created as Expert Review Required.
The columns of the registry are:
The initial contents of the registry can be found in Table 1. The specification column for all rows in that table should be this document.
Additionally, the label of 0 is to be marked as 'Reserved'.
It is requested that IANA create a new registry entitled "COSE Header Algorithm Labels". The registery is to be created as Expert Review Required.
The columns of the registry are:
The initial contents of the registry can be found in Table 11, Table 12, and Table 17. The specification column for all rows in that table should be this document.
It is requested that IANA create a new registry entitled "COSE Algorithm Registry". The registery is to be created as Expert Review Required.
The initial contents of the registry can be found in Table 8, Table 7, Table 9, Table 4, Table 5, Table 6, Table 13, Table 14, Table 15, and Table 16. The specification column for all rows in that table should be this document.
It is requested that IANA create a new registry entitled "COSE Key Common Parameter" Registry. The registery is to be created as Expert Review Required.
The columns of the registry are:
This registry will be initially populated by the values in Section 7.1. The specification column for all of these entries will be this document.
It is requested that IANA create a new registry "COSE Key Type Parameters". The registery is to be created as Expert Review Required.
The columns of the table are:
This registry will be initially populated by the values in Table 20 and Table 21. The specification column for all of these entries will be this document.
It is requested that IANA create a new registry "COSE Elliptic Curve Parameters". The registery is to be created as Expert Review Required.
The columns of the table are:
This registry will be initially populated by the values in Table 18. The specification column for all of these entries will be this document.
This section registers the "application/cose" and "application/cose+cbor" media types in the "Media Types" registry. [CREF9]JLS: Should we register both or just the cose+cbor one? These media types are used to indicate that the content is a COSE_MSG. [CREF10]JLS: Should we create the equivalent of the smime-type parameter to identify the inner content type?
This section registers the "application/cose-key+cbor" and "application/cose-key-set+cbor" media types in the "Media Types" registry. These media types are used to indicate, respectively, that content is a COSE_Key or COSE_KeySet object.
This section registers a set of content formats for CoAP. ID assignment in the 24-255 range is requested.
Media Type | Encoding | ID | Reference |
---|---|---|---|
application/cose | TBD10 | [This Document] | |
application/cose-key | TBD11 | [This Document] | |
application/cose-key-set | TBD12 | [This Document |
There are security considerations:
[RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
[RFC7049] | Bormann, C. and P. Hoffman, "Concise Binary Object Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, October 2013. |
For people who prefer using a formal language to describe the syntax of the CBOR, in this section a CDDL grammar is given that corresponds to [I-D.greevenbosch-appsawg-cbor-cddl]. This grammar is informational. In the event of differences between this grammar and the prose, the prose is considered to be authoritative.
The collected CDDL can be extracted from the XML version of this document via the following XPath expression below. (Depending on the XPath evaluator one is using, it may be necessary to deal with > as an entity.)
//artwork[@type='CDDL']/text()
; This is define to make the tool quieter Internal_Types = Sig_structure / Enc_structure / MAC_structure / COSE_KDF_Context
All of the currently defined recipient algorithms classes only use two levels of the COSE_Encrypt structure. The first level is the message content and the second level is the content key encryption. However, if one uses a recipient algorithm such as RSA-KEM (see Appendix A of RSA-KEM [RFC5990], then it make sense to have three levels of the COSE_Encrypt structure.
These levels would be:
This is an example of what a triple layer message would look like. The message has the following layers:
In effect this example is a decomposed version of using the ECDH-ES+A128KW algorithm.
Size of binary file is 216 bytes
998( [ h'a10101', { 5: h'02d1f7e6f26c43d4868d87ce' }, h'64f84d913ba60a76070a9a48f26e97e863e285295a44320878caceb0763a3 34806857c67', [ [ h'', { 1: -3 }, h'5a15dbf5b282ecb31a6074ee3815c252405dd7583e078188', [ [ h'', { 1: 50, 4: h'6d65726961646f632e6272616e64796275636b406275636b 6c616e642e6578616d706c65', -1: { 1: 2, -1: 1, -2: h'b2add44368ea6d641f9ca9af308b4079aeb519f11e9b8 a55a600b21233e86e68', -3: h'1a2cf118b9ee6895c8f415b686d4ca1cef362d4a7630a 31ef6019c0c56d33de0' } }, h'' ] ] ] ] ])
The examples can be found at https://github.com/cose-wg/Examples. The file names in each section correspond the same file names in the repository. I am currently still in the process of getting the examples up there along with some control information for people to be able to check and reproduce the examples.
Examples may have some features that are in question but not yet incorporated in the document.
To make it easier to read, the examples are presented using the CBOR's diagnostic notation rather than a binary dump. A ruby based tool exists to convert between a number of formats. This tool can be installed with the command line:
gem install cbor-diag
The diagnostic notation can be converted into binary files using the following command line:
diag2cbor < inputfile > outputfile
The examples can be extracted from the XML version of this document via an XPath expression as all of the artwork is tagged with the attribute type='CBORdiag'.
This example users the following:
Size of binary file is 73 bytes
996( [ h'a1016f4145532d434d41432d3235362f3634', { }, h'546869732069732074686520636f6e74656e742e', h'd9afa663dd740848', [ [ h'', { 1: -6, 4: h'6f75722d736563726574' }, h'' ] ] ])
This example uses the following:
Size of binary file is 217 bytes
996( [ h'a10104', { }, h'546869732069732074686520636f6e74656e742e', h'2ba937ca03d76c3dbad30cfcbaeef586f9c0f9ba616ad67e9205d38576ad9 930', [ [ h'', { 1: 52, 4: h'6d65726961646f632e6272616e64796275636b406275636b6c61 6e642e6578616d706c65', -3: h'706572656772696e2e746f6f6b407475636b626f726f7567682 e6578616d706c65', "apu": h'4d8553e7e74f3c6a3a9dd3ef286a8195cbf8a23d19558ccf ec7d34b824f42d92bd06bd2c7f0271f0214e141fb779ae2856abf585a58368b01 7e7f2a9e5ce4db5' }, h'' ] ] ])
This example uses the following:
Size of binary file is 124 bytes
996( [ h'a1016e4145532d3132382d4d41432d3634', { }, h'546869732069732074686520636f6e74656e742e', h'6d1fa77b2dd9146a', [ [ h'', { 1: -5, 4: h'30313863306165352d346439622d343731622d626664362d6565 66333134626337303337' }, h'711ab0dc2fc4585dce27effa6781c8093eba906f227b6eb0' ] ] ])
This example uses the following:
Size of binary file is 374 bytes
996( [ h'a10104', { }, h'546869732069732074686520636f6e74656e742e', h'7aaa6e74546873061f0a7de21ff0c0658d401a68da738dd893748651983ce 1d0', [ [ h'', { 1: 55, 4: h'62696c626f2e62616767696e7340686f626269746f6e2e657861 6d706c65', -1: { 1: 2, -1: 3, -2: h'43b12669acac3fd27898ffba0bcd2e6c366d53bc4db71f909 a759304acfb5e18cdc7ba0b13ff8c7636271a6924b1ac63c02688075b55ef2d61 3574e7dc242f79c3', -3: h'812dd694f4ef32b11014d74010a954689c6b6e8785b333d1a b44f22b9d1091ae8fc8ae40b687e5cfbe7ee6f8b47918a07bb04e9f5b1a51a334 a16bc09777434113' } }, h'f20ad9c96134f3c6be4f75e7101c0ecc5efa071ff20a87fd1ac285109 41ee0376573e2b384b56b99' ], [ h'', { 1: -5, 4: h'30313863306165352d346439622d343731622d626664362d6565 66333134626337303337' }, h'0b2c7cfce04e98276342d6476a7723c090dfdd15f9a518e7736549e99 8370695e6d6a83b4ae507bb' ] ] ])
This example uses the following:
Size of binary file is 184 bytes
998( [ h'a10101', { 5: h'c9cf4df2fe6c632bf7886413' }, h'45fce2814311024d3a479e7d3eed063850f3f0b9f3f948677e3ae9869bcf9 ff4e1763812', [ [ h'', { 1: 50, 4: h'6d65726961646f632e6272616e64796275636b406275636b6c61 6e642e6578616d706c65', -1: { 1: 2, -1: 1, -2: h'98f50a4ff6c05861c8860d13a638ea56c3f5ad7590bbfbf05 4e1c7b4d91d6280', -3: h'f01400b089867804b8e9fc96c3932161f1934f4223069170d 924b7e03bf822bb' } }, h'' ] ] ])
This example uses the following:
Size of binary file is 97 bytes
998( [ h'a1010a', { 5: h'89f52f65a1c580933b5261a7' }, h'7b9dcfa42c4e1d3182c402dc18ef8b5637de4fb62cf1dd156ea6e6e0', [ [ h'', { 1: "dir+kdf", 4: h'6f75722d736563726574', -20: h'61616262636364646565666667676868' }, h'' ] ] ])
This example uses the following:
Size of binary file is 105 bytes
999( [ h'', { }, h'546869732069732074686520636f6e74656e742e', [ [ h'a10126', { 4: h'3131' }, h'4358e9e92b46d45134548b6e3b4eae3d2f801bce85236c7aab42968ad 8e3e92400873ed761735222a6d1f442c4bb3a3151946b16900048572455e65451 d89aaba7' ] ] ])
This example uses the following:
Size of binary file is 277 bytes
999( [ h'', { }, h'546869732069732074686520636f6e74656e742e', [ [ h'a10126', { 4: h'3131' }, h'0dc1c5e62719d8f3cce1468b7c881eee6a8088b46bf836ae956dd38fe 931991900823ea760648f2425b96c39e23ddc4b7faed56d4a9bd0f3752cfdc628 254ed0f2' ], [ h'', { 1: -9, 4: h'62696c626f2e62616767696e7340686f626269746f6e2e657861 6d706c65' }, h'012ce5b1dfe8b5aa6eaa09a54c58a84ad0900e4fdf2759ec22d1c861c ccd75c7e1c4025a2da35e512fc2874d6ac8fd862d09ad07ed2deac297b897561e 04a8d42476011eb209c016416b4247b4d1475c398d35c4ac24d1c9fadda7eefe2 857e25a500d29aea539e58e8ca7737fe450d4e87ed3f78e637c12bbd213e78ba8 3a55f7e89934' ] ] ])
This is an example of a COSE Key set. This example includes the public keys for all of the previous examples.
In order the keys are:
Size of binary file is 481 bytes
[ { -1: 1, -2: h'65eda5a12577c2bae829437fe338701a10aaa375e1bb5b5de108de4 39c08551d', -3: h'1e52ed75701163f7f9e40ddf9f341b3dc9ba860af7e0ca7ca7e9eec d0084d19c', 1: 2, 2: h'6d65726961646f632e6272616e64796275636b406275636b6c616e64 2e6578616d706c65' }, { -1: 3, -2: h'0072992cb3ac08ecf3e5c63dedec0d51a8c1f79ef2f82f94f3c737b f5de7986671eac625fe8257bbd0394644caaa3aaf8f27a4585fbbcad0f2457620 085e5c8f42ad', -3: h'01dca6947bce88bc5790485ac97427342bc35f887d86d65a089377e 247e60baa55e4e8501e2ada5724ac51d6909008033ebc10ac999b9d7f5cc2519f 3fe1ea1d9475', 1: 2, 2: h'62696c626f2e62616767696e7340686f626269746f6e2e6578616d70 6c65' }, { -1: 1, -2: h'98f50a4ff6c05861c8860d13a638ea56c3f5ad7590bbfbf054e1c7b 4d91d6280', -3: h'f01400b089867804b8e9fc96c3932161f1934f4223069170d924b7e 03bf822bb', 1: 2, 2: h'706572656772696e2e746f6f6b407475636b626f726f7567682e6578 616d706c65' }, { -1: 1, -2: h'bac5b11cad8f99f9c72b05cf4b9e26d244dc189f745228255a219a8 6d6a09eff', -3: h'20138bf82dc1b6d562be0fa54ab7804a3a64b6d72ccfed6b6fb6ed2 8bbfc117e', 1: 2, 2: h'3131' } ]
This is an example of a COSE Key set. This example includes the private keys for all of the previous examples.
In order the keys are:
Size of binary file is 782 bytes
[ { 1: 2, 2: h'6d65726961646f632e6272616e64796275636b406275636b6c616e64 2e6578616d706c65', -1: 1, -2: h'65eda5a12577c2bae829437fe338701a10aaa375e1bb5b5de108de4 39c08551d', -3: h'1e52ed75701163f7f9e40ddf9f341b3dc9ba860af7e0ca7ca7e9eec d0084d19c', -4: h'aff907c99f9ad3aae6c4cdf21122bce2bd68b5283e6907154ad9118 40fa208cf' }, { 1: 4, 2: h'6f75722d736563726574', -1: h'849b57219dae48de646d07dbb533566e976686457c1491be3a76dce a6c427188' }, { 1: 2, 2: h'62696c626f2e62616767696e7340686f626269746f6e2e6578616d70 6c65', -1: 3, -2: h'0072992cb3ac08ecf3e5c63dedec0d51a8c1f79ef2f82f94f3c737b f5de7986671eac625fe8257bbd0394644caaa3aaf8f27a4585fbbcad0f2457620 085e5c8f42ad', -3: h'01dca6947bce88bc5790485ac97427342bc35f887d86d65a089377e 247e60baa55e4e8501e2ada5724ac51d6909008033ebc10ac999b9d7f5cc2519f 3fe1ea1d9475', -4: h'00085138ddabf5ca975f5860f91a08e91d6d5f9a76ad4018766a476 680b55cd339e8ab6c72b5facdb2a2a50ac25bd086647dd3e2e6e99e84ca2c3609 fdf177feb26d' }, { 1: 2, -1: 1, 2: h'706572656772696e2e746f6f6b407475636b626f726f7567682e6578 616d706c65', -2: h'98f50a4ff6c05861c8860d13a638ea56c3f5ad7590bbfbf054e1c7b 4d91d6280', -3: h'f01400b089867804b8e9fc96c3932161f1934f4223069170d924b7e 03bf822bb', -4: h'02d1f7e6f26c43d4868d87ceb2353161740aacf1f7163647984b522 a848df1c3' }, { 1: 4, 2: h'30313863306165352d346439622d343731622d626664362d65656633 3134626337303337', -1: h'849b57219dae48de646d07dbb533566e976686457c1491be3a76dce a6c427188' }, { 1: 2, 2: h'3131', -1: 1, -2: h'bac5b11cad8f99f9c72b05cf4b9e26d244dc189f745228255a219a8 6d6a09eff', -3: h'20138bf82dc1b6d562be0fa54ab7804a3a64b6d72ccfed6b6fb6ed2 8bbfc117e', -4: h'57c92077664146e876760c9520d054aa93c3afb04e306705db60903 08507b4d3' } ]