blob: 16ffa2a78031b578a4829ef54557c4904cc96c13 [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 Lundblade1d85d522020-06-22 13:24:59 -0700260DecodeNesting_CheckBoundedType(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 Lundblade085d7952020-07-24 10:26:30 -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) {
1690 // Extra items in the decimal fraction / big num
1691 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1692 goto Done;
1693 }
1694
1695Done:
1696
1697 return nReturn;
1698}
1699#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
1700
1701
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001702
1703/*
1704 */
1705inline static QCBORError DecodeURI(QCBORItem *pDecodedItem)
1706{
1707 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1708 return QCBOR_ERR_BAD_OPT_TAG;
1709 }
1710 pDecodedItem->uDataType = QCBOR_TYPE_URI;
1711 return QCBOR_SUCCESS;
1712}
1713
1714
1715inline static QCBORError DecodeB64URL(QCBORItem *pDecodedItem)
1716{
1717 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1718 return QCBOR_ERR_BAD_OPT_TAG;
1719 }
1720 pDecodedItem->uDataType = QCBOR_TYPE_BASE64URL;
1721 return QCBOR_SUCCESS;
1722}
1723
1724
1725inline static QCBORError DecodeB64(QCBORItem *pDecodedItem)
1726{
1727 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1728 return QCBOR_ERR_BAD_OPT_TAG;
1729 }
1730 pDecodedItem->uDataType = QCBOR_TYPE_BASE64;
1731 return QCBOR_SUCCESS;
1732}
1733
1734
1735inline static QCBORError DecodeRegex(QCBORItem *pDecodedItem)
1736{
1737 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1738 return QCBOR_ERR_BAD_OPT_TAG;
1739 }
1740 pDecodedItem->uDataType = QCBOR_TYPE_REGEX;
1741 return QCBOR_SUCCESS;
1742}
1743
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001744inline static QCBORError DecodeWrappedCBOR(QCBORItem *pDecodedItem)
1745{
1746 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1747 return QCBOR_ERR_BAD_OPT_TAG;
1748 }
1749 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR;
1750 return QCBOR_SUCCESS;
1751}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001752
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001753
1754inline static QCBORError DecodeWrappedCBORSequence(QCBORItem *pDecodedItem)
1755{
1756 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1757 return QCBOR_ERR_BAD_OPT_TAG;
1758 }
1759 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE;
1760 return QCBOR_SUCCESS;
1761}
1762
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001763inline static QCBORError DecodeMIME(QCBORItem *pDecodedItem)
1764{
1765 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
1766 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
1767 } else if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1768 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
1769 } else {
1770 return QCBOR_ERR_BAD_OPT_TAG;
1771 }
1772 return QCBOR_SUCCESS;
1773}
1774
1775
1776/*
1777 */
1778inline static QCBORError DecodeUUID(QCBORItem *pDecodedItem)
1779{
1780 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1781 return QCBOR_ERR_BAD_OPT_TAG;
1782 }
1783 pDecodedItem->uDataType = QCBOR_TYPE_UUID;
1784 return QCBOR_SUCCESS;
1785}
1786
1787
Laurence Lundblade59289e52019-12-30 13:44:37 -08001788/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001789 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001790 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001791QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001792QCBORDecode_GetNext(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001793{
1794 QCBORError nReturn;
1795
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001796 nReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001797 if(nReturn != QCBOR_SUCCESS) {
1798 goto Done;
1799 }
1800
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001801 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
1802 switch(pDecodedItem->uTags[i] ) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08001803
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001804 case CBOR_TAG_DATE_STRING:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001805 nReturn = DecodeDateString(pDecodedItem);
1806 break;
1807
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001808 case CBOR_TAG_DATE_EPOCH:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001809 nReturn = DecodeDateEpoch(pDecodedItem);
1810 break;
1811
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001812 case CBOR_TAG_POS_BIGNUM:
1813 case CBOR_TAG_NEG_BIGNUM:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001814 nReturn = DecodeBigNum(pDecodedItem);
1815 break;
1816
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001817 #ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1818 case CBOR_TAG_DECIMAL_FRACTION:
1819 case CBOR_TAG_BIGFLOAT:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001820 // For aggregate tagged types, what goes into pTags is only collected
1821 // from the surrounding data item, not the contents, so pTags is not
1822 // passed on here.
1823
1824 nReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
1825 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001826 #endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001827
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001828 case CBOR_TAG_CBOR:
1829 nReturn = DecodeWrappedCBOR(pDecodedItem);
1830 break;
1831
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001832 case CBOR_TAG_CBOR_SEQUENCE:
1833 nReturn = DecodeWrappedCBORSequence(pDecodedItem);
1834 break;
1835
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001836 case CBOR_TAG_URI:
1837 nReturn = DecodeURI(pDecodedItem);
1838 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001839
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001840 case CBOR_TAG_B64URL:
1841 nReturn = DecodeB64URL(pDecodedItem);
1842 break;
1843
1844 case CBOR_TAG_B64:
1845 nReturn = DecodeB64(pDecodedItem);
1846 break;
1847
1848 case CBOR_TAG_MIME:
1849 case CBOR_TAG_BINARY_MIME:
1850 nReturn = DecodeMIME(pDecodedItem);
1851 break;
1852
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001853 case CBOR_TAG_REGEX:
1854 nReturn = DecodeRegex(pDecodedItem);
1855 break;
1856
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001857 case CBOR_TAG_BIN_UUID:
1858 nReturn = DecodeUUID(pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001859 break;
1860
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001861 case CBOR_TAG_INVALID16:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001862 // The end of the tag list or no tags
1863 // Successful exit from the loop.
1864 goto Done;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001865
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001866 default:
1867 // A tag that is not understood
1868 // A successful exit from the loop
1869 goto Done;
1870
1871 }
1872 if(nReturn != QCBOR_SUCCESS) {
1873 goto Done;
1874 }
Laurence Lundblade59289e52019-12-30 13:44:37 -08001875 }
1876
1877Done:
1878 if(nReturn != QCBOR_SUCCESS) {
1879 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
1880 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
1881 }
1882 return nReturn;
1883}
1884
1885
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001886QCBORError QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
1887{
1888 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
1889
1890 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
1891
1892 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
1893
1894 return uErr;
1895}
1896
1897
Laurence Lundblade59289e52019-12-30 13:44:37 -08001898/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001899 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001900 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001901QCBORError
1902QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
1903 QCBORItem *pDecodedItem,
1904 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001905{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001906 QCBORError nReturn;
1907
1908 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
1909 if(nReturn != QCBOR_SUCCESS) {
1910 return nReturn;
1911 }
1912
1913 if(pTags != NULL) {
1914 pTags->uNumUsed = 0;
1915 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001916 if(pDecodedItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001917 break;
1918 }
1919 if(pTags->uNumUsed >= pTags->uNumAllocated) {
1920 return QCBOR_ERR_TOO_MANY_TAGS;
1921 }
1922 pTags->puTags[pTags->uNumUsed] = ConvertTag(me, pDecodedItem->uTags[i]);
1923 pTags->uNumUsed++;
1924 }
1925 }
1926
1927 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001928}
1929
1930
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001931/*
Laurence Lundblade6de37062018-10-15 12:22:42 +05301932 Decoding items is done in 5 layered functions, one calling the
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301933 next one down. If a layer has no work to do for a particular item
1934 it returns quickly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001935
Laurence Lundblade59289e52019-12-30 13:44:37 -08001936 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
1937 tagged data items, turning them into the local C representation.
1938 For the most simple it is just associating a QCBOR_TYPE with the data. For
1939 the complex ones that an aggregate of data items, there is some further
1940 decoding and a little bit of recursion.
1941
1942 - QCBORDecode_GetNextMapOrArray - This manages the beginnings and
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301943 ends of maps and arrays. It tracks descending into and ascending
Laurence Lundblade6de37062018-10-15 12:22:42 +05301944 out of maps/arrays. It processes all breaks that terminate
Laurence Lundbladebb87be22020-04-09 19:15:32 -07001945 indefinite length maps and arrays.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001946
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301947 - GetNext_MapEntry -- This handles the combining of two
1948 items, the label and the data, that make up a map entry.
1949 It only does work on maps. It combines the label and data
1950 items into one labeled item.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001951
Laurence Lundblade59289e52019-12-30 13:44:37 -08001952 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
1953 tags into bit flags associated with the data item. No actual decoding
1954 of the contents of the tagged item is performed here.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001955
Laurence Lundblade59289e52019-12-30 13:44:37 -08001956 - GetNext_FullItem -- This assembles the sub-items that make up
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301957 an indefinte length string into one string item. It uses the
Laurence Lundblade6de37062018-10-15 12:22:42 +05301958 string allocater to create contiguous space for the item. It
1959 processes all breaks that are part of indefinite length strings.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001960
Laurence Lundblade59289e52019-12-30 13:44:37 -08001961 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
1962 atomic data item has a "major type", an integer "argument" and optionally
1963 some content. For text and byte strings, the content is the bytes
1964 that make up the string. These are the smallest data items that are
1965 considered to be well-formed. The content may also be other data items in
1966 the case of aggregate types. They are not handled in this layer.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001967
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001968 Roughly this takes 300 bytes of stack for vars. Need to
1969 evaluate this more carefully and correctly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001970
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301971 */
1972
1973
1974/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001975 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001976 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001977int QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001978 const QCBORItem *pItem,
1979 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001980{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001981 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++ ) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001982 if(pItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001983 break;
1984 }
1985 if(ConvertTag(me, pItem->uTags[i]) == uTag) {
1986 return 1;
1987 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001988 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001989
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001990 return 0;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001991}
1992
1993
1994/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001995 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001996 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07001997QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001998{
Laurence Lundblade085d7952020-07-24 10:26:30 -07001999 QCBORError uReturn = me->uLastError;
2000
2001 if(uReturn != QCBOR_SUCCESS) {
2002 goto Done;
2003 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002004
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002005 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002006 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002007 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002008 goto Done;
2009 }
2010
2011 // Error out if not all the bytes are consumed
2012 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002013 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002014 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002015
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002016Done:
Laurence Lundblade6de37062018-10-15 12:22:42 +05302017 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002018 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002019 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002020
Laurence Lundblade085d7952020-07-24 10:26:30 -07002021 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002022}
2023
2024
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002025/*
2026Public function, see header qcbor/qcbor_decode.h file
2027*/
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002028uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2029 const QCBORItem *pItem,
2030 unsigned int uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002031{
2032 if(uIndex > QCBOR_MAX_TAGS_PER_ITEM) {
2033 return CBOR_TAG_INVALID16;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002034 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002035 return ConvertTag(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002036 }
2037}
2038
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002039
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002040/*
2041
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002042Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002043
Laurence Lundbladeee851742020-01-08 08:37:05 -08002044 - Hit end of input before it was expected while decoding type and
2045 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002046
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002047 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002048
Laurence Lundbladeee851742020-01-08 08:37:05 -08002049 - Hit end of input while decoding a text or byte string
2050 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002051
Laurence Lundbladeee851742020-01-08 08:37:05 -08002052 - Encountered conflicting tags -- e.g., an item is tagged both a date
2053 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002054
Laurence Lundbladeee851742020-01-08 08:37:05 -08002055 - Encontered an array or mapp that has too many items
2056 QCBOR_ERR_ARRAY_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002057
Laurence Lundbladeee851742020-01-08 08:37:05 -08002058 - Encountered array/map nesting that is too deep
2059 QCBOR_ERR_ARRAY_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002060
Laurence Lundbladeee851742020-01-08 08:37:05 -08002061 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2062 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002063
Laurence Lundbladeee851742020-01-08 08:37:05 -08002064 - The type of a map label is not a string or int
2065 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002066
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002067 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002068
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002069 */
2070
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002071
2072
Laurence Lundbladef6531662018-12-04 10:42:22 +09002073
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002074/* ===========================================================================
2075 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002076
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002077 This implements a simple sting allocator for indefinite length
2078 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2079 implements the function type QCBORStringAllocate and allows easy
2080 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002081
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002082 This particular allocator is built-in for convenience. The caller
2083 can implement their own. All of this following code will get
2084 dead-stripped if QCBORDecode_SetMemPool() is not called.
2085
2086 This is a very primitive memory allocator. It does not track
2087 individual allocations, only a high-water mark. A free or
2088 reallocation must be of the last chunk allocated.
2089
2090 The size of the pool and offset to free memory are packed into the
2091 first 8 bytes of the memory pool so we don't have to keep them in
2092 the decode context. Since the address of the pool may not be
2093 aligned, they have to be packed and unpacked as if they were
2094 serialized data of the wire or such.
2095
2096 The sizes packed in are uint32_t to be the same on all CPU types
2097 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002098 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002099
2100
Laurence Lundbladeee851742020-01-08 08:37:05 -08002101static inline int
2102MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002103{
2104 // Use of UsefulInputBuf is overkill, but it is convenient.
2105 UsefulInputBuf UIB;
2106
Laurence Lundbladeee851742020-01-08 08:37:05 -08002107 // Just assume the size here. It was checked during SetUp so
2108 // the assumption is safe.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002109 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem, QCBOR_DECODE_MIN_MEM_POOL_SIZE});
2110 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2111 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2112 return UsefulInputBuf_GetError(&UIB);
2113}
2114
2115
Laurence Lundbladeee851742020-01-08 08:37:05 -08002116static inline int
2117MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002118{
2119 // Use of UsefulOutBuf is overkill, but convenient. The
2120 // length check performed here is useful.
2121 UsefulOutBuf UOB;
2122
2123 UsefulOutBuf_Init(&UOB, Pool);
2124 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2125 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2126 return UsefulOutBuf_GetError(&UOB);
2127}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002128
2129
2130/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002131 Internal function for an allocation, reallocation free and destuct.
2132
2133 Having only one function rather than one each per mode saves space in
2134 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002135
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002136 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2137 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002138static UsefulBuf
2139MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002140{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002141 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002142
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002143 uint32_t uPoolSize;
2144 uint32_t uFreeOffset;
2145
2146 if(uNewSize > UINT32_MAX) {
2147 // This allocator is only good up to 4GB. This check should
2148 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2149 goto Done;
2150 }
2151 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2152
2153 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2154 goto Done;
2155 }
2156
2157 if(uNewSize) {
2158 if(pMem) {
2159 // REALLOCATION MODE
2160 // Calculate pointer to the end of the memory pool. It is
2161 // assumed that pPool + uPoolSize won't wrap around by
2162 // assuming the caller won't pass a pool buffer in that is
2163 // not in legitimate memory space.
2164 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2165
2166 // Check that the pointer for reallocation is in the range of the
2167 // pool. This also makes sure that pointer math further down
2168 // doesn't wrap under or over.
2169 if(pMem >= pPool && pMem < pPoolEnd) {
2170 // Offset to start of chunk for reallocation. This won't
2171 // wrap under because of check that pMem >= pPool. Cast
2172 // is safe because the pool is always less than UINT32_MAX
2173 // because of check in QCBORDecode_SetMemPool().
2174 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2175
2176 // Check to see if the allocation will fit. uPoolSize -
2177 // uMemOffset will not wrap under because of check that
2178 // pMem is in the range of the uPoolSize by check above.
2179 if(uNewSize <= uPoolSize - uMemOffset) {
2180 ReturnValue.ptr = pMem;
2181 ReturnValue.len = uNewSize;
2182
2183 // Addition won't wrap around over because uNewSize was
2184 // checked to be sure it is less than the pool size.
2185 uFreeOffset = uMemOffset + uNewSize32;
2186 }
2187 }
2188 } else {
2189 // ALLOCATION MODE
2190 // uPoolSize - uFreeOffset will not underflow because this
2191 // pool implementation makes sure uFreeOffset is always
2192 // smaller than uPoolSize through this check here and
2193 // reallocation case.
2194 if(uNewSize <= uPoolSize - uFreeOffset) {
2195 ReturnValue.len = uNewSize;
2196 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002197 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002198 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002199 }
2200 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002201 if(pMem) {
2202 // FREE MODE
2203 // Cast is safe because of limit on pool size in
2204 // QCBORDecode_SetMemPool()
2205 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2206 } else {
2207 // DESTRUCT MODE
2208 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002209 }
2210 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002211
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002212 UsefulBuf Pool = {pPool, uPoolSize};
2213 MemPool_Pack(Pool, uFreeOffset);
2214
2215Done:
2216 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002217}
2218
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002219
Laurence Lundbladef6531662018-12-04 10:42:22 +09002220/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002221 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002222 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002223QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2224 UsefulBuf Pool,
2225 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002226{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002227 // The pool size and free mem offset are packed into the beginning
2228 // of the pool memory. This compile time check make sure the
2229 // constant in the header is correct. This check should optimize
2230 // down to nothing.
2231 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07002232 return QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002233 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002234
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002235 // The pool size and free offset packed in to the beginning of pool
2236 // memory are only 32-bits. This check will optimize out on 32-bit
2237 // machines.
2238 if(Pool.len > UINT32_MAX) {
2239 return QCBOR_ERR_BUFFER_TOO_LARGE;
2240 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002241
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002242 // This checks that the pool buffer given is big enough.
2243 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
2244 return QCBOR_ERR_BUFFER_TOO_SMALL;
2245 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002246
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002247 pMe->StringAllocator.pfAllocator = MemPool_Function;
2248 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2249 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002250
Laurence Lundblade30816f22018-11-10 13:40:22 +07002251 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002252}
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002253
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002254
2255
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002256
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002257
2258
2259/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002260 Consume an entire map or array (and do next to
2261 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002262 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002263static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002264ConsumeItem(QCBORDecodeContext *pMe,
2265 const QCBORItem *pItemToConsume,
2266 uint_fast8_t *puNextNestLevel)
2267{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002268 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002269 QCBORItem Item;
2270
Laurence Lundblade02625d42020-06-25 14:41:41 -07002271 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ConsumeItem");
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002272
Laurence Lundblade02625d42020-06-25 14:41:41 -07002273 if(QCBORItem_IsMapOrArray(pItemToConsume)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002274 /* There is only real work to do for maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002275
Laurence Lundblade1341c592020-04-11 14:19:05 -07002276 /* This works for definite and indefinite length
2277 * maps and arrays by using the nesting level
2278 */
2279 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002280 uReturn = QCBORDecode_GetNext(pMe, &Item);
2281 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002282 goto Done;
2283 }
2284 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002285
Laurence Lundblade1341c592020-04-11 14:19:05 -07002286 if(puNextNestLevel != NULL) {
2287 *puNextNestLevel = Item.uNextNestLevel;
2288 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002289 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002290
Laurence Lundblade1341c592020-04-11 14:19:05 -07002291 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002292 /* item_to_consume is not a map or array */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002293 if(puNextNestLevel != NULL) {
2294 /* Just pass the nesting level through */
2295 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2296 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002297 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002298 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002299
2300Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002301 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002302}
2303
2304
Laurence Lundblade1341c592020-04-11 14:19:05 -07002305/* Return true if the labels in Item1 and Item2 are the same.
2306 Works only for integer and string labels. Returns false
2307 for any other type. */
2308static inline bool
2309MatchLabel(QCBORItem Item1, QCBORItem Item2)
2310{
2311 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2312 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2313 return true;
2314 }
2315 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002316 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002317 return true;
2318 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002319 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002320 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2321 return true;
2322 }
2323 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2324 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2325 return true;
2326 }
2327 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002328
Laurence Lundblade1341c592020-04-11 14:19:05 -07002329 /* Other label types are never matched */
2330 return false;
2331}
2332
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002333
2334/*
2335 Returns true if Item1 and Item2 are the same type
2336 or if either are of QCBOR_TYPE_ANY.
2337 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002338static inline bool
2339MatchType(QCBORItem Item1, QCBORItem Item2)
2340{
2341 if(Item1.uDataType == Item2.uDataType) {
2342 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002343 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002344 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002345 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002346 return true;
2347 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002348 return false;
2349}
2350
2351
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002352/**
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002353 \brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002354
2355 @param[in] pMe The decode context to search.
2356 @param[in,out] pItemArray The items to search for and the items found.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002357 @param[out] puOffset Byte offset of last item matched.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002358 @param[in] pCBContext Context for the not-found item call back
2359 @param[in] pfCallback Function to call on items not matched in pItemArray
2360
2361 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2362
2363 @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.
2364
2365 @retval QCBOR_ERR_UNEXPECTED_TYPE The label was matched, but not the type.
2366
2367 @retval Also errors returned by QCBORDecode_GetNext().
2368
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002369 On input pItemArray contains a list of labels and data types
2370 of items to be found.
2371
2372 On output the fully retrieved items are filled in with
2373 values and such. The label was matched, so it never changes.
2374
2375 If an item was not found, its data type is set to none.
2376
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002377 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002378static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002379MapSearch(QCBORDecodeContext *pMe,
2380 QCBORItem *pItemArray,
2381 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002382 void *pCBContext,
2383 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002384{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002385 QCBORError uReturn;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002386
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002387 if(pMe->uLastError != QCBOR_SUCCESS) {
2388 return pMe->uLastError;
2389 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002390
Laurence Lundblade085d7952020-07-24 10:26:30 -07002391 QCBORDecodeNesting SaveNesting = pMe->nesting; // TODO: refactor?
2392
2393 uint64_t uFoundItemBitMap = 0;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002394
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002395 if(!DecodeNesting_CheckBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
2396 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2397 /* QCBOR_TYPE_NONE as first item indicates just looking
2398 for the end of an array, so don't give error. */
2399 uReturn = QCBOR_ERR_NOT_A_MAP;
2400 goto Done;
2401 }
2402
Laurence Lundblade085d7952020-07-24 10:26:30 -07002403 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2404 // It is an empty bounded array or map
2405 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2406 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002407 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002408 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002409 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002410 // Nothing is ever found in an empty array or map. All items
2411 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002412 uReturn = QCBOR_SUCCESS;
2413 }
2414 goto Done;
2415 }
2416
2417 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 Lundblade1341c592020-04-11 14:19:05 -07002430
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002431 uint_fast8_t uNextNestLevel;
2432
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002433
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002434 /* Iterate over items in the map / array */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002435 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002436 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002437 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002438
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002439 /* Get the item */
2440 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002441 uReturn = QCBORDecode_GetNext(pMe, &Item);
2442 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002443 /* Got non-well-formed CBOR */
2444 goto Done;
2445 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002446
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002447 /* See if item has one of the labels that are of interest */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002448 int nIndex;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002449 QCBORItem *pIterator;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002450 bool bMatched = false;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002451 for(pIterator = pItemArray, nIndex = 0; pIterator->uLabelType != 0; pIterator++, nIndex++) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002452 if(MatchLabel(Item, *pIterator)) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002453 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002454 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2455 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002456 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002457 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002458 /* Also try to match its type */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002459 if(!MatchType(Item, *pIterator)) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002460 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002461 goto Done;
2462 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002463
2464 /* Successful match. Return the item. */
2465 *pIterator = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002466 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002467 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002468 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002469 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002470 bMatched = true;
2471 }
2472 }
2473 if(!bMatched && pfCallback != NULL) {
2474 /*
2475 Call the callback on unmatched labels.
2476 (It is tempting to do duplicate detection here, but that would
2477 require dynamic memory allocation because the number of labels
2478 that might be encountered is unbounded.)
2479 */
2480 uReturn = (*pfCallback)(pCBContext, &Item);
2481 if(uReturn != QCBOR_SUCCESS) {
2482 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002483 }
2484 }
2485
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002486 /*
2487 Consume the item whether matched or not. This
2488 does the work of traversing maps and array and
2489 everything in them. In this loop only the
2490 items at the current nesting level are examined
2491 to match the labels.
2492 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002493 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
2494 if(uReturn) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002495 goto Done;
2496 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002497
2498 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002499
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002500 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002501
2502 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002503 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2504 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002505
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002506 Done:
2507 /* For all items not found, set the data type to QCBOR_TYPE_NONE */
2508 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002509 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002510 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002511 }
2512 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002513
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002514 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002515
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002516 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002517}
2518
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002519
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002520/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002521 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002522*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002523void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2524 int64_t nLabel,
2525 uint8_t uQcborType,
2526 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002527{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002528 if(pMe->uLastError != QCBOR_SUCCESS) {
2529 return;
2530 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002531
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002532 QCBORItem OneItemSeach[2];
2533 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2534 OneItemSeach[0].label.int64 = nLabel;
2535 OneItemSeach[0].uDataType = uQcborType;
2536 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002537
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002538 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2539 if(uReturn != QCBOR_SUCCESS) {
2540 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002541 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002542 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002543 uReturn = QCBOR_ERR_NOT_FOUND;
2544 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002545 }
2546
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002547 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002548
2549 Done:
2550 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002551}
2552
2553
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002554/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002555 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002556*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002557void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2558 const char *szLabel,
2559 uint8_t uQcborType,
2560 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002561{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002562 if(pMe->uLastError != QCBOR_SUCCESS) {
2563 return;
2564 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002565
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002566 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002567 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2568 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2569 OneItemSeach[0].uDataType = uQcborType;
2570 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002571
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002572 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2573 if(uReturn != QCBOR_SUCCESS) {
2574 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002575 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002576 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002577 uReturn = QCBOR_ERR_NOT_FOUND;
2578 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002579 }
2580
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002581 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002582
2583Done:
2584 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002585}
2586
2587
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002588
2589static QCBORError CheckTypeList(uint8_t uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
2590{
2591 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2592 if(uDataType == puTypeList[i]) {
2593 return QCBOR_SUCCESS;
2594 }
2595 }
2596 return QCBOR_ERR_UNEXPECTED_TYPE;
2597}
2598
Laurence Lundblade67257dc2020-07-27 03:33:37 -07002599
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002600/**
2601 @param[in] TagSpec Specification for matching tags.
2602 @param[in] uDataType A QCBOR data type
2603
2604 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
2605 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
2606
2607 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered tag value.
2608 */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002609static QCBORError CheckTagRequirement(const TagSpecification TagSpec, uint8_t uDataType)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002610{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002611 if(TagSpec.uTagRequirement == QCBOR_TAGSPEC_MATCH_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002612 // Must match the tag and only the tag
2613 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002614 }
2615
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002616 QCBORError uReturn = CheckTypeList(uDataType, TagSpec.uAllowedContentTypes);
2617 if(uReturn == QCBOR_SUCCESS) {
2618 return QCBOR_SUCCESS;
2619 }
2620
2621 if(TagSpec.uTagRequirement == QCBOR_TAGSPEC_MATCH_TAG_CONTENT_TYPE) {
2622 /* Must match the content type and only the content type.
2623 There was no match just above so it is a fail. */
2624 return QCBOR_ERR_UNEXPECTED_TYPE;
2625 }
2626
2627 /* If here it can match either the tag or the content
2628 and it hasn't matched the content, so the end
2629 result is whether it matches the tag. This is
2630 also the case that the CBOR standard discourages. */
2631
2632 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002633}
2634
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002635
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002636// Semi-private
2637// TODO: inline or collapse with QCBORDecode_GetTaggedStringInMapN?
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002638void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
2639 int64_t nLabel,
2640 TagSpecification TagSpec,
2641 QCBORItem *pItem)
2642{
2643 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
2644 if(pMe->uLastError != QCBOR_SUCCESS) {
2645 return;
2646 }
2647
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07002648 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002649}
2650
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002651// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002652void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
2653 const char *szLabel,
2654 TagSpecification TagSpec,
2655 QCBORItem *pItem)
2656{
2657 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
2658 if(pMe->uLastError != QCBOR_SUCCESS) {
2659 return;
2660 }
2661
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07002662 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002663}
2664
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002665// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002666void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
2667 int64_t nLabel,
2668 TagSpecification TagSpec,
2669 UsefulBufC *pString)
2670{
2671 QCBORItem Item;
2672 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
2673 if(pMe->uLastError == QCBOR_SUCCESS) {
2674 *pString = Item.val.string;
2675 }
2676}
2677
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002678// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002679void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
2680 const char * szLabel,
2681 TagSpecification TagSpec,
2682 UsefulBufC *pString)
2683{
2684 QCBORItem Item;
2685 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
2686 if(pMe->uLastError == QCBOR_SUCCESS) {
2687 *pString = Item.val.string;
2688 }
2689}
Laurence Lundblade1341c592020-04-11 14:19:05 -07002690
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002691/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002692 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002693*/
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002694QCBORError QCBORDecode_GetItemsInMap(QCBORDecodeContext *pCtx, QCBORItem *pItemList)
2695{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002696 return MapSearch(pCtx, pItemList, NULL, NULL, NULL);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002697}
2698
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002699/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002700 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002701*/
2702QCBORError QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pCtx,
2703 QCBORItem *pItemList,
2704 void *pCallbackCtx,
2705 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002706{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002707 return MapSearch(pCtx, pItemList, NULL, pCallbackCtx, pfCB);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002708}
2709
2710
Laurence Lundblade34691b92020-05-18 22:25:25 -07002711static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07002712{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002713 // TODO: check that only one item is in pSearch?
Laurence Lundblade34691b92020-05-18 22:25:25 -07002714 if(pMe->uLastError != QCBOR_SUCCESS) {
2715 // Already in error state; do nothing.
2716 return;
2717 }
2718
2719 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002720 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002721 if(pMe->uLastError != QCBOR_SUCCESS) {
2722 return;
2723 }
2724
Laurence Lundblade085d7952020-07-24 10:26:30 -07002725 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
2726 pMe->uLastError = QCBOR_ERR_NOT_FOUND;
2727 return;
2728 }
2729
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002730 /* Need to get the current pre-order nesting level and cursor to be
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07002731 at the map/array about to be entered.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002732
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002733 Also need the current map nesting level and start cursor to
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002734 be at the right place.
2735
2736 The UsefulInBuf offset could be anywhere, so no assumption is
2737 made about it.
2738
2739 No assumption is made about the pre-order nesting level either.
2740
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002741 However the bounded mode nesting level is assumed to be one above
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002742 the map level that is being entered.
2743 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002744 /* Seek to the data item that is the map or array */
2745 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002746
2747 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002748
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002749 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002750}
2751
2752
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002753/*
2754Public function, see header qcbor/qcbor_decode.h file
2755*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002756void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002757{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002758 QCBORItem OneItemSeach[2];
2759 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2760 OneItemSeach[0].label.int64 = nLabel;
2761 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2762 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002763
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002764 /* The map to enter was found, now finish of entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002765 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002766}
2767
2768
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002769/*
2770Public function, see header qcbor/qcbor_decode.h file
2771*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002772void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002773{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002774 QCBORItem OneItemSeach[2];
2775 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2776 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2777 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
2778 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002779
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002780 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002781}
2782
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002783/*
2784Public function, see header qcbor/qcbor_decode.h file
2785*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002786void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07002787{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002788 QCBORItem OneItemSeach[2];
2789 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2790 OneItemSeach[0].label.int64 = nLabel;
2791 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
2792 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002793
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002794 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002795}
2796
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002797/*
2798Public function, see header qcbor/qcbor_decode.h file
2799*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07002800void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
2801{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002802 QCBORItem OneItemSeach[2];
2803 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2804 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2805 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
2806 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002807
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002808 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002809}
2810
2811
Laurence Lundblade02625d42020-06-25 14:41:41 -07002812// Semi-private function
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002813void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002814{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002815 QCBORError uErr;
2816
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002817 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07002818 if(pMe->uLastError != QCBOR_SUCCESS) {
2819 // Already in error state; do nothing.
2820 return;
2821 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002822
2823 /* Get the data item that is the map that is being searched */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002824 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002825 uErr = QCBORDecode_GetNext(pMe, &Item);
2826 if(uErr != QCBOR_SUCCESS) {
2827 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07002828 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002829 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002830 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
2831 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002832 }
2833
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002834 const bool bIsEmpty = (Item.uNestingLevel == Item.uNextNestLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07002835 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002836 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
2837 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002838 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002839 pMe->nesting.pCurrent->u.ma.uCountCursor++;
2840 }
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002841 // Special case to increment nesting level for zero-length maps and arrays entered in bounded mode.
2842 DecodeNesting_Descend(&(pMe->nesting), uType);
2843 }
2844
Laurence Lundblade02625d42020-06-25 14:41:41 -07002845 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002846
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002847 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
2848 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002849
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002850Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002851 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002852}
2853
Laurence Lundblade02625d42020-06-25 14:41:41 -07002854
2855/*
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002856 This is the common work for exiting a level that is a bounded map, array or bstr
2857 wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07002858
2859 One chunk of work is to set up the pre-order traversal so it is at
2860 the item just after the bounded map, array or bstr that is being
2861 exited. This is somewhat complex.
2862
2863 The other work is to level-up the bounded mode to next higest bounded
2864 mode or the top level if there isn't one.
2865 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002866static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07002867ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002868{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002869 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002870
Laurence Lundblade02625d42020-06-25 14:41:41 -07002871 /*
2872 First the pre-order-traversal byte offset is positioned to the
2873 item just after the bounded mode item that was just consumed.
2874 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002875 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
2876
Laurence Lundblade02625d42020-06-25 14:41:41 -07002877 /*
2878 Next, set the current nesting level to one above the bounded level
2879 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002880
Laurence Lundblade02625d42020-06-25 14:41:41 -07002881 DecodeNesting_CheckBoundedType() is always called before this and
2882 makes sure pCurrentBounded is valid.
2883 */
2884 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
2885
2886 /*
2887 This does the complex work of leveling up the pre-order traversal
2888 when the end of a map or array or another bounded level is
2889 reached. It may do nothing, or ascend all the way to the top
2890 level.
2891 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07002892 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002893 if(uErr != QCBOR_SUCCESS) {
2894 goto Done;
2895 }
2896
Laurence Lundblade02625d42020-06-25 14:41:41 -07002897 /*
2898 This makes the next highest bounded level the current bounded
2899 level. If there is no next highest level, then no bounded mode is
2900 in effect.
2901 */
2902 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002903
Laurence Lundblade02625d42020-06-25 14:41:41 -07002904 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002905
2906Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07002907 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ExitBoundedLevel");
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002908 return uErr;
2909}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002910
Laurence Lundblade02625d42020-06-25 14:41:41 -07002911
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002912// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07002913void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002914{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002915 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07002916 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002917 return;
2918 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002919
Laurence Lundblade02625d42020-06-25 14:41:41 -07002920 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002921
Laurence Lundblade02625d42020-06-25 14:41:41 -07002922 if(!DecodeNesting_CheckBoundedType(&(pMe->nesting), uType)) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002923 uErr = QCBOR_ERR_CLOSE_MISMATCH;
2924 goto Done;
2925 }
2926
Laurence Lundblade02625d42020-06-25 14:41:41 -07002927 /*
2928 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002929 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002930 from previous map search, then do a dummy search.
2931 */
2932 if(pMe->uMapEndOffsetCache == MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002933 QCBORItem Dummy;
2934 Dummy.uLabelType = QCBOR_TYPE_NONE;
2935 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
2936 if(uErr != QCBOR_SUCCESS) {
2937 goto Done;
2938 }
2939 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002940
Laurence Lundblade02625d42020-06-25 14:41:41 -07002941 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002942
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002943Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002944 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002945}
2946
2947
Laurence Lundblade1341c592020-04-11 14:19:05 -07002948void QCBORDecode_RewindMap(QCBORDecodeContext *pMe)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002949{
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002950 // TODO: check for map mode; test this
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002951 //pMe->nesting.pCurrent->uCount = pMe->nesting.pCurrent->u.ma.uCountTotal;
2952 UsefulInputBuf_Seek(&(pMe->InBuf), pMe->nesting.pCurrent->u.ma.uStartOffset);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002953}
2954
2955
Laurence Lundblade1341c592020-04-11 14:19:05 -07002956
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002957static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002958 const QCBORItem *pItem,
2959 uint8_t uTagRequirement,
2960 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002961{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002962 if(pBstr) {
2963 *pBstr = NULLUsefulBufC;
2964 }
2965
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002966 if(pMe->uLastError != QCBOR_SUCCESS) {
2967 // Already in error state; do nothing.
2968 return pMe->uLastError;
2969 }
2970
2971 QCBORError uError = QCBOR_SUCCESS;
2972
2973 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
2974 uError = QCBOR_ERR_UNEXPECTED_TYPE;
2975 goto Done;;
2976 }
2977
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002978 const TagSpecification TagSpec = {uTagRequirement,
2979 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
2980 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
2981 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002982
2983 uError = CheckTagRequirement(TagSpec, pItem->uDataType);
2984 if(uError != QCBOR_SUCCESS) {
2985 goto Done;
2986 }
2987
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002988 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07002989 /* Reverse the decrement done by GetNext() for the bstr as
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002990 so the increment in NestLevelAscender called by ExitBoundedLevel()
2991 will work right. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002992 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07002993 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07002994
2995 if(pBstr) {
2996 *pBstr = pItem->val.string;
2997 }
2998
2999 const size_t uPreviousLength = UsefulInputBuf_GetLength(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003000
3001 // Need to move UIB input cursor to the right place
3002
3003 // Really this is a subtraction and an assignment; not much code
3004 // There is a range check in the seek.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003005 // The bstr was just consumed so the cursor is at the next item after it
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003006
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003007 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003008
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003009 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
3010
3011 UsefulInputBuf_SetBufferLen(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003012
Laurence Lundblade02625d42020-06-25 14:41:41 -07003013 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
3014 uPreviousLength,
3015 uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003016Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07003017 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "Entered Bstr");
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003018
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003019 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003020}
3021
3022
Laurence Lundblade02625d42020-06-25 14:41:41 -07003023/*
3024 Public function, see header qcbor/qcbor_decode.h file
3025 */
3026void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003027 uint8_t uTagRequirement,
3028 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003029{
3030 if(pMe->uLastError != QCBOR_SUCCESS) {
3031 // Already in error state; do nothing.
3032 return;
3033 }
3034
3035 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003036 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003037 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3038 if(pMe->uLastError != QCBOR_SUCCESS) {
3039 return;
3040 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003041
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003042 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003043 &Item,
3044 uTagRequirement,
3045 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003046}
3047
3048
Laurence Lundblade02625d42020-06-25 14:41:41 -07003049/*
3050 Public function, see header qcbor/qcbor_decode.h file
3051 */
3052void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
3053 uint8_t uTagRequirement,
3054 int64_t nLabel,
3055 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003056{
3057 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003058 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003059
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003060 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003061}
3062
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003063
Laurence Lundblade02625d42020-06-25 14:41:41 -07003064/*
3065 Public function, see header qcbor/qcbor_decode.h file
3066 */
3067void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
3068 uint8_t uTagRequirement,
3069 const char *szLabel,
3070 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003071{
3072 QCBORItem Item;
3073 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3074
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003075 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003076}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003077
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003078
Laurence Lundblade02625d42020-06-25 14:41:41 -07003079/*
3080 Public function, see header qcbor/qcbor_decode.h file
3081 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003082void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003083{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003084 if(pMe->uLastError != QCBOR_SUCCESS) {
3085 // Already in error state; do nothing.
3086 return;
3087 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003088
Laurence Lundblade02625d42020-06-25 14:41:41 -07003089 if(!DecodeNesting_CheckBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
3090 pMe->uLastError = QCBOR_ERR_CLOSE_MISMATCH;
3091 return;
3092 }
3093
3094 /*
3095 Reset the length of the UsefulInputBuf to what it was before
3096 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003097 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003098 UsefulInputBuf_SetBufferLen(&(pMe->InBuf),
3099 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003100
3101
Laurence Lundblade02625d42020-06-25 14:41:41 -07003102 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003103 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003104}
3105
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003106
Laurence Lundbladee6430642020-03-14 21:15:44 -07003107
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003108
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003109
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003110
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003111
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003112
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003113static QCBORError InterpretBool(const QCBORItem *pItem, bool *pBool)
3114{
3115 switch(pItem->uDataType) {
3116 case QCBOR_TYPE_TRUE:
3117 *pBool = true;
3118 return QCBOR_SUCCESS;
3119 break;
3120
3121 case QCBOR_TYPE_FALSE:
3122 *pBool = false;
3123 return QCBOR_SUCCESS;
3124 break;
3125
3126 default:
3127 return QCBOR_ERR_UNEXPECTED_TYPE;
3128 break;
3129 }
3130}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003131
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003132/*
3133Public function, see header qcbor/qcbor_decode.h file
3134*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003135void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003136{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003137 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003138 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003139 return;
3140 }
3141
Laurence Lundbladec4537442020-04-14 18:53:22 -07003142 QCBORError nError;
3143 QCBORItem Item;
3144
3145 nError = QCBORDecode_GetNext(pMe, &Item);
3146 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003147 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003148 return;
3149 }
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_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003157{
3158 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003159 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003160
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003161 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003162}
3163
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003164/*
3165Public function, see header qcbor/qcbor_decode.h file
3166*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003167void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3168{
3169 QCBORItem Item;
3170 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3171
3172 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
3173}
3174
3175
3176
3177void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe, TagSpecification TagSpec, UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003178{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003179 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003180 // Already in error state, do nothing
3181 return;
3182 }
3183
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003184 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003185 QCBORItem Item;
3186
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003187 uError = QCBORDecode_GetNext(pMe, &Item);
3188 if(uError != QCBOR_SUCCESS) {
3189 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003190 return;
3191 }
3192
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003193 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, Item.uDataType);
3194
3195 if(pMe->uLastError == QCBOR_SUCCESS) {
3196 *pBstr = Item.val.string;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003197 }
3198}
3199
Laurence Lundbladec4537442020-04-14 18:53:22 -07003200
3201
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003202
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003203static QCBORError ConvertBigNum(uint8_t uTagRequirement,
3204 const QCBORItem *pItem,
3205 UsefulBufC *pValue,
3206 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003207{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003208 const TagSpecification TagSpec = {uTagRequirement,
3209 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE},
3210 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3211 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003212
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003213 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
3214 if(uErr != QCBOR_SUCCESS) {
3215 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003216 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003217
3218 *pValue = pItem->val.string;
3219
3220 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3221 *pbIsNegative = false;
3222 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3223 *pbIsNegative = true;
3224 }
3225
3226 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003227}
3228
3229
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003230/**
3231 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003232 */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003233void QCBORDecode_GetBignum(QCBORDecodeContext *pMe, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003234{
3235 if(pMe->uLastError != QCBOR_SUCCESS) {
3236 // Already in error state, do nothing
3237 return;
3238 }
3239
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003240 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003241 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3242 if(uError != QCBOR_SUCCESS) {
3243 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003244 return;
3245 }
3246
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003247 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003248}
3249
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003250/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003251Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003252*/
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003253void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003254{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003255 QCBORItem Item;
3256 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003257
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003258 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003259}
3260
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003261/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003262Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003263*/
3264void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
3265{
3266 QCBORItem Item;
3267 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3268
3269 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
3270}
3271
3272
3273
3274// Semi private
3275QCBORError FarfMIME(uint8_t uTagRequirement, const QCBORItem *pItem, UsefulBufC *pMessage, bool *pbIsNot7Bit)
3276{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003277
3278
3279 const TagSpecification TagSpecText = {uTagRequirement,
3280 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3281 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3282 };
3283 const TagSpecification TagSpecBinary = {uTagRequirement,
3284 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3285 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3286 };
3287
3288
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003289 QCBORError uReturn;
3290
3291 if(CheckTagRequirement(TagSpecText, pItem->uDataType)) {
3292 *pMessage = pItem->val.string;
3293 if(pbIsNot7Bit != NULL) {
3294 *pbIsNot7Bit = false;
3295 }
3296 uReturn = QCBOR_SUCCESS;
3297 } else if(CheckTagRequirement(TagSpecBinary, pItem->uDataType)) {
3298 *pMessage = pItem->val.string;
3299 if(pbIsNot7Bit != NULL) {
3300 *pbIsNot7Bit = true;
3301 }
3302 uReturn = QCBOR_SUCCESS;
3303
3304 } else {
3305 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3306 }
3307
3308 return uReturn;
3309}
3310
3311
3312
3313
3314
Laurence Lundbladec4537442020-04-14 18:53:22 -07003315
3316
3317
Laurence Lundbladee6430642020-03-14 21:15:44 -07003318
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003319typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003320
3321
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003322// The main exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003323static QCBORError Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003324{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003325 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003326
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003327 if(uResult != 0) {
3328 /* This loop will run a maximum of 19 times because
3329 * UINT64_MAX < 10 ^^ 19. More than that will cause
3330 * exit with the overflow error
3331 */
3332 for(; nExponent > 0; nExponent--) {
3333 if(uResult > UINT64_MAX / 10) {
3334 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3335 }
3336 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003337 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003338
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003339 for(; nExponent < 0; nExponent++) {
3340 uResult = uResult / 10;
3341 if(uResult == 0) {
3342 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3343 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003344 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003345 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003346 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003347
3348 *puResult = uResult;
3349
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003350 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003351}
3352
3353
Laurence Lundbladee6430642020-03-14 21:15:44 -07003354/* Convert a decimal fraction to an int64_t without using
3355 floating point or math libraries. Most decimal fractions
3356 will not fit in an int64_t and this will error out with
3357 under or overflow
3358 */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003359static QCBORError Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003360{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003361 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003362
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003363 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003364
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003365 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003366 * INT64_MAX < 2^31. More than that will cause
3367 * exist with the overflow error
3368 */
3369 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003370 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003371 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003372 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003373 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003374 nExponent--;
3375 }
3376
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003377 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003378 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003379 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3380 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003381 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003382 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003383 }
3384
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003385 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003386
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003387 return QCBOR_SUCCESS;
3388}
3389
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003390/*
3391 Compute value with signed mantissa and signed result. Works with exponent of 2 or 10 based on exponentiator.
3392 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003393static inline QCBORError ExponentiateNN(int64_t nMantissa, int64_t nExponent, int64_t *pnResult, fExponentiator pfExp)
3394{
3395 uint64_t uResult;
3396
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003397 // Take the absolute value of the mantissa and convert to unsigned.
3398 // TODO: this should be possible in one intruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003399 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3400
3401 // Do the exponentiation of the positive mantissa
3402 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3403 if(uReturn) {
3404 return uReturn;
3405 }
3406
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003407
Laurence Lundblade983500d2020-05-14 11:49:34 -07003408 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3409 of INT64_MIN. This assumes two's compliment representation where
3410 INT64_MIN is one increment farther from 0 than INT64_MAX.
3411 Trying to write -INT64_MIN doesn't work to get this because the
3412 compiler tries to work with an int64_t which can't represent
3413 -INT64_MIN.
3414 */
3415 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3416
3417 // Error out if too large
3418 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003419 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3420 }
3421
3422 // Casts are safe because of checks above
3423 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
3424
3425 return QCBOR_SUCCESS;
3426}
3427
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003428/*
3429 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3430 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003431static inline QCBORError ExponentitateNU(int64_t nMantissa, int64_t nExponent, uint64_t *puResult, fExponentiator pfExp)
3432{
3433 if(nMantissa < 0) {
3434 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3435 }
3436
3437 // Cast to unsigned is OK because of check for negative
3438 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
3439 // Exponentiation is straight forward
3440 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
3441}
3442
3443
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003444#include <math.h>
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003445
3446
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003447static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003448{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003449 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003450
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003451 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003452 const uint8_t *pByte = BigNum.ptr;
3453 size_t uLen = BigNum.len;
3454 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07003455 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003456 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003457 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07003458 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003459 }
3460
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003461 *pResult = uResult;
3462 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003463}
3464
Laurence Lundblade887add82020-05-17 05:50:34 -07003465static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003466{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003467 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003468}
3469
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003470static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003471{
3472 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003473 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
3474 if(uError) {
3475 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003476 }
3477 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
3478 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003479 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003480}
3481
3482
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003483static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003484{
3485 uint64_t uResult;
Laurence Lundbladeda095972020-06-06 18:35:33 -07003486 /* negaative int furthest from zero is INT64_MIN
3487 which is expressed as -INT64_MAX-1. The value of
3488 a negative bignum is -n-1, one further from zero
3489 than the positive bignum */
3490
3491 /* say INT64_MIN is -2; then INT64_MAX is 1.
3492 Then -n-1 <= INT64_MIN.
3493 Then -n -1 <= -INT64_MAX - 1
3494 THen n <= INT64_MAX. */
3495 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003496 if(uError) {
3497 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003498 }
3499 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
Laurence Lundblade887add82020-05-17 05:50:34 -07003500 // TODO: this code is incorrect. See RFC 7049
Laurence Lundbladeda095972020-06-06 18:35:33 -07003501 uResult++; // this is the -1 in -n-1
Laurence Lundbladee6430642020-03-14 21:15:44 -07003502 *pResult = -(int64_t)uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003503 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003504}
3505
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003506#include "fenv.h"
Laurence Lundbladec4537442020-04-14 18:53:22 -07003507
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003508
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003509/*
3510Convert a integers and floats to an int64_t.
3511
3512\param[in] uOptions Bit mask list of conversion options.
3513
3514\retval QCBOR_ERR_CONVERSION_NOT_REQUESTED Conversion, possible, but not requested in uOptions.
3515
3516\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3517
3518\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3519
3520*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003521static QCBORError ConvertInt64(const QCBORItem *pItem, uint32_t uOptions, int64_t *pnValue)
3522{
3523 switch(pItem->uDataType) {
3524 // TODO: float when ifdefs are set
3525 case QCBOR_TYPE_DOUBLE:
3526 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
3527 // TODO: what about under/overflow here?
3528 // Invokes the floating-point HW and/or compiler-added libraries
3529 feclearexcept(FE_ALL_EXCEPT);
3530 *pnValue = llround(pItem->val.dfnum);
3531 if(fetestexcept(FE_INVALID)) {
3532 // TODO: better error code
3533 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3534 }
3535 } else {
3536 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3537 }
3538 break;
3539
3540 case QCBOR_TYPE_INT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003541 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003542 *pnValue = pItem->val.int64;
3543 } else {
3544 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3545 }
3546 break;
3547
3548 case QCBOR_TYPE_UINT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003549 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003550 if(pItem->val.uint64 < INT64_MAX) {
3551 *pnValue = pItem->val.int64;
3552 } else {
3553 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3554 }
3555 } else {
3556 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3557 }
3558 break;
3559
3560 default:
3561 return QCBOR_ERR_UNEXPECTED_TYPE;
3562 }
3563 return QCBOR_SUCCESS;
3564}
3565
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003566
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003567void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
3568 uint32_t uOptions,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003569 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003570 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003571{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003572 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003573 return;
3574 }
3575
Laurence Lundbladee6430642020-03-14 21:15:44 -07003576 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003577 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3578 if(uError) {
3579 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003580 return;
3581 }
3582
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003583 if(pItem) {
3584 *pItem = Item;
3585 }
3586
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003587 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uOptions, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003588}
3589
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003590
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003591void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3592 int64_t nLabel,
3593 uint32_t uOptions,
3594 int64_t *pnValue,
3595 QCBORItem *pItem)
3596{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003597 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003598 if(pMe->uLastError != QCBOR_SUCCESS) {
3599 return;
3600 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003601
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003602 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uOptions, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003603}
3604
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003605
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003606void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
3607 const char * szLabel,
3608 uint32_t uOptions,
3609 int64_t *pnValue,
3610 QCBORItem *pItem)
3611{
3612 if(pMe->uLastError != QCBOR_SUCCESS) {
3613 return;
3614 }
3615
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003616 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003617 if(pMe->uLastError != QCBOR_SUCCESS) {
3618 return;
3619 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003620
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003621 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uOptions, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003622}
3623
3624
3625
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003626/*
3627 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003628
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003629 \param[in] uOptions Bit mask list of conversion options.
3630
3631 \retval QCBOR_ERR_CONVERSION_NOT_REQUESTED Conversion, possible, but not requested in uOptions.
3632
3633 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3634
3635 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3636
3637 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003638static QCBORError Int64ConvertAll(const QCBORItem *pItem, uint32_t uOptions, int64_t *pnValue)
3639{
3640 QCBORError uErr;
3641
3642 switch(pItem->uDataType) {
3643
3644 case QCBOR_TYPE_POSBIGNUM:
3645 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3646 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003647 } else {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003648 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003649 }
3650 break;
3651
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003652 case QCBOR_TYPE_NEGBIGNUM:
3653 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3654 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003655 } else {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003656 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003657 }
3658 break;
3659
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003660#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
3661 case QCBOR_TYPE_DECIMAL_FRACTION:
3662 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3663 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
3664 pItem->val.expAndMantissa.nExponent,
3665 pnValue,
3666 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003667 } else {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003668 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3669 }
3670 break;
3671
3672 case QCBOR_TYPE_BIGFLOAT:
3673 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
3674 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
3675 pItem->val.expAndMantissa.nExponent,
3676 pnValue,
3677 Exponentitate2);
3678 } else {
3679 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3680 }
3681 break;
3682
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003683 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
3684 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3685 int64_t nMantissa;
3686 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3687 if(uErr) {
3688 return uErr;
3689 }
3690 return ExponentiateNN(nMantissa,
3691 pItem->val.expAndMantissa.nExponent,
3692 pnValue,
3693 Exponentitate10);
3694 } else {
3695 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3696 }
3697 break;
3698
3699 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
3700 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3701 int64_t nMantissa;
3702 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3703 if(uErr) {
3704 return uErr;
3705 }
3706 return ExponentiateNN(nMantissa,
3707 pItem->val.expAndMantissa.nExponent,
3708 pnValue,
3709 Exponentitate10);
3710 } else {
3711 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3712 }
3713 break;
3714
3715 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
3716 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3717 int64_t nMantissa;
3718 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3719 if(uErr) {
3720 return uErr;
3721 }
3722 return ExponentiateNN(nMantissa,
3723 pItem->val.expAndMantissa.nExponent,
3724 pnValue,
3725 Exponentitate2);
3726 } else {
3727 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3728 }
3729 break;
3730
3731 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
3732 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3733 int64_t nMantissa;
3734 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3735 if(uErr) {
3736 return uErr;
3737 }
3738 return ExponentiateNN(nMantissa,
3739 pItem->val.expAndMantissa.nExponent,
3740 pnValue,
3741 Exponentitate2);
3742 } else {
3743 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003744 }
3745 break;
3746
Laurence Lundbladec4537442020-04-14 18:53:22 -07003747 default:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003748 return QCBOR_ERR_UNEXPECTED_TYPE;
3749#endif
Laurence Lundbladec4537442020-04-14 18:53:22 -07003750 }
3751}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003752
3753
Laurence Lundbladec4537442020-04-14 18:53:22 -07003754/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003755 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003756 */
3757void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uOptions, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003758{
3759 QCBORItem Item;
3760
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003761 QCBORDecode_GetInt64ConvertInternal(pMe, uOptions, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003762
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003763 if(pMe->uLastError == QCBOR_SUCCESS) {
3764 // The above conversion succeeded
3765 return;
3766 }
3767
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003768 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003769 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07003770 return;
3771 }
3772
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003773 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uOptions, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003774}
3775
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003776
3777/*
3778Public function, see header qcbor/qcbor_decode.h file
3779*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003780void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, int64_t *pnValue)
3781{
3782 QCBORItem Item;
3783
3784 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uOptions, pnValue, &Item);
3785
3786 if(pMe->uLastError == QCBOR_SUCCESS) {
3787 // The above conversion succeeded
3788 return;
3789 }
3790
3791 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3792 // The above conversion failed in a way that code below can't correct
3793 return;
3794 }
3795
3796 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uOptions, pnValue);
3797}
3798
3799
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003800/*
3801Public function, see header qcbor/qcbor_decode.h file
3802*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003803void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, int64_t *pnValue)
3804{
3805 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003806 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uOptions, pnValue, &Item);
3807
3808 if(pMe->uLastError == QCBOR_SUCCESS) {
3809 // The above conversion succeeded
3810 return;
3811 }
3812
3813 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3814 // The above conversion failed in a way that code below can't correct
3815 return;
3816 }
3817
3818 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uOptions, pnValue);
3819}
3820
3821
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003822static QCBORError ConvertUint64(const QCBORItem *pItem, uint32_t uOptions, uint64_t *puValue)
3823{
3824 switch(pItem->uDataType) {
3825 // TODO: type flaot
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07003826 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003827 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
3828 feclearexcept(FE_ALL_EXCEPT);
3829 double dRounded = round(pItem->val.dfnum);
3830 // TODO: over/underflow
3831 if(fetestexcept(FE_INVALID)) {
3832 // TODO: better error code
3833 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3834 } else if(isnan(dRounded)) {
3835 // TODO: better error code
3836 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3837 } else if(dRounded >= 0) {
3838 *puValue = (uint64_t)dRounded;
3839 } else {
3840 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3841 }
3842 } else {
3843 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3844 }
3845 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003846
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003847 case QCBOR_TYPE_INT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003848 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003849 if(pItem->val.int64 >= 0) {
3850 *puValue = (uint64_t)pItem->val.int64;
3851 } else {
3852 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3853 }
3854 } else {
3855 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3856 }
3857 break;
3858
3859 case QCBOR_TYPE_UINT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003860 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003861 *puValue = pItem->val.uint64;
3862 } else {
3863 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3864 }
3865 break;
3866
3867 default:
3868 return QCBOR_ERR_UNEXPECTED_TYPE;
3869 }
3870 return QCBOR_SUCCESS;
3871}
Laurence Lundbladec4537442020-04-14 18:53:22 -07003872
3873
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003874void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
3875 uint32_t uOptions,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003876 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003877 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003878{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003879 if(pMe->uLastError != QCBOR_SUCCESS) {
3880 return;
3881 }
3882
Laurence Lundbladec4537442020-04-14 18:53:22 -07003883 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003884
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003885 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3886 if(uError) {
3887 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003888 return;
3889 }
3890
Laurence Lundbladea826c502020-05-10 21:07:00 -07003891 if(pItem) {
3892 *pItem = Item;
3893 }
3894
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003895 pMe->uLastError = (uint8_t)ConvertUint64(&Item, uOptions, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003896}
3897
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003898
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003899void QCBORDecode_GetInt8ConvertInternal(QCBORDecodeContext *pMe, uint32_t uOptions, int8_t *pnValue, QCBORItem *pItem)
3900{
3901 int64_t uValue;
3902 QCBORDecode_GetInt64ConvertInternal(pMe, uOptions, &uValue, pItem);
3903 if(pMe->uLastError != QCBOR_SUCCESS) {
3904 return;
3905 }
3906
3907 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3908 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3909 }
3910}
3911
3912void QCBORDecode_GetInt8ConvertInternalInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, int8_t *pnValue, QCBORItem *pItem)
3913{
3914 int64_t uValue;
3915 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uOptions, &uValue, pItem);
3916 if(pMe->uLastError != QCBOR_SUCCESS) {
3917 return;
3918 }
3919
3920 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3921 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3922 }
3923}
3924
3925void QCBORDecode_GetInt8ConvertInternalInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, int8_t *pnValue, QCBORItem *pItem)
3926{
3927 int64_t uValue;
3928 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uOptions, &uValue, pItem);
3929 if(pMe->uLastError != QCBOR_SUCCESS) {
3930 return;
3931 }
3932
3933 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3934 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3935 }
3936}
3937
3938
3939
3940
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003941void QCBORDecode_GetUint64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3942 int64_t nLabel,
3943 uint32_t uOptions,
3944 uint64_t *puValue,
3945 QCBORItem *pItem)
3946{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003947 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003948 if(pMe->uLastError != QCBOR_SUCCESS) {
3949 return;
3950 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003951
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003952 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uOptions, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003953}
3954
3955
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003956void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003957 const char * szLabel,
3958 uint32_t uOptions,
3959 uint64_t *puValue,
3960 QCBORItem *pItem)
3961{
3962 if(pMe->uLastError != QCBOR_SUCCESS) {
3963 return;
3964 }
3965
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003966 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003967 if(pMe->uLastError != QCBOR_SUCCESS) {
3968 return;
3969 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003970
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003971 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uOptions, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003972}
3973
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003974/*
3975 Public function, see header qcbor/qcbor_decode.h file
3976*/
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003977static QCBORError Uint64ConvertAll(const QCBORItem *pItem, uint32_t uOptions, uint64_t *puValue)
3978{
3979 QCBORError uErr;
3980
3981 switch(pItem->uDataType) {
3982
3983 case QCBOR_TYPE_POSBIGNUM:
3984 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3985 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
3986 } else {
3987 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3988 }
3989 break;
3990
3991 case QCBOR_TYPE_NEGBIGNUM:
3992 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3993 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3994 } else {
3995 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3996 }
3997 break;
3998
3999#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4000
4001 case QCBOR_TYPE_DECIMAL_FRACTION:
4002 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4003 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4004 pItem->val.expAndMantissa.nExponent,
4005 puValue,
4006 Exponentitate10);
4007 } else {
4008 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4009 }
4010 break;
4011
4012 case QCBOR_TYPE_BIGFLOAT:
4013 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
4014 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4015 pItem->val.expAndMantissa.nExponent,
4016 puValue,
4017 Exponentitate2);
4018 } else {
4019 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4020 }
4021 break;
4022
4023 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4024 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4025 // TODO: Would be better to convert to unsigned
4026 int64_t nMantissa;
4027 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4028 if(uErr != QCBOR_SUCCESS) {
4029 return uErr;
4030 }
4031 return ExponentitateNU(nMantissa,
4032 pItem->val.expAndMantissa.nExponent,
4033 puValue,
4034 Exponentitate10);
4035 } else {
4036 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4037 }
4038 break;
4039
4040 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4041 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4042 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4043 } else {
4044 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4045 }
4046 break;
4047
4048 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
4049 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4050 // TODO: Would be better to convert to unsigned
4051 int64_t nMantissa;
4052 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4053 if(uErr != QCBOR_SUCCESS) {
4054 return uErr;
4055 }
4056 return ExponentitateNU(nMantissa,
4057 pItem->val.expAndMantissa.nExponent,
4058 puValue,
4059 Exponentitate2);
4060 } else {
4061 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4062 }
4063 break;
4064
4065 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
4066 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4067 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4068 } else {
4069 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4070 }
4071 break;
4072#endif
4073 default:
4074 return QCBOR_ERR_UNEXPECTED_TYPE;
4075 }
4076}
4077
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004078/*
4079 Public function, see header qcbor/qcbor_decode.h file
4080*/
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004081void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uOptions, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004082{
4083 QCBORItem Item;
4084
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004085 QCBORDecode_GetUInt64ConvertInternal(pMe, uOptions, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004086
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004087 if(pMe->uLastError == QCBOR_SUCCESS) {
4088 // The above conversion succeeded
4089 return;
4090 }
4091
4092 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4093 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004094 return;
4095 }
4096
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004097 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uOptions, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004098}
4099
Laurence Lundbladec4537442020-04-14 18:53:22 -07004100
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004101/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004102 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004103*/
4104void QCBORDecode_GetUint64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, uint64_t *puValue)
4105{
4106 QCBORItem Item;
4107
4108 QCBORDecode_GetUint64ConvertInternalInMapN(pMe, nLabel, uOptions, puValue, &Item);
4109
4110 if(pMe->uLastError == QCBOR_SUCCESS) {
4111 // The above conversion succeeded
4112 return;
4113 }
4114
4115 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4116 // The above conversion failed in a way that code below can't correct
4117 return;
4118 }
4119
4120 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uOptions, puValue);
4121}
4122
4123
4124/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004125 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004126*/
4127void QCBORDecode_GetUint64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, uint64_t *puValue)
4128{
4129 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004130 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe, szLabel, uOptions, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004131
4132 if(pMe->uLastError == QCBOR_SUCCESS) {
4133 // The above conversion succeeded
4134 return;
4135 }
4136
4137 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4138 // The above conversion failed in a way that code below can't correct
4139 return;
4140 }
4141
4142 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uOptions, puValue);
4143}
4144
4145
4146static QCBORError ConvertDouble(const QCBORItem *pItem, uint32_t uOptions, double *pdValue)
4147{
4148 switch(pItem->uDataType) {
4149 // TODO: float when ifdefs are set
4150 case QCBOR_TYPE_DOUBLE:
4151 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
4152 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
4153 *pdValue = pItem->val.dfnum;
4154 } else {
4155 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4156 }
4157 }
4158 break;
4159
4160 case QCBOR_TYPE_INT64:
4161 if(uOptions & QCBOR_CONVERT_TYPE_INT64) {
4162 // TODO: how does this work?
4163 *pdValue = (double)pItem->val.int64;
4164
4165 } else {
4166 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4167 }
4168 break;
4169
4170 case QCBOR_TYPE_UINT64:
4171 if(uOptions & QCBOR_CONVERT_TYPE_UINT64) {
4172 *pdValue = (double)pItem->val.uint64;
4173 } else {
4174 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4175 }
4176 break;
4177
4178 default:
4179 return QCBOR_ERR_UNEXPECTED_TYPE;
4180 }
4181
4182 return QCBOR_SUCCESS;
4183}
4184
4185
4186
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004187void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
4188 uint32_t uOptions,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004189 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004190 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004191{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004192 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004193 return;
4194 }
4195
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004196 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004197
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004198 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004199 if(uError) {
4200 pMe->uLastError = (uint8_t)uError;
4201 return;
4202 }
4203
4204 if(pItem) {
4205 *pItem = Item;
4206 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004207
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004208 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uOptions, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004209}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004210
Laurence Lundbladec4537442020-04-14 18:53:22 -07004211
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004212void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4213 int64_t nLabel,
4214 uint32_t uOptions,
4215 double *pdValue,
4216 QCBORItem *pItem)
4217{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004218 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004219 if(pMe->uLastError != QCBOR_SUCCESS) {
4220 return;
4221 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004222
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004223 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uOptions, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004224}
4225
4226void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4227 const char * szLabel,
4228 uint32_t uOptions,
4229 double *pdValue,
4230 QCBORItem *pItem)
4231{
4232 if(pMe->uLastError != QCBOR_SUCCESS) {
4233 return;
4234 }
4235
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004236 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004237 if(pMe->uLastError != QCBOR_SUCCESS) {
4238 return;
4239 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004240
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004241 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uOptions, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004242}
4243
4244
4245
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004246static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4247{
4248 double dResult;
4249
4250 dResult = 0.0;
4251 const uint8_t *pByte = BigNum.ptr;
4252 size_t uLen = BigNum.len;
4253 /* This will overflow and become the float value INFINITY if the number
4254 is too large to fit. No error will be logged.
4255 TODO: should an error be logged? */
4256 while(uLen--) {
4257 dResult = (dResult * 256.0) + (double)*pByte++;
4258 }
4259
4260 return dResult;
4261}
4262
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004263static QCBORError DoubleConvertAll(const QCBORItem *pItem, uint32_t uOptions, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004264{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004265 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004266 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4267
4268 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004269 switch(pItem->uDataType) {
4270 // TODO: type float
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004271
4272#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004273 case QCBOR_TYPE_DECIMAL_FRACTION:
4274 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4275 // TODO: rounding and overflow errors
4276 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4277 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4278 } else {
4279 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4280 }
4281 break;
4282
4283 case QCBOR_TYPE_BIGFLOAT:
4284 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
4285 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4286 exp2((double)pItem->val.expAndMantissa.nExponent);
4287 } else {
4288 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4289 }
4290 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004291#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004292
4293 case QCBOR_TYPE_POSBIGNUM:
4294 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
4295 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4296 } else {
4297 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4298 }
4299 break;
4300
4301 case QCBOR_TYPE_NEGBIGNUM:
4302 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004303 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004304 } else {
4305 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4306 }
4307 break;
4308
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004309#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004310 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4311 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4312 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4313 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4314 } else {
4315 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4316 }
4317 break;
4318
4319 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4320 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4321 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4322 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4323 } else {
4324 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4325 }
4326 break;
4327
4328 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
4329 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
4330 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4331 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4332 } else {
4333 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4334 }
4335 break;
4336
4337 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
4338 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004339 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004340 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4341 } else {
4342 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4343 }
4344 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004345#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4346
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004347
4348 default:
4349 return QCBOR_ERR_UNEXPECTED_TYPE;
4350 }
4351
4352 return QCBOR_SUCCESS;
4353}
4354
4355
4356/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004357 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004358*/
4359void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe, uint32_t uOptions, double *pdValue)
4360{
4361
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004362 QCBORItem Item;
4363
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004364 QCBORDecode_GetDoubleConvertInternal(pMe, uOptions, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004365
4366 if(pMe->uLastError == QCBOR_SUCCESS) {
4367 // The above conversion succeeded
4368 return;
4369 }
4370
4371 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4372 // The above conversion failed in a way that code below can't correct
4373 return;
4374 }
4375
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004376 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uOptions, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004377}
4378
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004379
4380/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004381 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004382*/
4383void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, double *pdValue)
4384{
4385 QCBORItem Item;
4386
4387 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uOptions, pdValue, &Item);
4388
4389 if(pMe->uLastError == QCBOR_SUCCESS) {
4390 // The above conversion succeeded
4391 return;
4392 }
4393
4394 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4395 // The above conversion failed in a way that code below can't correct
4396 return;
4397 }
4398
4399 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uOptions, pdValue);
4400}
4401
4402
4403/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004404 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004405*/
4406void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, double *pdValue)
4407{
4408 QCBORItem Item;
4409 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uOptions, pdValue, &Item);
4410
4411 if(pMe->uLastError == QCBOR_SUCCESS) {
4412 // The above conversion succeeded
4413 return;
4414 }
4415
4416 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4417 // The above conversion failed in a way that code below can't correct
4418 return;
4419 }
4420
4421 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uOptions, pdValue);
4422}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004423
4424
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004425#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004426static void ProcessDecimalFraction(QCBORDecodeContext *pMe,
4427 uint8_t uTagRequirement,
4428 QCBORItem *pItem,
4429 int64_t *pnMantissa,
4430 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004431{
4432 QCBORError uErr;
4433
4434 if(pItem->uDataType == QCBOR_TYPE_ARRAY) {
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004435
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004436 if(uTagRequirement == QCBOR_TAGSPEC_MATCH_TAG_CONTENT_TYPE) {
4437 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4438 return;
4439 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004440 /* The decimal fraction was untagged so it shows up as an
4441 array at this point. We are called to interpret it
4442 as a decimal fraction, so do protocol decoding. If
4443 it was tagged, iw would shouw up here with the
4444 QCBOR_TYPE_DECIMAL_FRACTION or such. */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004445 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4446 if(uErr != QCBOR_SUCCESS) {
4447 pMe->uLastError = (uint8_t)uErr;
4448 return;
4449 }
4450 }
4451
4452 if(uTagRequirement == QCBOR_TAGSPEC_MATCH_TAG_CONTENT_TYPE) {
4453 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4454 return;
4455 }
4456
4457 switch (pItem->uDataType) {
4458
4459 case QCBOR_TYPE_DECIMAL_FRACTION:
4460 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
4461 *pnExponent = pItem->val.expAndMantissa.nExponent;
4462 break;
4463
4464 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4465 *pnExponent = pItem->val.expAndMantissa.nExponent;
4466
4467 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
4468 if(uErr != QCBOR_SUCCESS) {
4469 pMe->uLastError = (uint8_t)uErr;
4470 }
4471 break;
4472
4473 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4474 *pnExponent = pItem->val.expAndMantissa.nExponent;
4475
4476 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
4477 if(uErr != QCBOR_SUCCESS) {
4478 pMe->uLastError = (uint8_t)uErr;
4479 }
4480 break;
4481
4482 default:
4483 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4484 }
4485}
4486
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004487
4488void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
4489 uint8_t uTagRequirement,
4490 int64_t *pnMantissa,
4491 int64_t *pnExponent)
4492{
4493 if(pMe->uLastError != QCBOR_SUCCESS) {
4494 return;
4495 }
4496
4497 QCBORItem Item;
4498 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4499 if(uError) {
4500 pMe->uLastError = (uint8_t)uError;
4501 return;
4502 }
4503
4504 ProcessDecimalFraction(pMe, uTagRequirement, &Item, pnMantissa, pnExponent);
4505}
4506
4507
4508void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004509 uint8_t uTagRequirement,
4510 int64_t nLabel,
4511 int64_t *pnMantissa,
4512 int64_t *pnExponent)
4513{
4514 QCBORItem Item;
4515
4516 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004517 ProcessDecimalFraction(pMe, uTagRequirement, &Item, pnMantissa, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004518}
4519
4520
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004521void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
4522 uint8_t uTagRequirement,
4523 const char *szLabel,
4524 int64_t *pnMantissa,
4525 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004526{
4527 QCBORItem Item;
4528
4529 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4530
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004531 ProcessDecimalFraction(pMe, uTagRequirement, &Item, pnMantissa, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004532}
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004533#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004534
4535
4536UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
4537{
4538 while(uInt & 0xff0000000000UL) {
4539 uInt = uInt << 8;
4540 };
4541
4542 UsefulOutBuf UOB;
4543
4544 UsefulOutBuf_Init(&UOB, Buffer);
4545
4546 while(uInt) {
4547 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff0000000000UL) >> 56));
4548 uInt = uInt << 8;
4549 }
4550
4551 return UsefulOutBuf_OutUBuf(&UOB);
4552}
4553
4554
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004555#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4556
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004557static void ProcessDecimalFractionBig(QCBORDecodeContext *pMe,
4558 uint8_t uTagRequirement,
4559 QCBORItem *pItem,
4560 UsefulBuf BufferForMantissa,
4561 UsefulBufC *pMantissa,
4562 bool *pbIsNegative,
4563 int64_t *pnExponent)
4564{
4565
4566 const TagSpecification TagSpec = {uTagRequirement,
4567 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4568 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4569 };
4570
4571 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
4572 if(uErr != QCBOR_SUCCESS) {
4573 pMe->uLastError = (uint8_t)uErr;
4574 return;
4575 }
4576
4577 if(pItem->uDataType == QCBOR_TYPE_ARRAY) {
4578 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4579 if(uErr != QCBOR_SUCCESS) {
4580 pMe->uLastError = (uint8_t)uErr;
4581 return;
4582 }
4583 }
4584
4585 uint64_t uMantissa;
4586
4587 switch (pItem->uDataType) {
4588
4589 case QCBOR_TYPE_DECIMAL_FRACTION:
4590 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
4591 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
4592 *pbIsNegative = false;
4593 } else {
4594 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
4595 *pbIsNegative = true;
4596 }
4597 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
4598 *pnExponent = pItem->val.expAndMantissa.nExponent;
4599 break;
4600
4601 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4602 *pnExponent = pItem->val.expAndMantissa.nExponent;
4603 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4604 *pbIsNegative = false;
4605 break;
4606
4607 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4608 *pnExponent = pItem->val.expAndMantissa.nExponent;
4609 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4610 *pbIsNegative = true;
4611 break;
4612
4613 default:
4614 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4615 }
4616}
4617
4618
4619void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
4620 uint8_t uTagRequirement,
4621 UsefulBuf MantissaBuffer,
4622 UsefulBufC *pMantissa,
4623 bool *pbMantissaIsNegative,
4624 int64_t *pnExponent)
4625{
4626
4627 if(pMe->uLastError != QCBOR_SUCCESS) {
4628 return;
4629 }
4630
4631 QCBORItem Item;
4632 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4633 if(uError) {
4634 pMe->uLastError = (uint8_t)uError;
4635 return;
4636 }
4637
4638 ProcessDecimalFractionBig(pMe, uTagRequirement, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
4639
4640}
4641
4642void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
4643 uint8_t uTagRequirement,
4644 int64_t nLabel,
4645 UsefulBuf BufferForMantissa,
4646 UsefulBufC *pMantissa,
4647 bool *pbIsNegative,
4648 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004649{
4650 QCBORItem Item;
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004651
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004652 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004653 if(pMe->uLastError != QCBOR_SUCCESS) {
4654 return;
4655 }
4656
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004657 ProcessDecimalFractionBig(pMe, uTagRequirement, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
4658}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004659
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004660
4661void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
4662 uint8_t uTagRequirement,
4663 const char *szLabel,
4664 UsefulBuf BufferForMantissa,
4665 UsefulBufC *pMantissa,
4666 bool *pbIsNegative,
4667 int64_t *pnExponent)
4668{
4669 QCBORItem Item;
4670
4671 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4672 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004673 return;
4674 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004675
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004676 ProcessDecimalFractionBig(pMe, uTagRequirement, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004677}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004678
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004679#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004680
4681/*
4682
4683 TODO: do something with this text
4684 The main mode of decoding is a pre-order travesal of the tree of leaves (numbers, strings...)
4685 formed by intermediate nodes (arrays and maps). The cursor for the traversal
4686 is the byte offset in the encoded input and a leaf counter for definite
4687 length maps and arrays. Indefinite length maps and arrays are handled
4688 by look ahead for the break.
4689
4690 The view presented to the caller has tags, labels and the chunks of
4691 indefinite length strings aggregated into one decorated data item.
4692
4693 The caller understands the nesting level in pre-order traversal by
4694 the fact that a data item that is a map or array is presented to
4695 the caller when it is first encountered in the pre-order traversal and that all data items are presented with its nesting level
4696 and the nesting level of the next item.
4697
4698 The caller traverse maps and arrays in a special mode that often more convenient
4699 that tracking by nesting level. When an array or map is expected or encountered
4700 the EnterMap or EnteryArray can be called.
4701
4702 When entering a map or array like this, the cursor points to the first
4703 item in the map or array. When exiting, it points to the item after
4704 the map or array, regardless of whether the items in the map or array were
4705 all traversed.
4706
4707 When in a map or array, the cursor functions as normal, but traversal
4708 cannot go past the end of the map or array that was entered. If this
4709 is attempted the QCBOR_ERR_NO_MORE_ITEMS error is returned. To
4710 go past the end of the map or array ExitMap() or ExitArray() must
4711 be called. It can be called any time regardless of the position
4712 of the cursor.
4713
4714 When a map is entered, a special function allows fetching data items
4715 by label. This call will traversal the whole map looking for the
4716 labeled item. The whole map is traversed so as to detect duplicates.
4717 This type of fetching items does not affect the normal traversal
4718 cursor.
4719
4720
4721 When a data item is presented to the caller, the nesting level of the data
4722 item is presented along with the nesting level of the item that would be
4723 next consumed.
4724 */