CBOR data definition language: a notational convention to express CBOR data structures.
draft-greevenbosch-appsawg-cbor-cddl-04

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2014-12-15
Replaced by draft-ietf-cbor-cddl
Stream (None)
Intended RFC status (None)
Formats plain text pdf html 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                                    B. Greevenbosch
Internet-Draft                                                    R. Sun
Intended status: Informational                       Huawei Technologies
Expires: June 19, 2015                                         C. Vigano
                                                    University of Bremen
                                                       December 16, 2014

 CBOR data definition language: a notational convention to express CBOR
                            data structures.
                draft-greevenbosch-appsawg-cbor-cddl-04

Abstract

   This document proposes a notational convention to express CBOR data
   structures.  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 June 19, 2015.

Copyright Notice

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

Greevenbosch, et al.      Expires June 19, 2015                 [Page 1]
Internet-Draft                CBOR notation                December 2014

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  3
   2.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
   3.  Definitions  . . . . . . . . . . . . . . . . . . . . . . . . .  3
   4.  Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . .  3
     4.1.  General conventions  . . . . . . . . . . . . . . . . . . .  4
     4.2.  Keywords for primitive datatypes . . . . . . . . . . . . .  4
     4.3.  Arrays . . . . . . . . . . . . . . . . . . . . . . . . . .  5
     4.4.  Structures . . . . . . . . . . . . . . . . . . . . . . . .  5
     4.5.  Maps . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
       4.5.1.  Explicit Maps  . . . . . . . . . . . . . . . . . . . .  6
       4.5.2.  Implicit Maps  . . . . . . . . . . . . . . . . . . . .  6
     4.6.  Tags . . . . . . . . . . . . . . . . . . . . . . . . . . .  7
     4.7.  Ordering . . . . . . . . . . . . . . . . . . . . . . . . .  8
   5.  Examples . . . . . . . . . . . . . . . . . . . . . . . . . . .  9
     5.1.  Moves in a computer game . . . . . . . . . . . . . . . . .  9
     5.2.  Fruit  . . . . . . . . . . . . . . . . . . . . . . . . . . 11
   6.  Using CDDL . . . . . . . . . . . . . . . . . . . . . . . . . . 14
     6.1.  As a guide to a human user . . . . . . . . . . . . . . . . 14
     6.2.  For automated verification of CBOR data structure  . . . . 14
     6.3.  For data analytics tools . . . . . . . . . . . . . . . . . 14
   7.  Open Issues  . . . . . . . . . . . . . . . . . . . . . . . . . 15
   8.  Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . 15
   9.  Security considerations  . . . . . . . . . . . . . . . . . . . 16
   10. IANA considerations  . . . . . . . . . . . . . . . . . . . . . 16
   11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 16
   Appendix A.  ABNF grammar  . . . . . . . . . . . . . . . . . . . . 16
   Appendix B.  CBOR keywords . . . . . . . . . . . . . . . . . . . . 18
   12. Normative References . . . . . . . . . . . . . . . . . . . . . 18
   Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 18

Greevenbosch, et al.      Expires June 19, 2015                 [Page 2]
Internet-Draft                CBOR notation                December 2014

1.  Requirements notation

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
Show full document text