blob: fc9cf2b97dc43f35d6c1df6c91a1c1c45a72a848 [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.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080036#include "ieee754.h" /* Does not use math.h */
Laurence Lundbladec7114722020-08-13 05:11:40 -070037
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080039
40#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
41 * pow(), exp2()
42 */
43#include <fenv.h> /* feclearexcept(), fetestexcept() */
44
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080045#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070046
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070047
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080048
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053049/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080050 * This casts away the const-ness of a pointer, usually so it can be
51 * freed or realloced.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053052 */
53#define UNCONST_POINTER(ptr) ((void *)(ptr))
54
Laurence Lundbladea9489f82020-09-12 13:50:56 -070055#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070056
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070057
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080058
59
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070060static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070061QCBORItem_IsMapOrArray(const QCBORItem *pMe)
62{
63 const uint8_t uDataType = pMe->uDataType;
64 return uDataType == QCBOR_TYPE_MAP ||
65 uDataType == QCBOR_TYPE_ARRAY ||
66 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
67}
68
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070069static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070070QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
71{
72 if(!QCBORItem_IsMapOrArray(pMe)){
73 return false;
74 }
75
76 if(pMe->val.uCount != 0) {
77 return false;
78 }
79 return true;
80}
81
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070082static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070083QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
84{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080085#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -070086 if(!QCBORItem_IsMapOrArray(pMe)){
87 return false;
88 }
89
90 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
91 return false;
92 }
93 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080094#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
95 (void)pMe;
96 return false;
97#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -070098}
99
100
Laurence Lundbladeee851742020-01-08 08:37:05 -0800101/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700102 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -0800103 ===========================================================================*/
104
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700105/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800106 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
107 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700108 */
109
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700110
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700111static inline uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700112DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700113{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700114 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800115 /* Limit in DecodeNesting_Descend against more than
116 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700117 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700118 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700119}
120
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700121
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700122static inline uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700123DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700124{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700125 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800126 /* Limit in DecodeNesting_Descend against more than
127 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700128 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700129 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700130}
131
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700132
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700133static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700134DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700135{
136 return pNesting->pCurrentBounded->u.ma.uStartOffset;
137}
138
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700139
Laurence Lundblade085d7952020-07-24 10:26:30 -0700140static inline bool
141DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
142{
143 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
144 return true;
145 } else {
146 return false;
147 }
148}
149
150
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700151static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700152DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700153{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700154 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700155 return true;
156 } else {
157 return false;
158 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700159}
160
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700161
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700162static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700163DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700164{
165 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800166 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700167 return false;
168 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800169
170#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700171 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800172 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700173 return false;
174 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800175
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800176#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
177
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800178 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700179 return true;
180}
181
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700182static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700183DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700184{
185 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800186 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700187 return true;
188 }
189 return false;
190}
191
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700192
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700193static inline bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700194{
195 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
196 return true;
197 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700198 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700199 return true;
200 }
201 return false;
202}
203
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700204
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700205static inline void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700206{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800207 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700208 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800209 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
210 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
211 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700212 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700213 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700214
215 if(bIsEmpty) {
216 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
217 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700218}
219
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700220
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700221static inline void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700222{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700223 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700224}
225
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700226
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700227static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700228DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700229{
230 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800231 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700232 return false;
233 }
234 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800235 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700236 return false;
237 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700238 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800239 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700240 return false;
241 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800242 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800243 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
244 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800245 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700246 return false;
247 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800248 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700249 return true;
250}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700251
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700252
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700253static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700254DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700255{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800256 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700257 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
258 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700259 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700260 return false;
261 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700262}
263
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700264
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700265static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700266DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700267{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700268 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
269 return true;
270 } else {
271 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700272 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700273}
274
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700275
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700276static inline bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700277DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700278{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700279 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700280 return false;
281 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700282
283 if(pNesting->pCurrentBounded->uLevelType != uType) {
284 return false;
285 }
286
287 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700288}
289
Laurence Lundblade02625d42020-06-25 14:41:41 -0700290
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700291static inline void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700292DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700293{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800294 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700295 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700296}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700297
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700298
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700299static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700300DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
301{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800302 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700303 pNesting->pCurrent->u.ma.uCountCursor++;
304}
305
306
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700307static inline void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700308DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
309{
310 pNesting->pCurrent--;
311}
312
Laurence Lundblade02625d42020-06-25 14:41:41 -0700313
314static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700315DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700316{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800317 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700318 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700319 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700320 }
321
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800322 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700323 pNesting->pCurrent++;
324
325 pNesting->pCurrent->uLevelType = uType;
326
327 return QCBOR_SUCCESS;
328}
329
330
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700331static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800332DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
333 bool bIsEmpty,
334 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700335{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700336 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800337 * Should only be called on map/array.
338 *
339 * Have descended into this before this is called. The job here is
340 * just to mark it in bounded mode.
341 *
342 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
343 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
344 *
345 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700346 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800347 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700348 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700349 }
350
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700351 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700352
353 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700354
355 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700356}
357
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700358
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700359static inline QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700360DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700361 uint8_t uQCBORType,
362 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700363{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700364 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700365
366 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800367 /* Nothing to do for empty definite-length arrays. They are just are
368 * effectively the same as an item that is not a map or array.
369 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700370 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800371 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700372 }
373
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800374 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700375 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
376 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700377 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700378 goto Done;
379 }
380
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700381 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700382 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700383 goto Done;
384 }
385
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800386 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700387 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
388 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700389
390 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700391
392Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700393 return uError;;
394}
395
396
397static inline void
398DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
399{
400 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
401}
402
403
404static inline void
405DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
406{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700407 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700408 pNesting->pCurrentBounded--;
409 if(DecodeNesting_IsCurrentBounded(pNesting)) {
410 break;
411 }
412 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700413}
414
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800415
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700416static inline void
417DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
418{
419 pNesting->pCurrent = pNesting->pCurrentBounded;
420}
421
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700422
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700423static inline QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700424DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700425 uint32_t uEndOffset,
426 uint32_t uEndOfBstr)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700427{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700428 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700429
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700430 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700431 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700432 goto Done;
433 }
434
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800435 /* Fill in the new byte string level */
Laurence Lundbladef76a2622020-08-06 19:51:03 -0700436 pNesting->pCurrent->u.bs.uPreviousEndOffset = uEndOffset;
437 pNesting->pCurrent->u.bs.uEndOfBstr = uEndOfBstr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700438
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800439 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700440 pNesting->pCurrentBounded = pNesting->pCurrent;
441
442Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700443 return uError;;
444}
445
Laurence Lundbladed0304932020-06-27 10:59:38 -0700446
447static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700448DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700449{
450 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700451}
452
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700453
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700454static inline void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800455DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
456{
457 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
458}
459
460
461static inline void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700462DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700463{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700464 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700465 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
466 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700467}
468
469
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700470static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800471DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
472 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700473{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700474 *pSave = *pNesting;
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700475 pNesting->pCurrent = pNesting->pCurrentBounded;
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800476 DecodeNesting_ResetMapOrArrayCount(pNesting);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700477}
478
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700479
Laurence Lundblade02625d42020-06-25 14:41:41 -0700480static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800481DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
482 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700483{
484 *pNesting = *pSave;
485}
486
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700487
Laurence Lundblade02625d42020-06-25 14:41:41 -0700488static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700489DecodeNesting_GetEndOfBstr(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700490{
491 return pMe->pCurrentBounded->u.bs.uEndOfBstr;
492}
493
494
Laurence Lundblade02625d42020-06-25 14:41:41 -0700495static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700496DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700497{
498 return pMe->pCurrentBounded->u.bs.uPreviousEndOffset;
499}
500
501
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800502
503
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800504#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800505/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800506 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
507
508 The following four functions are pretty wrappers for invocation of
509 the string allocator supplied by the caller.
510
Laurence Lundbladeee851742020-01-08 08:37:05 -0800511 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800512
Laurence Lundbladeee851742020-01-08 08:37:05 -0800513static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800514StringAllocator_Free(const QCBORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800515{
516 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
517}
518
Laurence Lundbladeee851742020-01-08 08:37:05 -0800519// StringAllocator_Reallocate called with pMem NULL is
520// equal to StringAllocator_Allocate()
521static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800522StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800523 void *pMem,
524 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800525{
526 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
527}
528
Laurence Lundbladeee851742020-01-08 08:37:05 -0800529static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800530StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800531{
532 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
533}
534
Laurence Lundbladeee851742020-01-08 08:37:05 -0800535static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800536StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800537{
538 if(pMe->pfAllocator) {
539 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
540 }
541}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800542#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543
544
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800545
546
Laurence Lundbladeee851742020-01-08 08:37:05 -0800547/*===========================================================================
548 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700549
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800550 See qcbor/qcbor_decode.h for definition of the object
551 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800552 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700553/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800554 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700555 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800556void QCBORDecode_Init(QCBORDecodeContext *pMe,
557 UsefulBufC EncodedCBOR,
558 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700559{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800560 memset(pMe, 0, sizeof(QCBORDecodeContext));
561 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
562 /* Don't bother with error check on decode mode. If a bad value is
563 * passed it will just act as if the default normal mode of 0 was set.
564 */
565 pMe->uDecodeMode = (uint8_t)nDecodeMode;
566 DecodeNesting_Init(&(pMe->nesting));
567
568 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
569 * GetNext_TaggedItem() and MapTagNumber(). */
570 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700571}
572
573
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800574#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
575
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700576/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800577 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700578 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800579void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
580 QCBORStringAllocate pfAllocateFunction,
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800581 void *pAllocateContext,
582 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700583{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800584 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
585 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
586 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700587}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800588#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700589
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800590
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800591
592
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800593/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800594 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800595 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800596void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800597 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700598{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800599 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700600 (void)pMe;
601 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700602}
603
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700604
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800605
606
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700607/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800608 * Decoding items is done in six layers, one calling the next one
609 * down. If a layer has no work to do for a particular item, it
610 * returns quickly.
611 *
612 * 1. QCBORDecode_GetNextTagContent - The top layer processes tagged
613 * data items, turning them into the local C representation. For the
614 * most simple it is just associating a QCBOR_TYPE with the data. For
615 * the complex ones that an aggregate of data items, there is some
616 * further decoding and some limited recursion.
617 *
618 * 2. QCBORDecode_GetNextMapOrArray - This manages the beginnings and
619 * ends of maps and arrays. It tracks descending into and ascending
620 * out of maps/arrays. It processes breaks that terminate
621 * indefinite-length maps and arrays.
622 *
623 * 3. QCBORDecode_GetNextMapEntry - This handles the combining of two
624 * items, the label and the data, that make up a map entry. It only
625 * does work on maps. It combines the label and data items into one
626 * labeled item.
627 *
628 * 4. QCBORDecode_GetNextTagNumber - This decodes type 6 tag
629 * numbers. It turns the tag numbers into bit flags associated with
630 * the data item. No actual decoding of the contents of the tag is
631 * performed here.
632 *
633 * 5. QCBORDecode_GetNextFullString - This assembles the sub-items
634 * that make up an indefinite-length string into one string item. It
635 * uses the string allocator to create contiguous space for the
636 * item. It processes all breaks that are part of indefinite-length
637 * strings.
638 *
639 * 6. DecodeAtomicDataItem - This decodes the atomic data items in
640 * CBOR. Each atomic data item has a "major type", an integer
641 * "argument" and optionally some content. For text and byte strings,
642 * the content is the bytes that make up the string. These are the
643 * smallest data items that are considered to be well-formed. The
644 * content may also be other data items in the case of aggregate
645 * types. They are not handled in this layer.
646 *
647 * Roughly this takes 300 bytes of stack for vars. TODO: evaluate this
648 * more carefully and correctly.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700649 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800650
651
652/*
653 * Note about use of int and unsigned variables.
654 *
655 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
656 * used carefully here, and in particular why it isn't used in the
657 * public interface. Also see
658 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
659 *
660 * Int is used for values that need less than 16-bits and would be
661 * subject to integer promotion and result in complaining from static
662 * analyzers.
663 */
664
665
666/**
667 * @brief Decode the CBOR head, the type and argument.
668 *
669 * @param[in] pUInBuf The input buffer to read from.
670 * @param[out] pnMajorType The decoded major type.
671 * @param[out] puArgument The decoded argument.
672 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
673 *
674 * @retval QCBOR_ERR_UNSUPPORTED
675 * @retval QCBOR_ERR_HIT_END
676 *
677 * This decodes the CBOR "head" that every CBOR data item has. See
678 * longer explaination of the head in documentation for
679 * QCBOREncode_EncodeHead().
680 *
681 * This does the network->host byte order conversion. The conversion
682 * here also results in the conversion for floats in addition to that
683 * for lengths, tags and integer values.
684 *
685 * The int type is preferred to uint8_t for some variables as this
686 * avoids integer promotions, can reduce code size and makes static
687 * analyzers happier.
688 */
689static inline QCBORError
690DecodeHead(UsefulInputBuf *pUInBuf,
691 int *pnMajorType,
692 uint64_t *puArgument,
693 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700694{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800695 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800696
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800697 /* Get the initial byte that every CBOR data item has and break it
698 * down. */
699 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800700 const int nTmpMajorType = nInitialByte >> 5;
701 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800702
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800703 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800704 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800705
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800706 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800707 /* Need to get 1,2,4 or 8 additional argument bytes. Map
708 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
709 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800710 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800711
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800712 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800713 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800714 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800715 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800716 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
717 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800718 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800719 /* The reserved and thus-far unused additional info values */
720 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800721 goto Done;
722 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800723 /* Less than 24, additional info is argument or 31, an
724 * indefinite-length. No more bytes to get.
725 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800726 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700727 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800728
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700729 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800730 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700731 goto Done;
732 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800733
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800734 /* All successful if arrived here. */
735 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800736 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800737 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800738 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800739
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700740Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800741 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742}
743
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800744
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800745/**
746 * @brief Decode integer types, major types 0 and 1.
747 *
748 * @param[in] nMajorType The CBOR major type (0 or 1).
749 * @param[in] uArgument The argument from the head.
750 * @param[out] pDecodedItem The filled in decoded item.
751 *
752 * @retval QCBOR_ERR_INT_OVERFLOW
753 *
754 * Must only be called when major type is 0 or 1.
755 *
756 * CBOR doesn't explicitly specify two's compliment for integers but
757 * all CPUs use it these days and the test vectors in the RFC are
758 * so. All integers in the CBOR structure are positive and the major
759 * type indicates positive or negative. CBOR can express positive
760 * integers up to 2^x - 1 where x is the number of bits and negative
761 * integers down to 2^x. Note that negative numbers can be one more
762 * away from zero than positive. Stdint, as far as I can tell, uses
763 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700764 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700765static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800766DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700767{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800768 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800769
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700770 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800771 if (uArgument <= INT64_MAX) {
772 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700773 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800774
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700775 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800776 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700777 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700778 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800779
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700780 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800781 if(uArgument <= INT64_MAX) {
782 /* CBOR's representation of negative numbers lines up with
783 * the two-compliment representation. A negative integer has
784 * one more in range than a positive integer. INT64_MIN is
785 * equal to (-INT64_MAX) - 1.
786 */
787 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700788 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800789
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700790 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800791 /* C can't represent a negative integer in this range so it
792 * is an error.
793 */
794 uReturn = QCBOR_ERR_INT_OVERFLOW;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700795 }
796 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800797
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800798 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700799}
800
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800801
802/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700803#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
804#error QCBOR_TYPE_FALSE macro value wrong
805#endif
806
807#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
808#error QCBOR_TYPE_TRUE macro value wrong
809#endif
810
811#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
812#error QCBOR_TYPE_NULL macro value wrong
813#endif
814
815#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
816#error QCBOR_TYPE_UNDEF macro value wrong
817#endif
818
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700819#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
820#error QCBOR_TYPE_BREAK macro value wrong
821#endif
822
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700823#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
824#error QCBOR_TYPE_DOUBLE macro value wrong
825#endif
826
827#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
828#error QCBOR_TYPE_FLOAT macro value wrong
829#endif
830
Laurence Lundblade9b334962020-08-27 10:55:53 -0700831
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800832/**
833 * @brief Decode major type 7 -- true, false, floating-point, break...
834 *
835 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
836 * @param[in] uArgument The argument from the head.
837 * @param[out] pDecodedItem The filled in decoded item.
838 *
839 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
840 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700841 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800842
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800843static inline QCBORError
844DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
845{
846 QCBORError uReturn = QCBOR_SUCCESS;
847
848 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
849 * checks above make sure uAdditionalInfo values line up with
850 * uDataType values. DecodeHead() never returns an AdditionalInfo
851 * > 0x1f so cast is safe.
852 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800853 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800854
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800855 switch(nAdditionalInfo) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800856 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
857 * are caught before this is called.
858 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800859
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800860 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700861#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800862 /* Half-precision is returned as a double. The cast to
863 * uint16_t is safe because the encoded value was 16 bits. It
864 * was widened to 64 bits to be passed in here.
865 */
866 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700867 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800868#else /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800869 uReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800870#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700871 break;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800872 case SINGLE_PREC_FLOAT: /* 26 */
873 /* Single precision is normally returned as a double since
874 * double is widely supported, there is no loss of precision,
875 * it makes it easy for the caller in most cases and it can
876 * be converted back to single with no loss of precision
877 *
878 * The cast to uint32_t is safe because the encoded value was
879 * 32 bits. It was widened to 64 bits to be passed in here.
880 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700881 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800882 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700883#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800884 /* In the normal case, use HW to convert float to
885 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700886 pDecodedItem->val.dfnum = (double)f;
887 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800888#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800889 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700890 pDecodedItem->val.fnum = f;
891 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
892
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800893 /* IEEE754_FloatToDouble() could be used here to return as
894 * a double, but it adds object code and most likely
895 * anyone disabling FLOAT HW use doesn't care about floats
896 * and wants to save object code.
897 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800898#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700899 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700900 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700901
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800902 case DOUBLE_PREC_FLOAT: /* 27 */
903 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700904 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700905 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800906
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800907 case CBOR_SIMPLEV_FALSE: /* 20 */
908 case CBOR_SIMPLEV_TRUE: /* 21 */
909 case CBOR_SIMPLEV_NULL: /* 22 */
910 case CBOR_SIMPLEV_UNDEF: /* 23 */
911 case CBOR_SIMPLE_BREAK: /* 31 */
912 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800913
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800914 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
915 if(uArgument <= CBOR_SIMPLE_BREAK) {
916 /* This takes out f8 00 ... f8 1f which should be encoded
917 * as e0 … f7
918 */
919 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700920 goto Done;
921 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800922 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800923
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800924 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700925 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800926 /* DecodeHead() will make uArgument equal to
927 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
928 * safe because the 2, 4 and 8 byte lengths of uNumber are in
929 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -0800930 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800931 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700932 break;
933 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800934
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700935Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800936 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700937}
938
939
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800940/**
941 * @brief Decode text and byte strings
942 *
943 * @param[in] pAllocator The string allocator or NULL.
944 * @param[in] uStrLen The length of the string.
945 * @param[in] pUInBuf The surce from which to read the string's bytes.
946 * @param[out] pDecodedItem The filled in decoded item.
947 *
948 * @retval QCBOR_ERR_HIT_END
949 * @retval QCBOR_ERR_STRING_ALLOCATE
950 * @retval QCBOR_ERR_STRING_TOO_LONG
951 *
952 * The reads @c uStrlen bytes from @c pUInBuf and fills in @c
953 * pDecodedItem. If @c pAllocator is not NULL then memory for the
954 * string is allocated.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700955 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800956static inline QCBORError
957DecodeBytes(const QCBORInternalAllocator *pAllocator,
958 uint64_t uStrLen,
959 UsefulInputBuf *pUInBuf,
960 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700961{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800962 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800963
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800964 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
965 * CPUs. This check makes the casts to size_t below safe.
966 *
967 * The max is 4 bytes less than the largest sizeof() so this can be
968 * tested by putting a SIZE_MAX length in the CBOR test input (no
969 * one will care the limit on strings is 4 bytes shorter).
970 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800971 if(uStrLen > SIZE_MAX-4) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800972 uReturn = QCBOR_ERR_STRING_TOO_LONG;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800973 goto Done;
974 }
975
976 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530977 if(UsefulBuf_IsNULLC(Bytes)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800978 /* Failed to get the bytes for this string item */
979 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530980 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700981 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530982
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800983#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800984 /* Note that this is not where allocation to coalesce
985 * indefinite-length strings is done. This is for when the caller
986 * has requested all strings be allocated. Disabling indefinite
987 * length strings also disables this allocate-all option.
988 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800989 if(pAllocator) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800990 /* request to use the string allocator to make a copy */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800991 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530992 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800993 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530994 goto Done;
995 }
996 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800997 pDecodedItem->uDataAlloc = 1;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800998 goto Done;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530999 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001000#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1001 (void)pAllocator;
1002#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1003
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001004 /* Normal case with no string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001005 pDecodedItem->val.string = Bytes;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001006
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301007Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001008 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001009}
1010
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001011
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001012/**
1013 * @brief Map the CBOR major types for strings to the QCBOR types.
1014 *
1015 * @param[in] nCBORMajorType The CBOR major type to convert.
1016 * @retturns QCBOR type number.
1017 *
1018 * This only works for the two string types.
1019 */
1020static inline uint8_t ConvertStringMajorTypes(int nCBORMajorType)
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001021{
1022 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
1023 #error QCBOR_TYPE_BYTE_STRING no lined up with major type
1024 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001025
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001026 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
1027 #error QCBOR_TYPE_TEXT_STRING no lined up with major type
1028 #endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001029
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001030 return (uint8_t)(nCBORMajorType + 4);
1031}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001032
1033
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001034/**
1035 * @brief Map the CBOR major types for arrays/maps to the QCBOR types.
1036 *
1037 * @param[in] nCBORMajorType The CBOR major type to convert.
1038 * @retturns QCBOR type number.
1039 *
1040 * This only works for the two aggregate types.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001041 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001042static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001043{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001044 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1045 #error QCBOR_TYPE_ARRAY value not lined up with major type
1046 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001047
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001048 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1049 #error QCBOR_TYPE_MAP value not lined up with major type
1050 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001051
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001052 return (uint8_t)(nCBORMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001053}
1054
1055
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001056/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001057 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001058 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001059 * @param[in] pUInBuf Input buffer to read data item from.
1060 * @param[out] pDecodedItem The filled-in decoded item.
1061 * @param[in] pAllocator The allocator to use for strings or NULL.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001062 *
1063 * @retval QCBOR_ERR_UNSUPPORTED
1064 * @retval QCBOR_ERR_HIT_END
1065 * @retval QCBOR_ERR_INT_OVERFLOW
1066 * @retval QCBOR_ERR_STRING_ALLOCATE
1067 * @retval QCBOR_ERR_STRING_TOO_LONG
1068 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1069 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001070 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1071 *
1072 * This decodes the most primitive / atomic data item. It does
1073 * no combing of data items.
1074 */
1075static QCBORError
1076DecodeAtomicDataItem(UsefulInputBuf *pUInBuf,
1077 QCBORItem *pDecodedItem,
1078 const QCBORInternalAllocator *pAllocator)
1079{
1080 QCBORError uReturn;
1081
1082 /* Get the major type and the argument. The argument could be
1083 * length of more bytes or the value depending on the major
1084 * type. nAdditionalInfo is an encoding of the length of the
1085 * uNumber and is needed to decode floats and doubles.
1086 */
1087 int nMajorType = 0;
1088 uint64_t uArgument = 0;
1089 int nAdditionalInfo = 0;
1090
1091 memset(pDecodedItem, 0, sizeof(QCBORItem));
1092
1093 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1094 if(uReturn) {
1095 goto Done;
1096 }
1097
1098 /* At this point the major type and the argument are valid. We've
1099 * got the type and the argument that starts every CBOR data item.
1100 */
1101 switch (nMajorType) {
1102 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1103 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
1104 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1105 uReturn = QCBOR_ERR_BAD_INT;
1106 } else {
1107 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
1108 }
1109 break;
1110
1111 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1112 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1113 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
1114 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1115 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
1116 } else {
1117 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
1118 }
1119 break;
1120
1121 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1122 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
1123 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1124 /* Indefinite-length string. */
1125#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1126 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1127#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1128 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1129 break;
1130#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1131 } else {
1132 /* Definite-length string. */
1133 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1134 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1135 goto Done;
1136 }
1137 /* cast OK because of check above */
1138 pDecodedItem->val.uCount = (uint16_t)uArgument;
1139 }
1140 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
1141 break;
1142
1143 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
1144 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1145 uReturn = QCBOR_ERR_BAD_INT;
1146 } else {
1147 pDecodedItem->val.uTagV = uArgument;
1148 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1149 }
1150 break;
1151
1152 case CBOR_MAJOR_TYPE_SIMPLE:
1153 /* Major type 7: float, double, true, false, null... */
1154 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
1155 break;
1156
1157 default:
1158 /* Never happens because DecodeHead() should never return > 7 */
1159 uReturn = QCBOR_ERR_UNSUPPORTED;
1160 break;
1161 }
1162
1163Done:
1164 return uReturn;
1165}
1166
1167
1168/**
1169 * @brief Process indefinite-length strings (decode layer 5).
1170 *
1171 * @param[in] pMe Decoder context
1172 * @param[out] pDecodedItem The decoded item that work is done on.
1173 *
1174 * @retval QCBOR_ERR_UNSUPPORTED
1175 * @retval QCBOR_ERR_HIT_END
1176 * @retval QCBOR_ERR_INT_OVERFLOW
1177 * @retval QCBOR_ERR_STRING_ALLOCATE
1178 * @retval QCBOR_ERR_STRING_TOO_LONG
1179 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1180 * @retval QCBOR_ERR_BAD_TYPE_7
1181 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001182 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1183 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001184 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001185 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001186 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001187 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001188 * If it is, this loops getting the subsequent chunk data items that
1189 * make up the string. The string allocator is used to make a
1190 * contiguous buffer for the chunks. When this completes @c
1191 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001192 *
1193 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001194 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001195static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001196QCBORDecode_GetNextFullString(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001197{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001198 /* Aproximate stack usage
1199 * 64-bit 32-bit
1200 * local vars 32 16
1201 * 2 UsefulBufs 32 16
1202 * QCBORItem 56 52
1203 * TOTAL 120 74
1204 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001205
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001206 /* The string allocator is used here for two purposes: 1)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001207 * coalescing the chunks of an indefinite-length string, 2)
1208 * allocating storage for every string returned when requested.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001209 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001210 * The first use is below in this function. Indefinite-length
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001211 * strings cannot be processed at all without a string allocator.
1212 *
1213 * The second used is in DecodeBytes() which is called by
1214 * GetNext_Item() below. This second use unneccessary for most use
1215 * and only happens when requested in the call to
1216 * QCBORDecode_SetMemPool(). If the second use not requested then
1217 * NULL is passed for the string allocator to GetNext_Item().
1218 *
1219 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1220 * allocator altogether and thus both of these uses. It reduced the
1221 * decoder object code by about 400 bytes.
1222 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001223 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001224
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001225#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001226 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001227
1228 if(pMe->StringAllocator.pfAllocator) {
1229 pAllocator = &(pMe->StringAllocator);
1230 if(pMe->bStringAllocateAll) {
1231 pAllocatorForGetNext = pAllocator;
1232 }
1233 }
1234#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1235
1236 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001237 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001238 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001239 goto Done;
1240 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001241
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001242 /* Only do indefinite-length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001243 const uint8_t uStringType = pDecodedItem->uDataType;
1244 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001245 goto Done;
1246 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001247
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001248 /* Is this a string with an indefinite length? */
1249 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1250 goto Done;
1251 }
1252
1253#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001254 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001255 if(pAllocator == NULL) {
1256 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1257 goto Done;
1258 }
1259
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001260 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001261 UsefulBufC FullString = NULLUsefulBufC;
1262
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001263 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001264 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001265 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001266 /* Pass a NULL string allocator to GetNext_Item() because the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001267 * individual string chunks in an indefinite-length should not
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001268 * be allocated. They are always copied in the the contiguous
1269 * buffer allocated here.
1270 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001271 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), &StringChunkItem, NULL);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001272 if(uReturn) {
1273 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001274 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001275
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001276 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001277 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001278 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001279 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301280 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001281 break;
1282 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001283
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001284 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001285 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001286 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001287 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001288 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001289 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001290 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1291 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
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 /* The first time throurgh FullString.ptr is NULL and this is
1296 * equivalent to StringAllocator_Allocate(). Subsequently it is
1297 * not NULL and a reallocation happens.
1298 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001299 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1300 UNCONST_POINTER(FullString.ptr),
1301 FullString.len + StringChunkItem.val.string.len);
1302
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001303 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001304 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001305 break;
1306 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001307
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001308 /* Copy new string chunk to the end of accumulated string */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001309 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001310 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001311
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001312 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1313 /* Getting the item failed, clean up the allocated memory */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001314 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001315 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001316#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1317 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1318#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001319
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001320Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001321 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001322}
1323
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001324
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001325/**
1326 * @brief This converts a tag number to a shorter mapped value for storage.
1327 *
1328 * @param[in] pMe The decode context.
1329 * @param[in] uUnMappedTag The tag number to map
1330 * @param[out] puMappedTagNumer The stored tag number.
1331 *
1332 * @return error code.
1333 *
1334 * The main point of mapping tag numbers is make QCBORItem
1335 * smaller. With this mapping storage of 4 tags takes up 8
1336 * bytes. Without, it would take up 32 bytes.
1337 *
1338 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1339 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1340 *
1341 * See also UnMapTagNumber() and @ref QCBORItem.
1342 */
1343static inline QCBORError
1344MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1345{
1346 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1347 unsigned uTagMapIndex;
1348 /* Is there room in the tag map, or is it in it already? */
1349 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1350 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1351 break;
1352 }
1353 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1354 break;
1355 }
1356 }
1357 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1358 return QCBOR_ERR_TOO_MANY_TAGS;
1359 }
1360
1361 /* Covers the cases where tag is new and were it is already in the map */
1362 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1363 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1364
1365 } else {
1366 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1367 }
1368
1369 return QCBOR_SUCCESS;
1370}
1371
1372
1373/**
1374 * @brief This converts a mapped tag number to the actual tag number.
1375 *
1376 * @param[in] pMe The decode context.
1377 * @param[in] uMappedTagNumber The stored tag number.
1378 *
1379 * @return The actual tag number is returned or
1380 * @ref CBOR_TAG_INVALID64 on error.
1381 *
1382 * This is the reverse of MapTagNumber()
1383 */
1384static uint64_t
1385UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1386{
1387 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1388 return uMappedTagNumber;
1389 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001390 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001391 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001392 /* This won't be negative because of code below in
1393 * MapTagNumber()
1394 */
1395 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1396 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001397 }
1398}
1399
Laurence Lundblade9b334962020-08-27 10:55:53 -07001400
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001401/**
1402 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1403 *
1404 * @param[in] pMe Decoder context
1405 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001406
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001407 * @retval QCBOR_ERR_UNSUPPORTED
1408 * @retval QCBOR_ERR_HIT_END
1409 * @retval QCBOR_ERR_INT_OVERFLOW
1410 * @retval QCBOR_ERR_STRING_ALLOCATE
1411 * @retval QCBOR_ERR_STRING_TOO_LONG
1412 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1413 * @retval QCBOR_ERR_BAD_TYPE_7
1414 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1415 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1416 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1417 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1418 * @retval QCBOR_ERR_TOO_MANY_TAGS
1419 *
1420 * This loops getting atomic data items until one is not a tag
1421 * number. Usually this is largely pass-through because most
1422 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001423 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001424static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001425QCBORDecode_GetNextTagNumber(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001426{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001427 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1428
1429 /* Initialize to CBOR_TAG_INVALID16 */
1430 #if CBOR_TAG_INVALID16 != 0xffff
1431 /* Be sure the memset does the right thing. */
1432 #err CBOR_TAG_INVALID16 tag not defined as expected
1433 #endif
1434 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001435
Laurence Lundblade9b334962020-08-27 10:55:53 -07001436 QCBORError uReturn = QCBOR_SUCCESS;
1437
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001438 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001439 for(;;) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001440 QCBORError uErr = QCBORDecode_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001441 if(uErr != QCBOR_SUCCESS) {
1442 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001443 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001444 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001445
Laurence Lundblade9b334962020-08-27 10:55:53 -07001446 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001447 /* Successful exit from loop; maybe got some tags, maybe not */
1448 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001449 break;
1450 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001451
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001452 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1453 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001454 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001455 /* Continue on to get all tags wrapping this item even though
1456 * it is erroring out in the end. This allows decoding to
1457 * continue. This is a resource limit error, not a problem
1458 * with being well-formed CBOR.
1459 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001460 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001461 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001462 /* Slide tags over one in the array to make room at index 0.
1463 * Must use memmove because the move source and destination
1464 * overlap.
1465 */
1466 memmove(&auItemsTags[1], auItemsTags, sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001467
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001468 /* Map the tag */
1469 uint16_t uMappedTagNumer;
1470 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumer);
1471 /* Continue even on error so as to consume all tags wrapping
1472 * this data item so decoding can go on. If MapTagNumber()
1473 * errors once it will continue to error.
1474 */
1475 auItemsTags[0] = uMappedTagNumer;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001476 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001477
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001478Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001479 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001480}
1481
1482
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001483/**
1484 * @brief Combine a map entry label and value into one item (decode layer 3).
1485 *
1486 * @param[in] pMe Decoder context
1487 * @param[out] pDecodedItem The decoded item that work is done on.
1488 *
1489 * @retval QCBOR_ERR_UNSUPPORTED
1490 * @retval QCBOR_ERR_HIT_END
1491 * @retval QCBOR_ERR_INT_OVERFLOW
1492 * @retval QCBOR_ERR_STRING_ALLOCATE
1493 * @retval QCBOR_ERR_STRING_TOO_LONG
1494 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1495 * @retval QCBOR_ERR_BAD_TYPE_7
1496 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1497 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1498 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1499 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1500 * @retval QCBOR_ERR_TOO_MANY_TAGS
1501 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1502 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1503 *
1504 * If a the current nesting level is a map, then this
1505 * combines pairs of items into one data item with a label
1506 * and value.
1507 *
1508 * This is pass-through if the current nesting leve is
1509 * not a map.
1510 *
1511 * This also implements maps-as-array mode where a map
1512 * is treated like an array to allow caller to do their
1513 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001514 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001515static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001516QCBORDecode_GetNextMapEntry(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001517{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001518 QCBORError uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1519 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001520 goto Done;
1521 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001522
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001523 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1524 /* Break can't be a map entry */
1525 goto Done;
1526 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001527
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001528 if(pMe->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1529 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001530
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001531 if(DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1532 /* Save label in pDecodedItem and get the next which will
1533 * be the real data item.
1534 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001535 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001536 uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1537 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001538 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001539 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001540
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301541 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001542
1543 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001544 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001545 pDecodedItem->label.string = LabelItem.val.string;
1546 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001547 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == pMe->uDecodeMode) {
1548 /* It's not a string and we only want strings */
1549 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001550 goto Done;
1551 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1552 pDecodedItem->label.int64 = LabelItem.val.int64;
1553 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1554 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1555 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1556 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1557 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1558 pDecodedItem->label.string = LabelItem.val.string;
1559 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1560 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1561 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001562 /* label is not an int or a string. It is an arrray
1563 * or a float or such and this implementation doesn't handle that.
1564 * Also, tags on labels are ignored.
1565 */
1566 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001567 goto Done;
1568 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001569 }
1570 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001571 /* Decoding of maps as arrays to let the caller decide what to do
1572 * about labels, particularly lables that are not integers or
1573 * strings.
1574 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001575 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001576 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001577 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001578 goto Done;
1579 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001580 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001581 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1582 * Cast is needed because of integer promotion.
1583 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001584 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001585 }
1586 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001587
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001588Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001589 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001590}
1591
1592
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001593#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001594/**
1595 * @brief Peek and see if next data item is a break;
1596 *
1597 * @param[in] pUIB UsefulInputBuf to read from.
1598 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1599 *
1600 * @return Any decoding error.
1601 *
1602 * See if next item is a CBOR break. If it is, it is consumed,
1603 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001604*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001605static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001606NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1607{
1608 *pbNextIsBreak = false;
1609 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001610 QCBORItem Peek;
1611 size_t uPeek = UsefulInputBuf_Tell(pUIB);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001612 QCBORError uReturn = DecodeAtomicDataItem(pUIB, &Peek, NULL);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001613 if(uReturn != QCBOR_SUCCESS) {
1614 return uReturn;
1615 }
1616 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001617 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001618 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001619 } else {
1620 *pbNextIsBreak = true;
1621 }
1622 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001623
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001624 return QCBOR_SUCCESS;
1625}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001626#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001627
1628
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001629/**
1630 * @brief Ascend up nesting levels if all items in them have been consumed.
1631 *
1632 * @param[in] pMe The decode context.
1633 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1634 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001635 * An item was just consumed, now figure out if it was the
1636 * end of an array/map map that can be closed out. That
1637 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001638*/
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001639static QCBORError
1640QCBORDecode_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001641{
1642 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001643
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001644 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001645 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1646
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001647 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1648 /* Nesting level is bstr-wrapped CBOR */
1649
1650 /* Ascent for bstr-wrapped CBOR is always by explicit call
1651 * so no further ascending can happen.
1652 */
1653 break;
1654
1655 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1656 /* Level is a definite-length array/map */
1657
1658 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001659 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1660 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001661 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001662 break;
1663 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001664 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001665 * is time to ascend one level. This happens below.
1666 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001667
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001668#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001669 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001670 /* Level is an indefinite-length array/map. */
1671
1672 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001673 bool bIsBreak = false;
1674 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1675 if(uReturn != QCBOR_SUCCESS) {
1676 goto Done;
1677 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001678
1679 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001680 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001681 break;
1682 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001683
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001684 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001685 * it is time to ascend one level.
1686 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001687
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001688#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001689 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001690
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001691
1692 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001693
Laurence Lundblade93d89472020-10-03 22:30:50 -07001694 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001695 * QCBORDecode_ExitBoundedMode().
1696 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001697 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001698 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001699 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001700 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001701 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001702 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001703
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001704 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001705 break;
1706 }
1707
1708 /* Finally, actually ascend one level. */
1709 DecodeNesting_Ascend(&(pMe->nesting));
1710 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001711
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001712 uReturn = QCBOR_SUCCESS;
1713
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001714#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001715Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001716#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1717
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001718 return uReturn;
1719}
1720
1721
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001722/**
1723 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1724 *
1725 * @param[in] pMe Decoder context
1726 * @param[out] pDecodedItem The decoded item that work is done on.
1727 *
1728 * @retval QCBOR_ERR_UNSUPPORTED
1729 * @retval QCBOR_ERR_HIT_END
1730 * @retval QCBOR_ERR_INT_OVERFLOW
1731 * @retval QCBOR_ERR_STRING_ALLOCATE
1732 * @retval QCBOR_ERR_STRING_TOO_LONG
1733 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1734 * @retval QCBOR_ERR_BAD_TYPE_7
1735 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1736 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1737 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1738 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1739 * @retval QCBOR_ERR_TOO_MANY_TAGS
1740 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1741 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1742 * @retval QCBOR_ERR_NO_MORE_ITEMS
1743 * @retval QCBOR_ERR_BAD_BREAK
1744 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
1745 *
1746 * This handles the traversal descending into and asecnding out of
1747 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
1748 * definite- and indefinte-length maps and arrays by looking at the
1749 * item count or finding CBOR breaks. It detects the ends of the
1750 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001751 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001752static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001753QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001754{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001755 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001756 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001757
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001758 /* If out of bytes to consume, it is either the end of the
1759 * top-level sequence of some bstr-wrapped CBOR that was entered.
1760 *
1761 * In the case of bstr-wrapped CBOR, the length of the
1762 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
1763 * the bstr-wrapped CBOR is exited, the length is set back to the
1764 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001765 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001766 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001767 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001768 goto Done;
1769 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001770
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001771 /* Check to see if at the end of a bounded definite-length map or
1772 * array. The check for a break ending indefinite-length array is
1773 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001774 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001775 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001776 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001777 goto Done;
1778 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001779
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001780 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001781 uReturn = QCBORDecode_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001782 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1783 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001784 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001785 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301786
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001787 /* Breaks ending arrays/maps are processed later in the call to
1788 * QCBORDecode_NestLevelAscender(). They should never show up here.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001789 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301790 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001791 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301792 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301793 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001794
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001795 /* Record the nesting level for this data item before processing
1796 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001797 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001798 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001799
Laurence Lundblade642282a2020-06-23 12:00:33 -07001800
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001801 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001802 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001803 /* If the new item is a map or array, descend.
1804 *
1805 * Empty indefinite-length maps and arrays are descended into,
1806 * but then ascended out of in the next chunk of code.
1807 *
1808 * Maps and arrays do count as items in the map/array that
1809 * encloses them so a decrement needs to be done for them too,
1810 * but that is done only when all the items in them have been
1811 * processed, not when they are opened with the exception of an
1812 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001813 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001814 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001815 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001816 pDecodedItem->uDataType,
1817 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001818 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001819 /* This error is probably a traversal error and it overrides
1820 * the non-traversal error.
1821 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001822 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001823 goto Done;
1824 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001825 }
1826
Laurence Lundblade02625d42020-06-25 14:41:41 -07001827 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1828 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1829 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001830 /* The following cases are handled here:
1831 * - A non-aggregate item like an integer or string
1832 * - An empty definite-length map or array
1833 * - An indefinite-length map or array that might be empty or might not.
1834 *
1835 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
1836 * for an definite-length map/array and break detection for an
1837 * indefinite-0length map/array. If the end of the map/array was
1838 * reached, then it ascends nesting levels, possibly all the way
1839 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001840 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001841 QCBORError uAscendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001842 uAscendErr = QCBORDecode_NestLevelAscender(pMe, true);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001843 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001844 /* This error is probably a traversal error and it overrides
1845 * the non-traversal error.
1846 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001847 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001848 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001849 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301850 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001851
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001852 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001853 /* Tell the caller what level is next. This tells them what
1854 * maps/arrays were closed out and makes it possible for them to
1855 * reconstruct the tree with just the information returned in a
1856 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001857 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001858 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001859 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001860 pDecodedItem->uNextNestLevel = 0;
1861 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001862 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001863 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001864
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001865Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001866 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001867}
1868
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001869
1870/**
1871 * @brief Shift 0th tag out of the tag list.
1872 *
1873 * pDecodedItem[in,out] The data item to convert.
1874 *
1875 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
1876 * shifted into empty slot at the end of the tag list.
1877 */
1878static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001879{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001880 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
1881 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
1882 }
1883 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001884}
1885
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001886
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001887/**
1888 * @brief Convert different epoch date formats in to the QCBOR epoch date format
1889 *
1890 * pDecodedItem[in,out] The data item to convert.
1891 *
1892 * @retval QCBOR_ERR_DATE_OVERFLOW
1893 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1894 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1895 *
1896 * The epoch date tag defined in QCBOR allows for floating-point
1897 * dates. It even allows a protocol to flop between date formats when
1898 * ever it wants. Floating-point dates aren't that useful as they are
1899 * only needed for dates beyond the age of the earth.
1900 *
1901 * This converts all the date formats into one format of an unsigned
1902 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001903 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001904static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001905{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001906 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001907
1908 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1909
1910 switch (pDecodedItem->uDataType) {
1911
1912 case QCBOR_TYPE_INT64:
1913 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1914 break;
1915
1916 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001917 /* This only happens for CBOR type 0 > INT64_MAX so it is
1918 * always an overflow.
1919 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001920 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1921 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001922 break;
1923
1924 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001925 case QCBOR_TYPE_FLOAT:
1926#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001927 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001928 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001929 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001930 pDecodedItem->val.dfnum :
1931 (double)pDecodedItem->val.fnum;
1932
1933 /* The conversion from float to integer requires overflow
1934 * detection since floats can be much larger than integers.
1935 * This implementation errors out on these large float values
1936 * since they are beyond the age of the earth.
1937 *
1938 * These constants for the overflow check are computed by the
1939 * compiler. They are not computed at run time.
1940 *
1941 * The factor of 0x7ff is added/subtracted to avoid a
1942 * rounding error in the wrong direction when the compiler
1943 * computes these constants. There is rounding because an
1944 * 64-bit integer has 63 bits of precision where a double
1945 * only has 53 bits. Without the 0x7ff factor, the compiler
1946 * may round up and produce a double for the bounds check
1947 * that is larger than can be stored in a 64-bit integer. The
1948 * amount of 0x7ff is picked because it has 11 bits set.
1949 *
1950 * Without the 0x7ff there is a ~30 minute range of time
1951 * values 10 billion years in the past and in the future
1952 * where this code could go wrong. Some compilers correctly
1953 * generate a warning or error without the 0x7ff.
1954 */
1955 const double dDateMax = (double)(INT64_MAX - 0x7ff);
1956 const double dDateMin = (double)(INT64_MIN + 0x7ff);
1957
1958 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07001959 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001960 goto Done;
1961 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001962
1963 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001964 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001965 pDecodedItem->val.epochDate.fSecondsFraction =
1966 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001967 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001968#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07001969
Laurence Lundbladec7114722020-08-13 05:11:40 -07001970 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001971 goto Done;
1972
Laurence Lundblade9682a532020-06-06 18:33:04 -07001973#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001974 break;
1975
1976 default:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001977 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001978 goto Done;
1979 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001980
Laurence Lundblade59289e52019-12-30 13:44:37 -08001981 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1982
1983Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001984 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001985}
1986
1987
1988#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001989/**
1990 * @brief Decode decimal fractions and big floats.
1991 *
1992 * @param[in] pMe The decode context.
1993 * @param[in,out] pDecodedItem On input the array data item that
1994 * holds the mantissa and exponent. On
1995 * output the decoded mantissa and
1996 * exponent.
1997 *
1998 * @returns Decoding errors from getting primitive data items or
1999 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2000 *
2001 * When called pDecodedItem must be the array that is tagged as a big
2002 * float or decimal fraction, the array that has the two members, the
2003 * exponent and mantissa.
2004 *
2005 * This will fetch and decode the exponent and mantissa and put the
2006 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002007 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002008static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002009QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002010{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002011 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002012
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002013 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002014 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002015 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002016 goto Done;
2017 }
2018
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002019 /* A check for pDecodedItem->val.uCount == 2 would work for
2020 * definite-length arrays, but not for indefnite. Instead remember
2021 * the nesting level the two integers must be at, which is one
2022 * deeper than that of the array.
2023 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002024 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2025
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002026 /* --- Which is it, decimal fraction or a bigfloat? --- */
2027 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002028 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2029
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002030 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002031 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002032 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2033 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002034 goto Done;
2035 }
2036 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002037 /* Array is empty or a map/array encountered when expecting an int */
2038 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002039 goto Done;
2040 }
2041 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002042 /* Data arriving as an unsigned int < INT64_MAX has been
2043 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2044 * also means that the only data arriving here of type
2045 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2046 * and thus an error that will get handled in the next else.
2047 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002048 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2049 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002050 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2051 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002052 goto Done;
2053 }
2054
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002055 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002056 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002057 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2058 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002059 goto Done;
2060 }
2061 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002062 /* Mantissa missing or map/array encountered when expecting number */
2063 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002064 goto Done;
2065 }
2066 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002067 /* Data arriving as an unsigned int < INT64_MAX has been
2068 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2069 * also means that the only data arriving here of type
2070 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2071 * and thus an error that will get handled in an else below.
2072 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002073 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002074 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2075 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002076 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002077 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002078 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002079 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2080 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2081 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002082 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002083 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2084 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002085 goto Done;
2086 }
2087
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002088 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002089 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002090 /* Extra items in the decimal fraction / big float */
2091 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002092 goto Done;
2093 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002094 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002095
2096Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002097 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002098}
2099#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
2100
2101
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002102/**
2103 * @brief Decode the MIME type tag
2104 *
2105 * @param[in,out] pDecodedItem The item to decode.
2106 *
2107 * Handle the text and binary MIME type tags. Slightly too complicated
2108 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2109 * incorreclty text-only.
2110 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002111static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002112{
2113 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2114 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002115 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002116 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2117 } else {
2118 return QCBOR_ERR_BAD_OPT_TAG;
2119 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002120
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002121 return QCBOR_SUCCESS;
2122}
2123
2124
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002125/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002126 * Table of CBOR tags whose content is either a text string or a byte
2127 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2128 * of uQCBORtype indicates the content should be a byte string rather
2129 * than a text string
2130 */
2131struct StringTagMapEntry {
2132 uint16_t uTagNumber;
2133 uint8_t uQCBORtype;
2134};
2135
2136#define IS_BYTE_STRING_BIT 0x80
2137#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2138
2139static const struct StringTagMapEntry StringTagMap[] = {
2140 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
2141 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2142 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2143 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2144 {CBOR_TAG_URI, QCBOR_TYPE_URI},
2145 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2146 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2147 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2148 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
2149 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2150 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2151};
2152
2153
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002154/**
2155 * @brief Process standard CBOR tags whose content is a string
2156 *
2157 * @param[in] uTag The tag.
2158 * @param[in,out] pDecodedItem The data item.
2159 *
2160 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2161 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2162 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2163 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002164 * Process the CBOR tags that whose content is a byte string or a text
2165 * string and for which the string is just passed on to the caller.
2166 *
2167 * This maps the CBOR tag to the QCBOR type and checks the content
2168 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002169 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002170 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002171 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002172static inline QCBORError
2173ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002174{
Laurence Lundblade99615302020-11-29 11:19:47 -08002175 /* This only works on tags that were not mapped; no need for other yet */
2176 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2177 return QCBOR_ERR_UNSUPPORTED;
2178 }
2179
2180 unsigned uIndex;
2181 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2182 if(StringTagMap[uIndex].uTagNumber == uTag) {
2183 break;
2184 }
2185 }
2186
2187 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2188 if(uQCBORType == QCBOR_TYPE_NONE) {
2189 /* repurpose this error to mean, not handled here */
2190 return QCBOR_ERR_UNSUPPORTED;
2191 }
2192
2193 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2194 if(uQCBORType & IS_BYTE_STRING_BIT) {
2195 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2196 }
2197
2198 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002199 return QCBOR_ERR_BAD_OPT_TAG;
2200 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002201
Laurence Lundblade99615302020-11-29 11:19:47 -08002202 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002203 return QCBOR_SUCCESS;
2204}
2205
2206
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002207/**
2208 * @brief Decode tag content for select tags (decoding layer 1).
2209 *
2210 * @param[in] pMe The decode context.
2211 * @param[out] pDecodedItem The decoded item.
2212 *
2213 * @return Decoding error code.
2214 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002215 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2216 * but the whole tag was not decoded. Here, the whole tags (tag number
2217 * and tag content) that are supported by QCBOR are decoded. This is a
2218 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002219 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002220static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002221QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002222{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002223 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002224
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002225 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002226 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002227 goto Done;
2228 }
2229
Laurence Lundblade99615302020-11-29 11:19:47 -08002230 /* When there are no tag numbers for the item, this exits first
2231 * thing and effectively does nothing.
2232 *
2233 * This loops over all the tag numbers accumulated for this item
2234 * trying to decode and interpret them. This stops at the end of
2235 * the list or at the first tag number that can't be interpreted by
2236 * this code. This is effectively a recursive processing of the
2237 * tags number list that handles nested tags.
2238 */
2239 while(1) {
2240 /* Don't bother to unmap tags via QCBORITem.uTags since this
2241 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2242 */
2243 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002244
Laurence Lundblade99615302020-11-29 11:19:47 -08002245 if(uTagToProcess == CBOR_TAG_INVALID16) {
2246 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002247 break;
2248
Laurence Lundblade99615302020-11-29 11:19:47 -08002249 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002250 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002251
Laurence Lundblade93d89472020-10-03 22:30:50 -07002252#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002253 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2254 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002255 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundblade93d89472020-10-03 22:30:50 -07002256#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002257
Laurence Lundblade99615302020-11-29 11:19:47 -08002258 } else if(uTagToProcess == CBOR_TAG_MIME ||
2259 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002260 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002261
Laurence Lundblade99615302020-11-29 11:19:47 -08002262 } else {
2263 /* See if it is a pass-through byte/text string tag; process if so */
2264 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002265
Laurence Lundblade99615302020-11-29 11:19:47 -08002266 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2267 /* It wasn't a pass-through byte/text string tag so it is
2268 * an unknown tag. This is the exit from the loop on the
2269 * first unknown tag. It is a successful exit.
2270 */
2271 uReturn = QCBOR_SUCCESS;
2272 break;
2273 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002274 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002275
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002276 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002277 /* Error exit from the loop */
2278 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002279 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002280
2281 /* A tag was successfully processed, shift it out of the list of
2282 * tags returned. This is the loop increment.
2283 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002284 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002285 }
2286
2287Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002288 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002289}
2290
2291
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002292/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002293 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002294 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002295QCBORError
2296QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2297{
2298 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002299 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002300 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002301 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2302 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2303 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002304 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002305}
2306
2307
2308/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002309 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002310 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002311QCBORError
2312QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2313{
2314 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2315 const UsefulInputBuf Save = pMe->InBuf;
2316
2317 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2318
2319 pMe->nesting = SaveNesting;
2320 pMe->InBuf = Save;
2321
2322 return uErr;
2323}
2324
2325
2326/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002327 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002328 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002329void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2330{
2331 if(pMe->uLastError != QCBOR_SUCCESS) {
2332 return;
2333 }
2334
2335 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2336}
2337
2338
2339/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002340 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002341 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002342QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002343QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2344 QCBORItem *pDecodedItem,
2345 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002346{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002348
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002349 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2350 if(uReturn != QCBOR_SUCCESS) {
2351 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002352 }
2353
2354 if(pTags != NULL) {
2355 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002356 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002357 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2358 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002359 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002360 }
2361 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2362 return QCBOR_ERR_TOO_MANY_TAGS;
2363 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002364 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002365 pTags->uNumUsed++;
2366 }
2367 }
2368
2369 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002370}
2371
2372
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002373/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002374 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302375 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002376bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002377 const QCBORItem *pItem,
2378 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002379{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002380 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2381 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002382 break;
2383 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002384 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002385 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002386 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002387 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002388
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002389 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002390}
2391
2392
2393/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002394 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002395 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002396QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002397{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002398 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002399
2400 if(uReturn != QCBOR_SUCCESS) {
2401 goto Done;
2402 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002403
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002404 /* Error out if all the maps/arrays are not closed out */
2405 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002406 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002407 goto Done;
2408 }
2409
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002410 /* Error out if not all the bytes are consumed */
2411 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002412 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002413 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002414
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002415Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002416#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002417 /* Call the destructor for the string allocator if there is one.
2418 * Always called, even if there are errors; always have to clean up.
2419 */
2420 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002421#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002422
Laurence Lundblade085d7952020-07-24 10:26:30 -07002423 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002424}
2425
2426
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002427/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002428 * Public function, see header qcbor/qcbor_decode.h file
2429 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002430// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002431uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2432 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002433 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002434{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002435 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2436 return CBOR_TAG_INVALID64;
2437 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002438 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2439 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002440 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002441 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002442 }
2443}
2444
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002445
Laurence Lundblade9b334962020-08-27 10:55:53 -07002446/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002447 * Public function, see header qcbor/qcbor_decode.h file
2448 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002449uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2450 uint32_t uIndex)
2451{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002452 if(pMe->uLastError != QCBOR_SUCCESS) {
2453 return CBOR_TAG_INVALID64;
2454 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002455 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2456 return CBOR_TAG_INVALID64;
2457 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002458 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002459 }
2460}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002461
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002462
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002463
2464
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002465#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002466
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002467/* ===========================================================================
2468 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002469
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002470 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002471 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2472 implements the function type QCBORStringAllocate and allows easy
2473 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002474
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002475 This particular allocator is built-in for convenience. The caller
2476 can implement their own. All of this following code will get
2477 dead-stripped if QCBORDecode_SetMemPool() is not called.
2478
2479 This is a very primitive memory allocator. It does not track
2480 individual allocations, only a high-water mark. A free or
2481 reallocation must be of the last chunk allocated.
2482
2483 The size of the pool and offset to free memory are packed into the
2484 first 8 bytes of the memory pool so we don't have to keep them in
2485 the decode context. Since the address of the pool may not be
2486 aligned, they have to be packed and unpacked as if they were
2487 serialized data of the wire or such.
2488
2489 The sizes packed in are uint32_t to be the same on all CPU types
2490 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002491 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002492
2493
Laurence Lundbladeee851742020-01-08 08:37:05 -08002494static inline int
2495MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002496{
2497 // Use of UsefulInputBuf is overkill, but it is convenient.
2498 UsefulInputBuf UIB;
2499
Laurence Lundbladeee851742020-01-08 08:37:05 -08002500 // Just assume the size here. It was checked during SetUp so
2501 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002502 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002503 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2504 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2505 return UsefulInputBuf_GetError(&UIB);
2506}
2507
2508
Laurence Lundbladeee851742020-01-08 08:37:05 -08002509static inline int
2510MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002511{
2512 // Use of UsefulOutBuf is overkill, but convenient. The
2513 // length check performed here is useful.
2514 UsefulOutBuf UOB;
2515
2516 UsefulOutBuf_Init(&UOB, Pool);
2517 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2518 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2519 return UsefulOutBuf_GetError(&UOB);
2520}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002521
2522
2523/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002524 Internal function for an allocation, reallocation free and destuct.
2525
2526 Having only one function rather than one each per mode saves space in
2527 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002528
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002529 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2530 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002531static UsefulBuf
2532MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002533{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002534 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002535
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002536 uint32_t uPoolSize;
2537 uint32_t uFreeOffset;
2538
2539 if(uNewSize > UINT32_MAX) {
2540 // This allocator is only good up to 4GB. This check should
2541 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2542 goto Done;
2543 }
2544 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2545
2546 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2547 goto Done;
2548 }
2549
2550 if(uNewSize) {
2551 if(pMem) {
2552 // REALLOCATION MODE
2553 // Calculate pointer to the end of the memory pool. It is
2554 // assumed that pPool + uPoolSize won't wrap around by
2555 // assuming the caller won't pass a pool buffer in that is
2556 // not in legitimate memory space.
2557 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2558
2559 // Check that the pointer for reallocation is in the range of the
2560 // pool. This also makes sure that pointer math further down
2561 // doesn't wrap under or over.
2562 if(pMem >= pPool && pMem < pPoolEnd) {
2563 // Offset to start of chunk for reallocation. This won't
2564 // wrap under because of check that pMem >= pPool. Cast
2565 // is safe because the pool is always less than UINT32_MAX
2566 // because of check in QCBORDecode_SetMemPool().
2567 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2568
2569 // Check to see if the allocation will fit. uPoolSize -
2570 // uMemOffset will not wrap under because of check that
2571 // pMem is in the range of the uPoolSize by check above.
2572 if(uNewSize <= uPoolSize - uMemOffset) {
2573 ReturnValue.ptr = pMem;
2574 ReturnValue.len = uNewSize;
2575
2576 // Addition won't wrap around over because uNewSize was
2577 // checked to be sure it is less than the pool size.
2578 uFreeOffset = uMemOffset + uNewSize32;
2579 }
2580 }
2581 } else {
2582 // ALLOCATION MODE
2583 // uPoolSize - uFreeOffset will not underflow because this
2584 // pool implementation makes sure uFreeOffset is always
2585 // smaller than uPoolSize through this check here and
2586 // reallocation case.
2587 if(uNewSize <= uPoolSize - uFreeOffset) {
2588 ReturnValue.len = uNewSize;
2589 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002590 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002591 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002592 }
2593 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002594 if(pMem) {
2595 // FREE MODE
2596 // Cast is safe because of limit on pool size in
2597 // QCBORDecode_SetMemPool()
2598 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2599 } else {
2600 // DESTRUCT MODE
2601 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002602 }
2603 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002604
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002605 UsefulBuf Pool = {pPool, uPoolSize};
2606 MemPool_Pack(Pool, uFreeOffset);
2607
2608Done:
2609 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002610}
2611
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002612
Laurence Lundbladef6531662018-12-04 10:42:22 +09002613/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002614 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002615 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002616QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2617 UsefulBuf Pool,
2618 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002619{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002620 // The pool size and free mem offset are packed into the beginning
2621 // of the pool memory. This compile time check make sure the
2622 // constant in the header is correct. This check should optimize
2623 // down to nothing.
2624 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002625 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002626 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002627
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002628 // The pool size and free offset packed in to the beginning of pool
2629 // memory are only 32-bits. This check will optimize out on 32-bit
2630 // machines.
2631 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002632 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002633 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002634
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002635 // This checks that the pool buffer given is big enough.
2636 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002637 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002638 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002639
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002640 pMe->StringAllocator.pfAllocator = MemPool_Function;
2641 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2642 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002643
Laurence Lundblade30816f22018-11-10 13:40:22 +07002644 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002645}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002646#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002647
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002648
2649
Laurence Lundblade9b334962020-08-27 10:55:53 -07002650static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2651{
2652 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2653}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002654
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002655
2656/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002657 Consume an entire map or array (and do next to
2658 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002659 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002660static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002661ConsumeItem(QCBORDecodeContext *pMe,
2662 const QCBORItem *pItemToConsume,
2663 uint_fast8_t *puNextNestLevel)
2664{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002665 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002666 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002667
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002668 // If it is a map or array, this will tell if it is empty.
2669 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2670
2671 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2672 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002673
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002674 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002675 * maps and arrays by using the nesting level
2676 */
2677 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002678 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002679 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002680 goto Done;
2681 }
2682 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002683
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002684 *puNextNestLevel = Item.uNextNestLevel;
2685
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002686 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002687
Laurence Lundblade1341c592020-04-11 14:19:05 -07002688 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002689 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002690 /* Just pass the nesting level through */
2691 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2692
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002693 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002694 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002695
2696Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002697 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002698}
2699
2700
Laurence Lundblade1341c592020-04-11 14:19:05 -07002701/* Return true if the labels in Item1 and Item2 are the same.
2702 Works only for integer and string labels. Returns false
2703 for any other type. */
2704static inline bool
2705MatchLabel(QCBORItem Item1, QCBORItem Item2)
2706{
2707 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2708 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2709 return true;
2710 }
2711 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002712 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002713 return true;
2714 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002715 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002716 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2717 return true;
2718 }
2719 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2720 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2721 return true;
2722 }
2723 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002724
Laurence Lundblade1341c592020-04-11 14:19:05 -07002725 /* Other label types are never matched */
2726 return false;
2727}
2728
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002729
2730/*
2731 Returns true if Item1 and Item2 are the same type
2732 or if either are of QCBOR_TYPE_ANY.
2733 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002734static inline bool
2735MatchType(QCBORItem Item1, QCBORItem Item2)
2736{
2737 if(Item1.uDataType == Item2.uDataType) {
2738 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002739 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002740 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002741 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002742 return true;
2743 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002744 return false;
2745}
2746
2747
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002748/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002749 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002750
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002751 @param[in] pMe The decode context to search.
2752 @param[in,out] pItemArray The items to search for and the items found.
2753 @param[out] puOffset Byte offset of last item matched.
2754 @param[in] pCBContext Context for the not-found item call back.
2755 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002756
2757 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2758
Laurence Lundblade93d89472020-10-03 22:30:50 -07002759 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2760 were found for one of the labels being
2761 search for. This duplicate detection is
2762 only performed for items in pItemArray,
2763 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002764
Laurence Lundblade93d89472020-10-03 22:30:50 -07002765 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2766 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002767
2768 @retval Also errors returned by QCBORDecode_GetNext().
2769
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002770 On input pItemArray contains a list of labels and data types
2771 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002772
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002773 On output the fully retrieved items are filled in with
2774 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002775
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002776 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002777
2778 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002779 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002780static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002781MapSearch(QCBORDecodeContext *pMe,
2782 QCBORItem *pItemArray,
2783 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002784 void *pCBContext,
2785 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002786{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002787 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002788 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002789
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002790 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002791 uReturn = pMe->uLastError;
2792 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002793 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002794
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002795 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002796 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2797 /* QCBOR_TYPE_NONE as first item indicates just looking
2798 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002799 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2800 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002801 }
2802
Laurence Lundblade085d7952020-07-24 10:26:30 -07002803 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2804 // It is an empty bounded array or map
2805 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2806 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002807 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002808 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002809 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002810 // Nothing is ever found in an empty array or map. All items
2811 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002812 uReturn = QCBOR_SUCCESS;
2813 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002814 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002815 }
2816
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002817 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002818 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2819
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002820 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002821 UsefulInputBuf_Seek(&(pMe->InBuf),
2822 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002823
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002824 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002825 Loop over all the items in the map or array. Each item
2826 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002827 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002828 length maps and arrays. The only reason this is ever
2829 called on arrays is to find their end position.
2830
2831 This will always run over all items in order to do
2832 duplicate detection.
2833
2834 This will exit with failure if it encounters an
2835 unrecoverable error, but continue on for recoverable
2836 errors.
2837
2838 If a recoverable error occurs on a matched item, then
2839 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002840 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002841 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002842 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002843 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002844 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002845 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002846
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002847 /* Get the item */
2848 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002849 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002850 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002851 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002852 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002853 goto Done;
2854 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002855 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002856 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002857 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002858 goto Done;
2859 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002860
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002861 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002862 bool bMatched = false;
2863 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2864 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002865 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002866 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2867 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002868 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002869 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002870 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002871 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002872 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002873 goto Done;
2874 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002875
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002876 if(uResult != QCBOR_SUCCESS) {
2877 uReturn = uResult;
2878 goto Done;
2879 }
2880
Laurence Lundblade1341c592020-04-11 14:19:05 -07002881 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002882 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002883 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002884 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002885 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002886 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002887 bMatched = true;
2888 }
2889 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002890
2891
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002892 if(!bMatched && pfCallback != NULL) {
2893 /*
2894 Call the callback on unmatched labels.
2895 (It is tempting to do duplicate detection here, but that would
2896 require dynamic memory allocation because the number of labels
2897 that might be encountered is unbounded.)
2898 */
2899 uReturn = (*pfCallback)(pCBContext, &Item);
2900 if(uReturn != QCBOR_SUCCESS) {
2901 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002902 }
2903 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002904
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002905 /*
2906 Consume the item whether matched or not. This
2907 does the work of traversing maps and array and
2908 everything in them. In this loop only the
2909 items at the current nesting level are examined
2910 to match the labels.
2911 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002912 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002913 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002914 goto Done;
2915 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002916
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002917 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002918
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002919 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002920
2921 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002922
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002923 // Check here makes sure that this won't accidentally be
2924 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002925 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08002926 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
2927 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002928 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
2929 goto Done;
2930 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002931 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2932 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002933
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002934 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002935 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2936
2937 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002938 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07002939 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002940 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002941 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
2942 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002943 }
2944 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002945
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002946 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002947}
2948
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002949
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002950/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002951 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002952*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002953void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2954 int64_t nLabel,
2955 uint8_t uQcborType,
2956 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002957{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002958 if(pMe->uLastError != QCBOR_SUCCESS) {
2959 return;
2960 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002961
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002962 QCBORItem OneItemSeach[2];
2963 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2964 OneItemSeach[0].label.int64 = nLabel;
2965 OneItemSeach[0].uDataType = uQcborType;
2966 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002967
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002968 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002969
2970 *pItem = OneItemSeach[0];
2971
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002972 if(uReturn != QCBOR_SUCCESS) {
2973 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002974 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002975 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002976 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002977 }
2978
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002979 Done:
2980 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002981}
2982
2983
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002984/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002985 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002986*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002987void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2988 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07002989 uint8_t uQcborType,
2990 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002991{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002992 if(pMe->uLastError != QCBOR_SUCCESS) {
2993 return;
2994 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002995
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002996 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002997 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2998 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2999 OneItemSeach[0].uDataType = uQcborType;
3000 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003001
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003002 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3003 if(uReturn != QCBOR_SUCCESS) {
3004 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003005 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003006 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003007 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003008 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003009 }
3010
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003011 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003012
3013Done:
3014 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003015}
3016
3017
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003018
Laurence Lundblade93d89472020-10-03 22:30:50 -07003019static QCBORError
3020CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003021{
3022 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3023 if(uDataType == puTypeList[i]) {
3024 return QCBOR_SUCCESS;
3025 }
3026 }
3027 return QCBOR_ERR_UNEXPECTED_TYPE;
3028}
3029
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003030
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003031/**
3032 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003033 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003034
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003035 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3036 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003037
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003038 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3039 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003040 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003041static QCBORError
3042CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003043{
3044 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3045 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3046 /* There are tags that QCBOR couldn't process on this item and
3047 the caller has told us there should not be. */
3048 return QCBOR_ERR_UNEXPECTED_TYPE;
3049 }
3050
3051 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3052 const int nItemType = pItem->uDataType;
3053
3054 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3055 // Must match the tag and only the tag
3056 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3057 }
3058
3059 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3060 if(uReturn == QCBOR_SUCCESS) {
3061 return QCBOR_SUCCESS;
3062 }
3063
3064 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3065 /* Must match the content type and only the content type.
3066 There was no match just above so it is a fail. */
3067 return QCBOR_ERR_UNEXPECTED_TYPE;
3068 }
3069
3070 /* If here it can match either the tag or the content
3071 and it hasn't matched the content, so the end
3072 result is whether it matches the tag. This is
3073 also the case that the CBOR standard discourages. */
3074
3075 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3076}
3077
Laurence Lundblade9b334962020-08-27 10:55:53 -07003078
Laurence Lundblade9b334962020-08-27 10:55:53 -07003079
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003080// This could be semi-private if need be
3081static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003082void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3083 int64_t nLabel,
3084 TagSpecification TagSpec,
3085 QCBORItem *pItem)
3086{
3087 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3088 if(pMe->uLastError != QCBOR_SUCCESS) {
3089 return;
3090 }
3091
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003092 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003093}
3094
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003095
3096// This could be semi-private if need be
3097static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003098void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3099 const char *szLabel,
3100 TagSpecification TagSpec,
3101 QCBORItem *pItem)
3102{
3103 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3104 if(pMe->uLastError != QCBOR_SUCCESS) {
3105 return;
3106 }
3107
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003108 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003109}
3110
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003111// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003112void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3113 int64_t nLabel,
3114 TagSpecification TagSpec,
3115 UsefulBufC *pString)
3116{
3117 QCBORItem Item;
3118 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3119 if(pMe->uLastError == QCBOR_SUCCESS) {
3120 *pString = Item.val.string;
3121 }
3122}
3123
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003124// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003125void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3126 const char * szLabel,
3127 TagSpecification TagSpec,
3128 UsefulBufC *pString)
3129{
3130 QCBORItem Item;
3131 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3132 if(pMe->uLastError == QCBOR_SUCCESS) {
3133 *pString = Item.val.string;
3134 }
3135}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003136
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003137/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003138 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003139*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003140void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003141{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003142 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3143 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003144}
3145
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003146/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003147 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003148*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003149void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3150 QCBORItem *pItemList,
3151 void *pCallbackCtx,
3152 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003153{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003154 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3155 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003156}
3157
3158
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003159/**
3160 * @brief Search for a map/array by label and enter it
3161 *
3162 * @param[in] pMe The decode context.
3163 * @param[in] pSearch The map/array to search for.
3164 *
3165 * @c pSearch is expected to contain one item of type map or array
3166 * with the label specified. The current bounded map will be searched for
3167 * this and if found will be entered.
3168 *
3169 * If the label is not found, or the item found is not a map or array,
3170 * the error state is set.
3171 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003172static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003173{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003174 // The first item in pSearch is the one that is to be
3175 // entered. It should be the only one filled in. Any other
3176 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003177 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003178 return;
3179 }
3180
3181 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003182 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003183 if(pMe->uLastError != QCBOR_SUCCESS) {
3184 return;
3185 }
3186
Laurence Lundblade9b334962020-08-27 10:55:53 -07003187 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003188 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003189 return;
3190 }
3191
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003192 /*
3193 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3194 * next item for the pre-order traversal cursor to be the map/array
3195 * found by MapSearch(). The next few lines of code force the
3196 * cursor to that.
3197 *
3198 * There is no need to retain the old cursor because
3199 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3200 * beginning of the map/array being entered.
3201 *
3202 * The cursor is forced by: 1) setting the input buffer position to
3203 * the item offset found by MapSearch(), 2) setting the map/array
3204 * counter to the total in the map/array, 3) setting the nesting
3205 * level. Setting the map/array counter to the total is not
3206 * strictly correct, but this is OK because this cursor only needs
3207 * to be used to get one item and MapSearch() has already found it
3208 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003209 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003210 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003211
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003212 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3213
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003214 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003215
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003216 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003217}
3218
3219
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003220/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003221 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003222*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003223void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003224{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003225 QCBORItem OneItemSeach[2];
3226 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3227 OneItemSeach[0].label.int64 = nLabel;
3228 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3229 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003230
Laurence Lundblade9b334962020-08-27 10:55:53 -07003231 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003232 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003233}
3234
3235
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003236/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003237 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003238*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003239void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003240{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003241 QCBORItem OneItemSeach[2];
3242 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3243 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3244 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3245 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003246
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003247 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003248}
3249
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003250/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003251 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003252*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003253void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003254{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003255 QCBORItem OneItemSeach[2];
3256 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3257 OneItemSeach[0].label.int64 = nLabel;
3258 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3259 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003260
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003261 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003262}
3263
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003264/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003265 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003266*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003267void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3268{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003269 QCBORItem OneItemSeach[2];
3270 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3271 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3272 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3273 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003274
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003275 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003276}
3277
3278
Laurence Lundblade02625d42020-06-25 14:41:41 -07003279// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003280void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003281{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003282 QCBORError uErr;
3283
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003284 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003285 if(pMe->uLastError != QCBOR_SUCCESS) {
3286 // Already in error state; do nothing.
3287 return;
3288 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003289
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003290 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003291 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003292 uErr = QCBORDecode_GetNext(pMe, &Item);
3293 if(uErr != QCBOR_SUCCESS) {
3294 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003295 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003296 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003297 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3298 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003299 }
3300
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003301 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003302
3303
Laurence Lundbladef0499502020-08-01 11:55:57 -07003304 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003305 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003306 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3307 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003308 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003309 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3310 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003311 // Special case to increment nesting level for zero-length maps
3312 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003313 DecodeNesting_Descend(&(pMe->nesting), uType);
3314 }
3315
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003316 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003317
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003318 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3319 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003320
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003321 if(pItem != NULL) {
3322 *pItem = Item;
3323 }
3324
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003325Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003326 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003327}
3328
Laurence Lundblade02625d42020-06-25 14:41:41 -07003329
3330/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003331 This is the common work for exiting a level that is a bounded map,
3332 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003333
3334 One chunk of work is to set up the pre-order traversal so it is at
3335 the item just after the bounded map, array or bstr that is being
3336 exited. This is somewhat complex.
3337
3338 The other work is to level-up the bounded mode to next higest bounded
3339 mode or the top level if there isn't one.
3340 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003341static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003342ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003343{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003344 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003345
Laurence Lundblade02625d42020-06-25 14:41:41 -07003346 /*
3347 First the pre-order-traversal byte offset is positioned to the
3348 item just after the bounded mode item that was just consumed.
3349 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003350 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3351
Laurence Lundblade02625d42020-06-25 14:41:41 -07003352 /*
3353 Next, set the current nesting level to one above the bounded level
3354 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003355
Laurence Lundblade02625d42020-06-25 14:41:41 -07003356 DecodeNesting_CheckBoundedType() is always called before this and
3357 makes sure pCurrentBounded is valid.
3358 */
3359 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3360
3361 /*
3362 This does the complex work of leveling up the pre-order traversal
3363 when the end of a map or array or another bounded level is
3364 reached. It may do nothing, or ascend all the way to the top
3365 level.
3366 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003367 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003368 if(uErr != QCBOR_SUCCESS) {
3369 goto Done;
3370 }
3371
Laurence Lundblade02625d42020-06-25 14:41:41 -07003372 /*
3373 This makes the next highest bounded level the current bounded
3374 level. If there is no next highest level, then no bounded mode is
3375 in effect.
3376 */
3377 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003378
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003379 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003380
3381Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003382 return uErr;
3383}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003384
Laurence Lundblade02625d42020-06-25 14:41:41 -07003385
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003386// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003387void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003388{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003389 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003390 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003391 return;
3392 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003393
Laurence Lundblade02625d42020-06-25 14:41:41 -07003394 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003395
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003396 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003397 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003398 goto Done;
3399 }
3400
Laurence Lundblade02625d42020-06-25 14:41:41 -07003401 /*
3402 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003403 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003404 from previous map search, then do a dummy search.
3405 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003406 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003407 QCBORItem Dummy;
3408 Dummy.uLabelType = QCBOR_TYPE_NONE;
3409 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3410 if(uErr != QCBOR_SUCCESS) {
3411 goto Done;
3412 }
3413 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003414
Laurence Lundblade02625d42020-06-25 14:41:41 -07003415 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003416
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003417Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003418 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003419}
3420
3421
Laurence Lundblade1341c592020-04-11 14:19:05 -07003422
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003423static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003424 const QCBORItem *pItem,
3425 uint8_t uTagRequirement,
3426 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003427{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003428 if(pBstr) {
3429 *pBstr = NULLUsefulBufC;
3430 }
3431
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003432 if(pMe->uLastError != QCBOR_SUCCESS) {
3433 // Already in error state; do nothing.
3434 return pMe->uLastError;
3435 }
3436
3437 QCBORError uError = QCBOR_SUCCESS;
3438
3439 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
3440 uError = QCBOR_ERR_UNEXPECTED_TYPE;
3441 goto Done;;
3442 }
3443
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003444 const TagSpecification TagSpec =
3445 {
3446 uTagRequirement,
3447 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3448 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3449 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003450
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003451 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003452 if(uError != QCBOR_SUCCESS) {
3453 goto Done;
3454 }
3455
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003456 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003457 // Reverse the decrement done by GetNext() for the bstr so the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003458 // increment in QCBORDecode_NestLevelAscender() called by ExitBoundedLevel()
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003459 // will work right.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003460 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003461 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003462
3463 if(pBstr) {
3464 *pBstr = pItem->val.string;
3465 }
3466
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003467 // This saves the current length of the UsefulInputBuf and then
3468 // narrows the UsefulInputBuf to start and length of the wrapped
3469 // CBOR that is being entered.
3470 //
3471 // This makes sure the length is less than
3472 // QCBOR_MAX_DECODE_INPUT_SIZE which is slighly less than
3473 // UINT32_MAX. The value UINT32_MAX is used as a special indicator
3474 // value. The checks against QCBOR_MAX_DECODE_INPUT_SIZE also make
3475 // the casts safe. uEndOfBstr will always be less than
3476 // uPreviousLength because of the way UsefulInputBuf works so there
3477 // is no need to check it. There is also a range check in the
3478 // seek.
3479 //
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003480 // Most of these calls are simple inline accessors so this doesn't
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003481 // amount to much code.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003482 // Cast of uPreviousLength to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003483 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003484 if((uint32_t)uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003485 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003486 goto Done;
3487 }
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003488 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003489 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003490 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003491
Laurence Lundblade02625d42020-06-25 14:41:41 -07003492 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003493 (uint32_t)uPreviousLength,
3494 (uint32_t)uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003495Done:
3496 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003497}
3498
3499
Laurence Lundblade02625d42020-06-25 14:41:41 -07003500/*
3501 Public function, see header qcbor/qcbor_decode.h file
3502 */
3503void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003504 uint8_t uTagRequirement,
3505 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003506{
3507 if(pMe->uLastError != QCBOR_SUCCESS) {
3508 // Already in error state; do nothing.
3509 return;
3510 }
3511
3512 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003513 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003514 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3515 if(pMe->uLastError != QCBOR_SUCCESS) {
3516 return;
3517 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003518
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003519 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003520 &Item,
3521 uTagRequirement,
3522 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003523}
3524
3525
Laurence Lundblade02625d42020-06-25 14:41:41 -07003526/*
3527 Public function, see header qcbor/qcbor_decode.h file
3528 */
3529void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003530 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003531 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003532 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003533{
3534 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003535 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003536
Laurence Lundblade93d89472020-10-03 22:30:50 -07003537 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3538 &Item,
3539 uTagRequirement,
3540 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003541}
3542
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003543
Laurence Lundblade02625d42020-06-25 14:41:41 -07003544/*
3545 Public function, see header qcbor/qcbor_decode.h file
3546 */
3547void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003548 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003549 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003550 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003551{
3552 QCBORItem Item;
3553 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3554
Laurence Lundblade93d89472020-10-03 22:30:50 -07003555 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3556 &Item,
3557 uTagRequirement,
3558 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003559}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003560
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003561
Laurence Lundblade02625d42020-06-25 14:41:41 -07003562/*
3563 Public function, see header qcbor/qcbor_decode.h file
3564 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003565void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003566{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003567 if(pMe->uLastError != QCBOR_SUCCESS) {
3568 // Already in error state; do nothing.
3569 return;
3570 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003571
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003572 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003573 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003574 return;
3575 }
3576
3577 /*
3578 Reset the length of the UsefulInputBuf to what it was before
3579 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003580 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003581 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003582 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003583
3584
Laurence Lundblade02625d42020-06-25 14:41:41 -07003585 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003586 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003587}
3588
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003589
Laurence Lundbladee6430642020-03-14 21:15:44 -07003590
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003591
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003592
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003593
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003594
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003595
Laurence Lundblade93d89472020-10-03 22:30:50 -07003596static QCBORError
3597InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003598{
3599 switch(pItem->uDataType) {
3600 case QCBOR_TYPE_TRUE:
3601 *pBool = true;
3602 return QCBOR_SUCCESS;
3603 break;
3604
3605 case QCBOR_TYPE_FALSE:
3606 *pBool = false;
3607 return QCBOR_SUCCESS;
3608 break;
3609
3610 default:
3611 return QCBOR_ERR_UNEXPECTED_TYPE;
3612 break;
3613 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003614 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003615}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003616
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003617
Laurence Lundblade9b334962020-08-27 10:55:53 -07003618
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003619/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003620 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003621*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003622void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003623{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003624 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003625 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003626 return;
3627 }
3628
Laurence Lundbladec4537442020-04-14 18:53:22 -07003629 QCBORError nError;
3630 QCBORItem Item;
3631
3632 nError = QCBORDecode_GetNext(pMe, &Item);
3633 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003634 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003635 return;
3636 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003637 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003638}
3639
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003640
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003641/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003642 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003643*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003644void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003645{
3646 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003647 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003648
Laurence Lundblade9b334962020-08-27 10:55:53 -07003649 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003650}
3651
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003652
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003653/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003654 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003655*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003656void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3657{
3658 QCBORItem Item;
3659 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3660
Laurence Lundblade9b334962020-08-27 10:55:53 -07003661 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003662}
3663
3664
3665
Laurence Lundbladec7114722020-08-13 05:11:40 -07003666
3667static void ProcessEpochDate(QCBORDecodeContext *pMe,
3668 QCBORItem *pItem,
3669 uint8_t uTagRequirement,
3670 int64_t *pnTime)
3671{
3672 if(pMe->uLastError != QCBOR_SUCCESS) {
3673 // Already in error state, do nothing
3674 return;
3675 }
3676
3677 QCBORError uErr;
3678
3679 const TagSpecification TagSpec =
3680 {
3681 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003682 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3683 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003684 };
3685
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003686 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003687 if(uErr != QCBOR_SUCCESS) {
3688 goto Done;
3689 }
3690
3691 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3692 uErr = DecodeDateEpoch(pItem);
3693 if(uErr != QCBOR_SUCCESS) {
3694 goto Done;
3695 }
3696 }
3697
Laurence Lundblade9b334962020-08-27 10:55:53 -07003698 // Save the tags in the last item's tags in the decode context
3699 // for QCBORDecode_GetNthTagOfLast()
3700 CopyTags(pMe, pItem);
3701
Laurence Lundbladec7114722020-08-13 05:11:40 -07003702 *pnTime = pItem->val.epochDate.nSeconds;
3703
3704Done:
3705 pMe->uLastError = (uint8_t)uErr;
3706}
3707
3708
3709void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003710 uint8_t uTagRequirement,
3711 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003712{
3713 if(pMe->uLastError != QCBOR_SUCCESS) {
3714 // Already in error state, do nothing
3715 return;
3716 }
3717
3718 QCBORItem Item;
3719 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3720
3721 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3722}
3723
3724
3725void
3726QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3727 int64_t nLabel,
3728 uint8_t uTagRequirement,
3729 int64_t *pnTime)
3730{
3731 QCBORItem Item;
3732 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3733 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3734}
3735
3736
3737void
3738QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3739 const char *szLabel,
3740 uint8_t uTagRequirement,
3741 int64_t *pnTime)
3742{
3743 QCBORItem Item;
3744 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3745 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3746}
3747
3748
3749
3750
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003751void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3752 TagSpecification TagSpec,
3753 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003754{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003755 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003756 // Already in error state, do nothing
3757 return;
3758 }
3759
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003760 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003761 QCBORItem Item;
3762
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003763 uError = QCBORDecode_GetNext(pMe, &Item);
3764 if(uError != QCBOR_SUCCESS) {
3765 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003766 return;
3767 }
3768
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003769 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003770
3771 if(pMe->uLastError == QCBOR_SUCCESS) {
3772 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003773 } else {
3774 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003775 }
3776}
3777
Laurence Lundbladec4537442020-04-14 18:53:22 -07003778
3779
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003780
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003781static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003782 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003783 UsefulBufC *pValue,
3784 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003785{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003786 const TagSpecification TagSpec =
3787 {
3788 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003789 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3790 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003791 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003792
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003793 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003794 if(uErr != QCBOR_SUCCESS) {
3795 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003796 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003797
3798 *pValue = pItem->val.string;
3799
3800 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3801 *pbIsNegative = false;
3802 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3803 *pbIsNegative = true;
3804 }
3805
3806 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003807}
3808
3809
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003810/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003811 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003812 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003813void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3814 uint8_t uTagRequirement,
3815 UsefulBufC *pValue,
3816 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003817{
3818 if(pMe->uLastError != QCBOR_SUCCESS) {
3819 // Already in error state, do nothing
3820 return;
3821 }
3822
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003823 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003824 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3825 if(uError != QCBOR_SUCCESS) {
3826 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003827 return;
3828 }
3829
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003830 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003831}
3832
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003833
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003834/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003835 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003836*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003837void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3838 int64_t nLabel,
3839 uint8_t uTagRequirement,
3840 UsefulBufC *pValue,
3841 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003842{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003843 QCBORItem Item;
3844 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003845 if(pMe->uLastError != QCBOR_SUCCESS) {
3846 return;
3847 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003848
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003849 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003850}
3851
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003852
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003853/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003854 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003855*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003856void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3857 const char *szLabel,
3858 uint8_t uTagRequirement,
3859 UsefulBufC *pValue,
3860 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003861{
3862 QCBORItem Item;
3863 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003864 if(pMe->uLastError != QCBOR_SUCCESS) {
3865 return;
3866 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003867
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003868 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003869}
3870
3871
3872
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003873
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003874// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003875QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3876 const QCBORItem *pItem,
3877 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07003878 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003879{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003880 const TagSpecification TagSpecText =
3881 {
3882 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003883 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3884 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003885 };
3886 const TagSpecification TagSpecBinary =
3887 {
3888 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003889 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3890 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003891 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003892
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003893 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003894
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003895 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003896 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003897 if(pbIsTag257 != NULL) {
3898 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003899 }
3900 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003901 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003902 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003903 if(pbIsTag257 != NULL) {
3904 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003905 }
3906 uReturn = QCBOR_SUCCESS;
3907
3908 } else {
3909 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3910 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003911
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003912 return uReturn;
3913}
3914
Laurence Lundblade93d89472020-10-03 22:30:50 -07003915// Improvement: add methods for wrapped CBOR, a simple alternate
3916// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003917
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003918
3919
3920
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003921#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003922
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003923typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003924
3925
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003926// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003927static QCBORError
3928Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003929{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003930 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003931
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003932 if(uResult != 0) {
3933 /* This loop will run a maximum of 19 times because
3934 * UINT64_MAX < 10 ^^ 19. More than that will cause
3935 * exit with the overflow error
3936 */
3937 for(; nExponent > 0; nExponent--) {
3938 if(uResult > UINT64_MAX / 10) {
3939 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3940 }
3941 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003942 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003943
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003944 for(; nExponent < 0; nExponent++) {
3945 uResult = uResult / 10;
3946 if(uResult == 0) {
3947 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3948 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003949 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003950 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003951 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003952
3953 *puResult = uResult;
3954
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003955 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003956}
3957
3958
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003959// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003960static QCBORError
3961Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003962{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003963 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003964
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003965 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003966
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003967 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003968 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003969 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07003970 */
3971 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003972 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003973 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003974 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003975 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003976 nExponent--;
3977 }
3978
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003979 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003980 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003981 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3982 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003983 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003984 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003985 }
3986
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003987 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003988
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003989 return QCBOR_SUCCESS;
3990}
3991
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003992
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003993/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003994 Compute value with signed mantissa and signed result. Works with
3995 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003996 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003997static inline QCBORError ExponentiateNN(int64_t nMantissa,
3998 int64_t nExponent,
3999 int64_t *pnResult,
4000 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004001{
4002 uint64_t uResult;
4003
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004004 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004005 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004006 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4007
4008 // Do the exponentiation of the positive mantissa
4009 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4010 if(uReturn) {
4011 return uReturn;
4012 }
4013
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004014
Laurence Lundblade983500d2020-05-14 11:49:34 -07004015 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4016 of INT64_MIN. This assumes two's compliment representation where
4017 INT64_MIN is one increment farther from 0 than INT64_MAX.
4018 Trying to write -INT64_MIN doesn't work to get this because the
4019 compiler tries to work with an int64_t which can't represent
4020 -INT64_MIN.
4021 */
4022 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4023
4024 // Error out if too large
4025 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004026 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4027 }
4028
4029 // Casts are safe because of checks above
4030 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4031
4032 return QCBOR_SUCCESS;
4033}
4034
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004035
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004036/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004037 Compute value with signed mantissa and unsigned result. Works with
4038 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004039 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004040static inline QCBORError ExponentitateNU(int64_t nMantissa,
4041 int64_t nExponent,
4042 uint64_t *puResult,
4043 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004044{
4045 if(nMantissa < 0) {
4046 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4047 }
4048
4049 // Cast to unsigned is OK because of check for negative
4050 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4051 // Exponentiation is straight forward
4052 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4053}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004054
4055
4056/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004057 Compute value with signed mantissa and unsigned result. Works with
4058 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004059 */
4060static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4061 int64_t nExponent,
4062 uint64_t *puResult,
4063 fExponentiator pfExp)
4064{
4065 return (*pfExp)(uMantissa, nExponent, puResult);
4066}
4067
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004068#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4069
4070
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004071
4072
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004073
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004074static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004075{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004076 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004077
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004078 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004079 const uint8_t *pByte = BigNum.ptr;
4080 size_t uLen = BigNum.len;
4081 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004082 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004083 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004084 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004085 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004086 }
4087
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004088 *pResult = uResult;
4089 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004090}
4091
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004092
Laurence Lundblade887add82020-05-17 05:50:34 -07004093static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004094{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004095 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004096}
4097
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004098
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004099static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004100{
4101 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004102 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4103 if(uError) {
4104 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004105 }
4106 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4107 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004108 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004109}
4110
4111
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004112static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004113{
4114 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004115 /* The negative integer furthest from zero for a C int64_t is
4116 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4117 negative number in CBOR is computed as -n - 1 where n is the
4118 encoded integer, where n is what is in the variable BigNum. When
4119 converting BigNum to a uint64_t, the maximum value is thus
4120 INT64_MAX, so that when it -n - 1 is applied to it the result will
4121 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004122
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004123 -n - 1 <= INT64_MIN.
4124 -n - 1 <= -INT64_MAX - 1
4125 n <= INT64_MAX.
4126 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004127 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004128 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004129 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004130 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004131
4132 /// Now apply -n - 1. The cast is safe because
4133 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4134 // is the largest positive integer that an int64_t can
4135 // represent. */
4136 *pnResult = -(int64_t)uResult - 1;
4137
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004138 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004139}
4140
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004141
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004142
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004143
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004144
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004145/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004146Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004147
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004148\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004149
Laurence Lundblade93d89472020-10-03 22:30:50 -07004150\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4151 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004152
4153\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4154
Laurence Lundblade93d89472020-10-03 22:30:50 -07004155\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4156 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004157*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004158static QCBORError
4159ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004160{
4161 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004162 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004163 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004164#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004165 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004166 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4167 http://www.cplusplus.com/reference/cmath/llround/
4168 */
4169 // Not interested in FE_INEXACT
4170 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004171 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4172 *pnValue = llround(pItem->val.dfnum);
4173 } else {
4174 *pnValue = lroundf(pItem->val.fnum);
4175 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004176 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4177 // llround() shouldn't result in divide by zero, but catch
4178 // it here in case it unexpectedly does. Don't try to
4179 // distinguish between the various exceptions because it seems
4180 // they vary by CPU, compiler and OS.
4181 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004182 }
4183 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004184 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004185 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004186#else
4187 return QCBOR_ERR_HW_FLOAT_DISABLED;
4188#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004189 break;
4190
4191 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004192 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004193 *pnValue = pItem->val.int64;
4194 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004195 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004196 }
4197 break;
4198
4199 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004200 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004201 if(pItem->val.uint64 < INT64_MAX) {
4202 *pnValue = pItem->val.int64;
4203 } else {
4204 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4205 }
4206 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004207 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004208 }
4209 break;
4210
4211 default:
4212 return QCBOR_ERR_UNEXPECTED_TYPE;
4213 }
4214 return QCBOR_SUCCESS;
4215}
4216
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004217
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004218void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004219 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004220 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004221 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004222{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004223 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004224 return;
4225 }
4226
Laurence Lundbladee6430642020-03-14 21:15:44 -07004227 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004228 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4229 if(uError) {
4230 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004231 return;
4232 }
4233
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004234 if(pItem) {
4235 *pItem = Item;
4236 }
4237
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004238 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004239}
4240
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004241
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004242void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4243 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004244 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004245 int64_t *pnValue,
4246 QCBORItem *pItem)
4247{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004248 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004249 if(pMe->uLastError != QCBOR_SUCCESS) {
4250 return;
4251 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004252
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004253 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004254}
4255
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004256
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004257void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4258 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004259 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004260 int64_t *pnValue,
4261 QCBORItem *pItem)
4262{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004263 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004264 if(pMe->uLastError != QCBOR_SUCCESS) {
4265 return;
4266 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004267
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004268 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004269}
4270
4271
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004272/*
4273 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004274
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004275 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004276
Laurence Lundblade93d89472020-10-03 22:30:50 -07004277 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4278 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004279
4280 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4281
Laurence Lundblade93d89472020-10-03 22:30:50 -07004282 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4283 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004284 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004285static QCBORError
4286Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004287{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004288 switch(pItem->uDataType) {
4289
4290 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004291 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004292 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004293 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004294 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004295 }
4296 break;
4297
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004298 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004299 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004300 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004301 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004302 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004303 }
4304 break;
4305
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004306#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4307 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004308 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004309 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004310 pItem->val.expAndMantissa.nExponent,
4311 pnValue,
4312 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004313 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004314 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004315 }
4316 break;
4317
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004318 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004319 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004320 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004321 pItem->val.expAndMantissa.nExponent,
4322 pnValue,
4323 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004324 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004325 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004326 }
4327 break;
4328
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004329 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004330 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004331 int64_t nMantissa;
4332 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004333 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4334 if(uErr) {
4335 return uErr;
4336 }
4337 return ExponentiateNN(nMantissa,
4338 pItem->val.expAndMantissa.nExponent,
4339 pnValue,
4340 Exponentitate10);
4341 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004342 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004343 }
4344 break;
4345
4346 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004347 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004348 int64_t nMantissa;
4349 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004350 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4351 if(uErr) {
4352 return uErr;
4353 }
4354 return ExponentiateNN(nMantissa,
4355 pItem->val.expAndMantissa.nExponent,
4356 pnValue,
4357 Exponentitate10);
4358 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004359 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004360 }
4361 break;
4362
4363 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004364 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004365 int64_t nMantissa;
4366 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004367 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4368 if(uErr) {
4369 return uErr;
4370 }
4371 return ExponentiateNN(nMantissa,
4372 pItem->val.expAndMantissa.nExponent,
4373 pnValue,
4374 Exponentitate2);
4375 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004376 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004377 }
4378 break;
4379
4380 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004381 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004382 int64_t nMantissa;
4383 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004384 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4385 if(uErr) {
4386 return uErr;
4387 }
4388 return ExponentiateNN(nMantissa,
4389 pItem->val.expAndMantissa.nExponent,
4390 pnValue,
4391 Exponentitate2);
4392 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004393 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004394 }
4395 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004396#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4397
Laurence Lundbladee6430642020-03-14 21:15:44 -07004398
Laurence Lundbladec4537442020-04-14 18:53:22 -07004399 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004400 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004401}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004402
4403
Laurence Lundbladec4537442020-04-14 18:53:22 -07004404/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004405 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004406 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004407void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004408{
4409 QCBORItem Item;
4410
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004411 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004412
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004413 if(pMe->uLastError == QCBOR_SUCCESS) {
4414 // The above conversion succeeded
4415 return;
4416 }
4417
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004418 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004419 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004420 return;
4421 }
4422
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004423 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004424}
4425
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004426
4427/*
4428Public function, see header qcbor/qcbor_decode.h file
4429*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004430void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4431 int64_t nLabel,
4432 uint32_t uConvertTypes,
4433 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004434{
4435 QCBORItem Item;
4436
Laurence Lundblade93d89472020-10-03 22:30:50 -07004437 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4438 nLabel,
4439 uConvertTypes,
4440 pnValue,
4441 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004442
4443 if(pMe->uLastError == QCBOR_SUCCESS) {
4444 // The above conversion succeeded
4445 return;
4446 }
4447
4448 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4449 // The above conversion failed in a way that code below can't correct
4450 return;
4451 }
4452
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004453 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004454}
4455
4456
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004457/*
4458Public function, see header qcbor/qcbor_decode.h file
4459*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004460void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4461 const char *szLabel,
4462 uint32_t uConvertTypes,
4463 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004464{
4465 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004466 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4467 szLabel,
4468 uConvertTypes,
4469 pnValue,
4470 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004471
4472 if(pMe->uLastError == QCBOR_SUCCESS) {
4473 // The above conversion succeeded
4474 return;
4475 }
4476
4477 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4478 // The above conversion failed in a way that code below can't correct
4479 return;
4480 }
4481
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004482 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004483}
4484
4485
Laurence Lundblade93d89472020-10-03 22:30:50 -07004486static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004487{
4488 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004489 case QCBOR_TYPE_DOUBLE:
4490 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004491#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004492 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004493 // Can't use llround here because it will not convert values
4494 // greater than INT64_MAX and less than UINT64_MAX that
4495 // need to be converted so it is more complicated.
4496 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4497 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4498 if(isnan(pItem->val.dfnum)) {
4499 return QCBOR_ERR_FLOAT_EXCEPTION;
4500 } else if(pItem->val.dfnum < 0) {
4501 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4502 } else {
4503 double dRounded = round(pItem->val.dfnum);
4504 // See discussion in DecodeDateEpoch() for
4505 // explanation of - 0x7ff
4506 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4507 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4508 }
4509 *puValue = (uint64_t)dRounded;
4510 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004511 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004512 if(isnan(pItem->val.fnum)) {
4513 return QCBOR_ERR_FLOAT_EXCEPTION;
4514 } else if(pItem->val.fnum < 0) {
4515 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4516 } else {
4517 float fRounded = roundf(pItem->val.fnum);
4518 // See discussion in DecodeDateEpoch() for
4519 // explanation of - 0x7ff
4520 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4521 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4522 }
4523 *puValue = (uint64_t)fRounded;
4524 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004525 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004526 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4527 // round() and roundf() shouldn't result in exceptions here, but
4528 // catch them to be robust and thorough. Don't try to
4529 // distinguish between the various exceptions because it seems
4530 // they vary by CPU, compiler and OS.
4531 return QCBOR_ERR_FLOAT_EXCEPTION;
4532 }
4533
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004534 } else {
4535 return QCBOR_ERR_UNEXPECTED_TYPE;
4536 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004537#else
4538 return QCBOR_ERR_HW_FLOAT_DISABLED;
4539#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004540 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004541
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004542 case QCBOR_TYPE_INT64:
4543 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4544 if(pItem->val.int64 >= 0) {
4545 *puValue = (uint64_t)pItem->val.int64;
4546 } else {
4547 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4548 }
4549 } else {
4550 return QCBOR_ERR_UNEXPECTED_TYPE;
4551 }
4552 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004553
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004554 case QCBOR_TYPE_UINT64:
4555 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4556 *puValue = pItem->val.uint64;
4557 } else {
4558 return QCBOR_ERR_UNEXPECTED_TYPE;
4559 }
4560 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004561
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004562 default:
4563 return QCBOR_ERR_UNEXPECTED_TYPE;
4564 }
4565
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004566 return QCBOR_SUCCESS;
4567}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004568
4569
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004570void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004571 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004572 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004573 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004574{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004575 if(pMe->uLastError != QCBOR_SUCCESS) {
4576 return;
4577 }
4578
Laurence Lundbladec4537442020-04-14 18:53:22 -07004579 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004580
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004581 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4582 if(uError) {
4583 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004584 return;
4585 }
4586
Laurence Lundbladea826c502020-05-10 21:07:00 -07004587 if(pItem) {
4588 *pItem = Item;
4589 }
4590
Laurence Lundblade93d89472020-10-03 22:30:50 -07004591 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004592}
4593
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004594
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004595void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004596 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004597 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004598 uint64_t *puValue,
4599 QCBORItem *pItem)
4600{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004601 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004602 if(pMe->uLastError != QCBOR_SUCCESS) {
4603 return;
4604 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004605
Laurence Lundblade93d89472020-10-03 22:30:50 -07004606 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004607}
4608
4609
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004610void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004611 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004612 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004613 uint64_t *puValue,
4614 QCBORItem *pItem)
4615{
4616 if(pMe->uLastError != QCBOR_SUCCESS) {
4617 return;
4618 }
4619
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004620 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004621 if(pMe->uLastError != QCBOR_SUCCESS) {
4622 return;
4623 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004624
Laurence Lundblade93d89472020-10-03 22:30:50 -07004625 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004626}
4627
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004628
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004629
Laurence Lundblade93d89472020-10-03 22:30:50 -07004630static QCBORError
4631UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004632{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004633 switch(pItem->uDataType) {
4634
4635 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004636 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004637 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4638 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004639 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004640 }
4641 break;
4642
4643 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004644 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004645 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4646 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004647 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004648 }
4649 break;
4650
4651#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4652
4653 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004654 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004655 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004656 pItem->val.expAndMantissa.nExponent,
4657 puValue,
4658 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004659 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004660 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004661 }
4662 break;
4663
4664 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004665 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004666 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4667 pItem->val.expAndMantissa.nExponent,
4668 puValue,
4669 Exponentitate2);
4670 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004671 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004672 }
4673 break;
4674
4675 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004676 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004677 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004678 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004679 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004680 if(uErr != QCBOR_SUCCESS) {
4681 return uErr;
4682 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004683 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004684 pItem->val.expAndMantissa.nExponent,
4685 puValue,
4686 Exponentitate10);
4687 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004688 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004689 }
4690 break;
4691
4692 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004693 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004694 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4695 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004696 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004697 }
4698 break;
4699
4700 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004701 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004702 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004703 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004704 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004705 if(uErr != QCBOR_SUCCESS) {
4706 return uErr;
4707 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004708 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004709 pItem->val.expAndMantissa.nExponent,
4710 puValue,
4711 Exponentitate2);
4712 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004713 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004714 }
4715 break;
4716
4717 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004718 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004719 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4720 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004721 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004722 }
4723 break;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004724#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004725 default:
4726 return QCBOR_ERR_UNEXPECTED_TYPE;
4727 }
4728}
4729
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004730
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004731/*
4732 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004733 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004734void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004735{
4736 QCBORItem Item;
4737
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004738 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004739
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004740 if(pMe->uLastError == QCBOR_SUCCESS) {
4741 // The above conversion succeeded
4742 return;
4743 }
4744
4745 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4746 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004747 return;
4748 }
4749
Laurence Lundblade93d89472020-10-03 22:30:50 -07004750 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004751}
4752
Laurence Lundbladec4537442020-04-14 18:53:22 -07004753
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004754/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004755 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004756*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004757void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004758 int64_t nLabel,
4759 uint32_t uConvertTypes,
4760 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004761{
4762 QCBORItem Item;
4763
Laurence Lundblade93d89472020-10-03 22:30:50 -07004764 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4765 nLabel,
4766 uConvertTypes,
4767 puValue,
4768 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004769
4770 if(pMe->uLastError == QCBOR_SUCCESS) {
4771 // The above conversion succeeded
4772 return;
4773 }
4774
4775 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4776 // The above conversion failed in a way that code below can't correct
4777 return;
4778 }
4779
Laurence Lundblade93d89472020-10-03 22:30:50 -07004780 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004781}
4782
4783
4784/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004785 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004786*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004787void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004788 const char *szLabel,
4789 uint32_t uConvertTypes,
4790 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004791{
4792 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004793 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
4794 szLabel,
4795 uConvertTypes,
4796 puValue,
4797 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004798
4799 if(pMe->uLastError == QCBOR_SUCCESS) {
4800 // The above conversion succeeded
4801 return;
4802 }
4803
4804 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4805 // The above conversion failed in a way that code below can't correct
4806 return;
4807 }
4808
Laurence Lundblade93d89472020-10-03 22:30:50 -07004809 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004810}
4811
4812
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004813
4814
Laurence Lundblade9b334962020-08-27 10:55:53 -07004815static QCBORError ConvertDouble(const QCBORItem *pItem,
4816 uint32_t uConvertTypes,
4817 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004818{
4819 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004820 case QCBOR_TYPE_FLOAT:
4821#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4822 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4823 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004824 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004825 *pdValue = (double)pItem->val.fnum;
4826 } else {
4827 return QCBOR_ERR_UNEXPECTED_TYPE;
4828 }
4829 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004830#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004831 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004832#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004833 break;
4834
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004835 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004836 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4837 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004838 *pdValue = pItem->val.dfnum;
4839 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004840 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004841 }
4842 }
4843 break;
4844
4845 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004846#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004847 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004848 // A simple cast seems to do the job with no worry of exceptions.
4849 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004850 *pdValue = (double)pItem->val.int64;
4851
4852 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004853 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004854 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004855#else
4856 return QCBOR_ERR_HW_FLOAT_DISABLED;
4857#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004858 break;
4859
4860 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004861#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004862 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004863 // A simple cast seems to do the job with no worry of exceptions.
4864 // There will be precision loss for some values.
4865 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004866 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004867 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004868 }
4869 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004870#else
4871 return QCBOR_ERR_HW_FLOAT_DISABLED;
4872#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004873
4874 default:
4875 return QCBOR_ERR_UNEXPECTED_TYPE;
4876 }
4877
4878 return QCBOR_SUCCESS;
4879}
4880
4881
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004882void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004883 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004884 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004885 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004886{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004887 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004888 return;
4889 }
4890
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004891 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004892
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004893 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004894 if(uError) {
4895 pMe->uLastError = (uint8_t)uError;
4896 return;
4897 }
4898
4899 if(pItem) {
4900 *pItem = Item;
4901 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004902
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004903 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004904}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004905
Laurence Lundbladec4537442020-04-14 18:53:22 -07004906
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004907void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4908 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004909 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004910 double *pdValue,
4911 QCBORItem *pItem)
4912{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004913 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004914 if(pMe->uLastError != QCBOR_SUCCESS) {
4915 return;
4916 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004917
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004918 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004919}
4920
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004921
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004922void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4923 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004924 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004925 double *pdValue,
4926 QCBORItem *pItem)
4927{
4928 if(pMe->uLastError != QCBOR_SUCCESS) {
4929 return;
4930 }
4931
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004932 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004933 if(pMe->uLastError != QCBOR_SUCCESS) {
4934 return;
4935 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004936
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004937 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004938}
4939
4940
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004941#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004942static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4943{
4944 double dResult;
4945
4946 dResult = 0.0;
4947 const uint8_t *pByte = BigNum.ptr;
4948 size_t uLen = BigNum.len;
4949 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07004950 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004951 while(uLen--) {
4952 dResult = (dResult * 256.0) + (double)*pByte++;
4953 }
4954
4955 return dResult;
4956}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004957#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4958
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004959
Laurence Lundblade93d89472020-10-03 22:30:50 -07004960static QCBORError
4961DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004962{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004963#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004964 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004965 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4966
4967 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004968 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004969
4970#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004971 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004972 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004973 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004974 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4975 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4976 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004977 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004978 }
4979 break;
4980
4981 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004982 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004983 // Underflow gives 0, overflow gives infinity
4984 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4985 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004986 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004987 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004988 }
4989 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004990#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004991
4992 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004993 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004994 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4995 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004996 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004997 }
4998 break;
4999
5000 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005001 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005002 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005003 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005004 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005005 }
5006 break;
5007
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005008#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005009 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005010 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005011 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5012 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5013 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005014 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005015 }
5016 break;
5017
5018 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005019 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005020 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5021 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5022 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005023 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005024 }
5025 break;
5026
5027 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005028 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005029 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5030 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5031 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005032 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005033 }
5034 break;
5035
5036 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005037 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005038 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005039 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5040 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005041 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005042 }
5043 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005044#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
5045
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005046 default:
5047 return QCBOR_ERR_UNEXPECTED_TYPE;
5048 }
5049
5050 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005051
5052#else
5053 (void)pItem;
5054 (void)uConvertTypes;
5055 (void)pdValue;
5056 return QCBOR_ERR_HW_FLOAT_DISABLED;
5057#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5058
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005059}
5060
5061
5062/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005063 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005064*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005065void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5066 uint32_t uConvertTypes,
5067 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005068{
5069
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005070 QCBORItem Item;
5071
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005072 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005073
5074 if(pMe->uLastError == QCBOR_SUCCESS) {
5075 // The above conversion succeeded
5076 return;
5077 }
5078
5079 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5080 // The above conversion failed in a way that code below can't correct
5081 return;
5082 }
5083
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005084 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005085}
5086
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005087
5088/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005089 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005090*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005091void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5092 int64_t nLabel,
5093 uint32_t uConvertTypes,
5094 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005095{
5096 QCBORItem Item;
5097
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005098 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005099
5100 if(pMe->uLastError == QCBOR_SUCCESS) {
5101 // The above conversion succeeded
5102 return;
5103 }
5104
5105 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5106 // The above conversion failed in a way that code below can't correct
5107 return;
5108 }
5109
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005110 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005111}
5112
5113
5114/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005115 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005116*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005117void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5118 const char *szLabel,
5119 uint32_t uConvertTypes,
5120 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005121{
5122 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005123 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005124
5125 if(pMe->uLastError == QCBOR_SUCCESS) {
5126 // The above conversion succeeded
5127 return;
5128 }
5129
5130 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5131 // The above conversion failed in a way that code below can't correct
5132 return;
5133 }
5134
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005135 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005136}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005137
5138
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005139
5140
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005141#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005142static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5143{
5144 while((uInt & 0xff00000000000000UL) == 0) {
5145 uInt = uInt << 8;
5146 };
5147
5148 UsefulOutBuf UOB;
5149
5150 UsefulOutBuf_Init(&UOB, Buffer);
5151
5152 while(uInt) {
5153 const uint64_t xx = uInt & 0xff00000000000000UL;
5154 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5155 uInt = uInt << 8;
5156 (void)xx;
5157 }
5158
5159 return UsefulOutBuf_OutUBuf(&UOB);
5160}
5161
5162
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005163static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5164 TagSpecification TagSpec,
5165 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005166{
5167 QCBORError uErr;
5168 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005169 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005170 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005171 if(uErr != QCBOR_SUCCESS) {
5172 goto Done;
5173 }
5174
5175 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5176 break; // Successful exit. Moving on to finish decoding.
5177 }
5178
5179 // The item is an array, which means an undecoded
5180 // mantissa and exponent, so decode it. It will then
5181 // have a different type and exit the loop if.
5182 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5183 if(uErr != QCBOR_SUCCESS) {
5184 goto Done;
5185 }
5186
5187 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005188 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005189 }
5190Done:
5191 return uErr;
5192}
5193
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005194
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005195static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005196 TagSpecification TagSpec,
5197 QCBORItem *pItem,
5198 int64_t *pnMantissa,
5199 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005200{
5201 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005202
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005203 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005204 if(uErr != QCBOR_SUCCESS) {
5205 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005206 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005207
Laurence Lundblade9b334962020-08-27 10:55:53 -07005208 switch (pItem->uDataType) {
5209
5210 case QCBOR_TYPE_DECIMAL_FRACTION:
5211 case QCBOR_TYPE_BIGFLOAT:
5212 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5213 *pnExponent = pItem->val.expAndMantissa.nExponent;
5214 break;
5215
5216 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5217 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5218 *pnExponent = pItem->val.expAndMantissa.nExponent;
5219 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5220 break;
5221
5222 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5223 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5224 *pnExponent = pItem->val.expAndMantissa.nExponent;
5225 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5226 break;
5227
5228 default:
5229 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5230 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005231
5232 Done:
5233 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005234}
5235
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005236
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005237static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005238 TagSpecification TagSpec,
5239 QCBORItem *pItem,
5240 UsefulBuf BufferForMantissa,
5241 UsefulBufC *pMantissa,
5242 bool *pbIsNegative,
5243 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005244{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005245 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005246
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005247 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005248 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005249 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005250 }
5251
5252 uint64_t uMantissa;
5253
5254 switch (pItem->uDataType) {
5255
5256 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005257 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005258 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5259 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5260 *pbIsNegative = false;
5261 } else {
5262 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5263 *pbIsNegative = true;
5264 }
5265 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5266 *pnExponent = pItem->val.expAndMantissa.nExponent;
5267 break;
5268
5269 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005270 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005271 *pnExponent = pItem->val.expAndMantissa.nExponent;
5272 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5273 *pbIsNegative = false;
5274 break;
5275
5276 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005277 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005278 *pnExponent = pItem->val.expAndMantissa.nExponent;
5279 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5280 *pbIsNegative = true;
5281 break;
5282
5283 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005284 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005285 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005286
5287Done:
5288 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005289}
5290
5291
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005292/*
5293 Public function, see header qcbor/qcbor_decode.h file
5294*/
5295void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5296 uint8_t uTagRequirement,
5297 int64_t *pnMantissa,
5298 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005299{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005300 if(pMe->uLastError != QCBOR_SUCCESS) {
5301 return;
5302 }
5303
5304 QCBORItem Item;
5305 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5306 if(uError) {
5307 pMe->uLastError = (uint8_t)uError;
5308 return;
5309 }
5310
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005311 const TagSpecification TagSpec =
5312 {
5313 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005314 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5315 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5316 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005317 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005318
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005319 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005320}
5321
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005322
5323/*
5324 Public function, see header qcbor/qcbor_decode.h file
5325*/
5326void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005327 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005328 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005329 int64_t *pnMantissa,
5330 int64_t *pnExponent)
5331{
5332 if(pMe->uLastError != QCBOR_SUCCESS) {
5333 return;
5334 }
5335
5336 QCBORItem Item;
5337 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5338
5339 const TagSpecification TagSpec =
5340 {
5341 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005342 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5343 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5344 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005345 };
5346
5347 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5348}
5349
5350
5351/*
5352 Public function, see header qcbor/qcbor_decode.h file
5353*/
5354void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005355 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005356 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005357 int64_t *pnMantissa,
5358 int64_t *pnExponent)
5359{
5360 if(pMe->uLastError != QCBOR_SUCCESS) {
5361 return;
5362 }
5363
5364 QCBORItem Item;
5365 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5366
5367 const TagSpecification TagSpec =
5368 {
5369 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005370 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5371 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5372 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005373 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005374
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005375 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5376}
5377
5378
5379/*
5380 Public function, see header qcbor/qcbor_decode.h file
5381*/
5382void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5383 uint8_t uTagRequirement,
5384 UsefulBuf MantissaBuffer,
5385 UsefulBufC *pMantissa,
5386 bool *pbMantissaIsNegative,
5387 int64_t *pnExponent)
5388{
5389 if(pMe->uLastError != QCBOR_SUCCESS) {
5390 return;
5391 }
5392
5393 QCBORItem Item;
5394 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5395 if(uError) {
5396 pMe->uLastError = (uint8_t)uError;
5397 return;
5398 }
5399
5400 const TagSpecification TagSpec =
5401 {
5402 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005403 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5404 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5405 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005406 };
5407
Laurence Lundblade93d89472020-10-03 22:30:50 -07005408 ProcessMantissaAndExponentBig(pMe,
5409 TagSpec,
5410 &Item,
5411 MantissaBuffer,
5412 pMantissa,
5413 pbMantissaIsNegative,
5414 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005415}
5416
5417
5418/*
5419 Public function, see header qcbor/qcbor_decode.h file
5420*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005421void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005422 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005423 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005424 UsefulBuf BufferForMantissa,
5425 UsefulBufC *pMantissa,
5426 bool *pbIsNegative,
5427 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005428{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005429 if(pMe->uLastError != QCBOR_SUCCESS) {
5430 return;
5431 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005432
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005433 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005434 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005435 if(pMe->uLastError != QCBOR_SUCCESS) {
5436 return;
5437 }
5438
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005439 const TagSpecification TagSpec =
5440 {
5441 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005442 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5443 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5444 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005445 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005446
Laurence Lundblade93d89472020-10-03 22:30:50 -07005447 ProcessMantissaAndExponentBig(pMe,
5448 TagSpec,
5449 &Item,
5450 BufferForMantissa,
5451 pMantissa,
5452 pbIsNegative,
5453 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005454}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005455
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005456
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005457/*
5458 Public function, see header qcbor/qcbor_decode.h file
5459*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005460void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005461 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005462 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005463 UsefulBuf BufferForMantissa,
5464 UsefulBufC *pMantissa,
5465 bool *pbIsNegative,
5466 int64_t *pnExponent)
5467{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005468 if(pMe->uLastError != QCBOR_SUCCESS) {
5469 return;
5470 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005471
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005472 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005473 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5474 if(pMe->uLastError != QCBOR_SUCCESS) {
5475 return;
5476 }
5477
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005478 const TagSpecification TagSpec =
5479 {
5480 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005481 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5482 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5483 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005484 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005485
5486 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5487}
5488
5489
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005490/*
5491 Public function, see header qcbor/qcbor_decode.h file
5492*/
5493void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5494 uint8_t uTagRequirement,
5495 int64_t *pnMantissa,
5496 int64_t *pnExponent)
5497{
5498 if(pMe->uLastError != QCBOR_SUCCESS) {
5499 return;
5500 }
5501
5502 QCBORItem Item;
5503 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5504 if(uError) {
5505 pMe->uLastError = (uint8_t)uError;
5506 return;
5507 }
5508 const TagSpecification TagSpec =
5509 {
5510 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005511 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5512 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5513 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005514 };
5515
5516 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5517}
5518
5519
5520/*
5521 Public function, see header qcbor/qcbor_decode.h file
5522*/
5523void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005524 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005525 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005526 int64_t *pnMantissa,
5527 int64_t *pnExponent)
5528{
5529 if(pMe->uLastError != QCBOR_SUCCESS) {
5530 return;
5531 }
5532
5533 QCBORItem Item;
5534 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5535 if(pMe->uLastError != QCBOR_SUCCESS) {
5536 return;
5537 }
5538
5539 const TagSpecification TagSpec =
5540 {
5541 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005542 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5543 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5544 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005545 };
5546
5547 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5548}
5549
5550
5551/*
5552 Public function, see header qcbor/qcbor_decode.h file
5553*/
5554void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005555 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005556 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005557 int64_t *pnMantissa,
5558 int64_t *pnExponent)
5559{
5560 if(pMe->uLastError != QCBOR_SUCCESS) {
5561 return;
5562 }
5563
5564 QCBORItem Item;
5565 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5566 if(pMe->uLastError != QCBOR_SUCCESS) {
5567 return;
5568 }
5569
5570 const TagSpecification TagSpec =
5571 {
5572 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005573 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5574 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5575 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005576 };
5577
5578 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5579}
5580
5581
5582/*
5583 Public function, see header qcbor/qcbor_decode.h file
5584*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005585void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5586 uint8_t uTagRequirement,
5587 UsefulBuf MantissaBuffer,
5588 UsefulBufC *pMantissa,
5589 bool *pbMantissaIsNegative,
5590 int64_t *pnExponent)
5591{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005592 if(pMe->uLastError != QCBOR_SUCCESS) {
5593 return;
5594 }
5595
5596 QCBORItem Item;
5597 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5598 if(uError) {
5599 pMe->uLastError = (uint8_t)uError;
5600 return;
5601 }
5602
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005603 const TagSpecification TagSpec =
5604 {
5605 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005606 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5607 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5608 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005609 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005610
5611 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005612}
5613
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005614
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005615/*
5616 Public function, see header qcbor/qcbor_decode.h file
5617*/
5618void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005619 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005620 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005621 UsefulBuf BufferForMantissa,
5622 UsefulBufC *pMantissa,
5623 bool *pbIsNegative,
5624 int64_t *pnExponent)
5625{
5626 if(pMe->uLastError != QCBOR_SUCCESS) {
5627 return;
5628 }
5629
5630 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005631 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5632 if(pMe->uLastError != QCBOR_SUCCESS) {
5633 return;
5634 }
5635
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005636 const TagSpecification TagSpec =
5637 {
5638 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005639 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5640 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5641 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005642 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005643
Laurence Lundblade93d89472020-10-03 22:30:50 -07005644 ProcessMantissaAndExponentBig(pMe,
5645 TagSpec,
5646 &Item,
5647 BufferForMantissa,
5648 pMantissa,
5649 pbIsNegative,
5650 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005651}
5652
5653
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005654/*
5655 Public function, see header qcbor/qcbor_decode.h file
5656*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005657void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005658 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005659 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005660 UsefulBuf BufferForMantissa,
5661 UsefulBufC *pMantissa,
5662 bool *pbIsNegative,
5663 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005664{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005665 if(pMe->uLastError != QCBOR_SUCCESS) {
5666 return;
5667 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005668
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005669 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005670 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5671 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005672 return;
5673 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005674
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005675 const TagSpecification TagSpec =
5676 {
5677 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005678 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5679 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5680 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005681 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005682
Laurence Lundblade93d89472020-10-03 22:30:50 -07005683 ProcessMantissaAndExponentBig(pMe,
5684 TagSpec,
5685 &Item,
5686 BufferForMantissa,
5687 pMantissa,
5688 pbIsNegative,
5689 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005690}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005691
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005692#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */