blob: 69b9198bb848a5ee1e5074efb9e64d2b498726f8 [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundbladeee851742020-01-08 08:37:05 -08003 Copyright (c) 2018-2020, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade53b945a2020-12-27 02:05:01 -080039
Laurence Lundblade6474c982020-12-26 22:14:34 -080040#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
41 * pow(), exp2()
42 */
43#include <fenv.h> /* feclearexcept(), fetestexcept() */
Laurence Lundblade53b945a2020-12-27 02:05:01 -080044
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 Lundbladeb69cad72018-09-13 11:09:01 -070048
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053049/*
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -0800172 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700173 return false;
174 }
Laurence Lundblade53b945a2020-12-27 02:05:01 -0800175
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800176#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
177
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -0800207 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700208 /*
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -0800239 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700240 return false;
241 }
Laurence Lundblade6474c982020-12-26 22:14:34 -0800242 /* Works for both definite and indefinite length 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 Lundblade6474c982020-12-26 22:14:34 -0800245 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700246 return false;
247 }
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -0800294 /* Only call on a defnite 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 Lundblade6474c982020-12-26 22:14:34 -0800302 /* Only call on a defnite 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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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
Laurence Lundblade53b945a2020-12-27 02:05:01 -0800343 * 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 Lundblade6474c982020-12-26 22:14:34 -0800367 /* Nothing to do for empty definite lenth 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 Lundblade6474c982020-12-26 22:14:34 -0800371 /* Empty indefinite length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700372 }
373
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -0800554 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700555 */
Laurence Lundblade25403ed2021-01-02 16:28:07 -0800556void QCBORDecode_Init(QCBORDecodeContext *pMe,
Laurence Lundblade6474c982020-12-26 22:14:34 -0800557 UsefulBufC EncodedCBOR,
558 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700559{
Laurence Lundblade25403ed2021-01-02 16:28:07 -0800560 memset(pMe, 0, sizeof(QCBORDecodeContext));
561 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
Laurence Lundblade6474c982020-12-26 22:14:34 -0800562 /* 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 */
Laurence Lundblade25403ed2021-01-02 16:28:07 -0800565 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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -0800591
592
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800593/*
Laurence Lundblade6474c982020-12-26 22:14:34 -0800594 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800595 */
Laurence Lundblade6474c982020-12-26 22:14:34 -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 Lundblade6474c982020-12-26 22:14:34 -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 Lundblade25403ed2021-01-02 16:28:07 -0800605
606
607/*
608 Decoding items is done in 5 layered functions, one calling the
609 next one down. If a layer has no work to do for a particular item
610 it returns quickly.
611
612 - QCBORDecode_GetNext, GetNextWithTags -- The top layer processes
613 tagged data items, turning them into the local C representation.
614 For the 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 further
616 decoding and a little bit of recursion.
617
618 - 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 all breaks that terminate
621 indefinite length maps and arrays.
622
623 - GetNext_MapEntry -- This handles the combining of two
624 items, the label and the data, that make up a map entry.
625 It only does work on maps. It combines the label and data
626 items into one labeled item.
627
628 - GetNext_TaggedItem -- This decodes type 6 tagging. It turns the
629 tags into bit flags associated with the data item. No actual decoding
630 of the contents of the tagged item is performed here.
631
632 - GetNext_FullItem -- This assembles the sub-items that make up
633 an indefinte length string into one string item. It uses the
634 string allocater to create contiguous space for the item. It
635 processes all breaks that are part of indefinite length strings.
636
637 - GetNext_Item -- This decodes the atomic data items in CBOR. Each
638 atomic data item has a "major type", an integer "argument" and optionally
639 some content. For text and byte strings, the content is the bytes
640 that make up the string. These are the smallest data items that are
641 considered to be well-formed. The content may also be other data items in
642 the case of aggregate types. They are not handled in this layer.
643
644 Roughly this takes 300 bytes of stack for vars. Need to
645 evaluate this more carefully and correctly.
646
647 */
648
649
Laurence Lundblade1c929722020-12-27 02:44:57 -0800650/**
651 * @brief Decode the CBOR head, the type and argument.
652 *
653 * @param[in] pUInBuf The input buffer to read from.
654 * @param[out] pnMajorType The decoded major type.
655 * @param[out] puArgument The decoded argument.
656 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
657 *
658 * @retval QCBOR_ERR_UNSUPPORTED
659 * @retval QCBOR_ERR_HIT_END
660 *
661 * This decodes the CBOR "head" that every CBOR data item has. See
662 * longer explaination of the head in documentation for
663 * QCBOREncode_EncodeHead().
664 *
665 * This does the network->host byte order conversion. The conversion
666 * here also results in the conversion for floats in addition to that
667 * for lengths, tags and integer values.
668 *
669 * The int type is preferred to uint8_t for some variables as this
670 * avoids integer promotions, can reduce code size and makes static
671 * analyzers happier.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700672 */
Laurence Lundblade1c929722020-12-27 02:44:57 -0800673static inline QCBORError
674DecodeHead(UsefulInputBuf *pUInBuf,
675 int *pnMajorType,
676 uint64_t *puArgument,
677 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700678{
Laurence Lundblade1c929722020-12-27 02:44:57 -0800679 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800680
Laurence Lundblade1c929722020-12-27 02:44:57 -0800681 /* Get the initial byte that every CBOR data item has and break it
682 * down. */
683 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800684 const int nTmpMajorType = nInitialByte >> 5;
685 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800686
Laurence Lundblade1c929722020-12-27 02:44:57 -0800687 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800688 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800689
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800690 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800691 /* Need to get 1,2,4 or 8 additional argument bytes. Map
692 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
693 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800694 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800695
Laurence Lundblade1c929722020-12-27 02:44:57 -0800696 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800697 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800698 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800699 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800700 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
701 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800702 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800703 /* The reserved and thus-far unused additional info values */
704 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800705 goto Done;
706 } else {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800707 /* Less than 24, additional info is argument or 31, an
708 * indefinite length. No more bytes to get.
709 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800710 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700711 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800712
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700713 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800714 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700715 goto Done;
716 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800717
Laurence Lundblade1c929722020-12-27 02:44:57 -0800718 /* All successful if arrived here. */
719 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800720 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800721 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800722 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800723
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700724Done:
Laurence Lundblade1c929722020-12-27 02:44:57 -0800725 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700726}
727
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800728
Laurence Lundblade1c929722020-12-27 02:44:57 -0800729/**
730 * @brief Decode integer types, major types 0 and 1.
731 *
732 * @param[in] nMajorType The CBOR major type (0 or 1).
733 * @param[in] uArgument The argument from the head.
734 * @param[out] pDecodedItem The filled in decoded item.
735 *
736 * @retval QCBOR_ERR_INT_OVERFLOW
737 *
738 * Must only be called when major type is 0 or 1.
739 *
740 * CBOR doesn't explicitly specify two's compliment for integers but
741 * all CPUs use it these days and the test vectors in the RFC are
742 * so. All integers in the CBOR structure are positive and the major
743 * type indicates positive or negative. CBOR can express positive
744 * integers up to 2^x - 1 where x is the number of bits and negative
745 * integers down to 2^x. Note that negative numbers can be one more
746 * away from zero than positive. Stdint, as far as I can tell, uses
747 * two's compliment to represent negative integers.
748 *
749 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
750 * used carefully here, and in particular why it isn't used in the
751 * public interface. Also see
752 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
753 *
754 * Int is used for values that need less than 16-bits and would be
755 * subject to integer promotion and result in complaining from static
756 * analyzers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700757 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700758static inline QCBORError
Laurence Lundblade1c929722020-12-27 02:44:57 -0800759DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700760{
Laurence Lundblade1c929722020-12-27 02:44:57 -0800761 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800762
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700763 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800764 if (uArgument <= INT64_MAX) {
765 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700766 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800767
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700768 } else {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800769 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700770 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700771 }
Laurence Lundblade1c929722020-12-27 02:44:57 -0800772
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700773 } else {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800774 if(uArgument <= INT64_MAX) {
775 /* CBOR's representation of negative numbers lines up with
776 * the two-compliment representation. A negative integer has
777 * one more in range than a positive integer. INT64_MIN is
778 * equal to (-INT64_MAX) - 1.
779 */
780 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700781 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800782
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700783 } else {
Laurence Lundblade1c929722020-12-27 02:44:57 -0800784 /* C can't represent a negative integer in this range so it
785 * is an error.
786 */
787 uReturn = QCBOR_ERR_INT_OVERFLOW;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700788 }
789 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800790
Laurence Lundblade1c929722020-12-27 02:44:57 -0800791 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700792}
793
Laurence Lundblade1c929722020-12-27 02:44:57 -0800794
Laurence Lundblade38299092020-12-28 04:13:50 -0800795/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700796#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
797#error QCBOR_TYPE_FALSE macro value wrong
798#endif
799
800#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
801#error QCBOR_TYPE_TRUE macro value wrong
802#endif
803
804#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
805#error QCBOR_TYPE_NULL macro value wrong
806#endif
807
808#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
809#error QCBOR_TYPE_UNDEF macro value wrong
810#endif
811
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700812#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
813#error QCBOR_TYPE_BREAK macro value wrong
814#endif
815
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700816#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
817#error QCBOR_TYPE_DOUBLE macro value wrong
818#endif
819
820#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
821#error QCBOR_TYPE_FLOAT macro value wrong
822#endif
823
Laurence Lundblade38299092020-12-28 04:13:50 -0800824
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800825/**
826 * @brief Decode type 7 -- true, false, floating-point, break...
827 *
828 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
829 * @param[in] uArgument The argument from the head.
830 * @param[out] pDecodedItem The filled in decoded item.
831 *
832 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
833 * @retval QCBOR_ERR_BAD_TYPE_7
834 */
Laurence Lundblade9b334962020-08-27 10:55:53 -0700835
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700836static inline QCBORError
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800837DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700838{
Laurence Lundblade38299092020-12-28 04:13:50 -0800839 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800840
Laurence Lundblade38299092020-12-28 04:13:50 -0800841 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
842 * checks above make sure uAdditionalInfo values line up with
843 * uDataType values. DecodeHead() never returns an AdditionalInfo
844 * > 0x1f so cast is safe.
845 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800846 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800847
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800848 switch(nAdditionalInfo) {
Laurence Lundblade38299092020-12-28 04:13:50 -0800849 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
850 * are caught before this is called.
851 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800852
Laurence Lundblade38299092020-12-28 04:13:50 -0800853 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700854#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade38299092020-12-28 04:13:50 -0800855 /* Half-precision is returned as a double. The cast to
856 * uint16_t is safe because the encoded value was 16 bits. It
857 * was widened to 64 bits to be passed in here.
858 */
859 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700860 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800861#else /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade38299092020-12-28 04:13:50 -0800862 uReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800863#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700864 break;
Laurence Lundblade38299092020-12-28 04:13:50 -0800865 case SINGLE_PREC_FLOAT: /* 26 */
866 /* Single precision is normally returned as a double since
867 * double is widely supported, there is no loss of precision,
868 * it makes it easy for the caller in most cases and it can
869 * be converted back to single with no loss of precision
870 *
871 * The cast to uint32_t is safe because the encoded value was
872 * 32 bits. It was widened to 64 bits to be passed in here.
873 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700874 {
Laurence Lundblade38299092020-12-28 04:13:50 -0800875 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700876#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade38299092020-12-28 04:13:50 -0800877 /* In the normal case, use HW to convert float to
878 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700879 pDecodedItem->val.dfnum = (double)f;
880 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800881#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade38299092020-12-28 04:13:50 -0800882 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700883 pDecodedItem->val.fnum = f;
884 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
885
Laurence Lundblade38299092020-12-28 04:13:50 -0800886 /* IEEE754_FloatToDouble() could be used here to return as
887 * a double, but it adds object code and most likely
888 * anyone disabling FLOAT HW use doesn't care about floats
889 * and wants to save object code.
890 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800891#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700892 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700893 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700894
Laurence Lundblade38299092020-12-28 04:13:50 -0800895 case DOUBLE_PREC_FLOAT: /* 27 */
896 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700897 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700898 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800899
Laurence Lundblade38299092020-12-28 04:13:50 -0800900 case CBOR_SIMPLEV_FALSE: /* 20 */
901 case CBOR_SIMPLEV_TRUE: /* 21 */
902 case CBOR_SIMPLEV_NULL: /* 22 */
903 case CBOR_SIMPLEV_UNDEF: /* 23 */
904 case CBOR_SIMPLE_BREAK: /* 31 */
905 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800906
Laurence Lundblade38299092020-12-28 04:13:50 -0800907 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
908 if(uArgument <= CBOR_SIMPLE_BREAK) {
909 /* This takes out f8 00 ... f8 1f which should be encoded
910 * as e0 … f7
911 */
912 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700913 goto Done;
914 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800915 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800916
Laurence Lundblade38299092020-12-28 04:13:50 -0800917 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700918 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade38299092020-12-28 04:13:50 -0800919 /* DecodeHead() will make uArgument equal to
920 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
921 * safe because the 2, 4 and 8 byte lengths of uNumber are in
922 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -0800923 */
Laurence Lundblade38299092020-12-28 04:13:50 -0800924 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700925 break;
926 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800927
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700928Done:
Laurence Lundblade38299092020-12-28 04:13:50 -0800929 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700930}
931
932
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800933/**
934 * @brief Decode text and byte strings
935 *
936 * @param[in] pAllocator The string allocator or NULL.
937 * @param[in] uStrLen The length of the string.
938 * @param[in] pUInBuf The surce from which to read the string's bytes.
939 * @param[out] pDecodedItem The filled in decoded item.
940 *
941 * @retval QCBOR_ERR_HIT_END
942 * @retval QCBOR_ERR_STRING_ALLOCATE
943 * @retval QCBOR_ERR_STRING_TOO_LONG
944 *
945 * The reads @c uStrlen bytes from @c pUInBuf and fills in @c
946 * pDecodedItem. If @c pAllocator is not NULL then memory for the
947 * string is allocated.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700948 */
Laurence Lundblade38299092020-12-28 04:13:50 -0800949static inline QCBORError
Laurence Lundblade63e68f72020-12-28 04:24:11 -0800950DecodeBytes(const QCBORInternalAllocator *pAllocator,
951 uint64_t uStrLen,
952 UsefulInputBuf *pUInBuf,
953 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700954{
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800955 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800956
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800957 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
958 * CPUs. This check makes the casts to size_t below safe.
959 *
960 * The max is 4 bytes less than the largest sizeof() so this can be
961 * tested by putting a SIZE_MAX length in the CBOR test input (no
962 * one will care the limit on strings is 4 bytes shorter).
963 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800964 if(uStrLen > SIZE_MAX-4) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800965 uReturn = QCBOR_ERR_STRING_TOO_LONG;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800966 goto Done;
967 }
968
969 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530970 if(UsefulBuf_IsNULLC(Bytes)) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800971 /* Failed to get the bytes for this string item */
972 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530973 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700974 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530975
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800976#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800977 /* Note that this is not where allocation to coallsece
978 * indefinite-length strings is done. This is for when the caller
979 * has requested all strings be allocated. Disabling indefinite
980 * length strings also disables this allocate-all option.
981 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800982 if(pAllocator) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800983 /* request to use the string allocator to make a copy */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800984 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530985 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800986 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530987 goto Done;
988 }
989 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800990 pDecodedItem->uDataAlloc = 1;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800991 goto Done;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530992 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800993#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
994 (void)pAllocator;
995#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
996
Laurence Lundblade554ebd52020-12-29 03:26:06 -0800997 /* Normal case with no string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800998 pDecodedItem->val.string = Bytes;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800999
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301000Done:
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001001 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001002}
1003
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001004
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001005/**
1006 * @brief Map the CBOR major types for strings to the QCBOR types.
1007 *
1008 * @param[in] nCBORMajorType The CBOR major type to convert.
1009 * @retturns QCBOR type number.
1010 *
1011 * This only works for the two string types.
1012 */
1013static inline uint8_t ConvertStringMajorTypes(int nCBORMajorType)
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001014{
1015 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
1016 #error QCBOR_TYPE_BYTE_STRING no lined up with major type
1017 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001018
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001019 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
1020 #error QCBOR_TYPE_TEXT_STRING no lined up with major type
1021 #endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001022
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001023 return (uint8_t)(nCBORMajorType + 4);
1024}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001025
1026
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001027/**
1028 * @brief Map the CBOR major types for arrays/maps to the QCBOR types.
1029 *
1030 * @param[in] nCBORMajorType The CBOR major type to convert.
1031 * @retturns QCBOR type number.
1032 *
1033 * This only works for the two aggregate types.
1034 */
1035static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
1036{
1037 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1038 #error QCBOR_TYPE_ARRAY value not lined up with major type
1039 #endif
1040
1041 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1042 #error QCBOR_TYPE_MAP value not lined up with major type
1043 #endif
1044
1045 return (uint8_t)(nCBORMajorType);
1046}
1047
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001048
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001049/**
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001050 * @brief Decode a single primitive data item.
1051 *
1052 * @param[in] pUInBuf Input buffer to read data item from.
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001053 * @param[out] pDecodedItem The filled-in decoded item.
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001054 * @param[in] pAllocator The allocator to use for strings or NULL.
1055 *
1056 * @retval QCBOR_ERR_UNSUPPORTED
1057 * @retval QCBOR_ERR_HIT_END
1058 * @retval QCBOR_ERR_INT_OVERFLOW
1059 * @retval QCBOR_ERR_STRING_ALLOCATE
1060 * @retval QCBOR_ERR_STRING_TOO_LONG
1061 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1062 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001063 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001064 *
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001065 * This decodes the most primitive / atomic data item. It does
1066 * no combing of data items.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001067 */
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001068static QCBORError GetNext_Item(UsefulInputBuf *pUInBuf,
1069 QCBORItem *pDecodedItem,
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001070 const QCBORInternalAllocator *pAllocator)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001071{
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001072 QCBORError uReturn;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001073
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001074 /* Get the major type and the argument. The argument could be
1075 * length of more bytes or the value depending on the major
1076 * type. nAdditionalInfo is an encoding of the length of the
1077 * uNumber and is needed to decode floats and doubles.
1078 */
Rob Gilton47cc9562020-08-10 12:03:38 +01001079 int nMajorType = 0;
Laurence Lundblade1c929722020-12-27 02:44:57 -08001080 uint64_t uArgument = 0;
Rob Gilton47cc9562020-08-10 12:03:38 +01001081 int nAdditionalInfo = 0;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001082
Laurence Lundblade4b09f632019-10-09 14:34:59 -07001083 memset(pDecodedItem, 0, sizeof(QCBORItem));
1084
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001085 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1086 if(uReturn) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001087 goto Done;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001088 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001089
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001090 /* At this point the major type and the argument are valid. We've
1091 * got the type and the argument that starts every CBOR data item.
1092 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001093 switch (nMajorType) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001094 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1095 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001096 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001097 uReturn = QCBOR_ERR_BAD_INT;
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001098 } else {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001099 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
Laurence Lundblade3a6042e2019-06-28 19:58:04 -07001100 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001101 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001102
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001103 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1104 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1105 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001106 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001107 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001108 } else {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001109 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001110 }
1111 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001112
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001113 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1114 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001115 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001116 /* Indefinite-length string. */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001117#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -07001118 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001119#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001120 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001121 break;
1122#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001123 } else {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001124 /* Definite-length string. */
1125 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1126 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1127 goto Done;
1128 }
1129 /* cast OK because of check above */
Laurence Lundblade1c929722020-12-27 02:44:57 -08001130 pDecodedItem->val.uCount = (uint16_t)uArgument;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001131 }
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001132 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001133 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001134
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001135 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001136 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001137 uReturn = QCBOR_ERR_BAD_INT;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001138 } else {
Laurence Lundblade1c929722020-12-27 02:44:57 -08001139 pDecodedItem->val.uTagV = uArgument;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001140 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001141 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001142 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001143
Laurence Lundbladeee851742020-01-08 08:37:05 -08001144 case CBOR_MAJOR_TYPE_SIMPLE:
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001145 /* Major type 7: float, double, true, false, null... */
1146 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001147 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001148
Laurence Lundbladeee851742020-01-08 08:37:05 -08001149 default:
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001150 /* Never happens because DecodeHead() should never return > 7 */
1151 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001152 break;
1153 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001154
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001155Done:
Laurence Lundblade554ebd52020-12-29 03:26:06 -08001156 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001157}
1158
1159
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001160/**
1161 * @brief Process indefinite length strings
1162 *
1163 * @param[in] pMe Decoder context
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001164 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001165 *
1166 * @retval QCBOR_ERR_UNSUPPORTED
1167 * @retval QCBOR_ERR_HIT_END
1168 * @retval QCBOR_ERR_INT_OVERFLOW
1169 * @retval QCBOR_ERR_STRING_ALLOCATE
1170 * @retval QCBOR_ERR_STRING_TOO_LONG
1171 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1172 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001173 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001174 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1175 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001176 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001177 *
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001178 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001179 *
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001180 * If it is, this loops getting the subsequent chunk data items that
1181 * make up the string. The string allocator is used to make a
1182 * contiguous buffer for the chunks. When this completes @c
1183 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001184 *
1185 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001186 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001187static inline QCBORError
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001188GetNext_FullItem(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001189{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001190 /* Aproximate stack usage
1191 * 64-bit 32-bit
1192 * local vars 32 16
1193 * 2 UsefulBufs 32 16
1194 * QCBORItem 56 52
1195 * TOTAL 120 74
1196 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001197
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001198 /* The string allocator is used here for two purposes: 1)
1199 * coalescing the chunks of an indefinite length string, 2)
1200 * allocating storage for every string returned.
1201 *
1202 * The first use is below in this function. Indefinite length
1203 * strings cannot be processed at all without a string allocator.
1204 *
1205 * The second used is in DecodeBytes() which is called by
1206 * GetNext_Item() below. This second use unneccessary for most use
1207 * and only happens when requested in the call to
1208 * QCBORDecode_SetMemPool(). If the second use not requested then
1209 * NULL is passed for the string allocator to GetNext_Item().
1210 *
1211 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1212 * allocator altogether and thus both of these uses. It reduced the
1213 * decoder object code by about 400 bytes.
1214 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001215 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001216
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001217#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001218 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001219
1220 if(pMe->StringAllocator.pfAllocator) {
1221 pAllocator = &(pMe->StringAllocator);
1222 if(pMe->bStringAllocateAll) {
1223 pAllocatorForGetNext = pAllocator;
1224 }
1225 }
1226#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1227
1228 QCBORError uReturn;
1229 uReturn = GetNext_Item(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
1230 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001231 goto Done;
1232 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001233
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001234 /* Only do indefinite length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001235 const uint8_t uStringType = pDecodedItem->uDataType;
1236 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001237 goto Done;
1238 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001239
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001240 /* Is this a string with an indefinite length? */
1241 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1242 goto Done;
1243 }
1244
1245#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
1246 /* Can't do indefinite length strings without a string allocator */
1247 if(pAllocator == NULL) {
1248 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1249 goto Done;
1250 }
1251
1252 /* Loop getting chunks of the indefinite length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001253 UsefulBufC FullString = NULLUsefulBufC;
1254
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001255 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001256 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001257 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001258 /* Pass a NULL string allocator to GetNext_Item() because the
1259 * individual string chunks in an indefinite length should not
1260 * be allocated. They are always copied in the the contiguous
1261 * buffer allocated here.
1262 */
1263 uReturn = GetNext_Item(&(pMe->InBuf), &StringChunkItem, NULL);
1264 if(uReturn) {
1265 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001266 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001267
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001268 /* Is item is the marker for end of the indefinite length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001269 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001270 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001271 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301272 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001273 break;
1274 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001275
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001276 /* All chunks must be of the same type, the type of the item
1277 * that introduces the indefinite length string. This also
1278 * catches errors where the chunk is not a string at all and an
1279 * indefinite length string inside an indefinite length string.
1280 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001281 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001282 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1283 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001284 break;
1285 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001286
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001287 /* The first time throurgh FullString.ptr is NULL and this is
1288 * equivalent to StringAllocator_Allocate(). Subsequently it is
1289 * not NULL and a reallocation happens.
1290 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001291 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1292 UNCONST_POINTER(FullString.ptr),
1293 FullString.len + StringChunkItem.val.string.len);
1294
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001295 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001296 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001297 break;
1298 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001299
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001300 /* Copy new string chunk to the end of accumulated string */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001301 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001302 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001303
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001304 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1305 /* Getting the item failed, clean up the allocated memory */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001306 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001307 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001308#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1309 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1310#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001311
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001312Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001313 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001314}
1315
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001316
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001317/**
1318 * @brief This converts a tag number to a shorter mapped value for storage.
1319 *
1320 * @param[in] pMe The decode context.
1321 * @param[in] uUnMappedTag The tag number to map
1322 * @param[out] puMappedTagNumer The stored tag number.
1323 *
1324 * @return error code.
1325 *
1326 * The main point of mapping tag numbers is make QCBORItem
1327 * smaller. With this mapping storage of 4 tags takes up 8
1328 * bytes. Without, it would take up 32 bytes.
1329 *
1330 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1331 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1332 *
1333 * See also UnMapTagNumber() and @ref QCBORItem.
1334 */
1335static inline QCBORError
1336MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1337{
1338 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1339 int uTagMapIndex;
1340 /* Is there room in the tag map, or is it in it already? */
1341 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1342 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1343 break;
1344 }
1345 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1346 break;
1347 }
1348 }
1349 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1350 return QCBOR_ERR_TOO_MANY_TAGS;
1351 }
1352
1353 /* Covers the cases where tag is new and were it is already in the map */
1354 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1355 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1356
1357 } else {
1358 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1359 }
1360
1361 return QCBOR_SUCCESS;
1362}
1363
1364
1365/**
1366 * @brief This converts a mapped tag number to the actual tag number.
1367 *
1368 * @param[in] pMe The decode context.
1369 * @param[in] uMappedTagNumber The stored tag number.
1370 *
1371 * @return The actual tag number is returned or
1372 * @ref CBOR_TAG_INVALID64 on error.
1373 *
1374 * This is the reverse of MapTagNumber()
1375 */
1376static uint64_t
1377UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1378{
1379 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1380 return uMappedTagNumber;
1381 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001382 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001383 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001384 /* This won't be negative because of code below in
1385 * MapTagNumber()
1386 */
1387 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1388 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001389 }
1390}
1391
Laurence Lundblade9b334962020-08-27 10:55:53 -07001392
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001393/**
1394 * @brief Aggregate all tags wrapping a data item.
1395 *
1396 * @param[in] pMe Decoder context
1397 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001398
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001399 * @retval QCBOR_ERR_UNSUPPORTED
1400 * @retval QCBOR_ERR_HIT_END
1401 * @retval QCBOR_ERR_INT_OVERFLOW
1402 * @retval QCBOR_ERR_STRING_ALLOCATE
1403 * @retval QCBOR_ERR_STRING_TOO_LONG
1404 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1405 * @retval QCBOR_ERR_BAD_TYPE_7
1406 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1407 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1408 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1409 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1410 * @retval QCBOR_ERR_TOO_MANY_TAGS
1411 *
1412 * This loops getting atomic data items until one is not a tag
1413 * number. Usually this is largely pass-through because most
1414 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001415 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001416static QCBORError
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001417GetNext_TaggedItem(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001418{
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001419 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1420
1421 /* Initialize to CBOR_TAG_INVALID16 */
1422 #if CBOR_TAG_INVALID16 != 0xffff
1423 /* Be sure the memset does the right thing. */
1424 #err CBOR_TAG_INVALID16 tag not defined as expected
1425 #endif
1426 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001427
Laurence Lundblade9b334962020-08-27 10:55:53 -07001428 QCBORError uReturn = QCBOR_SUCCESS;
1429
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001430 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001431 for(;;) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001432 QCBORError uErr = GetNext_FullItem(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001433 if(uErr != QCBOR_SUCCESS) {
1434 uReturn = uErr;
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001435 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001436 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001437
Laurence Lundblade9b334962020-08-27 10:55:53 -07001438 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001439 /* Successful exit from loop; maybe got some tags, maybe not */
1440 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001441 break;
1442 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001443
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001444 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1445 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001446 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001447 /* Continue on to get all tags wrapping this item even though
1448 * it is erroring out in the end. This allows decoding to
1449 * continue. This is a resource limit error, not a problem
1450 * with being well-formed CBOR.
1451 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001452 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001453 }
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001454 /* Slide tags over one in the array to make room at index 0.
1455 * Must use memmove because the move source and destination
1456 * overlap.
1457 */
1458 memmove(&auItemsTags[1], auItemsTags, sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001459
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001460 /* Map the tag */
1461 uint16_t uMappedTagNumer;
1462 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumer);
1463 /* Continue even on error so as to consume all tags wrapping
1464 * this data item so decoding can go on. If MapTagNumber()
1465 * errors once it will continue to error.
1466 */
1467 auItemsTags[0] = uMappedTagNumer;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001468 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001469
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001470Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001471 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001472}
1473
1474
1475/*
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001476 * @brief Combine a map entry label and value into one item.
1477 *
1478 * @param[in] pMe Decoder context
1479 * @param[out] pDecodedItem The decoded item that work is done on.
1480 *
1481 * @retval QCBOR_ERR_UNSUPPORTED
1482 * @retval QCBOR_ERR_HIT_END
1483 * @retval QCBOR_ERR_INT_OVERFLOW
1484 * @retval QCBOR_ERR_STRING_ALLOCATE
1485 * @retval QCBOR_ERR_STRING_TOO_LONG
1486 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1487 * @retval QCBOR_ERR_BAD_TYPE_7
1488 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1489 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1490 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1491 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1492 * @retval QCBOR_ERR_TOO_MANY_TAGS
1493 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1494 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1495 *
1496 * If a the current nesting level is a map, then this
1497 * combines pairs of items into one data item with a label
1498 * and value.
1499 *
1500 * This is pass-through if the current nesting leve is
1501 * not a map.
1502 *
1503 * This also implements maps-as-array mode where a map
1504 * is treated like an array to allow caller to do their
1505 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001506 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001507static inline QCBORError
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001508GetNext_MapEntry(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001509{
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001510 QCBORError uReturn = GetNext_TaggedItem(me, pDecodedItem);
1511 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001512 goto Done;
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001513 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001514
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001515 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001516 /* Break can't be a map entry */
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001517 goto Done;
1518 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001519
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001520 if(me->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001521 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001522
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001523 if(DecodeNesting_IsCurrentTypeMap(&(me->nesting))) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001524 /* Save label in pDecodedItem and get the next which will
1525 * be the real data item.
1526 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001527 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001528 uReturn = GetNext_TaggedItem(me, pDecodedItem);
1529 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001530 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001531 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001532
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301533 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001534
1535 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001536 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001537 pDecodedItem->label.string = LabelItem.val.string;
1538 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
1539 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == me->uDecodeMode) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001540 /* It's not a string and we only want strings */
1541 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001542 goto Done;
1543 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1544 pDecodedItem->label.int64 = LabelItem.val.int64;
1545 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1546 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1547 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1548 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1549 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1550 pDecodedItem->label.string = LabelItem.val.string;
1551 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1552 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1553 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001554 /* label is not an int or a string. It is an arrray
1555 * or a float or such and this implementation doesn't handle that.
1556 * Also, tags on labels are ignored.
1557 */
1558 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001559 goto Done;
1560 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001561 }
1562 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001563 /* Decoding of maps as arrays to let the caller decide what to do
1564 * about labels, particularly lables that are not integers or
1565 * strings.
1566 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001567 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001568 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001569 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001570 goto Done;
1571 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001572 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001573 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1574 * Cast is needed because of integer promotion.
1575 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001576 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001577 }
1578 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001579
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001580Done:
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001581 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001582}
1583
1584
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001585#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001586/**
1587 * @brief Peek and see if next data item is a break;
1588 *
1589 * @param[in] pUIB UsefulInputBuf to read from.
1590 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1591 *
1592 * @return Any decoding error.
1593 *
1594 * See if next item is a CBOR break. If it is, it is consumed,
1595 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001596*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001597static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001598NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1599{
1600 *pbNextIsBreak = false;
1601 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001602 QCBORItem Peek;
1603 size_t uPeek = UsefulInputBuf_Tell(pUIB);
1604 QCBORError uReturn = GetNext_Item(pUIB, &Peek, NULL);
1605 if(uReturn != QCBOR_SUCCESS) {
1606 return uReturn;
1607 }
1608 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001609 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001610 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001611 } else {
1612 *pbNextIsBreak = true;
1613 }
1614 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001615
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001616 return QCBOR_SUCCESS;
1617}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001618#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001619
1620
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001621/*
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001622 * @brief Ascend up nesting levels if all items in them have been consumed.
1623 *
1624 * @param[in] pMe The decode context.
1625 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1626 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001627 * An item was just consumed, now figure out if it was the
1628 * end of an array/map map that can be closed out. That
1629 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001630*/
Laurence Lundbladed0304932020-06-27 10:59:38 -07001631static QCBORError NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001632{
1633 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001634
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001635 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001636 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1637
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001638 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1639 /* Nesting level is bstr-wrapped CBOR */
1640
1641 /* Ascent for bstr-wrapped CBOR is always by explicit call
1642 * so no further ascending can happen.
1643 */
1644 break;
1645
1646 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1647 /* Level is a definite-length array/map */
1648
1649 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001650 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1651 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001652 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001653 break;
1654 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001655 /* All items in a definite length array were consumed so it
1656 * is time to ascend one level. This happens below.
1657 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001658
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001659#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001660 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001661 /* Level is an indefinite-length array/map. */
1662
1663 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001664 bool bIsBreak = false;
1665 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1666 if(uReturn != QCBOR_SUCCESS) {
1667 goto Done;
1668 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001669
1670 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001671 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001672 break;
1673 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001674
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001675 /* It was a break in an indefinite length map / array so
1676 * it is time to ascend one level.
1677 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001678
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001679#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001680 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001681
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001682
1683 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001684
Laurence Lundblade93d89472020-10-03 22:30:50 -07001685 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001686 * QCBORDecode_ExitBoundedMode().
1687 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001688 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade93d89472020-10-03 22:30:50 -07001689 /* Set the count to zero for definite length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001690 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001691 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001692 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001693 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001694
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001695 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001696 break;
1697 }
1698
1699 /* Finally, actually ascend one level. */
1700 DecodeNesting_Ascend(&(pMe->nesting));
1701 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001702
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001703 uReturn = QCBOR_SUCCESS;
1704
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001705#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001706Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001707#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1708
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001709 return uReturn;
1710}
1711
1712
1713/*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001714 This handles the traversal descending into and asecnding out of maps,
Laurence Lundblade642282a2020-06-23 12:00:33 -07001715 arrays and bstr-wrapped CBOR. It figures out the ends of definite and
1716 indefinte length maps and arrays by looking at the item count or
1717 finding CBOR breaks. It detects the ends of the top-level sequence
1718 and of bstr-wrapped CBOR by byte count.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001719
1720 @retval QCBOR_ERR_UNSUPPORTED X
1721
1722 @retval QCBOR_ERR_HIT_END
1723
1724 @retval QCBOR_ERR_INT_OVERFLOW X
1725
1726 @retval QCBOR_ERR_STRING_ALLOCATE
1727
1728 @retval QCBOR_ERR_STRING_TOO_LONG
1729
1730 @retval QCBOR_ERR_HALF_PRECISION_DISABLED X
1731
1732 @retval QCBOR_ERR_BAD_TYPE_7 X
1733
1734 @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1735
1736 @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1737
1738 @retval QCBOR_ERR_TOO_MANY_TAGS
1739
1740 @retval QCBOR_ERR_MAP_LABEL_TYPE X
1741
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001742 @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
Laurence Lundblade9b334962020-08-27 10:55:53 -07001743
1744 @retval QCBOR_ERR_NO_MORE_ITEMS
1745
1746 @retval QCBOR_ERR_BAD_BREAK
1747
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001748 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001749static QCBORError
1750QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001751{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001752 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001753 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001754
Laurence Lundblade642282a2020-06-23 12:00:33 -07001755 /*
1756 If out of bytes to consume, it is either the end of the top-level
1757 sequence of some bstr-wrapped CBOR that was entered.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001758
Laurence Lundblade642282a2020-06-23 12:00:33 -07001759 In the case of bstr-wrapped CBOR, the length of the UsefulInputBuf
1760 was set to that of the bstr-wrapped CBOR. When the bstr-wrapped
1761 CBOR is exited, the length is set back to the top-level's length
1762 or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001763 */
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001764 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001765 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001766 goto Done;
1767 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001768
Laurence Lundblade642282a2020-06-23 12:00:33 -07001769 /*
1770 Check to see if at the end of a bounded definite length map or
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001771 array. The check for a break ending indefinite length array is
1772 later in NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001773 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001774 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001775 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001776 goto Done;
1777 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001778
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001779 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001780 uReturn = GetNext_MapEntry(me, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001781 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1782 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001783 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001784 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301785
Laurence Lundblade642282a2020-06-23 12:00:33 -07001786 /*
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001787 Breaks ending arrays/maps are processed later in the call to
1788 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 Lundblade642282a2020-06-23 12:00:33 -07001795 /*
1796 Record the nesting level for this data item before processing any
1797 of decrementing and descending.
1798 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001799 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001800
Laurence Lundblade642282a2020-06-23 12:00:33 -07001801
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001802 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001803 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001804 /*
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001805 If the new item is a map or array, descend.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001806
Laurence Lundblade93d89472020-10-03 22:30:50 -07001807 Empty indefinite length maps and arrays are descended into, but
1808 then ascended out of in the next chunk of code.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001809
1810 Maps and arrays do count as items in the map/array that
Laurence Lundblade642282a2020-06-23 12:00:33 -07001811 encloses them so a decrement needs to be done for them too, but
1812 that is done only when all the items in them have been
1813 processed, not when they are opened with the exception of an
1814 empty map or array.
1815 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001816 QCBORError uDescendErr;
1817 uDescendErr = DecodeNesting_DescendMapOrArray(&(me->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001818 pDecodedItem->uDataType,
1819 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001820 if(uDescendErr != QCBOR_SUCCESS) {
1821 /* This error is probably a traversal error and it
1822 overrides the non-traversal error. */
1823 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001824 goto Done;
1825 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001826 }
1827
Laurence Lundblade02625d42020-06-25 14:41:41 -07001828 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1829 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1830 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade642282a2020-06-23 12:00:33 -07001831 /*
1832 The following cases are handled here:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001833 - A non-aggregate item like an integer or string
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001834 - An empty definite length map or array
1835 - An indefinite length map or array that might be empty or might not.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001836
Laurence Lundbladee6f15112020-07-23 18:44:16 -07001837 NestLevelAscender() does the work of decrementing the count for an
Laurence Lundblade02625d42020-06-25 14:41:41 -07001838 definite length map/array and break detection for an indefinite
1839 length map/array. If the end of the map/array was reached, then
1840 it ascends nesting levels, possibly all the way to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001841 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001842 QCBORError uAscendErr;
1843 uAscendErr = NestLevelAscender(me, true);
1844 if(uAscendErr != QCBOR_SUCCESS) {
1845 /* This error is probably a traversal error and it
1846 overrides the non-traversal error. */
1847 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 Lundblade642282a2020-06-23 12:00:33 -07001853 /*
Laurence Lundblade02625d42020-06-25 14:41:41 -07001854 Tell the caller what level is next. This tells them what
1855 maps/arrays were closed out and makes it possible for them to
1856 reconstruct the tree with just the information returned in
1857 a QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001858 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001859 if(DecodeNesting_IsAtEndOfBoundedLevel(&(me->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001860 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001861 pDecodedItem->uNextNestLevel = 0;
1862 } else {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001863 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(me->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001864 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001865
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001866Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001867 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001868}
1869
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001870
1871static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001872{
Laurence Lundblade25403ed2021-01-02 16:28:07 -08001873 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
1874 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
1875 }
1876 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001877}
1878
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001879
Laurence Lundblade9b334962020-08-27 10:55:53 -07001880
Laurence Lundblade59289e52019-12-30 13:44:37 -08001881/*
Laurence Lundbladeee851742020-01-08 08:37:05 -08001882 The epoch formatted date. Turns lots of different forms of encoding
1883 date into uniform one
Laurence Lundblade59289e52019-12-30 13:44:37 -08001884 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001885static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001886{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001887 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001888
1889 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1890
1891 switch (pDecodedItem->uDataType) {
1892
1893 case QCBOR_TYPE_INT64:
1894 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1895 break;
1896
1897 case QCBOR_TYPE_UINT64:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001898 // This only happens for CBOR type 0 > INT64_MAX so it is
1899 // always an overflow.
1900 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1901 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001902 break;
1903
1904 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001905 case QCBOR_TYPE_FLOAT:
1906#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001907 {
1908 // This comparison needs to be done as a float before
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001909 // conversion to an int64_t to be able to detect doubles that
1910 // are too large to fit into an int64_t. A double has 52
1911 // bits of preceision. An int64_t has 63. Casting INT64_MAX
1912 // to a double actually causes a round up which is bad and
1913 // wrong for the comparison because it will allow conversion
1914 // of doubles that can't fit into a uint64_t. To remedy this
1915 // INT64_MAX - 0x7ff is used as the cutoff point because if
1916 // that value rounds up in conversion to double it will still
1917 // be less than INT64_MAX. 0x7ff is picked because it has 11
1918 // bits set.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001919 //
Laurence Lundblade7b5a3b62020-07-22 10:17:16 -07001920 // INT64_MAX seconds is on the order of 10 billion years, and
1921 // the earth is less than 5 billion years old, so for most
1922 // uses this conversion error won't occur even though doubles
1923 // can go much larger.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001924 //
1925 // Without the 0x7ff there is a ~30 minute range of time
1926 // values 10 billion years in the past and in the future
Laurence Lundbladec7114722020-08-13 05:11:40 -07001927 // where this code would go wrong. Some compilers
1928 // will generate warnings or errors without the 0x7ff
1929 // because of the precision issue.
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001930 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
1931 pDecodedItem->val.dfnum :
1932 (double)pDecodedItem->val.fnum;
Laurence Lundbladec7114722020-08-13 05:11:40 -07001933 if(isnan(d) ||
1934 d > (double)(INT64_MAX - 0x7ff) ||
1935 d < (double)(INT64_MIN + 0x7ff)) {
1936 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001937 goto Done;
1938 }
1939 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001940 pDecodedItem->val.epochDate.fSecondsFraction =
1941 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001942 }
Laurence Lundblade9682a532020-06-06 18:33:04 -07001943#else
Laurence Lundblade4b270642020-08-14 12:53:07 -07001944
Laurence Lundbladec7114722020-08-13 05:11:40 -07001945 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001946 goto Done;
1947
Laurence Lundblade9682a532020-06-06 18:33:04 -07001948#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001949 break;
1950
1951 default:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001952 uReturn = QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001953 goto Done;
1954 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001955
Laurence Lundblade59289e52019-12-30 13:44:37 -08001956 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1957
1958Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001959 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001960}
1961
1962
1963#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
1964/*
Laurence Lundbladee176d852021-01-03 17:50:30 -08001965 * @brief Decode decimal fractions and big floats.
1966 *
1967 * @param[in] The decode context.
1968 * @param[in,out] pDecodedItem On input the array data item that
1969 * holds the mantissa and exponent. On
1970 * output the decoded mantissa and
1971 * exponent.
1972 *
1973 * @returns Decoding errors from getting primitive data items or
1974 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
1975 *
1976 * When called pDecodedItem must be the array that is tagged as a big
1977 * float or decimal fraction, the array that has the two members, the
1978 * exponent and mantissa.
1979 *
1980 * This will fetch and decode the exponent and mantissa and put the
1981 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001982 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07001983static inline QCBORError
Laurence Lundblade59289e52019-12-30 13:44:37 -08001984QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1985{
Laurence Lundbladee176d852021-01-03 17:50:30 -08001986 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001987
Laurence Lundbladee176d852021-01-03 17:50:30 -08001988 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001989 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundbladee176d852021-01-03 17:50:30 -08001990 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001991 goto Done;
1992 }
1993
Laurence Lundbladee176d852021-01-03 17:50:30 -08001994 /* A check for pDecodedItem->val.uCount == 2 would work for
1995 * definite length arrays, but not for indefnite. Instead remember
1996 * the nesting level the two integers must be at, which is one
1997 * deeper than that of the array.
1998 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001999 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2000
Laurence Lundbladee176d852021-01-03 17:50:30 -08002001 /* --- Which is it, ecimal fraction or a bigfloat? --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002002 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
2003 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2004
Laurence Lundbladee176d852021-01-03 17:50:30 -08002005 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002006 QCBORItem exponentItem;
Laurence Lundbladee176d852021-01-03 17:50:30 -08002007 uReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
2008 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002009 goto Done;
2010 }
2011 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002012 /* Array is empty or a map/array encountered when expecting an int */
2013 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002014 goto Done;
2015 }
2016 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002017 /* Data arriving as an unsigned int < INT64_MAX has been
2018 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2019 * also means that the only data arriving here of type
2020 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2021 * and thus an error that will get handled in the next else.
2022 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002023 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2024 } else {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002025 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2026 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002027 goto Done;
2028 }
2029
Laurence Lundbladee176d852021-01-03 17:50:30 -08002030 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002031 QCBORItem mantissaItem;
Laurence Lundbladee176d852021-01-03 17:50:30 -08002032 uReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
2033 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002034 goto Done;
2035 }
2036 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002037 /* Mantissa missing or map/array encountered when expecting number */
2038 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002039 goto Done;
2040 }
2041 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundbladee176d852021-01-03 17:50:30 -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 an else below.
2047 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002048 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002049 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2050 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002051 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002052 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundbladee176d852021-01-03 17:50:30 -08002053 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002054 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2055 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2056 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002057 } else {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002058 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2059 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002060 goto Done;
2061 }
2062
Laurence Lundbladee176d852021-01-03 17:50:30 -08002063 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002064 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundbladee176d852021-01-03 17:50:30 -08002065 /* Extra items in the decimal fraction / big float */
2066 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002067 goto Done;
2068 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002069 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002070
2071Done:
Laurence Lundbladee176d852021-01-03 17:50:30 -08002072 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002073}
2074#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
2075
2076
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002077static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002078{
2079 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2080 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002081 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002082 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2083 } else {
2084 return QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002085
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002086 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002087
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002088 return QCBOR_SUCCESS;
2089}
2090
2091
Laurence Lundblade99615302020-11-29 11:19:47 -08002092/*
2093 * Table of CBOR tags whose content is either a text string or a byte
2094 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2095 * of uQCBORtype indicates the content should be a byte string rather
2096 * than a text string
2097 */
2098struct StringTagMapEntry {
2099 uint16_t uTagNumber;
2100 uint8_t uQCBORtype;
2101};
2102
2103#define IS_BYTE_STRING_BIT 0x80
2104#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2105
2106static const struct StringTagMapEntry StringTagMap[] = {
2107 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
2108 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2109 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2110 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2111 {CBOR_TAG_URI, QCBOR_TYPE_URI},
2112 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2113 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2114 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2115 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
2116 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2117 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2118};
2119
2120
2121/*
2122 * Process the CBOR tags that whose content is a byte string or a text
2123 * string and for which the string is just passed on to the caller.
2124 *
2125 * This maps the CBOR tag to the QCBOR type and checks the content
2126 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002127 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002128 * possible.
2129 *
2130 * This returns QCBOR_SUCCESS if the tag was procssed,
2131 * QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2132 * QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2133 */
2134static inline
2135QCBORError ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002136{
Laurence Lundblade99615302020-11-29 11:19:47 -08002137 /* This only works on tags that were not mapped; no need for other yet */
2138 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2139 return QCBOR_ERR_UNSUPPORTED;
2140 }
2141
2142 unsigned uIndex;
2143 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2144 if(StringTagMap[uIndex].uTagNumber == uTag) {
2145 break;
2146 }
2147 }
2148
2149 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2150 if(uQCBORType == QCBOR_TYPE_NONE) {
2151 /* repurpose this error to mean, not handled here */
2152 return QCBOR_ERR_UNSUPPORTED;
2153 }
2154
2155 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2156 if(uQCBORType & IS_BYTE_STRING_BIT) {
2157 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2158 }
2159
2160 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002161 return QCBOR_ERR_BAD_OPT_TAG;
2162 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002163
Laurence Lundblade99615302020-11-29 11:19:47 -08002164 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002165 return QCBOR_SUCCESS;
2166}
2167
2168
Laurence Lundblade59289e52019-12-30 13:44:37 -08002169/*
Laurence Lundblade99615302020-11-29 11:19:47 -08002170 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2171 * but the whole tag was not decoded. Here, the whole tags (tag number
2172 * and tag content) that are supported by QCBOR are decoded. This is a
2173 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002174 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002175static QCBORError
2176QCBORDecode_GetNextTag(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002177{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002178 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002179
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002180 uReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
2181 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002182 goto Done;
2183 }
2184
Laurence Lundblade99615302020-11-29 11:19:47 -08002185 /* When there are no tag numbers for the item, this exits first
2186 * thing and effectively does nothing.
2187 *
2188 * This loops over all the tag numbers accumulated for this item
2189 * trying to decode and interpret them. This stops at the end of
2190 * the list or at the first tag number that can't be interpreted by
2191 * this code. This is effectively a recursive processing of the
2192 * tags number list that handles nested tags.
2193 */
2194 while(1) {
2195 /* Don't bother to unmap tags via QCBORITem.uTags since this
2196 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2197 */
2198 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002199
Laurence Lundblade99615302020-11-29 11:19:47 -08002200 if(uTagToProcess == CBOR_TAG_INVALID16) {
2201 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002202 break;
2203
Laurence Lundblade99615302020-11-29 11:19:47 -08002204 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002205 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002206
Laurence Lundblade93d89472020-10-03 22:30:50 -07002207#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002208 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2209 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002210 uReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
Laurence Lundblade93d89472020-10-03 22:30:50 -07002211#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002212
Laurence Lundblade99615302020-11-29 11:19:47 -08002213 } else if(uTagToProcess == CBOR_TAG_MIME ||
2214 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002215 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002216
Laurence Lundblade99615302020-11-29 11:19:47 -08002217 } else {
2218 /* See if it is a pass-through byte/text string tag; process if so */
2219 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002220
Laurence Lundblade99615302020-11-29 11:19:47 -08002221 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2222 /* It wasn't a pass-through byte/text string tag so it is
2223 * an unknown tag. This is the exit from the loop on the
2224 * first unknown tag. It is a successful exit.
2225 */
2226 uReturn = QCBOR_SUCCESS;
2227 break;
2228 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002229 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002230
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002231 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002232 /* Error exit from the loop */
2233 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002234 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002235
2236 /* A tag was successfully processed, shift it out of the list of
2237 * tags returned. This is the loop increment.
2238 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002239 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002240 }
2241
2242Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002243 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002244}
2245
2246
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002247/*
2248 Public function, see header qcbor/qcbor_decode.h file
2249 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002250QCBORError
2251QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2252{
2253 QCBORError uErr;
2254 uErr = QCBORDecode_GetNextTag(pMe, pDecodedItem);
2255 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002256 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2257 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2258 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002259 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002260}
2261
2262
2263/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002264 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002265 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002266QCBORError
2267QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2268{
2269 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2270 const UsefulInputBuf Save = pMe->InBuf;
2271
2272 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2273
2274 pMe->nesting = SaveNesting;
2275 pMe->InBuf = Save;
2276
2277 return uErr;
2278}
2279
2280
2281/*
2282 Public function, see header qcbor/qcbor_decode.h file
2283 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002284void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2285{
2286 if(pMe->uLastError != QCBOR_SUCCESS) {
2287 return;
2288 }
2289
2290 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2291}
2292
2293
2294/*
2295 Public function, see header qcbor/qcbor_decode.h file
2296 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002297QCBORError
2298QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
2299 QCBORItem *pDecodedItem,
2300 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002301{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002302 QCBORError nReturn;
2303
2304 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
2305 if(nReturn != QCBOR_SUCCESS) {
2306 return nReturn;
2307 }
2308
2309 if(pTags != NULL) {
2310 pTags->uNumUsed = 0;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002311 // Reverse the order because pTags is reverse of
2312 // QCBORItem.uTags.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002313 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2314 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002315 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002316 }
2317 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2318 return QCBOR_ERR_TOO_MANY_TAGS;
2319 }
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002320 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(me,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002321 pTags->uNumUsed++;
2322 }
2323 }
2324
2325 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002326}
2327
2328
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302329
2330/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002331 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002332 */
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002333bool QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002334 const QCBORItem *pItem,
2335 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002336{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002337 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2338 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002339 break;
2340 }
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002341 if(UnMapTagNumber(me, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002342 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002343 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002344 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002345
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002346 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002347}
2348
2349
2350/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002351 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002352 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07002353QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002354{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002355 QCBORError uReturn = me->uLastError;
2356
2357 if(uReturn != QCBOR_SUCCESS) {
2358 goto Done;
2359 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002360
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002361 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002362 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002363 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002364 goto Done;
2365 }
2366
2367 // Error out if not all the bytes are consumed
2368 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002369 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002370 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002371
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002372Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002373#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade6de37062018-10-15 12:22:42 +05302374 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002375 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002376 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002377#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002378
Laurence Lundblade085d7952020-07-24 10:26:30 -07002379 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002380}
2381
2382
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002383/*
Laurence Lundblade9b334962020-08-27 10:55:53 -07002384 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002385*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07002386// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002387uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2388 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002389 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002390{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002391 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2392 return CBOR_TAG_INVALID64;
2393 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002394 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2395 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002396 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002397 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002398 }
2399}
2400
Laurence Lundblade9b334962020-08-27 10:55:53 -07002401/*
2402 Public function, see header qcbor/qcbor_decode.h file
2403*/
2404uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2405 uint32_t uIndex)
2406{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002407 if(pMe->uLastError != QCBOR_SUCCESS) {
2408 return CBOR_TAG_INVALID64;
2409 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002410 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2411 return CBOR_TAG_INVALID64;
2412 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002413 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002414 }
2415}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002416
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002417/*
2418
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002419Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002420
Laurence Lundbladeee851742020-01-08 08:37:05 -08002421 - Hit end of input before it was expected while decoding type and
2422 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002423
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002424 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002425
Laurence Lundbladeee851742020-01-08 08:37:05 -08002426 - Hit end of input while decoding a text or byte string
2427 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002428
Laurence Lundbladeee851742020-01-08 08:37:05 -08002429 - Encountered conflicting tags -- e.g., an item is tagged both a date
2430 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002431
Laurence Lundbladeee851742020-01-08 08:37:05 -08002432 - Encontered an array or mapp that has too many items
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002433 QCBOR_ERR_ARRAY_DECODE_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002434
Laurence Lundbladeee851742020-01-08 08:37:05 -08002435 - Encountered array/map nesting that is too deep
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002436 QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002437
Laurence Lundbladeee851742020-01-08 08:37:05 -08002438 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2439 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002440
Laurence Lundbladeee851742020-01-08 08:37:05 -08002441 - The type of a map label is not a string or int
2442 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002443
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002444 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002445
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002446 */
2447
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002448
2449
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002450#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002451
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002452/* ===========================================================================
2453 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002454
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002455 This implements a simple sting allocator for indefinite length
2456 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2457 implements the function type QCBORStringAllocate and allows easy
2458 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002459
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002460 This particular allocator is built-in for convenience. The caller
2461 can implement their own. All of this following code will get
2462 dead-stripped if QCBORDecode_SetMemPool() is not called.
2463
2464 This is a very primitive memory allocator. It does not track
2465 individual allocations, only a high-water mark. A free or
2466 reallocation must be of the last chunk allocated.
2467
2468 The size of the pool and offset to free memory are packed into the
2469 first 8 bytes of the memory pool so we don't have to keep them in
2470 the decode context. Since the address of the pool may not be
2471 aligned, they have to be packed and unpacked as if they were
2472 serialized data of the wire or such.
2473
2474 The sizes packed in are uint32_t to be the same on all CPU types
2475 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002476 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002477
2478
Laurence Lundbladeee851742020-01-08 08:37:05 -08002479static inline int
2480MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002481{
2482 // Use of UsefulInputBuf is overkill, but it is convenient.
2483 UsefulInputBuf UIB;
2484
Laurence Lundbladeee851742020-01-08 08:37:05 -08002485 // Just assume the size here. It was checked during SetUp so
2486 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002487 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002488 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2489 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2490 return UsefulInputBuf_GetError(&UIB);
2491}
2492
2493
Laurence Lundbladeee851742020-01-08 08:37:05 -08002494static inline int
2495MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002496{
2497 // Use of UsefulOutBuf is overkill, but convenient. The
2498 // length check performed here is useful.
2499 UsefulOutBuf UOB;
2500
2501 UsefulOutBuf_Init(&UOB, Pool);
2502 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2503 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2504 return UsefulOutBuf_GetError(&UOB);
2505}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002506
2507
2508/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002509 Internal function for an allocation, reallocation free and destuct.
2510
2511 Having only one function rather than one each per mode saves space in
2512 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002513
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002514 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2515 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002516static UsefulBuf
2517MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002518{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002519 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002520
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002521 uint32_t uPoolSize;
2522 uint32_t uFreeOffset;
2523
2524 if(uNewSize > UINT32_MAX) {
2525 // This allocator is only good up to 4GB. This check should
2526 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2527 goto Done;
2528 }
2529 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2530
2531 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2532 goto Done;
2533 }
2534
2535 if(uNewSize) {
2536 if(pMem) {
2537 // REALLOCATION MODE
2538 // Calculate pointer to the end of the memory pool. It is
2539 // assumed that pPool + uPoolSize won't wrap around by
2540 // assuming the caller won't pass a pool buffer in that is
2541 // not in legitimate memory space.
2542 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2543
2544 // Check that the pointer for reallocation is in the range of the
2545 // pool. This also makes sure that pointer math further down
2546 // doesn't wrap under or over.
2547 if(pMem >= pPool && pMem < pPoolEnd) {
2548 // Offset to start of chunk for reallocation. This won't
2549 // wrap under because of check that pMem >= pPool. Cast
2550 // is safe because the pool is always less than UINT32_MAX
2551 // because of check in QCBORDecode_SetMemPool().
2552 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2553
2554 // Check to see if the allocation will fit. uPoolSize -
2555 // uMemOffset will not wrap under because of check that
2556 // pMem is in the range of the uPoolSize by check above.
2557 if(uNewSize <= uPoolSize - uMemOffset) {
2558 ReturnValue.ptr = pMem;
2559 ReturnValue.len = uNewSize;
2560
2561 // Addition won't wrap around over because uNewSize was
2562 // checked to be sure it is less than the pool size.
2563 uFreeOffset = uMemOffset + uNewSize32;
2564 }
2565 }
2566 } else {
2567 // ALLOCATION MODE
2568 // uPoolSize - uFreeOffset will not underflow because this
2569 // pool implementation makes sure uFreeOffset is always
2570 // smaller than uPoolSize through this check here and
2571 // reallocation case.
2572 if(uNewSize <= uPoolSize - uFreeOffset) {
2573 ReturnValue.len = uNewSize;
2574 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002575 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002576 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002577 }
2578 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002579 if(pMem) {
2580 // FREE MODE
2581 // Cast is safe because of limit on pool size in
2582 // QCBORDecode_SetMemPool()
2583 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2584 } else {
2585 // DESTRUCT MODE
2586 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002587 }
2588 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002589
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002590 UsefulBuf Pool = {pPool, uPoolSize};
2591 MemPool_Pack(Pool, uFreeOffset);
2592
2593Done:
2594 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002595}
2596
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002597
Laurence Lundbladef6531662018-12-04 10:42:22 +09002598/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002599 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002600 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002601QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2602 UsefulBuf Pool,
2603 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002604{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002605 // The pool size and free mem offset are packed into the beginning
2606 // of the pool memory. This compile time check make sure the
2607 // constant in the header is correct. This check should optimize
2608 // down to nothing.
2609 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002610 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002611 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002612
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002613 // The pool size and free offset packed in to the beginning of pool
2614 // memory are only 32-bits. This check will optimize out on 32-bit
2615 // machines.
2616 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002617 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002618 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002619
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002620 // This checks that the pool buffer given is big enough.
2621 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002622 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002623 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002624
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002625 pMe->StringAllocator.pfAllocator = MemPool_Function;
2626 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2627 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002628
Laurence Lundblade30816f22018-11-10 13:40:22 +07002629 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002630}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002631#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002632
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002633
2634
Laurence Lundblade9b334962020-08-27 10:55:53 -07002635static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2636{
2637 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2638}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002639
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002640
2641/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002642 Consume an entire map or array (and do next to
2643 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002644 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002645static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002646ConsumeItem(QCBORDecodeContext *pMe,
2647 const QCBORItem *pItemToConsume,
2648 uint_fast8_t *puNextNestLevel)
2649{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002650 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002651 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002652
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002653 // If it is a map or array, this will tell if it is empty.
2654 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2655
2656 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2657 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002658
Laurence Lundblade1341c592020-04-11 14:19:05 -07002659 /* This works for definite and indefinite length
2660 * maps and arrays by using the nesting level
2661 */
2662 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002663 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002664 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002665 goto Done;
2666 }
2667 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002668
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002669 *puNextNestLevel = Item.uNextNestLevel;
2670
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002671 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002672
Laurence Lundblade1341c592020-04-11 14:19:05 -07002673 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002674 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002675 /* Just pass the nesting level through */
2676 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2677
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002678 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002679 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002680
2681Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002682 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002683}
2684
2685
Laurence Lundblade1341c592020-04-11 14:19:05 -07002686/* Return true if the labels in Item1 and Item2 are the same.
2687 Works only for integer and string labels. Returns false
2688 for any other type. */
2689static inline bool
2690MatchLabel(QCBORItem Item1, QCBORItem Item2)
2691{
2692 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2693 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2694 return true;
2695 }
2696 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002697 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002698 return true;
2699 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002700 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002701 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2702 return true;
2703 }
2704 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2705 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2706 return true;
2707 }
2708 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002709
Laurence Lundblade1341c592020-04-11 14:19:05 -07002710 /* Other label types are never matched */
2711 return false;
2712}
2713
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002714
2715/*
2716 Returns true if Item1 and Item2 are the same type
2717 or if either are of QCBOR_TYPE_ANY.
2718 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002719static inline bool
2720MatchType(QCBORItem Item1, QCBORItem Item2)
2721{
2722 if(Item1.uDataType == Item2.uDataType) {
2723 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002724 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002725 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002726 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002727 return true;
2728 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002729 return false;
2730}
2731
2732
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002733/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002734 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002735
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002736 @param[in] pMe The decode context to search.
2737 @param[in,out] pItemArray The items to search for and the items found.
2738 @param[out] puOffset Byte offset of last item matched.
2739 @param[in] pCBContext Context for the not-found item call back.
2740 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002741
2742 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2743
Laurence Lundblade93d89472020-10-03 22:30:50 -07002744 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2745 were found for one of the labels being
2746 search for. This duplicate detection is
2747 only performed for items in pItemArray,
2748 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002749
Laurence Lundblade93d89472020-10-03 22:30:50 -07002750 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2751 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002752
2753 @retval Also errors returned by QCBORDecode_GetNext().
2754
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002755 On input pItemArray contains a list of labels and data types
2756 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002757
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002758 On output the fully retrieved items are filled in with
2759 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002760
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002761 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002762
2763 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002764 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002765static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002766MapSearch(QCBORDecodeContext *pMe,
2767 QCBORItem *pItemArray,
2768 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002769 void *pCBContext,
2770 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002771{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002772 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002773 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002774
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002775 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002776 uReturn = pMe->uLastError;
2777 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002778 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002779
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002780 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002781 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2782 /* QCBOR_TYPE_NONE as first item indicates just looking
2783 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002784 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2785 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002786 }
2787
Laurence Lundblade085d7952020-07-24 10:26:30 -07002788 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2789 // It is an empty bounded array or map
2790 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2791 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002792 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002793 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002794 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002795 // Nothing is ever found in an empty array or map. All items
2796 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002797 uReturn = QCBOR_SUCCESS;
2798 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002799 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002800 }
2801
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002802 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002803 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2804
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002805 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002806 UsefulInputBuf_Seek(&(pMe->InBuf),
2807 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002808
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002809 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002810 Loop over all the items in the map or array. Each item
2811 could be a map or array, but label matching is only at
2812 the main level. This handles definite and indefinite
2813 length maps and arrays. The only reason this is ever
2814 called on arrays is to find their end position.
2815
2816 This will always run over all items in order to do
2817 duplicate detection.
2818
2819 This will exit with failure if it encounters an
2820 unrecoverable error, but continue on for recoverable
2821 errors.
2822
2823 If a recoverable error occurs on a matched item, then
2824 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002825 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002826 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002827 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002828 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002829 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002830 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002831
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002832 /* Get the item */
2833 QCBORItem Item;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002834 QCBORError uResult = QCBORDecode_GetNextTag(pMe, &Item);
2835 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002836 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002837 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002838 goto Done;
2839 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002840 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002841 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002842 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002843 goto Done;
2844 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002845
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002846 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002847 bool bMatched = false;
2848 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2849 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002850 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002851 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2852 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002853 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002854 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002855 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002856 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002857 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002858 goto Done;
2859 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002860
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002861 if(uResult != QCBOR_SUCCESS) {
2862 uReturn = uResult;
2863 goto Done;
2864 }
2865
Laurence Lundblade1341c592020-04-11 14:19:05 -07002866 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002867 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002868 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002869 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002870 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002871 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002872 bMatched = true;
2873 }
2874 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002875
2876
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002877 if(!bMatched && pfCallback != NULL) {
2878 /*
2879 Call the callback on unmatched labels.
2880 (It is tempting to do duplicate detection here, but that would
2881 require dynamic memory allocation because the number of labels
2882 that might be encountered is unbounded.)
2883 */
2884 uReturn = (*pfCallback)(pCBContext, &Item);
2885 if(uReturn != QCBOR_SUCCESS) {
2886 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002887 }
2888 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002889
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002890 /*
2891 Consume the item whether matched or not. This
2892 does the work of traversing maps and array and
2893 everything in them. In this loop only the
2894 items at the current nesting level are examined
2895 to match the labels.
2896 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002897 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002898 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002899 goto Done;
2900 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002901
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002902 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002903
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002904 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002905
2906 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002907
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002908 // Check here makes sure that this won't accidentally be
2909 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002910 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08002911 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
2912 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002913 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
2914 goto Done;
2915 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002916 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2917 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002918
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002919 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002920 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2921
2922 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002923 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07002924 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002925 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002926 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
2927 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002928 }
2929 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002930
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002931 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002932}
2933
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002934
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002935/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002936 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002937*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002938void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2939 int64_t nLabel,
2940 uint8_t uQcborType,
2941 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002942{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002943 if(pMe->uLastError != QCBOR_SUCCESS) {
2944 return;
2945 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002946
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002947 QCBORItem OneItemSeach[2];
2948 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2949 OneItemSeach[0].label.int64 = nLabel;
2950 OneItemSeach[0].uDataType = uQcborType;
2951 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002952
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002953 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002954
2955 *pItem = OneItemSeach[0];
2956
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002957 if(uReturn != QCBOR_SUCCESS) {
2958 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002959 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002960 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002961 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002962 }
2963
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002964 Done:
2965 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002966}
2967
2968
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002969/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002970 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002971*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002972void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2973 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07002974 uint8_t uQcborType,
2975 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002976{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002977 if(pMe->uLastError != QCBOR_SUCCESS) {
2978 return;
2979 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002980
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002981 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002982 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2983 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2984 OneItemSeach[0].uDataType = uQcborType;
2985 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002986
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002987 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2988 if(uReturn != QCBOR_SUCCESS) {
2989 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002990 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002991 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002992 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002993 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002994 }
2995
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002996 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002997
2998Done:
2999 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003000}
3001
3002
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003003
Laurence Lundblade93d89472020-10-03 22:30:50 -07003004static QCBORError
3005CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003006{
3007 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3008 if(uDataType == puTypeList[i]) {
3009 return QCBOR_SUCCESS;
3010 }
3011 }
3012 return QCBOR_ERR_UNEXPECTED_TYPE;
3013}
3014
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003015
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003016/**
3017 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003018 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003019
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003020 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3021 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003022
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003023 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3024 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003025 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003026static QCBORError
3027CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003028{
3029 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3030 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3031 /* There are tags that QCBOR couldn't process on this item and
3032 the caller has told us there should not be. */
3033 return QCBOR_ERR_UNEXPECTED_TYPE;
3034 }
3035
3036 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3037 const int nItemType = pItem->uDataType;
3038
3039 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3040 // Must match the tag and only the tag
3041 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3042 }
3043
3044 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3045 if(uReturn == QCBOR_SUCCESS) {
3046 return QCBOR_SUCCESS;
3047 }
3048
3049 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3050 /* Must match the content type and only the content type.
3051 There was no match just above so it is a fail. */
3052 return QCBOR_ERR_UNEXPECTED_TYPE;
3053 }
3054
3055 /* If here it can match either the tag or the content
3056 and it hasn't matched the content, so the end
3057 result is whether it matches the tag. This is
3058 also the case that the CBOR standard discourages. */
3059
3060 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3061}
3062
Laurence Lundblade9b334962020-08-27 10:55:53 -07003063
Laurence Lundblade9b334962020-08-27 10:55:53 -07003064
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003065// This could be semi-private if need be
3066static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003067void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3068 int64_t nLabel,
3069 TagSpecification TagSpec,
3070 QCBORItem *pItem)
3071{
3072 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3073 if(pMe->uLastError != QCBOR_SUCCESS) {
3074 return;
3075 }
3076
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003077 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003078}
3079
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003080
3081// This could be semi-private if need be
3082static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003083void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3084 const char *szLabel,
3085 TagSpecification TagSpec,
3086 QCBORItem *pItem)
3087{
3088 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3089 if(pMe->uLastError != QCBOR_SUCCESS) {
3090 return;
3091 }
3092
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003093 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003094}
3095
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003096// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003097void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3098 int64_t nLabel,
3099 TagSpecification TagSpec,
3100 UsefulBufC *pString)
3101{
3102 QCBORItem Item;
3103 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3104 if(pMe->uLastError == QCBOR_SUCCESS) {
3105 *pString = Item.val.string;
3106 }
3107}
3108
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003109// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003110void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3111 const char * szLabel,
3112 TagSpecification TagSpec,
3113 UsefulBufC *pString)
3114{
3115 QCBORItem Item;
3116 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3117 if(pMe->uLastError == QCBOR_SUCCESS) {
3118 *pString = Item.val.string;
3119 }
3120}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003121
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003122/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003123 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003124*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003125void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003126{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003127 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3128 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003129}
3130
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003131/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003132 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003133*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003134void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3135 QCBORItem *pItemList,
3136 void *pCallbackCtx,
3137 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003138{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003139 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3140 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003141}
3142
3143
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003144/**
3145 * @brief Search for a map/array by label and enter it
3146 *
3147 * @param[in] pMe The decode context.
3148 * @param[in] pSearch The map/array to search for.
3149 *
3150 * @c pSearch is expected to contain one item of type map or array
3151 * with the label specified. The current bounded map will be searched for
3152 * this and if found will be entered.
3153 *
3154 * If the label is not found, or the item found is not a map or array,
3155 * the error state is set.
3156 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003157static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003158{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003159 // The first item in pSearch is the one that is to be
3160 // entered. It should be the only one filled in. Any other
3161 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003162 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003163 return;
3164 }
3165
3166 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003167 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003168 if(pMe->uLastError != QCBOR_SUCCESS) {
3169 return;
3170 }
3171
Laurence Lundblade9b334962020-08-27 10:55:53 -07003172 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003173 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003174 return;
3175 }
3176
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003177 /*
3178 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3179 * next item for the pre-order traversal cursor to be the map/array
3180 * found by MapSearch(). The next few lines of code force the
3181 * cursor to that.
3182 *
3183 * There is no need to retain the old cursor because
3184 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3185 * beginning of the map/array being entered.
3186 *
3187 * The cursor is forced by: 1) setting the input buffer position to
3188 * the item offset found by MapSearch(), 2) setting the map/array
3189 * counter to the total in the map/array, 3) setting the nesting
3190 * level. Setting the map/array counter to the total is not
3191 * strictly correct, but this is OK because this cursor only needs
3192 * to be used to get one item and MapSearch() has already found it
3193 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003194 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003195 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003196
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003197 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3198
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003199 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003200
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003201 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003202}
3203
3204
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003205/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003206 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003207*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003208void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003209{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003210 QCBORItem OneItemSeach[2];
3211 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3212 OneItemSeach[0].label.int64 = nLabel;
3213 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3214 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003215
Laurence Lundblade9b334962020-08-27 10:55:53 -07003216 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003217 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003218}
3219
3220
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003221/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003222 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003223*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003224void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003225{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003226 QCBORItem OneItemSeach[2];
3227 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3228 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3229 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3230 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003231
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003232 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003233}
3234
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003235/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003236 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003237*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003238void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003239{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003240 QCBORItem OneItemSeach[2];
3241 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3242 OneItemSeach[0].label.int64 = nLabel;
3243 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3244 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003245
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003246 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003247}
3248
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003249/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003250 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003251*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003252void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3253{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003254 QCBORItem OneItemSeach[2];
3255 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3256 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3257 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3258 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003259
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003260 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003261}
3262
3263
Laurence Lundblade02625d42020-06-25 14:41:41 -07003264// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003265void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003266{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003267 QCBORError uErr;
3268
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003269 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003270 if(pMe->uLastError != QCBOR_SUCCESS) {
3271 // Already in error state; do nothing.
3272 return;
3273 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003274
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003275 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003276 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003277 uErr = QCBORDecode_GetNext(pMe, &Item);
3278 if(uErr != QCBOR_SUCCESS) {
3279 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003280 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003281 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003282 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3283 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003284 }
3285
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003286 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003287
3288
Laurence Lundbladef0499502020-08-01 11:55:57 -07003289 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003290 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003291 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3292 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003293 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003294 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3295 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003296 // Special case to increment nesting level for zero-length maps
3297 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003298 DecodeNesting_Descend(&(pMe->nesting), uType);
3299 }
3300
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003301 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003302
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003303 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3304 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003305
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003306 if(pItem != NULL) {
3307 *pItem = Item;
3308 }
3309
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003310Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003311 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003312}
3313
Laurence Lundblade02625d42020-06-25 14:41:41 -07003314
3315/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003316 This is the common work for exiting a level that is a bounded map,
3317 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003318
3319 One chunk of work is to set up the pre-order traversal so it is at
3320 the item just after the bounded map, array or bstr that is being
3321 exited. This is somewhat complex.
3322
3323 The other work is to level-up the bounded mode to next higest bounded
3324 mode or the top level if there isn't one.
3325 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003326static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003327ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003328{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003329 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003330
Laurence Lundblade02625d42020-06-25 14:41:41 -07003331 /*
3332 First the pre-order-traversal byte offset is positioned to the
3333 item just after the bounded mode item that was just consumed.
3334 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003335 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3336
Laurence Lundblade02625d42020-06-25 14:41:41 -07003337 /*
3338 Next, set the current nesting level to one above the bounded level
3339 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003340
Laurence Lundblade02625d42020-06-25 14:41:41 -07003341 DecodeNesting_CheckBoundedType() is always called before this and
3342 makes sure pCurrentBounded is valid.
3343 */
3344 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3345
3346 /*
3347 This does the complex work of leveling up the pre-order traversal
3348 when the end of a map or array or another bounded level is
3349 reached. It may do nothing, or ascend all the way to the top
3350 level.
3351 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07003352 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003353 if(uErr != QCBOR_SUCCESS) {
3354 goto Done;
3355 }
3356
Laurence Lundblade02625d42020-06-25 14:41:41 -07003357 /*
3358 This makes the next highest bounded level the current bounded
3359 level. If there is no next highest level, then no bounded mode is
3360 in effect.
3361 */
3362 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003363
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003364 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003365
3366Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003367 return uErr;
3368}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003369
Laurence Lundblade02625d42020-06-25 14:41:41 -07003370
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003371// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003372void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003373{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003374 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003375 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003376 return;
3377 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003378
Laurence Lundblade02625d42020-06-25 14:41:41 -07003379 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003380
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003381 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003382 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003383 goto Done;
3384 }
3385
Laurence Lundblade02625d42020-06-25 14:41:41 -07003386 /*
3387 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003388 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003389 from previous map search, then do a dummy search.
3390 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003391 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003392 QCBORItem Dummy;
3393 Dummy.uLabelType = QCBOR_TYPE_NONE;
3394 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3395 if(uErr != QCBOR_SUCCESS) {
3396 goto Done;
3397 }
3398 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003399
Laurence Lundblade02625d42020-06-25 14:41:41 -07003400 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003401
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003402Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003403 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003404}
3405
3406
Laurence Lundblade1341c592020-04-11 14:19:05 -07003407
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003408static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003409 const QCBORItem *pItem,
3410 uint8_t uTagRequirement,
3411 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003412{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003413 if(pBstr) {
3414 *pBstr = NULLUsefulBufC;
3415 }
3416
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003417 if(pMe->uLastError != QCBOR_SUCCESS) {
3418 // Already in error state; do nothing.
3419 return pMe->uLastError;
3420 }
3421
3422 QCBORError uError = QCBOR_SUCCESS;
3423
3424 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
3425 uError = QCBOR_ERR_UNEXPECTED_TYPE;
3426 goto Done;;
3427 }
3428
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003429 const TagSpecification TagSpec =
3430 {
3431 uTagRequirement,
3432 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3433 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3434 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003435
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003436 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003437 if(uError != QCBOR_SUCCESS) {
3438 goto Done;
3439 }
3440
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003441 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003442 // Reverse the decrement done by GetNext() for the bstr so the
3443 // increment in NestLevelAscender() called by ExitBoundedLevel()
3444 // will work right.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003445 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003446 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003447
3448 if(pBstr) {
3449 *pBstr = pItem->val.string;
3450 }
3451
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003452 // This saves the current length of the UsefulInputBuf and then
3453 // narrows the UsefulInputBuf to start and length of the wrapped
3454 // CBOR that is being entered.
3455 //
3456 // This makes sure the length is less than
3457 // QCBOR_MAX_DECODE_INPUT_SIZE which is slighly less than
3458 // UINT32_MAX. The value UINT32_MAX is used as a special indicator
3459 // value. The checks against QCBOR_MAX_DECODE_INPUT_SIZE also make
3460 // the casts safe. uEndOfBstr will always be less than
3461 // uPreviousLength because of the way UsefulInputBuf works so there
3462 // is no need to check it. There is also a range check in the
3463 // seek.
3464 //
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003465 // Most of these calls are simple inline accessors so this doesn't
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003466 // amount to much code.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003467 // Cast of uPreviousLength to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003468 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003469 if((uint32_t)uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003470 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003471 goto Done;
3472 }
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003473 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003474 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003475 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003476
Laurence Lundblade02625d42020-06-25 14:41:41 -07003477 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003478 (uint32_t)uPreviousLength,
3479 (uint32_t)uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003480Done:
3481 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003482}
3483
3484
Laurence Lundblade02625d42020-06-25 14:41:41 -07003485/*
3486 Public function, see header qcbor/qcbor_decode.h file
3487 */
3488void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003489 uint8_t uTagRequirement,
3490 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003491{
3492 if(pMe->uLastError != QCBOR_SUCCESS) {
3493 // Already in error state; do nothing.
3494 return;
3495 }
3496
3497 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003498 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003499 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3500 if(pMe->uLastError != QCBOR_SUCCESS) {
3501 return;
3502 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003503
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003504 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003505 &Item,
3506 uTagRequirement,
3507 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003508}
3509
3510
Laurence Lundblade02625d42020-06-25 14:41:41 -07003511/*
3512 Public function, see header qcbor/qcbor_decode.h file
3513 */
3514void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003515 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003516 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003517 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003518{
3519 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003520 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003521
Laurence Lundblade93d89472020-10-03 22:30:50 -07003522 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3523 &Item,
3524 uTagRequirement,
3525 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003526}
3527
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003528
Laurence Lundblade02625d42020-06-25 14:41:41 -07003529/*
3530 Public function, see header qcbor/qcbor_decode.h file
3531 */
3532void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003533 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003534 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003535 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003536{
3537 QCBORItem Item;
3538 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3539
Laurence Lundblade93d89472020-10-03 22:30:50 -07003540 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3541 &Item,
3542 uTagRequirement,
3543 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003544}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003545
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003546
Laurence Lundblade02625d42020-06-25 14:41:41 -07003547/*
3548 Public function, see header qcbor/qcbor_decode.h file
3549 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003550void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003551{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003552 if(pMe->uLastError != QCBOR_SUCCESS) {
3553 // Already in error state; do nothing.
3554 return;
3555 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003556
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003557 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003558 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003559 return;
3560 }
3561
3562 /*
3563 Reset the length of the UsefulInputBuf to what it was before
3564 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003565 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003566 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003567 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003568
3569
Laurence Lundblade02625d42020-06-25 14:41:41 -07003570 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003571 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003572}
3573
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003574
Laurence Lundbladee6430642020-03-14 21:15:44 -07003575
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003576
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003577
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003578
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003579
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003580
Laurence Lundblade93d89472020-10-03 22:30:50 -07003581static QCBORError
3582InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003583{
3584 switch(pItem->uDataType) {
3585 case QCBOR_TYPE_TRUE:
3586 *pBool = true;
3587 return QCBOR_SUCCESS;
3588 break;
3589
3590 case QCBOR_TYPE_FALSE:
3591 *pBool = false;
3592 return QCBOR_SUCCESS;
3593 break;
3594
3595 default:
3596 return QCBOR_ERR_UNEXPECTED_TYPE;
3597 break;
3598 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003599 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003600}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003601
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003602
Laurence Lundblade9b334962020-08-27 10:55:53 -07003603
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003604/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003605 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003606*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003607void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003608{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003609 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003610 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003611 return;
3612 }
3613
Laurence Lundbladec4537442020-04-14 18:53:22 -07003614 QCBORError nError;
3615 QCBORItem Item;
3616
3617 nError = QCBORDecode_GetNext(pMe, &Item);
3618 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003619 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003620 return;
3621 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003622 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003623}
3624
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003625
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003626/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003627 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003628*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003629void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003630{
3631 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003632 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003633
Laurence Lundblade9b334962020-08-27 10:55:53 -07003634 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003635}
3636
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003637
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003638/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003639 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003640*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003641void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3642{
3643 QCBORItem Item;
3644 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3645
Laurence Lundblade9b334962020-08-27 10:55:53 -07003646 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003647}
3648
3649
3650
Laurence Lundbladec7114722020-08-13 05:11:40 -07003651
3652static void ProcessEpochDate(QCBORDecodeContext *pMe,
3653 QCBORItem *pItem,
3654 uint8_t uTagRequirement,
3655 int64_t *pnTime)
3656{
3657 if(pMe->uLastError != QCBOR_SUCCESS) {
3658 // Already in error state, do nothing
3659 return;
3660 }
3661
3662 QCBORError uErr;
3663
3664 const TagSpecification TagSpec =
3665 {
3666 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003667 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3668 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003669 };
3670
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003671 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003672 if(uErr != QCBOR_SUCCESS) {
3673 goto Done;
3674 }
3675
3676 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3677 uErr = DecodeDateEpoch(pItem);
3678 if(uErr != QCBOR_SUCCESS) {
3679 goto Done;
3680 }
3681 }
3682
Laurence Lundblade9b334962020-08-27 10:55:53 -07003683 // Save the tags in the last item's tags in the decode context
3684 // for QCBORDecode_GetNthTagOfLast()
3685 CopyTags(pMe, pItem);
3686
Laurence Lundbladec7114722020-08-13 05:11:40 -07003687 *pnTime = pItem->val.epochDate.nSeconds;
3688
3689Done:
3690 pMe->uLastError = (uint8_t)uErr;
3691}
3692
3693
3694void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003695 uint8_t uTagRequirement,
3696 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003697{
3698 if(pMe->uLastError != QCBOR_SUCCESS) {
3699 // Already in error state, do nothing
3700 return;
3701 }
3702
3703 QCBORItem Item;
3704 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3705
3706 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3707}
3708
3709
3710void
3711QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3712 int64_t nLabel,
3713 uint8_t uTagRequirement,
3714 int64_t *pnTime)
3715{
3716 QCBORItem Item;
3717 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3718 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3719}
3720
3721
3722void
3723QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3724 const char *szLabel,
3725 uint8_t uTagRequirement,
3726 int64_t *pnTime)
3727{
3728 QCBORItem Item;
3729 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3730 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3731}
3732
3733
3734
3735
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003736void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3737 TagSpecification TagSpec,
3738 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003739{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003740 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003741 // Already in error state, do nothing
3742 return;
3743 }
3744
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003745 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003746 QCBORItem Item;
3747
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003748 uError = QCBORDecode_GetNext(pMe, &Item);
3749 if(uError != QCBOR_SUCCESS) {
3750 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003751 return;
3752 }
3753
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003754 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003755
3756 if(pMe->uLastError == QCBOR_SUCCESS) {
3757 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003758 } else {
3759 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003760 }
3761}
3762
Laurence Lundbladec4537442020-04-14 18:53:22 -07003763
3764
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003765
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003766static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003767 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003768 UsefulBufC *pValue,
3769 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003770{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003771 const TagSpecification TagSpec =
3772 {
3773 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003774 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3775 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003776 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003777
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003778 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003779 if(uErr != QCBOR_SUCCESS) {
3780 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003781 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003782
3783 *pValue = pItem->val.string;
3784
3785 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3786 *pbIsNegative = false;
3787 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3788 *pbIsNegative = true;
3789 }
3790
3791 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003792}
3793
3794
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003795/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003796 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003797 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003798void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3799 uint8_t uTagRequirement,
3800 UsefulBufC *pValue,
3801 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003802{
3803 if(pMe->uLastError != QCBOR_SUCCESS) {
3804 // Already in error state, do nothing
3805 return;
3806 }
3807
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003808 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003809 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3810 if(uError != QCBOR_SUCCESS) {
3811 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003812 return;
3813 }
3814
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003815 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003816}
3817
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003818
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003819/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003820 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003821*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003822void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3823 int64_t nLabel,
3824 uint8_t uTagRequirement,
3825 UsefulBufC *pValue,
3826 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003827{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003828 QCBORItem Item;
3829 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003830 if(pMe->uLastError != QCBOR_SUCCESS) {
3831 return;
3832 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003833
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003834 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003835}
3836
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003837
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003838/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003839 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003840*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003841void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3842 const char *szLabel,
3843 uint8_t uTagRequirement,
3844 UsefulBufC *pValue,
3845 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003846{
3847 QCBORItem Item;
3848 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003849 if(pMe->uLastError != QCBOR_SUCCESS) {
3850 return;
3851 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003852
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003853 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003854}
3855
3856
3857
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003858
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003859// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003860QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3861 const QCBORItem *pItem,
3862 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07003863 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003864{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003865 const TagSpecification TagSpecText =
3866 {
3867 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003868 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3869 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003870 };
3871 const TagSpecification TagSpecBinary =
3872 {
3873 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003874 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3875 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003876 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003877
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003878 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003879
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003880 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003881 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003882 if(pbIsTag257 != NULL) {
3883 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003884 }
3885 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003886 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003887 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003888 if(pbIsTag257 != NULL) {
3889 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003890 }
3891 uReturn = QCBOR_SUCCESS;
3892
3893 } else {
3894 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3895 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003896
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003897 return uReturn;
3898}
3899
Laurence Lundblade93d89472020-10-03 22:30:50 -07003900// Improvement: add methods for wrapped CBOR, a simple alternate
3901// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003902
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003903
3904
3905
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003906#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003907
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003908typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003909
3910
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003911// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003912static QCBORError
3913Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003914{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003915 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003916
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003917 if(uResult != 0) {
3918 /* This loop will run a maximum of 19 times because
3919 * UINT64_MAX < 10 ^^ 19. More than that will cause
3920 * exit with the overflow error
3921 */
3922 for(; nExponent > 0; nExponent--) {
3923 if(uResult > UINT64_MAX / 10) {
3924 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3925 }
3926 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003927 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003928
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003929 for(; nExponent < 0; nExponent++) {
3930 uResult = uResult / 10;
3931 if(uResult == 0) {
3932 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3933 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003934 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003935 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003936 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003937
3938 *puResult = uResult;
3939
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003940 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003941}
3942
3943
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003944// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003945static QCBORError
3946Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003947{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003948 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003949
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003950 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003951
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003952 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003953 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003954 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07003955 */
3956 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003957 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003958 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003959 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003960 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003961 nExponent--;
3962 }
3963
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003964 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003965 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003966 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3967 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003968 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003969 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003970 }
3971
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003972 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003973
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003974 return QCBOR_SUCCESS;
3975}
3976
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003977
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003978/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003979 Compute value with signed mantissa and signed result. Works with
3980 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003981 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003982static inline QCBORError ExponentiateNN(int64_t nMantissa,
3983 int64_t nExponent,
3984 int64_t *pnResult,
3985 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003986{
3987 uint64_t uResult;
3988
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003989 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003990 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003991 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3992
3993 // Do the exponentiation of the positive mantissa
3994 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3995 if(uReturn) {
3996 return uReturn;
3997 }
3998
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003999
Laurence Lundblade983500d2020-05-14 11:49:34 -07004000 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4001 of INT64_MIN. This assumes two's compliment representation where
4002 INT64_MIN is one increment farther from 0 than INT64_MAX.
4003 Trying to write -INT64_MIN doesn't work to get this because the
4004 compiler tries to work with an int64_t which can't represent
4005 -INT64_MIN.
4006 */
4007 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4008
4009 // Error out if too large
4010 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004011 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4012 }
4013
4014 // Casts are safe because of checks above
4015 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4016
4017 return QCBOR_SUCCESS;
4018}
4019
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004020
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004021/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004022 Compute value with signed mantissa and unsigned result. Works with
4023 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004024 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004025static inline QCBORError ExponentitateNU(int64_t nMantissa,
4026 int64_t nExponent,
4027 uint64_t *puResult,
4028 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004029{
4030 if(nMantissa < 0) {
4031 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4032 }
4033
4034 // Cast to unsigned is OK because of check for negative
4035 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4036 // Exponentiation is straight forward
4037 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4038}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004039
4040
4041/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004042 Compute value with signed mantissa and unsigned result. Works with
4043 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004044 */
4045static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4046 int64_t nExponent,
4047 uint64_t *puResult,
4048 fExponentiator pfExp)
4049{
4050 return (*pfExp)(uMantissa, nExponent, puResult);
4051}
4052
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004053#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4054
4055
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004056
4057
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004058
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004059static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004060{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004061 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004062
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004063 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004064 const uint8_t *pByte = BigNum.ptr;
4065 size_t uLen = BigNum.len;
4066 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004067 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004068 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004069 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004070 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004071 }
4072
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004073 *pResult = uResult;
4074 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004075}
4076
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004077
Laurence Lundblade887add82020-05-17 05:50:34 -07004078static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004079{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004080 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004081}
4082
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004083
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004084static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004085{
4086 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004087 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4088 if(uError) {
4089 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004090 }
4091 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4092 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004093 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004094}
4095
4096
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004097static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004098{
4099 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004100 /* The negative integer furthest from zero for a C int64_t is
4101 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4102 negative number in CBOR is computed as -n - 1 where n is the
4103 encoded integer, where n is what is in the variable BigNum. When
4104 converting BigNum to a uint64_t, the maximum value is thus
4105 INT64_MAX, so that when it -n - 1 is applied to it the result will
4106 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004107
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004108 -n - 1 <= INT64_MIN.
4109 -n - 1 <= -INT64_MAX - 1
4110 n <= INT64_MAX.
4111 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004112 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004113 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004114 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004115 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004116
4117 /// Now apply -n - 1. The cast is safe because
4118 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4119 // is the largest positive integer that an int64_t can
4120 // represent. */
4121 *pnResult = -(int64_t)uResult - 1;
4122
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004123 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004124}
4125
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004126
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004127
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004128
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004129
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004130/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004131Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004132
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004133\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004134
Laurence Lundblade93d89472020-10-03 22:30:50 -07004135\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4136 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004137
4138\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4139
Laurence Lundblade93d89472020-10-03 22:30:50 -07004140\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4141 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004142*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004143static QCBORError
4144ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004145{
4146 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004147 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004148 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004149#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004150 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004151 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4152 http://www.cplusplus.com/reference/cmath/llround/
4153 */
4154 // Not interested in FE_INEXACT
4155 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004156 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4157 *pnValue = llround(pItem->val.dfnum);
4158 } else {
4159 *pnValue = lroundf(pItem->val.fnum);
4160 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004161 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4162 // llround() shouldn't result in divide by zero, but catch
4163 // it here in case it unexpectedly does. Don't try to
4164 // distinguish between the various exceptions because it seems
4165 // they vary by CPU, compiler and OS.
4166 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004167 }
4168 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004169 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004170 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004171#else
4172 return QCBOR_ERR_HW_FLOAT_DISABLED;
4173#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004174 break;
4175
4176 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004177 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004178 *pnValue = pItem->val.int64;
4179 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004180 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004181 }
4182 break;
4183
4184 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004185 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004186 if(pItem->val.uint64 < INT64_MAX) {
4187 *pnValue = pItem->val.int64;
4188 } else {
4189 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4190 }
4191 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004192 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004193 }
4194 break;
4195
4196 default:
4197 return QCBOR_ERR_UNEXPECTED_TYPE;
4198 }
4199 return QCBOR_SUCCESS;
4200}
4201
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004202
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004203void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004204 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004205 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004206 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004207{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004208 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004209 return;
4210 }
4211
Laurence Lundbladee6430642020-03-14 21:15:44 -07004212 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004213 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4214 if(uError) {
4215 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004216 return;
4217 }
4218
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004219 if(pItem) {
4220 *pItem = Item;
4221 }
4222
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004223 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004224}
4225
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004226
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004227void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4228 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004229 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004230 int64_t *pnValue,
4231 QCBORItem *pItem)
4232{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004233 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004234 if(pMe->uLastError != QCBOR_SUCCESS) {
4235 return;
4236 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004237
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004238 pMe->uLastError = (uint8_t)ConvertInt64(pItem, 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_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4243 const char * szLabel,
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_GetItemInMapSZ(pMe, szLabel, 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
4256
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004257/*
4258 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004259
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004260 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004261
Laurence Lundblade93d89472020-10-03 22:30:50 -07004262 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4263 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004264
4265 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4266
Laurence Lundblade93d89472020-10-03 22:30:50 -07004267 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4268 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004269 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004270static QCBORError
4271Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004272{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004273 switch(pItem->uDataType) {
4274
4275 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004276 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004277 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004278 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004279 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004280 }
4281 break;
4282
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004283 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004284 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004285 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004286 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004287 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004288 }
4289 break;
4290
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004291#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4292 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004293 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004294 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004295 pItem->val.expAndMantissa.nExponent,
4296 pnValue,
4297 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004298 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004299 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004300 }
4301 break;
4302
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004303 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004304 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004305 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004306 pItem->val.expAndMantissa.nExponent,
4307 pnValue,
4308 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004309 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004310 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004311 }
4312 break;
4313
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004314 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004315 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004316 int64_t nMantissa;
4317 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004318 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4319 if(uErr) {
4320 return uErr;
4321 }
4322 return ExponentiateNN(nMantissa,
4323 pItem->val.expAndMantissa.nExponent,
4324 pnValue,
4325 Exponentitate10);
4326 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004327 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004328 }
4329 break;
4330
4331 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004332 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004333 int64_t nMantissa;
4334 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004335 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4336 if(uErr) {
4337 return uErr;
4338 }
4339 return ExponentiateNN(nMantissa,
4340 pItem->val.expAndMantissa.nExponent,
4341 pnValue,
4342 Exponentitate10);
4343 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004344 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004345 }
4346 break;
4347
4348 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004349 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004350 int64_t nMantissa;
4351 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004352 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4353 if(uErr) {
4354 return uErr;
4355 }
4356 return ExponentiateNN(nMantissa,
4357 pItem->val.expAndMantissa.nExponent,
4358 pnValue,
4359 Exponentitate2);
4360 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004361 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004362 }
4363 break;
4364
4365 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004366 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004367 int64_t nMantissa;
4368 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004369 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4370 if(uErr) {
4371 return uErr;
4372 }
4373 return ExponentiateNN(nMantissa,
4374 pItem->val.expAndMantissa.nExponent,
4375 pnValue,
4376 Exponentitate2);
4377 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004378 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004379 }
4380 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004381#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4382
Laurence Lundbladee6430642020-03-14 21:15:44 -07004383
Laurence Lundbladec4537442020-04-14 18:53:22 -07004384 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004385 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004386}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004387
4388
Laurence Lundbladec4537442020-04-14 18:53:22 -07004389/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004390 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004391 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004392void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004393{
4394 QCBORItem Item;
4395
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004396 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004397
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004398 if(pMe->uLastError == QCBOR_SUCCESS) {
4399 // The above conversion succeeded
4400 return;
4401 }
4402
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004403 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004404 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004405 return;
4406 }
4407
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004408 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004409}
4410
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004411
4412/*
4413Public function, see header qcbor/qcbor_decode.h file
4414*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004415void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4416 int64_t nLabel,
4417 uint32_t uConvertTypes,
4418 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004419{
4420 QCBORItem Item;
4421
Laurence Lundblade93d89472020-10-03 22:30:50 -07004422 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4423 nLabel,
4424 uConvertTypes,
4425 pnValue,
4426 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004427
4428 if(pMe->uLastError == QCBOR_SUCCESS) {
4429 // The above conversion succeeded
4430 return;
4431 }
4432
4433 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4434 // The above conversion failed in a way that code below can't correct
4435 return;
4436 }
4437
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004438 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004439}
4440
4441
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004442/*
4443Public function, see header qcbor/qcbor_decode.h file
4444*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004445void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4446 const char *szLabel,
4447 uint32_t uConvertTypes,
4448 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004449{
4450 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004451 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4452 szLabel,
4453 uConvertTypes,
4454 pnValue,
4455 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004456
4457 if(pMe->uLastError == QCBOR_SUCCESS) {
4458 // The above conversion succeeded
4459 return;
4460 }
4461
4462 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4463 // The above conversion failed in a way that code below can't correct
4464 return;
4465 }
4466
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004467 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004468}
4469
4470
Laurence Lundblade93d89472020-10-03 22:30:50 -07004471static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004472{
4473 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004474 case QCBOR_TYPE_DOUBLE:
4475 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004476#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004477 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004478 // Can't use llround here because it will not convert values
4479 // greater than INT64_MAX and less than UINT64_MAX that
4480 // need to be converted so it is more complicated.
4481 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4482 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4483 if(isnan(pItem->val.dfnum)) {
4484 return QCBOR_ERR_FLOAT_EXCEPTION;
4485 } else if(pItem->val.dfnum < 0) {
4486 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4487 } else {
4488 double dRounded = round(pItem->val.dfnum);
4489 // See discussion in DecodeDateEpoch() for
4490 // explanation of - 0x7ff
4491 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4492 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4493 }
4494 *puValue = (uint64_t)dRounded;
4495 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004496 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004497 if(isnan(pItem->val.fnum)) {
4498 return QCBOR_ERR_FLOAT_EXCEPTION;
4499 } else if(pItem->val.fnum < 0) {
4500 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4501 } else {
4502 float fRounded = roundf(pItem->val.fnum);
4503 // See discussion in DecodeDateEpoch() for
4504 // explanation of - 0x7ff
4505 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4506 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4507 }
4508 *puValue = (uint64_t)fRounded;
4509 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004510 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004511 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4512 // round() and roundf() shouldn't result in exceptions here, but
4513 // catch them to be robust and thorough. Don't try to
4514 // distinguish between the various exceptions because it seems
4515 // they vary by CPU, compiler and OS.
4516 return QCBOR_ERR_FLOAT_EXCEPTION;
4517 }
4518
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004519 } else {
4520 return QCBOR_ERR_UNEXPECTED_TYPE;
4521 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004522#else
4523 return QCBOR_ERR_HW_FLOAT_DISABLED;
4524#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004525 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004526
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004527 case QCBOR_TYPE_INT64:
4528 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4529 if(pItem->val.int64 >= 0) {
4530 *puValue = (uint64_t)pItem->val.int64;
4531 } else {
4532 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4533 }
4534 } else {
4535 return QCBOR_ERR_UNEXPECTED_TYPE;
4536 }
4537 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004538
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004539 case QCBOR_TYPE_UINT64:
4540 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4541 *puValue = pItem->val.uint64;
4542 } else {
4543 return QCBOR_ERR_UNEXPECTED_TYPE;
4544 }
4545 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004546
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004547 default:
4548 return QCBOR_ERR_UNEXPECTED_TYPE;
4549 }
4550
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004551 return QCBOR_SUCCESS;
4552}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004553
4554
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004555void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004556 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004557 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004558 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004559{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004560 if(pMe->uLastError != QCBOR_SUCCESS) {
4561 return;
4562 }
4563
Laurence Lundbladec4537442020-04-14 18:53:22 -07004564 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004565
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004566 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4567 if(uError) {
4568 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004569 return;
4570 }
4571
Laurence Lundbladea826c502020-05-10 21:07:00 -07004572 if(pItem) {
4573 *pItem = Item;
4574 }
4575
Laurence Lundblade93d89472020-10-03 22:30:50 -07004576 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004577}
4578
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004579
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004580void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004581 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004582 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004583 uint64_t *puValue,
4584 QCBORItem *pItem)
4585{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004586 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004587 if(pMe->uLastError != QCBOR_SUCCESS) {
4588 return;
4589 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004590
Laurence Lundblade93d89472020-10-03 22:30:50 -07004591 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004592}
4593
4594
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004595void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004596 const char * szLabel,
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{
4601 if(pMe->uLastError != QCBOR_SUCCESS) {
4602 return;
4603 }
4604
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004605 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004606 if(pMe->uLastError != QCBOR_SUCCESS) {
4607 return;
4608 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004609
Laurence Lundblade93d89472020-10-03 22:30:50 -07004610 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004611}
4612
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004613
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004614
Laurence Lundblade93d89472020-10-03 22:30:50 -07004615static QCBORError
4616UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004617{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004618 switch(pItem->uDataType) {
4619
4620 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004621 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004622 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4623 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004624 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004625 }
4626 break;
4627
4628 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004629 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004630 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4631 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004632 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004633 }
4634 break;
4635
4636#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4637
4638 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004639 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004640 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004641 pItem->val.expAndMantissa.nExponent,
4642 puValue,
4643 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004644 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004645 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004646 }
4647 break;
4648
4649 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004650 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004651 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4652 pItem->val.expAndMantissa.nExponent,
4653 puValue,
4654 Exponentitate2);
4655 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004656 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004657 }
4658 break;
4659
4660 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004661 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004662 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004663 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004664 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004665 if(uErr != QCBOR_SUCCESS) {
4666 return uErr;
4667 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004668 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004669 pItem->val.expAndMantissa.nExponent,
4670 puValue,
4671 Exponentitate10);
4672 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004673 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004674 }
4675 break;
4676
4677 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004678 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004679 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4680 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004681 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004682 }
4683 break;
4684
4685 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004686 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004687 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004688 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004689 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004690 if(uErr != QCBOR_SUCCESS) {
4691 return uErr;
4692 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004693 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004694 pItem->val.expAndMantissa.nExponent,
4695 puValue,
4696 Exponentitate2);
4697 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004698 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004699 }
4700 break;
4701
4702 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004703 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004704 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4705 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004706 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004707 }
4708 break;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004709#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004710 default:
4711 return QCBOR_ERR_UNEXPECTED_TYPE;
4712 }
4713}
4714
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004715
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004716/*
4717 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004718 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004719void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004720{
4721 QCBORItem Item;
4722
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004723 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004724
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004725 if(pMe->uLastError == QCBOR_SUCCESS) {
4726 // The above conversion succeeded
4727 return;
4728 }
4729
4730 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4731 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004732 return;
4733 }
4734
Laurence Lundblade93d89472020-10-03 22:30:50 -07004735 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004736}
4737
Laurence Lundbladec4537442020-04-14 18:53:22 -07004738
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004739/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004740 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004741*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004742void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004743 int64_t nLabel,
4744 uint32_t uConvertTypes,
4745 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004746{
4747 QCBORItem Item;
4748
Laurence Lundblade93d89472020-10-03 22:30:50 -07004749 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4750 nLabel,
4751 uConvertTypes,
4752 puValue,
4753 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004754
4755 if(pMe->uLastError == QCBOR_SUCCESS) {
4756 // The above conversion succeeded
4757 return;
4758 }
4759
4760 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4761 // The above conversion failed in a way that code below can't correct
4762 return;
4763 }
4764
Laurence Lundblade93d89472020-10-03 22:30:50 -07004765 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004766}
4767
4768
4769/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004770 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004771*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004772void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004773 const char *szLabel,
4774 uint32_t uConvertTypes,
4775 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004776{
4777 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004778 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
4779 szLabel,
4780 uConvertTypes,
4781 puValue,
4782 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004783
4784 if(pMe->uLastError == QCBOR_SUCCESS) {
4785 // The above conversion succeeded
4786 return;
4787 }
4788
4789 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4790 // The above conversion failed in a way that code below can't correct
4791 return;
4792 }
4793
Laurence Lundblade93d89472020-10-03 22:30:50 -07004794 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004795}
4796
4797
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004798
4799
Laurence Lundblade9b334962020-08-27 10:55:53 -07004800static QCBORError ConvertDouble(const QCBORItem *pItem,
4801 uint32_t uConvertTypes,
4802 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004803{
4804 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004805 case QCBOR_TYPE_FLOAT:
4806#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4807 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4808 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004809 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004810 *pdValue = (double)pItem->val.fnum;
4811 } else {
4812 return QCBOR_ERR_UNEXPECTED_TYPE;
4813 }
4814 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004815#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004816 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004817#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004818 break;
4819
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004820 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004821 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4822 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004823 *pdValue = pItem->val.dfnum;
4824 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004825 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004826 }
4827 }
4828 break;
4829
4830 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004831#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004832 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004833 // A simple cast seems to do the job with no worry of exceptions.
4834 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004835 *pdValue = (double)pItem->val.int64;
4836
4837 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004838 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004839 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004840#else
4841 return QCBOR_ERR_HW_FLOAT_DISABLED;
4842#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004843 break;
4844
4845 case QCBOR_TYPE_UINT64:
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.
4850 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004851 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004852 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004853 }
4854 break;
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
4859 default:
4860 return QCBOR_ERR_UNEXPECTED_TYPE;
4861 }
4862
4863 return QCBOR_SUCCESS;
4864}
4865
4866
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004867void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004868 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004869 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004870 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004871{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004872 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004873 return;
4874 }
4875
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004876 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004877
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004878 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004879 if(uError) {
4880 pMe->uLastError = (uint8_t)uError;
4881 return;
4882 }
4883
4884 if(pItem) {
4885 *pItem = Item;
4886 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004887
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004888 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004889}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004890
Laurence Lundbladec4537442020-04-14 18:53:22 -07004891
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004892void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4893 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004894 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004895 double *pdValue,
4896 QCBORItem *pItem)
4897{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004898 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004899 if(pMe->uLastError != QCBOR_SUCCESS) {
4900 return;
4901 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004902
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004903 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004904}
4905
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004906
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004907void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4908 const char * szLabel,
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{
4913 if(pMe->uLastError != QCBOR_SUCCESS) {
4914 return;
4915 }
4916
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004917 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004918 if(pMe->uLastError != QCBOR_SUCCESS) {
4919 return;
4920 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004921
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004922 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004923}
4924
4925
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004926#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004927static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4928{
4929 double dResult;
4930
4931 dResult = 0.0;
4932 const uint8_t *pByte = BigNum.ptr;
4933 size_t uLen = BigNum.len;
4934 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07004935 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004936 while(uLen--) {
4937 dResult = (dResult * 256.0) + (double)*pByte++;
4938 }
4939
4940 return dResult;
4941}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004942#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4943
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004944
Laurence Lundblade93d89472020-10-03 22:30:50 -07004945static QCBORError
4946DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004947{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004948#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004949 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004950 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4951
4952 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004953 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004954
4955#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004956 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004957 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004958 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004959 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4960 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4961 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004962 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004963 }
4964 break;
4965
4966 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004967 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004968 // Underflow gives 0, overflow gives infinity
4969 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4970 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004971 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004972 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004973 }
4974 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004975#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004976
4977 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004978 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004979 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4980 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004981 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004982 }
4983 break;
4984
4985 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004986 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004987 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004988 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004989 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004990 }
4991 break;
4992
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004993#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004994 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004995 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004996 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4997 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4998 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004999 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005000 }
5001 break;
5002
5003 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005004 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005005 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5006 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5007 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005008 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005009 }
5010 break;
5011
5012 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005013 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005014 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5015 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5016 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005017 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005018 }
5019 break;
5020
5021 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005022 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005023 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005024 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5025 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005026 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005027 }
5028 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005029#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
5030
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005031 default:
5032 return QCBOR_ERR_UNEXPECTED_TYPE;
5033 }
5034
5035 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005036
5037#else
5038 (void)pItem;
5039 (void)uConvertTypes;
5040 (void)pdValue;
5041 return QCBOR_ERR_HW_FLOAT_DISABLED;
5042#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5043
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005044}
5045
5046
5047/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005048 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005049*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005050void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5051 uint32_t uConvertTypes,
5052 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005053{
5054
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005055 QCBORItem Item;
5056
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005057 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005058
5059 if(pMe->uLastError == QCBOR_SUCCESS) {
5060 // The above conversion succeeded
5061 return;
5062 }
5063
5064 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5065 // The above conversion failed in a way that code below can't correct
5066 return;
5067 }
5068
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005069 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005070}
5071
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005072
5073/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005074 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005075*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005076void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5077 int64_t nLabel,
5078 uint32_t uConvertTypes,
5079 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005080{
5081 QCBORItem Item;
5082
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005083 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005084
5085 if(pMe->uLastError == QCBOR_SUCCESS) {
5086 // The above conversion succeeded
5087 return;
5088 }
5089
5090 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5091 // The above conversion failed in a way that code below can't correct
5092 return;
5093 }
5094
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005095 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005096}
5097
5098
5099/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005100 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005101*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005102void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5103 const char *szLabel,
5104 uint32_t uConvertTypes,
5105 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005106{
5107 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005108 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005109
5110 if(pMe->uLastError == QCBOR_SUCCESS) {
5111 // The above conversion succeeded
5112 return;
5113 }
5114
5115 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5116 // The above conversion failed in a way that code below can't correct
5117 return;
5118 }
5119
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005120 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005121}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005122
5123
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005124
5125
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005126#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005127static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5128{
5129 while((uInt & 0xff00000000000000UL) == 0) {
5130 uInt = uInt << 8;
5131 };
5132
5133 UsefulOutBuf UOB;
5134
5135 UsefulOutBuf_Init(&UOB, Buffer);
5136
5137 while(uInt) {
5138 const uint64_t xx = uInt & 0xff00000000000000UL;
5139 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5140 uInt = uInt << 8;
5141 (void)xx;
5142 }
5143
5144 return UsefulOutBuf_OutUBuf(&UOB);
5145}
5146
5147
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005148static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5149 TagSpecification TagSpec,
5150 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005151{
5152 QCBORError uErr;
5153 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005154 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005155 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005156 if(uErr != QCBOR_SUCCESS) {
5157 goto Done;
5158 }
5159
5160 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5161 break; // Successful exit. Moving on to finish decoding.
5162 }
5163
5164 // The item is an array, which means an undecoded
5165 // mantissa and exponent, so decode it. It will then
5166 // have a different type and exit the loop if.
5167 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5168 if(uErr != QCBOR_SUCCESS) {
5169 goto Done;
5170 }
5171
5172 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005173 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005174 }
5175Done:
5176 return uErr;
5177}
5178
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005179
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005180static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005181 TagSpecification TagSpec,
5182 QCBORItem *pItem,
5183 int64_t *pnMantissa,
5184 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005185{
5186 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005187
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005188 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005189 if(uErr != QCBOR_SUCCESS) {
5190 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005191 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005192
Laurence Lundblade9b334962020-08-27 10:55:53 -07005193 switch (pItem->uDataType) {
5194
5195 case QCBOR_TYPE_DECIMAL_FRACTION:
5196 case QCBOR_TYPE_BIGFLOAT:
5197 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5198 *pnExponent = pItem->val.expAndMantissa.nExponent;
5199 break;
5200
5201 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5202 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5203 *pnExponent = pItem->val.expAndMantissa.nExponent;
5204 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5205 break;
5206
5207 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5208 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5209 *pnExponent = pItem->val.expAndMantissa.nExponent;
5210 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5211 break;
5212
5213 default:
5214 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5215 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005216
5217 Done:
5218 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005219}
5220
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005221
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005222static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005223 TagSpecification TagSpec,
5224 QCBORItem *pItem,
5225 UsefulBuf BufferForMantissa,
5226 UsefulBufC *pMantissa,
5227 bool *pbIsNegative,
5228 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005229{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005230 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005231
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005232 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005233 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005234 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005235 }
5236
5237 uint64_t uMantissa;
5238
5239 switch (pItem->uDataType) {
5240
5241 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005242 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005243 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5244 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5245 *pbIsNegative = false;
5246 } else {
5247 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5248 *pbIsNegative = true;
5249 }
5250 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5251 *pnExponent = pItem->val.expAndMantissa.nExponent;
5252 break;
5253
5254 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005255 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005256 *pnExponent = pItem->val.expAndMantissa.nExponent;
5257 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5258 *pbIsNegative = false;
5259 break;
5260
5261 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005262 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005263 *pnExponent = pItem->val.expAndMantissa.nExponent;
5264 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5265 *pbIsNegative = true;
5266 break;
5267
5268 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005269 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005270 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005271
5272Done:
5273 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005274}
5275
5276
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005277/*
5278 Public function, see header qcbor/qcbor_decode.h file
5279*/
5280void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5281 uint8_t uTagRequirement,
5282 int64_t *pnMantissa,
5283 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005284{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005285 if(pMe->uLastError != QCBOR_SUCCESS) {
5286 return;
5287 }
5288
5289 QCBORItem Item;
5290 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5291 if(uError) {
5292 pMe->uLastError = (uint8_t)uError;
5293 return;
5294 }
5295
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005296 const TagSpecification TagSpec =
5297 {
5298 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005299 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5300 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5301 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005302 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005303
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005304 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005305}
5306
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005307
5308/*
5309 Public function, see header qcbor/qcbor_decode.h file
5310*/
5311void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005312 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005313 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005314 int64_t *pnMantissa,
5315 int64_t *pnExponent)
5316{
5317 if(pMe->uLastError != QCBOR_SUCCESS) {
5318 return;
5319 }
5320
5321 QCBORItem Item;
5322 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5323
5324 const TagSpecification TagSpec =
5325 {
5326 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005327 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5328 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5329 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005330 };
5331
5332 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5333}
5334
5335
5336/*
5337 Public function, see header qcbor/qcbor_decode.h file
5338*/
5339void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005340 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005341 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005342 int64_t *pnMantissa,
5343 int64_t *pnExponent)
5344{
5345 if(pMe->uLastError != QCBOR_SUCCESS) {
5346 return;
5347 }
5348
5349 QCBORItem Item;
5350 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5351
5352 const TagSpecification TagSpec =
5353 {
5354 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005355 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5356 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5357 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005358 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005359
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005360 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5361}
5362
5363
5364/*
5365 Public function, see header qcbor/qcbor_decode.h file
5366*/
5367void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5368 uint8_t uTagRequirement,
5369 UsefulBuf MantissaBuffer,
5370 UsefulBufC *pMantissa,
5371 bool *pbMantissaIsNegative,
5372 int64_t *pnExponent)
5373{
5374 if(pMe->uLastError != QCBOR_SUCCESS) {
5375 return;
5376 }
5377
5378 QCBORItem Item;
5379 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5380 if(uError) {
5381 pMe->uLastError = (uint8_t)uError;
5382 return;
5383 }
5384
5385 const TagSpecification TagSpec =
5386 {
5387 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005388 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5389 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5390 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005391 };
5392
Laurence Lundblade93d89472020-10-03 22:30:50 -07005393 ProcessMantissaAndExponentBig(pMe,
5394 TagSpec,
5395 &Item,
5396 MantissaBuffer,
5397 pMantissa,
5398 pbMantissaIsNegative,
5399 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005400}
5401
5402
5403/*
5404 Public function, see header qcbor/qcbor_decode.h file
5405*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005406void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005407 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005408 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005409 UsefulBuf BufferForMantissa,
5410 UsefulBufC *pMantissa,
5411 bool *pbIsNegative,
5412 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005413{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005414 if(pMe->uLastError != QCBOR_SUCCESS) {
5415 return;
5416 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005417
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005418 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005419 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005420 if(pMe->uLastError != QCBOR_SUCCESS) {
5421 return;
5422 }
5423
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005424 const TagSpecification TagSpec =
5425 {
5426 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005427 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5428 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5429 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005430 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005431
Laurence Lundblade93d89472020-10-03 22:30:50 -07005432 ProcessMantissaAndExponentBig(pMe,
5433 TagSpec,
5434 &Item,
5435 BufferForMantissa,
5436 pMantissa,
5437 pbIsNegative,
5438 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005439}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005440
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005441
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005442/*
5443 Public function, see header qcbor/qcbor_decode.h file
5444*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005445void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005446 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005447 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005448 UsefulBuf BufferForMantissa,
5449 UsefulBufC *pMantissa,
5450 bool *pbIsNegative,
5451 int64_t *pnExponent)
5452{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005453 if(pMe->uLastError != QCBOR_SUCCESS) {
5454 return;
5455 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005456
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005457 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005458 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5459 if(pMe->uLastError != QCBOR_SUCCESS) {
5460 return;
5461 }
5462
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005463 const TagSpecification TagSpec =
5464 {
5465 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005466 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5467 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5468 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005469 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005470
5471 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5472}
5473
5474
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005475/*
5476 Public function, see header qcbor/qcbor_decode.h file
5477*/
5478void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5479 uint8_t uTagRequirement,
5480 int64_t *pnMantissa,
5481 int64_t *pnExponent)
5482{
5483 if(pMe->uLastError != QCBOR_SUCCESS) {
5484 return;
5485 }
5486
5487 QCBORItem Item;
5488 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5489 if(uError) {
5490 pMe->uLastError = (uint8_t)uError;
5491 return;
5492 }
5493 const TagSpecification TagSpec =
5494 {
5495 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005496 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5497 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5498 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005499 };
5500
5501 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5502}
5503
5504
5505/*
5506 Public function, see header qcbor/qcbor_decode.h file
5507*/
5508void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005509 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005510 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005511 int64_t *pnMantissa,
5512 int64_t *pnExponent)
5513{
5514 if(pMe->uLastError != QCBOR_SUCCESS) {
5515 return;
5516 }
5517
5518 QCBORItem Item;
5519 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5520 if(pMe->uLastError != QCBOR_SUCCESS) {
5521 return;
5522 }
5523
5524 const TagSpecification TagSpec =
5525 {
5526 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005527 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5528 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5529 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005530 };
5531
5532 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5533}
5534
5535
5536/*
5537 Public function, see header qcbor/qcbor_decode.h file
5538*/
5539void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005540 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005541 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005542 int64_t *pnMantissa,
5543 int64_t *pnExponent)
5544{
5545 if(pMe->uLastError != QCBOR_SUCCESS) {
5546 return;
5547 }
5548
5549 QCBORItem Item;
5550 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5551 if(pMe->uLastError != QCBOR_SUCCESS) {
5552 return;
5553 }
5554
5555 const TagSpecification TagSpec =
5556 {
5557 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005558 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5559 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5560 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005561 };
5562
5563 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5564}
5565
5566
5567/*
5568 Public function, see header qcbor/qcbor_decode.h file
5569*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005570void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5571 uint8_t uTagRequirement,
5572 UsefulBuf MantissaBuffer,
5573 UsefulBufC *pMantissa,
5574 bool *pbMantissaIsNegative,
5575 int64_t *pnExponent)
5576{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005577 if(pMe->uLastError != QCBOR_SUCCESS) {
5578 return;
5579 }
5580
5581 QCBORItem Item;
5582 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5583 if(uError) {
5584 pMe->uLastError = (uint8_t)uError;
5585 return;
5586 }
5587
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005588 const TagSpecification TagSpec =
5589 {
5590 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005591 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5592 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5593 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005594 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005595
5596 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005597}
5598
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005599
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005600/*
5601 Public function, see header qcbor/qcbor_decode.h file
5602*/
5603void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005604 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005605 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005606 UsefulBuf BufferForMantissa,
5607 UsefulBufC *pMantissa,
5608 bool *pbIsNegative,
5609 int64_t *pnExponent)
5610{
5611 if(pMe->uLastError != QCBOR_SUCCESS) {
5612 return;
5613 }
5614
5615 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005616 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5617 if(pMe->uLastError != QCBOR_SUCCESS) {
5618 return;
5619 }
5620
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005621 const TagSpecification TagSpec =
5622 {
5623 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005624 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5625 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5626 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005627 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005628
Laurence Lundblade93d89472020-10-03 22:30:50 -07005629 ProcessMantissaAndExponentBig(pMe,
5630 TagSpec,
5631 &Item,
5632 BufferForMantissa,
5633 pMantissa,
5634 pbIsNegative,
5635 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005636}
5637
5638
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005639/*
5640 Public function, see header qcbor/qcbor_decode.h file
5641*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005642void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005643 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005644 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005645 UsefulBuf BufferForMantissa,
5646 UsefulBufC *pMantissa,
5647 bool *pbIsNegative,
5648 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005649{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005650 if(pMe->uLastError != QCBOR_SUCCESS) {
5651 return;
5652 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005653
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005654 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005655 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5656 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005657 return;
5658 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005659
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005660 const TagSpecification TagSpec =
5661 {
5662 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005663 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5664 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5665 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005666 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005667
Laurence Lundblade93d89472020-10-03 22:30:50 -07005668 ProcessMantissaAndExponentBig(pMe,
5669 TagSpec,
5670 &Item,
5671 BufferForMantissa,
5672 pMantissa,
5673 pbIsNegative,
5674 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005675}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005676
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005677#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */