Concise data definition language (CDDL): a notational convention to express CBOR data structures
draft-ietf-cbor-cddl-02

Document Type Active Internet-Draft (cbor WG)
Last updated 2018-03-15 (latest revision 2018-02-26)
Replaces draft-greevenbosch-appsawg-cbor-cddl
Stream IETF
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream WG state Waiting for WG Chair Go-Ahead (wg milestone: May 2018 - Submit CDDL to IESG ... )
Revised I-D Needed - Issue raised by WGLC
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                        H. Birkholz
Internet-Draft                                            Fraunhofer SIT
Intended status: Standards Track                               C. Vigano
Expires: August 30, 2018                             Universitaet Bremen
                                                              C. Bormann
                                                 Universitaet Bremen TZI
                                                       February 26, 2018

  Concise data definition language (CDDL): a notational convention to
                      express CBOR data structures
                        draft-ietf-cbor-cddl-02

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 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 August 30, 2018.

Copyright Notice

   Copyright (c) 2018 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

Birkholz, et al.         Expires August 30, 2018                [Page 1]
Internet-Draft                    CDDL                     February 2018

   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.

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  . . . . . . . . . . . . .   6
       2.1.1.  Usage . . . . . . . . . . . . . . . . . . . . . . . .   8
       2.1.2.  Syntax  . . . . . . . . . . . . . . . . . . . . . . .   8
     2.2.  Types . . . . . . . . . . . . . . . . . . . . . . . . . .   9
       2.2.1.  Values  . . . . . . . . . . . . . . . . . . . . . . .   9
       2.2.2.  Choices . . . . . . . . . . . . . . . . . . . . . . .   9
       2.2.3.  Representation Types  . . . . . . . . . . . . . . . .  11
       2.2.4.  Root type . . . . . . . . . . . . . . . . . . . . . .  11
   3.  Syntax  . . . . . . . . . . . . . . . . . . . . . . . . . . .  12
     3.1.  General conventions . . . . . . . . . . . . . . . . . . .  12
     3.2.  Occurrence  . . . . . . . . . . . . . . . . . . . . . . .  13
     3.3.  Predefined names for types  . . . . . . . . . . . . . . .  14
     3.4.  Arrays  . . . . . . . . . . . . . . . . . . . . . . . . .  15
     3.5.  Maps  . . . . . . . . . . . . . . . . . . . . . . . . . .  15
       3.5.1.  Structs . . . . . . . . . . . . . . . . . . . . . . .  16
       3.5.2.  Tables  . . . . . . . . . . . . . . . . . . . . . . .  19
       3.5.3.  Cuts in Maps  . . . . . . . . . . . . . . . . . . . .  19
     3.6.  Tags  . . . . . . . . . . . . . . . . . . . . . . . . . .  20
     3.7.  Unwrapping  . . . . . . . . . . . . . . . . . . . . . . .  21
     3.8.  Controls  . . . . . . . . . . . . . . . . . . . . . . . .  22
       3.8.1.  Control operator .size  . . . . . . . . . . . . . . .  22
       3.8.2.  Control operator .bits  . . . . . . . . . . . . . . .  23
       3.8.3.  Control operator .regexp  . . . . . . . . . . . . . .  24
       3.8.4.  Control operators .cbor and .cborseq  . . . . . . . .  25
       3.8.5.  Control operators .within and .and  . . . . . . . . .  25
       3.8.6.  Control operators .lt, .le, .gt, .ge, .eq, .ne, and
               .default  . . . . . . . . . . . . . . . . . . . . . .  26
     3.9.  Socket/Plug . . . . . . . . . . . . . . . . . . . . . . .  27
     3.10. Generics  . . . . . . . . . . . . . . . . . . . . . . . .  28
     3.11. Operator Precedence . . . . . . . . . . . . . . . . . . .  28
   4.  Making Use of CDDL  . . . . . . . . . . . . . . . . . . . . .  30
Show full document text