qcbor_common.h

Go to the documentation of this file.

/* ==========================================================================
 * qcbor_common -- Common definitions for encding and decoding.
 *
 * Copyright (c) 2016-2018, The Linux Foundation.
 * Copyright (c) 2018-2024, Laurence Lundblade.
 * Copyright (c) 2021, Arm Limited.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer in the documentation and/or other materials provided
 *       with the distribution.
 *     * Neither the name of The Linux Foundation nor the names of its
 *       contributors, nor the name "Laurence Lundblade" may be used to
 *       endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ========================================================================= */
 
#ifndef qcbor_common_h
#define qcbor_common_h
 
#ifdef __cplusplus
extern "C" {
#if 0
} // Keep editor indention formatting happy
#endif
#endif
 
#define QCBOR_VERSION_MAJOR 2
#define QCBOR_VERSION_MINOR 0
#define QCBOR_VERSION_PATCH 0
 
/* This is an alpha (not ready for commercial use) release of 2.0.0 */
 
#define QCBOR_SPIFFY_DECODE
 
 
 
/* Standard CBOR Major type for positive integers of various lengths. */
#define CBOR_MAJOR_TYPE_POSITIVE_INT 0
 
/* Standard CBOR Major type for negative integer of various lengths. */
#define CBOR_MAJOR_TYPE_NEGATIVE_INT 1
 
/* Standard CBOR Major type for an array of arbitrary 8-bit bytes. */
#define CBOR_MAJOR_TYPE_BYTE_STRING  2
 
/* Standard CBOR Major type for a UTF-8 string. Note this is true 8-bit UTF8
 * with no encoding and no NULL termination. */
#define CBOR_MAJOR_TYPE_TEXT_STRING  3
 
/* Standard CBOR Major type for an ordered array of other CBOR data items. */
#define CBOR_MAJOR_TYPE_ARRAY        4
 
/* Standard CBOR Major type for CBOR MAP. Maps an array of pairs. The
 * first item in the pair is the "label" (key, name or identfier) and the second
 * item is the value.  */
#define CBOR_MAJOR_TYPE_MAP          5
 
/* Standard CBOR major type for a tag number. This creates a CBOR "tag" that
 * is the tag number and a data item that follows as the tag content.
 *
 * Note that this was called an optional tag in RFC 7049, but there's
 * not really anything optional about it. It was misleading. It is
 * renamed in RFC 8949.
 */
#define CBOR_MAJOR_TYPE_TAG          6
#define CBOR_MAJOR_TYPE_OPTIONAL     6
 
/* Standard CBOR simple types like float, the values true, false, null... */
#define CBOR_MAJOR_TYPE_SIMPLE       7
 
 
 
 
/*
 * Tags that are used with CBOR_MAJOR_TYPE_OPTIONAL. These
 * are types defined in RFC 8949 and some additional ones
 * in the IANA CBOR tags registry.
 */
#define CBOR_TAG_DATE_STRING    0
#define CBOR_TAG_DATE_EPOCH     1
#define CBOR_TAG_POS_BIGNUM     2
#define CBOR_TAG_NEG_BIGNUM     3
#define CBOR_TAG_DECIMAL_FRACTION  4
#define CBOR_TAG_BIGFLOAT       5
#define CBOR_TAG_COSE_ENCRYPT0 16
#define CBOR_TAG_COSE_ENCRYPTO 16
#define CBOR_TAG_COSE_MAC0     17
#define CBOR_TAG_COSE_SIGN1    18
#define CBOR_TAG_ENC_AS_B64URL 21
#define CBOR_TAG_ENC_AS_B64    22
#define CBOR_TAG_ENC_AS_B16    23
#define CBOR_TAG_CBOR          24
#define CBOR_TAG_URI           32
#define CBOR_TAG_B64URL        33
#define CBOR_TAG_B64           34
#define CBOR_TAG_REGEX         35
#define CBOR_TAG_MIME          36
#define CBOR_TAG_BIN_UUID      37
#define CBOR_TAG_CWT           61
#define CBOR_TAG_CBOR_SEQUENCE 63
#define CBOR_TAG_COSE_ENCRYPT  96
#define CBOR_TAG_ENCRYPT       96
#define CBOR_TAG_COSE_MAC      97
#define CBOR_TAG_MAC           97
#define CBOR_TAG_COSE_SIGN     98
#define CBOR_TAG_SIGN          98
#define CBOR_TAG_DAYS_EPOCH    100
#define CBOR_TAG_GEO_COORD     103
#define CBOR_TAG_BINARY_MIME   257
#define CBOR_TAG_DAYS_STRING   1004
#define CBOR_TAG_CBOR_MAGIC    55799
 
#define CBOR_TAG_INVALID16 0xffff
#define CBOR_TAG_INVALID32 0xffffffff
#define CBOR_TAG_INVALID64 0xffffffffffffffff
 
#define CBOR_TAG_ANY (CBOR_TAG_INVALID64 - 1)
 
 
 
 
typedef enum {
   QCBOR_SUCCESS = 0,
 
   QCBOR_ERR_BUFFER_TOO_SMALL = 1,
 
   QCBOR_ERR_ENCODE_UNSUPPORTED = 2,
 
   QCBOR_ERR_BUFFER_TOO_LARGE = 3,
 
   QCBOR_ERR_ARRAY_NESTING_TOO_DEEP = 4,
 
   QCBOR_ERR_CLOSE_MISMATCH = 5,
 
   QCBOR_ERR_ARRAY_TOO_LONG = 6,
 
   QCBOR_ERR_TOO_MANY_CLOSES = 7,
 
   QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN = 8,
 
   QCBOR_ERR_OPEN_BYTE_STRING = 9,
 
   QCBOR_ERR_CANNOT_CANCEL = 10,
 
#define QCBOR_START_OF_NOT_WELL_FORMED_ERRORS 20
 
   QCBOR_ERR_BAD_TYPE_7 = 20,
 
   QCBOR_ERR_EXTRA_BYTES = 21,
 
   QCBOR_ERR_UNSUPPORTED = 22,
 
   QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED = 23,
 
   QCBOR_ERR_BAD_INT = 24,
 
#define QCBOR_START_OF_UNRECOVERABLE_DECODE_ERRORS 30
 
   QCBOR_ERR_INDEFINITE_STRING_CHUNK = 30,
 
   QCBOR_ERR_HIT_END = 31,
 
   QCBOR_ERR_BAD_BREAK = 32,
 
#define QCBOR_END_OF_NOT_WELL_FORMED_ERRORS 39
 
   QCBOR_ERR_INPUT_TOO_LARGE = 40,
 
   QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP = 41,
 
   QCBOR_ERR_ARRAY_DECODE_TOO_LONG = 42,
 
   QCBOR_ERR_STRING_TOO_LONG = 43,
 
   QCBOR_ERR_BAD_EXP_AND_MANTISSA = 44,
 
   QCBOR_ERR_NO_STRING_ALLOCATOR = 45,
 
   QCBOR_ERR_STRING_ALLOCATE = 46,
 
   QCBOR_ERR_MAP_LABEL_TYPE = 47,
 
   QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT = 48,
   QCBOR_ERR_BAD_TAG_CONTENT = 48,
   QCBOR_ERR_BAD_OPT_TAG = 48,
 
   QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED = 49,
 
   QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED = 50,
 
   QCBOR_ERR_TAGS_DISABLED = 51,
 
   // TODO: maybe reduce number of conformance codes to not use up unrecoverable errors
 
   QCBOR_ERR_PREFERRED_CONFORMANCE = 52,
 
   QCBOR_ERR_CDE_CONFORMANCE = 53,
 
   QCBOR_ERR_DCBOR_CONFORMANCE = 54,
 
   QCBOR_ERR_UNSORTED = 55,
 
   QCBOR_ERR_CANT_CHECK_FLOAT_CONFORMANCE = 56,
 
#define QCBOR_END_OF_UNRECOVERABLE_DECODE_ERRORS 59
 
   QCBOR_ERR_TOO_MANY_TAGS = 60,
 
   QCBOR_ERR_UNEXPECTED_TYPE = 61,
 
   QCBOR_ERR_DUPLICATE_LABEL = 62,
 
   QCBOR_ERR_MEM_POOL_SIZE = 63,
 
   QCBOR_ERR_INT_OVERFLOW = 64,
 
   QCBOR_ERR_DATE_OVERFLOW = 65,
 
   QCBOR_ERR_EXIT_MISMATCH = 66,
 
   QCBOR_ERR_NO_MORE_ITEMS = 67,
 
   QCBOR_ERR_LABEL_NOT_FOUND = 68,
 
   QCBOR_ERR_NUMBER_SIGN_CONVERSION = 69,
 
   QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW = 70,
 
   QCBOR_ERR_MAP_NOT_ENTERED = 71,
 
   QCBOR_ERR_CALLBACK_FAIL = 72,
 
   QCBOR_ERR_FLOAT_DATE_DISABLED = 73,
 
   QCBOR_ERR_HALF_PRECISION_DISABLED = 74,
 
   QCBOR_ERR_HW_FLOAT_DISABLED = 75,
 
   QCBOR_ERR_FLOAT_EXCEPTION = 76,
 
   QCBOR_ERR_ALL_FLOAT_DISABLED = 77,
 
   QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT = 78,
 
   QCBOR_ERR_NOT_PREFERRED = 79,
 
   QCBOR_ERR_NOT_ALLOWED = 80,
 
   QCBOR_ERR_CANNOT_ENTER_ALLOCATED_STRING = 81,
 
   QCBOR_ERR_NO_NEGATIVE_ZERO = 87,
 
   QCBOR_ERR_UNEXPECTED_TAG_NUMBER = 89, // TODO: rid of this in favor of below?
 
   QCBOR_ERR_UNPROCESSED_TAG_NUMBER = 90,
 
   QCBOR_ERR_FIRST_USER_DEFINED = 128,
 
   QCBOR_ERR_LAST_USER_DEFINED = 255
 
   /* This is stored in uint8_t; never add values > 255 */
} QCBORError;
 
 
const char *
qcbor_err_to_str(QCBORError uErr);
 
 
 
 
#define QCBOR_MAX_ARRAY_NESTING  15
 
 
#define QCBOR_MAX_ITEMS_IN_ARRAY (UINT16_MAX-1) /* -1 is because the
                                                 * value UINT16_MAX is
                                                 * used to indicate
                                                 * indefinite-length.
                                                 */
#define QCBOR_MAX_ITEMS_IN_MAP  (QCBOR_MAX_ITEMS_IN_ARRAY/2)
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* qcbor_common_h */