Concise Binary Object Representation (CBOR) Tag for Error Indications
draft-richter-cbor-error-tag-01

Document Type Active Internet-Draft (individual)
Last updated 2019-01-30
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                                         J. Richter
Internet-Draft                               pdv Financial Software GmbH
Intended status: Informational                                C. Bormann
Expires: August 3, 2019                          Universitaet Bremen TZI
                                                        January 30, 2019

 Concise Binary Object Representation (CBOR) Tag for Error Indications
                    draft-richter-cbor-error-tag-01

Abstract

   The Concise Binary Object Representation (CBOR, RFC 7049) is a data
   format whose design goals include the possibility of extremely small
   code size, fairly small message size, and extensibility without the
   need for version negotiation.

   In CBOR, one point of extensibility is the definition of CBOR tags.
   While CBOR defines representations for null values and for an
   undefined value, there is no convention for expressing errors or
   exceptions in data structures, where the actual value desired could
   not be calculated due to an error.  The present specification defines
   a tag for such error indications, enabling the addition of varying
   levels of detail.

Note to Readers

   Please discuss this draft on the mailing list cbor@ietf.org -
   subscribe at https://www.ietf.org/mailman/listinfo/cbor to follow the
   discussions.

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 3, 2019.

Richter & Bormann        Expires August 3, 2019                 [Page 1]
Internet-Draft       CBOR Tag for Error Indications         January 2019

Copyright Notice

   Copyright (c) 2019 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 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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Error Format  . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  CDDL typenames  . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .   6
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   6

1.  Introduction

   The Concise Binary Object Representation (CBOR, [RFC7049]) provides
   for the interchange of structured data without a requirement for a
   pre-agreed schema.  RFC 7049 defines a basic set of data types, as
   well as a tagging mechanism that enables extending the set of data
   types supported via an IANA registry.

   In CBOR, one point of extensibility is the definition of CBOR tags.
   While CBOR defines representations for null values and for an
   undefine value, there is no convention for expressing errors or
   exceptions in data structures.  The present specification defines a
   tag for such error indications, enabling varying levels of detail.

Richter & Bormann        Expires August 3, 2019                 [Page 2]
Internet-Draft       CBOR Tag for Error Indications         January 2019

2.  Error Format

   An error value is indicated by CBOR tag TBD101, which tags a data
   item that may contain additional information about the error value:

   o  If no further information is provided, the data item is the CBOR
      value null.

   o  If a diagnostic text string is provided, the data item is that
      text string.

   o  If more detailed information is provided, the data item is a map
      (CBOR major type 5), with text string or integer keys and values
Show full document text