blob: eabd3e437299eade817688b0bd1e7308f09c9499 [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 Lundblade8e36f812024-01-26 10:59:29 -07003 Copyright (c) 2018-2024, Laurence Lundblade.
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02004 Copyright (c) 2021, Arm Limited.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07005 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08006
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07007Redistribution and use in source and binary forms, with or without
8modification, are permitted provided that the following conditions are
9met:
10 * Redistributions of source code must retain the above copyright
11 notice, this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above
13 copyright notice, this list of conditions and the following
14 disclaimer in the documentation and/or other materials provided
15 with the distribution.
16 * Neither the name of The Linux Foundation nor the names of its
17 contributors, nor the name "Laurence Lundblade" may be used to
18 endorse or promote products derived from this software without
19 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080020
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070021THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
22WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
24ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
25BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
30OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080032 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070033
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080034
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080035#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070036#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080037#include "ieee754.h" /* Does not use math.h */
Laurence Lundbladec7114722020-08-13 05:11:40 -070038
39#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080040
41#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
42 * pow(), exp2()
43 */
44#include <fenv.h> /* feclearexcept(), fetestexcept() */
45
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080046#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070047
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070048
Laurence Lundblade68cb61c2023-02-12 13:21:44 -080049#if (defined(__GNUC__) && !defined(__clang__))
Laurence Lundblade8e36f812024-01-26 10:59:29 -070050/*
Laurence Lundblade68cb61c2023-02-12 13:21:44 -080051 * This is how the -Wmaybe-uninitialized compiler warning is
52 * handled. It can’t be ignored because some version of gcc enable it
53 * with -Wall which is a common and useful gcc warning option. It also
54 * can’t be ignored because it is the goal of QCBOR to compile clean
55 * out of the box in all environments.
56 *
57 * The big problem with -Wmaybe-uninitialized is that it generates
58 * false positives. It complains things are uninitialized when they
59 * are not. This is because it is not a thorough static analyzer. This
60 * is why “maybe” is in its name. The problem is it is just not
61 * thorough enough to understand all the code (and someone saw fit to
62 * put it in gcc and worse to enable it with -Wall).
63 *
64 * One solution would be to change the code so -Wmaybe-uninitialized
65 * doesn’t get confused, for example adding an unnecessary extra
66 * initialization to zero. (If variables were truly uninitialized, the
67 * correct path is to understand the code thoroughly and set them to
68 * the correct value at the correct time; in essence this is already
69 * done; -Wmaybe-uninitialized just can’t tell). This path is not
70 * taken because it makes the code bigger and is kind of the tail
71 * wagging the dog.
72 *
73 * The solution here is to just use a pragma to disable it for the
74 * whole file. Disabling it for each line makes the code fairly ugly
75 * requiring #pragma to push, pop and ignore. Another reason is the
76 * warnings issues vary by version of gcc and which optimization
77 * optimizations are selected. Another reason is that compilers other
78 * than gcc don’t have -Wmaybe-uninitialized.
79 *
80 * One may ask how to be sure these warnings are false positives and
81 * not real issues. 1) The code has been read carefully to check. 2)
82 * Testing is pretty thorough. 3) This code has been run through
83 * thorough high-quality static analyzers.
84 *
85 * In particularly, most of the warnings are about
86 * Item.Item->uDataType being uninitialized. QCBORDecode_GetNext()
87 * *always* sets this value and test case confirm
88 * this. -Wmaybe-uninitialized just can't tell.
89 *
90 * https://stackoverflow.com/questions/5080848/disable-gcc-may-be-used-uninitialized-on-a-particular-variable
91 */
92#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
Laurence Lundblade8e36f812024-01-26 10:59:29 -070093#endif
Laurence Lundblade68cb61c2023-02-12 13:21:44 -080094
95
96
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080097
Laurence Lundbladea9489f82020-09-12 13:50:56 -070098#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070099
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700100
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800101
102
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700103static bool
104QCBORItem_IsMapOrArray(const QCBORItem Item)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700105{
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700106 const uint8_t uDataType = Item.uDataType;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700107 return uDataType == QCBOR_TYPE_MAP ||
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700108#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
109 uDataType == QCBOR_TYPE_MAP_AS_ARRAY ||
110#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
111 uDataType == QCBOR_TYPE_ARRAY;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700112}
113
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700114static bool
115QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem Item)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700116{
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700117 if(!QCBORItem_IsMapOrArray(Item)){
Laurence Lundblade02625d42020-06-25 14:41:41 -0700118 return false;
119 }
120
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700121 if(Item.val.uCount != 0) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700122 return false;
123 }
124 return true;
125}
126
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700127static bool
128QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem Item)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700129{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800130#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700131 if(!QCBORItem_IsMapOrArray(Item)){
Laurence Lundblade02625d42020-06-25 14:41:41 -0700132 return false;
133 }
134
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700135 if(Item.val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700136 return false;
137 }
138 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800139#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700140 (void)Item;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800141 return false;
142#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700143}
144
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700145/* Return true if the labels in Item1 and Item2 are the same.
146 Works only for integer and string labels. Returns false
147 for any other type. */
148static bool
149QCBORItem_MatchLabel(const QCBORItem Item1, const QCBORItem Item2)
150{
151 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
152 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
153 return true;
154 }
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700155#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700156 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
157 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
158 return true;
159 }
160 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
161 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
162 return true;
163 }
164 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
165 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
166 return true;
167 }
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700168#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700169 }
170
171 /* Other label types are never matched */
172 return false;
173}
174
175
176/*
177 Returns true if Item1 and Item2 are the same type
178 or if either are of QCBOR_TYPE_ANY.
179 */
180static bool
181QCBORItem_MatchType(const QCBORItem Item1, const QCBORItem Item2)
182{
183 if(Item1.uDataType == Item2.uDataType) {
184 return true;
185 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
186 return true;
187 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
188 return true;
189 }
190 return false;
191}
192
Laurence Lundblade02625d42020-06-25 14:41:41 -0700193
Laurence Lundbladeee851742020-01-08 08:37:05 -0800194/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700195 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -0800196 ===========================================================================*/
197
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700198/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800199 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
200 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700201 */
202
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700203
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700204static uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700205DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700206{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700207 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800208 /* Limit in DecodeNesting_Descend against more than
209 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700210 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700211 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700212}
213
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700214
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700215static uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700216DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700217{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700218 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800219 /* Limit in DecodeNesting_Descend against more than
220 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700221 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700222 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700223}
224
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700225
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700226static uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700227DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700228{
229 return pNesting->pCurrentBounded->u.ma.uStartOffset;
230}
231
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700232
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700233static bool
Laurence Lundblade085d7952020-07-24 10:26:30 -0700234DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
235{
236 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
237 return true;
238 } else {
239 return false;
240 }
241}
242
243
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700244static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700245DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700246{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700247 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700248 return true;
249 } else {
250 return false;
251 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700252}
253
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700254
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700255static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700256DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700257{
258 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800259 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700260 return false;
261 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800262
263#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700264 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800265 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700266 return false;
267 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800268
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800269#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
270
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800271 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700272 return true;
273}
274
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700275static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700276DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700277{
278 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800279 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700280 return true;
281 }
282 return false;
283}
284
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700285
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700286static bool
287DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700288{
289 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
290 return true;
291 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700292 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700293 return true;
294 }
295 return false;
296}
297
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700298
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700299static void
300DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700301{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800302 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700303 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800304 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
305 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
306 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700307 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700308 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700309
310 if(bIsEmpty) {
311 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
312 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700313}
314
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700315
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700316static void
317DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700318{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700319 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700320}
321
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700322
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700323static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700324DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700325{
326 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800327 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700328 return false;
329 }
330 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800331 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700332 return false;
333 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700334 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800335 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700336 return false;
337 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800338 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800339 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
340 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800341 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700342 return false;
343 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800344 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700345 return true;
346}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700347
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700348
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700349static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700350DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700351{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800352 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700353 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
354 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700355 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700356 return false;
357 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700358}
359
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700360
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700361static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700362DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700363{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700364 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
365 return true;
366 } else {
367 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700368 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700369}
370
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700371
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700372static bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700373DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700374{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700375 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700376 return false;
377 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700378
Laurence Lundblade5db34da2024-05-30 03:14:35 -0700379 uint8_t uItemDataType = pNesting->pCurrentBounded->uLevelType;
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700380#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundblade5db34da2024-05-30 03:14:35 -0700381 if(uItemDataType == QCBOR_TYPE_MAP_AS_ARRAY) {
382 uItemDataType = QCBOR_TYPE_ARRAY;
383 }
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700384#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
Laurence Lundblade5db34da2024-05-30 03:14:35 -0700385
386 if(uItemDataType != uType) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700387 return false;
388 }
389
390 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700391}
392
Laurence Lundblade02625d42020-06-25 14:41:41 -0700393
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700394static void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700395DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700396{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800397 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700398 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700399}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700400
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700401
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700402static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700403DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
404{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800405 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700406 pNesting->pCurrent->u.ma.uCountCursor++;
407}
408
409
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700410static void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700411DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
412{
413 pNesting->pCurrent--;
414}
415
Laurence Lundblade02625d42020-06-25 14:41:41 -0700416
417static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700418DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700419{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800420 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700421 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700422 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700423 }
424
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800425 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700426 pNesting->pCurrent++;
427
428 pNesting->pCurrent->uLevelType = uType;
429
430 return QCBOR_SUCCESS;
431}
432
433
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700434static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800435DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
436 bool bIsEmpty,
437 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700438{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700439 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800440 * Should only be called on map/array.
441 *
442 * Have descended into this before this is called. The job here is
443 * just to mark it in bounded mode.
444 *
445 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
446 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
447 *
448 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700449 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800450 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700451 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700452 }
453
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700454 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700455
456 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700457
458 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700459}
460
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700461
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700462static QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700463DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700464 uint8_t uQCBORType,
465 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700466{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700467 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700468
469 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800470 /* Nothing to do for empty definite-length arrays. They are just are
471 * effectively the same as an item that is not a map or array.
472 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700473 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800474 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700475 }
476
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800477 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700478 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
479 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700480 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700481 goto Done;
482 }
483
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700484 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700485 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700486 goto Done;
487 }
488
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800489 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700490 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
491 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700492
493 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700494
495Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700496 return uError;;
497}
498
499
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700500static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700501DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
502{
503 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
504}
505
506
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700507static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700508DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
509{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700510 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700511 pNesting->pCurrentBounded--;
512 if(DecodeNesting_IsCurrentBounded(pNesting)) {
513 break;
514 }
515 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700516}
517
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800518
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700519static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700520DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
521{
522 pNesting->pCurrent = pNesting->pCurrentBounded;
523}
524
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700525
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700526static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700527DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700528 uint32_t uEndOffset,
529 uint32_t uStartOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700530{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700531 QCBORError uError;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700532
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700533 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700534 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700535 goto Done;
536 }
537
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800538 /* Fill in the new byte string level */
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700539 pNesting->pCurrent->u.bs.uSavedEndOffset = uEndOffset;
540 pNesting->pCurrent->u.bs.uBstrStartOffset = uStartOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700541
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800542 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700543 pNesting->pCurrentBounded = pNesting->pCurrent;
544
545Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700546 return uError;;
547}
548
Laurence Lundbladed0304932020-06-27 10:59:38 -0700549
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700550static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700551DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700552{
553 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700554}
555
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700556
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700557static void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800558DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
559{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700560 if(pNesting->pCurrent->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
561 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
562 }
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800563}
564
565
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700566static void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700567DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700568{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700569 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700570 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
571 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700572}
573
574
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700575static void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800576DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
577 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700578{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700579 *pSave = *pNesting;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700580}
581
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700582
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700583static void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800584DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
585 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700586{
587 *pNesting = *pSave;
588}
589
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700590
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700591static uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700592DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700593{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700594 return pMe->pCurrentBounded->u.bs.uSavedEndOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700595}
596
597
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800598
599
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800600#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800601/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800602 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
603
604 The following four functions are pretty wrappers for invocation of
605 the string allocator supplied by the caller.
606
Laurence Lundbladeee851742020-01-08 08:37:05 -0800607 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800608
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700609static void
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800610StringAllocator_Free(const QCBORInternalAllocator *pMe, const void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800611{
Maxim Zhukovd538f0a2022-12-20 20:40:38 +0300612 /* This cast to uintptr_t suppresses the "-Wcast-qual" warnings.
613 * This is the one place where the const needs to be cast away so const can
614 * be use in the rest of the code.
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800615 */
Maxim Zhukovd538f0a2022-12-20 20:40:38 +0300616 (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)(uintptr_t)pMem, 0);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800617}
618
Laurence Lundbladeee851742020-01-08 08:37:05 -0800619// StringAllocator_Reallocate called with pMem NULL is
620// equal to StringAllocator_Allocate()
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700621static UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800622StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800623 const void *pMem,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800624 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800625{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800626 /* See comment in StringAllocator_Free() */
Maxim Zhukovd538f0a2022-12-20 20:40:38 +0300627 return (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)(uintptr_t)pMem, uSize);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800628}
629
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700630static UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800631StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800632{
633 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
634}
635
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700636static void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800637StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800638{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800639 /* See comment in StringAllocator_Free() */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800640 if(pMe->pfAllocator) {
641 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
642 }
643}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800644#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800645
646
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800647
648
Laurence Lundbladeee851742020-01-08 08:37:05 -0800649/*===========================================================================
650 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700651
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800652 See qcbor/qcbor_decode.h for definition of the object
653 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800654 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700655/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800656 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700657 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700658void
659QCBORDecode_Init(QCBORDecodeContext *pMe,
660 UsefulBufC EncodedCBOR,
661 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700662{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800663 memset(pMe, 0, sizeof(QCBORDecodeContext));
664 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
665 /* Don't bother with error check on decode mode. If a bad value is
666 * passed it will just act as if the default normal mode of 0 was set.
667 */
668 pMe->uDecodeMode = (uint8_t)nDecodeMode;
669 DecodeNesting_Init(&(pMe->nesting));
670
671 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
672 * GetNext_TaggedItem() and MapTagNumber(). */
673 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700674}
675
676
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800677#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
678
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700679/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800680 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700681 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700682void
683QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
684 QCBORStringAllocate pfAllocateFunction,
685 void *pAllocateContext,
686 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700687{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800688 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
689 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
690 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700691}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800692#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700693
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800694
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800695
696
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800697/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800698 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800699 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700700void
701QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
702 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700703{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800704 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700705 (void)pMe;
706 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700707}
708
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700709
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800710
711
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700712/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800713 * Decoding items is done in six layers, one calling the next one
714 * down. If a layer has no work to do for a particular item, it
715 * returns quickly.
716 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700717 * 1. QCBORDecode_Private_GetNextTagContent - The top layer processes
718 * tagged data items, turning them into the local C representation.
719 * For the most simple it is just associating a QCBOR_TYPE with the
720 * data. For the complex ones that an aggregate of data items, there
721 * is some further decoding and some limited recursion.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800722 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700723 * 2. QCBORDecode_Private_GetNextMapOrArray - This manages the
724 * beginnings and ends of maps and arrays. It tracks descending into
725 * and ascending out of maps/arrays. It processes breaks that
726 * terminate indefinite-length maps and arrays.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800727 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700728 * 3. QCBORDecode_Private_GetNextMapEntry - This handles the combining
729 * of two items, the label and the data, that make up a map entry. It
730 * only does work on maps. It combines the label and data items into
731 * one labeled item.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800732 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700733 * 4. QCBORDecode_Private_GetNextTagNumber - This decodes type 6 tag
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800734 * numbers. It turns the tag numbers into bit flags associated with
735 * the data item. No actual decoding of the contents of the tag is
736 * performed here.
737 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700738 * 5. QCBORDecode_Private_GetNextFullString - This assembles the
739 * sub-items that make up an indefinite-length string into one string
740 * item. It uses the string allocator to create contiguous space for
741 * the item. It processes all breaks that are part of
742 * indefinite-length strings.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800743 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700744 * 6. QCBOR_Private_DecodeAtomicDataItem - This decodes the atomic
745 * data items in CBOR. Each atomic data item has a "major type", an
746 * integer "argument" and optionally some content. For text and byte
747 * strings, the content is the bytes that make up the string. These
748 * are the smallest data items that are considered to be well-formed.
749 * The content may also be other data items in the case of aggregate
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800750 * types. They are not handled in this layer.
751 *
Laurence Lundblade0f01ac62024-02-18 23:07:07 -0700752 * This uses about 350 bytes of stack. This number comes from
753 * instrumenting (printf address of stack variables) the code on x86
754 * compiled for size optimization.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700755 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800756
757
758/*
759 * Note about use of int and unsigned variables.
760 *
761 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
762 * used carefully here, and in particular why it isn't used in the
763 * public interface. Also see
764 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
765 *
766 * Int is used for values that need less than 16-bits and would be
767 * subject to integer promotion and result in complaining from static
768 * analyzers.
769 */
770
771
772/**
773 * @brief Decode the CBOR head, the type and argument.
774 *
775 * @param[in] pUInBuf The input buffer to read from.
776 * @param[out] pnMajorType The decoded major type.
777 * @param[out] puArgument The decoded argument.
778 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
779 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -0700780 * @retval QCBOR_ERR_UNSUPPORTED Encountered unsupported/reserved features
781 * @retval QCBOR_ERR_HIT_END Unexpected end of input
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800782 *
783 * This decodes the CBOR "head" that every CBOR data item has. See
784 * longer explaination of the head in documentation for
785 * QCBOREncode_EncodeHead().
786 *
787 * This does the network->host byte order conversion. The conversion
788 * here also results in the conversion for floats in addition to that
789 * for lengths, tags and integer values.
790 *
791 * The int type is preferred to uint8_t for some variables as this
792 * avoids integer promotions, can reduce code size and makes static
793 * analyzers happier.
794 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700795static QCBORError
796QCBOR_Private_DecodeHead(UsefulInputBuf *pUInBuf,
797 int *pnMajorType,
798 uint64_t *puArgument,
799 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700800{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800801 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800802
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800803 /* Get the initial byte that every CBOR data item has and break it
804 * down. */
805 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800806 const int nTmpMajorType = nInitialByte >> 5;
807 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800808
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800809 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800810 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800811
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800812 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800813 /* Need to get 1,2,4 or 8 additional argument bytes. Map
814 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
815 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800816 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800817
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800818 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800819 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800820 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800821 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800822 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
823 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800824 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800825 /* The reserved and thus-far unused additional info values */
826 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800827 goto Done;
828 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800829 /* Less than 24, additional info is argument or 31, an
830 * indefinite-length. No more bytes to get.
831 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800832 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700833 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800834
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700835 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800836 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700837 goto Done;
838 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800839
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800840 /* All successful if arrived here. */
841 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800842 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800843 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800844 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800845
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700846Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800847 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700848}
849
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800850
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800851/**
852 * @brief Decode integer types, major types 0 and 1.
853 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700854 * @param[in] nMajorType The CBOR major type (0 or 1).
855 * @param[in] uArgument The argument from the head.
856 * @param[in] nAdditionalInfo So it can be error-checked.
857 * @param[out] pDecodedItem The filled in decoded item.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800858 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700859 * @retval QCBOR_ERR_INT_OVERFLOW Too-large negative encountered.
860 * @retval QCBOR_ERR_BAD_INT nAdditionalInfo indicated indefinte.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800861 *
862 * Must only be called when major type is 0 or 1.
863 *
864 * CBOR doesn't explicitly specify two's compliment for integers but
865 * all CPUs use it these days and the test vectors in the RFC are
866 * so. All integers in the CBOR structure are positive and the major
867 * type indicates positive or negative. CBOR can express positive
868 * integers up to 2^x - 1 where x is the number of bits and negative
869 * integers down to 2^x. Note that negative numbers can be one more
870 * away from zero than positive. Stdint, as far as I can tell, uses
871 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700872 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700873static QCBORError
874QCBOR_Private_DecodeInteger(const int nMajorType,
875 const uint64_t uArgument,
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700876 const int nAdditionalInfo,
Laurence Lundblade8e36f812024-01-26 10:59:29 -0700877 QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700878{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800879 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800880
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700881 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
882 uReturn = QCBOR_ERR_BAD_INT;
883 goto Done;
884 }
885
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700886 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800887 if (uArgument <= INT64_MAX) {
888 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700889 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800890
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700891 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800892 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700893 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700894 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800895
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700896 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800897 if(uArgument <= INT64_MAX) {
898 /* CBOR's representation of negative numbers lines up with
899 * the two-compliment representation. A negative integer has
900 * one more in range than a positive integer. INT64_MIN is
901 * equal to (-INT64_MAX) - 1.
902 */
903 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700904 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800905
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700906 } else {
Laurence Lundblade2d493002024-02-01 11:09:17 -0700907 pDecodedItem->val.uint64 = uArgument;
908 pDecodedItem->uDataType = QCBOR_TYPE_65BIT_NEG_INT;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700909 }
910 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800911
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700912Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800913 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700914}
915
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800916
Laurence Lundbladeec290b82024-06-10 11:10:54 -0700917/**
918 * @brief Decode text and byte strings
919 *
920 * @param[in] pMe Decoder context.
921 * @param[in] bAllocate Whether to allocate and copy string.
922 * @param[in] nMajorType Whether it is a byte or text string.
923 * @param[in] uStrLen The length of the string.
924 * @param[in] nAdditionalInfo Whether it is an indefinite-length string.
925 * @param[out] pDecodedItem The filled-in decoded item.
926 *
927 * @retval QCBOR_ERR_HIT_END Unexpected end of input.
928 * @retval QCBOR_ERR_STRING_ALLOCATE Out of memory.
929 * @retval QCBOR_ERR_STRING_TOO_LONG String longer than SIZE_MAX - 4.
930 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR Allocation requested, but no allocator
931 *
932 * This reads @c uStrlen bytes from the input and fills in @c
933 * pDecodedItem. If @c bAllocate is true, then memory for the string
934 * is allocated.
935 */
936static QCBORError
937QCBOR_Private_DecodeString(QCBORDecodeContext *pMe,
938 const bool bAllocate,
939 const int nMajorType,
940 const uint64_t uStrLen,
941 const int nAdditionalInfo,
942 QCBORItem *pDecodedItem)
943{
944 QCBORError uReturn = QCBOR_SUCCESS;
945
946 /* ---- Figure out the major type ---- */
947 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
948 #error QCBOR_TYPE_BYTE_STRING not lined up with major type
949 #endif
950
951 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
952 #error QCBOR_TYPE_TEXT_STRING not lined up with major type
953 #endif
954 pDecodedItem->uDataType = (uint8_t)(nMajorType + 4);
955
956 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
957 /* --- Just the head of an indefinite-length string --- */
958 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
959
960 } else {
961 /* --- A definite-length string --- */
962 /* --- (which might be a chunk of an indefinte-length string) --- */
963
964 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
965 * CPUs. This check makes the casts to size_t below safe.
966 *
967 * The max is 4 bytes less than the largest sizeof() so this can be
968 * tested by putting a SIZE_MAX length in the CBOR test input (no
969 * one will care the limit on strings is 4 bytes shorter).
970 */
971 if(uStrLen > SIZE_MAX-4) {
972 uReturn = QCBOR_ERR_STRING_TOO_LONG;
973 goto Done;
974 }
975
976 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(&(pMe->InBuf), (size_t)uStrLen);
977 if(UsefulBuf_IsNULLC(Bytes)) {
978 /* Failed to get the bytes for this string item */
979 uReturn = QCBOR_ERR_HIT_END;
980 goto Done;
981 }
982
983 if(bAllocate) {
984#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
985 /* --- Put string in allocated memory --- */
986
987 /* Note that this is not where allocation to coalesce
988 * indefinite-length strings is done. This is for when the
989 * caller has requested all strings be allocated. Disabling
990 * indefinite length strings also disables this allocate-all
991 * option.
992 */
993
994 if(pMe->StringAllocator.pfAllocator == NULL) {
995 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
996 goto Done;
997 }
998 UsefulBuf NewMem = StringAllocator_Allocate(&(pMe->StringAllocator), (size_t)uStrLen);
999 if(UsefulBuf_IsNULL(NewMem)) {
1000 uReturn = QCBOR_ERR_STRING_ALLOCATE;
1001 goto Done;
1002 }
1003 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
1004 pDecodedItem->uDataAlloc = 1;
1005#else
1006 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1007#endif /* ! QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1008 } else {
1009 /* --- Normal case with no string allocator --- */
1010 pDecodedItem->val.string = Bytes;
1011 }
1012 }
1013
1014Done:
1015 return uReturn;
1016}
1017
1018
1019/**
1020 * @brief Decode array or map.
1021 *
1022 * @param[in] uMode Decoder mode.
1023 * @param[in] nMajorType Whether it is a byte or text string.
1024 * @param[in] uItemCount The length of the string.
1025 * @param[in] nAdditionalInfo Whether it is an indefinite-length.
1026 * @param[out] pDecodedItem The filled-in decoded item.
1027 *
1028 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED Indefinites disabled.
1029 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG Too many items in array/map.
1030 *
1031 * Not much to do for arrays and maps. Just the type item count (but a
1032 * little messy because of ifdefs for indefinite-lengths and
1033 * map-as-array decoding).
1034 *
1035 * This also does the bulk of the work for @ref
1036 * QCBOR_DECODE_MODE_MAP_AS_ARRAY, a special mode to handle
1037 * arbitrarily complex map labels. This ifdefs out with
1038 * QCBOR_DISABLE_NON_INTEGER_LABELS.
1039 */
1040static QCBORError
1041QCBOR_Private_DecodeArrayOrMap(const uint8_t uMode,
1042 const int nMajorType,
1043 const uint64_t uItemCount,
1044 const int nAdditionalInfo,
1045 QCBORItem *pDecodedItem)
1046{
1047 QCBORError uReturn;
1048
1049 /* ------ Sort out the data type ------ */
1050 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1051 #error QCBOR_TYPE_ARRAY value not lined up with major type
1052 #endif
1053
1054 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1055 #error QCBOR_TYPE_MAP value not lined up with major type
1056 #endif
1057 pDecodedItem->uDataType = (uint8_t)nMajorType;
1058#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
1059 if(uMode == QCBOR_DECODE_MODE_MAP_AS_ARRAY && nMajorType == QCBOR_TYPE_MAP) {
1060 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
1061 }
1062#else
1063 (void)uMode;
1064#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
1065
1066 uReturn = QCBOR_SUCCESS;
1067
1068 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1069 /* ------ Indefinite-length array/map ----- */
1070#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1071 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1072#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1073 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1074#endif /* ! QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1075 } else {
1076
1077#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
1078 if(uMode == QCBOR_DECODE_MODE_MAP_AS_ARRAY && nMajorType == QCBOR_TYPE_MAP) {
1079 /* ------ Definite-length map as array ------ */
1080
1081 if(uItemCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
1082 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1083 } else {
1084 /* cast OK because of check above */
1085 pDecodedItem->val.uCount = (uint16_t)uItemCount*2;
1086 }
1087
1088 } else
1089#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
1090 {
1091 /* ------ Definite-length array/map ------ */
1092 if(uItemCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
1093 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1094 } else {
1095 /* cast OK because of check above */
1096 pDecodedItem->val.uCount = (uint16_t)uItemCount;
1097 }
1098 }
1099 }
1100
1101 return uReturn;
1102}
1103
1104
1105/**
1106 * @brief Decode a tag number.
1107 *
1108 * @param[in] uTagNumber The length of the string.
1109 * @param[in] nAdditionalInfo So this can be error-checked.
1110 * @param[out] pDecodedItem The filled-in decoded item.
1111 *
1112 * @retval QCBOR_ERR_BAD_INT nAdditionalInfo is LEN_IS_INDEFINITE.
1113 * @retval QCBOR_ERR_TAGS_DISABLED QCBOR_DISABLE_TAGS is defined.
1114 *
1115 * Not much to do for tags, but fill in pDecodedItem and check for
1116 * error in nAdditionalInfo.
1117 */
1118static QCBORError
1119QCBOR_Private_DecodeTag(const uint64_t uTagNumber,
1120 const int nAdditionalInfo,
1121 QCBORItem *pDecodedItem)
1122{
1123#ifndef QCBOR_DISABLE_TAGS
1124 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1125 return QCBOR_ERR_BAD_INT;
1126 } else {
1127 pDecodedItem->val.uTagV = uTagNumber;
1128 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1129 return QCBOR_SUCCESS;
1130 }
1131#else /* QCBOR_DISABLE_TAGS */
1132 (void)nAdditionalInfo;
Laurence Lundblade6c9a8242024-06-12 20:34:52 -07001133 (void)uTagNumber;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001134 (void)pDecodedItem;
1135 return QCBOR_ERR_TAGS_DISABLED;
1136#endif /* QCBOR_DISABLE_TAGS */
1137}
1138
1139
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001140/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001141#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
1142#error QCBOR_TYPE_FALSE macro value wrong
1143#endif
1144
1145#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
1146#error QCBOR_TYPE_TRUE macro value wrong
1147#endif
1148
1149#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
1150#error QCBOR_TYPE_NULL macro value wrong
1151#endif
1152
1153#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
1154#error QCBOR_TYPE_UNDEF macro value wrong
1155#endif
1156
Laurence Lundblade0f99d692018-09-26 14:39:28 -07001157#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
1158#error QCBOR_TYPE_BREAK macro value wrong
1159#endif
1160
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001161#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
1162#error QCBOR_TYPE_DOUBLE macro value wrong
1163#endif
1164
1165#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
1166#error QCBOR_TYPE_FLOAT macro value wrong
1167#endif
1168
Laurence Lundblade9b334962020-08-27 10:55:53 -07001169
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001170/**
1171 * @brief Decode major type 7 -- true, false, floating-point, break...
1172 *
1173 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
1174 * @param[in] uArgument The argument from the head.
1175 * @param[out] pDecodedItem The filled in decoded item.
1176 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001177 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED Half-precision in input, but decode
1178 * of half-precision disabled
1179 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point in input, but all float
1180 * decode is disabled.
1181 * @retval QCBOR_ERR_BAD_TYPE_7 Not-allowed representation of simple
1182 * type in input.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001183 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001184static QCBORError
1185QCBOR_Private_DecodeType7(const int nAdditionalInfo,
1186 const uint64_t uArgument,
1187 QCBORItem *pDecodedItem)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001188{
1189 QCBORError uReturn = QCBOR_SUCCESS;
1190
1191 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
1192 * checks above make sure uAdditionalInfo values line up with
1193 * uDataType values. DecodeHead() never returns an AdditionalInfo
1194 * > 0x1f so cast is safe.
1195 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001196 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001197
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001198 switch(nAdditionalInfo) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001199 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
1200 * are caught before this is called.
1201 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001202
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001203 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -07001204#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001205 /* Half-precision is returned as a double. The cast to
1206 * uint16_t is safe because the encoded value was 16 bits. It
1207 * was widened to 64 bits to be passed in here.
1208 */
1209 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +07001210 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001211#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001212 uReturn = FLOAT_ERR_CODE_NO_HALF_PREC(QCBOR_SUCCESS);
Laurence Lundblade12d32c52018-09-19 11:25:27 -07001213 break;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001214 case SINGLE_PREC_FLOAT: /* 26 */
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001215#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001216 /* Single precision is normally returned as a double since
1217 * double is widely supported, there is no loss of precision,
1218 * it makes it easy for the caller in most cases and it can
1219 * be converted back to single with no loss of precision
1220 *
1221 * The cast to uint32_t is safe because the encoded value was
1222 * 32 bits. It was widened to 64 bits to be passed in here.
1223 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07001224 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001225 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07001226#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001227 /* In the normal case, use HW to convert float to
1228 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07001229 pDecodedItem->val.dfnum = (double)f;
1230 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001231#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001232 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07001233 pDecodedItem->val.fnum = f;
1234 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
1235
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001236 /* IEEE754_FloatToDouble() could be used here to return as
1237 * a double, but it adds object code and most likely
1238 * anyone disabling FLOAT HW use doesn't care about floats
1239 * and wants to save object code.
1240 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001241#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07001242 }
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001243#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
1244 uReturn = FLOAT_ERR_CODE_NO_FLOAT(QCBOR_SUCCESS);
Laurence Lundblade12d32c52018-09-19 11:25:27 -07001245 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07001246
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001247 case DOUBLE_PREC_FLOAT: /* 27 */
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001248#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001249 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +07001250 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001251#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
1252 uReturn = FLOAT_ERR_CODE_NO_FLOAT(QCBOR_SUCCESS);
Laurence Lundblade12d32c52018-09-19 11:25:27 -07001253 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001254
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001255 case CBOR_SIMPLEV_FALSE: /* 20 */
1256 case CBOR_SIMPLEV_TRUE: /* 21 */
1257 case CBOR_SIMPLEV_NULL: /* 22 */
1258 case CBOR_SIMPLEV_UNDEF: /* 23 */
1259 case CBOR_SIMPLE_BREAK: /* 31 */
1260 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001261
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001262 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
1263 if(uArgument <= CBOR_SIMPLE_BREAK) {
1264 /* This takes out f8 00 ... f8 1f which should be encoded
1265 * as e0 … f7
1266 */
1267 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001268 goto Done;
1269 }
Laurence Lundblade5e390822019-01-06 12:35:01 -08001270 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001271
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001272 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001273 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001274 /* DecodeHead() will make uArgument equal to
1275 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
1276 * safe because the 2, 4 and 8 byte lengths of uNumber are in
1277 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -08001278 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001279 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001280 break;
1281 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001282
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001283Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001284 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001285}
1286
1287
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001288/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001289 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001290 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001291 * @param[in] pMe Decoder context.
1292 * @param[in] bAllocateStrings If true, use allocator for strings.
1293 * @param[out] pDecodedItem The filled-in decoded item.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001294 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001295 * @retval QCBOR_ERR_UNSUPPORTED Encountered unsupported/reserved
1296 * features
1297 * @retval QCBOR_ERR_HIT_END Unexpected end of input
1298 * @retval QCBOR_ERR_INT_OVERFLOW Too-large negative encountered
1299 * @retval QCBOR_ERR_STRING_ALLOCATE Out of memory.
1300 * @retval QCBOR_ERR_STRING_TOO_LONG String longer than SIZE_MAX - 4.
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001301 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR Allocation requested, but no allocator
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001302 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED Half-precision in input, but decode
1303 * of half-precision disabled
1304 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point in input, but all
1305 * float decode is disabled.
1306 * @retval QCBOR_ERR_BAD_TYPE_7 Not-allowed representation of
1307 * simple type in input.
1308 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED Indefinite length map/array
1309 * in input, but indefinite
1310 * lengths disabled.
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001311 * @retval QCBOR_ERR_BAD_INT nAdditionalInfo indicated indefinte.
1312 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG Too many items in array/map.
1313 * @retval QCBOR_ERR_TAGS_DISABLED QCBOR_DISABLE_TAGS is defined.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001314 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001315 * This decodes the most primitive/atomic data item. It does no
1316 * combining of data items.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001317 */
1318static QCBORError
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001319QCBOR_Private_DecodeAtomicDataItem(QCBORDecodeContext *pMe,
1320 const bool bAllocateStrings,
1321 QCBORItem *pDecodedItem)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001322{
1323 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001324 int nMajorType = 0;
1325 uint64_t uArgument = 0;
1326 int nAdditionalInfo = 0;
1327
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001328 /* Decode the "head" that every CBOR item has into the major type,
1329 * argument and the additional info.
1330 */
1331 uReturn = QCBOR_Private_DecodeHead(&(pMe->InBuf), &nMajorType, &uArgument, &nAdditionalInfo);
1332 if(uReturn != QCBOR_SUCCESS) {
1333 return uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001334 }
1335
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001336 memset(pDecodedItem, 0, sizeof(QCBORItem));
1337
1338 /* All the functions below get inlined by the optimizer. This code
1339 * is easier to read with them all being similar functions, even if
1340 * some functions don't do much.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001341 */
1342 switch (nMajorType) {
1343 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1344 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001345 return QCBOR_Private_DecodeInteger(nMajorType, uArgument, nAdditionalInfo, pDecodedItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001346 break;
1347
1348 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1349 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001350 return QCBOR_Private_DecodeString(pMe, bAllocateStrings, nMajorType, uArgument, nAdditionalInfo, pDecodedItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001351 break;
1352
1353 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1354 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001355 return QCBOR_Private_DecodeArrayOrMap(pMe->uDecodeMode, nMajorType, uArgument, nAdditionalInfo, pDecodedItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001356 break;
1357
1358 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001359 return QCBOR_Private_DecodeTag(uArgument, nAdditionalInfo, pDecodedItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001360 break;
1361
1362 case CBOR_MAJOR_TYPE_SIMPLE:
1363 /* Major type 7: float, double, true, false, null... */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001364 return QCBOR_Private_DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001365 break;
1366
1367 default:
1368 /* Never happens because DecodeHead() should never return > 7 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001369 return QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001370 break;
1371 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001372}
1373
1374
1375/**
1376 * @brief Process indefinite-length strings (decode layer 5).
1377 *
1378 * @param[in] pMe Decoder context
1379 * @param[out] pDecodedItem The decoded item that work is done on.
1380 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001381 * @retval QCBOR_ERR_UNSUPPORTED Encountered unsupported/reserved
1382 * features
1383 * @retval QCBOR_ERR_HIT_END Unexpected end of input
1384 * @retval QCBOR_ERR_INT_OVERFLOW Too-large negative encountered
1385 * @retval QCBOR_ERR_STRING_ALLOCATE Out of memory.
1386 * @retval QCBOR_ERR_STRING_TOO_LONG String longer than SIZE_MAX - 4.
1387 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED Half-precision in input, but decode
1388 * of half-precision disabled
1389 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point in input, but all
1390 * float decode is disabled.
1391 * @retval QCBOR_ERR_BAD_TYPE_7 Not-allowed representation of
1392 * simple type in input.
1393 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED Indefinite length map/array
1394 * in input, but indefinite
1395 * lengths disabled.
1396 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR Indefinite-length string in input,
1397 * but no string allocator.
1398 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK Error in indefinite-length string.
1399 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED Indefinite-length string in
1400 * input, but indefinite-length
1401 * strings are disabled.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001402 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001403 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001404 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001405 * If it is, this loops getting the subsequent chunk data items that
1406 * make up the string. The string allocator is used to make a
1407 * contiguous buffer for the chunks. When this completes @c
1408 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001409 *
1410 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001411 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001412static QCBORError
1413QCBORDecode_Private_GetNextFullString(QCBORDecodeContext *pMe,
1414 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001415{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001416 /* Aproximate stack usage
1417 * 64-bit 32-bit
1418 * local vars 32 16
1419 * 2 UsefulBufs 32 16
1420 * QCBORItem 56 52
1421 * TOTAL 120 74
1422 */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001423 QCBORError uReturn;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001424
1425 /* A note about string allocation -- Memory for strings is
1426 * allocated either because 1) indefinte-length string chunks are
1427 * being coalecsed or 2) caller has requested all strings be
1428 * allocated. The first case is handed below here. The second case
1429 * is handled in DecodeString if the bAllocate is true. That
1430 * boolean originates here with pMe->bStringAllocateAll immediately
1431 * below. That is, QCBOR_Private_DecodeAtomicDataItem() is called
1432 * in two different contexts here 1) main-line processing which is
1433 * where definite-length strings need to be allocated if
1434 * bStringAllocateAll is true and 2) processing chunks of
1435 * indefinite-lengths strings in in which case there must be no
1436 * allocation.
1437 */
1438
1439
1440 uReturn = QCBOR_Private_DecodeAtomicDataItem(pMe, pMe->bStringAllocateAll, pDecodedItem);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001441 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001442 goto Done;
1443 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001444
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001445
1446 /* This is where out-of-place break is detected for the whole
1447 * decoding stack. Break is an error for everything that calls
1448 * QCBORDecode_Private_GetNextFullString(), so the check is
1449 * centralized here.
1450 */
1451 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1452 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001453 goto Done;
1454 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001455
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001456
1457 /* Skip out if not an indefinite-length string */
1458 const uint8_t uStringType = pDecodedItem->uDataType;
1459 if(uStringType != QCBOR_TYPE_BYTE_STRING &&
1460 uStringType != QCBOR_TYPE_TEXT_STRING) {
1461 goto Done;
1462 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001463 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1464 goto Done;
1465 }
1466
1467#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001468 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001469 if(!pMe->StringAllocator.pfAllocator) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001470 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1471 goto Done;
1472 }
1473
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001474 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001475 UsefulBufC FullString = NULLUsefulBufC;
1476
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001477 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001478 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001479 QCBORItem StringChunkItem;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001480 /* Pass false to DecodeAtomicDataItem() because the individual
1481 * string chunks in an indefinite-length must not be
1482 * allocated. They are always copied into the allocated
1483 * contiguous buffer allocated here.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001484 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001485 uReturn = QCBOR_Private_DecodeAtomicDataItem(pMe, false, &StringChunkItem);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001486 if(uReturn) {
1487 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001488 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001489
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001490 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001491 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001492 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001493 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301494 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001495 break;
1496 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001497
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001498 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001499 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001500 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001501 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001502 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001503 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001504 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1505 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001506 break;
1507 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001508
David Navarro9123e5b2022-03-28 16:04:03 +02001509 if (StringChunkItem.val.string.len > 0) {
1510 /* The first time throurgh FullString.ptr is NULL and this is
1511 * equivalent to StringAllocator_Allocate(). Subsequently it is
1512 * not NULL and a reallocation happens.
1513 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001514 UsefulBuf NewMem = StringAllocator_Reallocate(&(pMe->StringAllocator),
David Navarro9123e5b2022-03-28 16:04:03 +02001515 FullString.ptr,
1516 FullString.len + StringChunkItem.val.string.len);
David Navarro9123e5b2022-03-28 16:04:03 +02001517 if(UsefulBuf_IsNULL(NewMem)) {
1518 uReturn = QCBOR_ERR_STRING_ALLOCATE;
1519 break;
1520 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001521
David Navarro9123e5b2022-03-28 16:04:03 +02001522 /* Copy new string chunk to the end of accumulated string */
1523 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001524 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001525 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001526
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001527 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1528 /* Getting the item failed, clean up the allocated memory */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001529 StringAllocator_Free(&(pMe->StringAllocator), FullString.ptr);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001530 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001531#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1532 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1533#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001534
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001535Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001536 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001537}
1538
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001539
Laurence Lundblade37286c02022-09-03 10:05:02 -07001540#ifndef QCBOR_DISABLE_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001541/**
1542 * @brief This converts a tag number to a shorter mapped value for storage.
1543 *
1544 * @param[in] pMe The decode context.
1545 * @param[in] uUnMappedTag The tag number to map
1546 * @param[out] puMappedTagNumer The stored tag number.
1547 *
1548 * @return error code.
1549 *
1550 * The main point of mapping tag numbers is make QCBORItem
1551 * smaller. With this mapping storage of 4 tags takes up 8
1552 * bytes. Without, it would take up 32 bytes.
1553 *
1554 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1555 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1556 *
1557 * See also UnMapTagNumber() and @ref QCBORItem.
1558 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001559static QCBORError
1560QCBORDecode_Private_MapTagNumber(QCBORDecodeContext *pMe,
1561 const uint64_t uUnMappedTag,
1562 uint16_t *puMappedTagNumer)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001563{
1564 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1565 unsigned uTagMapIndex;
1566 /* Is there room in the tag map, or is it in it already? */
1567 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1568 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1569 break;
1570 }
1571 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1572 break;
1573 }
1574 }
1575 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1576 return QCBOR_ERR_TOO_MANY_TAGS;
1577 }
1578
1579 /* Covers the cases where tag is new and were it is already in the map */
1580 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1581 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1582
1583 } else {
1584 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1585 }
1586
1587 return QCBOR_SUCCESS;
1588}
1589
1590
1591/**
1592 * @brief This converts a mapped tag number to the actual tag number.
1593 *
1594 * @param[in] pMe The decode context.
1595 * @param[in] uMappedTagNumber The stored tag number.
1596 *
1597 * @return The actual tag number is returned or
1598 * @ref CBOR_TAG_INVALID64 on error.
1599 *
1600 * This is the reverse of MapTagNumber()
1601 */
1602static uint64_t
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001603QCBORDecode_Private_UnMapTagNumber(const QCBORDecodeContext *pMe,
1604 const uint16_t uMappedTagNumber)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001605{
1606 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1607 return uMappedTagNumber;
1608 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001609 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001610 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001611 /* This won't be negative because of code below in
1612 * MapTagNumber()
1613 */
1614 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1615 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001616 }
1617}
Laurence Lundblade37286c02022-09-03 10:05:02 -07001618#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001619
Laurence Lundblade9b334962020-08-27 10:55:53 -07001620
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001621/**
1622 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1623 *
1624 * @param[in] pMe Decoder context
1625 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001626 *
1627 * @retval QCBOR_ERR_UNSUPPORTED Encountered unsupported/reserved
1628 * features
1629 * @retval QCBOR_ERR_HIT_END Unexpected end of input
1630 * @retval QCBOR_ERR_INT_OVERFLOW Too-large negative encountered
1631 * @retval QCBOR_ERR_STRING_ALLOCATE Out of memory.
1632 * @retval QCBOR_ERR_STRING_TOO_LONG String longer than SIZE_MAX - 4.
1633 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED Half-precision in input, but decode
1634 * of half-precision disabled
1635 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point in input, but all
1636 * float decode is disabled.
1637 * @retval QCBOR_ERR_BAD_TYPE_7 Not-allowed representation of
1638 * simple type in input.
1639 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED Indefinite length map/array
1640 * in input, but indefinite
1641 * lengths disabled.
1642 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR Indefinite-length string in input,
1643 * but no string allocator.
1644 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK Error in indefinite-length string.
1645 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED Indefinite-length string in
1646 * input, but indefinite-length
1647 * strings are disabled.
1648 * @retval QCBOR_ERR_TOO_MANY_TAGS Too many tag numbers on item.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001649 *
1650 * This loops getting atomic data items until one is not a tag
1651 * number. Usually this is largely pass-through because most
1652 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001653 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001654static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001655QCBORDecode_Private_GetNextTagNumber(QCBORDecodeContext *pMe,
1656 QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001657{
Laurence Lundblade37286c02022-09-03 10:05:02 -07001658#ifndef QCBOR_DISABLE_TAGS
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001659 /* Accummulate the tags from multiple items here and then copy them
1660 * into the last item, the non-tag item.
1661 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001662 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1663
1664 /* Initialize to CBOR_TAG_INVALID16 */
1665 #if CBOR_TAG_INVALID16 != 0xffff
1666 /* Be sure the memset does the right thing. */
1667 #err CBOR_TAG_INVALID16 tag not defined as expected
1668 #endif
1669 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001670
Laurence Lundblade9b334962020-08-27 10:55:53 -07001671 QCBORError uReturn = QCBOR_SUCCESS;
1672
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001673 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001674 for(;;) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001675 QCBORError uErr = QCBORDecode_Private_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001676 if(uErr != QCBOR_SUCCESS) {
1677 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001678 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001679 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001680
Laurence Lundblade9b334962020-08-27 10:55:53 -07001681 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001682 /* Successful exit from loop; maybe got some tags, maybe not */
1683 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001684 break;
1685 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001686
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001687 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1688 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001689 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001690 /* Continue on to get all tags wrapping this item even though
1691 * it is erroring out in the end. This allows decoding to
1692 * continue. This is a resource limit error, not a problem
1693 * with being well-formed CBOR.
1694 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001695 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001696 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001697 /* Slide tags over one in the array to make room at index 0.
1698 * Must use memmove because the move source and destination
1699 * overlap.
1700 */
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001701 memmove(&auItemsTags[1],
1702 auItemsTags,
1703 sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001704
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001705 /* Map the tag */
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001706 uint16_t uMappedTagNumber = 0;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001707 uReturn = QCBORDecode_Private_MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumber);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001708 /* Continue even on error so as to consume all tags wrapping
1709 * this data item so decoding can go on. If MapTagNumber()
1710 * errors once it will continue to error.
1711 */
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001712 auItemsTags[0] = uMappedTagNumber;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001713 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001714
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001715Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001716 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001717
Laurence Lundblade37286c02022-09-03 10:05:02 -07001718#else /* QCBOR_DISABLE_TAGS */
1719
Laurence Lundblade0f01ac62024-02-18 23:07:07 -07001720 return QCBORDecode_Private_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade37286c02022-09-03 10:05:02 -07001721
1722#endif /* QCBOR_DISABLE_TAGS */
1723}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001724
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001725
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001726/**
1727 * @brief Combine a map entry label and value into one item (decode layer 3).
1728 *
1729 * @param[in] pMe Decoder context
1730 * @param[out] pDecodedItem The decoded item that work is done on.
1731 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001732 * @retval QCBOR_ERR_UNSUPPORTED Encountered unsupported/reserved
1733 * features
1734 * @retval QCBOR_ERR_HIT_END Unexpected end of input
1735 * @retval QCBOR_ERR_INT_OVERFLOW Too-large negative encountered
1736 * @retval QCBOR_ERR_STRING_ALLOCATE Out of memory.
1737 * @retval QCBOR_ERR_STRING_TOO_LONG String longer than SIZE_MAX - 4.
1738 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED Half-precision in input, but decode
1739 * of half-precision disabled
1740 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point in input, but all
1741 * float decode is disabled.
1742 * @retval QCBOR_ERR_BAD_TYPE_7 Not-allowed representation of
1743 * simple type in input.
1744 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED Indefinite length map/array
1745 * in input, but indefinite
1746 * lengths disabled.
1747 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR Indefinite-length string in input,
1748 * but no string allocator.
1749 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK Error in indefinite-length string.
1750 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED Indefinite-length string in
1751 * input, but indefinite-length
1752 * strings are disabled.
1753 * @retval QCBOR_ERR_TOO_MANY_TAGS Too many tag numbers on item.
1754 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG Too many items in array.
1755 * @retval QCBOR_ERR_MAP_LABEL_TYPE Map label not string or integer.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001756 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001757 * If the current nesting level is a map, then this combines pairs of
1758 * items into one data item with a label and value.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001759 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001760 * This is passthrough if the current nesting level is not a map.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001761 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001762 * This also implements maps-as-array mode where a map is treated like
1763 * an array to allow caller to do their own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001764 */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001765
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001766static QCBORError
1767QCBORDecode_Private_GetNextMapEntry(QCBORDecodeContext *pMe,
1768 QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001769{
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001770 QCBORItem LabelItem;
1771 QCBORError uErr;
1772
1773 uErr = QCBORDecode_Private_GetNextTagNumber(pMe, pDecodedItem);
1774 if(QCBORDecode_IsUnrecoverableError(uErr)) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001775 goto Done;
1776 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001777
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001778 if(!DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1779 /* Not decoding a map. Nothing to do. */
1780 /* When decoding maps-as-arrays, the type will be
1781 * QCBOR_TYPE_MAP_AS_ARRAY and this function will exit
1782 * here. This is now map processing for maps-as-arrays is not
1783 * done. */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001784 goto Done;
1785 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001786
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001787 /* Decoding a map entry, so the item decoded above was the label */
1788 LabelItem = *pDecodedItem;
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001789
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001790 /* Get the value of the map item */
1791 uErr = QCBORDecode_Private_GetNextTagNumber(pMe, pDecodedItem);
1792 if(QCBORDecode_IsUnrecoverableError(uErr)) {
1793 goto Done;
1794 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001795
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001796 /* Combine the label item and value item into one */
1797 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1798 pDecodedItem->uLabelType = LabelItem.uDataType;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001799
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001800#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
1801 /* QCBOR_DECODE_MODE_MAP_STRINGS_ONLY might have been a bad idea. Maybe
1802 * get rid of it in QCBOR 2.0
1803 */
1804 if(pMe->uDecodeMode == QCBOR_DECODE_MODE_MAP_STRINGS_ONLY &&
1805 LabelItem.uDataType != QCBOR_TYPE_TEXT_STRING) {
1806 uErr = QCBOR_ERR_MAP_LABEL_TYPE;
1807 goto Done;
1808 }
1809#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
1810
1811 switch(LabelItem.uDataType) {
1812 case QCBOR_TYPE_INT64:
1813 pDecodedItem->label.int64 = LabelItem.val.int64;
1814 break;
1815
1816#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
1817 case QCBOR_TYPE_UINT64:
1818 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1819 break;
1820
1821 case QCBOR_TYPE_TEXT_STRING:
1822 case QCBOR_TYPE_BYTE_STRING:
1823 pDecodedItem->label.string = LabelItem.val.string;
1824 break;
1825#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
1826
1827 default:
1828 uErr = QCBOR_ERR_MAP_LABEL_TYPE;
1829 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001830 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001831
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001832Done:
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001833 return uErr;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001834}
1835
1836
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001837#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001838/**
1839 * @brief Peek and see if next data item is a break;
1840 *
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001841 * param[in] pUIB UsefulInputBuf to read from.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001842 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1843 *
1844 * @return Any decoding error.
1845 *
1846 * See if next item is a CBOR break. If it is, it is consumed,
1847 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001848*/
Laurence Lundblade8e36f812024-01-26 10:59:29 -07001849static QCBORError
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001850QCBOR_Private_NextIsBreak(QCBORDecodeContext *pMe, bool *pbNextIsBreak)
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001851{
1852 *pbNextIsBreak = false;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001853 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001854 QCBORItem Peek;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001855 size_t uPeek = UsefulInputBuf_Tell(&(pMe->InBuf));
1856 QCBORError uReturn = QCBOR_Private_DecodeAtomicDataItem(pMe, false, &Peek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001857 if(uReturn != QCBOR_SUCCESS) {
1858 return uReturn;
1859 }
1860 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001861 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001862 UsefulInputBuf_Seek(&(pMe->InBuf), uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001863 } else {
1864 *pbNextIsBreak = true;
1865 }
1866 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001867
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001868 return QCBOR_SUCCESS;
1869}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001870#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001871
1872
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001873/**
1874 * @brief Ascend up nesting levels if all items in them have been consumed.
1875 *
1876 * @param[in] pMe The decode context.
1877 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07001878 * @param[out] pbBreak Set to true if extra break was consumed.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001879 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001880 * An item was just consumed, now figure out if it was the
1881 * end of an array/map map that can be closed out. That
1882 * may in turn close out the above array/map...
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07001883 *
1884 * When ascending indefinite-length arrays and maps, this will correctly
1885 * consume the break for the level above. This is a problem for the
1886 * implementation of QCBORDecode_GetArray() that must not return
1887 * that break. @c pbBreak is set to true to indicate that one
1888 * byte should be removed.
1889 *
1890 * Improvement: this could reduced further if indef is disabled
1891 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001892static QCBORError
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07001893QCBORDecode_Private_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd, bool *pbBreak)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001894{
1895 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001896
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001897 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001898 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07001899 if(pbBreak) {
1900 *pbBreak = false;
1901 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001902
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001903 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1904 /* Nesting level is bstr-wrapped CBOR */
1905
1906 /* Ascent for bstr-wrapped CBOR is always by explicit call
1907 * so no further ascending can happen.
1908 */
1909 break;
1910
1911 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1912 /* Level is a definite-length array/map */
1913
1914 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001915 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1916 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001917 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001918 break;
1919 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001920 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001921 * is time to ascend one level. This happens below.
1922 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001923
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001924#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001925 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001926 /* Level is an indefinite-length array/map. */
1927
1928 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001929 bool bIsBreak = false;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07001930 uReturn = QCBOR_Private_NextIsBreak(pMe, &bIsBreak);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001931 if(uReturn != QCBOR_SUCCESS) {
1932 goto Done;
1933 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001934
1935 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001936 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001937 break;
1938 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001939
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001940 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001941 * it is time to ascend one level.
1942 */
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07001943 if(pbBreak) {
1944 *pbBreak = true;
1945 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001946
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001947#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001948 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001949
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001950
1951 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001952
Laurence Lundblade93d89472020-10-03 22:30:50 -07001953 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001954 * QCBORDecode_ExitBoundedMode().
1955 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001956 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001957 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001958 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001959 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001960 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001961 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001962
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001963 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001964 break;
1965 }
1966
1967 /* Finally, actually ascend one level. */
1968 DecodeNesting_Ascend(&(pMe->nesting));
1969 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001970
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001971 uReturn = QCBOR_SUCCESS;
1972
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001973#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001974Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001975#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1976
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001977 return uReturn;
1978}
1979
1980
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001981/**
1982 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1983 *
1984 * @param[in] pMe Decoder context
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07001985 * @param[out] pbBreak Set to true if extra break was consumed.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001986 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07001987
1988 * @retval QCBOR_ERR_UNSUPPORTED Encountered unsupported/reserved
1989 * features
1990 * @retval QCBOR_ERR_HIT_END Unexpected end of input
1991 * @retval QCBOR_ERR_INT_OVERFLOW Too-large negative encountered
1992 * @retval QCBOR_ERR_STRING_ALLOCATE Out of memory.
1993 * @retval QCBOR_ERR_STRING_TOO_LONG String longer than SIZE_MAX - 4.
1994 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED Half-precision in input, but decode
1995 * of half-precision disabled
1996 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point in input, but all
1997 * float decode is disabled.
1998 * @retval QCBOR_ERR_BAD_TYPE_7 Not-allowed representation of
1999 * simple type in input.
2000 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED Indefinite length map/array
2001 * in input, but indefinite
2002 * lengths disabled.
2003 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR Indefinite-length string in input,
2004 * but no string allocator.
2005 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK Error in indefinite-length string.
2006 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED Indefinite-length string in
2007 * input, but indefinite-length
2008 * strings are disabled.
2009 * @retval QCBOR_ERR_TOO_MANY_TAGS Too many tag numbers on item.
2010 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG Too many items in array.
2011 * @retval QCBOR_ERR_MAP_LABEL_TYPE Map label not string or integer.
2012 * @retval QCBOR_ERR_NO_MORE_ITEMS Need more items for map or array.
2013 * @retval QCBOR_ERR_BAD_BREAK Indefinite-length break in wrong
2014 * place.
2015 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP Nesting deeper than QCBOR
2016 * can handle.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002017 *
2018 * This handles the traversal descending into and asecnding out of
2019 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
2020 * definite- and indefinte-length maps and arrays by looking at the
2021 * item count or finding CBOR breaks. It detects the ends of the
2022 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002023 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002024static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002025QCBORDecode_Private_GetNextMapOrArray(QCBORDecodeContext *pMe,
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07002026 bool *pbBreak,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002027 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002028{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002029 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07002030 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002031
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002032 /* If out of bytes to consume, it is either the end of the
2033 * top-level sequence of some bstr-wrapped CBOR that was entered.
2034 *
2035 * In the case of bstr-wrapped CBOR, the length of the
2036 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
2037 * the bstr-wrapped CBOR is exited, the length is set back to the
2038 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07002039 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002040 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002041 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07002042 goto Done;
2043 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07002044
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002045 /* Check to see if at the end of a bounded definite-length map or
2046 * array. The check for a break ending indefinite-length array is
2047 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002048 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002049 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002050 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07002051 goto Done;
2052 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07002053
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08002054 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002055 uReturn = QCBORDecode_Private_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002056 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
2057 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002058 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002059 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05302060
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002061 /* Record the nesting level for this data item before processing
2062 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07002063 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002064 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002065
Laurence Lundblade642282a2020-06-23 12:00:33 -07002066
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07002067 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002068 if(QCBORItem_IsMapOrArray(*pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002069 /* If the new item is a map or array, descend.
2070 *
2071 * Empty indefinite-length maps and arrays are descended into,
2072 * but then ascended out of in the next chunk of code.
2073 *
2074 * Maps and arrays do count as items in the map/array that
2075 * encloses them so a decrement needs to be done for them too,
2076 * but that is done only when all the items in them have been
2077 * processed, not when they are opened with the exception of an
2078 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07002079 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002080 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002081 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07002082 pDecodedItem->uDataType,
2083 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002084 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002085 /* This error is probably a traversal error and it overrides
2086 * the non-traversal error.
2087 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002088 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002089 goto Done;
2090 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07002091 }
2092
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002093 if(!QCBORItem_IsMapOrArray(*pDecodedItem) ||
2094 QCBORItem_IsEmptyDefiniteLengthMapOrArray(*pDecodedItem) ||
2095 QCBORItem_IsIndefiniteLengthMapOrArray(*pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002096 /* The following cases are handled here:
2097 * - A non-aggregate item like an integer or string
2098 * - An empty definite-length map or array
2099 * - An indefinite-length map or array that might be empty or might not.
2100 *
2101 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
2102 * for an definite-length map/array and break detection for an
2103 * indefinite-0length map/array. If the end of the map/array was
2104 * reached, then it ascends nesting levels, possibly all the way
2105 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002106 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002107 QCBORError uAscendErr;
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07002108 uAscendErr = QCBORDecode_Private_NestLevelAscender(pMe, true, pbBreak);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002109 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002110 /* This error is probably a traversal error and it overrides
2111 * the non-traversal error.
2112 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002113 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002114 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07002115 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05302116 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002117
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07002118 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002119 /* Tell the caller what level is next. This tells them what
2120 * maps/arrays were closed out and makes it possible for them to
2121 * reconstruct the tree with just the information returned in a
2122 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07002123 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002124 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07002125 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002126 pDecodedItem->uNextNestLevel = 0;
2127 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002128 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002129 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002130
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002131Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002132 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002133}
2134
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002135
Laurence Lundblade37286c02022-09-03 10:05:02 -07002136#ifndef QCBOR_DISABLE_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002137/**
2138 * @brief Shift 0th tag out of the tag list.
2139 *
2140 * pDecodedItem[in,out] The data item to convert.
2141 *
2142 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
2143 * shifted into empty slot at the end of the tag list.
2144 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002145static void
2146QCBOR_Private_ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07002147{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002148 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
2149 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
2150 }
2151 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002152}
Laurence Lundblade37286c02022-09-03 10:05:02 -07002153#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002154
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07002155
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002156/**
2157 * @brief Convert different epoch date formats in to the QCBOR epoch date format
2158 *
2159 * pDecodedItem[in,out] The data item to convert.
2160 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07002161 * @retval QCBOR_ERR_DATE_OVERFLOW 65-bit negative integer.
2162 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED Float-point date in input,
2163 * floating-point date disabled.
2164 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point date in input,
2165 * all floating-point disabled.
2166 * @retval QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT Unexpected and unrecoverable
2167 * error decoding date.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002168 *
2169 * The epoch date tag defined in QCBOR allows for floating-point
2170 * dates. It even allows a protocol to flop between date formats when
2171 * ever it wants. Floating-point dates aren't that useful as they are
2172 * only needed for dates beyond the age of the earth.
2173 *
2174 * This converts all the date formats into one format of an unsigned
2175 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002176 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002177static QCBORError
2178QCBOR_Private_DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002179{
Laurence Lundbladec7114722020-08-13 05:11:40 -07002180 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002181
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02002182#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade59289e52019-12-30 13:44:37 -08002183 pDecodedItem->val.epochDate.fSecondsFraction = 0;
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02002184#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002185
2186 switch (pDecodedItem->uDataType) {
2187
2188 case QCBOR_TYPE_INT64:
2189 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
2190 break;
2191
2192 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002193 /* This only happens for CBOR type 0 > INT64_MAX so it is
2194 * always an overflow.
2195 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07002196 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2197 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002198 break;
2199
2200 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07002201 case QCBOR_TYPE_FLOAT:
2202#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08002203 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002204 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07002205 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002206 pDecodedItem->val.dfnum :
2207 (double)pDecodedItem->val.fnum;
2208
2209 /* The conversion from float to integer requires overflow
2210 * detection since floats can be much larger than integers.
2211 * This implementation errors out on these large float values
2212 * since they are beyond the age of the earth.
2213 *
2214 * These constants for the overflow check are computed by the
2215 * compiler. They are not computed at run time.
2216 *
2217 * The factor of 0x7ff is added/subtracted to avoid a
2218 * rounding error in the wrong direction when the compiler
Laurence Lundblade16a207a2021-09-18 17:22:46 -07002219 * computes these constants. There is rounding because a
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002220 * 64-bit integer has 63 bits of precision where a double
2221 * only has 53 bits. Without the 0x7ff factor, the compiler
2222 * may round up and produce a double for the bounds check
2223 * that is larger than can be stored in a 64-bit integer. The
2224 * amount of 0x7ff is picked because it has 11 bits set.
2225 *
2226 * Without the 0x7ff there is a ~30 minute range of time
2227 * values 10 billion years in the past and in the future
Laurence Lundblade16a207a2021-09-18 17:22:46 -07002228 * where this code could go wrong. Some compilers
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002229 * generate a warning or error without the 0x7ff.
2230 */
2231 const double dDateMax = (double)(INT64_MAX - 0x7ff);
2232 const double dDateMin = (double)(INT64_MIN + 0x7ff);
2233
2234 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07002235 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002236 goto Done;
2237 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002238
2239 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002240 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07002241 pDecodedItem->val.epochDate.fSecondsFraction =
2242 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002243 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002244#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07002245
Laurence Lundblade16a207a2021-09-18 17:22:46 -07002246 uReturn = QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07002247 goto Done;
2248
Laurence Lundblade9682a532020-06-06 18:33:04 -07002249#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002250 break;
2251
2252 default:
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07002253 /* It's the arrays and maps that are unrecoverable because
2254 * they are not consumed here. Since this is just an error
2255 * condition, no extra code is added here to make the error
2256 * recoverable for non-arrays and maps like strings. */
2257 uReturn = QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002258 goto Done;
2259 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002260
Laurence Lundblade59289e52019-12-30 13:44:37 -08002261 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
2262
2263Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07002264 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002265}
2266
2267
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002268/**
2269 * @brief Convert the days epoch date.
2270 *
2271 * pDecodedItem[in,out] The data item to convert.
2272 *
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07002273 * @retval QCBOR_ERR_DATE_OVERFLOW 65-bit negative integer.
2274 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED Float-point date in input,
2275 * floating-point date disabled.
2276 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED Float-point date in input,
2277 * all floating-point disabled.
2278 * @retval QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT Unexpected and unrecoverable
2279 * error decoding date.
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002280 *
2281 * This is much simpler than the other epoch date format because
2282 * floating-porint is not allowed. This is mostly a simple type check.
2283 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002284static QCBORError
2285QCBOR_Private_DecodeDaysEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002286{
2287 QCBORError uReturn = QCBOR_SUCCESS;
2288
2289 switch (pDecodedItem->uDataType) {
2290
2291 case QCBOR_TYPE_INT64:
2292 pDecodedItem->val.epochDays = pDecodedItem->val.int64;
2293 break;
2294
2295 case QCBOR_TYPE_UINT64:
2296 /* This only happens for CBOR type 0 > INT64_MAX so it is
2297 * always an overflow.
2298 */
2299 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2300 goto Done;
2301 break;
2302
2303 default:
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07002304 /* It's the arrays and maps that are unrecoverable because
2305 * they are not consumed here. Since this is just an error
2306 * condition, no extra code is added here to make the error
2307 * recoverable for non-arrays and maps like strings. */
2308 uReturn = QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT;
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002309 goto Done;
2310 break;
2311 }
2312
2313 pDecodedItem->uDataType = QCBOR_TYPE_DAYS_EPOCH;
2314
2315Done:
2316 return uReturn;
2317}
2318
2319
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002320#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade37286c02022-09-03 10:05:02 -07002321
2322/* Forward declaration is necessary for
2323 * QCBORDecode_MantissaAndExponent(). to be able to decode bignum
2324 * tags in the mantissa. If the mantissa is a decimal fraction or big
2325 * float in error, this will result in a recurive call to
2326 * QCBORDecode_MantissaAndExponent(), but the recursion will unwined
2327 * correctly and the correct error is returned.
2328 */
2329static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002330QCBORDecode_Private_GetNextTagContent(QCBORDecodeContext *pMe,
2331 QCBORItem *pDecodedItem);
Laurence Lundblade37286c02022-09-03 10:05:02 -07002332
2333
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002334/**
2335 * @brief Decode decimal fractions and big floats.
2336 *
2337 * @param[in] pMe The decode context.
2338 * @param[in,out] pDecodedItem On input the array data item that
2339 * holds the mantissa and exponent. On
2340 * output the decoded mantissa and
2341 * exponent.
2342 *
2343 * @returns Decoding errors from getting primitive data items or
2344 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2345 *
Laurence Lundblade37286c02022-09-03 10:05:02 -07002346 * When called pDecodedItem must be the array with two members, the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 * exponent and mantissa.
2348 *
2349 * This will fetch and decode the exponent and mantissa and put the
2350 * result back into pDecodedItem.
Laurence Lundblade37286c02022-09-03 10:05:02 -07002351 *
2352 * This does no checking or processing of tag numbers. That is to be
2353 * done by the code that calls this.
2354 *
2355 * This stuffs the type of the mantissa into pDecodedItem with the expectation
2356 * the caller will process it.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002357 */
Laurence Lundblade37286c02022-09-03 10:05:02 -07002358static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002359QCBORDecode_Private_ExpMantissa(QCBORDecodeContext *pMe,
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002360 QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002361{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002362 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002363
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002364 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002365 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002366 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002367 goto Done;
2368 }
2369
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002370 /* A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002371 * definite-length arrays, but not for indefinite. Instead remember
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002372 * the nesting level the two integers must be at, which is one
2373 * deeper than that of the array.
2374 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002375 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2376
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002377 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002378 QCBORItem exponentItem;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002379 uReturn = QCBORDecode_GetNext(pMe, &exponentItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002380 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002381 goto Done;
2382 }
2383 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002384 /* Array is empty or a map/array encountered when expecting an int */
2385 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002386 goto Done;
2387 }
2388 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002389 /* Data arriving as an unsigned int < INT64_MAX has been
2390 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2391 * also means that the only data arriving here of type
2392 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2393 * and thus an error that will get handled in the next else.
2394 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002395 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2396 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002397 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2398 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002399 goto Done;
2400 }
2401
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002402 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002403 QCBORItem mantissaItem;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002404 uReturn = QCBORDecode_GetNext(pMe, &mantissaItem);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002405 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002406 goto Done;
2407 }
2408 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002409 /* Mantissa missing or map/array encountered when expecting number */
2410 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002411 goto Done;
2412 }
Laurence Lundblade37286c02022-09-03 10:05:02 -07002413 /* Stuff the mantissa data type into the item to send it up to the
2414 * the next level. */
2415 pDecodedItem->uDataType = mantissaItem.uDataType;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002416 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002417 /* Data arriving as an unsigned int < INT64_MAX has been
2418 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2419 * also means that the only data arriving here of type
2420 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2421 * and thus an error that will get handled in an else below.
2422 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002423 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade37286c02022-09-03 10:05:02 -07002424#ifndef QCBOR_DISABLE_TAGS
2425 /* With tags fully disabled a big number mantissa will error out
2426 * in the call to QCBORDecode_GetNextWithTags() because it has
2427 * a tag number.
2428 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07002429 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2430 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002431 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002432 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade37286c02022-09-03 10:05:02 -07002433#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002434 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002435 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2436 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002437 goto Done;
2438 }
2439
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002440 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002441 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002442 /* Extra items in the decimal fraction / big float */
Laurence Lundblade37286c02022-09-03 10:05:02 -07002443 /* Improvement: this should probably be an unrecoverable error. */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002444 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002445 goto Done;
2446 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002447 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002448
2449Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002450 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002451}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002452#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002453
2454
Laurence Lundblade37286c02022-09-03 10:05:02 -07002455#ifndef QCBOR_DISABLE_TAGS
2456
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002457#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002458/**
2459 * @brief Decode the MIME type tag
2460 *
2461 * @param[in,out] pDecodedItem The item to decode.
2462 *
2463 * Handle the text and binary MIME type tags. Slightly too complicated
2464 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2465 * incorreclty text-only.
2466 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002467static QCBORError
2468QCBOR_Private_DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002469{
2470 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2471 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002472 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002473 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2474 } else {
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07002475 /* It's the arrays and maps that are unrecoverable because
2476 * they are not consumed here. Since this is just an error
2477 * condition, no extra code is added here to make the error
2478 * recoverable for non-arrays and maps like strings. */
2479 return QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002480 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002481
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002482 return QCBOR_SUCCESS;
2483}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002484#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002485
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002486/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002487 * Table of CBOR tags whose content is either a text string or a byte
2488 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2489 * of uQCBORtype indicates the content should be a byte string rather
2490 * than a text string
2491 */
2492struct StringTagMapEntry {
2493 uint16_t uTagNumber;
2494 uint8_t uQCBORtype;
2495};
2496
2497#define IS_BYTE_STRING_BIT 0x80
2498#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2499
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002500static const struct StringTagMapEntry QCBOR_Private_StringTagMap[] = {
Laurence Lundblade99615302020-11-29 11:19:47 -08002501 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002502 {CBOR_TAG_DAYS_STRING, QCBOR_TYPE_DAYS_STRING},
Laurence Lundblade99615302020-11-29 11:19:47 -08002503 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2504 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2505 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2506 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002507#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002508 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2509 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2510 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2511 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002512#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002513 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2514 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2515};
2516
2517
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002518/**
2519 * @brief Process standard CBOR tags whose content is a string
2520 *
2521 * @param[in] uTag The tag.
2522 * @param[in,out] pDecodedItem The data item.
2523 *
2524 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2525 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07002526 * \ref QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT if the content type was wrong for the tag.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002527 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002528 * Process the CBOR tags that whose content is a byte string or a text
2529 * string and for which the string is just passed on to the caller.
2530 *
2531 * This maps the CBOR tag to the QCBOR type and checks the content
2532 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002533 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002534 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002535 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002536static QCBORError
2537QCBOR_Private_ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002538{
Laurence Lundblade99615302020-11-29 11:19:47 -08002539 /* This only works on tags that were not mapped; no need for other yet */
2540 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2541 return QCBOR_ERR_UNSUPPORTED;
2542 }
2543
2544 unsigned uIndex;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002545 for(uIndex = 0; QCBOR_Private_StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2546 if(QCBOR_Private_StringTagMap[uIndex].uTagNumber == uTag) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002547 break;
2548 }
2549 }
2550
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002551 const uint8_t uQCBORType = QCBOR_Private_StringTagMap[uIndex].uQCBORtype;
Laurence Lundblade99615302020-11-29 11:19:47 -08002552 if(uQCBORType == QCBOR_TYPE_NONE) {
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002553 /* repurpose this error to mean not handled here */
Laurence Lundblade99615302020-11-29 11:19:47 -08002554 return QCBOR_ERR_UNSUPPORTED;
2555 }
2556
2557 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2558 if(uQCBORType & IS_BYTE_STRING_BIT) {
2559 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2560 }
2561
2562 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07002563 /* It's the arrays and maps that are unrecoverable because
2564 * they are not consumed here. Since this is just an error
2565 * condition, no extra code is added here to make the error
2566 * recoverable for non-arrays and maps like strings. */
2567 return QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002568 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002569
Laurence Lundblade99615302020-11-29 11:19:47 -08002570 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002571 return QCBOR_SUCCESS;
2572}
Laurence Lundblade37286c02022-09-03 10:05:02 -07002573#endif /* QCBOR_DISABLE_TAGS */
2574
2575
2576#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07002577/**
2578 * @brief Figures out data type for exponent mantissa tags.
2579 *
2580 * @param[in] uTagToProcess Either @ref CBOR_TAG_DECIMAL_FRACTION or
2581 * @ref CBOR_TAG_BIG_FLOAT.
2582 * @param[in] pDecodedItem Item being decoded.
2583 *
2584 * @returns One of the 6 values between \ref QCBOR_TYPE_DECIMAL_FRACTION
2585 * and @ref QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM.
2586 *
2587 * Does mapping between a CBOR tag number and a QCBOR type. with a
2588 * little bit of logic and arithmatic.
2589 *
2590 * Used in serveral contexts. Does the work where sometimes the data
2591 * item is explicitly tagged and sometimes not.
Laurence Lundblade37286c02022-09-03 10:05:02 -07002592 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002593static uint8_t
2594QCBOR_Private_ExpMantissaDataType(const uint16_t uTagToProcess,
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07002595 const QCBORItem *pDecodedItem)
Laurence Lundblade37286c02022-09-03 10:05:02 -07002596{
2597 uint8_t uBase = uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ?
2598 QCBOR_TYPE_DECIMAL_FRACTION :
2599 QCBOR_TYPE_BIGFLOAT;
2600 if(pDecodedItem->uDataType != QCBOR_TYPE_INT64) {
2601 uBase = (uint8_t)(uBase + pDecodedItem->uDataType - QCBOR_TYPE_POSBIGNUM + 1);
2602 }
2603 return uBase;
2604}
2605#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002606
2607
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002608/**
2609 * @brief Decode tag content for select tags (decoding layer 1).
2610 *
2611 * @param[in] pMe The decode context.
2612 * @param[out] pDecodedItem The decoded item.
2613 *
2614 * @return Decoding error code.
2615 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002616 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2617 * but the whole tag was not decoded. Here, the whole tags (tag number
2618 * and tag content) that are supported by QCBOR are decoded. This is a
2619 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002620 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002621static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002622QCBORDecode_Private_GetNextTagContent(QCBORDecodeContext *pMe,
2623 QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002624{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002625 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002626
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07002627 uReturn = QCBORDecode_Private_GetNextMapOrArray(pMe, NULL, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002628 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002629 goto Done;
2630 }
2631
Laurence Lundblade37286c02022-09-03 10:05:02 -07002632#ifndef QCBOR_DISABLE_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002633 /* When there are no tag numbers for the item, this exits first
2634 * thing and effectively does nothing.
2635 *
2636 * This loops over all the tag numbers accumulated for this item
2637 * trying to decode and interpret them. This stops at the end of
2638 * the list or at the first tag number that can't be interpreted by
2639 * this code. This is effectively a recursive processing of the
2640 * tags number list that handles nested tags.
2641 */
2642 while(1) {
2643 /* Don't bother to unmap tags via QCBORITem.uTags since this
2644 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2645 */
2646 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002647
Laurence Lundblade99615302020-11-29 11:19:47 -08002648 if(uTagToProcess == CBOR_TAG_INVALID16) {
2649 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002650 break;
2651
Laurence Lundblade99615302020-11-29 11:19:47 -08002652 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002653 uReturn = QCBOR_Private_DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002654
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002655 } else if(uTagToProcess == CBOR_TAG_DAYS_EPOCH) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002656 uReturn = QCBOR_Private_DecodeDaysEpoch(pDecodedItem);
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002657
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002658#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002659 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2660 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002661 uReturn = QCBORDecode_Private_ExpMantissa(pMe, pDecodedItem);
Laurence Lundblade37286c02022-09-03 10:05:02 -07002662 /* --- Which is it, decimal fraction or a bigfloat? --- */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002663 pDecodedItem->uDataType = QCBOR_Private_ExpMantissaDataType(uTagToProcess, pDecodedItem);
Laurence Lundblade37286c02022-09-03 10:05:02 -07002664
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002665#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002666#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002667 } else if(uTagToProcess == CBOR_TAG_MIME ||
2668 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002669 uReturn = QCBOR_Private_DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002670#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002671
Laurence Lundblade99615302020-11-29 11:19:47 -08002672 } else {
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01002673 /* See if it is a passthrough byte/text string tag; process if so */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002674 uReturn = QCBOR_Private_ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002675
Laurence Lundblade99615302020-11-29 11:19:47 -08002676 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01002677 /* It wasn't a passthrough byte/text string tag so it is
Laurence Lundblade99615302020-11-29 11:19:47 -08002678 * an unknown tag. This is the exit from the loop on the
2679 * first unknown tag. It is a successful exit.
2680 */
2681 uReturn = QCBOR_SUCCESS;
2682 break;
2683 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002684 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002685
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002686 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002687 /* Error exit from the loop */
2688 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002689 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002690
2691 /* A tag was successfully processed, shift it out of the list of
2692 * tags returned. This is the loop increment.
2693 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002694 QCBOR_Private_ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002695 }
Laurence Lundblade37286c02022-09-03 10:05:02 -07002696#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002697
2698Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002699 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002700}
2701
2702
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002703/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002704 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002705 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002706QCBORError
2707QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2708{
2709 QCBORError uErr;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002710 uErr = QCBORDecode_Private_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002711 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002712 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2713 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2714 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002715 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002716}
2717
2718
2719/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002720 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002721 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002722QCBORError
2723QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2724{
2725 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2726 const UsefulInputBuf Save = pMe->InBuf;
2727
2728 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2729
2730 pMe->nesting = SaveNesting;
2731 pMe->InBuf = Save;
2732
2733 return uErr;
2734}
2735
2736
2737/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002738 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002739 */
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002740void
2741QCBORDecode_VPeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2742{
2743 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladef00b8be2024-03-08 10:34:33 -08002744 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2745 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002746 return;
2747 }
2748
2749 pMe->uLastError = (uint8_t)QCBORDecode_PeekNext(pMe, pDecodedItem);
2750}
2751
2752
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002753static void
2754QCBORDecode_Private_CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2755{
2756#ifndef QCBOR_DISABLE_TAGS
2757 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2758#else
2759 (void)pMe;
2760 (void)pItem;
2761#endif
2762}
2763
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002764/*
2765 * Public function, see header qcbor/qcbor_decode.h file
2766 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002767void
2768QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002769{
2770 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladef00b8be2024-03-08 10:34:33 -08002771 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2772 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002773 return;
2774 }
2775
2776 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07002777 QCBORDecode_Private_CopyTags(pMe, pDecodedItem);
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002778}
2779
2780
2781/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002782 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002783 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002784QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002785QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2786 QCBORItem *pDecodedItem,
2787 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002788{
Laurence Lundblade37286c02022-09-03 10:05:02 -07002789#ifndef QCBOR_DISABLE_TAGS
2790
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002791 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002792
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002793 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2794 if(uReturn != QCBOR_SUCCESS) {
2795 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002796 }
2797
2798 if(pTags != NULL) {
2799 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002800 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002801 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2802 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002803 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002804 }
2805 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2806 return QCBOR_ERR_TOO_MANY_TAGS;
2807 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002808 pTags->puTags[pTags->uNumUsed] = QCBORDecode_Private_UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002809 pTags->uNumUsed++;
2810 }
2811 }
2812
2813 return QCBOR_SUCCESS;
Laurence Lundblade37286c02022-09-03 10:05:02 -07002814
2815#else /* QCBOR_DISABLE_TAGS */
2816 (void)pMe;
2817 (void)pDecodedItem;
2818 (void)pTags;
2819 return QCBOR_ERR_TAGS_DISABLED;
2820#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002821}
2822
2823
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002824/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002825 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302826 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002827bool
2828QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
2829 const QCBORItem *pItem,
2830 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002831{
Laurence Lundblade37286c02022-09-03 10:05:02 -07002832#ifndef QCBOR_DISABLE_TAGS
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002833 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2834 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002835 break;
2836 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002837 if(QCBORDecode_Private_UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002838 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002839 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002840 }
Laurence Lundblade37286c02022-09-03 10:05:02 -07002841#else /* QCBOR_TAGS_DISABLED */
2842 (void)pMe;
2843 (void)pItem;
2844 (void)uTag;
2845#endif /* QCBOR_TAGS_DISABLED */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002846
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002847 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002848}
2849
2850
2851/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002852 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002853 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002854QCBORError
2855QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002856{
Laurence Lundblade87495732021-02-26 10:05:55 -07002857 if(puConsumed != NULL) {
2858 *puConsumed = pMe->InBuf.cursor;
2859 }
2860
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002861 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002862
2863 if(uReturn != QCBOR_SUCCESS) {
2864 goto Done;
2865 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002866
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002867 /* Error out if all the maps/arrays are not closed out */
2868 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002869 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002870 goto Done;
2871 }
2872
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002873 /* Error out if not all the bytes are consumed */
2874 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002875 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002876 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002877
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002878Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002879 return uReturn;
2880}
2881
2882
2883/*
2884 * Public function, see header qcbor/qcbor_decode.h file
2885 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002886QCBORError
2887QCBORDecode_Finish(QCBORDecodeContext *pMe)
Laurence Lundblade87495732021-02-26 10:05:55 -07002888{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002889#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002890 /* Call the destructor for the string allocator if there is one.
2891 * Always called, even if there are errors; always have to clean up.
2892 */
2893 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002894#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002895
Laurence Lundblade87495732021-02-26 10:05:55 -07002896 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002897}
2898
2899
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002900/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002901 * Public function, see header qcbor/qcbor_decode.h file
2902 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002903uint64_t
2904QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2905 const QCBORItem *pItem,
2906 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002907{
Laurence Lundblade37286c02022-09-03 10:05:02 -07002908#ifndef QCBOR_DISABLE_TAGS
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002909 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2910 return CBOR_TAG_INVALID64;
2911 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002912 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2913 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002914 } else {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002915 return QCBORDecode_Private_UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002916 }
Laurence Lundblade37286c02022-09-03 10:05:02 -07002917#else /* QCBOR_DISABLE_TAGS */
2918 (void)pMe;
2919 (void)pItem;
2920 (void)uIndex;
2921
2922 return CBOR_TAG_INVALID64;
2923#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002924}
2925
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002926
Laurence Lundblade9b334962020-08-27 10:55:53 -07002927/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002928 * Public function, see header qcbor/qcbor_decode.h file
2929 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002930uint64_t
2931QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2932 uint32_t uIndex)
Laurence Lundblade9b334962020-08-27 10:55:53 -07002933{
Laurence Lundblade37286c02022-09-03 10:05:02 -07002934#ifndef QCBOR_DISABLE_TAGS
2935
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002936 if(pMe->uLastError != QCBOR_SUCCESS) {
2937 return CBOR_TAG_INVALID64;
2938 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002939 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2940 return CBOR_TAG_INVALID64;
2941 } else {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002942 return QCBORDecode_Private_UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002943 }
Laurence Lundblade37286c02022-09-03 10:05:02 -07002944#else /* QCBOR_DISABLE_TAGS */
2945 (void)pMe;
2946 (void)uIndex;
2947
2948 return CBOR_TAG_INVALID64;
2949#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002950}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002951
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002952
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002953
2954
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002955#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002956
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002957/* ===========================================================================
2958 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002959
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002960 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002961 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2962 implements the function type QCBORStringAllocate and allows easy
2963 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002964
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002965 This particular allocator is built-in for convenience. The caller
2966 can implement their own. All of this following code will get
2967 dead-stripped if QCBORDecode_SetMemPool() is not called.
2968
2969 This is a very primitive memory allocator. It does not track
2970 individual allocations, only a high-water mark. A free or
2971 reallocation must be of the last chunk allocated.
2972
2973 The size of the pool and offset to free memory are packed into the
2974 first 8 bytes of the memory pool so we don't have to keep them in
2975 the decode context. Since the address of the pool may not be
2976 aligned, they have to be packed and unpacked as if they were
2977 serialized data of the wire or such.
2978
2979 The sizes packed in are uint32_t to be the same on all CPU types
2980 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002981 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002982
2983
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002984static int
Laurence Lundbladeee851742020-01-08 08:37:05 -08002985MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002986{
2987 // Use of UsefulInputBuf is overkill, but it is convenient.
2988 UsefulInputBuf UIB;
2989
Laurence Lundbladeee851742020-01-08 08:37:05 -08002990 // Just assume the size here. It was checked during SetUp so
2991 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002992 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002993 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2994 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2995 return UsefulInputBuf_GetError(&UIB);
2996}
2997
2998
Laurence Lundblade8e36f812024-01-26 10:59:29 -07002999static int
Laurence Lundbladeee851742020-01-08 08:37:05 -08003000MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003001{
3002 // Use of UsefulOutBuf is overkill, but convenient. The
3003 // length check performed here is useful.
3004 UsefulOutBuf UOB;
3005
3006 UsefulOutBuf_Init(&UOB, Pool);
3007 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
3008 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
3009 return UsefulOutBuf_GetError(&UOB);
3010}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003011
3012
3013/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003014 Internal function for an allocation, reallocation free and destuct.
3015
3016 Having only one function rather than one each per mode saves space in
3017 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003018
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003019 Code Reviewers: THIS FUNCTION DOES POINTER MATH
3020 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08003021static UsefulBuf
3022MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003023{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003024 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003025
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003026 uint32_t uPoolSize;
3027 uint32_t uFreeOffset;
3028
3029 if(uNewSize > UINT32_MAX) {
3030 // This allocator is only good up to 4GB. This check should
3031 // optimize out if sizeof(size_t) == sizeof(uint32_t)
3032 goto Done;
3033 }
3034 const uint32_t uNewSize32 = (uint32_t)uNewSize;
3035
3036 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
3037 goto Done;
3038 }
3039
3040 if(uNewSize) {
3041 if(pMem) {
3042 // REALLOCATION MODE
3043 // Calculate pointer to the end of the memory pool. It is
3044 // assumed that pPool + uPoolSize won't wrap around by
3045 // assuming the caller won't pass a pool buffer in that is
3046 // not in legitimate memory space.
3047 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
3048
3049 // Check that the pointer for reallocation is in the range of the
3050 // pool. This also makes sure that pointer math further down
3051 // doesn't wrap under or over.
3052 if(pMem >= pPool && pMem < pPoolEnd) {
3053 // Offset to start of chunk for reallocation. This won't
3054 // wrap under because of check that pMem >= pPool. Cast
3055 // is safe because the pool is always less than UINT32_MAX
3056 // because of check in QCBORDecode_SetMemPool().
3057 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
3058
3059 // Check to see if the allocation will fit. uPoolSize -
3060 // uMemOffset will not wrap under because of check that
3061 // pMem is in the range of the uPoolSize by check above.
3062 if(uNewSize <= uPoolSize - uMemOffset) {
3063 ReturnValue.ptr = pMem;
3064 ReturnValue.len = uNewSize;
3065
3066 // Addition won't wrap around over because uNewSize was
3067 // checked to be sure it is less than the pool size.
3068 uFreeOffset = uMemOffset + uNewSize32;
3069 }
3070 }
3071 } else {
3072 // ALLOCATION MODE
3073 // uPoolSize - uFreeOffset will not underflow because this
3074 // pool implementation makes sure uFreeOffset is always
3075 // smaller than uPoolSize through this check here and
3076 // reallocation case.
3077 if(uNewSize <= uPoolSize - uFreeOffset) {
3078 ReturnValue.len = uNewSize;
3079 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08003080 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003081 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003082 }
3083 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003084 if(pMem) {
3085 // FREE MODE
3086 // Cast is safe because of limit on pool size in
3087 // QCBORDecode_SetMemPool()
3088 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
3089 } else {
3090 // DESTRUCT MODE
3091 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003092 }
3093 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003094
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003095 UsefulBuf Pool = {pPool, uPoolSize};
3096 MemPool_Pack(Pool, uFreeOffset);
3097
3098Done:
3099 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003100}
3101
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003102
Laurence Lundbladef6531662018-12-04 10:42:22 +09003103/*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003104 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09003105 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003106QCBORError
3107QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
3108 UsefulBuf Pool,
3109 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003110{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003111 // The pool size and free mem offset are packed into the beginning
Dave Thaler93c01182022-08-06 15:08:35 -04003112 // of the pool memory. This compile time check makes sure the
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003113 // constant in the header is correct. This check should optimize
3114 // down to nothing.
Dave Thaler93c01182022-08-06 15:08:35 -04003115#ifdef _MSC_VER
3116#pragma warning(push)
3117#pragma warning(disable:4127) // conditional expression is constant
3118#endif
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003119 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003120 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003121 }
Dave Thaler93c01182022-08-06 15:08:35 -04003122#ifdef _MSC_VER
3123#pragma warning(pop)
3124#endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003125
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003126 // The pool size and free offset packed in to the beginning of pool
3127 // memory are only 32-bits. This check will optimize out on 32-bit
3128 // machines.
3129 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003130 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003131 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003132
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003133 // This checks that the pool buffer given is big enough.
3134 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003135 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08003136 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003137
Laurence Lundblade3427dee2021-06-20 11:11:24 -07003138 QCBORDecode_SetUpAllocator(pMe, MemPool_Function, Pool.ptr, bAllStrings);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08003139
Laurence Lundblade30816f22018-11-10 13:40:22 +07003140 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07003141}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08003142#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003143
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003144
3145
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003146
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07003147/**
3148 * @brief Consume an entire map or array including its contents.
3149 *
3150 * @param[in] pMe The decoder context.
3151 * @param[in] pItemToConsume The array/map whose contents are to be
3152 * consumed.
3153 * @param[out] puNextNestLevel The next nesting level after the item was
3154 * fully consumed.
3155 *
3156 * This may be called when @c pItemToConsume is not an array or
3157 * map. In that case, this is just a pass through for @c puNextNestLevel
3158 * since there is nothing to do.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003159 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003160static QCBORError
3161QCBORDecode_Private_ConsumeItem(QCBORDecodeContext *pMe,
3162 const QCBORItem *pItemToConsume,
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003163 bool *pbBreak,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003164 uint8_t *puNextNestLevel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003165{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003166 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003167 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003168
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07003169 /* If it is a map or array, this will tell if it is empty. */
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003170 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
3171
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003172 if(QCBORItem_IsMapOrArray(*pItemToConsume) && !bIsEmpty) {
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003173 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003174
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07003175 /* This works for definite- and indefinite-length maps and
3176 * arrays by using the nesting level
Laurence Lundblade1341c592020-04-11 14:19:05 -07003177 */
3178 do {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003179 uReturn = QCBORDecode_Private_GetNextMapOrArray(pMe, pbBreak, &Item);
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07003180 if(QCBORDecode_IsUnrecoverableError(uReturn) ||
3181 uReturn == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003182 goto Done;
3183 }
3184 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003185
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003186 *puNextNestLevel = Item.uNextNestLevel;
3187
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003188 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003189
Laurence Lundblade1341c592020-04-11 14:19:05 -07003190 } else {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003191 /* pItemToConsume is not a map or array. Just pass the nesting
Laurence Lundbladeaf5921e2022-07-15 09:06:30 -07003192 * level through. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003193 *puNextNestLevel = pItemToConsume->uNextNestLevel;
3194
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003195 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003196 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003197
3198Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003199 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003200}
3201
Laurence Lundblade732e52d2021-02-22 20:11:01 -07003202
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003203/*
3204 * Public function, see header qcbor/qcbor_decode.h file
3205 */
3206void
3207QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade732e52d2021-02-22 20:11:01 -07003208{
Laurence Lundblade732e52d2021-02-22 20:11:01 -07003209 QCBORDecode_VGetNext(pMe, pDecodedItem);
3210
3211 if(pMe->uLastError == QCBOR_SUCCESS) {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003212 pMe->uLastError = (uint8_t)QCBORDecode_Private_ConsumeItem(pMe, pDecodedItem, NULL,
Máté Tóth-Pálc6d59682021-05-26 18:55:30 +02003213 &pDecodedItem->uNextNestLevel);
Laurence Lundblade732e52d2021-02-22 20:11:01 -07003214 }
3215}
3216
3217
Laurence Lundblade11654912024-05-09 11:49:24 -07003218/*
3219 * Public function, see header qcbor/qcbor_decode.h file
3220 */
Laurence Lundblade535bb5e2024-06-16 12:06:32 -07003221QCBORError
3222QCBORDecode_EndCheck(QCBORDecodeContext *pMe)
Laurence Lundblade11654912024-05-09 11:49:24 -07003223{
Laurence Lundblade535bb5e2024-06-16 12:06:32 -07003224 size_t uCursorOffset;
3225 QCBORError uErr;
Laurence Lundblade11654912024-05-09 11:49:24 -07003226
Laurence Lundblade535bb5e2024-06-16 12:06:32 -07003227 uErr = QCBORDecode_GetError(pMe);
3228 if(uErr != QCBOR_SUCCESS) {
3229 return uErr;
Laurence Lundblade11654912024-05-09 11:49:24 -07003230 }
3231
3232 uCursorOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
3233
3234 if(uCursorOffset == UsefulInputBuf_GetBufferLength(&(pMe->InBuf))) {
Laurence Lundblade535bb5e2024-06-16 12:06:32 -07003235 return QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade11654912024-05-09 11:49:24 -07003236 }
Laurence Lundblade535bb5e2024-06-16 12:06:32 -07003237
3238 return QCBOR_SUCCESS;
Laurence Lundblade11654912024-05-09 11:49:24 -07003239}
3240
3241
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003242/**
3243 * @brief Rewind cursor to start as if map or array were just entered.
3244 *
3245 * @param[in] pMe The decoding context
3246 *
3247 * This affects the nesting tracking and the UsefulInputBuf.
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003248 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003249static void
3250QCBORDecode_Private_RewindMapOrArray(QCBORDecodeContext *pMe)
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003251{
3252 /* Reset nesting tracking to the deepest bounded level */
3253 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
3254
3255 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3256
3257 /* Reposition traversal cursor to the start of the map/array */
3258 UsefulInputBuf_Seek(&(pMe->InBuf),
3259 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
3260}
3261
3262
3263/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003264 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003265 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003266void
3267QCBORDecode_Rewind(QCBORDecodeContext *pMe)
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003268{
3269 if(pMe->nesting.pCurrentBounded != NULL) {
3270 /* In a bounded map, array or bstr-wrapped CBOR */
3271
3272 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
3273 /* In bstr-wrapped CBOR. */
3274
3275 /* Reposition traversal cursor to start of wrapping byte string */
3276 UsefulInputBuf_Seek(&(pMe->InBuf),
3277 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
3278 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
3279
3280 } else {
3281 /* In a map or array */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003282 QCBORDecode_Private_RewindMapOrArray(pMe);
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003283 }
3284
3285 } else {
3286 /* Not in anything bounded */
3287
3288 /* Reposition traversal cursor to the start of input CBOR */
3289 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
3290
3291 /* Reset nesting tracking to beginning of input. */
3292 DecodeNesting_Init(&(pMe->nesting));
3293 }
3294
3295 pMe->uLastError = QCBOR_SUCCESS;
3296}
3297
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003298
Laurence Lundblade9b334962020-08-27 10:55:53 -07003299
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003300
3301
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003302typedef struct {
3303 void *pCBContext;
3304 QCBORItemCallback pfCallback;
3305} MapSearchCallBack;
3306
3307typedef struct {
3308 size_t uStartOffset;
3309 uint16_t uItemCount;
3310} MapSearchInfo;
3311
3312
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003313/**
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003314 * @brief Search a map for a set of items.
3315 *
3316 * @param[in] pMe The decode context to search.
3317 * @param[in,out] pItemArray The items to search for and the items found.
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003318 * @param[out] pInfo Several bits of meta-info returned by search.
3319 * @param[in] pCallBack Callback object or @c NULL.
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003320 *
3321 * @retval QCBOR_ERR_NOT_ENTERED Trying to search without entering a map.
3322 *
3323 * @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
3324 * were found for one of the labels being
3325 * search for. This duplicate detection is
3326 * only performed for items in pItemArray,
3327 * not every item in the map.
3328 *
3329 * @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
3330 * wrong for the matchd label.
3331 *
3332 * @retval Also errors returned by QCBORDecode_GetNext().
3333 *
3334 * On input, \c pItemArray contains a list of labels and data types of
3335 * items to be found.
3336 *
3337 * On output, the fully retrieved items are filled in with values and
3338 * such. The label was matched, so it never changes.
3339 *
3340 * If an item was not found, its data type is set to @ref QCBOR_TYPE_NONE.
3341 *
3342 * This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003343 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003344static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003345QCBORDecode_Private_MapSearch(QCBORDecodeContext *pMe,
3346 QCBORItem *pItemArray,
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003347 MapSearchInfo *pInfo,
3348 MapSearchCallBack *pCallBack)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003349{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003350 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003351 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07003352
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003353 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003354 uReturn = pMe->uLastError;
3355 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003356 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003357
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003358 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003359 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
3360 /* QCBOR_TYPE_NONE as first item indicates just looking
3361 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003362 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
3363 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003364 }
3365
Laurence Lundblade085d7952020-07-24 10:26:30 -07003366 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
3367 // It is an empty bounded array or map
3368 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
3369 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003370 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07003371 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07003372 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003373 // Nothing is ever found in an empty array or map. All items
3374 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07003375 uReturn = QCBOR_SUCCESS;
3376 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003377 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07003378 }
3379
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003380 QCBORDecodeNesting SaveNesting;
Laurence Lundblade11654912024-05-09 11:49:24 -07003381 size_t uSavePos = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade085d7952020-07-24 10:26:30 -07003382 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
3383
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003384 /* Reposition to search from the start of the map / array */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003385 QCBORDecode_Private_RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003386
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003387 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003388 Loop over all the items in the map or array. Each item
3389 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003390 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003391 length maps and arrays. The only reason this is ever
3392 called on arrays is to find their end position.
3393
3394 This will always run over all items in order to do
3395 duplicate detection.
3396
3397 This will exit with failure if it encounters an
3398 unrecoverable error, but continue on for recoverable
3399 errors.
3400
3401 If a recoverable error occurs on a matched item, then
3402 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003403 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07003404 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003405 if(pInfo) {
3406 pInfo->uItemCount = 0;
3407 }
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02003408 uint8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003409 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003410 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07003411 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003412
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003413 /* Get the item */
3414 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003415 /* QCBORDecode_Private_GetNextTagContent() rather than GetNext()
3416 * because a label match is performed on recoverable errors to
3417 * be able to return the the error code for the found item. */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003418 QCBORError uResult = QCBORDecode_Private_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003419 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003420 /* The map/array can't be decoded when unrecoverable errors occur */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003421 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003422 goto Done;
3423 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003424 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003425 /* Unexpected end of map or array. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003426 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003427 goto Done;
3428 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003429
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003430 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003431 bool bMatched = false;
3432 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003433 if(QCBORItem_MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003434 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003435 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
3436 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003437 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003438 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003439 if(uResult != QCBOR_SUCCESS) {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003440 /* The label matches, but the data item is in error.
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003441 * It is OK to have recoverable errors on items that
3442 * are not matched. */
Laurence Lundblade63926052021-03-29 16:05:51 -07003443 uReturn = uResult;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003444 goto Done;
3445 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003446 if(!QCBORItem_MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade63926052021-03-29 16:05:51 -07003447 /* The data item is not of the type(s) requested */
3448 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003449 goto Done;
3450 }
3451
Laurence Lundblade1341c592020-04-11 14:19:05 -07003452 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003453 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003454 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003455 if(pInfo) {
3456 pInfo->uStartOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003457 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003458 bMatched = true;
3459 }
3460 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003461
3462
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003463 if(!bMatched && pCallBack != NULL) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003464 /*
3465 Call the callback on unmatched labels.
3466 (It is tempting to do duplicate detection here, but that would
3467 require dynamic memory allocation because the number of labels
3468 that might be encountered is unbounded.)
3469 */
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003470 uReturn = (*(pCallBack->pfCallback))(pCallBack->pCBContext, &Item);
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003471 if(uReturn != QCBOR_SUCCESS) {
3472 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003473 }
3474 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003475
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003476 /*
3477 Consume the item whether matched or not. This
3478 does the work of traversing maps and array and
3479 everything in them. In this loop only the
3480 items at the current nesting level are examined
3481 to match the labels.
3482 */
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003483 uReturn = QCBORDecode_Private_ConsumeItem(pMe, &Item, NULL, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003484 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003485 goto Done;
3486 }
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003487
3488 if(pInfo) {
3489 pInfo->uItemCount++;
3490 }
3491
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003492 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003493
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003494 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003495
3496 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003497
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003498 // Check here makes sure that this won't accidentally be
3499 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003500 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003501 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3502 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003503 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3504 goto Done;
3505 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003506 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3507 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003508
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003509 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003510 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
Laurence Lundblade11654912024-05-09 11:49:24 -07003511 UsefulInputBuf_Seek(&(pMe->InBuf), uSavePos);
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003512
3513 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003514 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003515 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003516 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003517 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3518 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003519 }
3520 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003521
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003522 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003523}
3524
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003525
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003526/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003527 * Public function, see header qcbor/qcbor_decode.h file
3528 */
3529void
3530QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3531 int64_t nLabel,
3532 uint8_t uQcborType,
3533 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003534{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003535 if(pMe->uLastError != QCBOR_SUCCESS) {
3536 return;
3537 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003538
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003539 QCBORItem OneItemSeach[2];
3540 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3541 OneItemSeach[0].label.int64 = nLabel;
3542 OneItemSeach[0].uDataType = uQcborType;
3543 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003544
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003545 QCBORError uReturn = QCBORDecode_Private_MapSearch(pMe, OneItemSeach, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003546
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003547 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003548 pItem->uDataType = QCBOR_TYPE_NONE;
3549 pItem->uLabelType = QCBOR_TYPE_NONE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003550 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003551 }
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003552
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003553 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003554 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003555 }
3556
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003557 *pItem = OneItemSeach[0];
3558 QCBORDecode_Private_CopyTags(pMe, pItem);
3559
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003560 Done:
3561 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003562}
3563
3564
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003565/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003566 * Public function, see header qcbor/qcbor_decode.h file
3567 */
3568void
3569QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3570 const char *szLabel,
3571 uint8_t uQcborType,
3572 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003573{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003574 if(pMe->uLastError != QCBOR_SUCCESS) {
3575 return;
3576 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003577
Laurence Lundbladeec290b82024-06-10 11:10:54 -07003578#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003579 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003580 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3581 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3582 OneItemSeach[0].uDataType = uQcborType;
3583 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003584
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003585 QCBORError uReturn = QCBORDecode_Private_MapSearch(pMe, OneItemSeach, NULL, NULL);
3586
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003587 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003588 pItem->uDataType = QCBOR_TYPE_NONE;
3589 pItem->uLabelType = QCBOR_TYPE_NONE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003590 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003591 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003592 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003593 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003594 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003595 }
3596
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003597 *pItem = OneItemSeach[0];
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003598 QCBORDecode_Private_CopyTags(pMe, pItem);
Laurence Lundbladeec290b82024-06-10 11:10:54 -07003599
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07003600Done:
Laurence Lundbladeec290b82024-06-10 11:10:54 -07003601#else
3602 (void)pMe;
3603 (void)szLabel;
3604 (void)uQcborType;
3605 (void)pItem;
3606 QCBORError uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
3607#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
3608
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003609 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003610}
3611
3612
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003613
3614/**
3615 * @brief Semi-private. Get pointer, length and item for an array or map.
3616 *
3617 * @param[in] pMe The decode context.
3618 * @param[in] uType CBOR major type, either array/map.
3619 * @param[out] pItem The item for the array/map.
3620 * @param[out] pEncodedCBOR Pointer and length of the encoded map or array.
3621 *
3622 * The next item to be decoded must be a map or array as specified by \c uType.
3623 *
3624 * \c pItem will be filled in with the label and tags of the array or map
3625 * in addition to \c pEncodedCBOR giving the pointer and length of the
3626 * encoded CBOR.
3627 *
3628 * When this is complete, the traversal cursor is at the end of the array or
3629 * map that was retrieved.
3630 */
3631void
3632QCBORDecode_Private_GetArrayOrMap(QCBORDecodeContext *pMe,
3633 const uint8_t uType,
3634 QCBORItem *pItem,
3635 UsefulBufC *pEncodedCBOR)
3636{
3637 QCBORError uErr;
3638 uint8_t uNestLevel;
3639 size_t uStartingCursor;
3640 size_t uStartOfReturned;
3641 size_t uEndOfReturned;
3642 size_t uTempSaveCursor;
3643 bool bInMap;
3644 QCBORItem LabelItem;
3645 bool EndedByBreak;
3646
3647 uStartingCursor = UsefulInputBuf_Tell(&(pMe->InBuf));
3648 bInMap = DecodeNesting_IsCurrentTypeMap(&(pMe->nesting));
3649
3650 /* Could call GetNext here, but don't need to because this
3651 * is only interested in arrays and maps. */
3652 uErr = QCBORDecode_Private_GetNextMapOrArray(pMe, NULL, pItem);
3653 if(uErr != QCBOR_SUCCESS) {
3654 pMe->uLastError = (uint8_t)uErr;
3655 return;
3656 }
3657
Laurence Lundblade5db34da2024-05-30 03:14:35 -07003658 uint8_t uItemDataType = pItem->uDataType;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07003659#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundblade5db34da2024-05-30 03:14:35 -07003660 if(uItemDataType == QCBOR_TYPE_MAP_AS_ARRAY) {
3661 uItemDataType = QCBOR_TYPE_ARRAY;
3662 }
Laurence Lundbladeec290b82024-06-10 11:10:54 -07003663#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
Laurence Lundblade5db34da2024-05-30 03:14:35 -07003664
3665 if(uItemDataType != uType) {
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003666 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
3667 return;
3668 }
3669
3670 if(bInMap) {
3671 /* If the item is in a map, the start of the array/map
3672 * itself, not the label, must be found. Do this by
3673 * rewinding to the starting position and fetching
3674 * just the label data item. QCBORDecode_Private_GetNextTagNumber()
3675 * doesn't do any of the array/map item counting or nesting
3676 * level tracking. Used here it will just fetech the label
3677 * data item.
3678 *
3679 * Have to save the cursor and put it back to the position
3680 * after the full item once the label as been fetched by
3681 * itself.
3682 */
3683 uTempSaveCursor = UsefulInputBuf_Tell(&(pMe->InBuf));
3684 UsefulInputBuf_Seek(&(pMe->InBuf), uStartingCursor);
3685
3686 /* Item has been fetched once so safe to ignore error */
3687 (void)QCBORDecode_Private_GetNextTagNumber(pMe, &LabelItem);
3688
3689 uStartOfReturned = UsefulInputBuf_Tell(&(pMe->InBuf));
3690 UsefulInputBuf_Seek(&(pMe->InBuf), uTempSaveCursor);
3691 } else {
3692 uStartOfReturned = uStartingCursor;
3693 }
3694
3695 /* Consume the entire array/map to find the end */
3696 uErr = QCBORDecode_Private_ConsumeItem(pMe, pItem, &EndedByBreak, &uNestLevel);
3697 if(uErr != QCBOR_SUCCESS) {
3698 pMe->uLastError = (uint8_t)uErr;
3699 goto Done;
3700 }
3701
3702 /* Fill in returned values */
3703 uEndOfReturned = UsefulInputBuf_Tell(&(pMe->InBuf));
3704 if(EndedByBreak) {
3705 /* When ascending nesting levels, a break for the level above
3706 * was consumed. That break is not a part of what is consumed here. */
3707 uEndOfReturned--;
3708 }
3709 pEncodedCBOR->ptr = UsefulInputBuf_OffsetToPointer(&(pMe->InBuf), uStartOfReturned);
3710 pEncodedCBOR->len = uEndOfReturned - uStartOfReturned;
3711
3712Done:
3713 return;
3714}
3715
3716
3717/**
3718 * @brief Semi-private. Get pointer, length and item count of an array or map.
3719 *
3720 * @param[in] pMe The decode context.
3721 * @param[in] pTarget The label and type of the array or map to retrieve.
3722 * @param[out] pItem The item for the array/map.
3723 * @param[out] pEncodedCBOR Pointer and length of the encoded map or array.
3724 *
3725 * The next item to be decoded must be a map or array as specified by \c uType.
3726 *
3727 * When this is complete, the traversal cursor is unchanged.
3728 */void
3729QCBORDecode_Private_SearchAndGetArrayOrMap(QCBORDecodeContext *pMe,
3730 QCBORItem *pTarget,
3731 QCBORItem *pItem,
3732 UsefulBufC *pEncodedCBOR)
3733{
3734 MapSearchInfo Info;
3735 QCBORDecodeNesting SaveNesting;
3736 size_t uSaveCursor;
3737
3738 pMe->uLastError = (uint8_t)QCBORDecode_Private_MapSearch(pMe, pTarget, &Info, NULL);
3739 if(pMe->uLastError != QCBOR_SUCCESS) {
3740 return;
3741 }
3742
3743 /* Save the whole position of things so they can be restored.
3744 * so the cursor position is unchanged by this operation, like
3745 * all the other GetXxxxInMap() operations. */
3746 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
3747 uSaveCursor = UsefulInputBuf_Tell(&(pMe->InBuf));
3748
3749 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3750 UsefulInputBuf_Seek(&(pMe->InBuf), Info.uStartOffset);
3751 QCBORDecode_Private_GetArrayOrMap(pMe, pTarget[0].uDataType, pItem, pEncodedCBOR);
3752
3753 UsefulInputBuf_Seek(&(pMe->InBuf), uSaveCursor);
3754 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
3755}
3756
3757
3758
3759
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003760/**
3761 * @brief Is a QCBOR_TYPE in the type list?
3762 *
3763 * @param[in] uDataType Type to check for.
3764 * @param[in] puTypeList List to check.
3765 *
3766 * @retval QCBOR_SUCCESS If in the list.
3767 * @retval QCBOR_ERR_UNEXPECTED_TYPE Not in the list.
3768 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003769static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003770QCBOR_Private_CheckTypeList(const int uDataType,
3771 const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003772{
3773 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
Laurence Lundblade68cb61c2023-02-12 13:21:44 -08003774 if(uDataType == puTypeList[i]) { /* -Wmaybe-uninitialized falsly warns here */
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003775 return QCBOR_SUCCESS;
3776 }
3777 }
3778 return QCBOR_ERR_UNEXPECTED_TYPE;
3779}
3780
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003781
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003782/**
Laurence Lundblade37286c02022-09-03 10:05:02 -07003783 * Match a tag/type specification against the type of the item.
3784 *
3785 * @param[in] TagSpec Specification for matching tags.
3786 * @param[in] pItem The item to check.
3787 *
3788 * @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3789 * @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
3790 *
3791 * This checks the item data type of untagged items as well as of
3792 * tagged items against a specification to see if decoding should
3793 * proceed.
3794 *
3795 * This relies on the automatic tag decoding done by QCBOR that turns
3796 * tag numbers into particular QCBOR_TYPEs so there is no actual
3797 * comparsion of tag numbers, just of QCBOR_TYPEs.
3798 *
3799 * This checks the data item type as possibly representing the tag
3800 * number or as the tag content type.
3801 *
3802 * If QCBOR_DISABLE_TAGS is #defined, this primarily checks the item
3803 * data type against the allowed tag content types. It will also error out
3804 * if the caller tries to require a tag because there is no way that can
3805 * ever be fulfilled.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003806 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003807static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003808QCBOR_Private_CheckTagRequirement(const QCBOR_Private_TagSpec TagSpec,
3809 const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003810{
Laurence Lundblade68cb61c2023-02-12 13:21:44 -08003811 const int nItemType = pItem->uDataType; /* -Wmaybe-uninitialized falsly warns here */
Laurence Lundblade37286c02022-09-03 10:05:02 -07003812 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3813
3814#ifndef QCBOR_DISABLE_TAGS
Laurence Lundblade68cb61c2023-02-12 13:21:44 -08003815 /* -Wmaybe-uninitialized falsly warns here */
Laurence Lundblade9b334962020-08-27 10:55:53 -07003816 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3817 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3818 /* There are tags that QCBOR couldn't process on this item and
Laurence Lundblade37286c02022-09-03 10:05:02 -07003819 * the caller has told us there should not be.
3820 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07003821 return QCBOR_ERR_UNEXPECTED_TYPE;
3822 }
3823
Laurence Lundblade9b334962020-08-27 10:55:53 -07003824 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
Laurence Lundblade37286c02022-09-03 10:05:02 -07003825 /* Must match the tag number and only the tag */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003826 return QCBOR_Private_CheckTypeList(nItemType, TagSpec.uTaggedTypes);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003827 }
3828
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003829 QCBORError uReturn = QCBOR_Private_CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003830 if(uReturn == QCBOR_SUCCESS) {
3831 return QCBOR_SUCCESS;
3832 }
3833
3834 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3835 /* Must match the content type and only the content type.
Laurence Lundblade37286c02022-09-03 10:05:02 -07003836 * There was no match just above so it is a fail. */
Laurence Lundblade9b334962020-08-27 10:55:53 -07003837 return QCBOR_ERR_UNEXPECTED_TYPE;
3838 }
3839
Laurence Lundblade37286c02022-09-03 10:05:02 -07003840 /* QCBOR_TAG_REQUIREMENT_OPTIONAL_TAG: If here it can match either the tag or the content
3841 * and it hasn't matched the content, so the end
3842 * result is whether it matches the tag. This is
3843 * the tag optional case that the CBOR standard discourages.
3844 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07003845
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003846 return QCBOR_Private_CheckTypeList(nItemType, TagSpec.uTaggedTypes);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003847
Laurence Lundblade37286c02022-09-03 10:05:02 -07003848#else /* QCBOR_DISABLE_TAGS */
3849 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3850 return QCBOR_ERR_UNEXPECTED_TYPE;
3851 }
3852
Laurence Lundblade0f01ac62024-02-18 23:07:07 -07003853 return QCBOR_Private_CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
Laurence Lundblade37286c02022-09-03 10:05:02 -07003854
3855#endif /* QCBOR_DISABLE_TAGS */
3856}
Laurence Lundblade9b334962020-08-27 10:55:53 -07003857
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003858
3859/**
3860 * @brief Get an item by label to match a tag specification.
3861 *
3862 * @param[in] pMe The decode context.
3863 * @param[in] nLabel The label to search map for.
3864 * @param[in] TagSpec The tag number specification to match.
3865 * @param[out] pItem The item found.
3866 *
3867 * This finds the item with the given label in currently open
3868 * map. Then checks that its tag number and types matches the tag
3869 * specification. If not, an error is set in the decode context.
3870 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003871static void
3872QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3873 const int64_t nLabel,
3874 const QCBOR_Private_TagSpec TagSpec,
3875 QCBORItem *pItem)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003876{
3877 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3878 if(pMe->uLastError != QCBOR_SUCCESS) {
3879 return;
3880 }
3881
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003882 pMe->uLastError = (uint8_t)QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003883}
3884
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003885
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003886/**
3887 * @brief Get an item by label to match a tag specification.
3888 *
3889 * @param[in] pMe The decode context.
3890 * @param[in] szLabel The label to search map for.
3891 * @param[in] TagSpec The tag number specification to match.
3892 * @param[out] pItem The item found.
3893 *
3894 * This finds the item with the given label in currently open
3895 * map. Then checks that its tag number and types matches the tag
3896 * specification. If not, an error is set in the decode context.
3897 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003898static void
3899QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3900 const char *szLabel,
3901 const QCBOR_Private_TagSpec TagSpec,
3902 QCBORItem *pItem)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003903{
3904 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3905 if(pMe->uLastError != QCBOR_SUCCESS) {
3906 return;
3907 }
3908
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003909 pMe->uLastError = (uint8_t)QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003910}
3911
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003912
3913/**
3914 * @brief Semi-private to get an string by label to match a tag specification.
3915 *
3916 * @param[in] pMe The decode context.
3917 * @param[in] nLabel The label to search map for.
3918 * @param[in] TagSpec The tag number specification to match.
3919 * @param[out] pString The string found.
3920 *
3921 * This finds the string with the given label in currently open
3922 * map. Then checks that its tag number and types matches the tag
3923 * specification. If not, an error is set in the decode context.
3924 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003925void
3926QCBORDecode_Private_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3927 const int64_t nLabel,
3928 const QCBOR_Private_TagSpec TagSpec,
3929 UsefulBufC *pString)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003930{
3931 QCBORItem Item;
3932 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3933 if(pMe->uLastError == QCBOR_SUCCESS) {
3934 *pString = Item.val.string;
3935 }
3936}
3937
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003938
3939/**
3940 * @brief Semi-private to get an string by label to match a tag specification.
3941 *
3942 * @param[in] pMe The decode context.
3943 * @param[in] szLabel The label to search map for.
3944 * @param[in] TagSpec The tag number specification to match.
3945 * @param[out] pString The string found.
3946 *
3947 * This finds the string with the given label in currently open
3948 * map. Then checks that its tag number and types matches the tag
3949 * specification. If not, an error is set in the decode context.
3950 */void
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003951QCBORDecode_Private_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3952 const char * szLabel,
3953 const QCBOR_Private_TagSpec TagSpec,
3954 UsefulBufC *pString)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003955{
3956 QCBORItem Item;
3957 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3958 if(pMe->uLastError == QCBOR_SUCCESS) {
3959 *pString = Item.val.string;
3960 }
3961}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003962
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07003963
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003964/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003965 * Public function, see header qcbor/qcbor_decode.h file
3966 */
3967void
3968QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003969{
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003970 QCBORError uErr = QCBORDecode_Private_MapSearch(pMe, pItemList, NULL, NULL);
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003971 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003972}
3973
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003974/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07003975 * Public function, see header qcbor/qcbor_decode.h file
3976 */
3977void
3978QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3979 QCBORItem *pItemList,
3980 void *pCallbackCtx,
3981 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003982{
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07003983 MapSearchCallBack CallBack;
3984 CallBack.pCBContext = pCallbackCtx;
3985 CallBack.pfCallback = pfCB;
3986
3987 QCBORError uErr = QCBORDecode_Private_MapSearch(pMe, pItemList, NULL, &CallBack);
3988
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003989 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003990}
3991
3992
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003993/**
3994 * @brief Search for a map/array by label and enter it
3995 *
3996 * @param[in] pMe The decode context.
3997 * @param[in] pSearch The map/array to search for.
3998 *
3999 * @c pSearch is expected to contain one item of type map or array
4000 * with the label specified. The current bounded map will be searched for
4001 * this and if found will be entered.
4002 *
4003 * If the label is not found, or the item found is not a map or array,
4004 * the error state is set.
4005 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004006static void
4007QCBORDecode_Private_SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07004008{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07004009 // The first item in pSearch is the one that is to be
4010 // entered. It should be the only one filled in. Any other
4011 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07004012 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07004013 return;
4014 }
4015
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07004016 MapSearchInfo Info;
4017 pMe->uLastError = (uint8_t)QCBORDecode_Private_MapSearch(pMe, pSearch, &Info, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07004018 if(pMe->uLastError != QCBOR_SUCCESS) {
4019 return;
4020 }
4021
Laurence Lundblade9b334962020-08-27 10:55:53 -07004022 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07004023 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004024 return;
4025 }
4026
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004027
4028 /* The map or array was found. Now enter it.
4029 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08004030 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
4031 * next item for the pre-order traversal cursor to be the map/array
4032 * found by MapSearch(). The next few lines of code force the
4033 * cursor to that.
4034 *
4035 * There is no need to retain the old cursor because
4036 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
4037 * beginning of the map/array being entered.
4038 *
4039 * The cursor is forced by: 1) setting the input buffer position to
4040 * the item offset found by MapSearch(), 2) setting the map/array
4041 * counter to the total in the map/array, 3) setting the nesting
4042 * level. Setting the map/array counter to the total is not
4043 * strictly correct, but this is OK because this cursor only needs
4044 * to be used to get one item and MapSearch() has already found it
4045 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004046 */
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07004047 UsefulInputBuf_Seek(&(pMe->InBuf), Info.uStartOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004048
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08004049 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
4050
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004051 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07004052
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004053 QCBORDecode_Private_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004054}
4055
4056
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004057/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004058 * Public function, see header qcbor/qcbor_decode.h file
4059 */
4060void
4061QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004062{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07004063 QCBORItem OneItemSeach[2];
4064 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
4065 OneItemSeach[0].label.int64 = nLabel;
4066 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
4067 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07004068
Laurence Lundblade9b334962020-08-27 10:55:53 -07004069 /* The map to enter was found, now finish off entering it. */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004070 QCBORDecode_Private_SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004071}
4072
4073
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004074/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004075 * Public function, see header qcbor/qcbor_decode.h file
4076 */
4077void
4078QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004079{
Laurence Lundbladeec290b82024-06-10 11:10:54 -07004080#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07004081 QCBORItem OneItemSeach[2];
4082 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
4083 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
4084 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
4085 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004086
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004087 QCBORDecode_Private_SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladeec290b82024-06-10 11:10:54 -07004088#else
4089 (void)szLabel;
4090 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
4091#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004092}
4093
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004094/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004095 * Public function, see header qcbor/qcbor_decode.h file
4096 */
4097void
4098QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07004099{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07004100 QCBORItem OneItemSeach[2];
4101 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
4102 OneItemSeach[0].label.int64 = nLabel;
4103 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
4104 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07004105
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004106 QCBORDecode_Private_SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07004107}
4108
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004109/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004110 * Public function, see header qcbor/qcbor_decode.h file
4111 */
4112void
4113QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundblade34691b92020-05-18 22:25:25 -07004114{
Laurence Lundbladeec290b82024-06-10 11:10:54 -07004115#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07004116 QCBORItem OneItemSeach[2];
4117 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
4118 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
4119 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
4120 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07004121
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004122 QCBORDecode_Private_SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladeec290b82024-06-10 11:10:54 -07004123#else
4124 (void)szLabel;
4125 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
4126#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
Laurence Lundblade1341c592020-04-11 14:19:05 -07004127}
4128
4129
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004130/**
4131 * @brief Semi-private to do the the work for EnterMap() and EnterArray().
4132 *
4133 * @param[in] pMe The decode context
4134 * @param[in] uType QCBOR_TYPE_MAP or QCBOR_TYPE_ARRAY.
4135 * @param[out] pItem The data item for the map or array entered.
4136 *
4137 * The next item in the traversal must be a map or array. This
4138 * consumes that item and does the book keeping to enter the map or
4139 * array.
4140 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004141void
4142QCBORDecode_Private_EnterBoundedMapOrArray(QCBORDecodeContext *pMe,
4143 const uint8_t uType,
4144 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004145{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004146 QCBORError uErr;
4147
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004148 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07004149 if(pMe->uLastError != QCBOR_SUCCESS) {
4150 // Already in error state; do nothing.
4151 return;
4152 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07004153
Laurence Lundbladed40951e2020-08-28 11:11:14 -07004154 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004155 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004156 uErr = QCBORDecode_GetNext(pMe, &Item);
4157 if(uErr != QCBOR_SUCCESS) {
4158 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07004159 }
Laurence Lundblade5db34da2024-05-30 03:14:35 -07004160
4161 uint8_t uItemDataType = Item.uDataType;
Laurence Lundbladeec290b82024-06-10 11:10:54 -07004162
4163#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
Laurence Lundblade5db34da2024-05-30 03:14:35 -07004164 if(uItemDataType == QCBOR_TYPE_MAP_AS_ARRAY ) {
4165 uItemDataType = QCBOR_TYPE_ARRAY;
4166 }
Laurence Lundbladeec290b82024-06-10 11:10:54 -07004167#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
4168
Laurence Lundblade5db34da2024-05-30 03:14:35 -07004169 if(uItemDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004170 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
4171 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07004172 }
4173
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004174 QCBORDecode_Private_CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07004175
4176
Laurence Lundbladef0499502020-08-01 11:55:57 -07004177 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07004178 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07004179 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
4180 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004181 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07004182 pMe->nesting.pCurrent->u.ma.uCountCursor++;
4183 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07004184 // Special case to increment nesting level for zero-length maps
4185 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07004186 DecodeNesting_Descend(&(pMe->nesting), uType);
4187 }
4188
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07004189 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004190
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004191 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
4192 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004193
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07004194 if(pItem != NULL) {
4195 *pItem = Item;
4196 }
4197
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004198Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004199 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004200}
4201
Laurence Lundblade02625d42020-06-25 14:41:41 -07004202
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004203/**
4204 * @brief Exit a bounded map, array or bstr (semi-private).
4205 *
4206 * @param[in] pMe Decode context.
4207 * @param[in] uEndOffset The input buffer offset of the end of item exited.
4208 *
4209 * @returns QCBOR_SUCCESS or an error code.
4210 *
4211 * This is the common work for exiting a level that is a bounded map,
4212 * array or bstr wrapped CBOR.
4213 *
4214 * One chunk of work is to set up the pre-order traversal so it is at
4215 * the item just after the bounded map, array or bstr that is being
4216 * exited. This is somewhat complex.
4217 *
4218 * The other work is to level-up the bounded mode to next higest
4219 * bounded mode or the top level if there isn't one.
Laurence Lundblade02625d42020-06-25 14:41:41 -07004220 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004221static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004222QCBORDecode_Private_ExitBoundedLevel(QCBORDecodeContext *pMe,
4223 const uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004224{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004225 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004226
Laurence Lundblade02625d42020-06-25 14:41:41 -07004227 /*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004228 * First the pre-order-traversal byte offset is positioned to the
4229 * item just after the bounded mode item that was just consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07004230 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004231 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
4232
Laurence Lundblade02625d42020-06-25 14:41:41 -07004233 /*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004234 * Next, set the current nesting level to one above the bounded
4235 * level that was just exited.
4236 *
4237 * DecodeNesting_CheckBoundedType() is always called before this
4238 * and makes sure pCurrentBounded is valid.
Laurence Lundblade02625d42020-06-25 14:41:41 -07004239 */
4240 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
4241
4242 /*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004243 * This does the complex work of leveling up the pre-order
4244 * traversal when the end of a map or array or another bounded
4245 * level is reached. It may do nothing, or ascend all the way to
4246 * the top level.
Laurence Lundblade02625d42020-06-25 14:41:41 -07004247 */
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07004248 uErr = QCBORDecode_Private_NestLevelAscender(pMe, NULL, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004249 if(uErr != QCBOR_SUCCESS) {
4250 goto Done;
4251 }
4252
Laurence Lundblade02625d42020-06-25 14:41:41 -07004253 /*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004254 * This makes the next highest bounded level the current bounded
4255 * level. If there is no next highest level, then no bounded mode
4256 * is in effect.
Laurence Lundblade02625d42020-06-25 14:41:41 -07004257 */
4258 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004259
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07004260 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004261
4262Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004263 return uErr;
4264}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004265
Laurence Lundblade02625d42020-06-25 14:41:41 -07004266
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004267/**
4268 * @brief Get started exiting a map or array (semi-private)
4269 *
4270 * @param[in] pMe The decode context
4271 * @param[in] uType QCBOR_TYPE_ARRAY or QCBOR_TYPE_MAP
4272 *
4273 * This does some work for map and array exiting (but not
4274 * bstr exiting). Then QCBORDecode_Private_ExitBoundedLevel()
4275 * is called to do the rest.
4276 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004277void
4278QCBORDecode_Private_ExitBoundedMapOrArray(QCBORDecodeContext *pMe,
4279 const uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004280{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004281 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07004282 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004283 return;
4284 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004285
Laurence Lundblade02625d42020-06-25 14:41:41 -07004286 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004287
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07004288 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07004289 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004290 goto Done;
4291 }
4292
Laurence Lundblade02625d42020-06-25 14:41:41 -07004293 /*
4294 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004295 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07004296 from previous map search, then do a dummy search.
4297 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07004298 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004299 QCBORItem Dummy;
4300 Dummy.uLabelType = QCBOR_TYPE_NONE;
Laurence Lundbladea29f45a2024-05-14 15:55:19 -07004301 uErr = QCBORDecode_Private_MapSearch(pMe, &Dummy, NULL, NULL);
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004302 if(uErr != QCBOR_SUCCESS) {
4303 goto Done;
4304 }
4305 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004306
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004307 uErr = QCBORDecode_Private_ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004308
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004309Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07004310 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07004311}
4312
4313
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004314/**
4315 * @brief The main work of entering some byte-string wrapped CBOR.
4316 *
4317 * @param[in] pMe The decode context.
4318 * @param[in] pItem The byte string item.
4319 * @param[in] uTagRequirement One of @c QCBOR_TAG_REQUIREMENT_XXX
4320 * @param[out] pBstr Pointer and length of byte string entered.
4321 *
4322 * This is called once the byte string item has been decoded to do all
4323 * the book keeping work for descending a nesting level into the
4324 * nested CBOR.
4325 *
4326 * See QCBORDecode_EnterBstrWrapped() for details on uTagRequirement.
4327 */
Laurence Lundblade37286c02022-09-03 10:05:02 -07004328static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004329QCBORDecode_Private_EnterBstrWrapped(QCBORDecodeContext *pMe,
4330 const QCBORItem *pItem,
4331 const uint8_t uTagRequirement,
4332 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004333{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07004334 if(pBstr) {
4335 *pBstr = NULLUsefulBufC;
4336 }
4337
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004338 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004339 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004340 return pMe->uLastError;
4341 }
4342
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004343 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004344
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004345 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004346 {
4347 uTagRequirement,
4348 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
4349 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4350 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004351
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004352 uError = QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004353 if(uError != QCBOR_SUCCESS) {
4354 goto Done;
4355 }
4356
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004357 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004358 /* Reverse the decrement done by GetNext() for the bstr so the
4359 * increment in QCBORDecode_NestLevelAscender() called by
4360 * ExitBoundedLevel() will work right.
4361 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004362 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07004363 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07004364
4365 if(pBstr) {
4366 *pBstr = pItem->val.string;
4367 }
4368
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004369 /* This saves the current length of the UsefulInputBuf and then
4370 * narrows the UsefulInputBuf to start and length of the wrapped
4371 * CBOR that is being entered.
4372 *
4373 * Most of these calls are simple inline accessors so this doesn't
4374 * amount to much code.
4375 */
4376
Laurence Lundbladea4308a82020-10-03 18:08:57 -07004377 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004378 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
4379 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07004380 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07004381 goto Done;
4382 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004383
4384 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
4385 pItem->val.string.ptr);
4386 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
4387 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
4388 /* This should never happen because pItem->val.string.ptr should
4389 * always be valid since it was just returned.
4390 */
4391 uError = QCBOR_ERR_INPUT_TOO_LARGE;
4392 goto Done;
4393 }
4394
4395 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
4396
4397 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07004398 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004399
Laurence Lundblade02625d42020-06-25 14:41:41 -07004400 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07004401 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004402 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004403Done:
4404 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004405}
4406
4407
Laurence Lundblade02625d42020-06-25 14:41:41 -07004408/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004409 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade02625d42020-06-25 14:41:41 -07004410 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004411void
4412QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
4413 const uint8_t uTagRequirement,
4414 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07004415{
4416 if(pMe->uLastError != QCBOR_SUCCESS) {
4417 // Already in error state; do nothing.
4418 return;
4419 }
4420
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004421 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07004422 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07004423 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
4424 if(pMe->uLastError != QCBOR_SUCCESS) {
4425 return;
4426 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07004427
Laurence Lundblade31fddb72024-05-13 13:03:35 -07004428 if(Item.uDataAlloc) {
4429 pMe->uLastError = QCBOR_ERR_CANNOT_ENTER_ALLOCATED_STRING;
4430 return;
4431 }
4432
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004433 pMe->uLastError = (uint8_t)QCBORDecode_Private_EnterBstrWrapped(pMe,
4434 &Item,
4435 uTagRequirement,
4436 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07004437}
4438
4439
Laurence Lundblade02625d42020-06-25 14:41:41 -07004440/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004441 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade02625d42020-06-25 14:41:41 -07004442 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004443void
4444QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
4445 const int64_t nLabel,
4446 const uint8_t uTagRequirement,
4447 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004448{
4449 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004450 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004451
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004452 pMe->uLastError = (uint8_t)QCBORDecode_Private_EnterBstrWrapped(pMe,
4453 &Item,
4454 uTagRequirement,
4455 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004456}
4457
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004458
Laurence Lundblade02625d42020-06-25 14:41:41 -07004459/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004460 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade02625d42020-06-25 14:41:41 -07004461 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004462void
4463QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
4464 const char *szLabel,
4465 const uint8_t uTagRequirement,
4466 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004467{
4468 QCBORItem Item;
4469 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4470
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004471 pMe->uLastError = (uint8_t)QCBORDecode_Private_EnterBstrWrapped(pMe,
4472 &Item,
4473 uTagRequirement,
4474 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07004475}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004476
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004477
Laurence Lundblade02625d42020-06-25 14:41:41 -07004478/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004479 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade02625d42020-06-25 14:41:41 -07004480 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004481void
4482QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004483{
Laurence Lundblade02625d42020-06-25 14:41:41 -07004484 if(pMe->uLastError != QCBOR_SUCCESS) {
4485 // Already in error state; do nothing.
4486 return;
4487 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004488
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07004489 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07004490 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07004491 return;
4492 }
4493
Laurence Lundbladecf41c522021-02-20 10:19:07 -07004494 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
4495
Laurence Lundblade02625d42020-06-25 14:41:41 -07004496 /*
4497 Reset the length of the UsefulInputBuf to what it was before
4498 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07004499 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07004500 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004501 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07004502
4503
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004504 QCBORError uErr = QCBORDecode_Private_ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07004505 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07004506}
4507
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004508
Laurence Lundbladee6430642020-03-14 21:15:44 -07004509
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004510/**
4511 * @brief Process simple type true and false, a boolean
4512 *
4513 * @param[in] pMe The decode context.
4514 * @param[in] pItem The item with either true or false.
4515 * @param[out] pBool The boolean value output.
4516 *
4517 * Sets the internal error if the item isn't a true or a false. Also
4518 * records any tag numbers as the tag numbers of the last item.
4519 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004520static void
4521QCBORDecode_Private_ProcessBool(QCBORDecodeContext *pMe,
4522 const QCBORItem *pItem,
4523 bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004524{
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07004525 if(pMe->uLastError != QCBOR_SUCCESS) {
4526 /* Already in error state, do nothing */
4527 return;
4528 }
4529
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004530 switch(pItem->uDataType) {
4531 case QCBOR_TYPE_TRUE:
4532 *pBool = true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004533 break;
4534
4535 case QCBOR_TYPE_FALSE:
4536 *pBool = false;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004537 break;
4538
4539 default:
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07004540 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004541 break;
4542 }
4543}
Laurence Lundbladee6430642020-03-14 21:15:44 -07004544
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004545
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004546/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07004547 * Public function, see header qcbor/qcbor_decode.h file
4548 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004549void
4550QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004551{
Laurence Lundbladec4537442020-04-14 18:53:22 -07004552 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07004553 QCBORDecode_VGetNext(pMe, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004554 QCBORDecode_Private_ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004555}
4556
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004557
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004558/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07004559 * Public function, see header qcbor/qcbor_decode.h file
4560 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004561void
4562QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe,
4563 const int64_t nLabel,
4564 bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004565{
4566 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004567 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004568 QCBORDecode_Private_ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004569}
4570
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004571
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004572/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07004573 * Public function, see header qcbor/qcbor_decode.h file
4574 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004575void
4576QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe,
4577 const char *szLabel,
4578 bool *pValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004579{
4580 QCBORItem Item;
4581 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004582 QCBORDecode_Private_ProcessBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004583}
4584
4585
Laurence Lundblade3888f002024-06-12 21:20:56 -07004586/**
4587 * @brief Process simple values.
4588 *
4589 * @param[in] pMe The decode context.
4590 * @param[in] pItem The item with the simple value.
4591 * @param[out] puSimple The simple value output.
4592 *
4593 * Sets the internal error if the item isn't a true or a false. Also
4594 * records any tag numbers as the tag numbers of the last item.
4595 */
4596static void
4597QCBORDecode_Private_ProcessSimple(QCBORDecodeContext *pMe,
4598 const QCBORItem *pItem,
4599 uint8_t *puSimple)
4600{
4601 if(pMe->uLastError != QCBOR_SUCCESS) {
4602 return;
4603 }
4604
4605 /* It's kind of lame to remap true...undef back to simple values, but
4606 * this function isn't used much and to not do it would require
4607 * changing GetNext() behavior in an incompatible way.
4608 */
4609 switch(pItem->uDataType) {
4610 case QCBOR_TYPE_UKNOWN_SIMPLE:
4611 *puSimple = pItem->val.uSimple;
4612 break;
4613
4614 case QCBOR_TYPE_TRUE:
4615 *puSimple = CBOR_SIMPLEV_TRUE;
4616 break;
4617
4618 case QCBOR_TYPE_FALSE:
4619 *puSimple = CBOR_SIMPLEV_FALSE;
4620 break;
4621
4622 case QCBOR_TYPE_NULL:
4623 *puSimple = CBOR_SIMPLEV_NULL;
4624 break;
4625
4626 case QCBOR_TYPE_UNDEF:
4627 *puSimple = CBOR_SIMPLEV_UNDEF;
4628 break;
4629
4630 default:
4631 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4632 return;
4633 }
Laurence Lundblade3888f002024-06-12 21:20:56 -07004634}
4635
4636/*
4637 * Public function, see header qcbor/qcbor_decode.h file
4638 */
4639void
4640QCBORDecode_GetSimple(QCBORDecodeContext *pMe, uint8_t *puSimple)
4641{
4642 QCBORItem Item;
Laurence Lundblade3888f002024-06-12 21:20:56 -07004643 QCBORDecode_VGetNext(pMe, &Item);
4644 QCBORDecode_Private_ProcessSimple(pMe, &Item, puSimple);
4645}
4646
4647/*
4648 * Public function, see header qcbor/qcbor_decode.h file
4649 */
4650void
4651QCBORDecode_GetSimpleInMapN(QCBORDecodeContext *pMe,
4652 int64_t nLabel,
4653 uint8_t *puSimpleValue)
4654{
4655 QCBORItem Item;
4656 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3888f002024-06-12 21:20:56 -07004657 QCBORDecode_Private_ProcessSimple(pMe, &Item, puSimpleValue);
4658}
4659
4660/*
4661 * Public function, see header qcbor/qcbor_decode.h file
4662 */
4663void
4664QCBORDecode_GetSimpleInMapSZ(QCBORDecodeContext *pMe,
4665 const char *szLabel,
4666 uint8_t *puSimpleValue)
4667{
4668 QCBORItem Item;
4669 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3888f002024-06-12 21:20:56 -07004670 QCBORDecode_Private_ProcessSimple(pMe, &Item, puSimpleValue);
4671}
4672
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004673
Laurence Lundbladec7114722020-08-13 05:11:40 -07004674
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004675/**
4676 * @brief Common processing for an epoch date.
4677 *
4678 * @param[in] pMe The decode context.
4679 * @param[in] pItem The item with the date.
4680 * @param[in] uTagRequirement One of @c QCBOR_TAG_REQUIREMENT_XXX.
4681 * @param[out] pnTime The returned date.
4682 *
4683 * Common processing for the date tag. Mostly make sure the tag
4684 * content is correct and copy forward any further other tag numbers.
4685 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004686static void
4687QCBORDecode_Private_ProcessEpochDate(QCBORDecodeContext *pMe,
4688 QCBORItem *pItem,
4689 const uint8_t uTagRequirement,
4690 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07004691{
4692 if(pMe->uLastError != QCBOR_SUCCESS) {
4693 // Already in error state, do nothing
4694 return;
4695 }
4696
4697 QCBORError uErr;
4698
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004699 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladec7114722020-08-13 05:11:40 -07004700 {
4701 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004702 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4703 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07004704 };
4705
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004706 uErr = QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07004707 if(uErr != QCBOR_SUCCESS) {
4708 goto Done;
4709 }
4710
4711 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004712 uErr = QCBOR_Private_DecodeDateEpoch(pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07004713 if(uErr != QCBOR_SUCCESS) {
4714 goto Done;
4715 }
4716 }
4717
4718 *pnTime = pItem->val.epochDate.nSeconds;
4719
4720Done:
4721 pMe->uLastError = (uint8_t)uErr;
4722}
4723
4724
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004725
4726/*
4727 * Public function, see header qcbor/qcbor_spiffy_decode.h file
4728 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004729void
4730QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
4731 uint8_t uTagRequirement,
4732 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07004733{
Laurence Lundbladec7114722020-08-13 05:11:40 -07004734 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07004735 QCBORDecode_VGetNext(pMe, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004736 QCBORDecode_Private_ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
Laurence Lundbladec7114722020-08-13 05:11:40 -07004737}
4738
4739
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004740/*
4741 * Public function, see header qcbor/qcbor_spiffy_decode.h file
4742 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07004743void
4744QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
4745 int64_t nLabel,
4746 uint8_t uTagRequirement,
4747 int64_t *pnTime)
4748{
4749 QCBORItem Item;
4750 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004751 QCBORDecode_Private_ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
Laurence Lundbladec7114722020-08-13 05:11:40 -07004752}
4753
4754
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004755/*
4756 * Public function, see header qcbor/qcbor_spiffy_decode.h file
4757 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07004758void
4759QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
4760 const char *szLabel,
4761 uint8_t uTagRequirement,
4762 int64_t *pnTime)
4763{
4764 QCBORItem Item;
4765 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004766 QCBORDecode_Private_ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
Laurence Lundbladec7114722020-08-13 05:11:40 -07004767}
4768
4769
4770
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004771/**
4772 * @brief Common processing for an epoch date.
4773 *
4774 * @param[in] pMe The decode context.
4775 * @param[in] pItem The item with the date.
4776 * @param[in] uTagRequirement One of @c QCBOR_TAG_REQUIREMENT_XXX.
4777 * @param[out] pnDays The returned day count.
4778 *
4779 * Common processing for the RFC 8943 day-count tag. Mostly make sure
4780 * the tag content is correct and copy forward any further other tag
4781 * numbers.
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004782 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004783static void
4784QCBORDecode_Private_ProcessEpochDays(QCBORDecodeContext *pMe,
4785 QCBORItem *pItem,
4786 uint8_t uTagRequirement,
4787 int64_t *pnDays)
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004788{
4789 if(pMe->uLastError != QCBOR_SUCCESS) {
4790 /* Already in error state, do nothing */
4791 return;
4792 }
4793
4794 QCBORError uErr;
4795
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004796 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004797 {
4798 uTagRequirement,
4799 {QCBOR_TYPE_DAYS_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4800 {QCBOR_TYPE_INT64, QCBOR_TYPE_UINT64, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4801 };
4802
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004803 uErr = QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004804 if(uErr != QCBOR_SUCCESS) {
4805 goto Done;
4806 }
4807
4808 if(pItem->uDataType != QCBOR_TYPE_DAYS_EPOCH) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004809 uErr = QCBOR_Private_DecodeDaysEpoch(pItem);
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004810 if(uErr != QCBOR_SUCCESS) {
4811 goto Done;
4812 }
4813 }
4814
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004815 *pnDays = pItem->val.epochDays;
4816
4817Done:
4818 pMe->uLastError = (uint8_t)uErr;
4819}
4820
4821
4822/*
4823 * Public function, see header qcbor/qcbor_decode.h
4824 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004825void
4826QCBORDecode_GetEpochDays(QCBORDecodeContext *pMe,
4827 uint8_t uTagRequirement,
4828 int64_t *pnDays)
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004829{
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004830 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07004831 QCBORDecode_VGetNext(pMe, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004832 QCBORDecode_Private_ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004833}
4834
4835
4836/*
4837 * Public function, see header qcbor/qcbor_decode.h
4838 */
4839void
4840QCBORDecode_GetEpochDaysInMapN(QCBORDecodeContext *pMe,
4841 int64_t nLabel,
4842 uint8_t uTagRequirement,
4843 int64_t *pnDays)
4844{
4845 QCBORItem Item;
4846 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004847 QCBORDecode_Private_ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004848}
4849
4850
4851/*
4852 * Public function, see header qcbor/qcbor_decode.h
4853 */
4854void
4855QCBORDecode_GetEpochDaysInMapSZ(QCBORDecodeContext *pMe,
4856 const char *szLabel,
4857 uint8_t uTagRequirement,
4858 int64_t *pnDays)
4859{
4860 QCBORItem Item;
4861 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004862 QCBORDecode_Private_ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
Laurence Lundblade46d63e92021-05-13 11:37:10 -07004863}
4864
4865
4866
Laurence Lundblade37286c02022-09-03 10:05:02 -07004867/*
4868 * @brief Get a string that matches the type/tag specification.
4869 */
4870void
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004871QCBORDecode_Private_GetTaggedString(QCBORDecodeContext *pMe,
4872 const QCBOR_Private_TagSpec TagSpec,
4873 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004874{
Laurence Lundbladec4537442020-04-14 18:53:22 -07004875 QCBORItem Item;
4876
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07004877 QCBORDecode_VGetNext(pMe, &Item);
4878 if(pMe->uLastError) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004879 return;
4880 }
4881
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004882 pMe->uLastError = (uint8_t)QCBOR_Private_CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004883
4884 if(pMe->uLastError == QCBOR_SUCCESS) {
4885 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07004886 } else {
4887 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004888 }
4889}
4890
Laurence Lundbladec4537442020-04-14 18:53:22 -07004891
4892
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004893
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004894/**
4895 * @brief Common processing for a big number tag.
4896 *
4897 * @param[in] uTagRequirement One of @c QCBOR_TAG_REQUIREMENT_XXX.
4898 * @param[in] pItem The item with the date.
4899 * @param[out] pValue The returned big number
4900 * @param[out] pbIsNegative The returned sign of the big number.
4901 *
4902 * Common processing for the big number tag. Mostly make sure
4903 * the tag content is correct and copy forward any further other tag
4904 * numbers.
4905 */
Laurence Lundblade37286c02022-09-03 10:05:02 -07004906static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004907QCBOR_Private_ProcessBigNum(const uint8_t uTagRequirement,
4908 const QCBORItem *pItem,
4909 UsefulBufC *pValue,
4910 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004911{
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004912 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004913 {
4914 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004915 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4916 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004917 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004918
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004919 QCBORError uErr = QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004920 if(uErr != QCBOR_SUCCESS) {
4921 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004922 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004923
4924 *pValue = pItem->val.string;
4925
4926 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
4927 *pbIsNegative = false;
4928 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
4929 *pbIsNegative = true;
4930 }
4931
4932 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004933}
4934
4935
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004936/*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004937 * Public function, see header qcbor/qcbor_spiffy_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004938 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004939void
4940QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
4941 const uint8_t uTagRequirement,
4942 UsefulBufC *pValue,
4943 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004944{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004945 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07004946 QCBORDecode_VGetNext(pMe, &Item);
4947 if(pMe->uLastError) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004948 return;
4949 }
4950
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004951 pMe->uLastError = (uint8_t)QCBOR_Private_ProcessBigNum(uTagRequirement,
4952 &Item,
4953 pValue,
4954 pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004955}
4956
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004957
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004958/*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004959 * Public function, see header qcbor/qcbor_spiffy_decode.h
4960 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004961void
4962QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
4963 const int64_t nLabel,
4964 const uint8_t uTagRequirement,
4965 UsefulBufC *pValue,
4966 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004967{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004968 QCBORItem Item;
4969 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004970 if(pMe->uLastError != QCBOR_SUCCESS) {
4971 return;
4972 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004973
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004974 pMe->uLastError = (uint8_t)QCBOR_Private_ProcessBigNum(uTagRequirement,
4975 &Item,
4976 pValue,
4977 pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004978}
4979
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004980
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004981/*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07004982 * Public function, see header qcbor/qcbor_spiffy_decode.h
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004983 */
4984void
4985QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
4986 const char *szLabel,
4987 const uint8_t uTagRequirement,
4988 UsefulBufC *pValue,
4989 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004990{
4991 QCBORItem Item;
4992 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004993 if(pMe->uLastError != QCBOR_SUCCESS) {
4994 return;
4995 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004996
Laurence Lundblade8e36f812024-01-26 10:59:29 -07004997 pMe->uLastError = (uint8_t)QCBOR_Private_ProcessBigNum(uTagRequirement,
4998 &Item,
4999 pValue,
5000 pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005001}
5002
5003
5004
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005005/**
5006 * @brief Common processing for MIME tag (semi-private).
5007 *
5008 * @param[in] uTagRequirement One of @c QCBOR_TAG_REQUIREMENT_XXX.
5009 * @param[in] pItem The item with the date.
5010 * @param[out] pMessage The returned MIME message.
5011 * @param[out] pbIsTag257 If true, binary MIME, if not, text MIME.
5012 *
5013 * Common processing for the MIME tag. Mostly make sure the tag
5014 * content is correct and copy forward any further other tag
5015 * numbers. See QCBORDecode_GetMIMEMessage().
5016 */
Laurence Lundblade37286c02022-09-03 10:05:02 -07005017QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005018QCBORDecode_Private_GetMIME(const uint8_t uTagRequirement,
Laurence Lundblade37286c02022-09-03 10:05:02 -07005019 const QCBORItem *pItem,
5020 UsefulBufC *pMessage,
5021 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005022{
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005023 const QCBOR_Private_TagSpec TagSpecText =
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07005024 {
5025 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005026 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
5027 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07005028 };
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005029 const QCBOR_Private_TagSpec TagSpecBinary =
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07005030 {
5031 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005032 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
5033 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07005034 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005035
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005036 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07005037
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005038 if(QCBOR_Private_CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005039 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07005040 if(pbIsTag257 != NULL) {
5041 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005042 }
5043 uReturn = QCBOR_SUCCESS;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005044 } else if(QCBOR_Private_CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005045 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07005046 if(pbIsTag257 != NULL) {
5047 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005048 }
5049 uReturn = QCBOR_SUCCESS;
5050
5051 } else {
5052 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
5053 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07005054
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005055 return uReturn;
5056}
5057
Laurence Lundblade93d89472020-10-03 22:30:50 -07005058// Improvement: add methods for wrapped CBOR, a simple alternate
5059// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07005060
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005061
5062
5063
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005064#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07005065
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005066/**
5067 * @brief Prototype for conversion of exponent and mantissa to unsigned integer.
5068 *
5069 * @param[in] uMantissa The mantissa.
5070 * @param[in] nExponent The exponent.
5071 * @param[out] puResult The resulting integer.
5072 *
5073 * Concrete implementations of this are for exponent base 10 and 2 supporting
5074 * decimal fractions and big floats.
5075 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005076typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005077
5078
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005079/**
5080 * @brief Base 10 exponentiate a mantissa and exponent into an unsigned 64-bit integer.
5081 *
5082 * @param[in] uMantissa The unsigned integer mantissa.
5083 * @param[in] nExponent The signed integer exponent.
5084 * @param[out] puResult Place to return the unsigned integer result.
5085 *
5086 * This computes: mantissa * 10 ^^ exponent as for a decimal fraction. The output is a 64-bit
5087 * unsigned integer.
5088 *
5089 * There are many inputs for which the result will not fit in the
5090 * 64-bit integer and \ref QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW will
5091 * be returned.
5092 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07005093static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005094QCBOR_Private_Exponentitate10(const uint64_t uMantissa,
5095 int64_t nExponent,
5096 uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07005097{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005098 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07005099
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005100 if(uResult != 0) {
5101 /* This loop will run a maximum of 19 times because
5102 * UINT64_MAX < 10 ^^ 19. More than that will cause
5103 * exit with the overflow error
5104 */
5105 for(; nExponent > 0; nExponent--) {
5106 if(uResult > UINT64_MAX / 10) {
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005107 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005108 }
5109 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07005110 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005111
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005112 for(; nExponent < 0; nExponent++) {
5113 uResult = uResult / 10;
5114 if(uResult == 0) {
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005115 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005116 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005117 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005118 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005119 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07005120
5121 *puResult = uResult;
5122
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005123 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07005124}
5125
5126
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005127/**
5128 * @brief Base 2 exponentiate a mantissa and exponent into an unsigned 64-bit integer.
5129 *
5130 * @param[in] uMantissa The unsigned integer mantissa.
5131 * @param[in] nExponent The signed integer exponent.
5132 * @param[out] puResult Place to return the unsigned integer result.
5133 *
5134 * This computes: mantissa * 2 ^^ exponent as for a big float. The
5135 * output is a 64-bit unsigned integer.
5136 *
5137 * There are many inputs for which the result will not fit in the
5138 * 64-bit integer and \ref QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW will
5139 * be returned.
5140 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07005141static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005142QCBOR_Private_Exponentitate2(const uint64_t uMantissa,
5143 int64_t nExponent,
5144 uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005145{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005146 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005147
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005148 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005149
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005150 /* This loop will run a maximum of 64 times because INT64_MAX <
5151 * 2^31. More than that will cause exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07005152 */
5153 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005154 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005155 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005156 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005157 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005158 nExponent--;
5159 }
5160
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005161 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005162 if(uResult == 0) {
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005163 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005164 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005165 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005166 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005167 }
5168
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005169 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005170
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005171 return QCBOR_SUCCESS;
5172}
5173
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005174
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005175/**
5176 * @brief Exponentiate a signed mantissa and signed exponent to produce a signed result.
5177 *
5178 * @param[in] nMantissa Signed integer mantissa.
5179 * @param[in] nExponent Signed integer exponent.
5180 * @param[out] pnResult Place to put the signed integer result.
5181 * @param[in] pfExp Exponentiation function.
5182 *
5183 * @returns Error code
5184 *
5185 * \c pfExp performs exponentiation on and unsigned mantissa and
5186 * produces an unsigned result. This converts the mantissa from signed
5187 * and converts the result to signed. The exponentiation function is
5188 * either for base 2 or base 10 (and could be other if needed).
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005189 */
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005190static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005191QCBOR_Private_ExponentiateNN(const int64_t nMantissa,
5192 const int64_t nExponent,
5193 int64_t *pnResult,
5194 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005195{
5196 uint64_t uResult;
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005197 uint64_t uMantissa;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005198
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005199 /* Take the absolute value and put it into an unsigned. */
5200 if(nMantissa >= 0) {
5201 /* Positive case is straightforward */
5202 uMantissa = (uint64_t)nMantissa;
5203 } else if(nMantissa != INT64_MIN) {
5204 /* The common negative case. See next. */
5205 uMantissa = (uint64_t)-nMantissa;
5206 } else {
5207 /* int64_t and uint64_t are always two's complement per the
5208 * C standard (and since QCBOR uses these it only works with
5209 * two's complement, which is pretty much universal these
5210 * days). The range of a negative two's complement integer is
5211 * one more that than a positive, so the simple code above might
5212 * not work all the time because you can't simply negate the
5213 * value INT64_MIN because it can't be represented in an
5214 * int64_t. -INT64_MIN can however be represented in a
5215 * uint64_t. Some compilers seem to recognize this case for the
5216 * above code and put the correct value in uMantissa, however
5217 * they are not required to do this by the C standard. This next
5218 * line does however work for all compilers.
5219 *
5220 * This does assume two's complement where -INT64_MIN ==
5221 * INT64_MAX + 1 (which wouldn't be true for one's complement or
5222 * sign and magnitude (but we know we're using two's complement
5223 * because int64_t requires it)).
5224 *
5225 * See these, particularly the detailed commentary:
5226 * https://stackoverflow.com/questions/54915742/does-c99-mandate-a-int64-t-type-be-available-always
5227 * https://stackoverflow.com/questions/37301078/is-negating-int-min-undefined-behaviour
5228 */
5229 uMantissa = (uint64_t)INT64_MAX+1;
5230 }
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005231
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005232 /* Call the exponentiator passed for either base 2 or base 10.
5233 * Here is where most of the overflow errors are caught. */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005234 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
5235 if(uReturn) {
5236 return uReturn;
5237 }
5238
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005239 /* Convert back to the sign of the original mantissa */
5240 if(nMantissa >= 0) {
5241 if(uResult > INT64_MAX) {
5242 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
5243 }
5244 *pnResult = (int64_t)uResult;
5245 } else {
5246 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
5247 * of INT64_MIN. This assumes two's compliment representation
5248 * where INT64_MIN is one increment farther from 0 than
5249 * INT64_MAX. Trying to write -INT64_MIN doesn't work to get
5250 * this because the compiler makes it an int64_t which can't
5251 * represent -INT64_MIN. Also see above.
5252 */
5253 if(uResult > (uint64_t)INT64_MAX+1) {
5254 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
5255 }
5256 *pnResult = -(int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005257 }
5258
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005259 return QCBOR_SUCCESS;
5260}
5261
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005262
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005263/**
5264 * @brief Exponentiate an unsigned mantissa and signed exponent to produce an unsigned result.
5265 *
5266 * @param[in] nMantissa Signed integer mantissa.
5267 * @param[in] nExponent Signed integer exponent.
5268 * @param[out] puResult Place to put the signed integer result.
5269 * @param[in] pfExp Exponentiation function.
5270 *
5271 * @returns Error code
5272 *
5273 * \c pfExp performs exponentiation on and unsigned mantissa and
5274 * produces an unsigned result. This errors out if the mantissa
5275 * is negative because the output is unsigned.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005276 */
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005277static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005278QCBOR_Private_ExponentitateNU(const int64_t nMantissa,
5279 const int64_t nExponent,
5280 uint64_t *puResult,
5281 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005282{
5283 if(nMantissa < 0) {
5284 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
5285 }
5286
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005287 /* Cast to unsigned is OK because of check for negative.
5288 * Cast to unsigned is OK because UINT64_MAX > INT64_MAX.
5289 * Exponentiation is straight forward
5290 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005291 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
5292}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005293
5294
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005295/**
5296 * @brief Exponentiate an usnigned mantissa and unsigned exponent to produce an unsigned result.
5297 *
5298 * @param[in] uMantissa Unsigned integer mantissa.
5299 * @param[in] nExponent Unsigned integer exponent.
5300 * @param[out] puResult Place to put the unsigned integer result.
5301 * @param[in] pfExp Exponentiation function.
5302 *
5303 * @returns Error code
5304 *
5305 * \c pfExp performs exponentiation on and unsigned mantissa and
5306 * produces an unsigned result so this is just a wrapper that does
5307 * nothing (and is likely inlined).
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005308 */
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005309static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005310QCBOR_Private_ExponentitateUU(const uint64_t uMantissa,
5311 const int64_t nExponent,
5312 uint64_t *puResult,
5313 fExponentiator pfExp)
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005314{
5315 return (*pfExp)(uMantissa, nExponent, puResult);
5316}
5317
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005318#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005319
5320
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005321
5322
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005323/**
5324 * @brief Convert a CBOR big number to a uint64_t.
5325 *
5326 * @param[in] BigNum Bytes of the big number to convert.
5327 * @param[in] uMax Maximum value allowed for the result.
5328 * @param[out] pResult Place to put the unsigned integer result.
5329 *
5330 * @returns Error code
5331 *
5332 * Many values will overflow because a big num can represent a much
5333 * larger range than uint64_t.
5334 */
5335static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005336QCBOR_Private_ConvertBigNumToUnsigned(const UsefulBufC BigNum,
5337 const uint64_t uMax,
5338 uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005339{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005340 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005341
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005342 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005343 const uint8_t *pByte = BigNum.ptr;
5344 size_t uLen = BigNum.len;
5345 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07005346 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07005347 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005348 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07005349 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005350 }
5351
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005352 *pResult = uResult;
5353 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005354}
5355
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005356
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005357/**
5358 * @brief Convert a CBOR postive big number to a uint64_t.
5359 *
5360 * @param[in] BigNum Bytes of the big number to convert.
5361 * @param[out] pResult Place to put the unsigned integer result.
5362 *
5363 * @returns Error code
5364 *
5365 * Many values will overflow because a big num can represent a much
5366 * larger range than uint64_t.
5367 */
5368static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005369QCBOR_Private_ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum,
5370 uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005371{
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005372 return QCBOR_Private_ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005373}
5374
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005375
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005376/**
5377 * @brief Convert a CBOR positive big number to an int64_t.
5378 *
5379 * @param[in] BigNum Bytes of the big number to convert.
5380 * @param[out] pResult Place to put the signed integer result.
5381 *
5382 * @returns Error code
5383 *
5384 * Many values will overflow because a big num can represent a much
5385 * larger range than int64_t.
5386 */
5387static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005388QCBOR_Private_ConvertPositiveBigNumToSigned(const UsefulBufC BigNum,
5389 int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005390{
5391 uint64_t uResult;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005392 QCBORError uError = QCBOR_Private_ConvertBigNumToUnsigned(BigNum,
5393 INT64_MAX,
5394 &uResult);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005395 if(uError) {
5396 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005397 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005398 /* Cast is safe because ConvertBigNumToUnsigned limits to INT64_MAX */
Laurence Lundbladee6430642020-03-14 21:15:44 -07005399 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005400 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005401}
5402
5403
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005404/**
5405 * @brief Convert a CBOR negative big number to an int64_t.
5406 *
5407 * @param[in] BigNum Bytes of the big number to convert.
5408 * @param[out] pnResult Place to put the signed integer result.
5409 *
5410 * @returns Error code
5411 *
5412 * Many values will overflow because a big num can represent a much
5413 * larger range than int64_t.
5414 */
5415static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005416QCBOR_Private_ConvertNegativeBigNumToSigned(const UsefulBufC BigNum,
5417 int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005418{
5419 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005420 /* The negative integer furthest from zero for a C int64_t is
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005421 * INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
5422 * negative number in CBOR is computed as -n - 1 where n is the
5423 * encoded integer, where n is what is in the variable BigNum. When
5424 * converting BigNum to a uint64_t, the maximum value is thus
5425 * INT64_MAX, so that when it -n - 1 is applied to it the result
5426 * will never be further from 0 than INT64_MIN.
5427 *
5428 * -n - 1 <= INT64_MIN.
5429 * -n - 1 <= -INT64_MAX - 1
5430 * n <= INT64_MAX.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005431 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005432 QCBORError uError = QCBOR_Private_ConvertBigNumToUnsigned(BigNum,
5433 INT64_MAX,
5434 &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005435 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005436 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005437 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005438
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07005439 /* Now apply -n - 1. The cast is safe because
5440 * ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
5441 * is the largest positive integer that an int64_t can
5442 * represent. */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005443 *pnResult = -(int64_t)uResult - 1;
5444
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005445 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005446}
5447
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005448
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005449
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005450
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005451/**
5452 * @brief Convert integers and floats to an int64_t.
5453 *
5454 * @param[in] pItem The item to convert.
5455 * @param[in] uConvertTypes Bit mask list of conversion options.
5456 * @param[out] pnValue The resulting converted value.
5457 *
5458 * @retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
5459 * in uConvertTypes.
5460 * @retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
5461 * @retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
5462 * or too small.
5463 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07005464static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005465QCBOR_Private_ConvertInt64(const QCBORItem *pItem,
5466 const uint32_t uConvertTypes,
5467 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005468{
5469 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005470 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005471 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005472#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005473 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005474 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
5475 http://www.cplusplus.com/reference/cmath/llround/
5476 */
5477 // Not interested in FE_INEXACT
5478 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005479 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
5480 *pnValue = llround(pItem->val.dfnum);
5481 } else {
5482 *pnValue = lroundf(pItem->val.fnum);
5483 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005484 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
5485 // llround() shouldn't result in divide by zero, but catch
5486 // it here in case it unexpectedly does. Don't try to
5487 // distinguish between the various exceptions because it seems
5488 // they vary by CPU, compiler and OS.
5489 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005490 }
5491 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005492 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005493 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005494#else
5495 return QCBOR_ERR_HW_FLOAT_DISABLED;
5496#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005497 break;
5498
5499 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005500 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005501 *pnValue = pItem->val.int64;
5502 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005503 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005504 }
5505 break;
5506
5507 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005508 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005509 if(pItem->val.uint64 < INT64_MAX) {
5510 *pnValue = pItem->val.int64;
5511 } else {
5512 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
5513 }
5514 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005515 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005516 }
5517 break;
5518
Laurence Lundblade2d493002024-02-01 11:09:17 -07005519 case QCBOR_TYPE_65BIT_NEG_INT:
5520 /* This type occurs if the value won't fit into int64_t
5521 * so this is always an error. */
5522 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
5523 break;
5524
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005525 default:
5526 return QCBOR_ERR_UNEXPECTED_TYPE;
5527 }
5528 return QCBOR_SUCCESS;
5529}
5530
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005531
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005532/**
5533 * @brief Almost-public method to decode a number and convert to int64_t (semi-private).
5534 *
5535 * @param[in] pMe The decode context.
5536 * @param[in] uConvertTypes Bit mask list of conversion options.
5537 * @param[out] pnValue Result of the conversion.
5538 * @param[in,out] pItem Temporary space to store Item, returned item.
5539 *
5540 * See QCBORDecode_GetInt64Convert().
5541 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005542void
5543QCBORDecode_Private_GetInt64Convert(QCBORDecodeContext *pMe,
5544 uint32_t uConvertTypes,
5545 int64_t *pnValue,
5546 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005547{
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07005548 QCBORDecode_VGetNext(pMe, pItem);
5549 if(pMe->uLastError) {
Laurence Lundbladee6430642020-03-14 21:15:44 -07005550 return;
5551 }
5552
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005553 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertInt64(pItem,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005554 uConvertTypes,
5555 pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005556}
5557
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005558/**
5559 * @brief Almost-public method to decode a number and convert to int64_t (semi-private).
5560 *
5561 * @param[in] pMe The decode context.
5562 * @param[in] nLabel Label to find in map.
5563 * @param[in] uConvertTypes Bit mask list of conversion options.
5564 * @param[out] pnValue Result of the conversion.
5565 * @param[in,out] pItem Temporary space to store Item, returned item.
5566 *
5567 * See QCBORDecode_GetInt64ConvertInMapN().
5568 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005569void
5570QCBORDecode_Private_GetInt64ConvertInMapN(QCBORDecodeContext *pMe,
5571 int64_t nLabel,
5572 uint32_t uConvertTypes,
5573 int64_t *pnValue,
5574 QCBORItem *pItem)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005575{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005576 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005577 if(pMe->uLastError != QCBOR_SUCCESS) {
5578 return;
5579 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005580
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005581 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertInt64(pItem,
5582 uConvertTypes,
5583 pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005584}
5585
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005586/**
5587 * @brief Almost-public method to decode a number and convert to int64_t (semi-private).
5588 *
5589 * @param[in] pMe The decode context.
5590 * @param[in] szLabel Label to find in map.
5591 * @param[in] uConvertTypes Bit mask list of conversion options.
5592 * @param[out] pnValue Result of the conversion.
5593 * @param[in,out] pItem Temporary space to store Item, returned item.
5594 *
5595 * See QCBORDecode_GetInt64ConvertInMapSZ().
5596 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005597void
5598QCBORDecode_Private_GetInt64ConvertInMapSZ(QCBORDecodeContext *pMe,
5599 const char * szLabel,
5600 uint32_t uConvertTypes,
5601 int64_t *pnValue,
5602 QCBORItem *pItem)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005603{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005604 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005605 if(pMe->uLastError != QCBOR_SUCCESS) {
5606 return;
5607 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005608
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005609 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertInt64(pItem,
5610 uConvertTypes,
5611 pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005612}
5613
5614
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005615/**
5616 * @brief Convert many number types to an int64_t.
5617 *
5618 * @param[in] pItem The item to convert.
5619 * @param[in] uConvertTypes Bit mask list of conversion options.
5620 * @param[out] pnValue The resulting converted value.
5621 *
5622 * @retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
5623 * in uConvertTypes.
5624 * @retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
5625 * @retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
5626 * or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005627 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07005628static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005629QCBOR_Private_Int64ConvertAll(const QCBORItem *pItem,
5630 const uint32_t uConvertTypes,
5631 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005632{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005633 switch(pItem->uDataType) {
5634
5635 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005636 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005637 return QCBOR_Private_ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005638 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005639 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005640 }
5641 break;
5642
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005643 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005644 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005645 return QCBOR_Private_ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005646 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005647 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005648 }
5649 break;
5650
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005651#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005652 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005653 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005654 return QCBOR_Private_ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005655 pItem->val.expAndMantissa.nExponent,
5656 pnValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005657 &QCBOR_Private_Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005658 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005659 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005660 }
5661 break;
5662
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005663 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005664 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005665 return QCBOR_Private_ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005666 pItem->val.expAndMantissa.nExponent,
5667 pnValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005668 QCBOR_Private_Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005669 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005670 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005671 }
5672 break;
5673
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005674 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005675 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005676 int64_t nMantissa;
5677 QCBORError uErr;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005678 uErr = QCBOR_Private_ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005679 if(uErr) {
5680 return uErr;
5681 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005682 return QCBOR_Private_ExponentiateNN(nMantissa,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005683 pItem->val.expAndMantissa.nExponent,
5684 pnValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005685 QCBOR_Private_Exponentitate10);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005686 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005687 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005688 }
5689 break;
5690
5691 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005692 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005693 int64_t nMantissa;
5694 QCBORError uErr;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005695 uErr = QCBOR_Private_ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005696 if(uErr) {
5697 return uErr;
5698 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005699 return QCBOR_Private_ExponentiateNN(nMantissa,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005700 pItem->val.expAndMantissa.nExponent,
5701 pnValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005702 QCBOR_Private_Exponentitate10);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005703 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005704 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005705 }
5706 break;
5707
5708 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005709 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005710 int64_t nMantissa;
5711 QCBORError uErr;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005712 uErr = QCBOR_Private_ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005713 if(uErr) {
5714 return uErr;
5715 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005716 return QCBOR_Private_ExponentiateNN(nMantissa,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005717 pItem->val.expAndMantissa.nExponent,
5718 pnValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005719 QCBOR_Private_Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005720 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005721 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005722 }
5723 break;
5724
5725 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005726 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005727 int64_t nMantissa;
5728 QCBORError uErr;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005729 uErr = QCBOR_Private_ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005730 if(uErr) {
5731 return uErr;
5732 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005733 return QCBOR_Private_ExponentiateNN(nMantissa,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005734 pItem->val.expAndMantissa.nExponent,
5735 pnValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005736 QCBOR_Private_Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005737 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005738 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07005739 }
5740 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005741#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005742
Laurence Lundbladee6430642020-03-14 21:15:44 -07005743
Laurence Lundbladec4537442020-04-14 18:53:22 -07005744 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005745 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005746}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005747
5748
Laurence Lundbladec4537442020-04-14 18:53:22 -07005749/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005750 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005751 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005752void
5753QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe,
5754 const uint32_t uConvertTypes,
5755 int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07005756{
5757 QCBORItem Item;
5758
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005759 QCBORDecode_Private_GetInt64Convert(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07005760
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005761 if(pMe->uLastError == QCBOR_SUCCESS) {
5762 // The above conversion succeeded
5763 return;
5764 }
5765
Laurence Lundbladef6c86662020-05-12 02:08:00 -07005766 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005767 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07005768 return;
5769 }
5770
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005771 pMe->uLastError = (uint8_t)QCBOR_Private_Int64ConvertAll(&Item,
5772 uConvertTypes,
5773 pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005774}
5775
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005776
5777/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005778 * Public function, see header qcbor/qcbor_decode.h file
5779 */
5780void
5781QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
5782 const int64_t nLabel,
5783 const uint32_t uConvertTypes,
5784 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005785{
5786 QCBORItem Item;
5787
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005788 QCBORDecode_Private_GetInt64ConvertInMapN(pMe,
Laurence Lundblade93d89472020-10-03 22:30:50 -07005789 nLabel,
5790 uConvertTypes,
5791 pnValue,
5792 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005793
5794 if(pMe->uLastError == QCBOR_SUCCESS) {
5795 // The above conversion succeeded
5796 return;
5797 }
5798
5799 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5800 // The above conversion failed in a way that code below can't correct
5801 return;
5802 }
5803
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005804 pMe->uLastError = (uint8_t)QCBOR_Private_Int64ConvertAll(&Item,
5805 uConvertTypes,
5806 pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005807}
5808
5809
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005810/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005811 * Public function, see header qcbor/qcbor_decode.h file
5812 */
5813void
5814QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
5815 const char *szLabel,
5816 const uint32_t uConvertTypes,
5817 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005818{
5819 QCBORItem Item;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005820 QCBORDecode_Private_GetInt64ConvertInMapSZ(pMe,
Laurence Lundblade93d89472020-10-03 22:30:50 -07005821 szLabel,
5822 uConvertTypes,
5823 pnValue,
5824 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005825
5826 if(pMe->uLastError == QCBOR_SUCCESS) {
5827 // The above conversion succeeded
5828 return;
5829 }
5830
5831 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5832 // The above conversion failed in a way that code below can't correct
5833 return;
5834 }
5835
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005836 pMe->uLastError = (uint8_t)QCBOR_Private_Int64ConvertAll(&Item,
5837 uConvertTypes,
5838 pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005839}
5840
5841
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005842/**
5843 * @brief Convert many number types to an uint64_t.
5844 *
5845 * @param[in] pItem The item to convert.
5846 * @param[in] uConvertTypes Bit mask list of conversion options.
5847 * @param[out] puValue The resulting converted value.
5848 *
5849 * @retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
5850 * in uConvertTypes.
5851 * @retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
5852 * @retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
5853 * or too small.
5854 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005855static QCBORError
5856QCBOR_Private_ConvertUInt64(const QCBORItem *pItem,
5857 const uint32_t uConvertTypes,
5858 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005859{
5860 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005861 case QCBOR_TYPE_DOUBLE:
5862 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005863#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005864 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005865 // Can't use llround here because it will not convert values
5866 // greater than INT64_MAX and less than UINT64_MAX that
5867 // need to be converted so it is more complicated.
5868 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
5869 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
5870 if(isnan(pItem->val.dfnum)) {
5871 return QCBOR_ERR_FLOAT_EXCEPTION;
5872 } else if(pItem->val.dfnum < 0) {
5873 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
5874 } else {
5875 double dRounded = round(pItem->val.dfnum);
5876 // See discussion in DecodeDateEpoch() for
5877 // explanation of - 0x7ff
5878 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
5879 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
5880 }
5881 *puValue = (uint64_t)dRounded;
5882 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005883 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005884 if(isnan(pItem->val.fnum)) {
5885 return QCBOR_ERR_FLOAT_EXCEPTION;
5886 } else if(pItem->val.fnum < 0) {
5887 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
5888 } else {
5889 float fRounded = roundf(pItem->val.fnum);
5890 // See discussion in DecodeDateEpoch() for
5891 // explanation of - 0x7ff
5892 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
5893 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
5894 }
5895 *puValue = (uint64_t)fRounded;
5896 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005897 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005898 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
5899 // round() and roundf() shouldn't result in exceptions here, but
5900 // catch them to be robust and thorough. Don't try to
5901 // distinguish between the various exceptions because it seems
5902 // they vary by CPU, compiler and OS.
5903 return QCBOR_ERR_FLOAT_EXCEPTION;
5904 }
5905
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005906 } else {
5907 return QCBOR_ERR_UNEXPECTED_TYPE;
5908 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005909#else
5910 return QCBOR_ERR_HW_FLOAT_DISABLED;
5911#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005912 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07005913
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005914 case QCBOR_TYPE_INT64:
5915 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
5916 if(pItem->val.int64 >= 0) {
5917 *puValue = (uint64_t)pItem->val.int64;
5918 } else {
5919 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
5920 }
5921 } else {
5922 return QCBOR_ERR_UNEXPECTED_TYPE;
5923 }
5924 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005925
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005926 case QCBOR_TYPE_UINT64:
5927 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade2d493002024-02-01 11:09:17 -07005928 *puValue = pItem->val.uint64;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005929 } else {
5930 return QCBOR_ERR_UNEXPECTED_TYPE;
5931 }
5932 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005933
Laurence Lundblade2d493002024-02-01 11:09:17 -07005934 case QCBOR_TYPE_65BIT_NEG_INT:
5935 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
5936
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005937 default:
5938 return QCBOR_ERR_UNEXPECTED_TYPE;
5939 }
5940
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005941 return QCBOR_SUCCESS;
5942}
Laurence Lundbladec4537442020-04-14 18:53:22 -07005943
5944
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005945/**
5946 * @brief Almost-public method to decode a number and convert to uint64_t (semi-private).
5947 *
5948 * @param[in] pMe The decode context.
5949 * @param[in] uConvertTypes Bit mask list of conversion options.
5950 * @param[out] puValue Result of the conversion.
5951 * @param[in,out] pItem Temporary space to store Item, returned item.
5952 *
5953 * See QCBORDecode_GetUInt64Convert().
5954 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005955void
5956QCBORDecode_Private_GetUInt64Convert(QCBORDecodeContext *pMe,
5957 const uint32_t uConvertTypes,
5958 uint64_t *puValue,
5959 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07005960{
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07005961 QCBORDecode_VGetNext(pMe, pItem);
5962 if(pMe->uLastError) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005963 return;
5964 }
5965
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07005966 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertUInt64(pItem,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005967 uConvertTypes,
5968 puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07005969}
5970
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005971
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07005972/**
5973 * @brief Almost-public method to decode a number and convert to uint64_t (semi-private).
5974 *
5975 * @param[in] pMe The decode context.
5976 * @param[in] nLabel Label to find in map.
5977 * @param[in] uConvertTypes Bit mask list of conversion options.
5978 * @param[out] puValue Result of the conversion.
5979 * @param[in,out] pItem Temporary space to store Item, returned item.
5980 *
5981 * See QCBORDecode_GetUInt64ConvertInMapN().
5982 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005983void
5984QCBORDecode_Private_GetUInt64ConvertInMapN(QCBORDecodeContext *pMe,
5985 const int64_t nLabel,
5986 const uint32_t uConvertTypes,
5987 uint64_t *puValue,
5988 QCBORItem *pItem)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005989{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005990 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005991 if(pMe->uLastError != QCBOR_SUCCESS) {
5992 return;
5993 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005994
Laurence Lundblade8e36f812024-01-26 10:59:29 -07005995 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertUInt64(pItem,
5996 uConvertTypes,
5997 puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005998}
5999
6000
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006001/**
6002 * @brief Almost-public method to decode a number and convert to uint64_t (semi-private).
6003 *
6004 * @param[in] pMe The decode context.
6005 * @param[in] szLabel Label to find in map.
6006 * @param[in] uConvertTypes Bit mask list of conversion options.
6007 * @param[out] puValue Result of the conversion.
6008 * @param[in,out] pItem Temporary space to store Item, returned item.
6009 *
6010 * See QCBORDecode_GetUInt64ConvertInMapSZ().
6011 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006012void
6013QCBORDecode_Private_GetUInt64ConvertInMapSZ(QCBORDecodeContext *pMe,
6014 const char *szLabel,
6015 const uint32_t uConvertTypes,
6016 uint64_t *puValue,
6017 QCBORItem *pItem)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006018{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07006019 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07006020 if(pMe->uLastError != QCBOR_SUCCESS) {
6021 return;
6022 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006023
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006024 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertUInt64(pItem,
6025 uConvertTypes,
6026 puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006027}
6028
Laurence Lundblade784b54b2020-08-10 01:24:52 -07006029
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006030/**
6031 * @brief Convert many number types to an unt64_t.
6032 *
6033 * @param[in] pItem The item to convert.
6034 * @param[in] uConvertTypes Bit mask list of conversion options.
6035 * @param[out] puValue The resulting converted value.
6036 *
6037 * @retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
6038 * in uConvertTypes.
6039 * @retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
6040 * @retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
6041 * or too small.
6042 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07006043static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006044QCBOR_Private_UInt64ConvertAll(const QCBORItem *pItem,
6045 const uint32_t uConvertTypes,
6046 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006047{
Laurence Lundblade68cb61c2023-02-12 13:21:44 -08006048 switch(pItem->uDataType) { /* -Wmaybe-uninitialized falsly warns here */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006049
6050 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006051 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006052 return QCBOR_Private_ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006053 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006054 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006055 }
6056 break;
6057
6058 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006059 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006060 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
6061 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006062 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006063 }
6064 break;
6065
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006066#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006067
6068 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006069 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006070 return QCBOR_Private_ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07006071 pItem->val.expAndMantissa.nExponent,
6072 puValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006073 QCBOR_Private_Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006074 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006075 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006076 }
6077 break;
6078
6079 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006080 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006081 return QCBOR_Private_ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006082 pItem->val.expAndMantissa.nExponent,
6083 puValue,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006084 QCBOR_Private_Exponentitate2);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006085 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006086 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006087 }
6088 break;
6089
6090 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006091 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07006092 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006093 QCBORError uErr;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006094 uErr = QCBOR_Private_ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006095 if(uErr != QCBOR_SUCCESS) {
6096 return uErr;
6097 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006098 return QCBOR_Private_ExponentitateUU(uMantissa,
6099 pItem->val.expAndMantissa.nExponent,
6100 puValue,
6101 QCBOR_Private_Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006102 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006103 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006104 }
6105 break;
6106
6107 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006108 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006109 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
6110 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006111 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006112 }
6113 break;
6114
6115 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006116 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07006117 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006118 QCBORError uErr;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006119 uErr = QCBOR_Private_ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum,
6120 &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006121 if(uErr != QCBOR_SUCCESS) {
6122 return uErr;
6123 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006124 return QCBOR_Private_ExponentitateUU(uMantissa,
6125 pItem->val.expAndMantissa.nExponent,
6126 puValue,
6127 QCBOR_Private_Exponentitate2);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006128 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006129 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006130 }
6131 break;
6132
6133 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006134 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006135 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
6136 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006137 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006138 }
6139 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006140#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006141 default:
6142 return QCBOR_ERR_UNEXPECTED_TYPE;
6143 }
6144}
6145
Laurence Lundblade784b54b2020-08-10 01:24:52 -07006146
Laurence Lundblade4e2da002020-06-13 23:08:31 -07006147/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006148 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07006149 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006150void
6151QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe,
6152 const uint32_t uConvertTypes,
6153 uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07006154{
6155 QCBORItem Item;
6156
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006157 QCBORDecode_Private_GetUInt64Convert(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07006158
Laurence Lundbladef6c86662020-05-12 02:08:00 -07006159 if(pMe->uLastError == QCBOR_SUCCESS) {
6160 // The above conversion succeeded
6161 return;
6162 }
6163
6164 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
6165 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07006166 return;
6167 }
6168
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006169 pMe->uLastError = (uint8_t)QCBOR_Private_UInt64ConvertAll(&Item,
6170 uConvertTypes,
6171 puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07006172}
6173
Laurence Lundbladec4537442020-04-14 18:53:22 -07006174
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006175/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006176 * Public function, see header qcbor/qcbor_decode.h file
6177 */
6178void
6179QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
6180 const int64_t nLabel,
6181 const uint32_t uConvertTypes,
6182 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006183{
6184 QCBORItem Item;
6185
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006186 QCBORDecode_Private_GetUInt64ConvertInMapN(pMe,
Laurence Lundblade93d89472020-10-03 22:30:50 -07006187 nLabel,
6188 uConvertTypes,
6189 puValue,
6190 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006191
6192 if(pMe->uLastError == QCBOR_SUCCESS) {
6193 // The above conversion succeeded
6194 return;
6195 }
6196
6197 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
6198 // The above conversion failed in a way that code below can't correct
6199 return;
6200 }
6201
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006202 pMe->uLastError = (uint8_t)QCBOR_Private_UInt64ConvertAll(&Item,
6203 uConvertTypes,
6204 puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006205}
6206
6207
6208/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006209 * Public function, see header qcbor/qcbor_decode.h file
6210 */
6211void
6212QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
6213 const char *szLabel,
6214 const uint32_t uConvertTypes,
6215 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006216{
6217 QCBORItem Item;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006218 QCBORDecode_Private_GetUInt64ConvertInMapSZ(pMe,
Laurence Lundblade93d89472020-10-03 22:30:50 -07006219 szLabel,
6220 uConvertTypes,
6221 puValue,
6222 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006223
6224 if(pMe->uLastError == QCBOR_SUCCESS) {
6225 // The above conversion succeeded
6226 return;
6227 }
6228
6229 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
6230 // The above conversion failed in a way that code below can't correct
6231 return;
6232 }
6233
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006234 pMe->uLastError = (uint8_t)QCBOR_Private_UInt64ConvertAll(&Item,
6235 uConvertTypes,
6236 puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006237}
6238
6239
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07006240
6241
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02006242#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006243/**
6244 * @brief Basic conversions to a double.
6245 *
6246 * @param[in] pItem The item to convert
6247 * @param[in] uConvertTypes Bit flags indicating source types for conversion
6248 * @param[out] pdValue The value converted to a double
6249 *
6250 * This does the conversions that don't need much object code,
6251 * the conversions from int, uint and float to double.
6252 *
6253 * See QCBOR_Private_DoubleConvertAll() for the full set
6254 * of conversions.
6255 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006256static QCBORError
6257QCBOR_Private_ConvertDouble(const QCBORItem *pItem,
6258 const uint32_t uConvertTypes,
6259 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006260{
6261 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006262 case QCBOR_TYPE_FLOAT:
6263#ifndef QCBOR_DISABLE_FLOAT_HW_USE
6264 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
6265 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07006266 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006267 *pdValue = (double)pItem->val.fnum;
6268 } else {
6269 return QCBOR_ERR_UNEXPECTED_TYPE;
6270 }
6271 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08006272#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006273 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08006274#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006275 break;
6276
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006277 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006278 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
6279 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006280 *pdValue = pItem->val.dfnum;
6281 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006282 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006283 }
6284 }
6285 break;
6286
6287 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006288#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006289 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07006290 // A simple cast seems to do the job with no worry of exceptions.
6291 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006292 *pdValue = (double)pItem->val.int64;
6293
6294 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006295 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006296 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006297#else
6298 return QCBOR_ERR_HW_FLOAT_DISABLED;
6299#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006300 break;
6301
6302 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006303#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006304 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07006305 // A simple cast seems to do the job with no worry of exceptions.
6306 // There will be precision loss for some values.
6307 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006308 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006309 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006310 }
6311 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006312#else
6313 return QCBOR_ERR_HW_FLOAT_DISABLED;
6314#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006315
Laurence Lundblade2d493002024-02-01 11:09:17 -07006316 case QCBOR_TYPE_65BIT_NEG_INT:
Laurence Lundbladeeb3cdef2024-02-17 20:38:55 -08006317#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade2d493002024-02-01 11:09:17 -07006318 *pdValue = -(double)pItem->val.uint64 - 1;
6319 break;
Laurence Lundbladeeb3cdef2024-02-17 20:38:55 -08006320#else
6321 return QCBOR_ERR_HW_FLOAT_DISABLED;
6322#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade2d493002024-02-01 11:09:17 -07006323
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006324 default:
6325 return QCBOR_ERR_UNEXPECTED_TYPE;
6326 }
6327
6328 return QCBOR_SUCCESS;
6329}
6330
6331
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006332/**
6333 * @brief Almost-public method to decode a number and convert to double (semi-private).
6334 *
6335 * @param[in] pMe The decode context.
6336 * @param[in] uConvertTypes Bit mask list of conversion options
6337 * @param[out] pdValue The output of the conversion.
6338 * @param[in,out] pItem Temporary space to store Item, returned item.
6339 *
6340 * See QCBORDecode_GetDoubleConvert().
6341 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006342void
6343QCBORDecode_Private_GetDoubleConvert(QCBORDecodeContext *pMe,
6344 const uint32_t uConvertTypes,
6345 double *pdValue,
6346 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07006347{
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07006348 QCBORDecode_VGetNext(pMe, pItem);
6349 if(pMe->uLastError) {
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07006350 return;
6351 }
6352
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006353 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertDouble(pItem,
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006354 uConvertTypes,
6355 pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07006356}
Laurence Lundbladec4537442020-04-14 18:53:22 -07006357
Laurence Lundbladec4537442020-04-14 18:53:22 -07006358
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006359/**
6360 * @brief Almost-public method to decode a number and convert to double (semi-private).
6361 *
6362 * @param[in] pMe The decode context.
6363 * @param[in] nLabel Label to find in map.
6364 * @param[in] uConvertTypes Bit mask list of conversion options
6365 * @param[out] pdValue The output of the conversion.
6366 * @param[in,out] pItem Temporary space to store Item, returned item.
6367 *
6368 * See QCBORDecode_GetDoubleConvertInMapN().
6369 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006370void
6371QCBORDecode_Private_GetDoubleConvertInMapN(QCBORDecodeContext *pMe,
6372 const int64_t nLabel,
6373 const uint32_t uConvertTypes,
6374 double *pdValue,
6375 QCBORItem *pItem)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006376{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07006377 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07006378 if(pMe->uLastError != QCBOR_SUCCESS) {
6379 return;
6380 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006381
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006382 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertDouble(pItem,
6383 uConvertTypes,
6384 pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006385}
6386
Laurence Lundblade784b54b2020-08-10 01:24:52 -07006387
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006388/**
6389 * @brief Almost-public method to decode a number and convert to double (semi-private).
6390 *
6391 * @param[in] pMe The decode context.
6392 * @param[in] szLabel Label to find in map.
6393 * @param[in] uConvertTypes Bit mask list of conversion options
6394 * @param[out] pdValue The output of the conversion.
6395 * @param[in,out] pItem Temporary space to store Item, returned item.
6396 *
6397 * See QCBORDecode_GetDoubleConvertInMapSZ().
6398 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006399void
6400QCBORDecode_Private_GetDoubleConvertInMapSZ(QCBORDecodeContext *pMe,
6401 const char *szLabel,
6402 const uint32_t uConvertTypes,
6403 double *pdValue,
6404 QCBORItem *pItem)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006405{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07006406 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07006407 if(pMe->uLastError != QCBOR_SUCCESS) {
6408 return;
6409 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006410
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006411 pMe->uLastError = (uint8_t)QCBOR_Private_ConvertDouble(pItem,
6412 uConvertTypes,
6413 pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006414}
6415
6416
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006417#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006418/**
6419 * @brief Convert a big number to double-precision float.
6420 *
6421 * @param[in] BigNum The big number to convert
6422 *
6423 * @returns The double value.
6424 *
6425 * This will always succeed. It will lose precision for larger
6426 * numbers. If the big number is too large to fit (more than
6427 * 1.7976931348623157E+308) infinity will be returned. NaN is never
6428 * returned.
6429 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006430static double
6431QCBOR_Private_ConvertBigNumToDouble(const UsefulBufC BigNum)
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07006432{
6433 double dResult;
6434
6435 dResult = 0.0;
6436 const uint8_t *pByte = BigNum.ptr;
6437 size_t uLen = BigNum.len;
6438 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006439 * is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07006440 while(uLen--) {
6441 dResult = (dResult * 256.0) + (double)*pByte++;
6442 }
6443
6444 return dResult;
6445}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006446#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
6447
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07006448
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006449
6450
6451/**
6452 * @brief Convert many number types to a double.
6453 *
6454 * @param[in] pItem The item to convert.
6455 * @param[in] uConvertTypes Bit mask list of conversion options.
6456 * @param[out] pdValue The resulting converted value.
6457 *
6458 * @retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
6459 * in uConvertTypes.
6460 * @retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
6461 * @retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
6462 * or too small.
6463 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07006464static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006465QCBOR_Private_DoubleConvertAll(const QCBORItem *pItem,
6466 const uint32_t uConvertTypes,
6467 double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07006468{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006469#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07006470 /*
Laurence Lundblade16a207a2021-09-18 17:22:46 -07006471 * What Every Computer Scientist Should Know About Floating-Point Arithmetic
6472 * https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
6473 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006474 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07006475
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006476#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006477 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006478 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07006479 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006480 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
6481 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
6482 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006483 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006484 }
6485 break;
6486
6487 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006488 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07006489 // Underflow gives 0, overflow gives infinity
6490 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
6491 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006492 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006493 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006494 }
6495 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006496#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006497
6498 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006499 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006500 *pdValue = QCBOR_Private_ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006501 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006502 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006503 }
6504 break;
6505
6506 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006507 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006508 *pdValue = -1-QCBOR_Private_ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006509 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006510 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006511 }
6512 break;
6513
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006514#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006515 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006516 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006517 double dMantissa = QCBOR_Private_ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006518 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
6519 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006520 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006521 }
6522 break;
6523
6524 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006525 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006526 double dMantissa = -QCBOR_Private_ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006527 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
6528 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006529 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006530 }
6531 break;
6532
6533 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006534 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006535 double dMantissa = QCBOR_Private_ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006536 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
6537 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006538 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006539 }
6540 break;
6541
6542 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006543 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006544 double dMantissa = -1-QCBOR_Private_ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006545 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
6546 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07006547 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006548 }
6549 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006550#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07006551
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006552 default:
6553 return QCBOR_ERR_UNEXPECTED_TYPE;
6554 }
6555
6556 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006557
6558#else
6559 (void)pItem;
6560 (void)uConvertTypes;
6561 (void)pdValue;
6562 return QCBOR_ERR_HW_FLOAT_DISABLED;
6563#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
6564
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006565}
6566
6567
6568/*
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006569 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006570 */
6571void
6572QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
6573 const uint32_t uConvertTypes,
6574 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006575{
6576
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07006577 QCBORItem Item;
6578
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006579 QCBORDecode_Private_GetDoubleConvert(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07006580
6581 if(pMe->uLastError == QCBOR_SUCCESS) {
6582 // The above conversion succeeded
6583 return;
6584 }
6585
6586 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
6587 // The above conversion failed in a way that code below can't correct
6588 return;
6589 }
6590
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006591 pMe->uLastError = (uint8_t)QCBOR_Private_DoubleConvertAll(&Item,
6592 uConvertTypes,
6593 pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07006594}
6595
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006596
6597/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006598 * Public function, see header qcbor/qcbor_decode.h file
6599 */
6600void
6601QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
6602 const int64_t nLabel,
6603 const uint32_t uConvertTypes,
6604 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006605{
6606 QCBORItem Item;
6607
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006608 QCBORDecode_Private_GetDoubleConvertInMapN(pMe,
6609 nLabel,
6610 uConvertTypes,
6611 pdValue,
6612 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006613
6614 if(pMe->uLastError == QCBOR_SUCCESS) {
6615 // The above conversion succeeded
6616 return;
6617 }
6618
6619 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
6620 // The above conversion failed in a way that code below can't correct
6621 return;
6622 }
6623
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006624 pMe->uLastError = (uint8_t)QCBOR_Private_DoubleConvertAll(&Item,
6625 uConvertTypes,
6626 pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006627}
6628
6629
6630/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006631 * Public function, see header qcbor/qcbor_decode.h file
6632 */
6633void
6634QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
6635 const char *szLabel,
6636 const uint32_t uConvertTypes,
6637 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006638{
6639 QCBORItem Item;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006640 QCBORDecode_Private_GetDoubleConvertInMapSZ(pMe,
6641 szLabel,
6642 uConvertTypes,
6643 pdValue,
6644 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006645
6646 if(pMe->uLastError == QCBOR_SUCCESS) {
6647 // The above conversion succeeded
6648 return;
6649 }
6650
6651 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
6652 // The above conversion failed in a way that code below can't correct
6653 return;
6654 }
6655
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006656 pMe->uLastError = (uint8_t)QCBOR_Private_DoubleConvertAll(&Item,
6657 uConvertTypes,
6658 pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07006659}
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02006660#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07006661
6662
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006663
6664
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07006665#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006666/**
6667 * @brief Convert an integer to a big number
6668 *
6669 * @param[in] uInt The integer to convert.
6670 * @param[in] Buffer The buffer to output the big number to.
6671 *
6672 * @returns The big number or NULLUsefulBufC is the buffer is to small.
6673 *
6674 * This always succeeds unless the buffer is too small.
6675 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006676static UsefulBufC
6677QCBOR_Private_ConvertIntToBigNum(uint64_t uInt, const UsefulBuf Buffer)
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006678{
6679 while((uInt & 0xff00000000000000UL) == 0) {
6680 uInt = uInt << 8;
6681 };
6682
6683 UsefulOutBuf UOB;
6684
6685 UsefulOutBuf_Init(&UOB, Buffer);
6686
6687 while(uInt) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006688 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
6689 uInt = uInt << 8;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07006690 }
6691
6692 return UsefulOutBuf_OutUBuf(&UOB);
6693}
6694
6695
Laurence Lundblade37286c02022-09-03 10:05:02 -07006696/**
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006697 * @brief Check and/or complete exponent and mantissa item.
Laurence Lundblade37286c02022-09-03 10:05:02 -07006698 *
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006699 * @param[in] pMe The decoder context.
6700 * @param[in] TagSpec Expected type(s).
6701 * @param[in,out] pItem See below.
Laurence Lundblade37286c02022-09-03 10:05:02 -07006702 *
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006703 * This is for decimal fractions and big floats, both of which are an
6704 * exponent and mantissa.
Laurence Lundblade37286c02022-09-03 10:05:02 -07006705 *
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006706 * If the item item had a tag number indicating it was a
6707 * decimal fraction or big float, then the input @c pItem will
6708 * have been decoded as exponent and mantissa. If there was
6709 * no tag number, the caller is asking this be decoded as a
6710 * big float or decimal fraction and @c pItem just has the
6711 * first item in an exponent and mantissa.
Laurence Lundblade37286c02022-09-03 10:05:02 -07006712 *
6713 * On output, the item is always a fully decoded decimal fraction or
6714 * big float.
6715 *
6716 * This errors out if the input type does not meet the TagSpec.
6717 */
Laurence Lundblade37286c02022-09-03 10:05:02 -07006718static QCBORError
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006719QCBOR_Private_ExpMantissaTypeHandler(QCBORDecodeContext *pMe,
6720 const QCBOR_Private_TagSpec TagSpec,
6721 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006722{
6723 QCBORError uErr;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006724
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006725 /* pItem could either be a decoded exponent and mantissa or
6726 * the opening array of an undecoded exponent and mantissa. This
Laurence Lundblade37286c02022-09-03 10:05:02 -07006727 * check will succeed on either, but doesn't say which it was.
6728 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006729 uErr = QCBOR_Private_CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade37286c02022-09-03 10:05:02 -07006730 if(uErr != QCBOR_SUCCESS) {
6731 goto Done;
6732 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006733
Laurence Lundblade37286c02022-09-03 10:05:02 -07006734 if(pItem->uDataType == QCBOR_TYPE_ARRAY) {
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006735 /* The item is an array, which means is is an undecoded exponent
6736 * and mantissa. This call consumes the items in the array and
6737 * results in a decoded exponent and mantissa in pItem. This is
Laurence Lundblade37286c02022-09-03 10:05:02 -07006738 * the case where there was no tag.
6739 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006740 uErr = QCBORDecode_Private_ExpMantissa(pMe, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006741 if(uErr != QCBOR_SUCCESS) {
6742 goto Done;
6743 }
6744
Laurence Lundblade37286c02022-09-03 10:05:02 -07006745 /* The above decode didn't determine whether it is a decimal
6746 * fraction or big num. Which of these two depends on what the
6747 * caller wants it decoded as since there is no tag, so fish the
6748 * type out of the TagSpec. */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006749 pItem->uDataType = QCBOR_Private_ExpMantissaDataType(TagSpec.uTaggedTypes[0], pItem);
Laurence Lundblade37286c02022-09-03 10:05:02 -07006750
6751 /* No need to check the type again. All that we need to know was
Laurence Lundblade23b4ce82024-02-18 21:28:30 -07006752 * that it decoded correctly as a exponent and mantissa. The
Laurence Lundblade37286c02022-09-03 10:05:02 -07006753 * QCBOR type is set out by what was requested.
6754 */
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006755 }
Laurence Lundblade37286c02022-09-03 10:05:02 -07006756
6757 /* If the item was not an array and the check passed, then
6758 * it is a fully decoded big float or decimal fraction and
6759 * matches what is requested.
6760 */
6761
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006762Done:
6763 return uErr;
6764}
6765
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006766
Laurence Lundblade37286c02022-09-03 10:05:02 -07006767/* Some notes from the work to disable tags.
6768 *
6769 * The API for big floats and decimal fractions seems good.
6770 * If there's any issue with it it's that the code size to
6771 * implement is a bit large because of the conversion
6772 * to/from int and bignum that is required. There is no API
6773 * that doesn't do the conversion so dead stripping will never
6774 * leave that code out.
6775 *
6776 * The implementation itself seems correct, but not as clean
6777 * and neat as it could be. It could probably be smaller too.
6778 *
6779 * The implementation has three main parts / functions
6780 * - The decoding of the array of two
6781 * - All the tag and type checking for the various API functions
6782 * - Conversion to/from bignum and int
6783 *
6784 * The type checking seems like it wastes the most code for
6785 * what it needs to do.
6786 *
6787 * The inlining for the conversion is probably making the
6788 * overall code base larger.
6789 *
6790 * The tests cases could be organized a lot better and be
6791 * more thorough.
6792 *
6793 * Seems also like there could be more common code in the
6794 * first tier part of the public API. Some functions only
6795 * vary by a TagSpec.
6796 */
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006797
6798/**
6799 * @brief Common processor for exponent and mantissa.
6800 *
6801 * @param[in] pMe The decode context.
6802 * @param[in] TagSpec The expected/allowed tags.
6803 * @param[in] pItem The data item to process.
6804 * @param[out] pnMantissa The returned mantissa as an int64_t.
6805 * @param[out] pnExponent The returned exponent as an int64_t.
6806 *
6807 * This handles exponent and mantissa for base 2 and 10. This
6808 * is limited to a mantissa that is an int64_t. See also
6809 * QCBORDecode_Private_ProcessExpMantissaBig().
6810 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006811static void
6812QCBOR_Private_ProcessExpMantissa(QCBORDecodeContext *pMe,
6813 const QCBOR_Private_TagSpec TagSpec,
6814 QCBORItem *pItem,
6815 int64_t *pnMantissa,
6816 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07006817{
6818 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006819
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07006820 if(pMe->uLastError) {
6821 return;
6822 }
6823
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006824 uErr = QCBOR_Private_ExpMantissaTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006825 if(uErr != QCBOR_SUCCESS) {
6826 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07006827 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07006828
Laurence Lundblade9b334962020-08-27 10:55:53 -07006829 switch (pItem->uDataType) {
6830
6831 case QCBOR_TYPE_DECIMAL_FRACTION:
6832 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade9b334962020-08-27 10:55:53 -07006833 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade37286c02022-09-03 10:05:02 -07006834 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
Laurence Lundblade9b334962020-08-27 10:55:53 -07006835 break;
6836
Laurence Lundblade37286c02022-09-03 10:05:02 -07006837#ifndef QCBOR_DISABLE_TAGS
6838 /* If tags are disabled, mantissas can never be big nums */
Laurence Lundblade9b334962020-08-27 10:55:53 -07006839 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
6840 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
6841 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006842 uErr = QCBOR_Private_ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
Laurence Lundblade9b334962020-08-27 10:55:53 -07006843 break;
6844
6845 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
6846 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
6847 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006848 uErr = QCBOR_Private_ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
Laurence Lundblade9b334962020-08-27 10:55:53 -07006849 break;
Laurence Lundblade37286c02022-09-03 10:05:02 -07006850#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundblade9b334962020-08-27 10:55:53 -07006851
6852 default:
6853 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
6854 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006855
6856 Done:
6857 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07006858}
6859
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006860
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006861/**
6862 * @brief Decode exponent and mantissa into a big number.
6863 *
6864 * @param[in] pMe The decode context.
6865 * @param[in] TagSpec The expected/allowed tags.
6866 * @param[in] pItem Item to decode and convert.
6867 * @param[in] BufferForMantissa Buffer to output mantissa into.
6868 * @param[out] pMantissa The output mantissa.
6869 * @param[out] pbIsNegative The sign of the output.
6870 * @param[out] pnExponent The mantissa of the output.
6871 *
6872 * This is the common processing of a decimal fraction or a big float
6873 * into a big number. This will decode and consume all the CBOR items
6874 * that make up the decimal fraction or big float.
6875 */
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006876static void
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07006877QCBORDecode_Private_ProcessExpMantissaBig(QCBORDecodeContext *pMe,
6878 const QCBOR_Private_TagSpec TagSpec,
6879 QCBORItem *pItem,
6880 const UsefulBuf BufferForMantissa,
6881 UsefulBufC *pMantissa,
6882 bool *pbIsNegative,
6883 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006884{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006885 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006886
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07006887 if(pMe->uLastError != QCBOR_SUCCESS) {
6888 return;
6889 }
6890
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006891 uErr = QCBOR_Private_ExpMantissaTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006892 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006893 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006894 }
6895
6896 uint64_t uMantissa;
6897
6898 switch (pItem->uDataType) {
6899
6900 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006901 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07006902 /* See comments in ExponentiateNN() on handling INT64_MIN */
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006903 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
6904 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
6905 *pbIsNegative = false;
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07006906 } else if(pItem->val.expAndMantissa.Mantissa.nInt != INT64_MIN) {
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006907 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
6908 *pbIsNegative = true;
Laurence Lundblade4e808ba2022-12-29 12:45:20 -07006909 } else {
6910 uMantissa = (uint64_t)INT64_MAX+1;
6911 *pbIsNegative = true;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006912 }
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006913 *pMantissa = QCBOR_Private_ConvertIntToBigNum(uMantissa,
6914 BufferForMantissa);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006915 *pnExponent = pItem->val.expAndMantissa.nExponent;
6916 break;
6917
Laurence Lundblade37286c02022-09-03 10:05:02 -07006918#ifndef QCBOR_DISABLE_TAGS
6919 /* If tags are disabled, mantissas can never be big nums */
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006920 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006921 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006922 *pnExponent = pItem->val.expAndMantissa.nExponent;
6923 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
6924 *pbIsNegative = false;
6925 break;
6926
6927 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006928 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006929 *pnExponent = pItem->val.expAndMantissa.nExponent;
6930 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
6931 *pbIsNegative = true;
6932 break;
Laurence Lundblade37286c02022-09-03 10:05:02 -07006933#endif /* QCBOR_DISABLE_TAGS */
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006934
6935 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006936 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006937 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006938
6939Done:
6940 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006941}
6942
6943
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006944/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006945 * Public function, see header qcbor/qcbor_decode.h file
6946 */
6947void
6948QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
6949 const uint8_t uTagRequirement,
6950 int64_t *pnMantissa,
6951 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006952{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006953 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07006954 QCBORDecode_VGetNext(pMe, &Item);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006955
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006956 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006957 {
6958 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07006959 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
6960 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
6961 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006962 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07006963
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006964 QCBOR_Private_ProcessExpMantissa(pMe,
6965 TagSpec,
6966 &Item,
6967 pnMantissa,
6968 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07006969}
6970
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006971
6972/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006973 * Public function, see header qcbor/qcbor_decode.h file
6974 */
6975void
6976QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
6977 const int64_t nLabel,
6978 const uint8_t uTagRequirement,
6979 int64_t *pnMantissa,
6980 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006981{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006982 QCBORItem Item;
6983 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
6984
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006985 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006986 {
6987 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07006988 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
6989 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
6990 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006991 };
6992
Laurence Lundblade8e36f812024-01-26 10:59:29 -07006993 QCBOR_Private_ProcessExpMantissa(pMe,
6994 TagSpec,
6995 &Item,
6996 pnMantissa,
6997 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07006998}
6999
7000
7001/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007002 * Public function, see header qcbor/qcbor_decode.h file
7003 */
7004void
7005QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
7006 const char *szLabel,
7007 const uint8_t uTagRequirement,
7008 int64_t *pnMantissa,
7009 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007010{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007011 QCBORItem Item;
7012 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
7013
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007014 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007015 {
7016 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007017 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
7018 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
7019 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007020 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07007021
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007022 QCBOR_Private_ProcessExpMantissa(pMe,
7023 TagSpec,
7024 &Item,
7025 pnMantissa,
7026 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007027}
7028
7029
7030/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007031 * Public function, see header qcbor/qcbor_decode.h file
7032 */
7033void
7034QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
7035 const uint8_t uTagRequirement,
7036 const UsefulBuf MantissaBuffer,
7037 UsefulBufC *pMantissa,
7038 bool *pbMantissaIsNegative,
7039 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007040{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007041 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07007042 QCBORDecode_VGetNext(pMe, &Item);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007043
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007044 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007045 {
7046 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007047 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
7048 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
7049 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007050 };
7051
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07007052 QCBORDecode_Private_ProcessExpMantissaBig(pMe,
7053 TagSpec,
7054 &Item,
7055 MantissaBuffer,
7056 pMantissa,
7057 pbMantissaIsNegative,
7058 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007059}
7060
7061
7062/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007063 * Public function, see header qcbor/qcbor_decode.h file
7064 */
7065void
7066QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
7067 const int64_t nLabel,
7068 const uint8_t uTagRequirement,
7069 const UsefulBuf BufferForMantissa,
7070 UsefulBufC *pMantissa,
7071 bool *pbIsNegative,
7072 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07007073{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07007074
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007075 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07007076 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07007077
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007078 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007079 {
7080 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007081 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
7082 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
7083 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007084 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007085
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07007086 QCBORDecode_Private_ProcessExpMantissaBig(pMe,
7087 TagSpec,
7088 &Item,
7089 BufferForMantissa,
7090 pMantissa,
7091 pbIsNegative,
7092 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07007093}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07007094
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07007095
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007096/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007097 * Public function, see header qcbor/qcbor_decode.h file
7098 */
7099void
7100QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
7101 const char *szLabel,
7102 const uint8_t uTagRequirement,
7103 const UsefulBuf BufferForMantissa,
7104 UsefulBufC *pMantissa,
7105 bool *pbIsNegative,
7106 int64_t *pnExponent)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007107{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007108 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007109 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007110
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007111 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007112 {
7113 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007114 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
7115 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
7116 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007117 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007118
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07007119 QCBORDecode_Private_ProcessExpMantissaBig(pMe,
7120 TagSpec,
7121 &Item,
7122 BufferForMantissa,
7123 pMantissa,
7124 pbIsNegative,
7125 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007126}
7127
7128
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007129/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007130 * Public function, see header qcbor/qcbor_decode.h file
7131 */
7132void
7133QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
7134 const uint8_t uTagRequirement,
7135 int64_t *pnMantissa,
7136 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007137{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007138 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07007139 QCBORDecode_VGetNext(pMe, &Item);
7140
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007141 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007142 {
7143 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007144 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
7145 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
7146 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007147 };
7148
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007149 QCBOR_Private_ProcessExpMantissa(pMe,
7150 TagSpec,
7151 &Item,
7152 pnMantissa,
7153 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007154}
7155
7156
7157/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007158 * Public function, see header qcbor/qcbor_decode.h file
7159 */
7160void
7161QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
7162 const int64_t nLabel,
7163 const uint8_t uTagRequirement,
7164 int64_t *pnMantissa,
7165 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007166{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007167 QCBORItem Item;
7168 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007169
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007170 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007171 {
7172 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007173 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
7174 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
7175 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007176 };
7177
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007178 QCBOR_Private_ProcessExpMantissa(pMe,
7179 TagSpec,
7180 &Item,
7181 pnMantissa,
7182 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007183}
7184
7185
7186/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007187 * Public function, see header qcbor/qcbor_decode.h file
7188 */
7189void
7190QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
7191 const char *szLabel,
7192 const uint8_t uTagRequirement,
7193 int64_t *pnMantissa,
7194 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007195{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007196 QCBORItem Item;
7197 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007198
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007199 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007200 {
7201 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007202 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
7203 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
7204 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007205 };
7206
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007207 QCBOR_Private_ProcessExpMantissa(pMe,
7208 TagSpec,
7209 &Item,
7210 pnMantissa,
7211 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007212}
7213
7214
7215/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007216 * Public function, see header qcbor/qcbor_decode.h file
7217 */
7218void
7219QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
7220 const uint8_t uTagRequirement,
7221 const UsefulBuf MantissaBuffer,
7222 UsefulBufC *pMantissa,
7223 bool *pbMantissaIsNegative,
7224 int64_t *pnExponent)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007225{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007226 QCBORItem Item;
Laurence Lundbladecdbbc192024-06-28 15:13:04 -07007227 QCBORDecode_VGetNext(pMe, &Item);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007228
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007229 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007230 {
7231 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007232 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
7233 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
7234 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007235 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007236
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07007237 QCBORDecode_Private_ProcessExpMantissaBig(pMe,
7238 TagSpec,
7239 &Item,
7240 MantissaBuffer,
7241 pMantissa,
7242 pbMantissaIsNegative,
7243 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007244}
7245
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007246
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007247/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007248 * Public function, see header qcbor/qcbor_decode.h file
7249 */
7250void
7251QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
7252 const int64_t nLabel,
7253 const uint8_t uTagRequirement,
7254 const UsefulBuf BufferForMantissa,
7255 UsefulBufC *pMantissa,
7256 bool *pbIsNegative,
7257 int64_t *pnExponent)
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007258{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007259 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007260 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007261
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007262 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007263 {
7264 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007265 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
7266 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
7267 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007268 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007269
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07007270 QCBORDecode_Private_ProcessExpMantissaBig(pMe,
7271 TagSpec,
7272 &Item,
7273 BufferForMantissa,
7274 pMantissa,
7275 pbIsNegative,
7276 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007277}
7278
7279
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007280/*
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007281 * Public function, see header qcbor/qcbor_decode.h file
7282 */
7283void
7284QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
7285 const char *szLabel,
7286 const uint8_t uTagRequirement,
7287 const UsefulBuf BufferForMantissa,
7288 UsefulBufC *pMantissa,
7289 bool *pbIsNegative,
7290 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07007291{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007292 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07007293 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07007294
Laurence Lundblade8e36f812024-01-26 10:59:29 -07007295 const QCBOR_Private_TagSpec TagSpec =
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007296 {
7297 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07007298 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
7299 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
7300 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07007301 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07007302
Laurence Lundblade4ae4ef92024-02-05 19:21:31 -07007303 QCBORDecode_Private_ProcessExpMantissaBig(pMe,
7304 TagSpec,
7305 &Item,
7306 BufferForMantissa,
7307 pMantissa,
7308 pbIsNegative,
7309 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07007310}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07007311
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07007312#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladed883ad32024-03-23 22:37:37 -07007313
7314
7315#if !defined(USEFULBUF_DISABLE_ALL_FLOAT) && !defined(QCBOR_DISABLE_PREFERRED_FLOAT)
7316/*
7317 * Public function, see header qcbor/qcbor_spiffy_decode.h file
7318 */
7319void
7320QCBORDecode_GetNumberConvertPrecisely(QCBORDecodeContext *pMe,
7321 QCBORItem *pNumber)
7322{
7323 QCBORItem Item;
7324 struct IEEE754_ToInt ToInt;
7325 double d;
7326 QCBORError uError;
7327
7328 if(pMe->uLastError != QCBOR_SUCCESS) {
7329 return;
7330 }
7331
7332 uError = QCBORDecode_GetNext(pMe, &Item);
7333 if(uError != QCBOR_SUCCESS) {
7334 pMe->uLastError = (uint8_t)uError;
7335 return;
7336 }
7337
7338 switch(Item.uDataType) {
7339 case QCBOR_TYPE_INT64:
7340 case QCBOR_TYPE_UINT64:
7341 *pNumber = Item;
7342 break;
7343
7344 case QCBOR_TYPE_DOUBLE:
7345 ToInt = IEEE754_DoubleToInt(Item.val.dfnum);
7346 if(ToInt.type == IEEE754_ToInt_IS_INT) {
7347 pNumber->uDataType = QCBOR_TYPE_INT64;
7348 pNumber->val.int64 = ToInt.integer.is_signed;
7349 } else if(ToInt.type == IEEE754_ToInt_IS_UINT) {
7350 if(ToInt.integer.un_signed <= INT64_MAX) {
7351 /* Do the same as base QCBOR integer decoding */
7352 pNumber->uDataType = QCBOR_TYPE_INT64;
7353 pNumber->val.int64 = (int64_t)ToInt.integer.un_signed;
7354 } else {
7355 pNumber->uDataType = QCBOR_TYPE_UINT64;
7356 pNumber->val.uint64 = ToInt.integer.un_signed;
7357 }
7358 } else {
7359 *pNumber = Item;
7360 }
7361 break;
7362
7363 case QCBOR_TYPE_FLOAT:
7364 ToInt = IEEE754_SingleToInt(Item.val.fnum);
7365 if(ToInt.type == IEEE754_ToInt_IS_INT) {
7366 pNumber->uDataType = QCBOR_TYPE_INT64;
7367 pNumber->val.int64 = ToInt.integer.is_signed;
7368 } else if(ToInt.type == IEEE754_ToInt_IS_UINT) {
7369 if(ToInt.integer.un_signed <= INT64_MAX) {
7370 /* Do the same as base QCBOR integer decoding */
7371 pNumber->uDataType = QCBOR_TYPE_INT64;
7372 pNumber->val.int64 = (int64_t)ToInt.integer.un_signed;
7373 } else {
7374 pNumber->uDataType = QCBOR_TYPE_UINT64;
7375 pNumber->val.uint64 = ToInt.integer.un_signed;
7376 }
7377 } else {
7378 *pNumber = Item;
7379 }
7380 break;
7381
7382
7383 case QCBOR_TYPE_65BIT_NEG_INT:
7384 d = IEEE754_UintToDouble(Item.val.uint64, 1);
7385 if(d == IEEE754_UINT_TO_DOUBLE_OOB) {
7386 *pNumber = Item;
7387 } else {
7388 pNumber->uDataType = QCBOR_TYPE_DOUBLE;
7389 /* -1 is because of CBOR offset of negative numbers */
7390 pNumber->val.dfnum = d - 1;
7391 }
7392 break;
7393
7394 default:
7395 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
7396 pNumber->uDataType = QCBOR_TYPE_NONE;
7397 break;
7398 }
7399}
7400
7401#endif /* ! USEFULBUF_DISABLE_ALL_FLOAT && ! QCBOR_DISABLE_PREFERRED_FLOAT */