blob: e268763bbddaa8f33ac2953b7a3ed7442154f656 [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/*
1965 Decode decimal fractions and big floats.
1966
1967 When called pDecodedItem must be the array that is tagged as a big
1968 float or decimal fraction, the array that has the two members, the
1969 exponent and mantissa.
1970
1971 This will fetch and decode the exponent and mantissa and put the
1972 result back into pDecodedItem.
1973 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07001974static inline QCBORError
Laurence Lundblade59289e52019-12-30 13:44:37 -08001975QCBORDecode_MantissaAndExponent(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
1976{
1977 QCBORError nReturn;
1978
1979 // --- Make sure it is an array; track nesting level of members ---
1980 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
1981 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
1982 goto Done;
1983 }
1984
1985 // A check for pDecodedItem->val.uCount == 2 would work for
Laurence Lundbladeee851742020-01-08 08:37:05 -08001986 // definite length arrays, but not for indefnite. Instead remember
1987 // the nesting level the two integers must be at, which is one
1988 // deeper than that of the array.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001989 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
1990
1991 // --- Is it a decimal fraction or a bigfloat? ---
1992 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(me, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
1993 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
1994
1995 // --- Get the exponent ---
1996 QCBORItem exponentItem;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001997 nReturn = QCBORDecode_GetNextMapOrArray(me, &exponentItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08001998 if(nReturn != QCBOR_SUCCESS) {
1999 goto Done;
2000 }
2001 if(exponentItem.uNestingLevel != nNestLevel) {
2002 // Array is empty or a map/array encountered when expecting an int
2003 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
2004 goto Done;
2005 }
2006 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
2007 // Data arriving as an unsigned int < INT64_MAX has been converted
2008 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
2009 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
2010 // will be too large for this to handle and thus an error that will
2011 // get handled in the next else.
2012 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2013 } else {
2014 // Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX
2015 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
2016 goto Done;
2017 }
2018
2019 // --- Get the mantissa ---
2020 QCBORItem mantissaItem;
2021 nReturn = QCBORDecode_GetNextWithTags(me, &mantissaItem, NULL);
2022 if(nReturn != QCBOR_SUCCESS) {
2023 goto Done;
2024 }
2025 if(mantissaItem.uNestingLevel != nNestLevel) {
2026 // Mantissa missing or map/array encountered when expecting number
2027 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
2028 goto Done;
2029 }
2030 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
2031 // Data arriving as an unsigned int < INT64_MAX has been converted
2032 // to QCBOR_TYPE_INT64 and thus handled here. This is also means
2033 // that the only data arriving here of type QCBOR_TYPE_UINT64 data
2034 // will be too large for this to handle and thus an error that
2035 // will get handled in an else below.
2036 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002037 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2038 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002039 // Got a good big num mantissa
2040 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
2041 // Depends on numbering of QCBOR_TYPE_XXX
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002042 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2043 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2044 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002045 } else {
2046 // Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX
2047 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
2048 goto Done;
2049 }
2050
2051 // --- Check that array only has the two numbers ---
2052 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07002053 // Extra items in the decimal fraction / big float
Laurence Lundblade59289e52019-12-30 13:44:37 -08002054 nReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
2055 goto Done;
2056 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002057 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002058
2059Done:
Laurence Lundblade59289e52019-12-30 13:44:37 -08002060 return nReturn;
2061}
2062#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
2063
2064
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002065static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002066{
2067 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2068 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002069 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002070 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2071 } else {
2072 return QCBOR_ERR_BAD_OPT_TAG;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002073
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002074 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002075
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002076 return QCBOR_SUCCESS;
2077}
2078
2079
Laurence Lundblade99615302020-11-29 11:19:47 -08002080/*
2081 * Table of CBOR tags whose content is either a text string or a byte
2082 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2083 * of uQCBORtype indicates the content should be a byte string rather
2084 * than a text string
2085 */
2086struct StringTagMapEntry {
2087 uint16_t uTagNumber;
2088 uint8_t uQCBORtype;
2089};
2090
2091#define IS_BYTE_STRING_BIT 0x80
2092#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2093
2094static const struct StringTagMapEntry StringTagMap[] = {
2095 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
2096 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2097 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2098 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2099 {CBOR_TAG_URI, QCBOR_TYPE_URI},
2100 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2101 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2102 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2103 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
2104 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2105 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2106};
2107
2108
2109/*
2110 * Process the CBOR tags that whose content is a byte string or a text
2111 * string and for which the string is just passed on to the caller.
2112 *
2113 * This maps the CBOR tag to the QCBOR type and checks the content
2114 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002115 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002116 * possible.
2117 *
2118 * This returns QCBOR_SUCCESS if the tag was procssed,
2119 * QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2120 * QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2121 */
2122static inline
2123QCBORError ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002124{
Laurence Lundblade99615302020-11-29 11:19:47 -08002125 /* This only works on tags that were not mapped; no need for other yet */
2126 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2127 return QCBOR_ERR_UNSUPPORTED;
2128 }
2129
2130 unsigned uIndex;
2131 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2132 if(StringTagMap[uIndex].uTagNumber == uTag) {
2133 break;
2134 }
2135 }
2136
2137 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2138 if(uQCBORType == QCBOR_TYPE_NONE) {
2139 /* repurpose this error to mean, not handled here */
2140 return QCBOR_ERR_UNSUPPORTED;
2141 }
2142
2143 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2144 if(uQCBORType & IS_BYTE_STRING_BIT) {
2145 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2146 }
2147
2148 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002149 return QCBOR_ERR_BAD_OPT_TAG;
2150 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002151
Laurence Lundblade99615302020-11-29 11:19:47 -08002152 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002153 return QCBOR_SUCCESS;
2154}
2155
2156
Laurence Lundblade59289e52019-12-30 13:44:37 -08002157/*
Laurence Lundblade99615302020-11-29 11:19:47 -08002158 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2159 * but the whole tag was not decoded. Here, the whole tags (tag number
2160 * and tag content) that are supported by QCBOR are decoded. This is a
2161 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002162 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002163static QCBORError
2164QCBORDecode_GetNextTag(QCBORDecodeContext *me, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002165{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002166 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002167
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002168 uReturn = QCBORDecode_GetNextMapOrArray(me, pDecodedItem);
2169 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002170 goto Done;
2171 }
2172
Laurence Lundblade99615302020-11-29 11:19:47 -08002173 /* When there are no tag numbers for the item, this exits first
2174 * thing and effectively does nothing.
2175 *
2176 * This loops over all the tag numbers accumulated for this item
2177 * trying to decode and interpret them. This stops at the end of
2178 * the list or at the first tag number that can't be interpreted by
2179 * this code. This is effectively a recursive processing of the
2180 * tags number list that handles nested tags.
2181 */
2182 while(1) {
2183 /* Don't bother to unmap tags via QCBORITem.uTags since this
2184 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2185 */
2186 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002187
Laurence Lundblade99615302020-11-29 11:19:47 -08002188 if(uTagToProcess == CBOR_TAG_INVALID16) {
2189 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002190 break;
2191
Laurence Lundblade99615302020-11-29 11:19:47 -08002192 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002193 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002194
Laurence Lundblade93d89472020-10-03 22:30:50 -07002195#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002196 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2197 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002198 uReturn = QCBORDecode_MantissaAndExponent(me, pDecodedItem);
Laurence Lundblade93d89472020-10-03 22:30:50 -07002199#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002200
Laurence Lundblade99615302020-11-29 11:19:47 -08002201 } else if(uTagToProcess == CBOR_TAG_MIME ||
2202 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002203 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002204
Laurence Lundblade99615302020-11-29 11:19:47 -08002205 } else {
2206 /* See if it is a pass-through byte/text string tag; process if so */
2207 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002208
Laurence Lundblade99615302020-11-29 11:19:47 -08002209 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2210 /* It wasn't a pass-through byte/text string tag so it is
2211 * an unknown tag. This is the exit from the loop on the
2212 * first unknown tag. It is a successful exit.
2213 */
2214 uReturn = QCBOR_SUCCESS;
2215 break;
2216 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002217 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002218
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002219 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002220 /* Error exit from the loop */
2221 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002222 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002223
2224 /* A tag was successfully processed, shift it out of the list of
2225 * tags returned. This is the loop increment.
2226 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002227 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002228 }
2229
2230Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002231 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002232}
2233
2234
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002235/*
2236 Public function, see header qcbor/qcbor_decode.h file
2237 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002238QCBORError
2239QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2240{
2241 QCBORError uErr;
2242 uErr = QCBORDecode_GetNextTag(pMe, pDecodedItem);
2243 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002244 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2245 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2246 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002247 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002248}
2249
2250
2251/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002252 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002253 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002254QCBORError
2255QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2256{
2257 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2258 const UsefulInputBuf Save = pMe->InBuf;
2259
2260 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2261
2262 pMe->nesting = SaveNesting;
2263 pMe->InBuf = Save;
2264
2265 return uErr;
2266}
2267
2268
2269/*
2270 Public function, see header qcbor/qcbor_decode.h file
2271 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002272void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2273{
2274 if(pMe->uLastError != QCBOR_SUCCESS) {
2275 return;
2276 }
2277
2278 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2279}
2280
2281
2282/*
2283 Public function, see header qcbor/qcbor_decode.h file
2284 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002285QCBORError
2286QCBORDecode_GetNextWithTags(QCBORDecodeContext *me,
2287 QCBORItem *pDecodedItem,
2288 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002289{
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002290 QCBORError nReturn;
2291
2292 nReturn = QCBORDecode_GetNext(me, pDecodedItem);
2293 if(nReturn != QCBOR_SUCCESS) {
2294 return nReturn;
2295 }
2296
2297 if(pTags != NULL) {
2298 pTags->uNumUsed = 0;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002299 // Reverse the order because pTags is reverse of
2300 // QCBORItem.uTags.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002301 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2302 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002303 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002304 }
2305 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2306 return QCBOR_ERR_TOO_MANY_TAGS;
2307 }
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002308 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(me,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002309 pTags->uNumUsed++;
2310 }
2311 }
2312
2313 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002314}
2315
2316
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302317
2318/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002319 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002320 */
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002321bool QCBORDecode_IsTagged(QCBORDecodeContext *me,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002322 const QCBORItem *pItem,
2323 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002324{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002325 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2326 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002327 break;
2328 }
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002329 if(UnMapTagNumber(me, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002330 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002331 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002332 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002333
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002334 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002335}
2336
2337
2338/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002339 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002340 */
Laurence Lundblade30816f22018-11-10 13:40:22 +07002341QCBORError QCBORDecode_Finish(QCBORDecodeContext *me)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002342{
Laurence Lundblade085d7952020-07-24 10:26:30 -07002343 QCBORError uReturn = me->uLastError;
2344
2345 if(uReturn != QCBOR_SUCCESS) {
2346 goto Done;
2347 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002348
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002349 // Error out if all the maps/arrays are not closed out
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002350 if(!DecodeNesting_IsCurrentAtTop(&(me->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002351 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002352 goto Done;
2353 }
2354
2355 // Error out if not all the bytes are consumed
2356 if(UsefulInputBuf_BytesUnconsumed(&(me->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002357 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002358 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002359
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002360Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002361#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade6de37062018-10-15 12:22:42 +05302362 // Call the destructor for the string allocator if there is one.
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002363 // Always called, even if there are errors; always have to clean up
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002364 StringAllocator_Destruct(&(me->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002365#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002366
Laurence Lundblade085d7952020-07-24 10:26:30 -07002367 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002368}
2369
2370
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002371/*
Laurence Lundblade9b334962020-08-27 10:55:53 -07002372 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002373*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07002374// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002375uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2376 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002377 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002378{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002379 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2380 return CBOR_TAG_INVALID64;
2381 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002382 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2383 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002384 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002385 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002386 }
2387}
2388
Laurence Lundblade9b334962020-08-27 10:55:53 -07002389/*
2390 Public function, see header qcbor/qcbor_decode.h file
2391*/
2392uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2393 uint32_t uIndex)
2394{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002395 if(pMe->uLastError != QCBOR_SUCCESS) {
2396 return CBOR_TAG_INVALID64;
2397 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002398 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2399 return CBOR_TAG_INVALID64;
2400 } else {
Laurence Lundblade25403ed2021-01-02 16:28:07 -08002401 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002402 }
2403}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002404
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002405/*
2406
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002407Decoder errors handled in this file
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002408
Laurence Lundbladeee851742020-01-08 08:37:05 -08002409 - Hit end of input before it was expected while decoding type and
2410 number QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002411
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002412 - negative integer that is too large for C QCBOR_ERR_INT_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002413
Laurence Lundbladeee851742020-01-08 08:37:05 -08002414 - Hit end of input while decoding a text or byte string
2415 QCBOR_ERR_HIT_END
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002416
Laurence Lundbladeee851742020-01-08 08:37:05 -08002417 - Encountered conflicting tags -- e.g., an item is tagged both a date
2418 string and an epoch date QCBOR_ERR_UNSUPPORTED
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002419
Laurence Lundbladeee851742020-01-08 08:37:05 -08002420 - Encontered an array or mapp that has too many items
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002421 QCBOR_ERR_ARRAY_DECODE_TOO_LONG
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002422
Laurence Lundbladeee851742020-01-08 08:37:05 -08002423 - Encountered array/map nesting that is too deep
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002424 QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002425
Laurence Lundbladeee851742020-01-08 08:37:05 -08002426 - An epoch date > INT64_MAX or < INT64_MIN was encountered
2427 QCBOR_ERR_DATE_OVERFLOW
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002428
Laurence Lundbladeee851742020-01-08 08:37:05 -08002429 - The type of a map label is not a string or int
2430 QCBOR_ERR_MAP_LABEL_TYPE
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002431
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002432 - Hit end with arrays or maps still open -- QCBOR_ERR_EXTRA_BYTES
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002433
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002434 */
2435
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002436
2437
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002438#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002439
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002440/* ===========================================================================
2441 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002442
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002443 This implements a simple sting allocator for indefinite length
2444 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2445 implements the function type QCBORStringAllocate and allows easy
2446 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002447
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002448 This particular allocator is built-in for convenience. The caller
2449 can implement their own. All of this following code will get
2450 dead-stripped if QCBORDecode_SetMemPool() is not called.
2451
2452 This is a very primitive memory allocator. It does not track
2453 individual allocations, only a high-water mark. A free or
2454 reallocation must be of the last chunk allocated.
2455
2456 The size of the pool and offset to free memory are packed into the
2457 first 8 bytes of the memory pool so we don't have to keep them in
2458 the decode context. Since the address of the pool may not be
2459 aligned, they have to be packed and unpacked as if they were
2460 serialized data of the wire or such.
2461
2462 The sizes packed in are uint32_t to be the same on all CPU types
2463 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002464 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002465
2466
Laurence Lundbladeee851742020-01-08 08:37:05 -08002467static inline int
2468MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002469{
2470 // Use of UsefulInputBuf is overkill, but it is convenient.
2471 UsefulInputBuf UIB;
2472
Laurence Lundbladeee851742020-01-08 08:37:05 -08002473 // Just assume the size here. It was checked during SetUp so
2474 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002475 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002476 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2477 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2478 return UsefulInputBuf_GetError(&UIB);
2479}
2480
2481
Laurence Lundbladeee851742020-01-08 08:37:05 -08002482static inline int
2483MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002484{
2485 // Use of UsefulOutBuf is overkill, but convenient. The
2486 // length check performed here is useful.
2487 UsefulOutBuf UOB;
2488
2489 UsefulOutBuf_Init(&UOB, Pool);
2490 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2491 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2492 return UsefulOutBuf_GetError(&UOB);
2493}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002494
2495
2496/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002497 Internal function for an allocation, reallocation free and destuct.
2498
2499 Having only one function rather than one each per mode saves space in
2500 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002501
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002502 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2503 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002504static UsefulBuf
2505MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002506{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002507 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002508
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002509 uint32_t uPoolSize;
2510 uint32_t uFreeOffset;
2511
2512 if(uNewSize > UINT32_MAX) {
2513 // This allocator is only good up to 4GB. This check should
2514 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2515 goto Done;
2516 }
2517 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2518
2519 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2520 goto Done;
2521 }
2522
2523 if(uNewSize) {
2524 if(pMem) {
2525 // REALLOCATION MODE
2526 // Calculate pointer to the end of the memory pool. It is
2527 // assumed that pPool + uPoolSize won't wrap around by
2528 // assuming the caller won't pass a pool buffer in that is
2529 // not in legitimate memory space.
2530 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2531
2532 // Check that the pointer for reallocation is in the range of the
2533 // pool. This also makes sure that pointer math further down
2534 // doesn't wrap under or over.
2535 if(pMem >= pPool && pMem < pPoolEnd) {
2536 // Offset to start of chunk for reallocation. This won't
2537 // wrap under because of check that pMem >= pPool. Cast
2538 // is safe because the pool is always less than UINT32_MAX
2539 // because of check in QCBORDecode_SetMemPool().
2540 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2541
2542 // Check to see if the allocation will fit. uPoolSize -
2543 // uMemOffset will not wrap under because of check that
2544 // pMem is in the range of the uPoolSize by check above.
2545 if(uNewSize <= uPoolSize - uMemOffset) {
2546 ReturnValue.ptr = pMem;
2547 ReturnValue.len = uNewSize;
2548
2549 // Addition won't wrap around over because uNewSize was
2550 // checked to be sure it is less than the pool size.
2551 uFreeOffset = uMemOffset + uNewSize32;
2552 }
2553 }
2554 } else {
2555 // ALLOCATION MODE
2556 // uPoolSize - uFreeOffset will not underflow because this
2557 // pool implementation makes sure uFreeOffset is always
2558 // smaller than uPoolSize through this check here and
2559 // reallocation case.
2560 if(uNewSize <= uPoolSize - uFreeOffset) {
2561 ReturnValue.len = uNewSize;
2562 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002563 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002564 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002565 }
2566 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002567 if(pMem) {
2568 // FREE MODE
2569 // Cast is safe because of limit on pool size in
2570 // QCBORDecode_SetMemPool()
2571 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2572 } else {
2573 // DESTRUCT MODE
2574 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002575 }
2576 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002577
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002578 UsefulBuf Pool = {pPool, uPoolSize};
2579 MemPool_Pack(Pool, uFreeOffset);
2580
2581Done:
2582 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002583}
2584
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002585
Laurence Lundbladef6531662018-12-04 10:42:22 +09002586/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002587 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002588 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002589QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2590 UsefulBuf Pool,
2591 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002592{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002593 // The pool size and free mem offset are packed into the beginning
2594 // of the pool memory. This compile time check make sure the
2595 // constant in the header is correct. This check should optimize
2596 // down to nothing.
2597 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002598 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002599 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002600
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002601 // The pool size and free offset packed in to the beginning of pool
2602 // memory are only 32-bits. This check will optimize out on 32-bit
2603 // machines.
2604 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002605 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002606 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002607
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002608 // This checks that the pool buffer given is big enough.
2609 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002610 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002611 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002612
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002613 pMe->StringAllocator.pfAllocator = MemPool_Function;
2614 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2615 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002616
Laurence Lundblade30816f22018-11-10 13:40:22 +07002617 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002618}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002619#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002620
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002621
2622
Laurence Lundblade9b334962020-08-27 10:55:53 -07002623static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2624{
2625 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2626}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002627
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002628
2629/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002630 Consume an entire map or array (and do next to
2631 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002632 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002633static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002634ConsumeItem(QCBORDecodeContext *pMe,
2635 const QCBORItem *pItemToConsume,
2636 uint_fast8_t *puNextNestLevel)
2637{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002638 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002639 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002640
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002641 // If it is a map or array, this will tell if it is empty.
2642 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2643
2644 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2645 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002646
Laurence Lundblade1341c592020-04-11 14:19:05 -07002647 /* This works for definite and indefinite length
2648 * maps and arrays by using the nesting level
2649 */
2650 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002651 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002652 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002653 goto Done;
2654 }
2655 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002656
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002657 *puNextNestLevel = Item.uNextNestLevel;
2658
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002659 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002660
Laurence Lundblade1341c592020-04-11 14:19:05 -07002661 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002662 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002663 /* Just pass the nesting level through */
2664 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2665
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002666 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002667 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002668
2669Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002670 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002671}
2672
2673
Laurence Lundblade1341c592020-04-11 14:19:05 -07002674/* Return true if the labels in Item1 and Item2 are the same.
2675 Works only for integer and string labels. Returns false
2676 for any other type. */
2677static inline bool
2678MatchLabel(QCBORItem Item1, QCBORItem Item2)
2679{
2680 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2681 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2682 return true;
2683 }
2684 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002685 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002686 return true;
2687 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002688 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002689 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2690 return true;
2691 }
2692 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2693 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2694 return true;
2695 }
2696 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002697
Laurence Lundblade1341c592020-04-11 14:19:05 -07002698 /* Other label types are never matched */
2699 return false;
2700}
2701
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002702
2703/*
2704 Returns true if Item1 and Item2 are the same type
2705 or if either are of QCBOR_TYPE_ANY.
2706 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002707static inline bool
2708MatchType(QCBORItem Item1, QCBORItem Item2)
2709{
2710 if(Item1.uDataType == Item2.uDataType) {
2711 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002712 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002713 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002714 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002715 return true;
2716 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002717 return false;
2718}
2719
2720
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002721/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002722 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002723
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002724 @param[in] pMe The decode context to search.
2725 @param[in,out] pItemArray The items to search for and the items found.
2726 @param[out] puOffset Byte offset of last item matched.
2727 @param[in] pCBContext Context for the not-found item call back.
2728 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002729
2730 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2731
Laurence Lundblade93d89472020-10-03 22:30:50 -07002732 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2733 were found for one of the labels being
2734 search for. This duplicate detection is
2735 only performed for items in pItemArray,
2736 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002737
Laurence Lundblade93d89472020-10-03 22:30:50 -07002738 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2739 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002740
2741 @retval Also errors returned by QCBORDecode_GetNext().
2742
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002743 On input pItemArray contains a list of labels and data types
2744 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002745
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002746 On output the fully retrieved items are filled in with
2747 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002748
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002749 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002750
2751 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002752 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002753static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002754MapSearch(QCBORDecodeContext *pMe,
2755 QCBORItem *pItemArray,
2756 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002757 void *pCBContext,
2758 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002759{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002760 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002761 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002762
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002763 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002764 uReturn = pMe->uLastError;
2765 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002766 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002767
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002768 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002769 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2770 /* QCBOR_TYPE_NONE as first item indicates just looking
2771 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002772 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2773 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002774 }
2775
Laurence Lundblade085d7952020-07-24 10:26:30 -07002776 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2777 // It is an empty bounded array or map
2778 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2779 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002780 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002781 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002782 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002783 // Nothing is ever found in an empty array or map. All items
2784 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002785 uReturn = QCBOR_SUCCESS;
2786 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002787 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002788 }
2789
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002790 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002791 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2792
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002793 /* Reposition to search from the start of the map / array */
Laurence Lundblade02625d42020-06-25 14:41:41 -07002794 UsefulInputBuf_Seek(&(pMe->InBuf),
2795 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
Laurence Lundblade1341c592020-04-11 14:19:05 -07002796
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002797 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002798 Loop over all the items in the map or array. Each item
2799 could be a map or array, but label matching is only at
2800 the main level. This handles definite and indefinite
2801 length maps and arrays. The only reason this is ever
2802 called on arrays is to find their end position.
2803
2804 This will always run over all items in order to do
2805 duplicate detection.
2806
2807 This will exit with failure if it encounters an
2808 unrecoverable error, but continue on for recoverable
2809 errors.
2810
2811 If a recoverable error occurs on a matched item, then
2812 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002813 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002814 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002815 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002816 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002817 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002818 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002819
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002820 /* Get the item */
2821 QCBORItem Item;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002822 QCBORError uResult = QCBORDecode_GetNextTag(pMe, &Item);
2823 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002824 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002825 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002826 goto Done;
2827 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002828 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002829 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002830 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002831 goto Done;
2832 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002833
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002834 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002835 bool bMatched = false;
2836 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2837 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002838 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002839 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2840 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002841 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002842 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002843 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002844 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002845 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002846 goto Done;
2847 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002848
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002849 if(uResult != QCBOR_SUCCESS) {
2850 uReturn = uResult;
2851 goto Done;
2852 }
2853
Laurence Lundblade1341c592020-04-11 14:19:05 -07002854 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002855 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002856 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002857 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002858 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002859 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002860 bMatched = true;
2861 }
2862 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002863
2864
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002865 if(!bMatched && pfCallback != NULL) {
2866 /*
2867 Call the callback on unmatched labels.
2868 (It is tempting to do duplicate detection here, but that would
2869 require dynamic memory allocation because the number of labels
2870 that might be encountered is unbounded.)
2871 */
2872 uReturn = (*pfCallback)(pCBContext, &Item);
2873 if(uReturn != QCBOR_SUCCESS) {
2874 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002875 }
2876 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002877
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002878 /*
2879 Consume the item whether matched or not. This
2880 does the work of traversing maps and array and
2881 everything in them. In this loop only the
2882 items at the current nesting level are examined
2883 to match the labels.
2884 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002885 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002886 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002887 goto Done;
2888 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002889
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002890 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002891
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002892 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002893
2894 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002895
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002896 // Check here makes sure that this won't accidentally be
2897 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002898 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08002899 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
2900 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002901 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
2902 goto Done;
2903 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002904 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2905 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002906
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002907 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002908 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2909
2910 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002911 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07002912 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002913 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002914 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
2915 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002916 }
2917 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002918
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002919 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002920}
2921
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002922
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002923/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002924 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002925*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002926void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
2927 int64_t nLabel,
2928 uint8_t uQcborType,
2929 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002930{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002931 if(pMe->uLastError != QCBOR_SUCCESS) {
2932 return;
2933 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002934
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002935 QCBORItem OneItemSeach[2];
2936 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
2937 OneItemSeach[0].label.int64 = nLabel;
2938 OneItemSeach[0].uDataType = uQcborType;
2939 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002940
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002941 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002942
2943 *pItem = OneItemSeach[0];
2944
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002945 if(uReturn != QCBOR_SUCCESS) {
2946 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002947 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002948 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002949 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002950 }
2951
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002952 Done:
2953 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002954}
2955
2956
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002957/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002958 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07002959*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07002960void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
2961 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07002962 uint8_t uQcborType,
2963 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002964{
Laurence Lundbladeda095972020-06-06 18:35:33 -07002965 if(pMe->uLastError != QCBOR_SUCCESS) {
2966 return;
2967 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002968
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002969 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002970 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
2971 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
2972 OneItemSeach[0].uDataType = uQcborType;
2973 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07002974
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002975 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
2976 if(uReturn != QCBOR_SUCCESS) {
2977 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002978 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002979 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002980 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002981 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002982 }
2983
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07002984 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002985
2986Done:
2987 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002988}
2989
2990
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002991
Laurence Lundblade93d89472020-10-03 22:30:50 -07002992static QCBORError
2993CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07002994{
2995 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
2996 if(uDataType == puTypeList[i]) {
2997 return QCBOR_SUCCESS;
2998 }
2999 }
3000 return QCBOR_ERR_UNEXPECTED_TYPE;
3001}
3002
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003003
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003004/**
3005 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003006 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003007
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003008 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3009 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003010
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003011 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3012 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003013 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003014static QCBORError
3015CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003016{
3017 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3018 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3019 /* There are tags that QCBOR couldn't process on this item and
3020 the caller has told us there should not be. */
3021 return QCBOR_ERR_UNEXPECTED_TYPE;
3022 }
3023
3024 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3025 const int nItemType = pItem->uDataType;
3026
3027 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3028 // Must match the tag and only the tag
3029 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3030 }
3031
3032 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3033 if(uReturn == QCBOR_SUCCESS) {
3034 return QCBOR_SUCCESS;
3035 }
3036
3037 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3038 /* Must match the content type and only the content type.
3039 There was no match just above so it is a fail. */
3040 return QCBOR_ERR_UNEXPECTED_TYPE;
3041 }
3042
3043 /* If here it can match either the tag or the content
3044 and it hasn't matched the content, so the end
3045 result is whether it matches the tag. This is
3046 also the case that the CBOR standard discourages. */
3047
3048 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3049}
3050
Laurence Lundblade9b334962020-08-27 10:55:53 -07003051
Laurence Lundblade9b334962020-08-27 10:55:53 -07003052
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003053// This could be semi-private if need be
3054static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003055void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3056 int64_t nLabel,
3057 TagSpecification TagSpec,
3058 QCBORItem *pItem)
3059{
3060 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3061 if(pMe->uLastError != QCBOR_SUCCESS) {
3062 return;
3063 }
3064
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003065 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003066}
3067
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003068
3069// This could be semi-private if need be
3070static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003071void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3072 const char *szLabel,
3073 TagSpecification TagSpec,
3074 QCBORItem *pItem)
3075{
3076 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3077 if(pMe->uLastError != QCBOR_SUCCESS) {
3078 return;
3079 }
3080
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003081 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003082}
3083
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003084// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003085void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3086 int64_t nLabel,
3087 TagSpecification TagSpec,
3088 UsefulBufC *pString)
3089{
3090 QCBORItem Item;
3091 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3092 if(pMe->uLastError == QCBOR_SUCCESS) {
3093 *pString = Item.val.string;
3094 }
3095}
3096
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003097// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003098void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3099 const char * szLabel,
3100 TagSpecification TagSpec,
3101 UsefulBufC *pString)
3102{
3103 QCBORItem Item;
3104 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3105 if(pMe->uLastError == QCBOR_SUCCESS) {
3106 *pString = Item.val.string;
3107 }
3108}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003109
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003110/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003111 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003112*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003113void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003114{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003115 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3116 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003117}
3118
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003119/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003120 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003121*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003122void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3123 QCBORItem *pItemList,
3124 void *pCallbackCtx,
3125 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003126{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003127 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3128 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003129}
3130
3131
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003132/**
3133 * @brief Search for a map/array by label and enter it
3134 *
3135 * @param[in] pMe The decode context.
3136 * @param[in] pSearch The map/array to search for.
3137 *
3138 * @c pSearch is expected to contain one item of type map or array
3139 * with the label specified. The current bounded map will be searched for
3140 * this and if found will be entered.
3141 *
3142 * If the label is not found, or the item found is not a map or array,
3143 * the error state is set.
3144 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003145static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003146{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003147 // The first item in pSearch is the one that is to be
3148 // entered. It should be the only one filled in. Any other
3149 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003150 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003151 return;
3152 }
3153
3154 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003155 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003156 if(pMe->uLastError != QCBOR_SUCCESS) {
3157 return;
3158 }
3159
Laurence Lundblade9b334962020-08-27 10:55:53 -07003160 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003161 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003162 return;
3163 }
3164
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003165 /*
3166 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3167 * next item for the pre-order traversal cursor to be the map/array
3168 * found by MapSearch(). The next few lines of code force the
3169 * cursor to that.
3170 *
3171 * There is no need to retain the old cursor because
3172 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3173 * beginning of the map/array being entered.
3174 *
3175 * The cursor is forced by: 1) setting the input buffer position to
3176 * the item offset found by MapSearch(), 2) setting the map/array
3177 * counter to the total in the map/array, 3) setting the nesting
3178 * level. Setting the map/array counter to the total is not
3179 * strictly correct, but this is OK because this cursor only needs
3180 * to be used to get one item and MapSearch() has already found it
3181 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003182 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003183 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003184
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003185 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3186
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003187 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003188
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003189 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003190}
3191
3192
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003193/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003194 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003195*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003196void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003197{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003198 QCBORItem OneItemSeach[2];
3199 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3200 OneItemSeach[0].label.int64 = nLabel;
3201 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3202 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003203
Laurence Lundblade9b334962020-08-27 10:55:53 -07003204 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003205 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003206}
3207
3208
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003209/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003210 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003211*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003212void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003213{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003214 QCBORItem OneItemSeach[2];
3215 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3216 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3217 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3218 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003219
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003220 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003221}
3222
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003223/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003224 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003225*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003226void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003227{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003228 QCBORItem OneItemSeach[2];
3229 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3230 OneItemSeach[0].label.int64 = nLabel;
3231 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3232 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003233
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003234 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003235}
3236
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003237/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003238 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003239*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003240void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3241{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003242 QCBORItem OneItemSeach[2];
3243 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3244 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3245 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3246 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003247
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003248 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003249}
3250
3251
Laurence Lundblade02625d42020-06-25 14:41:41 -07003252// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003253void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003254{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003255 QCBORError uErr;
3256
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003257 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003258 if(pMe->uLastError != QCBOR_SUCCESS) {
3259 // Already in error state; do nothing.
3260 return;
3261 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003262
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003263 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003264 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003265 uErr = QCBORDecode_GetNext(pMe, &Item);
3266 if(uErr != QCBOR_SUCCESS) {
3267 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003268 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003269 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003270 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3271 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003272 }
3273
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003274 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003275
3276
Laurence Lundbladef0499502020-08-01 11:55:57 -07003277 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003278 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003279 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3280 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003281 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003282 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3283 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003284 // Special case to increment nesting level for zero-length maps
3285 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003286 DecodeNesting_Descend(&(pMe->nesting), uType);
3287 }
3288
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003289 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003290
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003291 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3292 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003293
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003294 if(pItem != NULL) {
3295 *pItem = Item;
3296 }
3297
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003298Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003299 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003300}
3301
Laurence Lundblade02625d42020-06-25 14:41:41 -07003302
3303/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003304 This is the common work for exiting a level that is a bounded map,
3305 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003306
3307 One chunk of work is to set up the pre-order traversal so it is at
3308 the item just after the bounded map, array or bstr that is being
3309 exited. This is somewhat complex.
3310
3311 The other work is to level-up the bounded mode to next higest bounded
3312 mode or the top level if there isn't one.
3313 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003314static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003315ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003316{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003317 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003318
Laurence Lundblade02625d42020-06-25 14:41:41 -07003319 /*
3320 First the pre-order-traversal byte offset is positioned to the
3321 item just after the bounded mode item that was just consumed.
3322 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003323 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3324
Laurence Lundblade02625d42020-06-25 14:41:41 -07003325 /*
3326 Next, set the current nesting level to one above the bounded level
3327 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003328
Laurence Lundblade02625d42020-06-25 14:41:41 -07003329 DecodeNesting_CheckBoundedType() is always called before this and
3330 makes sure pCurrentBounded is valid.
3331 */
3332 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3333
3334 /*
3335 This does the complex work of leveling up the pre-order traversal
3336 when the end of a map or array or another bounded level is
3337 reached. It may do nothing, or ascend all the way to the top
3338 level.
3339 */
Laurence Lundbladed0304932020-06-27 10:59:38 -07003340 uErr = NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003341 if(uErr != QCBOR_SUCCESS) {
3342 goto Done;
3343 }
3344
Laurence Lundblade02625d42020-06-25 14:41:41 -07003345 /*
3346 This makes the next highest bounded level the current bounded
3347 level. If there is no next highest level, then no bounded mode is
3348 in effect.
3349 */
3350 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003351
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003352 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003353
3354Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003355 return uErr;
3356}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003357
Laurence Lundblade02625d42020-06-25 14:41:41 -07003358
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003359// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003360void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003361{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003362 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003363 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003364 return;
3365 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003366
Laurence Lundblade02625d42020-06-25 14:41:41 -07003367 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003368
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003369 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003370 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003371 goto Done;
3372 }
3373
Laurence Lundblade02625d42020-06-25 14:41:41 -07003374 /*
3375 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003376 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003377 from previous map search, then do a dummy search.
3378 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003379 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003380 QCBORItem Dummy;
3381 Dummy.uLabelType = QCBOR_TYPE_NONE;
3382 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3383 if(uErr != QCBOR_SUCCESS) {
3384 goto Done;
3385 }
3386 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003387
Laurence Lundblade02625d42020-06-25 14:41:41 -07003388 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003389
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003390Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003391 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003392}
3393
3394
Laurence Lundblade1341c592020-04-11 14:19:05 -07003395
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003396static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003397 const QCBORItem *pItem,
3398 uint8_t uTagRequirement,
3399 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003400{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003401 if(pBstr) {
3402 *pBstr = NULLUsefulBufC;
3403 }
3404
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003405 if(pMe->uLastError != QCBOR_SUCCESS) {
3406 // Already in error state; do nothing.
3407 return pMe->uLastError;
3408 }
3409
3410 QCBORError uError = QCBOR_SUCCESS;
3411
3412 if(pItem->uDataType != QCBOR_TYPE_BYTE_STRING) {
3413 uError = QCBOR_ERR_UNEXPECTED_TYPE;
3414 goto Done;;
3415 }
3416
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003417 const TagSpecification TagSpec =
3418 {
3419 uTagRequirement,
3420 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3421 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3422 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003423
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003424 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003425 if(uError != QCBOR_SUCCESS) {
3426 goto Done;
3427 }
3428
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003429 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003430 // Reverse the decrement done by GetNext() for the bstr so the
3431 // increment in NestLevelAscender() called by ExitBoundedLevel()
3432 // will work right.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003433 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003434 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003435
3436 if(pBstr) {
3437 *pBstr = pItem->val.string;
3438 }
3439
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003440 // This saves the current length of the UsefulInputBuf and then
3441 // narrows the UsefulInputBuf to start and length of the wrapped
3442 // CBOR that is being entered.
3443 //
3444 // This makes sure the length is less than
3445 // QCBOR_MAX_DECODE_INPUT_SIZE which is slighly less than
3446 // UINT32_MAX. The value UINT32_MAX is used as a special indicator
3447 // value. The checks against QCBOR_MAX_DECODE_INPUT_SIZE also make
3448 // the casts safe. uEndOfBstr will always be less than
3449 // uPreviousLength because of the way UsefulInputBuf works so there
3450 // is no need to check it. There is also a range check in the
3451 // seek.
3452 //
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003453 // Most of these calls are simple inline accessors so this doesn't
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003454 // amount to much code.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003455 // Cast of uPreviousLength to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003456 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003457 if((uint32_t)uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003458 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003459 goto Done;
3460 }
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003461 const size_t uEndOfBstr = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003462 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOfBstr - pItem->val.string.len);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003463 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003464
Laurence Lundblade02625d42020-06-25 14:41:41 -07003465 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003466 (uint32_t)uPreviousLength,
3467 (uint32_t)uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003468Done:
3469 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003470}
3471
3472
Laurence Lundblade02625d42020-06-25 14:41:41 -07003473/*
3474 Public function, see header qcbor/qcbor_decode.h file
3475 */
3476void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003477 uint8_t uTagRequirement,
3478 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003479{
3480 if(pMe->uLastError != QCBOR_SUCCESS) {
3481 // Already in error state; do nothing.
3482 return;
3483 }
3484
3485 /* Get the data item that is the map that is being searched */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003486 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003487 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3488 if(pMe->uLastError != QCBOR_SUCCESS) {
3489 return;
3490 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003491
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003492 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003493 &Item,
3494 uTagRequirement,
3495 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003496}
3497
3498
Laurence Lundblade02625d42020-06-25 14:41:41 -07003499/*
3500 Public function, see header qcbor/qcbor_decode.h file
3501 */
3502void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003503 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003504 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003505 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003506{
3507 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003508 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003509
Laurence Lundblade93d89472020-10-03 22:30:50 -07003510 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3511 &Item,
3512 uTagRequirement,
3513 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003514}
3515
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003516
Laurence Lundblade02625d42020-06-25 14:41:41 -07003517/*
3518 Public function, see header qcbor/qcbor_decode.h file
3519 */
3520void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003521 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003522 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003523 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003524{
3525 QCBORItem Item;
3526 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3527
Laurence Lundblade93d89472020-10-03 22:30:50 -07003528 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3529 &Item,
3530 uTagRequirement,
3531 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003532}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003533
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003534
Laurence Lundblade02625d42020-06-25 14:41:41 -07003535/*
3536 Public function, see header qcbor/qcbor_decode.h file
3537 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003538void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003539{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003540 if(pMe->uLastError != QCBOR_SUCCESS) {
3541 // Already in error state; do nothing.
3542 return;
3543 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003544
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003545 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003546 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003547 return;
3548 }
3549
3550 /*
3551 Reset the length of the UsefulInputBuf to what it was before
3552 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003553 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003554 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003555 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003556
3557
Laurence Lundblade02625d42020-06-25 14:41:41 -07003558 QCBORError uErr = ExitBoundedLevel(pMe, DecodeNesting_GetEndOfBstr(&(pMe->nesting)));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003559 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003560}
3561
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003562
Laurence Lundbladee6430642020-03-14 21:15:44 -07003563
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003564
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003565
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003566
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003567
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003568
Laurence Lundblade93d89472020-10-03 22:30:50 -07003569static QCBORError
3570InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003571{
3572 switch(pItem->uDataType) {
3573 case QCBOR_TYPE_TRUE:
3574 *pBool = true;
3575 return QCBOR_SUCCESS;
3576 break;
3577
3578 case QCBOR_TYPE_FALSE:
3579 *pBool = false;
3580 return QCBOR_SUCCESS;
3581 break;
3582
3583 default:
3584 return QCBOR_ERR_UNEXPECTED_TYPE;
3585 break;
3586 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003587 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003588}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003589
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003590
Laurence Lundblade9b334962020-08-27 10:55:53 -07003591
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003592/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003593 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003594*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003595void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003596{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003597 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003598 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003599 return;
3600 }
3601
Laurence Lundbladec4537442020-04-14 18:53:22 -07003602 QCBORError nError;
3603 QCBORItem Item;
3604
3605 nError = QCBORDecode_GetNext(pMe, &Item);
3606 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003607 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003608 return;
3609 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003610 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003611}
3612
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003613
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003614/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003615 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003616*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003617void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003618{
3619 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003620 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003621
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_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3630{
3631 QCBORItem Item;
3632 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3633
Laurence Lundblade9b334962020-08-27 10:55:53 -07003634 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003635}
3636
3637
3638
Laurence Lundbladec7114722020-08-13 05:11:40 -07003639
3640static void ProcessEpochDate(QCBORDecodeContext *pMe,
3641 QCBORItem *pItem,
3642 uint8_t uTagRequirement,
3643 int64_t *pnTime)
3644{
3645 if(pMe->uLastError != QCBOR_SUCCESS) {
3646 // Already in error state, do nothing
3647 return;
3648 }
3649
3650 QCBORError uErr;
3651
3652 const TagSpecification TagSpec =
3653 {
3654 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003655 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3656 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003657 };
3658
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003659 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003660 if(uErr != QCBOR_SUCCESS) {
3661 goto Done;
3662 }
3663
3664 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3665 uErr = DecodeDateEpoch(pItem);
3666 if(uErr != QCBOR_SUCCESS) {
3667 goto Done;
3668 }
3669 }
3670
Laurence Lundblade9b334962020-08-27 10:55:53 -07003671 // Save the tags in the last item's tags in the decode context
3672 // for QCBORDecode_GetNthTagOfLast()
3673 CopyTags(pMe, pItem);
3674
Laurence Lundbladec7114722020-08-13 05:11:40 -07003675 *pnTime = pItem->val.epochDate.nSeconds;
3676
3677Done:
3678 pMe->uLastError = (uint8_t)uErr;
3679}
3680
3681
3682void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003683 uint8_t uTagRequirement,
3684 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003685{
3686 if(pMe->uLastError != QCBOR_SUCCESS) {
3687 // Already in error state, do nothing
3688 return;
3689 }
3690
3691 QCBORItem Item;
3692 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3693
3694 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3695}
3696
3697
3698void
3699QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3700 int64_t nLabel,
3701 uint8_t uTagRequirement,
3702 int64_t *pnTime)
3703{
3704 QCBORItem Item;
3705 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3706 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3707}
3708
3709
3710void
3711QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3712 const char *szLabel,
3713 uint8_t uTagRequirement,
3714 int64_t *pnTime)
3715{
3716 QCBORItem Item;
3717 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3718 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3719}
3720
3721
3722
3723
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003724void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3725 TagSpecification TagSpec,
3726 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003727{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003728 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003729 // Already in error state, do nothing
3730 return;
3731 }
3732
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003733 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003734 QCBORItem Item;
3735
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003736 uError = QCBORDecode_GetNext(pMe, &Item);
3737 if(uError != QCBOR_SUCCESS) {
3738 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003739 return;
3740 }
3741
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003742 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003743
3744 if(pMe->uLastError == QCBOR_SUCCESS) {
3745 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003746 } else {
3747 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003748 }
3749}
3750
Laurence Lundbladec4537442020-04-14 18:53:22 -07003751
3752
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003753
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003754static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003755 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003756 UsefulBufC *pValue,
3757 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003758{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003759 const TagSpecification TagSpec =
3760 {
3761 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003762 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3763 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003764 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003765
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003766 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003767 if(uErr != QCBOR_SUCCESS) {
3768 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003769 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003770
3771 *pValue = pItem->val.string;
3772
3773 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3774 *pbIsNegative = false;
3775 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3776 *pbIsNegative = true;
3777 }
3778
3779 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003780}
3781
3782
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003783/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003784 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003785 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003786void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3787 uint8_t uTagRequirement,
3788 UsefulBufC *pValue,
3789 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003790{
3791 if(pMe->uLastError != QCBOR_SUCCESS) {
3792 // Already in error state, do nothing
3793 return;
3794 }
3795
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003796 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003797 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3798 if(uError != QCBOR_SUCCESS) {
3799 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003800 return;
3801 }
3802
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003803 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003804}
3805
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003806
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003807/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003808 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003809*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003810void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3811 int64_t nLabel,
3812 uint8_t uTagRequirement,
3813 UsefulBufC *pValue,
3814 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003815{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003816 QCBORItem Item;
3817 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003818 if(pMe->uLastError != QCBOR_SUCCESS) {
3819 return;
3820 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003821
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003822 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003823}
3824
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003825
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003826/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003827 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003828*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003829void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3830 const char *szLabel,
3831 uint8_t uTagRequirement,
3832 UsefulBufC *pValue,
3833 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003834{
3835 QCBORItem Item;
3836 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003837 if(pMe->uLastError != QCBOR_SUCCESS) {
3838 return;
3839 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003840
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003841 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003842}
3843
3844
3845
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003846
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003847// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003848QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3849 const QCBORItem *pItem,
3850 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07003851 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003852{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003853 const TagSpecification TagSpecText =
3854 {
3855 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003856 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3857 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003858 };
3859 const TagSpecification TagSpecBinary =
3860 {
3861 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003862 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3863 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003864 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003865
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003866 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003867
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003868 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003869 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003870 if(pbIsTag257 != NULL) {
3871 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003872 }
3873 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003874 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003875 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003876 if(pbIsTag257 != NULL) {
3877 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003878 }
3879 uReturn = QCBOR_SUCCESS;
3880
3881 } else {
3882 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3883 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003884
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003885 return uReturn;
3886}
3887
Laurence Lundblade93d89472020-10-03 22:30:50 -07003888// Improvement: add methods for wrapped CBOR, a simple alternate
3889// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003890
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003891
3892
3893
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003894#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003895
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003896typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003897
3898
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003899// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003900static QCBORError
3901Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003902{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003903 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003904
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003905 if(uResult != 0) {
3906 /* This loop will run a maximum of 19 times because
3907 * UINT64_MAX < 10 ^^ 19. More than that will cause
3908 * exit with the overflow error
3909 */
3910 for(; nExponent > 0; nExponent--) {
3911 if(uResult > UINT64_MAX / 10) {
3912 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
3913 }
3914 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003915 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003916
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003917 for(; nExponent < 0; nExponent++) {
3918 uResult = uResult / 10;
3919 if(uResult == 0) {
3920 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3921 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003922 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07003923 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003924 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003925
3926 *puResult = uResult;
3927
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003928 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003929}
3930
3931
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003932// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003933static QCBORError
3934Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003935{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003936 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003937
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003938 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003939
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003940 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07003941 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003942 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07003943 */
3944 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003945 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003946 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07003947 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003948 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003949 nExponent--;
3950 }
3951
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003952 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003953 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003954 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
3955 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003956 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003957 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003958 }
3959
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003960 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07003961
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003962 return QCBOR_SUCCESS;
3963}
3964
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003965
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003966/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003967 Compute value with signed mantissa and signed result. Works with
3968 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003969 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003970static inline QCBORError ExponentiateNN(int64_t nMantissa,
3971 int64_t nExponent,
3972 int64_t *pnResult,
3973 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003974{
3975 uint64_t uResult;
3976
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003977 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07003978 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003979 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
3980
3981 // Do the exponentiation of the positive mantissa
3982 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
3983 if(uReturn) {
3984 return uReturn;
3985 }
3986
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003987
Laurence Lundblade983500d2020-05-14 11:49:34 -07003988 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
3989 of INT64_MIN. This assumes two's compliment representation where
3990 INT64_MIN is one increment farther from 0 than INT64_MAX.
3991 Trying to write -INT64_MIN doesn't work to get this because the
3992 compiler tries to work with an int64_t which can't represent
3993 -INT64_MIN.
3994 */
3995 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
3996
3997 // Error out if too large
3998 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003999 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4000 }
4001
4002 // Casts are safe because of checks above
4003 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4004
4005 return QCBOR_SUCCESS;
4006}
4007
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004008
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004009/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004010 Compute value with signed mantissa and unsigned result. Works with
4011 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004012 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004013static inline QCBORError ExponentitateNU(int64_t nMantissa,
4014 int64_t nExponent,
4015 uint64_t *puResult,
4016 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004017{
4018 if(nMantissa < 0) {
4019 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4020 }
4021
4022 // Cast to unsigned is OK because of check for negative
4023 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4024 // Exponentiation is straight forward
4025 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4026}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004027
4028
4029/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004030 Compute value with signed mantissa and unsigned result. Works with
4031 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004032 */
4033static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4034 int64_t nExponent,
4035 uint64_t *puResult,
4036 fExponentiator pfExp)
4037{
4038 return (*pfExp)(uMantissa, nExponent, puResult);
4039}
4040
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004041#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4042
4043
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004044
4045
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004046
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004047static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004048{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004049 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004050
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004051 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004052 const uint8_t *pByte = BigNum.ptr;
4053 size_t uLen = BigNum.len;
4054 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004055 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004056 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004057 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004058 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004059 }
4060
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004061 *pResult = uResult;
4062 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004063}
4064
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004065
Laurence Lundblade887add82020-05-17 05:50:34 -07004066static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004067{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004068 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004069}
4070
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004071
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004072static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004073{
4074 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004075 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4076 if(uError) {
4077 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004078 }
4079 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4080 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004081 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004082}
4083
4084
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004085static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004086{
4087 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004088 /* The negative integer furthest from zero for a C int64_t is
4089 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4090 negative number in CBOR is computed as -n - 1 where n is the
4091 encoded integer, where n is what is in the variable BigNum. When
4092 converting BigNum to a uint64_t, the maximum value is thus
4093 INT64_MAX, so that when it -n - 1 is applied to it the result will
4094 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004095
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004096 -n - 1 <= INT64_MIN.
4097 -n - 1 <= -INT64_MAX - 1
4098 n <= INT64_MAX.
4099 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004100 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004101 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004102 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004103 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004104
4105 /// Now apply -n - 1. The cast is safe because
4106 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4107 // is the largest positive integer that an int64_t can
4108 // represent. */
4109 *pnResult = -(int64_t)uResult - 1;
4110
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004111 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004112}
4113
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004114
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004115
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004116
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004117
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004118/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004119Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004120
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004121\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004122
Laurence Lundblade93d89472020-10-03 22:30:50 -07004123\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4124 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004125
4126\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4127
Laurence Lundblade93d89472020-10-03 22:30:50 -07004128\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4129 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004130*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004131static QCBORError
4132ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004133{
4134 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004135 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004136 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004137#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004138 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004139 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4140 http://www.cplusplus.com/reference/cmath/llround/
4141 */
4142 // Not interested in FE_INEXACT
4143 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004144 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4145 *pnValue = llround(pItem->val.dfnum);
4146 } else {
4147 *pnValue = lroundf(pItem->val.fnum);
4148 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004149 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4150 // llround() shouldn't result in divide by zero, but catch
4151 // it here in case it unexpectedly does. Don't try to
4152 // distinguish between the various exceptions because it seems
4153 // they vary by CPU, compiler and OS.
4154 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004155 }
4156 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004157 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004158 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004159#else
4160 return QCBOR_ERR_HW_FLOAT_DISABLED;
4161#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004162 break;
4163
4164 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004165 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004166 *pnValue = pItem->val.int64;
4167 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004168 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004169 }
4170 break;
4171
4172 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004173 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004174 if(pItem->val.uint64 < INT64_MAX) {
4175 *pnValue = pItem->val.int64;
4176 } else {
4177 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4178 }
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 default:
4185 return QCBOR_ERR_UNEXPECTED_TYPE;
4186 }
4187 return QCBOR_SUCCESS;
4188}
4189
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004190
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004191void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004192 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004193 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004194 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004195{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004196 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004197 return;
4198 }
4199
Laurence Lundbladee6430642020-03-14 21:15:44 -07004200 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004201 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4202 if(uError) {
4203 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004204 return;
4205 }
4206
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004207 if(pItem) {
4208 *pItem = Item;
4209 }
4210
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004211 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004212}
4213
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004214
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004215void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4216 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004217 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004218 int64_t *pnValue,
4219 QCBORItem *pItem)
4220{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004221 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004222 if(pMe->uLastError != QCBOR_SUCCESS) {
4223 return;
4224 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004225
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004226 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004227}
4228
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004229
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004230void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4231 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004232 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004233 int64_t *pnValue,
4234 QCBORItem *pItem)
4235{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004236 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004237 if(pMe->uLastError != QCBOR_SUCCESS) {
4238 return;
4239 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004240
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004241 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004242}
4243
4244
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004245/*
4246 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004247
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004248 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004249
Laurence Lundblade93d89472020-10-03 22:30:50 -07004250 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4251 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004252
4253 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4254
Laurence Lundblade93d89472020-10-03 22:30:50 -07004255 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4256 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004257 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004258static QCBORError
4259Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004260{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004261 switch(pItem->uDataType) {
4262
4263 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004264 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004265 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004266 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004267 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004268 }
4269 break;
4270
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004271 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004272 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004273 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004274 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004275 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004276 }
4277 break;
4278
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004279#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4280 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004281 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004282 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004283 pItem->val.expAndMantissa.nExponent,
4284 pnValue,
4285 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004286 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004287 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004288 }
4289 break;
4290
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004291 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004292 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004293 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004294 pItem->val.expAndMantissa.nExponent,
4295 pnValue,
4296 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004297 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004298 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004299 }
4300 break;
4301
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004302 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004303 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004304 int64_t nMantissa;
4305 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004306 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4307 if(uErr) {
4308 return uErr;
4309 }
4310 return ExponentiateNN(nMantissa,
4311 pItem->val.expAndMantissa.nExponent,
4312 pnValue,
4313 Exponentitate10);
4314 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004315 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004316 }
4317 break;
4318
4319 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004320 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004321 int64_t nMantissa;
4322 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004323 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4324 if(uErr) {
4325 return uErr;
4326 }
4327 return ExponentiateNN(nMantissa,
4328 pItem->val.expAndMantissa.nExponent,
4329 pnValue,
4330 Exponentitate10);
4331 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004332 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004333 }
4334 break;
4335
4336 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004337 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004338 int64_t nMantissa;
4339 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004340 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4341 if(uErr) {
4342 return uErr;
4343 }
4344 return ExponentiateNN(nMantissa,
4345 pItem->val.expAndMantissa.nExponent,
4346 pnValue,
4347 Exponentitate2);
4348 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004349 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004350 }
4351 break;
4352
4353 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004354 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004355 int64_t nMantissa;
4356 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004357 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4358 if(uErr) {
4359 return uErr;
4360 }
4361 return ExponentiateNN(nMantissa,
4362 pItem->val.expAndMantissa.nExponent,
4363 pnValue,
4364 Exponentitate2);
4365 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004366 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004367 }
4368 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004369#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4370
Laurence Lundbladee6430642020-03-14 21:15:44 -07004371
Laurence Lundbladec4537442020-04-14 18:53:22 -07004372 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004373 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004374}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004375
4376
Laurence Lundbladec4537442020-04-14 18:53:22 -07004377/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004378 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004379 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004380void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004381{
4382 QCBORItem Item;
4383
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004384 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004385
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004386 if(pMe->uLastError == QCBOR_SUCCESS) {
4387 // The above conversion succeeded
4388 return;
4389 }
4390
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004391 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004392 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004393 return;
4394 }
4395
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004396 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004397}
4398
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004399
4400/*
4401Public function, see header qcbor/qcbor_decode.h file
4402*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004403void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4404 int64_t nLabel,
4405 uint32_t uConvertTypes,
4406 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004407{
4408 QCBORItem Item;
4409
Laurence Lundblade93d89472020-10-03 22:30:50 -07004410 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4411 nLabel,
4412 uConvertTypes,
4413 pnValue,
4414 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004415
4416 if(pMe->uLastError == QCBOR_SUCCESS) {
4417 // The above conversion succeeded
4418 return;
4419 }
4420
4421 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4422 // The above conversion failed in a way that code below can't correct
4423 return;
4424 }
4425
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004426 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004427}
4428
4429
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004430/*
4431Public function, see header qcbor/qcbor_decode.h file
4432*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004433void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4434 const char *szLabel,
4435 uint32_t uConvertTypes,
4436 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004437{
4438 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004439 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4440 szLabel,
4441 uConvertTypes,
4442 pnValue,
4443 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004444
4445 if(pMe->uLastError == QCBOR_SUCCESS) {
4446 // The above conversion succeeded
4447 return;
4448 }
4449
4450 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4451 // The above conversion failed in a way that code below can't correct
4452 return;
4453 }
4454
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004455 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004456}
4457
4458
Laurence Lundblade93d89472020-10-03 22:30:50 -07004459static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004460{
4461 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004462 case QCBOR_TYPE_DOUBLE:
4463 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004464#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004465 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004466 // Can't use llround here because it will not convert values
4467 // greater than INT64_MAX and less than UINT64_MAX that
4468 // need to be converted so it is more complicated.
4469 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4470 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4471 if(isnan(pItem->val.dfnum)) {
4472 return QCBOR_ERR_FLOAT_EXCEPTION;
4473 } else if(pItem->val.dfnum < 0) {
4474 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4475 } else {
4476 double dRounded = round(pItem->val.dfnum);
4477 // See discussion in DecodeDateEpoch() for
4478 // explanation of - 0x7ff
4479 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4480 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4481 }
4482 *puValue = (uint64_t)dRounded;
4483 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004484 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004485 if(isnan(pItem->val.fnum)) {
4486 return QCBOR_ERR_FLOAT_EXCEPTION;
4487 } else if(pItem->val.fnum < 0) {
4488 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4489 } else {
4490 float fRounded = roundf(pItem->val.fnum);
4491 // See discussion in DecodeDateEpoch() for
4492 // explanation of - 0x7ff
4493 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4494 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4495 }
4496 *puValue = (uint64_t)fRounded;
4497 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004498 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004499 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4500 // round() and roundf() shouldn't result in exceptions here, but
4501 // catch them to be robust and thorough. Don't try to
4502 // distinguish between the various exceptions because it seems
4503 // they vary by CPU, compiler and OS.
4504 return QCBOR_ERR_FLOAT_EXCEPTION;
4505 }
4506
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004507 } else {
4508 return QCBOR_ERR_UNEXPECTED_TYPE;
4509 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004510#else
4511 return QCBOR_ERR_HW_FLOAT_DISABLED;
4512#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004513 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004514
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004515 case QCBOR_TYPE_INT64:
4516 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4517 if(pItem->val.int64 >= 0) {
4518 *puValue = (uint64_t)pItem->val.int64;
4519 } else {
4520 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4521 }
4522 } else {
4523 return QCBOR_ERR_UNEXPECTED_TYPE;
4524 }
4525 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004526
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004527 case QCBOR_TYPE_UINT64:
4528 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4529 *puValue = pItem->val.uint64;
4530 } else {
4531 return QCBOR_ERR_UNEXPECTED_TYPE;
4532 }
4533 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004534
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004535 default:
4536 return QCBOR_ERR_UNEXPECTED_TYPE;
4537 }
4538
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004539 return QCBOR_SUCCESS;
4540}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004541
4542
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004543void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004544 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004545 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004546 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004547{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004548 if(pMe->uLastError != QCBOR_SUCCESS) {
4549 return;
4550 }
4551
Laurence Lundbladec4537442020-04-14 18:53:22 -07004552 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004553
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004554 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4555 if(uError) {
4556 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004557 return;
4558 }
4559
Laurence Lundbladea826c502020-05-10 21:07:00 -07004560 if(pItem) {
4561 *pItem = Item;
4562 }
4563
Laurence Lundblade93d89472020-10-03 22:30:50 -07004564 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004565}
4566
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004567
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004568void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004569 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004570 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004571 uint64_t *puValue,
4572 QCBORItem *pItem)
4573{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004574 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004575 if(pMe->uLastError != QCBOR_SUCCESS) {
4576 return;
4577 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004578
Laurence Lundblade93d89472020-10-03 22:30:50 -07004579 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004580}
4581
4582
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004583void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004584 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004585 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004586 uint64_t *puValue,
4587 QCBORItem *pItem)
4588{
4589 if(pMe->uLastError != QCBOR_SUCCESS) {
4590 return;
4591 }
4592
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004593 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004594 if(pMe->uLastError != QCBOR_SUCCESS) {
4595 return;
4596 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004597
Laurence Lundblade93d89472020-10-03 22:30:50 -07004598 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004599}
4600
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004601
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004602
Laurence Lundblade93d89472020-10-03 22:30:50 -07004603static QCBORError
4604UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004605{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004606 switch(pItem->uDataType) {
4607
4608 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004609 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004610 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4611 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004612 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004613 }
4614 break;
4615
4616 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004617 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004618 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4619 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004620 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004621 }
4622 break;
4623
4624#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4625
4626 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004627 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004628 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004629 pItem->val.expAndMantissa.nExponent,
4630 puValue,
4631 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004632 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004633 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004634 }
4635 break;
4636
4637 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004638 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004639 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4640 pItem->val.expAndMantissa.nExponent,
4641 puValue,
4642 Exponentitate2);
4643 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004644 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004645 }
4646 break;
4647
4648 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004649 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004650 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004651 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004652 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004653 if(uErr != QCBOR_SUCCESS) {
4654 return uErr;
4655 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004656 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004657 pItem->val.expAndMantissa.nExponent,
4658 puValue,
4659 Exponentitate10);
4660 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004661 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004662 }
4663 break;
4664
4665 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004666 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004667 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4668 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004669 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004670 }
4671 break;
4672
4673 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004674 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004675 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004676 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004677 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004678 if(uErr != QCBOR_SUCCESS) {
4679 return uErr;
4680 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004681 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004682 pItem->val.expAndMantissa.nExponent,
4683 puValue,
4684 Exponentitate2);
4685 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004686 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004687 }
4688 break;
4689
4690 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004691 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004692 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4693 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004694 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004695 }
4696 break;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004697#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004698 default:
4699 return QCBOR_ERR_UNEXPECTED_TYPE;
4700 }
4701}
4702
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004703
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004704/*
4705 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004706 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004707void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004708{
4709 QCBORItem Item;
4710
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004711 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004712
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004713 if(pMe->uLastError == QCBOR_SUCCESS) {
4714 // The above conversion succeeded
4715 return;
4716 }
4717
4718 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4719 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004720 return;
4721 }
4722
Laurence Lundblade93d89472020-10-03 22:30:50 -07004723 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004724}
4725
Laurence Lundbladec4537442020-04-14 18:53:22 -07004726
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004727/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004728 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004729*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004730void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004731 int64_t nLabel,
4732 uint32_t uConvertTypes,
4733 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004734{
4735 QCBORItem Item;
4736
Laurence Lundblade93d89472020-10-03 22:30:50 -07004737 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4738 nLabel,
4739 uConvertTypes,
4740 puValue,
4741 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004742
4743 if(pMe->uLastError == QCBOR_SUCCESS) {
4744 // The above conversion succeeded
4745 return;
4746 }
4747
4748 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4749 // The above conversion failed in a way that code below can't correct
4750 return;
4751 }
4752
Laurence Lundblade93d89472020-10-03 22:30:50 -07004753 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004754}
4755
4756
4757/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004758 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004759*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004760void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004761 const char *szLabel,
4762 uint32_t uConvertTypes,
4763 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004764{
4765 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004766 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
4767 szLabel,
4768 uConvertTypes,
4769 puValue,
4770 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004771
4772 if(pMe->uLastError == QCBOR_SUCCESS) {
4773 // The above conversion succeeded
4774 return;
4775 }
4776
4777 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4778 // The above conversion failed in a way that code below can't correct
4779 return;
4780 }
4781
Laurence Lundblade93d89472020-10-03 22:30:50 -07004782 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004783}
4784
4785
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004786
4787
Laurence Lundblade9b334962020-08-27 10:55:53 -07004788static QCBORError ConvertDouble(const QCBORItem *pItem,
4789 uint32_t uConvertTypes,
4790 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004791{
4792 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004793 case QCBOR_TYPE_FLOAT:
4794#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4795 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4796 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004797 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004798 *pdValue = (double)pItem->val.fnum;
4799 } else {
4800 return QCBOR_ERR_UNEXPECTED_TYPE;
4801 }
4802 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004803#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004804 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004805#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004806 break;
4807
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004808 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004809 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4810 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004811 *pdValue = pItem->val.dfnum;
4812 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004813 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004814 }
4815 }
4816 break;
4817
4818 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004819#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004820 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004821 // A simple cast seems to do the job with no worry of exceptions.
4822 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004823 *pdValue = (double)pItem->val.int64;
4824
4825 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004826 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004827 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004828#else
4829 return QCBOR_ERR_HW_FLOAT_DISABLED;
4830#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004831 break;
4832
4833 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004834#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004835 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004836 // A simple cast seems to do the job with no worry of exceptions.
4837 // There will be precision loss for some values.
4838 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004839 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004840 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004841 }
4842 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004843#else
4844 return QCBOR_ERR_HW_FLOAT_DISABLED;
4845#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004846
4847 default:
4848 return QCBOR_ERR_UNEXPECTED_TYPE;
4849 }
4850
4851 return QCBOR_SUCCESS;
4852}
4853
4854
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004855void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004856 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004857 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004858 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004859{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004860 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004861 return;
4862 }
4863
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004864 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004865
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004866 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004867 if(uError) {
4868 pMe->uLastError = (uint8_t)uError;
4869 return;
4870 }
4871
4872 if(pItem) {
4873 *pItem = Item;
4874 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004875
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004876 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004877}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004878
Laurence Lundbladec4537442020-04-14 18:53:22 -07004879
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004880void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4881 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004882 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004883 double *pdValue,
4884 QCBORItem *pItem)
4885{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004886 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004887 if(pMe->uLastError != QCBOR_SUCCESS) {
4888 return;
4889 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004890
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004891 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004892}
4893
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004894
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004895void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4896 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004897 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004898 double *pdValue,
4899 QCBORItem *pItem)
4900{
4901 if(pMe->uLastError != QCBOR_SUCCESS) {
4902 return;
4903 }
4904
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004905 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004906 if(pMe->uLastError != QCBOR_SUCCESS) {
4907 return;
4908 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004909
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004910 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004911}
4912
4913
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004914#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004915static double ConvertBigNumToDouble(const UsefulBufC BigNum)
4916{
4917 double dResult;
4918
4919 dResult = 0.0;
4920 const uint8_t *pByte = BigNum.ptr;
4921 size_t uLen = BigNum.len;
4922 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07004923 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004924 while(uLen--) {
4925 dResult = (dResult * 256.0) + (double)*pByte++;
4926 }
4927
4928 return dResult;
4929}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004930#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
4931
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004932
Laurence Lundblade93d89472020-10-03 22:30:50 -07004933static QCBORError
4934DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004935{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004936#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004937 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004938 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
4939
4940 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004941 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004942
4943#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004944 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004945 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004946 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004947 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4948 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
4949 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004950 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004951 }
4952 break;
4953
4954 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004955 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07004956 // Underflow gives 0, overflow gives infinity
4957 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
4958 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004959 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004960 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004961 }
4962 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004963#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004964
4965 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004966 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004967 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
4968 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004969 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004970 }
4971 break;
4972
4973 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004974 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07004975 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004976 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004977 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004978 }
4979 break;
4980
Laurence Lundblade410c7e02020-06-25 23:35:29 -07004981#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004982 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004983 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004984 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4985 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4986 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004987 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004988 }
4989 break;
4990
4991 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004992 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004993 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
4994 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
4995 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004996 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004997 }
4998 break;
4999
5000 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005001 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005002 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5003 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5004 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005005 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005006 }
5007 break;
5008
5009 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005010 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005011 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005012 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5013 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005014 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005015 }
5016 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005017#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
5018
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005019 default:
5020 return QCBOR_ERR_UNEXPECTED_TYPE;
5021 }
5022
5023 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005024
5025#else
5026 (void)pItem;
5027 (void)uConvertTypes;
5028 (void)pdValue;
5029 return QCBOR_ERR_HW_FLOAT_DISABLED;
5030#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5031
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005032}
5033
5034
5035/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005036 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005037*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005038void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5039 uint32_t uConvertTypes,
5040 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005041{
5042
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005043 QCBORItem Item;
5044
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005045 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005046
5047 if(pMe->uLastError == QCBOR_SUCCESS) {
5048 // The above conversion succeeded
5049 return;
5050 }
5051
5052 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5053 // The above conversion failed in a way that code below can't correct
5054 return;
5055 }
5056
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005057 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005058}
5059
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005060
5061/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005062 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005063*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005064void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5065 int64_t nLabel,
5066 uint32_t uConvertTypes,
5067 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005068{
5069 QCBORItem Item;
5070
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005071 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005072
5073 if(pMe->uLastError == QCBOR_SUCCESS) {
5074 // The above conversion succeeded
5075 return;
5076 }
5077
5078 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5079 // The above conversion failed in a way that code below can't correct
5080 return;
5081 }
5082
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005083 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005084}
5085
5086
5087/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005088 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005089*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005090void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5091 const char *szLabel,
5092 uint32_t uConvertTypes,
5093 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005094{
5095 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005096 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005097
5098 if(pMe->uLastError == QCBOR_SUCCESS) {
5099 // The above conversion succeeded
5100 return;
5101 }
5102
5103 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5104 // The above conversion failed in a way that code below can't correct
5105 return;
5106 }
5107
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005108 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005109}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005110
5111
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005112
5113
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005114#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005115static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5116{
5117 while((uInt & 0xff00000000000000UL) == 0) {
5118 uInt = uInt << 8;
5119 };
5120
5121 UsefulOutBuf UOB;
5122
5123 UsefulOutBuf_Init(&UOB, Buffer);
5124
5125 while(uInt) {
5126 const uint64_t xx = uInt & 0xff00000000000000UL;
5127 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5128 uInt = uInt << 8;
5129 (void)xx;
5130 }
5131
5132 return UsefulOutBuf_OutUBuf(&UOB);
5133}
5134
5135
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005136static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5137 TagSpecification TagSpec,
5138 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005139{
5140 QCBORError uErr;
5141 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005142 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005143 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005144 if(uErr != QCBOR_SUCCESS) {
5145 goto Done;
5146 }
5147
5148 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5149 break; // Successful exit. Moving on to finish decoding.
5150 }
5151
5152 // The item is an array, which means an undecoded
5153 // mantissa and exponent, so decode it. It will then
5154 // have a different type and exit the loop if.
5155 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5156 if(uErr != QCBOR_SUCCESS) {
5157 goto Done;
5158 }
5159
5160 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005161 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005162 }
5163Done:
5164 return uErr;
5165}
5166
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005167
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005168static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005169 TagSpecification TagSpec,
5170 QCBORItem *pItem,
5171 int64_t *pnMantissa,
5172 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005173{
5174 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005175
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005176 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005177 if(uErr != QCBOR_SUCCESS) {
5178 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005179 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005180
Laurence Lundblade9b334962020-08-27 10:55:53 -07005181 switch (pItem->uDataType) {
5182
5183 case QCBOR_TYPE_DECIMAL_FRACTION:
5184 case QCBOR_TYPE_BIGFLOAT:
5185 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5186 *pnExponent = pItem->val.expAndMantissa.nExponent;
5187 break;
5188
5189 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5190 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5191 *pnExponent = pItem->val.expAndMantissa.nExponent;
5192 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5193 break;
5194
5195 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5196 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5197 *pnExponent = pItem->val.expAndMantissa.nExponent;
5198 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5199 break;
5200
5201 default:
5202 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5203 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005204
5205 Done:
5206 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005207}
5208
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005209
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005210static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005211 TagSpecification TagSpec,
5212 QCBORItem *pItem,
5213 UsefulBuf BufferForMantissa,
5214 UsefulBufC *pMantissa,
5215 bool *pbIsNegative,
5216 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005217{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005218 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005219
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005220 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005221 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005222 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005223 }
5224
5225 uint64_t uMantissa;
5226
5227 switch (pItem->uDataType) {
5228
5229 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005230 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005231 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5232 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5233 *pbIsNegative = false;
5234 } else {
5235 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5236 *pbIsNegative = true;
5237 }
5238 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5239 *pnExponent = pItem->val.expAndMantissa.nExponent;
5240 break;
5241
5242 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005243 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005244 *pnExponent = pItem->val.expAndMantissa.nExponent;
5245 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5246 *pbIsNegative = false;
5247 break;
5248
5249 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005250 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005251 *pnExponent = pItem->val.expAndMantissa.nExponent;
5252 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5253 *pbIsNegative = true;
5254 break;
5255
5256 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005257 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005258 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005259
5260Done:
5261 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005262}
5263
5264
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005265/*
5266 Public function, see header qcbor/qcbor_decode.h file
5267*/
5268void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5269 uint8_t uTagRequirement,
5270 int64_t *pnMantissa,
5271 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005272{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005273 if(pMe->uLastError != QCBOR_SUCCESS) {
5274 return;
5275 }
5276
5277 QCBORItem Item;
5278 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5279 if(uError) {
5280 pMe->uLastError = (uint8_t)uError;
5281 return;
5282 }
5283
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005284 const TagSpecification TagSpec =
5285 {
5286 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005287 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5288 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5289 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005290 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005291
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005292 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005293}
5294
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005295
5296/*
5297 Public function, see header qcbor/qcbor_decode.h file
5298*/
5299void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005300 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005301 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005302 int64_t *pnMantissa,
5303 int64_t *pnExponent)
5304{
5305 if(pMe->uLastError != QCBOR_SUCCESS) {
5306 return;
5307 }
5308
5309 QCBORItem Item;
5310 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5311
5312 const TagSpecification TagSpec =
5313 {
5314 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005315 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5316 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5317 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005318 };
5319
5320 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5321}
5322
5323
5324/*
5325 Public function, see header qcbor/qcbor_decode.h file
5326*/
5327void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005328 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005329 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005330 int64_t *pnMantissa,
5331 int64_t *pnExponent)
5332{
5333 if(pMe->uLastError != QCBOR_SUCCESS) {
5334 return;
5335 }
5336
5337 QCBORItem Item;
5338 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5339
5340 const TagSpecification TagSpec =
5341 {
5342 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005343 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5344 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5345 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005346 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005347
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005348 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5349}
5350
5351
5352/*
5353 Public function, see header qcbor/qcbor_decode.h file
5354*/
5355void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5356 uint8_t uTagRequirement,
5357 UsefulBuf MantissaBuffer,
5358 UsefulBufC *pMantissa,
5359 bool *pbMantissaIsNegative,
5360 int64_t *pnExponent)
5361{
5362 if(pMe->uLastError != QCBOR_SUCCESS) {
5363 return;
5364 }
5365
5366 QCBORItem Item;
5367 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5368 if(uError) {
5369 pMe->uLastError = (uint8_t)uError;
5370 return;
5371 }
5372
5373 const TagSpecification TagSpec =
5374 {
5375 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005376 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5377 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5378 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005379 };
5380
Laurence Lundblade93d89472020-10-03 22:30:50 -07005381 ProcessMantissaAndExponentBig(pMe,
5382 TagSpec,
5383 &Item,
5384 MantissaBuffer,
5385 pMantissa,
5386 pbMantissaIsNegative,
5387 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005388}
5389
5390
5391/*
5392 Public function, see header qcbor/qcbor_decode.h file
5393*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005394void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005395 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005396 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005397 UsefulBuf BufferForMantissa,
5398 UsefulBufC *pMantissa,
5399 bool *pbIsNegative,
5400 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005401{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005402 if(pMe->uLastError != QCBOR_SUCCESS) {
5403 return;
5404 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005405
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005406 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005407 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005408 if(pMe->uLastError != QCBOR_SUCCESS) {
5409 return;
5410 }
5411
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005412 const TagSpecification TagSpec =
5413 {
5414 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005415 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5416 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5417 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005418 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005419
Laurence Lundblade93d89472020-10-03 22:30:50 -07005420 ProcessMantissaAndExponentBig(pMe,
5421 TagSpec,
5422 &Item,
5423 BufferForMantissa,
5424 pMantissa,
5425 pbIsNegative,
5426 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005427}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005428
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005429
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005430/*
5431 Public function, see header qcbor/qcbor_decode.h file
5432*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005433void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005434 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005435 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005436 UsefulBuf BufferForMantissa,
5437 UsefulBufC *pMantissa,
5438 bool *pbIsNegative,
5439 int64_t *pnExponent)
5440{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005441 if(pMe->uLastError != QCBOR_SUCCESS) {
5442 return;
5443 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005444
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005445 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005446 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5447 if(pMe->uLastError != QCBOR_SUCCESS) {
5448 return;
5449 }
5450
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005451 const TagSpecification TagSpec =
5452 {
5453 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005454 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5455 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5456 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005457 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005458
5459 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5460}
5461
5462
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005463/*
5464 Public function, see header qcbor/qcbor_decode.h file
5465*/
5466void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5467 uint8_t uTagRequirement,
5468 int64_t *pnMantissa,
5469 int64_t *pnExponent)
5470{
5471 if(pMe->uLastError != QCBOR_SUCCESS) {
5472 return;
5473 }
5474
5475 QCBORItem Item;
5476 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5477 if(uError) {
5478 pMe->uLastError = (uint8_t)uError;
5479 return;
5480 }
5481 const TagSpecification TagSpec =
5482 {
5483 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005484 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5485 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5486 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005487 };
5488
5489 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5490}
5491
5492
5493/*
5494 Public function, see header qcbor/qcbor_decode.h file
5495*/
5496void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005497 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005498 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005499 int64_t *pnMantissa,
5500 int64_t *pnExponent)
5501{
5502 if(pMe->uLastError != QCBOR_SUCCESS) {
5503 return;
5504 }
5505
5506 QCBORItem Item;
5507 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5508 if(pMe->uLastError != QCBOR_SUCCESS) {
5509 return;
5510 }
5511
5512 const TagSpecification TagSpec =
5513 {
5514 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005515 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5516 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5517 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005518 };
5519
5520 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5521}
5522
5523
5524/*
5525 Public function, see header qcbor/qcbor_decode.h file
5526*/
5527void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005528 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005529 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005530 int64_t *pnMantissa,
5531 int64_t *pnExponent)
5532{
5533 if(pMe->uLastError != QCBOR_SUCCESS) {
5534 return;
5535 }
5536
5537 QCBORItem Item;
5538 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5539 if(pMe->uLastError != QCBOR_SUCCESS) {
5540 return;
5541 }
5542
5543 const TagSpecification TagSpec =
5544 {
5545 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005546 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5547 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5548 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005549 };
5550
5551 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5552}
5553
5554
5555/*
5556 Public function, see header qcbor/qcbor_decode.h file
5557*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005558void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5559 uint8_t uTagRequirement,
5560 UsefulBuf MantissaBuffer,
5561 UsefulBufC *pMantissa,
5562 bool *pbMantissaIsNegative,
5563 int64_t *pnExponent)
5564{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005565 if(pMe->uLastError != QCBOR_SUCCESS) {
5566 return;
5567 }
5568
5569 QCBORItem Item;
5570 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5571 if(uError) {
5572 pMe->uLastError = (uint8_t)uError;
5573 return;
5574 }
5575
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005576 const TagSpecification TagSpec =
5577 {
5578 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005579 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5580 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5581 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005582 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005583
5584 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005585}
5586
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005587
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005588/*
5589 Public function, see header qcbor/qcbor_decode.h file
5590*/
5591void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005592 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005593 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005594 UsefulBuf BufferForMantissa,
5595 UsefulBufC *pMantissa,
5596 bool *pbIsNegative,
5597 int64_t *pnExponent)
5598{
5599 if(pMe->uLastError != QCBOR_SUCCESS) {
5600 return;
5601 }
5602
5603 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005604 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5605 if(pMe->uLastError != QCBOR_SUCCESS) {
5606 return;
5607 }
5608
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005609 const TagSpecification TagSpec =
5610 {
5611 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005612 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5613 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5614 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005615 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005616
Laurence Lundblade93d89472020-10-03 22:30:50 -07005617 ProcessMantissaAndExponentBig(pMe,
5618 TagSpec,
5619 &Item,
5620 BufferForMantissa,
5621 pMantissa,
5622 pbIsNegative,
5623 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005624}
5625
5626
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005627/*
5628 Public function, see header qcbor/qcbor_decode.h file
5629*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005630void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005631 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005632 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005633 UsefulBuf BufferForMantissa,
5634 UsefulBufC *pMantissa,
5635 bool *pbIsNegative,
5636 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005637{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005638 if(pMe->uLastError != QCBOR_SUCCESS) {
5639 return;
5640 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005641
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005642 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005643 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5644 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005645 return;
5646 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005647
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005648 const TagSpecification TagSpec =
5649 {
5650 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005651 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5652 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5653 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005654 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005655
Laurence Lundblade93d89472020-10-03 22:30:50 -07005656 ProcessMantissaAndExponentBig(pMe,
5657 TagSpec,
5658 &Item,
5659 BufferForMantissa,
5660 pMantissa,
5661 pbIsNegative,
5662 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005663}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005664
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005665#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */