blob: 6450203d072e7aa08bd07de7ac3a2bd76aae7694 [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundbladeee851742020-01-08 08:37:05 -08003 Copyright (c) 2018-2020, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundbladec7114722020-08-13 05:11:40 -070036#include "ieee754.h" // Does not use math.h
37
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
39#include <math.h> // For isnan(). TODO: list
40#endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070041
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070042
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053043/*
44 This casts away the const-ness of a pointer, usually so it can be
45 freed or realloced.
46 */
47#define UNCONST_POINTER(ptr) ((void *)(ptr))
48
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070049
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070050
Laurence Lundblade02625d42020-06-25 14:41:41 -070051inline static bool
52// TODO: add more tests for QCBOR_TYPE_MAP_AS_ARRAY mode in qcbor_decode_tests.c
53QCBORItem_IsMapOrArray(const QCBORItem *pMe)
54{
55 const uint8_t uDataType = pMe->uDataType;
56 return uDataType == QCBOR_TYPE_MAP ||
57 uDataType == QCBOR_TYPE_ARRAY ||
58 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
59}
60
61inline static bool
62QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
63{
64 if(!QCBORItem_IsMapOrArray(pMe)){
65 return false;
66 }
67
68 if(pMe->val.uCount != 0) {
69 return false;
70 }
71 return true;
72}
73
74inline static bool
75QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
76{
77 if(!QCBORItem_IsMapOrArray(pMe)){
78 return false;
79 }
80
81 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
82 return false;
83 }
84 return true;
85}
86
87
Laurence Lundbladeee851742020-01-08 08:37:05 -080088/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070089 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080090 ===========================================================================*/
91
Laurence Lundblade9c905e82020-04-25 11:31:38 -070092/*
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070093 See commecnts about and typedef of QCBORDecodeNesting in qcbor_private.h, the data structure
94 all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -070095
Laurence Lundblade9c905e82020-04-25 11:31:38 -070096
Laurence Lundblade9c905e82020-04-25 11:31:38 -070097
Laurence Lundblade9c905e82020-04-25 11:31:38 -070098 */
99
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700100
101inline static uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700102DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700103{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700104 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700105 /*
106 Limit in DecodeNesting_Descend against more than
107 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
108 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700109 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700110}
111
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700112
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700113inline static uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700114DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700115{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700116 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700117 /*
118 Limit in DecodeNesting_Descend against more than
119 QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
120 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700121 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700122}
123
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700124
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700125static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700126DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700127{
128 return pNesting->pCurrentBounded->u.ma.uStartOffset;
129}
130
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700131
Laurence Lundblade085d7952020-07-24 10:26:30 -0700132static inline bool
133DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
134{
135 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
136 return true;
137 } else {
138 return false;
139 }
140}
141
142
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700143inline static bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700144DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700145{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700146 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700147 return true;
148 } else {
149 return false;
150 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700151}
152
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700153
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700154inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700155DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700156{
157 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700158 // Not a map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700159 return false;
160 }
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700161 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700162 // Is indefinite
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700163 return false;
164 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700165 // All checks passed; is a definte length map or array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700166 return true;
167}
168
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700169
Laurence Lundblade642282a2020-06-23 12:00:33 -0700170inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700171DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700172{
173 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700174 // is a byte string
Laurence Lundblade642282a2020-06-23 12:00:33 -0700175 return true;
176 }
177 return false;
178}
179
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700180
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700181inline static bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700182{
183 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
184 return true;
185 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700186 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700187 return true;
188 }
189 return false;
190}
191
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700192
Laurence Lundblade085d7952020-07-24 10:26:30 -0700193inline static void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700194{
195 // Should be only called on maps and arrays
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700196 /*
197 DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
198 larger than DecodeNesting_EnterBoundedMode which keeps it less than
199 uin32_t so the cast is safe.
200 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700201 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700202
203 if(bIsEmpty) {
204 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
205 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700206}
207
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700208
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700209inline static void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700210{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700211 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700212}
213
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700214
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700215inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700216DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700217{
218 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700219 // No bounded map or array or... set up
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700220 return false;
221 }
222 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700223 // Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700224 return false;
225 }
226 if(!DecodeNesting_IsCurrentBounded(pNesting)) { // TODO: pCurrent vs pCurrentBounded
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700227 // Not at a bounded level
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700228 return false;
229 }
Laurence Lundbladed0304932020-06-27 10:59:38 -0700230 // Works for both definite and indefinite length maps/arrays
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700231 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700232 // Count is not zero, still unconsumed item
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700233 return false;
234 }
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700235 // All checks passed, got to the end of a map/array
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700236 return true;
237}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700238
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700239
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700240inline static bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700241DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700242{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700243 // Must only be called on map / array
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700244 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
245 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700246 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700247 return false;
248 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700249}
250
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700251
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700252inline static bool
253DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700254{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700255 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
256 return true;
257 } else {
258 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700259 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700260}
261
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700262
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700263inline static bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700264DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700265{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700266 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700267 return false;
268 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700269
270 if(pNesting->pCurrentBounded->uLevelType != uType) {
271 return false;
272 }
273
274 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700275}
276
Laurence Lundblade02625d42020-06-25 14:41:41 -0700277
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700278inline static void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700279DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700280{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700281 // Only call on a defnite length array / map
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700282 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700283}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700284
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700285
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700286inline static void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700287DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
288{
289 // Only call on a defnite length array / map
290 pNesting->pCurrent->u.ma.uCountCursor++;
291}
292
293
294inline static void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700295DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
296{
297 pNesting->pCurrent--;
298}
299
Laurence Lundblade02625d42020-06-25 14:41:41 -0700300
301static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700302DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700303{
304 // Error out if nesting is too deep
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700305 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700306 return QCBOR_ERR_ARRAY_NESTING_TOO_DEEP;
307 }
308
309 // The actual descend
310 pNesting->pCurrent++;
311
312 pNesting->pCurrent->uLevelType = uType;
313
314 return QCBOR_SUCCESS;
315}
316
317
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700318inline static QCBORError
Laurence Lundblade085d7952020-07-24 10:26:30 -0700319DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700320{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700321 /*
322 Should only be called on map/array.
323
324 Have descended into this before this is called. The job here is
325 just to mark it in bounded mode.
326 */
Laurence Lundblade287b25c2020-08-06 13:48:42 -0700327 if(uOffset >= QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700328 return QCBOR_ERR_BUFFER_TOO_LARGE;
329 }
330
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700331 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700332
333 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700334
335 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700336}
337
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700338
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700339inline static QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700340DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700341 uint8_t uQCBORType,
342 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700343{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700344 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700345
346 if(uCount == 0) {
347 // Nothing to do for empty definite lenth arrays. They are just are
348 // effectively the same as an item that is not a map or array
349 goto Done;
350 // Empty indefinite length maps and arrays are handled elsewhere
351 }
352
353 // Error out if arrays is too long to handle
Laurence Lundblade02625d42020-06-25 14:41:41 -0700354 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
355 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
356 uError = QCBOR_ERR_ARRAY_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700357 goto Done;
358 }
359
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700360 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700361 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700362 goto Done;
363 }
364
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700365 // Fill in the new map/array level. Check above makes casts OK.
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700366 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
367 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700368
369 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700370
371Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700372 return uError;;
373}
374
375
376static inline void
377DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
378{
379 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
380}
381
382
383static inline void
384DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
385{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700386 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700387 pNesting->pCurrentBounded--;
388 if(DecodeNesting_IsCurrentBounded(pNesting)) {
389 break;
390 }
391 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700392}
393
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700394static inline void
395DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
396{
397 pNesting->pCurrent = pNesting->pCurrentBounded;
398}
399
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700400
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700401inline static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700402DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700403 uint32_t uEndOffset,
404 uint32_t uEndOfBstr)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700405{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700406 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700407
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700408 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700409 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700410 goto Done;
411 }
412
Laurence Lundblade02625d42020-06-25 14:41:41 -0700413 // Fill in the new byte string level
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700414 pNesting->pCurrent->u.bs.uPreviousEndOffset = uEndOffset;
415 pNesting->pCurrent->u.bs.uEndOfBstr = uEndOfBstr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700416
Laurence Lundblade02625d42020-06-25 14:41:41 -0700417 // Bstr wrapped levels are always bounded
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700418 pNesting->pCurrentBounded = pNesting->pCurrent;
419
420Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700421 return uError;;
422}
423
Laurence Lundbladed0304932020-06-27 10:59:38 -0700424
425static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700426DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700427{
428 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700429}
430
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700431
Laurence Lundbladeee851742020-01-08 08:37:05 -0800432inline static void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700433DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700434{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700435 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700436 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
437 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700438}
439
440
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700441inline static void
Laurence Lundblade02625d42020-06-25 14:41:41 -0700442DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting, QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700443{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700444 *pSave = *pNesting;
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700445 pNesting->pCurrent = pNesting->pCurrentBounded;
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700446 pNesting->pCurrent->u.ma.uCountCursor = pNesting->pCurrent->u.ma.uCountTotal;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700447}
448
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700449
Laurence Lundblade02625d42020-06-25 14:41:41 -0700450static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700451DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting, const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700452{
453 *pNesting = *pSave;
454}
455
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700456
Laurence Lundblade02625d42020-06-25 14:41:41 -0700457static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700458DecodeNesting_GetEndOfBstr(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700459{
460 return pMe->pCurrentBounded->u.bs.uEndOfBstr;
461}
462
463
Laurence Lundblade02625d42020-06-25 14:41:41 -0700464static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700465DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700466{
467 return pMe->pCurrentBounded->u.bs.uPreviousEndOffset;
468}
469
470
Laurence Lundblade02625d42020-06-25 14:41:41 -0700471#include <stdio.h>
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700472
473const char *TypeStr(uint8_t type)
474{
475 switch(type) {
476 case QCBOR_TYPE_MAP: return " map";
477 case QCBOR_TYPE_ARRAY: return "array";
478 case QCBOR_TYPE_BYTE_STRING: return " bstr";
479 default: return " --- ";
480 }
481}
482
483static char buf[20]; // Not thread safe, but that is OK
484const char *CountString(uint16_t uCount, uint16_t uTotal)
485{
486 if(uTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
487 strcpy(buf, "indefinite");
488 } else {
489 sprintf(buf, "%d/%d", uCount, uTotal);
490 }
491 return buf;
492}
493
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700494
Laurence Lundblade02625d42020-06-25 14:41:41 -0700495void DecodeNesting_Print(QCBORDecodeNesting *pNesting, UsefulInputBuf *pBuf, const char *szName)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700496{
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700497#if 0
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700498 printf("---%s--%d/%d--\narrow is current bounded level\n",
Laurence Lundblade02625d42020-06-25 14:41:41 -0700499 szName,
500 (uint32_t)pBuf->cursor,
501 (uint32_t)pBuf->UB.len);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700502
503 printf("Level Type Count Offsets \n");
Laurence Lundblade02625d42020-06-25 14:41:41 -0700504 for(int i = 0; i < QCBOR_MAX_ARRAY_NESTING; i++) {
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700505 if(&(pNesting->pLevels[i]) > pNesting->pCurrent) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700506 break;
507 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700508
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700509 printf("%2s %2d %s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700510 pNesting->pCurrentBounded == &(pNesting->pLevels[i]) ? "->": " ",
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700511 i,
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700512 TypeStr(pNesting->pLevels[i].uLevelType));
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700513
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700514 if(pNesting->pLevels[i].uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700515 printf(" %5d %5d",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700516 pNesting->pLevels[i].u.bs.uEndOfBstr,
517 pNesting->pLevels[i].u.bs.uPreviousEndOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700518
519 } else {
520 printf("%10.10s ",
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700521 CountString(pNesting->pLevels[i].u.ma.uCountCursor,
522 pNesting->pLevels[i].u.ma.uCountTotal));
523 if(pNesting->pLevels[i].u.ma.uStartOffset != UINT32_MAX) {
524 printf("Bounded start: %u",pNesting->pLevels[i].u.ma.uStartOffset);
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700525 }
526 }
527
528 printf("\n");
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700529 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700530 printf("\n");
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -0700531#endif
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700532}
533
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700534
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700535
Laurence Lundbladeee851742020-01-08 08:37:05 -0800536/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800537 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
538
539 The following four functions are pretty wrappers for invocation of
540 the string allocator supplied by the caller.
541
Laurence Lundbladeee851742020-01-08 08:37:05 -0800542 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543
Laurence Lundbladeee851742020-01-08 08:37:05 -0800544static inline void
545StringAllocator_Free(const QCORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800546{
547 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
548}
549
Laurence Lundbladeee851742020-01-08 08:37:05 -0800550// StringAllocator_Reallocate called with pMem NULL is
551// equal to StringAllocator_Allocate()
552static inline UsefulBuf
553StringAllocator_Reallocate(const QCORInternalAllocator *pMe,
554 void *pMem,
555 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800556{
557 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
558}
559
Laurence Lundbladeee851742020-01-08 08:37:05 -0800560static inline UsefulBuf
561StringAllocator_Allocate(const QCORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800562{
563 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
564}
565
Laurence Lundbladeee851742020-01-08 08:37:05 -0800566static inline void
567StringAllocator_Destruct(const QCORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800568{
569 if(pMe->pfAllocator) {
570 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
571 }
572}
573
574
575
Laurence Lundbladeee851742020-01-08 08:37:05 -0800576/*===========================================================================
577 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800579 See qcbor/qcbor_decode.h for definition of the object
580 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800581 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700582/*
583 Public function, see header file
584 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800585void QCBORDecode_Init(QCBORDecodeContext *me,
586 UsefulBufC EncodedCBOR,
587 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700588{
589 memset(me, 0, sizeof(QCBORDecodeContext));
590 UsefulInputBuf_Init(&(me->InBuf), EncodedCBOR);
Laurence Lundbladeee851742020-01-08 08:37:05 -0800591 // Don't bother with error check on decode mode. If a bad value is
592 // passed it will just act as if the default normal mode of 0 was set.
Laurence Lundbladee6bcef12020-04-01 10:56:27 -0700593 me->uDecodeMode = (uint8_t)nDecodeMode;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700594 DecodeNesting_Init(&(me->nesting));
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700595 for(int i = 0; i < QCBOR_NUM_MAPPED_TAGS; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -0700596 me->auMappedTags[i] = CBOR_TAG_INVALID16;
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700597 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700598}
599
600
601/*
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700602 Public function, see header file
603 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800604void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
605 QCBORStringAllocate pfAllocateFunction,
606 void *pAllocateContext,
607 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700608{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800609 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
610 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
611 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700612}
613
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800614
615/*
616 Public function, see header file
617 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700618void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800619 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700620{
Laurence Lundblade830fbf92020-05-31 17:22:33 -0700621 // This does nothing now. It is retained for backwards compatibility
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700622 (void)pMe;
623 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700624}
625
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700626
627/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800628 This decodes the fundamental part of a CBOR data item, the type and
629 number
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800630
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700631 This is the Counterpart to InsertEncodedTypeAndNumber().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800632
Laurence Lundbladeee851742020-01-08 08:37:05 -0800633 This does the network->host byte order conversion. The conversion
634 here also results in the conversion for floats in addition to that
635 for lengths, tags and integer values.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800636
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700637 This returns:
638 pnMajorType -- the major type for the item
Laurence Lundbladeee851742020-01-08 08:37:05 -0800639
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800640 puArgument -- the "number" which is used a the value for integers,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800641 tags and floats and length for strings and arrays
642
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800643 pnAdditionalInfo -- Pass this along to know what kind of float or
Laurence Lundbladeee851742020-01-08 08:37:05 -0800644 if length is indefinite
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800645
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800646 The int type is preferred to uint8_t for some variables as this
647 avoids integer promotions, can reduce code size and makes
648 static analyzers happier.
Laurence Lundblade9b334962020-08-27 10:55:53 -0700649
650 @retval QCBOR_ERR_UNSUPPORTED
651
652 @retval QCBOR_ERR_HIT_END
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700653 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800654inline static QCBORError DecodeTypeAndNumber(UsefulInputBuf *pUInBuf,
655 int *pnMajorType,
656 uint64_t *puArgument,
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800657 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700658{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700659 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800660
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700661 // Get the initial byte that every CBOR data item has
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800662 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800663
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700664 // Break down the initial byte
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800665 const int nTmpMajorType = nInitialByte >> 5;
666 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800667
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800668 // Where the number or argument accumulates
669 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800670
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800671 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700672 // Need to get 1,2,4 or 8 additional argument bytes. Map
673 // LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800674 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800675
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800676 // Loop getting all the bytes in the argument
677 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800678 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800679 // This shift and add gives the endian conversion
680 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
681 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800682 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800683 // The reserved and thus-far unused additional info values
684 nReturn = QCBOR_ERR_UNSUPPORTED;
685 goto Done;
686 } else {
687 // Less than 24, additional info is argument or 31, an indefinite length
688 // No more bytes to get
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800689 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700690 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800691
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700692 if(UsefulInputBuf_GetError(pUInBuf)) {
693 nReturn = QCBOR_ERR_HIT_END;
694 goto Done;
695 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800696
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700697 // All successful if we got here.
698 nReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800699 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800700 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800701 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800702
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700703Done:
704 return nReturn;
705}
706
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800707
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700708/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800709 CBOR doesn't explicitly specify two's compliment for integers but all
710 CPUs use it these days and the test vectors in the RFC are so. All
711 integers in the CBOR structure are positive and the major type
712 indicates positive or negative. CBOR can express positive integers
713 up to 2^x - 1 where x is the number of bits and negative integers
714 down to 2^x. Note that negative numbers can be one more away from
715 zero than positive. Stdint, as far as I can tell, uses two's
716 compliment to represent negative integers.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800717
Laurence Lundblade9b334962020-08-27 10:55:53 -0700718 See http://www.unix.org/whitepapers/64bit.html for reasons int is
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800719 used carefully here, and in particular why it isn't used in the interface.
720 Also see
721 https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
722
723 Int is used for values that need less than 16-bits and would be subject
724 to integer promotion and complaining by static analyzers.
Laurence Lundblade9b334962020-08-27 10:55:53 -0700725
726 @retval QCBOR_ERR_INT_OVERFLOW
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700727 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800728inline static QCBORError
729DecodeInteger(int nMajorType, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700730{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700731 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800732
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700733 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
734 if (uNumber <= INT64_MAX) {
735 pDecodedItem->val.int64 = (int64_t)uNumber;
736 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800737
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700738 } else {
739 pDecodedItem->val.uint64 = uNumber;
740 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800741
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742 }
743 } else {
744 if(uNumber <= INT64_MAX) {
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800745 // CBOR's representation of negative numbers lines up with the
746 // two-compliment representation. A negative integer has one
747 // more in range than a positive integer. INT64_MIN is
748 // equal to (-INT64_MAX) - 1.
749 pDecodedItem->val.int64 = (-(int64_t)uNumber) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700750 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800751
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700752 } else {
753 // C can't represent a negative integer in this range
Laurence Lundblade21d1d812019-09-28 22:47:49 -1000754 // so it is an error.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700755 nReturn = QCBOR_ERR_INT_OVERFLOW;
756 }
757 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800758
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700759 return nReturn;
760}
761
762// Make sure #define value line up as DecodeSimple counts on this.
763#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
764#error QCBOR_TYPE_FALSE macro value wrong
765#endif
766
767#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
768#error QCBOR_TYPE_TRUE macro value wrong
769#endif
770
771#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
772#error QCBOR_TYPE_NULL macro value wrong
773#endif
774
775#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
776#error QCBOR_TYPE_UNDEF macro value wrong
777#endif
778
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700779#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
780#error QCBOR_TYPE_BREAK macro value wrong
781#endif
782
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700783#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
784#error QCBOR_TYPE_DOUBLE macro value wrong
785#endif
786
787#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
788#error QCBOR_TYPE_FLOAT macro value wrong
789#endif
790
791/*
792 Decode true, false, floats, break...
Laurence Lundblade9b334962020-08-27 10:55:53 -0700793
794 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
795
796 @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700797 */
Laurence Lundbladeee851742020-01-08 08:37:05 -0800798inline static QCBORError
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800799DecodeSimple(int nAdditionalInfo, uint64_t uNumber, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700800{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700801 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800802
Laurence Lundbladeee851742020-01-08 08:37:05 -0800803 // uAdditionalInfo is 5 bits from the initial byte compile time checks
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800804 // above make sure uAdditionalInfo values line up with uDataType values.
805 // DecodeTypeAndNumber never returns a major type > 1f so cast is safe
806 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800807
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800808 switch(nAdditionalInfo) {
Laurence Lundbladeee851742020-01-08 08:37:05 -0800809 // No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they are
810 // caught before this is called.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800811
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700812 case HALF_PREC_FLOAT:
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700813#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700814 // Half-precision is returned as a double.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -0700815 // The cast to uint16_t is safe because the encoded value
Laurence Lundblade9682a532020-06-06 18:33:04 -0700816 // was 16 bits. It was widened to 64 bits to be passed in here.
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700817 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uNumber);
818 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700819#else
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700820 nReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700821#endif
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700822 break;
Laurence Lundbladecc2ed342018-09-22 17:29:55 -0700823 case SINGLE_PREC_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700824 // Single precision is normally returned as a double
825 // since double is widely supported, there is no loss of
826 // precision, it makes it easy for the caller in
827 // most cases and it can be converted back to single
828 // with no loss of precision
829 //
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -0700830 // The cast to uint32_t is safe because the encoded value
Laurence Lundblade8fa7d5d2020-07-11 16:30:47 -0700831 // was 32 bits. It was widened to 64 bits to be passed in here.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700832 {
833 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uNumber);
834#ifndef QCBOR_DISABLE_FLOAT_HW_USE
835 // In the normal case, use HW to convert float to double.
836 pDecodedItem->val.dfnum = (double)f;
837 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade9682a532020-06-06 18:33:04 -0700838#else
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700839 // Use of float HW is disabled, return as a float.
840 pDecodedItem->val.fnum = f;
841 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
842
843 // IEEE754_FloatToDouble() could be used here to return
844 // as a double, but it adds object code and most likely
845 // anyone disabling FLOAT HW use doesn't care about
846 // floats and wants to save object code.
Laurence Lundblade9682a532020-06-06 18:33:04 -0700847#endif
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700848 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700849 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700850
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700851 case DOUBLE_PREC_FLOAT:
852 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uNumber);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700853 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700854 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800855
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700856 case CBOR_SIMPLEV_FALSE: // 20
857 case CBOR_SIMPLEV_TRUE: // 21
858 case CBOR_SIMPLEV_NULL: // 22
859 case CBOR_SIMPLEV_UNDEF: // 23
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700860 case CBOR_SIMPLE_BREAK: // 31
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700861 break; // nothing to do
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800862
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700863 case CBOR_SIMPLEV_ONEBYTE: // 24
864 if(uNumber <= CBOR_SIMPLE_BREAK) {
865 // This takes out f8 00 ... f8 1f which should be encoded as e0 … f7
Laurence Lundblade077475f2019-04-26 09:06:33 -0700866 nReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700867 goto Done;
868 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800869 /* FALLTHROUGH */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700870 // fall through intentionally
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800871
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700872 default: // 0-19
873 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundbladeee851742020-01-08 08:37:05 -0800874 /*
875 DecodeTypeAndNumber will make uNumber equal to
876 uAdditionalInfo when uAdditionalInfo is < 24 This cast is
877 safe because the 2, 4 and 8 byte lengths of uNumber are in
878 the double/float cases above
879 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700880 pDecodedItem->val.uSimple = (uint8_t)uNumber;
881 break;
882 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800883
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700884Done:
885 return nReturn;
886}
887
888
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700889/*
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530890 Decode text and byte strings. Call the string allocator if asked to.
Laurence Lundblade9b334962020-08-27 10:55:53 -0700891
892 @retval QCBOR_ERR_HIT_END
893
894 @retval QCBOR_ERR_STRING_ALLOCATE
895
896 @retval QCBOR_ERR_STRING_TOO_LONG
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700897 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800898inline static QCBORError DecodeBytes(const QCORInternalAllocator *pAllocator,
899 int nMajorType,
900 uint64_t uStrLen,
901 UsefulInputBuf *pUInBuf,
902 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700903{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700904 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800905
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800906 // CBOR lengths can be 64 bits, but size_t is not 64 bits on all CPUs.
907 // This check makes the casts to size_t below safe.
908
909 // 4 bytes less than the largest sizeof() so this can be tested by
910 // putting a SIZE_MAX length in the CBOR test input (no one will
911 // care the limit on strings is 4 bytes shorter).
912 if(uStrLen > SIZE_MAX-4) {
913 nReturn = QCBOR_ERR_STRING_TOO_LONG;
914 goto Done;
915 }
916
917 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530918 if(UsefulBuf_IsNULLC(Bytes)) {
919 // Failed to get the bytes for this string item
920 nReturn = QCBOR_ERR_HIT_END;
921 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700922 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530923
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800924 if(pAllocator) {
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530925 // We are asked to use string allocator to make a copy
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800926 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530927 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +0700928 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530929 goto Done;
930 }
931 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800932 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530933 } else {
934 // Normal case with no string allocator
935 pDecodedItem->val.string = Bytes;
936 }
Laurence Lundbladeee851742020-01-08 08:37:05 -0800937 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800938 // Cast because ternary operator causes promotion to integer
939 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
940 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800941
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530942Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700943 return nReturn;
944}
945
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700946
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800947
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700948
949
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700950
951
Laurence Lundbladeee851742020-01-08 08:37:05 -0800952// Make sure the constants align as this is assumed by
953// the GetAnItem() implementation
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700954#if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
955#error QCBOR_TYPE_ARRAY value not lined up with major type
956#endif
957#if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
958#error QCBOR_TYPE_MAP value not lined up with major type
959#endif
960
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700961/*
Laurence Lundbladeee851742020-01-08 08:37:05 -0800962 This gets a single data item and decodes it including preceding
963 optional tagging. This does not deal with arrays and maps and nesting
964 except to decode the data item introducing them. Arrays and maps are
965 handled at the next level up in GetNext().
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800966
Laurence Lundbladeee851742020-01-08 08:37:05 -0800967 Errors detected here include: an array that is too long to decode,
968 hit end of buffer unexpectedly, a few forms of invalid encoded CBOR
Laurence Lundblade9b334962020-08-27 10:55:53 -0700969
970 @retval QCBOR_ERR_UNSUPPORTED
971
972 @retval QCBOR_ERR_HIT_END
973
974 @retval QCBOR_ERR_INT_OVERFLOW
975
976 @retval QCBOR_ERR_STRING_ALLOCATE
977
978 @retval QCBOR_ERR_STRING_TOO_LONG
979
980 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
981
982 @retval QCBOR_ERR_BAD_TYPE_7
983
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700984 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800985static QCBORError GetNext_Item(UsefulInputBuf *pUInBuf,
986 QCBORItem *pDecodedItem,
987 const QCORInternalAllocator *pAllocator)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700988{
Laurence Lundblade30816f22018-11-10 13:40:22 +0700989 QCBORError nReturn;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800990
Laurence Lundbladeee851742020-01-08 08:37:05 -0800991 /*
992 Get the major type and the number. Number could be length of more
993 bytes or the value depending on the major type nAdditionalInfo is
994 an encoding of the length of the uNumber and is needed to decode
995 floats and doubles
996 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800997 int nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700998 uint64_t uNumber;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800999 int nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001000
Laurence Lundblade4b09f632019-10-09 14:34:59 -07001001 memset(pDecodedItem, 0, sizeof(QCBORItem));
1002
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001003 nReturn = DecodeTypeAndNumber(pUInBuf, &nMajorType, &uNumber, &nAdditionalInfo);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001004
Laurence Lundbladeee851742020-01-08 08:37:05 -08001005 // Error out here if we got into trouble on the type and number. The
1006 // code after this will not work if the type and number is not good.
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001007 if(nReturn) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001008 goto Done;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001009 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001010
Laurence Lundbladeee851742020-01-08 08:37:05 -08001011 // At this point the major type and the value are valid. We've got
1012 // the type and the number that starts every CBOR data item.
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001013 switch (nMajorType) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001014 case CBOR_MAJOR_TYPE_POSITIVE_INT: // Major type 0
1015 case CBOR_MAJOR_TYPE_NEGATIVE_INT: // Major type 1
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001016 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001017 nReturn = QCBOR_ERR_BAD_INT;
1018 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001019 nReturn = DecodeInteger(nMajorType, uNumber, pDecodedItem);
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001020 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001021 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001022
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001023 case CBOR_MAJOR_TYPE_BYTE_STRING: // Major type 2
1024 case CBOR_MAJOR_TYPE_TEXT_STRING: // Major type 3
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001025 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1026 const bool bIsBstr = (nMajorType == CBOR_MAJOR_TYPE_BYTE_STRING);
1027 pDecodedItem->uDataType = (uint8_t)(bIsBstr ? QCBOR_TYPE_BYTE_STRING
1028 : QCBOR_TYPE_TEXT_STRING);
Laurence Lundbladea44d5062018-10-17 18:45:12 +05301029 pDecodedItem->val.string = (UsefulBufC){NULL, SIZE_MAX};
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001030 } else {
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001031 nReturn = DecodeBytes(pAllocator, nMajorType, uNumber, pUInBuf, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001032 }
1033 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001034
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001035 case CBOR_MAJOR_TYPE_ARRAY: // Major type 4
1036 case CBOR_MAJOR_TYPE_MAP: // Major type 5
1037 // Record the number of items in the array or map
1038 if(uNumber > QCBOR_MAX_ITEMS_IN_ARRAY) {
1039 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
1040 goto Done;
1041 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001042 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001043 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001044 } else {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001045 // type conversion OK because of check above
1046 pDecodedItem->val.uCount = (uint16_t)uNumber;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001047 }
Laurence Lundbladeee851742020-01-08 08:37:05 -08001048 // C preproc #if above makes sure constants for major types align
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001049 // DecodeTypeAndNumber never returns a major type > 7 so cast is safe
1050 pDecodedItem->uDataType = (uint8_t)nMajorType;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001051 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001052
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001053 case CBOR_MAJOR_TYPE_OPTIONAL: // Major type 6, optional prepended tags
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001054 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001055 nReturn = QCBOR_ERR_BAD_INT;
1056 } else {
1057 pDecodedItem->val.uTagV = uNumber;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001058 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001059 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001060 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001061
Laurence Lundbladeee851742020-01-08 08:37:05 -08001062 case CBOR_MAJOR_TYPE_SIMPLE:
1063 // Major type 7, float, double, true, false, null...
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001064 nReturn = DecodeSimple(nAdditionalInfo, uNumber, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001065 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001066
Laurence Lundbladeee851742020-01-08 08:37:05 -08001067 default:
1068 // Never happens because DecodeTypeAndNumber() should never return > 7
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001069 nReturn = QCBOR_ERR_UNSUPPORTED;
1070 break;
1071 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001072
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001073Done:
1074 return nReturn;
1075}
1076
1077
1078
1079/*
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001080 This layer deals with indefinite length strings. It pulls all the
Laurence Lundbladeee851742020-01-08 08:37:05 -08001081 individual chunk items together into one QCBORItem using the string
1082 allocator.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001083
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301084 Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade9b334962020-08-27 10:55:53 -07001085
1086 @retval QCBOR_ERR_UNSUPPORTED
1087
1088 @retval QCBOR_ERR_HIT_END
1089
1090 @retval QCBOR_ERR_INT_OVERFLOW
1091
1092 @retval QCBOR_ERR_STRING_ALLOCATE
1093
1094 @retval QCBOR_ERR_STRING_TOO_LONG
1095
1096 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1097
1098 @retval QCBOR_ERR_BAD_TYPE_7
1099
1100 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1101
1102 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001103 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001104static inline QCBORError
1105GetNext_FullItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001106{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001107 // Stack usage; int/ptr 2 UsefulBuf 2 QCBORItem -- 96
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001108
1109 // Get pointer to string allocator. First use is to pass it to
1110 // GetNext_Item() when option is set to allocate for *every* string.
1111 // Second use here is to allocate space to coallese indefinite
1112 // length string items into one.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001113 const QCORInternalAllocator *pAllocator = me->StringAllocator.pfAllocator ?
1114 &(me->StringAllocator) :
1115 NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001116
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001117 QCBORError nReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001118 nReturn = GetNext_Item(&(me->InBuf),
1119 pDecodedItem,
1120 me->bStringAllocateAll ? pAllocator: NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001121 if(nReturn) {
1122 goto Done;
1123 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001124
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001125 // To reduce code size by removing support for indefinite length strings, the
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301126 // code in this function from here down can be eliminated. Run tests, except
1127 // indefinite length string tests, to be sure all is OK if this is removed.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001128
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001129 // Only do indefinite length processing on strings
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001130 const uint8_t uStringType = pDecodedItem->uDataType;
1131 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001132 goto Done; // no need to do any work here on non-string types
1133 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001134
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001135 // Is this a string with an indefinite length?
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301136 if(pDecodedItem->val.string.len != SIZE_MAX) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001137 goto Done; // length is not indefinite, so no work to do here
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001138 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001139
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301140 // Can't do indefinite length strings without a string allocator
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001141 if(pAllocator == NULL) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001142 nReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1143 goto Done;
1144 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001145
Laurence Lundblade4b270642020-08-14 12:53:07 -07001146 // Loop getting chunks of the indefinite length string
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001147 UsefulBufC FullString = NULLUsefulBufC;
1148
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001149 for(;;) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001150 // Get item for next chunk
1151 QCBORItem StringChunkItem;
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001152 // NULL string allocator passed here. Do not need to allocate
1153 // chunks even if bStringAllocateAll is set.
Laurence Lundbladefae26bf2019-02-18 11:15:43 -08001154 nReturn = GetNext_Item(&(me->InBuf), &StringChunkItem, NULL);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001155 if(nReturn) {
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001156 break; // Error getting the next chunk
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001157 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001158
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301159 // See if it is a marker at end of indefinite length string
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001160 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001161 // String is complete
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001162 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301163 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001164 break;
1165 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001166
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001167 // Match data type of chunk to type at beginning.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301168 // Also catches error of other non-string types that don't belong.
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001169 // Also catches indefinite length strings inside indefinite length strings
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001170 if(StringChunkItem.uDataType != uStringType ||
1171 StringChunkItem.val.string.len == SIZE_MAX) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07001172 nReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001173 break;
1174 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001175
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301176 // Alloc new buffer or expand previously allocated buffer so it can fit
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001177 // The first time throurgh FullString.ptr is NULL and this is
1178 // equivalent to StringAllocator_Allocate()
1179 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1180 UNCONST_POINTER(FullString.ptr),
1181 FullString.len + StringChunkItem.val.string.len);
1182
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001183 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301184 // Allocation of memory for the string failed
Laurence Lundblade30816f22018-11-10 13:40:22 +07001185 nReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001186 break;
1187 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001188
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001189 // Copy new string chunk at the end of string so far.
1190 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001191 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001192
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001193 if(nReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1194 // Getting the item failed, clean up the allocated memory
1195 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001196 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001197
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001198Done:
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001199 return nReturn;
1200}
1201
Laurence Lundblade9b334962020-08-27 10:55:53 -07001202static uint64_t ConvertTag(const QCBORDecodeContext *me, uint16_t uTagVal) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001203 if(uTagVal <= QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001204 return uTagVal;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001205 } else if(uTagVal == CBOR_TAG_INVALID16) {
1206 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001207 } else {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001208 const int x = uTagVal - (QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001209 return me->auMappedTags[x];
1210 }
1211}
1212
Laurence Lundblade9b334962020-08-27 10:55:53 -07001213
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001214/*
Laurence Lundblade59289e52019-12-30 13:44:37 -08001215 Gets all optional tag data items preceding a data item that is not an
1216 optional tag and records them as bits in the tag map.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001217
1218 @retval QCBOR_ERR_UNSUPPORTED
1219
1220 @retval QCBOR_ERR_HIT_END
1221
1222 @retval QCBOR_ERR_INT_OVERFLOW
1223
1224 @retval QCBOR_ERR_STRING_ALLOCATE
1225
1226 @retval QCBOR_ERR_STRING_TOO_LONG
1227
1228 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1229
1230 @retval QCBOR_ERR_BAD_TYPE_7
1231
1232 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1233
1234 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1235
1236 @retval QCBOR_ERR_TOO_MANY_TAGS
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001237 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001238static QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001239GetNext_TaggedItem(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001240{
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001241 uint16_t auTags[QCBOR_MAX_TAGS_PER_ITEM] = {CBOR_TAG_INVALID16,
1242 CBOR_TAG_INVALID16,
1243 CBOR_TAG_INVALID16,
1244 CBOR_TAG_INVALID16};
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001245
Laurence Lundblade9b334962020-08-27 10:55:53 -07001246 QCBORError uReturn = QCBOR_SUCCESS;
1247
Laurence Lundblade59289e52019-12-30 13:44:37 -08001248 // Loop fetching items until the item fetched is not a tag
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001249 for(;;) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001250 QCBORError uErr = GetNext_FullItem(me, pDecodedItem);
1251 if(uErr != QCBOR_SUCCESS) {
1252 uReturn = uErr;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001253 goto Done; // Error out of the loop
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001254 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001255
Laurence Lundblade9b334962020-08-27 10:55:53 -07001256 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001257 // Successful exit from loop; maybe got some tags, maybe not
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001258 memcpy(pDecodedItem->uTags, auTags, sizeof(auTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001259 break;
1260 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001261
Laurence Lundblade9b334962020-08-27 10:55:53 -07001262 if(auTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1263 // No room in the tag list
1264 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
1265 // Continue on to get all tags on this item even though
1266 // it is erroring out in the end. This is a resource limit
1267 // error, not an problem with being well-formed CBOR.
1268 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001269 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001270 // Slide tags over one in the array to make room at index 0
1271 for(size_t uTagIndex = QCBOR_MAX_TAGS_PER_ITEM - 1; uTagIndex > 0; uTagIndex--) {
1272 auTags[uTagIndex] = auTags[uTagIndex-1];
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001273 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001274
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001275 // Is the tag > 16 bits?
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001276 if(pDecodedItem->val.uTagV > QCBOR_LAST_UNMAPPED_TAG) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001277 size_t uTagMapIndex;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001278 // Is there room in the tag map, or is it in it already?
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001279 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07001280 if(me->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001281 break;
1282 }
1283 if(me->auMappedTags[uTagMapIndex] == pDecodedItem->val.uTagV) {
1284 break;
1285 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001286 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001287 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1288 // No room for the tag
Laurence Lundblade9b334962020-08-27 10:55:53 -07001289 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
1290 // Continue on to get all tags on this item even though
1291 // it is erroring out in the end. This is a resource limit
1292 // error, not an problem with being well-formed CBOR.
1293 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001294 }
1295
Laurence Lundblade410c7e02020-06-25 23:35:29 -07001296 // Covers the cases where tag is new and were it is already in the map
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001297 me->auMappedTags[uTagMapIndex] = pDecodedItem->val.uTagV;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001298 auTags[0] = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001299
1300 } else {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001301 auTags[0] = (uint16_t)pDecodedItem->val.uTagV;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001302 }
1303 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001304
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001305Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001306 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001307}
1308
1309
1310/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001311 This layer takes care of map entries. It combines the label and data
1312 items into one QCBORItem.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001313
1314 @retval QCBOR_ERR_UNSUPPORTED
1315
1316 @retval QCBOR_ERR_HIT_END
1317
1318 @retval QCBOR_ERR_INT_OVERFLOW
1319
1320 @retval QCBOR_ERR_STRING_ALLOCATE
1321
1322 @retval QCBOR_ERR_STRING_TOO_LONG
1323
1324 @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1325
1326 @retval QCBOR_ERR_BAD_TYPE_7
1327
1328 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1329
1330 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1331
1332 @retval QCBOR_ERR_TOO_MANY_TAGS
1333
1334 @retval QCBOR_ERR_MAP_LABEL_TYPE
1335
1336 @retval QCBOR_ERR_ARRAY_TOO_LONG
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001337 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001338static inline QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001339GetNext_MapEntry(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001340{
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001341 // Stack use: int/ptr 1, QCBORItem -- 56
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001342 QCBORError nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001343 if(nReturn)
1344 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001345
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001346 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001347 // Break can't be a map entry
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001348 goto Done;
1349 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001350
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001351 if(me->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1352 // In a map and caller wants maps decoded, not treated as arrays
1353
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001354 if(DecodeNesting_IsCurrentTypeMap(&(me->nesting))) {
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001355 // If in a map and the right decoding mode, get the label
1356
Laurence Lundbladeee851742020-01-08 08:37:05 -08001357 // Save label in pDecodedItem and get the next which will
1358 // be the real data
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001359 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001360 nReturn = GetNext_TaggedItem(me, pDecodedItem);
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001361 if(nReturn)
1362 goto Done;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001363
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301364 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001365
1366 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
1367 // strings are always good labels
1368 pDecodedItem->label.string = LabelItem.val.string;
1369 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
1370 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == me->uDecodeMode) {
Laurence Lundbladeee851742020-01-08 08:37:05 -08001371 // It's not a string and we only want strings
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001372 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1373 goto Done;
1374 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1375 pDecodedItem->label.int64 = LabelItem.val.int64;
1376 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1377 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1378 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1379 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1380 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1381 pDecodedItem->label.string = LabelItem.val.string;
1382 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1383 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1384 } else {
1385 // label is not an int or a string. It is an arrray
1386 // or a float or such and this implementation doesn't handle that.
1387 // Also, tags on labels are ignored.
1388 nReturn = QCBOR_ERR_MAP_LABEL_TYPE;
1389 goto Done;
1390 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001391 }
1392 } else {
1393 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001394 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
1395 nReturn = QCBOR_ERR_ARRAY_TOO_LONG;
1396 goto Done;
1397 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001398 // Decoding a map as an array
1399 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001400 // Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2
1401 // Cast is needed because of integer promotion
1402 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001403 }
1404 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001405
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001406Done:
1407 return nReturn;
1408}
1409
1410
Laurence Lundblade02625d42020-06-25 14:41:41 -07001411/*
1412 See if next item is a CBOR break. If it is, it is consumed,
1413 if not it is not consumed.
1414*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001415static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001416NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1417{
1418 *pbNextIsBreak = false;
1419 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001420 QCBORItem Peek;
1421 size_t uPeek = UsefulInputBuf_Tell(pUIB);
1422 QCBORError uReturn = GetNext_Item(pUIB, &Peek, NULL);
1423 if(uReturn != QCBOR_SUCCESS) {
1424 return uReturn;
1425 }
1426 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001427 // It is not a break, rewind so it can be processed normally.
1428 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001429 } else {
1430 *pbNextIsBreak = true;
1431 }
1432 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001433
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001434 return QCBOR_SUCCESS;
1435}
1436
1437
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001438/*
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001439 An item was just consumed, now figure out if it was the
1440 end of an array or map that can be closed out. That
1441 may in turn close out another map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001442*/
Laurence Lundbladed0304932020-06-27 10:59:38 -07001443static QCBORError NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001444{
1445 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001446
Laurence Lundblade642282a2020-06-23 12:00:33 -07001447 /* This loops ascending nesting levels as long as there is ascending to do */
1448 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1449
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001450 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001451 /* Decrement count for definite length maps / arrays */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001452 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1453 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001454 /* Didn't close out map or array, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001455 break;
1456 }
Laurence Lundblade02625d42020-06-25 14:41:41 -07001457 /* All of a definite length array was consumed; fall through to ascend */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001458
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001459 } else {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001460 /* If not definite length, have to check for a CBOR break */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001461 bool bIsBreak = false;
1462 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1463 if(uReturn != QCBOR_SUCCESS) {
1464 goto Done;
1465 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001466
1467 if(!bIsBreak) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001468 /* It's not a break so nothing closes out and all work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001469 break;
1470 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001471
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001472 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001473 /*
1474 Break occurred inside a bstr-wrapped CBOR or
1475 in the top level sequence. This is always an
1476 error because neither are an indefinte length
1477 map/array.
1478 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001479 uReturn = QCBOR_ERR_BAD_BREAK;
1480 goto Done;
1481 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001482
Laurence Lundblade02625d42020-06-25 14:41:41 -07001483 /* It was a break in an indefinite length map / array */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001484 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001485
Laurence Lundblade02625d42020-06-25 14:41:41 -07001486 /* All items in the map/array level have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001487
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001488 /* But ascent in bounded mode is only by explicit call to QCBORDecode_ExitBoundedMode() */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001489 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001490 /* 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 -07001491 if(bMarkEnd) {
1492 // Used for definite and indefinite to signal end
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001493 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001494
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001495 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001496 break;
1497 }
1498
1499 /* Finally, actually ascend one level. */
1500 DecodeNesting_Ascend(&(pMe->nesting));
1501 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001502
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001503 uReturn = QCBOR_SUCCESS;
1504
1505Done:
1506 return uReturn;
1507}
1508
1509
1510/*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001511 This handles the traversal descending into and asecnding out of maps,
Laurence Lundblade642282a2020-06-23 12:00:33 -07001512 arrays and bstr-wrapped CBOR. It figures out the ends of definite and
1513 indefinte length maps and arrays by looking at the item count or
1514 finding CBOR breaks. It detects the ends of the top-level sequence
1515 and of bstr-wrapped CBOR by byte count.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001516
1517 @retval QCBOR_ERR_UNSUPPORTED X
1518
1519 @retval QCBOR_ERR_HIT_END
1520
1521 @retval QCBOR_ERR_INT_OVERFLOW X
1522
1523 @retval QCBOR_ERR_STRING_ALLOCATE
1524
1525 @retval QCBOR_ERR_STRING_TOO_LONG
1526
1527 @retval QCBOR_ERR_HALF_PRECISION_DISABLED X
1528
1529 @retval QCBOR_ERR_BAD_TYPE_7 X
1530
1531 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1532
1533 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1534
1535 @retval QCBOR_ERR_TOO_MANY_TAGS
1536
1537 @retval QCBOR_ERR_MAP_LABEL_TYPE X
1538
1539 @retval QCBOR_ERR_ARRAY_TOO_LONG
1540
1541 @retval QCBOR_ERR_NO_MORE_ITEMS
1542
1543 @retval QCBOR_ERR_BAD_BREAK
1544
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001545 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001546static QCBORError
1547QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001548{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001549 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001550 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001551
Laurence Lundblade642282a2020-06-23 12:00:33 -07001552 /*
1553 If out of bytes to consume, it is either the end of the top-level
1554 sequence of some bstr-wrapped CBOR that was entered.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001555
Laurence Lundblade642282a2020-06-23 12:00:33 -07001556 In the case of bstr-wrapped CBOR, the length of the UsefulInputBuf
1557 was set to that of the bstr-wrapped CBOR. When the bstr-wrapped
1558 CBOR is exited, the length is set back to the top-level's length
1559 or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001560 */
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001561 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001562 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001563 goto Done;
1564 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001565
Laurence Lundblade642282a2020-06-23 12:00:33 -07001566 /*
1567 Check to see if at the end of a bounded definite length map or
Laurence Lundblade02625d42020-06-25 14:41:41 -07001568 array. The check for the end of an indefinite length array is
1569 later.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001570 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001571 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001572 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001573 goto Done;
1574 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001575
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001576 /* ==== Next: not at the end so get another item ==== */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001577 uReturn = GetNext_MapEntry(me, pDecodedItem);
1578 if(uReturn) {
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001579 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001580 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301581
Laurence Lundblade642282a2020-06-23 12:00:33 -07001582 /*
1583 Breaks ending arrays/maps are always processed at the end of this
1584 function. They should never show up here.
1585 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301586 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001587 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301588 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301589 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001590
Laurence Lundblade642282a2020-06-23 12:00:33 -07001591 /*
1592 Record the nesting level for this data item before processing any
1593 of decrementing and descending.
1594 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001595 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001596
Laurence Lundblade642282a2020-06-23 12:00:33 -07001597
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001598 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001599 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001600 /*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001601 If the new item is a map or array, descend.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001602
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001603 Empty indefinite length maps and arrays are descended into, but then ascended out
Laurence Lundblade02625d42020-06-25 14:41:41 -07001604 of in the next chunk of code.
1605
1606 Maps and arrays do count as items in the map/array that
Laurence Lundblade642282a2020-06-23 12:00:33 -07001607 encloses them so a decrement needs to be done for them too, but
1608 that is done only when all the items in them have been
1609 processed, not when they are opened with the exception of an
1610 empty map or array.
1611 */
1612 uReturn = DecodeNesting_DescendMapOrArray(&(me->nesting),
1613 pDecodedItem->uDataType,
1614 pDecodedItem->val.uCount);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001615 if(uReturn != QCBOR_SUCCESS) {
1616 goto Done;
1617 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001618 }
1619
Laurence Lundblade02625d42020-06-25 14:41:41 -07001620 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1621 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1622 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001623 /*
1624 The following cases are handled here:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001625 - A non-aggregate like an integer or string
1626 - An empty definite length map or array
1627 - An indefinite length map or array that might be empty or might not.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001628
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001629 NestLevelAscender() does the work of decrementing the count for an
Laurence Lundblade02625d42020-06-25 14:41:41 -07001630 definite length map/array and break detection for an indefinite
1631 length map/array. If the end of the map/array was reached, then
1632 it ascends nesting levels, possibly all the way to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001633 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001634 uReturn = NestLevelAscender(me, true);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001635 if(uReturn) {
1636 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001637 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301638 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001639
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001640 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001641 /*
Laurence Lundblade02625d42020-06-25 14:41:41 -07001642 Tell the caller what level is next. This tells them what
1643 maps/arrays were closed out and makes it possible for them to
1644 reconstruct the tree with just the information returned in
1645 a QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001646 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001647 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001648 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001649 pDecodedItem->uNextNestLevel = 0;
1650 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001651 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001652 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001653
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001654Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001655 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001656 /* This sets uDataType and uLabelType to QCBOR_TYPE_NONE */
Laurence Lundbladee9482dd2019-10-11 12:58:46 -07001657 memset(pDecodedItem, 0, sizeof(QCBORItem));
1658 }
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001659 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001660}
1661
Laurence Lundblade9b334962020-08-27 10:55:53 -07001662static void ShiftTags(QCBORItem *pDecodedItem)
1663{
1664 pDecodedItem->uTags[0] = pDecodedItem->uTags[1];
1665 pDecodedItem->uTags[1] = pDecodedItem->uTags[2];
1666 pDecodedItem->uTags[2] = pDecodedItem->uTags[3];
1667 pDecodedItem->uTags[2] = CBOR_TAG_INVALID16;
1668}
1669
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001670
Laurence Lundblade59289e52019-12-30 13:44:37 -08001671/*
1672 Mostly just assign the right data type for the date string.
1673 */
1674inline static QCBORError DecodeDateString(QCBORItem *pDecodedItem)
1675{
Laurence Lundblade59289e52019-12-30 13:44:37 -08001676 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1677 return QCBOR_ERR_BAD_OPT_TAG;
1678 }
1679
1680 const UsefulBufC Temp = pDecodedItem->val.string;
1681 pDecodedItem->val.dateString = Temp;
1682 pDecodedItem->uDataType = QCBOR_TYPE_DATE_STRING;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001683 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001684 return QCBOR_SUCCESS;
1685}
1686
1687
Laurence Lundblade9b334962020-08-27 10:55:53 -07001688
Laurence Lundblade59289e52019-12-30 13:44:37 -08001689/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001690 The epoch formatted date. Turns lots of different forms of encoding
1691 date into uniform one
Laurence Lundblade59289e52019-12-30 13:44:37 -08001692 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001693static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001694{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001695 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001696
1697 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1698
1699 switch (pDecodedItem->uDataType) {
1700
1701 case QCBOR_TYPE_INT64:
1702 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1703 break;
1704
1705 case QCBOR_TYPE_UINT64:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001706 // This only happens for CBOR type 0 > INT64_MAX so it is
1707 // always an overflow.
1708 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1709 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001710 break;
1711
1712 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001713 case QCBOR_TYPE_FLOAT:
1714#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001715 {
1716 // This comparison needs to be done as a float before
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001717 // conversion to an int64_t to be able to detect doubles that
1718 // are too large to fit into an int64_t. A double has 52
1719 // bits of preceision. An int64_t has 63. Casting INT64_MAX
1720 // to a double actually causes a round up which is bad and
1721 // wrong for the comparison because it will allow conversion
1722 // of doubles that can't fit into a uint64_t. To remedy this
1723 // INT64_MAX - 0x7ff is used as the cutoff point because if
1724 // that value rounds up in conversion to double it will still
1725 // be less than INT64_MAX. 0x7ff is picked because it has 11
1726 // bits set.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001727 //
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001728 // INT64_MAX seconds is on the order of 10 billion years, and
1729 // the earth is less than 5 billion years old, so for most
1730 // uses this conversion error won't occur even though doubles
1731 // can go much larger.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001732 //
1733 // Without the 0x7ff there is a ~30 minute range of time
1734 // values 10 billion years in the past and in the future
Laurence Lundbladec7114722020-08-13 05:11:40 -07001735 // where this code would go wrong. Some compilers
1736 // will generate warnings or errors without the 0x7ff
1737 // because of the precision issue.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001738 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
1739 pDecodedItem->val.dfnum :
1740 (double)pDecodedItem->val.fnum;
Laurence Lundbladec7114722020-08-13 05:11:40 -07001741 if(isnan(d) ||
1742 d > (double)(INT64_MAX - 0x7ff) ||
1743 d < (double)(INT64_MIN + 0x7ff)) {
1744 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001745 goto Done;
1746 }
1747 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001748 pDecodedItem->val.epochDate.fSecondsFraction =
1749 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001750 }
Laurence Lundblade9682a532020-06-06 18:33:04 -07001751#else
Laurence Lundblade4b270642020-08-14 12:53:07 -07001752
Laurence Lundbladec7114722020-08-13 05:11:40 -07001753 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001754 goto Done;
1755
Laurence Lundblade9682a532020-06-06 18:33:04 -07001756#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001757 break;
1758
1759 default:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001760 uReturn = QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001761 goto Done;
1762 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001763
Laurence Lundblade59289e52019-12-30 13:44:37 -08001764 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1765
1766Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001767 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001768}
1769
1770
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001771/*
1772 Mostly just assign the right data type for the bignum.
1773 */
1774inline static QCBORError DecodeBigNum(QCBORItem *pDecodedItem)
1775{
1776 // Stack Use: UsefulBuf 1 -- 16
1777 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1778 return QCBOR_ERR_BAD_OPT_TAG;
1779 }
1780 const UsefulBufC Temp = pDecodedItem->val.string;
1781 pDecodedItem->val.bigNum = Temp;
1782 const bool bIsPosBigNum = (bool)(pDecodedItem->uTags[0] == CBOR_TAG_POS_BIGNUM);
1783 pDecodedItem->uDataType = (uint8_t)(bIsPosBigNum ? QCBOR_TYPE_POSBIGNUM
1784 : QCBOR_TYPE_NEGBIGNUM);
1785 return QCBOR_SUCCESS;
1786}
1787
1788
Laurence Lundblade59289e52019-12-30 13:44:37 -08001789#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1790/*
1791 Decode decimal fractions and big floats.
1792
1793 When called pDecodedItem must be the array that is tagged as a big
1794 float or decimal fraction, the array that has the two members, the
1795 exponent and mantissa.
1796
1797 This will fetch and decode the exponent and mantissa and put the
1798 result back into pDecodedItem.
1799 */
1800inline static QCBORError
1801QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1802{
1803 QCBORError nReturn;
1804
1805 // --- Make sure it is an array; track nesting level of members ---
1806 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
1807 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1808 goto Done;
1809 }
1810
1811 // A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladeee851742020-01-08 08:37:05 -08001812 // definite length arrays, but not for indefnite. Instead remember
1813 // the nesting level the two integers must be at, which is one
1814 // deeper than that of the array.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001815 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
1816
1817 // --- Is it a decimal fraction or a bigfloat? ---
1818 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
1819 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
1820
1821 // --- Get the exponent ---
1822 QCBORItem exponentItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001823 nReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001824 if(nReturn != QCBOR_SUCCESS) {
1825 goto Done;
1826 }
1827 if(exponentItem.uNestingLevel != nNestLevel) {
1828 // Array is empty or a map/array encountered when expecting an int
1829 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1830 goto Done;
1831 }
1832 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
1833 // Data arriving as an unsigned int < INT64_MAX has been converted
1834 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1835 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1836 // will be too large for this to handle and thus an error that will
1837 // get handled in the next else.
1838 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
1839 } else {
1840 // Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX
1841 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1842 goto Done;
1843 }
1844
1845 // --- Get the mantissa ---
1846 QCBORItem mantissaItem;
1847 nReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
1848 if(nReturn != QCBOR_SUCCESS) {
1849 goto Done;
1850 }
1851 if(mantissaItem.uNestingLevel != nNestLevel) {
1852 // Mantissa missing or map/array encountered when expecting number
1853 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1854 goto Done;
1855 }
1856 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
1857 // Data arriving as an unsigned int < INT64_MAX has been converted
1858 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
1859 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
1860 // will be too large for this to handle and thus an error that
1861 // will get handled in an else below.
1862 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
1863 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM || mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
1864 // Got a good big num mantissa
1865 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
1866 // Depends on numbering of QCBOR_TYPE_XXX
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001867 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
1868 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
1869 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001870 } else {
1871 // Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX
1872 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1873 goto Done;
1874 }
1875
1876 // --- Check that array only has the two numbers ---
1877 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07001878 // Extra items in the decimal fraction / big float
Laurence Lundblade59289e52019-12-30 13:44:37 -08001879 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1880 goto Done;
1881 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07001882 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel; // TODO: make sure this is right
Laurence Lundblade59289e52019-12-30 13:44:37 -08001883
1884Done:
Laurence Lundblade59289e52019-12-30 13:44:37 -08001885 return nReturn;
1886}
1887#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
1888
1889
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001890inline static QCBORError DecodeURI(QCBORItem *pDecodedItem)
1891{
1892 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1893 return QCBOR_ERR_BAD_OPT_TAG;
1894 }
1895 pDecodedItem->uDataType = QCBOR_TYPE_URI;
1896 return QCBOR_SUCCESS;
1897}
1898
1899
1900inline static QCBORError DecodeB64URL(QCBORItem *pDecodedItem)
1901{
1902 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1903 return QCBOR_ERR_BAD_OPT_TAG;
1904 }
1905 pDecodedItem->uDataType = QCBOR_TYPE_BASE64URL;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001906
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001907 return QCBOR_SUCCESS;
1908}
1909
1910
1911inline static QCBORError DecodeB64(QCBORItem *pDecodedItem)
1912{
1913 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1914 return QCBOR_ERR_BAD_OPT_TAG;
1915 }
1916 pDecodedItem->uDataType = QCBOR_TYPE_BASE64;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001917
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001918 return QCBOR_SUCCESS;
1919}
1920
1921
1922inline static QCBORError DecodeRegex(QCBORItem *pDecodedItem)
1923{
1924 if(pDecodedItem->uDataType != QCBOR_TYPE_TEXT_STRING) {
1925 return QCBOR_ERR_BAD_OPT_TAG;
1926 }
1927 pDecodedItem->uDataType = QCBOR_TYPE_REGEX;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001928
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001929 return QCBOR_SUCCESS;
1930}
1931
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001932
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001933inline static QCBORError DecodeWrappedCBOR(QCBORItem *pDecodedItem)
1934{
1935 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1936 return QCBOR_ERR_BAD_OPT_TAG;
1937 }
1938 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001939
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07001940 return QCBOR_SUCCESS;
1941}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001942
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001943
1944inline static QCBORError DecodeWrappedCBORSequence(QCBORItem *pDecodedItem)
1945{
1946 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1947 return QCBOR_ERR_BAD_OPT_TAG;
1948 }
1949 pDecodedItem->uDataType = QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001950
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07001951 return QCBOR_SUCCESS;
1952}
1953
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001954
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001955inline static QCBORError DecodeMIME(QCBORItem *pDecodedItem)
1956{
1957 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
1958 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07001959 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001960 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
1961 } else {
1962 return QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001963
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001964 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001965
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001966 return QCBOR_SUCCESS;
1967}
1968
1969
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001970inline static QCBORError DecodeUUID(QCBORItem *pDecodedItem)
1971{
1972 if(pDecodedItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
1973 return QCBOR_ERR_BAD_OPT_TAG;
1974 }
1975 pDecodedItem->uDataType = QCBOR_TYPE_UUID;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001976
Laurence Lundblade91853ae2020-06-15 19:35:58 -07001977 return QCBOR_SUCCESS;
1978}
1979
1980
Laurence Lundblade59289e52019-12-30 13:44:37 -08001981/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08001982 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08001983 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001984QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001985QCBORDecode_GetNext(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001986{
1987 QCBORError nReturn;
1988
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001989 nReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001990 if(nReturn != QCBOR_SUCCESS) {
1991 goto Done;
1992 }
1993
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001994 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001995 switch(pDecodedItem->uTags[i]) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08001996
Laurence Lundblade4a21be12020-08-05 12:48:33 -07001997 // Many of the functions here only just map a CBOR tag to
1998 // a QCBOR_TYPE for a string and could probably be
1999 // implemented with less object code. This implementation
2000 // of string types takes about 120 bytes of object code
2001 // (that is always linked and not removed by dead stripping).
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002002 case CBOR_TAG_DATE_STRING:
Laurence Lundblade59289e52019-12-30 13:44:37 -08002003 nReturn = DecodeDateString(pDecodedItem);
2004 break;
2005
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002006 case CBOR_TAG_DATE_EPOCH:
Laurence Lundblade59289e52019-12-30 13:44:37 -08002007 nReturn = DecodeDateEpoch(pDecodedItem);
2008 break;
2009
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002010 case CBOR_TAG_POS_BIGNUM:
2011 case CBOR_TAG_NEG_BIGNUM:
Laurence Lundblade59289e52019-12-30 13:44:37 -08002012 nReturn = DecodeBigNum(pDecodedItem);
2013 break;
2014
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002015 #ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
2016 case CBOR_TAG_DECIMAL_FRACTION:
2017 case CBOR_TAG_BIGFLOAT:
Laurence Lundblade59289e52019-12-30 13:44:37 -08002018 // For aggregate tagged types, what goes into pTags is only collected
2019 // from the surrounding data item, not the contents, so pTags is not
2020 // passed on here.
2021
2022 nReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
2023 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002024 #endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002025
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07002026 case CBOR_TAG_CBOR:
2027 nReturn = DecodeWrappedCBOR(pDecodedItem);
2028 break;
2029
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002030 case CBOR_TAG_CBOR_SEQUENCE:
2031 nReturn = DecodeWrappedCBORSequence(pDecodedItem);
2032 break;
2033
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002034 case CBOR_TAG_URI:
2035 nReturn = DecodeURI(pDecodedItem);
2036 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002037
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002038 case CBOR_TAG_B64URL:
2039 nReturn = DecodeB64URL(pDecodedItem);
2040 break;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002041
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002042 case CBOR_TAG_B64:
2043 nReturn = DecodeB64(pDecodedItem);
2044 break;
2045
2046 case CBOR_TAG_MIME:
2047 case CBOR_TAG_BINARY_MIME:
2048 nReturn = DecodeMIME(pDecodedItem);
2049 break;
2050
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002051 case CBOR_TAG_REGEX:
2052 nReturn = DecodeRegex(pDecodedItem);
2053 break;
2054
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002055 case CBOR_TAG_BIN_UUID:
2056 nReturn = DecodeUUID(pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002057 break;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002058
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002059 case CBOR_TAG_INVALID16:
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002060 // The end of the tag list or no tags
2061 // Successful exit from the loop.
2062 goto Done;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002063
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002064 default:
2065 // A tag that is not understood
2066 // A successful exit from the loop
2067 goto Done;
2068
2069 }
2070 if(nReturn != QCBOR_SUCCESS) {
2071 goto Done;
2072 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002073 // A tag was successfully processed, shift it
2074 // out of the list of tags returned.
2075 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002076 }
2077
2078Done:
2079 if(nReturn != QCBOR_SUCCESS) {
2080 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2081 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2082 }
2083 return nReturn;
2084}
2085
2086
2087/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002088 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002089 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002090QCBORError
2091QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
2092 QCBORItem *pDecodedItem,
2093 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002094{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002095 QCBORError nReturn;
2096
2097 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
2098 if(nReturn != QCBOR_SUCCESS) {
2099 return nReturn;
2100 }
2101
2102 if(pTags != NULL) {
2103 pTags->uNumUsed = 0;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002104 // Reverse the order because pTags is reverse of
2105 // QCBORItem.uTags.
2106 for(int i = QCBOR_MAX_TAGS_PER_ITEM-1; i >=0 ; i--) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002107 if(pDecodedItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002108 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002109 }
2110 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2111 return QCBOR_ERR_TOO_MANY_TAGS;
2112 }
2113 pTags->puTags[pTags->uNumUsed] = ConvertTag(me, pDecodedItem->uTags[i]);
2114 pTags->uNumUsed++;
2115 }
2116 }
2117
2118 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002119}
2120
2121
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002122/*
Laurence Lundblade6de37062018-10-15 12:22:42 +05302123 Decoding items is done in 5 layered functions, one calling the
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302124 next one down. If a layer has no work to do for a particular item
2125 it returns quickly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002126
Laurence Lundblade59289e52019-12-30 13:44:37 -08002127 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
2128 tagged data items, turning them into the local C representation.
2129 For the most simple it is just associating a QCBOR_TYPE with the data. For
2130 the complex ones that an aggregate of data items, there is some further
2131 decoding and a little bit of recursion.
2132
2133 - QCBORDecode_GetNextMapOrArray - This manages the beginnings and
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302134 ends of maps and arrays. It tracks descending into and ascending
Laurence Lundblade6de37062018-10-15 12:22:42 +05302135 out of maps/arrays. It processes all breaks that terminate
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002136 indefinite length maps and arrays.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002137
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302138 - GetNext_MapEntry -- This handles the combining of two
2139 items, the label and the data, that make up a map entry.
2140 It only does work on maps. It combines the label and data
2141 items into one labeled item.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002142
Laurence Lundblade59289e52019-12-30 13:44:37 -08002143 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
2144 tags into bit flags associated with the data item. No actual decoding
2145 of the contents of the tagged item is performed here.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002146
Laurence Lundblade59289e52019-12-30 13:44:37 -08002147 - GetNext_FullItem -- This assembles the sub-items that make up
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302148 an indefinte length string into one string item. It uses the
Laurence Lundblade6de37062018-10-15 12:22:42 +05302149 string allocater to create contiguous space for the item. It
2150 processes all breaks that are part of indefinite length strings.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002151
Laurence Lundblade59289e52019-12-30 13:44:37 -08002152 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
2153 atomic data item has a "major type", an integer "argument" and optionally
2154 some content. For text and byte strings, the content is the bytes
2155 that make up the string. These are the smallest data items that are
2156 considered to be well-formed. The content may also be other data items in
2157 the case of aggregate types. They are not handled in this layer.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002158
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002159 Roughly this takes 300 bytes of stack for vars. Need to
2160 evaluate this more carefully and correctly.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002161
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302162 */
2163
2164
2165/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002166 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002167 */
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002168bool QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002169 const QCBORItem *pItem,
2170 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002171{
Laurence Lundblade9b334962020-08-27 10:55:53 -07002172 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM; i++) {
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002173 if(pItem->uTags[i] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002174 break;
2175 }
2176 if(ConvertTag(me, pItem->uTags[i]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002177 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002178 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002179 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002180
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002181 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002182}
2183
2184
2185/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002186 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002187 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07002188QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002189{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002190 QCBORError uReturn = me->uLastError;
2191
2192 if(uReturn != QCBOR_SUCCESS) {
2193 goto Done;
2194 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002195
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002196 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002197 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002198 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002199 goto Done;
2200 }
2201
2202 // Error out if not all the bytes are consumed
2203 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002204 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002205 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002206
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002207Done:
Laurence Lundblade6de37062018-10-15 12:22:42 +05302208 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002209 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002210 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002211
Laurence Lundblade085d7952020-07-24 10:26:30 -07002212 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002213}
2214
2215
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002216/*
Laurence Lundblade9b334962020-08-27 10:55:53 -07002217 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002218*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07002219// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002220uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2221 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002222 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002223{
Laurence Lundblade9b334962020-08-27 10:55:53 -07002224 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2225 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002226 } else {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07002227 return ConvertTag(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002228 }
2229}
2230
Laurence Lundblade9b334962020-08-27 10:55:53 -07002231/*
2232 Public function, see header qcbor/qcbor_decode.h file
2233*/
2234uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2235 uint32_t uIndex)
2236{
2237 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2238 return CBOR_TAG_INVALID64;
2239 } else {
2240 return ConvertTag(pMe, pMe->uLastTags[uIndex]);
2241 }
2242}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002243
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002244/*
2245
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002246Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002247
Laurence Lundbladeee851742020-01-08 08:37:05 -08002248 - Hit end of input before it was expected while decoding type and
2249 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002250
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002251 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002252
Laurence Lundbladeee851742020-01-08 08:37:05 -08002253 - Hit end of input while decoding a text or byte string
2254 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002255
Laurence Lundbladeee851742020-01-08 08:37:05 -08002256 - Encountered conflicting tags -- e.g., an item is tagged both a date
2257 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002258
Laurence Lundbladeee851742020-01-08 08:37:05 -08002259 - Encontered an array or mapp that has too many items
2260 QCBOR_ERR_ARRAY_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002261
Laurence Lundbladeee851742020-01-08 08:37:05 -08002262 - Encountered array/map nesting that is too deep
2263 QCBOR_ERR_ARRAY_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002264
Laurence Lundbladeee851742020-01-08 08:37:05 -08002265 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2266 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002267
Laurence Lundbladeee851742020-01-08 08:37:05 -08002268 - The type of a map label is not a string or int
2269 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002270
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002271 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002272
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002273 */
2274
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002275
2276
Laurence Lundbladef6531662018-12-04 10:42:22 +09002277
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002278/* ===========================================================================
2279 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002280
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002281 This implements a simple sting allocator for indefinite length
2282 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2283 implements the function type QCBORStringAllocate and allows easy
2284 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002285
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002286 This particular allocator is built-in for convenience. The caller
2287 can implement their own. All of this following code will get
2288 dead-stripped if QCBORDecode_SetMemPool() is not called.
2289
2290 This is a very primitive memory allocator. It does not track
2291 individual allocations, only a high-water mark. A free or
2292 reallocation must be of the last chunk allocated.
2293
2294 The size of the pool and offset to free memory are packed into the
2295 first 8 bytes of the memory pool so we don't have to keep them in
2296 the decode context. Since the address of the pool may not be
2297 aligned, they have to be packed and unpacked as if they were
2298 serialized data of the wire or such.
2299
2300 The sizes packed in are uint32_t to be the same on all CPU types
2301 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002302 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002303
2304
Laurence Lundbladeee851742020-01-08 08:37:05 -08002305static inline int
2306MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002307{
2308 // Use of UsefulInputBuf is overkill, but it is convenient.
2309 UsefulInputBuf UIB;
2310
Laurence Lundbladeee851742020-01-08 08:37:05 -08002311 // Just assume the size here. It was checked during SetUp so
2312 // the assumption is safe.
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002313 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem, QCBOR_DECODE_MIN_MEM_POOL_SIZE});
2314 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2315 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2316 return UsefulInputBuf_GetError(&UIB);
2317}
2318
2319
Laurence Lundbladeee851742020-01-08 08:37:05 -08002320static inline int
2321MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002322{
2323 // Use of UsefulOutBuf is overkill, but convenient. The
2324 // length check performed here is useful.
2325 UsefulOutBuf UOB;
2326
2327 UsefulOutBuf_Init(&UOB, Pool);
2328 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2329 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2330 return UsefulOutBuf_GetError(&UOB);
2331}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002332
2333
2334/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002335 Internal function for an allocation, reallocation free and destuct.
2336
2337 Having only one function rather than one each per mode saves space in
2338 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002339
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002340 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2341 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002342static UsefulBuf
2343MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002344{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002345 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002346
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002347 uint32_t uPoolSize;
2348 uint32_t uFreeOffset;
2349
2350 if(uNewSize > UINT32_MAX) {
2351 // This allocator is only good up to 4GB. This check should
2352 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2353 goto Done;
2354 }
2355 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2356
2357 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2358 goto Done;
2359 }
2360
2361 if(uNewSize) {
2362 if(pMem) {
2363 // REALLOCATION MODE
2364 // Calculate pointer to the end of the memory pool. It is
2365 // assumed that pPool + uPoolSize won't wrap around by
2366 // assuming the caller won't pass a pool buffer in that is
2367 // not in legitimate memory space.
2368 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2369
2370 // Check that the pointer for reallocation is in the range of the
2371 // pool. This also makes sure that pointer math further down
2372 // doesn't wrap under or over.
2373 if(pMem >= pPool && pMem < pPoolEnd) {
2374 // Offset to start of chunk for reallocation. This won't
2375 // wrap under because of check that pMem >= pPool. Cast
2376 // is safe because the pool is always less than UINT32_MAX
2377 // because of check in QCBORDecode_SetMemPool().
2378 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2379
2380 // Check to see if the allocation will fit. uPoolSize -
2381 // uMemOffset will not wrap under because of check that
2382 // pMem is in the range of the uPoolSize by check above.
2383 if(uNewSize <= uPoolSize - uMemOffset) {
2384 ReturnValue.ptr = pMem;
2385 ReturnValue.len = uNewSize;
2386
2387 // Addition won't wrap around over because uNewSize was
2388 // checked to be sure it is less than the pool size.
2389 uFreeOffset = uMemOffset + uNewSize32;
2390 }
2391 }
2392 } else {
2393 // ALLOCATION MODE
2394 // uPoolSize - uFreeOffset will not underflow because this
2395 // pool implementation makes sure uFreeOffset is always
2396 // smaller than uPoolSize through this check here and
2397 // reallocation case.
2398 if(uNewSize <= uPoolSize - uFreeOffset) {
2399 ReturnValue.len = uNewSize;
2400 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002401 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002402 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002403 }
2404 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002405 if(pMem) {
2406 // FREE MODE
2407 // Cast is safe because of limit on pool size in
2408 // QCBORDecode_SetMemPool()
2409 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2410 } else {
2411 // DESTRUCT MODE
2412 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002413 }
2414 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002415
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002416 UsefulBuf Pool = {pPool, uPoolSize};
2417 MemPool_Pack(Pool, uFreeOffset);
2418
2419Done:
2420 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002421}
2422
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002423
Laurence Lundbladef6531662018-12-04 10:42:22 +09002424/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002425 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002426 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002427QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2428 UsefulBuf Pool,
2429 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002430{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002431 // The pool size and free mem offset are packed into the beginning
2432 // of the pool memory. This compile time check make sure the
2433 // constant in the header is correct. This check should optimize
2434 // down to nothing.
2435 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundblade30816f22018-11-10 13:40:22 +07002436 return QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002437 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002438
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002439 // The pool size and free offset packed in to the beginning of pool
2440 // memory are only 32-bits. This check will optimize out on 32-bit
2441 // machines.
2442 if(Pool.len > UINT32_MAX) {
2443 return QCBOR_ERR_BUFFER_TOO_LARGE;
2444 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002445
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002446 // This checks that the pool buffer given is big enough.
2447 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
2448 return QCBOR_ERR_BUFFER_TOO_SMALL;
2449 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002450
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002451 pMe->StringAllocator.pfAllocator = MemPool_Function;
2452 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2453 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002454
Laurence Lundblade30816f22018-11-10 13:40:22 +07002455 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002456}
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002457
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002458
2459
Laurence Lundblade9b334962020-08-27 10:55:53 -07002460static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2461{
2462 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2463}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002464
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002465
2466/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002467 Consume an entire map or array (and do next to
2468 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002469 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002470static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002471ConsumeItem(QCBORDecodeContext *pMe,
2472 const QCBORItem *pItemToConsume,
2473 uint_fast8_t *puNextNestLevel)
2474{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002475 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002476 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002477
Laurence Lundblade02625d42020-06-25 14:41:41 -07002478 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ConsumeItem");
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002479
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002480 // If it is a map or array, this will tell if it is empty.
2481 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2482
2483 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2484 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002485
Laurence Lundblade1341c592020-04-11 14:19:05 -07002486 /* This works for definite and indefinite length
2487 * maps and arrays by using the nesting level
2488 */
2489 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002490 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundblade4b270642020-08-14 12:53:07 -07002491 if( QCBORDecode_IsNotWellFormed(uReturn)) {
2492 // TODO: also resource limit errors
Laurence Lundblade1341c592020-04-11 14:19:05 -07002493 goto Done;
2494 }
2495 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002496
Laurence Lundblade1341c592020-04-11 14:19:05 -07002497 if(puNextNestLevel != NULL) {
2498 *puNextNestLevel = Item.uNextNestLevel;
2499 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002500 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002501
Laurence Lundblade1341c592020-04-11 14:19:05 -07002502 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002503 /* item_to_consume is not a map or array */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002504 if(puNextNestLevel != NULL) {
2505 /* Just pass the nesting level through */
2506 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2507 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002508 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002509 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002510
2511Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002512 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002513}
2514
2515
Laurence Lundblade1341c592020-04-11 14:19:05 -07002516/* Return true if the labels in Item1 and Item2 are the same.
2517 Works only for integer and string labels. Returns false
2518 for any other type. */
2519static inline bool
2520MatchLabel(QCBORItem Item1, QCBORItem Item2)
2521{
2522 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2523 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2524 return true;
2525 }
2526 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002527 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002528 return true;
2529 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002530 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002531 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2532 return true;
2533 }
2534 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2535 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2536 return true;
2537 }
2538 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002539
Laurence Lundblade1341c592020-04-11 14:19:05 -07002540 /* Other label types are never matched */
2541 return false;
2542}
2543
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002544
2545/*
2546 Returns true if Item1 and Item2 are the same type
2547 or if either are of QCBOR_TYPE_ANY.
2548 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002549static inline bool
2550MatchType(QCBORItem Item1, QCBORItem Item2)
2551{
2552 if(Item1.uDataType == Item2.uDataType) {
2553 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002554 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002555 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002556 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002557 return true;
2558 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002559 return false;
2560}
2561
2562
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002563/**
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002564 \brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002565
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002566 @param[in] pMe The decode context to search.
2567 @param[in,out] pItemArray The items to search for and the items found.
2568 @param[out] puOffset Byte offset of last item matched.
2569 @param[in] pCBContext Context for the not-found item call back.
2570 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002571
2572 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2573
Laurence Lundblade9b334962020-08-27 10:55:53 -07002574 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label) were found
2575 for one of the labels being search for. This duplicate detection is only performed for items in pItemArray,
2576 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002577
2578 @retval QCBOR_ERR_UNEXPECTED_TYPE The label was matched, but not the type.
2579
2580 @retval Also errors returned by QCBORDecode_GetNext().
2581
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002582 On input pItemArray contains a list of labels and data types
2583 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002584
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002585 On output the fully retrieved items are filled in with
2586 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002587
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002588 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002589 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002590static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002591MapSearch(QCBORDecodeContext *pMe,
2592 QCBORItem *pItemArray,
2593 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002594 void *pCBContext,
2595 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002596{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002597 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002598 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002599
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002600 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002601 uReturn = pMe->uLastError;
2602 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002603 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002604
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002605 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002606 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2607 /* QCBOR_TYPE_NONE as first item indicates just looking
2608 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002609 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2610 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002611 }
2612
Laurence Lundblade085d7952020-07-24 10:26:30 -07002613 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2614 // It is an empty bounded array or map
2615 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2616 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002617 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002618 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002619 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002620 // Nothing is ever found in an empty array or map. All items
2621 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002622 uReturn = QCBOR_SUCCESS;
2623 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002624 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002625 }
2626
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002627 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002628 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2629
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002630 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002631 UsefulInputBuf_Seek(&(pMe->InBuf),
2632 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002633
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002634 /*
2635 Loop over all the items in the map. They could be
2636 deeply nested and this should handle both definite
2637 and indefinite length maps and arrays, so this
2638 adds some complexity.
2639 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002640 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002641 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002642 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002643 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002644 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002645
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002646 /* Get the item */
2647 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002648 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002649 if(QCBORDecode_IsNotWellFormed(uReturn)) {
2650 /* Got non-well-formed CBOR so map can't even be decoded. */
Laurence Lundblade4b270642020-08-14 12:53:07 -07002651 // TODO: also bail out on implementation limits like array too big
Laurence Lundblade1341c592020-04-11 14:19:05 -07002652 goto Done;
2653 }
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002654 if(uReturn == QCBOR_ERR_NO_MORE_ITEMS) {
2655 // Unexpected end of map or array.
2656 goto Done;
2657 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002658
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002659 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002660 bool bMatched = false;
2661 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
Laurence Lundblade4b270642020-08-14 12:53:07 -07002662 // TODO: have label filled in on invalid CBOR so error reporting
Laurence Lundblade9b334962020-08-27 10:55:53 -07002663 // can work a lot better.
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002664 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002665 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002666 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2667 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002668 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002669 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002670 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002671 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002672 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002673 goto Done;
2674 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002675
Laurence Lundblade1341c592020-04-11 14:19:05 -07002676 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002677 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002678 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002679 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002680 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002681 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002682 bMatched = true;
2683 }
2684 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002685
2686
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002687 if(!bMatched && pfCallback != NULL) {
2688 /*
2689 Call the callback on unmatched labels.
2690 (It is tempting to do duplicate detection here, but that would
2691 require dynamic memory allocation because the number of labels
2692 that might be encountered is unbounded.)
2693 */
2694 uReturn = (*pfCallback)(pCBContext, &Item);
2695 if(uReturn != QCBOR_SUCCESS) {
2696 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002697 }
2698 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002699
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002700 /*
2701 Consume the item whether matched or not. This
2702 does the work of traversing maps and array and
2703 everything in them. In this loop only the
2704 items at the current nesting level are examined
2705 to match the labels.
2706 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002707 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002708 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002709 goto Done;
2710 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002711
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002712 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002713
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002714 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002715
2716 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002717 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2718 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002719
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002720 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002721 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2722
2723 Done2:
Laurence Lundbladec7114722020-08-13 05:11:40 -07002724 /* For all items not found, set the data type to QCBOR_TYPE_NONE */
2725 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002726 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002727 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002728 }
2729 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002730
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002731 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002732}
2733
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002734
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002735/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002736 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002737*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002738void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2739 int64_t nLabel,
2740 uint8_t uQcborType,
2741 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002742{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002743 if(pMe->uLastError != QCBOR_SUCCESS) {
2744 return;
2745 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002746
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002747 QCBORItem OneItemSeach[2];
2748 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2749 OneItemSeach[0].label.int64 = nLabel;
2750 OneItemSeach[0].uDataType = uQcborType;
2751 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002752
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002753 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2754 if(uReturn != QCBOR_SUCCESS) {
2755 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002756 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002757 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002758 uReturn = QCBOR_ERR_NOT_FOUND;
2759 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002760 }
2761
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002762 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002763
2764 Done:
2765 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002766}
2767
2768
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002769/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002770 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002771*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002772void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2773 const char *szLabel,
2774 uint8_t uQcborType,
2775 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002776{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002777 if(pMe->uLastError != QCBOR_SUCCESS) {
2778 return;
2779 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002780
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002781 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002782 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2783 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2784 OneItemSeach[0].uDataType = uQcborType;
2785 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002786
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002787 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2788 if(uReturn != QCBOR_SUCCESS) {
2789 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002790 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002791 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002792 uReturn = QCBOR_ERR_NOT_FOUND;
2793 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002794 }
2795
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002796 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002797
2798Done:
2799 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002800}
2801
2802
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002803
Laurence Lundblade9b334962020-08-27 10:55:53 -07002804static QCBORError CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002805{
2806 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2807 if(uDataType == puTypeList[i]) {
2808 return QCBOR_SUCCESS;
2809 }
2810 }
2811 return QCBOR_ERR_UNEXPECTED_TYPE;
2812}
2813
Laurence Lundblade67257dc2020-07-27 03:33:37 -07002814
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002815/**
2816 @param[in] TagSpec Specification for matching tags.
2817 @param[in] uDataType A QCBOR data type
Laurence Lundblade9b334962020-08-27 10:55:53 -07002818
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002819 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
2820 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07002821
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002822 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered tag value.
2823 */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002824static QCBORError CheckTagRequirement(const TagSpecification TagSpec, uint8_t uDataType)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002825{
Laurence Lundblade9b334962020-08-27 10:55:53 -07002826 if((TagSpec.uTagRequirement & (~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS)) == QCBOR_TAG_REQUIREMENT_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002827 // Must match the tag and only the tag
2828 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002829 }
2830
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002831 QCBORError uReturn = CheckTypeList(uDataType, TagSpec.uAllowedContentTypes);
2832 if(uReturn == QCBOR_SUCCESS) {
2833 return QCBOR_SUCCESS;
2834 }
2835
Laurence Lundblade9b334962020-08-27 10:55:53 -07002836 if((TagSpec.uTagRequirement & (~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS)) == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002837 /* Must match the content type and only the content type.
2838 There was no match just above so it is a fail. */
2839 return QCBOR_ERR_UNEXPECTED_TYPE;
2840 }
2841
2842 /* If here it can match either the tag or the content
2843 and it hasn't matched the content, so the end
2844 result is whether it matches the tag. This is
2845 also the case that the CBOR standard discourages. */
2846
2847 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002848}
2849
Laurence Lundblade9b334962020-08-27 10:55:53 -07002850static QCBORError CheckTagRequirement2(const TagSpecification TagSpec, const QCBORItem *pItem)
2851{
2852 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
2853 pItem->uTags[0] != CBOR_TAG_INVALID16) {
2854 /* There are tags that QCBOR couldn't process on this item and
2855 the caller has told us there should not be. */
2856 return QCBOR_ERR_UNEXPECTED_TYPE;
2857 }
2858
2859 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
2860 const int nItemType = pItem->uDataType;
2861
2862 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
2863 // Must match the tag and only the tag
2864 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
2865 }
2866
2867 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
2868 if(uReturn == QCBOR_SUCCESS) {
2869 return QCBOR_SUCCESS;
2870 }
2871
2872 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
2873 /* Must match the content type and only the content type.
2874 There was no match just above so it is a fail. */
2875 return QCBOR_ERR_UNEXPECTED_TYPE;
2876 }
2877
2878 /* If here it can match either the tag or the content
2879 and it hasn't matched the content, so the end
2880 result is whether it matches the tag. This is
2881 also the case that the CBOR standard discourages. */
2882
2883 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
2884}
2885
2886#if 0
2887/**
2888 @param[in] TagSpec Specification for matching tags.
2889 @param[in] uDataType A QCBOR data type
2890
2891 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
2892 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
2893
2894 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered tag value.
2895 */
2896static QCBORError CheckTagRequirement2(const TagSpecification TagSpec, uint8_t uDataType)
2897{
2898 const uint16_t *pTags;
2899/*
2900For all the tag-specific accessor methods supported, GetNext will
2901 process then automatically when encountered during decoding.
2902 The will have a QCBOR_TYPE and a representation in QCBORItem.
2903 There are no expections to this (so far).
2904
2905 That means the tag list in the QCBORItem will never have
2906 these tags in it. The tags in that list never need to
2907 be examined here.
2908
2909
2910
29111 Tag list must be empty
2912
29132 and 5, first tag must be in expected list
2914
29154
2916
29173 tag list must be empty or one in the expected list
2918
29196, if first tag is expected, consume it, pass the rest on
2920
2921
2922 */
2923
2924 /*
2925 First thing to understand is that GetNext will have processed
2926 the tags this code knows about. They will not be in the unprocessed
2927 tags list and the dataType will be of the processed CBOR.
2928 */
2929
2930 const bool bUnprocessedTagsEmpty = pTags[0] != CBOR_TAG_INVALID16;
2931
2932 const bool bDataTypeMatchesRequestedTaggedType = !CheckTypeList(uDataType, TagSpec.uTaggedTypes);
2933
2934 const bool bDataTypeMatchesRequestedContentType = !CheckTypeList(uDataType, TagSpec.uAllowedContentTypes);
2935
2936
2937 if(TagSpec.uTagRequirement == 1) {
2938 /* There should be no tags at all, so the unprocessed tag
2939 list should be empty.
2940
2941 The content has to match the expected content. If
2942 there was a tag that was interpreted, the content
2943 wouldn't match.
2944
2945 */
2946 if(!bUnprocessedTagsEmpty) {
2947 return QCBOR_ERR_UNEXPECTED_TYPE;
2948 } else {
2949 if(!bDataTypeMatchesRequestedContentType) {
2950 return QCBOR_ERR_UNEXPECTED_TYPE;
2951 } else {
2952 return QCBOR_SUCCESS;
2953 }
2954
2955 }
2956
2957
2958
2959 } else if(TagSpec.uTagRequirement == 2) {
2960 /* The tag was present so GetNext will have interpreted it by now.
2961 The data type should be one of the requested types
2962 and there should be no other tags. */
2963
2964 if(!bUnprocessedTagsEmpty) {
2965 return QCBOR_ERR_UNEXPECTED_TYPE;
2966 } else {
2967 if(!bDataTypeMatchesRequestedTaggedType) {
2968 return QCBOR_ERR_UNEXPECTED_TYPE;
2969 } else {
2970 return QCBOR_SUCCESS;
2971 }
2972 }
2973 } else if(TagSpec.uTagRequirement == 3) {
2974 if(!bUnprocessedTagsEmpty) {
2975 return QCBOR_ERR_UNEXPECTED_TYPE;
2976 } else {
2977 if(bDataTypeMatchesRequestedTaggedType || bDataTypeMatchesRequestedContentType) {
2978 return true;
2979 } else {
2980 return false;
2981 }
2982 }
2983 } else if(TagSpec.uTagRequirement == 4) {
2984
2985
2986
2987
2988
2989
2990
2991 if(TagSpec.uTagRequirement == QCBOR_TAG_REQUIREMENT_TAG) {
2992 // Must match the tag and only the tag
2993 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
2994 }
2995
2996 QCBORError uReturn = CheckTypeList(uDataType, TagSpec.uAllowedContentTypes);
2997 if(uReturn == QCBOR_SUCCESS) {
2998 return QCBOR_SUCCESS;
2999 }
3000
3001 if(TagSpec.uTagRequirement == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3002 /* Must match the content type and only the content type.
3003 There was no match just above so it is a fail. */
3004 return QCBOR_ERR_UNEXPECTED_TYPE;
3005 }
3006
3007 /* If here it can match either the tag or the content
3008 and it hasn't matched the content, so the end
3009 result is whether it matches the tag. This is
3010 also the case that the CBOR standard discourages. */
3011
3012 return CheckTypeList(uDataType, TagSpec.uTaggedTypes);
3013}
3014
3015#endif
3016
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003017
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003018// Semi-private
3019// TODO: inline or collapse with QCBORDecode_GetTaggedStringInMapN?
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003020void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3021 int64_t nLabel,
3022 TagSpecification TagSpec,
3023 QCBORItem *pItem)
3024{
3025 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3026 if(pMe->uLastError != QCBOR_SUCCESS) {
3027 return;
3028 }
3029
Laurence Lundblade9b334962020-08-27 10:55:53 -07003030 pMe->uLastError = (uint8_t)CheckTagRequirement2(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003031}
3032
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003033// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003034void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3035 const char *szLabel,
3036 TagSpecification TagSpec,
3037 QCBORItem *pItem)
3038{
3039 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3040 if(pMe->uLastError != QCBOR_SUCCESS) {
3041 return;
3042 }
3043
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07003044 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem->uDataType);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003045}
3046
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003047// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003048void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3049 int64_t nLabel,
3050 TagSpecification TagSpec,
3051 UsefulBufC *pString)
3052{
3053 QCBORItem Item;
3054 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3055 if(pMe->uLastError == QCBOR_SUCCESS) {
3056 *pString = Item.val.string;
3057 }
3058}
3059
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003060// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003061void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3062 const char * szLabel,
3063 TagSpecification TagSpec,
3064 UsefulBufC *pString)
3065{
3066 QCBORItem Item;
3067 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3068 if(pMe->uLastError == QCBOR_SUCCESS) {
3069 *pString = Item.val.string;
3070 }
3071}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003072
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003073/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003074 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003075*/
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003076QCBORError QCBORDecode_GetItemsInMap(QCBORDecodeContext *pCtx, QCBORItem *pItemList)
3077{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003078 return MapSearch(pCtx, pItemList, NULL, NULL, NULL);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003079}
3080
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003081/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003082 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003083*/
3084QCBORError QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pCtx,
3085 QCBORItem *pItemList,
3086 void *pCallbackCtx,
3087 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003088{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003089 return MapSearch(pCtx, pItemList, NULL, pCallbackCtx, pfCB);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003090}
3091
3092
Laurence Lundblade34691b92020-05-18 22:25:25 -07003093static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003094{
Laurence Lundblade085d7952020-07-24 10:26:30 -07003095 // TODO: check that only one item is in pSearch?
Laurence Lundblade34691b92020-05-18 22:25:25 -07003096 if(pMe->uLastError != QCBOR_SUCCESS) {
3097 // Already in error state; do nothing.
3098 return;
3099 }
3100
3101 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003102 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003103 if(pMe->uLastError != QCBOR_SUCCESS) {
3104 return;
3105 }
3106
Laurence Lundblade9b334962020-08-27 10:55:53 -07003107 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
3108 pMe->uLastError = QCBOR_ERR_NOT_FOUND;
3109 return;
3110 }
3111
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003112 /* Need to get the current pre-order nesting level and cursor to be
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07003113 at the map/array about to be entered.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003114
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003115 Also need the current map nesting level and start cursor to
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003116 be at the right place.
3117
3118 The UsefulInBuf offset could be anywhere, so no assumption is
3119 made about it.
3120
3121 No assumption is made about the pre-order nesting level either.
3122
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003123 However the bounded mode nesting level is assumed to be one above
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003124 the map level that is being entered.
3125 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003126 /* Seek to the data item that is the map or array */
3127 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003128
3129 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003130
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003131 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003132}
3133
3134
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003135/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003136 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003137*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003138void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003139{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003140 QCBORItem OneItemSeach[2];
3141 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3142 OneItemSeach[0].label.int64 = nLabel;
3143 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3144 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003145
Laurence Lundblade9b334962020-08-27 10:55:53 -07003146 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003147 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003148}
3149
3150
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003151/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003152 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003153*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003154void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003155{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003156 QCBORItem OneItemSeach[2];
3157 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3158 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3159 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3160 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003161
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003162 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003163}
3164
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003165/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003166 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003167*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003168void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003169{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003170 QCBORItem OneItemSeach[2];
3171 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3172 OneItemSeach[0].label.int64 = nLabel;
3173 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3174 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003175
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003176 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003177}
3178
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003179/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003180 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003181*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003182void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3183{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003184 QCBORItem OneItemSeach[2];
3185 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3186 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3187 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3188 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003189
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003190 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003191}
3192
3193
Laurence Lundblade02625d42020-06-25 14:41:41 -07003194// Semi-private function
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003195void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003196{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003197 QCBORError uErr;
3198
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003199 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003200 if(pMe->uLastError != QCBOR_SUCCESS) {
3201 // Already in error state; do nothing.
3202 return;
3203 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003204
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003205 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003206 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003207 uErr = QCBORDecode_GetNext(pMe, &Item);
3208 if(uErr != QCBOR_SUCCESS) {
3209 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003210 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003211 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003212 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3213 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003214 }
3215
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003216 CopyTags(pMe, &Item);
3217
3218
Laurence Lundbladef0499502020-08-01 11:55:57 -07003219 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003220 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003221 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3222 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003223 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003224 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3225 }
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003226 // Special case to increment nesting level for zero-length maps and arrays entered in bounded mode.
3227 DecodeNesting_Descend(&(pMe->nesting), uType);
3228 }
3229
Laurence Lundblade02625d42020-06-25 14:41:41 -07003230 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003231
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003232 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3233 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003234
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003235Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003236 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003237}
3238
Laurence Lundblade02625d42020-06-25 14:41:41 -07003239
3240/*
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003241 This is the common work for exiting a level that is a bounded map, array or bstr
3242 wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003243
3244 One chunk of work is to set up the pre-order traversal so it is at
3245 the item just after the bounded map, array or bstr that is being
3246 exited. This is somewhat complex.
3247
3248 The other work is to level-up the bounded mode to next higest bounded
3249 mode or the top level if there isn't one.
3250 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003251static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003252ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003253{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003254 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003255
Laurence Lundblade02625d42020-06-25 14:41:41 -07003256 /*
3257 First the pre-order-traversal byte offset is positioned to the
3258 item just after the bounded mode item that was just consumed.
3259 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003260 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3261
Laurence Lundblade02625d42020-06-25 14:41:41 -07003262 /*
3263 Next, set the current nesting level to one above the bounded level
3264 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003265
Laurence Lundblade02625d42020-06-25 14:41:41 -07003266 DecodeNesting_CheckBoundedType() is always called before this and
3267 makes sure pCurrentBounded is valid.
3268 */
3269 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3270
3271 /*
3272 This does the complex work of leveling up the pre-order traversal
3273 when the end of a map or array or another bounded level is
3274 reached. It may do nothing, or ascend all the way to the top
3275 level.
3276 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07003277 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003278 if(uErr != QCBOR_SUCCESS) {
3279 goto Done;
3280 }
3281
Laurence Lundblade02625d42020-06-25 14:41:41 -07003282 /*
3283 This makes the next highest bounded level the current bounded
3284 level. If there is no next highest level, then no bounded mode is
3285 in effect.
3286 */
3287 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003288
Laurence Lundblade02625d42020-06-25 14:41:41 -07003289 pMe->uMapEndOffsetCache = MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003290
3291Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07003292 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "ExitBoundedLevel");
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003293 return uErr;
3294}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003295
Laurence Lundblade02625d42020-06-25 14:41:41 -07003296
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003297// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003298void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003299{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003300 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003301 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003302 return;
3303 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003304
Laurence Lundblade02625d42020-06-25 14:41:41 -07003305 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003306
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003307 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003308 uErr = QCBOR_ERR_CLOSE_MISMATCH;
3309 goto Done;
3310 }
3311
Laurence Lundblade02625d42020-06-25 14:41:41 -07003312 /*
3313 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003314 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003315 from previous map search, then do a dummy search.
3316 */
3317 if(pMe->uMapEndOffsetCache == MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003318 QCBORItem Dummy;
3319 Dummy.uLabelType = QCBOR_TYPE_NONE;
3320 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3321 if(uErr != QCBOR_SUCCESS) {
3322 goto Done;
3323 }
3324 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003325
Laurence Lundblade02625d42020-06-25 14:41:41 -07003326 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003327
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003328Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003329 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003330}
3331
3332
Laurence Lundblade1341c592020-04-11 14:19:05 -07003333
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003334static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003335 const QCBORItem *pItem,
3336 uint8_t uTagRequirement,
3337 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003338{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003339 if(pBstr) {
3340 *pBstr = NULLUsefulBufC;
3341 }
3342
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003343 if(pMe->uLastError != QCBOR_SUCCESS) {
3344 // Already in error state; do nothing.
3345 return pMe->uLastError;
3346 }
3347
3348 QCBORError uError = QCBOR_SUCCESS;
3349
3350 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
3351 uError = QCBOR_ERR_UNEXPECTED_TYPE;
3352 goto Done;;
3353 }
3354
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003355 const TagSpecification TagSpec =
3356 {
3357 uTagRequirement,
3358 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3359 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3360 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003361
3362 uError = CheckTagRequirement(TagSpec, pItem->uDataType);
3363 if(uError != QCBOR_SUCCESS) {
3364 goto Done;
3365 }
3366
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003367 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003368 /* Reverse the decrement done by GetNext() for the bstr as
Laurence Lundblade410c7e02020-06-25 23:35:29 -07003369 so the increment in NestLevelAscender called by ExitBoundedLevel()
3370 will work right. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003371 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003372 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003373
3374 if(pBstr) {
3375 *pBstr = pItem->val.string;
3376 }
3377
3378 const size_t uPreviousLength = UsefulInputBuf_GetLength(&(pMe->InBuf));
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003379
3380 // Need to move UIB input cursor to the right place
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003381 // Most of these calls are simple inline accessors so this doesn't
3382 // amount to much code. There is a range check in the seek.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003383 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003384 if(uEndOfBstr >= UINT32_MAX || uPreviousLength >= UINT32_MAX) {
3385 // TODO: test this error condition
3386 uError = QCBOR_ERR_BUFFER_TOO_LARGE;
3387 goto Done;
3388 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003389 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003390 UsefulInputBuf_SetBufferLen(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003391
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003392 // Casts are OK because of the checks above.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003393 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003394 (uint32_t)uPreviousLength,
3395 (uint32_t)uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003396Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -07003397 DecodeNesting_Print(&(pMe->nesting), &(pMe->InBuf), "Entered Bstr");
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003398
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003399 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003400}
3401
3402
Laurence Lundblade02625d42020-06-25 14:41:41 -07003403/*
3404 Public function, see header qcbor/qcbor_decode.h file
3405 */
3406void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003407 uint8_t uTagRequirement,
3408 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003409{
3410 if(pMe->uLastError != QCBOR_SUCCESS) {
3411 // Already in error state; do nothing.
3412 return;
3413 }
3414
3415 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003416 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003417 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3418 if(pMe->uLastError != QCBOR_SUCCESS) {
3419 return;
3420 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003421
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003422 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003423 &Item,
3424 uTagRequirement,
3425 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003426}
3427
3428
Laurence Lundblade02625d42020-06-25 14:41:41 -07003429/*
3430 Public function, see header qcbor/qcbor_decode.h file
3431 */
3432void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003433 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003434 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003435 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003436{
3437 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003438 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003439
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003440 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003441}
3442
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003443
Laurence Lundblade02625d42020-06-25 14:41:41 -07003444/*
3445 Public function, see header qcbor/qcbor_decode.h file
3446 */
3447void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003448 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003449 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003450 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003451{
3452 QCBORItem Item;
3453 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3454
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003455 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe, &Item, uTagRequirement, pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003456}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003457
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003458
Laurence Lundblade02625d42020-06-25 14:41:41 -07003459/*
3460 Public function, see header qcbor/qcbor_decode.h file
3461 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003462void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003463{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003464 if(pMe->uLastError != QCBOR_SUCCESS) {
3465 // Already in error state; do nothing.
3466 return;
3467 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003468
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003469 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003470 pMe->uLastError = QCBOR_ERR_CLOSE_MISMATCH;
3471 return;
3472 }
3473
3474 /*
3475 Reset the length of the UsefulInputBuf to what it was before
3476 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003477 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003478 UsefulInputBuf_SetBufferLen(&(pMe->InBuf),
3479 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003480
3481
Laurence Lundblade02625d42020-06-25 14:41:41 -07003482 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003483 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003484}
3485
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003486
Laurence Lundbladee6430642020-03-14 21:15:44 -07003487
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003488
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003489
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003490
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003491
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003492
Laurence Lundblade9b334962020-08-27 10:55:53 -07003493static QCBORError InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003494{
3495 switch(pItem->uDataType) {
3496 case QCBOR_TYPE_TRUE:
3497 *pBool = true;
3498 return QCBOR_SUCCESS;
3499 break;
3500
3501 case QCBOR_TYPE_FALSE:
3502 *pBool = false;
3503 return QCBOR_SUCCESS;
3504 break;
3505
3506 default:
3507 return QCBOR_ERR_UNEXPECTED_TYPE;
3508 break;
3509 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003510 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003511}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003512
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003513
Laurence Lundblade9b334962020-08-27 10:55:53 -07003514
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003515/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003516 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003517*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003518void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003519{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003520 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003521 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003522 return;
3523 }
3524
Laurence Lundbladec4537442020-04-14 18:53:22 -07003525 QCBORError nError;
3526 QCBORItem Item;
3527
3528 nError = QCBORDecode_GetNext(pMe, &Item);
3529 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003530 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003531 return;
3532 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003533 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003534}
3535
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003536
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003537/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003538 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003539*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003540void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003541{
3542 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003543 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003544
Laurence Lundblade9b334962020-08-27 10:55:53 -07003545 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003546}
3547
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003548
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003549/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003550 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003551*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003552void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3553{
3554 QCBORItem Item;
3555 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3556
Laurence Lundblade9b334962020-08-27 10:55:53 -07003557 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003558}
3559
3560
3561
Laurence Lundblade9b334962020-08-27 10:55:53 -07003562/*
3563 A number of methods decode CBOR that is associated with a
3564 specific tag or tags.
Laurence Lundbladec7114722020-08-13 05:11:40 -07003565
Laurence Lundblade9b334962020-08-27 10:55:53 -07003566 The API of the method returns the
3567 data in a way specific to the
3568
3569 No tags at all.
3570
3571
3572 Require tag for the particular type for the method and no other.
3573
3574
3575 Either no tags at all or the particular type for the method and no other.
3576
3577 No tag for particular type; pass other tags along.
3578
3579 Require the tag for the particular type; pass other tags along
3580
3581 Any tagging is OK; consume the tag for the particular type if present,
3582 pass other tags along.
3583
3584
3585 1) REQUIRED
3586- 1 XXXX -- works
3587- T 1 XXX -- works, T is returned
3588
3589 if(tag is of interest) {
3590 process content
3591 return T if present
3592 }
3593
3594
3595 2) FORBIDDEN
3596 - XXX -- works
3597 - T XXX -- ???
3598
3599 if(tag is of interest) {
3600 error out since tag is forbidden
3601 } else {
3602 process contents
3603 return T
3604 }
3605
3606 3) OPTIONAL
3607 - XXX works
3608 - 1 XXX works
3609 - T XXX
3610 - T 1 XXX works, T is returned
3611
3612if (inner tag is of interest) {
3613 process content
3614 return tag T if present
3615 } else if (there is no tag) {
3616 process content
3617 } else {
3618 process content if possible
3619 return T
3620 }
3621
3622A field is type X
3623 - tag for type X is REQUIRED
3624 - tag for type X is FORBIDDEN
3625 - tag for type X is optional
3626 - Other tags are FORBIDDEN
3627 - Other tags are ALLOWED
3628
3629
3630
3631 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003632
3633static void ProcessEpochDate(QCBORDecodeContext *pMe,
3634 QCBORItem *pItem,
3635 uint8_t uTagRequirement,
3636 int64_t *pnTime)
3637{
3638 if(pMe->uLastError != QCBOR_SUCCESS) {
3639 // Already in error state, do nothing
3640 return;
3641 }
3642
3643 QCBORError uErr;
3644
3645 const TagSpecification TagSpec =
3646 {
3647 uTagRequirement,
3648 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3649 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT}
3650 };
3651
Laurence Lundblade4b270642020-08-14 12:53:07 -07003652 // TODO: this will give an unexpected type error instead of
Laurence Lundbladec7114722020-08-13 05:11:40 -07003653 // overflow error for QCBOR_TYPE_UINT64 because TagSpec
3654 // only has three target types.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003655 uErr = CheckTagRequirement2(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003656 if(uErr != QCBOR_SUCCESS) {
3657 goto Done;
3658 }
3659
3660 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3661 uErr = DecodeDateEpoch(pItem);
3662 if(uErr != QCBOR_SUCCESS) {
3663 goto Done;
3664 }
3665 }
3666
Laurence Lundblade9b334962020-08-27 10:55:53 -07003667 // Save the tags in the last item's tags in the decode context
3668 // for QCBORDecode_GetNthTagOfLast()
3669 CopyTags(pMe, pItem);
3670
Laurence Lundbladec7114722020-08-13 05:11:40 -07003671 *pnTime = pItem->val.epochDate.nSeconds;
3672
3673Done:
3674 pMe->uLastError = (uint8_t)uErr;
3675}
3676
3677
3678void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
3679 uint8_t uTagRequirement,
3680 int64_t *pnTime)
3681{
3682 if(pMe->uLastError != QCBOR_SUCCESS) {
3683 // Already in error state, do nothing
3684 return;
3685 }
3686
3687 QCBORItem Item;
3688 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3689
3690 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3691}
3692
3693
3694void
3695QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3696 int64_t nLabel,
3697 uint8_t uTagRequirement,
3698 int64_t *pnTime)
3699{
3700 QCBORItem Item;
3701 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3702 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3703}
3704
3705
3706void
3707QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3708 const char *szLabel,
3709 uint8_t uTagRequirement,
3710 int64_t *pnTime)
3711{
3712 QCBORItem Item;
3713 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3714 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3715}
3716
3717
3718
3719
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003720void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3721 TagSpecification TagSpec,
3722 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003723{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003724 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003725 // Already in error state, do nothing
3726 return;
3727 }
3728
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003729 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003730 QCBORItem Item;
3731
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003732 uError = QCBORDecode_GetNext(pMe, &Item);
3733 if(uError != QCBOR_SUCCESS) {
3734 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003735 return;
3736 }
3737
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003738 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, Item.uDataType);
3739
3740 if(pMe->uLastError == QCBOR_SUCCESS) {
3741 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003742 } else {
3743 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003744 }
3745}
3746
Laurence Lundbladec4537442020-04-14 18:53:22 -07003747
3748
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003749
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003750static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003751 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003752 UsefulBufC *pValue,
3753 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003754{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003755 const TagSpecification TagSpec =
3756 {
3757 uTagRequirement,
3758 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE},
3759 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3760 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003761
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003762 QCBORError uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
3763 if(uErr != QCBOR_SUCCESS) {
3764 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003765 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003766
3767 *pValue = pItem->val.string;
3768
3769 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3770 *pbIsNegative = false;
3771 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3772 *pbIsNegative = true;
3773 }
3774
3775 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003776}
3777
3778
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003779/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003780 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003781 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003782void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3783 uint8_t uTagRequirement,
3784 UsefulBufC *pValue,
3785 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003786{
3787 if(pMe->uLastError != QCBOR_SUCCESS) {
3788 // Already in error state, do nothing
3789 return;
3790 }
3791
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003792 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003793 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3794 if(uError != QCBOR_SUCCESS) {
3795 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003796 return;
3797 }
3798
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003799 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003800}
3801
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003802
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003803/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003804 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003805*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003806void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3807 int64_t nLabel,
3808 uint8_t uTagRequirement,
3809 UsefulBufC *pValue,
3810 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003811{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003812 QCBORItem Item;
3813 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003814 if(pMe->uLastError != QCBOR_SUCCESS) {
3815 return;
3816 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003817
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003818 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003819}
3820
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003821
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003822/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003823 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003824*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003825void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3826 const char *szLabel,
3827 uint8_t uTagRequirement,
3828 UsefulBufC *pValue,
3829 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003830{
3831 QCBORItem Item;
3832 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003833 if(pMe->uLastError != QCBOR_SUCCESS) {
3834 return;
3835 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003836
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003837 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003838}
3839
3840
3841
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003842
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003843// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003844QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3845 const QCBORItem *pItem,
3846 UsefulBufC *pMessage,
3847 bool *pbIsNot7Bit)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003848{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003849 const TagSpecification TagSpecText =
3850 {
3851 uTagRequirement,
3852 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3853 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3854 };
3855 const TagSpecification TagSpecBinary =
3856 {
3857 uTagRequirement,
3858 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3859 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3860 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003861
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003862 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003863
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003864 if(CheckTagRequirement(TagSpecText, pItem->uDataType) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003865 *pMessage = pItem->val.string;
3866 if(pbIsNot7Bit != NULL) {
3867 *pbIsNot7Bit = false;
3868 }
3869 uReturn = QCBOR_SUCCESS;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003870 } else if(CheckTagRequirement(TagSpecBinary, pItem->uDataType) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003871 *pMessage = pItem->val.string;
3872 if(pbIsNot7Bit != NULL) {
3873 *pbIsNot7Bit = true;
3874 }
3875 uReturn = QCBOR_SUCCESS;
3876
3877 } else {
3878 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3879 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003880
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003881 return uReturn;
3882}
3883
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003884// Improvement: add methods for wrapped CBOR, a simple alternate to EnterBstrWrapped
3885
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003886
3887
3888
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003889#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003890
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003891typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003892
3893
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003894// The exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003895static QCBORError Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003896{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003897 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003898
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003899 if(uResult != 0) {
3900 /* This loop will run a maximum of 19 times because
3901 * UINT64_MAX < 10 ^^ 19. More than that will cause
3902 * exit with the overflow error
3903 */
3904 for(; nExponent > 0; nExponent--) {
3905 if(uResult > UINT64_MAX / 10) {
3906 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3907 }
3908 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003909 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003910
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003911 for(; nExponent < 0; nExponent++) {
3912 uResult = uResult / 10;
3913 if(uResult == 0) {
3914 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3915 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003916 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003917 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003918 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003919
3920 *puResult = uResult;
3921
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003922 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003923}
3924
3925
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003926// The exponentiator that works on only positive numbers
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003927static QCBORError Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003928{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003929 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003930
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003931 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003932
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003933 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003934 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003935 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07003936 */
3937 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003938 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003939 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003940 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003941 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003942 nExponent--;
3943 }
3944
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003945 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003946 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003947 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3948 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003949 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003950 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003951 }
3952
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003953 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003954
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003955 return QCBOR_SUCCESS;
3956}
3957
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003958
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003959/*
3960 Compute value with signed mantissa and signed result. Works with exponent of 2 or 10 based on exponentiator.
3961 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003962static inline QCBORError ExponentiateNN(int64_t nMantissa,
3963 int64_t nExponent,
3964 int64_t *pnResult,
3965 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003966{
3967 uint64_t uResult;
3968
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003969 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003970 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003971 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3972
3973 // Do the exponentiation of the positive mantissa
3974 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3975 if(uReturn) {
3976 return uReturn;
3977 }
3978
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003979
Laurence Lundblade983500d2020-05-14 11:49:34 -07003980 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3981 of INT64_MIN. This assumes two's compliment representation where
3982 INT64_MIN is one increment farther from 0 than INT64_MAX.
3983 Trying to write -INT64_MIN doesn't work to get this because the
3984 compiler tries to work with an int64_t which can't represent
3985 -INT64_MIN.
3986 */
3987 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3988
3989 // Error out if too large
3990 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003991 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
3992 }
3993
3994 // Casts are safe because of checks above
3995 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
3996
3997 return QCBOR_SUCCESS;
3998}
3999
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004000
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004001/*
4002 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
4003 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004004static inline QCBORError ExponentitateNU(int64_t nMantissa,
4005 int64_t nExponent,
4006 uint64_t *puResult,
4007 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004008{
4009 if(nMantissa < 0) {
4010 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4011 }
4012
4013 // Cast to unsigned is OK because of check for negative
4014 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4015 // Exponentiation is straight forward
4016 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4017}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004018
4019
4020/*
4021 Compute value with signed mantissa and unsigned result. Works with exponent of 2 or 10 based on exponentiator.
4022 */
4023static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4024 int64_t nExponent,
4025 uint64_t *puResult,
4026 fExponentiator pfExp)
4027{
4028 return (*pfExp)(uMantissa, nExponent, puResult);
4029}
4030
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004031#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4032
4033
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004034
4035
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004036
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004037static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004038{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004039 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004040
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004041 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004042 const uint8_t *pByte = BigNum.ptr;
4043 size_t uLen = BigNum.len;
4044 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004045 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004046 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004047 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004048 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004049 }
4050
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004051 *pResult = uResult;
4052 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004053}
4054
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004055
Laurence Lundblade887add82020-05-17 05:50:34 -07004056static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004057{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004058 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004059}
4060
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004061
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004062static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004063{
4064 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004065 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4066 if(uError) {
4067 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004068 }
4069 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4070 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004071 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004072}
4073
4074
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004075static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004076{
4077 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004078 /* The negative integer furthest from zero for a C int64_t is
4079 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4080 negative number in CBOR is computed as -n - 1 where n is the
4081 encoded integer, where n is what is in the variable BigNum. When
4082 converting BigNum to a uint64_t, the maximum value is thus
4083 INT64_MAX, so that when it -n - 1 is applied to it the result will
4084 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004085
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004086 -n - 1 <= INT64_MIN.
4087 -n - 1 <= -INT64_MAX - 1
4088 n <= INT64_MAX.
4089 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004090 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004091 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004092 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004093 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004094
4095 /// Now apply -n - 1. The cast is safe because
4096 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4097 // is the largest positive integer that an int64_t can
4098 // represent. */
4099 *pnResult = -(int64_t)uResult - 1;
4100
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004101 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004102}
4103
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004104
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004105
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004106
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004107#include "fenv.h"
Laurence Lundbladec4537442020-04-14 18:53:22 -07004108
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004109
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004110/*
4111Convert a integers and floats to an int64_t.
4112
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004113\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004114
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004115\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004116
4117\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4118
4119\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
4120
4121*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004122static QCBORError ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004123{
4124 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004125 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004126 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004127#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004128 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004129 // TODO: what about under/overflow here?
4130 // Invokes the floating-point HW and/or compiler-added libraries
4131 feclearexcept(FE_ALL_EXCEPT);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004132 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4133 *pnValue = llround(pItem->val.dfnum);
4134 } else {
4135 *pnValue = lroundf(pItem->val.fnum);
4136 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004137 if(fetestexcept(FE_INVALID)) {
4138 // TODO: better error code
4139 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4140 }
4141 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004142 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004143 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004144#else
4145 return QCBOR_ERR_HW_FLOAT_DISABLED;
4146#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004147 break;
4148
4149 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004150 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004151 *pnValue = pItem->val.int64;
4152 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004153 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004154 }
4155 break;
4156
4157 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004158 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004159 if(pItem->val.uint64 < INT64_MAX) {
4160 *pnValue = pItem->val.int64;
4161 } else {
4162 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4163 }
4164 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004165 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004166 }
4167 break;
4168
4169 default:
4170 return QCBOR_ERR_UNEXPECTED_TYPE;
4171 }
4172 return QCBOR_SUCCESS;
4173}
4174
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004175
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004176void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004177 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004178 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004179 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004180{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004181 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004182 return;
4183 }
4184
Laurence Lundbladee6430642020-03-14 21:15:44 -07004185 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004186 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4187 if(uError) {
4188 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004189 return;
4190 }
4191
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004192 if(pItem) {
4193 *pItem = Item;
4194 }
4195
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004196 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004197}
4198
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004199
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004200void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4201 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004202 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004203 int64_t *pnValue,
4204 QCBORItem *pItem)
4205{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004206 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004207 if(pMe->uLastError != QCBOR_SUCCESS) {
4208 return;
4209 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004210
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004211 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004212}
4213
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004214
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004215void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4216 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004217 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004218 int64_t *pnValue,
4219 QCBORItem *pItem)
4220{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004221 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004222 if(pMe->uLastError != QCBOR_SUCCESS) {
4223 return;
4224 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004225
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004226 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004227}
4228
4229
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004230/*
4231 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004232
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004233 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004234
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004235 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004236
4237 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4238
4239 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large or too small.
4240
4241 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004242static QCBORError Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004243{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004244 switch(pItem->uDataType) {
4245
4246 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004247 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004248 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004249 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004250 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004251 }
4252 break;
4253
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004254 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004255 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004256 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004257 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004258 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004259 }
4260 break;
4261
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004262#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4263 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004264 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004265 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004266 pItem->val.expAndMantissa.nExponent,
4267 pnValue,
4268 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004269 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004270 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004271 }
4272 break;
4273
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004274 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004275 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004276 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004277 pItem->val.expAndMantissa.nExponent,
4278 pnValue,
4279 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004280 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004281 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004282 }
4283 break;
4284
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004285 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004286 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004287 int64_t nMantissa;
4288 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004289 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4290 if(uErr) {
4291 return uErr;
4292 }
4293 return ExponentiateNN(nMantissa,
4294 pItem->val.expAndMantissa.nExponent,
4295 pnValue,
4296 Exponentitate10);
4297 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004298 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004299 }
4300 break;
4301
4302 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004303 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004304 int64_t nMantissa;
4305 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004306 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4307 if(uErr) {
4308 return uErr;
4309 }
4310 return ExponentiateNN(nMantissa,
4311 pItem->val.expAndMantissa.nExponent,
4312 pnValue,
4313 Exponentitate10);
4314 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004315 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004316 }
4317 break;
4318
4319 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004320 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004321 int64_t nMantissa;
4322 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004323 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4324 if(uErr) {
4325 return uErr;
4326 }
4327 return ExponentiateNN(nMantissa,
4328 pItem->val.expAndMantissa.nExponent,
4329 pnValue,
4330 Exponentitate2);
4331 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004332 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004333 }
4334 break;
4335
4336 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004337 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004338 int64_t nMantissa;
4339 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004340 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4341 if(uErr) {
4342 return uErr;
4343 }
4344 return ExponentiateNN(nMantissa,
4345 pItem->val.expAndMantissa.nExponent,
4346 pnValue,
4347 Exponentitate2);
4348 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004349 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004350 }
4351 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004352#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4353
Laurence Lundbladee6430642020-03-14 21:15:44 -07004354
Laurence Lundbladec4537442020-04-14 18:53:22 -07004355 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004356 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004357}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004358
4359
Laurence Lundbladec4537442020-04-14 18:53:22 -07004360/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004361 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004362 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004363void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004364{
4365 QCBORItem Item;
4366
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004367 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004368
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004369 if(pMe->uLastError == QCBOR_SUCCESS) {
4370 // The above conversion succeeded
4371 return;
4372 }
4373
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004374 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004375 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004376 return;
4377 }
4378
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004379 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004380}
4381
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004382
4383/*
4384Public function, see header qcbor/qcbor_decode.h file
4385*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004386void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4387 int64_t nLabel,
4388 uint32_t uConvertTypes,
4389 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004390{
4391 QCBORItem Item;
4392
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004393 QCBORDecode_GetInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004394
4395 if(pMe->uLastError == QCBOR_SUCCESS) {
4396 // The above conversion succeeded
4397 return;
4398 }
4399
4400 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4401 // The above conversion failed in a way that code below can't correct
4402 return;
4403 }
4404
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004405 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004406}
4407
4408
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004409/*
4410Public function, see header qcbor/qcbor_decode.h file
4411*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004412void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4413 const char *szLabel,
4414 uint32_t uConvertTypes,
4415 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004416{
4417 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004418 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pnValue, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004419
4420 if(pMe->uLastError == QCBOR_SUCCESS) {
4421 // The above conversion succeeded
4422 return;
4423 }
4424
4425 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4426 // The above conversion failed in a way that code below can't correct
4427 return;
4428 }
4429
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004430 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004431}
4432
4433
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004434static QCBORError ConvertUint64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004435{
4436 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004437 case QCBOR_TYPE_DOUBLE:
4438 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004439#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004440 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4441 // TODO: this code needs work
4442 feclearexcept(FE_ALL_EXCEPT);
4443 double dRounded = round(pItem->val.dfnum);
4444 // TODO: over/underflow
4445 if(fetestexcept(FE_INVALID)) {
4446 // TODO: better error code
4447 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4448 } else if(isnan(dRounded)) {
4449 // TODO: better error code
4450 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4451 } else if(dRounded >= 0) {
4452 *puValue = (uint64_t)dRounded;
4453 } else {
4454 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4455 }
4456 } else {
4457 return QCBOR_ERR_UNEXPECTED_TYPE;
4458 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004459#else
4460 return QCBOR_ERR_HW_FLOAT_DISABLED;
4461#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004462 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004463
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004464 case QCBOR_TYPE_INT64:
4465 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4466 if(pItem->val.int64 >= 0) {
4467 *puValue = (uint64_t)pItem->val.int64;
4468 } else {
4469 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4470 }
4471 } else {
4472 return QCBOR_ERR_UNEXPECTED_TYPE;
4473 }
4474 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004475
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004476 case QCBOR_TYPE_UINT64:
4477 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4478 *puValue = pItem->val.uint64;
4479 } else {
4480 return QCBOR_ERR_UNEXPECTED_TYPE;
4481 }
4482 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004483
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004484 default:
4485 return QCBOR_ERR_UNEXPECTED_TYPE;
4486 }
4487
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004488 return QCBOR_SUCCESS;
4489}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004490
4491
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004492void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004493 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004494 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004495 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004496{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004497 if(pMe->uLastError != QCBOR_SUCCESS) {
4498 return;
4499 }
4500
Laurence Lundbladec4537442020-04-14 18:53:22 -07004501 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004502
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004503 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4504 if(uError) {
4505 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004506 return;
4507 }
4508
Laurence Lundbladea826c502020-05-10 21:07:00 -07004509 if(pItem) {
4510 *pItem = Item;
4511 }
4512
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004513 pMe->uLastError = (uint8_t)ConvertUint64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004514}
4515
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004516
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004517void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004518 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004519 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004520 uint64_t *puValue,
4521 QCBORItem *pItem)
4522{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004523 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004524 if(pMe->uLastError != QCBOR_SUCCESS) {
4525 return;
4526 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004527
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004528 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004529}
4530
4531
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004532void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004533 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004534 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004535 uint64_t *puValue,
4536 QCBORItem *pItem)
4537{
4538 if(pMe->uLastError != QCBOR_SUCCESS) {
4539 return;
4540 }
4541
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004542 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004543 if(pMe->uLastError != QCBOR_SUCCESS) {
4544 return;
4545 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004546
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004547 pMe->uLastError = (uint8_t)ConvertUint64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004548}
4549
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004550
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004551/*
4552 Public function, see header qcbor/qcbor_decode.h file
4553*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004554static QCBORError Uint64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004555{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004556 switch(pItem->uDataType) {
4557
4558 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004559 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004560 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4561 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004562 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004563 }
4564 break;
4565
4566 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004567 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004568 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4569 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004570 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004571 }
4572 break;
4573
4574#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4575
4576 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004577 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004578 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004579 pItem->val.expAndMantissa.nExponent,
4580 puValue,
4581 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004582 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004583 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004584 }
4585 break;
4586
4587 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004588 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004589 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4590 pItem->val.expAndMantissa.nExponent,
4591 puValue,
4592 Exponentitate2);
4593 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004594 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004595 }
4596 break;
4597
4598 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004599 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004600 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004601 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004602 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004603 if(uErr != QCBOR_SUCCESS) {
4604 return uErr;
4605 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004606 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004607 pItem->val.expAndMantissa.nExponent,
4608 puValue,
4609 Exponentitate10);
4610 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004611 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004612 }
4613 break;
4614
4615 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004616 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004617 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4618 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004619 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004620 }
4621 break;
4622
4623 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004624 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004625 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004626 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004627 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004628 if(uErr != QCBOR_SUCCESS) {
4629 return uErr;
4630 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004631 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004632 pItem->val.expAndMantissa.nExponent,
4633 puValue,
4634 Exponentitate2);
4635 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004636 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004637 }
4638 break;
4639
4640 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004641 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004642 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4643 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004644 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004645 }
4646 break;
4647#endif
4648 default:
4649 return QCBOR_ERR_UNEXPECTED_TYPE;
4650 }
4651}
4652
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004653
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004654/*
4655 Public function, see header qcbor/qcbor_decode.h file
4656*/
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004657void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004658{
4659 QCBORItem Item;
4660
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004661 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004662
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004663 if(pMe->uLastError == QCBOR_SUCCESS) {
4664 // The above conversion succeeded
4665 return;
4666 }
4667
4668 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4669 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004670 return;
4671 }
4672
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004673 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004674}
4675
Laurence Lundbladec4537442020-04-14 18:53:22 -07004676
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004677/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004678 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004679*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004680void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004681 int64_t nLabel,
4682 uint32_t uConvertTypes,
4683 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004684{
4685 QCBORItem Item;
4686
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004687 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe, nLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004688
4689 if(pMe->uLastError == QCBOR_SUCCESS) {
4690 // The above conversion succeeded
4691 return;
4692 }
4693
4694 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4695 // The above conversion failed in a way that code below can't correct
4696 return;
4697 }
4698
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004699 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004700}
4701
4702
4703/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004704 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004705*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004706void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004707 const char *szLabel,
4708 uint32_t uConvertTypes,
4709 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004710{
4711 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004712 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, puValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004713
4714 if(pMe->uLastError == QCBOR_SUCCESS) {
4715 // The above conversion succeeded
4716 return;
4717 }
4718
4719 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4720 // The above conversion failed in a way that code below can't correct
4721 return;
4722 }
4723
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004724 pMe->uLastError = (uint8_t)Uint64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004725}
4726
4727
Laurence Lundblade9b334962020-08-27 10:55:53 -07004728static QCBORError ConvertDouble(const QCBORItem *pItem,
4729 uint32_t uConvertTypes,
4730 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004731{
4732 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004733 case QCBOR_TYPE_FLOAT:
4734#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4735 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4736 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4737 *pdValue = (double)pItem->val.fnum;
4738 } else {
4739 return QCBOR_ERR_UNEXPECTED_TYPE;
4740 }
4741 }
4742#else
4743 return QCBOR_ERR_HW_FLOAT_DISABLED;
4744#endif
4745 break;
4746
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004747 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004748 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4749 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004750 *pdValue = pItem->val.dfnum;
4751 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004752 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004753 }
4754 }
4755 break;
4756
4757 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004758#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004759 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004760 // TODO: how does this work?
4761 *pdValue = (double)pItem->val.int64;
4762
4763 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004764 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004765 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004766#else
4767 return QCBOR_ERR_HW_FLOAT_DISABLED;
4768#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004769 break;
4770
4771 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004772#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004773 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004774 *pdValue = (double)pItem->val.uint64;
4775 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004776 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004777 }
4778 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004779#else
4780 return QCBOR_ERR_HW_FLOAT_DISABLED;
4781#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004782
4783 default:
4784 return QCBOR_ERR_UNEXPECTED_TYPE;
4785 }
4786
4787 return QCBOR_SUCCESS;
4788}
4789
4790
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004791void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004792 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004793 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004794 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004795{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004796 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004797 return;
4798 }
4799
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004800 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004801
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004802 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004803 if(uError) {
4804 pMe->uLastError = (uint8_t)uError;
4805 return;
4806 }
4807
4808 if(pItem) {
4809 *pItem = Item;
4810 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004811
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004812 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004813}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004814
Laurence Lundbladec4537442020-04-14 18:53:22 -07004815
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004816void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4817 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004818 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004819 double *pdValue,
4820 QCBORItem *pItem)
4821{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004822 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004823 if(pMe->uLastError != QCBOR_SUCCESS) {
4824 return;
4825 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004826
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004827 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004828}
4829
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004830
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004831void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4832 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004833 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004834 double *pdValue,
4835 QCBORItem *pItem)
4836{
4837 if(pMe->uLastError != QCBOR_SUCCESS) {
4838 return;
4839 }
4840
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004841 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004842 if(pMe->uLastError != QCBOR_SUCCESS) {
4843 return;
4844 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004845
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004846 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004847}
4848
4849
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004850#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004851static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4852{
4853 double dResult;
4854
4855 dResult = 0.0;
4856 const uint8_t *pByte = BigNum.ptr;
4857 size_t uLen = BigNum.len;
4858 /* This will overflow and become the float value INFINITY if the number
4859 is too large to fit. No error will be logged.
4860 TODO: should an error be logged? */
4861 while(uLen--) {
4862 dResult = (dResult * 256.0) + (double)*pByte++;
4863 }
4864
4865 return dResult;
4866}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004867#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4868
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004869
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004870static QCBORError DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004871{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004872#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004873 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004874 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4875
4876 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004877 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004878
4879#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004880 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004881 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004882 // TODO: rounding and overflow errors
4883 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4884 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4885 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004886 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004887 }
4888 break;
4889
4890 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004891 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004892 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4893 exp2((double)pItem->val.expAndMantissa.nExponent);
4894 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004895 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004896 }
4897 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004898#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004899
4900 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004901 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004902 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4903 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004904 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004905 }
4906 break;
4907
4908 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004909 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004910 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004911 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004912 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004913 }
4914 break;
4915
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004916#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004917 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004918 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004919 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4920 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4921 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004922 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004923 }
4924 break;
4925
4926 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004927 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004928 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4929 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4930 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004931 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004932 }
4933 break;
4934
4935 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004936 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004937 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4938 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4939 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004940 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004941 }
4942 break;
4943
4944 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004945 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004946 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004947 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
4948 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004949 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004950 }
4951 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004952#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4953
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004954
4955 default:
4956 return QCBOR_ERR_UNEXPECTED_TYPE;
4957 }
4958
4959 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004960
4961#else
4962 (void)pItem;
4963 (void)uConvertTypes;
4964 (void)pdValue;
4965 return QCBOR_ERR_HW_FLOAT_DISABLED;
4966#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4967
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004968}
4969
4970
4971/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004972 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004973*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07004974void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
4975 uint32_t uConvertTypes,
4976 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004977{
4978
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004979 QCBORItem Item;
4980
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004981 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004982
4983 if(pMe->uLastError == QCBOR_SUCCESS) {
4984 // The above conversion succeeded
4985 return;
4986 }
4987
4988 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4989 // The above conversion failed in a way that code below can't correct
4990 return;
4991 }
4992
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004993 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004994}
4995
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004996
4997/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004998 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004999*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005000void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5001 int64_t nLabel,
5002 uint32_t uConvertTypes,
5003 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005004{
5005 QCBORItem Item;
5006
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005007 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005008
5009 if(pMe->uLastError == QCBOR_SUCCESS) {
5010 // The above conversion succeeded
5011 return;
5012 }
5013
5014 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5015 // The above conversion failed in a way that code below can't correct
5016 return;
5017 }
5018
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005019 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005020}
5021
5022
5023/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005024 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005025*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005026void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5027 const char *szLabel,
5028 uint32_t uConvertTypes,
5029 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005030{
5031 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005032 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005033
5034 if(pMe->uLastError == QCBOR_SUCCESS) {
5035 // The above conversion succeeded
5036 return;
5037 }
5038
5039 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5040 // The above conversion failed in a way that code below can't correct
5041 return;
5042 }
5043
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005044 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005045}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005046
5047
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005048
5049
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005050#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005051static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5052{
5053 while((uInt & 0xff00000000000000UL) == 0) {
5054 uInt = uInt << 8;
5055 };
5056
5057 UsefulOutBuf UOB;
5058
5059 UsefulOutBuf_Init(&UOB, Buffer);
5060
5061 while(uInt) {
5062 const uint64_t xx = uInt & 0xff00000000000000UL;
5063 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5064 uInt = uInt << 8;
5065 (void)xx;
5066 }
5067
5068 return UsefulOutBuf_OutUBuf(&UOB);
5069}
5070
5071
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005072static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5073 TagSpecification TagSpec,
5074 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005075{
5076 QCBORError uErr;
5077 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005078 while(1) {
5079 uErr = CheckTagRequirement(TagSpec, pItem->uDataType);
5080 if(uErr != QCBOR_SUCCESS) {
5081 goto Done;
5082 }
5083
5084 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5085 break; // Successful exit. Moving on to finish decoding.
5086 }
5087
5088 // The item is an array, which means an undecoded
5089 // mantissa and exponent, so decode it. It will then
5090 // have a different type and exit the loop if.
5091 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5092 if(uErr != QCBOR_SUCCESS) {
5093 goto Done;
5094 }
5095
5096 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005097 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005098 }
5099Done:
5100 return uErr;
5101}
5102
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005103
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005104static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005105 TagSpecification TagSpec,
5106 QCBORItem *pItem,
5107 int64_t *pnMantissa,
5108 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005109{
5110 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005111
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005112 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005113 if(uErr != QCBOR_SUCCESS) {
5114 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005115 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005116
Laurence Lundblade9b334962020-08-27 10:55:53 -07005117 switch (pItem->uDataType) {
5118
5119 case QCBOR_TYPE_DECIMAL_FRACTION:
5120 case QCBOR_TYPE_BIGFLOAT:
5121 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5122 *pnExponent = pItem->val.expAndMantissa.nExponent;
5123 break;
5124
5125 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5126 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5127 *pnExponent = pItem->val.expAndMantissa.nExponent;
5128 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5129 break;
5130
5131 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5132 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5133 *pnExponent = pItem->val.expAndMantissa.nExponent;
5134 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5135 break;
5136
5137 default:
5138 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5139 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005140
5141 Done:
5142 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005143}
5144
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005145
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005146static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005147 TagSpecification TagSpec,
5148 QCBORItem *pItem,
5149 UsefulBuf BufferForMantissa,
5150 UsefulBufC *pMantissa,
5151 bool *pbIsNegative,
5152 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005153{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005154 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005155
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005156 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005157 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005158 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005159 }
5160
5161 uint64_t uMantissa;
5162
5163 switch (pItem->uDataType) {
5164
5165 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005166 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005167 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5168 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5169 *pbIsNegative = false;
5170 } else {
5171 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5172 *pbIsNegative = true;
5173 }
5174 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5175 *pnExponent = pItem->val.expAndMantissa.nExponent;
5176 break;
5177
5178 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005179 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005180 *pnExponent = pItem->val.expAndMantissa.nExponent;
5181 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5182 *pbIsNegative = false;
5183 break;
5184
5185 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005186 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005187 *pnExponent = pItem->val.expAndMantissa.nExponent;
5188 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5189 *pbIsNegative = true;
5190 break;
5191
5192 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005193 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005194 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005195
5196Done:
5197 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005198}
5199
5200
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005201/*
5202 Public function, see header qcbor/qcbor_decode.h file
5203*/
5204void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5205 uint8_t uTagRequirement,
5206 int64_t *pnMantissa,
5207 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005208{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005209 if(pMe->uLastError != QCBOR_SUCCESS) {
5210 return;
5211 }
5212
5213 QCBORItem Item;
5214 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5215 if(uError) {
5216 pMe->uLastError = (uint8_t)uError;
5217 return;
5218 }
5219
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005220 const TagSpecification TagSpec =
5221 {
5222 uTagRequirement,
5223 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5224 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5225 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005226
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005227 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005228}
5229
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005230
5231/*
5232 Public function, see header qcbor/qcbor_decode.h file
5233*/
5234void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005235 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005236 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005237 int64_t *pnMantissa,
5238 int64_t *pnExponent)
5239{
5240 if(pMe->uLastError != QCBOR_SUCCESS) {
5241 return;
5242 }
5243
5244 QCBORItem Item;
5245 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5246
5247 const TagSpecification TagSpec =
5248 {
5249 uTagRequirement,
5250 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5251 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5252 };
5253
5254 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5255}
5256
5257
5258/*
5259 Public function, see header qcbor/qcbor_decode.h file
5260*/
5261void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005262 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005263 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005264 int64_t *pnMantissa,
5265 int64_t *pnExponent)
5266{
5267 if(pMe->uLastError != QCBOR_SUCCESS) {
5268 return;
5269 }
5270
5271 QCBORItem Item;
5272 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5273
5274 const TagSpecification TagSpec =
5275 {
5276 uTagRequirement,
5277 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5278 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5279 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005280
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005281 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5282}
5283
5284
5285/*
5286 Public function, see header qcbor/qcbor_decode.h file
5287*/
5288void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5289 uint8_t uTagRequirement,
5290 UsefulBuf MantissaBuffer,
5291 UsefulBufC *pMantissa,
5292 bool *pbMantissaIsNegative,
5293 int64_t *pnExponent)
5294{
5295 if(pMe->uLastError != QCBOR_SUCCESS) {
5296 return;
5297 }
5298
5299 QCBORItem Item;
5300 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5301 if(uError) {
5302 pMe->uLastError = (uint8_t)uError;
5303 return;
5304 }
5305
5306 const TagSpecification TagSpec =
5307 {
5308 uTagRequirement,
5309 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5310 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5311 };
5312
5313 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
5314}
5315
5316
5317/*
5318 Public function, see header qcbor/qcbor_decode.h file
5319*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005320void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005321 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005322 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005323 UsefulBuf BufferForMantissa,
5324 UsefulBufC *pMantissa,
5325 bool *pbIsNegative,
5326 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005327{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005328 if(pMe->uLastError != QCBOR_SUCCESS) {
5329 return;
5330 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005331
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005332 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005333 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005334 if(pMe->uLastError != QCBOR_SUCCESS) {
5335 return;
5336 }
5337
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005338 const TagSpecification TagSpec =
5339 {
5340 uTagRequirement,
5341 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5342 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5343 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005344
5345 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005346}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005347
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005348
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005349/*
5350 Public function, see header qcbor/qcbor_decode.h file
5351*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005352void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005353 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005354 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005355 UsefulBuf BufferForMantissa,
5356 UsefulBufC *pMantissa,
5357 bool *pbIsNegative,
5358 int64_t *pnExponent)
5359{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005360 if(pMe->uLastError != QCBOR_SUCCESS) {
5361 return;
5362 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005363
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005364 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005365 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5366 if(pMe->uLastError != QCBOR_SUCCESS) {
5367 return;
5368 }
5369
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005370 const TagSpecification TagSpec =
5371 {
5372 uTagRequirement,
5373 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM, QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM},
5374 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5375 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005376
5377 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5378}
5379
5380
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005381/*
5382 Public function, see header qcbor/qcbor_decode.h file
5383*/
5384void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5385 uint8_t uTagRequirement,
5386 int64_t *pnMantissa,
5387 int64_t *pnExponent)
5388{
5389 if(pMe->uLastError != QCBOR_SUCCESS) {
5390 return;
5391 }
5392
5393 QCBORItem Item;
5394 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5395 if(uError) {
5396 pMe->uLastError = (uint8_t)uError;
5397 return;
5398 }
5399 const TagSpecification TagSpec =
5400 {
5401 uTagRequirement,
5402 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5403 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5404 };
5405
5406 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5407}
5408
5409
5410/*
5411 Public function, see header qcbor/qcbor_decode.h file
5412*/
5413void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005414 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005415 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005416 int64_t *pnMantissa,
5417 int64_t *pnExponent)
5418{
5419 if(pMe->uLastError != QCBOR_SUCCESS) {
5420 return;
5421 }
5422
5423 QCBORItem Item;
5424 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5425 if(pMe->uLastError != QCBOR_SUCCESS) {
5426 return;
5427 }
5428
5429 const TagSpecification TagSpec =
5430 {
5431 uTagRequirement,
5432 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5433 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5434 };
5435
5436 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5437}
5438
5439
5440/*
5441 Public function, see header qcbor/qcbor_decode.h file
5442*/
5443void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005444 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005445 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005446 int64_t *pnMantissa,
5447 int64_t *pnExponent)
5448{
5449 if(pMe->uLastError != QCBOR_SUCCESS) {
5450 return;
5451 }
5452
5453 QCBORItem Item;
5454 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5455 if(pMe->uLastError != QCBOR_SUCCESS) {
5456 return;
5457 }
5458
5459 const TagSpecification TagSpec =
5460 {
5461 uTagRequirement,
5462 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5463 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5464 };
5465
5466 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5467}
5468
5469
5470/*
5471 Public function, see header qcbor/qcbor_decode.h file
5472*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005473void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5474 uint8_t uTagRequirement,
5475 UsefulBuf MantissaBuffer,
5476 UsefulBufC *pMantissa,
5477 bool *pbMantissaIsNegative,
5478 int64_t *pnExponent)
5479{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005480 if(pMe->uLastError != QCBOR_SUCCESS) {
5481 return;
5482 }
5483
5484 QCBORItem Item;
5485 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5486 if(uError) {
5487 pMe->uLastError = (uint8_t)uError;
5488 return;
5489 }
5490
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005491 const TagSpecification TagSpec =
5492 {
5493 uTagRequirement,
5494 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5495 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5496 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005497
5498 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005499}
5500
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005501
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005502/*
5503 Public function, see header qcbor/qcbor_decode.h file
5504*/
5505void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005506 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005507 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005508 UsefulBuf BufferForMantissa,
5509 UsefulBufC *pMantissa,
5510 bool *pbIsNegative,
5511 int64_t *pnExponent)
5512{
5513 if(pMe->uLastError != QCBOR_SUCCESS) {
5514 return;
5515 }
5516
5517 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005518 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5519 if(pMe->uLastError != QCBOR_SUCCESS) {
5520 return;
5521 }
5522
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005523 const TagSpecification TagSpec =
5524 {
5525 uTagRequirement,
5526 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5527 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5528 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005529
5530 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5531}
5532
5533
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005534/*
5535 Public function, see header qcbor/qcbor_decode.h file
5536*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005537void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005538 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005539 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005540 UsefulBuf BufferForMantissa,
5541 UsefulBufC *pMantissa,
5542 bool *pbIsNegative,
5543 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005544{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005545 if(pMe->uLastError != QCBOR_SUCCESS) {
5546 return;
5547 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005548
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005549 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005550 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5551 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005552 return;
5553 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005554
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005555 const TagSpecification TagSpec =
5556 {
5557 uTagRequirement,
5558 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM, QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM},
5559 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
5560 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005561
5562 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005563}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005564
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005565#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */