blob: 8e8bdc293a9613cf5cef4f79b134e06654e8d397 [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 Lundblade3f1318a2021-01-04 18:26:44 -08003 Copyright (c) 2018-2021, Laurence Lundblade.
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02004 Copyright (c) 2021, Arm Limited.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07005 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08006
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07007Redistribution and use in source and binary forms, with or without
8modification, are permitted provided that the following conditions are
9met:
10 * Redistributions of source code must retain the above copyright
11 notice, this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above
13 copyright notice, this list of conditions and the following
14 disclaimer in the documentation and/or other materials provided
15 with the distribution.
16 * Neither the name of The Linux Foundation nor the names of its
17 contributors, nor the name "Laurence Lundblade" may be used to
18 endorse or promote products derived from this software without
19 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080020
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070021THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
22WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
24ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
25BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
30OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080032 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070033
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080034
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080035#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070036#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080037#include "ieee754.h" /* Does not use math.h */
Laurence Lundbladec7114722020-08-13 05:11:40 -070038
39#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080040
41#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
42 * pow(), exp2()
43 */
44#include <fenv.h> /* feclearexcept(), fetestexcept() */
45
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080046#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070047
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070048
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080049
Laurence Lundbladea9489f82020-09-12 13:50:56 -070050#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070051
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070052
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080053
54
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070055static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070056QCBORItem_IsMapOrArray(const QCBORItem *pMe)
57{
58 const uint8_t uDataType = pMe->uDataType;
59 return uDataType == QCBOR_TYPE_MAP ||
60 uDataType == QCBOR_TYPE_ARRAY ||
61 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
62}
63
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070064static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070065QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
66{
67 if(!QCBORItem_IsMapOrArray(pMe)){
68 return false;
69 }
70
71 if(pMe->val.uCount != 0) {
72 return false;
73 }
74 return true;
75}
76
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070077static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070078QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
79{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080080#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -070081 if(!QCBORItem_IsMapOrArray(pMe)){
82 return false;
83 }
84
85 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
86 return false;
87 }
88 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080089#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
90 (void)pMe;
91 return false;
92#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -070093}
94
95
Laurence Lundbladeee851742020-01-08 08:37:05 -080096/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070097 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080098 ===========================================================================*/
99
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700100/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800101 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
102 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700103 */
104
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700105
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700106static inline uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700107DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700108{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700109 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800110 /* Limit in DecodeNesting_Descend against more than
111 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700112 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700113 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700114}
115
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700116
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700117static inline uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700118DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700119{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700120 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800121 /* Limit in DecodeNesting_Descend against more than
122 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700123 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700124 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700125}
126
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700127
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700128static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700129DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700130{
131 return pNesting->pCurrentBounded->u.ma.uStartOffset;
132}
133
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700134
Laurence Lundblade085d7952020-07-24 10:26:30 -0700135static inline bool
136DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
137{
138 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
139 return true;
140 } else {
141 return false;
142 }
143}
144
145
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700146static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700147DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700148{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700149 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700150 return true;
151 } else {
152 return false;
153 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700154}
155
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700156
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700157static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700158DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700159{
160 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800161 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700162 return false;
163 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800164
165#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700166 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800167 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700168 return false;
169 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800170
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800171#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
172
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800173 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700174 return true;
175}
176
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700177static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700178DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700179{
180 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800181 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700182 return true;
183 }
184 return false;
185}
186
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700187
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700188static inline bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700189{
190 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
191 return true;
192 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700193 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700194 return true;
195 }
196 return false;
197}
198
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700199
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700200static inline void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700201{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800202 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700203 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800204 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
205 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
206 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700207 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700208 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700209
210 if(bIsEmpty) {
211 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
212 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700213}
214
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700215
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700216static inline void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700217{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700218 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700219}
220
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700221
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700222static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700223DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700224{
225 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800226 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700227 return false;
228 }
229 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800230 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700231 return false;
232 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700233 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800234 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700235 return false;
236 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800237 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800238 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
239 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800240 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700241 return false;
242 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800243 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700244 return true;
245}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700246
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700247
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700248static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700249DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700250{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800251 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700252 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
253 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700254 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700255 return false;
256 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700257}
258
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700259
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700260static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700261DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700262{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700263 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
264 return true;
265 } else {
266 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700267 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700268}
269
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700270
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700271static inline bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700272DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700273{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700274 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700275 return false;
276 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700277
278 if(pNesting->pCurrentBounded->uLevelType != uType) {
279 return false;
280 }
281
282 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700283}
284
Laurence Lundblade02625d42020-06-25 14:41:41 -0700285
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700286static inline void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700287DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700288{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800289 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700290 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700291}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700292
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700293
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700294static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700295DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
296{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800297 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700298 pNesting->pCurrent->u.ma.uCountCursor++;
299}
300
301
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700302static inline void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700303DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
304{
305 pNesting->pCurrent--;
306}
307
Laurence Lundblade02625d42020-06-25 14:41:41 -0700308
309static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700310DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700311{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800312 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700313 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700314 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700315 }
316
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800317 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700318 pNesting->pCurrent++;
319
320 pNesting->pCurrent->uLevelType = uType;
321
322 return QCBOR_SUCCESS;
323}
324
325
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700326static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800327DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
328 bool bIsEmpty,
329 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700330{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700331 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800332 * Should only be called on map/array.
333 *
334 * Have descended into this before this is called. The job here is
335 * just to mark it in bounded mode.
336 *
337 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
338 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
339 *
340 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700341 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800342 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700343 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700344 }
345
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700346 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700347
348 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700349
350 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700351}
352
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700353
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700354static inline QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700355DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700356 uint8_t uQCBORType,
357 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700358{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700359 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700360
361 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800362 /* Nothing to do for empty definite-length arrays. They are just are
363 * effectively the same as an item that is not a map or array.
364 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700365 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800366 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700367 }
368
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800369 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700370 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
371 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700372 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700373 goto Done;
374 }
375
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700376 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700377 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700378 goto Done;
379 }
380
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800381 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700382 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
383 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700384
385 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700386
387Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700388 return uError;;
389}
390
391
392static inline void
393DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
394{
395 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
396}
397
398
399static inline void
400DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
401{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700402 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700403 pNesting->pCurrentBounded--;
404 if(DecodeNesting_IsCurrentBounded(pNesting)) {
405 break;
406 }
407 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700408}
409
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800410
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700411static inline void
412DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
413{
414 pNesting->pCurrent = pNesting->pCurrentBounded;
415}
416
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700417
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700418static inline QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700419DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700420 uint32_t uEndOffset,
421 uint32_t uStartOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700422{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700423 QCBORError uError;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700424
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700425 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700426 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700427 goto Done;
428 }
429
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800430 /* Fill in the new byte string level */
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700431 pNesting->pCurrent->u.bs.uSavedEndOffset = uEndOffset;
432 pNesting->pCurrent->u.bs.uBstrStartOffset = uStartOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700433
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800434 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700435 pNesting->pCurrentBounded = pNesting->pCurrent;
436
437Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700438 return uError;;
439}
440
Laurence Lundbladed0304932020-06-27 10:59:38 -0700441
442static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700443DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700444{
445 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700446}
447
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700448
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700449static inline void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800450DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
451{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700452 if(pNesting->pCurrent->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
453 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
454 }
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800455}
456
457
458static inline void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700459DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700460{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700461 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700462 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
463 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700464}
465
466
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700467static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800468DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
469 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700470{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700471 *pSave = *pNesting;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700472}
473
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700474
Laurence Lundblade02625d42020-06-25 14:41:41 -0700475static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800476DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
477 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700478{
479 *pNesting = *pSave;
480}
481
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700482
Laurence Lundblade02625d42020-06-25 14:41:41 -0700483static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700484DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700485{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700486 return pMe->pCurrentBounded->u.bs.uSavedEndOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700487}
488
489
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800490
491
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800492#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800493/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800494 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
495
496 The following four functions are pretty wrappers for invocation of
497 the string allocator supplied by the caller.
498
Laurence Lundbladeee851742020-01-08 08:37:05 -0800499 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800500
Laurence Lundbladeee851742020-01-08 08:37:05 -0800501static inline void
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800502StringAllocator_Free(const QCBORInternalAllocator *pMe, const void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800503{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800504 /* These pragmas allow the "-Wcast-qual" warnings flag to be set for
505 * gcc and clang. This is the one place where the const needs to be
506 * cast away so const can be use in the rest of the code.
507 */
508#pragma GCC diagnostic push
509#pragma GCC diagnostic ignored "-Wcast-qual"
510 (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, 0);
511#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800512}
513
Laurence Lundbladeee851742020-01-08 08:37:05 -0800514// StringAllocator_Reallocate called with pMem NULL is
515// equal to StringAllocator_Allocate()
516static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800517StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800518 const void *pMem,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800519 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800520{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800521 /* See comment in StringAllocator_Free() */
522#pragma GCC diagnostic push
523#pragma GCC diagnostic ignored "-Wcast-qual"
524 return (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, uSize);
525#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800526}
527
Laurence Lundbladeee851742020-01-08 08:37:05 -0800528static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800529StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800530{
531 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
532}
533
Laurence Lundbladeee851742020-01-08 08:37:05 -0800534static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800535StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800536{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800537 /* See comment in StringAllocator_Free() */
538#pragma GCC diagnostic push
539#pragma GCC diagnostic ignored "-Wcast-qual"
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800540 if(pMe->pfAllocator) {
541 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
542 }
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800543#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800544}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800545#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800546
547
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800548
549
Laurence Lundbladeee851742020-01-08 08:37:05 -0800550/*===========================================================================
551 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700552
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800553 See qcbor/qcbor_decode.h for definition of the object
554 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800555 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700556/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800557 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700558 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800559void QCBORDecode_Init(QCBORDecodeContext *pMe,
560 UsefulBufC EncodedCBOR,
561 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700562{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800563 memset(pMe, 0, sizeof(QCBORDecodeContext));
564 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
565 /* Don't bother with error check on decode mode. If a bad value is
566 * passed it will just act as if the default normal mode of 0 was set.
567 */
568 pMe->uDecodeMode = (uint8_t)nDecodeMode;
569 DecodeNesting_Init(&(pMe->nesting));
570
571 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
572 * GetNext_TaggedItem() and MapTagNumber(). */
573 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700574}
575
576
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800577#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
578
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700579/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800580 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700581 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800582void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
583 QCBORStringAllocate pfAllocateFunction,
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800584 void *pAllocateContext,
585 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700586{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800587 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
588 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
589 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700590}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800591#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700592
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800593
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800594
595
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800596/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800597 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800598 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800599void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800600 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700601{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800602 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700603 (void)pMe;
604 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700605}
606
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700607
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800608
609
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700610/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800611 * Decoding items is done in six layers, one calling the next one
612 * down. If a layer has no work to do for a particular item, it
613 * returns quickly.
614 *
615 * 1. QCBORDecode_GetNextTagContent - The top layer processes tagged
616 * data items, turning them into the local C representation. For the
617 * most simple it is just associating a QCBOR_TYPE with the data. For
618 * the complex ones that an aggregate of data items, there is some
619 * further decoding and some limited recursion.
620 *
621 * 2. QCBORDecode_GetNextMapOrArray - This manages the beginnings and
622 * ends of maps and arrays. It tracks descending into and ascending
623 * out of maps/arrays. It processes breaks that terminate
624 * indefinite-length maps and arrays.
625 *
626 * 3. QCBORDecode_GetNextMapEntry - This handles the combining of two
627 * items, the label and the data, that make up a map entry. It only
628 * does work on maps. It combines the label and data items into one
629 * labeled item.
630 *
631 * 4. QCBORDecode_GetNextTagNumber - This decodes type 6 tag
632 * numbers. It turns the tag numbers into bit flags associated with
633 * the data item. No actual decoding of the contents of the tag is
634 * performed here.
635 *
636 * 5. QCBORDecode_GetNextFullString - This assembles the sub-items
637 * that make up an indefinite-length string into one string item. It
638 * uses the string allocator to create contiguous space for the
639 * item. It processes all breaks that are part of indefinite-length
640 * strings.
641 *
642 * 6. DecodeAtomicDataItem - This decodes the atomic data items in
643 * CBOR. Each atomic data item has a "major type", an integer
644 * "argument" and optionally some content. For text and byte strings,
645 * the content is the bytes that make up the string. These are the
646 * smallest data items that are considered to be well-formed. The
647 * content may also be other data items in the case of aggregate
648 * types. They are not handled in this layer.
649 *
650 * Roughly this takes 300 bytes of stack for vars. TODO: evaluate this
651 * more carefully and correctly.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700652 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800653
654
655/*
656 * Note about use of int and unsigned variables.
657 *
658 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
659 * used carefully here, and in particular why it isn't used in the
660 * public interface. Also see
661 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
662 *
663 * Int is used for values that need less than 16-bits and would be
664 * subject to integer promotion and result in complaining from static
665 * analyzers.
666 */
667
668
669/**
670 * @brief Decode the CBOR head, the type and argument.
671 *
672 * @param[in] pUInBuf The input buffer to read from.
673 * @param[out] pnMajorType The decoded major type.
674 * @param[out] puArgument The decoded argument.
675 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
676 *
677 * @retval QCBOR_ERR_UNSUPPORTED
678 * @retval QCBOR_ERR_HIT_END
679 *
680 * This decodes the CBOR "head" that every CBOR data item has. See
681 * longer explaination of the head in documentation for
682 * QCBOREncode_EncodeHead().
683 *
684 * This does the network->host byte order conversion. The conversion
685 * here also results in the conversion for floats in addition to that
686 * for lengths, tags and integer values.
687 *
688 * The int type is preferred to uint8_t for some variables as this
689 * avoids integer promotions, can reduce code size and makes static
690 * analyzers happier.
691 */
692static inline QCBORError
693DecodeHead(UsefulInputBuf *pUInBuf,
694 int *pnMajorType,
695 uint64_t *puArgument,
696 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700697{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800698 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800699
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800700 /* Get the initial byte that every CBOR data item has and break it
701 * down. */
702 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800703 const int nTmpMajorType = nInitialByte >> 5;
704 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800705
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800706 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800707 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800708
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800709 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800710 /* Need to get 1,2,4 or 8 additional argument bytes. Map
711 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
712 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800713 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800714
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800715 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800716 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800717 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800718 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800719 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
720 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800721 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800722 /* The reserved and thus-far unused additional info values */
723 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800724 goto Done;
725 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800726 /* Less than 24, additional info is argument or 31, an
727 * indefinite-length. No more bytes to get.
728 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800729 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700730 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800731
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700732 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800733 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700734 goto Done;
735 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800736
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800737 /* All successful if arrived here. */
738 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800739 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800740 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800741 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800742
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700743Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800744 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700745}
746
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800747
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800748/**
749 * @brief Decode integer types, major types 0 and 1.
750 *
751 * @param[in] nMajorType The CBOR major type (0 or 1).
752 * @param[in] uArgument The argument from the head.
753 * @param[out] pDecodedItem The filled in decoded item.
754 *
755 * @retval QCBOR_ERR_INT_OVERFLOW
756 *
757 * Must only be called when major type is 0 or 1.
758 *
759 * CBOR doesn't explicitly specify two's compliment for integers but
760 * all CPUs use it these days and the test vectors in the RFC are
761 * so. All integers in the CBOR structure are positive and the major
762 * type indicates positive or negative. CBOR can express positive
763 * integers up to 2^x - 1 where x is the number of bits and negative
764 * integers down to 2^x. Note that negative numbers can be one more
765 * away from zero than positive. Stdint, as far as I can tell, uses
766 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700767 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700768static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800769DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700770{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800771 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800772
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700773 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800774 if (uArgument <= INT64_MAX) {
775 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700776 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800777
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700778 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800779 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700780 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700781 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800782
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700783 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800784 if(uArgument <= INT64_MAX) {
785 /* CBOR's representation of negative numbers lines up with
786 * the two-compliment representation. A negative integer has
787 * one more in range than a positive integer. INT64_MIN is
788 * equal to (-INT64_MAX) - 1.
789 */
790 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700791 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800792
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700793 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800794 /* C can't represent a negative integer in this range so it
795 * is an error.
796 */
797 uReturn = QCBOR_ERR_INT_OVERFLOW;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700798 }
799 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800800
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800801 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700802}
803
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800804
805/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700806#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
807#error QCBOR_TYPE_FALSE macro value wrong
808#endif
809
810#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
811#error QCBOR_TYPE_TRUE macro value wrong
812#endif
813
814#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
815#error QCBOR_TYPE_NULL macro value wrong
816#endif
817
818#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
819#error QCBOR_TYPE_UNDEF macro value wrong
820#endif
821
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700822#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
823#error QCBOR_TYPE_BREAK macro value wrong
824#endif
825
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700826#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
827#error QCBOR_TYPE_DOUBLE macro value wrong
828#endif
829
830#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
831#error QCBOR_TYPE_FLOAT macro value wrong
832#endif
833
Laurence Lundblade9b334962020-08-27 10:55:53 -0700834
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800835/**
836 * @brief Decode major type 7 -- true, false, floating-point, break...
837 *
838 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
839 * @param[in] uArgument The argument from the head.
840 * @param[out] pDecodedItem The filled in decoded item.
841 *
842 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +0200843 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800844 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700845 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800846
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800847static inline QCBORError
848DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
849{
850 QCBORError uReturn = QCBOR_SUCCESS;
851
852 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
853 * checks above make sure uAdditionalInfo values line up with
854 * uDataType values. DecodeHead() never returns an AdditionalInfo
855 * > 0x1f so cast is safe.
856 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800857 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800858
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800859 switch(nAdditionalInfo) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800860 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
861 * are caught before this is called.
862 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800863
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800864 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700865#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800866 /* Half-precision is returned as a double. The cast to
867 * uint16_t is safe because the encoded value was 16 bits. It
868 * was widened to 64 bits to be passed in here.
869 */
870 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700871 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800872#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +0200873 uReturn = FLOAT_ERR_CODE_NO_HALF_PREC(QCBOR_SUCCESS);
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700874 break;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800875 case SINGLE_PREC_FLOAT: /* 26 */
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +0200876#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800877 /* Single precision is normally returned as a double since
878 * double is widely supported, there is no loss of precision,
879 * it makes it easy for the caller in most cases and it can
880 * be converted back to single with no loss of precision
881 *
882 * The cast to uint32_t is safe because the encoded value was
883 * 32 bits. It was widened to 64 bits to be passed in here.
884 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700885 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800886 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700887#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800888 /* In the normal case, use HW to convert float to
889 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700890 pDecodedItem->val.dfnum = (double)f;
891 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800892#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800893 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700894 pDecodedItem->val.fnum = f;
895 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
896
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800897 /* IEEE754_FloatToDouble() could be used here to return as
898 * a double, but it adds object code and most likely
899 * anyone disabling FLOAT HW use doesn't care about floats
900 * and wants to save object code.
901 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800902#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700903 }
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +0200904#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
905 uReturn = FLOAT_ERR_CODE_NO_FLOAT(QCBOR_SUCCESS);
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700906 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700907
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800908 case DOUBLE_PREC_FLOAT: /* 27 */
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +0200909#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800910 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700911 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +0200912#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
913 uReturn = FLOAT_ERR_CODE_NO_FLOAT(QCBOR_SUCCESS);
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700914 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800915
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800916 case CBOR_SIMPLEV_FALSE: /* 20 */
917 case CBOR_SIMPLEV_TRUE: /* 21 */
918 case CBOR_SIMPLEV_NULL: /* 22 */
919 case CBOR_SIMPLEV_UNDEF: /* 23 */
920 case CBOR_SIMPLE_BREAK: /* 31 */
921 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800922
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800923 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
924 if(uArgument <= CBOR_SIMPLE_BREAK) {
925 /* This takes out f8 00 ... f8 1f which should be encoded
926 * as e0 … f7
927 */
928 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700929 goto Done;
930 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800931 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800932
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800933 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700934 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800935 /* DecodeHead() will make uArgument equal to
936 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
937 * safe because the 2, 4 and 8 byte lengths of uNumber are in
938 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -0800939 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800940 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700941 break;
942 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800943
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700944Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800945 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700946}
947
948
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800949/**
950 * @brief Decode text and byte strings
951 *
952 * @param[in] pAllocator The string allocator or NULL.
953 * @param[in] uStrLen The length of the string.
954 * @param[in] pUInBuf The surce from which to read the string's bytes.
955 * @param[out] pDecodedItem The filled in decoded item.
956 *
957 * @retval QCBOR_ERR_HIT_END
958 * @retval QCBOR_ERR_STRING_ALLOCATE
959 * @retval QCBOR_ERR_STRING_TOO_LONG
960 *
961 * The reads @c uStrlen bytes from @c pUInBuf and fills in @c
962 * pDecodedItem. If @c pAllocator is not NULL then memory for the
963 * string is allocated.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700964 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800965static inline QCBORError
966DecodeBytes(const QCBORInternalAllocator *pAllocator,
967 uint64_t uStrLen,
968 UsefulInputBuf *pUInBuf,
969 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700970{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800971 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800972
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800973 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
974 * CPUs. This check makes the casts to size_t below safe.
975 *
976 * The max is 4 bytes less than the largest sizeof() so this can be
977 * tested by putting a SIZE_MAX length in the CBOR test input (no
978 * one will care the limit on strings is 4 bytes shorter).
979 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800980 if(uStrLen > SIZE_MAX-4) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800981 uReturn = QCBOR_ERR_STRING_TOO_LONG;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800982 goto Done;
983 }
984
985 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530986 if(UsefulBuf_IsNULLC(Bytes)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800987 /* Failed to get the bytes for this string item */
988 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530989 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700990 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530991
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800992#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800993 /* Note that this is not where allocation to coalesce
994 * indefinite-length strings is done. This is for when the caller
995 * has requested all strings be allocated. Disabling indefinite
996 * length strings also disables this allocate-all option.
997 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800998 if(pAllocator) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800999 /* request to use the string allocator to make a copy */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001000 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301001 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001002 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301003 goto Done;
1004 }
1005 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001006 pDecodedItem->uDataAlloc = 1;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001007 goto Done;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301008 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001009#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1010 (void)pAllocator;
1011#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1012
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001013 /* Normal case with no string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001014 pDecodedItem->val.string = Bytes;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001015
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301016Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001017 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001018}
1019
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001020
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001021/**
1022 * @brief Map the CBOR major types for strings to the QCBOR types.
1023 *
1024 * @param[in] nCBORMajorType The CBOR major type to convert.
1025 * @retturns QCBOR type number.
1026 *
1027 * This only works for the two string types.
1028 */
1029static inline uint8_t ConvertStringMajorTypes(int nCBORMajorType)
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001030{
1031 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
1032 #error QCBOR_TYPE_BYTE_STRING no lined up with major type
1033 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001034
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001035 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
1036 #error QCBOR_TYPE_TEXT_STRING no lined up with major type
1037 #endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001038
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001039 return (uint8_t)(nCBORMajorType + 4);
1040}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001041
1042
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001043/**
1044 * @brief Map the CBOR major types for arrays/maps to the QCBOR types.
1045 *
1046 * @param[in] nCBORMajorType The CBOR major type to convert.
1047 * @retturns QCBOR type number.
1048 *
1049 * This only works for the two aggregate types.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001050 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001051static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001052{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001053 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1054 #error QCBOR_TYPE_ARRAY value not lined up with major type
1055 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001056
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001057 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1058 #error QCBOR_TYPE_MAP value not lined up with major type
1059 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001060
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001061 return (uint8_t)(nCBORMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001062}
1063
1064
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001065/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001066 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001067 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001068 * @param[in] pUInBuf Input buffer to read data item from.
1069 * @param[out] pDecodedItem The filled-in decoded item.
1070 * @param[in] pAllocator The allocator to use for strings or NULL.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001071 *
1072 * @retval QCBOR_ERR_UNSUPPORTED
1073 * @retval QCBOR_ERR_HIT_END
1074 * @retval QCBOR_ERR_INT_OVERFLOW
1075 * @retval QCBOR_ERR_STRING_ALLOCATE
1076 * @retval QCBOR_ERR_STRING_TOO_LONG
1077 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001078 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001079 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001080 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1081 *
1082 * This decodes the most primitive / atomic data item. It does
1083 * no combing of data items.
1084 */
1085static QCBORError
1086DecodeAtomicDataItem(UsefulInputBuf *pUInBuf,
1087 QCBORItem *pDecodedItem,
1088 const QCBORInternalAllocator *pAllocator)
1089{
1090 QCBORError uReturn;
1091
1092 /* Get the major type and the argument. The argument could be
1093 * length of more bytes or the value depending on the major
1094 * type. nAdditionalInfo is an encoding of the length of the
1095 * uNumber and is needed to decode floats and doubles.
1096 */
1097 int nMajorType = 0;
1098 uint64_t uArgument = 0;
1099 int nAdditionalInfo = 0;
1100
1101 memset(pDecodedItem, 0, sizeof(QCBORItem));
1102
1103 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1104 if(uReturn) {
1105 goto Done;
1106 }
1107
1108 /* At this point the major type and the argument are valid. We've
1109 * got the type and the argument that starts every CBOR data item.
1110 */
1111 switch (nMajorType) {
1112 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1113 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
1114 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1115 uReturn = QCBOR_ERR_BAD_INT;
1116 } else {
1117 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
1118 }
1119 break;
1120
1121 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1122 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1123 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
1124 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1125 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
1126 } else {
1127 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
1128 }
1129 break;
1130
1131 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1132 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
1133 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1134 /* Indefinite-length string. */
1135#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1136 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1137#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1138 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1139 break;
1140#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1141 } else {
1142 /* Definite-length string. */
1143 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1144 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1145 goto Done;
1146 }
1147 /* cast OK because of check above */
1148 pDecodedItem->val.uCount = (uint16_t)uArgument;
1149 }
1150 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
1151 break;
1152
1153 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
1154 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1155 uReturn = QCBOR_ERR_BAD_INT;
1156 } else {
1157 pDecodedItem->val.uTagV = uArgument;
1158 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1159 }
1160 break;
1161
1162 case CBOR_MAJOR_TYPE_SIMPLE:
1163 /* Major type 7: float, double, true, false, null... */
1164 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
1165 break;
1166
1167 default:
1168 /* Never happens because DecodeHead() should never return > 7 */
1169 uReturn = QCBOR_ERR_UNSUPPORTED;
1170 break;
1171 }
1172
1173Done:
1174 return uReturn;
1175}
1176
1177
1178/**
1179 * @brief Process indefinite-length strings (decode layer 5).
1180 *
1181 * @param[in] pMe Decoder context
1182 * @param[out] pDecodedItem The decoded item that work is done on.
1183 *
1184 * @retval QCBOR_ERR_UNSUPPORTED
1185 * @retval QCBOR_ERR_HIT_END
1186 * @retval QCBOR_ERR_INT_OVERFLOW
1187 * @retval QCBOR_ERR_STRING_ALLOCATE
1188 * @retval QCBOR_ERR_STRING_TOO_LONG
1189 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001190 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001191 * @retval QCBOR_ERR_BAD_TYPE_7
1192 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001193 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1194 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001195 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001196 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001197 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001198 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001199 * If it is, this loops getting the subsequent chunk data items that
1200 * make up the string. The string allocator is used to make a
1201 * contiguous buffer for the chunks. When this completes @c
1202 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001203 *
1204 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001205 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001206static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001207QCBORDecode_GetNextFullString(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001208{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001209 /* Aproximate stack usage
1210 * 64-bit 32-bit
1211 * local vars 32 16
1212 * 2 UsefulBufs 32 16
1213 * QCBORItem 56 52
1214 * TOTAL 120 74
1215 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001216
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001217 /* The string allocator is used here for two purposes: 1)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001218 * coalescing the chunks of an indefinite-length string, 2)
1219 * allocating storage for every string returned when requested.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001220 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001221 * The first use is below in this function. Indefinite-length
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001222 * strings cannot be processed at all without a string allocator.
1223 *
1224 * The second used is in DecodeBytes() which is called by
1225 * GetNext_Item() below. This second use unneccessary for most use
1226 * and only happens when requested in the call to
1227 * QCBORDecode_SetMemPool(). If the second use not requested then
1228 * NULL is passed for the string allocator to GetNext_Item().
1229 *
1230 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1231 * allocator altogether and thus both of these uses. It reduced the
1232 * decoder object code by about 400 bytes.
1233 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001234 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001235
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001236#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001237 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001238
1239 if(pMe->StringAllocator.pfAllocator) {
1240 pAllocator = &(pMe->StringAllocator);
1241 if(pMe->bStringAllocateAll) {
1242 pAllocatorForGetNext = pAllocator;
1243 }
1244 }
1245#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1246
1247 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001248 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001249 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001250 goto Done;
1251 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001252
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001253 /* Only do indefinite-length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001254 const uint8_t uStringType = pDecodedItem->uDataType;
1255 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001256 goto Done;
1257 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001258
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001259 /* Is this a string with an indefinite length? */
1260 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1261 goto Done;
1262 }
1263
1264#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001265 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001266 if(pAllocator == NULL) {
1267 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1268 goto Done;
1269 }
1270
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001271 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001272 UsefulBufC FullString = NULLUsefulBufC;
1273
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001274 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001275 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001276 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001277 /* Pass a NULL string allocator to GetNext_Item() because the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001278 * individual string chunks in an indefinite-length should not
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001279 * be allocated. They are always copied in the the contiguous
1280 * buffer allocated here.
1281 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001282 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), &StringChunkItem, NULL);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001283 if(uReturn) {
1284 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001285 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001286
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001287 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001288 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001289 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001290 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301291 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001292 break;
1293 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001294
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001295 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001296 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001297 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001298 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001299 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001300 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001301 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1302 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001303 break;
1304 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001305
David Navarro9123e5b2022-03-28 16:04:03 +02001306 if (StringChunkItem.val.string.len > 0) {
1307 /* The first time throurgh FullString.ptr is NULL and this is
1308 * equivalent to StringAllocator_Allocate(). Subsequently it is
1309 * not NULL and a reallocation happens.
1310 */
1311 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1312 FullString.ptr,
1313 FullString.len + StringChunkItem.val.string.len);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001314
David Navarro9123e5b2022-03-28 16:04:03 +02001315 if(UsefulBuf_IsNULL(NewMem)) {
1316 uReturn = QCBOR_ERR_STRING_ALLOCATE;
1317 break;
1318 }
1319
1320 /* Copy new string chunk to the end of accumulated string */
1321 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001322 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001323 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001324
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001325 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1326 /* Getting the item failed, clean up the allocated memory */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001327 StringAllocator_Free(pAllocator, FullString.ptr);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001328 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001329#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1330 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1331#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001332
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001333Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001334 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001335}
1336
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001337
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001338/**
1339 * @brief This converts a tag number to a shorter mapped value for storage.
1340 *
1341 * @param[in] pMe The decode context.
1342 * @param[in] uUnMappedTag The tag number to map
1343 * @param[out] puMappedTagNumer The stored tag number.
1344 *
1345 * @return error code.
1346 *
1347 * The main point of mapping tag numbers is make QCBORItem
1348 * smaller. With this mapping storage of 4 tags takes up 8
1349 * bytes. Without, it would take up 32 bytes.
1350 *
1351 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1352 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1353 *
1354 * See also UnMapTagNumber() and @ref QCBORItem.
1355 */
1356static inline QCBORError
1357MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1358{
1359 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1360 unsigned uTagMapIndex;
1361 /* Is there room in the tag map, or is it in it already? */
1362 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1363 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1364 break;
1365 }
1366 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1367 break;
1368 }
1369 }
1370 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1371 return QCBOR_ERR_TOO_MANY_TAGS;
1372 }
1373
1374 /* Covers the cases where tag is new and were it is already in the map */
1375 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1376 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1377
1378 } else {
1379 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1380 }
1381
1382 return QCBOR_SUCCESS;
1383}
1384
1385
1386/**
1387 * @brief This converts a mapped tag number to the actual tag number.
1388 *
1389 * @param[in] pMe The decode context.
1390 * @param[in] uMappedTagNumber The stored tag number.
1391 *
1392 * @return The actual tag number is returned or
1393 * @ref CBOR_TAG_INVALID64 on error.
1394 *
1395 * This is the reverse of MapTagNumber()
1396 */
1397static uint64_t
1398UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1399{
1400 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1401 return uMappedTagNumber;
1402 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001403 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001404 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001405 /* This won't be negative because of code below in
1406 * MapTagNumber()
1407 */
1408 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1409 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001410 }
1411}
1412
Laurence Lundblade9b334962020-08-27 10:55:53 -07001413
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001414/**
1415 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1416 *
1417 * @param[in] pMe Decoder context
1418 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001419
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001420 * @retval QCBOR_ERR_UNSUPPORTED
1421 * @retval QCBOR_ERR_HIT_END
1422 * @retval QCBOR_ERR_INT_OVERFLOW
1423 * @retval QCBOR_ERR_STRING_ALLOCATE
1424 * @retval QCBOR_ERR_STRING_TOO_LONG
1425 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001426 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001427 * @retval QCBOR_ERR_BAD_TYPE_7
1428 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1429 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1430 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1431 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1432 * @retval QCBOR_ERR_TOO_MANY_TAGS
1433 *
1434 * This loops getting atomic data items until one is not a tag
1435 * number. Usually this is largely pass-through because most
1436 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001437 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001438static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001439QCBORDecode_GetNextTagNumber(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001440{
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001441 /* Accummulate the tags from multiple items here and then copy them
1442 * into the last item, the non-tag item.
1443 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001444 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1445
1446 /* Initialize to CBOR_TAG_INVALID16 */
1447 #if CBOR_TAG_INVALID16 != 0xffff
1448 /* Be sure the memset does the right thing. */
1449 #err CBOR_TAG_INVALID16 tag not defined as expected
1450 #endif
1451 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001452
Laurence Lundblade9b334962020-08-27 10:55:53 -07001453 QCBORError uReturn = QCBOR_SUCCESS;
1454
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001455 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001456 for(;;) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001457 QCBORError uErr = QCBORDecode_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001458 if(uErr != QCBOR_SUCCESS) {
1459 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001460 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001461 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001462
Laurence Lundblade9b334962020-08-27 10:55:53 -07001463 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001464 /* Successful exit from loop; maybe got some tags, maybe not */
1465 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001466 break;
1467 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001468
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001469 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1470 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001471 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001472 /* Continue on to get all tags wrapping this item even though
1473 * it is erroring out in the end. This allows decoding to
1474 * continue. This is a resource limit error, not a problem
1475 * with being well-formed CBOR.
1476 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001477 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001478 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001479 /* Slide tags over one in the array to make room at index 0.
1480 * Must use memmove because the move source and destination
1481 * overlap.
1482 */
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001483 memmove(&auItemsTags[1],
1484 auItemsTags,
1485 sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001486
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001487 /* Map the tag */
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001488 uint16_t uMappedTagNumber = 0;
1489 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumber);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001490 /* Continue even on error so as to consume all tags wrapping
1491 * this data item so decoding can go on. If MapTagNumber()
1492 * errors once it will continue to error.
1493 */
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001494 auItemsTags[0] = uMappedTagNumber;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001495 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001496
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001497Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001498 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001499}
1500
1501
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001502/**
1503 * @brief Combine a map entry label and value into one item (decode layer 3).
1504 *
1505 * @param[in] pMe Decoder context
1506 * @param[out] pDecodedItem The decoded item that work is done on.
1507 *
1508 * @retval QCBOR_ERR_UNSUPPORTED
1509 * @retval QCBOR_ERR_HIT_END
1510 * @retval QCBOR_ERR_INT_OVERFLOW
1511 * @retval QCBOR_ERR_STRING_ALLOCATE
1512 * @retval QCBOR_ERR_STRING_TOO_LONG
1513 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001514 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001515 * @retval QCBOR_ERR_BAD_TYPE_7
1516 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1517 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1518 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1519 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1520 * @retval QCBOR_ERR_TOO_MANY_TAGS
1521 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1522 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1523 *
1524 * If a the current nesting level is a map, then this
1525 * combines pairs of items into one data item with a label
1526 * and value.
1527 *
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01001528 * This is passthrough if the current nesting leve is
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001529 * not a map.
1530 *
1531 * This also implements maps-as-array mode where a map
1532 * is treated like an array to allow caller to do their
1533 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001534 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001535static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001536QCBORDecode_GetNextMapEntry(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001537{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001538 QCBORError uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1539 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001540 goto Done;
1541 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001542
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001543 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1544 /* Break can't be a map entry */
1545 goto Done;
1546 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001547
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001548 if(pMe->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1549 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001550
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001551 if(DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1552 /* Save label in pDecodedItem and get the next which will
1553 * be the real data item.
1554 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001555 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001556 uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1557 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001558 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001559 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001560
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301561 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001562
1563 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001564 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001565 pDecodedItem->label.string = LabelItem.val.string;
1566 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001567 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == pMe->uDecodeMode) {
1568 /* It's not a string and we only want strings */
1569 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001570 goto Done;
1571 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1572 pDecodedItem->label.int64 = LabelItem.val.int64;
1573 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1574 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1575 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1576 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1577 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1578 pDecodedItem->label.string = LabelItem.val.string;
1579 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1580 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1581 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001582 /* label is not an int or a string. It is an arrray
1583 * or a float or such and this implementation doesn't handle that.
1584 * Also, tags on labels are ignored.
1585 */
1586 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001587 goto Done;
1588 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001589 }
1590 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001591 /* Decoding of maps as arrays to let the caller decide what to do
1592 * about labels, particularly lables that are not integers or
1593 * strings.
1594 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001595 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001596 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001597 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001598 goto Done;
1599 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001600 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001601 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1602 * Cast is needed because of integer promotion.
1603 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001604 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001605 }
1606 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001607
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001608Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001609 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001610}
1611
1612
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001613#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001614/**
1615 * @brief Peek and see if next data item is a break;
1616 *
1617 * @param[in] pUIB UsefulInputBuf to read from.
1618 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1619 *
1620 * @return Any decoding error.
1621 *
1622 * See if next item is a CBOR break. If it is, it is consumed,
1623 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001624*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001625static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001626NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1627{
1628 *pbNextIsBreak = false;
1629 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001630 QCBORItem Peek;
1631 size_t uPeek = UsefulInputBuf_Tell(pUIB);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001632 QCBORError uReturn = DecodeAtomicDataItem(pUIB, &Peek, NULL);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001633 if(uReturn != QCBOR_SUCCESS) {
1634 return uReturn;
1635 }
1636 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001637 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001638 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001639 } else {
1640 *pbNextIsBreak = true;
1641 }
1642 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001643
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001644 return QCBOR_SUCCESS;
1645}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001646#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001647
1648
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001649/**
1650 * @brief Ascend up nesting levels if all items in them have been consumed.
1651 *
1652 * @param[in] pMe The decode context.
1653 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1654 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001655 * An item was just consumed, now figure out if it was the
1656 * end of an array/map map that can be closed out. That
1657 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001658*/
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001659static QCBORError
1660QCBORDecode_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001661{
1662 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001663
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001664 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001665 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1666
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001667 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1668 /* Nesting level is bstr-wrapped CBOR */
1669
1670 /* Ascent for bstr-wrapped CBOR is always by explicit call
1671 * so no further ascending can happen.
1672 */
1673 break;
1674
1675 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1676 /* Level is a definite-length array/map */
1677
1678 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001679 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1680 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001681 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001682 break;
1683 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001684 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001685 * is time to ascend one level. This happens below.
1686 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001687
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001688#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001689 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001690 /* Level is an indefinite-length array/map. */
1691
1692 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001693 bool bIsBreak = false;
1694 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1695 if(uReturn != QCBOR_SUCCESS) {
1696 goto Done;
1697 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001698
1699 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001700 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001701 break;
1702 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001703
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001704 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001705 * it is time to ascend one level.
1706 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001707
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001708#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001709 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001710
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001711
1712 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001713
Laurence Lundblade93d89472020-10-03 22:30:50 -07001714 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001715 * QCBORDecode_ExitBoundedMode().
1716 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001717 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001718 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001719 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001720 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001721 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001722 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001723
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001724 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001725 break;
1726 }
1727
1728 /* Finally, actually ascend one level. */
1729 DecodeNesting_Ascend(&(pMe->nesting));
1730 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001731
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001732 uReturn = QCBOR_SUCCESS;
1733
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001734#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001735Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001736#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1737
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001738 return uReturn;
1739}
1740
1741
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001742/**
1743 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1744 *
1745 * @param[in] pMe Decoder context
1746 * @param[out] pDecodedItem The decoded item that work is done on.
1747 *
1748 * @retval QCBOR_ERR_UNSUPPORTED
1749 * @retval QCBOR_ERR_HIT_END
1750 * @retval QCBOR_ERR_INT_OVERFLOW
1751 * @retval QCBOR_ERR_STRING_ALLOCATE
1752 * @retval QCBOR_ERR_STRING_TOO_LONG
1753 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001754 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001755 * @retval QCBOR_ERR_BAD_TYPE_7
1756 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1757 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1758 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1759 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1760 * @retval QCBOR_ERR_TOO_MANY_TAGS
1761 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1762 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1763 * @retval QCBOR_ERR_NO_MORE_ITEMS
1764 * @retval QCBOR_ERR_BAD_BREAK
1765 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
1766 *
1767 * This handles the traversal descending into and asecnding out of
1768 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
1769 * definite- and indefinte-length maps and arrays by looking at the
1770 * item count or finding CBOR breaks. It detects the ends of the
1771 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001772 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001773static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001774QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001775{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001776 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001777 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001778
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001779 /* If out of bytes to consume, it is either the end of the
1780 * top-level sequence of some bstr-wrapped CBOR that was entered.
1781 *
1782 * In the case of bstr-wrapped CBOR, the length of the
1783 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
1784 * the bstr-wrapped CBOR is exited, the length is set back to the
1785 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001786 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001787 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001788 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001789 goto Done;
1790 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001791
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001792 /* Check to see if at the end of a bounded definite-length map or
1793 * array. The check for a break ending indefinite-length array is
1794 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001795 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001796 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001797 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001798 goto Done;
1799 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001800
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001801 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001802 uReturn = QCBORDecode_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001803 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1804 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001805 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001806 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301807
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001808 /* Breaks ending arrays/maps are processed later in the call to
1809 * QCBORDecode_NestLevelAscender(). They should never show up here.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001810 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301811 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001812 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301813 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301814 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001815
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001816 /* Record the nesting level for this data item before processing
1817 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001818 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001819 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001820
Laurence Lundblade642282a2020-06-23 12:00:33 -07001821
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001822 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001823 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001824 /* If the new item is a map or array, descend.
1825 *
1826 * Empty indefinite-length maps and arrays are descended into,
1827 * but then ascended out of in the next chunk of code.
1828 *
1829 * Maps and arrays do count as items in the map/array that
1830 * encloses them so a decrement needs to be done for them too,
1831 * but that is done only when all the items in them have been
1832 * processed, not when they are opened with the exception of an
1833 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001834 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001835 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001836 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001837 pDecodedItem->uDataType,
1838 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001839 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001840 /* This error is probably a traversal error and it overrides
1841 * the non-traversal error.
1842 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001843 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001844 goto Done;
1845 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001846 }
1847
Laurence Lundblade02625d42020-06-25 14:41:41 -07001848 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1849 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1850 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001851 /* The following cases are handled here:
1852 * - A non-aggregate item like an integer or string
1853 * - An empty definite-length map or array
1854 * - An indefinite-length map or array that might be empty or might not.
1855 *
1856 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
1857 * for an definite-length map/array and break detection for an
1858 * indefinite-0length map/array. If the end of the map/array was
1859 * reached, then it ascends nesting levels, possibly all the way
1860 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001861 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001862 QCBORError uAscendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001863 uAscendErr = QCBORDecode_NestLevelAscender(pMe, true);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001864 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001865 /* This error is probably a traversal error and it overrides
1866 * the non-traversal error.
1867 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001868 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001869 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001870 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301871 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001872
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001873 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001874 /* Tell the caller what level is next. This tells them what
1875 * maps/arrays were closed out and makes it possible for them to
1876 * reconstruct the tree with just the information returned in a
1877 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001878 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001879 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001880 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001881 pDecodedItem->uNextNestLevel = 0;
1882 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001883 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001884 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001885
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001886Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001887 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001888}
1889
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001890
1891/**
1892 * @brief Shift 0th tag out of the tag list.
1893 *
1894 * pDecodedItem[in,out] The data item to convert.
1895 *
1896 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
1897 * shifted into empty slot at the end of the tag list.
1898 */
1899static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001900{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001901 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
1902 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
1903 }
1904 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001905}
1906
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001907
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001908/**
1909 * @brief Convert different epoch date formats in to the QCBOR epoch date format
1910 *
1911 * pDecodedItem[in,out] The data item to convert.
1912 *
1913 * @retval QCBOR_ERR_DATE_OVERFLOW
1914 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001915 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001916 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1917 *
1918 * The epoch date tag defined in QCBOR allows for floating-point
1919 * dates. It even allows a protocol to flop between date formats when
1920 * ever it wants. Floating-point dates aren't that useful as they are
1921 * only needed for dates beyond the age of the earth.
1922 *
1923 * This converts all the date formats into one format of an unsigned
1924 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001925 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001926static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001927{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001928 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001929
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001930#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade59289e52019-12-30 13:44:37 -08001931 pDecodedItem->val.epochDate.fSecondsFraction = 0;
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02001932#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001933
1934 switch (pDecodedItem->uDataType) {
1935
1936 case QCBOR_TYPE_INT64:
1937 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1938 break;
1939
1940 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001941 /* This only happens for CBOR type 0 > INT64_MAX so it is
1942 * always an overflow.
1943 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001944 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1945 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001946 break;
1947
1948 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001949 case QCBOR_TYPE_FLOAT:
1950#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001951 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001952 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001953 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001954 pDecodedItem->val.dfnum :
1955 (double)pDecodedItem->val.fnum;
1956
1957 /* The conversion from float to integer requires overflow
1958 * detection since floats can be much larger than integers.
1959 * This implementation errors out on these large float values
1960 * since they are beyond the age of the earth.
1961 *
1962 * These constants for the overflow check are computed by the
1963 * compiler. They are not computed at run time.
1964 *
1965 * The factor of 0x7ff is added/subtracted to avoid a
1966 * rounding error in the wrong direction when the compiler
Laurence Lundblade16a207a2021-09-18 17:22:46 -07001967 * computes these constants. There is rounding because a
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001968 * 64-bit integer has 63 bits of precision where a double
1969 * only has 53 bits. Without the 0x7ff factor, the compiler
1970 * may round up and produce a double for the bounds check
1971 * that is larger than can be stored in a 64-bit integer. The
1972 * amount of 0x7ff is picked because it has 11 bits set.
1973 *
1974 * Without the 0x7ff there is a ~30 minute range of time
1975 * values 10 billion years in the past and in the future
Laurence Lundblade16a207a2021-09-18 17:22:46 -07001976 * where this code could go wrong. Some compilers
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001977 * generate a warning or error without the 0x7ff.
1978 */
1979 const double dDateMax = (double)(INT64_MAX - 0x7ff);
1980 const double dDateMin = (double)(INT64_MIN + 0x7ff);
1981
1982 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07001983 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001984 goto Done;
1985 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001986
1987 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001988 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001989 pDecodedItem->val.epochDate.fSecondsFraction =
1990 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001991 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001992#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07001993
Laurence Lundblade16a207a2021-09-18 17:22:46 -07001994 uReturn = QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001995 goto Done;
1996
Laurence Lundblade9682a532020-06-06 18:33:04 -07001997#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001998 break;
1999
2000 default:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002001 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002002 goto Done;
2003 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002004
Laurence Lundblade59289e52019-12-30 13:44:37 -08002005 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
2006
2007Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07002008 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002009}
2010
2011
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002012/**
2013 * @brief Convert the days epoch date.
2014 *
2015 * pDecodedItem[in,out] The data item to convert.
2016 *
2017 * @retval QCBOR_ERR_DATE_OVERFLOW
2018 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02002019 * @retval QCBOR_ERR_ALL_FLOAT_DISABLED
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002020 * @retval QCBOR_ERR_BAD_TAG_CONTENT
2021 *
2022 * This is much simpler than the other epoch date format because
2023 * floating-porint is not allowed. This is mostly a simple type check.
2024 */
2025static QCBORError DecodeDaysEpoch(QCBORItem *pDecodedItem)
2026{
2027 QCBORError uReturn = QCBOR_SUCCESS;
2028
2029 switch (pDecodedItem->uDataType) {
2030
2031 case QCBOR_TYPE_INT64:
2032 pDecodedItem->val.epochDays = pDecodedItem->val.int64;
2033 break;
2034
2035 case QCBOR_TYPE_UINT64:
2036 /* This only happens for CBOR type 0 > INT64_MAX so it is
2037 * always an overflow.
2038 */
2039 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2040 goto Done;
2041 break;
2042
2043 default:
2044 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
2045 goto Done;
2046 break;
2047 }
2048
2049 pDecodedItem->uDataType = QCBOR_TYPE_DAYS_EPOCH;
2050
2051Done:
2052 return uReturn;
2053}
2054
2055
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002056#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002057/**
2058 * @brief Decode decimal fractions and big floats.
2059 *
2060 * @param[in] pMe The decode context.
2061 * @param[in,out] pDecodedItem On input the array data item that
2062 * holds the mantissa and exponent. On
2063 * output the decoded mantissa and
2064 * exponent.
2065 *
2066 * @returns Decoding errors from getting primitive data items or
2067 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2068 *
2069 * When called pDecodedItem must be the array that is tagged as a big
2070 * float or decimal fraction, the array that has the two members, the
2071 * exponent and mantissa.
2072 *
2073 * This will fetch and decode the exponent and mantissa and put the
2074 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002075 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002076static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002077QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002078{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002079 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002080
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002081 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002082 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002083 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002084 goto Done;
2085 }
2086
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002087 /* A check for pDecodedItem->val.uCount == 2 would work for
2088 * definite-length arrays, but not for indefnite. Instead remember
2089 * the nesting level the two integers must be at, which is one
2090 * deeper than that of the array.
2091 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002092 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2093
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002094 /* --- Which is it, decimal fraction or a bigfloat? --- */
2095 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002096 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2097
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002098 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002099 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002100 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2101 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002102 goto Done;
2103 }
2104 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002105 /* Array is empty or a map/array encountered when expecting an int */
2106 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002107 goto Done;
2108 }
2109 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002110 /* Data arriving as an unsigned int < INT64_MAX has been
2111 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2112 * also means that the only data arriving here of type
2113 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2114 * and thus an error that will get handled in the next else.
2115 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002116 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2117 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002118 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2119 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002120 goto Done;
2121 }
2122
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002123 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002124 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002125 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2126 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002127 goto Done;
2128 }
2129 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002130 /* Mantissa missing or map/array encountered when expecting number */
2131 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002132 goto Done;
2133 }
2134 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002135 /* Data arriving as an unsigned int < INT64_MAX has been
2136 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2137 * also means that the only data arriving here of type
2138 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2139 * and thus an error that will get handled in an else below.
2140 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002141 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002142 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2143 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002144 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002145 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002146 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002147 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2148 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2149 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002150 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002151 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2152 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002153 goto Done;
2154 }
2155
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002156 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002157 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002158 /* Extra items in the decimal fraction / big float */
2159 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002160 goto Done;
2161 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002162 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002163
2164Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002165 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002166}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002167#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002168
2169
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002170#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002171/**
2172 * @brief Decode the MIME type tag
2173 *
2174 * @param[in,out] pDecodedItem The item to decode.
2175 *
2176 * Handle the text and binary MIME type tags. Slightly too complicated
2177 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2178 * incorreclty text-only.
2179 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002180static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002181{
2182 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2183 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002184 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002185 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2186 } else {
2187 return QCBOR_ERR_BAD_OPT_TAG;
2188 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002189
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002190 return QCBOR_SUCCESS;
2191}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002192#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002193
2194
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002195/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002196 * Table of CBOR tags whose content is either a text string or a byte
2197 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2198 * of uQCBORtype indicates the content should be a byte string rather
2199 * than a text string
2200 */
2201struct StringTagMapEntry {
2202 uint16_t uTagNumber;
2203 uint8_t uQCBORtype;
2204};
2205
2206#define IS_BYTE_STRING_BIT 0x80
2207#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2208
2209static const struct StringTagMapEntry StringTagMap[] = {
2210 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002211 {CBOR_TAG_DAYS_STRING, QCBOR_TYPE_DAYS_STRING},
Laurence Lundblade99615302020-11-29 11:19:47 -08002212 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2213 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2214 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2215 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002216#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002217 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2218 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2219 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2220 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002221#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002222 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2223 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2224};
2225
2226
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002227/**
2228 * @brief Process standard CBOR tags whose content is a string
2229 *
2230 * @param[in] uTag The tag.
2231 * @param[in,out] pDecodedItem The data item.
2232 *
2233 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2234 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2235 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2236 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002237 * Process the CBOR tags that whose content is a byte string or a text
2238 * string and for which the string is just passed on to the caller.
2239 *
2240 * This maps the CBOR tag to the QCBOR type and checks the content
2241 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002242 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002243 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002244 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002245static inline QCBORError
2246ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002247{
Laurence Lundblade99615302020-11-29 11:19:47 -08002248 /* This only works on tags that were not mapped; no need for other yet */
2249 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2250 return QCBOR_ERR_UNSUPPORTED;
2251 }
2252
2253 unsigned uIndex;
2254 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2255 if(StringTagMap[uIndex].uTagNumber == uTag) {
2256 break;
2257 }
2258 }
2259
2260 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2261 if(uQCBORType == QCBOR_TYPE_NONE) {
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002262 /* repurpose this error to mean not handled here */
Laurence Lundblade99615302020-11-29 11:19:47 -08002263 return QCBOR_ERR_UNSUPPORTED;
2264 }
2265
2266 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2267 if(uQCBORType & IS_BYTE_STRING_BIT) {
2268 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2269 }
2270
2271 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002272 return QCBOR_ERR_BAD_OPT_TAG;
2273 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002274
Laurence Lundblade99615302020-11-29 11:19:47 -08002275 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002276 return QCBOR_SUCCESS;
2277}
2278
2279
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002280/**
2281 * @brief Decode tag content for select tags (decoding layer 1).
2282 *
2283 * @param[in] pMe The decode context.
2284 * @param[out] pDecodedItem The decoded item.
2285 *
2286 * @return Decoding error code.
2287 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002288 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2289 * but the whole tag was not decoded. Here, the whole tags (tag number
2290 * and tag content) that are supported by QCBOR are decoded. This is a
2291 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002292 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002293static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002294QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002295{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002296 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002297
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002298 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002299 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002300 goto Done;
2301 }
2302
Laurence Lundblade99615302020-11-29 11:19:47 -08002303 /* When there are no tag numbers for the item, this exits first
2304 * thing and effectively does nothing.
2305 *
2306 * This loops over all the tag numbers accumulated for this item
2307 * trying to decode and interpret them. This stops at the end of
2308 * the list or at the first tag number that can't be interpreted by
2309 * this code. This is effectively a recursive processing of the
2310 * tags number list that handles nested tags.
2311 */
2312 while(1) {
2313 /* Don't bother to unmap tags via QCBORITem.uTags since this
2314 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2315 */
2316 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002317
Laurence Lundblade99615302020-11-29 11:19:47 -08002318 if(uTagToProcess == CBOR_TAG_INVALID16) {
2319 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002320 break;
2321
Laurence Lundblade99615302020-11-29 11:19:47 -08002322 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002323 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002324
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002325 } else if(uTagToProcess == CBOR_TAG_DAYS_EPOCH) {
2326 uReturn = DecodeDaysEpoch(pDecodedItem);
2327
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002328#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002329 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2330 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002331 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002332#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002333#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002334 } else if(uTagToProcess == CBOR_TAG_MIME ||
2335 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002336 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002337#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002338
Laurence Lundblade99615302020-11-29 11:19:47 -08002339 } else {
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01002340 /* See if it is a passthrough byte/text string tag; process if so */
Laurence Lundblade99615302020-11-29 11:19:47 -08002341 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002342
Laurence Lundblade99615302020-11-29 11:19:47 -08002343 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
Laurence Lundbladea9e7ab92022-03-23 10:28:48 +01002344 /* It wasn't a passthrough byte/text string tag so it is
Laurence Lundblade99615302020-11-29 11:19:47 -08002345 * an unknown tag. This is the exit from the loop on the
2346 * first unknown tag. It is a successful exit.
2347 */
2348 uReturn = QCBOR_SUCCESS;
2349 break;
2350 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002351 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002352
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002353 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002354 /* Error exit from the loop */
2355 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002356 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002357
2358 /* A tag was successfully processed, shift it out of the list of
2359 * tags returned. This is the loop increment.
2360 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002361 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002362 }
2363
2364Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002365 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002366}
2367
2368
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002369/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002370 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002371 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002372QCBORError
2373QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2374{
2375 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002376 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002377 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002378 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2379 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2380 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002381 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002382}
2383
2384
2385/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002386 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002387 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002388QCBORError
2389QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2390{
2391 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2392 const UsefulInputBuf Save = pMe->InBuf;
2393
2394 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2395
2396 pMe->nesting = SaveNesting;
2397 pMe->InBuf = Save;
2398
2399 return uErr;
2400}
2401
2402
2403/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002404 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002405 */
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002406void
2407QCBORDecode_VPeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2408{
2409 if(pMe->uLastError != QCBOR_SUCCESS) {
2410 return;
2411 }
2412
2413 pMe->uLastError = (uint8_t)QCBORDecode_PeekNext(pMe, pDecodedItem);
2414}
2415
2416
2417/*
2418 * Public function, see header qcbor/qcbor_decode.h file
2419 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002420void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2421{
2422 if(pMe->uLastError != QCBOR_SUCCESS) {
2423 return;
2424 }
2425
2426 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2427}
2428
2429
2430/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002431 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002432 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002433QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002434QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2435 QCBORItem *pDecodedItem,
2436 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002437{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002438 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002439
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002440 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2441 if(uReturn != QCBOR_SUCCESS) {
2442 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002443 }
2444
2445 if(pTags != NULL) {
2446 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002447 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002448 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2449 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002450 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002451 }
2452 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2453 return QCBOR_ERR_TOO_MANY_TAGS;
2454 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002455 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002456 pTags->uNumUsed++;
2457 }
2458 }
2459
2460 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002461}
2462
2463
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002464/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002465 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302466 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002467bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002468 const QCBORItem *pItem,
2469 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002470{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002471 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2472 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002473 break;
2474 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002475 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002476 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002477 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002478 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002479
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002480 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002481}
2482
2483
2484/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002485 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002486 */
Laurence Lundblade87495732021-02-26 10:05:55 -07002487QCBORError QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002488{
Laurence Lundblade87495732021-02-26 10:05:55 -07002489 if(puConsumed != NULL) {
2490 *puConsumed = pMe->InBuf.cursor;
2491 }
2492
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002493 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002494
2495 if(uReturn != QCBOR_SUCCESS) {
2496 goto Done;
2497 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002498
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002499 /* Error out if all the maps/arrays are not closed out */
2500 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002501 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002502 goto Done;
2503 }
2504
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002505 /* Error out if not all the bytes are consumed */
2506 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002507 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002508 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002509
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002510Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002511 return uReturn;
2512}
2513
2514
2515/*
2516 * Public function, see header qcbor/qcbor_decode.h file
2517 */
2518QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
2519{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002520#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002521 /* Call the destructor for the string allocator if there is one.
2522 * Always called, even if there are errors; always have to clean up.
2523 */
2524 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002525#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002526
Laurence Lundblade87495732021-02-26 10:05:55 -07002527 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002528}
2529
2530
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002531/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002532 * Public function, see header qcbor/qcbor_decode.h file
2533 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002534// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002535uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2536 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002537 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002538{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002539 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2540 return CBOR_TAG_INVALID64;
2541 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002542 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2543 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002544 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002545 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002546 }
2547}
2548
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002549
Laurence Lundblade9b334962020-08-27 10:55:53 -07002550/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002551 * Public function, see header qcbor/qcbor_decode.h file
2552 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002553uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2554 uint32_t uIndex)
2555{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002556 if(pMe->uLastError != QCBOR_SUCCESS) {
2557 return CBOR_TAG_INVALID64;
2558 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002559 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2560 return CBOR_TAG_INVALID64;
2561 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002562 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002563 }
2564}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002565
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002566
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002567
2568
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002569#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002570
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002571/* ===========================================================================
2572 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002573
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002574 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002575 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2576 implements the function type QCBORStringAllocate and allows easy
2577 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002578
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002579 This particular allocator is built-in for convenience. The caller
2580 can implement their own. All of this following code will get
2581 dead-stripped if QCBORDecode_SetMemPool() is not called.
2582
2583 This is a very primitive memory allocator. It does not track
2584 individual allocations, only a high-water mark. A free or
2585 reallocation must be of the last chunk allocated.
2586
2587 The size of the pool and offset to free memory are packed into the
2588 first 8 bytes of the memory pool so we don't have to keep them in
2589 the decode context. Since the address of the pool may not be
2590 aligned, they have to be packed and unpacked as if they were
2591 serialized data of the wire or such.
2592
2593 The sizes packed in are uint32_t to be the same on all CPU types
2594 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002595 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002596
2597
Laurence Lundbladeee851742020-01-08 08:37:05 -08002598static inline int
2599MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002600{
2601 // Use of UsefulInputBuf is overkill, but it is convenient.
2602 UsefulInputBuf UIB;
2603
Laurence Lundbladeee851742020-01-08 08:37:05 -08002604 // Just assume the size here. It was checked during SetUp so
2605 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002606 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002607 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2608 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2609 return UsefulInputBuf_GetError(&UIB);
2610}
2611
2612
Laurence Lundbladeee851742020-01-08 08:37:05 -08002613static inline int
2614MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002615{
2616 // Use of UsefulOutBuf is overkill, but convenient. The
2617 // length check performed here is useful.
2618 UsefulOutBuf UOB;
2619
2620 UsefulOutBuf_Init(&UOB, Pool);
2621 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2622 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2623 return UsefulOutBuf_GetError(&UOB);
2624}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002625
2626
2627/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002628 Internal function for an allocation, reallocation free and destuct.
2629
2630 Having only one function rather than one each per mode saves space in
2631 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002632
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002633 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2634 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002635static UsefulBuf
2636MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002637{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002638 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002639
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002640 uint32_t uPoolSize;
2641 uint32_t uFreeOffset;
2642
2643 if(uNewSize > UINT32_MAX) {
2644 // This allocator is only good up to 4GB. This check should
2645 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2646 goto Done;
2647 }
2648 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2649
2650 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2651 goto Done;
2652 }
2653
2654 if(uNewSize) {
2655 if(pMem) {
2656 // REALLOCATION MODE
2657 // Calculate pointer to the end of the memory pool. It is
2658 // assumed that pPool + uPoolSize won't wrap around by
2659 // assuming the caller won't pass a pool buffer in that is
2660 // not in legitimate memory space.
2661 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2662
2663 // Check that the pointer for reallocation is in the range of the
2664 // pool. This also makes sure that pointer math further down
2665 // doesn't wrap under or over.
2666 if(pMem >= pPool && pMem < pPoolEnd) {
2667 // Offset to start of chunk for reallocation. This won't
2668 // wrap under because of check that pMem >= pPool. Cast
2669 // is safe because the pool is always less than UINT32_MAX
2670 // because of check in QCBORDecode_SetMemPool().
2671 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2672
2673 // Check to see if the allocation will fit. uPoolSize -
2674 // uMemOffset will not wrap under because of check that
2675 // pMem is in the range of the uPoolSize by check above.
2676 if(uNewSize <= uPoolSize - uMemOffset) {
2677 ReturnValue.ptr = pMem;
2678 ReturnValue.len = uNewSize;
2679
2680 // Addition won't wrap around over because uNewSize was
2681 // checked to be sure it is less than the pool size.
2682 uFreeOffset = uMemOffset + uNewSize32;
2683 }
2684 }
2685 } else {
2686 // ALLOCATION MODE
2687 // uPoolSize - uFreeOffset will not underflow because this
2688 // pool implementation makes sure uFreeOffset is always
2689 // smaller than uPoolSize through this check here and
2690 // reallocation case.
2691 if(uNewSize <= uPoolSize - uFreeOffset) {
2692 ReturnValue.len = uNewSize;
2693 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002694 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002695 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002696 }
2697 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002698 if(pMem) {
2699 // FREE MODE
2700 // Cast is safe because of limit on pool size in
2701 // QCBORDecode_SetMemPool()
2702 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2703 } else {
2704 // DESTRUCT MODE
2705 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002706 }
2707 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002708
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002709 UsefulBuf Pool = {pPool, uPoolSize};
2710 MemPool_Pack(Pool, uFreeOffset);
2711
2712Done:
2713 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002714}
2715
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002716
Laurence Lundbladef6531662018-12-04 10:42:22 +09002717/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002718 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002719 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002720QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2721 UsefulBuf Pool,
2722 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002723{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002724 // The pool size and free mem offset are packed into the beginning
2725 // of the pool memory. This compile time check make sure the
2726 // constant in the header is correct. This check should optimize
2727 // down to nothing.
2728 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002729 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002730 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002731
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002732 // The pool size and free offset packed in to the beginning of pool
2733 // memory are only 32-bits. This check will optimize out on 32-bit
2734 // machines.
2735 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002736 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002737 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002738
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002739 // This checks that the pool buffer given is big enough.
2740 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002741 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002742 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002743
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002744 QCBORDecode_SetUpAllocator(pMe, MemPool_Function, Pool.ptr, bAllStrings);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002745
Laurence Lundblade30816f22018-11-10 13:40:22 +07002746 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002747}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002748#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002749
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002750
2751
Laurence Lundblade9b334962020-08-27 10:55:53 -07002752static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2753{
2754 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2755}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002756
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002757
2758/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002759 Consume an entire map or array (and do next to
2760 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002761 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002762static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002763ConsumeItem(QCBORDecodeContext *pMe,
2764 const QCBORItem *pItemToConsume,
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02002765 uint8_t *puNextNestLevel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002766{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002767 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002768 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002769
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002770 // If it is a map or array, this will tell if it is empty.
2771 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2772
2773 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2774 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002775
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002776 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002777 * maps and arrays by using the nesting level
2778 */
2779 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002780 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002781 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002782 goto Done;
2783 }
2784 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002785
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002786 *puNextNestLevel = Item.uNextNestLevel;
2787
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002788 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002789
Laurence Lundblade1341c592020-04-11 14:19:05 -07002790 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002791 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002792 /* Just pass the nesting level through */
2793 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2794
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002795 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002796 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002797
2798Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002799 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002800}
2801
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002802
2803void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2804{
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002805 QCBORDecode_VGetNext(pMe, pDecodedItem);
2806
2807 if(pMe->uLastError == QCBOR_SUCCESS) {
Máté Tóth-Pálc6d59682021-05-26 18:55:30 +02002808 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem,
2809 &pDecodedItem->uNextNestLevel);
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002810 }
2811}
2812
2813
2814
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002815/* Call only on maps and arrays. Rewinds the cursor
2816 * to the start as if it was just entered.
2817 */
2818static void RewindMapOrArray(QCBORDecodeContext *pMe)
2819{
2820 /* Reset nesting tracking to the deepest bounded level */
2821 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2822
2823 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2824
2825 /* Reposition traversal cursor to the start of the map/array */
2826 UsefulInputBuf_Seek(&(pMe->InBuf),
2827 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2828}
2829
2830
2831/*
2832 Public function, see header qcbor/qcbor_decode.h file
2833 */
2834void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2835{
2836 if(pMe->nesting.pCurrentBounded != NULL) {
2837 /* In a bounded map, array or bstr-wrapped CBOR */
2838
2839 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2840 /* In bstr-wrapped CBOR. */
2841
2842 /* Reposition traversal cursor to start of wrapping byte string */
2843 UsefulInputBuf_Seek(&(pMe->InBuf),
2844 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2845 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2846
2847 } else {
2848 /* In a map or array */
2849 RewindMapOrArray(pMe);
2850 }
2851
2852 } else {
2853 /* Not in anything bounded */
2854
2855 /* Reposition traversal cursor to the start of input CBOR */
2856 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2857
2858 /* Reset nesting tracking to beginning of input. */
2859 DecodeNesting_Init(&(pMe->nesting));
2860 }
2861
2862 pMe->uLastError = QCBOR_SUCCESS;
2863}
2864
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002865
Laurence Lundblade1341c592020-04-11 14:19:05 -07002866/* Return true if the labels in Item1 and Item2 are the same.
2867 Works only for integer and string labels. Returns false
2868 for any other type. */
2869static inline bool
2870MatchLabel(QCBORItem Item1, QCBORItem Item2)
2871{
2872 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2873 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2874 return true;
2875 }
2876 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002877 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002878 return true;
2879 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002880 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002881 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2882 return true;
2883 }
2884 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2885 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2886 return true;
2887 }
2888 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002889
Laurence Lundblade1341c592020-04-11 14:19:05 -07002890 /* Other label types are never matched */
2891 return false;
2892}
2893
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002894
2895/*
2896 Returns true if Item1 and Item2 are the same type
2897 or if either are of QCBOR_TYPE_ANY.
2898 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002899static inline bool
2900MatchType(QCBORItem Item1, QCBORItem Item2)
2901{
2902 if(Item1.uDataType == Item2.uDataType) {
2903 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002904 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002905 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002906 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002907 return true;
2908 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002909 return false;
2910}
2911
2912
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002913/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002914 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002915
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002916 @param[in] pMe The decode context to search.
2917 @param[in,out] pItemArray The items to search for and the items found.
2918 @param[out] puOffset Byte offset of last item matched.
2919 @param[in] pCBContext Context for the not-found item call back.
2920 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002921
2922 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2923
Laurence Lundblade93d89472020-10-03 22:30:50 -07002924 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2925 were found for one of the labels being
2926 search for. This duplicate detection is
2927 only performed for items in pItemArray,
2928 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002929
Laurence Lundblade93d89472020-10-03 22:30:50 -07002930 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2931 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002932
2933 @retval Also errors returned by QCBORDecode_GetNext().
2934
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002935 On input pItemArray contains a list of labels and data types
2936 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002937
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002938 On output the fully retrieved items are filled in with
2939 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002940
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002941 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002942
2943 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002944 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002945static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002946MapSearch(QCBORDecodeContext *pMe,
2947 QCBORItem *pItemArray,
2948 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002949 void *pCBContext,
2950 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002951{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002952 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002953 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002954
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002955 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002956 uReturn = pMe->uLastError;
2957 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002958 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002959
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002960 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002961 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2962 /* QCBOR_TYPE_NONE as first item indicates just looking
2963 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002964 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2965 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002966 }
2967
Laurence Lundblade085d7952020-07-24 10:26:30 -07002968 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2969 // It is an empty bounded array or map
2970 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2971 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002972 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002973 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002974 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002975 // Nothing is ever found in an empty array or map. All items
2976 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002977 uReturn = QCBOR_SUCCESS;
2978 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002979 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002980 }
2981
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002982 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002983 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
Laurence Lundbladeaccf3562022-07-01 13:28:17 -07002984 const size_t uSaveCursor = UsefulInputBuf_Tell(&(pMe->InBuf));
2985
Laurence Lundblade085d7952020-07-24 10:26:30 -07002986
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002987 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002988 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002989
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002990 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002991 Loop over all the items in the map or array. Each item
2992 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002993 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002994 length maps and arrays. The only reason this is ever
2995 called on arrays is to find their end position.
2996
2997 This will always run over all items in order to do
2998 duplicate detection.
2999
3000 This will exit with failure if it encounters an
3001 unrecoverable error, but continue on for recoverable
3002 errors.
3003
3004 If a recoverable error occurs on a matched item, then
3005 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003006 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07003007 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02003008 uint8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003009 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003010 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07003011 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003012
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003013 /* Get the item */
3014 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003015 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003016 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003017 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003018 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003019 goto Done;
3020 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003021 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003022 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003023 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003024 goto Done;
3025 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003026
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003027 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003028 bool bMatched = false;
3029 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
3030 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003031 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003032 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
3033 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003034 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003035 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003036 if(uResult != QCBOR_SUCCESS) {
3037 /* The label matches, but the data item is in error */
3038 uReturn = uResult;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003039 goto Done;
3040 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003041 if(!MatchType(Item, pItemArray[nIndex])) {
3042 /* The data item is not of the type(s) requested */
3043 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003044 goto Done;
3045 }
3046
Laurence Lundblade1341c592020-04-11 14:19:05 -07003047 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003048 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003049 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003050 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003051 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003052 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003053 bMatched = true;
3054 }
3055 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003056
3057
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003058 if(!bMatched && pfCallback != NULL) {
3059 /*
3060 Call the callback on unmatched labels.
3061 (It is tempting to do duplicate detection here, but that would
3062 require dynamic memory allocation because the number of labels
3063 that might be encountered is unbounded.)
3064 */
3065 uReturn = (*pfCallback)(pCBContext, &Item);
3066 if(uReturn != QCBOR_SUCCESS) {
3067 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003068 }
3069 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003070
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003071 /*
3072 Consume the item whether matched or not. This
3073 does the work of traversing maps and array and
3074 everything in them. In this loop only the
3075 items at the current nesting level are examined
3076 to match the labels.
3077 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003078 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003079 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003080 goto Done;
3081 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003082
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003083 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003084
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003085 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003086
3087 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003088
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003089 // Check here makes sure that this won't accidentally be
3090 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003091 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003092 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3093 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003094 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3095 goto Done;
3096 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003097 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3098 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003099
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003100 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003101 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
Laurence Lundbladeaccf3562022-07-01 13:28:17 -07003102 UsefulInputBuf_Seek(&(pMe->InBuf), uSaveCursor);
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003103
3104 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003105 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003106 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003107 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003108 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3109 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003110 }
3111 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003112
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003113 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003114}
3115
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003116
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003117/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003118 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003119*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003120void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3121 int64_t nLabel,
3122 uint8_t uQcborType,
3123 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003124{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003125 if(pMe->uLastError != QCBOR_SUCCESS) {
3126 return;
3127 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003128
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003129 QCBORItem OneItemSeach[2];
3130 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3131 OneItemSeach[0].label.int64 = nLabel;
3132 OneItemSeach[0].uDataType = uQcborType;
3133 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003134
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003135 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003136
3137 *pItem = OneItemSeach[0];
3138
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003139 if(uReturn != QCBOR_SUCCESS) {
3140 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003141 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003142 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003143 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003144 }
3145
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003146 Done:
3147 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003148}
3149
3150
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003151/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003152 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003153*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003154void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3155 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003156 uint8_t uQcborType,
3157 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003158{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003159 if(pMe->uLastError != QCBOR_SUCCESS) {
3160 return;
3161 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003162
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003163 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003164 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3165 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3166 OneItemSeach[0].uDataType = uQcborType;
3167 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003168
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003169 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3170 if(uReturn != QCBOR_SUCCESS) {
3171 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003172 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003173 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003174 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003175 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003176 }
3177
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003178 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003179
3180Done:
3181 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003182}
3183
3184
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003185
Laurence Lundblade93d89472020-10-03 22:30:50 -07003186static QCBORError
3187CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003188{
3189 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3190 if(uDataType == puTypeList[i]) {
3191 return QCBOR_SUCCESS;
3192 }
3193 }
3194 return QCBOR_ERR_UNEXPECTED_TYPE;
3195}
3196
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003197
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003198/**
3199 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003200 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003201
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003202 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3203 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003204
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003205 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3206 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003207 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003208static QCBORError
3209CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003210{
3211 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3212 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3213 /* There are tags that QCBOR couldn't process on this item and
3214 the caller has told us there should not be. */
3215 return QCBOR_ERR_UNEXPECTED_TYPE;
3216 }
3217
3218 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3219 const int nItemType = pItem->uDataType;
3220
3221 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3222 // Must match the tag and only the tag
3223 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3224 }
3225
3226 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3227 if(uReturn == QCBOR_SUCCESS) {
3228 return QCBOR_SUCCESS;
3229 }
3230
3231 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3232 /* Must match the content type and only the content type.
3233 There was no match just above so it is a fail. */
3234 return QCBOR_ERR_UNEXPECTED_TYPE;
3235 }
3236
3237 /* If here it can match either the tag or the content
3238 and it hasn't matched the content, so the end
3239 result is whether it matches the tag. This is
3240 also the case that the CBOR standard discourages. */
3241
3242 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3243}
3244
Laurence Lundblade9b334962020-08-27 10:55:53 -07003245
Laurence Lundblade9b334962020-08-27 10:55:53 -07003246
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003247// This could be semi-private if need be
3248static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003249void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3250 int64_t nLabel,
3251 TagSpecification TagSpec,
3252 QCBORItem *pItem)
3253{
3254 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3255 if(pMe->uLastError != QCBOR_SUCCESS) {
3256 return;
3257 }
3258
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003259 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003260}
3261
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003262
3263// This could be semi-private if need be
3264static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003265void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3266 const char *szLabel,
3267 TagSpecification TagSpec,
3268 QCBORItem *pItem)
3269{
3270 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3271 if(pMe->uLastError != QCBOR_SUCCESS) {
3272 return;
3273 }
3274
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003275 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003276}
3277
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003278// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003279void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3280 int64_t nLabel,
3281 TagSpecification TagSpec,
3282 UsefulBufC *pString)
3283{
3284 QCBORItem Item;
3285 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3286 if(pMe->uLastError == QCBOR_SUCCESS) {
3287 *pString = Item.val.string;
3288 }
3289}
3290
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003291// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003292void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3293 const char * szLabel,
3294 TagSpecification TagSpec,
3295 UsefulBufC *pString)
3296{
3297 QCBORItem Item;
3298 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3299 if(pMe->uLastError == QCBOR_SUCCESS) {
3300 *pString = Item.val.string;
3301 }
3302}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003303
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003304/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003305 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003306*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003307void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003308{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003309 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3310 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003311}
3312
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003313/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003314 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003315*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003316void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3317 QCBORItem *pItemList,
3318 void *pCallbackCtx,
3319 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003320{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003321 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3322 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003323}
3324
3325
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003326/**
3327 * @brief Search for a map/array by label and enter it
3328 *
3329 * @param[in] pMe The decode context.
3330 * @param[in] pSearch The map/array to search for.
3331 *
3332 * @c pSearch is expected to contain one item of type map or array
3333 * with the label specified. The current bounded map will be searched for
3334 * this and if found will be entered.
3335 *
3336 * If the label is not found, or the item found is not a map or array,
3337 * the error state is set.
3338 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003339static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003340{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003341 // The first item in pSearch is the one that is to be
3342 // entered. It should be the only one filled in. Any other
3343 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003344 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003345 return;
3346 }
3347
3348 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003349 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003350 if(pMe->uLastError != QCBOR_SUCCESS) {
3351 return;
3352 }
3353
Laurence Lundblade9b334962020-08-27 10:55:53 -07003354 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003355 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003356 return;
3357 }
3358
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003359
3360 /* The map or array was found. Now enter it.
3361 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003362 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3363 * next item for the pre-order traversal cursor to be the map/array
3364 * found by MapSearch(). The next few lines of code force the
3365 * cursor to that.
3366 *
3367 * There is no need to retain the old cursor because
3368 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3369 * beginning of the map/array being entered.
3370 *
3371 * The cursor is forced by: 1) setting the input buffer position to
3372 * the item offset found by MapSearch(), 2) setting the map/array
3373 * counter to the total in the map/array, 3) setting the nesting
3374 * level. Setting the map/array counter to the total is not
3375 * strictly correct, but this is OK because this cursor only needs
3376 * to be used to get one item and MapSearch() has already found it
3377 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003378 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003379 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003380
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003381 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3382
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003383 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003384
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003385 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003386}
3387
3388
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003389/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003390 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003391*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003392void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003393{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003394 QCBORItem OneItemSeach[2];
3395 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3396 OneItemSeach[0].label.int64 = nLabel;
3397 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3398 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003399
Laurence Lundblade9b334962020-08-27 10:55:53 -07003400 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003401 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003402}
3403
3404
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003405/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003406 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003407*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003408void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003409{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003410 QCBORItem OneItemSeach[2];
3411 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3412 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3413 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3414 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003415
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003416 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003417}
3418
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003419/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003420 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003421*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003422void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003423{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003424 QCBORItem OneItemSeach[2];
3425 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3426 OneItemSeach[0].label.int64 = nLabel;
3427 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3428 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003429
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003430 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003431}
3432
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003433/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003434 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003435*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003436void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3437{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003438 QCBORItem OneItemSeach[2];
3439 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3440 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3441 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3442 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003443
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003444 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003445}
3446
3447
Laurence Lundblade02625d42020-06-25 14:41:41 -07003448// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003449void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003450{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003451 QCBORError uErr;
3452
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003453 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003454 if(pMe->uLastError != QCBOR_SUCCESS) {
3455 // Already in error state; do nothing.
3456 return;
3457 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003458
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003459 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003460 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003461 uErr = QCBORDecode_GetNext(pMe, &Item);
3462 if(uErr != QCBOR_SUCCESS) {
3463 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003464 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003465 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003466 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3467 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003468 }
3469
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003470 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003471
3472
Laurence Lundbladef0499502020-08-01 11:55:57 -07003473 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003474 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003475 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3476 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003477 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003478 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3479 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003480 // Special case to increment nesting level for zero-length maps
3481 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003482 DecodeNesting_Descend(&(pMe->nesting), uType);
3483 }
3484
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003485 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003486
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003487 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3488 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003489
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003490 if(pItem != NULL) {
3491 *pItem = Item;
3492 }
3493
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003494Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003495 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003496}
3497
Laurence Lundblade02625d42020-06-25 14:41:41 -07003498
3499/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003500 This is the common work for exiting a level that is a bounded map,
3501 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003502
3503 One chunk of work is to set up the pre-order traversal so it is at
3504 the item just after the bounded map, array or bstr that is being
3505 exited. This is somewhat complex.
3506
3507 The other work is to level-up the bounded mode to next higest bounded
3508 mode or the top level if there isn't one.
3509 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003510static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003511ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003512{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003513 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003514
Laurence Lundblade02625d42020-06-25 14:41:41 -07003515 /*
3516 First the pre-order-traversal byte offset is positioned to the
3517 item just after the bounded mode item that was just consumed.
3518 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003519 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3520
Laurence Lundblade02625d42020-06-25 14:41:41 -07003521 /*
3522 Next, set the current nesting level to one above the bounded level
3523 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003524
Laurence Lundblade02625d42020-06-25 14:41:41 -07003525 DecodeNesting_CheckBoundedType() is always called before this and
3526 makes sure pCurrentBounded is valid.
3527 */
3528 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3529
3530 /*
3531 This does the complex work of leveling up the pre-order traversal
3532 when the end of a map or array or another bounded level is
3533 reached. It may do nothing, or ascend all the way to the top
3534 level.
3535 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003536 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003537 if(uErr != QCBOR_SUCCESS) {
3538 goto Done;
3539 }
3540
Laurence Lundblade02625d42020-06-25 14:41:41 -07003541 /*
3542 This makes the next highest bounded level the current bounded
3543 level. If there is no next highest level, then no bounded mode is
3544 in effect.
3545 */
3546 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003547
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003548 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003549
3550Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003551 return uErr;
3552}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003553
Laurence Lundblade02625d42020-06-25 14:41:41 -07003554
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003555// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003556void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003557{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003558 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003559 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003560 return;
3561 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003562
Laurence Lundblade02625d42020-06-25 14:41:41 -07003563 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003564
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003565 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003566 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003567 goto Done;
3568 }
3569
Laurence Lundblade02625d42020-06-25 14:41:41 -07003570 /*
3571 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003572 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003573 from previous map search, then do a dummy search.
3574 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003575 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003576 QCBORItem Dummy;
3577 Dummy.uLabelType = QCBOR_TYPE_NONE;
3578 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3579 if(uErr != QCBOR_SUCCESS) {
3580 goto Done;
3581 }
3582 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003583
Laurence Lundblade02625d42020-06-25 14:41:41 -07003584 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003585
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003586Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003587 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003588}
3589
3590
Laurence Lundblade1341c592020-04-11 14:19:05 -07003591
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003592static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003593 const QCBORItem *pItem,
3594 uint8_t uTagRequirement,
3595 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003596{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003597 if(pBstr) {
3598 *pBstr = NULLUsefulBufC;
3599 }
3600
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003601 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003602 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003603 return pMe->uLastError;
3604 }
3605
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003606 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003607
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003608 const TagSpecification TagSpec =
3609 {
3610 uTagRequirement,
3611 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3612 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3613 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003614
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003615 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003616 if(uError != QCBOR_SUCCESS) {
3617 goto Done;
3618 }
3619
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003620 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003621 /* Reverse the decrement done by GetNext() for the bstr so the
3622 * increment in QCBORDecode_NestLevelAscender() called by
3623 * ExitBoundedLevel() will work right.
3624 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003625 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003626 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003627
3628 if(pBstr) {
3629 *pBstr = pItem->val.string;
3630 }
3631
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003632 /* This saves the current length of the UsefulInputBuf and then
3633 * narrows the UsefulInputBuf to start and length of the wrapped
3634 * CBOR that is being entered.
3635 *
3636 * Most of these calls are simple inline accessors so this doesn't
3637 * amount to much code.
3638 */
3639
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003640 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003641 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3642 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003643 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003644 goto Done;
3645 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003646
3647 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3648 pItem->val.string.ptr);
3649 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3650 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3651 /* This should never happen because pItem->val.string.ptr should
3652 * always be valid since it was just returned.
3653 */
3654 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3655 goto Done;
3656 }
3657
3658 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3659
3660 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003661 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003662
Laurence Lundblade02625d42020-06-25 14:41:41 -07003663 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003664 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003665 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003666Done:
3667 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003668}
3669
3670
Laurence Lundblade02625d42020-06-25 14:41:41 -07003671/*
3672 Public function, see header qcbor/qcbor_decode.h file
3673 */
3674void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003675 uint8_t uTagRequirement,
3676 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003677{
3678 if(pMe->uLastError != QCBOR_SUCCESS) {
3679 // Already in error state; do nothing.
3680 return;
3681 }
3682
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003683 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003684 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003685 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3686 if(pMe->uLastError != QCBOR_SUCCESS) {
3687 return;
3688 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003689
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003690 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003691 &Item,
3692 uTagRequirement,
3693 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003694}
3695
3696
Laurence Lundblade02625d42020-06-25 14:41:41 -07003697/*
3698 Public function, see header qcbor/qcbor_decode.h file
3699 */
3700void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003701 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003702 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003703 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003704{
3705 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003706 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003707
Laurence Lundblade93d89472020-10-03 22:30:50 -07003708 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3709 &Item,
3710 uTagRequirement,
3711 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003712}
3713
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003714
Laurence Lundblade02625d42020-06-25 14:41:41 -07003715/*
3716 Public function, see header qcbor/qcbor_decode.h file
3717 */
3718void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003719 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003720 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003721 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003722{
3723 QCBORItem Item;
3724 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3725
Laurence Lundblade93d89472020-10-03 22:30:50 -07003726 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3727 &Item,
3728 uTagRequirement,
3729 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003730}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003731
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003732
Laurence Lundblade02625d42020-06-25 14:41:41 -07003733/*
3734 Public function, see header qcbor/qcbor_decode.h file
3735 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003736void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003737{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003738 if(pMe->uLastError != QCBOR_SUCCESS) {
3739 // Already in error state; do nothing.
3740 return;
3741 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003742
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003743 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003744 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003745 return;
3746 }
3747
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003748 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3749
Laurence Lundblade02625d42020-06-25 14:41:41 -07003750 /*
3751 Reset the length of the UsefulInputBuf to what it was before
3752 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003753 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003754 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003755 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003756
3757
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003758 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003759 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003760}
3761
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003762
Laurence Lundbladee6430642020-03-14 21:15:44 -07003763
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003764
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003765static inline void
3766ProcessBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003767{
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003768 if(pMe->uLastError != QCBOR_SUCCESS) {
3769 /* Already in error state, do nothing */
3770 return;
3771 }
3772
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003773 switch(pItem->uDataType) {
3774 case QCBOR_TYPE_TRUE:
3775 *pBool = true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003776 break;
3777
3778 case QCBOR_TYPE_FALSE:
3779 *pBool = false;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003780 break;
3781
3782 default:
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003783 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003784 break;
3785 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003786 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003787}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003788
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003789
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003790/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003791 * Public function, see header qcbor/qcbor_decode.h file
3792 */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003793void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003794{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003795 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003796 /* Already in error state, do nothing */
Laurence Lundbladee6430642020-03-14 21:15:44 -07003797 return;
3798 }
3799
Laurence Lundbladec4537442020-04-14 18:53:22 -07003800 QCBORItem Item;
3801
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003802 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3803
3804 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003805}
3806
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003807
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003808/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003809 * Public function, see header qcbor/qcbor_decode.h file
3810 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003811void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003812{
3813 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003814 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003815
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003816 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003817}
3818
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003819
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003820/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003821 * Public function, see header qcbor/qcbor_decode.h file
3822 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003823void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3824{
3825 QCBORItem Item;
3826 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3827
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003828 ProcessBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003829}
3830
3831
3832
Laurence Lundbladec7114722020-08-13 05:11:40 -07003833
3834static void ProcessEpochDate(QCBORDecodeContext *pMe,
3835 QCBORItem *pItem,
3836 uint8_t uTagRequirement,
3837 int64_t *pnTime)
3838{
3839 if(pMe->uLastError != QCBOR_SUCCESS) {
3840 // Already in error state, do nothing
3841 return;
3842 }
3843
3844 QCBORError uErr;
3845
3846 const TagSpecification TagSpec =
3847 {
3848 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003849 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3850 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003851 };
3852
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003853 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003854 if(uErr != QCBOR_SUCCESS) {
3855 goto Done;
3856 }
3857
3858 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3859 uErr = DecodeDateEpoch(pItem);
3860 if(uErr != QCBOR_SUCCESS) {
3861 goto Done;
3862 }
3863 }
3864
Laurence Lundblade9b334962020-08-27 10:55:53 -07003865 // Save the tags in the last item's tags in the decode context
3866 // for QCBORDecode_GetNthTagOfLast()
3867 CopyTags(pMe, pItem);
3868
Laurence Lundbladec7114722020-08-13 05:11:40 -07003869 *pnTime = pItem->val.epochDate.nSeconds;
3870
3871Done:
3872 pMe->uLastError = (uint8_t)uErr;
3873}
3874
3875
3876void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003877 uint8_t uTagRequirement,
3878 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003879{
3880 if(pMe->uLastError != QCBOR_SUCCESS) {
3881 // Already in error state, do nothing
3882 return;
3883 }
3884
3885 QCBORItem Item;
3886 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3887
3888 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3889}
3890
3891
3892void
3893QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3894 int64_t nLabel,
3895 uint8_t uTagRequirement,
3896 int64_t *pnTime)
3897{
3898 QCBORItem Item;
3899 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3900 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3901}
3902
3903
3904void
3905QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3906 const char *szLabel,
3907 uint8_t uTagRequirement,
3908 int64_t *pnTime)
3909{
3910 QCBORItem Item;
3911 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3912 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3913}
3914
3915
3916
Laurence Lundblade46d63e92021-05-13 11:37:10 -07003917/*
3918 * Common processing for the RFC 8943 day-count tag. Mostly
3919 * make sure the tag content is correct and copy forward any
3920 * further other tag numbers.
3921 */
3922static void ProcessEpochDays(QCBORDecodeContext *pMe,
3923 QCBORItem *pItem,
3924 uint8_t uTagRequirement,
3925 int64_t *pnDays)
3926{
3927 if(pMe->uLastError != QCBOR_SUCCESS) {
3928 /* Already in error state, do nothing */
3929 return;
3930 }
3931
3932 QCBORError uErr;
3933
3934 const TagSpecification TagSpec =
3935 {
3936 uTagRequirement,
3937 {QCBOR_TYPE_DAYS_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3938 {QCBOR_TYPE_INT64, QCBOR_TYPE_UINT64, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3939 };
3940
3941 uErr = CheckTagRequirement(TagSpec, pItem);
3942 if(uErr != QCBOR_SUCCESS) {
3943 goto Done;
3944 }
3945
3946 if(pItem->uDataType != QCBOR_TYPE_DAYS_EPOCH) {
3947 uErr = DecodeDaysEpoch(pItem);
3948 if(uErr != QCBOR_SUCCESS) {
3949 goto Done;
3950 }
3951 }
3952
3953 /* Save the tags in the last item's tags in the decode context
3954 * for QCBORDecode_GetNthTagOfLast()
3955 */
3956 CopyTags(pMe, pItem);
3957
3958 *pnDays = pItem->val.epochDays;
3959
3960Done:
3961 pMe->uLastError = (uint8_t)uErr;
3962}
3963
3964
3965/*
3966 * Public function, see header qcbor/qcbor_decode.h
3967 */
3968void QCBORDecode_GetEpochDays(QCBORDecodeContext *pMe,
3969 uint8_t uTagRequirement,
3970 int64_t *pnDays)
3971{
3972 if(pMe->uLastError != QCBOR_SUCCESS) {
3973 /* Already in error state, do nothing */
3974 return;
3975 }
3976
3977 QCBORItem Item;
3978 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3979
3980 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3981}
3982
3983
3984/*
3985 * Public function, see header qcbor/qcbor_decode.h
3986 */
3987void
3988QCBORDecode_GetEpochDaysInMapN(QCBORDecodeContext *pMe,
3989 int64_t nLabel,
3990 uint8_t uTagRequirement,
3991 int64_t *pnDays)
3992{
3993 QCBORItem Item;
3994 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3995 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3996}
3997
3998
3999/*
4000 * Public function, see header qcbor/qcbor_decode.h
4001 */
4002void
4003QCBORDecode_GetEpochDaysInMapSZ(QCBORDecodeContext *pMe,
4004 const char *szLabel,
4005 uint8_t uTagRequirement,
4006 int64_t *pnDays)
4007{
4008 QCBORItem Item;
4009 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
4010 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
4011}
4012
4013
4014
Laurence Lundbladec7114722020-08-13 05:11:40 -07004015
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004016void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
4017 TagSpecification TagSpec,
4018 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004019{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004020 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004021 // Already in error state, do nothing
4022 return;
4023 }
4024
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07004025 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004026 QCBORItem Item;
4027
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07004028 uError = QCBORDecode_GetNext(pMe, &Item);
4029 if(uError != QCBOR_SUCCESS) {
4030 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004031 return;
4032 }
4033
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004034 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004035
4036 if(pMe->uLastError == QCBOR_SUCCESS) {
4037 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07004038 } else {
4039 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004040 }
4041}
4042
Laurence Lundbladec4537442020-04-14 18:53:22 -07004043
4044
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004045
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004046static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004047 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004048 UsefulBufC *pValue,
4049 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004050{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004051 const TagSpecification TagSpec =
4052 {
4053 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004054 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4055 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004056 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004057
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004058 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004059 if(uErr != QCBOR_SUCCESS) {
4060 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004061 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004062
4063 *pValue = pItem->val.string;
4064
4065 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
4066 *pbIsNegative = false;
4067 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
4068 *pbIsNegative = true;
4069 }
4070
4071 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004072}
4073
4074
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004075/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004076 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004077 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004078void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
4079 uint8_t uTagRequirement,
4080 UsefulBufC *pValue,
4081 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004082{
4083 if(pMe->uLastError != QCBOR_SUCCESS) {
4084 // Already in error state, do nothing
4085 return;
4086 }
4087
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004088 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004089 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4090 if(uError != QCBOR_SUCCESS) {
4091 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004092 return;
4093 }
4094
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004095 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004096}
4097
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004098
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004099/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004100 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004101*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004102void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
4103 int64_t nLabel,
4104 uint8_t uTagRequirement,
4105 UsefulBufC *pValue,
4106 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004107{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004108 QCBORItem Item;
4109 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004110 if(pMe->uLastError != QCBOR_SUCCESS) {
4111 return;
4112 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004113
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004114 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004115}
4116
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004117
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004118/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004119 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004120*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004121void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
4122 const char *szLabel,
4123 uint8_t uTagRequirement,
4124 UsefulBufC *pValue,
4125 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004126{
4127 QCBORItem Item;
4128 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004129 if(pMe->uLastError != QCBOR_SUCCESS) {
4130 return;
4131 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004132
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004133 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004134}
4135
4136
4137
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004138
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004139// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004140QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
4141 const QCBORItem *pItem,
4142 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07004143 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004144{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004145 const TagSpecification TagSpecText =
4146 {
4147 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004148 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4149 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004150 };
4151 const TagSpecification TagSpecBinary =
4152 {
4153 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004154 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4155 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004156 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004157
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004158 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004159
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004160 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004161 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004162 if(pbIsTag257 != NULL) {
4163 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004164 }
4165 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004166 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004167 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004168 if(pbIsTag257 != NULL) {
4169 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004170 }
4171 uReturn = QCBOR_SUCCESS;
4172
4173 } else {
4174 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
4175 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07004176
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004177 return uReturn;
4178}
4179
Laurence Lundblade93d89472020-10-03 22:30:50 -07004180// Improvement: add methods for wrapped CBOR, a simple alternate
4181// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004182
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004183
4184
4185
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004186#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07004187
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004188typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004189
4190
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004191// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004192static QCBORError
4193Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004194{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004195 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004196
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004197 if(uResult != 0) {
4198 /* This loop will run a maximum of 19 times because
4199 * UINT64_MAX < 10 ^^ 19. More than that will cause
4200 * exit with the overflow error
4201 */
4202 for(; nExponent > 0; nExponent--) {
4203 if(uResult > UINT64_MAX / 10) {
4204 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4205 }
4206 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004207 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004208
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004209 for(; nExponent < 0; nExponent++) {
4210 uResult = uResult / 10;
4211 if(uResult == 0) {
4212 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4213 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004214 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004215 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004216 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004217
4218 *puResult = uResult;
4219
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004220 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004221}
4222
4223
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004224// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004225static QCBORError
4226Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004227{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004228 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004229
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004230 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004231
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004232 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004233 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004234 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004235 */
4236 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004237 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004238 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004239 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004240 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004241 nExponent--;
4242 }
4243
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004244 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004245 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004246 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4247 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004248 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004249 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004250 }
4251
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004252 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004253
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004254 return QCBOR_SUCCESS;
4255}
4256
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004257
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004258/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004259 Compute value with signed mantissa and signed result. Works with
4260 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004261 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004262static inline QCBORError ExponentiateNN(int64_t nMantissa,
4263 int64_t nExponent,
4264 int64_t *pnResult,
4265 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004266{
4267 uint64_t uResult;
4268
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004269 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004270 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004271 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4272
4273 // Do the exponentiation of the positive mantissa
4274 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4275 if(uReturn) {
4276 return uReturn;
4277 }
4278
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004279
Laurence Lundblade983500d2020-05-14 11:49:34 -07004280 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4281 of INT64_MIN. This assumes two's compliment representation where
4282 INT64_MIN is one increment farther from 0 than INT64_MAX.
4283 Trying to write -INT64_MIN doesn't work to get this because the
4284 compiler tries to work with an int64_t which can't represent
4285 -INT64_MIN.
4286 */
4287 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4288
4289 // Error out if too large
4290 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004291 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4292 }
4293
4294 // Casts are safe because of checks above
4295 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4296
4297 return QCBOR_SUCCESS;
4298}
4299
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004300
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004301/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004302 Compute value with signed mantissa and unsigned result. Works with
4303 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004304 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004305static inline QCBORError ExponentitateNU(int64_t nMantissa,
4306 int64_t nExponent,
4307 uint64_t *puResult,
4308 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004309{
4310 if(nMantissa < 0) {
4311 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4312 }
4313
4314 // Cast to unsigned is OK because of check for negative
4315 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4316 // Exponentiation is straight forward
4317 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4318}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004319
4320
4321/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004322 Compute value with signed mantissa and unsigned result. Works with
4323 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004324 */
4325static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4326 int64_t nExponent,
4327 uint64_t *puResult,
4328 fExponentiator pfExp)
4329{
4330 return (*pfExp)(uMantissa, nExponent, puResult);
4331}
4332
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004333#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004334
4335
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004336
4337
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004338
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004339static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004340{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004341 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004342
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004343 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004344 const uint8_t *pByte = BigNum.ptr;
4345 size_t uLen = BigNum.len;
4346 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004347 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004348 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004349 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004350 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004351 }
4352
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004353 *pResult = uResult;
4354 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004355}
4356
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004357
Laurence Lundblade887add82020-05-17 05:50:34 -07004358static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004359{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004360 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004361}
4362
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004363
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004364static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004365{
4366 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004367 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4368 if(uError) {
4369 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004370 }
4371 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4372 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004373 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004374}
4375
4376
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004377static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004378{
4379 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004380 /* The negative integer furthest from zero for a C int64_t is
4381 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4382 negative number in CBOR is computed as -n - 1 where n is the
4383 encoded integer, where n is what is in the variable BigNum. When
4384 converting BigNum to a uint64_t, the maximum value is thus
4385 INT64_MAX, so that when it -n - 1 is applied to it the result will
4386 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004387
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004388 -n - 1 <= INT64_MIN.
4389 -n - 1 <= -INT64_MAX - 1
4390 n <= INT64_MAX.
4391 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004392 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004393 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004394 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004395 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004396
4397 /// Now apply -n - 1. The cast is safe because
4398 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4399 // is the largest positive integer that an int64_t can
4400 // represent. */
4401 *pnResult = -(int64_t)uResult - 1;
4402
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004403 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004404}
4405
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004406
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004407
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004408
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004409
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004410/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004411Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004412
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004413\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004414
Laurence Lundblade93d89472020-10-03 22:30:50 -07004415\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4416 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004417
4418\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4419
Laurence Lundblade93d89472020-10-03 22:30:50 -07004420\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4421 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004422*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004423static QCBORError
4424ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004425{
4426 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004427 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004428 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004429#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004430 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004431 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4432 http://www.cplusplus.com/reference/cmath/llround/
4433 */
4434 // Not interested in FE_INEXACT
4435 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004436 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4437 *pnValue = llround(pItem->val.dfnum);
4438 } else {
4439 *pnValue = lroundf(pItem->val.fnum);
4440 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004441 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4442 // llround() shouldn't result in divide by zero, but catch
4443 // it here in case it unexpectedly does. Don't try to
4444 // distinguish between the various exceptions because it seems
4445 // they vary by CPU, compiler and OS.
4446 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004447 }
4448 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004449 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004450 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004451#else
4452 return QCBOR_ERR_HW_FLOAT_DISABLED;
4453#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004454 break;
4455
4456 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004457 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004458 *pnValue = pItem->val.int64;
4459 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004460 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004461 }
4462 break;
4463
4464 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004465 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004466 if(pItem->val.uint64 < INT64_MAX) {
4467 *pnValue = pItem->val.int64;
4468 } else {
4469 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4470 }
4471 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004472 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004473 }
4474 break;
4475
4476 default:
4477 return QCBOR_ERR_UNEXPECTED_TYPE;
4478 }
4479 return QCBOR_SUCCESS;
4480}
4481
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004482
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004483void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004484 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004485 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004486 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004487{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004488 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004489 return;
4490 }
4491
Laurence Lundbladee6430642020-03-14 21:15:44 -07004492 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004493 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4494 if(uError) {
4495 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004496 return;
4497 }
4498
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004499 if(pItem) {
4500 *pItem = Item;
4501 }
4502
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004503 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004504}
4505
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004506
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004507void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4508 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004509 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004510 int64_t *pnValue,
4511 QCBORItem *pItem)
4512{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004513 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004514 if(pMe->uLastError != QCBOR_SUCCESS) {
4515 return;
4516 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004517
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004518 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004519}
4520
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004521
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004522void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4523 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004524 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004525 int64_t *pnValue,
4526 QCBORItem *pItem)
4527{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004528 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004529 if(pMe->uLastError != QCBOR_SUCCESS) {
4530 return;
4531 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004532
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004533 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004534}
4535
4536
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004537/*
4538 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004539
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004540 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004541
Laurence Lundblade93d89472020-10-03 22:30:50 -07004542 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4543 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004544
4545 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4546
Laurence Lundblade93d89472020-10-03 22:30:50 -07004547 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4548 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004549 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004550static QCBORError
4551Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004552{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004553 switch(pItem->uDataType) {
4554
4555 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004556 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004557 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004558 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004559 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004560 }
4561 break;
4562
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004563 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004564 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004565 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004566 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004567 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004568 }
4569 break;
4570
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004571#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004572 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004573 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004574 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004575 pItem->val.expAndMantissa.nExponent,
4576 pnValue,
4577 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004578 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004579 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004580 }
4581 break;
4582
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004583 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004584 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004585 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004586 pItem->val.expAndMantissa.nExponent,
4587 pnValue,
4588 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004589 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004590 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004591 }
4592 break;
4593
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004594 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004595 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004596 int64_t nMantissa;
4597 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004598 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4599 if(uErr) {
4600 return uErr;
4601 }
4602 return ExponentiateNN(nMantissa,
4603 pItem->val.expAndMantissa.nExponent,
4604 pnValue,
4605 Exponentitate10);
4606 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004607 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004608 }
4609 break;
4610
4611 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004612 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004613 int64_t nMantissa;
4614 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004615 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4616 if(uErr) {
4617 return uErr;
4618 }
4619 return ExponentiateNN(nMantissa,
4620 pItem->val.expAndMantissa.nExponent,
4621 pnValue,
4622 Exponentitate10);
4623 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004624 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004625 }
4626 break;
4627
4628 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004629 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004630 int64_t nMantissa;
4631 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004632 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4633 if(uErr) {
4634 return uErr;
4635 }
4636 return ExponentiateNN(nMantissa,
4637 pItem->val.expAndMantissa.nExponent,
4638 pnValue,
4639 Exponentitate2);
4640 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004641 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004642 }
4643 break;
4644
4645 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004646 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004647 int64_t nMantissa;
4648 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004649 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4650 if(uErr) {
4651 return uErr;
4652 }
4653 return ExponentiateNN(nMantissa,
4654 pItem->val.expAndMantissa.nExponent,
4655 pnValue,
4656 Exponentitate2);
4657 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004658 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004659 }
4660 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004661#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004662
Laurence Lundbladee6430642020-03-14 21:15:44 -07004663
Laurence Lundbladec4537442020-04-14 18:53:22 -07004664 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004665 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004666}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004667
4668
Laurence Lundbladec4537442020-04-14 18:53:22 -07004669/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004670 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004671 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004672void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004673{
4674 QCBORItem Item;
4675
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004676 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004677
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004678 if(pMe->uLastError == QCBOR_SUCCESS) {
4679 // The above conversion succeeded
4680 return;
4681 }
4682
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004683 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004684 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004685 return;
4686 }
4687
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004688 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004689}
4690
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004691
4692/*
4693Public function, see header qcbor/qcbor_decode.h file
4694*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004695void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4696 int64_t nLabel,
4697 uint32_t uConvertTypes,
4698 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004699{
4700 QCBORItem Item;
4701
Laurence Lundblade93d89472020-10-03 22:30:50 -07004702 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4703 nLabel,
4704 uConvertTypes,
4705 pnValue,
4706 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004707
4708 if(pMe->uLastError == QCBOR_SUCCESS) {
4709 // The above conversion succeeded
4710 return;
4711 }
4712
4713 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4714 // The above conversion failed in a way that code below can't correct
4715 return;
4716 }
4717
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004718 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004719}
4720
4721
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004722/*
4723Public function, see header qcbor/qcbor_decode.h file
4724*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004725void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4726 const char *szLabel,
4727 uint32_t uConvertTypes,
4728 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004729{
4730 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004731 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4732 szLabel,
4733 uConvertTypes,
4734 pnValue,
4735 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004736
4737 if(pMe->uLastError == QCBOR_SUCCESS) {
4738 // The above conversion succeeded
4739 return;
4740 }
4741
4742 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4743 // The above conversion failed in a way that code below can't correct
4744 return;
4745 }
4746
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004747 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004748}
4749
4750
Laurence Lundblade93d89472020-10-03 22:30:50 -07004751static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004752{
4753 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004754 case QCBOR_TYPE_DOUBLE:
4755 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004756#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004757 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004758 // Can't use llround here because it will not convert values
4759 // greater than INT64_MAX and less than UINT64_MAX that
4760 // need to be converted so it is more complicated.
4761 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4762 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4763 if(isnan(pItem->val.dfnum)) {
4764 return QCBOR_ERR_FLOAT_EXCEPTION;
4765 } else if(pItem->val.dfnum < 0) {
4766 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4767 } else {
4768 double dRounded = round(pItem->val.dfnum);
4769 // See discussion in DecodeDateEpoch() for
4770 // explanation of - 0x7ff
4771 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4772 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4773 }
4774 *puValue = (uint64_t)dRounded;
4775 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004776 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004777 if(isnan(pItem->val.fnum)) {
4778 return QCBOR_ERR_FLOAT_EXCEPTION;
4779 } else if(pItem->val.fnum < 0) {
4780 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4781 } else {
4782 float fRounded = roundf(pItem->val.fnum);
4783 // See discussion in DecodeDateEpoch() for
4784 // explanation of - 0x7ff
4785 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4786 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4787 }
4788 *puValue = (uint64_t)fRounded;
4789 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004790 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004791 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4792 // round() and roundf() shouldn't result in exceptions here, but
4793 // catch them to be robust and thorough. Don't try to
4794 // distinguish between the various exceptions because it seems
4795 // they vary by CPU, compiler and OS.
4796 return QCBOR_ERR_FLOAT_EXCEPTION;
4797 }
4798
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004799 } else {
4800 return QCBOR_ERR_UNEXPECTED_TYPE;
4801 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004802#else
4803 return QCBOR_ERR_HW_FLOAT_DISABLED;
4804#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004805 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004806
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004807 case QCBOR_TYPE_INT64:
4808 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4809 if(pItem->val.int64 >= 0) {
4810 *puValue = (uint64_t)pItem->val.int64;
4811 } else {
4812 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4813 }
4814 } else {
4815 return QCBOR_ERR_UNEXPECTED_TYPE;
4816 }
4817 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004818
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004819 case QCBOR_TYPE_UINT64:
4820 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4821 *puValue = pItem->val.uint64;
4822 } else {
4823 return QCBOR_ERR_UNEXPECTED_TYPE;
4824 }
4825 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004826
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004827 default:
4828 return QCBOR_ERR_UNEXPECTED_TYPE;
4829 }
4830
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004831 return QCBOR_SUCCESS;
4832}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004833
4834
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004835void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004836 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004837 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004838 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004839{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004840 if(pMe->uLastError != QCBOR_SUCCESS) {
4841 return;
4842 }
4843
Laurence Lundbladec4537442020-04-14 18:53:22 -07004844 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004845
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004846 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4847 if(uError) {
4848 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004849 return;
4850 }
4851
Laurence Lundbladea826c502020-05-10 21:07:00 -07004852 if(pItem) {
4853 *pItem = Item;
4854 }
4855
Laurence Lundblade93d89472020-10-03 22:30:50 -07004856 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004857}
4858
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004859
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004860void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004861 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004862 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004863 uint64_t *puValue,
4864 QCBORItem *pItem)
4865{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004866 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004867 if(pMe->uLastError != QCBOR_SUCCESS) {
4868 return;
4869 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004870
Laurence Lundblade93d89472020-10-03 22:30:50 -07004871 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004872}
4873
4874
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004875void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004876 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004877 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004878 uint64_t *puValue,
4879 QCBORItem *pItem)
4880{
4881 if(pMe->uLastError != QCBOR_SUCCESS) {
4882 return;
4883 }
4884
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004885 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004886 if(pMe->uLastError != QCBOR_SUCCESS) {
4887 return;
4888 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004889
Laurence Lundblade93d89472020-10-03 22:30:50 -07004890 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004891}
4892
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004893
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004894
Laurence Lundblade93d89472020-10-03 22:30:50 -07004895static QCBORError
4896UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004897{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004898 switch(pItem->uDataType) {
4899
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 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
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 Lundblade7e5be1d2020-05-24 21:17:28 -07004910 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4911 } 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 Lundbladedd6e76e2021-03-10 01:54:01 -07004916#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004917
4918 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004919 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004920 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004921 pItem->val.expAndMantissa.nExponent,
4922 puValue,
4923 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004924 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004925 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004926 }
4927 break;
4928
4929 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004930 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004931 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4932 pItem->val.expAndMantissa.nExponent,
4933 puValue,
4934 Exponentitate2);
4935 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004936 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004937 }
4938 break;
4939
4940 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004941 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004942 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004943 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004944 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004945 if(uErr != QCBOR_SUCCESS) {
4946 return uErr;
4947 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004948 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004949 pItem->val.expAndMantissa.nExponent,
4950 puValue,
4951 Exponentitate10);
4952 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004953 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004954 }
4955 break;
4956
4957 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004958 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004959 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4960 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004961 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004962 }
4963 break;
4964
4965 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004966 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004967 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004968 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004969 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004970 if(uErr != QCBOR_SUCCESS) {
4971 return uErr;
4972 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004973 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004974 pItem->val.expAndMantissa.nExponent,
4975 puValue,
4976 Exponentitate2);
4977 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004978 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004979 }
4980 break;
4981
4982 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004983 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004984 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4985 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004986 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004987 }
4988 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004989#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004990 default:
4991 return QCBOR_ERR_UNEXPECTED_TYPE;
4992 }
4993}
4994
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004995
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004996/*
4997 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004998 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004999void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005000{
5001 QCBORItem Item;
5002
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005003 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07005004
Laurence Lundbladef6c86662020-05-12 02:08:00 -07005005 if(pMe->uLastError == QCBOR_SUCCESS) {
5006 // The above conversion succeeded
5007 return;
5008 }
5009
5010 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5011 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07005012 return;
5013 }
5014
Laurence Lundblade93d89472020-10-03 22:30:50 -07005015 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005016}
5017
Laurence Lundbladec4537442020-04-14 18:53:22 -07005018
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005019/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005020 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005021*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07005022void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07005023 int64_t nLabel,
5024 uint32_t uConvertTypes,
5025 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005026{
5027 QCBORItem Item;
5028
Laurence Lundblade93d89472020-10-03 22:30:50 -07005029 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
5030 nLabel,
5031 uConvertTypes,
5032 puValue,
5033 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005034
5035 if(pMe->uLastError == QCBOR_SUCCESS) {
5036 // The above conversion succeeded
5037 return;
5038 }
5039
5040 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5041 // The above conversion failed in a way that code below can't correct
5042 return;
5043 }
5044
Laurence Lundblade93d89472020-10-03 22:30:50 -07005045 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005046}
5047
5048
5049/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005050 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005051*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07005052void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07005053 const char *szLabel,
5054 uint32_t uConvertTypes,
5055 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005056{
5057 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07005058 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
5059 szLabel,
5060 uConvertTypes,
5061 puValue,
5062 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005063
5064 if(pMe->uLastError == QCBOR_SUCCESS) {
5065 // The above conversion succeeded
5066 return;
5067 }
5068
5069 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5070 // The above conversion failed in a way that code below can't correct
5071 return;
5072 }
5073
Laurence Lundblade93d89472020-10-03 22:30:50 -07005074 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005075}
5076
5077
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07005078
5079
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02005080#ifndef USEFULBUF_DISABLE_ALL_FLOAT
Laurence Lundblade9b334962020-08-27 10:55:53 -07005081static QCBORError ConvertDouble(const QCBORItem *pItem,
5082 uint32_t uConvertTypes,
5083 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005084{
5085 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005086 case QCBOR_TYPE_FLOAT:
5087#ifndef QCBOR_DISABLE_FLOAT_HW_USE
5088 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5089 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005090 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005091 *pdValue = (double)pItem->val.fnum;
5092 } else {
5093 return QCBOR_ERR_UNEXPECTED_TYPE;
5094 }
5095 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005096#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005097 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005098#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005099 break;
5100
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005101 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005102 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5103 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005104 *pdValue = pItem->val.dfnum;
5105 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005106 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005107 }
5108 }
5109 break;
5110
5111 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005112#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005113 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005114 // A simple cast seems to do the job with no worry of exceptions.
5115 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005116 *pdValue = (double)pItem->val.int64;
5117
5118 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005119 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005120 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005121#else
5122 return QCBOR_ERR_HW_FLOAT_DISABLED;
5123#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005124 break;
5125
5126 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005127#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005128 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005129 // A simple cast seems to do the job with no worry of exceptions.
5130 // There will be precision loss for some values.
5131 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005132 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005133 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005134 }
5135 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005136#else
5137 return QCBOR_ERR_HW_FLOAT_DISABLED;
5138#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005139
5140 default:
5141 return QCBOR_ERR_UNEXPECTED_TYPE;
5142 }
5143
5144 return QCBOR_SUCCESS;
5145}
5146
5147
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005148void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005149 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005150 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005151 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005152{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005153 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07005154 return;
5155 }
5156
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005157 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005158
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005159 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005160 if(uError) {
5161 pMe->uLastError = (uint8_t)uError;
5162 return;
5163 }
5164
5165 if(pItem) {
5166 *pItem = Item;
5167 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005168
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005169 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005170}
Laurence Lundbladec4537442020-04-14 18:53:22 -07005171
Laurence Lundbladec4537442020-04-14 18:53:22 -07005172
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005173void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
5174 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005175 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005176 double *pdValue,
5177 QCBORItem *pItem)
5178{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005179 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005180 if(pMe->uLastError != QCBOR_SUCCESS) {
5181 return;
5182 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005183
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005184 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005185}
5186
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005187
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005188void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
5189 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005190 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005191 double *pdValue,
5192 QCBORItem *pItem)
5193{
5194 if(pMe->uLastError != QCBOR_SUCCESS) {
5195 return;
5196 }
5197
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005198 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005199 if(pMe->uLastError != QCBOR_SUCCESS) {
5200 return;
5201 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005202
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005203 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005204}
5205
5206
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005207#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005208static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5209{
5210 double dResult;
5211
5212 dResult = 0.0;
5213 const uint8_t *pByte = BigNum.ptr;
5214 size_t uLen = BigNum.len;
5215 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005216 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005217 while(uLen--) {
5218 dResult = (dResult * 256.0) + (double)*pByte++;
5219 }
5220
5221 return dResult;
5222}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005223#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5224
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005225
Laurence Lundblade93d89472020-10-03 22:30:50 -07005226static QCBORError
5227DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005228{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005229#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005230 /*
Laurence Lundblade16a207a2021-09-18 17:22:46 -07005231 * What Every Computer Scientist Should Know About Floating-Point Arithmetic
5232 * https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5233 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005234 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005235
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005236#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005237 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005238 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005239 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005240 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5241 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5242 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005243 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005244 }
5245 break;
5246
5247 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005248 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005249 // Underflow gives 0, overflow gives infinity
5250 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5251 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005252 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005253 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005254 }
5255 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005256#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005257
5258 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005259 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005260 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5261 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005262 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005263 }
5264 break;
5265
5266 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005267 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005268 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005269 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005270 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005271 }
5272 break;
5273
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005274#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005275 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005276 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005277 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5278 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5279 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005280 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005281 }
5282 break;
5283
5284 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005285 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005286 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5287 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5288 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005289 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005290 }
5291 break;
5292
5293 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005294 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005295 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5296 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5297 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005298 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005299 }
5300 break;
5301
5302 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005303 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005304 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005305 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5306 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005307 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005308 }
5309 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005310#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005311
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005312 default:
5313 return QCBOR_ERR_UNEXPECTED_TYPE;
5314 }
5315
5316 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005317
5318#else
5319 (void)pItem;
5320 (void)uConvertTypes;
5321 (void)pdValue;
5322 return QCBOR_ERR_HW_FLOAT_DISABLED;
5323#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5324
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005325}
5326
5327
5328/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005329 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005330*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005331void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5332 uint32_t uConvertTypes,
5333 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005334{
5335
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005336 QCBORItem Item;
5337
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005338 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005339
5340 if(pMe->uLastError == QCBOR_SUCCESS) {
5341 // The above conversion succeeded
5342 return;
5343 }
5344
5345 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5346 // The above conversion failed in a way that code below can't correct
5347 return;
5348 }
5349
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005350 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005351}
5352
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005353
5354/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005355 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005356*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005357void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5358 int64_t nLabel,
5359 uint32_t uConvertTypes,
5360 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005361{
5362 QCBORItem Item;
5363
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005364 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005365
5366 if(pMe->uLastError == QCBOR_SUCCESS) {
5367 // The above conversion succeeded
5368 return;
5369 }
5370
5371 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5372 // The above conversion failed in a way that code below can't correct
5373 return;
5374 }
5375
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005376 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005377}
5378
5379
5380/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005381 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005382*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005383void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5384 const char *szLabel,
5385 uint32_t uConvertTypes,
5386 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005387{
5388 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005389 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005390
5391 if(pMe->uLastError == QCBOR_SUCCESS) {
5392 // The above conversion succeeded
5393 return;
5394 }
5395
5396 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5397 // The above conversion failed in a way that code below can't correct
5398 return;
5399 }
5400
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005401 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005402}
Máté Tóth-Pálef5f07a2021-09-17 19:31:37 +02005403#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005404
5405
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005406
5407
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005408#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005409static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5410{
5411 while((uInt & 0xff00000000000000UL) == 0) {
5412 uInt = uInt << 8;
5413 };
5414
5415 UsefulOutBuf UOB;
5416
5417 UsefulOutBuf_Init(&UOB, Buffer);
5418
5419 while(uInt) {
5420 const uint64_t xx = uInt & 0xff00000000000000UL;
5421 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5422 uInt = uInt << 8;
5423 (void)xx;
5424 }
5425
5426 return UsefulOutBuf_OutUBuf(&UOB);
5427}
5428
5429
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005430static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5431 TagSpecification TagSpec,
5432 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005433{
5434 QCBORError uErr;
5435 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005436 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005437 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005438 if(uErr != QCBOR_SUCCESS) {
5439 goto Done;
5440 }
5441
5442 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5443 break; // Successful exit. Moving on to finish decoding.
5444 }
5445
5446 // The item is an array, which means an undecoded
5447 // mantissa and exponent, so decode it. It will then
5448 // have a different type and exit the loop if.
5449 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5450 if(uErr != QCBOR_SUCCESS) {
5451 goto Done;
5452 }
5453
5454 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005455 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005456 }
5457Done:
5458 return uErr;
5459}
5460
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005461
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005462static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005463 TagSpecification TagSpec,
5464 QCBORItem *pItem,
5465 int64_t *pnMantissa,
5466 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005467{
5468 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005469
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005470 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005471 if(uErr != QCBOR_SUCCESS) {
5472 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005473 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005474
Laurence Lundblade9b334962020-08-27 10:55:53 -07005475 switch (pItem->uDataType) {
5476
5477 case QCBOR_TYPE_DECIMAL_FRACTION:
5478 case QCBOR_TYPE_BIGFLOAT:
5479 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5480 *pnExponent = pItem->val.expAndMantissa.nExponent;
5481 break;
5482
5483 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5484 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5485 *pnExponent = pItem->val.expAndMantissa.nExponent;
5486 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5487 break;
5488
5489 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5490 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5491 *pnExponent = pItem->val.expAndMantissa.nExponent;
5492 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5493 break;
5494
5495 default:
5496 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5497 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005498
5499 Done:
5500 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005501}
5502
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005503
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005504static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005505 TagSpecification TagSpec,
5506 QCBORItem *pItem,
5507 UsefulBuf BufferForMantissa,
5508 UsefulBufC *pMantissa,
5509 bool *pbIsNegative,
5510 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005511{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005512 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005513
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005514 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005515 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005516 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005517 }
5518
5519 uint64_t uMantissa;
5520
5521 switch (pItem->uDataType) {
5522
5523 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005524 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005525 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5526 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5527 *pbIsNegative = false;
5528 } else {
5529 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5530 *pbIsNegative = true;
5531 }
5532 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5533 *pnExponent = pItem->val.expAndMantissa.nExponent;
5534 break;
5535
5536 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005537 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005538 *pnExponent = pItem->val.expAndMantissa.nExponent;
5539 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5540 *pbIsNegative = false;
5541 break;
5542
5543 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005544 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005545 *pnExponent = pItem->val.expAndMantissa.nExponent;
5546 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5547 *pbIsNegative = true;
5548 break;
5549
5550 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005551 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005552 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005553
5554Done:
5555 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005556}
5557
5558
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005559/*
5560 Public function, see header qcbor/qcbor_decode.h file
5561*/
5562void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5563 uint8_t uTagRequirement,
5564 int64_t *pnMantissa,
5565 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005566{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005567 if(pMe->uLastError != QCBOR_SUCCESS) {
5568 return;
5569 }
5570
5571 QCBORItem Item;
5572 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5573 if(uError) {
5574 pMe->uLastError = (uint8_t)uError;
5575 return;
5576 }
5577
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005578 const TagSpecification TagSpec =
5579 {
5580 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005581 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5582 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5583 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005584 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005585
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005586 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005587}
5588
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005589
5590/*
5591 Public function, see header qcbor/qcbor_decode.h file
5592*/
5593void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005594 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005595 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005596 int64_t *pnMantissa,
5597 int64_t *pnExponent)
5598{
5599 if(pMe->uLastError != QCBOR_SUCCESS) {
5600 return;
5601 }
5602
5603 QCBORItem Item;
5604 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5605
5606 const TagSpecification TagSpec =
5607 {
5608 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005609 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5610 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5611 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005612 };
5613
5614 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5615}
5616
5617
5618/*
5619 Public function, see header qcbor/qcbor_decode.h file
5620*/
5621void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005622 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005623 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005624 int64_t *pnMantissa,
5625 int64_t *pnExponent)
5626{
5627 if(pMe->uLastError != QCBOR_SUCCESS) {
5628 return;
5629 }
5630
5631 QCBORItem Item;
5632 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5633
5634 const TagSpecification TagSpec =
5635 {
5636 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005637 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5638 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5639 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005640 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005641
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005642 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5643}
5644
5645
5646/*
5647 Public function, see header qcbor/qcbor_decode.h file
5648*/
5649void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5650 uint8_t uTagRequirement,
5651 UsefulBuf MantissaBuffer,
5652 UsefulBufC *pMantissa,
5653 bool *pbMantissaIsNegative,
5654 int64_t *pnExponent)
5655{
5656 if(pMe->uLastError != QCBOR_SUCCESS) {
5657 return;
5658 }
5659
5660 QCBORItem Item;
5661 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5662 if(uError) {
5663 pMe->uLastError = (uint8_t)uError;
5664 return;
5665 }
5666
5667 const TagSpecification TagSpec =
5668 {
5669 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005670 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5671 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5672 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005673 };
5674
Laurence Lundblade93d89472020-10-03 22:30:50 -07005675 ProcessMantissaAndExponentBig(pMe,
5676 TagSpec,
5677 &Item,
5678 MantissaBuffer,
5679 pMantissa,
5680 pbMantissaIsNegative,
5681 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005682}
5683
5684
5685/*
5686 Public function, see header qcbor/qcbor_decode.h file
5687*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005688void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005689 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005690 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005691 UsefulBuf BufferForMantissa,
5692 UsefulBufC *pMantissa,
5693 bool *pbIsNegative,
5694 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005695{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005696 if(pMe->uLastError != QCBOR_SUCCESS) {
5697 return;
5698 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005699
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005700 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005701 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005702 if(pMe->uLastError != QCBOR_SUCCESS) {
5703 return;
5704 }
5705
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005706 const TagSpecification TagSpec =
5707 {
5708 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005709 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5710 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5711 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005712 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005713
Laurence Lundblade93d89472020-10-03 22:30:50 -07005714 ProcessMantissaAndExponentBig(pMe,
5715 TagSpec,
5716 &Item,
5717 BufferForMantissa,
5718 pMantissa,
5719 pbIsNegative,
5720 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005721}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005722
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005723
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005724/*
5725 Public function, see header qcbor/qcbor_decode.h file
5726*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005727void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005728 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005729 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005730 UsefulBuf BufferForMantissa,
5731 UsefulBufC *pMantissa,
5732 bool *pbIsNegative,
5733 int64_t *pnExponent)
5734{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005735 if(pMe->uLastError != QCBOR_SUCCESS) {
5736 return;
5737 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005738
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005739 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005740 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5741 if(pMe->uLastError != QCBOR_SUCCESS) {
5742 return;
5743 }
5744
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005745 const TagSpecification TagSpec =
5746 {
5747 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005748 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5749 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5750 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005751 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005752
5753 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5754}
5755
5756
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005757/*
5758 Public function, see header qcbor/qcbor_decode.h file
5759*/
5760void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5761 uint8_t uTagRequirement,
5762 int64_t *pnMantissa,
5763 int64_t *pnExponent)
5764{
5765 if(pMe->uLastError != QCBOR_SUCCESS) {
5766 return;
5767 }
5768
5769 QCBORItem Item;
5770 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5771 if(uError) {
5772 pMe->uLastError = (uint8_t)uError;
5773 return;
5774 }
5775 const TagSpecification TagSpec =
5776 {
5777 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005778 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5779 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5780 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005781 };
5782
5783 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5784}
5785
5786
5787/*
5788 Public function, see header qcbor/qcbor_decode.h file
5789*/
5790void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005791 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005792 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005793 int64_t *pnMantissa,
5794 int64_t *pnExponent)
5795{
5796 if(pMe->uLastError != QCBOR_SUCCESS) {
5797 return;
5798 }
5799
5800 QCBORItem Item;
5801 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5802 if(pMe->uLastError != QCBOR_SUCCESS) {
5803 return;
5804 }
5805
5806 const TagSpecification TagSpec =
5807 {
5808 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005809 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5810 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5811 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005812 };
5813
5814 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5815}
5816
5817
5818/*
5819 Public function, see header qcbor/qcbor_decode.h file
5820*/
5821void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005822 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005823 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005824 int64_t *pnMantissa,
5825 int64_t *pnExponent)
5826{
5827 if(pMe->uLastError != QCBOR_SUCCESS) {
5828 return;
5829 }
5830
5831 QCBORItem Item;
5832 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5833 if(pMe->uLastError != QCBOR_SUCCESS) {
5834 return;
5835 }
5836
5837 const TagSpecification TagSpec =
5838 {
5839 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005840 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5841 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5842 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005843 };
5844
5845 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5846}
5847
5848
5849/*
5850 Public function, see header qcbor/qcbor_decode.h file
5851*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005852void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5853 uint8_t uTagRequirement,
5854 UsefulBuf MantissaBuffer,
5855 UsefulBufC *pMantissa,
5856 bool *pbMantissaIsNegative,
5857 int64_t *pnExponent)
5858{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005859 if(pMe->uLastError != QCBOR_SUCCESS) {
5860 return;
5861 }
5862
5863 QCBORItem Item;
5864 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5865 if(uError) {
5866 pMe->uLastError = (uint8_t)uError;
5867 return;
5868 }
5869
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005870 const TagSpecification TagSpec =
5871 {
5872 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005873 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5874 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5875 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005876 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005877
5878 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005879}
5880
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005881
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005882/*
5883 Public function, see header qcbor/qcbor_decode.h file
5884*/
5885void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005886 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005887 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005888 UsefulBuf BufferForMantissa,
5889 UsefulBufC *pMantissa,
5890 bool *pbIsNegative,
5891 int64_t *pnExponent)
5892{
5893 if(pMe->uLastError != QCBOR_SUCCESS) {
5894 return;
5895 }
5896
5897 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005898 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5899 if(pMe->uLastError != QCBOR_SUCCESS) {
5900 return;
5901 }
5902
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005903 const TagSpecification TagSpec =
5904 {
5905 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005906 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5907 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5908 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005909 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005910
Laurence Lundblade93d89472020-10-03 22:30:50 -07005911 ProcessMantissaAndExponentBig(pMe,
5912 TagSpec,
5913 &Item,
5914 BufferForMantissa,
5915 pMantissa,
5916 pbIsNegative,
5917 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005918}
5919
5920
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005921/*
5922 Public function, see header qcbor/qcbor_decode.h file
5923*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005924void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005925 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005926 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005927 UsefulBuf BufferForMantissa,
5928 UsefulBufC *pMantissa,
5929 bool *pbIsNegative,
5930 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005931{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005932 if(pMe->uLastError != QCBOR_SUCCESS) {
5933 return;
5934 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005935
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005936 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005937 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5938 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005939 return;
5940 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005941
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005942 const TagSpecification TagSpec =
5943 {
5944 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005945 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5946 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5947 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005948 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005949
Laurence Lundblade93d89472020-10-03 22:30:50 -07005950 ProcessMantissaAndExponentBig(pMe,
5951 TagSpec,
5952 &Item,
5953 BufferForMantissa,
5954 pMantissa,
5955 pbIsNegative,
5956 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005957}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005958
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005959#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */