CBOR data definition language: a notational convention to express CBOR data structures.
draft-greevenbosch-appsawg-cbor-cddl-06
The information below is for an old version of the document |
Document |
Type |
|
Active Internet-Draft (individual)
|
|
Authors |
|
Christoph Vigano
,
Henk Birkholz
|
|
Last updated |
|
2015-07-06
|
|
Replaced by |
|
RFC 8610, RFC 8610
|
|
Stream |
|
(None)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
pdf
htmlized (tools)
htmlized
bibtex
|
Stream |
Stream state |
|
(No stream defined) |
|
Consensus Boilerplate |
|
Unknown
|
|
RFC Editor Note |
|
(None)
|
IESG |
IESG state |
|
I-D Exists
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
Network Working Group C. Vigano
Internet-Draft Universitaet Bremen
Intended status: Informational H. Birkholz
Expires: January 6, 2016 Fraunhofer SIT
July 05, 2015
CBOR data definition language: a notational convention to express CBOR
data structures.
draft-greevenbosch-appsawg-cbor-cddl-06
Abstract
This document proposes a notational convention to express CBOR data
structures (RFC 7049). Its main goal is to provide an easy and
unambiguous way to express structures for protocol messages and data
formats that use CBOR.
Status of This Memo
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 January 6, 2016.
Copyright Notice
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
Vigano & Birkholz Expires January 6, 2016 [Page 1]
Internet-Draft CBOR notation July 2015
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Requirements notation . . . . . . . . . . . . . . . . . . 4
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
2. The Style of Data Structure Specification . . . . . . . . . . 4
2.1. Groups and Composition in CDDL . . . . . . . . . . . . . 5
2.1.1. Usage . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.2. Syntax . . . . . . . . . . . . . . . . . . . . . . . 8
2.2. Types . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.2.1. Values . . . . . . . . . . . . . . . . . . . . . . . 8
2.2.2. Choices . . . . . . . . . . . . . . . . . . . . . . . 8
2.2.3. Representation Types . . . . . . . . . . . . . . . . 10
2.2.4. Root type . . . . . . . . . . . . . . . . . . . . . . 10
3. Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1. General conventions . . . . . . . . . . . . . . . . . . . 11
3.2. Occurrence . . . . . . . . . . . . . . . . . . . . . . . 12
3.3. Predefined names for types . . . . . . . . . . . . . . . 12
3.4. Arrays . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.5. Maps . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.5.1. Structs . . . . . . . . . . . . . . . . . . . . . . . 14
3.5.2. Tables . . . . . . . . . . . . . . . . . . . . . . . 17
3.6. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.1. Moves in a computer game . . . . . . . . . . . . . . . . 18
4.2. Fruit . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.3. RFC 7071 . . . . . . . . . . . . . . . . . . . . . . . . 24
4.4. Examples from JSON Content Rules . . . . . . . . . . . . 28
5. Making Use of CDDL . . . . . . . . . . . . . . . . . . . . . 30
5.1. As a guide to a human user . . . . . . . . . . . . . . . 30
5.2. For automated checking of CBOR data structure . . . . . . 30
5.3. For data analysis tools . . . . . . . . . . . . . . . . . 30
6. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 31
7. Resolved Issues . . . . . . . . . . . . . . . . . . . . . . . 31
8. Security considerations . . . . . . . . . . . . . . . . . . . 32
9. IANA considerations . . . . . . . . . . . . . . . . . . . . . 32
10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 32
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 32
Show full document text