blob: 75da839f52534839f68b16de3e2353af0906099a [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundbladeee851742020-01-08 08:37:05 -08003 Copyright (c) 2018-2020, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundbladec7114722020-08-13 05:11:40 -070036#include "ieee754.h" // Does not use math.h
37
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade323f8a92020-09-06 19:43:09 -070039#include <math.h> // For isnan(), llround(), llroudf(), round(), roundf(),
40 // pow(), exp2()
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -070041#include <fenv.h> // feclearexcept(), fetestexcept()
Laurence Lundbladec7114722020-08-13 05:11:40 -070042#endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070043
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070044
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053045/*
46 This casts away the const-ness of a pointer, usually so it can be
47 freed or realloced.
48 */
49#define UNCONST_POINTER(ptr) ((void *)(ptr))
50
Laurence Lundbladea9489f82020-09-12 13:50:56 -070051#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070052
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070053
Laurence Lundblade02625d42020-06-25 14:41:41 -070054inline static bool
55// TODO: add more tests for QCBOR_TYPE_MAP_AS_ARRAY mode in qcbor_decode_tests.c
56QCBORItem_IsMapOrArray(const QCBORItem *pMe)
57{
58 const uint8_t uDataType = pMe->uDataType;
59 return uDataType == QCBOR_TYPE_MAP ||
60 uDataType == QCBOR_TYPE_ARRAY ||
61 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
62}
63
64inline static bool
65QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
66{
67 if(!QCBORItem_IsMapOrArray(pMe)){
68 return false;
69 }
70
71 if(pMe->val.uCount != 0) {
72 return false;
73 }
74 return true;
75}
76
77inline static bool
78QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
79{
80 if(!QCBORItem_IsMapOrArray(pMe)){
81 return false;
82 }
83
84 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
85 return false;
86 }
87 return true;
88}
89
90
Laurence Lundbladeee851742020-01-08 08:37:05 -080091/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070092 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080093 ===========================================================================*/
94
Laurence Lundblade9c905e82020-04-25 11:31:38 -070095/*
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070096 See commecnts about and typedef of QCBORDecodeNesting in qcbor_private.h, the data structure
97 all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -070098
Laurence Lundblade9c905e82020-04-25 11:31:38 -070099
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700100
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700101 */
102
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700103
104inline static uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700105DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700106{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700107 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700108 /*
109 Limit in DecodeNesting_Descend against more than
110 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
111 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700112 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700113}
114
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700115
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700116inline static uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700117DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700118{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700119 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700120 /*
121 Limit in DecodeNesting_Descend against more than
122 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
123 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700124 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700125}
126
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700127
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700128static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700129DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700130{
131 return pNesting->pCurrentBounded->u.ma.uStartOffset;
132}
133
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700134
Laurence Lundblade085d7952020-07-24 10:26:30 -0700135static inline bool
136DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
137{
138 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
139 return true;
140 } else {
141 return false;
142 }
143}
144
145
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700146inline static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700147DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700148{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700149 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700150 return true;
151 } else {
152 return false;
153 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700154}
155
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700156
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700157inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700158DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700159{
160 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700161 // Not a map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700162 return false;
163 }
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700164 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700165 // Is indefinite
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700166 return false;
167 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700168 // All checks passed; is a definte length map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700169 return true;
170}
171
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700172
Laurence Lundblade642282a2020-06-23 12:00:33 -0700173inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700174DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700175{
176 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700177 // is a byte string
Laurence Lundblade642282a2020-06-23 12:00:33 -0700178 return true;
179 }
180 return false;
181}
182
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700183
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700184inline static bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700185{
186 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
187 return true;
188 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700189 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700190 return true;
191 }
192 return false;
193}
194
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700195
Laurence Lundblade085d7952020-07-24 10:26:30 -0700196inline static void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700197{
198 // Should be only called on maps and arrays
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700199 /*
200 DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
201 larger than DecodeNesting_EnterBoundedMode which keeps it less than
202 uin32_t so the cast is safe.
203 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700204 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700205
206 if(bIsEmpty) {
207 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
208 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700209}
210
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700211
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700212inline static void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700213{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700214 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700215}
216
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700217
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700218inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700219DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700220{
221 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700222 // No bounded map or array set up
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700223 return false;
224 }
225 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700226 // Not a map or array; end of those is by byte count
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700227 return false;
228 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700229 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
230 // In a traveral at a level deeper than the bounded level
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700231 return false;
232 }
Laurence Lundbladed0304932020-06-27 10:59:38 -0700233 // Works for both definite and indefinite length maps/arrays
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700234 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700235 // Count is not zero, still unconsumed item
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700236 return false;
237 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700238 // All checks passed, got to the end of an array or map
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700239 return true;
240}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700241
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700242
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700243inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700244DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700245{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700246 // Must only be called on map / array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700247 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
248 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700249 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700250 return false;
251 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700252}
253
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700254
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700255inline static bool
256DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700257{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700258 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
259 return true;
260 } else {
261 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700262 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700263}
264
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700265
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700266inline static bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700267DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700268{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700269 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700270 return false;
271 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700272
273 if(pNesting->pCurrentBounded->uLevelType != uType) {
274 return false;
275 }
276
277 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700278}
279
Laurence Lundblade02625d42020-06-25 14:41:41 -0700280
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700281inline static void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700282DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700283{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700284 // Only call on a defnite length array / map
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700285 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700286}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700287
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700288
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700289inline static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700290DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
291{
292 // Only call on a defnite length array / map
293 pNesting->pCurrent->u.ma.uCountCursor++;
294}
295
296
297inline static void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700298DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
299{
300 pNesting->pCurrent--;
301}
302
Laurence Lundblade02625d42020-06-25 14:41:41 -0700303
304static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700305DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700306{
307 // Error out if nesting is too deep
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700308 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700309 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700310 }
311
312 // The actual descend
313 pNesting->pCurrent++;
314
315 pNesting->pCurrent->uLevelType = uType;
316
317 return QCBOR_SUCCESS;
318}
319
320
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700321inline static QCBORError
Laurence Lundblade085d7952020-07-24 10:26:30 -0700322DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700323{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700324 /*
325 Should only be called on map/array.
326
327 Have descended into this before this is called. The job here is
328 just to mark it in bounded mode.
Laurence Lundbladebfbf4942020-09-16 23:31:00 -0700329
330 Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
331 uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700332 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -0700333 if(uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700334 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700335 }
336
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700337 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700338
339 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700340
341 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700342}
343
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700344
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700345inline static QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700346DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700347 uint8_t uQCBORType,
348 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700349{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700350 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700351
352 if(uCount == 0) {
353 // Nothing to do for empty definite lenth arrays. They are just are
354 // effectively the same as an item that is not a map or array
355 goto Done;
356 // Empty indefinite length maps and arrays are handled elsewhere
357 }
358
359 // Error out if arrays is too long to handle
Laurence Lundblade02625d42020-06-25 14:41:41 -0700360 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
361 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700362 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700363 goto Done;
364 }
365
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700366 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700367 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700368 goto Done;
369 }
370
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700371 // Fill in the new map/array level. Check above makes casts OK.
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700372 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
373 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700374
375 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700376
377Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700378 return uError;;
379}
380
381
382static inline void
383DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
384{
385 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
386}
387
388
389static inline void
390DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
391{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700392 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700393 pNesting->pCurrentBounded--;
394 if(DecodeNesting_IsCurrentBounded(pNesting)) {
395 break;
396 }
397 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700398}
399
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700400static inline void
401DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
402{
403 pNesting->pCurrent = pNesting->pCurrentBounded;
404}
405
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700406
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700407inline static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700408DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700409 uint32_t uEndOffset,
410 uint32_t uEndOfBstr)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700411{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700412 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700413
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700414 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700415 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700416 goto Done;
417 }
418
Laurence Lundblade02625d42020-06-25 14:41:41 -0700419 // Fill in the new byte string level
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700420 pNesting->pCurrent->u.bs.uPreviousEndOffset = uEndOffset;
421 pNesting->pCurrent->u.bs.uEndOfBstr = uEndOfBstr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700422
Laurence Lundblade02625d42020-06-25 14:41:41 -0700423 // Bstr wrapped levels are always bounded
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700424 pNesting->pCurrentBounded = pNesting->pCurrent;
425
426Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700427 return uError;;
428}
429
Laurence Lundbladed0304932020-06-27 10:59:38 -0700430
431static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700432DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700433{
434 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700435}
436
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700437
Laurence Lundbladeee851742020-01-08 08:37:05 -0800438inline static void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700439DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700440{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700441 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700442 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
443 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700444}
445
446
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700447inline static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700448DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting, QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700449{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700450 *pSave = *pNesting;
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700451 pNesting->pCurrent = pNesting->pCurrentBounded;
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700452 pNesting->pCurrent->u.ma.uCountCursor = pNesting->pCurrent->u.ma.uCountTotal;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700453}
454
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700455
Laurence Lundblade02625d42020-06-25 14:41:41 -0700456static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700457DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting, const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700458{
459 *pNesting = *pSave;
460}
461
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700462
Laurence Lundblade02625d42020-06-25 14:41:41 -0700463static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700464DecodeNesting_GetEndOfBstr(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700465{
466 return pMe->pCurrentBounded->u.bs.uEndOfBstr;
467}
468
469
Laurence Lundblade02625d42020-06-25 14:41:41 -0700470static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700471DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700472{
473 return pMe->pCurrentBounded->u.bs.uPreviousEndOffset;
474}
475
476
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700477
Laurence Lundbladeee851742020-01-08 08:37:05 -0800478/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800479 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
480
481 The following four functions are pretty wrappers for invocation of
482 the string allocator supplied by the caller.
483
Laurence Lundbladeee851742020-01-08 08:37:05 -0800484 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800485
Laurence Lundbladeee851742020-01-08 08:37:05 -0800486static inline void
487StringAllocator_Free(const QCORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800488{
489 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
490}
491
Laurence Lundbladeee851742020-01-08 08:37:05 -0800492// StringAllocator_Reallocate called with pMem NULL is
493// equal to StringAllocator_Allocate()
494static inline UsefulBuf
495StringAllocator_Reallocate(const QCORInternalAllocator *pMe,
496 void *pMem,
497 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800498{
499 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
500}
501
Laurence Lundbladeee851742020-01-08 08:37:05 -0800502static inline UsefulBuf
503StringAllocator_Allocate(const QCORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800504{
505 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
506}
507
Laurence Lundbladeee851742020-01-08 08:37:05 -0800508static inline void
509StringAllocator_Destruct(const QCORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800510{
511 if(pMe->pfAllocator) {
512 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
513 }
514}
515
516
517
Laurence Lundbladeee851742020-01-08 08:37:05 -0800518/*===========================================================================
519 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700520
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800521 See qcbor/qcbor_decode.h for definition of the object
522 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800523 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700524/*
525 Public function, see header file
526 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800527void QCBORDecode_Init(QCBORDecodeContext *me,
528 UsefulBufC EncodedCBOR,
529 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700530{
531 memset(me, 0, sizeof(QCBORDecodeContext));
532 UsefulInputBuf_Init(&(me->InBuf), EncodedCBOR);
Laurence Lundbladeee851742020-01-08 08:37:05 -0800533 // Don't bother with error check on decode mode. If a bad value is
534 // passed it will just act as if the default normal mode of 0 was set.
Laurence Lundbladee6bcef12020-04-01 10:56:27 -0700535 me->uDecodeMode = (uint8_t)nDecodeMode;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700536 DecodeNesting_Init(&(me->nesting));
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700537 for(int i = 0; i < QCBOR_NUM_MAPPED_TAGS; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -0700538 me->auMappedTags[i] = CBOR_TAG_INVALID16;
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700539 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700540}
541
542
543/*
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700544 Public function, see header file
545 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800546void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
547 QCBORStringAllocate pfAllocateFunction,
548 void *pAllocateContext,
549 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700550{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800551 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
552 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
553 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700554}
555
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800556
557/*
558 Public function, see header file
559 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700560void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800561 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700562{
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700563 // This does nothing now. It is retained for backwards compatibility
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700564 (void)pMe;
565 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700566}
567
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700568
569/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800570 This decodes the fundamental part of a CBOR data item, the type and
571 number
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800572
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700573 This is the counterpart to QCBOREncode_EncodeHead().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800574
Laurence Lundbladeee851742020-01-08 08:37:05 -0800575 This does the network->host byte order conversion. The conversion
576 here also results in the conversion for floats in addition to that
577 for lengths, tags and integer values.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800578
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700579 This returns:
580 pnMajorType -- the major type for the item
Laurence Lundbladeee851742020-01-08 08:37:05 -0800581
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800582 puArgument -- the "number" which is used a the value for integers,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800583 tags and floats and length for strings and arrays
584
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800585 pnAdditionalInfo -- Pass this along to know what kind of float or
Laurence Lundbladeee851742020-01-08 08:37:05 -0800586 if length is indefinite
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800587
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800588 The int type is preferred to uint8_t for some variables as this
589 avoids integer promotions, can reduce code size and makes
590 static analyzers happier.
Laurence Lundblade9b334962020-08-27 10:55:53 -0700591
592 @retval QCBOR_ERR_UNSUPPORTED
593
594 @retval QCBOR_ERR_HIT_END
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700595 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800596inline static QCBORError DecodeTypeAndNumber(UsefulInputBuf *pUInBuf,
597 int *pnMajorType,
598 uint64_t *puArgument,
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800599 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700600{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700601 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800602
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700603 // Get the initial byte that every CBOR data item has
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800604 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800605
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700606 // Break down the initial byte
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800607 const int nTmpMajorType = nInitialByte >> 5;
608 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800609
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800610 // Where the number or argument accumulates
611 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800612
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800613 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700614 // Need to get 1,2,4 or 8 additional argument bytes. Map
615 // LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800616 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800617
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800618 // Loop getting all the bytes in the argument
619 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800620 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800621 // This shift and add gives the endian conversion
622 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
623 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800624 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800625 // The reserved and thus-far unused additional info values
626 nReturn = QCBOR_ERR_UNSUPPORTED;
627 goto Done;
628 } else {
629 // Less than 24, additional info is argument or 31, an indefinite length
630 // No more bytes to get
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800631 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700632 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800633
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700634 if(UsefulInputBuf_GetError(pUInBuf)) {
635 nReturn = QCBOR_ERR_HIT_END;
636 goto Done;
637 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800638
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700639 // All successful if we got here.
640 nReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800641 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800642 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800643 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800644
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700645Done:
646 return nReturn;
647}
648
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800649
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700650/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800651 CBOR doesn't explicitly specify two's compliment for integers but all
652 CPUs use it these days and the test vectors in the RFC are so. All
653 integers in the CBOR structure are positive and the major type
654 indicates positive or negative. CBOR can express positive integers
655 up to 2^x - 1 where x is the number of bits and negative integers
656 down to 2^x. Note that negative numbers can be one more away from
657 zero than positive. Stdint, as far as I can tell, uses two's
658 compliment to represent negative integers.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800659
Laurence Lundblade9b334962020-08-27 10:55:53 -0700660 See http://www.unix.org/whitepapers/64bit.html for reasons int is
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800661 used carefully here, and in particular why it isn't used in the interface.
662 Also see
663 https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
664
665 Int is used for values that need less than 16-bits and would be subject
666 to integer promotion and complaining by static analyzers.
Laurence Lundblade9b334962020-08-27 10:55:53 -0700667
668 @retval QCBOR_ERR_INT_OVERFLOW
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700669 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800670inline static QCBORError
671DecodeInteger(int nMajorType, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700672{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700673 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800674
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700675 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
676 if (uNumber <= INT64_MAX) {
677 pDecodedItem->val.int64 = (int64_t)uNumber;
678 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800679
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700680 } else {
681 pDecodedItem->val.uint64 = uNumber;
682 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800683
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700684 }
685 } else {
686 if(uNumber <= INT64_MAX) {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800687 // CBOR's representation of negative numbers lines up with the
688 // two-compliment representation. A negative integer has one
689 // more in range than a positive integer. INT64_MIN is
690 // equal to (-INT64_MAX) - 1.
691 pDecodedItem->val.int64 = (-(int64_t)uNumber) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700692 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800693
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700694 } else {
695 // C can't represent a negative integer in this range
Laurence Lundblade21d1d812019-09-28 22:47:49 -1000696 // so it is an error.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700697 nReturn = QCBOR_ERR_INT_OVERFLOW;
698 }
699 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800700
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700701 return nReturn;
702}
703
704// Make sure #define value line up as DecodeSimple counts on this.
705#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
706#error QCBOR_TYPE_FALSE macro value wrong
707#endif
708
709#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
710#error QCBOR_TYPE_TRUE macro value wrong
711#endif
712
713#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
714#error QCBOR_TYPE_NULL macro value wrong
715#endif
716
717#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
718#error QCBOR_TYPE_UNDEF macro value wrong
719#endif
720
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700721#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
722#error QCBOR_TYPE_BREAK macro value wrong
723#endif
724
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700725#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
726#error QCBOR_TYPE_DOUBLE macro value wrong
727#endif
728
729#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
730#error QCBOR_TYPE_FLOAT macro value wrong
731#endif
732
733/*
734 Decode true, false, floats, break...
Laurence Lundblade9b334962020-08-27 10:55:53 -0700735
736 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
737
738 @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700739 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800740inline static QCBORError
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800741DecodeSimple(int nAdditionalInfo, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700743 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800744
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700745 // uAdditionalInfo is 5 bits from the initial byte. Compile time checks
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800746 // above make sure uAdditionalInfo values line up with uDataType values.
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700747 // DecodeTypeAndNumber() never returns an AdditionalInfo > 0x1f so cast is safe
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800748 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800749
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800750 switch(nAdditionalInfo) {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800751 // No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they are
752 // caught before this is called.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800753
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700754 case HALF_PREC_FLOAT: // 25
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700755#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700756 // Half-precision is returned as a double.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -0700757 // The cast to uint16_t is safe because the encoded value
Laurence Lundblade9682a532020-06-06 18:33:04 -0700758 // was 16 bits. It was widened to 64 bits to be passed in here.
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700759 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uNumber);
760 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700761#else
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700762 nReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700763#endif
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700764 break;
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700765 case SINGLE_PREC_FLOAT: // 26
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700766 // Single precision is normally returned as a double
767 // since double is widely supported, there is no loss of
768 // precision, it makes it easy for the caller in
769 // most cases and it can be converted back to single
770 // with no loss of precision
771 //
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -0700772 // The cast to uint32_t is safe because the encoded value
Laurence Lundblade8fa7d5d2020-07-11 16:30:47 -0700773 // was 32 bits. It was widened to 64 bits to be passed in here.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700774 {
775 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uNumber);
776#ifndef QCBOR_DISABLE_FLOAT_HW_USE
777 // In the normal case, use HW to convert float to double.
778 pDecodedItem->val.dfnum = (double)f;
779 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700780#else
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700781 // Use of float HW is disabled, return as a float.
782 pDecodedItem->val.fnum = f;
783 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
784
785 // IEEE754_FloatToDouble() could be used here to return
786 // as a double, but it adds object code and most likely
787 // anyone disabling FLOAT HW use doesn't care about
788 // floats and wants to save object code.
Laurence Lundblade9682a532020-06-06 18:33:04 -0700789#endif
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700790 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700791 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700792
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700793 case DOUBLE_PREC_FLOAT: // 27
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700794 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uNumber);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700795 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700796 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800797
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700798 case CBOR_SIMPLEV_FALSE: // 20
799 case CBOR_SIMPLEV_TRUE: // 21
800 case CBOR_SIMPLEV_NULL: // 22
801 case CBOR_SIMPLEV_UNDEF: // 23
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700802 case CBOR_SIMPLE_BREAK: // 31
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700803 break; // nothing to do
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800804
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700805 case CBOR_SIMPLEV_ONEBYTE: // 24
806 if(uNumber <= CBOR_SIMPLE_BREAK) {
807 // This takes out f8 00 ... f8 1f which should be encoded as e0 … f7
Laurence Lundblade077475f2019-04-26 09:06:33 -0700808 nReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700809 goto Done;
810 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800811 /* FALLTHROUGH */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700812 // fall through intentionally
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800813
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700814 default: // 0-19
815 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundbladeee851742020-01-08 08:37:05 -0800816 /*
817 DecodeTypeAndNumber will make uNumber equal to
818 uAdditionalInfo when uAdditionalInfo is < 24 This cast is
819 safe because the 2, 4 and 8 byte lengths of uNumber are in
820 the double/float cases above
821 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700822 pDecodedItem->val.uSimple = (uint8_t)uNumber;
823 break;
824 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800825
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700826Done:
827 return nReturn;
828}
829
830
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700831/*
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530832 Decode text and byte strings. Call the string allocator if asked to.
Laurence Lundblade9b334962020-08-27 10:55:53 -0700833
834 @retval QCBOR_ERR_HIT_END
835
836 @retval QCBOR_ERR_STRING_ALLOCATE
837
838 @retval QCBOR_ERR_STRING_TOO_LONG
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700839 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800840inline static QCBORError DecodeBytes(const QCORInternalAllocator *pAllocator,
841 int nMajorType,
842 uint64_t uStrLen,
843 UsefulInputBuf *pUInBuf,
844 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700845{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700846 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800847
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800848 // CBOR lengths can be 64 bits, but size_t is not 64 bits on all CPUs.
849 // This check makes the casts to size_t below safe.
850
851 // 4 bytes less than the largest sizeof() so this can be tested by
852 // putting a SIZE_MAX length in the CBOR test input (no one will
853 // care the limit on strings is 4 bytes shorter).
854 if(uStrLen > SIZE_MAX-4) {
855 nReturn = QCBOR_ERR_STRING_TOO_LONG;
856 goto Done;
857 }
858
859 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530860 if(UsefulBuf_IsNULLC(Bytes)) {
861 // Failed to get the bytes for this string item
862 nReturn = QCBOR_ERR_HIT_END;
863 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700864 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530865
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800866 if(pAllocator) {
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530867 // We are asked to use string allocator to make a copy
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800868 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530869 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +0700870 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530871 goto Done;
872 }
873 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800874 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530875 } else {
876 // Normal case with no string allocator
877 pDecodedItem->val.string = Bytes;
878 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800879 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800880 // Cast because ternary operator causes promotion to integer
881 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
882 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800883
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530884Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700885 return nReturn;
886}
887
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700888
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800889
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700890
891
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700892
893
Laurence Lundbladeee851742020-01-08 08:37:05 -0800894// Make sure the constants align as this is assumed by
895// the GetAnItem() implementation
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700896#if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
897#error QCBOR_TYPE_ARRAY value not lined up with major type
898#endif
899#if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
900#error QCBOR_TYPE_MAP value not lined up with major type
901#endif
902
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700903/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800904 This gets a single data item and decodes it including preceding
905 optional tagging. This does not deal with arrays and maps and nesting
906 except to decode the data item introducing them. Arrays and maps are
907 handled at the next level up in GetNext().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800908
Laurence Lundbladeee851742020-01-08 08:37:05 -0800909 Errors detected here include: an array that is too long to decode,
910 hit end of buffer unexpectedly, a few forms of invalid encoded CBOR
Laurence Lundblade9b334962020-08-27 10:55:53 -0700911
912 @retval QCBOR_ERR_UNSUPPORTED
913
914 @retval QCBOR_ERR_HIT_END
915
916 @retval QCBOR_ERR_INT_OVERFLOW
917
918 @retval QCBOR_ERR_STRING_ALLOCATE
919
920 @retval QCBOR_ERR_STRING_TOO_LONG
921
922 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
923
924 @retval QCBOR_ERR_BAD_TYPE_7
925
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700926 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800927static QCBORError GetNext_Item(UsefulInputBuf *pUInBuf,
928 QCBORItem *pDecodedItem,
929 const QCORInternalAllocator *pAllocator)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700930{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700931 QCBORError nReturn;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800932
Laurence Lundbladeee851742020-01-08 08:37:05 -0800933 /*
934 Get the major type and the number. Number could be length of more
935 bytes or the value depending on the major type nAdditionalInfo is
936 an encoding of the length of the uNumber and is needed to decode
937 floats and doubles
938 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800939 int nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700940 uint64_t uNumber;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800941 int nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800942
Laurence Lundblade4b09f632019-10-09 14:34:59 -0700943 memset(pDecodedItem, 0, sizeof(QCBORItem));
944
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800945 nReturn = DecodeTypeAndNumber(pUInBuf, &nMajorType, &uNumber, &nAdditionalInfo);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800946
Laurence Lundbladeee851742020-01-08 08:37:05 -0800947 // Error out here if we got into trouble on the type and number. The
948 // code after this will not work if the type and number is not good.
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700949 if(nReturn) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700950 goto Done;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700951 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800952
Laurence Lundbladeee851742020-01-08 08:37:05 -0800953 // At this point the major type and the value are valid. We've got
954 // the type and the number that starts every CBOR data item.
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800955 switch (nMajorType) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700956 case CBOR_MAJOR_TYPE_POSITIVE_INT: // Major type 0
957 case CBOR_MAJOR_TYPE_NEGATIVE_INT: // Major type 1
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800958 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700959 nReturn = QCBOR_ERR_BAD_INT;
960 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800961 nReturn = DecodeInteger(nMajorType, uNumber, pDecodedItem);
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700962 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700963 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800964
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700965 case CBOR_MAJOR_TYPE_BYTE_STRING: // Major type 2
966 case CBOR_MAJOR_TYPE_TEXT_STRING: // Major type 3
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800967 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
968 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
969 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
970 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530971 pDecodedItem->val.string = (UsefulBufC){NULL, SIZE_MAX};
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700972 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800973 nReturn = DecodeBytes(pAllocator, nMajorType, uNumber, pUInBuf, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700974 }
975 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800976
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700977 case CBOR_MAJOR_TYPE_ARRAY: // Major type 4
978 case CBOR_MAJOR_TYPE_MAP: // Major type 5
979 // Record the number of items in the array or map
980 if(uNumber > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700981 nReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700982 goto Done;
983 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800984 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700985 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700986 } else {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800987 // type conversion OK because of check above
988 pDecodedItem->val.uCount = (uint16_t)uNumber;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700989 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800990 // C preproc #if above makes sure constants for major types align
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800991 // DecodeTypeAndNumber never returns a major type > 7 so cast is safe
992 pDecodedItem->uDataType = (uint8_t)nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700993 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800994
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700995 case CBOR_MAJOR_TYPE_OPTIONAL: // Major type 6, optional prepended tags
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800996 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundbladebb1062e2019-08-12 23:28:54 -0700997 nReturn = QCBOR_ERR_BAD_INT;
998 } else {
999 pDecodedItem->val.uTagV = uNumber;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001000 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001001 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001002 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001003
Laurence Lundbladeee851742020-01-08 08:37:05 -08001004 case CBOR_MAJOR_TYPE_SIMPLE:
1005 // Major type 7, float, double, true, false, null...
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001006 nReturn = DecodeSimple(nAdditionalInfo, uNumber, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001007 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001008
Laurence Lundbladeee851742020-01-08 08:37:05 -08001009 default:
1010 // Never happens because DecodeTypeAndNumber() should never return > 7
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001011 nReturn = QCBOR_ERR_UNSUPPORTED;
1012 break;
1013 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001014
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001015Done:
1016 return nReturn;
1017}
1018
1019
1020
1021/*
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001022 This layer deals with indefinite length strings. It pulls all the
Laurence Lundbladeee851742020-01-08 08:37:05 -08001023 individual chunk items together into one QCBORItem using the string
1024 allocator.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001025
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301026 Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade9b334962020-08-27 10:55:53 -07001027
1028 @retval QCBOR_ERR_UNSUPPORTED
1029
1030 @retval QCBOR_ERR_HIT_END
1031
1032 @retval QCBOR_ERR_INT_OVERFLOW
1033
1034 @retval QCBOR_ERR_STRING_ALLOCATE
1035
1036 @retval QCBOR_ERR_STRING_TOO_LONG
1037
1038 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1039
1040 @retval QCBOR_ERR_BAD_TYPE_7
1041
1042 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1043
1044 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001045 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001046static inline QCBORError
1047GetNext_FullItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001048{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001049 // Stack usage; int/ptr 2 UsefulBuf 2 QCBORItem -- 96
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001050
1051 // Get pointer to string allocator. First use is to pass it to
1052 // GetNext_Item() when option is set to allocate for *every* string.
1053 // Second use here is to allocate space to coallese indefinite
1054 // length string items into one.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001055 const QCORInternalAllocator *pAllocator = me->StringAllocator.pfAllocator ?
1056 &(me->StringAllocator) :
1057 NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001058
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001059 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001060 nReturn = GetNext_Item(&(me->InBuf),
1061 pDecodedItem,
1062 me->bStringAllocateAll ? pAllocator: NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001063 if(nReturn) {
1064 goto Done;
1065 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001066
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001067 // To reduce code size by removing support for indefinite length strings, the
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301068 // code in this function from here down can be eliminated. Run tests, except
1069 // indefinite length string tests, to be sure all is OK if this is removed.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001070
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001071 // Only do indefinite length processing on strings
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001072 const uint8_t uStringType = pDecodedItem->uDataType;
1073 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001074 goto Done; // no need to do any work here on non-string types
1075 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001076
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001077 // Is this a string with an indefinite length?
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301078 if(pDecodedItem->val.string.len != SIZE_MAX) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001079 goto Done; // length is not indefinite, so no work to do here
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001080 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001081
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301082 // Can't do indefinite length strings without a string allocator
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001083 if(pAllocator == NULL) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001084 nReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1085 goto Done;
1086 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001087
Laurence Lundblade4b270642020-08-14 12:53:07 -07001088 // Loop getting chunks of the indefinite length string
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001089 UsefulBufC FullString = NULLUsefulBufC;
1090
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001091 for(;;) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001092 // Get item for next chunk
1093 QCBORItem StringChunkItem;
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001094 // NULL string allocator passed here. Do not need to allocate
1095 // chunks even if bStringAllocateAll is set.
Laurence Lundbladefae26bf2019-02-18 11:15:43 -08001096 nReturn = GetNext_Item(&(me->InBuf), &StringChunkItem, NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001097 if(nReturn) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001098 break; // Error getting the next chunk
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001099 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001100
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301101 // See if it is a marker at end of indefinite length string
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001102 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001103 // String is complete
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001104 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301105 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001106 break;
1107 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001108
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001109 // Match data type of chunk to type at beginning.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301110 // Also catches error of other non-string types that don't belong.
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001111 // Also catches indefinite length strings inside indefinite length strings
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001112 if(StringChunkItem.uDataType != uStringType ||
1113 StringChunkItem.val.string.len == SIZE_MAX) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07001114 nReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001115 break;
1116 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001117
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301118 // Alloc new buffer or expand previously allocated buffer so it can fit
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001119 // The first time throurgh FullString.ptr is NULL and this is
1120 // equivalent to StringAllocator_Allocate()
1121 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1122 UNCONST_POINTER(FullString.ptr),
1123 FullString.len + StringChunkItem.val.string.len);
1124
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001125 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301126 // Allocation of memory for the string failed
Laurence Lundblade30816f22018-11-10 13:40:22 +07001127 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001128 break;
1129 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001130
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001131 // Copy new string chunk at the end of string so far.
1132 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001133 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001134
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001135 if(nReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1136 // Getting the item failed, clean up the allocated memory
1137 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001138 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001139
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001140Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001141 return nReturn;
1142}
1143
Laurence Lundblade9b334962020-08-27 10:55:53 -07001144static uint64_t ConvertTag(const QCBORDecodeContext *me, uint16_t uTagVal) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001145 if(uTagVal <= QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001146 return uTagVal;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001147 } else if(uTagVal == CBOR_TAG_INVALID16) {
1148 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001149 } else {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001150 const int x = uTagVal - (QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001151 return me->auMappedTags[x];
1152 }
1153}
1154
Laurence Lundblade9b334962020-08-27 10:55:53 -07001155
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001156/*
Laurence Lundblade59289e52019-12-30 13:44:37 -08001157 Gets all optional tag data items preceding a data item that is not an
1158 optional tag and records them as bits in the tag map.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001159
1160 @retval QCBOR_ERR_UNSUPPORTED
1161
1162 @retval QCBOR_ERR_HIT_END
1163
1164 @retval QCBOR_ERR_INT_OVERFLOW
1165
1166 @retval QCBOR_ERR_STRING_ALLOCATE
1167
1168 @retval QCBOR_ERR_STRING_TOO_LONG
1169
1170 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1171
1172 @retval QCBOR_ERR_BAD_TYPE_7
1173
1174 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1175
1176 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1177
1178 @retval QCBOR_ERR_TOO_MANY_TAGS
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001179 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001180static QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001181GetNext_TaggedItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001182{
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001183 uint16_t auTags[QCBOR_MAX_TAGS_PER_ITEM] = {CBOR_TAG_INVALID16,
1184 CBOR_TAG_INVALID16,
1185 CBOR_TAG_INVALID16,
1186 CBOR_TAG_INVALID16};
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001187
Laurence Lundblade9b334962020-08-27 10:55:53 -07001188 QCBORError uReturn = QCBOR_SUCCESS;
1189
Laurence Lundblade59289e52019-12-30 13:44:37 -08001190 // Loop fetching items until the item fetched is not a tag
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001191 for(;;) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001192 QCBORError uErr = GetNext_FullItem(me, pDecodedItem);
1193 if(uErr != QCBOR_SUCCESS) {
1194 uReturn = uErr;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001195 goto Done; // Error out of the loop
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001196 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001197
Laurence Lundblade9b334962020-08-27 10:55:53 -07001198 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001199 // Successful exit from loop; maybe got some tags, maybe not
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001200 memcpy(pDecodedItem->uTags, auTags, sizeof(auTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001201 break;
1202 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001203
Laurence Lundblade9b334962020-08-27 10:55:53 -07001204 if(auTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1205 // No room in the tag list
1206 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
1207 // Continue on to get all tags on this item even though
1208 // it is erroring out in the end. This is a resource limit
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07001209 // error, not a problem with being well-formed CBOR.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001210 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001211 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001212 // Slide tags over one in the array to make room at index 0
1213 for(size_t uTagIndex = QCBOR_MAX_TAGS_PER_ITEM - 1; uTagIndex > 0; uTagIndex--) {
1214 auTags[uTagIndex] = auTags[uTagIndex-1];
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001215 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001216
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001217 // Is the tag > 16 bits?
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001218 if(pDecodedItem->val.uTagV > QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001219 size_t uTagMapIndex;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001220 // Is there room in the tag map, or is it in it already?
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001221 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001222 if(me->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001223 break;
1224 }
1225 if(me->auMappedTags[uTagMapIndex] == pDecodedItem->val.uTagV) {
1226 break;
1227 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001228 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001229 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1230 // No room for the tag
Laurence Lundblade9b334962020-08-27 10:55:53 -07001231 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
1232 // Continue on to get all tags on this item even though
1233 // it is erroring out in the end. This is a resource limit
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07001234 // error, not a problem with being well-formed CBOR.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001235 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001236 }
1237
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001238 // Covers the cases where tag is new and were it is already in the map
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001239 me->auMappedTags[uTagMapIndex] = pDecodedItem->val.uTagV;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001240 auTags[0] = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001241
1242 } else {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001243 auTags[0] = (uint16_t)pDecodedItem->val.uTagV;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001244 }
1245 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001246
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001247Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001248 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001249}
1250
1251
1252/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001253 This layer takes care of map entries. It combines the label and data
1254 items into one QCBORItem.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001255
1256 @retval QCBOR_ERR_UNSUPPORTED
1257
1258 @retval QCBOR_ERR_HIT_END
1259
1260 @retval QCBOR_ERR_INT_OVERFLOW
1261
1262 @retval QCBOR_ERR_STRING_ALLOCATE
1263
1264 @retval QCBOR_ERR_STRING_TOO_LONG
1265
1266 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1267
1268 @retval QCBOR_ERR_BAD_TYPE_7
1269
1270 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1271
1272 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1273
1274 @retval QCBOR_ERR_TOO_MANY_TAGS
1275
1276 @retval QCBOR_ERR_MAP_LABEL_TYPE
1277
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001278 @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001279 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001280static inline QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001281GetNext_MapEntry(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001282{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001283 // Stack use: int/ptr 1, QCBORItem -- 56
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001284 QCBORError nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001285 if(nReturn)
1286 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001287
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001288 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001289 // Break can't be a map entry
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001290 goto Done;
1291 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001292
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001293 if(me->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1294 // In a map and caller wants maps decoded, not treated as arrays
1295
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001296 if(DecodeNesting_IsCurrentTypeMap(&(me->nesting))) {
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001297 // If in a map and the right decoding mode, get the label
1298
Laurence Lundbladeee851742020-01-08 08:37:05 -08001299 // Save label in pDecodedItem and get the next which will
1300 // be the real data
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001301 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001302 nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001303 if(QCBORDecode_IsUnrecoverableError(nReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001304 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001305 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001306
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301307 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001308
1309 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
1310 // strings are always good labels
1311 pDecodedItem->label.string = LabelItem.val.string;
1312 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
1313 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == me->uDecodeMode) {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001314 // It's not a string and we only want strings
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001315 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1316 goto Done;
1317 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1318 pDecodedItem->label.int64 = LabelItem.val.int64;
1319 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1320 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1321 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1322 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1323 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1324 pDecodedItem->label.string = LabelItem.val.string;
1325 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1326 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1327 } else {
1328 // label is not an int or a string. It is an arrray
1329 // or a float or such and this implementation doesn't handle that.
1330 // Also, tags on labels are ignored.
1331 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1332 goto Done;
1333 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001334 }
1335 } else {
1336 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001337 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001338 nReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001339 goto Done;
1340 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001341 // Decoding a map as an array
1342 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001343 // Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2
1344 // Cast is needed because of integer promotion
1345 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001346 }
1347 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001348
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001349Done:
1350 return nReturn;
1351}
1352
1353
Laurence Lundblade02625d42020-06-25 14:41:41 -07001354/*
1355 See if next item is a CBOR break. If it is, it is consumed,
1356 if not it is not consumed.
1357*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001358static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001359NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1360{
1361 *pbNextIsBreak = false;
1362 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001363 QCBORItem Peek;
1364 size_t uPeek = UsefulInputBuf_Tell(pUIB);
1365 QCBORError uReturn = GetNext_Item(pUIB, &Peek, NULL);
1366 if(uReturn != QCBOR_SUCCESS) {
1367 return uReturn;
1368 }
1369 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001370 // It is not a break, rewind so it can be processed normally.
1371 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001372 } else {
1373 *pbNextIsBreak = true;
1374 }
1375 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001376
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001377 return QCBOR_SUCCESS;
1378}
1379
1380
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001381/*
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001382 An item was just consumed, now figure out if it was the
1383 end of an array or map that can be closed out. That
1384 may in turn close out another map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001385*/
Laurence Lundbladed0304932020-06-27 10:59:38 -07001386static QCBORError NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001387{
1388 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001389
Laurence Lundblade642282a2020-06-23 12:00:33 -07001390 /* This loops ascending nesting levels as long as there is ascending to do */
1391 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1392
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001393 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001394 /* Decrement count for definite length maps / arrays */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001395 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1396 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001397 /* Didn't close out map or array, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001398 break;
1399 }
Laurence Lundblade02625d42020-06-25 14:41:41 -07001400 /* All of a definite length array was consumed; fall through to ascend */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001401
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001402 } else {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001403 /* If not definite length, have to check for a CBOR break */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001404 bool bIsBreak = false;
1405 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1406 if(uReturn != QCBOR_SUCCESS) {
1407 goto Done;
1408 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001409
1410 if(!bIsBreak) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001411 /* It's not a break so nothing closes out and all work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001412 break;
1413 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001414
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001415 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001416 /*
1417 Break occurred inside a bstr-wrapped CBOR or
1418 in the top level sequence. This is always an
1419 error because neither are an indefinte length
1420 map/array.
1421 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001422 uReturn = QCBOR_ERR_BAD_BREAK;
1423 goto Done;
1424 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001425
Laurence Lundblade02625d42020-06-25 14:41:41 -07001426 /* It was a break in an indefinite length map / array */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001427 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001428
Laurence Lundblade02625d42020-06-25 14:41:41 -07001429 /* All items in the map/array level have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001430
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001431 /* But ascent in bounded mode is only by explicit call to QCBORDecode_ExitBoundedMode() */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001432 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001433 /* Set the count to zero for definite length arrays to indicate cursor is at end of bounded map / array */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001434 if(bMarkEnd) {
1435 // Used for definite and indefinite to signal end
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001436 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001437
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001438 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001439 break;
1440 }
1441
1442 /* Finally, actually ascend one level. */
1443 DecodeNesting_Ascend(&(pMe->nesting));
1444 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001445
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001446 uReturn = QCBOR_SUCCESS;
1447
1448Done:
1449 return uReturn;
1450}
1451
1452
1453/*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001454 This handles the traversal descending into and asecnding out of maps,
Laurence Lundblade642282a2020-06-23 12:00:33 -07001455 arrays and bstr-wrapped CBOR. It figures out the ends of definite and
1456 indefinte length maps and arrays by looking at the item count or
1457 finding CBOR breaks. It detects the ends of the top-level sequence
1458 and of bstr-wrapped CBOR by byte count.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001459
1460 @retval QCBOR_ERR_UNSUPPORTED X
1461
1462 @retval QCBOR_ERR_HIT_END
1463
1464 @retval QCBOR_ERR_INT_OVERFLOW X
1465
1466 @retval QCBOR_ERR_STRING_ALLOCATE
1467
1468 @retval QCBOR_ERR_STRING_TOO_LONG
1469
1470 @retval QCBOR_ERR_HALF_PRECISION_DISABLED X
1471
1472 @retval QCBOR_ERR_BAD_TYPE_7 X
1473
1474 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1475
1476 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1477
1478 @retval QCBOR_ERR_TOO_MANY_TAGS
1479
1480 @retval QCBOR_ERR_MAP_LABEL_TYPE X
1481
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001482 @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
Laurence Lundblade9b334962020-08-27 10:55:53 -07001483
1484 @retval QCBOR_ERR_NO_MORE_ITEMS
1485
1486 @retval QCBOR_ERR_BAD_BREAK
1487
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001488 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001489static QCBORError
1490QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001491{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001492 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001493 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001494
Laurence Lundblade642282a2020-06-23 12:00:33 -07001495 /*
1496 If out of bytes to consume, it is either the end of the top-level
1497 sequence of some bstr-wrapped CBOR that was entered.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001498
Laurence Lundblade642282a2020-06-23 12:00:33 -07001499 In the case of bstr-wrapped CBOR, the length of the UsefulInputBuf
1500 was set to that of the bstr-wrapped CBOR. When the bstr-wrapped
1501 CBOR is exited, the length is set back to the top-level's length
1502 or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001503 */
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001504 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001505 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001506 goto Done;
1507 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001508
Laurence Lundblade642282a2020-06-23 12:00:33 -07001509 /*
1510 Check to see if at the end of a bounded definite length map or
Laurence Lundblade02625d42020-06-25 14:41:41 -07001511 array. The check for the end of an indefinite length array is
1512 later.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001513 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001514 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001515 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001516 goto Done;
1517 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001518
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001519 /* ==== Next: not at the end so get another item ==== */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001520 uReturn = GetNext_MapEntry(me, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001521 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1522 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001523 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001524 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301525
Laurence Lundblade642282a2020-06-23 12:00:33 -07001526 /*
1527 Breaks ending arrays/maps are always processed at the end of this
1528 function. They should never show up here.
1529 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301530 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001531 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301532 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301533 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001534
Laurence Lundblade642282a2020-06-23 12:00:33 -07001535 /*
1536 Record the nesting level for this data item before processing any
1537 of decrementing and descending.
1538 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001539 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001540
Laurence Lundblade642282a2020-06-23 12:00:33 -07001541
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001542 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001543 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001544 /*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001545 If the new item is a map or array, descend.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001546
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001547 Empty indefinite length maps and arrays are descended into, but then ascended out
Laurence Lundblade02625d42020-06-25 14:41:41 -07001548 of in the next chunk of code.
1549
1550 Maps and arrays do count as items in the map/array that
Laurence Lundblade642282a2020-06-23 12:00:33 -07001551 encloses them so a decrement needs to be done for them too, but
1552 that is done only when all the items in them have been
1553 processed, not when they are opened with the exception of an
1554 empty map or array.
1555 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001556 QCBORError uDescendErr;
1557 uDescendErr = DecodeNesting_DescendMapOrArray(&(me->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001558 pDecodedItem->uDataType,
1559 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001560 if(uDescendErr != QCBOR_SUCCESS) {
1561 /* This error is probably a traversal error and it
1562 overrides the non-traversal error. */
1563 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001564 goto Done;
1565 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001566 }
1567
Laurence Lundblade02625d42020-06-25 14:41:41 -07001568 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1569 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1570 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001571 /*
1572 The following cases are handled here:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001573 - A non-aggregate like an integer or string
1574 - An empty definite length map or array
1575 - An indefinite length map or array that might be empty or might not.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001576
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001577 NestLevelAscender() does the work of decrementing the count for an
Laurence Lundblade02625d42020-06-25 14:41:41 -07001578 definite length map/array and break detection for an indefinite
1579 length map/array. If the end of the map/array was reached, then
1580 it ascends nesting levels, possibly all the way to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001581 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001582 QCBORError uAscendErr;
1583 uAscendErr = NestLevelAscender(me, true);
1584 if(uAscendErr != QCBOR_SUCCESS) {
1585 /* This error is probably a traversal error and it
1586 overrides the non-traversal error. */
1587 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001588 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001589 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301590 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001591
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001592 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001593 /*
Laurence Lundblade02625d42020-06-25 14:41:41 -07001594 Tell the caller what level is next. This tells them what
1595 maps/arrays were closed out and makes it possible for them to
1596 reconstruct the tree with just the information returned in
1597 a QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001598 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001599 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001600 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001601 pDecodedItem->uNextNestLevel = 0;
1602 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001603 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001604 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001605
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001606Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001607 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001608}
1609
Laurence Lundblade9b334962020-08-27 10:55:53 -07001610static void ShiftTags(QCBORItem *pDecodedItem)
1611{
1612 pDecodedItem->uTags[0] = pDecodedItem->uTags[1];
1613 pDecodedItem->uTags[1] = pDecodedItem->uTags[2];
1614 pDecodedItem->uTags[2] = pDecodedItem->uTags[3];
1615 pDecodedItem->uTags[2] = CBOR_TAG_INVALID16;
1616}
1617
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001618
Laurence Lundblade59289e52019-12-30 13:44:37 -08001619/*
1620 Mostly just assign the right data type for the date string.
1621 */
1622inline static QCBORError DecodeDateString(QCBORItem *pDecodedItem)
1623{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001624 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1625 return QCBOR_ERR_BAD_OPT_TAG;
1626 }
1627
1628 const UsefulBufC Temp = pDecodedItem->val.string;
1629 pDecodedItem->val.dateString = Temp;
1630 pDecodedItem->uDataType = QCBOR_TYPE_DATE_STRING;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001631 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001632 return QCBOR_SUCCESS;
1633}
1634
1635
Laurence Lundblade9b334962020-08-27 10:55:53 -07001636
Laurence Lundblade59289e52019-12-30 13:44:37 -08001637/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001638 The epoch formatted date. Turns lots of different forms of encoding
1639 date into uniform one
Laurence Lundblade59289e52019-12-30 13:44:37 -08001640 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001641static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001642{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001643 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001644
1645 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1646
1647 switch (pDecodedItem->uDataType) {
1648
1649 case QCBOR_TYPE_INT64:
1650 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1651 break;
1652
1653 case QCBOR_TYPE_UINT64:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001654 // This only happens for CBOR type 0 > INT64_MAX so it is
1655 // always an overflow.
1656 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1657 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001658 break;
1659
1660 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001661 case QCBOR_TYPE_FLOAT:
1662#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001663 {
1664 // This comparison needs to be done as a float before
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001665 // conversion to an int64_t to be able to detect doubles that
1666 // are too large to fit into an int64_t. A double has 52
1667 // bits of preceision. An int64_t has 63. Casting INT64_MAX
1668 // to a double actually causes a round up which is bad and
1669 // wrong for the comparison because it will allow conversion
1670 // of doubles that can't fit into a uint64_t. To remedy this
1671 // INT64_MAX - 0x7ff is used as the cutoff point because if
1672 // that value rounds up in conversion to double it will still
1673 // be less than INT64_MAX. 0x7ff is picked because it has 11
1674 // bits set.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001675 //
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001676 // INT64_MAX seconds is on the order of 10 billion years, and
1677 // the earth is less than 5 billion years old, so for most
1678 // uses this conversion error won't occur even though doubles
1679 // can go much larger.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001680 //
1681 // Without the 0x7ff there is a ~30 minute range of time
1682 // values 10 billion years in the past and in the future
Laurence Lundbladec7114722020-08-13 05:11:40 -07001683 // where this code would go wrong. Some compilers
1684 // will generate warnings or errors without the 0x7ff
1685 // because of the precision issue.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001686 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
1687 pDecodedItem->val.dfnum :
1688 (double)pDecodedItem->val.fnum;
Laurence Lundbladec7114722020-08-13 05:11:40 -07001689 if(isnan(d) ||
1690 d > (double)(INT64_MAX - 0x7ff) ||
1691 d < (double)(INT64_MIN + 0x7ff)) {
1692 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001693 goto Done;
1694 }
1695 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001696 pDecodedItem->val.epochDate.fSecondsFraction =
1697 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001698 }
Laurence Lundblade9682a532020-06-06 18:33:04 -07001699#else
Laurence Lundblade4b270642020-08-14 12:53:07 -07001700
Laurence Lundbladec7114722020-08-13 05:11:40 -07001701 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001702 goto Done;
1703
Laurence Lundblade9682a532020-06-06 18:33:04 -07001704#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001705 break;
1706
1707 default:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001708 uReturn = QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001709 goto Done;
1710 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001711
Laurence Lundblade59289e52019-12-30 13:44:37 -08001712 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1713
1714Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001715 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001716}
1717
1718
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001719/*
1720 Mostly just assign the right data type for the bignum.
1721 */
1722inline static QCBORError DecodeBigNum(QCBORItem *pDecodedItem)
1723{
1724 // Stack Use: UsefulBuf 1 -- 16
1725 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1726 return QCBOR_ERR_BAD_OPT_TAG;
1727 }
1728 const UsefulBufC Temp = pDecodedItem->val.string;
1729 pDecodedItem->val.bigNum = Temp;
1730 const bool bIsPosBigNum = (bool)(pDecodedItem->uTags[0] == CBOR_TAG_POS_BIGNUM);
1731 pDecodedItem->uDataType = (uint8_t)(bIsPosBigNum ? QCBOR_TYPE_POSBIGNUM
1732 : QCBOR_TYPE_NEGBIGNUM);
1733 return QCBOR_SUCCESS;
1734}
1735
1736
Laurence Lundblade59289e52019-12-30 13:44:37 -08001737#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1738/*
1739 Decode decimal fractions and big floats.
1740
1741 When called pDecodedItem must be the array that is tagged as a big
1742 float or decimal fraction, the array that has the two members, the
1743 exponent and mantissa.
1744
1745 This will fetch and decode the exponent and mantissa and put the
1746 result back into pDecodedItem.
1747 */
1748inline static QCBORError
1749QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1750{
1751 QCBORError nReturn;
1752
1753 // --- Make sure it is an array; track nesting level of members ---
1754 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
1755 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1756 goto Done;
1757 }
1758
1759 // A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladeee851742020-01-08 08:37:05 -08001760 // definite length arrays, but not for indefnite. Instead remember
1761 // the nesting level the two integers must be at, which is one
1762 // deeper than that of the array.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001763 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
1764
1765 // --- Is it a decimal fraction or a bigfloat? ---
1766 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
1767 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
1768
1769 // --- Get the exponent ---
1770 QCBORItem exponentItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001771 nReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001772 if(nReturn != QCBOR_SUCCESS) {
1773 goto Done;
1774 }
1775 if(exponentItem.uNestingLevel != nNestLevel) {
1776 // Array is empty or a map/array encountered when expecting an int
1777 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1778 goto Done;
1779 }
1780 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
1781 // Data arriving as an unsigned int < INT64_MAX has been converted
1782 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1783 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1784 // will be too large for this to handle and thus an error that will
1785 // get handled in the next else.
1786 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
1787 } else {
1788 // Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX
1789 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1790 goto Done;
1791 }
1792
1793 // --- Get the mantissa ---
1794 QCBORItem mantissaItem;
1795 nReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
1796 if(nReturn != QCBOR_SUCCESS) {
1797 goto Done;
1798 }
1799 if(mantissaItem.uNestingLevel != nNestLevel) {
1800 // Mantissa missing or map/array encountered when expecting number
1801 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1802 goto Done;
1803 }
1804 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
1805 // Data arriving as an unsigned int < INT64_MAX has been converted
1806 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1807 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1808 // will be too large for this to handle and thus an error that
1809 // will get handled in an else below.
1810 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
1811 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM || mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
1812 // Got a good big num mantissa
1813 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
1814 // Depends on numbering of QCBOR_TYPE_XXX
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001815 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
1816 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
1817 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001818 } else {
1819 // Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX
1820 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1821 goto Done;
1822 }
1823
1824 // --- Check that array only has the two numbers ---
1825 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07001826 // Extra items in the decimal fraction / big float
Laurence Lundblade59289e52019-12-30 13:44:37 -08001827 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1828 goto Done;
1829 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07001830 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001831
1832Done:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001833 return nReturn;
1834}
1835#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
1836
1837
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001838inline static QCBORError DecodeURI(QCBORItem *pDecodedItem)
1839{
1840 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1841 return QCBOR_ERR_BAD_OPT_TAG;
1842 }
1843 pDecodedItem->uDataType = QCBOR_TYPE_URI;
1844 return QCBOR_SUCCESS;
1845}
1846
1847
1848inline static QCBORError DecodeB64URL(QCBORItem *pDecodedItem)
1849{
1850 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1851 return QCBOR_ERR_BAD_OPT_TAG;
1852 }
1853 pDecodedItem->uDataType = QCBOR_TYPE_BASE64URL;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001854
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001855 return QCBOR_SUCCESS;
1856}
1857
1858
1859inline static QCBORError DecodeB64(QCBORItem *pDecodedItem)
1860{
1861 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1862 return QCBOR_ERR_BAD_OPT_TAG;
1863 }
1864 pDecodedItem->uDataType = QCBOR_TYPE_BASE64;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001865
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001866 return QCBOR_SUCCESS;
1867}
1868
1869
1870inline static QCBORError DecodeRegex(QCBORItem *pDecodedItem)
1871{
1872 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1873 return QCBOR_ERR_BAD_OPT_TAG;
1874 }
1875 pDecodedItem->uDataType = QCBOR_TYPE_REGEX;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001876
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001877 return QCBOR_SUCCESS;
1878}
1879
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001880
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001881inline static QCBORError DecodeWrappedCBOR(QCBORItem *pDecodedItem)
1882{
1883 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1884 return QCBOR_ERR_BAD_OPT_TAG;
1885 }
1886 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001887
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001888 return QCBOR_SUCCESS;
1889}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001890
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001891
1892inline static QCBORError DecodeWrappedCBORSequence(QCBORItem *pDecodedItem)
1893{
1894 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1895 return QCBOR_ERR_BAD_OPT_TAG;
1896 }
1897 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001898
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001899 return QCBOR_SUCCESS;
1900}
1901
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001902
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001903inline static QCBORError DecodeMIME(QCBORItem *pDecodedItem)
1904{
1905 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
1906 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07001907 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001908 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
1909 } else {
1910 return QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001911
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001912 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001913
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001914 return QCBOR_SUCCESS;
1915}
1916
1917
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001918inline static QCBORError DecodeUUID(QCBORItem *pDecodedItem)
1919{
1920 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1921 return QCBOR_ERR_BAD_OPT_TAG;
1922 }
1923 pDecodedItem->uDataType = QCBOR_TYPE_UUID;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001924
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001925 return QCBOR_SUCCESS;
1926}
1927
1928
Laurence Lundblade59289e52019-12-30 13:44:37 -08001929/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001930 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001931 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001932static QCBORError
1933QCBORDecode_GetNextTag(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001934{
1935 QCBORError nReturn;
1936
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001937 nReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001938 if(nReturn != QCBOR_SUCCESS) {
1939 goto Done;
1940 }
1941
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001942 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001943 switch(pDecodedItem->uTags[i]) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08001944
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001945 // Many of the functions here only just map a CBOR tag to
1946 // a QCBOR_TYPE for a string and could probably be
1947 // implemented with less object code. This implementation
1948 // of string types takes about 120 bytes of object code
1949 // (that is always linked and not removed by dead stripping).
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001950 case CBOR_TAG_DATE_STRING:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001951 nReturn = DecodeDateString(pDecodedItem);
1952 break;
1953
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001954 case CBOR_TAG_DATE_EPOCH:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001955 nReturn = DecodeDateEpoch(pDecodedItem);
1956 break;
1957
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001958 case CBOR_TAG_POS_BIGNUM:
1959 case CBOR_TAG_NEG_BIGNUM:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001960 nReturn = DecodeBigNum(pDecodedItem);
1961 break;
1962
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001963 #ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1964 case CBOR_TAG_DECIMAL_FRACTION:
1965 case CBOR_TAG_BIGFLOAT:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001966 // For aggregate tagged types, what goes into pTags is only collected
1967 // from the surrounding data item, not the contents, so pTags is not
1968 // passed on here.
1969
1970 nReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
1971 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001972 #endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001973
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001974 case CBOR_TAG_CBOR:
1975 nReturn = DecodeWrappedCBOR(pDecodedItem);
1976 break;
1977
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001978 case CBOR_TAG_CBOR_SEQUENCE:
1979 nReturn = DecodeWrappedCBORSequence(pDecodedItem);
1980 break;
1981
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001982 case CBOR_TAG_URI:
1983 nReturn = DecodeURI(pDecodedItem);
1984 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001985
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001986 case CBOR_TAG_B64URL:
1987 nReturn = DecodeB64URL(pDecodedItem);
1988 break;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001989
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001990 case CBOR_TAG_B64:
1991 nReturn = DecodeB64(pDecodedItem);
1992 break;
1993
1994 case CBOR_TAG_MIME:
1995 case CBOR_TAG_BINARY_MIME:
1996 nReturn = DecodeMIME(pDecodedItem);
1997 break;
1998
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001999 case CBOR_TAG_REGEX:
2000 nReturn = DecodeRegex(pDecodedItem);
2001 break;
2002
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002003 case CBOR_TAG_BIN_UUID:
2004 nReturn = DecodeUUID(pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002005 break;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002006
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002007 case CBOR_TAG_INVALID16:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002008 // The end of the tag list or no tags
2009 // Successful exit from the loop.
2010 goto Done;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002011
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002012 default:
2013 // A tag that is not understood
2014 // A successful exit from the loop
2015 goto Done;
2016
2017 }
2018 if(nReturn != QCBOR_SUCCESS) {
2019 goto Done;
2020 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002021 // A tag was successfully processed, shift it
2022 // out of the list of tags returned.
2023 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002024 }
2025
2026Done:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002027 return nReturn;
2028}
2029
2030
2031QCBORError
2032QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2033{
2034 QCBORError uErr;
2035 uErr = QCBORDecode_GetNextTag(pMe, pDecodedItem);
2036 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002037 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2038 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2039 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002040 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002041}
2042
2043
2044/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002045 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002046 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002047void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2048{
2049 if(pMe->uLastError != QCBOR_SUCCESS) {
2050 return;
2051 }
2052
2053 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2054}
2055
2056
2057/*
2058 Public function, see header qcbor/qcbor_decode.h file
2059 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002060QCBORError
2061QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
2062 QCBORItem *pDecodedItem,
2063 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002064{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002065 QCBORError nReturn;
2066
2067 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
2068 if(nReturn != QCBOR_SUCCESS) {
2069 return nReturn;
2070 }
2071
2072 if(pTags != NULL) {
2073 pTags->uNumUsed = 0;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002074 // Reverse the order because pTags is reverse of
2075 // QCBORItem.uTags.
2076 for(int i = QCBOR_MAX_TAGS_PER_ITEM-1; i >=0 ; i--) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002077 if(pDecodedItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002078 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002079 }
2080 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2081 return QCBOR_ERR_TOO_MANY_TAGS;
2082 }
2083 pTags->puTags[pTags->uNumUsed] = ConvertTag(me, pDecodedItem->uTags[i]);
2084 pTags->uNumUsed++;
2085 }
2086 }
2087
2088 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002089}
2090
2091
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002092/*
Laurence Lundblade6de37062018-10-15 12:22:42 +05302093 Decoding items is done in 5 layered functions, one calling the
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302094 next one down. If a layer has no work to do for a particular item
2095 it returns quickly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002096
Laurence Lundblade59289e52019-12-30 13:44:37 -08002097 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
2098 tagged data items, turning them into the local C representation.
2099 For the most simple it is just associating a QCBOR_TYPE with the data. For
2100 the complex ones that an aggregate of data items, there is some further
2101 decoding and a little bit of recursion.
2102
2103 - QCBORDecode_GetNextMapOrArray - This manages the beginnings and
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302104 ends of maps and arrays. It tracks descending into and ascending
Laurence Lundblade6de37062018-10-15 12:22:42 +05302105 out of maps/arrays. It processes all breaks that terminate
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002106 indefinite length maps and arrays.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002107
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302108 - GetNext_MapEntry -- This handles the combining of two
2109 items, the label and the data, that make up a map entry.
2110 It only does work on maps. It combines the label and data
2111 items into one labeled item.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002112
Laurence Lundblade59289e52019-12-30 13:44:37 -08002113 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
2114 tags into bit flags associated with the data item. No actual decoding
2115 of the contents of the tagged item is performed here.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002116
Laurence Lundblade59289e52019-12-30 13:44:37 -08002117 - GetNext_FullItem -- This assembles the sub-items that make up
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302118 an indefinte length string into one string item. It uses the
Laurence Lundblade6de37062018-10-15 12:22:42 +05302119 string allocater to create contiguous space for the item. It
2120 processes all breaks that are part of indefinite length strings.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002121
Laurence Lundblade59289e52019-12-30 13:44:37 -08002122 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
2123 atomic data item has a "major type", an integer "argument" and optionally
2124 some content. For text and byte strings, the content is the bytes
2125 that make up the string. These are the smallest data items that are
2126 considered to be well-formed. The content may also be other data items in
2127 the case of aggregate types. They are not handled in this layer.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002128
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002129 Roughly this takes 300 bytes of stack for vars. Need to
2130 evaluate this more carefully and correctly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002131
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302132 */
2133
2134
2135/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002136 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002137 */
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002138bool QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002139 const QCBORItem *pItem,
2140 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002141{
Laurence Lundblade9b334962020-08-27 10:55:53 -07002142 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002143 if(pItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002144 break;
2145 }
2146 if(ConvertTag(me, pItem->uTags[i]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002147 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002148 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002149 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002150
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002151 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002152}
2153
2154
2155/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002156 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002157 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07002158QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002159{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002160 QCBORError uReturn = me->uLastError;
2161
2162 if(uReturn != QCBOR_SUCCESS) {
2163 goto Done;
2164 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002165
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002166 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002167 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002168 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002169 goto Done;
2170 }
2171
2172 // Error out if not all the bytes are consumed
2173 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002174 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002175 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002176
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002177Done:
Laurence Lundblade6de37062018-10-15 12:22:42 +05302178 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002179 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002180 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002181
Laurence Lundblade085d7952020-07-24 10:26:30 -07002182 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002183}
2184
2185
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002186/*
Laurence Lundblade9b334962020-08-27 10:55:53 -07002187 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002188*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07002189// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002190uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2191 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002192 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002193{
Laurence Lundblade9b334962020-08-27 10:55:53 -07002194 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2195 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002196 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002197 return ConvertTag(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002198 }
2199}
2200
Laurence Lundblade9b334962020-08-27 10:55:53 -07002201/*
2202 Public function, see header qcbor/qcbor_decode.h file
2203*/
2204uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2205 uint32_t uIndex)
2206{
2207 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2208 return CBOR_TAG_INVALID64;
2209 } else {
2210 return ConvertTag(pMe, pMe->uLastTags[uIndex]);
2211 }
2212}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002213
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002214/*
2215
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002216Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002217
Laurence Lundbladeee851742020-01-08 08:37:05 -08002218 - Hit end of input before it was expected while decoding type and
2219 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002220
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002221 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002222
Laurence Lundbladeee851742020-01-08 08:37:05 -08002223 - Hit end of input while decoding a text or byte string
2224 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002225
Laurence Lundbladeee851742020-01-08 08:37:05 -08002226 - Encountered conflicting tags -- e.g., an item is tagged both a date
2227 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002228
Laurence Lundbladeee851742020-01-08 08:37:05 -08002229 - Encontered an array or mapp that has too many items
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002230 QCBOR_ERR_ARRAY_DECODE_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002231
Laurence Lundbladeee851742020-01-08 08:37:05 -08002232 - Encountered array/map nesting that is too deep
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002233 QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002234
Laurence Lundbladeee851742020-01-08 08:37:05 -08002235 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2236 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002237
Laurence Lundbladeee851742020-01-08 08:37:05 -08002238 - The type of a map label is not a string or int
2239 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002240
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002241 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002242
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002243 */
2244
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002245
2246
Laurence Lundbladef6531662018-12-04 10:42:22 +09002247
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002248/* ===========================================================================
2249 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002250
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002251 This implements a simple sting allocator for indefinite length
2252 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2253 implements the function type QCBORStringAllocate and allows easy
2254 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002255
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002256 This particular allocator is built-in for convenience. The caller
2257 can implement their own. All of this following code will get
2258 dead-stripped if QCBORDecode_SetMemPool() is not called.
2259
2260 This is a very primitive memory allocator. It does not track
2261 individual allocations, only a high-water mark. A free or
2262 reallocation must be of the last chunk allocated.
2263
2264 The size of the pool and offset to free memory are packed into the
2265 first 8 bytes of the memory pool so we don't have to keep them in
2266 the decode context. Since the address of the pool may not be
2267 aligned, they have to be packed and unpacked as if they were
2268 serialized data of the wire or such.
2269
2270 The sizes packed in are uint32_t to be the same on all CPU types
2271 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002272 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002273
2274
Laurence Lundbladeee851742020-01-08 08:37:05 -08002275static inline int
2276MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002277{
2278 // Use of UsefulInputBuf is overkill, but it is convenient.
2279 UsefulInputBuf UIB;
2280
Laurence Lundbladeee851742020-01-08 08:37:05 -08002281 // Just assume the size here. It was checked during SetUp so
2282 // the assumption is safe.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002283 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem, QCBOR_DECODE_MIN_MEM_POOL_SIZE});
2284 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2285 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2286 return UsefulInputBuf_GetError(&UIB);
2287}
2288
2289
Laurence Lundbladeee851742020-01-08 08:37:05 -08002290static inline int
2291MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002292{
2293 // Use of UsefulOutBuf is overkill, but convenient. The
2294 // length check performed here is useful.
2295 UsefulOutBuf UOB;
2296
2297 UsefulOutBuf_Init(&UOB, Pool);
2298 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2299 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2300 return UsefulOutBuf_GetError(&UOB);
2301}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002302
2303
2304/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002305 Internal function for an allocation, reallocation free and destuct.
2306
2307 Having only one function rather than one each per mode saves space in
2308 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002309
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002310 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2311 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002312static UsefulBuf
2313MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002314{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002315 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002316
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002317 uint32_t uPoolSize;
2318 uint32_t uFreeOffset;
2319
2320 if(uNewSize > UINT32_MAX) {
2321 // This allocator is only good up to 4GB. This check should
2322 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2323 goto Done;
2324 }
2325 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2326
2327 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2328 goto Done;
2329 }
2330
2331 if(uNewSize) {
2332 if(pMem) {
2333 // REALLOCATION MODE
2334 // Calculate pointer to the end of the memory pool. It is
2335 // assumed that pPool + uPoolSize won't wrap around by
2336 // assuming the caller won't pass a pool buffer in that is
2337 // not in legitimate memory space.
2338 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2339
2340 // Check that the pointer for reallocation is in the range of the
2341 // pool. This also makes sure that pointer math further down
2342 // doesn't wrap under or over.
2343 if(pMem >= pPool && pMem < pPoolEnd) {
2344 // Offset to start of chunk for reallocation. This won't
2345 // wrap under because of check that pMem >= pPool. Cast
2346 // is safe because the pool is always less than UINT32_MAX
2347 // because of check in QCBORDecode_SetMemPool().
2348 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2349
2350 // Check to see if the allocation will fit. uPoolSize -
2351 // uMemOffset will not wrap under because of check that
2352 // pMem is in the range of the uPoolSize by check above.
2353 if(uNewSize <= uPoolSize - uMemOffset) {
2354 ReturnValue.ptr = pMem;
2355 ReturnValue.len = uNewSize;
2356
2357 // Addition won't wrap around over because uNewSize was
2358 // checked to be sure it is less than the pool size.
2359 uFreeOffset = uMemOffset + uNewSize32;
2360 }
2361 }
2362 } else {
2363 // ALLOCATION MODE
2364 // uPoolSize - uFreeOffset will not underflow because this
2365 // pool implementation makes sure uFreeOffset is always
2366 // smaller than uPoolSize through this check here and
2367 // reallocation case.
2368 if(uNewSize <= uPoolSize - uFreeOffset) {
2369 ReturnValue.len = uNewSize;
2370 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002371 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002372 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002373 }
2374 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002375 if(pMem) {
2376 // FREE MODE
2377 // Cast is safe because of limit on pool size in
2378 // QCBORDecode_SetMemPool()
2379 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2380 } else {
2381 // DESTRUCT MODE
2382 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002383 }
2384 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002385
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002386 UsefulBuf Pool = {pPool, uPoolSize};
2387 MemPool_Pack(Pool, uFreeOffset);
2388
2389Done:
2390 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002391}
2392
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002393
Laurence Lundbladef6531662018-12-04 10:42:22 +09002394/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002395 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002396 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002397QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2398 UsefulBuf Pool,
2399 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002400{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002401 // The pool size and free mem offset are packed into the beginning
2402 // of the pool memory. This compile time check make sure the
2403 // constant in the header is correct. This check should optimize
2404 // down to nothing.
2405 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002406 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002407 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002408
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002409 // The pool size and free offset packed in to the beginning of pool
2410 // memory are only 32-bits. This check will optimize out on 32-bit
2411 // machines.
2412 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002413 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002414 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002415
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002416 // This checks that the pool buffer given is big enough.
2417 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002418 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002419 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002420
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002421 pMe->StringAllocator.pfAllocator = MemPool_Function;
2422 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2423 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002424
Laurence Lundblade30816f22018-11-10 13:40:22 +07002425 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002426}
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002427
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002428
2429
Laurence Lundblade9b334962020-08-27 10:55:53 -07002430static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2431{
2432 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2433}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002434
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002435
2436/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002437 Consume an entire map or array (and do next to
2438 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002439 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002440static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002441ConsumeItem(QCBORDecodeContext *pMe,
2442 const QCBORItem *pItemToConsume,
2443 uint_fast8_t *puNextNestLevel)
2444{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002445 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002446 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002447
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002448 // If it is a map or array, this will tell if it is empty.
2449 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2450
2451 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2452 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002453
Laurence Lundblade1341c592020-04-11 14:19:05 -07002454 /* This works for definite and indefinite length
2455 * maps and arrays by using the nesting level
2456 */
2457 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002458 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002459 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002460 goto Done;
2461 }
2462 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002463
Laurence Lundblade1341c592020-04-11 14:19:05 -07002464 if(puNextNestLevel != NULL) {
2465 *puNextNestLevel = Item.uNextNestLevel;
2466 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002467 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002468
Laurence Lundblade1341c592020-04-11 14:19:05 -07002469 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002470 /* item_to_consume is not a map or array */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002471 if(puNextNestLevel != NULL) {
2472 /* Just pass the nesting level through */
2473 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2474 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002475 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002476 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002477
2478Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002479 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002480}
2481
2482
Laurence Lundblade1341c592020-04-11 14:19:05 -07002483/* Return true if the labels in Item1 and Item2 are the same.
2484 Works only for integer and string labels. Returns false
2485 for any other type. */
2486static inline bool
2487MatchLabel(QCBORItem Item1, QCBORItem Item2)
2488{
2489 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2490 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2491 return true;
2492 }
2493 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002494 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002495 return true;
2496 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002497 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002498 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2499 return true;
2500 }
2501 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2502 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2503 return true;
2504 }
2505 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002506
Laurence Lundblade1341c592020-04-11 14:19:05 -07002507 /* Other label types are never matched */
2508 return false;
2509}
2510
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002511
2512/*
2513 Returns true if Item1 and Item2 are the same type
2514 or if either are of QCBOR_TYPE_ANY.
2515 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002516static inline bool
2517MatchType(QCBORItem Item1, QCBORItem Item2)
2518{
2519 if(Item1.uDataType == Item2.uDataType) {
2520 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002521 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002522 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002523 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002524 return true;
2525 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002526 return false;
2527}
2528
2529
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002530/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002531 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002532
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002533 @param[in] pMe The decode context to search.
2534 @param[in,out] pItemArray The items to search for and the items found.
2535 @param[out] puOffset Byte offset of last item matched.
2536 @param[in] pCBContext Context for the not-found item call back.
2537 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002538
2539 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2540
Laurence Lundblade9b334962020-08-27 10:55:53 -07002541 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label) were found
2542 for one of the labels being search for. This duplicate detection is only performed for items in pItemArray,
2543 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002544
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002545 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002546
2547 @retval Also errors returned by QCBORDecode_GetNext().
2548
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002549 On input pItemArray contains a list of labels and data types
2550 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002551
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002552 On output the fully retrieved items are filled in with
2553 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002554
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002555 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002556 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002557// TODO: make this handle indefinite length strings, possibly with
2558// allocation only when returning the string.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002559static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002560MapSearch(QCBORDecodeContext *pMe,
2561 QCBORItem *pItemArray,
2562 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002563 void *pCBContext,
2564 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002565{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002566 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002567 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002568
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002569 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002570 uReturn = pMe->uLastError;
2571 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002572 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002573
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002574 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002575 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2576 /* QCBOR_TYPE_NONE as first item indicates just looking
2577 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002578 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2579 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002580 }
2581
Laurence Lundblade085d7952020-07-24 10:26:30 -07002582 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2583 // It is an empty bounded array or map
2584 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2585 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002586 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002587 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002588 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002589 // Nothing is ever found in an empty array or map. All items
2590 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002591 uReturn = QCBOR_SUCCESS;
2592 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002593 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002594 }
2595
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002596 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002597 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2598
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002599 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002600 UsefulInputBuf_Seek(&(pMe->InBuf),
2601 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002602
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002603 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002604 Loop over all the items in the map or array. Each item
2605 could be a map or array, but label matching is only at
2606 the main level. This handles definite and indefinite
2607 length maps and arrays. The only reason this is ever
2608 called on arrays is to find their end position.
2609
2610 This will always run over all items in order to do
2611 duplicate detection.
2612
2613 This will exit with failure if it encounters an
2614 unrecoverable error, but continue on for recoverable
2615 errors.
2616
2617 If a recoverable error occurs on a matched item, then
2618 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002619 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002620 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002621 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002622 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002623 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002624 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002625
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002626 /* Get the item */
2627 QCBORItem Item;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002628 QCBORError uResult = QCBORDecode_GetNextTag(pMe, &Item);
2629 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07002630 /* Got non-well-formed CBOR so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002631 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002632 goto Done;
2633 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002634 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002635 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002636 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002637 goto Done;
2638 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002639
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002640 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002641 bool bMatched = false;
2642 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2643 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002644 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002645 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2646 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002647 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002648 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002649 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002650 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002651 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002652 goto Done;
2653 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002654
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002655 if(uResult != QCBOR_SUCCESS) {
2656 uReturn = uResult;
2657 goto Done;
2658 }
2659
Laurence Lundblade1341c592020-04-11 14:19:05 -07002660 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002661 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002662 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002663 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002664 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002665 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002666 bMatched = true;
2667 }
2668 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002669
2670
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002671 if(!bMatched && pfCallback != NULL) {
2672 /*
2673 Call the callback on unmatched labels.
2674 (It is tempting to do duplicate detection here, but that would
2675 require dynamic memory allocation because the number of labels
2676 that might be encountered is unbounded.)
2677 */
2678 uReturn = (*pfCallback)(pCBContext, &Item);
2679 if(uReturn != QCBOR_SUCCESS) {
2680 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002681 }
2682 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002683
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002684 /*
2685 Consume the item whether matched or not. This
2686 does the work of traversing maps and array and
2687 everything in them. In this loop only the
2688 items at the current nesting level are examined
2689 to match the labels.
2690 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002691 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002692 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002693 goto Done;
2694 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002695
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002696 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002697
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002698 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002699
2700 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002701
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002702 // Check here makes sure that this won't accidentally be
2703 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002704 // QCBOR_MAX_DECODE_INPUT_SIZE.
2705 if(uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
2706 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
2707 goto Done;
2708 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002709 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2710 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002711
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002712 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002713 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2714
2715 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002716 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07002717 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002718 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002719 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
2720 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002721 }
2722 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002723
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002724 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002725}
2726
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002727
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002728/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002729 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002730*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002731void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2732 int64_t nLabel,
2733 uint8_t uQcborType,
2734 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002735{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002736 if(pMe->uLastError != QCBOR_SUCCESS) {
2737 return;
2738 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002739
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002740 QCBORItem OneItemSeach[2];
2741 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2742 OneItemSeach[0].label.int64 = nLabel;
2743 OneItemSeach[0].uDataType = uQcborType;
2744 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002745
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002746 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002747
2748 *pItem = OneItemSeach[0];
2749
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002750 if(uReturn != QCBOR_SUCCESS) {
2751 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002752 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002753 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002754 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002755 }
2756
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002757 Done:
2758 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002759}
2760
2761
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002762/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002763 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002764*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002765void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2766 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07002767 uint8_t uQcborType,
2768 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002769{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002770 if(pMe->uLastError != QCBOR_SUCCESS) {
2771 return;
2772 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002773
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002774 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002775 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2776 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2777 OneItemSeach[0].uDataType = uQcborType;
2778 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002779
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002780 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2781 if(uReturn != QCBOR_SUCCESS) {
2782 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002783 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002784 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002785 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002786 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002787 }
2788
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002789 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002790
2791Done:
2792 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002793}
2794
2795
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002796
Laurence Lundblade9b334962020-08-27 10:55:53 -07002797static QCBORError CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002798{
2799 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2800 if(uDataType == puTypeList[i]) {
2801 return QCBOR_SUCCESS;
2802 }
2803 }
2804 return QCBOR_ERR_UNEXPECTED_TYPE;
2805}
2806
Laurence Lundblade67257dc2020-07-27 03:33:37 -07002807
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002808/**
2809 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002810 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002811
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002812 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
2813 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07002814
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002815 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered tag value.
2816 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002817static QCBORError CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07002818{
2819 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
2820 pItem->uTags[0] != CBOR_TAG_INVALID16) {
2821 /* There are tags that QCBOR couldn't process on this item and
2822 the caller has told us there should not be. */
2823 return QCBOR_ERR_UNEXPECTED_TYPE;
2824 }
2825
2826 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
2827 const int nItemType = pItem->uDataType;
2828
2829 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
2830 // Must match the tag and only the tag
2831 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
2832 }
2833
2834 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
2835 if(uReturn == QCBOR_SUCCESS) {
2836 return QCBOR_SUCCESS;
2837 }
2838
2839 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
2840 /* Must match the content type and only the content type.
2841 There was no match just above so it is a fail. */
2842 return QCBOR_ERR_UNEXPECTED_TYPE;
2843 }
2844
2845 /* If here it can match either the tag or the content
2846 and it hasn't matched the content, so the end
2847 result is whether it matches the tag. This is
2848 also the case that the CBOR standard discourages. */
2849
2850 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
2851}
2852
Laurence Lundblade9b334962020-08-27 10:55:53 -07002853
Laurence Lundblade9b334962020-08-27 10:55:53 -07002854
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07002855// This could be semi-private if need be
2856static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002857void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
2858 int64_t nLabel,
2859 TagSpecification TagSpec,
2860 QCBORItem *pItem)
2861{
2862 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
2863 if(pMe->uLastError != QCBOR_SUCCESS) {
2864 return;
2865 }
2866
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002867 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002868}
2869
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07002870
2871// This could be semi-private if need be
2872static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002873void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
2874 const char *szLabel,
2875 TagSpecification TagSpec,
2876 QCBORItem *pItem)
2877{
2878 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
2879 if(pMe->uLastError != QCBOR_SUCCESS) {
2880 return;
2881 }
2882
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002883 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002884}
2885
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002886// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002887void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
2888 int64_t nLabel,
2889 TagSpecification TagSpec,
2890 UsefulBufC *pString)
2891{
2892 QCBORItem Item;
2893 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
2894 if(pMe->uLastError == QCBOR_SUCCESS) {
2895 *pString = Item.val.string;
2896 }
2897}
2898
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002899// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002900void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
2901 const char * szLabel,
2902 TagSpecification TagSpec,
2903 UsefulBufC *pString)
2904{
2905 QCBORItem Item;
2906 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
2907 if(pMe->uLastError == QCBOR_SUCCESS) {
2908 *pString = Item.val.string;
2909 }
2910}
Laurence Lundblade1341c592020-04-11 14:19:05 -07002911
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002912/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002913 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002914*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002915void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002916{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002917 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
2918 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002919}
2920
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002921/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002922 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002923*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002924void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
2925 QCBORItem *pItemList,
2926 void *pCallbackCtx,
2927 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002928{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002929 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
2930 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002931}
2932
2933
Laurence Lundblade34691b92020-05-18 22:25:25 -07002934static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07002935{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07002936 // The first item in pSearch is the one that is to be
2937 // entered. It should be the only one filled in. Any other
2938 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07002939 if(pMe->uLastError != QCBOR_SUCCESS) {
2940 // Already in error state; do nothing.
2941 return;
2942 }
2943
2944 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002945 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002946 if(pMe->uLastError != QCBOR_SUCCESS) {
2947 return;
2948 }
2949
Laurence Lundblade9b334962020-08-27 10:55:53 -07002950 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002951 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002952 return;
2953 }
2954
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002955 /* Need to get the current pre-order nesting level and cursor to be
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07002956 at the map/array about to be entered.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002957
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002958 Also need the current map nesting level and start cursor to
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002959 be at the right place.
2960
2961 The UsefulInBuf offset could be anywhere, so no assumption is
2962 made about it.
2963
2964 No assumption is made about the pre-order nesting level either.
2965
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002966 However the bounded mode nesting level is assumed to be one above
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002967 the map level that is being entered.
2968 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002969 /* Seek to the data item that is the map or array */
2970 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002971
2972 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002973
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002974 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002975}
2976
2977
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002978/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07002979 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002980*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002981void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002982{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002983 QCBORItem OneItemSeach[2];
2984 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2985 OneItemSeach[0].label.int64 = nLabel;
2986 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2987 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002988
Laurence Lundblade9b334962020-08-27 10:55:53 -07002989 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002990 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002991}
2992
2993
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002994/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07002995 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002996*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002997void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002998{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002999 QCBORItem OneItemSeach[2];
3000 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3001 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3002 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3003 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003004
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003005 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003006}
3007
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003008/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003009 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003010*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003011void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003012{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003013 QCBORItem OneItemSeach[2];
3014 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3015 OneItemSeach[0].label.int64 = nLabel;
3016 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3017 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003018
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003019 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003020}
3021
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003022/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003023 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003024*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003025void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3026{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003027 QCBORItem OneItemSeach[2];
3028 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3029 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3030 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3031 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003032
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003033 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003034}
3035
3036
Laurence Lundblade02625d42020-06-25 14:41:41 -07003037// Semi-private function
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003038void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003039{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003040 QCBORError uErr;
3041
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003042 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003043 if(pMe->uLastError != QCBOR_SUCCESS) {
3044 // Already in error state; do nothing.
3045 return;
3046 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003047
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003048 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003049 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003050 uErr = QCBORDecode_GetNext(pMe, &Item);
3051 if(uErr != QCBOR_SUCCESS) {
3052 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003053 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003054 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003055 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3056 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003057 }
3058
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003059 CopyTags(pMe, &Item);
3060
3061
Laurence Lundbladef0499502020-08-01 11:55:57 -07003062 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003063 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003064 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3065 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003066 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003067 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3068 }
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003069 // Special case to increment nesting level for zero-length maps and arrays entered in bounded mode.
3070 DecodeNesting_Descend(&(pMe->nesting), uType);
3071 }
3072
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003073 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003074
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003075 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3076 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003077
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003078Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003079 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003080}
3081
Laurence Lundblade02625d42020-06-25 14:41:41 -07003082
3083/*
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003084 This is the common work for exiting a level that is a bounded map, array or bstr
3085 wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003086
3087 One chunk of work is to set up the pre-order traversal so it is at
3088 the item just after the bounded map, array or bstr that is being
3089 exited. This is somewhat complex.
3090
3091 The other work is to level-up the bounded mode to next higest bounded
3092 mode or the top level if there isn't one.
3093 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003094static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003095ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003096{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003097 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003098
Laurence Lundblade02625d42020-06-25 14:41:41 -07003099 /*
3100 First the pre-order-traversal byte offset is positioned to the
3101 item just after the bounded mode item that was just consumed.
3102 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003103 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3104
Laurence Lundblade02625d42020-06-25 14:41:41 -07003105 /*
3106 Next, set the current nesting level to one above the bounded level
3107 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003108
Laurence Lundblade02625d42020-06-25 14:41:41 -07003109 DecodeNesting_CheckBoundedType() is always called before this and
3110 makes sure pCurrentBounded is valid.
3111 */
3112 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3113
3114 /*
3115 This does the complex work of leveling up the pre-order traversal
3116 when the end of a map or array or another bounded level is
3117 reached. It may do nothing, or ascend all the way to the top
3118 level.
3119 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07003120 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003121 if(uErr != QCBOR_SUCCESS) {
3122 goto Done;
3123 }
3124
Laurence Lundblade02625d42020-06-25 14:41:41 -07003125 /*
3126 This makes the next highest bounded level the current bounded
3127 level. If there is no next highest level, then no bounded mode is
3128 in effect.
3129 */
3130 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003131
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003132 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003133
3134Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003135 return uErr;
3136}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003137
Laurence Lundblade02625d42020-06-25 14:41:41 -07003138
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003139// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003140void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003141{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003142 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003143 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003144 return;
3145 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003146
Laurence Lundblade02625d42020-06-25 14:41:41 -07003147 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003148
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003149 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003150 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003151 goto Done;
3152 }
3153
Laurence Lundblade02625d42020-06-25 14:41:41 -07003154 /*
3155 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003156 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003157 from previous map search, then do a dummy search.
3158 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003159 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003160 QCBORItem Dummy;
3161 Dummy.uLabelType = QCBOR_TYPE_NONE;
3162 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3163 if(uErr != QCBOR_SUCCESS) {
3164 goto Done;
3165 }
3166 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003167
Laurence Lundblade02625d42020-06-25 14:41:41 -07003168 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003169
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003170Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003171 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003172}
3173
3174
Laurence Lundblade1341c592020-04-11 14:19:05 -07003175
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003176static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003177 const QCBORItem *pItem,
3178 uint8_t uTagRequirement,
3179 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003180{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003181 if(pBstr) {
3182 *pBstr = NULLUsefulBufC;
3183 }
3184
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003185 if(pMe->uLastError != QCBOR_SUCCESS) {
3186 // Already in error state; do nothing.
3187 return pMe->uLastError;
3188 }
3189
3190 QCBORError uError = QCBOR_SUCCESS;
3191
3192 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
3193 uError = QCBOR_ERR_UNEXPECTED_TYPE;
3194 goto Done;;
3195 }
3196
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003197 const TagSpecification TagSpec =
3198 {
3199 uTagRequirement,
3200 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3201 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3202 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003203
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003204 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003205 if(uError != QCBOR_SUCCESS) {
3206 goto Done;
3207 }
3208
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003209 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003210 /* Reverse the decrement done by GetNext() for the bstr as
Laurence Lundblade410c7e02020-06-25 23:35:29 -07003211 so the increment in NestLevelAscender called by ExitBoundedLevel()
3212 will work right. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003213 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003214 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003215
3216 if(pBstr) {
3217 *pBstr = pItem->val.string;
3218 }
3219
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003220 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003221
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003222 // Need to move UIB input cursor to the right place.
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003223 // Most of these calls are simple inline accessors so this doesn't
3224 // amount to much code. There is a range check in the seek.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003225 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003226 if(uEndOfBstr >= QCBOR_MAX_DECODE_INPUT_SIZE || uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003227 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003228 goto Done;
3229 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003230 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003231 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003232
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003233 // Casts are OK because of checks against QCBOR_MAX_DECODE_INPUT_SIZE above.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003234 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003235 (uint32_t)uPreviousLength,
3236 (uint32_t)uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003237Done:
3238 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003239}
3240
3241
Laurence Lundblade02625d42020-06-25 14:41:41 -07003242/*
3243 Public function, see header qcbor/qcbor_decode.h file
3244 */
3245void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003246 uint8_t uTagRequirement,
3247 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003248{
3249 if(pMe->uLastError != QCBOR_SUCCESS) {
3250 // Already in error state; do nothing.
3251 return;
3252 }
3253
3254 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003255 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003256 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3257 if(pMe->uLastError != QCBOR_SUCCESS) {
3258 return;
3259 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003260
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003261 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003262 &Item,
3263 uTagRequirement,
3264 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003265}
3266
3267
Laurence Lundblade02625d42020-06-25 14:41:41 -07003268/*
3269 Public function, see header qcbor/qcbor_decode.h file
3270 */
3271void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003272 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003273 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003274 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003275{
3276 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003277 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003278
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003279 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003280}
3281
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003282
Laurence Lundblade02625d42020-06-25 14:41:41 -07003283/*
3284 Public function, see header qcbor/qcbor_decode.h file
3285 */
3286void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003287 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003288 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003289 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003290{
3291 QCBORItem Item;
3292 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3293
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003294 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003295}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003296
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003297
Laurence Lundblade02625d42020-06-25 14:41:41 -07003298/*
3299 Public function, see header qcbor/qcbor_decode.h file
3300 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003301void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003302{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003303 if(pMe->uLastError != QCBOR_SUCCESS) {
3304 // Already in error state; do nothing.
3305 return;
3306 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003307
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003308 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003309 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003310 return;
3311 }
3312
3313 /*
3314 Reset the length of the UsefulInputBuf to what it was before
3315 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003316 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003317 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003318 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003319
3320
Laurence Lundblade02625d42020-06-25 14:41:41 -07003321 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003322 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003323}
3324
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003325
Laurence Lundbladee6430642020-03-14 21:15:44 -07003326
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003327
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003328
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003329
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003330
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003331
Laurence Lundblade9b334962020-08-27 10:55:53 -07003332static QCBORError InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003333{
3334 switch(pItem->uDataType) {
3335 case QCBOR_TYPE_TRUE:
3336 *pBool = true;
3337 return QCBOR_SUCCESS;
3338 break;
3339
3340 case QCBOR_TYPE_FALSE:
3341 *pBool = false;
3342 return QCBOR_SUCCESS;
3343 break;
3344
3345 default:
3346 return QCBOR_ERR_UNEXPECTED_TYPE;
3347 break;
3348 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003349 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003350}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003351
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003352
Laurence Lundblade9b334962020-08-27 10:55:53 -07003353
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003354/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003355 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003356*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003357void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003358{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003359 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003360 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003361 return;
3362 }
3363
Laurence Lundbladec4537442020-04-14 18:53:22 -07003364 QCBORError nError;
3365 QCBORItem Item;
3366
3367 nError = QCBORDecode_GetNext(pMe, &Item);
3368 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003369 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003370 return;
3371 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003372 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003373}
3374
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003375
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003376/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003377 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003378*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003379void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003380{
3381 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003382 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003383
Laurence Lundblade9b334962020-08-27 10:55:53 -07003384 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003385}
3386
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003387
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003388/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003389 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003390*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003391void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3392{
3393 QCBORItem Item;
3394 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3395
Laurence Lundblade9b334962020-08-27 10:55:53 -07003396 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003397}
3398
3399
3400
Laurence Lundblade9b334962020-08-27 10:55:53 -07003401/*
3402 A number of methods decode CBOR that is associated with a
3403 specific tag or tags.
Laurence Lundbladec7114722020-08-13 05:11:40 -07003404
Laurence Lundblade9b334962020-08-27 10:55:53 -07003405 The API of the method returns the
3406 data in a way specific to the
3407
3408 No tags at all.
3409
3410
3411 Require tag for the particular type for the method and no other.
3412
3413
3414 Either no tags at all or the particular type for the method and no other.
3415
3416 No tag for particular type; pass other tags along.
3417
3418 Require the tag for the particular type; pass other tags along
3419
3420 Any tagging is OK; consume the tag for the particular type if present,
3421 pass other tags along.
3422
3423
3424 1) REQUIRED
3425- 1 XXXX -- works
3426- T 1 XXX -- works, T is returned
3427
3428 if(tag is of interest) {
3429 process content
3430 return T if present
3431 }
3432
3433
3434 2) FORBIDDEN
3435 - XXX -- works
3436 - T XXX -- ???
3437
3438 if(tag is of interest) {
3439 error out since tag is forbidden
3440 } else {
3441 process contents
3442 return T
3443 }
3444
3445 3) OPTIONAL
3446 - XXX works
3447 - 1 XXX works
3448 - T XXX
3449 - T 1 XXX works, T is returned
3450
3451if (inner tag is of interest) {
3452 process content
3453 return tag T if present
3454 } else if (there is no tag) {
3455 process content
3456 } else {
3457 process content if possible
3458 return T
3459 }
3460
3461A field is type X
3462 - tag for type X is REQUIRED
3463 - tag for type X is FORBIDDEN
3464 - tag for type X is optional
3465 - Other tags are FORBIDDEN
3466 - Other tags are ALLOWED
3467
3468
3469
3470 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003471
3472static void ProcessEpochDate(QCBORDecodeContext *pMe,
3473 QCBORItem *pItem,
3474 uint8_t uTagRequirement,
3475 int64_t *pnTime)
3476{
3477 if(pMe->uLastError != QCBOR_SUCCESS) {
3478 // Already in error state, do nothing
3479 return;
3480 }
3481
3482 QCBORError uErr;
3483
3484 const TagSpecification TagSpec =
3485 {
3486 uTagRequirement,
3487 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3488 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT}
3489 };
3490
Laurence Lundblade4b270642020-08-14 12:53:07 -07003491 // TODO: this will give an unexpected type error instead of
Laurence Lundbladec7114722020-08-13 05:11:40 -07003492 // overflow error for QCBOR_TYPE_UINT64 because TagSpec
3493 // only has three target types.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003494 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003495 if(uErr != QCBOR_SUCCESS) {
3496 goto Done;
3497 }
3498
3499 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3500 uErr = DecodeDateEpoch(pItem);
3501 if(uErr != QCBOR_SUCCESS) {
3502 goto Done;
3503 }
3504 }
3505
Laurence Lundblade9b334962020-08-27 10:55:53 -07003506 // Save the tags in the last item's tags in the decode context
3507 // for QCBORDecode_GetNthTagOfLast()
3508 CopyTags(pMe, pItem);
3509
Laurence Lundbladec7114722020-08-13 05:11:40 -07003510 *pnTime = pItem->val.epochDate.nSeconds;
3511
3512Done:
3513 pMe->uLastError = (uint8_t)uErr;
3514}
3515
3516
3517void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
3518 uint8_t uTagRequirement,
3519 int64_t *pnTime)
3520{
3521 if(pMe->uLastError != QCBOR_SUCCESS) {
3522 // Already in error state, do nothing
3523 return;
3524 }
3525
3526 QCBORItem Item;
3527 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3528
3529 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3530}
3531
3532
3533void
3534QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3535 int64_t nLabel,
3536 uint8_t uTagRequirement,
3537 int64_t *pnTime)
3538{
3539 QCBORItem Item;
3540 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3541 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3542}
3543
3544
3545void
3546QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3547 const char *szLabel,
3548 uint8_t uTagRequirement,
3549 int64_t *pnTime)
3550{
3551 QCBORItem Item;
3552 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3553 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3554}
3555
3556
3557
3558
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003559void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3560 TagSpecification TagSpec,
3561 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003562{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003563 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003564 // Already in error state, do nothing
3565 return;
3566 }
3567
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003568 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003569 QCBORItem Item;
3570
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003571 uError = QCBORDecode_GetNext(pMe, &Item);
3572 if(uError != QCBOR_SUCCESS) {
3573 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003574 return;
3575 }
3576
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003577 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003578
3579 if(pMe->uLastError == QCBOR_SUCCESS) {
3580 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003581 } else {
3582 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003583 }
3584}
3585
Laurence Lundbladec4537442020-04-14 18:53:22 -07003586
3587
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003588
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003589static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003590 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003591 UsefulBufC *pValue,
3592 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003593{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003594 const TagSpecification TagSpec =
3595 {
3596 uTagRequirement,
3597 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE},
3598 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3599 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003600
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003601 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003602 if(uErr != QCBOR_SUCCESS) {
3603 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003604 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003605
3606 *pValue = pItem->val.string;
3607
3608 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3609 *pbIsNegative = false;
3610 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3611 *pbIsNegative = true;
3612 }
3613
3614 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003615}
3616
3617
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003618/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003619 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003620 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003621void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3622 uint8_t uTagRequirement,
3623 UsefulBufC *pValue,
3624 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003625{
3626 if(pMe->uLastError != QCBOR_SUCCESS) {
3627 // Already in error state, do nothing
3628 return;
3629 }
3630
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003631 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003632 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3633 if(uError != QCBOR_SUCCESS) {
3634 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003635 return;
3636 }
3637
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003638 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003639}
3640
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003641
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003642/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003643 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003644*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003645void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3646 int64_t nLabel,
3647 uint8_t uTagRequirement,
3648 UsefulBufC *pValue,
3649 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003650{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003651 QCBORItem Item;
3652 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003653 if(pMe->uLastError != QCBOR_SUCCESS) {
3654 return;
3655 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003656
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003657 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003658}
3659
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003660
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003661/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003662 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003663*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003664void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3665 const char *szLabel,
3666 uint8_t uTagRequirement,
3667 UsefulBufC *pValue,
3668 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003669{
3670 QCBORItem Item;
3671 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003672 if(pMe->uLastError != QCBOR_SUCCESS) {
3673 return;
3674 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003675
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003676 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003677}
3678
3679
3680
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003681
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003682// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003683QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3684 const QCBORItem *pItem,
3685 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07003686 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003687{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003688 const TagSpecification TagSpecText =
3689 {
3690 uTagRequirement,
3691 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3692 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3693 };
3694 const TagSpecification TagSpecBinary =
3695 {
3696 uTagRequirement,
3697 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3698 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3699 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003700
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003701 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003702
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003703 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003704 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003705 if(pbIsTag257 != NULL) {
3706 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003707 }
3708 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003709 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003710 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003711 if(pbIsTag257 != NULL) {
3712 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003713 }
3714 uReturn = QCBOR_SUCCESS;
3715
3716 } else {
3717 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3718 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003719
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003720 return uReturn;
3721}
3722
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003723// Improvement: add methods for wrapped CBOR, a simple alternate to EnterBstrWrapped
3724
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003725
3726
3727
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003728#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003729
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003730typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003731
3732
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003733// The exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003734static QCBORError Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003735{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003736 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003737
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003738 if(uResult != 0) {
3739 /* This loop will run a maximum of 19 times because
3740 * UINT64_MAX < 10 ^^ 19. More than that will cause
3741 * exit with the overflow error
3742 */
3743 for(; nExponent > 0; nExponent--) {
3744 if(uResult > UINT64_MAX / 10) {
3745 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3746 }
3747 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003748 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003749
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003750 for(; nExponent < 0; nExponent++) {
3751 uResult = uResult / 10;
3752 if(uResult == 0) {
3753 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3754 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003755 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003756 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003757 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003758
3759 *puResult = uResult;
3760
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003761 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003762}
3763
3764
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003765// The exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003766static QCBORError Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003767{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003768 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003769
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003770 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003771
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003772 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003773 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003774 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07003775 */
3776 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003777 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003778 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003779 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003780 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003781 nExponent--;
3782 }
3783
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003784 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003785 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003786 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3787 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003788 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003789 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003790 }
3791
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003792 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003793
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003794 return QCBOR_SUCCESS;
3795}
3796
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003797
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003798/*
3799 Compute value with signed mantissa and signed result. Works with exponent of 2 or 10 based on exponentiator.
3800 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003801static inline QCBORError ExponentiateNN(int64_t nMantissa,
3802 int64_t nExponent,
3803 int64_t *pnResult,
3804 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003805{
3806 uint64_t uResult;
3807
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003808 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003809 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003810 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3811
3812 // Do the exponentiation of the positive mantissa
3813 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3814 if(uReturn) {
3815 return uReturn;
3816 }
3817
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003818
Laurence Lundblade983500d2020-05-14 11:49:34 -07003819 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3820 of INT64_MIN. This assumes two's compliment representation where
3821 INT64_MIN is one increment farther from 0 than INT64_MAX.
3822 Trying to write -INT64_MIN doesn't work to get this because the
3823 compiler tries to work with an int64_t which can't represent
3824 -INT64_MIN.
3825 */
3826 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3827
3828 // Error out if too large
3829 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003830 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3831 }
3832
3833 // Casts are safe because of checks above
3834 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
3835
3836 return QCBOR_SUCCESS;
3837}
3838
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003839
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003840/*
3841 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3842 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003843static inline QCBORError ExponentitateNU(int64_t nMantissa,
3844 int64_t nExponent,
3845 uint64_t *puResult,
3846 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003847{
3848 if(nMantissa < 0) {
3849 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3850 }
3851
3852 // Cast to unsigned is OK because of check for negative
3853 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
3854 // Exponentiation is straight forward
3855 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
3856}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003857
3858
3859/*
3860 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3861 */
3862static inline QCBORError ExponentitateUU(uint64_t uMantissa,
3863 int64_t nExponent,
3864 uint64_t *puResult,
3865 fExponentiator pfExp)
3866{
3867 return (*pfExp)(uMantissa, nExponent, puResult);
3868}
3869
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003870#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
3871
3872
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003873
3874
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003875
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003876static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003877{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003878 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003879
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003880 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003881 const uint8_t *pByte = BigNum.ptr;
3882 size_t uLen = BigNum.len;
3883 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07003884 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003885 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003886 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07003887 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003888 }
3889
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003890 *pResult = uResult;
3891 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003892}
3893
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003894
Laurence Lundblade887add82020-05-17 05:50:34 -07003895static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003896{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003897 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003898}
3899
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003900
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003901static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003902{
3903 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003904 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
3905 if(uError) {
3906 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003907 }
3908 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
3909 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003910 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003911}
3912
3913
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003914static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003915{
3916 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003917 /* The negative integer furthest from zero for a C int64_t is
3918 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
3919 negative number in CBOR is computed as -n - 1 where n is the
3920 encoded integer, where n is what is in the variable BigNum. When
3921 converting BigNum to a uint64_t, the maximum value is thus
3922 INT64_MAX, so that when it -n - 1 is applied to it the result will
3923 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07003924
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003925 -n - 1 <= INT64_MIN.
3926 -n - 1 <= -INT64_MAX - 1
3927 n <= INT64_MAX.
3928 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07003929 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003930 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003931 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003932 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003933
3934 /// Now apply -n - 1. The cast is safe because
3935 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
3936 // is the largest positive integer that an int64_t can
3937 // represent. */
3938 *pnResult = -(int64_t)uResult - 1;
3939
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003940 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003941}
3942
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003943
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003944
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003945
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003946
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003947/*
3948Convert a integers and floats to an int64_t.
3949
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003950\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003951
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003952\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003953
3954\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3955
3956\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3957
3958*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003959static QCBORError ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003960{
3961 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003962 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003963 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003964#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003965 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003966 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
3967 http://www.cplusplus.com/reference/cmath/llround/
3968 */
3969 // Not interested in FE_INEXACT
3970 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003971 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
3972 *pnValue = llround(pItem->val.dfnum);
3973 } else {
3974 *pnValue = lroundf(pItem->val.fnum);
3975 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003976 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
3977 // llround() shouldn't result in divide by zero, but catch
3978 // it here in case it unexpectedly does. Don't try to
3979 // distinguish between the various exceptions because it seems
3980 // they vary by CPU, compiler and OS.
3981 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003982 }
3983 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003984 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003985 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003986#else
3987 return QCBOR_ERR_HW_FLOAT_DISABLED;
3988#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003989 break;
3990
3991 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003992 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003993 *pnValue = pItem->val.int64;
3994 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003995 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003996 }
3997 break;
3998
3999 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004000 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004001 if(pItem->val.uint64 < INT64_MAX) {
4002 *pnValue = pItem->val.int64;
4003 } else {
4004 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4005 }
4006 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004007 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004008 }
4009 break;
4010
4011 default:
4012 return QCBOR_ERR_UNEXPECTED_TYPE;
4013 }
4014 return QCBOR_SUCCESS;
4015}
4016
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004017
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004018void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004019 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004020 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004021 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004022{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004023 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004024 return;
4025 }
4026
Laurence Lundbladee6430642020-03-14 21:15:44 -07004027 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004028 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4029 if(uError) {
4030 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004031 return;
4032 }
4033
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004034 if(pItem) {
4035 *pItem = Item;
4036 }
4037
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004038 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004039}
4040
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004041
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004042void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4043 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004044 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004045 int64_t *pnValue,
4046 QCBORItem *pItem)
4047{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004048 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004049 if(pMe->uLastError != QCBOR_SUCCESS) {
4050 return;
4051 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004052
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004053 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004054}
4055
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004056
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004057void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4058 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004059 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004060 int64_t *pnValue,
4061 QCBORItem *pItem)
4062{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004063 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004064 if(pMe->uLastError != QCBOR_SUCCESS) {
4065 return;
4066 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004067
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004068 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004069}
4070
4071
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004072/*
4073 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004074
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004075 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004076
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004077 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004078
4079 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4080
4081 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
4082
4083 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004084static QCBORError Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004085{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004086 switch(pItem->uDataType) {
4087
4088 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004089 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004090 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004091 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004092 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004093 }
4094 break;
4095
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004096 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004097 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004098 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004099 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004100 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004101 }
4102 break;
4103
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004104#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4105 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004106 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004107 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004108 pItem->val.expAndMantissa.nExponent,
4109 pnValue,
4110 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004111 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004112 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004113 }
4114 break;
4115
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004116 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004117 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004118 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004119 pItem->val.expAndMantissa.nExponent,
4120 pnValue,
4121 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004122 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004123 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004124 }
4125 break;
4126
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004127 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004128 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004129 int64_t nMantissa;
4130 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004131 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4132 if(uErr) {
4133 return uErr;
4134 }
4135 return ExponentiateNN(nMantissa,
4136 pItem->val.expAndMantissa.nExponent,
4137 pnValue,
4138 Exponentitate10);
4139 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004140 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004141 }
4142 break;
4143
4144 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004145 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004146 int64_t nMantissa;
4147 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004148 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4149 if(uErr) {
4150 return uErr;
4151 }
4152 return ExponentiateNN(nMantissa,
4153 pItem->val.expAndMantissa.nExponent,
4154 pnValue,
4155 Exponentitate10);
4156 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004157 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004158 }
4159 break;
4160
4161 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004162 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004163 int64_t nMantissa;
4164 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004165 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4166 if(uErr) {
4167 return uErr;
4168 }
4169 return ExponentiateNN(nMantissa,
4170 pItem->val.expAndMantissa.nExponent,
4171 pnValue,
4172 Exponentitate2);
4173 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004174 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004175 }
4176 break;
4177
4178 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004179 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004180 int64_t nMantissa;
4181 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004182 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4183 if(uErr) {
4184 return uErr;
4185 }
4186 return ExponentiateNN(nMantissa,
4187 pItem->val.expAndMantissa.nExponent,
4188 pnValue,
4189 Exponentitate2);
4190 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004191 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004192 }
4193 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004194#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4195
Laurence Lundbladee6430642020-03-14 21:15:44 -07004196
Laurence Lundbladec4537442020-04-14 18:53:22 -07004197 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004198 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004199}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004200
4201
Laurence Lundbladec4537442020-04-14 18:53:22 -07004202/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004203 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004204 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004205void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004206{
4207 QCBORItem Item;
4208
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004209 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004210
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004211 if(pMe->uLastError == QCBOR_SUCCESS) {
4212 // The above conversion succeeded
4213 return;
4214 }
4215
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004216 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004217 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004218 return;
4219 }
4220
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004221 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004222}
4223
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004224
4225/*
4226Public function, see header qcbor/qcbor_decode.h file
4227*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004228void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4229 int64_t nLabel,
4230 uint32_t uConvertTypes,
4231 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004232{
4233 QCBORItem Item;
4234
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004235 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004236
4237 if(pMe->uLastError == QCBOR_SUCCESS) {
4238 // The above conversion succeeded
4239 return;
4240 }
4241
4242 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4243 // The above conversion failed in a way that code below can't correct
4244 return;
4245 }
4246
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004247 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004248}
4249
4250
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004251/*
4252Public function, see header qcbor/qcbor_decode.h file
4253*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004254void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4255 const char *szLabel,
4256 uint32_t uConvertTypes,
4257 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004258{
4259 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004260 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004261
4262 if(pMe->uLastError == QCBOR_SUCCESS) {
4263 // The above conversion succeeded
4264 return;
4265 }
4266
4267 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4268 // The above conversion failed in a way that code below can't correct
4269 return;
4270 }
4271
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004272 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004273}
4274
4275
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004276static QCBORError ConvertUint64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004277{
4278 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004279 case QCBOR_TYPE_DOUBLE:
4280 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004281#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004282 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004283 // Can't use llround here because it will not convert values
4284 // greater than INT64_MAX and less than UINT64_MAX that
4285 // need to be converted so it is more complicated.
4286 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4287 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4288 if(isnan(pItem->val.dfnum)) {
4289 return QCBOR_ERR_FLOAT_EXCEPTION;
4290 } else if(pItem->val.dfnum < 0) {
4291 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4292 } else {
4293 double dRounded = round(pItem->val.dfnum);
4294 // See discussion in DecodeDateEpoch() for
4295 // explanation of - 0x7ff
4296 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4297 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4298 }
4299 *puValue = (uint64_t)dRounded;
4300 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004301 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004302 if(isnan(pItem->val.fnum)) {
4303 return QCBOR_ERR_FLOAT_EXCEPTION;
4304 } else if(pItem->val.fnum < 0) {
4305 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4306 } else {
4307 float fRounded = roundf(pItem->val.fnum);
4308 // See discussion in DecodeDateEpoch() for
4309 // explanation of - 0x7ff
4310 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4311 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4312 }
4313 *puValue = (uint64_t)fRounded;
4314 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004315 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004316 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4317 // round() and roundf() shouldn't result in exceptions here, but
4318 // catch them to be robust and thorough. Don't try to
4319 // distinguish between the various exceptions because it seems
4320 // they vary by CPU, compiler and OS.
4321 return QCBOR_ERR_FLOAT_EXCEPTION;
4322 }
4323
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004324 } else {
4325 return QCBOR_ERR_UNEXPECTED_TYPE;
4326 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004327#else
4328 return QCBOR_ERR_HW_FLOAT_DISABLED;
4329#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004330 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004331
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004332 case QCBOR_TYPE_INT64:
4333 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4334 if(pItem->val.int64 >= 0) {
4335 *puValue = (uint64_t)pItem->val.int64;
4336 } else {
4337 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4338 }
4339 } else {
4340 return QCBOR_ERR_UNEXPECTED_TYPE;
4341 }
4342 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004343
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004344 case QCBOR_TYPE_UINT64:
4345 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4346 *puValue = pItem->val.uint64;
4347 } else {
4348 return QCBOR_ERR_UNEXPECTED_TYPE;
4349 }
4350 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004351
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004352 default:
4353 return QCBOR_ERR_UNEXPECTED_TYPE;
4354 }
4355
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004356 return QCBOR_SUCCESS;
4357}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004358
4359
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004360void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004361 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004362 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004363 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004364{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004365 if(pMe->uLastError != QCBOR_SUCCESS) {
4366 return;
4367 }
4368
Laurence Lundbladec4537442020-04-14 18:53:22 -07004369 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004370
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004371 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4372 if(uError) {
4373 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004374 return;
4375 }
4376
Laurence Lundbladea826c502020-05-10 21:07:00 -07004377 if(pItem) {
4378 *pItem = Item;
4379 }
4380
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004381 pMe->uLastError = (uint8_t)ConvertUint64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004382}
4383
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004384
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004385void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004386 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004387 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004388 uint64_t *puValue,
4389 QCBORItem *pItem)
4390{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004391 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004392 if(pMe->uLastError != QCBOR_SUCCESS) {
4393 return;
4394 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004395
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004396 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004397}
4398
4399
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004400void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004401 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004402 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004403 uint64_t *puValue,
4404 QCBORItem *pItem)
4405{
4406 if(pMe->uLastError != QCBOR_SUCCESS) {
4407 return;
4408 }
4409
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004410 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004411 if(pMe->uLastError != QCBOR_SUCCESS) {
4412 return;
4413 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004414
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004415 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004416}
4417
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004418
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004419/*
4420 Public function, see header qcbor/qcbor_decode.h file
4421*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004422static QCBORError Uint64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004423{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004424 switch(pItem->uDataType) {
4425
4426 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004427 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004428 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4429 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004430 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004431 }
4432 break;
4433
4434 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004435 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004436 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4437 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004438 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004439 }
4440 break;
4441
4442#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4443
4444 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004445 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004446 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004447 pItem->val.expAndMantissa.nExponent,
4448 puValue,
4449 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004450 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004451 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004452 }
4453 break;
4454
4455 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004456 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004457 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4458 pItem->val.expAndMantissa.nExponent,
4459 puValue,
4460 Exponentitate2);
4461 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004462 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004463 }
4464 break;
4465
4466 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004467 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004468 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004469 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004470 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004471 if(uErr != QCBOR_SUCCESS) {
4472 return uErr;
4473 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004474 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004475 pItem->val.expAndMantissa.nExponent,
4476 puValue,
4477 Exponentitate10);
4478 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004479 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004480 }
4481 break;
4482
4483 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004484 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004485 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4486 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004487 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004488 }
4489 break;
4490
4491 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004492 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004493 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004494 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004495 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004496 if(uErr != QCBOR_SUCCESS) {
4497 return uErr;
4498 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004499 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004500 pItem->val.expAndMantissa.nExponent,
4501 puValue,
4502 Exponentitate2);
4503 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004504 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004505 }
4506 break;
4507
4508 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004509 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004510 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4511 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004512 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004513 }
4514 break;
4515#endif
4516 default:
4517 return QCBOR_ERR_UNEXPECTED_TYPE;
4518 }
4519}
4520
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004521
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004522/*
4523 Public function, see header qcbor/qcbor_decode.h file
4524*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004525void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004526{
4527 QCBORItem Item;
4528
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004529 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004530
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004531 if(pMe->uLastError == QCBOR_SUCCESS) {
4532 // The above conversion succeeded
4533 return;
4534 }
4535
4536 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4537 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004538 return;
4539 }
4540
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004541 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004542}
4543
Laurence Lundbladec4537442020-04-14 18:53:22 -07004544
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004545/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004546 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004547*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004548void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004549 int64_t nLabel,
4550 uint32_t uConvertTypes,
4551 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004552{
4553 QCBORItem Item;
4554
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004555 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004556
4557 if(pMe->uLastError == QCBOR_SUCCESS) {
4558 // The above conversion succeeded
4559 return;
4560 }
4561
4562 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4563 // The above conversion failed in a way that code below can't correct
4564 return;
4565 }
4566
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004567 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004568}
4569
4570
4571/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004572 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004573*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004574void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004575 const char *szLabel,
4576 uint32_t uConvertTypes,
4577 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004578{
4579 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004580 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004581
4582 if(pMe->uLastError == QCBOR_SUCCESS) {
4583 // The above conversion succeeded
4584 return;
4585 }
4586
4587 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4588 // The above conversion failed in a way that code below can't correct
4589 return;
4590 }
4591
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004592 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004593}
4594
4595
Laurence Lundblade9b334962020-08-27 10:55:53 -07004596static QCBORError ConvertDouble(const QCBORItem *pItem,
4597 uint32_t uConvertTypes,
4598 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004599{
4600 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004601 case QCBOR_TYPE_FLOAT:
4602#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4603 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4604 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004605 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004606 *pdValue = (double)pItem->val.fnum;
4607 } else {
4608 return QCBOR_ERR_UNEXPECTED_TYPE;
4609 }
4610 }
4611#else
4612 return QCBOR_ERR_HW_FLOAT_DISABLED;
4613#endif
4614 break;
4615
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004616 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004617 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4618 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004619 *pdValue = pItem->val.dfnum;
4620 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004621 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004622 }
4623 }
4624 break;
4625
4626 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004627#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004628 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004629 // A simple cast seems to do the job with no worry of exceptions.
4630 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004631 *pdValue = (double)pItem->val.int64;
4632
4633 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004634 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004635 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004636#else
4637 return QCBOR_ERR_HW_FLOAT_DISABLED;
4638#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004639 break;
4640
4641 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004642#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004643 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004644 // A simple cast seems to do the job with no worry of exceptions.
4645 // There will be precision loss for some values.
4646 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004647 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004648 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004649 }
4650 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004651#else
4652 return QCBOR_ERR_HW_FLOAT_DISABLED;
4653#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004654
4655 default:
4656 return QCBOR_ERR_UNEXPECTED_TYPE;
4657 }
4658
4659 return QCBOR_SUCCESS;
4660}
4661
4662
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004663void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004664 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004665 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004666 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004667{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004668 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004669 return;
4670 }
4671
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004672 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004673
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004674 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004675 if(uError) {
4676 pMe->uLastError = (uint8_t)uError;
4677 return;
4678 }
4679
4680 if(pItem) {
4681 *pItem = Item;
4682 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004683
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004684 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004685}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004686
Laurence Lundbladec4537442020-04-14 18:53:22 -07004687
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004688void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4689 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004690 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004691 double *pdValue,
4692 QCBORItem *pItem)
4693{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004694 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004695 if(pMe->uLastError != QCBOR_SUCCESS) {
4696 return;
4697 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004698
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004699 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004700}
4701
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004702
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004703void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4704 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004705 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004706 double *pdValue,
4707 QCBORItem *pItem)
4708{
4709 if(pMe->uLastError != QCBOR_SUCCESS) {
4710 return;
4711 }
4712
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004713 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004714 if(pMe->uLastError != QCBOR_SUCCESS) {
4715 return;
4716 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004717
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004718 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004719}
4720
4721
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004722#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004723static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4724{
4725 double dResult;
4726
4727 dResult = 0.0;
4728 const uint8_t *pByte = BigNum.ptr;
4729 size_t uLen = BigNum.len;
4730 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07004731 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004732 while(uLen--) {
4733 dResult = (dResult * 256.0) + (double)*pByte++;
4734 }
4735
4736 return dResult;
4737}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004738#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4739
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004740
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004741static QCBORError DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004742{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004743#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004744 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004745 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4746
4747 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004748 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004749
4750#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004751 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004752 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004753 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004754 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4755 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4756 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004757 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004758 }
4759 break;
4760
4761 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004762 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004763 // Underflow gives 0, overflow gives infinity
4764 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4765 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004766 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004767 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004768 }
4769 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004770#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004771
4772 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004773 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004774 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4775 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004776 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004777 }
4778 break;
4779
4780 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004781 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004782 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004783 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004784 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004785 }
4786 break;
4787
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004788#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004789 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004790 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004791 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4792 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4793 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004794 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004795 }
4796 break;
4797
4798 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004799 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004800 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4801 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4802 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004803 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004804 }
4805 break;
4806
4807 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004808 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004809 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4810 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4811 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004812 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004813 }
4814 break;
4815
4816 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004817 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004818 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004819 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4820 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004821 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004822 }
4823 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004824#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4825
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004826 default:
4827 return QCBOR_ERR_UNEXPECTED_TYPE;
4828 }
4829
4830 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004831
4832#else
4833 (void)pItem;
4834 (void)uConvertTypes;
4835 (void)pdValue;
4836 return QCBOR_ERR_HW_FLOAT_DISABLED;
4837#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4838
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004839}
4840
4841
4842/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004843 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004844*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07004845void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
4846 uint32_t uConvertTypes,
4847 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004848{
4849
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004850 QCBORItem Item;
4851
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004852 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004853
4854 if(pMe->uLastError == QCBOR_SUCCESS) {
4855 // The above conversion succeeded
4856 return;
4857 }
4858
4859 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4860 // The above conversion failed in a way that code below can't correct
4861 return;
4862 }
4863
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004864 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004865}
4866
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004867
4868/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004869 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004870*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07004871void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
4872 int64_t nLabel,
4873 uint32_t uConvertTypes,
4874 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004875{
4876 QCBORItem Item;
4877
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004878 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004879
4880 if(pMe->uLastError == QCBOR_SUCCESS) {
4881 // The above conversion succeeded
4882 return;
4883 }
4884
4885 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4886 // The above conversion failed in a way that code below can't correct
4887 return;
4888 }
4889
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004890 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004891}
4892
4893
4894/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004895 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004896*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07004897void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
4898 const char *szLabel,
4899 uint32_t uConvertTypes,
4900 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004901{
4902 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004903 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004904
4905 if(pMe->uLastError == QCBOR_SUCCESS) {
4906 // The above conversion succeeded
4907 return;
4908 }
4909
4910 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4911 // The above conversion failed in a way that code below can't correct
4912 return;
4913 }
4914
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004915 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004916}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004917
4918
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004919
4920
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004921#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004922static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
4923{
4924 while((uInt & 0xff00000000000000UL) == 0) {
4925 uInt = uInt << 8;
4926 };
4927
4928 UsefulOutBuf UOB;
4929
4930 UsefulOutBuf_Init(&UOB, Buffer);
4931
4932 while(uInt) {
4933 const uint64_t xx = uInt & 0xff00000000000000UL;
4934 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
4935 uInt = uInt << 8;
4936 (void)xx;
4937 }
4938
4939 return UsefulOutBuf_OutUBuf(&UOB);
4940}
4941
4942
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004943static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
4944 TagSpecification TagSpec,
4945 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004946{
4947 QCBORError uErr;
4948 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004949 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004950 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004951 if(uErr != QCBOR_SUCCESS) {
4952 goto Done;
4953 }
4954
4955 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
4956 break; // Successful exit. Moving on to finish decoding.
4957 }
4958
4959 // The item is an array, which means an undecoded
4960 // mantissa and exponent, so decode it. It will then
4961 // have a different type and exit the loop if.
4962 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4963 if(uErr != QCBOR_SUCCESS) {
4964 goto Done;
4965 }
4966
4967 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07004968 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004969 }
4970Done:
4971 return uErr;
4972}
4973
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004974
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004975static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004976 TagSpecification TagSpec,
4977 QCBORItem *pItem,
4978 int64_t *pnMantissa,
4979 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004980{
4981 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004982
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004983 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004984 if(uErr != QCBOR_SUCCESS) {
4985 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004986 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004987
Laurence Lundblade9b334962020-08-27 10:55:53 -07004988 switch (pItem->uDataType) {
4989
4990 case QCBOR_TYPE_DECIMAL_FRACTION:
4991 case QCBOR_TYPE_BIGFLOAT:
4992 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
4993 *pnExponent = pItem->val.expAndMantissa.nExponent;
4994 break;
4995
4996 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4997 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
4998 *pnExponent = pItem->val.expAndMantissa.nExponent;
4999 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5000 break;
5001
5002 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5003 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5004 *pnExponent = pItem->val.expAndMantissa.nExponent;
5005 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5006 break;
5007
5008 default:
5009 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5010 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005011
5012 Done:
5013 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005014}
5015
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005016
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005017static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005018 TagSpecification TagSpec,
5019 QCBORItem *pItem,
5020 UsefulBuf BufferForMantissa,
5021 UsefulBufC *pMantissa,
5022 bool *pbIsNegative,
5023 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005024{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005025 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005026
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005027 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005028 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005029 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005030 }
5031
5032 uint64_t uMantissa;
5033
5034 switch (pItem->uDataType) {
5035
5036 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005037 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005038 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5039 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5040 *pbIsNegative = false;
5041 } else {
5042 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5043 *pbIsNegative = true;
5044 }
5045 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5046 *pnExponent = pItem->val.expAndMantissa.nExponent;
5047 break;
5048
5049 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005050 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005051 *pnExponent = pItem->val.expAndMantissa.nExponent;
5052 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5053 *pbIsNegative = false;
5054 break;
5055
5056 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005057 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005058 *pnExponent = pItem->val.expAndMantissa.nExponent;
5059 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5060 *pbIsNegative = true;
5061 break;
5062
5063 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005064 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005065 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005066
5067Done:
5068 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005069}
5070
5071
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005072/*
5073 Public function, see header qcbor/qcbor_decode.h file
5074*/
5075void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5076 uint8_t uTagRequirement,
5077 int64_t *pnMantissa,
5078 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005079{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005080 if(pMe->uLastError != QCBOR_SUCCESS) {
5081 return;
5082 }
5083
5084 QCBORItem Item;
5085 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5086 if(uError) {
5087 pMe->uLastError = (uint8_t)uError;
5088 return;
5089 }
5090
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005091 const TagSpecification TagSpec =
5092 {
5093 uTagRequirement,
5094 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5095 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5096 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005097
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005098 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005099}
5100
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005101
5102/*
5103 Public function, see header qcbor/qcbor_decode.h file
5104*/
5105void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005106 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005107 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005108 int64_t *pnMantissa,
5109 int64_t *pnExponent)
5110{
5111 if(pMe->uLastError != QCBOR_SUCCESS) {
5112 return;
5113 }
5114
5115 QCBORItem Item;
5116 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5117
5118 const TagSpecification TagSpec =
5119 {
5120 uTagRequirement,
5121 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5122 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5123 };
5124
5125 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5126}
5127
5128
5129/*
5130 Public function, see header qcbor/qcbor_decode.h file
5131*/
5132void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005133 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005134 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005135 int64_t *pnMantissa,
5136 int64_t *pnExponent)
5137{
5138 if(pMe->uLastError != QCBOR_SUCCESS) {
5139 return;
5140 }
5141
5142 QCBORItem Item;
5143 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5144
5145 const TagSpecification TagSpec =
5146 {
5147 uTagRequirement,
5148 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5149 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5150 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005151
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005152 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5153}
5154
5155
5156/*
5157 Public function, see header qcbor/qcbor_decode.h file
5158*/
5159void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5160 uint8_t uTagRequirement,
5161 UsefulBuf MantissaBuffer,
5162 UsefulBufC *pMantissa,
5163 bool *pbMantissaIsNegative,
5164 int64_t *pnExponent)
5165{
5166 if(pMe->uLastError != QCBOR_SUCCESS) {
5167 return;
5168 }
5169
5170 QCBORItem Item;
5171 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5172 if(uError) {
5173 pMe->uLastError = (uint8_t)uError;
5174 return;
5175 }
5176
5177 const TagSpecification TagSpec =
5178 {
5179 uTagRequirement,
5180 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5181 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5182 };
5183
5184 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
5185}
5186
5187
5188/*
5189 Public function, see header qcbor/qcbor_decode.h file
5190*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005191void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005192 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005193 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005194 UsefulBuf BufferForMantissa,
5195 UsefulBufC *pMantissa,
5196 bool *pbIsNegative,
5197 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005198{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005199 if(pMe->uLastError != QCBOR_SUCCESS) {
5200 return;
5201 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005202
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005203 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005204 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005205 if(pMe->uLastError != QCBOR_SUCCESS) {
5206 return;
5207 }
5208
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005209 const TagSpecification TagSpec =
5210 {
5211 uTagRequirement,
5212 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5213 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5214 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005215
5216 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005217}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005218
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005219
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005220/*
5221 Public function, see header qcbor/qcbor_decode.h file
5222*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005223void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005224 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005225 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005226 UsefulBuf BufferForMantissa,
5227 UsefulBufC *pMantissa,
5228 bool *pbIsNegative,
5229 int64_t *pnExponent)
5230{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005231 if(pMe->uLastError != QCBOR_SUCCESS) {
5232 return;
5233 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005234
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005235 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005236 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5237 if(pMe->uLastError != QCBOR_SUCCESS) {
5238 return;
5239 }
5240
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005241 const TagSpecification TagSpec =
5242 {
5243 uTagRequirement,
5244 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5245 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5246 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005247
5248 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5249}
5250
5251
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005252/*
5253 Public function, see header qcbor/qcbor_decode.h file
5254*/
5255void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5256 uint8_t uTagRequirement,
5257 int64_t *pnMantissa,
5258 int64_t *pnExponent)
5259{
5260 if(pMe->uLastError != QCBOR_SUCCESS) {
5261 return;
5262 }
5263
5264 QCBORItem Item;
5265 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5266 if(uError) {
5267 pMe->uLastError = (uint8_t)uError;
5268 return;
5269 }
5270 const TagSpecification TagSpec =
5271 {
5272 uTagRequirement,
5273 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5274 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5275 };
5276
5277 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5278}
5279
5280
5281/*
5282 Public function, see header qcbor/qcbor_decode.h file
5283*/
5284void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005285 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005286 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005287 int64_t *pnMantissa,
5288 int64_t *pnExponent)
5289{
5290 if(pMe->uLastError != QCBOR_SUCCESS) {
5291 return;
5292 }
5293
5294 QCBORItem Item;
5295 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5296 if(pMe->uLastError != QCBOR_SUCCESS) {
5297 return;
5298 }
5299
5300 const TagSpecification TagSpec =
5301 {
5302 uTagRequirement,
5303 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5304 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5305 };
5306
5307 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5308}
5309
5310
5311/*
5312 Public function, see header qcbor/qcbor_decode.h file
5313*/
5314void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005315 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005316 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005317 int64_t *pnMantissa,
5318 int64_t *pnExponent)
5319{
5320 if(pMe->uLastError != QCBOR_SUCCESS) {
5321 return;
5322 }
5323
5324 QCBORItem Item;
5325 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5326 if(pMe->uLastError != QCBOR_SUCCESS) {
5327 return;
5328 }
5329
5330 const TagSpecification TagSpec =
5331 {
5332 uTagRequirement,
5333 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5334 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5335 };
5336
5337 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5338}
5339
5340
5341/*
5342 Public function, see header qcbor/qcbor_decode.h file
5343*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005344void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5345 uint8_t uTagRequirement,
5346 UsefulBuf MantissaBuffer,
5347 UsefulBufC *pMantissa,
5348 bool *pbMantissaIsNegative,
5349 int64_t *pnExponent)
5350{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005351 if(pMe->uLastError != QCBOR_SUCCESS) {
5352 return;
5353 }
5354
5355 QCBORItem Item;
5356 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5357 if(uError) {
5358 pMe->uLastError = (uint8_t)uError;
5359 return;
5360 }
5361
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005362 const TagSpecification TagSpec =
5363 {
5364 uTagRequirement,
5365 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5366 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5367 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005368
5369 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005370}
5371
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005372
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005373/*
5374 Public function, see header qcbor/qcbor_decode.h file
5375*/
5376void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005377 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005378 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005379 UsefulBuf BufferForMantissa,
5380 UsefulBufC *pMantissa,
5381 bool *pbIsNegative,
5382 int64_t *pnExponent)
5383{
5384 if(pMe->uLastError != QCBOR_SUCCESS) {
5385 return;
5386 }
5387
5388 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005389 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5390 if(pMe->uLastError != QCBOR_SUCCESS) {
5391 return;
5392 }
5393
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005394 const TagSpecification TagSpec =
5395 {
5396 uTagRequirement,
5397 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5398 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5399 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005400
5401 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5402}
5403
5404
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005405/*
5406 Public function, see header qcbor/qcbor_decode.h file
5407*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005408void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005409 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005410 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005411 UsefulBuf BufferForMantissa,
5412 UsefulBufC *pMantissa,
5413 bool *pbIsNegative,
5414 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005415{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005416 if(pMe->uLastError != QCBOR_SUCCESS) {
5417 return;
5418 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005419
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005420 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005421 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5422 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005423 return;
5424 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005425
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005426 const TagSpecification TagSpec =
5427 {
5428 uTagRequirement,
5429 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5430 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5431 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005432
5433 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005434}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005435
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005436#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */