]> Universität Bremen TZI

Postfach 330440 Bremen D-28359 Germany +49-421-218-63921 cabo@tzi.org

Applications and Real-Time CBOR CBOR (STD 94, RFC 8949) defines "Deterministically Encoded CBOR" in its Section 4.2, providing some flexibility for application specific decisions. To facilitate Deterministic Encoding to be offered as a selectable feature of generic encoders, the present document discusses a Common CBOR Deterministic Encoding Profile that can be shared by a large set of applications with potentially diverging detailed requirements. The concept of Application Profiles is layered on top of the Common CBOR Deterministic Encoding Profile and can address those more application specific requirements. The document defines the application profile "Gordian dCBOR" as an example of an application profile built on the Common CBOR Deterministic Encoding Profile. About This Document Status information for this document may be found at . Discussion of this document takes place on the Concise Binary Object Representation Maintenance and Extensions (CBOR) Working Group mailing list (), which is archived at . Subscribe at . Source for this draft and an issue tracker can be found at .

Introduction CBOR (STD 94, RFC 8949) defines "Deterministically Encoded CBOR" in its Section 4.2, providing some flexibility for application specific decisions. To facilitate Deterministic Encoding to be offered as a selectable feature of generic encoders, the present document discusses a Common CBOR Deterministic Encoding Profile that can be shared by a large set of applications with potentially diverging detailed requirements. The concept of Application Profiles is layered on top of the Common CBOR Deterministic Encoding Profile and can address those more application specific requirements. The document defines the application profile "Gordian dCBOR" as an example of an application profile built on the Common CBOR Deterministic Encoding Profile.

Conventions and Definitions 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.

Common CBOR Deterministic Encoding Profile defines Core Deterministic Encoding Requirements for CBOR. It mandates to keep with what are only recommendations for Preferred Encoding for regular CBOR encoders. It adds mandates for definite-length encoding and for a map ordering based on lexicographic ordering of the (deterministically) encoded map keys. Note that this specific set of requirements is elective -- in principle, other variants of deterministic encoding can be defined (and have been, being phased out slowly, as detailed in ), or (as many applications of CBOR do today) deterministic encoding is not used at all. The core requirements are designed, however, to provide well-understood and easy to implement rules while maximizing coverage, i.e., the subset of CBOR data items that are fully specified by these rules, and also placing minimal burden on implementations. picks up on the interaction of extensibility (CBOR tags) and deterministic encoding. CBOR itself uses some tags to increase the range of its basic generic data types, e.g., tag 2/3 extend the range of basic major types 0/1 in a seamless way. recommends handling this transition the same way as with the transition between different integer representation lengths in the basic generic data model, i.e., by mandating the Preferred Encoding ().

1. The Common CBOR Deterministic Encoding Profile turns this recommendation into a mandate: Integers that can be represented by basic major type 0 and 1 are encoded using the deterministic encoding defined for them, and integers outside this range are encoded using the preferred serialization () of tag 2 and 3 (i.e., no leading zeros).

Most tags capture more specific application semantics and therefore may be harder to define a deterministic encoding for. While the deterministic encoding of their tag internals is often covered by the Core Deterministic Encoding Requirements, the mapping of diverging platform application data types on the tag contents may be hard to do in a deterministic way; see for more explanation as well as examples. As the Common CBOR Deterministic Encoding Profile would continually need to address additional issues raised by the registration of new tags, this specification RECOMMENDS that new tag registrations address deterministic encoding in the context of this Profile. A particularly difficult field to obtain deterministic encoding for is floating point numbers, partially because they themselves are often obtained from processes that are not deterministic between platforms. See for more details. presents a number of choices, which need to be made to obtain a Common CBOR Deterministic Encoding Profile. Specifically (in the order of the bullet list at the end of ):

1. Besides the mandated use of preferred encoding, there is no further specific action for the different zero values, e.g., an encoder that is asked by an application to represent a negative floating point zero will generate 0xf98000.
2. There is no attempt to mix integers and floating point numbers, i.e., all floating point values are encoded as the preferred floating-point representation that accurately represents the value, independent of whether the floating point value is, mathematically, an integral value (choice 2 of the second bullet).
3. There is no special handling of NaN values, except that the preferred encoding rules also apply to NaNs with payloads, using the canonical encoding of NaNs as defined in . Typically, most applications that employ NaNs in their storage and communication interfaces will only use the NaN with payload 0, which encodes as 0xf97e00.
4. There is no special handling of subnormal values.
5. The Common CBOR Deterministic Encoding Profile does not presume equivalence of floating point values with other representation (e.g., tag 4/5) with basic floating point values.

The main intent here is to preserve the basic generic data model, so application profiles can make their own decisions. For an example of that, see . While is a relatively terse document that is not always easy to interpret, to this author its intent appears to be aligned with that of the Common CBOR Deterministic Encoding Profile defined here.

Application Profiles The dCBOR Application Profile specifies the use of Deterministic Encoding as defined in (see also for more information) together with some application-level rules. As an example, the rules for Gordian dCBOR are specified in this section. The application-level rules specified by an Application Profile are based on the same Common CBOR Deterministic Encoding Profile; they do not "fork" CBOR. An Application Profile implementation produces well-formed, deterministically encoded CBOR according to , and existing generic CBOR decoders will therefore be able to decode it, including those that check for Deterministic Encoding. Similarly, generic CBOR encoders will be able to produce valid CBOR that can be processed by Application Profile implementations, if handed Application Profile conforming data model level information from an application. Please note that the separation between standard CBOR processing and the processing required by the Application Profile is a conceptual one: Both Application Profile processing and standard CBOR processing can be combined into a special dCBOR/CBOR encoder/decoder. An Application Profile is intended to be used in conjunction with an application, which typically will use a subset of the CBOR generic data model, which in turn influences which subset of the application profile is used. As a result, an Application Profile places no direct requirement on what subset of CBOR is implemented. For instance, while the dCBOR application profile defines rules for the processing of floating point values, there is no requirement that dCBOR implementations support floating point numbers (or any other kind of number, such as arbitrary precision integers or 64-bit negative integers) when they are used with applications that do not use them.

Gordian dCBOR Gordian dCBOR provides an application profile that requires encoders to produce valid CBOR in deterministic encoding as defined in the Common CBOR Deterministic Encoding Profile. Gordian dCBOR also requires dCBOR decoders to reject CBOR data items that were not deterministically encoded. Beyond the Common CBOR Deterministic Encoding Profile, dCBOR imposes certain limitations on the CBOR basic generic data model. Some items that can be represented in the CBOR basic generic data model are entirely outlawed by this application profile. Other items are represented by what are considered equivalent data items by the dCBOR equivalence model, so a recipient application might receive data that may not be the same data in the CBOR equivalence model as the ones the generating application produced. These restrictions mainly are about numeric values, which are therefore the subject of the main subsection of this section.

Removing Simple Values Only the three simple values false (0xf4), true (0xf5), and null (0xf6) are allowed at the application level; the remaining 253 values must be rejected.

Removing Integer Values Only the integer values in range [-2⁶³, 2⁶⁴-1] can be expressed in dCBOR. Note that the range is asymmetric, with only 2⁶³ negative values, but 2⁶⁴ unsigned (non-negative) values, creating an (approximately) 64.6 bit integer. This maps to a choice between a platform 64-bit two's complement signed integer (often called int64) and a 64-bit unsigned integer (uint64). (Specific applications will, of course, further restrict valid ranges of integers, based on their position and semantics in the CBOR data item.)

Numeric Reduction of Floating-Point Values dCBOR implementations that do support floating point numbers MUST perform the following two reductions of numeric values when constructing CBOR data items:

1. When representing integral floating point values (floating point values with a zero fractional part), check whether the mathematically identical value can be represented as a dCBOR integer value. If that is the case, convert the integral floating point to that mathematically identical integer value before encoding it. (Deterministic Encoding will then ensure the shortest length encoding is used.) This means that if a floating point value has a non-zero fractional part, or an exponent that takes it out of the range of basic integers, the original floating point value is used for encoding. (Specifically, conversion to a bignum is never considered.) This also means that the three representations of a zero number in CBOR (0, 0.0, -0.0 in diagnostic notation) are all reduced to the basic integer 0 (with preferred encoding 0x00). Note that this reduction can turn valid maps into invalid ones, as it can create duplicate keys, e.g., for: This means that, at the application level, the application MUST prevent the creation of maps that would turn invalid in dCBOR processing.
2. In addition, represent all NaN values by using the quiet NaN value having the half-width CBOR representation 0xf97e00 before encoding.

dCBOR-based applications MUST accept these "reduced" numbers in place of the original value, e.g., a dCBOR-based application that expects a floating point value needs to accept a basic integer value in its place (and, if needed, convert it to a floating point value for its own further processing). dCBOR-based applications MUST NOT accept numbers that have not been reduced as specified in this section, except maybe by making the unreduced numbers available for their diagnostic value when there has been an explicit request to do so. This is similar to a checking flag mentioned in Section 5.1 (API Considerations) of being set by default.

Extensibility does not discuss extensibility. A meaningful way to handle extensibility in this application profile would be to lift value range restrictions, keeping the profile-specific equivalence rules show here intact and possibly adding equivalences as needed for newly allowed values. This requires further discussion.

Implementation Status (Boilerplate as per :) This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in . The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist. According to , "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".

Gordian dCBOR Application Profile

TypeScript

• Implementation Location:
• Primary Maintainer:
• Languages: TypeScript (transpiles to JavaScript)
• Coverage:
• Testing:
• Licensing:

Swift

• Implementation Location:
• Primary Maintainer:
• Languages: Swift
• Coverage:
• Testing:
• Licensing: BSD-2-Clause-Patent

Rust

• Implementation Location:
• Primary Maintainer:
• Languages: Rust
• Coverage:
• Testing:
• Licensing: Custom

Ruby

• Implementation Location:
• Primary Maintainer: Carsten Bormann
• Languages: Ruby
• Coverage: Complete specification; complemented by CBOR encoder/decoder and command line interface from and deterministic encoding from . Based on a previous version of dCBOR that had fewer value restrictions, to be updated.
• Testing:
• Licensing: Apache-2.0

Security Considerations TODO Security

IANA Considerations This document has no IANA actions.

References Normative References 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. This document obsoletes RFC 7049, providing editorial improvements, new details, and errata fixes while keeping full compatibility with the interchange format of RFC 7049. It does not create a new version of the format. IEEE In 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. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Informative References Universität Bremen TZI CBOR (STD 94, RFC 8949) defines "Deterministically Encoded CBOR" in its Section 4.2. The present document provides additional information about use cases, deployment considerations, and implementation choices for Deterministic Encoding. Blockchain Commons Blockchain Commons CBOR (RFC 8949) defines "Deterministically Encoded CBOR" in its Section 4.2. The present document provides the application profile "dCBOR" that can be used to help achieve interoperable deterministic encoding. Discussion Venues This note is to be removed before publishing as an RFC. Source for this draft and an issue tracker can be found at https://github.com/BlockchainCommons/WIPs-IETF-draft-deterministic- cbor. n.d. n.d. n.d. n.d. n.d. n.d. Independent This document describes a deterministic encoding scheme for CBOR intended for usage in high-end computing platforms like mobile phones, Web browsers, and Web servers. In addition to enhancing interoperability, deterministic encoding can also support cryptographic operations like signing CBOR data items. Using this specification, the latter can achieved without wrapping such data in byte strings or depend on non-standard canonicalization procedures. This document describes a simple process that allows authors of Internet-Drafts to record the status of known implementations by including an Implementation Status section. This will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. This process is not mandatory. Authors of Internet-Drafts are encouraged to consider using the process for their documents, and working groups are invited to think about applying the process to all of their protocol specifications. This document obsoletes RFC 6982, advancing it to a Best Current Practice.

Acknowledgments of this document is based on the work of Wolf McNally and Christopher Allen as documented in and discussed in 2023 in the CBOR working group.

Contributors Blockchain Commons

wolf@wolfmcnally.com

Blockchain Commons

christophera@lifewithalacrity.com

Independent

Montpellier France anders.rundgren.net@gmail.com https://www.linkedin.com/in/andersrundgren/