blob: 8989211b7211f06eaca47706c9108968af25ce5d [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003 Copyright (c) 2018-2021, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080036#include "ieee754.h" /* Does not use math.h */
Laurence Lundbladec7114722020-08-13 05:11:40 -070037
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080039
40#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
41 * pow(), exp2()
42 */
43#include <fenv.h> /* feclearexcept(), fetestexcept() */
44
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080045#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070046
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070047
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080048
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053049/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080050 * This casts away the const-ness of a pointer, usually so it can be
51 * freed or realloced.
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +053052 */
53#define UNCONST_POINTER(ptr) ((void *)(ptr))
54
Laurence Lundbladea9489f82020-09-12 13:50:56 -070055#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070056
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070057
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080058
59
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070060static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070061QCBORItem_IsMapOrArray(const QCBORItem *pMe)
62{
63 const uint8_t uDataType = pMe->uDataType;
64 return uDataType == QCBOR_TYPE_MAP ||
65 uDataType == QCBOR_TYPE_ARRAY ||
66 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
67}
68
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070069static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070070QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
71{
72 if(!QCBORItem_IsMapOrArray(pMe)){
73 return false;
74 }
75
76 if(pMe->val.uCount != 0) {
77 return false;
78 }
79 return true;
80}
81
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070082static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070083QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
84{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080085#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -070086 if(!QCBORItem_IsMapOrArray(pMe)){
87 return false;
88 }
89
90 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
91 return false;
92 }
93 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080094#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
95 (void)pMe;
96 return false;
97#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -070098}
99
100
Laurence Lundbladeee851742020-01-08 08:37:05 -0800101/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700102 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -0800103 ===========================================================================*/
104
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700105/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800106 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
107 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700108 */
109
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700110
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700111static inline uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700112DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700113{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700114 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800115 /* Limit in DecodeNesting_Descend against more than
116 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700117 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700118 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700119}
120
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700121
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700122static inline uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700123DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700124{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700125 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800126 /* Limit in DecodeNesting_Descend against more than
127 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700128 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700129 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700130}
131
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700132
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700133static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700134DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700135{
136 return pNesting->pCurrentBounded->u.ma.uStartOffset;
137}
138
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700139
Laurence Lundblade085d7952020-07-24 10:26:30 -0700140static inline bool
141DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
142{
143 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
144 return true;
145 } else {
146 return false;
147 }
148}
149
150
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700151static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700152DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700153{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700154 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700155 return true;
156 } else {
157 return false;
158 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700159}
160
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700161
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700162static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700163DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700164{
165 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800166 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700167 return false;
168 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800169
170#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700171 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800172 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700173 return false;
174 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800175
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800176#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
177
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800178 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700179 return true;
180}
181
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700182static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700183DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700184{
185 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800186 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700187 return true;
188 }
189 return false;
190}
191
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700192
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700193static inline bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700194{
195 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
196 return true;
197 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700198 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700199 return true;
200 }
201 return false;
202}
203
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700204
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700205static inline void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700206{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800207 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700208 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800209 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
210 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
211 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700212 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700213 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700214
215 if(bIsEmpty) {
216 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
217 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700218}
219
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700220
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700221static inline void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700222{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700223 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700224}
225
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700226
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700227static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700228DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700229{
230 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800231 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700232 return false;
233 }
234 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800235 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700236 return false;
237 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700238 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800239 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700240 return false;
241 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800242 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800243 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
244 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800245 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700246 return false;
247 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800248 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700249 return true;
250}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700251
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700252
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700253static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700254DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700255{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800256 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700257 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
258 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700259 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700260 return false;
261 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700262}
263
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700264
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700265static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700266DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700267{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700268 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
269 return true;
270 } else {
271 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700272 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700273}
274
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700275
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700276static inline bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700277DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700278{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700279 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700280 return false;
281 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700282
283 if(pNesting->pCurrentBounded->uLevelType != uType) {
284 return false;
285 }
286
287 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700288}
289
Laurence Lundblade02625d42020-06-25 14:41:41 -0700290
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700291static inline void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700292DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700293{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800294 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700295 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700296}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700297
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700298
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700299static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700300DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
301{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800302 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700303 pNesting->pCurrent->u.ma.uCountCursor++;
304}
305
306
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700307static inline void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700308DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
309{
310 pNesting->pCurrent--;
311}
312
Laurence Lundblade02625d42020-06-25 14:41:41 -0700313
314static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700315DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700316{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800317 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700318 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700319 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700320 }
321
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800322 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700323 pNesting->pCurrent++;
324
325 pNesting->pCurrent->uLevelType = uType;
326
327 return QCBOR_SUCCESS;
328}
329
330
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700331static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800332DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
333 bool bIsEmpty,
334 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700335{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700336 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800337 * Should only be called on map/array.
338 *
339 * Have descended into this before this is called. The job here is
340 * just to mark it in bounded mode.
341 *
342 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
343 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
344 *
345 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700346 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800347 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700348 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700349 }
350
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700351 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700352
353 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700354
355 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700356}
357
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700358
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700359static inline QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700360DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700361 uint8_t uQCBORType,
362 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700363{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700364 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700365
366 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800367 /* Nothing to do for empty definite-length arrays. They are just are
368 * effectively the same as an item that is not a map or array.
369 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700370 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800371 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700372 }
373
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800374 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700375 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
376 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700377 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700378 goto Done;
379 }
380
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700381 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700382 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700383 goto Done;
384 }
385
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800386 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700387 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
388 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700389
390 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700391
392Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700393 return uError;;
394}
395
396
397static inline void
398DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
399{
400 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
401}
402
403
404static inline void
405DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
406{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700407 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700408 pNesting->pCurrentBounded--;
409 if(DecodeNesting_IsCurrentBounded(pNesting)) {
410 break;
411 }
412 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700413}
414
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800415
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700416static inline void
417DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
418{
419 pNesting->pCurrent = pNesting->pCurrentBounded;
420}
421
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700422
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700423static inline QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700424DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700425 uint32_t uEndOffset,
426 uint32_t uStartOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700427{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700428 QCBORError uError;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700429
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700430 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700431 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700432 goto Done;
433 }
434
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800435 /* Fill in the new byte string level */
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700436 pNesting->pCurrent->u.bs.uSavedEndOffset = uEndOffset;
437 pNesting->pCurrent->u.bs.uBstrStartOffset = uStartOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700438
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800439 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700440 pNesting->pCurrentBounded = pNesting->pCurrent;
441
442Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700443 return uError;;
444}
445
Laurence Lundbladed0304932020-06-27 10:59:38 -0700446
447static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700448DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700449{
450 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700451}
452
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700453
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700454static inline void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800455DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
456{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700457 if(pNesting->pCurrent->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
458 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
459 }
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800460}
461
462
463static inline void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700464DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700465{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700466 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700467 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
468 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700469}
470
471
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700472static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800473DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
474 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700475{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700476 *pSave = *pNesting;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700477}
478
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700479
Laurence Lundblade02625d42020-06-25 14:41:41 -0700480static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800481DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
482 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700483{
484 *pNesting = *pSave;
485}
486
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700487
Laurence Lundblade02625d42020-06-25 14:41:41 -0700488static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700489DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700490{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700491 return pMe->pCurrentBounded->u.bs.uSavedEndOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700492}
493
494
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800495
496
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800497#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800498/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800499 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
500
501 The following four functions are pretty wrappers for invocation of
502 the string allocator supplied by the caller.
503
Laurence Lundbladeee851742020-01-08 08:37:05 -0800504 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800505
Laurence Lundbladeee851742020-01-08 08:37:05 -0800506static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800507StringAllocator_Free(const QCBORInternalAllocator *pMe, void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800508{
509 (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, 0);
510}
511
Laurence Lundbladeee851742020-01-08 08:37:05 -0800512// StringAllocator_Reallocate called with pMem NULL is
513// equal to StringAllocator_Allocate()
514static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800515StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800516 void *pMem,
517 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800518{
519 return (pMe->pfAllocator)(pMe->pAllocateCxt, pMem, uSize);
520}
521
Laurence Lundbladeee851742020-01-08 08:37:05 -0800522static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800523StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800524{
525 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
526}
527
Laurence Lundbladeee851742020-01-08 08:37:05 -0800528static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800529StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800530{
531 if(pMe->pfAllocator) {
532 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
533 }
534}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800535#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800536
537
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800538
539
Laurence Lundbladeee851742020-01-08 08:37:05 -0800540/*===========================================================================
541 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700542
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800543 See qcbor/qcbor_decode.h for definition of the object
544 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800545 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700546/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800547 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700548 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800549void QCBORDecode_Init(QCBORDecodeContext *pMe,
550 UsefulBufC EncodedCBOR,
551 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700552{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800553 memset(pMe, 0, sizeof(QCBORDecodeContext));
554 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
555 /* Don't bother with error check on decode mode. If a bad value is
556 * passed it will just act as if the default normal mode of 0 was set.
557 */
558 pMe->uDecodeMode = (uint8_t)nDecodeMode;
559 DecodeNesting_Init(&(pMe->nesting));
560
561 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
562 * GetNext_TaggedItem() and MapTagNumber(). */
563 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700564}
565
566
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800567#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
568
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700569/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800570 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700571 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800572void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
573 QCBORStringAllocate pfAllocateFunction,
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800574 void *pAllocateContext,
575 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700576{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800577 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
578 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
579 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700580}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800581#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700582
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800583
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800584
585
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800586/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800587 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800588 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800589void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800590 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700591{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800592 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700593 (void)pMe;
594 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700595}
596
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700597
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800598
599
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700600/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800601 * Decoding items is done in six layers, one calling the next one
602 * down. If a layer has no work to do for a particular item, it
603 * returns quickly.
604 *
605 * 1. QCBORDecode_GetNextTagContent - The top layer processes tagged
606 * data items, turning them into the local C representation. For the
607 * most simple it is just associating a QCBOR_TYPE with the data. For
608 * the complex ones that an aggregate of data items, there is some
609 * further decoding and some limited recursion.
610 *
611 * 2. QCBORDecode_GetNextMapOrArray - This manages the beginnings and
612 * ends of maps and arrays. It tracks descending into and ascending
613 * out of maps/arrays. It processes breaks that terminate
614 * indefinite-length maps and arrays.
615 *
616 * 3. QCBORDecode_GetNextMapEntry - This handles the combining of two
617 * items, the label and the data, that make up a map entry. It only
618 * does work on maps. It combines the label and data items into one
619 * labeled item.
620 *
621 * 4. QCBORDecode_GetNextTagNumber - This decodes type 6 tag
622 * numbers. It turns the tag numbers into bit flags associated with
623 * the data item. No actual decoding of the contents of the tag is
624 * performed here.
625 *
626 * 5. QCBORDecode_GetNextFullString - This assembles the sub-items
627 * that make up an indefinite-length string into one string item. It
628 * uses the string allocator to create contiguous space for the
629 * item. It processes all breaks that are part of indefinite-length
630 * strings.
631 *
632 * 6. DecodeAtomicDataItem - This decodes the atomic data items in
633 * CBOR. Each atomic data item has a "major type", an integer
634 * "argument" and optionally some content. For text and byte strings,
635 * the content is the bytes that make up the string. These are the
636 * smallest data items that are considered to be well-formed. The
637 * content may also be other data items in the case of aggregate
638 * types. They are not handled in this layer.
639 *
640 * Roughly this takes 300 bytes of stack for vars. TODO: evaluate this
641 * more carefully and correctly.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700642 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800643
644
645/*
646 * Note about use of int and unsigned variables.
647 *
648 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
649 * used carefully here, and in particular why it isn't used in the
650 * public interface. Also see
651 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
652 *
653 * Int is used for values that need less than 16-bits and would be
654 * subject to integer promotion and result in complaining from static
655 * analyzers.
656 */
657
658
659/**
660 * @brief Decode the CBOR head, the type and argument.
661 *
662 * @param[in] pUInBuf The input buffer to read from.
663 * @param[out] pnMajorType The decoded major type.
664 * @param[out] puArgument The decoded argument.
665 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
666 *
667 * @retval QCBOR_ERR_UNSUPPORTED
668 * @retval QCBOR_ERR_HIT_END
669 *
670 * This decodes the CBOR "head" that every CBOR data item has. See
671 * longer explaination of the head in documentation for
672 * QCBOREncode_EncodeHead().
673 *
674 * This does the network->host byte order conversion. The conversion
675 * here also results in the conversion for floats in addition to that
676 * for lengths, tags and integer values.
677 *
678 * The int type is preferred to uint8_t for some variables as this
679 * avoids integer promotions, can reduce code size and makes static
680 * analyzers happier.
681 */
682static inline QCBORError
683DecodeHead(UsefulInputBuf *pUInBuf,
684 int *pnMajorType,
685 uint64_t *puArgument,
686 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700687{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800688 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800689
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800690 /* Get the initial byte that every CBOR data item has and break it
691 * down. */
692 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800693 const int nTmpMajorType = nInitialByte >> 5;
694 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800695
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800696 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800697 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800698
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800699 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800700 /* Need to get 1,2,4 or 8 additional argument bytes. Map
701 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
702 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800703 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800704
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800705 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800706 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800707 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800708 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800709 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
710 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800711 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800712 /* The reserved and thus-far unused additional info values */
713 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800714 goto Done;
715 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800716 /* Less than 24, additional info is argument or 31, an
717 * indefinite-length. No more bytes to get.
718 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800719 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700720 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800721
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700722 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800723 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700724 goto Done;
725 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800726
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800727 /* All successful if arrived here. */
728 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800729 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800730 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800731 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800732
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700733Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800734 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700735}
736
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800737
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800738/**
739 * @brief Decode integer types, major types 0 and 1.
740 *
741 * @param[in] nMajorType The CBOR major type (0 or 1).
742 * @param[in] uArgument The argument from the head.
743 * @param[out] pDecodedItem The filled in decoded item.
744 *
745 * @retval QCBOR_ERR_INT_OVERFLOW
746 *
747 * Must only be called when major type is 0 or 1.
748 *
749 * CBOR doesn't explicitly specify two's compliment for integers but
750 * all CPUs use it these days and the test vectors in the RFC are
751 * so. All integers in the CBOR structure are positive and the major
752 * type indicates positive or negative. CBOR can express positive
753 * integers up to 2^x - 1 where x is the number of bits and negative
754 * integers down to 2^x. Note that negative numbers can be one more
755 * away from zero than positive. Stdint, as far as I can tell, uses
756 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700757 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700758static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800759DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700760{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800772
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700773 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800791 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700792}
793
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800794
795/* 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 Lundblade9b334962020-08-27 10:55:53 -0700824
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800825/**
826 * @brief Decode major 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
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700834 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800835
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800836static inline QCBORError
837DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
838{
839 QCBORError uReturn = QCBOR_SUCCESS;
840
841 /* 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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800853 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700854#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800875 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700876#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800917 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700918 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800929 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700930}
931
932
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800949static inline QCBORError
950DecodeBytes(const QCBORInternalAllocator *pAllocator,
951 uint64_t uStrLen,
952 UsefulInputBuf *pUInBuf,
953 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700954{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800955 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800956
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -0800977 /* Note that this is not where allocation to coalesce
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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -08001001 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001002}
1003
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001004
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -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.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001034 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001035static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001036{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001037 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1038 #error QCBOR_TYPE_ARRAY value not lined up with major type
1039 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001040
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001041 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1042 #error QCBOR_TYPE_MAP value not lined up with major type
1043 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001044
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001045 return (uint8_t)(nCBORMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001046}
1047
1048
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001049/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001050 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001051 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001052 * @param[in] pUInBuf Input buffer to read data item from.
1053 * @param[out] pDecodedItem The filled-in decoded item.
1054 * @param[in] pAllocator The allocator to use for strings or NULL.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001055 *
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 Lundblade3f1318a2021-01-04 18:26:44 -08001063 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1064 *
1065 * This decodes the most primitive / atomic data item. It does
1066 * no combing of data items.
1067 */
1068static QCBORError
1069DecodeAtomicDataItem(UsefulInputBuf *pUInBuf,
1070 QCBORItem *pDecodedItem,
1071 const QCBORInternalAllocator *pAllocator)
1072{
1073 QCBORError uReturn;
1074
1075 /* Get the major type and the argument. The argument could be
1076 * length of more bytes or the value depending on the major
1077 * type. nAdditionalInfo is an encoding of the length of the
1078 * uNumber and is needed to decode floats and doubles.
1079 */
1080 int nMajorType = 0;
1081 uint64_t uArgument = 0;
1082 int nAdditionalInfo = 0;
1083
1084 memset(pDecodedItem, 0, sizeof(QCBORItem));
1085
1086 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1087 if(uReturn) {
1088 goto Done;
1089 }
1090
1091 /* At this point the major type and the argument are valid. We've
1092 * got the type and the argument that starts every CBOR data item.
1093 */
1094 switch (nMajorType) {
1095 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1096 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
1097 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1098 uReturn = QCBOR_ERR_BAD_INT;
1099 } else {
1100 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
1101 }
1102 break;
1103
1104 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1105 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1106 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
1107 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1108 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
1109 } else {
1110 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
1111 }
1112 break;
1113
1114 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1115 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
1116 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1117 /* Indefinite-length string. */
1118#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1119 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1120#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1121 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1122 break;
1123#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1124 } else {
1125 /* Definite-length string. */
1126 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1127 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1128 goto Done;
1129 }
1130 /* cast OK because of check above */
1131 pDecodedItem->val.uCount = (uint16_t)uArgument;
1132 }
1133 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
1134 break;
1135
1136 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
1137 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1138 uReturn = QCBOR_ERR_BAD_INT;
1139 } else {
1140 pDecodedItem->val.uTagV = uArgument;
1141 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1142 }
1143 break;
1144
1145 case CBOR_MAJOR_TYPE_SIMPLE:
1146 /* Major type 7: float, double, true, false, null... */
1147 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
1148 break;
1149
1150 default:
1151 /* Never happens because DecodeHead() should never return > 7 */
1152 uReturn = QCBOR_ERR_UNSUPPORTED;
1153 break;
1154 }
1155
1156Done:
1157 return uReturn;
1158}
1159
1160
1161/**
1162 * @brief Process indefinite-length strings (decode layer 5).
1163 *
1164 * @param[in] pMe Decoder context
1165 * @param[out] pDecodedItem The decoded item that work is done on.
1166 *
1167 * @retval QCBOR_ERR_UNSUPPORTED
1168 * @retval QCBOR_ERR_HIT_END
1169 * @retval QCBOR_ERR_INT_OVERFLOW
1170 * @retval QCBOR_ERR_STRING_ALLOCATE
1171 * @retval QCBOR_ERR_STRING_TOO_LONG
1172 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1173 * @retval QCBOR_ERR_BAD_TYPE_7
1174 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001175 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1176 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001177 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001178 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001179 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001180 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001181 * If it is, this loops getting the subsequent chunk data items that
1182 * make up the string. The string allocator is used to make a
1183 * contiguous buffer for the chunks. When this completes @c
1184 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001185 *
1186 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001187 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001188static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001189QCBORDecode_GetNextFullString(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001190{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001191 /* Aproximate stack usage
1192 * 64-bit 32-bit
1193 * local vars 32 16
1194 * 2 UsefulBufs 32 16
1195 * QCBORItem 56 52
1196 * TOTAL 120 74
1197 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001198
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001199 /* The string allocator is used here for two purposes: 1)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001200 * coalescing the chunks of an indefinite-length string, 2)
1201 * allocating storage for every string returned when requested.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001202 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001203 * The first use is below in this function. Indefinite-length
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001204 * strings cannot be processed at all without a string allocator.
1205 *
1206 * The second used is in DecodeBytes() which is called by
1207 * GetNext_Item() below. This second use unneccessary for most use
1208 * and only happens when requested in the call to
1209 * QCBORDecode_SetMemPool(). If the second use not requested then
1210 * NULL is passed for the string allocator to GetNext_Item().
1211 *
1212 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1213 * allocator altogether and thus both of these uses. It reduced the
1214 * decoder object code by about 400 bytes.
1215 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001216 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001217
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001218#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001219 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001220
1221 if(pMe->StringAllocator.pfAllocator) {
1222 pAllocator = &(pMe->StringAllocator);
1223 if(pMe->bStringAllocateAll) {
1224 pAllocatorForGetNext = pAllocator;
1225 }
1226 }
1227#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1228
1229 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001230 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001231 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001232 goto Done;
1233 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001234
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001235 /* Only do indefinite-length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001236 const uint8_t uStringType = pDecodedItem->uDataType;
1237 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001238 goto Done;
1239 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001240
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001241 /* Is this a string with an indefinite length? */
1242 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1243 goto Done;
1244 }
1245
1246#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001247 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001248 if(pAllocator == NULL) {
1249 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1250 goto Done;
1251 }
1252
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001253 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001254 UsefulBufC FullString = NULLUsefulBufC;
1255
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001256 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001257 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001258 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001259 /* Pass a NULL string allocator to GetNext_Item() because the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001260 * individual string chunks in an indefinite-length should not
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001261 * be allocated. They are always copied in the the contiguous
1262 * buffer allocated here.
1263 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001264 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), &StringChunkItem, NULL);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001265 if(uReturn) {
1266 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001267 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001268
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001269 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001270 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001271 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001272 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301273 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001274 break;
1275 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001276
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001277 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001278 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001279 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001280 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001281 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001282 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001283 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1284 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001285 break;
1286 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001287
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001288 /* The first time throurgh FullString.ptr is NULL and this is
1289 * equivalent to StringAllocator_Allocate(). Subsequently it is
1290 * not NULL and a reallocation happens.
1291 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001292 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
1293 UNCONST_POINTER(FullString.ptr),
1294 FullString.len + StringChunkItem.val.string.len);
1295
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001296 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001297 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001298 break;
1299 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001300
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001301 /* Copy new string chunk to the end of accumulated string */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001302 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001303 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001304
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001305 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1306 /* Getting the item failed, clean up the allocated memory */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001307 StringAllocator_Free(pAllocator, UNCONST_POINTER(FullString.ptr));
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001308 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001309#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1310 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1311#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001312
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001313Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001314 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001315}
1316
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001317
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001318/**
1319 * @brief This converts a tag number to a shorter mapped value for storage.
1320 *
1321 * @param[in] pMe The decode context.
1322 * @param[in] uUnMappedTag The tag number to map
1323 * @param[out] puMappedTagNumer The stored tag number.
1324 *
1325 * @return error code.
1326 *
1327 * The main point of mapping tag numbers is make QCBORItem
1328 * smaller. With this mapping storage of 4 tags takes up 8
1329 * bytes. Without, it would take up 32 bytes.
1330 *
1331 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1332 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1333 *
1334 * See also UnMapTagNumber() and @ref QCBORItem.
1335 */
1336static inline QCBORError
1337MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1338{
1339 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1340 unsigned uTagMapIndex;
1341 /* Is there room in the tag map, or is it in it already? */
1342 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1343 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1344 break;
1345 }
1346 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1347 break;
1348 }
1349 }
1350 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1351 return QCBOR_ERR_TOO_MANY_TAGS;
1352 }
1353
1354 /* Covers the cases where tag is new and were it is already in the map */
1355 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1356 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1357
1358 } else {
1359 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1360 }
1361
1362 return QCBOR_SUCCESS;
1363}
1364
1365
1366/**
1367 * @brief This converts a mapped tag number to the actual tag number.
1368 *
1369 * @param[in] pMe The decode context.
1370 * @param[in] uMappedTagNumber The stored tag number.
1371 *
1372 * @return The actual tag number is returned or
1373 * @ref CBOR_TAG_INVALID64 on error.
1374 *
1375 * This is the reverse of MapTagNumber()
1376 */
1377static uint64_t
1378UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1379{
1380 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1381 return uMappedTagNumber;
1382 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001383 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001384 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001385 /* This won't be negative because of code below in
1386 * MapTagNumber()
1387 */
1388 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1389 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001390 }
1391}
1392
Laurence Lundblade9b334962020-08-27 10:55:53 -07001393
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001394/**
1395 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1396 *
1397 * @param[in] pMe Decoder context
1398 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001399
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001400 * @retval QCBOR_ERR_UNSUPPORTED
1401 * @retval QCBOR_ERR_HIT_END
1402 * @retval QCBOR_ERR_INT_OVERFLOW
1403 * @retval QCBOR_ERR_STRING_ALLOCATE
1404 * @retval QCBOR_ERR_STRING_TOO_LONG
1405 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1406 * @retval QCBOR_ERR_BAD_TYPE_7
1407 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1408 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1409 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1410 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1411 * @retval QCBOR_ERR_TOO_MANY_TAGS
1412 *
1413 * This loops getting atomic data items until one is not a tag
1414 * number. Usually this is largely pass-through because most
1415 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001416 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001417static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001418QCBORDecode_GetNextTagNumber(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001419{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001420 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1421
1422 /* Initialize to CBOR_TAG_INVALID16 */
1423 #if CBOR_TAG_INVALID16 != 0xffff
1424 /* Be sure the memset does the right thing. */
1425 #err CBOR_TAG_INVALID16 tag not defined as expected
1426 #endif
1427 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001428
Laurence Lundblade9b334962020-08-27 10:55:53 -07001429 QCBORError uReturn = QCBOR_SUCCESS;
1430
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001431 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001432 for(;;) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001433 QCBORError uErr = QCBORDecode_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001434 if(uErr != QCBOR_SUCCESS) {
1435 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001436 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001437 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001438
Laurence Lundblade9b334962020-08-27 10:55:53 -07001439 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001440 /* Successful exit from loop; maybe got some tags, maybe not */
1441 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001442 break;
1443 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001444
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001445 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1446 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001447 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001448 /* Continue on to get all tags wrapping this item even though
1449 * it is erroring out in the end. This allows decoding to
1450 * continue. This is a resource limit error, not a problem
1451 * with being well-formed CBOR.
1452 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001453 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001454 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001455 /* Slide tags over one in the array to make room at index 0.
1456 * Must use memmove because the move source and destination
1457 * overlap.
1458 */
1459 memmove(&auItemsTags[1], auItemsTags, sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001460
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001461 /* Map the tag */
1462 uint16_t uMappedTagNumer;
1463 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumer);
1464 /* Continue even on error so as to consume all tags wrapping
1465 * this data item so decoding can go on. If MapTagNumber()
1466 * errors once it will continue to error.
1467 */
1468 auItemsTags[0] = uMappedTagNumer;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001469 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001470
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001471Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001472 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001473}
1474
1475
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001476/**
1477 * @brief Combine a map entry label and value into one item (decode layer 3).
1478 *
1479 * @param[in] pMe Decoder context
1480 * @param[out] pDecodedItem The decoded item that work is done on.
1481 *
1482 * @retval QCBOR_ERR_UNSUPPORTED
1483 * @retval QCBOR_ERR_HIT_END
1484 * @retval QCBOR_ERR_INT_OVERFLOW
1485 * @retval QCBOR_ERR_STRING_ALLOCATE
1486 * @retval QCBOR_ERR_STRING_TOO_LONG
1487 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1488 * @retval QCBOR_ERR_BAD_TYPE_7
1489 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1490 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1491 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1492 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1493 * @retval QCBOR_ERR_TOO_MANY_TAGS
1494 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1495 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1496 *
1497 * If a the current nesting level is a map, then this
1498 * combines pairs of items into one data item with a label
1499 * and value.
1500 *
1501 * This is pass-through if the current nesting leve is
1502 * not a map.
1503 *
1504 * This also implements maps-as-array mode where a map
1505 * is treated like an array to allow caller to do their
1506 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001507 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001508static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001509QCBORDecode_GetNextMapEntry(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001510{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001511 QCBORError uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1512 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001513 goto Done;
1514 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001515
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001516 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1517 /* Break can't be a map entry */
1518 goto Done;
1519 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001520
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001521 if(pMe->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1522 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001523
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001524 if(DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1525 /* Save label in pDecodedItem and get the next which will
1526 * be the real data item.
1527 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001528 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001529 uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1530 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001531 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001532 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001533
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301534 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001535
1536 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001537 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001538 pDecodedItem->label.string = LabelItem.val.string;
1539 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001540 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == pMe->uDecodeMode) {
1541 /* It's not a string and we only want strings */
1542 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001543 goto Done;
1544 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1545 pDecodedItem->label.int64 = LabelItem.val.int64;
1546 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1547 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1548 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1549 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1550 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1551 pDecodedItem->label.string = LabelItem.val.string;
1552 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1553 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1554 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001555 /* label is not an int or a string. It is an arrray
1556 * or a float or such and this implementation doesn't handle that.
1557 * Also, tags on labels are ignored.
1558 */
1559 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001560 goto Done;
1561 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001562 }
1563 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001564 /* Decoding of maps as arrays to let the caller decide what to do
1565 * about labels, particularly lables that are not integers or
1566 * strings.
1567 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001568 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001569 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001570 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001571 goto Done;
1572 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001573 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001574 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1575 * Cast is needed because of integer promotion.
1576 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001577 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001578 }
1579 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001580
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001581Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001582 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001583}
1584
1585
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001586#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001587/**
1588 * @brief Peek and see if next data item is a break;
1589 *
1590 * @param[in] pUIB UsefulInputBuf to read from.
1591 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1592 *
1593 * @return Any decoding error.
1594 *
1595 * See if next item is a CBOR break. If it is, it is consumed,
1596 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001597*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001598static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001599NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1600{
1601 *pbNextIsBreak = false;
1602 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001603 QCBORItem Peek;
1604 size_t uPeek = UsefulInputBuf_Tell(pUIB);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001605 QCBORError uReturn = DecodeAtomicDataItem(pUIB, &Peek, NULL);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001606 if(uReturn != QCBOR_SUCCESS) {
1607 return uReturn;
1608 }
1609 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001610 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001611 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001612 } else {
1613 *pbNextIsBreak = true;
1614 }
1615 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001616
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001617 return QCBOR_SUCCESS;
1618}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001619#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001620
1621
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001622/**
1623 * @brief Ascend up nesting levels if all items in them have been consumed.
1624 *
1625 * @param[in] pMe The decode context.
1626 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1627 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001628 * An item was just consumed, now figure out if it was the
1629 * end of an array/map map that can be closed out. That
1630 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001631*/
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001632static QCBORError
1633QCBORDecode_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001634{
1635 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001636
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001637 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001638 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1639
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001640 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1641 /* Nesting level is bstr-wrapped CBOR */
1642
1643 /* Ascent for bstr-wrapped CBOR is always by explicit call
1644 * so no further ascending can happen.
1645 */
1646 break;
1647
1648 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1649 /* Level is a definite-length array/map */
1650
1651 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001652 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1653 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001654 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001655 break;
1656 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001657 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001658 * is time to ascend one level. This happens below.
1659 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001660
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001661#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001662 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001663 /* Level is an indefinite-length array/map. */
1664
1665 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001666 bool bIsBreak = false;
1667 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1668 if(uReturn != QCBOR_SUCCESS) {
1669 goto Done;
1670 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001671
1672 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001673 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001674 break;
1675 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001676
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001677 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001678 * it is time to ascend one level.
1679 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001680
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001681#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001682 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001683
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001684
1685 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001686
Laurence Lundblade93d89472020-10-03 22:30:50 -07001687 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001688 * QCBORDecode_ExitBoundedMode().
1689 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001690 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001691 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001692 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001693 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001694 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001695 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001696
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001697 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001698 break;
1699 }
1700
1701 /* Finally, actually ascend one level. */
1702 DecodeNesting_Ascend(&(pMe->nesting));
1703 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001704
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001705 uReturn = QCBOR_SUCCESS;
1706
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001707#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001708Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001709#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1710
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001711 return uReturn;
1712}
1713
1714
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001715/**
1716 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1717 *
1718 * @param[in] pMe Decoder context
1719 * @param[out] pDecodedItem The decoded item that work is done on.
1720 *
1721 * @retval QCBOR_ERR_UNSUPPORTED
1722 * @retval QCBOR_ERR_HIT_END
1723 * @retval QCBOR_ERR_INT_OVERFLOW
1724 * @retval QCBOR_ERR_STRING_ALLOCATE
1725 * @retval QCBOR_ERR_STRING_TOO_LONG
1726 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1727 * @retval QCBOR_ERR_BAD_TYPE_7
1728 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1729 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1730 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1731 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1732 * @retval QCBOR_ERR_TOO_MANY_TAGS
1733 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1734 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1735 * @retval QCBOR_ERR_NO_MORE_ITEMS
1736 * @retval QCBOR_ERR_BAD_BREAK
1737 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
1738 *
1739 * This handles the traversal descending into and asecnding out of
1740 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
1741 * definite- and indefinte-length maps and arrays by looking at the
1742 * item count or finding CBOR breaks. It detects the ends of the
1743 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001744 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001745static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001746QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001747{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001748 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001749 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001750
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001751 /* If out of bytes to consume, it is either the end of the
1752 * top-level sequence of some bstr-wrapped CBOR that was entered.
1753 *
1754 * In the case of bstr-wrapped CBOR, the length of the
1755 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
1756 * the bstr-wrapped CBOR is exited, the length is set back to the
1757 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001758 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001759 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001760 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001761 goto Done;
1762 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001763
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001764 /* Check to see if at the end of a bounded definite-length map or
1765 * array. The check for a break ending indefinite-length array is
1766 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001767 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001768 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001769 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001770 goto Done;
1771 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001772
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001773 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001774 uReturn = QCBORDecode_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001775 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1776 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001777 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001778 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301779
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001780 /* Breaks ending arrays/maps are processed later in the call to
1781 * QCBORDecode_NestLevelAscender(). They should never show up here.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001782 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301783 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001784 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301785 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301786 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001787
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001788 /* Record the nesting level for this data item before processing
1789 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001790 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001791 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001792
Laurence Lundblade642282a2020-06-23 12:00:33 -07001793
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001794 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001795 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001796 /* If the new item is a map or array, descend.
1797 *
1798 * Empty indefinite-length maps and arrays are descended into,
1799 * but then ascended out of in the next chunk of code.
1800 *
1801 * Maps and arrays do count as items in the map/array that
1802 * encloses them so a decrement needs to be done for them too,
1803 * but that is done only when all the items in them have been
1804 * processed, not when they are opened with the exception of an
1805 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001806 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001807 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001808 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001809 pDecodedItem->uDataType,
1810 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001811 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001812 /* This error is probably a traversal error and it overrides
1813 * the non-traversal error.
1814 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001815 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001816 goto Done;
1817 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001818 }
1819
Laurence Lundblade02625d42020-06-25 14:41:41 -07001820 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1821 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1822 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001823 /* The following cases are handled here:
1824 * - A non-aggregate item like an integer or string
1825 * - An empty definite-length map or array
1826 * - An indefinite-length map or array that might be empty or might not.
1827 *
1828 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
1829 * for an definite-length map/array and break detection for an
1830 * indefinite-0length map/array. If the end of the map/array was
1831 * reached, then it ascends nesting levels, possibly all the way
1832 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001833 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001834 QCBORError uAscendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001835 uAscendErr = QCBORDecode_NestLevelAscender(pMe, true);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001836 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001837 /* This error is probably a traversal error and it overrides
1838 * the non-traversal error.
1839 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001840 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001841 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001842 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301843 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001844
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001845 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001846 /* Tell the caller what level is next. This tells them what
1847 * maps/arrays were closed out and makes it possible for them to
1848 * reconstruct the tree with just the information returned in a
1849 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001850 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001851 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001852 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001853 pDecodedItem->uNextNestLevel = 0;
1854 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001855 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001856 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001857
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001858Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001859 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001860}
1861
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001862
1863/**
1864 * @brief Shift 0th tag out of the tag list.
1865 *
1866 * pDecodedItem[in,out] The data item to convert.
1867 *
1868 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
1869 * shifted into empty slot at the end of the tag list.
1870 */
1871static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001872{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -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 Lundblade3f1318a2021-01-04 18:26:44 -08001880/**
1881 * @brief Convert different epoch date formats in to the QCBOR epoch date format
1882 *
1883 * pDecodedItem[in,out] The data item to convert.
1884 *
1885 * @retval QCBOR_ERR_DATE_OVERFLOW
1886 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1887 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1888 *
1889 * The epoch date tag defined in QCBOR allows for floating-point
1890 * dates. It even allows a protocol to flop between date formats when
1891 * ever it wants. Floating-point dates aren't that useful as they are
1892 * only needed for dates beyond the age of the earth.
1893 *
1894 * This converts all the date formats into one format of an unsigned
1895 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001896 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001897static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001898{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001899 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001900
1901 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1902
1903 switch (pDecodedItem->uDataType) {
1904
1905 case QCBOR_TYPE_INT64:
1906 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1907 break;
1908
1909 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001910 /* This only happens for CBOR type 0 > INT64_MAX so it is
1911 * always an overflow.
1912 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001913 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1914 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001915 break;
1916
1917 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001918 case QCBOR_TYPE_FLOAT:
1919#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001920 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001921 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001922 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001923 pDecodedItem->val.dfnum :
1924 (double)pDecodedItem->val.fnum;
1925
1926 /* The conversion from float to integer requires overflow
1927 * detection since floats can be much larger than integers.
1928 * This implementation errors out on these large float values
1929 * since they are beyond the age of the earth.
1930 *
1931 * These constants for the overflow check are computed by the
1932 * compiler. They are not computed at run time.
1933 *
1934 * The factor of 0x7ff is added/subtracted to avoid a
1935 * rounding error in the wrong direction when the compiler
1936 * computes these constants. There is rounding because an
1937 * 64-bit integer has 63 bits of precision where a double
1938 * only has 53 bits. Without the 0x7ff factor, the compiler
1939 * may round up and produce a double for the bounds check
1940 * that is larger than can be stored in a 64-bit integer. The
1941 * amount of 0x7ff is picked because it has 11 bits set.
1942 *
1943 * Without the 0x7ff there is a ~30 minute range of time
1944 * values 10 billion years in the past and in the future
1945 * where this code could go wrong. Some compilers correctly
1946 * generate a warning or error without the 0x7ff.
1947 */
1948 const double dDateMax = (double)(INT64_MAX - 0x7ff);
1949 const double dDateMin = (double)(INT64_MIN + 0x7ff);
1950
1951 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07001952 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001953 goto Done;
1954 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001955
1956 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001957 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001958 pDecodedItem->val.epochDate.fSecondsFraction =
1959 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001960 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001961#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07001962
Laurence Lundbladec7114722020-08-13 05:11:40 -07001963 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001964 goto Done;
1965
Laurence Lundblade9682a532020-06-06 18:33:04 -07001966#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001967 break;
1968
1969 default:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001970 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001971 goto Done;
1972 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001973
Laurence Lundblade59289e52019-12-30 13:44:37 -08001974 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1975
1976Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001977 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001978}
1979
1980
1981#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001982/**
1983 * @brief Decode decimal fractions and big floats.
1984 *
1985 * @param[in] pMe The decode context.
1986 * @param[in,out] pDecodedItem On input the array data item that
1987 * holds the mantissa and exponent. On
1988 * output the decoded mantissa and
1989 * exponent.
1990 *
1991 * @returns Decoding errors from getting primitive data items or
1992 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
1993 *
1994 * When called pDecodedItem must be the array that is tagged as a big
1995 * float or decimal fraction, the array that has the two members, the
1996 * exponent and mantissa.
1997 *
1998 * This will fetch and decode the exponent and mantissa and put the
1999 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002000 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002001static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002002QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002003{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002004 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002005
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002006 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002007 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002008 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002009 goto Done;
2010 }
2011
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002012 /* A check for pDecodedItem->val.uCount == 2 would work for
2013 * definite-length arrays, but not for indefnite. Instead remember
2014 * the nesting level the two integers must be at, which is one
2015 * deeper than that of the array.
2016 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002017 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2018
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002019 /* --- Which is it, decimal fraction or a bigfloat? --- */
2020 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002021 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2022
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002023 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002024 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002025 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2026 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002027 goto Done;
2028 }
2029 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002030 /* Array is empty or a map/array encountered when expecting an int */
2031 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002032 goto Done;
2033 }
2034 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002035 /* Data arriving as an unsigned int < INT64_MAX has been
2036 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2037 * also means that the only data arriving here of type
2038 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2039 * and thus an error that will get handled in the next else.
2040 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002041 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2042 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002043 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2044 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002045 goto Done;
2046 }
2047
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002048 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002049 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002050 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2051 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002052 goto Done;
2053 }
2054 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002055 /* Mantissa missing or map/array encountered when expecting number */
2056 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002057 goto Done;
2058 }
2059 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002060 /* Data arriving as an unsigned int < INT64_MAX has been
2061 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2062 * also means that the only data arriving here of type
2063 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2064 * and thus an error that will get handled in an else below.
2065 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002066 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002067 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2068 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002069 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002070 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002071 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002072 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2073 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2074 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002075 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002076 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2077 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002078 goto Done;
2079 }
2080
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002081 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002082 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002083 /* Extra items in the decimal fraction / big float */
2084 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002085 goto Done;
2086 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002087 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002088
2089Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002090 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002091}
2092#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
2093
2094
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002095#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002096/**
2097 * @brief Decode the MIME type tag
2098 *
2099 * @param[in,out] pDecodedItem The item to decode.
2100 *
2101 * Handle the text and binary MIME type tags. Slightly too complicated
2102 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2103 * incorreclty text-only.
2104 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002105static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002106{
2107 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2108 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002109 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002110 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2111 } else {
2112 return QCBOR_ERR_BAD_OPT_TAG;
2113 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002114
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002115 return QCBOR_SUCCESS;
2116}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002117#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002118
2119
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002120/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002121 * Table of CBOR tags whose content is either a text string or a byte
2122 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2123 * of uQCBORtype indicates the content should be a byte string rather
2124 * than a text string
2125 */
2126struct StringTagMapEntry {
2127 uint16_t uTagNumber;
2128 uint8_t uQCBORtype;
2129};
2130
2131#define IS_BYTE_STRING_BIT 0x80
2132#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2133
2134static const struct StringTagMapEntry StringTagMap[] = {
2135 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
2136 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2137 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2138 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2139 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002140#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002141 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2142 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2143 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2144 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002145#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002146 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2147 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2148};
2149
2150
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002151/**
2152 * @brief Process standard CBOR tags whose content is a string
2153 *
2154 * @param[in] uTag The tag.
2155 * @param[in,out] pDecodedItem The data item.
2156 *
2157 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2158 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2159 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2160 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002161 * Process the CBOR tags that whose content is a byte string or a text
2162 * string and for which the string is just passed on to the caller.
2163 *
2164 * This maps the CBOR tag to the QCBOR type and checks the content
2165 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002166 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002167 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002168 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002169static inline QCBORError
2170ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002171{
Laurence Lundblade99615302020-11-29 11:19:47 -08002172 /* This only works on tags that were not mapped; no need for other yet */
2173 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2174 return QCBOR_ERR_UNSUPPORTED;
2175 }
2176
2177 unsigned uIndex;
2178 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2179 if(StringTagMap[uIndex].uTagNumber == uTag) {
2180 break;
2181 }
2182 }
2183
2184 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2185 if(uQCBORType == QCBOR_TYPE_NONE) {
2186 /* repurpose this error to mean, not handled here */
2187 return QCBOR_ERR_UNSUPPORTED;
2188 }
2189
2190 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2191 if(uQCBORType & IS_BYTE_STRING_BIT) {
2192 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2193 }
2194
2195 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002196 return QCBOR_ERR_BAD_OPT_TAG;
2197 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002198
Laurence Lundblade99615302020-11-29 11:19:47 -08002199 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002200 return QCBOR_SUCCESS;
2201}
2202
2203
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002204/**
2205 * @brief Decode tag content for select tags (decoding layer 1).
2206 *
2207 * @param[in] pMe The decode context.
2208 * @param[out] pDecodedItem The decoded item.
2209 *
2210 * @return Decoding error code.
2211 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002212 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2213 * but the whole tag was not decoded. Here, the whole tags (tag number
2214 * and tag content) that are supported by QCBOR are decoded. This is a
2215 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002216 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002217static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002218QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002219{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002220 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002221
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002222 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002223 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002224 goto Done;
2225 }
2226
Laurence Lundblade99615302020-11-29 11:19:47 -08002227 /* When there are no tag numbers for the item, this exits first
2228 * thing and effectively does nothing.
2229 *
2230 * This loops over all the tag numbers accumulated for this item
2231 * trying to decode and interpret them. This stops at the end of
2232 * the list or at the first tag number that can't be interpreted by
2233 * this code. This is effectively a recursive processing of the
2234 * tags number list that handles nested tags.
2235 */
2236 while(1) {
2237 /* Don't bother to unmap tags via QCBORITem.uTags since this
2238 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2239 */
2240 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002241
Laurence Lundblade99615302020-11-29 11:19:47 -08002242 if(uTagToProcess == CBOR_TAG_INVALID16) {
2243 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002244 break;
2245
Laurence Lundblade99615302020-11-29 11:19:47 -08002246 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002247 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002248
Laurence Lundblade93d89472020-10-03 22:30:50 -07002249#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002250 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2251 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002252 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundblade93d89472020-10-03 22:30:50 -07002253#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002254#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002255 } else if(uTagToProcess == CBOR_TAG_MIME ||
2256 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002257 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002258#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002259
Laurence Lundblade99615302020-11-29 11:19:47 -08002260 } else {
2261 /* See if it is a pass-through byte/text string tag; process if so */
2262 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002263
Laurence Lundblade99615302020-11-29 11:19:47 -08002264 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2265 /* It wasn't a pass-through byte/text string tag so it is
2266 * an unknown tag. This is the exit from the loop on the
2267 * first unknown tag. It is a successful exit.
2268 */
2269 uReturn = QCBOR_SUCCESS;
2270 break;
2271 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002272 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002273
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002274 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002275 /* Error exit from the loop */
2276 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002277 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002278
2279 /* A tag was successfully processed, shift it out of the list of
2280 * tags returned. This is the loop increment.
2281 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002282 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002283 }
2284
2285Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002286 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002287}
2288
2289
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002290/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002291 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002292 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002293QCBORError
2294QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2295{
2296 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002297 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002298 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002299 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2300 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2301 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002302 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002303}
2304
2305
2306/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002307 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002308 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002309QCBORError
2310QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2311{
2312 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2313 const UsefulInputBuf Save = pMe->InBuf;
2314
2315 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2316
2317 pMe->nesting = SaveNesting;
2318 pMe->InBuf = Save;
2319
2320 return uErr;
2321}
2322
2323
2324/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002325 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002326 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002327void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2328{
2329 if(pMe->uLastError != QCBOR_SUCCESS) {
2330 return;
2331 }
2332
2333 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2334}
2335
2336
2337/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002338 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002339 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002340QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002341QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2342 QCBORItem *pDecodedItem,
2343 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002344{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002345 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002346
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2348 if(uReturn != QCBOR_SUCCESS) {
2349 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002350 }
2351
2352 if(pTags != NULL) {
2353 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002354 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002355 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2356 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002357 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002358 }
2359 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2360 return QCBOR_ERR_TOO_MANY_TAGS;
2361 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002362 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002363 pTags->uNumUsed++;
2364 }
2365 }
2366
2367 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002368}
2369
2370
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002371/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002372 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302373 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002374bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002375 const QCBORItem *pItem,
2376 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002377{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002378 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2379 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002380 break;
2381 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002382 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002383 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002384 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002385 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002386
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002387 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002388}
2389
2390
2391/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002392 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002393 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002394QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002395{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002396 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002397
2398 if(uReturn != QCBOR_SUCCESS) {
2399 goto Done;
2400 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002401
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002402 /* Error out if all the maps/arrays are not closed out */
2403 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002404 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002405 goto Done;
2406 }
2407
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002408 /* Error out if not all the bytes are consumed */
2409 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002410 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002411 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002412
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002413Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002414#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002415 /* Call the destructor for the string allocator if there is one.
2416 * Always called, even if there are errors; always have to clean up.
2417 */
2418 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002419#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002420
Laurence Lundblade085d7952020-07-24 10:26:30 -07002421 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002422}
2423
2424
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002425/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002426 * Public function, see header qcbor/qcbor_decode.h file
2427 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002428// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002429uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2430 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002431 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002432{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002433 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2434 return CBOR_TAG_INVALID64;
2435 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002436 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2437 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002438 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002439 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002440 }
2441}
2442
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002443
Laurence Lundblade9b334962020-08-27 10:55:53 -07002444/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002445 * Public function, see header qcbor/qcbor_decode.h file
2446 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002447uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2448 uint32_t uIndex)
2449{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002450 if(pMe->uLastError != QCBOR_SUCCESS) {
2451 return CBOR_TAG_INVALID64;
2452 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002453 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2454 return CBOR_TAG_INVALID64;
2455 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002456 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002457 }
2458}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002459
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002460
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002461
2462
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002463#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002464
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002465/* ===========================================================================
2466 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002467
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002468 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002469 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2470 implements the function type QCBORStringAllocate and allows easy
2471 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002472
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002473 This particular allocator is built-in for convenience. The caller
2474 can implement their own. All of this following code will get
2475 dead-stripped if QCBORDecode_SetMemPool() is not called.
2476
2477 This is a very primitive memory allocator. It does not track
2478 individual allocations, only a high-water mark. A free or
2479 reallocation must be of the last chunk allocated.
2480
2481 The size of the pool and offset to free memory are packed into the
2482 first 8 bytes of the memory pool so we don't have to keep them in
2483 the decode context. Since the address of the pool may not be
2484 aligned, they have to be packed and unpacked as if they were
2485 serialized data of the wire or such.
2486
2487 The sizes packed in are uint32_t to be the same on all CPU types
2488 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002489 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002490
2491
Laurence Lundbladeee851742020-01-08 08:37:05 -08002492static inline int
2493MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002494{
2495 // Use of UsefulInputBuf is overkill, but it is convenient.
2496 UsefulInputBuf UIB;
2497
Laurence Lundbladeee851742020-01-08 08:37:05 -08002498 // Just assume the size here. It was checked during SetUp so
2499 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002500 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002501 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2502 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2503 return UsefulInputBuf_GetError(&UIB);
2504}
2505
2506
Laurence Lundbladeee851742020-01-08 08:37:05 -08002507static inline int
2508MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002509{
2510 // Use of UsefulOutBuf is overkill, but convenient. The
2511 // length check performed here is useful.
2512 UsefulOutBuf UOB;
2513
2514 UsefulOutBuf_Init(&UOB, Pool);
2515 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2516 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2517 return UsefulOutBuf_GetError(&UOB);
2518}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002519
2520
2521/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002522 Internal function for an allocation, reallocation free and destuct.
2523
2524 Having only one function rather than one each per mode saves space in
2525 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002526
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002527 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2528 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002529static UsefulBuf
2530MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002531{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002532 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002533
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002534 uint32_t uPoolSize;
2535 uint32_t uFreeOffset;
2536
2537 if(uNewSize > UINT32_MAX) {
2538 // This allocator is only good up to 4GB. This check should
2539 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2540 goto Done;
2541 }
2542 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2543
2544 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2545 goto Done;
2546 }
2547
2548 if(uNewSize) {
2549 if(pMem) {
2550 // REALLOCATION MODE
2551 // Calculate pointer to the end of the memory pool. It is
2552 // assumed that pPool + uPoolSize won't wrap around by
2553 // assuming the caller won't pass a pool buffer in that is
2554 // not in legitimate memory space.
2555 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2556
2557 // Check that the pointer for reallocation is in the range of the
2558 // pool. This also makes sure that pointer math further down
2559 // doesn't wrap under or over.
2560 if(pMem >= pPool && pMem < pPoolEnd) {
2561 // Offset to start of chunk for reallocation. This won't
2562 // wrap under because of check that pMem >= pPool. Cast
2563 // is safe because the pool is always less than UINT32_MAX
2564 // because of check in QCBORDecode_SetMemPool().
2565 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2566
2567 // Check to see if the allocation will fit. uPoolSize -
2568 // uMemOffset will not wrap under because of check that
2569 // pMem is in the range of the uPoolSize by check above.
2570 if(uNewSize <= uPoolSize - uMemOffset) {
2571 ReturnValue.ptr = pMem;
2572 ReturnValue.len = uNewSize;
2573
2574 // Addition won't wrap around over because uNewSize was
2575 // checked to be sure it is less than the pool size.
2576 uFreeOffset = uMemOffset + uNewSize32;
2577 }
2578 }
2579 } else {
2580 // ALLOCATION MODE
2581 // uPoolSize - uFreeOffset will not underflow because this
2582 // pool implementation makes sure uFreeOffset is always
2583 // smaller than uPoolSize through this check here and
2584 // reallocation case.
2585 if(uNewSize <= uPoolSize - uFreeOffset) {
2586 ReturnValue.len = uNewSize;
2587 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002588 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002589 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002590 }
2591 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002592 if(pMem) {
2593 // FREE MODE
2594 // Cast is safe because of limit on pool size in
2595 // QCBORDecode_SetMemPool()
2596 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2597 } else {
2598 // DESTRUCT MODE
2599 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002600 }
2601 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002602
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002603 UsefulBuf Pool = {pPool, uPoolSize};
2604 MemPool_Pack(Pool, uFreeOffset);
2605
2606Done:
2607 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002608}
2609
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002610
Laurence Lundbladef6531662018-12-04 10:42:22 +09002611/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002612 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002613 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002614QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2615 UsefulBuf Pool,
2616 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002617{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002618 // The pool size and free mem offset are packed into the beginning
2619 // of the pool memory. This compile time check make sure the
2620 // constant in the header is correct. This check should optimize
2621 // down to nothing.
2622 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002623 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002624 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002625
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002626 // The pool size and free offset packed in to the beginning of pool
2627 // memory are only 32-bits. This check will optimize out on 32-bit
2628 // machines.
2629 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002630 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002631 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002632
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002633 // This checks that the pool buffer given is big enough.
2634 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002635 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002636 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002637
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002638 pMe->StringAllocator.pfAllocator = MemPool_Function;
2639 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2640 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002641
Laurence Lundblade30816f22018-11-10 13:40:22 +07002642 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002643}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002644#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002645
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002646
2647
Laurence Lundblade9b334962020-08-27 10:55:53 -07002648static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2649{
2650 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2651}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002652
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002653
2654/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002655 Consume an entire map or array (and do next to
2656 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002657 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002658static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002659ConsumeItem(QCBORDecodeContext *pMe,
2660 const QCBORItem *pItemToConsume,
2661 uint_fast8_t *puNextNestLevel)
2662{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002663 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002664 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002665
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002666 // If it is a map or array, this will tell if it is empty.
2667 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2668
2669 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2670 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002671
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002672 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002673 * maps and arrays by using the nesting level
2674 */
2675 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002676 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002677 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002678 goto Done;
2679 }
2680 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002681
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002682 *puNextNestLevel = Item.uNextNestLevel;
2683
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002684 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002685
Laurence Lundblade1341c592020-04-11 14:19:05 -07002686 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002687 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002688 /* Just pass the nesting level through */
2689 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2690
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002691 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002692 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002693
2694Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002695 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002696}
2697
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002698
2699void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2700{
2701 uint8_t uNextNestLevel;
2702
2703 QCBORDecode_VGetNext(pMe, pDecodedItem);
2704
2705 if(pMe->uLastError == QCBOR_SUCCESS) {
2706 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem, &uNextNestLevel);
2707 pDecodedItem->uNextNestLevel = uNextNestLevel;
2708 }
2709}
2710
2711
2712
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002713/* Call only on maps and arrays. Rewinds the cursor
2714 * to the start as if it was just entered.
2715 */
2716static void RewindMapOrArray(QCBORDecodeContext *pMe)
2717{
2718 /* Reset nesting tracking to the deepest bounded level */
2719 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2720
2721 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2722
2723 /* Reposition traversal cursor to the start of the map/array */
2724 UsefulInputBuf_Seek(&(pMe->InBuf),
2725 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2726}
2727
2728
2729/*
2730 Public function, see header qcbor/qcbor_decode.h file
2731 */
2732void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2733{
2734 if(pMe->nesting.pCurrentBounded != NULL) {
2735 /* In a bounded map, array or bstr-wrapped CBOR */
2736
2737 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2738 /* In bstr-wrapped CBOR. */
2739
2740 /* Reposition traversal cursor to start of wrapping byte string */
2741 UsefulInputBuf_Seek(&(pMe->InBuf),
2742 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2743 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2744
2745 } else {
2746 /* In a map or array */
2747 RewindMapOrArray(pMe);
2748 }
2749
2750 } else {
2751 /* Not in anything bounded */
2752
2753 /* Reposition traversal cursor to the start of input CBOR */
2754 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2755
2756 /* Reset nesting tracking to beginning of input. */
2757 DecodeNesting_Init(&(pMe->nesting));
2758 }
2759
2760 pMe->uLastError = QCBOR_SUCCESS;
2761}
2762
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002763
Laurence Lundblade1341c592020-04-11 14:19:05 -07002764/* Return true if the labels in Item1 and Item2 are the same.
2765 Works only for integer and string labels. Returns false
2766 for any other type. */
2767static inline bool
2768MatchLabel(QCBORItem Item1, QCBORItem Item2)
2769{
2770 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2771 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2772 return true;
2773 }
2774 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002775 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002776 return true;
2777 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002778 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002779 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2780 return true;
2781 }
2782 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2783 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2784 return true;
2785 }
2786 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002787
Laurence Lundblade1341c592020-04-11 14:19:05 -07002788 /* Other label types are never matched */
2789 return false;
2790}
2791
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002792
2793/*
2794 Returns true if Item1 and Item2 are the same type
2795 or if either are of QCBOR_TYPE_ANY.
2796 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002797static inline bool
2798MatchType(QCBORItem Item1, QCBORItem Item2)
2799{
2800 if(Item1.uDataType == Item2.uDataType) {
2801 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002802 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002803 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002804 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002805 return true;
2806 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002807 return false;
2808}
2809
2810
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002811/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002812 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002813
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002814 @param[in] pMe The decode context to search.
2815 @param[in,out] pItemArray The items to search for and the items found.
2816 @param[out] puOffset Byte offset of last item matched.
2817 @param[in] pCBContext Context for the not-found item call back.
2818 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002819
2820 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2821
Laurence Lundblade93d89472020-10-03 22:30:50 -07002822 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2823 were found for one of the labels being
2824 search for. This duplicate detection is
2825 only performed for items in pItemArray,
2826 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002827
Laurence Lundblade93d89472020-10-03 22:30:50 -07002828 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2829 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002830
2831 @retval Also errors returned by QCBORDecode_GetNext().
2832
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002833 On input pItemArray contains a list of labels and data types
2834 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002835
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002836 On output the fully retrieved items are filled in with
2837 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002838
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002839 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002840
2841 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002842 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002843static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002844MapSearch(QCBORDecodeContext *pMe,
2845 QCBORItem *pItemArray,
2846 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002847 void *pCBContext,
2848 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002849{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002850 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002851 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002852
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002853 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002854 uReturn = pMe->uLastError;
2855 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002856 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002857
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002858 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002859 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2860 /* QCBOR_TYPE_NONE as first item indicates just looking
2861 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002862 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2863 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002864 }
2865
Laurence Lundblade085d7952020-07-24 10:26:30 -07002866 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2867 // It is an empty bounded array or map
2868 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2869 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002870 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002871 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002872 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002873 // Nothing is ever found in an empty array or map. All items
2874 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002875 uReturn = QCBOR_SUCCESS;
2876 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002877 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002878 }
2879
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002880 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002881 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2882
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002883 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002884 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002885
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002886 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002887 Loop over all the items in the map or array. Each item
2888 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002889 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002890 length maps and arrays. The only reason this is ever
2891 called on arrays is to find their end position.
2892
2893 This will always run over all items in order to do
2894 duplicate detection.
2895
2896 This will exit with failure if it encounters an
2897 unrecoverable error, but continue on for recoverable
2898 errors.
2899
2900 If a recoverable error occurs on a matched item, then
2901 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002902 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002903 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002904 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002905 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002906 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002907 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002908
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002909 /* Get the item */
2910 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002911 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002912 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002913 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002914 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002915 goto Done;
2916 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002917 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002918 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002919 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002920 goto Done;
2921 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002922
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002923 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002924 bool bMatched = false;
2925 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2926 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002927 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002928 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2929 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002930 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002931 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002932 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002933 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002934 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002935 goto Done;
2936 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002937
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002938 if(uResult != QCBOR_SUCCESS) {
2939 uReturn = uResult;
2940 goto Done;
2941 }
2942
Laurence Lundblade1341c592020-04-11 14:19:05 -07002943 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002944 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002945 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002946 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002947 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002948 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002949 bMatched = true;
2950 }
2951 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002952
2953
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002954 if(!bMatched && pfCallback != NULL) {
2955 /*
2956 Call the callback on unmatched labels.
2957 (It is tempting to do duplicate detection here, but that would
2958 require dynamic memory allocation because the number of labels
2959 that might be encountered is unbounded.)
2960 */
2961 uReturn = (*pfCallback)(pCBContext, &Item);
2962 if(uReturn != QCBOR_SUCCESS) {
2963 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002964 }
2965 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002966
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002967 /*
2968 Consume the item whether matched or not. This
2969 does the work of traversing maps and array and
2970 everything in them. In this loop only the
2971 items at the current nesting level are examined
2972 to match the labels.
2973 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002974 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002975 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002976 goto Done;
2977 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002978
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002979 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002980
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002981 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002982
2983 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002984
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002985 // Check here makes sure that this won't accidentally be
2986 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002987 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08002988 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
2989 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07002990 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
2991 goto Done;
2992 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002993 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
2994 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002995
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002996 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002997 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
2998
2999 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003000 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003001 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003002 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003003 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3004 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003005 }
3006 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003007
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003008 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003009}
3010
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003011
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003012/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003013 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003014*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003015void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3016 int64_t nLabel,
3017 uint8_t uQcborType,
3018 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003019{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003020 if(pMe->uLastError != QCBOR_SUCCESS) {
3021 return;
3022 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003023
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003024 QCBORItem OneItemSeach[2];
3025 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3026 OneItemSeach[0].label.int64 = nLabel;
3027 OneItemSeach[0].uDataType = uQcborType;
3028 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003029
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003030 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003031
3032 *pItem = OneItemSeach[0];
3033
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003034 if(uReturn != QCBOR_SUCCESS) {
3035 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003036 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003037 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003038 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003039 }
3040
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003041 Done:
3042 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003043}
3044
3045
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003046/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003047 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003048*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003049void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3050 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003051 uint8_t uQcborType,
3052 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003053{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003054 if(pMe->uLastError != QCBOR_SUCCESS) {
3055 return;
3056 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003057
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003058 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003059 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3060 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3061 OneItemSeach[0].uDataType = uQcborType;
3062 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003063
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003064 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3065 if(uReturn != QCBOR_SUCCESS) {
3066 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003067 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003068 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003069 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003070 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003071 }
3072
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003073 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003074
3075Done:
3076 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003077}
3078
3079
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003080
Laurence Lundblade93d89472020-10-03 22:30:50 -07003081static QCBORError
3082CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003083{
3084 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3085 if(uDataType == puTypeList[i]) {
3086 return QCBOR_SUCCESS;
3087 }
3088 }
3089 return QCBOR_ERR_UNEXPECTED_TYPE;
3090}
3091
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003092
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003093/**
3094 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003095 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003096
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003097 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3098 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003099
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003100 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3101 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003102 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003103static QCBORError
3104CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003105{
3106 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3107 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3108 /* There are tags that QCBOR couldn't process on this item and
3109 the caller has told us there should not be. */
3110 return QCBOR_ERR_UNEXPECTED_TYPE;
3111 }
3112
3113 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3114 const int nItemType = pItem->uDataType;
3115
3116 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3117 // Must match the tag and only the tag
3118 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3119 }
3120
3121 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3122 if(uReturn == QCBOR_SUCCESS) {
3123 return QCBOR_SUCCESS;
3124 }
3125
3126 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3127 /* Must match the content type and only the content type.
3128 There was no match just above so it is a fail. */
3129 return QCBOR_ERR_UNEXPECTED_TYPE;
3130 }
3131
3132 /* If here it can match either the tag or the content
3133 and it hasn't matched the content, so the end
3134 result is whether it matches the tag. This is
3135 also the case that the CBOR standard discourages. */
3136
3137 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3138}
3139
Laurence Lundblade9b334962020-08-27 10:55:53 -07003140
Laurence Lundblade9b334962020-08-27 10:55:53 -07003141
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003142// This could be semi-private if need be
3143static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003144void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3145 int64_t nLabel,
3146 TagSpecification TagSpec,
3147 QCBORItem *pItem)
3148{
3149 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3150 if(pMe->uLastError != QCBOR_SUCCESS) {
3151 return;
3152 }
3153
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003154 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003155}
3156
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003157
3158// This could be semi-private if need be
3159static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003160void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3161 const char *szLabel,
3162 TagSpecification TagSpec,
3163 QCBORItem *pItem)
3164{
3165 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3166 if(pMe->uLastError != QCBOR_SUCCESS) {
3167 return;
3168 }
3169
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003170 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003171}
3172
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003173// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003174void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3175 int64_t nLabel,
3176 TagSpecification TagSpec,
3177 UsefulBufC *pString)
3178{
3179 QCBORItem Item;
3180 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3181 if(pMe->uLastError == QCBOR_SUCCESS) {
3182 *pString = Item.val.string;
3183 }
3184}
3185
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003186// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003187void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3188 const char * szLabel,
3189 TagSpecification TagSpec,
3190 UsefulBufC *pString)
3191{
3192 QCBORItem Item;
3193 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3194 if(pMe->uLastError == QCBOR_SUCCESS) {
3195 *pString = Item.val.string;
3196 }
3197}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003198
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003199/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003200 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003201*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003202void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003203{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003204 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3205 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003206}
3207
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003208/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003209 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003210*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003211void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3212 QCBORItem *pItemList,
3213 void *pCallbackCtx,
3214 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003215{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003216 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3217 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003218}
3219
3220
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003221/**
3222 * @brief Search for a map/array by label and enter it
3223 *
3224 * @param[in] pMe The decode context.
3225 * @param[in] pSearch The map/array to search for.
3226 *
3227 * @c pSearch is expected to contain one item of type map or array
3228 * with the label specified. The current bounded map will be searched for
3229 * this and if found will be entered.
3230 *
3231 * If the label is not found, or the item found is not a map or array,
3232 * the error state is set.
3233 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003234static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003235{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003236 // The first item in pSearch is the one that is to be
3237 // entered. It should be the only one filled in. Any other
3238 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003239 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003240 return;
3241 }
3242
3243 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003244 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003245 if(pMe->uLastError != QCBOR_SUCCESS) {
3246 return;
3247 }
3248
Laurence Lundblade9b334962020-08-27 10:55:53 -07003249 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003250 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003251 return;
3252 }
3253
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003254
3255 /* The map or array was found. Now enter it.
3256 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003257 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3258 * next item for the pre-order traversal cursor to be the map/array
3259 * found by MapSearch(). The next few lines of code force the
3260 * cursor to that.
3261 *
3262 * There is no need to retain the old cursor because
3263 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3264 * beginning of the map/array being entered.
3265 *
3266 * The cursor is forced by: 1) setting the input buffer position to
3267 * the item offset found by MapSearch(), 2) setting the map/array
3268 * counter to the total in the map/array, 3) setting the nesting
3269 * level. Setting the map/array counter to the total is not
3270 * strictly correct, but this is OK because this cursor only needs
3271 * to be used to get one item and MapSearch() has already found it
3272 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003273 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003274 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003275
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003276 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3277
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003278 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003279
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003280 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003281}
3282
3283
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003284/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003285 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003286*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003287void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003288{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003289 QCBORItem OneItemSeach[2];
3290 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3291 OneItemSeach[0].label.int64 = nLabel;
3292 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3293 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003294
Laurence Lundblade9b334962020-08-27 10:55:53 -07003295 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003296 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003297}
3298
3299
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003300/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003301 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003302*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003303void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003304{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003305 QCBORItem OneItemSeach[2];
3306 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3307 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3308 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3309 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003310
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003311 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003312}
3313
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003314/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003315 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003316*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003317void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003318{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003319 QCBORItem OneItemSeach[2];
3320 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3321 OneItemSeach[0].label.int64 = nLabel;
3322 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3323 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003324
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003325 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003326}
3327
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003328/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003329 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003330*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003331void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3332{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003333 QCBORItem OneItemSeach[2];
3334 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3335 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3336 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3337 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003338
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003339 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003340}
3341
3342
Laurence Lundblade02625d42020-06-25 14:41:41 -07003343// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003344void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003345{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003346 QCBORError uErr;
3347
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003348 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003349 if(pMe->uLastError != QCBOR_SUCCESS) {
3350 // Already in error state; do nothing.
3351 return;
3352 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003353
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003354 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003355 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003356 uErr = QCBORDecode_GetNext(pMe, &Item);
3357 if(uErr != QCBOR_SUCCESS) {
3358 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003359 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003360 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003361 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3362 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003363 }
3364
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003365 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003366
3367
Laurence Lundbladef0499502020-08-01 11:55:57 -07003368 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003369 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003370 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3371 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003372 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003373 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3374 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003375 // Special case to increment nesting level for zero-length maps
3376 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003377 DecodeNesting_Descend(&(pMe->nesting), uType);
3378 }
3379
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003380 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003381
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003382 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3383 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003384
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003385 if(pItem != NULL) {
3386 *pItem = Item;
3387 }
3388
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003389Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003390 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003391}
3392
Laurence Lundblade02625d42020-06-25 14:41:41 -07003393
3394/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003395 This is the common work for exiting a level that is a bounded map,
3396 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003397
3398 One chunk of work is to set up the pre-order traversal so it is at
3399 the item just after the bounded map, array or bstr that is being
3400 exited. This is somewhat complex.
3401
3402 The other work is to level-up the bounded mode to next higest bounded
3403 mode or the top level if there isn't one.
3404 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003405static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003406ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003407{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003408 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003409
Laurence Lundblade02625d42020-06-25 14:41:41 -07003410 /*
3411 First the pre-order-traversal byte offset is positioned to the
3412 item just after the bounded mode item that was just consumed.
3413 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003414 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3415
Laurence Lundblade02625d42020-06-25 14:41:41 -07003416 /*
3417 Next, set the current nesting level to one above the bounded level
3418 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003419
Laurence Lundblade02625d42020-06-25 14:41:41 -07003420 DecodeNesting_CheckBoundedType() is always called before this and
3421 makes sure pCurrentBounded is valid.
3422 */
3423 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3424
3425 /*
3426 This does the complex work of leveling up the pre-order traversal
3427 when the end of a map or array or another bounded level is
3428 reached. It may do nothing, or ascend all the way to the top
3429 level.
3430 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003431 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003432 if(uErr != QCBOR_SUCCESS) {
3433 goto Done;
3434 }
3435
Laurence Lundblade02625d42020-06-25 14:41:41 -07003436 /*
3437 This makes the next highest bounded level the current bounded
3438 level. If there is no next highest level, then no bounded mode is
3439 in effect.
3440 */
3441 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003442
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003443 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003444
3445Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003446 return uErr;
3447}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003448
Laurence Lundblade02625d42020-06-25 14:41:41 -07003449
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003450// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003451void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003452{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003453 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003454 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003455 return;
3456 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003457
Laurence Lundblade02625d42020-06-25 14:41:41 -07003458 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003459
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003460 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003461 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003462 goto Done;
3463 }
3464
Laurence Lundblade02625d42020-06-25 14:41:41 -07003465 /*
3466 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003467 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003468 from previous map search, then do a dummy search.
3469 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003470 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003471 QCBORItem Dummy;
3472 Dummy.uLabelType = QCBOR_TYPE_NONE;
3473 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3474 if(uErr != QCBOR_SUCCESS) {
3475 goto Done;
3476 }
3477 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003478
Laurence Lundblade02625d42020-06-25 14:41:41 -07003479 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003480
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003481Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003482 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003483}
3484
3485
Laurence Lundblade1341c592020-04-11 14:19:05 -07003486
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003487static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003488 const QCBORItem *pItem,
3489 uint8_t uTagRequirement,
3490 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003491{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003492 if(pBstr) {
3493 *pBstr = NULLUsefulBufC;
3494 }
3495
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003496 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003497 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003498 return pMe->uLastError;
3499 }
3500
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003501 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003502
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003503 const TagSpecification TagSpec =
3504 {
3505 uTagRequirement,
3506 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3507 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3508 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003509
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003510 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003511 if(uError != QCBOR_SUCCESS) {
3512 goto Done;
3513 }
3514
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003515 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003516 /* Reverse the decrement done by GetNext() for the bstr so the
3517 * increment in QCBORDecode_NestLevelAscender() called by
3518 * ExitBoundedLevel() will work right.
3519 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003520 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003521 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003522
3523 if(pBstr) {
3524 *pBstr = pItem->val.string;
3525 }
3526
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003527 /* This saves the current length of the UsefulInputBuf and then
3528 * narrows the UsefulInputBuf to start and length of the wrapped
3529 * CBOR that is being entered.
3530 *
3531 * Most of these calls are simple inline accessors so this doesn't
3532 * amount to much code.
3533 */
3534
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003535 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003536 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3537 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003538 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003539 goto Done;
3540 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003541
3542 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3543 pItem->val.string.ptr);
3544 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3545 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3546 /* This should never happen because pItem->val.string.ptr should
3547 * always be valid since it was just returned.
3548 */
3549 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3550 goto Done;
3551 }
3552
3553 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3554
3555 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003556 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003557
Laurence Lundblade02625d42020-06-25 14:41:41 -07003558 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003559 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003560 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003561Done:
3562 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003563}
3564
3565
Laurence Lundblade02625d42020-06-25 14:41:41 -07003566/*
3567 Public function, see header qcbor/qcbor_decode.h file
3568 */
3569void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003570 uint8_t uTagRequirement,
3571 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003572{
3573 if(pMe->uLastError != QCBOR_SUCCESS) {
3574 // Already in error state; do nothing.
3575 return;
3576 }
3577
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003578 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003579 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003580 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3581 if(pMe->uLastError != QCBOR_SUCCESS) {
3582 return;
3583 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003584
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003585 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003586 &Item,
3587 uTagRequirement,
3588 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003589}
3590
3591
Laurence Lundblade02625d42020-06-25 14:41:41 -07003592/*
3593 Public function, see header qcbor/qcbor_decode.h file
3594 */
3595void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003596 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003597 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003598 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003599{
3600 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003601 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003602
Laurence Lundblade93d89472020-10-03 22:30:50 -07003603 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3604 &Item,
3605 uTagRequirement,
3606 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003607}
3608
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003609
Laurence Lundblade02625d42020-06-25 14:41:41 -07003610/*
3611 Public function, see header qcbor/qcbor_decode.h file
3612 */
3613void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003614 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003615 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003616 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003617{
3618 QCBORItem Item;
3619 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3620
Laurence Lundblade93d89472020-10-03 22:30:50 -07003621 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3622 &Item,
3623 uTagRequirement,
3624 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003625}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003626
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003627
Laurence Lundblade02625d42020-06-25 14:41:41 -07003628/*
3629 Public function, see header qcbor/qcbor_decode.h file
3630 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003631void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003632{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003633 if(pMe->uLastError != QCBOR_SUCCESS) {
3634 // Already in error state; do nothing.
3635 return;
3636 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003637
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003638 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003639 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003640 return;
3641 }
3642
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003643 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3644
Laurence Lundblade02625d42020-06-25 14:41:41 -07003645 /*
3646 Reset the length of the UsefulInputBuf to what it was before
3647 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003648 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003649 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003650 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003651
3652
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003653 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003654 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003655}
3656
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003657
Laurence Lundbladee6430642020-03-14 21:15:44 -07003658
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003659
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003660
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003661
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003662
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003663
Laurence Lundblade93d89472020-10-03 22:30:50 -07003664static QCBORError
3665InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003666{
3667 switch(pItem->uDataType) {
3668 case QCBOR_TYPE_TRUE:
3669 *pBool = true;
3670 return QCBOR_SUCCESS;
3671 break;
3672
3673 case QCBOR_TYPE_FALSE:
3674 *pBool = false;
3675 return QCBOR_SUCCESS;
3676 break;
3677
3678 default:
3679 return QCBOR_ERR_UNEXPECTED_TYPE;
3680 break;
3681 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003682 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003683}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003684
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003685
Laurence Lundblade9b334962020-08-27 10:55:53 -07003686
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003687/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003688 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003689*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003690void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003691{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003692 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003693 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003694 return;
3695 }
3696
Laurence Lundbladec4537442020-04-14 18:53:22 -07003697 QCBORError nError;
3698 QCBORItem Item;
3699
3700 nError = QCBORDecode_GetNext(pMe, &Item);
3701 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003702 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003703 return;
3704 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003705 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003706}
3707
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003708
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003709/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003710 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003711*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003712void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003713{
3714 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003715 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003716
Laurence Lundblade9b334962020-08-27 10:55:53 -07003717 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003718}
3719
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003720
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003721/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003722 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003723*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003724void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3725{
3726 QCBORItem Item;
3727 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3728
Laurence Lundblade9b334962020-08-27 10:55:53 -07003729 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003730}
3731
3732
3733
Laurence Lundbladec7114722020-08-13 05:11:40 -07003734
3735static void ProcessEpochDate(QCBORDecodeContext *pMe,
3736 QCBORItem *pItem,
3737 uint8_t uTagRequirement,
3738 int64_t *pnTime)
3739{
3740 if(pMe->uLastError != QCBOR_SUCCESS) {
3741 // Already in error state, do nothing
3742 return;
3743 }
3744
3745 QCBORError uErr;
3746
3747 const TagSpecification TagSpec =
3748 {
3749 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003750 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3751 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003752 };
3753
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003754 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003755 if(uErr != QCBOR_SUCCESS) {
3756 goto Done;
3757 }
3758
3759 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3760 uErr = DecodeDateEpoch(pItem);
3761 if(uErr != QCBOR_SUCCESS) {
3762 goto Done;
3763 }
3764 }
3765
Laurence Lundblade9b334962020-08-27 10:55:53 -07003766 // Save the tags in the last item's tags in the decode context
3767 // for QCBORDecode_GetNthTagOfLast()
3768 CopyTags(pMe, pItem);
3769
Laurence Lundbladec7114722020-08-13 05:11:40 -07003770 *pnTime = pItem->val.epochDate.nSeconds;
3771
3772Done:
3773 pMe->uLastError = (uint8_t)uErr;
3774}
3775
3776
3777void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003778 uint8_t uTagRequirement,
3779 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003780{
3781 if(pMe->uLastError != QCBOR_SUCCESS) {
3782 // Already in error state, do nothing
3783 return;
3784 }
3785
3786 QCBORItem Item;
3787 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3788
3789 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3790}
3791
3792
3793void
3794QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3795 int64_t nLabel,
3796 uint8_t uTagRequirement,
3797 int64_t *pnTime)
3798{
3799 QCBORItem Item;
3800 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3801 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3802}
3803
3804
3805void
3806QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3807 const char *szLabel,
3808 uint8_t uTagRequirement,
3809 int64_t *pnTime)
3810{
3811 QCBORItem Item;
3812 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3813 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3814}
3815
3816
3817
3818
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003819void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3820 TagSpecification TagSpec,
3821 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003822{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003823 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003824 // Already in error state, do nothing
3825 return;
3826 }
3827
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003828 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003829 QCBORItem Item;
3830
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003831 uError = QCBORDecode_GetNext(pMe, &Item);
3832 if(uError != QCBOR_SUCCESS) {
3833 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003834 return;
3835 }
3836
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003837 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003838
3839 if(pMe->uLastError == QCBOR_SUCCESS) {
3840 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003841 } else {
3842 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003843 }
3844}
3845
Laurence Lundbladec4537442020-04-14 18:53:22 -07003846
3847
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003848
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003849static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003850 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003851 UsefulBufC *pValue,
3852 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003853{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003854 const TagSpecification TagSpec =
3855 {
3856 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003857 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3858 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003859 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003860
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003861 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003862 if(uErr != QCBOR_SUCCESS) {
3863 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003864 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003865
3866 *pValue = pItem->val.string;
3867
3868 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3869 *pbIsNegative = false;
3870 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3871 *pbIsNegative = true;
3872 }
3873
3874 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003875}
3876
3877
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003878/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003879 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003880 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003881void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3882 uint8_t uTagRequirement,
3883 UsefulBufC *pValue,
3884 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003885{
3886 if(pMe->uLastError != QCBOR_SUCCESS) {
3887 // Already in error state, do nothing
3888 return;
3889 }
3890
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003891 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003892 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3893 if(uError != QCBOR_SUCCESS) {
3894 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003895 return;
3896 }
3897
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003898 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003899}
3900
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003901
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003902/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003903 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003904*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003905void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3906 int64_t nLabel,
3907 uint8_t uTagRequirement,
3908 UsefulBufC *pValue,
3909 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003910{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003911 QCBORItem Item;
3912 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003913 if(pMe->uLastError != QCBOR_SUCCESS) {
3914 return;
3915 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003916
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003917 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003918}
3919
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003920
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003921/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003922 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003923*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003924void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3925 const char *szLabel,
3926 uint8_t uTagRequirement,
3927 UsefulBufC *pValue,
3928 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003929{
3930 QCBORItem Item;
3931 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003932 if(pMe->uLastError != QCBOR_SUCCESS) {
3933 return;
3934 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003935
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003936 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003937}
3938
3939
3940
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003941
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003942// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003943QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3944 const QCBORItem *pItem,
3945 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07003946 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003947{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003948 const TagSpecification TagSpecText =
3949 {
3950 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003951 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3952 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003953 };
3954 const TagSpecification TagSpecBinary =
3955 {
3956 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003957 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3958 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003959 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003960
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003961 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003962
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003963 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003964 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003965 if(pbIsTag257 != NULL) {
3966 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003967 }
3968 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003969 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003970 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003971 if(pbIsTag257 != NULL) {
3972 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003973 }
3974 uReturn = QCBOR_SUCCESS;
3975
3976 } else {
3977 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
3978 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003979
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003980 return uReturn;
3981}
3982
Laurence Lundblade93d89472020-10-03 22:30:50 -07003983// Improvement: add methods for wrapped CBOR, a simple alternate
3984// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003985
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003986
3987
3988
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07003989#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07003990
Laurence Lundblade9c905e82020-04-25 11:31:38 -07003991typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003992
3993
Laurence Lundblade784b54b2020-08-10 01:24:52 -07003994// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07003995static QCBORError
3996Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003997{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07003998 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003999
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004000 if(uResult != 0) {
4001 /* This loop will run a maximum of 19 times because
4002 * UINT64_MAX < 10 ^^ 19. More than that will cause
4003 * exit with the overflow error
4004 */
4005 for(; nExponent > 0; nExponent--) {
4006 if(uResult > UINT64_MAX / 10) {
4007 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4008 }
4009 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004010 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004011
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004012 for(; nExponent < 0; nExponent++) {
4013 uResult = uResult / 10;
4014 if(uResult == 0) {
4015 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4016 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004017 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004018 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004019 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004020
4021 *puResult = uResult;
4022
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004023 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004024}
4025
4026
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004027// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004028static QCBORError
4029Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004030{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004031 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004032
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004033 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004034
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004035 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004036 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004037 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004038 */
4039 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004040 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004041 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004042 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004043 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004044 nExponent--;
4045 }
4046
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004047 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004048 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004049 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4050 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004051 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004052 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004053 }
4054
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004055 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004056
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004057 return QCBOR_SUCCESS;
4058}
4059
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004060
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004061/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004062 Compute value with signed mantissa and signed result. Works with
4063 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004064 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004065static inline QCBORError ExponentiateNN(int64_t nMantissa,
4066 int64_t nExponent,
4067 int64_t *pnResult,
4068 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004069{
4070 uint64_t uResult;
4071
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004072 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004073 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004074 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4075
4076 // Do the exponentiation of the positive mantissa
4077 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4078 if(uReturn) {
4079 return uReturn;
4080 }
4081
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004082
Laurence Lundblade983500d2020-05-14 11:49:34 -07004083 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4084 of INT64_MIN. This assumes two's compliment representation where
4085 INT64_MIN is one increment farther from 0 than INT64_MAX.
4086 Trying to write -INT64_MIN doesn't work to get this because the
4087 compiler tries to work with an int64_t which can't represent
4088 -INT64_MIN.
4089 */
4090 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4091
4092 // Error out if too large
4093 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004094 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4095 }
4096
4097 // Casts are safe because of checks above
4098 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4099
4100 return QCBOR_SUCCESS;
4101}
4102
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004103
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004104/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004105 Compute value with signed mantissa and unsigned result. Works with
4106 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004107 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004108static inline QCBORError ExponentitateNU(int64_t nMantissa,
4109 int64_t nExponent,
4110 uint64_t *puResult,
4111 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004112{
4113 if(nMantissa < 0) {
4114 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4115 }
4116
4117 // Cast to unsigned is OK because of check for negative
4118 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4119 // Exponentiation is straight forward
4120 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4121}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004122
4123
4124/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004125 Compute value with signed mantissa and unsigned result. Works with
4126 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004127 */
4128static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4129 int64_t nExponent,
4130 uint64_t *puResult,
4131 fExponentiator pfExp)
4132{
4133 return (*pfExp)(uMantissa, nExponent, puResult);
4134}
4135
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004136#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4137
4138
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004139
4140
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004141
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004142static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004143{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004144 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004145
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004146 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004147 const uint8_t *pByte = BigNum.ptr;
4148 size_t uLen = BigNum.len;
4149 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004150 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004151 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004152 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004153 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004154 }
4155
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004156 *pResult = uResult;
4157 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004158}
4159
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004160
Laurence Lundblade887add82020-05-17 05:50:34 -07004161static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004162{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004163 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004164}
4165
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004166
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004167static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004168{
4169 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004170 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4171 if(uError) {
4172 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004173 }
4174 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4175 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004176 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004177}
4178
4179
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004180static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004181{
4182 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004183 /* The negative integer furthest from zero for a C int64_t is
4184 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4185 negative number in CBOR is computed as -n - 1 where n is the
4186 encoded integer, where n is what is in the variable BigNum. When
4187 converting BigNum to a uint64_t, the maximum value is thus
4188 INT64_MAX, so that when it -n - 1 is applied to it the result will
4189 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004190
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004191 -n - 1 <= INT64_MIN.
4192 -n - 1 <= -INT64_MAX - 1
4193 n <= INT64_MAX.
4194 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004195 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004196 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004197 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004198 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004199
4200 /// Now apply -n - 1. The cast is safe because
4201 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4202 // is the largest positive integer that an int64_t can
4203 // represent. */
4204 *pnResult = -(int64_t)uResult - 1;
4205
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004206 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004207}
4208
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004209
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004210
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004211
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004212
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004213/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004214Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004215
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004216\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004217
Laurence Lundblade93d89472020-10-03 22:30:50 -07004218\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4219 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004220
4221\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4222
Laurence Lundblade93d89472020-10-03 22:30:50 -07004223\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4224 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004225*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004226static QCBORError
4227ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004228{
4229 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004230 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004231 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004232#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004233 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004234 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4235 http://www.cplusplus.com/reference/cmath/llround/
4236 */
4237 // Not interested in FE_INEXACT
4238 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004239 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4240 *pnValue = llround(pItem->val.dfnum);
4241 } else {
4242 *pnValue = lroundf(pItem->val.fnum);
4243 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004244 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4245 // llround() shouldn't result in divide by zero, but catch
4246 // it here in case it unexpectedly does. Don't try to
4247 // distinguish between the various exceptions because it seems
4248 // they vary by CPU, compiler and OS.
4249 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004250 }
4251 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004252 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004253 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004254#else
4255 return QCBOR_ERR_HW_FLOAT_DISABLED;
4256#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004257 break;
4258
4259 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004260 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004261 *pnValue = pItem->val.int64;
4262 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004263 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004264 }
4265 break;
4266
4267 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004268 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004269 if(pItem->val.uint64 < INT64_MAX) {
4270 *pnValue = pItem->val.int64;
4271 } else {
4272 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4273 }
4274 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004275 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004276 }
4277 break;
4278
4279 default:
4280 return QCBOR_ERR_UNEXPECTED_TYPE;
4281 }
4282 return QCBOR_SUCCESS;
4283}
4284
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004285
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004286void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004287 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004288 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004289 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004290{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004291 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004292 return;
4293 }
4294
Laurence Lundbladee6430642020-03-14 21:15:44 -07004295 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004296 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4297 if(uError) {
4298 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004299 return;
4300 }
4301
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004302 if(pItem) {
4303 *pItem = Item;
4304 }
4305
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004306 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004307}
4308
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004309
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004310void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4311 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004312 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004313 int64_t *pnValue,
4314 QCBORItem *pItem)
4315{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004316 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004317 if(pMe->uLastError != QCBOR_SUCCESS) {
4318 return;
4319 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004320
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004321 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004322}
4323
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004324
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004325void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4326 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004327 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004328 int64_t *pnValue,
4329 QCBORItem *pItem)
4330{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004331 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004332 if(pMe->uLastError != QCBOR_SUCCESS) {
4333 return;
4334 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004335
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004336 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004337}
4338
4339
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004340/*
4341 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004342
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004343 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004344
Laurence Lundblade93d89472020-10-03 22:30:50 -07004345 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4346 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004347
4348 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4349
Laurence Lundblade93d89472020-10-03 22:30:50 -07004350 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4351 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004352 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004353static QCBORError
4354Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004355{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004356 switch(pItem->uDataType) {
4357
4358 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004359 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004360 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004361 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004362 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004363 }
4364 break;
4365
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004366 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004367 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004368 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004369 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004370 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004371 }
4372 break;
4373
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004374#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4375 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004376 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004377 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004378 pItem->val.expAndMantissa.nExponent,
4379 pnValue,
4380 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004381 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004382 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004383 }
4384 break;
4385
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004386 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004387 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004388 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004389 pItem->val.expAndMantissa.nExponent,
4390 pnValue,
4391 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004392 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004393 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004394 }
4395 break;
4396
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004397 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004398 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004399 int64_t nMantissa;
4400 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004401 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4402 if(uErr) {
4403 return uErr;
4404 }
4405 return ExponentiateNN(nMantissa,
4406 pItem->val.expAndMantissa.nExponent,
4407 pnValue,
4408 Exponentitate10);
4409 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004410 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004411 }
4412 break;
4413
4414 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004415 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004416 int64_t nMantissa;
4417 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004418 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4419 if(uErr) {
4420 return uErr;
4421 }
4422 return ExponentiateNN(nMantissa,
4423 pItem->val.expAndMantissa.nExponent,
4424 pnValue,
4425 Exponentitate10);
4426 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004427 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004428 }
4429 break;
4430
4431 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004432 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004433 int64_t nMantissa;
4434 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004435 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4436 if(uErr) {
4437 return uErr;
4438 }
4439 return ExponentiateNN(nMantissa,
4440 pItem->val.expAndMantissa.nExponent,
4441 pnValue,
4442 Exponentitate2);
4443 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004444 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004445 }
4446 break;
4447
4448 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004449 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004450 int64_t nMantissa;
4451 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004452 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4453 if(uErr) {
4454 return uErr;
4455 }
4456 return ExponentiateNN(nMantissa,
4457 pItem->val.expAndMantissa.nExponent,
4458 pnValue,
4459 Exponentitate2);
4460 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004461 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004462 }
4463 break;
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004464#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
4465
Laurence Lundbladee6430642020-03-14 21:15:44 -07004466
Laurence Lundbladec4537442020-04-14 18:53:22 -07004467 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004468 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004469}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004470
4471
Laurence Lundbladec4537442020-04-14 18:53:22 -07004472/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004473 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004474 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004475void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004476{
4477 QCBORItem Item;
4478
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004479 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004480
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004481 if(pMe->uLastError == QCBOR_SUCCESS) {
4482 // The above conversion succeeded
4483 return;
4484 }
4485
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004486 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004487 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004488 return;
4489 }
4490
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004491 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004492}
4493
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004494
4495/*
4496Public function, see header qcbor/qcbor_decode.h file
4497*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004498void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4499 int64_t nLabel,
4500 uint32_t uConvertTypes,
4501 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004502{
4503 QCBORItem Item;
4504
Laurence Lundblade93d89472020-10-03 22:30:50 -07004505 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4506 nLabel,
4507 uConvertTypes,
4508 pnValue,
4509 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004510
4511 if(pMe->uLastError == QCBOR_SUCCESS) {
4512 // The above conversion succeeded
4513 return;
4514 }
4515
4516 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4517 // The above conversion failed in a way that code below can't correct
4518 return;
4519 }
4520
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004521 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004522}
4523
4524
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004525/*
4526Public function, see header qcbor/qcbor_decode.h file
4527*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004528void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4529 const char *szLabel,
4530 uint32_t uConvertTypes,
4531 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004532{
4533 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004534 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4535 szLabel,
4536 uConvertTypes,
4537 pnValue,
4538 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004539
4540 if(pMe->uLastError == QCBOR_SUCCESS) {
4541 // The above conversion succeeded
4542 return;
4543 }
4544
4545 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4546 // The above conversion failed in a way that code below can't correct
4547 return;
4548 }
4549
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004550 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004551}
4552
4553
Laurence Lundblade93d89472020-10-03 22:30:50 -07004554static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004555{
4556 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004557 case QCBOR_TYPE_DOUBLE:
4558 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004559#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004560 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004561 // Can't use llround here because it will not convert values
4562 // greater than INT64_MAX and less than UINT64_MAX that
4563 // need to be converted so it is more complicated.
4564 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4565 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4566 if(isnan(pItem->val.dfnum)) {
4567 return QCBOR_ERR_FLOAT_EXCEPTION;
4568 } else if(pItem->val.dfnum < 0) {
4569 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4570 } else {
4571 double dRounded = round(pItem->val.dfnum);
4572 // See discussion in DecodeDateEpoch() for
4573 // explanation of - 0x7ff
4574 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4575 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4576 }
4577 *puValue = (uint64_t)dRounded;
4578 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004579 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004580 if(isnan(pItem->val.fnum)) {
4581 return QCBOR_ERR_FLOAT_EXCEPTION;
4582 } else if(pItem->val.fnum < 0) {
4583 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4584 } else {
4585 float fRounded = roundf(pItem->val.fnum);
4586 // See discussion in DecodeDateEpoch() for
4587 // explanation of - 0x7ff
4588 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4589 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4590 }
4591 *puValue = (uint64_t)fRounded;
4592 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004593 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004594 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4595 // round() and roundf() shouldn't result in exceptions here, but
4596 // catch them to be robust and thorough. Don't try to
4597 // distinguish between the various exceptions because it seems
4598 // they vary by CPU, compiler and OS.
4599 return QCBOR_ERR_FLOAT_EXCEPTION;
4600 }
4601
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004602 } else {
4603 return QCBOR_ERR_UNEXPECTED_TYPE;
4604 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004605#else
4606 return QCBOR_ERR_HW_FLOAT_DISABLED;
4607#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004608 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004609
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004610 case QCBOR_TYPE_INT64:
4611 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4612 if(pItem->val.int64 >= 0) {
4613 *puValue = (uint64_t)pItem->val.int64;
4614 } else {
4615 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4616 }
4617 } else {
4618 return QCBOR_ERR_UNEXPECTED_TYPE;
4619 }
4620 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004621
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004622 case QCBOR_TYPE_UINT64:
4623 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4624 *puValue = pItem->val.uint64;
4625 } else {
4626 return QCBOR_ERR_UNEXPECTED_TYPE;
4627 }
4628 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004629
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004630 default:
4631 return QCBOR_ERR_UNEXPECTED_TYPE;
4632 }
4633
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004634 return QCBOR_SUCCESS;
4635}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004636
4637
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004638void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004639 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004640 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004641 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004642{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004643 if(pMe->uLastError != QCBOR_SUCCESS) {
4644 return;
4645 }
4646
Laurence Lundbladec4537442020-04-14 18:53:22 -07004647 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004648
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004649 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4650 if(uError) {
4651 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004652 return;
4653 }
4654
Laurence Lundbladea826c502020-05-10 21:07:00 -07004655 if(pItem) {
4656 *pItem = Item;
4657 }
4658
Laurence Lundblade93d89472020-10-03 22:30:50 -07004659 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004660}
4661
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004662
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004663void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004664 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004665 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004666 uint64_t *puValue,
4667 QCBORItem *pItem)
4668{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004669 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004670 if(pMe->uLastError != QCBOR_SUCCESS) {
4671 return;
4672 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004673
Laurence Lundblade93d89472020-10-03 22:30:50 -07004674 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004675}
4676
4677
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004678void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004679 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004680 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004681 uint64_t *puValue,
4682 QCBORItem *pItem)
4683{
4684 if(pMe->uLastError != QCBOR_SUCCESS) {
4685 return;
4686 }
4687
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004688 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004689 if(pMe->uLastError != QCBOR_SUCCESS) {
4690 return;
4691 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004692
Laurence Lundblade93d89472020-10-03 22:30:50 -07004693 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004694}
4695
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004696
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004697
Laurence Lundblade93d89472020-10-03 22:30:50 -07004698static QCBORError
4699UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004700{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004701 switch(pItem->uDataType) {
4702
4703 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004704 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004705 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4706 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004707 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004708 }
4709 break;
4710
4711 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004712 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004713 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4714 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004715 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004716 }
4717 break;
4718
4719#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
4720
4721 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004722 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004723 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004724 pItem->val.expAndMantissa.nExponent,
4725 puValue,
4726 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004727 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004728 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004729 }
4730 break;
4731
4732 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004733 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004734 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4735 pItem->val.expAndMantissa.nExponent,
4736 puValue,
4737 Exponentitate2);
4738 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004739 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004740 }
4741 break;
4742
4743 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004744 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004745 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004746 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004747 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004748 if(uErr != QCBOR_SUCCESS) {
4749 return uErr;
4750 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004751 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004752 pItem->val.expAndMantissa.nExponent,
4753 puValue,
4754 Exponentitate10);
4755 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004756 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004757 }
4758 break;
4759
4760 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004761 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004762 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4763 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004764 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004765 }
4766 break;
4767
4768 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004769 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004770 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004771 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004772 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004773 if(uErr != QCBOR_SUCCESS) {
4774 return uErr;
4775 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004776 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004777 pItem->val.expAndMantissa.nExponent,
4778 puValue,
4779 Exponentitate2);
4780 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004781 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004782 }
4783 break;
4784
4785 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004786 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004787 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4788 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004789 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004790 }
4791 break;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004792#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004793 default:
4794 return QCBOR_ERR_UNEXPECTED_TYPE;
4795 }
4796}
4797
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004798
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004799/*
4800 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004801 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004802void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004803{
4804 QCBORItem Item;
4805
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004806 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004807
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004808 if(pMe->uLastError == QCBOR_SUCCESS) {
4809 // The above conversion succeeded
4810 return;
4811 }
4812
4813 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4814 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004815 return;
4816 }
4817
Laurence Lundblade93d89472020-10-03 22:30:50 -07004818 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004819}
4820
Laurence Lundbladec4537442020-04-14 18:53:22 -07004821
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004822/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004823 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004824*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004825void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004826 int64_t nLabel,
4827 uint32_t uConvertTypes,
4828 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004829{
4830 QCBORItem Item;
4831
Laurence Lundblade93d89472020-10-03 22:30:50 -07004832 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4833 nLabel,
4834 uConvertTypes,
4835 puValue,
4836 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004837
4838 if(pMe->uLastError == QCBOR_SUCCESS) {
4839 // The above conversion succeeded
4840 return;
4841 }
4842
4843 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4844 // The above conversion failed in a way that code below can't correct
4845 return;
4846 }
4847
Laurence Lundblade93d89472020-10-03 22:30:50 -07004848 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004849}
4850
4851
4852/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004853 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004854*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004855void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004856 const char *szLabel,
4857 uint32_t uConvertTypes,
4858 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004859{
4860 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004861 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
4862 szLabel,
4863 uConvertTypes,
4864 puValue,
4865 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004866
4867 if(pMe->uLastError == QCBOR_SUCCESS) {
4868 // The above conversion succeeded
4869 return;
4870 }
4871
4872 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4873 // The above conversion failed in a way that code below can't correct
4874 return;
4875 }
4876
Laurence Lundblade93d89472020-10-03 22:30:50 -07004877 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004878}
4879
4880
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004881
4882
Laurence Lundblade9b334962020-08-27 10:55:53 -07004883static QCBORError ConvertDouble(const QCBORItem *pItem,
4884 uint32_t uConvertTypes,
4885 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004886{
4887 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004888 case QCBOR_TYPE_FLOAT:
4889#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4890 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4891 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004892 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004893 *pdValue = (double)pItem->val.fnum;
4894 } else {
4895 return QCBOR_ERR_UNEXPECTED_TYPE;
4896 }
4897 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004898#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004899 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004900#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004901 break;
4902
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004903 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004904 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4905 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004906 *pdValue = pItem->val.dfnum;
4907 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004908 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004909 }
4910 }
4911 break;
4912
4913 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004914#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004915 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004916 // A simple cast seems to do the job with no worry of exceptions.
4917 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004918 *pdValue = (double)pItem->val.int64;
4919
4920 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004921 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004922 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004923#else
4924 return QCBOR_ERR_HW_FLOAT_DISABLED;
4925#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004926 break;
4927
4928 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004929#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004930 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004931 // A simple cast seems to do the job with no worry of exceptions.
4932 // There will be precision loss for some values.
4933 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004934 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004935 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004936 }
4937 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004938#else
4939 return QCBOR_ERR_HW_FLOAT_DISABLED;
4940#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004941
4942 default:
4943 return QCBOR_ERR_UNEXPECTED_TYPE;
4944 }
4945
4946 return QCBOR_SUCCESS;
4947}
4948
4949
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004950void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004951 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004952 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004953 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004954{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004955 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004956 return;
4957 }
4958
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004959 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004960
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004961 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004962 if(uError) {
4963 pMe->uLastError = (uint8_t)uError;
4964 return;
4965 }
4966
4967 if(pItem) {
4968 *pItem = Item;
4969 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004970
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004971 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004972}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004973
Laurence Lundbladec4537442020-04-14 18:53:22 -07004974
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004975void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4976 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004977 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004978 double *pdValue,
4979 QCBORItem *pItem)
4980{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004981 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004982 if(pMe->uLastError != QCBOR_SUCCESS) {
4983 return;
4984 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004985
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004986 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004987}
4988
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004989
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004990void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4991 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004992 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004993 double *pdValue,
4994 QCBORItem *pItem)
4995{
4996 if(pMe->uLastError != QCBOR_SUCCESS) {
4997 return;
4998 }
4999
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005000 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005001 if(pMe->uLastError != QCBOR_SUCCESS) {
5002 return;
5003 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005004
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005005 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005006}
5007
5008
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005009#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005010static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5011{
5012 double dResult;
5013
5014 dResult = 0.0;
5015 const uint8_t *pByte = BigNum.ptr;
5016 size_t uLen = BigNum.len;
5017 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005018 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005019 while(uLen--) {
5020 dResult = (dResult * 256.0) + (double)*pByte++;
5021 }
5022
5023 return dResult;
5024}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005025#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5026
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005027
Laurence Lundblade93d89472020-10-03 22:30:50 -07005028static QCBORError
5029DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005030{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005031#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005032 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005033 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5034
5035 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005036 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005037
5038#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005039 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005040 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005041 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005042 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5043 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5044 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005045 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005046 }
5047 break;
5048
5049 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005050 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005051 // Underflow gives 0, overflow gives infinity
5052 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5053 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005054 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005055 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005056 }
5057 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005058#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005059
5060 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005061 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005062 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5063 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005064 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005065 }
5066 break;
5067
5068 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005069 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005070 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005071 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005072 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005073 }
5074 break;
5075
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005076#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005077 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005078 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005079 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5080 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5081 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005082 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005083 }
5084 break;
5085
5086 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005087 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005088 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5089 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5090 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005091 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005092 }
5093 break;
5094
5095 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005096 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005097 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5098 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5099 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005100 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005101 }
5102 break;
5103
5104 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005105 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005106 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005107 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5108 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005109 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005110 }
5111 break;
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005112#endif /* ndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */
5113
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005114 default:
5115 return QCBOR_ERR_UNEXPECTED_TYPE;
5116 }
5117
5118 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005119
5120#else
5121 (void)pItem;
5122 (void)uConvertTypes;
5123 (void)pdValue;
5124 return QCBOR_ERR_HW_FLOAT_DISABLED;
5125#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5126
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005127}
5128
5129
5130/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005131 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005132*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005133void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5134 uint32_t uConvertTypes,
5135 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005136{
5137
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005138 QCBORItem Item;
5139
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005140 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005141
5142 if(pMe->uLastError == QCBOR_SUCCESS) {
5143 // The above conversion succeeded
5144 return;
5145 }
5146
5147 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5148 // The above conversion failed in a way that code below can't correct
5149 return;
5150 }
5151
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005152 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005153}
5154
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005155
5156/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005157 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005158*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005159void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5160 int64_t nLabel,
5161 uint32_t uConvertTypes,
5162 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005163{
5164 QCBORItem Item;
5165
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005166 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005167
5168 if(pMe->uLastError == QCBOR_SUCCESS) {
5169 // The above conversion succeeded
5170 return;
5171 }
5172
5173 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5174 // The above conversion failed in a way that code below can't correct
5175 return;
5176 }
5177
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005178 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005179}
5180
5181
5182/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005183 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005184*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005185void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5186 const char *szLabel,
5187 uint32_t uConvertTypes,
5188 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005189{
5190 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005191 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005192
5193 if(pMe->uLastError == QCBOR_SUCCESS) {
5194 // The above conversion succeeded
5195 return;
5196 }
5197
5198 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5199 // The above conversion failed in a way that code below can't correct
5200 return;
5201 }
5202
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005203 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005204}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005205
5206
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005207
5208
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005209#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005210static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5211{
5212 while((uInt & 0xff00000000000000UL) == 0) {
5213 uInt = uInt << 8;
5214 };
5215
5216 UsefulOutBuf UOB;
5217
5218 UsefulOutBuf_Init(&UOB, Buffer);
5219
5220 while(uInt) {
5221 const uint64_t xx = uInt & 0xff00000000000000UL;
5222 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5223 uInt = uInt << 8;
5224 (void)xx;
5225 }
5226
5227 return UsefulOutBuf_OutUBuf(&UOB);
5228}
5229
5230
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005231static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5232 TagSpecification TagSpec,
5233 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005234{
5235 QCBORError uErr;
5236 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005237 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005238 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005239 if(uErr != QCBOR_SUCCESS) {
5240 goto Done;
5241 }
5242
5243 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5244 break; // Successful exit. Moving on to finish decoding.
5245 }
5246
5247 // The item is an array, which means an undecoded
5248 // mantissa and exponent, so decode it. It will then
5249 // have a different type and exit the loop if.
5250 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5251 if(uErr != QCBOR_SUCCESS) {
5252 goto Done;
5253 }
5254
5255 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005256 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005257 }
5258Done:
5259 return uErr;
5260}
5261
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005262
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005263static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005264 TagSpecification TagSpec,
5265 QCBORItem *pItem,
5266 int64_t *pnMantissa,
5267 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005268{
5269 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005270
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005271 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005272 if(uErr != QCBOR_SUCCESS) {
5273 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005274 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005275
Laurence Lundblade9b334962020-08-27 10:55:53 -07005276 switch (pItem->uDataType) {
5277
5278 case QCBOR_TYPE_DECIMAL_FRACTION:
5279 case QCBOR_TYPE_BIGFLOAT:
5280 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5281 *pnExponent = pItem->val.expAndMantissa.nExponent;
5282 break;
5283
5284 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5285 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5286 *pnExponent = pItem->val.expAndMantissa.nExponent;
5287 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5288 break;
5289
5290 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5291 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5292 *pnExponent = pItem->val.expAndMantissa.nExponent;
5293 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5294 break;
5295
5296 default:
5297 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5298 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005299
5300 Done:
5301 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005302}
5303
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005304
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005305static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005306 TagSpecification TagSpec,
5307 QCBORItem *pItem,
5308 UsefulBuf BufferForMantissa,
5309 UsefulBufC *pMantissa,
5310 bool *pbIsNegative,
5311 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005312{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005313 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005314
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005315 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005316 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005317 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005318 }
5319
5320 uint64_t uMantissa;
5321
5322 switch (pItem->uDataType) {
5323
5324 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005325 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005326 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5327 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5328 *pbIsNegative = false;
5329 } else {
5330 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5331 *pbIsNegative = true;
5332 }
5333 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5334 *pnExponent = pItem->val.expAndMantissa.nExponent;
5335 break;
5336
5337 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005338 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005339 *pnExponent = pItem->val.expAndMantissa.nExponent;
5340 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5341 *pbIsNegative = false;
5342 break;
5343
5344 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005345 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005346 *pnExponent = pItem->val.expAndMantissa.nExponent;
5347 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5348 *pbIsNegative = true;
5349 break;
5350
5351 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005352 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005353 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005354
5355Done:
5356 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005357}
5358
5359
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005360/*
5361 Public function, see header qcbor/qcbor_decode.h file
5362*/
5363void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5364 uint8_t uTagRequirement,
5365 int64_t *pnMantissa,
5366 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005367{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005368 if(pMe->uLastError != QCBOR_SUCCESS) {
5369 return;
5370 }
5371
5372 QCBORItem Item;
5373 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5374 if(uError) {
5375 pMe->uLastError = (uint8_t)uError;
5376 return;
5377 }
5378
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005379 const TagSpecification TagSpec =
5380 {
5381 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005382 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5383 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5384 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005385 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005386
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005387 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005388}
5389
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005390
5391/*
5392 Public function, see header qcbor/qcbor_decode.h file
5393*/
5394void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005395 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005396 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005397 int64_t *pnMantissa,
5398 int64_t *pnExponent)
5399{
5400 if(pMe->uLastError != QCBOR_SUCCESS) {
5401 return;
5402 }
5403
5404 QCBORItem Item;
5405 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5406
5407 const TagSpecification TagSpec =
5408 {
5409 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005410 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5411 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5412 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005413 };
5414
5415 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5416}
5417
5418
5419/*
5420 Public function, see header qcbor/qcbor_decode.h file
5421*/
5422void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005423 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005424 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005425 int64_t *pnMantissa,
5426 int64_t *pnExponent)
5427{
5428 if(pMe->uLastError != QCBOR_SUCCESS) {
5429 return;
5430 }
5431
5432 QCBORItem Item;
5433 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5434
5435 const TagSpecification TagSpec =
5436 {
5437 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005438 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5439 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5440 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005441 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005442
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005443 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5444}
5445
5446
5447/*
5448 Public function, see header qcbor/qcbor_decode.h file
5449*/
5450void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5451 uint8_t uTagRequirement,
5452 UsefulBuf MantissaBuffer,
5453 UsefulBufC *pMantissa,
5454 bool *pbMantissaIsNegative,
5455 int64_t *pnExponent)
5456{
5457 if(pMe->uLastError != QCBOR_SUCCESS) {
5458 return;
5459 }
5460
5461 QCBORItem Item;
5462 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5463 if(uError) {
5464 pMe->uLastError = (uint8_t)uError;
5465 return;
5466 }
5467
5468 const TagSpecification TagSpec =
5469 {
5470 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005471 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5472 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5473 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005474 };
5475
Laurence Lundblade93d89472020-10-03 22:30:50 -07005476 ProcessMantissaAndExponentBig(pMe,
5477 TagSpec,
5478 &Item,
5479 MantissaBuffer,
5480 pMantissa,
5481 pbMantissaIsNegative,
5482 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005483}
5484
5485
5486/*
5487 Public function, see header qcbor/qcbor_decode.h file
5488*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005489void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005490 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005491 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005492 UsefulBuf BufferForMantissa,
5493 UsefulBufC *pMantissa,
5494 bool *pbIsNegative,
5495 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005496{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005497 if(pMe->uLastError != QCBOR_SUCCESS) {
5498 return;
5499 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005500
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005501 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005502 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005503 if(pMe->uLastError != QCBOR_SUCCESS) {
5504 return;
5505 }
5506
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005507 const TagSpecification TagSpec =
5508 {
5509 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005510 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5511 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5512 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005513 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005514
Laurence Lundblade93d89472020-10-03 22:30:50 -07005515 ProcessMantissaAndExponentBig(pMe,
5516 TagSpec,
5517 &Item,
5518 BufferForMantissa,
5519 pMantissa,
5520 pbIsNegative,
5521 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005522}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005523
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005524
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005525/*
5526 Public function, see header qcbor/qcbor_decode.h file
5527*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005528void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005529 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005530 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005531 UsefulBuf BufferForMantissa,
5532 UsefulBufC *pMantissa,
5533 bool *pbIsNegative,
5534 int64_t *pnExponent)
5535{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005536 if(pMe->uLastError != QCBOR_SUCCESS) {
5537 return;
5538 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005539
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005540 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005541 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5542 if(pMe->uLastError != QCBOR_SUCCESS) {
5543 return;
5544 }
5545
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005546 const TagSpecification TagSpec =
5547 {
5548 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005549 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5550 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5551 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005552 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005553
5554 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5555}
5556
5557
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005558/*
5559 Public function, see header qcbor/qcbor_decode.h file
5560*/
5561void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5562 uint8_t uTagRequirement,
5563 int64_t *pnMantissa,
5564 int64_t *pnExponent)
5565{
5566 if(pMe->uLastError != QCBOR_SUCCESS) {
5567 return;
5568 }
5569
5570 QCBORItem Item;
5571 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5572 if(uError) {
5573 pMe->uLastError = (uint8_t)uError;
5574 return;
5575 }
5576 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 };
5583
5584 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5585}
5586
5587
5588/*
5589 Public function, see header qcbor/qcbor_decode.h file
5590*/
5591void QCBORDecode_GetBigFloatInMapN(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 int64_t *pnMantissa,
5595 int64_t *pnExponent)
5596{
5597 if(pMe->uLastError != QCBOR_SUCCESS) {
5598 return;
5599 }
5600
5601 QCBORItem Item;
5602 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5603 if(pMe->uLastError != QCBOR_SUCCESS) {
5604 return;
5605 }
5606
5607 const TagSpecification TagSpec =
5608 {
5609 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005610 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5611 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5612 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005613 };
5614
5615 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5616}
5617
5618
5619/*
5620 Public function, see header qcbor/qcbor_decode.h file
5621*/
5622void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005623 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005624 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005625 int64_t *pnMantissa,
5626 int64_t *pnExponent)
5627{
5628 if(pMe->uLastError != QCBOR_SUCCESS) {
5629 return;
5630 }
5631
5632 QCBORItem Item;
5633 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5634 if(pMe->uLastError != QCBOR_SUCCESS) {
5635 return;
5636 }
5637
5638 const TagSpecification TagSpec =
5639 {
5640 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005641 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5642 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5643 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005644 };
5645
5646 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5647}
5648
5649
5650/*
5651 Public function, see header qcbor/qcbor_decode.h file
5652*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005653void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5654 uint8_t uTagRequirement,
5655 UsefulBuf MantissaBuffer,
5656 UsefulBufC *pMantissa,
5657 bool *pbMantissaIsNegative,
5658 int64_t *pnExponent)
5659{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005660 if(pMe->uLastError != QCBOR_SUCCESS) {
5661 return;
5662 }
5663
5664 QCBORItem Item;
5665 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5666 if(uError) {
5667 pMe->uLastError = (uint8_t)uError;
5668 return;
5669 }
5670
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005671 const TagSpecification TagSpec =
5672 {
5673 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005674 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5675 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5676 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005677 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005678
5679 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005680}
5681
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005682
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005683/*
5684 Public function, see header qcbor/qcbor_decode.h file
5685*/
5686void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005687 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005688 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005689 UsefulBuf BufferForMantissa,
5690 UsefulBufC *pMantissa,
5691 bool *pbIsNegative,
5692 int64_t *pnExponent)
5693{
5694 if(pMe->uLastError != QCBOR_SUCCESS) {
5695 return;
5696 }
5697
5698 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005699 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5700 if(pMe->uLastError != QCBOR_SUCCESS) {
5701 return;
5702 }
5703
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005704 const TagSpecification TagSpec =
5705 {
5706 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005707 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5708 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5709 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005710 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005711
Laurence Lundblade93d89472020-10-03 22:30:50 -07005712 ProcessMantissaAndExponentBig(pMe,
5713 TagSpec,
5714 &Item,
5715 BufferForMantissa,
5716 pMantissa,
5717 pbIsNegative,
5718 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005719}
5720
5721
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005722/*
5723 Public function, see header qcbor/qcbor_decode.h file
5724*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005725void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005726 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005727 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005728 UsefulBuf BufferForMantissa,
5729 UsefulBufC *pMantissa,
5730 bool *pbIsNegative,
5731 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005732{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005733 if(pMe->uLastError != QCBOR_SUCCESS) {
5734 return;
5735 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005736
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005737 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005738 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5739 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005740 return;
5741 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005742
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005743 const TagSpecification TagSpec =
5744 {
5745 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005746 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5747 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5748 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005749 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005750
Laurence Lundblade93d89472020-10-03 22:30:50 -07005751 ProcessMantissaAndExponentBig(pMe,
5752 TagSpec,
5753 &Item,
5754 BufferForMantissa,
5755 pMantissa,
5756 pbIsNegative,
5757 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005758}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005759
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005760#endif /* QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA */