blob: e03ebef38da622a2554b9615d5dbd94ef1115337 [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundbladeee851742020-01-08 08:37:05 -08003 Copyright (c) 2018-2020, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade12d32c52018-09-19 11:25:27 -070036#include "ieee754.h"
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070037
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070038
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053039/*
40 This casts away the const-ness of a pointer, usually so it can be
41 freed or realloced.
42 */
43#define UNCONST_POINTER(ptr) ((void *)(ptr))
44
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070045
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070046
Laurence Lundblade02625d42020-06-25 14:41:41 -070047inline static bool
48// TODO: add more tests for QCBOR_TYPE_MAP_AS_ARRAY mode in qcbor_decode_tests.c
49QCBORItem_IsMapOrArray(const QCBORItem *pMe)
50{
51 const uint8_t uDataType = pMe->uDataType;
52 return uDataType == QCBOR_TYPE_MAP ||
53 uDataType == QCBOR_TYPE_ARRAY ||
54 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
55}
56
57inline static bool
58QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
59{
60 if(!QCBORItem_IsMapOrArray(pMe)){
61 return false;
62 }
63
64 if(pMe->val.uCount != 0) {
65 return false;
66 }
67 return true;
68}
69
70inline static bool
71QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
72{
73 if(!QCBORItem_IsMapOrArray(pMe)){
74 return false;
75 }
76
77 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
78 return false;
79 }
80 return true;
81}
82
83
Laurence Lundbladeee851742020-01-08 08:37:05 -080084/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070085 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080086 ===========================================================================*/
87
Laurence Lundblade9c905e82020-04-25 11:31:38 -070088/*
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070089 See commecnts about and typedef of QCBORDecodeNesting in qcbor_private.h, the data structure
90 all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -070091
Laurence Lundblade9c905e82020-04-25 11:31:38 -070092
Laurence Lundblade9c905e82020-04-25 11:31:38 -070093
Laurence Lundblade9c905e82020-04-25 11:31:38 -070094 */
95
Laurence Lundblade24d509a2020-06-06 18:43:15 -070096
97inline static uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -070098DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -070099{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700100 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700101 /*
102 Limit in DecodeNesting_Descend against more than
103 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
104 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700105 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700106}
107
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700108
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700109inline static uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700110DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700111{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700112 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700113 /*
114 Limit in DecodeNesting_Descend against more than
115 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
116 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700117 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700118}
119
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700120
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700121static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700122DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700123{
124 return pNesting->pCurrentBounded->u.ma.uStartOffset;
125}
126
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700127
Laurence Lundblade085d7952020-07-24 10:26:30 -0700128static inline bool
129DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
130{
131 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
132 return true;
133 } else {
134 return false;
135 }
136}
137
138
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700139inline static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700140DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700141{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700142 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700143 return true;
144 } else {
145 return false;
146 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700147}
148
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700149
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700150inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700151DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700152{
153 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700154 // Not a map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700155 return false;
156 }
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700157 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700158 // Is indefinite
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700159 return false;
160 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700161 // All checks passed; is a definte length map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700162 return true;
163}
164
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700165
Laurence Lundblade642282a2020-06-23 12:00:33 -0700166inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700167DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700168{
169 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700170 // is a byte string
Laurence Lundblade642282a2020-06-23 12:00:33 -0700171 return true;
172 }
173 return false;
174}
175
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700176
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700177inline static bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700178{
179 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
180 return true;
181 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700182 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700183 return true;
184 }
185 return false;
186}
187
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700188
Laurence Lundblade085d7952020-07-24 10:26:30 -0700189inline static void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700190{
191 // Should be only called on maps and arrays
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700192 /*
193 DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
194 larger than DecodeNesting_EnterBoundedMode which keeps it less than
195 uin32_t so the cast is safe.
196 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700197 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700198
199 if(bIsEmpty) {
200 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
201 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700202}
203
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700204
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700205inline static void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700206{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700207 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700208}
209
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700210
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700211inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700212DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700213{
214 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700215 // No bounded map or array or... set up
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700216 return false;
217 }
218 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700219 // Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700220 return false;
221 }
222 if(!DecodeNesting_IsCurrentBounded(pNesting)) { // TODO: pCurrent vs pCurrentBounded
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700223 // Not at a bounded level
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700224 return false;
225 }
Laurence Lundbladed0304932020-06-27 10:59:38 -0700226 // Works for both definite and indefinite length maps/arrays
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700227 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700228 // Count is not zero, still unconsumed item
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700229 return false;
230 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700231 // All checks passed, got to the end of a map/array
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700232 return true;
233}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700234
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700235
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700236inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700237DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700238{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700239 // Must only be called on map / array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700240 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
241 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700242 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700243 return false;
244 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700245}
246
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700247
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700248inline static bool
249DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700250{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700251 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
252 return true;
253 } else {
254 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700255 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700256}
257
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700258
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700259inline static bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700260DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700261{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700262 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700263 return false;
264 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700265
266 if(pNesting->pCurrentBounded->uLevelType != uType) {
267 return false;
268 }
269
270 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700271}
272
Laurence Lundblade02625d42020-06-25 14:41:41 -0700273
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700274inline static void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700275DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700276{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700277 // Only call on a defnite length array / map
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700278 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700279}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700280
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700281
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700282inline static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700283DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
284{
285 // Only call on a defnite length array / map
286 pNesting->pCurrent->u.ma.uCountCursor++;
287}
288
289
290inline static void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700291DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
292{
293 pNesting->pCurrent--;
294}
295
Laurence Lundblade02625d42020-06-25 14:41:41 -0700296
297static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700298DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700299{
300 // Error out if nesting is too deep
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700301 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700302 return QCBOR_ERR_ARRAY_NESTING_TOO_DEEP;
303 }
304
305 // The actual descend
306 pNesting->pCurrent++;
307
308 pNesting->pCurrent->uLevelType = uType;
309
310 return QCBOR_SUCCESS;
311}
312
313
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700314inline static QCBORError
Laurence Lundblade085d7952020-07-24 10:26:30 -0700315DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700316{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700317 /*
318 Should only be called on map/array.
319
320 Have descended into this before this is called. The job here is
321 just to mark it in bounded mode.
322 */
Laurence Lundblade085d7952020-07-24 10:26:30 -0700323 if(uOffset >= QCBOR_NON_BOUNDED_OFFSET) { //TODO: fix this bounds check
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700324 return QCBOR_ERR_BUFFER_TOO_LARGE;
325 }
326
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700327 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700328
329 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700330
331 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700332}
333
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700334
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700335inline static QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700336DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700337 uint8_t uQCBORType,
338 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700339{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700340 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700341
342 if(uCount == 0) {
343 // Nothing to do for empty definite lenth arrays. They are just are
344 // effectively the same as an item that is not a map or array
345 goto Done;
346 // Empty indefinite length maps and arrays are handled elsewhere
347 }
348
349 // Error out if arrays is too long to handle
Laurence Lundblade02625d42020-06-25 14:41:41 -0700350 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
351 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
352 uError = QCBOR_ERR_ARRAY_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700353 goto Done;
354 }
355
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700356 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700357 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700358 goto Done;
359 }
360
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700361 // Fill in the new map/array level. Check above makes casts OK.
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700362 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
363 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700364
365 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700366
367Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700368 return uError;;
369}
370
371
372static inline void
373DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
374{
375 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
376}
377
378
379static inline void
380DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
381{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700382 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700383 pNesting->pCurrentBounded--;
384 if(DecodeNesting_IsCurrentBounded(pNesting)) {
385 break;
386 }
387 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700388}
389
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700390static inline void
391DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
392{
393 pNesting->pCurrent = pNesting->pCurrentBounded;
394}
395
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700396
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700397inline static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700398DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
399 size_t uEndOffset,
400 size_t uEndOfBstr)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700401{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700402 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700403
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700404 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700405 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700406 goto Done;
407 }
408
Laurence Lundblade02625d42020-06-25 14:41:41 -0700409 // Fill in the new byte string level
410 // TODO: justify cast
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700411 pNesting->pCurrent->u.bs.uPreviousEndOffset = (uint32_t)uEndOffset;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700412 pNesting->pCurrent->u.bs.uEndOfBstr = (uint32_t)uEndOfBstr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700413
Laurence Lundblade02625d42020-06-25 14:41:41 -0700414 // Bstr wrapped levels are always bounded
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700415 pNesting->pCurrentBounded = pNesting->pCurrent;
416
417Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700418 return uError;;
419}
420
Laurence Lundbladed0304932020-06-27 10:59:38 -0700421
422static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700423DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700424{
425 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700426}
427
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700428
Laurence Lundbladeee851742020-01-08 08:37:05 -0800429inline static void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700430DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700431{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700432 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700433 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
434 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700435}
436
437
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700438inline static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700439DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting, QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700440{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700441 *pSave = *pNesting;
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700442 pNesting->pCurrent = pNesting->pCurrentBounded;
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700443 pNesting->pCurrent->u.ma.uCountCursor = pNesting->pCurrent->u.ma.uCountTotal;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700444}
445
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700446
Laurence Lundblade02625d42020-06-25 14:41:41 -0700447static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700448DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting, const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700449{
450 *pNesting = *pSave;
451}
452
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700453
Laurence Lundblade02625d42020-06-25 14:41:41 -0700454static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700455DecodeNesting_GetEndOfBstr(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700456{
457 return pMe->pCurrentBounded->u.bs.uEndOfBstr;
458}
459
460
Laurence Lundblade02625d42020-06-25 14:41:41 -0700461static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700462DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700463{
464 return pMe->pCurrentBounded->u.bs.uPreviousEndOffset;
465}
466
467
Laurence Lundblade02625d42020-06-25 14:41:41 -0700468#include <stdio.h>
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700469
470const char *TypeStr(uint8_t type)
471{
472 switch(type) {
473 case QCBOR_TYPE_MAP: return " map";
474 case QCBOR_TYPE_ARRAY: return "array";
475 case QCBOR_TYPE_BYTE_STRING: return " bstr";
476 default: return " --- ";
477 }
478}
479
480static char buf[20]; // Not thread safe, but that is OK
481const char *CountString(uint16_t uCount, uint16_t uTotal)
482{
483 if(uTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
484 strcpy(buf, "indefinite");
485 } else {
486 sprintf(buf, "%d/%d", uCount, uTotal);
487 }
488 return buf;
489}
490
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700491
Laurence Lundblade02625d42020-06-25 14:41:41 -0700492void DecodeNesting_Print(QCBORDecodeNesting *pNesting, UsefulInputBuf *pBuf, const char *szName)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700493{
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700494#if 0
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700495 printf("---%s--%d/%d--\narrow is current bounded level\n",
Laurence Lundblade02625d42020-06-25 14:41:41 -0700496 szName,
497 (uint32_t)pBuf->cursor,
498 (uint32_t)pBuf->UB.len);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700499
500 printf("Level Type Count Offsets \n");
Laurence Lundblade02625d42020-06-25 14:41:41 -0700501 for(int i = 0; i < QCBOR_MAX_ARRAY_NESTING; i++) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700502 if(&(pNesting->pLevels[i]) > pNesting->pCurrent) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700503 break;
504 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700505
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700506 printf("%2s %2d %s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700507 pNesting->pCurrentBounded == &(pNesting->pLevels[i]) ? "->": " ",
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700508 i,
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700509 TypeStr(pNesting->pLevels[i].uLevelType));
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700510
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700511 if(pNesting->pLevels[i].uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700512 printf(" %5d %5d",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700513 pNesting->pLevels[i].u.bs.uEndOfBstr,
514 pNesting->pLevels[i].u.bs.uPreviousEndOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700515
516 } else {
517 printf("%10.10s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700518 CountString(pNesting->pLevels[i].u.ma.uCountCursor,
519 pNesting->pLevels[i].u.ma.uCountTotal));
520 if(pNesting->pLevels[i].u.ma.uStartOffset != UINT32_MAX) {
521 printf("Bounded start: %u",pNesting->pLevels[i].u.ma.uStartOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700522 }
523 }
524
525 printf("\n");
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700526 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700527 printf("\n");
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700528#endif
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700529}
530
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700531
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700532
Laurence Lundbladeee851742020-01-08 08:37:05 -0800533/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800534 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
535
536 The following four functions are pretty wrappers for invocation of
537 the string allocator supplied by the caller.
538
Laurence Lundbladeee851742020-01-08 08:37:05 -0800539 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800540
Laurence Lundbladeee851742020-01-08 08:37:05 -0800541static inline void
542StringAllocator_Free(const QCORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543{
544 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
545}
546
Laurence Lundbladeee851742020-01-08 08:37:05 -0800547// StringAllocator_Reallocate called with pMem NULL is
548// equal to StringAllocator_Allocate()
549static inline UsefulBuf
550StringAllocator_Reallocate(const QCORInternalAllocator *pMe,
551 void *pMem,
552 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800553{
554 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
555}
556
Laurence Lundbladeee851742020-01-08 08:37:05 -0800557static inline UsefulBuf
558StringAllocator_Allocate(const QCORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800559{
560 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
561}
562
Laurence Lundbladeee851742020-01-08 08:37:05 -0800563static inline void
564StringAllocator_Destruct(const QCORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800565{
566 if(pMe->pfAllocator) {
567 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
568 }
569}
570
571
572
Laurence Lundbladeee851742020-01-08 08:37:05 -0800573/*===========================================================================
574 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700575
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800576 See qcbor/qcbor_decode.h for definition of the object
577 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800578 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700579/*
580 Public function, see header file
581 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800582void QCBORDecode_Init(QCBORDecodeContext *me,
583 UsefulBufC EncodedCBOR,
584 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700585{
586 memset(me, 0, sizeof(QCBORDecodeContext));
587 UsefulInputBuf_Init(&(me->InBuf), EncodedCBOR);
Laurence Lundbladeee851742020-01-08 08:37:05 -0800588 // Don't bother with error check on decode mode. If a bad value is
589 // passed it will just act as if the default normal mode of 0 was set.
Laurence Lundbladee6bcef12020-04-01 10:56:27 -0700590 me->uDecodeMode = (uint8_t)nDecodeMode;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700591 DecodeNesting_Init(&(me->nesting));
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700592 for(int i = 0; i < QCBOR_NUM_MAPPED_TAGS; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -0700593 me->auMappedTags[i] = CBOR_TAG_INVALID16;
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700594 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700595}
596
597
598/*
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700599 Public function, see header file
600 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800601void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
602 QCBORStringAllocate pfAllocateFunction,
603 void *pAllocateContext,
604 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700605{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800606 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
607 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
608 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700609}
610
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800611
612/*
613 Public function, see header file
614 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700615void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800616 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700617{
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700618 // This does nothing now. It is retained for backwards compatibility
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700619 (void)pMe;
620 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700621}
622
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700623
624/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800625 This decodes the fundamental part of a CBOR data item, the type and
626 number
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800627
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700628 This is the Counterpart to InsertEncodedTypeAndNumber().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800629
Laurence Lundbladeee851742020-01-08 08:37:05 -0800630 This does the network->host byte order conversion. The conversion
631 here also results in the conversion for floats in addition to that
632 for lengths, tags and integer values.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800633
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700634 This returns:
635 pnMajorType -- the major type for the item
Laurence Lundbladeee851742020-01-08 08:37:05 -0800636
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800637 puArgument -- the "number" which is used a the value for integers,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800638 tags and floats and length for strings and arrays
639
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800640 pnAdditionalInfo -- Pass this along to know what kind of float or
Laurence Lundbladeee851742020-01-08 08:37:05 -0800641 if length is indefinite
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800642
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800643 The int type is preferred to uint8_t for some variables as this
644 avoids integer promotions, can reduce code size and makes
645 static analyzers happier.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700646 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800647inline static QCBORError DecodeTypeAndNumber(UsefulInputBuf *pUInBuf,
648 int *pnMajorType,
649 uint64_t *puArgument,
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800650 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700651{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700652 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800653
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700654 // Get the initial byte that every CBOR data item has
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800655 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800656
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700657 // Break down the initial byte
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800658 const int nTmpMajorType = nInitialByte >> 5;
659 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800660
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800661 // Where the number or argument accumulates
662 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800663
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800664 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700665 // Need to get 1,2,4 or 8 additional argument bytes. Map
666 // LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800667 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800668
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800669 // Loop getting all the bytes in the argument
670 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800671 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800672 // This shift and add gives the endian conversion
673 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
674 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800675 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800676 // The reserved and thus-far unused additional info values
677 nReturn = QCBOR_ERR_UNSUPPORTED;
678 goto Done;
679 } else {
680 // Less than 24, additional info is argument or 31, an indefinite length
681 // No more bytes to get
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800682 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700683 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800684
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700685 if(UsefulInputBuf_GetError(pUInBuf)) {
686 nReturn = QCBOR_ERR_HIT_END;
687 goto Done;
688 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800689
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700690 // All successful if we got here.
691 nReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800692 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800693 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800694 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800695
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700696Done:
697 return nReturn;
698}
699
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800700
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700701/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800702 CBOR doesn't explicitly specify two's compliment for integers but all
703 CPUs use it these days and the test vectors in the RFC are so. All
704 integers in the CBOR structure are positive and the major type
705 indicates positive or negative. CBOR can express positive integers
706 up to 2^x - 1 where x is the number of bits and negative integers
707 down to 2^x. Note that negative numbers can be one more away from
708 zero than positive. Stdint, as far as I can tell, uses two's
709 compliment to represent negative integers.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800710
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700711 See http://www.unix.org/whitepapers/64bit.html for reasons int isn't
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800712 used carefully here, and in particular why it isn't used in the interface.
713 Also see
714 https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
715
716 Int is used for values that need less than 16-bits and would be subject
717 to integer promotion and complaining by static analyzers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700718 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800719inline static QCBORError
720DecodeInteger(int nMajorType, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700721{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700722 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800723
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700724 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
725 if (uNumber <= INT64_MAX) {
726 pDecodedItem->val.int64 = (int64_t)uNumber;
727 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800728
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700729 } else {
730 pDecodedItem->val.uint64 = uNumber;
731 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800732
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700733 }
734 } else {
735 if(uNumber <= INT64_MAX) {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800736 // CBOR's representation of negative numbers lines up with the
737 // two-compliment representation. A negative integer has one
738 // more in range than a positive integer. INT64_MIN is
739 // equal to (-INT64_MAX) - 1.
740 pDecodedItem->val.int64 = (-(int64_t)uNumber) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700741 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800742
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700743 } else {
744 // C can't represent a negative integer in this range
Laurence Lundblade21d1d812019-09-28 22:47:49 -1000745 // so it is an error.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700746 nReturn = QCBOR_ERR_INT_OVERFLOW;
747 }
748 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800749
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700750 return nReturn;
751}
752
753// Make sure #define value line up as DecodeSimple counts on this.
754#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
755#error QCBOR_TYPE_FALSE macro value wrong
756#endif
757
758#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
759#error QCBOR_TYPE_TRUE macro value wrong
760#endif
761
762#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
763#error QCBOR_TYPE_NULL macro value wrong
764#endif
765
766#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
767#error QCBOR_TYPE_UNDEF macro value wrong
768#endif
769
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700770#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
771#error QCBOR_TYPE_BREAK macro value wrong
772#endif
773
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700774#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
775#error QCBOR_TYPE_DOUBLE macro value wrong
776#endif
777
778#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
779#error QCBOR_TYPE_FLOAT macro value wrong
780#endif
781
782/*
783 Decode true, false, floats, break...
784 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800785inline static QCBORError
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800786DecodeSimple(int nAdditionalInfo, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700787{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700788 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800789
Laurence Lundbladeee851742020-01-08 08:37:05 -0800790 // uAdditionalInfo is 5 bits from the initial byte compile time checks
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800791 // above make sure uAdditionalInfo values line up with uDataType values.
792 // DecodeTypeAndNumber never returns a major type > 1f so cast is safe
793 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800794
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800795 switch(nAdditionalInfo) {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800796 // No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they are
797 // caught before this is called.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800798
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700799 case HALF_PREC_FLOAT:
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700800 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uNumber);
801 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700802 break;
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700803 case SINGLE_PREC_FLOAT:
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700804 pDecodedItem->val.dfnum = (double)UsefulBufUtil_CopyUint32ToFloat((uint32_t)uNumber);
805 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700806 break;
807 case DOUBLE_PREC_FLOAT:
808 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uNumber);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700809 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700810 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800811
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700812 case CBOR_SIMPLEV_FALSE: // 20
813 case CBOR_SIMPLEV_TRUE: // 21
814 case CBOR_SIMPLEV_NULL: // 22
815 case CBOR_SIMPLEV_UNDEF: // 23
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700816 case CBOR_SIMPLE_BREAK: // 31
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700817 break; // nothing to do
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800818
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700819 case CBOR_SIMPLEV_ONEBYTE: // 24
820 if(uNumber <= CBOR_SIMPLE_BREAK) {
821 // This takes out f8 00 ... f8 1f which should be encoded as e0 … f7
Laurence Lundblade077475f2019-04-26 09:06:33 -0700822 nReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700823 goto Done;
824 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800825 /* FALLTHROUGH */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700826 // fall through intentionally
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800827
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700828 default: // 0-19
829 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundbladeee851742020-01-08 08:37:05 -0800830 /*
831 DecodeTypeAndNumber will make uNumber equal to
832 uAdditionalInfo when uAdditionalInfo is < 24 This cast is
833 safe because the 2, 4 and 8 byte lengths of uNumber are in
834 the double/float cases above
835 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700836 pDecodedItem->val.uSimple = (uint8_t)uNumber;
837 break;
838 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800839
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700840Done:
841 return nReturn;
842}
843
844
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700845/*
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530846 Decode text and byte strings. Call the string allocator if asked to.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700847 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800848inline static QCBORError DecodeBytes(const QCORInternalAllocator *pAllocator,
849 int nMajorType,
850 uint64_t uStrLen,
851 UsefulInputBuf *pUInBuf,
852 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700853{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700854 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800855
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800856 // CBOR lengths can be 64 bits, but size_t is not 64 bits on all CPUs.
857 // This check makes the casts to size_t below safe.
858
859 // 4 bytes less than the largest sizeof() so this can be tested by
860 // putting a SIZE_MAX length in the CBOR test input (no one will
861 // care the limit on strings is 4 bytes shorter).
862 if(uStrLen > SIZE_MAX-4) {
863 nReturn = QCBOR_ERR_STRING_TOO_LONG;
864 goto Done;
865 }
866
867 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530868 if(UsefulBuf_IsNULLC(Bytes)) {
869 // Failed to get the bytes for this string item
870 nReturn = QCBOR_ERR_HIT_END;
871 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700872 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530873
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800874 if(pAllocator) {
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530875 // We are asked to use string allocator to make a copy
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800876 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530877 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +0700878 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530879 goto Done;
880 }
881 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800882 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530883 } else {
884 // Normal case with no string allocator
885 pDecodedItem->val.string = Bytes;
886 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800887 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800888 // Cast because ternary operator causes promotion to integer
889 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
890 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800891
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530892Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700893 return nReturn;
894}
895
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700896
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800897
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700898
899
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700900
901
Laurence Lundbladeee851742020-01-08 08:37:05 -0800902// Make sure the constants align as this is assumed by
903// the GetAnItem() implementation
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700904#if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
905#error QCBOR_TYPE_ARRAY value not lined up with major type
906#endif
907#if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
908#error QCBOR_TYPE_MAP value not lined up with major type
909#endif
910
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700911/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800912 This gets a single data item and decodes it including preceding
913 optional tagging. This does not deal with arrays and maps and nesting
914 except to decode the data item introducing them. Arrays and maps are
915 handled at the next level up in GetNext().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800916
Laurence Lundbladeee851742020-01-08 08:37:05 -0800917 Errors detected here include: an array that is too long to decode,
918 hit end of buffer unexpectedly, a few forms of invalid encoded CBOR
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700919 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800920static QCBORError GetNext_Item(UsefulInputBuf *pUInBuf,
921 QCBORItem *pDecodedItem,
922 const QCORInternalAllocator *pAllocator)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700923{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700924 QCBORError nReturn;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800925
Laurence Lundbladeee851742020-01-08 08:37:05 -0800926 /*
927 Get the major type and the number. Number could be length of more
928 bytes or the value depending on the major type nAdditionalInfo is
929 an encoding of the length of the uNumber and is needed to decode
930 floats and doubles
931 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800932 int nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700933 uint64_t uNumber;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800934 int nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800935
Laurence Lundblade4b09f632019-10-09 14:34:59 -0700936 memset(pDecodedItem, 0, sizeof(QCBORItem));
937
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800938 nReturn = DecodeTypeAndNumber(pUInBuf, &nMajorType, &uNumber, &nAdditionalInfo);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800939
Laurence Lundbladeee851742020-01-08 08:37:05 -0800940 // Error out here if we got into trouble on the type and number. The
941 // code after this will not work if the type and number is not good.
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700942 if(nReturn) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700943 goto Done;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700944 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800945
Laurence Lundbladeee851742020-01-08 08:37:05 -0800946 // At this point the major type and the value are valid. We've got
947 // the type and the number that starts every CBOR data item.
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800948 switch (nMajorType) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700949 case CBOR_MAJOR_TYPE_POSITIVE_INT: // Major type 0
950 case CBOR_MAJOR_TYPE_NEGATIVE_INT: // Major type 1
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800951 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700952 nReturn = QCBOR_ERR_BAD_INT;
953 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800954 nReturn = DecodeInteger(nMajorType, uNumber, pDecodedItem);
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700955 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700956 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800957
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700958 case CBOR_MAJOR_TYPE_BYTE_STRING: // Major type 2
959 case CBOR_MAJOR_TYPE_TEXT_STRING: // Major type 3
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800960 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
961 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
962 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
963 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530964 pDecodedItem->val.string = (UsefulBufC){NULL, SIZE_MAX};
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700965 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800966 nReturn = DecodeBytes(pAllocator, nMajorType, uNumber, pUInBuf, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700967 }
968 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800969
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700970 case CBOR_MAJOR_TYPE_ARRAY: // Major type 4
971 case CBOR_MAJOR_TYPE_MAP: // Major type 5
972 // Record the number of items in the array or map
973 if(uNumber > QCBOR_MAX_ITEMS_IN_ARRAY) {
974 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
975 goto Done;
976 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800977 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700978 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700979 } else {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800980 // type conversion OK because of check above
981 pDecodedItem->val.uCount = (uint16_t)uNumber;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700982 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800983 // C preproc #if above makes sure constants for major types align
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800984 // DecodeTypeAndNumber never returns a major type > 7 so cast is safe
985 pDecodedItem->uDataType = (uint8_t)nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700986 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800987
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700988 case CBOR_MAJOR_TYPE_OPTIONAL: // Major type 6, optional prepended tags
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800989 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundbladebb1062e2019-08-12 23:28:54 -0700990 nReturn = QCBOR_ERR_BAD_INT;
991 } else {
992 pDecodedItem->val.uTagV = uNumber;
993 pDecodedItem->uDataType = QCBOR_TYPE_OPTTAG;
994 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700995 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800996
Laurence Lundbladeee851742020-01-08 08:37:05 -0800997 case CBOR_MAJOR_TYPE_SIMPLE:
998 // Major type 7, float, double, true, false, null...
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800999 nReturn = DecodeSimple(nAdditionalInfo, uNumber, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001000 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001001
Laurence Lundbladeee851742020-01-08 08:37:05 -08001002 default:
1003 // Never happens because DecodeTypeAndNumber() should never return > 7
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001004 nReturn = QCBOR_ERR_UNSUPPORTED;
1005 break;
1006 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001007
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001008Done:
1009 return nReturn;
1010}
1011
1012
1013
1014/*
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001015 This layer deals with indefinite length strings. It pulls all the
Laurence Lundbladeee851742020-01-08 08:37:05 -08001016 individual chunk items together into one QCBORItem using the string
1017 allocator.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001018
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301019 Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001020 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001021static inline QCBORError
1022GetNext_FullItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001023{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001024 // Stack usage; int/ptr 2 UsefulBuf 2 QCBORItem -- 96
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001025
1026 // Get pointer to string allocator. First use is to pass it to
1027 // GetNext_Item() when option is set to allocate for *every* string.
1028 // Second use here is to allocate space to coallese indefinite
1029 // length string items into one.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001030 const QCORInternalAllocator *pAllocator = me->StringAllocator.pfAllocator ?
1031 &(me->StringAllocator) :
1032 NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001033
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001034 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001035 nReturn = GetNext_Item(&(me->InBuf),
1036 pDecodedItem,
1037 me->bStringAllocateAll ? pAllocator: NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001038 if(nReturn) {
1039 goto Done;
1040 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001041
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001042 // To reduce code size by removing support for indefinite length strings, the
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301043 // code in this function from here down can be eliminated. Run tests, except
1044 // indefinite length string tests, to be sure all is OK if this is removed.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001045
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001046 // Only do indefinite length processing on strings
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001047 const uint8_t uStringType = pDecodedItem->uDataType;
1048 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001049 goto Done; // no need to do any work here on non-string types
1050 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001051
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001052 // Is this a string with an indefinite length?
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301053 if(pDecodedItem->val.string.len != SIZE_MAX) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001054 goto Done; // length is not indefinite, so no work to do here
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001055 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001056
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301057 // Can't do indefinite length strings without a string allocator
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001058 if(pAllocator == NULL) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001059 nReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1060 goto Done;
1061 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001062
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001063 // Loop getting chunk of indefinite string
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001064 UsefulBufC FullString = NULLUsefulBufC;
1065
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001066 for(;;) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001067 // Get item for next chunk
1068 QCBORItem StringChunkItem;
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001069 // NULL string allocator passed here. Do not need to allocate
1070 // chunks even if bStringAllocateAll is set.
Laurence Lundbladefae26bf2019-02-18 11:15:43 -08001071 nReturn = GetNext_Item(&(me->InBuf), &StringChunkItem, NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001072 if(nReturn) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001073 break; // Error getting the next chunk
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001074 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001075
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301076 // See if it is a marker at end of indefinite length string
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001077 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001078 // String is complete
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001079 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301080 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001081 break;
1082 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001083
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001084 // Match data type of chunk to type at beginning.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301085 // Also catches error of other non-string types that don't belong.
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001086 // Also catches indefinite length strings inside indefinite length strings
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001087 if(StringChunkItem.uDataType != uStringType ||
1088 StringChunkItem.val.string.len == SIZE_MAX) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07001089 nReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001090 break;
1091 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001092
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301093 // Alloc new buffer or expand previously allocated buffer so it can fit
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001094 // The first time throurgh FullString.ptr is NULL and this is
1095 // equivalent to StringAllocator_Allocate()
1096 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1097 UNCONST_POINTER(FullString.ptr),
1098 FullString.len + StringChunkItem.val.string.len);
1099
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001100 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301101 // Allocation of memory for the string failed
Laurence Lundblade30816f22018-11-10 13:40:22 +07001102 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001103 break;
1104 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001105
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001106 // Copy new string chunk at the end of string so far.
1107 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001108 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001109
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001110 if(nReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1111 // Getting the item failed, clean up the allocated memory
1112 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001113 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001114
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001115Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001116 return nReturn;
1117}
1118
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001119
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001120static uint64_t ConvertTag(QCBORDecodeContext *me, uint16_t uTagVal) {
1121 if(uTagVal <= QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001122 return uTagVal;
1123 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001124 int x = uTagVal - (QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001125 return me->auMappedTags[x];
1126 }
1127}
1128
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001129/*
Laurence Lundblade59289e52019-12-30 13:44:37 -08001130 Gets all optional tag data items preceding a data item that is not an
1131 optional tag and records them as bits in the tag map.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001132 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001133static QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001134GetNext_TaggedItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001135{
Laurence Lundblade30816f22018-11-10 13:40:22 +07001136 QCBORError nReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001137
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001138 uint16_t auTags[QCBOR_MAX_TAGS_PER_ITEM] = {CBOR_TAG_INVALID16,
1139 CBOR_TAG_INVALID16,
1140 CBOR_TAG_INVALID16,
1141 CBOR_TAG_INVALID16};
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001142
Laurence Lundblade59289e52019-12-30 13:44:37 -08001143 // Loop fetching items until the item fetched is not a tag
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001144 for(;;) {
1145 nReturn = GetNext_FullItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001146 if(nReturn) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001147 goto Done; // Error out of the loop
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001148 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001149
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001150 if(pDecodedItem->uDataType != QCBOR_TYPE_OPTTAG) {
1151 // Successful exit from loop; maybe got some tags, maybe not
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001152 memcpy(pDecodedItem->uTags, auTags, sizeof(auTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001153 break;
1154 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001155
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001156 // Is there room for the tag in the tags list?
1157 size_t uTagIndex;
1158 for(uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001159 if(auTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001160 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001161 }
1162 }
1163 if(uTagIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001164 return QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001165 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001166
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001167 // Is the tag > 16 bits?
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001168 if(pDecodedItem->val.uTagV > QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001169 size_t uTagMapIndex;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001170 // Is there room in the tag map, or is it in it already?
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001171 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001172 if(me->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001173 break;
1174 }
1175 if(me->auMappedTags[uTagMapIndex] == pDecodedItem->val.uTagV) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001176 // TODO: test this
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001177 break;
1178 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001179 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001180 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1181 // No room for the tag
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001182 // Should never happen as long as QCBOR_MAX_TAGS_PER_ITEM <= QCBOR_NUM_MAPPED_TAGS
1183 return QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001184 }
1185
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001186 // Covers the cases where tag is new and were it is already in the map
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001187 me->auMappedTags[uTagMapIndex] = pDecodedItem->val.uTagV;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001188 auTags[uTagIndex] = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001189
1190 } else {
1191 auTags[uTagIndex] = (uint16_t)pDecodedItem->val.uTagV;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001192 }
1193 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001194
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001195Done:
1196 return nReturn;
1197}
1198
1199
1200/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001201 This layer takes care of map entries. It combines the label and data
1202 items into one QCBORItem.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001203 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001204static inline QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001205GetNext_MapEntry(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001206{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001207 // Stack use: int/ptr 1, QCBORItem -- 56
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001208 QCBORError nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001209 if(nReturn)
1210 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001211
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001212 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001213 // Break can't be a map entry
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001214 goto Done;
1215 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001216
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001217 if(me->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1218 // In a map and caller wants maps decoded, not treated as arrays
1219
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001220 if(DecodeNesting_IsCurrentTypeMap(&(me->nesting))) {
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001221 // If in a map and the right decoding mode, get the label
1222
Laurence Lundbladeee851742020-01-08 08:37:05 -08001223 // Save label in pDecodedItem and get the next which will
1224 // be the real data
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001225 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001226 nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001227 if(nReturn)
1228 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001229
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301230 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001231
1232 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
1233 // strings are always good labels
1234 pDecodedItem->label.string = LabelItem.val.string;
1235 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
1236 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == me->uDecodeMode) {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001237 // It's not a string and we only want strings
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001238 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1239 goto Done;
1240 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1241 pDecodedItem->label.int64 = LabelItem.val.int64;
1242 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1243 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1244 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1245 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1246 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1247 pDecodedItem->label.string = LabelItem.val.string;
1248 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1249 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1250 } else {
1251 // label is not an int or a string. It is an arrray
1252 // or a float or such and this implementation doesn't handle that.
1253 // Also, tags on labels are ignored.
1254 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1255 goto Done;
1256 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001257 }
1258 } else {
1259 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001260 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
1261 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
1262 goto Done;
1263 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001264 // Decoding a map as an array
1265 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001266 // Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2
1267 // Cast is needed because of integer promotion
1268 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001269 }
1270 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001271
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001272Done:
1273 return nReturn;
1274}
1275
1276
Laurence Lundblade02625d42020-06-25 14:41:41 -07001277/*
1278 See if next item is a CBOR break. If it is, it is consumed,
1279 if not it is not consumed.
1280*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001281static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001282NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1283{
1284 *pbNextIsBreak = false;
1285 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001286 QCBORItem Peek;
1287 size_t uPeek = UsefulInputBuf_Tell(pUIB);
1288 QCBORError uReturn = GetNext_Item(pUIB, &Peek, NULL);
1289 if(uReturn != QCBOR_SUCCESS) {
1290 return uReturn;
1291 }
1292 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001293 // It is not a break, rewind so it can be processed normally.
1294 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001295 } else {
1296 *pbNextIsBreak = true;
1297 }
1298 }
1299
1300 return QCBOR_SUCCESS;
1301}
1302
1303
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001304/*
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001305 An item was just consumed, now figure out if it was the
1306 end of an array or map that can be closed out. That
1307 may in turn close out another map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001308*/
Laurence Lundbladed0304932020-06-27 10:59:38 -07001309static QCBORError NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001310{
1311 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001312
Laurence Lundblade642282a2020-06-23 12:00:33 -07001313 /* This loops ascending nesting levels as long as there is ascending to do */
1314 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1315
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001316 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001317 /* Decrement count for definite length maps / arrays */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001318 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1319 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001320 /* Didn't close out map or array, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001321 break;
1322 }
Laurence Lundblade02625d42020-06-25 14:41:41 -07001323 /* All of a definite length array was consumed; fall through to ascend */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001324
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001325 } else {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001326 /* If not definite length, have to check for a CBOR break */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001327 bool bIsBreak = false;
1328 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1329 if(uReturn != QCBOR_SUCCESS) {
1330 goto Done;
1331 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001332
1333 if(!bIsBreak) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001334 /* It's not a break so nothing closes out and all work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001335 break;
1336 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001337
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001338 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001339 /*
1340 Break occurred inside a bstr-wrapped CBOR or
1341 in the top level sequence. This is always an
1342 error because neither are an indefinte length
1343 map/array.
1344 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001345 uReturn = QCBOR_ERR_BAD_BREAK;
1346 goto Done;
1347 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07001348
Laurence Lundblade02625d42020-06-25 14:41:41 -07001349 /* It was a break in an indefinite length map / array */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001350 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001351
Laurence Lundblade02625d42020-06-25 14:41:41 -07001352 /* All items in the map/array level have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001353
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001354 /* But ascent in bounded mode is only by explicit call to QCBORDecode_ExitBoundedMode() */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001355 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001356 /* Set the count to zero for definite length arrays to indicate cursor is at end of bounded map / array */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001357 if(bMarkEnd) {
1358 // Used for definite and indefinite to signal end
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001359 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001360
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001361 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001362 break;
1363 }
1364
1365 /* Finally, actually ascend one level. */
1366 DecodeNesting_Ascend(&(pMe->nesting));
1367 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001368
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001369 uReturn = QCBOR_SUCCESS;
1370
1371Done:
1372 return uReturn;
1373}
1374
1375
1376/*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001377 This handles the traversal descending into and asecnding out of maps,
Laurence Lundblade642282a2020-06-23 12:00:33 -07001378 arrays and bstr-wrapped CBOR. It figures out the ends of definite and
1379 indefinte length maps and arrays by looking at the item count or
1380 finding CBOR breaks. It detects the ends of the top-level sequence
1381 and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001382 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001383static QCBORError
1384QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001385{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001386 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001387 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001388
Laurence Lundblade642282a2020-06-23 12:00:33 -07001389 /*
1390 If out of bytes to consume, it is either the end of the top-level
1391 sequence of some bstr-wrapped CBOR that was entered.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001392
Laurence Lundblade642282a2020-06-23 12:00:33 -07001393 In the case of bstr-wrapped CBOR, the length of the UsefulInputBuf
1394 was set to that of the bstr-wrapped CBOR. When the bstr-wrapped
1395 CBOR is exited, the length is set back to the top-level's length
1396 or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001397 */
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001398 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001399 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001400 goto Done;
1401 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001402
Laurence Lundblade642282a2020-06-23 12:00:33 -07001403 /*
1404 Check to see if at the end of a bounded definite length map or
Laurence Lundblade02625d42020-06-25 14:41:41 -07001405 array. The check for the end of an indefinite length array is
1406 later.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001407 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001408 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001409 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001410 goto Done;
1411 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001412
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001413 /* ==== Next: not at the end so get another item ==== */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001414 uReturn = GetNext_MapEntry(me, pDecodedItem);
1415 if(uReturn) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001416 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001417 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301418
Laurence Lundblade642282a2020-06-23 12:00:33 -07001419 /*
1420 Breaks ending arrays/maps are always processed at the end of this
1421 function. They should never show up here.
1422 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301423 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001424 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301425 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301426 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001427
Laurence Lundblade642282a2020-06-23 12:00:33 -07001428 /*
1429 Record the nesting level for this data item before processing any
1430 of decrementing and descending.
1431 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001432 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001433
Laurence Lundblade642282a2020-06-23 12:00:33 -07001434
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001435 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001436 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001437 /*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001438 If the new item is a map or array, descend.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001439
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001440 Empty indefinite length maps and arrays are descended into, but then ascended out
Laurence Lundblade02625d42020-06-25 14:41:41 -07001441 of in the next chunk of code.
1442
1443 Maps and arrays do count as items in the map/array that
Laurence Lundblade642282a2020-06-23 12:00:33 -07001444 encloses them so a decrement needs to be done for them too, but
1445 that is done only when all the items in them have been
1446 processed, not when they are opened with the exception of an
1447 empty map or array.
1448 */
1449 uReturn = DecodeNesting_DescendMapOrArray(&(me->nesting),
1450 pDecodedItem->uDataType,
1451 pDecodedItem->val.uCount);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001452 if(uReturn != QCBOR_SUCCESS) {
1453 goto Done;
1454 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001455 }
1456
Laurence Lundblade02625d42020-06-25 14:41:41 -07001457 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1458 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1459 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001460 /*
1461 The following cases are handled here:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001462 - A non-aggregate like an integer or string
1463 - An empty definite length map or array
1464 - An indefinite length map or array that might be empty or might not.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001465
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001466 NestLevelAscender() does the work of decrementing the count for an
Laurence Lundblade02625d42020-06-25 14:41:41 -07001467 definite length map/array and break detection for an indefinite
1468 length map/array. If the end of the map/array was reached, then
1469 it ascends nesting levels, possibly all the way to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001470 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001471 uReturn = NestLevelAscender(me, true);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001472 if(uReturn) {
1473 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001474 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301475 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001476
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001477 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001478 /*
Laurence Lundblade02625d42020-06-25 14:41:41 -07001479 Tell the caller what level is next. This tells them what
1480 maps/arrays were closed out and makes it possible for them to
1481 reconstruct the tree with just the information returned in
1482 a QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001483 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001484 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001485 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001486 pDecodedItem->uNextNestLevel = 0;
1487 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001488 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001489 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001490
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001491Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001492 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001493 /* This sets uDataType and uLabelType to QCBOR_TYPE_NONE */
Laurence Lundbladee9482dd2019-10-11 12:58:46 -07001494 memset(pDecodedItem, 0, sizeof(QCBORItem));
1495 }
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001496 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001497}
1498
1499
Laurence Lundblade59289e52019-12-30 13:44:37 -08001500/*
1501 Mostly just assign the right data type for the date string.
1502 */
1503inline static QCBORError DecodeDateString(QCBORItem *pDecodedItem)
1504{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001505 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1506 return QCBOR_ERR_BAD_OPT_TAG;
1507 }
1508
1509 const UsefulBufC Temp = pDecodedItem->val.string;
1510 pDecodedItem->val.dateString = Temp;
1511 pDecodedItem->uDataType = QCBOR_TYPE_DATE_STRING;
1512 return QCBOR_SUCCESS;
1513}
1514
1515
1516/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001517 The epoch formatted date. Turns lots of different forms of encoding
1518 date into uniform one
Laurence Lundblade59289e52019-12-30 13:44:37 -08001519 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001520static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001521{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001522 QCBORError nReturn = QCBOR_SUCCESS;
1523
1524 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1525
1526 switch (pDecodedItem->uDataType) {
1527
1528 case QCBOR_TYPE_INT64:
1529 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1530 break;
1531
1532 case QCBOR_TYPE_UINT64:
1533 if(pDecodedItem->val.uint64 > INT64_MAX) {
1534 nReturn = QCBOR_ERR_DATE_OVERFLOW;
1535 goto Done;
1536 }
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001537 pDecodedItem->val.epochDate.nSeconds = (int64_t)pDecodedItem->val.uint64;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001538 break;
1539
1540 case QCBOR_TYPE_DOUBLE:
1541 {
1542 // This comparison needs to be done as a float before
1543 // conversion to an int64_t to be able to detect doubles
1544 // that are too large to fit into an int64_t. A double
1545 // has 52 bits of preceision. An int64_t has 63. Casting
1546 // INT64_MAX to a double actually causes a round up which
1547 // is bad and wrong for the comparison because it will
1548 // allow conversion of doubles that can't fit into a
1549 // uint64_t. To remedy this INT64_MAX - 0x7ff is used as
1550 // the cutoff point as if that rounds up in conversion to
1551 // double it will still be less than INT64_MAX. 0x7ff is
1552 // picked because it has 11 bits set.
1553 //
1554 // INT64_MAX seconds is on the order of 10 billion years,
1555 // and the earth is less than 5 billion years old, so for
1556 // most uses this conversion error won't occur even though
1557 // doubles can go much larger.
1558 //
1559 // Without the 0x7ff there is a ~30 minute range of time
1560 // values 10 billion years in the past and in the future
1561 // where this this code would go wrong.
1562 const double d = pDecodedItem->val.dfnum;
1563 if(d > (double)(INT64_MAX - 0x7ff)) {
1564 nReturn = QCBOR_ERR_DATE_OVERFLOW;
1565 goto Done;
1566 }
1567 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
1568 pDecodedItem->val.epochDate.fSecondsFraction = d - (double)pDecodedItem->val.epochDate.nSeconds;
1569 }
1570 break;
1571
1572 default:
1573 nReturn = QCBOR_ERR_BAD_OPT_TAG;
1574 goto Done;
1575 }
1576 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1577
1578Done:
1579 return nReturn;
1580}
1581
1582
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001583/*
1584 Mostly just assign the right data type for the bignum.
1585 */
1586inline static QCBORError DecodeBigNum(QCBORItem *pDecodedItem)
1587{
1588 // Stack Use: UsefulBuf 1 -- 16
1589 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1590 return QCBOR_ERR_BAD_OPT_TAG;
1591 }
1592 const UsefulBufC Temp = pDecodedItem->val.string;
1593 pDecodedItem->val.bigNum = Temp;
1594 const bool bIsPosBigNum = (bool)(pDecodedItem->uTags[0] == CBOR_TAG_POS_BIGNUM);
1595 pDecodedItem->uDataType = (uint8_t)(bIsPosBigNum ? QCBOR_TYPE_POSBIGNUM
1596 : QCBOR_TYPE_NEGBIGNUM);
1597 return QCBOR_SUCCESS;
1598}
1599
1600
Laurence Lundblade59289e52019-12-30 13:44:37 -08001601#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1602/*
1603 Decode decimal fractions and big floats.
1604
1605 When called pDecodedItem must be the array that is tagged as a big
1606 float or decimal fraction, the array that has the two members, the
1607 exponent and mantissa.
1608
1609 This will fetch and decode the exponent and mantissa and put the
1610 result back into pDecodedItem.
1611 */
1612inline static QCBORError
1613QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1614{
1615 QCBORError nReturn;
1616
1617 // --- Make sure it is an array; track nesting level of members ---
1618 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
1619 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1620 goto Done;
1621 }
1622
1623 // A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladeee851742020-01-08 08:37:05 -08001624 // definite length arrays, but not for indefnite. Instead remember
1625 // the nesting level the two integers must be at, which is one
1626 // deeper than that of the array.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001627 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
1628
1629 // --- Is it a decimal fraction or a bigfloat? ---
1630 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
1631 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
1632
1633 // --- Get the exponent ---
1634 QCBORItem exponentItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001635 nReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001636 if(nReturn != QCBOR_SUCCESS) {
1637 goto Done;
1638 }
1639 if(exponentItem.uNestingLevel != nNestLevel) {
1640 // Array is empty or a map/array encountered when expecting an int
1641 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1642 goto Done;
1643 }
1644 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
1645 // Data arriving as an unsigned int < INT64_MAX has been converted
1646 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1647 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1648 // will be too large for this to handle and thus an error that will
1649 // get handled in the next else.
1650 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
1651 } else {
1652 // Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX
1653 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1654 goto Done;
1655 }
1656
1657 // --- Get the mantissa ---
1658 QCBORItem mantissaItem;
1659 nReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
1660 if(nReturn != QCBOR_SUCCESS) {
1661 goto Done;
1662 }
1663 if(mantissaItem.uNestingLevel != nNestLevel) {
1664 // Mantissa missing or map/array encountered when expecting number
1665 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1666 goto Done;
1667 }
1668 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
1669 // Data arriving as an unsigned int < INT64_MAX has been converted
1670 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1671 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1672 // will be too large for this to handle and thus an error that
1673 // will get handled in an else below.
1674 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
1675 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM || mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
1676 // Got a good big num mantissa
1677 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
1678 // Depends on numbering of QCBOR_TYPE_XXX
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001679 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
1680 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
1681 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001682 } else {
1683 // Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX
1684 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1685 goto Done;
1686 }
1687
1688 // --- Check that array only has the two numbers ---
1689 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07001690 // Extra items in the decimal fraction / big float
Laurence Lundblade59289e52019-12-30 13:44:37 -08001691 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1692 goto Done;
1693 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07001694 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel; // TODO: make sure this is right
Laurence Lundblade59289e52019-12-30 13:44:37 -08001695
1696Done:
1697
1698 return nReturn;
1699}
1700#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
1701
1702
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001703
1704/*
1705 */
1706inline static QCBORError DecodeURI(QCBORItem *pDecodedItem)
1707{
1708 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1709 return QCBOR_ERR_BAD_OPT_TAG;
1710 }
1711 pDecodedItem->uDataType = QCBOR_TYPE_URI;
1712 return QCBOR_SUCCESS;
1713}
1714
1715
1716inline static QCBORError DecodeB64URL(QCBORItem *pDecodedItem)
1717{
1718 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1719 return QCBOR_ERR_BAD_OPT_TAG;
1720 }
1721 pDecodedItem->uDataType = QCBOR_TYPE_BASE64URL;
1722 return QCBOR_SUCCESS;
1723}
1724
1725
1726inline static QCBORError DecodeB64(QCBORItem *pDecodedItem)
1727{
1728 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1729 return QCBOR_ERR_BAD_OPT_TAG;
1730 }
1731 pDecodedItem->uDataType = QCBOR_TYPE_BASE64;
1732 return QCBOR_SUCCESS;
1733}
1734
1735
1736inline static QCBORError DecodeRegex(QCBORItem *pDecodedItem)
1737{
1738 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1739 return QCBOR_ERR_BAD_OPT_TAG;
1740 }
1741 pDecodedItem->uDataType = QCBOR_TYPE_REGEX;
1742 return QCBOR_SUCCESS;
1743}
1744
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001745inline static QCBORError DecodeWrappedCBOR(QCBORItem *pDecodedItem)
1746{
1747 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1748 return QCBOR_ERR_BAD_OPT_TAG;
1749 }
1750 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR;
1751 return QCBOR_SUCCESS;
1752}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001753
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001754
1755inline static QCBORError DecodeWrappedCBORSequence(QCBORItem *pDecodedItem)
1756{
1757 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1758 return QCBOR_ERR_BAD_OPT_TAG;
1759 }
1760 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE;
1761 return QCBOR_SUCCESS;
1762}
1763
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001764inline static QCBORError DecodeMIME(QCBORItem *pDecodedItem)
1765{
1766 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
1767 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
1768 } else if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1769 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
1770 } else {
1771 return QCBOR_ERR_BAD_OPT_TAG;
1772 }
1773 return QCBOR_SUCCESS;
1774}
1775
1776
1777/*
1778 */
1779inline static QCBORError DecodeUUID(QCBORItem *pDecodedItem)
1780{
1781 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1782 return QCBOR_ERR_BAD_OPT_TAG;
1783 }
1784 pDecodedItem->uDataType = QCBOR_TYPE_UUID;
1785 return QCBOR_SUCCESS;
1786}
1787
1788
Laurence Lundblade59289e52019-12-30 13:44:37 -08001789/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001790 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001791 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001792QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001793QCBORDecode_GetNext(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001794{
1795 QCBORError nReturn;
1796
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001797 nReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001798 if(nReturn != QCBOR_SUCCESS) {
1799 goto Done;
1800 }
1801
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001802 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
1803 switch(pDecodedItem->uTags[i] ) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08001804
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001805 case CBOR_TAG_DATE_STRING:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001806 nReturn = DecodeDateString(pDecodedItem);
1807 break;
1808
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001809 case CBOR_TAG_DATE_EPOCH:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001810 nReturn = DecodeDateEpoch(pDecodedItem);
1811 break;
1812
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001813 case CBOR_TAG_POS_BIGNUM:
1814 case CBOR_TAG_NEG_BIGNUM:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001815 nReturn = DecodeBigNum(pDecodedItem);
1816 break;
1817
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001818 #ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1819 case CBOR_TAG_DECIMAL_FRACTION:
1820 case CBOR_TAG_BIGFLOAT:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001821 // For aggregate tagged types, what goes into pTags is only collected
1822 // from the surrounding data item, not the contents, so pTags is not
1823 // passed on here.
1824
1825 nReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
1826 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001827 #endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001828
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001829 case CBOR_TAG_CBOR:
1830 nReturn = DecodeWrappedCBOR(pDecodedItem);
1831 break;
1832
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001833 case CBOR_TAG_CBOR_SEQUENCE:
1834 nReturn = DecodeWrappedCBORSequence(pDecodedItem);
1835 break;
1836
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001837 case CBOR_TAG_URI:
1838 nReturn = DecodeURI(pDecodedItem);
1839 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001840
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001841 case CBOR_TAG_B64URL:
1842 nReturn = DecodeB64URL(pDecodedItem);
1843 break;
1844
1845 case CBOR_TAG_B64:
1846 nReturn = DecodeB64(pDecodedItem);
1847 break;
1848
1849 case CBOR_TAG_MIME:
1850 case CBOR_TAG_BINARY_MIME:
1851 nReturn = DecodeMIME(pDecodedItem);
1852 break;
1853
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001854 case CBOR_TAG_REGEX:
1855 nReturn = DecodeRegex(pDecodedItem);
1856 break;
1857
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001858 case CBOR_TAG_BIN_UUID:
1859 nReturn = DecodeUUID(pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001860 break;
1861
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001862 case CBOR_TAG_INVALID16:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001863 // The end of the tag list or no tags
1864 // Successful exit from the loop.
1865 goto Done;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001866
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001867 default:
1868 // A tag that is not understood
1869 // A successful exit from the loop
1870 goto Done;
1871
1872 }
1873 if(nReturn != QCBOR_SUCCESS) {
1874 goto Done;
1875 }
Laurence Lundblade59289e52019-12-30 13:44:37 -08001876 }
1877
1878Done:
1879 if(nReturn != QCBOR_SUCCESS) {
1880 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
1881 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
1882 }
1883 return nReturn;
1884}
1885
1886
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001887QCBORError QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
1888{
1889 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
1890
1891 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
1892
1893 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundblade78f7b932020-07-28 20:02:25 -07001894 // TODO: undo the level tracking (or don't do it)
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001895
1896 return uErr;
1897}
1898
1899
Laurence Lundblade59289e52019-12-30 13:44:37 -08001900/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001901 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001902 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001903QCBORError
1904QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
1905 QCBORItem *pDecodedItem,
1906 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001907{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001908 QCBORError nReturn;
1909
1910 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
1911 if(nReturn != QCBOR_SUCCESS) {
1912 return nReturn;
1913 }
1914
1915 if(pTags != NULL) {
1916 pTags->uNumUsed = 0;
1917 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001918 if(pDecodedItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001919 break;
1920 }
1921 if(pTags->uNumUsed >= pTags->uNumAllocated) {
1922 return QCBOR_ERR_TOO_MANY_TAGS;
1923 }
1924 pTags->puTags[pTags->uNumUsed] = ConvertTag(me, pDecodedItem->uTags[i]);
1925 pTags->uNumUsed++;
1926 }
1927 }
1928
1929 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001930}
1931
1932
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001933/*
Laurence Lundblade6de37062018-10-15 12:22:42 +05301934 Decoding items is done in 5 layered functions, one calling the
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301935 next one down. If a layer has no work to do for a particular item
1936 it returns quickly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001937
Laurence Lundblade59289e52019-12-30 13:44:37 -08001938 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
1939 tagged data items, turning them into the local C representation.
1940 For the most simple it is just associating a QCBOR_TYPE with the data. For
1941 the complex ones that an aggregate of data items, there is some further
1942 decoding and a little bit of recursion.
1943
1944 - QCBORDecode_GetNextMapOrArray - This manages the beginnings and
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301945 ends of maps and arrays. It tracks descending into and ascending
Laurence Lundblade6de37062018-10-15 12:22:42 +05301946 out of maps/arrays. It processes all breaks that terminate
Laurence Lundbladebb87be22020-04-09 19:15:32 -07001947 indefinite length maps and arrays.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001948
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301949 - GetNext_MapEntry -- This handles the combining of two
1950 items, the label and the data, that make up a map entry.
1951 It only does work on maps. It combines the label and data
1952 items into one labeled item.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001953
Laurence Lundblade59289e52019-12-30 13:44:37 -08001954 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
1955 tags into bit flags associated with the data item. No actual decoding
1956 of the contents of the tagged item is performed here.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001957
Laurence Lundblade59289e52019-12-30 13:44:37 -08001958 - GetNext_FullItem -- This assembles the sub-items that make up
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301959 an indefinte length string into one string item. It uses the
Laurence Lundblade6de37062018-10-15 12:22:42 +05301960 string allocater to create contiguous space for the item. It
1961 processes all breaks that are part of indefinite length strings.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001962
Laurence Lundblade59289e52019-12-30 13:44:37 -08001963 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
1964 atomic data item has a "major type", an integer "argument" and optionally
1965 some content. For text and byte strings, the content is the bytes
1966 that make up the string. These are the smallest data items that are
1967 considered to be well-formed. The content may also be other data items in
1968 the case of aggregate types. They are not handled in this layer.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001969
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001970 Roughly this takes 300 bytes of stack for vars. Need to
1971 evaluate this more carefully and correctly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001972
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301973 */
1974
1975
1976/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001977 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001978 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001979int QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001980 const QCBORItem *pItem,
1981 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001982{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001983 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++ ) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001984 if(pItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001985 break;
1986 }
1987 if(ConvertTag(me, pItem->uTags[i]) == uTag) {
1988 return 1;
1989 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001990 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001991
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001992 return 0;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001993}
1994
1995
1996/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001997 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001998 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07001999QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002000{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002001 QCBORError uReturn = me->uLastError;
2002
2003 if(uReturn != QCBOR_SUCCESS) {
2004 goto Done;
2005 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002006
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002007 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002008 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002009 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002010 goto Done;
2011 }
2012
2013 // Error out if not all the bytes are consumed
2014 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002015 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002016 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002017
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002018Done:
Laurence Lundblade6de37062018-10-15 12:22:42 +05302019 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002020 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002021 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002022
Laurence Lundblade085d7952020-07-24 10:26:30 -07002023 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002024}
2025
2026
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002027/*
2028Public function, see header qcbor/qcbor_decode.h file
2029*/
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002030uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2031 const QCBORItem *pItem,
2032 unsigned int uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002033{
2034 if(uIndex > QCBOR_MAX_TAGS_PER_ITEM) {
2035 return CBOR_TAG_INVALID16;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002036 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002037 return ConvertTag(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002038 }
2039}
2040
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002041
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002042/*
2043
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002044Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002045
Laurence Lundbladeee851742020-01-08 08:37:05 -08002046 - Hit end of input before it was expected while decoding type and
2047 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002048
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002049 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002050
Laurence Lundbladeee851742020-01-08 08:37:05 -08002051 - Hit end of input while decoding a text or byte string
2052 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002053
Laurence Lundbladeee851742020-01-08 08:37:05 -08002054 - Encountered conflicting tags -- e.g., an item is tagged both a date
2055 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002056
Laurence Lundbladeee851742020-01-08 08:37:05 -08002057 - Encontered an array or mapp that has too many items
2058 QCBOR_ERR_ARRAY_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002059
Laurence Lundbladeee851742020-01-08 08:37:05 -08002060 - Encountered array/map nesting that is too deep
2061 QCBOR_ERR_ARRAY_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002062
Laurence Lundbladeee851742020-01-08 08:37:05 -08002063 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2064 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002065
Laurence Lundbladeee851742020-01-08 08:37:05 -08002066 - The type of a map label is not a string or int
2067 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002068
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002069 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002070
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002071 */
2072
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002073
2074
Laurence Lundbladef6531662018-12-04 10:42:22 +09002075
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002076/* ===========================================================================
2077 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002078
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002079 This implements a simple sting allocator for indefinite length
2080 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2081 implements the function type QCBORStringAllocate and allows easy
2082 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002083
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002084 This particular allocator is built-in for convenience. The caller
2085 can implement their own. All of this following code will get
2086 dead-stripped if QCBORDecode_SetMemPool() is not called.
2087
2088 This is a very primitive memory allocator. It does not track
2089 individual allocations, only a high-water mark. A free or
2090 reallocation must be of the last chunk allocated.
2091
2092 The size of the pool and offset to free memory are packed into the
2093 first 8 bytes of the memory pool so we don't have to keep them in
2094 the decode context. Since the address of the pool may not be
2095 aligned, they have to be packed and unpacked as if they were
2096 serialized data of the wire or such.
2097
2098 The sizes packed in are uint32_t to be the same on all CPU types
2099 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002100 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002101
2102
Laurence Lundbladeee851742020-01-08 08:37:05 -08002103static inline int
2104MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002105{
2106 // Use of UsefulInputBuf is overkill, but it is convenient.
2107 UsefulInputBuf UIB;
2108
Laurence Lundbladeee851742020-01-08 08:37:05 -08002109 // Just assume the size here. It was checked during SetUp so
2110 // the assumption is safe.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002111 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem, QCBOR_DECODE_MIN_MEM_POOL_SIZE});
2112 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2113 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2114 return UsefulInputBuf_GetError(&UIB);
2115}
2116
2117
Laurence Lundbladeee851742020-01-08 08:37:05 -08002118static inline int
2119MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002120{
2121 // Use of UsefulOutBuf is overkill, but convenient. The
2122 // length check performed here is useful.
2123 UsefulOutBuf UOB;
2124
2125 UsefulOutBuf_Init(&UOB, Pool);
2126 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2127 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2128 return UsefulOutBuf_GetError(&UOB);
2129}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002130
2131
2132/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002133 Internal function for an allocation, reallocation free and destuct.
2134
2135 Having only one function rather than one each per mode saves space in
2136 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002137
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002138 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2139 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002140static UsefulBuf
2141MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002142{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002143 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002144
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002145 uint32_t uPoolSize;
2146 uint32_t uFreeOffset;
2147
2148 if(uNewSize > UINT32_MAX) {
2149 // This allocator is only good up to 4GB. This check should
2150 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2151 goto Done;
2152 }
2153 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2154
2155 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2156 goto Done;
2157 }
2158
2159 if(uNewSize) {
2160 if(pMem) {
2161 // REALLOCATION MODE
2162 // Calculate pointer to the end of the memory pool. It is
2163 // assumed that pPool + uPoolSize won't wrap around by
2164 // assuming the caller won't pass a pool buffer in that is
2165 // not in legitimate memory space.
2166 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2167
2168 // Check that the pointer for reallocation is in the range of the
2169 // pool. This also makes sure that pointer math further down
2170 // doesn't wrap under or over.
2171 if(pMem >= pPool && pMem < pPoolEnd) {
2172 // Offset to start of chunk for reallocation. This won't
2173 // wrap under because of check that pMem >= pPool. Cast
2174 // is safe because the pool is always less than UINT32_MAX
2175 // because of check in QCBORDecode_SetMemPool().
2176 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2177
2178 // Check to see if the allocation will fit. uPoolSize -
2179 // uMemOffset will not wrap under because of check that
2180 // pMem is in the range of the uPoolSize by check above.
2181 if(uNewSize <= uPoolSize - uMemOffset) {
2182 ReturnValue.ptr = pMem;
2183 ReturnValue.len = uNewSize;
2184
2185 // Addition won't wrap around over because uNewSize was
2186 // checked to be sure it is less than the pool size.
2187 uFreeOffset = uMemOffset + uNewSize32;
2188 }
2189 }
2190 } else {
2191 // ALLOCATION MODE
2192 // uPoolSize - uFreeOffset will not underflow because this
2193 // pool implementation makes sure uFreeOffset is always
2194 // smaller than uPoolSize through this check here and
2195 // reallocation case.
2196 if(uNewSize <= uPoolSize - uFreeOffset) {
2197 ReturnValue.len = uNewSize;
2198 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002199 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002200 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002201 }
2202 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002203 if(pMem) {
2204 // FREE MODE
2205 // Cast is safe because of limit on pool size in
2206 // QCBORDecode_SetMemPool()
2207 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2208 } else {
2209 // DESTRUCT MODE
2210 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002211 }
2212 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002213
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002214 UsefulBuf Pool = {pPool, uPoolSize};
2215 MemPool_Pack(Pool, uFreeOffset);
2216
2217Done:
2218 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002219}
2220
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002221
Laurence Lundbladef6531662018-12-04 10:42:22 +09002222/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002223 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002224 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002225QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2226 UsefulBuf Pool,
2227 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002228{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002229 // The pool size and free mem offset are packed into the beginning
2230 // of the pool memory. This compile time check make sure the
2231 // constant in the header is correct. This check should optimize
2232 // down to nothing.
2233 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07002234 return QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002235 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002236
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002237 // The pool size and free offset packed in to the beginning of pool
2238 // memory are only 32-bits. This check will optimize out on 32-bit
2239 // machines.
2240 if(Pool.len > UINT32_MAX) {
2241 return QCBOR_ERR_BUFFER_TOO_LARGE;
2242 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002243
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002244 // This checks that the pool buffer given is big enough.
2245 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
2246 return QCBOR_ERR_BUFFER_TOO_SMALL;
2247 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002248
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002249 pMe->StringAllocator.pfAllocator = MemPool_Function;
2250 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2251 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002252
Laurence Lundblade30816f22018-11-10 13:40:22 +07002253 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002254}
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002255
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002256
2257
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002258
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002259
2260
2261/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002262 Consume an entire map or array (and do next to
2263 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002264 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002265static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002266ConsumeItem(QCBORDecodeContext *pMe,
2267 const QCBORItem *pItemToConsume,
2268 uint_fast8_t *puNextNestLevel)
2269{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002270 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002271 QCBORItem Item;
2272
Laurence Lundblade02625d42020-06-25 14:41:41 -07002273 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ConsumeItem");
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002274
Laurence Lundblade02625d42020-06-25 14:41:41 -07002275 if(QCBORItem_IsMapOrArray(pItemToConsume)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002276 /* There is only real work to do for maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002277
Laurence Lundblade1341c592020-04-11 14:19:05 -07002278 /* This works for definite and indefinite length
2279 * maps and arrays by using the nesting level
2280 */
2281 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002282 uReturn = QCBORDecode_GetNext(pMe, &Item);
2283 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002284 goto Done;
2285 }
2286 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002287
Laurence Lundblade1341c592020-04-11 14:19:05 -07002288 if(puNextNestLevel != NULL) {
2289 *puNextNestLevel = Item.uNextNestLevel;
2290 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002291 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002292
Laurence Lundblade1341c592020-04-11 14:19:05 -07002293 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002294 /* item_to_consume is not a map or array */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002295 if(puNextNestLevel != NULL) {
2296 /* Just pass the nesting level through */
2297 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2298 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002299 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002300 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002301
2302Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002303 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002304}
2305
2306
Laurence Lundblade1341c592020-04-11 14:19:05 -07002307/* Return true if the labels in Item1 and Item2 are the same.
2308 Works only for integer and string labels. Returns false
2309 for any other type. */
2310static inline bool
2311MatchLabel(QCBORItem Item1, QCBORItem Item2)
2312{
2313 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2314 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2315 return true;
2316 }
2317 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002318 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002319 return true;
2320 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002321 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002322 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2323 return true;
2324 }
2325 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2326 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2327 return true;
2328 }
2329 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002330
Laurence Lundblade1341c592020-04-11 14:19:05 -07002331 /* Other label types are never matched */
2332 return false;
2333}
2334
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002335
2336/*
2337 Returns true if Item1 and Item2 are the same type
2338 or if either are of QCBOR_TYPE_ANY.
2339 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002340static inline bool
2341MatchType(QCBORItem Item1, QCBORItem Item2)
2342{
2343 if(Item1.uDataType == Item2.uDataType) {
2344 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002345 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002346 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002347 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002348 return true;
2349 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002350 return false;
2351}
2352
2353
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002354/**
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002355 \brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002356
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002357 @param[in] pMe The decode context to search.
2358 @param[in,out] pItemArray The items to search for and the items found.
2359 @param[out] puOffset Byte offset of last item matched.
2360 @param[in] pCBContext Context for the not-found item call back.
2361 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002362
2363 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2364
2365 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label) were found for one of the labels being search for. This duplicate detection is only performed for items in pItemArray, not every item in the map.
2366
2367 @retval QCBOR_ERR_UNEXPECTED_TYPE The label was matched, but not the type.
2368
2369 @retval Also errors returned by QCBORDecode_GetNext().
2370
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002371 On input pItemArray contains a list of labels and data types
2372 of items to be found.
2373
2374 On output the fully retrieved items are filled in with
2375 values and such. The label was matched, so it never changes.
2376
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002377 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002378 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002379static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002380MapSearch(QCBORDecodeContext *pMe,
2381 QCBORItem *pItemArray,
2382 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002383 void *pCBContext,
2384 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002385{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002386 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002387 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002388
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002389 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002390 uReturn = pMe->uLastError;
2391 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002392 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002393
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002394 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002395 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2396 /* QCBOR_TYPE_NONE as first item indicates just looking
2397 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002398 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2399 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002400 }
2401
Laurence Lundblade085d7952020-07-24 10:26:30 -07002402 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2403 // It is an empty bounded array or map
2404 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2405 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002406 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002407 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002408 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002409 // Nothing is ever found in an empty array or map. All items
2410 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002411 uReturn = QCBOR_SUCCESS;
2412 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002413 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002414 }
2415
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002416 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002417 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2418
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002419 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002420 UsefulInputBuf_Seek(&(pMe->InBuf),
2421 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002422
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002423 /*
2424 Loop over all the items in the map. They could be
2425 deeply nested and this should handle both definite
2426 and indefinite length maps and arrays, so this
2427 adds some complexity.
2428 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002429 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002430 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002431 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002432 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002433 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002434
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002435 /* Get the item */
2436 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002437 uReturn = QCBORDecode_GetNext(pMe, &Item);
2438 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002439 /* Got non-well-formed CBOR */
2440 goto Done;
2441 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002442
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002443 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002444 bool bMatched = false;
2445 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2446 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002447 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002448 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2449 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002450 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002451 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002452 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002453 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002454 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002455 goto Done;
2456 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002457
Laurence Lundblade1341c592020-04-11 14:19:05 -07002458 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002459 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002460 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002461 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002462 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002463 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002464 bMatched = true;
2465 }
2466 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002467
2468
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002469 if(!bMatched && pfCallback != NULL) {
2470 /*
2471 Call the callback on unmatched labels.
2472 (It is tempting to do duplicate detection here, but that would
2473 require dynamic memory allocation because the number of labels
2474 that might be encountered is unbounded.)
2475 */
2476 uReturn = (*pfCallback)(pCBContext, &Item);
2477 if(uReturn != QCBOR_SUCCESS) {
2478 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002479 }
2480 }
2481
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002482 /*
2483 Consume the item whether matched or not. This
2484 does the work of traversing maps and array and
2485 everything in them. In this loop only the
2486 items at the current nesting level are examined
2487 to match the labels.
2488 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002489 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
2490 if(uReturn) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002491 goto Done;
2492 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002493
2494 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002495
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002496 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002497
2498 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002499 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2500 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002501
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002502 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002503 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2504
2505 Done2:
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002506 /* For all items not found, set the data type to QCBOR_TYPE_NONE */
2507 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002508 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002509 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002510 }
2511 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002512
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002513 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002514}
2515
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002516
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002517/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002518 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002519*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002520void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2521 int64_t nLabel,
2522 uint8_t uQcborType,
2523 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002524{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002525 if(pMe->uLastError != QCBOR_SUCCESS) {
2526 return;
2527 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002528
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002529 QCBORItem OneItemSeach[2];
2530 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2531 OneItemSeach[0].label.int64 = nLabel;
2532 OneItemSeach[0].uDataType = uQcborType;
2533 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002534
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002535 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2536 if(uReturn != QCBOR_SUCCESS) {
2537 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002538 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002539 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002540 uReturn = QCBOR_ERR_NOT_FOUND;
2541 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002542 }
2543
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002544 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002545
2546 Done:
2547 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002548}
2549
2550
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002551/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002552 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002553*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002554void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2555 const char *szLabel,
2556 uint8_t uQcborType,
2557 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002558{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002559 if(pMe->uLastError != QCBOR_SUCCESS) {
2560 return;
2561 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002562
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002563 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002564 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2565 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2566 OneItemSeach[0].uDataType = uQcborType;
2567 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002568
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002569 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2570 if(uReturn != QCBOR_SUCCESS) {
2571 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002572 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002573 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002574 uReturn = QCBOR_ERR_NOT_FOUND;
2575 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002576 }
2577
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002578 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002579
2580Done:
2581 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002582}
2583
2584
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002585
2586static QCBORError CheckTypeList(uint8_t uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
2587{
2588 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2589 if(uDataType == puTypeList[i]) {
2590 return QCBOR_SUCCESS;
2591 }
2592 }
2593 return QCBOR_ERR_UNEXPECTED_TYPE;
2594}
2595
Laurence Lundblade67257dc2020-07-27 03:33:37 -07002596
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002597/**
2598 @param[in] TagSpec Specification for matching tags.
2599 @param[in] uDataType A QCBOR data type
2600
2601 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
2602 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
2603
2604 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered tag value.
2605 */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002606static QCBORError CheckTagRequirement(const TagSpecification TagSpec, uint8_t uDataType)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002607{
Laurence Lundbladef9175a92020-07-30 21:35:45 -07002608 if(TagSpec.uTagRequirement == QCBOR_TAG_REQUIREMENT_MATCH_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002609 // Must match the tag and only the tag
2610 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002611 }
2612
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002613 QCBORError uReturn = CheckTypeList(uDataType, TagSpec.uAllowedContentTypes);
2614 if(uReturn == QCBOR_SUCCESS) {
2615 return QCBOR_SUCCESS;
2616 }
2617
Laurence Lundbladef9175a92020-07-30 21:35:45 -07002618 if(TagSpec.uTagRequirement == QCBOR_TAG_REQUIREMENT_NO_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002619 /* Must match the content type and only the content type.
2620 There was no match just above so it is a fail. */
2621 return QCBOR_ERR_UNEXPECTED_TYPE;
2622 }
2623
2624 /* If here it can match either the tag or the content
2625 and it hasn't matched the content, so the end
2626 result is whether it matches the tag. This is
2627 also the case that the CBOR standard discourages. */
2628
2629 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002630}
2631
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002632
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002633// Semi-private
2634// TODO: inline or collapse with QCBORDecode_GetTaggedStringInMapN?
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002635void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
2636 int64_t nLabel,
2637 TagSpecification TagSpec,
2638 QCBORItem *pItem)
2639{
2640 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
2641 if(pMe->uLastError != QCBOR_SUCCESS) {
2642 return;
2643 }
2644
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07002645 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002646}
2647
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002648// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002649void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
2650 const char *szLabel,
2651 TagSpecification TagSpec,
2652 QCBORItem *pItem)
2653{
2654 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
2655 if(pMe->uLastError != QCBOR_SUCCESS) {
2656 return;
2657 }
2658
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07002659 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002660}
2661
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002662// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002663void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
2664 int64_t nLabel,
2665 TagSpecification TagSpec,
2666 UsefulBufC *pString)
2667{
2668 QCBORItem Item;
2669 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
2670 if(pMe->uLastError == QCBOR_SUCCESS) {
2671 *pString = Item.val.string;
2672 }
2673}
2674
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002675// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002676void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
2677 const char * szLabel,
2678 TagSpecification TagSpec,
2679 UsefulBufC *pString)
2680{
2681 QCBORItem Item;
2682 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
2683 if(pMe->uLastError == QCBOR_SUCCESS) {
2684 *pString = Item.val.string;
2685 }
2686}
Laurence Lundblade1341c592020-04-11 14:19:05 -07002687
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002688/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002689 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002690*/
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002691QCBORError QCBORDecode_GetItemsInMap(QCBORDecodeContext *pCtx, QCBORItem *pItemList)
2692{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002693 return MapSearch(pCtx, pItemList, NULL, NULL, NULL);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002694}
2695
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002696/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002697 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002698*/
2699QCBORError QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pCtx,
2700 QCBORItem *pItemList,
2701 void *pCallbackCtx,
2702 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002703{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002704 return MapSearch(pCtx, pItemList, NULL, pCallbackCtx, pfCB);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002705}
2706
2707
Laurence Lundblade34691b92020-05-18 22:25:25 -07002708static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07002709{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002710 // TODO: check that only one item is in pSearch?
Laurence Lundblade34691b92020-05-18 22:25:25 -07002711 if(pMe->uLastError != QCBOR_SUCCESS) {
2712 // Already in error state; do nothing.
2713 return;
2714 }
2715
2716 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002717 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002718 if(pMe->uLastError != QCBOR_SUCCESS) {
2719 return;
2720 }
2721
Laurence Lundblade085d7952020-07-24 10:26:30 -07002722 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
2723 pMe->uLastError = QCBOR_ERR_NOT_FOUND;
2724 return;
2725 }
2726
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002727 /* Need to get the current pre-order nesting level and cursor to be
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07002728 at the map/array about to be entered.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002729
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002730 Also need the current map nesting level and start cursor to
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002731 be at the right place.
2732
2733 The UsefulInBuf offset could be anywhere, so no assumption is
2734 made about it.
2735
2736 No assumption is made about the pre-order nesting level either.
2737
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002738 However the bounded mode nesting level is assumed to be one above
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002739 the map level that is being entered.
2740 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002741 /* Seek to the data item that is the map or array */
2742 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002743
2744 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002745
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002746 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002747}
2748
2749
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002750/*
2751Public function, see header qcbor/qcbor_decode.h file
2752*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002753void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002754{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002755 QCBORItem OneItemSeach[2];
2756 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2757 OneItemSeach[0].label.int64 = nLabel;
2758 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2759 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002760
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002761 /* The map to enter was found, now finish of entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002762 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002763}
2764
2765
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002766/*
2767Public function, see header qcbor/qcbor_decode.h file
2768*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002769void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002770{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002771 QCBORItem OneItemSeach[2];
2772 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2773 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2774 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2775 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002776
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002777 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002778}
2779
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002780/*
2781Public function, see header qcbor/qcbor_decode.h file
2782*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002783void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07002784{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002785 QCBORItem OneItemSeach[2];
2786 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2787 OneItemSeach[0].label.int64 = nLabel;
2788 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
2789 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002790
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002791 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002792}
2793
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002794/*
2795Public function, see header qcbor/qcbor_decode.h file
2796*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002797void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
2798{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002799 QCBORItem OneItemSeach[2];
2800 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2801 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2802 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
2803 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002804
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002805 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002806}
2807
2808
Laurence Lundblade02625d42020-06-25 14:41:41 -07002809// Semi-private function
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002810void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002811{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002812 QCBORError uErr;
2813
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002814 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07002815 if(pMe->uLastError != QCBOR_SUCCESS) {
2816 // Already in error state; do nothing.
2817 return;
2818 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002819
2820 /* Get the data item that is the map that is being searched */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002821 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002822 uErr = QCBORDecode_GetNext(pMe, &Item);
2823 if(uErr != QCBOR_SUCCESS) {
2824 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07002825 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002826 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002827 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
2828 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002829 }
2830
Laurence Lundbladef0499502020-08-01 11:55:57 -07002831 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07002832 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002833 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
2834 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002835 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002836 pMe->nesting.pCurrent->u.ma.uCountCursor++;
2837 }
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002838 // Special case to increment nesting level for zero-length maps and arrays entered in bounded mode.
2839 DecodeNesting_Descend(&(pMe->nesting), uType);
2840 }
2841
Laurence Lundblade02625d42020-06-25 14:41:41 -07002842 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002843
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002844 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
2845 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002846
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002847Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002848 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002849}
2850
Laurence Lundblade02625d42020-06-25 14:41:41 -07002851
2852/*
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002853 This is the common work for exiting a level that is a bounded map, array or bstr
2854 wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07002855
2856 One chunk of work is to set up the pre-order traversal so it is at
2857 the item just after the bounded map, array or bstr that is being
2858 exited. This is somewhat complex.
2859
2860 The other work is to level-up the bounded mode to next higest bounded
2861 mode or the top level if there isn't one.
2862 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002863static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07002864ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002865{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002866 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002867
Laurence Lundblade02625d42020-06-25 14:41:41 -07002868 /*
2869 First the pre-order-traversal byte offset is positioned to the
2870 item just after the bounded mode item that was just consumed.
2871 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002872 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
2873
Laurence Lundblade02625d42020-06-25 14:41:41 -07002874 /*
2875 Next, set the current nesting level to one above the bounded level
2876 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002877
Laurence Lundblade02625d42020-06-25 14:41:41 -07002878 DecodeNesting_CheckBoundedType() is always called before this and
2879 makes sure pCurrentBounded is valid.
2880 */
2881 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
2882
2883 /*
2884 This does the complex work of leveling up the pre-order traversal
2885 when the end of a map or array or another bounded level is
2886 reached. It may do nothing, or ascend all the way to the top
2887 level.
2888 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07002889 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002890 if(uErr != QCBOR_SUCCESS) {
2891 goto Done;
2892 }
2893
Laurence Lundblade02625d42020-06-25 14:41:41 -07002894 /*
2895 This makes the next highest bounded level the current bounded
2896 level. If there is no next highest level, then no bounded mode is
2897 in effect.
2898 */
2899 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002900
Laurence Lundblade02625d42020-06-25 14:41:41 -07002901 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002902
2903Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07002904 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ExitBoundedLevel");
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002905 return uErr;
2906}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002907
Laurence Lundblade02625d42020-06-25 14:41:41 -07002908
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002909// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07002910void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002911{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002912 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07002913 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002914 return;
2915 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002916
Laurence Lundblade02625d42020-06-25 14:41:41 -07002917 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002918
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002919 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002920 uErr = QCBOR_ERR_CLOSE_MISMATCH;
2921 goto Done;
2922 }
2923
Laurence Lundblade02625d42020-06-25 14:41:41 -07002924 /*
2925 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002926 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002927 from previous map search, then do a dummy search.
2928 */
2929 if(pMe->uMapEndOffsetCache == MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002930 QCBORItem Dummy;
2931 Dummy.uLabelType = QCBOR_TYPE_NONE;
2932 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
2933 if(uErr != QCBOR_SUCCESS) {
2934 goto Done;
2935 }
2936 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002937
Laurence Lundblade02625d42020-06-25 14:41:41 -07002938 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002939
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002940Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002941 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002942}
2943
2944
Laurence Lundblade1341c592020-04-11 14:19:05 -07002945
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002946static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002947 const QCBORItem *pItem,
2948 uint8_t uTagRequirement,
2949 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002950{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002951 if(pBstr) {
2952 *pBstr = NULLUsefulBufC;
2953 }
2954
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002955 if(pMe->uLastError != QCBOR_SUCCESS) {
2956 // Already in error state; do nothing.
2957 return pMe->uLastError;
2958 }
2959
2960 QCBORError uError = QCBOR_SUCCESS;
2961
2962 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
2963 uError = QCBOR_ERR_UNEXPECTED_TYPE;
2964 goto Done;;
2965 }
2966
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002967 const TagSpecification TagSpec = {uTagRequirement,
2968 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
2969 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
2970 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002971
2972 uError = CheckTagRequirement(TagSpec, pItem->uDataType);
2973 if(uError != QCBOR_SUCCESS) {
2974 goto Done;
2975 }
2976
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002977 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07002978 /* Reverse the decrement done by GetNext() for the bstr as
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002979 so the increment in NestLevelAscender called by ExitBoundedLevel()
2980 will work right. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002981 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07002982 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07002983
2984 if(pBstr) {
2985 *pBstr = pItem->val.string;
2986 }
2987
2988 const size_t uPreviousLength = UsefulInputBuf_GetLength(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002989
2990 // Need to move UIB input cursor to the right place
2991
2992 // Really this is a subtraction and an assignment; not much code
2993 // There is a range check in the seek.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07002994 // The bstr was just consumed so the cursor is at the next item after it
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002995
Laurence Lundblade0750fc42020-06-20 21:02:34 -07002996 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002997
Laurence Lundblade0750fc42020-06-20 21:02:34 -07002998 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
2999
3000 UsefulInputBuf_SetBufferLen(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003001
Laurence Lundblade02625d42020-06-25 14:41:41 -07003002 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
3003 uPreviousLength,
3004 uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003005Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07003006 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "Entered Bstr");
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003007
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003008 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003009}
3010
3011
Laurence Lundblade02625d42020-06-25 14:41:41 -07003012/*
3013 Public function, see header qcbor/qcbor_decode.h file
3014 */
3015void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003016 uint8_t uTagRequirement,
3017 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003018{
3019 if(pMe->uLastError != QCBOR_SUCCESS) {
3020 // Already in error state; do nothing.
3021 return;
3022 }
3023
3024 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003025 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003026 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3027 if(pMe->uLastError != QCBOR_SUCCESS) {
3028 return;
3029 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003030
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003031 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003032 &Item,
3033 uTagRequirement,
3034 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003035}
3036
3037
Laurence Lundblade02625d42020-06-25 14:41:41 -07003038/*
3039 Public function, see header qcbor/qcbor_decode.h file
3040 */
3041void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
3042 uint8_t uTagRequirement,
3043 int64_t nLabel,
3044 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003045{
3046 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003047 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003048
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003049 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003050}
3051
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003052
Laurence Lundblade02625d42020-06-25 14:41:41 -07003053/*
3054 Public function, see header qcbor/qcbor_decode.h file
3055 */
3056void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
3057 uint8_t uTagRequirement,
3058 const char *szLabel,
3059 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003060{
3061 QCBORItem Item;
3062 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3063
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003064 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003065}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003066
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003067
Laurence Lundblade02625d42020-06-25 14:41:41 -07003068/*
3069 Public function, see header qcbor/qcbor_decode.h file
3070 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003071void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003072{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003073 if(pMe->uLastError != QCBOR_SUCCESS) {
3074 // Already in error state; do nothing.
3075 return;
3076 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003077
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003078 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003079 pMe->uLastError = QCBOR_ERR_CLOSE_MISMATCH;
3080 return;
3081 }
3082
3083 /*
3084 Reset the length of the UsefulInputBuf to what it was before
3085 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003086 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003087 UsefulInputBuf_SetBufferLen(&(pMe->InBuf),
3088 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003089
3090
Laurence Lundblade02625d42020-06-25 14:41:41 -07003091 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003092 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003093}
3094
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003095
Laurence Lundbladee6430642020-03-14 21:15:44 -07003096
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003097
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003098
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003099
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003100
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003101
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003102static QCBORError InterpretBool(const QCBORItem *pItem, bool *pBool)
3103{
3104 switch(pItem->uDataType) {
3105 case QCBOR_TYPE_TRUE:
3106 *pBool = true;
3107 return QCBOR_SUCCESS;
3108 break;
3109
3110 case QCBOR_TYPE_FALSE:
3111 *pBool = false;
3112 return QCBOR_SUCCESS;
3113 break;
3114
3115 default:
3116 return QCBOR_ERR_UNEXPECTED_TYPE;
3117 break;
3118 }
3119}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003120
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003121/*
3122Public function, see header qcbor/qcbor_decode.h file
3123*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003124void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003125{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003126 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003127 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003128 return;
3129 }
3130
Laurence Lundbladec4537442020-04-14 18:53:22 -07003131 QCBORError nError;
3132 QCBORItem Item;
3133
3134 nError = QCBORDecode_GetNext(pMe, &Item);
3135 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003136 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003137 return;
3138 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003139 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003140}
3141
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003142/*
3143Public function, see header qcbor/qcbor_decode.h file
3144*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003145void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003146{
3147 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003148 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003149
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003150 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003151}
3152
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003153/*
3154Public function, see header qcbor/qcbor_decode.h file
3155*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003156void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3157{
3158 QCBORItem Item;
3159 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3160
3161 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
3162}
3163
3164
3165
3166void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe, TagSpecification TagSpec, UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003167{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003168 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003169 // Already in error state, do nothing
3170 return;
3171 }
3172
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003173 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003174 QCBORItem Item;
3175
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003176 uError = QCBORDecode_GetNext(pMe, &Item);
3177 if(uError != QCBOR_SUCCESS) {
3178 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003179 return;
3180 }
3181
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003182 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, Item.uDataType);
3183
3184 if(pMe->uLastError == QCBOR_SUCCESS) {
3185 *pBstr = Item.val.string;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003186 }
3187}
3188
Laurence Lundbladec4537442020-04-14 18:53:22 -07003189
3190
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003191
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003192static QCBORError ConvertBigNum(uint8_t uTagRequirement,
3193 const QCBORItem *pItem,
3194 UsefulBufC *pValue,
3195 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003196{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003197 const TagSpecification TagSpec = {uTagRequirement,
3198 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE},
3199 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3200 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003201
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003202 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
3203 if(uErr != QCBOR_SUCCESS) {
3204 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003205 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003206
3207 *pValue = pItem->val.string;
3208
3209 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3210 *pbIsNegative = false;
3211 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3212 *pbIsNegative = true;
3213 }
3214
3215 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003216}
3217
3218
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003219/**
3220 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003221 */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003222void QCBORDecode_GetBignum(QCBORDecodeContext *pMe, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003223{
3224 if(pMe->uLastError != QCBOR_SUCCESS) {
3225 // Already in error state, do nothing
3226 return;
3227 }
3228
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003229 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003230 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3231 if(uError != QCBOR_SUCCESS) {
3232 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003233 return;
3234 }
3235
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003236 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003237}
3238
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003239/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003240Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003241*/
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003242void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003243{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003244 QCBORItem Item;
3245 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003246
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003247 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003248}
3249
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003250/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003251Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003252*/
3253void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
3254{
3255 QCBORItem Item;
3256 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3257
3258 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
3259}
3260
3261
3262
3263// Semi private
Laurence Lundbladef9175a92020-07-30 21:35:45 -07003264QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement, const QCBORItem *pItem, UsefulBufC *pMessage, bool *pbIsNot7Bit)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003265{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003266 const TagSpecification TagSpecText = {uTagRequirement,
3267 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3268 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3269 };
3270 const TagSpecification TagSpecBinary = {uTagRequirement,
3271 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3272 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3273 };
3274
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003275 QCBORError uReturn;
3276
3277 if(CheckTagRequirement(TagSpecText, pItem->uDataType)) {
3278 *pMessage = pItem->val.string;
3279 if(pbIsNot7Bit != NULL) {
3280 *pbIsNot7Bit = false;
3281 }
3282 uReturn = QCBOR_SUCCESS;
3283 } else if(CheckTagRequirement(TagSpecBinary, pItem->uDataType)) {
3284 *pMessage = pItem->val.string;
3285 if(pbIsNot7Bit != NULL) {
3286 *pbIsNot7Bit = true;
3287 }
3288 uReturn = QCBOR_SUCCESS;
3289
3290 } else {
3291 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3292 }
3293
3294 return uReturn;
3295}
3296
3297
3298
3299
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003300#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003301
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003302typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003303
3304
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003305// The main exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003306static QCBORError Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003307{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003308 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003309
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003310 if(uResult != 0) {
3311 /* This loop will run a maximum of 19 times because
3312 * UINT64_MAX < 10 ^^ 19. More than that will cause
3313 * exit with the overflow error
3314 */
3315 for(; nExponent > 0; nExponent--) {
3316 if(uResult > UINT64_MAX / 10) {
3317 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3318 }
3319 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003320 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003321
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003322 for(; nExponent < 0; nExponent++) {
3323 uResult = uResult / 10;
3324 if(uResult == 0) {
3325 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3326 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003327 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003328 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003329 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003330
3331 *puResult = uResult;
3332
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003333 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003334}
3335
3336
Laurence Lundbladee6430642020-03-14 21:15:44 -07003337/* Convert a decimal fraction to an int64_t without using
3338 floating point or math libraries. Most decimal fractions
3339 will not fit in an int64_t and this will error out with
3340 under or overflow
3341 */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003342static QCBORError Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003343{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003344 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003345
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003346 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003347
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003348 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003349 * INT64_MAX < 2^31. More than that will cause
3350 * exist with the overflow error
3351 */
3352 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003353 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003354 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003355 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003356 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003357 nExponent--;
3358 }
3359
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003360 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003361 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003362 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3363 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003364 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003365 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003366 }
3367
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003368 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003369
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003370 return QCBOR_SUCCESS;
3371}
3372
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003373/*
3374 Compute value with signed mantissa and signed result. Works with exponent of 2 or 10 based on exponentiator.
3375 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003376static inline QCBORError ExponentiateNN(int64_t nMantissa, int64_t nExponent, int64_t *pnResult, fExponentiator pfExp)
3377{
3378 uint64_t uResult;
3379
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003380 // Take the absolute value of the mantissa and convert to unsigned.
3381 // TODO: this should be possible in one intruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003382 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3383
3384 // Do the exponentiation of the positive mantissa
3385 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3386 if(uReturn) {
3387 return uReturn;
3388 }
3389
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003390
Laurence Lundblade983500d2020-05-14 11:49:34 -07003391 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3392 of INT64_MIN. This assumes two's compliment representation where
3393 INT64_MIN is one increment farther from 0 than INT64_MAX.
3394 Trying to write -INT64_MIN doesn't work to get this because the
3395 compiler tries to work with an int64_t which can't represent
3396 -INT64_MIN.
3397 */
3398 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3399
3400 // Error out if too large
3401 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003402 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3403 }
3404
3405 // Casts are safe because of checks above
3406 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
3407
3408 return QCBOR_SUCCESS;
3409}
3410
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003411/*
3412 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3413 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003414static inline QCBORError ExponentitateNU(int64_t nMantissa, int64_t nExponent, uint64_t *puResult, fExponentiator pfExp)
3415{
3416 if(nMantissa < 0) {
3417 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3418 }
3419
3420 // Cast to unsigned is OK because of check for negative
3421 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
3422 // Exponentiation is straight forward
3423 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
3424}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003425#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
3426
3427
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003428
3429
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003430#include <math.h>
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003431
3432
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003433static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003434{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003435 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003436
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003437 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003438 const uint8_t *pByte = BigNum.ptr;
3439 size_t uLen = BigNum.len;
3440 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07003441 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003442 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003443 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07003444 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003445 }
3446
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003447 *pResult = uResult;
3448 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003449}
3450
Laurence Lundblade887add82020-05-17 05:50:34 -07003451static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003452{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003453 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003454}
3455
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003456static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003457{
3458 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003459 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
3460 if(uError) {
3461 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003462 }
3463 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
3464 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003465 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003466}
3467
3468
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003469static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003470{
3471 uint64_t uResult;
Laurence Lundbladeda095972020-06-06 18:35:33 -07003472 /* negaative int furthest from zero is INT64_MIN
3473 which is expressed as -INT64_MAX-1. The value of
3474 a negative bignum is -n-1, one further from zero
3475 than the positive bignum */
3476
3477 /* say INT64_MIN is -2; then INT64_MAX is 1.
3478 Then -n-1 <= INT64_MIN.
3479 Then -n -1 <= -INT64_MAX - 1
3480 THen n <= INT64_MAX. */
3481 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003482 if(uError) {
3483 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003484 }
3485 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
Laurence Lundblade887add82020-05-17 05:50:34 -07003486 // TODO: this code is incorrect. See RFC 7049
Laurence Lundbladeda095972020-06-06 18:35:33 -07003487 uResult++; // this is the -1 in -n-1
Laurence Lundbladee6430642020-03-14 21:15:44 -07003488 *pResult = -(int64_t)uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003489 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003490}
3491
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003492
3493static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
3494{
3495 while((uInt & 0xff00000000000000UL) == 0) {
3496 uInt = uInt << 8;
3497 };
3498
3499 UsefulOutBuf UOB;
3500
3501 UsefulOutBuf_Init(&UOB, Buffer);
3502
3503 while(uInt) {
3504 const uint64_t xx = uInt & 0xff00000000000000UL;
3505 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
3506 uInt = uInt << 8;
3507 (void)xx;
3508 }
3509
3510 return UsefulOutBuf_OutUBuf(&UOB);
3511}
3512
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003513#include "fenv.h"
Laurence Lundbladec4537442020-04-14 18:53:22 -07003514
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003515
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003516/*
3517Convert a integers and floats to an int64_t.
3518
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003519\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003520
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003521\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003522
3523\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3524
3525\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3526
3527*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003528static QCBORError ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003529{
3530 switch(pItem->uDataType) {
3531 // TODO: float when ifdefs are set
3532 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003533 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003534 // TODO: what about under/overflow here?
3535 // Invokes the floating-point HW and/or compiler-added libraries
3536 feclearexcept(FE_ALL_EXCEPT);
3537 *pnValue = llround(pItem->val.dfnum);
3538 if(fetestexcept(FE_INVALID)) {
3539 // TODO: better error code
3540 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3541 }
3542 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003543 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003544 }
3545 break;
3546
3547 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003548 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003549 *pnValue = pItem->val.int64;
3550 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003551 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003552 }
3553 break;
3554
3555 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003556 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003557 if(pItem->val.uint64 < INT64_MAX) {
3558 *pnValue = pItem->val.int64;
3559 } else {
3560 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3561 }
3562 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003563 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003564 }
3565 break;
3566
3567 default:
3568 return QCBOR_ERR_UNEXPECTED_TYPE;
3569 }
3570 return QCBOR_SUCCESS;
3571}
3572
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003573
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003574void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003575 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003576 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003577 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003578{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003579 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003580 return;
3581 }
3582
Laurence Lundbladee6430642020-03-14 21:15:44 -07003583 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003584 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3585 if(uError) {
3586 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003587 return;
3588 }
3589
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003590 if(pItem) {
3591 *pItem = Item;
3592 }
3593
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003594 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003595}
3596
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003597
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003598void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3599 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003600 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003601 int64_t *pnValue,
3602 QCBORItem *pItem)
3603{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003604 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003605 if(pMe->uLastError != QCBOR_SUCCESS) {
3606 return;
3607 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003608
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003609 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003610}
3611
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003612
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003613void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
3614 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003615 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003616 int64_t *pnValue,
3617 QCBORItem *pItem)
3618{
3619 if(pMe->uLastError != QCBOR_SUCCESS) {
3620 return;
3621 }
3622
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003623 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003624 if(pMe->uLastError != QCBOR_SUCCESS) {
3625 return;
3626 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003627
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003628 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003629}
3630
3631
3632
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003633/*
3634 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003635
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003636 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003637
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003638 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003639
3640 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3641
3642 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3643
3644 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003645static QCBORError Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003646{
3647 QCBORError uErr;
3648
3649 switch(pItem->uDataType) {
3650
3651 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003652 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003653 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003654 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003655 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003656 }
3657 break;
3658
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003659 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003660 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003661 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003662 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003663 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003664 }
3665 break;
3666
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003667#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
3668 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003669 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003670 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
3671 pItem->val.expAndMantissa.nExponent,
3672 pnValue,
3673 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003674 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003675 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003676 }
3677 break;
3678
3679 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003680 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003681 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
3682 pItem->val.expAndMantissa.nExponent,
3683 pnValue,
3684 Exponentitate2);
3685 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003686 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003687 }
3688 break;
3689
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003690 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003691 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003692 int64_t nMantissa;
3693 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3694 if(uErr) {
3695 return uErr;
3696 }
3697 return ExponentiateNN(nMantissa,
3698 pItem->val.expAndMantissa.nExponent,
3699 pnValue,
3700 Exponentitate10);
3701 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003702 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003703 }
3704 break;
3705
3706 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003707 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003708 int64_t nMantissa;
3709 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3710 if(uErr) {
3711 return uErr;
3712 }
3713 return ExponentiateNN(nMantissa,
3714 pItem->val.expAndMantissa.nExponent,
3715 pnValue,
3716 Exponentitate10);
3717 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003718 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003719 }
3720 break;
3721
3722 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003723 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003724 int64_t nMantissa;
3725 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3726 if(uErr) {
3727 return uErr;
3728 }
3729 return ExponentiateNN(nMantissa,
3730 pItem->val.expAndMantissa.nExponent,
3731 pnValue,
3732 Exponentitate2);
3733 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003734 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003735 }
3736 break;
3737
3738 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003739 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003740 int64_t nMantissa;
3741 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3742 if(uErr) {
3743 return uErr;
3744 }
3745 return ExponentiateNN(nMantissa,
3746 pItem->val.expAndMantissa.nExponent,
3747 pnValue,
3748 Exponentitate2);
3749 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003750 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003751 }
3752 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003753#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
3754
Laurence Lundbladee6430642020-03-14 21:15:44 -07003755
Laurence Lundbladec4537442020-04-14 18:53:22 -07003756 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003757 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003758}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003759
3760
Laurence Lundbladec4537442020-04-14 18:53:22 -07003761/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003762 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003763 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003764void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003765{
3766 QCBORItem Item;
3767
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003768 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003769
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003770 if(pMe->uLastError == QCBOR_SUCCESS) {
3771 // The above conversion succeeded
3772 return;
3773 }
3774
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003775 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003776 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07003777 return;
3778 }
3779
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003780 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003781}
3782
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003783
3784/*
3785Public function, see header qcbor/qcbor_decode.h file
3786*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003787void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003788{
3789 QCBORItem Item;
3790
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003791 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003792
3793 if(pMe->uLastError == QCBOR_SUCCESS) {
3794 // The above conversion succeeded
3795 return;
3796 }
3797
3798 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3799 // The above conversion failed in a way that code below can't correct
3800 return;
3801 }
3802
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003803 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003804}
3805
3806
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003807/*
3808Public function, see header qcbor/qcbor_decode.h file
3809*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003810void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003811{
3812 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003813 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003814
3815 if(pMe->uLastError == QCBOR_SUCCESS) {
3816 // The above conversion succeeded
3817 return;
3818 }
3819
3820 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3821 // The above conversion failed in a way that code below can't correct
3822 return;
3823 }
3824
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003825 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003826}
3827
3828
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003829static QCBORError ConvertUint64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003830{
3831 switch(pItem->uDataType) {
3832 // TODO: type flaot
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07003833 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003834 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003835 feclearexcept(FE_ALL_EXCEPT);
3836 double dRounded = round(pItem->val.dfnum);
3837 // TODO: over/underflow
3838 if(fetestexcept(FE_INVALID)) {
3839 // TODO: better error code
3840 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3841 } else if(isnan(dRounded)) {
3842 // TODO: better error code
3843 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3844 } else if(dRounded >= 0) {
3845 *puValue = (uint64_t)dRounded;
3846 } else {
3847 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3848 }
3849 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003850 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003851 }
3852 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003853
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003854 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003855 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003856 if(pItem->val.int64 >= 0) {
3857 *puValue = (uint64_t)pItem->val.int64;
3858 } else {
3859 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3860 }
3861 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003862 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003863 }
3864 break;
3865
3866 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003867 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003868 *puValue = pItem->val.uint64;
3869 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003870 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003871 }
3872 break;
3873
3874 default:
3875 return QCBOR_ERR_UNEXPECTED_TYPE;
3876 }
3877 return QCBOR_SUCCESS;
3878}
Laurence Lundbladec4537442020-04-14 18:53:22 -07003879
3880
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003881void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003882 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003883 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003884 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003885{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003886 if(pMe->uLastError != QCBOR_SUCCESS) {
3887 return;
3888 }
3889
Laurence Lundbladec4537442020-04-14 18:53:22 -07003890 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003891
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003892 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3893 if(uError) {
3894 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003895 return;
3896 }
3897
Laurence Lundbladea826c502020-05-10 21:07:00 -07003898 if(pItem) {
3899 *pItem = Item;
3900 }
3901
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003902 pMe->uLastError = (uint8_t)ConvertUint64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003903}
3904
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003905
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003906void QCBORDecode_GetInt8ConvertInternal(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int8_t *pnValue, QCBORItem *pItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003907{
3908 int64_t uValue;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003909 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, &uValue, pItem);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003910 if(pMe->uLastError != QCBOR_SUCCESS) {
3911 return;
3912 }
3913
3914 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3915 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3916 }
3917}
3918
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003919void QCBORDecode_GetInt8ConvertInternalInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uConvertTypes, int8_t *pnValue, QCBORItem *pItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003920{
3921 int64_t uValue;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003922 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, &uValue, pItem);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003923 if(pMe->uLastError != QCBOR_SUCCESS) {
3924 return;
3925 }
3926
3927 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3928 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3929 }
3930}
3931
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003932void QCBORDecode_GetInt8ConvertInternalInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uConvertTypes, int8_t *pnValue, QCBORItem *pItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003933{
3934 int64_t uValue;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003935 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, &uValue, pItem);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003936 if(pMe->uLastError != QCBOR_SUCCESS) {
3937 return;
3938 }
3939
3940 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3941 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3942 }
3943}
3944
3945
3946
3947
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003948void QCBORDecode_GetUint64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3949 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003950 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003951 uint64_t *puValue,
3952 QCBORItem *pItem)
3953{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003954 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003955 if(pMe->uLastError != QCBOR_SUCCESS) {
3956 return;
3957 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003958
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003959 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003960}
3961
3962
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003963void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003964 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003965 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003966 uint64_t *puValue,
3967 QCBORItem *pItem)
3968{
3969 if(pMe->uLastError != QCBOR_SUCCESS) {
3970 return;
3971 }
3972
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003973 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003974 if(pMe->uLastError != QCBOR_SUCCESS) {
3975 return;
3976 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003977
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003978 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003979}
3980
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003981/*
3982 Public function, see header qcbor/qcbor_decode.h file
3983*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003984static QCBORError Uint64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003985{
3986 QCBORError uErr;
3987
3988 switch(pItem->uDataType) {
3989
3990 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003991 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003992 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
3993 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003994 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003995 }
3996 break;
3997
3998 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07003999 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004000 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4001 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004002 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004003 }
4004 break;
4005
4006#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4007
4008 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004009 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004010 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4011 pItem->val.expAndMantissa.nExponent,
4012 puValue,
4013 Exponentitate10);
4014 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004015 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004016 }
4017 break;
4018
4019 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004020 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004021 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4022 pItem->val.expAndMantissa.nExponent,
4023 puValue,
4024 Exponentitate2);
4025 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004026 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004027 }
4028 break;
4029
4030 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004031 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004032 // TODO: Would be better to convert to unsigned
4033 int64_t nMantissa;
4034 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4035 if(uErr != QCBOR_SUCCESS) {
4036 return uErr;
4037 }
4038 return ExponentitateNU(nMantissa,
4039 pItem->val.expAndMantissa.nExponent,
4040 puValue,
4041 Exponentitate10);
4042 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004043 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004044 }
4045 break;
4046
4047 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004048 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004049 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4050 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004051 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004052 }
4053 break;
4054
4055 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004056 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004057 // TODO: Would be better to convert to unsigned
4058 int64_t nMantissa;
4059 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4060 if(uErr != QCBOR_SUCCESS) {
4061 return uErr;
4062 }
4063 return ExponentitateNU(nMantissa,
4064 pItem->val.expAndMantissa.nExponent,
4065 puValue,
4066 Exponentitate2);
4067 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004068 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004069 }
4070 break;
4071
4072 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004073 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004074 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4075 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004076 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004077 }
4078 break;
4079#endif
4080 default:
4081 return QCBOR_ERR_UNEXPECTED_TYPE;
4082 }
4083}
4084
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004085/*
4086 Public function, see header qcbor/qcbor_decode.h file
4087*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004088void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004089{
4090 QCBORItem Item;
4091
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004092 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004093
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004094 if(pMe->uLastError == QCBOR_SUCCESS) {
4095 // The above conversion succeeded
4096 return;
4097 }
4098
4099 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4100 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004101 return;
4102 }
4103
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004104 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004105}
4106
Laurence Lundbladec4537442020-04-14 18:53:22 -07004107
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004108/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004109 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004110*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004111void QCBORDecode_GetUint64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004112{
4113 QCBORItem Item;
4114
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004115 QCBORDecode_GetUint64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004116
4117 if(pMe->uLastError == QCBOR_SUCCESS) {
4118 // The above conversion succeeded
4119 return;
4120 }
4121
4122 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4123 // The above conversion failed in a way that code below can't correct
4124 return;
4125 }
4126
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004127 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004128}
4129
4130
4131/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004132 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004133*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004134void QCBORDecode_GetUint64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004135{
4136 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004137 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004138
4139 if(pMe->uLastError == QCBOR_SUCCESS) {
4140 // The above conversion succeeded
4141 return;
4142 }
4143
4144 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4145 // The above conversion failed in a way that code below can't correct
4146 return;
4147 }
4148
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004149 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004150}
4151
4152
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004153static QCBORError ConvertDouble(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004154{
4155 switch(pItem->uDataType) {
4156 // TODO: float when ifdefs are set
4157 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004158 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4159 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004160 *pdValue = pItem->val.dfnum;
4161 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004162 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004163 }
4164 }
4165 break;
4166
4167 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004168 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004169 // TODO: how does this work?
4170 *pdValue = (double)pItem->val.int64;
4171
4172 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004173 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004174 }
4175 break;
4176
4177 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004178 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004179 *pdValue = (double)pItem->val.uint64;
4180 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004181 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004182 }
4183 break;
4184
4185 default:
4186 return QCBOR_ERR_UNEXPECTED_TYPE;
4187 }
4188
4189 return QCBOR_SUCCESS;
4190}
4191
4192
4193
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004194void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004195 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004196 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004197 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004198{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004199 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004200 return;
4201 }
4202
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004203 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004204
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004205 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004206 if(uError) {
4207 pMe->uLastError = (uint8_t)uError;
4208 return;
4209 }
4210
4211 if(pItem) {
4212 *pItem = Item;
4213 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004214
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004215 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004216}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004217
Laurence Lundbladec4537442020-04-14 18:53:22 -07004218
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004219void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4220 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004221 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004222 double *pdValue,
4223 QCBORItem *pItem)
4224{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004225 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004226 if(pMe->uLastError != QCBOR_SUCCESS) {
4227 return;
4228 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004229
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004230 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004231}
4232
4233void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4234 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004235 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004236 double *pdValue,
4237 QCBORItem *pItem)
4238{
4239 if(pMe->uLastError != QCBOR_SUCCESS) {
4240 return;
4241 }
4242
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004243 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004244 if(pMe->uLastError != QCBOR_SUCCESS) {
4245 return;
4246 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004247
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004248 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004249}
4250
4251
4252
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004253static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4254{
4255 double dResult;
4256
4257 dResult = 0.0;
4258 const uint8_t *pByte = BigNum.ptr;
4259 size_t uLen = BigNum.len;
4260 /* This will overflow and become the float value INFINITY if the number
4261 is too large to fit. No error will be logged.
4262 TODO: should an error be logged? */
4263 while(uLen--) {
4264 dResult = (dResult * 256.0) + (double)*pByte++;
4265 }
4266
4267 return dResult;
4268}
4269
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004270static QCBORError DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004271{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004272 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004273 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4274
4275 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004276 switch(pItem->uDataType) {
4277 // TODO: type float
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004278
4279#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004280 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004281 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004282 // TODO: rounding and overflow errors
4283 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4284 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4285 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004286 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004287 }
4288 break;
4289
4290 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004291 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004292 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4293 exp2((double)pItem->val.expAndMantissa.nExponent);
4294 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004295 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004296 }
4297 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004298#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004299
4300 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004301 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004302 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4303 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004304 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004305 }
4306 break;
4307
4308 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004309 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004310 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004311 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004312 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004313 }
4314 break;
4315
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004316#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004317 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004318 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004319 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4320 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4321 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004322 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004323 }
4324 break;
4325
4326 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004327 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004328 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4329 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4330 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004331 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004332 }
4333 break;
4334
4335 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004336 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004337 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4338 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4339 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004340 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004341 }
4342 break;
4343
4344 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004345 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004346 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004347 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4348 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004349 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004350 }
4351 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004352#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4353
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004354
4355 default:
4356 return QCBOR_ERR_UNEXPECTED_TYPE;
4357 }
4358
4359 return QCBOR_SUCCESS;
4360}
4361
4362
4363/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004364 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004365*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004366void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004367{
4368
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004369 QCBORItem Item;
4370
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004371 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004372
4373 if(pMe->uLastError == QCBOR_SUCCESS) {
4374 // The above conversion succeeded
4375 return;
4376 }
4377
4378 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4379 // The above conversion failed in a way that code below can't correct
4380 return;
4381 }
4382
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004383 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004384}
4385
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004386
4387/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004388 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004389*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004390void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004391{
4392 QCBORItem Item;
4393
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004394 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004395
4396 if(pMe->uLastError == QCBOR_SUCCESS) {
4397 // The above conversion succeeded
4398 return;
4399 }
4400
4401 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4402 // The above conversion failed in a way that code below can't correct
4403 return;
4404 }
4405
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004406 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004407}
4408
4409
4410/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004411 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004412*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004413void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uConvertTypes, double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004414{
4415 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004416 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004417
4418 if(pMe->uLastError == QCBOR_SUCCESS) {
4419 // The above conversion succeeded
4420 return;
4421 }
4422
4423 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4424 // The above conversion failed in a way that code below can't correct
4425 return;
4426 }
4427
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004428 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004429}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004430
4431
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004432
4433
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004434#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004435static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
4436 TagSpecification TagSpec,
4437 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004438{
4439 QCBORError uErr;
4440 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004441 while(1) {
4442 uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
4443 if(uErr != QCBOR_SUCCESS) {
4444 goto Done;
4445 }
4446
4447 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
4448 break; // Successful exit. Moving on to finish decoding.
4449 }
4450
4451 // The item is an array, which means an undecoded
4452 // mantissa and exponent, so decode it. It will then
4453 // have a different type and exit the loop if.
4454 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4455 if(uErr != QCBOR_SUCCESS) {
4456 goto Done;
4457 }
4458
4459 // Second time around, the type must match.
4460 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_MATCH_TAG;
4461 }
4462Done:
4463 return uErr;
4464}
4465
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004466
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004467static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004468 TagSpecification TagSpec,
4469 QCBORItem *pItem,
4470 int64_t *pnMantissa,
4471 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004472{
4473 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004474
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004475 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004476 if(uErr != QCBOR_SUCCESS) {
4477 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004478 }
4479
4480 switch (pItem->uDataType) {
4481
4482 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004483 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004484 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
4485 *pnExponent = pItem->val.expAndMantissa.nExponent;
4486 break;
4487
4488 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004489 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004490 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004491 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004492 break;
4493
4494 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004495 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004496 *pnExponent = pItem->val.expAndMantissa.nExponent;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004497 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004498 break;
4499
4500 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004501 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004502 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004503
4504 Done:
4505 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004506}
4507
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004508
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004509static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004510 TagSpecification TagSpec,
4511 QCBORItem *pItem,
4512 UsefulBuf BufferForMantissa,
4513 UsefulBufC *pMantissa,
4514 bool *pbIsNegative,
4515 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004516{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004517 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004518
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004519 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004520 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004521 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004522 }
4523
4524 uint64_t uMantissa;
4525
4526 switch (pItem->uDataType) {
4527
4528 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004529 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004530 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
4531 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
4532 *pbIsNegative = false;
4533 } else {
4534 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
4535 *pbIsNegative = true;
4536 }
4537 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
4538 *pnExponent = pItem->val.expAndMantissa.nExponent;
4539 break;
4540
4541 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004542 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004543 *pnExponent = pItem->val.expAndMantissa.nExponent;
4544 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4545 *pbIsNegative = false;
4546 break;
4547
4548 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004549 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004550 *pnExponent = pItem->val.expAndMantissa.nExponent;
4551 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4552 *pbIsNegative = true;
4553 break;
4554
4555 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004556 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004557 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004558
4559Done:
4560 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004561}
4562
4563
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004564/*
4565 Public function, see header qcbor/qcbor_decode.h file
4566*/
4567void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
4568 uint8_t uTagRequirement,
4569 int64_t *pnMantissa,
4570 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004571{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004572 if(pMe->uLastError != QCBOR_SUCCESS) {
4573 return;
4574 }
4575
4576 QCBORItem Item;
4577 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4578 if(uError) {
4579 pMe->uLastError = (uint8_t)uError;
4580 return;
4581 }
4582
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004583 const TagSpecification TagSpec =
4584 {
4585 uTagRequirement,
4586 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4587 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4588 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004589
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004590 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004591}
4592
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004593
4594/*
4595 Public function, see header qcbor/qcbor_decode.h file
4596*/
4597void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
4598 uint8_t uTagRequirement,
4599 int64_t nLabel,
4600 int64_t *pnMantissa,
4601 int64_t *pnExponent)
4602{
4603 if(pMe->uLastError != QCBOR_SUCCESS) {
4604 return;
4605 }
4606
4607 QCBORItem Item;
4608 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
4609
4610 const TagSpecification TagSpec =
4611 {
4612 uTagRequirement,
4613 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4614 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4615 };
4616
4617 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4618}
4619
4620
4621/*
4622 Public function, see header qcbor/qcbor_decode.h file
4623*/
4624void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
4625 uint8_t uTagRequirement,
4626 const char *szLabel,
4627 int64_t *pnMantissa,
4628 int64_t *pnExponent)
4629{
4630 if(pMe->uLastError != QCBOR_SUCCESS) {
4631 return;
4632 }
4633
4634 QCBORItem Item;
4635 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4636
4637 const TagSpecification TagSpec =
4638 {
4639 uTagRequirement,
4640 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4641 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4642 };
4643
4644 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4645}
4646
4647
4648/*
4649 Public function, see header qcbor/qcbor_decode.h file
4650*/
4651void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
4652 uint8_t uTagRequirement,
4653 UsefulBuf MantissaBuffer,
4654 UsefulBufC *pMantissa,
4655 bool *pbMantissaIsNegative,
4656 int64_t *pnExponent)
4657{
4658 if(pMe->uLastError != QCBOR_SUCCESS) {
4659 return;
4660 }
4661
4662 QCBORItem Item;
4663 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4664 if(uError) {
4665 pMe->uLastError = (uint8_t)uError;
4666 return;
4667 }
4668
4669 const TagSpecification TagSpec =
4670 {
4671 uTagRequirement,
4672 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4673 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4674 };
4675
4676 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
4677}
4678
4679
4680/*
4681 Public function, see header qcbor/qcbor_decode.h file
4682*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004683void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
4684 uint8_t uTagRequirement,
4685 int64_t nLabel,
4686 UsefulBuf BufferForMantissa,
4687 UsefulBufC *pMantissa,
4688 bool *pbIsNegative,
4689 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004690{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004691 if(pMe->uLastError != QCBOR_SUCCESS) {
4692 return;
4693 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004694
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004695 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004696 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004697 if(pMe->uLastError != QCBOR_SUCCESS) {
4698 return;
4699 }
4700
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004701 const TagSpecification TagSpec =
4702 {
4703 uTagRequirement,
4704 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4705 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4706 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004707
4708 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004709}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004710
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004711
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004712/*
4713 Public function, see header qcbor/qcbor_decode.h file
4714*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004715void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004716 uint8_t uTagRequirement,
4717 const char *szLabel,
4718 UsefulBuf BufferForMantissa,
4719 UsefulBufC *pMantissa,
4720 bool *pbIsNegative,
4721 int64_t *pnExponent)
4722{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004723 if(pMe->uLastError != QCBOR_SUCCESS) {
4724 return;
4725 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004726
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004727 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004728 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4729 if(pMe->uLastError != QCBOR_SUCCESS) {
4730 return;
4731 }
4732
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004733 const TagSpecification TagSpec =
4734 {
4735 uTagRequirement,
4736 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4737 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4738 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004739
4740 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
4741}
4742
4743
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004744/*
4745 Public function, see header qcbor/qcbor_decode.h file
4746*/
4747void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
4748 uint8_t uTagRequirement,
4749 int64_t *pnMantissa,
4750 int64_t *pnExponent)
4751{
4752 if(pMe->uLastError != QCBOR_SUCCESS) {
4753 return;
4754 }
4755
4756 QCBORItem Item;
4757 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4758 if(uError) {
4759 pMe->uLastError = (uint8_t)uError;
4760 return;
4761 }
4762 const TagSpecification TagSpec =
4763 {
4764 uTagRequirement,
4765 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4766 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4767 };
4768
4769 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4770}
4771
4772
4773/*
4774 Public function, see header qcbor/qcbor_decode.h file
4775*/
4776void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
4777 uint8_t uTagRequirement,
4778 int64_t nLabel,
4779 int64_t *pnMantissa,
4780 int64_t *pnExponent)
4781{
4782 if(pMe->uLastError != QCBOR_SUCCESS) {
4783 return;
4784 }
4785
4786 QCBORItem Item;
4787 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
4788 if(pMe->uLastError != QCBOR_SUCCESS) {
4789 return;
4790 }
4791
4792 const TagSpecification TagSpec =
4793 {
4794 uTagRequirement,
4795 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4796 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4797 };
4798
4799 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4800}
4801
4802
4803/*
4804 Public function, see header qcbor/qcbor_decode.h file
4805*/
4806void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
4807 uint8_t uTagRequirement,
4808 const char *szLabel,
4809 int64_t *pnMantissa,
4810 int64_t *pnExponent)
4811{
4812 if(pMe->uLastError != QCBOR_SUCCESS) {
4813 return;
4814 }
4815
4816 QCBORItem Item;
4817 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4818 if(pMe->uLastError != QCBOR_SUCCESS) {
4819 return;
4820 }
4821
4822 const TagSpecification TagSpec =
4823 {
4824 uTagRequirement,
4825 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4826 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4827 };
4828
4829 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
4830}
4831
4832
4833/*
4834 Public function, see header qcbor/qcbor_decode.h file
4835*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004836void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
4837 uint8_t uTagRequirement,
4838 UsefulBuf MantissaBuffer,
4839 UsefulBufC *pMantissa,
4840 bool *pbMantissaIsNegative,
4841 int64_t *pnExponent)
4842{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004843 if(pMe->uLastError != QCBOR_SUCCESS) {
4844 return;
4845 }
4846
4847 QCBORItem Item;
4848 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4849 if(uError) {
4850 pMe->uLastError = (uint8_t)uError;
4851 return;
4852 }
4853
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004854 const TagSpecification TagSpec =
4855 {
4856 uTagRequirement,
4857 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4858 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4859 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004860
4861 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004862}
4863
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004864
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004865/*
4866 Public function, see header qcbor/qcbor_decode.h file
4867*/
4868void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
4869 uint8_t uTagRequirement,
4870 int64_t nLabel,
4871 UsefulBuf BufferForMantissa,
4872 UsefulBufC *pMantissa,
4873 bool *pbIsNegative,
4874 int64_t *pnExponent)
4875{
4876 if(pMe->uLastError != QCBOR_SUCCESS) {
4877 return;
4878 }
4879
4880 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004881 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
4882 if(pMe->uLastError != QCBOR_SUCCESS) {
4883 return;
4884 }
4885
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004886 const TagSpecification TagSpec =
4887 {
4888 uTagRequirement,
4889 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4890 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4891 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004892
4893 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
4894}
4895
4896
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004897/*
4898 Public function, see header qcbor/qcbor_decode.h file
4899*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004900void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004901 uint8_t uTagRequirement,
4902 const char *szLabel,
4903 UsefulBuf BufferForMantissa,
4904 UsefulBufC *pMantissa,
4905 bool *pbIsNegative,
4906 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004907{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004908 if(pMe->uLastError != QCBOR_SUCCESS) {
4909 return;
4910 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004911
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004912 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004913 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4914 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004915 return;
4916 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004917
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004918 const TagSpecification TagSpec =
4919 {
4920 uTagRequirement,
4921 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
4922 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4923 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07004924
4925 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004926}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004927
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004928#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */