blob: e5a4cab971ba1d6c44174339be9442122d2a3a27 [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 Lundblade12d32c52018-09-19 11:25:27 -070035#include "ieee754.h"
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070036
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070037
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053038/*
39 This casts away the const-ness of a pointer, usually so it can be
40 freed or realloced.
41 */
42#define UNCONST_POINTER(ptr) ((void *)(ptr))
43
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070044
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070045
Laurence Lundblade02625d42020-06-25 14:41:41 -070046inline static bool
47// TODO: add more tests for QCBOR_TYPE_MAP_AS_ARRAY mode in qcbor_decode_tests.c
48QCBORItem_IsMapOrArray(const QCBORItem *pMe)
49{
50 const uint8_t uDataType = pMe->uDataType;
51 return uDataType == QCBOR_TYPE_MAP ||
52 uDataType == QCBOR_TYPE_ARRAY ||
53 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
54}
55
56inline static bool
57QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
58{
59 if(!QCBORItem_IsMapOrArray(pMe)){
60 return false;
61 }
62
63 if(pMe->val.uCount != 0) {
64 return false;
65 }
66 return true;
67}
68
69inline static bool
70QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
71{
72 if(!QCBORItem_IsMapOrArray(pMe)){
73 return false;
74 }
75
76 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
77 return false;
78 }
79 return true;
80}
81
82
Laurence Lundbladeee851742020-01-08 08:37:05 -080083/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070084 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080085 ===========================================================================*/
86
Laurence Lundblade9c905e82020-04-25 11:31:38 -070087/*
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070088 See commecnts about and typedef of QCBORDecodeNesting in qcbor_private.h, the data structure
89 all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -070090
Laurence Lundblade9c905e82020-04-25 11:31:38 -070091
Laurence Lundblade9c905e82020-04-25 11:31:38 -070092
Laurence Lundblade9c905e82020-04-25 11:31:38 -070093 */
94
Laurence Lundblade24d509a2020-06-06 18:43:15 -070095
96inline static uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -070097DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -070098{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070099 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700100 /*
101 Limit in DecodeNesting_Descend against more than
102 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
103 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700104 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700105}
106
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700107
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700108inline static uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700109DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700110{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700111 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700112 /*
113 Limit in DecodeNesting_Descend against more than
114 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
115 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700116 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700117}
118
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700119
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700120static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700121DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700122{
123 return pNesting->pCurrentBounded->u.ma.uStartOffset;
124}
125
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700126
Laurence Lundblade085d7952020-07-24 10:26:30 -0700127static inline bool
128DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
129{
130 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
131 return true;
132 } else {
133 return false;
134 }
135}
136
137
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700138inline static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700139DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700140{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700141 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700142 return true;
143 } else {
144 return false;
145 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700146}
147
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700148
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700149inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700150DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700151{
152 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700153 // Not a map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700154 return false;
155 }
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700156 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700157 // Is indefinite
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700158 return false;
159 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700160 // All checks passed; is a definte length map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700161 return true;
162}
163
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700164
Laurence Lundblade642282a2020-06-23 12:00:33 -0700165inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700166DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700167{
168 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700169 // is a byte string
Laurence Lundblade642282a2020-06-23 12:00:33 -0700170 return true;
171 }
172 return false;
173}
174
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700175
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700176inline static bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700177{
178 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
179 return true;
180 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700181 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700182 return true;
183 }
184 return false;
185}
186
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700187
Laurence Lundblade085d7952020-07-24 10:26:30 -0700188inline static void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700189{
190 // Should be only called on maps and arrays
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700191 /*
192 DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
193 larger than DecodeNesting_EnterBoundedMode which keeps it less than
194 uin32_t so the cast is safe.
195 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700196 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700197
198 if(bIsEmpty) {
199 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
200 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700201}
202
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700203
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700204inline static void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700205{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700206 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700207}
208
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700209
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700210inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700211DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700212{
213 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700214 // No bounded map or array or... set up
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700215 return false;
216 }
217 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700218 // Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700219 return false;
220 }
221 if(!DecodeNesting_IsCurrentBounded(pNesting)) { // TODO: pCurrent vs pCurrentBounded
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700222 // Not at a bounded level
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700223 return false;
224 }
Laurence Lundbladed0304932020-06-27 10:59:38 -0700225 // Works for both definite and indefinite length maps/arrays
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700226 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700227 // Count is not zero, still unconsumed item
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700228 return false;
229 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700230 // All checks passed, got to the end of a map/array
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700231 return true;
232}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700233
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700234
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700235inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700236DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700237{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700238 // Must only be called on map / array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700239 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
240 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700241 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700242 return false;
243 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700244}
245
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700246
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700247inline static bool
248DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700249{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700250 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
251 return true;
252 } else {
253 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700254 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700255}
256
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700257
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700258inline static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700259DecodeNesting_CheckBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700260{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700261 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700262 return false;
263 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700264
265 if(pNesting->pCurrentBounded->uLevelType != uType) {
266 return false;
267 }
268
269 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700270}
271
Laurence Lundblade02625d42020-06-25 14:41:41 -0700272
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700273inline static void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700274DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700275{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700276 // Only call on a defnite length array / map
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700277 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700278}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700279
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700280
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700281inline static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700282DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
283{
284 // Only call on a defnite length array / map
285 pNesting->pCurrent->u.ma.uCountCursor++;
286}
287
288
289inline static void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700290DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
291{
292 pNesting->pCurrent--;
293}
294
Laurence Lundblade02625d42020-06-25 14:41:41 -0700295
296static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700297DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700298{
299 // Error out if nesting is too deep
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700300 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700301 return QCBOR_ERR_ARRAY_NESTING_TOO_DEEP;
302 }
303
304 // The actual descend
305 pNesting->pCurrent++;
306
307 pNesting->pCurrent->uLevelType = uType;
308
309 return QCBOR_SUCCESS;
310}
311
312
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700313inline static QCBORError
Laurence Lundblade085d7952020-07-24 10:26:30 -0700314DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700315{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700316 /*
317 Should only be called on map/array.
318
319 Have descended into this before this is called. The job here is
320 just to mark it in bounded mode.
321 */
Laurence Lundblade085d7952020-07-24 10:26:30 -0700322 if(uOffset >= QCBOR_NON_BOUNDED_OFFSET) { //TODO: fix this bounds check
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700323 return QCBOR_ERR_BUFFER_TOO_LARGE;
324 }
325
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700326 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700327
328 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700329
330 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700331}
332
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700333
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700334inline static QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700335DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700336 uint8_t uQCBORType,
337 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700338{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700339 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700340
341 if(uCount == 0) {
342 // Nothing to do for empty definite lenth arrays. They are just are
343 // effectively the same as an item that is not a map or array
344 goto Done;
345 // Empty indefinite length maps and arrays are handled elsewhere
346 }
347
348 // Error out if arrays is too long to handle
Laurence Lundblade02625d42020-06-25 14:41:41 -0700349 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
350 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
351 uError = QCBOR_ERR_ARRAY_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700352 goto Done;
353 }
354
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700355 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700356 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700357 goto Done;
358 }
359
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700360 // Fill in the new map/array level. Check above makes casts OK.
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700361 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
362 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700363
364 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700365
366Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700367 return uError;;
368}
369
370
371static inline void
372DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
373{
374 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
375}
376
377
378static inline void
379DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
380{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700381 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700382 pNesting->pCurrentBounded--;
383 if(DecodeNesting_IsCurrentBounded(pNesting)) {
384 break;
385 }
386 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700387}
388
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700389static inline void
390DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
391{
392 pNesting->pCurrent = pNesting->pCurrentBounded;
393}
394
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700395
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700396inline static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700397DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
398 size_t uEndOffset,
399 size_t uEndOfBstr)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700400{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700401 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700402
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700403 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700404 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700405 goto Done;
406 }
407
Laurence Lundblade02625d42020-06-25 14:41:41 -0700408 // Fill in the new byte string level
409 // TODO: justify cast
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700410 pNesting->pCurrent->u.bs.uPreviousEndOffset = (uint32_t)uEndOffset;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700411 pNesting->pCurrent->u.bs.uEndOfBstr = (uint32_t)uEndOfBstr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700412
Laurence Lundblade02625d42020-06-25 14:41:41 -0700413 // Bstr wrapped levels are always bounded
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700414 pNesting->pCurrentBounded = pNesting->pCurrent;
415
416Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700417 return uError;;
418}
419
Laurence Lundbladed0304932020-06-27 10:59:38 -0700420
421static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700422DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700423{
424 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700425}
426
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700427
Laurence Lundbladeee851742020-01-08 08:37:05 -0800428inline static void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700429DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700430{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700431 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700432 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
433 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700434}
435
436
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700437inline static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700438DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting, QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700439{
Laurence Lundblade085d7952020-07-24 10:26:30 -0700440 //*pSave = *pNesting;
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700441 pNesting->pCurrent = pNesting->pCurrentBounded;
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700442 pNesting->pCurrent->u.ma.uCountCursor = pNesting->pCurrent->u.ma.uCountTotal;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700443}
444
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700445
Laurence Lundblade02625d42020-06-25 14:41:41 -0700446static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700447DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting, const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700448{
449 *pNesting = *pSave;
450}
451
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700452
Laurence Lundblade02625d42020-06-25 14:41:41 -0700453static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700454DecodeNesting_GetEndOfBstr(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700455{
456 return pMe->pCurrentBounded->u.bs.uEndOfBstr;
457}
458
459
Laurence Lundblade02625d42020-06-25 14:41:41 -0700460static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700461DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700462{
463 return pMe->pCurrentBounded->u.bs.uPreviousEndOffset;
464}
465
466
Laurence Lundblade02625d42020-06-25 14:41:41 -0700467#include <stdio.h>
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700468
469const char *TypeStr(uint8_t type)
470{
471 switch(type) {
472 case QCBOR_TYPE_MAP: return " map";
473 case QCBOR_TYPE_ARRAY: return "array";
474 case QCBOR_TYPE_BYTE_STRING: return " bstr";
475 default: return " --- ";
476 }
477}
478
479static char buf[20]; // Not thread safe, but that is OK
480const char *CountString(uint16_t uCount, uint16_t uTotal)
481{
482 if(uTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
483 strcpy(buf, "indefinite");
484 } else {
485 sprintf(buf, "%d/%d", uCount, uTotal);
486 }
487 return buf;
488}
489
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700490
Laurence Lundblade02625d42020-06-25 14:41:41 -0700491void DecodeNesting_Print(QCBORDecodeNesting *pNesting, UsefulInputBuf *pBuf, const char *szName)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700492{
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700493#if 0
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700494 printf("---%s--%d/%d--\narrow is current bounded level\n",
Laurence Lundblade02625d42020-06-25 14:41:41 -0700495 szName,
496 (uint32_t)pBuf->cursor,
497 (uint32_t)pBuf->UB.len);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700498
499 printf("Level Type Count Offsets \n");
Laurence Lundblade02625d42020-06-25 14:41:41 -0700500 for(int i = 0; i < QCBOR_MAX_ARRAY_NESTING; i++) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700501 if(&(pNesting->pLevels[i]) > pNesting->pCurrent) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700502 break;
503 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700504
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700505 printf("%2s %2d %s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700506 pNesting->pCurrentBounded == &(pNesting->pLevels[i]) ? "->": " ",
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700507 i,
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700508 TypeStr(pNesting->pLevels[i].uLevelType));
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700509
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700510 if(pNesting->pLevels[i].uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700511 printf(" %5d %5d",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700512 pNesting->pLevels[i].u.bs.uEndOfBstr,
513 pNesting->pLevels[i].u.bs.uPreviousEndOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700514
515 } else {
516 printf("%10.10s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700517 CountString(pNesting->pLevels[i].u.ma.uCountCursor,
518 pNesting->pLevels[i].u.ma.uCountTotal));
519 if(pNesting->pLevels[i].u.ma.uStartOffset != UINT32_MAX) {
520 printf("Bounded start: %u",pNesting->pLevels[i].u.ma.uStartOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700521 }
522 }
523
524 printf("\n");
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700525 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700526 printf("\n");
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700527#endif
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700528}
529
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700530
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700531
Laurence Lundbladeee851742020-01-08 08:37:05 -0800532/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800533 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
534
535 The following four functions are pretty wrappers for invocation of
536 the string allocator supplied by the caller.
537
Laurence Lundbladeee851742020-01-08 08:37:05 -0800538 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800539
Laurence Lundbladeee851742020-01-08 08:37:05 -0800540static inline void
541StringAllocator_Free(const QCORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800542{
543 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
544}
545
Laurence Lundbladeee851742020-01-08 08:37:05 -0800546// StringAllocator_Reallocate called with pMem NULL is
547// equal to StringAllocator_Allocate()
548static inline UsefulBuf
549StringAllocator_Reallocate(const QCORInternalAllocator *pMe,
550 void *pMem,
551 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800552{
553 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
554}
555
Laurence Lundbladeee851742020-01-08 08:37:05 -0800556static inline UsefulBuf
557StringAllocator_Allocate(const QCORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800558{
559 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
560}
561
Laurence Lundbladeee851742020-01-08 08:37:05 -0800562static inline void
563StringAllocator_Destruct(const QCORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800564{
565 if(pMe->pfAllocator) {
566 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
567 }
568}
569
570
571
Laurence Lundbladeee851742020-01-08 08:37:05 -0800572/*===========================================================================
573 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700574
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800575 See qcbor/qcbor_decode.h for definition of the object
576 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800577 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578/*
579 Public function, see header file
580 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800581void QCBORDecode_Init(QCBORDecodeContext *me,
582 UsefulBufC EncodedCBOR,
583 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700584{
585 memset(me, 0, sizeof(QCBORDecodeContext));
586 UsefulInputBuf_Init(&(me->InBuf), EncodedCBOR);
Laurence Lundbladeee851742020-01-08 08:37:05 -0800587 // Don't bother with error check on decode mode. If a bad value is
588 // passed it will just act as if the default normal mode of 0 was set.
Laurence Lundbladee6bcef12020-04-01 10:56:27 -0700589 me->uDecodeMode = (uint8_t)nDecodeMode;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700590 DecodeNesting_Init(&(me->nesting));
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700591 for(int i = 0; i < QCBOR_NUM_MAPPED_TAGS; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -0700592 me->auMappedTags[i] = CBOR_TAG_INVALID16;
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700593 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700594}
595
596
597/*
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700598 Public function, see header file
599 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800600void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
601 QCBORStringAllocate pfAllocateFunction,
602 void *pAllocateContext,
603 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700604{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800605 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
606 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
607 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700608}
609
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800610
611/*
612 Public function, see header file
613 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700614void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800615 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700616{
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700617 // This does nothing now. It is retained for backwards compatibility
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700618 (void)pMe;
619 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700620}
621
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700622
623/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800624 This decodes the fundamental part of a CBOR data item, the type and
625 number
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800626
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700627 This is the Counterpart to InsertEncodedTypeAndNumber().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800628
Laurence Lundbladeee851742020-01-08 08:37:05 -0800629 This does the network->host byte order conversion. The conversion
630 here also results in the conversion for floats in addition to that
631 for lengths, tags and integer values.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800632
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700633 This returns:
634 pnMajorType -- the major type for the item
Laurence Lundbladeee851742020-01-08 08:37:05 -0800635
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800636 puArgument -- the "number" which is used a the value for integers,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800637 tags and floats and length for strings and arrays
638
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800639 pnAdditionalInfo -- Pass this along to know what kind of float or
Laurence Lundbladeee851742020-01-08 08:37:05 -0800640 if length is indefinite
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800641
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800642 The int type is preferred to uint8_t for some variables as this
643 avoids integer promotions, can reduce code size and makes
644 static analyzers happier.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700645 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800646inline static QCBORError DecodeTypeAndNumber(UsefulInputBuf *pUInBuf,
647 int *pnMajorType,
648 uint64_t *puArgument,
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800649 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700650{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700651 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800652
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700653 // Get the initial byte that every CBOR data item has
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800654 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800655
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700656 // Break down the initial byte
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800657 const int nTmpMajorType = nInitialByte >> 5;
658 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800659
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800660 // Where the number or argument accumulates
661 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800662
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800663 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700664 // Need to get 1,2,4 or 8 additional argument bytes. Map
665 // LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800666 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800667
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800668 // Loop getting all the bytes in the argument
669 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800670 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800671 // This shift and add gives the endian conversion
672 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
673 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800674 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800675 // The reserved and thus-far unused additional info values
676 nReturn = QCBOR_ERR_UNSUPPORTED;
677 goto Done;
678 } else {
679 // Less than 24, additional info is argument or 31, an indefinite length
680 // No more bytes to get
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800681 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700682 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800683
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700684 if(UsefulInputBuf_GetError(pUInBuf)) {
685 nReturn = QCBOR_ERR_HIT_END;
686 goto Done;
687 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800688
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700689 // All successful if we got here.
690 nReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800691 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800692 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800693 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800694
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700695Done:
696 return nReturn;
697}
698
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800699
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700700/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800701 CBOR doesn't explicitly specify two's compliment for integers but all
702 CPUs use it these days and the test vectors in the RFC are so. All
703 integers in the CBOR structure are positive and the major type
704 indicates positive or negative. CBOR can express positive integers
705 up to 2^x - 1 where x is the number of bits and negative integers
706 down to 2^x. Note that negative numbers can be one more away from
707 zero than positive. Stdint, as far as I can tell, uses two's
708 compliment to represent negative integers.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800709
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700710 See http://www.unix.org/whitepapers/64bit.html for reasons int isn't
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800711 used carefully here, and in particular why it isn't used in the interface.
712 Also see
713 https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
714
715 Int is used for values that need less than 16-bits and would be subject
716 to integer promotion and complaining by static analyzers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700717 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800718inline static QCBORError
719DecodeInteger(int nMajorType, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700720{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700721 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800722
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700723 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
724 if (uNumber <= INT64_MAX) {
725 pDecodedItem->val.int64 = (int64_t)uNumber;
726 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800727
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700728 } else {
729 pDecodedItem->val.uint64 = uNumber;
730 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800731
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700732 }
733 } else {
734 if(uNumber <= INT64_MAX) {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800735 // CBOR's representation of negative numbers lines up with the
736 // two-compliment representation. A negative integer has one
737 // more in range than a positive integer. INT64_MIN is
738 // equal to (-INT64_MAX) - 1.
739 pDecodedItem->val.int64 = (-(int64_t)uNumber) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700740 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800741
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742 } else {
743 // C can't represent a negative integer in this range
Laurence Lundblade21d1d812019-09-28 22:47:49 -1000744 // so it is an error.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700745 nReturn = QCBOR_ERR_INT_OVERFLOW;
746 }
747 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800748
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700749 return nReturn;
750}
751
752// Make sure #define value line up as DecodeSimple counts on this.
753#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
754#error QCBOR_TYPE_FALSE macro value wrong
755#endif
756
757#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
758#error QCBOR_TYPE_TRUE macro value wrong
759#endif
760
761#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
762#error QCBOR_TYPE_NULL macro value wrong
763#endif
764
765#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
766#error QCBOR_TYPE_UNDEF macro value wrong
767#endif
768
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700769#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
770#error QCBOR_TYPE_BREAK macro value wrong
771#endif
772
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700773#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
774#error QCBOR_TYPE_DOUBLE macro value wrong
775#endif
776
777#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
778#error QCBOR_TYPE_FLOAT macro value wrong
779#endif
780
781/*
782 Decode true, false, floats, break...
783 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800784inline static QCBORError
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800785DecodeSimple(int nAdditionalInfo, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700786{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700787 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800788
Laurence Lundbladeee851742020-01-08 08:37:05 -0800789 // uAdditionalInfo is 5 bits from the initial byte compile time checks
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800790 // above make sure uAdditionalInfo values line up with uDataType values.
791 // DecodeTypeAndNumber never returns a major type > 1f so cast is safe
792 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800793
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800794 switch(nAdditionalInfo) {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800795 // No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they are
796 // caught before this is called.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800797
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700798 case HALF_PREC_FLOAT:
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700799 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uNumber);
800 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700801 break;
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700802 case SINGLE_PREC_FLOAT:
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700803 pDecodedItem->val.dfnum = (double)UsefulBufUtil_CopyUint32ToFloat((uint32_t)uNumber);
804 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700805 break;
806 case DOUBLE_PREC_FLOAT:
807 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uNumber);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700808 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700809 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800810
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700811 case CBOR_SIMPLEV_FALSE: // 20
812 case CBOR_SIMPLEV_TRUE: // 21
813 case CBOR_SIMPLEV_NULL: // 22
814 case CBOR_SIMPLEV_UNDEF: // 23
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700815 case CBOR_SIMPLE_BREAK: // 31
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700816 break; // nothing to do
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800817
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700818 case CBOR_SIMPLEV_ONEBYTE: // 24
819 if(uNumber <= CBOR_SIMPLE_BREAK) {
820 // This takes out f8 00 ... f8 1f which should be encoded as e0 … f7
Laurence Lundblade077475f2019-04-26 09:06:33 -0700821 nReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700822 goto Done;
823 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800824 /* FALLTHROUGH */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700825 // fall through intentionally
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800826
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700827 default: // 0-19
828 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundbladeee851742020-01-08 08:37:05 -0800829 /*
830 DecodeTypeAndNumber will make uNumber equal to
831 uAdditionalInfo when uAdditionalInfo is < 24 This cast is
832 safe because the 2, 4 and 8 byte lengths of uNumber are in
833 the double/float cases above
834 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700835 pDecodedItem->val.uSimple = (uint8_t)uNumber;
836 break;
837 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800838
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700839Done:
840 return nReturn;
841}
842
843
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700844/*
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530845 Decode text and byte strings. Call the string allocator if asked to.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700846 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800847inline static QCBORError DecodeBytes(const QCORInternalAllocator *pAllocator,
848 int nMajorType,
849 uint64_t uStrLen,
850 UsefulInputBuf *pUInBuf,
851 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700852{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700853 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800854
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800855 // CBOR lengths can be 64 bits, but size_t is not 64 bits on all CPUs.
856 // This check makes the casts to size_t below safe.
857
858 // 4 bytes less than the largest sizeof() so this can be tested by
859 // putting a SIZE_MAX length in the CBOR test input (no one will
860 // care the limit on strings is 4 bytes shorter).
861 if(uStrLen > SIZE_MAX-4) {
862 nReturn = QCBOR_ERR_STRING_TOO_LONG;
863 goto Done;
864 }
865
866 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530867 if(UsefulBuf_IsNULLC(Bytes)) {
868 // Failed to get the bytes for this string item
869 nReturn = QCBOR_ERR_HIT_END;
870 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700871 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530872
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800873 if(pAllocator) {
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530874 // We are asked to use string allocator to make a copy
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800875 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530876 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +0700877 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530878 goto Done;
879 }
880 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800881 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530882 } else {
883 // Normal case with no string allocator
884 pDecodedItem->val.string = Bytes;
885 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800886 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800887 // Cast because ternary operator causes promotion to integer
888 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
889 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800890
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530891Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700892 return nReturn;
893}
894
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700895
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800896
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700897
898
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700899
900
Laurence Lundbladeee851742020-01-08 08:37:05 -0800901// Make sure the constants align as this is assumed by
902// the GetAnItem() implementation
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700903#if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
904#error QCBOR_TYPE_ARRAY value not lined up with major type
905#endif
906#if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
907#error QCBOR_TYPE_MAP value not lined up with major type
908#endif
909
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700910/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800911 This gets a single data item and decodes it including preceding
912 optional tagging. This does not deal with arrays and maps and nesting
913 except to decode the data item introducing them. Arrays and maps are
914 handled at the next level up in GetNext().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800915
Laurence Lundbladeee851742020-01-08 08:37:05 -0800916 Errors detected here include: an array that is too long to decode,
917 hit end of buffer unexpectedly, a few forms of invalid encoded CBOR
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700918 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800919static QCBORError GetNext_Item(UsefulInputBuf *pUInBuf,
920 QCBORItem *pDecodedItem,
921 const QCORInternalAllocator *pAllocator)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700922{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700923 QCBORError nReturn;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800924
Laurence Lundbladeee851742020-01-08 08:37:05 -0800925 /*
926 Get the major type and the number. Number could be length of more
927 bytes or the value depending on the major type nAdditionalInfo is
928 an encoding of the length of the uNumber and is needed to decode
929 floats and doubles
930 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800931 int nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700932 uint64_t uNumber;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800933 int nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800934
Laurence Lundblade4b09f632019-10-09 14:34:59 -0700935 memset(pDecodedItem, 0, sizeof(QCBORItem));
936
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800937 nReturn = DecodeTypeAndNumber(pUInBuf, &nMajorType, &uNumber, &nAdditionalInfo);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800938
Laurence Lundbladeee851742020-01-08 08:37:05 -0800939 // Error out here if we got into trouble on the type and number. The
940 // code after this will not work if the type and number is not good.
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700941 if(nReturn) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700942 goto Done;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700943 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800944
Laurence Lundbladeee851742020-01-08 08:37:05 -0800945 // At this point the major type and the value are valid. We've got
946 // the type and the number that starts every CBOR data item.
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800947 switch (nMajorType) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700948 case CBOR_MAJOR_TYPE_POSITIVE_INT: // Major type 0
949 case CBOR_MAJOR_TYPE_NEGATIVE_INT: // Major type 1
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800950 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700951 nReturn = QCBOR_ERR_BAD_INT;
952 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800953 nReturn = DecodeInteger(nMajorType, uNumber, pDecodedItem);
Laurence Lundblade3a6042e2019-06-28 19:58:04 -0700954 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700955 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800956
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700957 case CBOR_MAJOR_TYPE_BYTE_STRING: // Major type 2
958 case CBOR_MAJOR_TYPE_TEXT_STRING: // Major type 3
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800959 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
960 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
961 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
962 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundbladea44d5062018-10-17 18:45:12 +0530963 pDecodedItem->val.string = (UsefulBufC){NULL, SIZE_MAX};
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700964 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800965 nReturn = DecodeBytes(pAllocator, nMajorType, uNumber, pUInBuf, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700966 }
967 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800968
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700969 case CBOR_MAJOR_TYPE_ARRAY: // Major type 4
970 case CBOR_MAJOR_TYPE_MAP: // Major type 5
971 // Record the number of items in the array or map
972 if(uNumber > QCBOR_MAX_ITEMS_IN_ARRAY) {
973 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
974 goto Done;
975 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800976 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700977 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700978 } else {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800979 // type conversion OK because of check above
980 pDecodedItem->val.uCount = (uint16_t)uNumber;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700981 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800982 // C preproc #if above makes sure constants for major types align
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800983 // DecodeTypeAndNumber never returns a major type > 7 so cast is safe
984 pDecodedItem->uDataType = (uint8_t)nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700985 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800986
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700987 case CBOR_MAJOR_TYPE_OPTIONAL: // Major type 6, optional prepended tags
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800988 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundbladebb1062e2019-08-12 23:28:54 -0700989 nReturn = QCBOR_ERR_BAD_INT;
990 } else {
991 pDecodedItem->val.uTagV = uNumber;
992 pDecodedItem->uDataType = QCBOR_TYPE_OPTTAG;
993 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700994 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800995
Laurence Lundbladeee851742020-01-08 08:37:05 -0800996 case CBOR_MAJOR_TYPE_SIMPLE:
997 // Major type 7, float, double, true, false, null...
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800998 nReturn = DecodeSimple(nAdditionalInfo, uNumber, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700999 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001000
Laurence Lundbladeee851742020-01-08 08:37:05 -08001001 default:
1002 // Never happens because DecodeTypeAndNumber() should never return > 7
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001003 nReturn = QCBOR_ERR_UNSUPPORTED;
1004 break;
1005 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001006
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001007Done:
1008 return nReturn;
1009}
1010
1011
1012
1013/*
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001014 This layer deals with indefinite length strings. It pulls all the
Laurence Lundbladeee851742020-01-08 08:37:05 -08001015 individual chunk items together into one QCBORItem using the string
1016 allocator.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001017
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301018 Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001019 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001020static inline QCBORError
1021GetNext_FullItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001022{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001023 // Stack usage; int/ptr 2 UsefulBuf 2 QCBORItem -- 96
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001024
1025 // Get pointer to string allocator. First use is to pass it to
1026 // GetNext_Item() when option is set to allocate for *every* string.
1027 // Second use here is to allocate space to coallese indefinite
1028 // length string items into one.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001029 const QCORInternalAllocator *pAllocator = me->StringAllocator.pfAllocator ?
1030 &(me->StringAllocator) :
1031 NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001032
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001033 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001034 nReturn = GetNext_Item(&(me->InBuf),
1035 pDecodedItem,
1036 me->bStringAllocateAll ? pAllocator: NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001037 if(nReturn) {
1038 goto Done;
1039 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001040
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001041 // To reduce code size by removing support for indefinite length strings, the
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301042 // code in this function from here down can be eliminated. Run tests, except
1043 // indefinite length string tests, to be sure all is OK if this is removed.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001044
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001045 // Only do indefinite length processing on strings
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001046 const uint8_t uStringType = pDecodedItem->uDataType;
1047 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001048 goto Done; // no need to do any work here on non-string types
1049 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001050
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001051 // Is this a string with an indefinite length?
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301052 if(pDecodedItem->val.string.len != SIZE_MAX) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001053 goto Done; // length is not indefinite, so no work to do here
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001054 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001055
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301056 // Can't do indefinite length strings without a string allocator
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001057 if(pAllocator == NULL) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001058 nReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1059 goto Done;
1060 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001061
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001062 // Loop getting chunk of indefinite string
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001063 UsefulBufC FullString = NULLUsefulBufC;
1064
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001065 for(;;) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001066 // Get item for next chunk
1067 QCBORItem StringChunkItem;
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001068 // NULL string allocator passed here. Do not need to allocate
1069 // chunks even if bStringAllocateAll is set.
Laurence Lundbladefae26bf2019-02-18 11:15:43 -08001070 nReturn = GetNext_Item(&(me->InBuf), &StringChunkItem, NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001071 if(nReturn) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001072 break; // Error getting the next chunk
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001073 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001074
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301075 // See if it is a marker at end of indefinite length string
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001076 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001077 // String is complete
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001078 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301079 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001080 break;
1081 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001082
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001083 // Match data type of chunk to type at beginning.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301084 // Also catches error of other non-string types that don't belong.
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001085 // Also catches indefinite length strings inside indefinite length strings
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001086 if(StringChunkItem.uDataType != uStringType ||
1087 StringChunkItem.val.string.len == SIZE_MAX) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07001088 nReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001089 break;
1090 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001091
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301092 // Alloc new buffer or expand previously allocated buffer so it can fit
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001093 // The first time throurgh FullString.ptr is NULL and this is
1094 // equivalent to StringAllocator_Allocate()
1095 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1096 UNCONST_POINTER(FullString.ptr),
1097 FullString.len + StringChunkItem.val.string.len);
1098
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001099 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301100 // Allocation of memory for the string failed
Laurence Lundblade30816f22018-11-10 13:40:22 +07001101 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001102 break;
1103 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001104
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001105 // Copy new string chunk at the end of string so far.
1106 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001107 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001108
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001109 if(nReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1110 // Getting the item failed, clean up the allocated memory
1111 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001112 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001113
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001114Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001115 return nReturn;
1116}
1117
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001118
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001119static uint64_t ConvertTag(QCBORDecodeContext *me, uint16_t uTagVal) {
1120 if(uTagVal <= QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001121 return uTagVal;
1122 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001123 int x = uTagVal - (QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001124 return me->auMappedTags[x];
1125 }
1126}
1127
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001128/*
Laurence Lundblade59289e52019-12-30 13:44:37 -08001129 Gets all optional tag data items preceding a data item that is not an
1130 optional tag and records them as bits in the tag map.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001131 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001132static QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001133GetNext_TaggedItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001134{
Laurence Lundblade30816f22018-11-10 13:40:22 +07001135 QCBORError nReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001136
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001137 uint16_t auTags[QCBOR_MAX_TAGS_PER_ITEM] = {CBOR_TAG_INVALID16,
1138 CBOR_TAG_INVALID16,
1139 CBOR_TAG_INVALID16,
1140 CBOR_TAG_INVALID16};
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001141
Laurence Lundblade59289e52019-12-30 13:44:37 -08001142 // Loop fetching items until the item fetched is not a tag
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001143 for(;;) {
1144 nReturn = GetNext_FullItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001145 if(nReturn) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001146 goto Done; // Error out of the loop
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001147 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001148
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001149 if(pDecodedItem->uDataType != QCBOR_TYPE_OPTTAG) {
1150 // Successful exit from loop; maybe got some tags, maybe not
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001151 memcpy(pDecodedItem->uTags, auTags, sizeof(auTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001152 break;
1153 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001154
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001155 // Is there room for the tag in the tags list?
1156 size_t uTagIndex;
1157 for(uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001158 if(auTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001159 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001160 }
1161 }
1162 if(uTagIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001163 return QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001164 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001165
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001166 // Is the tag > 16 bits?
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001167 if(pDecodedItem->val.uTagV > QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001168 size_t uTagMapIndex;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001169 // Is there room in the tag map, or is it in it already?
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001170 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001171 if(me->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001172 break;
1173 }
1174 if(me->auMappedTags[uTagMapIndex] == pDecodedItem->val.uTagV) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001175 // TODO: test this
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001176 break;
1177 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001178 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001179 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1180 // No room for the tag
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001181 // Should never happen as long as QCBOR_MAX_TAGS_PER_ITEM <= QCBOR_NUM_MAPPED_TAGS
1182 return QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001183 }
1184
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001185 // Covers the cases where tag is new and were it is already in the map
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001186 me->auMappedTags[uTagMapIndex] = pDecodedItem->val.uTagV;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001187 auTags[uTagIndex] = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001188
1189 } else {
1190 auTags[uTagIndex] = (uint16_t)pDecodedItem->val.uTagV;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001191 }
1192 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001193
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001194Done:
1195 return nReturn;
1196}
1197
1198
1199/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001200 This layer takes care of map entries. It combines the label and data
1201 items into one QCBORItem.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001202 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001203static inline QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001204GetNext_MapEntry(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001205{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001206 // Stack use: int/ptr 1, QCBORItem -- 56
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001207 QCBORError nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001208 if(nReturn)
1209 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001210
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001211 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001212 // Break can't be a map entry
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001213 goto Done;
1214 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001215
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001216 if(me->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1217 // In a map and caller wants maps decoded, not treated as arrays
1218
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001219 if(DecodeNesting_IsCurrentTypeMap(&(me->nesting))) {
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001220 // If in a map and the right decoding mode, get the label
1221
Laurence Lundbladeee851742020-01-08 08:37:05 -08001222 // Save label in pDecodedItem and get the next which will
1223 // be the real data
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001224 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001225 nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001226 if(nReturn)
1227 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001228
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301229 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001230
1231 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
1232 // strings are always good labels
1233 pDecodedItem->label.string = LabelItem.val.string;
1234 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
1235 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == me->uDecodeMode) {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001236 // It's not a string and we only want strings
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001237 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1238 goto Done;
1239 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1240 pDecodedItem->label.int64 = LabelItem.val.int64;
1241 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1242 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1243 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1244 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1245 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1246 pDecodedItem->label.string = LabelItem.val.string;
1247 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1248 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1249 } else {
1250 // label is not an int or a string. It is an arrray
1251 // or a float or such and this implementation doesn't handle that.
1252 // Also, tags on labels are ignored.
1253 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1254 goto Done;
1255 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001256 }
1257 } else {
1258 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001259 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
1260 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
1261 goto Done;
1262 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001263 // Decoding a map as an array
1264 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001265 // Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2
1266 // Cast is needed because of integer promotion
1267 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001268 }
1269 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001270
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001271Done:
1272 return nReturn;
1273}
1274
1275
Laurence Lundblade02625d42020-06-25 14:41:41 -07001276/*
1277 See if next item is a CBOR break. If it is, it is consumed,
1278 if not it is not consumed.
1279*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001280static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001281NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1282{
1283 *pbNextIsBreak = false;
1284 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001285 QCBORItem Peek;
1286 size_t uPeek = UsefulInputBuf_Tell(pUIB);
1287 QCBORError uReturn = GetNext_Item(pUIB, &Peek, NULL);
1288 if(uReturn != QCBOR_SUCCESS) {
1289 return uReturn;
1290 }
1291 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001292 // It is not a break, rewind so it can be processed normally.
1293 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001294 } else {
1295 *pbNextIsBreak = true;
1296 }
1297 }
1298
1299 return QCBOR_SUCCESS;
1300}
1301
1302
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001303/*
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001304 An item was just consumed, now figure out if it was the
1305 end of an array or map that can be closed out. That
1306 may in turn close out another map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001307*/
Laurence Lundbladed0304932020-06-27 10:59:38 -07001308static QCBORError NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001309{
1310 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001311
Laurence Lundblade642282a2020-06-23 12:00:33 -07001312 /* This loops ascending nesting levels as long as there is ascending to do */
1313 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1314
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001315 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001316 /* Decrement count for definite length maps / arrays */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001317 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1318 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001319 /* Didn't close out map or array, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001320 break;
1321 }
Laurence Lundblade02625d42020-06-25 14:41:41 -07001322 /* All of a definite length array was consumed; fall through to ascend */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001323
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001324 } else {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001325 /* If not definite length, have to check for a CBOR break */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001326 bool bIsBreak = false;
1327 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1328 if(uReturn != QCBOR_SUCCESS) {
1329 goto Done;
1330 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001331
1332 if(!bIsBreak) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001333 /* It's not a break so nothing closes out and all work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001334 break;
1335 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001336
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001337 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001338 /*
1339 Break occurred inside a bstr-wrapped CBOR or
1340 in the top level sequence. This is always an
1341 error because neither are an indefinte length
1342 map/array.
1343 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001344 uReturn = QCBOR_ERR_BAD_BREAK;
1345 goto Done;
1346 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07001347
Laurence Lundblade02625d42020-06-25 14:41:41 -07001348 /* It was a break in an indefinite length map / array */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001349 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001350
Laurence Lundblade02625d42020-06-25 14:41:41 -07001351 /* All items in the map/array level have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001352
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001353 /* But ascent in bounded mode is only by explicit call to QCBORDecode_ExitBoundedMode() */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001354 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001355 /* 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 -07001356 if(bMarkEnd) {
1357 // Used for definite and indefinite to signal end
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001358 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001359
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001360 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001361 break;
1362 }
1363
1364 /* Finally, actually ascend one level. */
1365 DecodeNesting_Ascend(&(pMe->nesting));
1366 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001367
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001368 uReturn = QCBOR_SUCCESS;
1369
1370Done:
1371 return uReturn;
1372}
1373
1374
1375/*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001376 This handles the traversal descending into and asecnding out of maps,
Laurence Lundblade642282a2020-06-23 12:00:33 -07001377 arrays and bstr-wrapped CBOR. It figures out the ends of definite and
1378 indefinte length maps and arrays by looking at the item count or
1379 finding CBOR breaks. It detects the ends of the top-level sequence
1380 and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001381 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001382static QCBORError
1383QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001384{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001385 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001386 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001387
Laurence Lundblade642282a2020-06-23 12:00:33 -07001388 /*
1389 If out of bytes to consume, it is either the end of the top-level
1390 sequence of some bstr-wrapped CBOR that was entered.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001391
Laurence Lundblade642282a2020-06-23 12:00:33 -07001392 In the case of bstr-wrapped CBOR, the length of the UsefulInputBuf
1393 was set to that of the bstr-wrapped CBOR. When the bstr-wrapped
1394 CBOR is exited, the length is set back to the top-level's length
1395 or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001396 */
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001397 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001398 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001399 goto Done;
1400 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001401
Laurence Lundblade642282a2020-06-23 12:00:33 -07001402 /*
1403 Check to see if at the end of a bounded definite length map or
Laurence Lundblade02625d42020-06-25 14:41:41 -07001404 array. The check for the end of an indefinite length array is
1405 later.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001406 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001407 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001408 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001409 goto Done;
1410 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001411
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001412 /* ==== Next: not at the end so get another item ==== */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001413 uReturn = GetNext_MapEntry(me, pDecodedItem);
1414 if(uReturn) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001415 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001416 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301417
Laurence Lundblade642282a2020-06-23 12:00:33 -07001418 /*
1419 Breaks ending arrays/maps are always processed at the end of this
1420 function. They should never show up here.
1421 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301422 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001423 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301424 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301425 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001426
Laurence Lundblade642282a2020-06-23 12:00:33 -07001427 /*
1428 Record the nesting level for this data item before processing any
1429 of decrementing and descending.
1430 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001431 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001432
Laurence Lundblade642282a2020-06-23 12:00:33 -07001433
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001434 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001435 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001436 /*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001437 If the new item is a map or array, descend.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001438
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001439 Empty indefinite length maps and arrays are descended into, but then ascended out
Laurence Lundblade02625d42020-06-25 14:41:41 -07001440 of in the next chunk of code.
1441
1442 Maps and arrays do count as items in the map/array that
Laurence Lundblade642282a2020-06-23 12:00:33 -07001443 encloses them so a decrement needs to be done for them too, but
1444 that is done only when all the items in them have been
1445 processed, not when they are opened with the exception of an
1446 empty map or array.
1447 */
1448 uReturn = DecodeNesting_DescendMapOrArray(&(me->nesting),
1449 pDecodedItem->uDataType,
1450 pDecodedItem->val.uCount);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001451 if(uReturn != QCBOR_SUCCESS) {
1452 goto Done;
1453 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001454 }
1455
Laurence Lundblade02625d42020-06-25 14:41:41 -07001456 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1457 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1458 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001459 /*
1460 The following cases are handled here:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001461 - A non-aggregate like an integer or string
1462 - An empty definite length map or array
1463 - An indefinite length map or array that might be empty or might not.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001464
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001465 NestLevelAscender() does the work of decrementing the count for an
Laurence Lundblade02625d42020-06-25 14:41:41 -07001466 definite length map/array and break detection for an indefinite
1467 length map/array. If the end of the map/array was reached, then
1468 it ascends nesting levels, possibly all the way to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001469 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001470 uReturn = NestLevelAscender(me, true);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001471 if(uReturn) {
1472 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001473 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301474 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001475
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001476 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001477 /*
Laurence Lundblade02625d42020-06-25 14:41:41 -07001478 Tell the caller what level is next. This tells them what
1479 maps/arrays were closed out and makes it possible for them to
1480 reconstruct the tree with just the information returned in
1481 a QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001482 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001483 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001484 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001485 pDecodedItem->uNextNestLevel = 0;
1486 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001487 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001488 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001489
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001490Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001491 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001492 /* This sets uDataType and uLabelType to QCBOR_TYPE_NONE */
Laurence Lundbladee9482dd2019-10-11 12:58:46 -07001493 memset(pDecodedItem, 0, sizeof(QCBORItem));
1494 }
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001495 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001496}
1497
1498
Laurence Lundblade59289e52019-12-30 13:44:37 -08001499/*
1500 Mostly just assign the right data type for the date string.
1501 */
1502inline static QCBORError DecodeDateString(QCBORItem *pDecodedItem)
1503{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001504 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1505 return QCBOR_ERR_BAD_OPT_TAG;
1506 }
1507
1508 const UsefulBufC Temp = pDecodedItem->val.string;
1509 pDecodedItem->val.dateString = Temp;
1510 pDecodedItem->uDataType = QCBOR_TYPE_DATE_STRING;
1511 return QCBOR_SUCCESS;
1512}
1513
1514
1515/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001516 The epoch formatted date. Turns lots of different forms of encoding
1517 date into uniform one
Laurence Lundblade59289e52019-12-30 13:44:37 -08001518 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001519static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001520{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001521 QCBORError nReturn = QCBOR_SUCCESS;
1522
1523 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1524
1525 switch (pDecodedItem->uDataType) {
1526
1527 case QCBOR_TYPE_INT64:
1528 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1529 break;
1530
1531 case QCBOR_TYPE_UINT64:
1532 if(pDecodedItem->val.uint64 > INT64_MAX) {
1533 nReturn = QCBOR_ERR_DATE_OVERFLOW;
1534 goto Done;
1535 }
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001536 pDecodedItem->val.epochDate.nSeconds = (int64_t)pDecodedItem->val.uint64;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001537 break;
1538
1539 case QCBOR_TYPE_DOUBLE:
1540 {
1541 // This comparison needs to be done as a float before
1542 // conversion to an int64_t to be able to detect doubles
1543 // that are too large to fit into an int64_t. A double
1544 // has 52 bits of preceision. An int64_t has 63. Casting
1545 // INT64_MAX to a double actually causes a round up which
1546 // is bad and wrong for the comparison because it will
1547 // allow conversion of doubles that can't fit into a
1548 // uint64_t. To remedy this INT64_MAX - 0x7ff is used as
1549 // the cutoff point as if that rounds up in conversion to
1550 // double it will still be less than INT64_MAX. 0x7ff is
1551 // picked because it has 11 bits set.
1552 //
1553 // INT64_MAX seconds is on the order of 10 billion years,
1554 // and the earth is less than 5 billion years old, so for
1555 // most uses this conversion error won't occur even though
1556 // doubles can go much larger.
1557 //
1558 // Without the 0x7ff there is a ~30 minute range of time
1559 // values 10 billion years in the past and in the future
1560 // where this this code would go wrong.
1561 const double d = pDecodedItem->val.dfnum;
1562 if(d > (double)(INT64_MAX - 0x7ff)) {
1563 nReturn = QCBOR_ERR_DATE_OVERFLOW;
1564 goto Done;
1565 }
1566 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
1567 pDecodedItem->val.epochDate.fSecondsFraction = d - (double)pDecodedItem->val.epochDate.nSeconds;
1568 }
1569 break;
1570
1571 default:
1572 nReturn = QCBOR_ERR_BAD_OPT_TAG;
1573 goto Done;
1574 }
1575 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1576
1577Done:
1578 return nReturn;
1579}
1580
1581
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001582/*
1583 Mostly just assign the right data type for the bignum.
1584 */
1585inline static QCBORError DecodeBigNum(QCBORItem *pDecodedItem)
1586{
1587 // Stack Use: UsefulBuf 1 -- 16
1588 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1589 return QCBOR_ERR_BAD_OPT_TAG;
1590 }
1591 const UsefulBufC Temp = pDecodedItem->val.string;
1592 pDecodedItem->val.bigNum = Temp;
1593 const bool bIsPosBigNum = (bool)(pDecodedItem->uTags[0] == CBOR_TAG_POS_BIGNUM);
1594 pDecodedItem->uDataType = (uint8_t)(bIsPosBigNum ? QCBOR_TYPE_POSBIGNUM
1595 : QCBOR_TYPE_NEGBIGNUM);
1596 return QCBOR_SUCCESS;
1597}
1598
1599
Laurence Lundblade59289e52019-12-30 13:44:37 -08001600#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1601/*
1602 Decode decimal fractions and big floats.
1603
1604 When called pDecodedItem must be the array that is tagged as a big
1605 float or decimal fraction, the array that has the two members, the
1606 exponent and mantissa.
1607
1608 This will fetch and decode the exponent and mantissa and put the
1609 result back into pDecodedItem.
1610 */
1611inline static QCBORError
1612QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1613{
1614 QCBORError nReturn;
1615
1616 // --- Make sure it is an array; track nesting level of members ---
1617 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
1618 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1619 goto Done;
1620 }
1621
1622 // A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladeee851742020-01-08 08:37:05 -08001623 // definite length arrays, but not for indefnite. Instead remember
1624 // the nesting level the two integers must be at, which is one
1625 // deeper than that of the array.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001626 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
1627
1628 // --- Is it a decimal fraction or a bigfloat? ---
1629 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
1630 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
1631
1632 // --- Get the exponent ---
1633 QCBORItem exponentItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001634 nReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001635 if(nReturn != QCBOR_SUCCESS) {
1636 goto Done;
1637 }
1638 if(exponentItem.uNestingLevel != nNestLevel) {
1639 // Array is empty or a map/array encountered when expecting an int
1640 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1641 goto Done;
1642 }
1643 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
1644 // Data arriving as an unsigned int < INT64_MAX has been converted
1645 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1646 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1647 // will be too large for this to handle and thus an error that will
1648 // get handled in the next else.
1649 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
1650 } else {
1651 // Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX
1652 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1653 goto Done;
1654 }
1655
1656 // --- Get the mantissa ---
1657 QCBORItem mantissaItem;
1658 nReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
1659 if(nReturn != QCBOR_SUCCESS) {
1660 goto Done;
1661 }
1662 if(mantissaItem.uNestingLevel != nNestLevel) {
1663 // Mantissa missing or map/array encountered when expecting number
1664 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1665 goto Done;
1666 }
1667 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
1668 // Data arriving as an unsigned int < INT64_MAX has been converted
1669 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1670 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1671 // will be too large for this to handle and thus an error that
1672 // will get handled in an else below.
1673 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
1674 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM || mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
1675 // Got a good big num mantissa
1676 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
1677 // Depends on numbering of QCBOR_TYPE_XXX
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001678 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
1679 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
1680 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001681 } else {
1682 // Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX
1683 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1684 goto Done;
1685 }
1686
1687 // --- Check that array only has the two numbers ---
1688 if(mantissaItem.uNextNestLevel == nNestLevel) {
1689 // Extra items in the decimal fraction / big num
1690 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1691 goto Done;
1692 }
1693
1694Done:
1695
1696 return nReturn;
1697}
1698#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
1699
1700
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001701
1702/*
1703 */
1704inline static QCBORError DecodeURI(QCBORItem *pDecodedItem)
1705{
1706 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1707 return QCBOR_ERR_BAD_OPT_TAG;
1708 }
1709 pDecodedItem->uDataType = QCBOR_TYPE_URI;
1710 return QCBOR_SUCCESS;
1711}
1712
1713
1714inline static QCBORError DecodeB64URL(QCBORItem *pDecodedItem)
1715{
1716 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1717 return QCBOR_ERR_BAD_OPT_TAG;
1718 }
1719 pDecodedItem->uDataType = QCBOR_TYPE_BASE64URL;
1720 return QCBOR_SUCCESS;
1721}
1722
1723
1724inline static QCBORError DecodeB64(QCBORItem *pDecodedItem)
1725{
1726 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1727 return QCBOR_ERR_BAD_OPT_TAG;
1728 }
1729 pDecodedItem->uDataType = QCBOR_TYPE_BASE64;
1730 return QCBOR_SUCCESS;
1731}
1732
1733
1734inline static QCBORError DecodeRegex(QCBORItem *pDecodedItem)
1735{
1736 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1737 return QCBOR_ERR_BAD_OPT_TAG;
1738 }
1739 pDecodedItem->uDataType = QCBOR_TYPE_REGEX;
1740 return QCBOR_SUCCESS;
1741}
1742
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001743inline static QCBORError DecodeWrappedCBOR(QCBORItem *pDecodedItem)
1744{
1745 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1746 return QCBOR_ERR_BAD_OPT_TAG;
1747 }
1748 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR;
1749 return QCBOR_SUCCESS;
1750}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001751
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001752
1753inline static QCBORError DecodeWrappedCBORSequence(QCBORItem *pDecodedItem)
1754{
1755 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1756 return QCBOR_ERR_BAD_OPT_TAG;
1757 }
1758 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE;
1759 return QCBOR_SUCCESS;
1760}
1761
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001762inline static QCBORError DecodeMIME(QCBORItem *pDecodedItem)
1763{
1764 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
1765 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
1766 } else if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1767 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
1768 } else {
1769 return QCBOR_ERR_BAD_OPT_TAG;
1770 }
1771 return QCBOR_SUCCESS;
1772}
1773
1774
1775/*
1776 */
1777inline static QCBORError DecodeUUID(QCBORItem *pDecodedItem)
1778{
1779 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1780 return QCBOR_ERR_BAD_OPT_TAG;
1781 }
1782 pDecodedItem->uDataType = QCBOR_TYPE_UUID;
1783 return QCBOR_SUCCESS;
1784}
1785
1786
Laurence Lundblade59289e52019-12-30 13:44:37 -08001787/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001788 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001789 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001790QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001791QCBORDecode_GetNext(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001792{
1793 QCBORError nReturn;
1794
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001795 nReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001796 if(nReturn != QCBOR_SUCCESS) {
1797 goto Done;
1798 }
1799
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001800 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
1801 switch(pDecodedItem->uTags[i] ) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08001802
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001803 case CBOR_TAG_DATE_STRING:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001804 nReturn = DecodeDateString(pDecodedItem);
1805 break;
1806
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001807 case CBOR_TAG_DATE_EPOCH:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001808 nReturn = DecodeDateEpoch(pDecodedItem);
1809 break;
1810
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001811 case CBOR_TAG_POS_BIGNUM:
1812 case CBOR_TAG_NEG_BIGNUM:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001813 nReturn = DecodeBigNum(pDecodedItem);
1814 break;
1815
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001816 #ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1817 case CBOR_TAG_DECIMAL_FRACTION:
1818 case CBOR_TAG_BIGFLOAT:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001819 // For aggregate tagged types, what goes into pTags is only collected
1820 // from the surrounding data item, not the contents, so pTags is not
1821 // passed on here.
1822
1823 nReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
1824 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001825 #endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001826
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001827 case CBOR_TAG_CBOR:
1828 nReturn = DecodeWrappedCBOR(pDecodedItem);
1829 break;
1830
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001831 case CBOR_TAG_CBOR_SEQUENCE:
1832 nReturn = DecodeWrappedCBORSequence(pDecodedItem);
1833 break;
1834
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001835 case CBOR_TAG_URI:
1836 nReturn = DecodeURI(pDecodedItem);
1837 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001838
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001839 case CBOR_TAG_B64URL:
1840 nReturn = DecodeB64URL(pDecodedItem);
1841 break;
1842
1843 case CBOR_TAG_B64:
1844 nReturn = DecodeB64(pDecodedItem);
1845 break;
1846
1847 case CBOR_TAG_MIME:
1848 case CBOR_TAG_BINARY_MIME:
1849 nReturn = DecodeMIME(pDecodedItem);
1850 break;
1851
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001852 case CBOR_TAG_REGEX:
1853 nReturn = DecodeRegex(pDecodedItem);
1854 break;
1855
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001856 case CBOR_TAG_BIN_UUID:
1857 nReturn = DecodeUUID(pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001858 break;
1859
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001860 case CBOR_TAG_INVALID16:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001861 // The end of the tag list or no tags
1862 // Successful exit from the loop.
1863 goto Done;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001864
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001865 default:
1866 // A tag that is not understood
1867 // A successful exit from the loop
1868 goto Done;
1869
1870 }
1871 if(nReturn != QCBOR_SUCCESS) {
1872 goto Done;
1873 }
Laurence Lundblade59289e52019-12-30 13:44:37 -08001874 }
1875
1876Done:
1877 if(nReturn != QCBOR_SUCCESS) {
1878 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
1879 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
1880 }
1881 return nReturn;
1882}
1883
1884
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001885QCBORError QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
1886{
1887 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
1888
1889 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
1890
1891 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
1892
1893 return uErr;
1894}
1895
1896
Laurence Lundblade59289e52019-12-30 13:44:37 -08001897/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001898 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001899 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001900QCBORError
1901QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
1902 QCBORItem *pDecodedItem,
1903 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001904{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001905 QCBORError nReturn;
1906
1907 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
1908 if(nReturn != QCBOR_SUCCESS) {
1909 return nReturn;
1910 }
1911
1912 if(pTags != NULL) {
1913 pTags->uNumUsed = 0;
1914 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001915 if(pDecodedItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001916 break;
1917 }
1918 if(pTags->uNumUsed >= pTags->uNumAllocated) {
1919 return QCBOR_ERR_TOO_MANY_TAGS;
1920 }
1921 pTags->puTags[pTags->uNumUsed] = ConvertTag(me, pDecodedItem->uTags[i]);
1922 pTags->uNumUsed++;
1923 }
1924 }
1925
1926 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001927}
1928
1929
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001930/*
Laurence Lundblade6de37062018-10-15 12:22:42 +05301931 Decoding items is done in 5 layered functions, one calling the
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301932 next one down. If a layer has no work to do for a particular item
1933 it returns quickly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001934
Laurence Lundblade59289e52019-12-30 13:44:37 -08001935 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
1936 tagged data items, turning them into the local C representation.
1937 For the most simple it is just associating a QCBOR_TYPE with the data. For
1938 the complex ones that an aggregate of data items, there is some further
1939 decoding and a little bit of recursion.
1940
1941 - QCBORDecode_GetNextMapOrArray - This manages the beginnings and
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301942 ends of maps and arrays. It tracks descending into and ascending
Laurence Lundblade6de37062018-10-15 12:22:42 +05301943 out of maps/arrays. It processes all breaks that terminate
Laurence Lundbladebb87be22020-04-09 19:15:32 -07001944 indefinite length maps and arrays.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001945
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301946 - GetNext_MapEntry -- This handles the combining of two
1947 items, the label and the data, that make up a map entry.
1948 It only does work on maps. It combines the label and data
1949 items into one labeled item.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001950
Laurence Lundblade59289e52019-12-30 13:44:37 -08001951 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
1952 tags into bit flags associated with the data item. No actual decoding
1953 of the contents of the tagged item is performed here.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001954
Laurence Lundblade59289e52019-12-30 13:44:37 -08001955 - GetNext_FullItem -- This assembles the sub-items that make up
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301956 an indefinte length string into one string item. It uses the
Laurence Lundblade6de37062018-10-15 12:22:42 +05301957 string allocater to create contiguous space for the item. It
1958 processes all breaks that are part of indefinite length strings.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001959
Laurence Lundblade59289e52019-12-30 13:44:37 -08001960 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
1961 atomic data item has a "major type", an integer "argument" and optionally
1962 some content. For text and byte strings, the content is the bytes
1963 that make up the string. These are the smallest data items that are
1964 considered to be well-formed. The content may also be other data items in
1965 the case of aggregate types. They are not handled in this layer.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001966
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001967 Roughly this takes 300 bytes of stack for vars. Need to
1968 evaluate this more carefully and correctly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001969
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05301970 */
1971
1972
1973/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001974 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001975 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001976int QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001977 const QCBORItem *pItem,
1978 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001979{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001980 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++ ) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001981 if(pItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001982 break;
1983 }
1984 if(ConvertTag(me, pItem->uTags[i]) == uTag) {
1985 return 1;
1986 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001987 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001988
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001989 return 0;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001990}
1991
1992
1993/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001994 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001995 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07001996QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001997{
Laurence Lundblade085d7952020-07-24 10:26:30 -07001998 QCBORError uReturn = me->uLastError;
1999
2000 if(uReturn != QCBOR_SUCCESS) {
2001 goto Done;
2002 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002003
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002004 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002005 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002006 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002007 goto Done;
2008 }
2009
2010 // Error out if not all the bytes are consumed
2011 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002012 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002013 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002014
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002015Done:
Laurence Lundblade6de37062018-10-15 12:22:42 +05302016 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002017 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002018 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002019
Laurence Lundblade085d7952020-07-24 10:26:30 -07002020 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002021}
2022
2023
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002024/*
2025Public function, see header qcbor/qcbor_decode.h file
2026*/
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002027uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2028 const QCBORItem *pItem,
2029 unsigned int uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002030{
2031 if(uIndex > QCBOR_MAX_TAGS_PER_ITEM) {
2032 return CBOR_TAG_INVALID16;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002033 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002034 return ConvertTag(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002035 }
2036}
2037
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002038
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002039/*
2040
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002041Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002042
Laurence Lundbladeee851742020-01-08 08:37:05 -08002043 - Hit end of input before it was expected while decoding type and
2044 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002045
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002046 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002047
Laurence Lundbladeee851742020-01-08 08:37:05 -08002048 - Hit end of input while decoding a text or byte string
2049 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002050
Laurence Lundbladeee851742020-01-08 08:37:05 -08002051 - Encountered conflicting tags -- e.g., an item is tagged both a date
2052 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002053
Laurence Lundbladeee851742020-01-08 08:37:05 -08002054 - Encontered an array or mapp that has too many items
2055 QCBOR_ERR_ARRAY_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002056
Laurence Lundbladeee851742020-01-08 08:37:05 -08002057 - Encountered array/map nesting that is too deep
2058 QCBOR_ERR_ARRAY_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002059
Laurence Lundbladeee851742020-01-08 08:37:05 -08002060 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2061 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002062
Laurence Lundbladeee851742020-01-08 08:37:05 -08002063 - The type of a map label is not a string or int
2064 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002065
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002066 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002067
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002068 */
2069
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002070
2071
Laurence Lundbladef6531662018-12-04 10:42:22 +09002072
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002073/* ===========================================================================
2074 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002075
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002076 This implements a simple sting allocator for indefinite length
2077 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2078 implements the function type QCBORStringAllocate and allows easy
2079 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002080
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002081 This particular allocator is built-in for convenience. The caller
2082 can implement their own. All of this following code will get
2083 dead-stripped if QCBORDecode_SetMemPool() is not called.
2084
2085 This is a very primitive memory allocator. It does not track
2086 individual allocations, only a high-water mark. A free or
2087 reallocation must be of the last chunk allocated.
2088
2089 The size of the pool and offset to free memory are packed into the
2090 first 8 bytes of the memory pool so we don't have to keep them in
2091 the decode context. Since the address of the pool may not be
2092 aligned, they have to be packed and unpacked as if they were
2093 serialized data of the wire or such.
2094
2095 The sizes packed in are uint32_t to be the same on all CPU types
2096 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002097 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002098
2099
Laurence Lundbladeee851742020-01-08 08:37:05 -08002100static inline int
2101MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002102{
2103 // Use of UsefulInputBuf is overkill, but it is convenient.
2104 UsefulInputBuf UIB;
2105
Laurence Lundbladeee851742020-01-08 08:37:05 -08002106 // Just assume the size here. It was checked during SetUp so
2107 // the assumption is safe.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002108 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem, QCBOR_DECODE_MIN_MEM_POOL_SIZE});
2109 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2110 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2111 return UsefulInputBuf_GetError(&UIB);
2112}
2113
2114
Laurence Lundbladeee851742020-01-08 08:37:05 -08002115static inline int
2116MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002117{
2118 // Use of UsefulOutBuf is overkill, but convenient. The
2119 // length check performed here is useful.
2120 UsefulOutBuf UOB;
2121
2122 UsefulOutBuf_Init(&UOB, Pool);
2123 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2124 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2125 return UsefulOutBuf_GetError(&UOB);
2126}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002127
2128
2129/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002130 Internal function for an allocation, reallocation free and destuct.
2131
2132 Having only one function rather than one each per mode saves space in
2133 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002134
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002135 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2136 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002137static UsefulBuf
2138MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002139{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002140 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002141
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002142 uint32_t uPoolSize;
2143 uint32_t uFreeOffset;
2144
2145 if(uNewSize > UINT32_MAX) {
2146 // This allocator is only good up to 4GB. This check should
2147 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2148 goto Done;
2149 }
2150 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2151
2152 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2153 goto Done;
2154 }
2155
2156 if(uNewSize) {
2157 if(pMem) {
2158 // REALLOCATION MODE
2159 // Calculate pointer to the end of the memory pool. It is
2160 // assumed that pPool + uPoolSize won't wrap around by
2161 // assuming the caller won't pass a pool buffer in that is
2162 // not in legitimate memory space.
2163 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2164
2165 // Check that the pointer for reallocation is in the range of the
2166 // pool. This also makes sure that pointer math further down
2167 // doesn't wrap under or over.
2168 if(pMem >= pPool && pMem < pPoolEnd) {
2169 // Offset to start of chunk for reallocation. This won't
2170 // wrap under because of check that pMem >= pPool. Cast
2171 // is safe because the pool is always less than UINT32_MAX
2172 // because of check in QCBORDecode_SetMemPool().
2173 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2174
2175 // Check to see if the allocation will fit. uPoolSize -
2176 // uMemOffset will not wrap under because of check that
2177 // pMem is in the range of the uPoolSize by check above.
2178 if(uNewSize <= uPoolSize - uMemOffset) {
2179 ReturnValue.ptr = pMem;
2180 ReturnValue.len = uNewSize;
2181
2182 // Addition won't wrap around over because uNewSize was
2183 // checked to be sure it is less than the pool size.
2184 uFreeOffset = uMemOffset + uNewSize32;
2185 }
2186 }
2187 } else {
2188 // ALLOCATION MODE
2189 // uPoolSize - uFreeOffset will not underflow because this
2190 // pool implementation makes sure uFreeOffset is always
2191 // smaller than uPoolSize through this check here and
2192 // reallocation case.
2193 if(uNewSize <= uPoolSize - uFreeOffset) {
2194 ReturnValue.len = uNewSize;
2195 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002196 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002197 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002198 }
2199 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002200 if(pMem) {
2201 // FREE MODE
2202 // Cast is safe because of limit on pool size in
2203 // QCBORDecode_SetMemPool()
2204 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2205 } else {
2206 // DESTRUCT MODE
2207 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002208 }
2209 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002210
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002211 UsefulBuf Pool = {pPool, uPoolSize};
2212 MemPool_Pack(Pool, uFreeOffset);
2213
2214Done:
2215 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002216}
2217
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002218
Laurence Lundbladef6531662018-12-04 10:42:22 +09002219/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002220 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002221 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002222QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2223 UsefulBuf Pool,
2224 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002225{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002226 // The pool size and free mem offset are packed into the beginning
2227 // of the pool memory. This compile time check make sure the
2228 // constant in the header is correct. This check should optimize
2229 // down to nothing.
2230 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07002231 return QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002232 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002233
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002234 // The pool size and free offset packed in to the beginning of pool
2235 // memory are only 32-bits. This check will optimize out on 32-bit
2236 // machines.
2237 if(Pool.len > UINT32_MAX) {
2238 return QCBOR_ERR_BUFFER_TOO_LARGE;
2239 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002240
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002241 // This checks that the pool buffer given is big enough.
2242 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
2243 return QCBOR_ERR_BUFFER_TOO_SMALL;
2244 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002245
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002246 pMe->StringAllocator.pfAllocator = MemPool_Function;
2247 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2248 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002249
Laurence Lundblade30816f22018-11-10 13:40:22 +07002250 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002251}
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002252
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002253
2254
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002255
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002256
2257
2258/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002259 Consume an entire map or array (and do next to
2260 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002261 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002262static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002263ConsumeItem(QCBORDecodeContext *pMe,
2264 const QCBORItem *pItemToConsume,
2265 uint_fast8_t *puNextNestLevel)
2266{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002267 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002268 QCBORItem Item;
2269
Laurence Lundblade02625d42020-06-25 14:41:41 -07002270 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ConsumeItem");
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002271
Laurence Lundblade02625d42020-06-25 14:41:41 -07002272 if(QCBORItem_IsMapOrArray(pItemToConsume)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002273 /* There is only real work to do for maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002274
Laurence Lundblade1341c592020-04-11 14:19:05 -07002275 /* This works for definite and indefinite length
2276 * maps and arrays by using the nesting level
2277 */
2278 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002279 uReturn = QCBORDecode_GetNext(pMe, &Item);
2280 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002281 goto Done;
2282 }
2283 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002284
Laurence Lundblade1341c592020-04-11 14:19:05 -07002285 if(puNextNestLevel != NULL) {
2286 *puNextNestLevel = Item.uNextNestLevel;
2287 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002288 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002289
Laurence Lundblade1341c592020-04-11 14:19:05 -07002290 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002291 /* item_to_consume is not a map or array */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002292 if(puNextNestLevel != NULL) {
2293 /* Just pass the nesting level through */
2294 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2295 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002296 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002297 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002298
2299Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002300 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002301}
2302
2303
Laurence Lundblade1341c592020-04-11 14:19:05 -07002304/* Return true if the labels in Item1 and Item2 are the same.
2305 Works only for integer and string labels. Returns false
2306 for any other type. */
2307static inline bool
2308MatchLabel(QCBORItem Item1, QCBORItem Item2)
2309{
2310 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2311 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2312 return true;
2313 }
2314 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002315 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002316 return true;
2317 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002318 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002319 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2320 return true;
2321 }
2322 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2323 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2324 return true;
2325 }
2326 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002327
Laurence Lundblade1341c592020-04-11 14:19:05 -07002328 /* Other label types are never matched */
2329 return false;
2330}
2331
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002332
2333/*
2334 Returns true if Item1 and Item2 are the same type
2335 or if either are of QCBOR_TYPE_ANY.
2336 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002337static inline bool
2338MatchType(QCBORItem Item1, QCBORItem Item2)
2339{
2340 if(Item1.uDataType == Item2.uDataType) {
2341 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002342 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002343 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002344 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002345 return true;
2346 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002347 return false;
2348}
2349
2350
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002351/**
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002352 \brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002353
2354 @param[in] pMe The decode context to search.
2355 @param[in,out] pItemArray The items to search for and the items found.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002356 @param[out] puOffset Byte offset of last item matched.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002357 @param[in] pCBContext Context for the not-found item call back
2358 @param[in] pfCallback Function to call on items not matched in pItemArray
2359
2360 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2361
2362 @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.
2363
2364 @retval QCBOR_ERR_UNEXPECTED_TYPE The label was matched, but not the type.
2365
2366 @retval Also errors returned by QCBORDecode_GetNext().
2367
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002368 On input pItemArray contains a list of labels and data types
2369 of items to be found.
2370
2371 On output the fully retrieved items are filled in with
2372 values and such. The label was matched, so it never changes.
2373
2374 If an item was not found, its data type is set to none.
2375
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002376 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002377static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002378MapSearch(QCBORDecodeContext *pMe,
2379 QCBORItem *pItemArray,
2380 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002381 void *pCBContext,
2382 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002383{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002384 QCBORError uReturn;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002385
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002386 if(pMe->uLastError != QCBOR_SUCCESS) {
2387 return pMe->uLastError;
2388 }
2389
Laurence Lundblade085d7952020-07-24 10:26:30 -07002390 QCBORDecodeNesting SaveNesting = pMe->nesting; // TODO: refactor?
2391
2392 uint64_t uFoundItemBitMap = 0;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002393
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002394 if(!DecodeNesting_CheckBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
2395 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2396 /* QCBOR_TYPE_NONE as first item indicates just looking
2397 for the end of an array, so don't give error. */
2398 uReturn = QCBOR_ERR_NOT_A_MAP;
2399 goto Done;
2400 }
2401
Laurence Lundblade085d7952020-07-24 10:26:30 -07002402 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2403 // It is an empty bounded array or map
2404 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2405 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002406 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002407 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002408 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002409 // Nothing is ever found in an empty array or map. All items
2410 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002411 uReturn = QCBOR_SUCCESS;
2412 }
2413 goto Done;
2414 }
2415
2416 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2417
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002418 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002419 UsefulInputBuf_Seek(&(pMe->InBuf),
2420 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002421
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002422 /*
2423 Loop over all the items in the map. They could be
2424 deeply nested and this should handle both definite
2425 and indefinite length maps and arrays, so this
2426 adds some complexity.
2427 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002428 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002429
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002430 uint_fast8_t uNextNestLevel;
2431
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002432
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002433 /* Iterate over items in the map / array */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002434 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002435 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002436 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002437
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002438 /* Get the item */
2439 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002440 uReturn = QCBORDecode_GetNext(pMe, &Item);
2441 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002442 /* Got non-well-formed CBOR */
2443 goto Done;
2444 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002445
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002446 /* See if item has one of the labels that are of interest */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002447 int nIndex;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002448 QCBORItem *pIterator;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002449 for(pIterator = pItemArray, nIndex = 0; pIterator->uLabelType != 0; pIterator++, nIndex++) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002450 if(MatchLabel(Item, *pIterator)) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002451 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002452 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2453 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002454 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002455 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002456 /* Also try to match its type */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002457 if(!MatchType(Item, *pIterator)) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002458 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002459 goto Done;
2460 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002461
2462 /* Successful match. Return the item. */
2463 *pIterator = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002464 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002465 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002466 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002467 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002468 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002469 /*
2470 Call the callback on unmatched labels.
2471 (It is tempting to do duplicate detection here, but that would
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002472 require dynamic memory allocation because the number of labels
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002473 that might be encountered is unbounded.)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002474 */
2475 if(pfCallback) {
2476 uReturn = (*pfCallback)(pCBContext, &Item);
2477 if(uReturn != QCBOR_SUCCESS) {
2478 goto Done;
2479 }
2480 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002481 }
2482 }
2483
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002484 /*
2485 Consume the item whether matched or not. This
2486 does the work of traversing maps and array and
2487 everything in them. In this loop only the
2488 items at the current nesting level are examined
2489 to match the labels.
2490 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002491 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
2492 if(uReturn) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002493 goto Done;
2494 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002495
2496 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002497
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002498 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002499
2500 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002501 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2502 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002503
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002504 /* For all items not found, set the data type to QCBOR_TYPE_NONE */
Laurence Lundblade085d7952020-07-24 10:26:30 -07002505Done:
2506 {int i;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002507 QCBORItem *pIterator;
2508 for(pIterator = pItemArray, i = 0; pIterator->uLabelType != 0; pIterator++, i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002509 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002510 pIterator->uDataType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002511 }
2512 }
Laurence Lundblade085d7952020-07-24 10:26:30 -07002513 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002514
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002515 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002516
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002517 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002518}
2519
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002520
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002521/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002522 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002523*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002524void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2525 int64_t nLabel,
2526 uint8_t uQcborType,
2527 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002528{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002529 if(pMe->uLastError != QCBOR_SUCCESS) {
2530 return;
2531 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002532
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002533 QCBORItem OneItemSeach[2];
2534 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2535 OneItemSeach[0].label.int64 = nLabel;
2536 OneItemSeach[0].uDataType = uQcborType;
2537 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002538
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002539 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2540 if(uReturn != QCBOR_SUCCESS) {
2541 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002542 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002543 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002544 uReturn = QCBOR_ERR_NOT_FOUND;
2545 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002546 }
2547
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002548 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002549
2550 Done:
2551 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002552}
2553
2554
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002555/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002556 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002557*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002558void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2559 const char *szLabel,
2560 uint8_t uQcborType,
2561 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002562{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002563 if(pMe->uLastError != QCBOR_SUCCESS) {
2564 return;
2565 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002566
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002567 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002568 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2569 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2570 OneItemSeach[0].uDataType = uQcborType;
2571 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002572
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002573 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2574 if(uReturn != QCBOR_SUCCESS) {
2575 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002576 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002577 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002578 uReturn = QCBOR_ERR_NOT_FOUND;
2579 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002580 }
2581
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002582 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002583
2584Done:
2585 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002586}
2587
2588
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002589
2590static QCBORError CheckTypeList(uint8_t uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
2591{
2592 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2593 if(uDataType == puTypeList[i]) {
2594 return QCBOR_SUCCESS;
2595 }
2596 }
2597 return QCBOR_ERR_UNEXPECTED_TYPE;
2598}
2599
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 Lundbladea8edadb2020-06-27 22:35:37 -07002815 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07002816 if(pMe->uLastError != QCBOR_SUCCESS) {
2817 // Already in error state; do nothing.
2818 return;
2819 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07002820
2821 /* Get the data item that is the map that is being searched */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002822 QCBORItem Item;
Laurence Lundblade986017c2020-05-23 19:25:02 -07002823 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
Laurence Lundblade34691b92020-05-18 22:25:25 -07002824 if(pMe->uLastError != QCBOR_SUCCESS) {
2825 return;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07002826 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002827 if(Item.uDataType != uType) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07002828 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
2829 return;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002830 }
2831
Laurence Lundblade085d7952020-07-24 10:26:30 -07002832 const bool bIsEmpty = Item.uNestingLevel == Item.uNextNestLevel;
2833 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002834 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
2835 // Undo decrement done by QCBORDecode_GetNext() so the the
2836 // the decrement when exiting the map / array works correctly
2837 pMe->nesting.pCurrent->u.ma.uCountCursor++;
2838 }
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002839 // Special case to increment nesting level for zero-length maps and arrays entered in bounded mode.
2840 DecodeNesting_Descend(&(pMe->nesting), uType);
2841 }
2842
Laurence Lundblade02625d42020-06-25 14:41:41 -07002843 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002844
Laurence Lundblade085d7952020-07-24 10:26:30 -07002845 QCBORError uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002846 UsefulInputBuf_Tell(&(pMe->InBuf)));
2847
2848 pMe->uLastError = (uint8_t)uErr;
2849
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002850 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "EnterMapModeDone");
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002851}
2852
Laurence Lundblade02625d42020-06-25 14:41:41 -07002853
2854/*
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002855 This is the common work for exiting a level that is a bounded map, array or bstr
2856 wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07002857
2858 One chunk of work is to set up the pre-order traversal so it is at
2859 the item just after the bounded map, array or bstr that is being
2860 exited. This is somewhat complex.
2861
2862 The other work is to level-up the bounded mode to next higest bounded
2863 mode or the top level if there isn't one.
2864 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002865static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07002866ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002867{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002868 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002869
Laurence Lundblade02625d42020-06-25 14:41:41 -07002870 /*
2871 First the pre-order-traversal byte offset is positioned to the
2872 item just after the bounded mode item that was just consumed.
2873 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002874 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
2875
Laurence Lundblade02625d42020-06-25 14:41:41 -07002876 /*
2877 Next, set the current nesting level to one above the bounded level
2878 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002879
Laurence Lundblade02625d42020-06-25 14:41:41 -07002880 DecodeNesting_CheckBoundedType() is always called before this and
2881 makes sure pCurrentBounded is valid.
2882 */
2883 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
2884
2885 /*
2886 This does the complex work of leveling up the pre-order traversal
2887 when the end of a map or array or another bounded level is
2888 reached. It may do nothing, or ascend all the way to the top
2889 level.
2890 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07002891 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002892 if(uErr != QCBOR_SUCCESS) {
2893 goto Done;
2894 }
2895
Laurence Lundblade02625d42020-06-25 14:41:41 -07002896 /*
2897 This makes the next highest bounded level the current bounded
2898 level. If there is no next highest level, then no bounded mode is
2899 in effect.
2900 */
2901 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002902
Laurence Lundblade02625d42020-06-25 14:41:41 -07002903 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002904
2905Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07002906 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ExitBoundedLevel");
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002907 return uErr;
2908}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002909
Laurence Lundblade02625d42020-06-25 14:41:41 -07002910
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002911// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07002912void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002913{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002914 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07002915 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002916 return;
2917 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002918
Laurence Lundblade02625d42020-06-25 14:41:41 -07002919 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002920
Laurence Lundblade02625d42020-06-25 14:41:41 -07002921 if(!DecodeNesting_CheckBoundedType(&(pMe->nesting), uType)) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002922 uErr = QCBOR_ERR_CLOSE_MISMATCH;
2923 goto Done;
2924 }
2925
Laurence Lundblade02625d42020-06-25 14:41:41 -07002926 /*
2927 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002928 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002929 from previous map search, then do a dummy search.
2930 */
2931 if(pMe->uMapEndOffsetCache == MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002932 QCBORItem Dummy;
2933 Dummy.uLabelType = QCBOR_TYPE_NONE;
2934 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
2935 if(uErr != QCBOR_SUCCESS) {
2936 goto Done;
2937 }
2938 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002939
Laurence Lundblade02625d42020-06-25 14:41:41 -07002940 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002941
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002942Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002943 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002944}
2945
2946
Laurence Lundblade1341c592020-04-11 14:19:05 -07002947void QCBORDecode_RewindMap(QCBORDecodeContext *pMe)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002948{
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002949 // TODO: check for map mode; test this
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002950 //pMe->nesting.pCurrent->uCount = pMe->nesting.pCurrent->u.ma.uCountTotal;
2951 UsefulInputBuf_Seek(&(pMe->InBuf), pMe->nesting.pCurrent->u.ma.uStartOffset);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002952}
2953
2954
Laurence Lundblade1341c592020-04-11 14:19:05 -07002955
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002956static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07002957 const QCBORItem *pItem,
2958 uint8_t uTagRequirement,
2959 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002960{
2961 if(pMe->uLastError != QCBOR_SUCCESS) {
2962 // Already in error state; do nothing.
2963 return pMe->uLastError;
2964 }
2965
2966 QCBORError uError = QCBOR_SUCCESS;
2967
2968 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
2969 uError = QCBOR_ERR_UNEXPECTED_TYPE;
2970 goto Done;;
2971 }
2972
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002973 const TagSpecification TagSpec = {uTagRequirement,
2974 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
2975 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
2976 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002977
2978 uError = CheckTagRequirement(TagSpec, pItem->uDataType);
2979 if(uError != QCBOR_SUCCESS) {
2980 goto Done;
2981 }
2982
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002983 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07002984 /* Reverse the decrement done by GetNext() for the bstr as
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002985 so the increment in NestLevelAscender called by ExitBoundedLevel()
2986 will work right. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07002987 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07002988 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07002989
2990 if(pBstr) {
2991 *pBstr = pItem->val.string;
2992 }
2993
2994 const size_t uPreviousLength = UsefulInputBuf_GetLength(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002995
2996 // Need to move UIB input cursor to the right place
2997
2998 // Really this is a subtraction and an assignment; not much code
2999 // There is a range check in the seek.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003000 // The bstr was just consumed so the cursor is at the next item after it
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003001
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003002 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003003
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003004 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
3005
3006 UsefulInputBuf_SetBufferLen(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003007
Laurence Lundblade02625d42020-06-25 14:41:41 -07003008 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
3009 uPreviousLength,
3010 uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003011Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07003012 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "Entered Bstr");
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003013
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003014 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003015}
3016
3017
Laurence Lundblade02625d42020-06-25 14:41:41 -07003018/*
3019 Public function, see header qcbor/qcbor_decode.h file
3020 */
3021void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003022 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003023 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003024{
3025 if(pMe->uLastError != QCBOR_SUCCESS) {
3026 // Already in error state; do nothing.
3027 return;
3028 }
3029
3030 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003031 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003032 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3033 if(pMe->uLastError != QCBOR_SUCCESS) {
3034 return;
3035 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003036
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003037 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003038 &Item,
3039 uTagRequirement,
3040 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003041}
3042
3043
Laurence Lundblade02625d42020-06-25 14:41:41 -07003044/*
3045 Public function, see header qcbor/qcbor_decode.h file
3046 */
3047void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
3048 uint8_t uTagRequirement,
3049 int64_t nLabel,
3050 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003051{
3052 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003053 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003054
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003055 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003056}
3057
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003058
Laurence Lundblade02625d42020-06-25 14:41:41 -07003059/*
3060 Public function, see header qcbor/qcbor_decode.h file
3061 */
3062void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
3063 uint8_t uTagRequirement,
3064 const char *szLabel,
3065 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003066{
3067 QCBORItem Item;
3068 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3069
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003070 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003071}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003072
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003073
Laurence Lundblade02625d42020-06-25 14:41:41 -07003074/*
3075 Public function, see header qcbor/qcbor_decode.h file
3076 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003077void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003078{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003079 if(pMe->uLastError != QCBOR_SUCCESS) {
3080 // Already in error state; do nothing.
3081 return;
3082 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003083
Laurence Lundblade02625d42020-06-25 14:41:41 -07003084 if(!DecodeNesting_CheckBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
3085 pMe->uLastError = QCBOR_ERR_CLOSE_MISMATCH;
3086 return;
3087 }
3088
3089 /*
3090 Reset the length of the UsefulInputBuf to what it was before
3091 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003092 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003093 UsefulInputBuf_SetBufferLen(&(pMe->InBuf),
3094 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003095
3096
Laurence Lundblade02625d42020-06-25 14:41:41 -07003097 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003098 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003099}
3100
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003101
Laurence Lundbladee6430642020-03-14 21:15:44 -07003102
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003103
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003104
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003105
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003106
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003107
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003108static QCBORError InterpretBool(const QCBORItem *pItem, bool *pBool)
3109{
3110 switch(pItem->uDataType) {
3111 case QCBOR_TYPE_TRUE:
3112 *pBool = true;
3113 return QCBOR_SUCCESS;
3114 break;
3115
3116 case QCBOR_TYPE_FALSE:
3117 *pBool = false;
3118 return QCBOR_SUCCESS;
3119 break;
3120
3121 default:
3122 return QCBOR_ERR_UNEXPECTED_TYPE;
3123 break;
3124 }
3125}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003126
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003127/*
3128Public function, see header qcbor/qcbor_decode.h file
3129*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003130void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003131{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003132 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003133 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003134 return;
3135 }
3136
Laurence Lundbladec4537442020-04-14 18:53:22 -07003137 QCBORError nError;
3138 QCBORItem Item;
3139
3140 nError = QCBORDecode_GetNext(pMe, &Item);
3141 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003142 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003143 return;
3144 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003145 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003146}
3147
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003148/*
3149Public function, see header qcbor/qcbor_decode.h file
3150*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003151void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003152{
3153 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003154 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003155
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003156 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003157}
3158
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003159/*
3160Public function, see header qcbor/qcbor_decode.h file
3161*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003162void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3163{
3164 QCBORItem Item;
3165 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3166
3167 pMe->uLastError = (uint8_t)InterpretBool(&Item, pValue);
3168}
3169
3170
3171
3172void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe, TagSpecification TagSpec, UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003173{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003174 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003175 // Already in error state, do nothing
3176 return;
3177 }
3178
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003179 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003180 QCBORItem Item;
3181
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003182 uError = QCBORDecode_GetNext(pMe, &Item);
3183 if(uError != QCBOR_SUCCESS) {
3184 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003185 return;
3186 }
3187
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003188 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, Item.uDataType);
3189
3190 if(pMe->uLastError == QCBOR_SUCCESS) {
3191 *pBstr = Item.val.string;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003192 }
3193}
3194
Laurence Lundbladec4537442020-04-14 18:53:22 -07003195
3196
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003197
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003198static QCBORError ConvertBigNum(uint8_t uTagRequirement,
3199 const QCBORItem *pItem,
3200 UsefulBufC *pValue,
3201 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003202{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003203 const TagSpecification TagSpec = {uTagRequirement,
3204 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE},
3205 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3206 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003207
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003208 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
3209 if(uErr != QCBOR_SUCCESS) {
3210 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003211 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003212
3213 *pValue = pItem->val.string;
3214
3215 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3216 *pbIsNegative = false;
3217 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3218 *pbIsNegative = true;
3219 }
3220
3221 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003222}
3223
3224
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003225/**
3226 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003227 */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003228void QCBORDecode_GetBignum(QCBORDecodeContext *pMe, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003229{
3230 if(pMe->uLastError != QCBOR_SUCCESS) {
3231 // Already in error state, do nothing
3232 return;
3233 }
3234
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003235 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003236 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3237 if(uError != QCBOR_SUCCESS) {
3238 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003239 return;
3240 }
3241
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003242 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003243}
3244
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003245/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003246Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003247*/
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003248void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003249{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003250 QCBORItem Item;
3251 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003252
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003253 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003254}
3255
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003256/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003257Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003258*/
3259void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint8_t uTagRequirement, UsefulBufC *pValue, bool *pbIsNegative)
3260{
3261 QCBORItem Item;
3262 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3263
3264 pMe->uLastError = (uint8_t)ConvertBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
3265}
3266
3267
3268
3269// Semi private
3270QCBORError FarfMIME(uint8_t uTagRequirement, const QCBORItem *pItem, UsefulBufC *pMessage, bool *pbIsNot7Bit)
3271{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003272
3273
3274 const TagSpecification TagSpecText = {uTagRequirement,
3275 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3276 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3277 };
3278 const TagSpecification TagSpecBinary = {uTagRequirement,
3279 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3280 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3281 };
3282
3283
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003284 QCBORError uReturn;
3285
3286 if(CheckTagRequirement(TagSpecText, pItem->uDataType)) {
3287 *pMessage = pItem->val.string;
3288 if(pbIsNot7Bit != NULL) {
3289 *pbIsNot7Bit = false;
3290 }
3291 uReturn = QCBOR_SUCCESS;
3292 } else if(CheckTagRequirement(TagSpecBinary, pItem->uDataType)) {
3293 *pMessage = pItem->val.string;
3294 if(pbIsNot7Bit != NULL) {
3295 *pbIsNot7Bit = true;
3296 }
3297 uReturn = QCBOR_SUCCESS;
3298
3299 } else {
3300 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3301 }
3302
3303 return uReturn;
3304}
3305
3306
3307
3308
3309
Laurence Lundbladec4537442020-04-14 18:53:22 -07003310
3311
3312
Laurence Lundbladee6430642020-03-14 21:15:44 -07003313
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003314typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003315
3316
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003317// The main exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003318static QCBORError Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003319{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003320 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003321
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003322 if(uResult != 0) {
3323 /* This loop will run a maximum of 19 times because
3324 * UINT64_MAX < 10 ^^ 19. More than that will cause
3325 * exit with the overflow error
3326 */
3327 for(; nExponent > 0; nExponent--) {
3328 if(uResult > UINT64_MAX / 10) {
3329 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3330 }
3331 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003332 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003333
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003334 for(; nExponent < 0; nExponent++) {
3335 uResult = uResult / 10;
3336 if(uResult == 0) {
3337 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3338 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003339 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003340 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003341 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003342
3343 *puResult = uResult;
3344
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003345 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003346}
3347
3348
Laurence Lundbladee6430642020-03-14 21:15:44 -07003349/* Convert a decimal fraction to an int64_t without using
3350 floating point or math libraries. Most decimal fractions
3351 will not fit in an int64_t and this will error out with
3352 under or overflow
3353 */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003354static QCBORError Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003355{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003356 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003357
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003358 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003359
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003360 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003361 * INT64_MAX < 2^31. More than that will cause
3362 * exist with the overflow error
3363 */
3364 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003365 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003366 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003367 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003368 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003369 nExponent--;
3370 }
3371
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003372 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003373 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003374 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3375 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003376 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003377 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003378 }
3379
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003380 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003381
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003382 return QCBOR_SUCCESS;
3383}
3384
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003385/*
3386 Compute value with signed mantissa and signed result. Works with exponent of 2 or 10 based on exponentiator.
3387 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003388static inline QCBORError ExponentiateNN(int64_t nMantissa, int64_t nExponent, int64_t *pnResult, fExponentiator pfExp)
3389{
3390 uint64_t uResult;
3391
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003392 // Take the absolute value of the mantissa and convert to unsigned.
3393 // TODO: this should be possible in one intruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003394 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3395
3396 // Do the exponentiation of the positive mantissa
3397 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3398 if(uReturn) {
3399 return uReturn;
3400 }
3401
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003402
Laurence Lundblade983500d2020-05-14 11:49:34 -07003403 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3404 of INT64_MIN. This assumes two's compliment representation where
3405 INT64_MIN is one increment farther from 0 than INT64_MAX.
3406 Trying to write -INT64_MIN doesn't work to get this because the
3407 compiler tries to work with an int64_t which can't represent
3408 -INT64_MIN.
3409 */
3410 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3411
3412 // Error out if too large
3413 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003414 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3415 }
3416
3417 // Casts are safe because of checks above
3418 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
3419
3420 return QCBOR_SUCCESS;
3421}
3422
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003423/*
3424 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
3425 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003426static inline QCBORError ExponentitateNU(int64_t nMantissa, int64_t nExponent, uint64_t *puResult, fExponentiator pfExp)
3427{
3428 if(nMantissa < 0) {
3429 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3430 }
3431
3432 // Cast to unsigned is OK because of check for negative
3433 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
3434 // Exponentiation is straight forward
3435 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
3436}
3437
3438
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003439#include <math.h>
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003440
3441
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003442static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003443{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003444 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003445
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003446 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003447 const uint8_t *pByte = BigNum.ptr;
3448 size_t uLen = BigNum.len;
3449 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07003450 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003451 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003452 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07003453 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003454 }
3455
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003456 *pResult = uResult;
3457 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003458}
3459
Laurence Lundblade887add82020-05-17 05:50:34 -07003460static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003461{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003462 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003463}
3464
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003465static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003466{
3467 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003468 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
3469 if(uError) {
3470 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003471 }
3472 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
3473 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003474 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003475}
3476
3477
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003478static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003479{
3480 uint64_t uResult;
Laurence Lundbladeda095972020-06-06 18:35:33 -07003481 /* negaative int furthest from zero is INT64_MIN
3482 which is expressed as -INT64_MAX-1. The value of
3483 a negative bignum is -n-1, one further from zero
3484 than the positive bignum */
3485
3486 /* say INT64_MIN is -2; then INT64_MAX is 1.
3487 Then -n-1 <= INT64_MIN.
3488 Then -n -1 <= -INT64_MAX - 1
3489 THen n <= INT64_MAX. */
3490 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003491 if(uError) {
3492 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003493 }
3494 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
Laurence Lundblade887add82020-05-17 05:50:34 -07003495 // TODO: this code is incorrect. See RFC 7049
Laurence Lundbladeda095972020-06-06 18:35:33 -07003496 uResult++; // this is the -1 in -n-1
Laurence Lundbladee6430642020-03-14 21:15:44 -07003497 *pResult = -(int64_t)uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003498 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003499}
3500
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003501#include "fenv.h"
Laurence Lundbladec4537442020-04-14 18:53:22 -07003502
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003503
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003504/*
3505Convert a integers and floats to an int64_t.
3506
3507\param[in] uOptions Bit mask list of conversion options.
3508
3509\retval QCBOR_ERR_CONVERSION_NOT_REQUESTED Conversion, possible, but not requested in uOptions.
3510
3511\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3512
3513\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3514
3515*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003516static QCBORError ConvertInt64(const QCBORItem *pItem, uint32_t uOptions, int64_t *pnValue)
3517{
3518 switch(pItem->uDataType) {
3519 // TODO: float when ifdefs are set
3520 case QCBOR_TYPE_DOUBLE:
3521 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
3522 // TODO: what about under/overflow here?
3523 // Invokes the floating-point HW and/or compiler-added libraries
3524 feclearexcept(FE_ALL_EXCEPT);
3525 *pnValue = llround(pItem->val.dfnum);
3526 if(fetestexcept(FE_INVALID)) {
3527 // TODO: better error code
3528 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3529 }
3530 } else {
3531 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3532 }
3533 break;
3534
3535 case QCBOR_TYPE_INT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003536 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003537 *pnValue = pItem->val.int64;
3538 } else {
3539 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3540 }
3541 break;
3542
3543 case QCBOR_TYPE_UINT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003544 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003545 if(pItem->val.uint64 < INT64_MAX) {
3546 *pnValue = pItem->val.int64;
3547 } else {
3548 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3549 }
3550 } else {
3551 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3552 }
3553 break;
3554
3555 default:
3556 return QCBOR_ERR_UNEXPECTED_TYPE;
3557 }
3558 return QCBOR_SUCCESS;
3559}
3560
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003561
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003562void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
3563 uint32_t uOptions,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003564 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003565 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003566{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003567 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003568 return;
3569 }
3570
Laurence Lundbladee6430642020-03-14 21:15:44 -07003571 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003572 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3573 if(uError) {
3574 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003575 return;
3576 }
3577
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003578 if(pItem) {
3579 *pItem = Item;
3580 }
3581
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003582 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uOptions, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003583}
3584
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003585
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003586void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3587 int64_t nLabel,
3588 uint32_t uOptions,
3589 int64_t *pnValue,
3590 QCBORItem *pItem)
3591{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003592 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003593 if(pMe->uLastError != QCBOR_SUCCESS) {
3594 return;
3595 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003596
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003597 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uOptions, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003598}
3599
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003600
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003601void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
3602 const char * szLabel,
3603 uint32_t uOptions,
3604 int64_t *pnValue,
3605 QCBORItem *pItem)
3606{
3607 if(pMe->uLastError != QCBOR_SUCCESS) {
3608 return;
3609 }
3610
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003611 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003612 if(pMe->uLastError != QCBOR_SUCCESS) {
3613 return;
3614 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003615
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003616 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uOptions, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003617}
3618
3619
3620
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003621/*
3622 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003623
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003624 \param[in] uOptions Bit mask list of conversion options.
3625
3626 \retval QCBOR_ERR_CONVERSION_NOT_REQUESTED Conversion, possible, but not requested in uOptions.
3627
3628 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
3629
3630 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
3631
3632 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003633static QCBORError Int64ConvertAll(const QCBORItem *pItem, uint32_t uOptions, int64_t *pnValue)
3634{
3635 QCBORError uErr;
3636
3637 switch(pItem->uDataType) {
3638
3639 case QCBOR_TYPE_POSBIGNUM:
3640 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3641 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003642 } else {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003643 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003644 }
3645 break;
3646
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003647 case QCBOR_TYPE_NEGBIGNUM:
3648 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3649 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003650 } else {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003651 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003652 }
3653 break;
3654
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003655#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
3656 case QCBOR_TYPE_DECIMAL_FRACTION:
3657 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3658 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
3659 pItem->val.expAndMantissa.nExponent,
3660 pnValue,
3661 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003662 } else {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003663 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3664 }
3665 break;
3666
3667 case QCBOR_TYPE_BIGFLOAT:
3668 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
3669 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
3670 pItem->val.expAndMantissa.nExponent,
3671 pnValue,
3672 Exponentitate2);
3673 } else {
3674 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3675 }
3676 break;
3677
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003678 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
3679 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3680 int64_t nMantissa;
3681 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3682 if(uErr) {
3683 return uErr;
3684 }
3685 return ExponentiateNN(nMantissa,
3686 pItem->val.expAndMantissa.nExponent,
3687 pnValue,
3688 Exponentitate10);
3689 } else {
3690 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3691 }
3692 break;
3693
3694 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
3695 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3696 int64_t nMantissa;
3697 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3698 if(uErr) {
3699 return uErr;
3700 }
3701 return ExponentiateNN(nMantissa,
3702 pItem->val.expAndMantissa.nExponent,
3703 pnValue,
3704 Exponentitate10);
3705 } else {
3706 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3707 }
3708 break;
3709
3710 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
3711 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3712 int64_t nMantissa;
3713 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3714 if(uErr) {
3715 return uErr;
3716 }
3717 return ExponentiateNN(nMantissa,
3718 pItem->val.expAndMantissa.nExponent,
3719 pnValue,
3720 Exponentitate2);
3721 } else {
3722 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3723 }
3724 break;
3725
3726 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
3727 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3728 int64_t nMantissa;
3729 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
3730 if(uErr) {
3731 return uErr;
3732 }
3733 return ExponentiateNN(nMantissa,
3734 pItem->val.expAndMantissa.nExponent,
3735 pnValue,
3736 Exponentitate2);
3737 } else {
3738 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003739 }
3740 break;
3741
Laurence Lundbladec4537442020-04-14 18:53:22 -07003742 default:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003743 return QCBOR_ERR_UNEXPECTED_TYPE;
3744#endif
Laurence Lundbladec4537442020-04-14 18:53:22 -07003745 }
3746}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003747
3748
Laurence Lundbladec4537442020-04-14 18:53:22 -07003749/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003750 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003751 */
3752void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uOptions, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003753{
3754 QCBORItem Item;
3755
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003756 QCBORDecode_GetInt64ConvertInternal(pMe, uOptions, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003757
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003758 if(pMe->uLastError == QCBOR_SUCCESS) {
3759 // The above conversion succeeded
3760 return;
3761 }
3762
Laurence Lundbladef6c86662020-05-12 02:08:00 -07003763 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003764 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07003765 return;
3766 }
3767
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003768 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uOptions, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003769}
3770
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003771
3772/*
3773Public function, see header qcbor/qcbor_decode.h file
3774*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003775void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, int64_t *pnValue)
3776{
3777 QCBORItem Item;
3778
3779 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uOptions, pnValue, &Item);
3780
3781 if(pMe->uLastError == QCBOR_SUCCESS) {
3782 // The above conversion succeeded
3783 return;
3784 }
3785
3786 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3787 // The above conversion failed in a way that code below can't correct
3788 return;
3789 }
3790
3791 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uOptions, pnValue);
3792}
3793
3794
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003795/*
3796Public function, see header qcbor/qcbor_decode.h file
3797*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003798void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, int64_t *pnValue)
3799{
3800 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003801 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uOptions, pnValue, &Item);
3802
3803 if(pMe->uLastError == QCBOR_SUCCESS) {
3804 // The above conversion succeeded
3805 return;
3806 }
3807
3808 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
3809 // The above conversion failed in a way that code below can't correct
3810 return;
3811 }
3812
3813 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uOptions, pnValue);
3814}
3815
3816
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003817static QCBORError ConvertUint64(const QCBORItem *pItem, uint32_t uOptions, uint64_t *puValue)
3818{
3819 switch(pItem->uDataType) {
3820 // TODO: type flaot
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07003821 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003822 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
3823 feclearexcept(FE_ALL_EXCEPT);
3824 double dRounded = round(pItem->val.dfnum);
3825 // TODO: over/underflow
3826 if(fetestexcept(FE_INVALID)) {
3827 // TODO: better error code
3828 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3829 } else if(isnan(dRounded)) {
3830 // TODO: better error code
3831 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3832 } else if(dRounded >= 0) {
3833 *puValue = (uint64_t)dRounded;
3834 } else {
3835 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3836 }
3837 } else {
3838 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3839 }
3840 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003841
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003842 case QCBOR_TYPE_INT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003843 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003844 if(pItem->val.int64 >= 0) {
3845 *puValue = (uint64_t)pItem->val.int64;
3846 } else {
3847 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3848 }
3849 } else {
3850 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3851 }
3852 break;
3853
3854 case QCBOR_TYPE_UINT64:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003855 if(uOptions & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003856 *puValue = pItem->val.uint64;
3857 } else {
3858 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3859 }
3860 break;
3861
3862 default:
3863 return QCBOR_ERR_UNEXPECTED_TYPE;
3864 }
3865 return QCBOR_SUCCESS;
3866}
Laurence Lundbladec4537442020-04-14 18:53:22 -07003867
3868
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003869void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
3870 uint32_t uOptions,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003871 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003872 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003873{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003874 if(pMe->uLastError != QCBOR_SUCCESS) {
3875 return;
3876 }
3877
Laurence Lundbladec4537442020-04-14 18:53:22 -07003878 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003879
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003880 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3881 if(uError) {
3882 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003883 return;
3884 }
3885
Laurence Lundbladea826c502020-05-10 21:07:00 -07003886 if(pItem) {
3887 *pItem = Item;
3888 }
3889
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003890 pMe->uLastError = (uint8_t)ConvertUint64(&Item, uOptions, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003891}
3892
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003893
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003894void QCBORDecode_GetInt8ConvertInternal(QCBORDecodeContext *pMe, uint32_t uOptions, int8_t *pnValue, QCBORItem *pItem)
3895{
3896 int64_t uValue;
3897 QCBORDecode_GetInt64ConvertInternal(pMe, uOptions, &uValue, pItem);
3898 if(pMe->uLastError != QCBOR_SUCCESS) {
3899 return;
3900 }
3901
3902 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3903 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3904 }
3905}
3906
3907void QCBORDecode_GetInt8ConvertInternalInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, int8_t *pnValue, QCBORItem *pItem)
3908{
3909 int64_t uValue;
3910 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uOptions, &uValue, pItem);
3911 if(pMe->uLastError != QCBOR_SUCCESS) {
3912 return;
3913 }
3914
3915 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3916 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3917 }
3918}
3919
3920void QCBORDecode_GetInt8ConvertInternalInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, int8_t *pnValue, QCBORItem *pItem)
3921{
3922 int64_t uValue;
3923 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uOptions, &uValue, pItem);
3924 if(pMe->uLastError != QCBOR_SUCCESS) {
3925 return;
3926 }
3927
3928 if(QCBOR_Int64ToInt8(uValue, pnValue)) {
3929 pMe->uLastError = QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3930 }
3931}
3932
3933
3934
3935
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003936void QCBORDecode_GetUint64ConvertInternalInMapN(QCBORDecodeContext *pMe,
3937 int64_t nLabel,
3938 uint32_t uOptions,
3939 uint64_t *puValue,
3940 QCBORItem *pItem)
3941{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003942 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003943 if(pMe->uLastError != QCBOR_SUCCESS) {
3944 return;
3945 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003946
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003947 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uOptions, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003948}
3949
3950
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07003951void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003952 const char * szLabel,
3953 uint32_t uOptions,
3954 uint64_t *puValue,
3955 QCBORItem *pItem)
3956{
3957 if(pMe->uLastError != QCBOR_SUCCESS) {
3958 return;
3959 }
3960
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003961 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003962 if(pMe->uLastError != QCBOR_SUCCESS) {
3963 return;
3964 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003965
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003966 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uOptions, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003967}
3968
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003969/*
3970 Public function, see header qcbor/qcbor_decode.h file
3971*/
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003972static QCBORError Uint64ConvertAll(const QCBORItem *pItem, uint32_t uOptions, uint64_t *puValue)
3973{
3974 QCBORError uErr;
3975
3976 switch(pItem->uDataType) {
3977
3978 case QCBOR_TYPE_POSBIGNUM:
3979 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3980 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
3981 } else {
3982 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3983 }
3984 break;
3985
3986 case QCBOR_TYPE_NEGBIGNUM:
3987 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
3988 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
3989 } else {
3990 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
3991 }
3992 break;
3993
3994#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
3995
3996 case QCBOR_TYPE_DECIMAL_FRACTION:
3997 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
3998 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
3999 pItem->val.expAndMantissa.nExponent,
4000 puValue,
4001 Exponentitate10);
4002 } else {
4003 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4004 }
4005 break;
4006
4007 case QCBOR_TYPE_BIGFLOAT:
4008 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
4009 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4010 pItem->val.expAndMantissa.nExponent,
4011 puValue,
4012 Exponentitate2);
4013 } else {
4014 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4015 }
4016 break;
4017
4018 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4019 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4020 // TODO: Would be better to convert to unsigned
4021 int64_t nMantissa;
4022 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4023 if(uErr != QCBOR_SUCCESS) {
4024 return uErr;
4025 }
4026 return ExponentitateNU(nMantissa,
4027 pItem->val.expAndMantissa.nExponent,
4028 puValue,
4029 Exponentitate10);
4030 } else {
4031 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4032 }
4033 break;
4034
4035 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4036 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4037 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4038 } else {
4039 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4040 }
4041 break;
4042
4043 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
4044 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4045 // TODO: Would be better to convert to unsigned
4046 int64_t nMantissa;
4047 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4048 if(uErr != QCBOR_SUCCESS) {
4049 return uErr;
4050 }
4051 return ExponentitateNU(nMantissa,
4052 pItem->val.expAndMantissa.nExponent,
4053 puValue,
4054 Exponentitate2);
4055 } else {
4056 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4057 }
4058 break;
4059
4060 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
4061 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4062 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4063 } else {
4064 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4065 }
4066 break;
4067#endif
4068 default:
4069 return QCBOR_ERR_UNEXPECTED_TYPE;
4070 }
4071}
4072
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004073/*
4074 Public function, see header qcbor/qcbor_decode.h file
4075*/
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004076void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uOptions, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004077{
4078 QCBORItem Item;
4079
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004080 QCBORDecode_GetUInt64ConvertInternal(pMe, uOptions, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004081
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004082 if(pMe->uLastError == QCBOR_SUCCESS) {
4083 // The above conversion succeeded
4084 return;
4085 }
4086
4087 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4088 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004089 return;
4090 }
4091
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004092 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uOptions, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004093}
4094
Laurence Lundbladec4537442020-04-14 18:53:22 -07004095
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004096/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004097 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004098*/
4099void QCBORDecode_GetUint64ConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, uint64_t *puValue)
4100{
4101 QCBORItem Item;
4102
4103 QCBORDecode_GetUint64ConvertInternalInMapN(pMe, nLabel, uOptions, puValue, &Item);
4104
4105 if(pMe->uLastError == QCBOR_SUCCESS) {
4106 // The above conversion succeeded
4107 return;
4108 }
4109
4110 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4111 // The above conversion failed in a way that code below can't correct
4112 return;
4113 }
4114
4115 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uOptions, puValue);
4116}
4117
4118
4119/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004120 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004121*/
4122void QCBORDecode_GetUint64ConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, uint64_t *puValue)
4123{
4124 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004125 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe, szLabel, uOptions, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004126
4127 if(pMe->uLastError == QCBOR_SUCCESS) {
4128 // The above conversion succeeded
4129 return;
4130 }
4131
4132 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4133 // The above conversion failed in a way that code below can't correct
4134 return;
4135 }
4136
4137 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uOptions, puValue);
4138}
4139
4140
4141static QCBORError ConvertDouble(const QCBORItem *pItem, uint32_t uOptions, double *pdValue)
4142{
4143 switch(pItem->uDataType) {
4144 // TODO: float when ifdefs are set
4145 case QCBOR_TYPE_DOUBLE:
4146 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
4147 if(uOptions & QCBOR_CONVERT_TYPE_FLOAT) {
4148 *pdValue = pItem->val.dfnum;
4149 } else {
4150 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4151 }
4152 }
4153 break;
4154
4155 case QCBOR_TYPE_INT64:
4156 if(uOptions & QCBOR_CONVERT_TYPE_INT64) {
4157 // TODO: how does this work?
4158 *pdValue = (double)pItem->val.int64;
4159
4160 } else {
4161 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4162 }
4163 break;
4164
4165 case QCBOR_TYPE_UINT64:
4166 if(uOptions & QCBOR_CONVERT_TYPE_UINT64) {
4167 *pdValue = (double)pItem->val.uint64;
4168 } else {
4169 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4170 }
4171 break;
4172
4173 default:
4174 return QCBOR_ERR_UNEXPECTED_TYPE;
4175 }
4176
4177 return QCBOR_SUCCESS;
4178}
4179
4180
4181
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004182void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
4183 uint32_t uOptions,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004184 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004185 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004186{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004187 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004188 return;
4189 }
4190
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004191 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004192
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004193 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004194 if(uError) {
4195 pMe->uLastError = (uint8_t)uError;
4196 return;
4197 }
4198
4199 if(pItem) {
4200 *pItem = Item;
4201 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004202
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004203 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uOptions, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004204}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004205
Laurence Lundbladec4537442020-04-14 18:53:22 -07004206
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004207void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4208 int64_t nLabel,
4209 uint32_t uOptions,
4210 double *pdValue,
4211 QCBORItem *pItem)
4212{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004213 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004214 if(pMe->uLastError != QCBOR_SUCCESS) {
4215 return;
4216 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004217
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004218 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uOptions, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004219}
4220
4221void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4222 const char * szLabel,
4223 uint32_t uOptions,
4224 double *pdValue,
4225 QCBORItem *pItem)
4226{
4227 if(pMe->uLastError != QCBOR_SUCCESS) {
4228 return;
4229 }
4230
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004231 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004232 if(pMe->uLastError != QCBOR_SUCCESS) {
4233 return;
4234 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004235
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004236 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uOptions, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004237}
4238
4239
4240
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004241static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4242{
4243 double dResult;
4244
4245 dResult = 0.0;
4246 const uint8_t *pByte = BigNum.ptr;
4247 size_t uLen = BigNum.len;
4248 /* This will overflow and become the float value INFINITY if the number
4249 is too large to fit. No error will be logged.
4250 TODO: should an error be logged? */
4251 while(uLen--) {
4252 dResult = (dResult * 256.0) + (double)*pByte++;
4253 }
4254
4255 return dResult;
4256}
4257
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004258static QCBORError DoubleConvertAll(const QCBORItem *pItem, uint32_t uOptions, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004259{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004260 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004261 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4262
4263 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004264 switch(pItem->uDataType) {
4265 // TODO: type float
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004266
4267#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004268 case QCBOR_TYPE_DECIMAL_FRACTION:
4269 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4270 // TODO: rounding and overflow errors
4271 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4272 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4273 } else {
4274 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4275 }
4276 break;
4277
4278 case QCBOR_TYPE_BIGFLOAT:
4279 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
4280 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4281 exp2((double)pItem->val.expAndMantissa.nExponent);
4282 } else {
4283 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4284 }
4285 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004286#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004287
4288 case QCBOR_TYPE_POSBIGNUM:
4289 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
4290 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4291 } else {
4292 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4293 }
4294 break;
4295
4296 case QCBOR_TYPE_NEGBIGNUM:
4297 if(uOptions & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004298 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004299 } else {
4300 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4301 }
4302 break;
4303
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004304#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004305 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4306 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4307 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4308 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4309 } else {
4310 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4311 }
4312 break;
4313
4314 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4315 if(uOptions & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
4316 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4317 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4318 } else {
4319 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4320 }
4321 break;
4322
4323 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
4324 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
4325 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4326 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4327 } else {
4328 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4329 }
4330 break;
4331
4332 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
4333 if(uOptions & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004334 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004335 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4336 } else {
4337 return QCBOR_ERR_CONVERSION_NOT_REQUESTED;
4338 }
4339 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004340#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4341
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004342
4343 default:
4344 return QCBOR_ERR_UNEXPECTED_TYPE;
4345 }
4346
4347 return QCBOR_SUCCESS;
4348}
4349
4350
4351/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004352 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004353*/
4354void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe, uint32_t uOptions, double *pdValue)
4355{
4356
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004357 QCBORItem Item;
4358
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004359 QCBORDecode_GetDoubleConvertInternal(pMe, uOptions, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004360
4361 if(pMe->uLastError == QCBOR_SUCCESS) {
4362 // The above conversion succeeded
4363 return;
4364 }
4365
4366 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4367 // The above conversion failed in a way that code below can't correct
4368 return;
4369 }
4370
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004371 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uOptions, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004372}
4373
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004374
4375/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004376 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004377*/
4378void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe, int64_t nLabel, uint32_t uOptions, double *pdValue)
4379{
4380 QCBORItem Item;
4381
4382 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uOptions, pdValue, &Item);
4383
4384 if(pMe->uLastError == QCBOR_SUCCESS) {
4385 // The above conversion succeeded
4386 return;
4387 }
4388
4389 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4390 // The above conversion failed in a way that code below can't correct
4391 return;
4392 }
4393
4394 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uOptions, pdValue);
4395}
4396
4397
4398/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004399 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004400*/
4401void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, uint32_t uOptions, double *pdValue)
4402{
4403 QCBORItem Item;
4404 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uOptions, pdValue, &Item);
4405
4406 if(pMe->uLastError == QCBOR_SUCCESS) {
4407 // The above conversion succeeded
4408 return;
4409 }
4410
4411 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4412 // The above conversion failed in a way that code below can't correct
4413 return;
4414 }
4415
4416 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uOptions, pdValue);
4417}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004418
4419
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004420#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004421static void ProcessDecimalFraction(QCBORDecodeContext *pMe,
4422 uint8_t uTagRequirement,
4423 QCBORItem *pItem,
4424 int64_t *pnMantissa,
4425 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004426{
4427 QCBORError uErr;
4428
4429 if(pItem->uDataType == QCBOR_TYPE_ARRAY) {
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004430
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004431 if(uTagRequirement == QCBOR_TAGSPEC_MATCH_TAG_CONTENT_TYPE) {
4432 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4433 return;
4434 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004435 /* The decimal fraction was untagged so it shows up as an
4436 array at this point. We are called to interpret it
4437 as a decimal fraction, so do protocol decoding. If
4438 it was tagged, iw would shouw up here with the
4439 QCBOR_TYPE_DECIMAL_FRACTION or such. */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004440 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4441 if(uErr != QCBOR_SUCCESS) {
4442 pMe->uLastError = (uint8_t)uErr;
4443 return;
4444 }
4445 }
4446
4447 if(uTagRequirement == QCBOR_TAGSPEC_MATCH_TAG_CONTENT_TYPE) {
4448 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4449 return;
4450 }
4451
4452 switch (pItem->uDataType) {
4453
4454 case QCBOR_TYPE_DECIMAL_FRACTION:
4455 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
4456 *pnExponent = pItem->val.expAndMantissa.nExponent;
4457 break;
4458
4459 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4460 *pnExponent = pItem->val.expAndMantissa.nExponent;
4461
4462 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
4463 if(uErr != QCBOR_SUCCESS) {
4464 pMe->uLastError = (uint8_t)uErr;
4465 }
4466 break;
4467
4468 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4469 *pnExponent = pItem->val.expAndMantissa.nExponent;
4470
4471 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
4472 if(uErr != QCBOR_SUCCESS) {
4473 pMe->uLastError = (uint8_t)uErr;
4474 }
4475 break;
4476
4477 default:
4478 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4479 }
4480}
4481
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004482
4483void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
4484 uint8_t uTagRequirement,
4485 int64_t *pnMantissa,
4486 int64_t *pnExponent)
4487{
4488 if(pMe->uLastError != QCBOR_SUCCESS) {
4489 return;
4490 }
4491
4492 QCBORItem Item;
4493 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4494 if(uError) {
4495 pMe->uLastError = (uint8_t)uError;
4496 return;
4497 }
4498
4499 ProcessDecimalFraction(pMe, uTagRequirement, &Item, pnMantissa, pnExponent);
4500}
4501
4502
4503void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004504 uint8_t uTagRequirement,
4505 int64_t nLabel,
4506 int64_t *pnMantissa,
4507 int64_t *pnExponent)
4508{
4509 QCBORItem Item;
4510
4511 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004512 ProcessDecimalFraction(pMe, uTagRequirement, &Item, pnMantissa, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004513}
4514
4515
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004516void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
4517 uint8_t uTagRequirement,
4518 const char *szLabel,
4519 int64_t *pnMantissa,
4520 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004521{
4522 QCBORItem Item;
4523
4524 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4525
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004526 ProcessDecimalFraction(pMe, uTagRequirement, &Item, pnMantissa, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004527}
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004528#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004529
4530
4531UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
4532{
4533 while(uInt & 0xff0000000000UL) {
4534 uInt = uInt << 8;
4535 };
4536
4537 UsefulOutBuf UOB;
4538
4539 UsefulOutBuf_Init(&UOB, Buffer);
4540
4541 while(uInt) {
4542 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff0000000000UL) >> 56));
4543 uInt = uInt << 8;
4544 }
4545
4546 return UsefulOutBuf_OutUBuf(&UOB);
4547}
4548
4549
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004550#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4551
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004552static void ProcessDecimalFractionBig(QCBORDecodeContext *pMe,
4553 uint8_t uTagRequirement,
4554 QCBORItem *pItem,
4555 UsefulBuf BufferForMantissa,
4556 UsefulBufC *pMantissa,
4557 bool *pbIsNegative,
4558 int64_t *pnExponent)
4559{
4560
4561 const TagSpecification TagSpec = {uTagRequirement,
4562 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
4563 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
4564 };
4565
4566 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
4567 if(uErr != QCBOR_SUCCESS) {
4568 pMe->uLastError = (uint8_t)uErr;
4569 return;
4570 }
4571
4572 if(pItem->uDataType == QCBOR_TYPE_ARRAY) {
4573 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
4574 if(uErr != QCBOR_SUCCESS) {
4575 pMe->uLastError = (uint8_t)uErr;
4576 return;
4577 }
4578 }
4579
4580 uint64_t uMantissa;
4581
4582 switch (pItem->uDataType) {
4583
4584 case QCBOR_TYPE_DECIMAL_FRACTION:
4585 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
4586 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
4587 *pbIsNegative = false;
4588 } else {
4589 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
4590 *pbIsNegative = true;
4591 }
4592 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
4593 *pnExponent = pItem->val.expAndMantissa.nExponent;
4594 break;
4595
4596 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
4597 *pnExponent = pItem->val.expAndMantissa.nExponent;
4598 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4599 *pbIsNegative = false;
4600 break;
4601
4602 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
4603 *pnExponent = pItem->val.expAndMantissa.nExponent;
4604 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
4605 *pbIsNegative = true;
4606 break;
4607
4608 default:
4609 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
4610 }
4611}
4612
4613
4614void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
4615 uint8_t uTagRequirement,
4616 UsefulBuf MantissaBuffer,
4617 UsefulBufC *pMantissa,
4618 bool *pbMantissaIsNegative,
4619 int64_t *pnExponent)
4620{
4621
4622 if(pMe->uLastError != QCBOR_SUCCESS) {
4623 return;
4624 }
4625
4626 QCBORItem Item;
4627 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4628 if(uError) {
4629 pMe->uLastError = (uint8_t)uError;
4630 return;
4631 }
4632
4633 ProcessDecimalFractionBig(pMe, uTagRequirement, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
4634
4635}
4636
4637void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
4638 uint8_t uTagRequirement,
4639 int64_t nLabel,
4640 UsefulBuf BufferForMantissa,
4641 UsefulBufC *pMantissa,
4642 bool *pbIsNegative,
4643 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004644{
4645 QCBORItem Item;
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004646
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004647 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004648 if(pMe->uLastError != QCBOR_SUCCESS) {
4649 return;
4650 }
4651
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004652 ProcessDecimalFractionBig(pMe, uTagRequirement, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
4653}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004654
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004655
4656void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
4657 uint8_t uTagRequirement,
4658 const char *szLabel,
4659 UsefulBuf BufferForMantissa,
4660 UsefulBufC *pMantissa,
4661 bool *pbIsNegative,
4662 int64_t *pnExponent)
4663{
4664 QCBORItem Item;
4665
4666 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4667 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004668 return;
4669 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004670
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004671 ProcessDecimalFractionBig(pMe, uTagRequirement, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004672}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004673
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004674#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07004675
4676/*
4677
4678 TODO: do something with this text
4679 The main mode of decoding is a pre-order travesal of the tree of leaves (numbers, strings...)
4680 formed by intermediate nodes (arrays and maps). The cursor for the traversal
4681 is the byte offset in the encoded input and a leaf counter for definite
4682 length maps and arrays. Indefinite length maps and arrays are handled
4683 by look ahead for the break.
4684
4685 The view presented to the caller has tags, labels and the chunks of
4686 indefinite length strings aggregated into one decorated data item.
4687
4688 The caller understands the nesting level in pre-order traversal by
4689 the fact that a data item that is a map or array is presented to
4690 the caller when it is first encountered in the pre-order traversal and that all data items are presented with its nesting level
4691 and the nesting level of the next item.
4692
4693 The caller traverse maps and arrays in a special mode that often more convenient
4694 that tracking by nesting level. When an array or map is expected or encountered
4695 the EnterMap or EnteryArray can be called.
4696
4697 When entering a map or array like this, the cursor points to the first
4698 item in the map or array. When exiting, it points to the item after
4699 the map or array, regardless of whether the items in the map or array were
4700 all traversed.
4701
4702 When in a map or array, the cursor functions as normal, but traversal
4703 cannot go past the end of the map or array that was entered. If this
4704 is attempted the QCBOR_ERR_NO_MORE_ITEMS error is returned. To
4705 go past the end of the map or array ExitMap() or ExitArray() must
4706 be called. It can be called any time regardless of the position
4707 of the cursor.
4708
4709 When a map is entered, a special function allows fetching data items
4710 by label. This call will traversal the whole map looking for the
4711 labeled item. The whole map is traversed so as to detect duplicates.
4712 This type of fetching items does not affect the normal traversal
4713 cursor.
4714
4715
4716 When a data item is presented to the caller, the nesting level of the data
4717 item is presented along with the nesting level of the item that would be
4718 next consumed.
4719 */