Internet-Draft | Managing CBOR numbers in Internet-Drafts | February 2024 |
Bormann | Expires 1 September 2024 | [Page] |
CBOR-based protocols often make use of numbers allocated in a registry. During development of the protocols, those numbers may not yet be available. This impedes the generation of data models and examples that actually can be used by tools.¶
This short draft proposes a common way to handle these situations,
without any changes to existing tools.
Also, in conjunction with the application-oriented EDN literal "e
", a
further reduction in editorial processing of CBOR examples around the
time of approval can be achieved.¶
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 https://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 1 September 2024.¶
Copyright (c) 2024 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 (https://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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
(Please see abstract.) [RFC8949] [I-D.bormann-cbor-e-ref]¶
A CBOR-based protocol might want to define a structure using CDDL [RFC8610][RFC9165], like that in Figure 1 (based on [RFC9290]):¶
The key numbers shown in this structure are likely to be intended for allocation in an IANA section.¶
The key numbers will be used in an example in the specification such as shown in Figure 2.¶
However, during development, these numbers are not yet fixed; they are likely to move around as parts of the specification are added or deleted.¶
What not to do during development:¶
This makes the model and the examples compile/check out even before having allocated the actually desired numbers, but it also leads to several problems:¶
It becomes hard to assess what the storage/transmission cost of these structures will be.¶
What is being checked in the CI (continuous integration) for the document is rather different from the final form.¶
Draft implementations trying to make use of these provisional structures have to cater for text strings, which may not actually be needed in the final form (which might expose specification bugs once numbers are used, too late in the process).¶
The work needed to put in the actual numbers, once allocated, is significant and error-prone.¶
It is not certain the CI system used during development can interact with the RFC editor's way of editing the document for publication.¶
To make the transition to a published document easier, the document is instead written with the convention demonstrated in the following example:¶
This document uses the keys for a map as an example. Other such constructs involving assigned numbers might also require temporary values for exposition in a specification, e.g., CBOR tags. For the sake of keeping this document short, examples for these are not given.¶
Including examples of other things that generate the need for temporary numbers, like tags, would be good.¶
CPA is short for "code point allocation", and is a reliable search key for finding the places that need to be updated after allocation.An earlier concept for this draft used TBD in place of CPA, as do many draft specifications being worked on today. TBD is better recognized than CPA, but also could be misunderstood to mean further work by the spec developer is required. A document submitted for publication should not really have "TBD" in it.¶
In the IANA section, the table to go into the registry is prepared as follows:¶
Key value | Name | CDDL Type | Brief description | Reference |
---|---|---|---|---|
CPA-1 | title |
text / tag38
|
short, human-readable summary of the problem shape | RFC XXXX |
CPA-2 | detail |
text / tag38
|
human-readable explanation specific to this occurrence of the problem | RFC XXXX |
CPA-3 | instance |
~uri
|
URI reference identifying specific occurrence of the problem | RFC XXXX |
CPA-4 | response-code |
uint .size 1
|
CoAP response code | RFC XXXX |
CPA-5 | base-uri |
~uri
|
Base URI | RFC XXXX |
CPA-6 | base-lang |
tag38-ltag
|
Base language tag (see tag38) | RFC XXXX |
CPA-7 | base-rtl |
tag38-direction
|
Base writing direction (see tag38) | RFC XXXX |
The provisionally made up key numbers will then be used in an example in the specification such as:¶
A "removeInRFC" note in the draft points the RFC editor to the present
document so the RFC editor knows what needs to be done at which point.
In the publication process, it is easy to remove the -CPA
suffixes
and CPA
prefixes for the RFC editor while filling in the actual IANA
allocated numbers and removing the note.¶
Note that in Table 1, the first column uses the name "CPA-1" for a value that in the rest of the document is assumed to be "-1" (and indicating a preference by the document author for this number); IANA as well as the designated experts involved are expected by the present document to decode this notation.¶
This document uses the CPA (code point allocation) convention
described in [I-D.bormann-cbor-draft-numbers].
For each entry, please remove the prefix "CPA" from the indicated
value of the column <REG_COLUMN>
, and replace the residue with the
value assigned by IANA; perform the same substitution for all other
occurrences of the prefix "CPA" in the document.
Finally, please remove this note.¶
This document uses the CPA (code point allocation) convention
described in [I-D.bormann-cbor-draft-numbers].
For each item whose key textual identifier has suffix "-CPA", please remove the suffix.
Then, consider the residue of the suffix removal, and replace the
key numeric identifier with the value assigned by IANA in the
<REG_COLUMN_1>
of the registry <REG_NAME>
, for the entry where
the value in the <REG_COLUMN_2>
is equal to the residue.
Finally, please remove this note.¶
The RFC editor with IANA would then execute these instructions as shown in Table 2 and Figure 7 (assuming the unlikely case that all numbers allocated are ten times the number proposed):¶
Key value | Name | CDDL Type | Brief description | Reference |
---|---|---|---|---|
-10 | title |
text / tag38
|
short, human-readable summary of the problem shape | RFC XXXX |
-20 | detail |
text / tag38
|
human-readable explanation specific to this occurrence of the problem | RFC XXXX |
-30 | instance |
~uri
|
URI reference identifying specific occurrence of the problem | RFC XXXX |
-40 | response-code |
uint .size 1
|
CoAP response code | RFC XXXX |
-50 | base-uri |
~uri
|
Base URI | RFC XXXX |
-60 | base-lang |
tag38-ltag
|
Base language tag (see tag38) | RFC XXXX |
-70 | base-rtl |
tag38-direction
|
Base writing direction (see tag38) | RFC XXXX |
Many documents have examples (which might even involve signatures over the contents) that depend on the assignments in more than the trivial way shown above, and regenerating them may not be easy for the RFC editor to do.¶
Therefore, for these documents we need another step involving the authors:¶
Immediately after allocation, but before the RFC-Editor EDIT step, the authors need to regenerate these examples and other generated content depending on the exact allocations.¶
In the current process, allocation is usually done after IESG approval, after IANA action, so we would need to halt the EDIT step for this regeneration.¶
Alternatively, we could be more aggressive in invoking some kind of IANA Early Allocation process, near the end of the IESG review. One way to do this with current tooling and process is to perform a late form of actual IANA "Early" Allocation. Or we could amend [BCP9] and/or [BCP100] in a more fundamental way.¶
We probably need an indicator in addition to CPA that signifies an example or other text must be regenerated (vs. simply be updated by IANA) when proposed numbers are updated by IANA.¶
[I-D.bormann-cbor-e-ref] defines a CBOR diagnostic notation application extension that
allows CBOR diagnostic notation to reference constants defined in a
CDDL model, the e''
application extension.¶
If the draft contains a CDDL model that includes definitions of
constants that may then be used in CBOR diagnostic notation, the use
of e''
constant references makes it unnecessary to change the
constant value in the example when final values are defined for these
constants.
(This application extension also can make the CBOR diagnostic notation
more readable and less distracting, replacing constructs such as¶
/ title-CPA / -1¶
by¶
e'title'¶
which removes the need to mention "CPA" and to provide a potentially distracting copy of the value assignment in the example.)¶
This document makes no requests of IANA. However, it specifies a procedure that can be followed during draft development that has a specific role for IANA and the interaction between RFC editor and IANA at important points during this development. This procedure is intended to be as little of an onus as possible, but that is the author's assessment only. IANA feedback is therefore requested.¶
The security considerations of [RFC8610] and [RFC8949] apply.¶
This document was motivated by the AUTH48 experience for RFC 9200..RFC 9203. Then, Jaime Jiménez made me finally write this document. Marco Tiloca provided useful comments on an early presentation of this idea. Michael Richardson pointed out the issues that led to Section 4.1. Carl Wallace provided further comments shining light on the practical aspects of the proposals.¶