CBOR data definition language: a notational convention to express CBOR data structures.
draft-greevenbosch-appsawg-cbor-cddl-02
| The information below is for an old version of the document |
| Document |
Type |
|
Active Internet-Draft (individual)
|
|
Last updated |
|
2014-06-26
|
|
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 Huawei Technologies
Intended status: Informational June 27, 2014
Expires: August 18, 2014
CBOR data definition language: a notational convention to express CBOR
data structures.
draft-greevenbosch-appsawg-cbor-cddl-02
Abstract
This document proposes a notational convention to express CBOR data
structures. Its main goal is to make it easy to express message
structures for protocols 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 December 27, 2014.
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
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Greevenbosch Expires August 18, 2014 [Page 1]
Internet-Draft CBOR notation February 2014
Table of Contents
1. Requirements notation . . . . . . . . . . . . . . . . . . . . 2
2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 3
4. Notational conventions . . . . . . . . . . . . . . . . . . . 3
4.1. General conventions . . . . . . . . . . . . . . . . . . . 3
4.2. Keywords for primitive datatypes . . . . . . . . . . . . 3
4.3. Arrays . . . . . . . . . . . . . . . . . . . . . . . . . 4
4.4. Structures . . . . . . . . . . . . . . . . . . . . . . . 4
4.5. Maps . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4.6. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.7. Optional variables . . . . . . . . . . . . . . . . . . . 7
5. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.1. Moves in a computer game . . . . . . . . . . . . . . . . 9
5.2. Fruit . . . . . . . . . . . . . . . . . . . . . . . . . . 11
6. Philosophy . . . . . . . . . . . . . . . . . . . . . . . . . 14
7. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 14
8. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 14
9. Security considerations . . . . . . . . . . . . . . . . . . . 15
10. IANA considerations . . . . . . . . . . . . . . . . . . . . . 15
11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 15
12. Normative References . . . . . . . . . . . . . . . . . . . . 15
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 15
1. Requirements notation
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
2. Introduction
In this document, a notational convention to express CBOR [RFC7049]
data structures is defined.
The main goal for the convention is to provide a unified notation
that can be used when defining protocols that use CBOR.
The CBOR notational convention has the following goals:
(G1) Able to provide an unambiguous description of a CBOR data
structures.
(G2) Easy for humans to read and write.
(G3) Flexibility to express the freedoms of choice in the CBOR data
format.
Greevenbosch Expires August 18, 2014 [Page 2]
Internet-Draft CBOR notation February 2014
(G4) Possibility to restrict format choices where appropriate.
(G5) Able to express common CBOR datatypes and structures.
(G6) Human and machine readable and processable.
(G7) Usable for automatic verification of whether CBOR data is
compliant to a predefined format.
Show full document text