]> Universität Bremen TZI

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

ART cbor Concise Data Definition Language Control Operator The Concise Data Definition Language (CDDL), standardized in RFC 8610, provides "control operators" as its main language extension point. RFCs have added to this extension point in both an application-specific and a more general way. The present document defines a number of additional generally applicable control operators for text conversion (bytes, integers, printf-style formatting, and JSON) and for an operation on text.

Introduction The Concise Data Definition Language (CDDL), standardized in , provides "control operators" as its main language extension point (). RFCs have added to this extension point in both an application-specific and a more general way. The present document defines a number of additional generally applicable control operators. In , the column marked t is for "target type" (left-hand side), and the column marked c is for "controller type" (right-hand side). Summary of New Control Operators in This Document

Name	t	c	Purpose
.b64u, .b64c	text	bytes	Base64 representation of byte strings
.b64u-sloppy, .b64c-sloppy	text	bytes	Sloppy-tolerant variants of the above
.hex, .hexlc, .hexuc	text	bytes	Base16 representation of byte strings
.b32, .h32	text	bytes	Base32 representation of byte strings
.b45	text	bytes	Base45 representation of byte strings
.base10	text	int	Text representation of integer numbers
.printf	text	array	Printf-formatted text representation of data items
.json	text	any	Text representation of JSON values
.join	text or bytes	array	Build text or byte string from array of components

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. Regular expressions mentioned in the text are as defined in . This specification uses terminology from . In particular, with respect to control operators, "target" refers to the left-hand-side operand and "controller" to the right-hand-side operand. "Tool" refers to tools along the lines of that described in . Note also that the data model underlying CDDL provides for text strings as well as byte strings as two separate types, which are then collectively referred to as "strings". The term "opinionated" is used in this document to explain that the selection of operators included is somewhat frugal, based on opinions about what the preferred (and likely) usage scenarios will be. Specifically, not including a potential choice doesn't by itself intend to express that the choice is unacceptable; it might still be added in a future registration if these opinions evolve.

Text Conversion

Byte Strings: Base 16 (Hex), Base 32, Base 45, and Base 64 A CDDL model often defines data that are byte strings in essence but need to be transported in various encoded forms, such as base64 or hex. This section defines a number of control operators to model these conversions. The control operators generally are of a form that could be used like this: The specification of these control operators cannot provide full coverage of the large number of transformations in use; it focuses on and additionally , as shown in . For the representations defined in , this specification uses names as inspired by Section of RFC 8949 : Control Operators for Text Conversion of Byte Strings

Name	Meaning	Reference
.b64u	Base64url, no padding
.b64u-sloppy	Base64url, no padding, sloppy
.b64c	Base64 classic, padding
.b64c-sloppy	Base64 classic, padding, sloppy
.b32	Base32, no padding
.h32	Base32 with "Extended Hex" alphabet, no padding
.hex	Base16 (hex), either case
.hexlc	Base16 (hex), lower case
.hexuc	Base16 (hex), upper case
.b45	Base45

Note that this specification is somewhat opinionated here: It does not provide base64url or base32(hex) encoding with padding or base64 classic without padding. Experience indicates that these combinations only ever occur in error, so the usability of CDDL is increased by not providing them in the first place. Also, adding "c" makes sure that any decision for classic base64 is actively taken. These control operators are "strict" in their matching, i.e., they only match base encodings that conform to the mandates of their defining documents. Note that this also means that .b64u and .b64c only match text strings composed of the set of characters defined for each of them, respectively. (This is perhaps worth pointing out explicitly as it contrasts with the "b64" literal prefix that can be used to notate byte strings in CDDL source code, which simply accepts characters from either alphabet. This behavior is different from the matching behavior of the four base64 control operators defined here.) The additional designation "sloppy" indicates that the text string is not validated for any additional bits being zero, in variance to what is specified in the paragraph that follows Table 1 in . Note that the present specification is opinionated again in not specifying a sloppy variant of base32 or base32hex, as no legacy use of sloppy base32(hex) was known at the time of writing. Base45 is known to be suboptimal for use in environments with limited data transparency (such as URLs) but is included because of its close relationship to QR codes and its wide use in health informatics (note that base45 is strongly specified not to allow sloppy forms of encoding).

Numerals Control Operator for Text Conversion of Integers

Name	Meaning	Reference
.base10	Base-ten (decimal) integer	---

The control operator .base10 allows the modeling of text strings that carry an integer number in decimal form (as a text string with digits in the usual base-ten positional numeral system), such as in the uint64/int64 formats of YANG-JSON . Again, the specification is opinionated by only providing for integer numbers represented without leading zeros, i.e., the decimal integer numerals match the regular expression 0|-?[1-9][0-9]* (of course, this is further restricted by the control type). See for more flexibility and for other numeric bases such as octal, hexadecimal, or binary conversions. Note that this control operator governs text representations of integers and should not be confused with the control operators governing text representations of byte strings (such as .b64u). This contrast is somewhat reinforced by spelling out "base" in the name .base10 as opposed to those of the byte string operators.

Printf-Style Formatting Control Operator for Printf-Style Formatting of Data Item(s)

Name	Meaning	Reference
.printf	Printf-style formatting of data item(s)	---

The control operator .printf allows the modeling of text strings that carry various formatted information, as long as the format can be represented in printf-style formatting strings as they are used in the C language (see Section 7.23.6.1 of ; note that the "C23" standard includes %b and %B for formatting into binary digits). The controller (right-hand side) of the .printf control is an array of one printf-style format string and zero or more data items that fit the individual conversion specifications in the format string. The construct matches a text string representing the textual output of an equivalent C-language printf function call that receives as arguments the format string and the data items following it in the array. Out of the functionality described for printf formatting in Section 7.23.6.1 of the C language specification , length modifiers (paragraph 7) are not used and MUST NOT be included in the format string. The "s" conversion specifier (paragraph 8) is used to interpolate a text string in UTF-8 form. The "c" conversion specifier (paragraph 8) represents a single Unicode scalar value as a UTF-8 character. The "p" and "n" conversion specifiers (paragraph 8) are not used and MUST NOT be included in the format string. In the following example, my_alg_19 matches the text string "0x0013": hexlabel = text .printf (["0x%04x", K]) ]]> The data items in the controller array do not need to be literals, as in the following example: hexlabel = text .printf (["0x%04x", K]) ]]> Here, any_alg matches the text strings "0x0013" or "0x0001" but not "0x1234".

JSON Values Some applications store complete JSON texts into text strings. The JSON value of these can easily be defined in CDDL by using the default JSON-to-CBOR conversion rules provided in Section of RFC 8949 . This is supported by a control operator similar to .cbor as defined in . Control Operator for Text Conversion of JSON Values

Name	Meaning	Reference
.json	JSON

Notes:

• JSON has known interoperability problems . While probably is not relevant to this specification, provides requirements that need to be followed to make use of the generic data model underlying CDDL. Note that the intention of is directly supported by Section of RFC 8949 . The recommendation to use text strings for representing numbers outside JSON's interoperable range is a requirement on the application data model and therefore needs to be reflected on the right-hand side of the .json control operator.
• This control operator provides no way to constrain the use of blank space or other serialization variants in the JSON representation of the data items; restrictions on the serialization to specific variants (e.g., not providing for the addition of any insignificant blank space and prescribing an order in which map entries are serialized) could be defined in future control operators.
• A .jsonseq is not provided in this document for JSON text sequences , as no use case for inclusion in CDDL is known at the time of writing; again, future control operators could address this use case.

Text Processing

Join Often, text strings need to be constructed out of parts that can best be modeled as an array. Control Operator for Text Generation from Arrays

Name	Meaning	Reference
.join	Concatenate elements of an array	---

For example, an IPv4 address in dotted-decimal might be modeled as in .

Using the .join Operator to Build Dotted-Decimal IPv4 Addresses

The elements of the controller array need to be strings (text or byte strings). The control operator matches a data item if that data item is also a string, built by concatenating the strings in the array. The result of this concatenation is of the same kind of string (text or bytes) as the first element of the array. (If there is no element in the array, the .join construct matches either kind of empty string, obviously further constrained by the control operator target.) The concatenation is performed on the sequences of bytes in the strings. If the result of the concatenation is a text string, the resulting sequence of bytes only matches the target data item if that result is a valid text string (i.e., valid UTF-8). Note that in contrast to the algorithm used in Section of RFC 8949 , there is no need for all individual byte sequences going into the concatenation to constitute valid text strings. Note that this control operator is hard to validate in the most general case, as this would require full parser functionality. Simple implementation strategies will use array elements with constant values as guideposts ("markers", such as the "." in ) for isolating the variable elements that need further validation at the CDDL data model level. Therefore, it is recommended to limit the use of .join to simple arrangements where the array elements are laid out explicitly and there are no adjacent variable elements without intervening constant values, and where these constant values do not occur within the text described by the variable elements. If more complex parsing functionality is required, the ABNF control operators (see ) may be useful; however, these cannot reach back into CDDL-specified elements like .join can.

IANA Considerations IANA has registered the contents of into the "CDDL Control Operators" registry of : New Control Operators

Name	Reference
.b64u	RFC 9741
.b64u-sloppy	RFC 9741
.b64c	RFC 9741
.b64c-sloppy	RFC 9741
.b45	RFC 9741
.b32	RFC 9741
.h32	RFC 9741
.hex	RFC 9741
.hexlc	RFC 9741
.hexuc	RFC 9741
.base10	RFC 9741
.printf	RFC 9741
.json	RFC 9741
.join	RFC 9741

Security Considerations The security considerations in apply. In addition, for the control operators defined in , the security considerations in apply.

References Normative References IANA International Organization for Standardization Technically equivalent specification text is available at . Fourth Edition Informative References

List of Figures :

List of Tables : : : : : : :

Acknowledgements suggested the need for many of the control operators defined here. The author would like to thank and for sharpening some of the mandates, for improvements to some examples, for serving as shepherd for this document and for his shepherd review, the IESG and Directorate reviewers (notably , , and ), and for serving as responsible AD and for providing a detailed AD review.