blob: 801761f470f6791dedf6e00bb5a1c2f84bed0263 [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 Lundbladea9489f82020-09-12 13:50:56 -070049#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070050
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070051
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080052
53
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070054static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070055QCBORItem_IsMapOrArray(const QCBORItem *pMe)
56{
57 const uint8_t uDataType = pMe->uDataType;
58 return uDataType == QCBOR_TYPE_MAP ||
59 uDataType == QCBOR_TYPE_ARRAY ||
60 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
61}
62
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070063static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070064QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
65{
66 if(!QCBORItem_IsMapOrArray(pMe)){
67 return false;
68 }
69
70 if(pMe->val.uCount != 0) {
71 return false;
72 }
73 return true;
74}
75
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070076static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070077QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
78{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080079#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -070080 if(!QCBORItem_IsMapOrArray(pMe)){
81 return false;
82 }
83
84 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
85 return false;
86 }
87 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080088#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
89 (void)pMe;
90 return false;
91#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -070092}
93
94
Laurence Lundbladeee851742020-01-08 08:37:05 -080095/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070096 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080097 ===========================================================================*/
98
Laurence Lundblade9c905e82020-04-25 11:31:38 -070099/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800100 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
101 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700102 */
103
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700104
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700105static inline uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700106DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700107{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700108 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800109 /* Limit in DecodeNesting_Descend against more than
110 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700111 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700112 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700113}
114
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700115
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700116static inline uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700117DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700118{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700119 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800120 /* Limit in DecodeNesting_Descend against more than
121 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700122 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700123 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700124}
125
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700126
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700127static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700128DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700129{
130 return pNesting->pCurrentBounded->u.ma.uStartOffset;
131}
132
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700133
Laurence Lundblade085d7952020-07-24 10:26:30 -0700134static inline bool
135DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
136{
137 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
138 return true;
139 } else {
140 return false;
141 }
142}
143
144
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700145static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700146DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700147{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700148 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700149 return true;
150 } else {
151 return false;
152 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700153}
154
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700155
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700156static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700157DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700158{
159 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800160 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700161 return false;
162 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800163
164#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700165 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800166 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700167 return false;
168 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800169
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800170#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
171
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800172 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700173 return true;
174}
175
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700176static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700177DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700178{
179 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800180 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700181 return true;
182 }
183 return false;
184}
185
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700186
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700187static inline bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700188{
189 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
190 return true;
191 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700192 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700193 return true;
194 }
195 return false;
196}
197
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700198
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700199static inline void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700200{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800201 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700202 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800203 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
204 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
205 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700206 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700207 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700208
209 if(bIsEmpty) {
210 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
211 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700212}
213
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700214
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700215static inline void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700216{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700217 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
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 bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700222DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700223{
224 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800225 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700226 return false;
227 }
228 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800229 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700230 return false;
231 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700232 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800233 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700234 return false;
235 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800236 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800237 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
238 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800239 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700240 return false;
241 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800242 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700243 return true;
244}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700245
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700246
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700247static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700248DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700249{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800250 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700251 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
252 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700253 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700254 return false;
255 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700256}
257
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700258
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700259static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700260DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700261{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700262 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
263 return true;
264 } else {
265 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700266 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700267}
268
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700269
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700270static inline bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700271DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700272{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700273 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700274 return false;
275 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700276
277 if(pNesting->pCurrentBounded->uLevelType != uType) {
278 return false;
279 }
280
281 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700282}
283
Laurence Lundblade02625d42020-06-25 14:41:41 -0700284
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700285static inline void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700286DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700287{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800288 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700289 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700290}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700291
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700292
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700293static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700294DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
295{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800296 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700297 pNesting->pCurrent->u.ma.uCountCursor++;
298}
299
300
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700301static inline void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700302DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
303{
304 pNesting->pCurrent--;
305}
306
Laurence Lundblade02625d42020-06-25 14:41:41 -0700307
308static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700309DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700310{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800311 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700312 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700313 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700314 }
315
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800316 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700317 pNesting->pCurrent++;
318
319 pNesting->pCurrent->uLevelType = uType;
320
321 return QCBOR_SUCCESS;
322}
323
324
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700325static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800326DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
327 bool bIsEmpty,
328 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700329{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700330 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800331 * Should only be called on map/array.
332 *
333 * Have descended into this before this is called. The job here is
334 * just to mark it in bounded mode.
335 *
336 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
337 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
338 *
339 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700340 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800341 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700342 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700343 }
344
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700345 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700346
347 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700348
349 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700350}
351
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700352
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700353static inline QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700354DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700355 uint8_t uQCBORType,
356 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700357{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700358 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700359
360 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800361 /* Nothing to do for empty definite-length arrays. They are just are
362 * effectively the same as an item that is not a map or array.
363 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700364 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800365 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700366 }
367
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800368 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700369 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
370 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700371 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700372 goto Done;
373 }
374
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700375 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700376 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700377 goto Done;
378 }
379
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800380 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700381 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
382 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700383
384 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700385
386Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700387 return uError;;
388}
389
390
391static inline void
392DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
393{
394 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
395}
396
397
398static inline void
399DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
400{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700401 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700402 pNesting->pCurrentBounded--;
403 if(DecodeNesting_IsCurrentBounded(pNesting)) {
404 break;
405 }
406 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700407}
408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800409
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700410static inline void
411DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
412{
413 pNesting->pCurrent = pNesting->pCurrentBounded;
414}
415
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700416
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700417static inline QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700418DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700419 uint32_t uEndOffset,
420 uint32_t uStartOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700421{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700422 QCBORError uError;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700423
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700424 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700425 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700426 goto Done;
427 }
428
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800429 /* Fill in the new byte string level */
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700430 pNesting->pCurrent->u.bs.uSavedEndOffset = uEndOffset;
431 pNesting->pCurrent->u.bs.uBstrStartOffset = uStartOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700432
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800433 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700434 pNesting->pCurrentBounded = pNesting->pCurrent;
435
436Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700437 return uError;;
438}
439
Laurence Lundbladed0304932020-06-27 10:59:38 -0700440
441static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700442DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700443{
444 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700445}
446
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700447
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700448static inline void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800449DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
450{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700451 if(pNesting->pCurrent->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
452 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
453 }
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800454}
455
456
457static inline void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700458DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700459{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700460 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700461 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
462 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700463}
464
465
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700466static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800467DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
468 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700469{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700470 *pSave = *pNesting;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700471}
472
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700473
Laurence Lundblade02625d42020-06-25 14:41:41 -0700474static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800475DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
476 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700477{
478 *pNesting = *pSave;
479}
480
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700481
Laurence Lundblade02625d42020-06-25 14:41:41 -0700482static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700483DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700484{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700485 return pMe->pCurrentBounded->u.bs.uSavedEndOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700486}
487
488
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800489
490
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800491#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800492/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800493 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
494
495 The following four functions are pretty wrappers for invocation of
496 the string allocator supplied by the caller.
497
Laurence Lundbladeee851742020-01-08 08:37:05 -0800498 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800499
Laurence Lundbladeee851742020-01-08 08:37:05 -0800500static inline void
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800501StringAllocator_Free(const QCBORInternalAllocator *pMe, const void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800502{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800503 /* These pragmas allow the "-Wcast-qual" warnings flag to be set for
504 * gcc and clang. This is the one place where the const needs to be
505 * cast away so const can be use in the rest of the code.
506 */
507#pragma GCC diagnostic push
508#pragma GCC diagnostic ignored "-Wcast-qual"
509 (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, 0);
510#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800511}
512
Laurence Lundbladeee851742020-01-08 08:37:05 -0800513// StringAllocator_Reallocate called with pMem NULL is
514// equal to StringAllocator_Allocate()
515static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800516StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800517 const void *pMem,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800518 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800519{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800520 /* See comment in StringAllocator_Free() */
521#pragma GCC diagnostic push
522#pragma GCC diagnostic ignored "-Wcast-qual"
523 return (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, uSize);
524#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800525}
526
Laurence Lundbladeee851742020-01-08 08:37:05 -0800527static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800528StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800529{
530 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
531}
532
Laurence Lundbladeee851742020-01-08 08:37:05 -0800533static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800534StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800535{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800536 /* See comment in StringAllocator_Free() */
537#pragma GCC diagnostic push
538#pragma GCC diagnostic ignored "-Wcast-qual"
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800539 if(pMe->pfAllocator) {
540 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
541 }
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800542#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800544#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800545
546
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800547
548
Laurence Lundbladeee851742020-01-08 08:37:05 -0800549/*===========================================================================
550 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700551
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800552 See qcbor/qcbor_decode.h for definition of the object
553 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800554 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700555/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800556 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700557 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800558void QCBORDecode_Init(QCBORDecodeContext *pMe,
559 UsefulBufC EncodedCBOR,
560 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700561{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800562 memset(pMe, 0, sizeof(QCBORDecodeContext));
563 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
564 /* Don't bother with error check on decode mode. If a bad value is
565 * passed it will just act as if the default normal mode of 0 was set.
566 */
567 pMe->uDecodeMode = (uint8_t)nDecodeMode;
568 DecodeNesting_Init(&(pMe->nesting));
569
570 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
571 * GetNext_TaggedItem() and MapTagNumber(). */
572 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700573}
574
575
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800576#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
577
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800579 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700580 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800581void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
582 QCBORStringAllocate pfAllocateFunction,
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800583 void *pAllocateContext,
584 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700585{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800586 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
587 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
588 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700589}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800590#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700591
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800592
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800593
594
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800595/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800596 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800597 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800598void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800599 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700600{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800601 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700602 (void)pMe;
603 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700604}
605
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700606
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800607
608
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700609/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800610 * Decoding items is done in six layers, one calling the next one
611 * down. If a layer has no work to do for a particular item, it
612 * returns quickly.
613 *
614 * 1. QCBORDecode_GetNextTagContent - The top layer processes tagged
615 * data items, turning them into the local C representation. For the
616 * most simple it is just associating a QCBOR_TYPE with the data. For
617 * the complex ones that an aggregate of data items, there is some
618 * further decoding and some limited recursion.
619 *
620 * 2. QCBORDecode_GetNextMapOrArray - This manages the beginnings and
621 * ends of maps and arrays. It tracks descending into and ascending
622 * out of maps/arrays. It processes breaks that terminate
623 * indefinite-length maps and arrays.
624 *
625 * 3. QCBORDecode_GetNextMapEntry - This handles the combining of two
626 * items, the label and the data, that make up a map entry. It only
627 * does work on maps. It combines the label and data items into one
628 * labeled item.
629 *
630 * 4. QCBORDecode_GetNextTagNumber - This decodes type 6 tag
631 * numbers. It turns the tag numbers into bit flags associated with
632 * the data item. No actual decoding of the contents of the tag is
633 * performed here.
634 *
635 * 5. QCBORDecode_GetNextFullString - This assembles the sub-items
636 * that make up an indefinite-length string into one string item. It
637 * uses the string allocator to create contiguous space for the
638 * item. It processes all breaks that are part of indefinite-length
639 * strings.
640 *
641 * 6. DecodeAtomicDataItem - This decodes the atomic data items in
642 * CBOR. Each atomic data item has a "major type", an integer
643 * "argument" and optionally some content. For text and byte strings,
644 * the content is the bytes that make up the string. These are the
645 * smallest data items that are considered to be well-formed. The
646 * content may also be other data items in the case of aggregate
647 * types. They are not handled in this layer.
648 *
649 * Roughly this takes 300 bytes of stack for vars. TODO: evaluate this
650 * more carefully and correctly.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700651 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800652
653
654/*
655 * Note about use of int and unsigned variables.
656 *
657 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
658 * used carefully here, and in particular why it isn't used in the
659 * public interface. Also see
660 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
661 *
662 * Int is used for values that need less than 16-bits and would be
663 * subject to integer promotion and result in complaining from static
664 * analyzers.
665 */
666
667
668/**
669 * @brief Decode the CBOR head, the type and argument.
670 *
671 * @param[in] pUInBuf The input buffer to read from.
672 * @param[out] pnMajorType The decoded major type.
673 * @param[out] puArgument The decoded argument.
674 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
675 *
676 * @retval QCBOR_ERR_UNSUPPORTED
677 * @retval QCBOR_ERR_HIT_END
678 *
679 * This decodes the CBOR "head" that every CBOR data item has. See
680 * longer explaination of the head in documentation for
681 * QCBOREncode_EncodeHead().
682 *
683 * This does the network->host byte order conversion. The conversion
684 * here also results in the conversion for floats in addition to that
685 * for lengths, tags and integer values.
686 *
687 * The int type is preferred to uint8_t for some variables as this
688 * avoids integer promotions, can reduce code size and makes static
689 * analyzers happier.
690 */
691static inline QCBORError
692DecodeHead(UsefulInputBuf *pUInBuf,
693 int *pnMajorType,
694 uint64_t *puArgument,
695 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700696{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800697 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800698
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800699 /* Get the initial byte that every CBOR data item has and break it
700 * down. */
701 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800702 const int nTmpMajorType = nInitialByte >> 5;
703 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800704
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800705 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800706 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800707
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800708 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800709 /* Need to get 1,2,4 or 8 additional argument bytes. Map
710 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
711 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800712 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800713
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800714 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800715 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800716 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800717 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800718 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
719 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800720 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800721 /* The reserved and thus-far unused additional info values */
722 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800723 goto Done;
724 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800725 /* Less than 24, additional info is argument or 31, an
726 * indefinite-length. No more bytes to get.
727 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800728 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700729 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800730
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700731 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800732 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700733 goto Done;
734 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800735
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800736 /* All successful if arrived here. */
737 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800738 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800739 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800740 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800741
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800743 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700744}
745
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800746
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800747/**
748 * @brief Decode integer types, major types 0 and 1.
749 *
750 * @param[in] nMajorType The CBOR major type (0 or 1).
751 * @param[in] uArgument The argument from the head.
752 * @param[out] pDecodedItem The filled in decoded item.
753 *
754 * @retval QCBOR_ERR_INT_OVERFLOW
755 *
756 * Must only be called when major type is 0 or 1.
757 *
758 * CBOR doesn't explicitly specify two's compliment for integers but
759 * all CPUs use it these days and the test vectors in the RFC are
760 * so. All integers in the CBOR structure are positive and the major
761 * type indicates positive or negative. CBOR can express positive
762 * integers up to 2^x - 1 where x is the number of bits and negative
763 * integers down to 2^x. Note that negative numbers can be one more
764 * away from zero than positive. Stdint, as far as I can tell, uses
765 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700766 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700767static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800768DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700769{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800770 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800771
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700772 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800773 if (uArgument <= INT64_MAX) {
774 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700775 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800776
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700777 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800778 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700779 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700780 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800781
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700782 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800783 if(uArgument <= INT64_MAX) {
784 /* CBOR's representation of negative numbers lines up with
785 * the two-compliment representation. A negative integer has
786 * one more in range than a positive integer. INT64_MIN is
787 * equal to (-INT64_MAX) - 1.
788 */
789 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700790 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800791
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700792 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800793 /* C can't represent a negative integer in this range so it
794 * is an error.
795 */
796 uReturn = QCBOR_ERR_INT_OVERFLOW;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700797 }
798 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800799
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800800 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700801}
802
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800803
804/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700805#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
806#error QCBOR_TYPE_FALSE macro value wrong
807#endif
808
809#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
810#error QCBOR_TYPE_TRUE macro value wrong
811#endif
812
813#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
814#error QCBOR_TYPE_NULL macro value wrong
815#endif
816
817#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
818#error QCBOR_TYPE_UNDEF macro value wrong
819#endif
820
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700821#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
822#error QCBOR_TYPE_BREAK macro value wrong
823#endif
824
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700825#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
826#error QCBOR_TYPE_DOUBLE macro value wrong
827#endif
828
829#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
830#error QCBOR_TYPE_FLOAT macro value wrong
831#endif
832
Laurence Lundblade9b334962020-08-27 10:55:53 -0700833
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800834/**
835 * @brief Decode major type 7 -- true, false, floating-point, break...
836 *
837 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
838 * @param[in] uArgument The argument from the head.
839 * @param[out] pDecodedItem The filled in decoded item.
840 *
841 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
842 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700843 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800844
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800845static inline QCBORError
846DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
847{
848 QCBORError uReturn = QCBOR_SUCCESS;
849
850 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
851 * checks above make sure uAdditionalInfo values line up with
852 * uDataType values. DecodeHead() never returns an AdditionalInfo
853 * > 0x1f so cast is safe.
854 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800855 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800856
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800857 switch(nAdditionalInfo) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800858 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
859 * are caught before this is called.
860 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800861
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800862 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700863#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800864 /* Half-precision is returned as a double. The cast to
865 * uint16_t is safe because the encoded value was 16 bits. It
866 * was widened to 64 bits to be passed in here.
867 */
868 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700869 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800870#else /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800871 uReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800872#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700873 break;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800874 case SINGLE_PREC_FLOAT: /* 26 */
875 /* Single precision is normally returned as a double since
876 * double is widely supported, there is no loss of precision,
877 * it makes it easy for the caller in most cases and it can
878 * be converted back to single with no loss of precision
879 *
880 * The cast to uint32_t is safe because the encoded value was
881 * 32 bits. It was widened to 64 bits to be passed in here.
882 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700883 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800884 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700885#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800886 /* In the normal case, use HW to convert float to
887 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700888 pDecodedItem->val.dfnum = (double)f;
889 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800890#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800891 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700892 pDecodedItem->val.fnum = f;
893 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
894
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800895 /* IEEE754_FloatToDouble() could be used here to return as
896 * a double, but it adds object code and most likely
897 * anyone disabling FLOAT HW use doesn't care about floats
898 * and wants to save object code.
899 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800900#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700901 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700902 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700903
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800904 case DOUBLE_PREC_FLOAT: /* 27 */
905 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700906 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700907 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800908
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800909 case CBOR_SIMPLEV_FALSE: /* 20 */
910 case CBOR_SIMPLEV_TRUE: /* 21 */
911 case CBOR_SIMPLEV_NULL: /* 22 */
912 case CBOR_SIMPLEV_UNDEF: /* 23 */
913 case CBOR_SIMPLE_BREAK: /* 31 */
914 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800915
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800916 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
917 if(uArgument <= CBOR_SIMPLE_BREAK) {
918 /* This takes out f8 00 ... f8 1f which should be encoded
919 * as e0 … f7
920 */
921 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700922 goto Done;
923 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800924 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800925
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800926 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700927 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800928 /* DecodeHead() will make uArgument equal to
929 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
930 * safe because the 2, 4 and 8 byte lengths of uNumber are in
931 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -0800932 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800933 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700934 break;
935 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800936
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700937Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800938 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700939}
940
941
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800942/**
943 * @brief Decode text and byte strings
944 *
945 * @param[in] pAllocator The string allocator or NULL.
946 * @param[in] uStrLen The length of the string.
947 * @param[in] pUInBuf The surce from which to read the string's bytes.
948 * @param[out] pDecodedItem The filled in decoded item.
949 *
950 * @retval QCBOR_ERR_HIT_END
951 * @retval QCBOR_ERR_STRING_ALLOCATE
952 * @retval QCBOR_ERR_STRING_TOO_LONG
953 *
954 * The reads @c uStrlen bytes from @c pUInBuf and fills in @c
955 * pDecodedItem. If @c pAllocator is not NULL then memory for the
956 * string is allocated.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700957 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800958static inline QCBORError
959DecodeBytes(const QCBORInternalAllocator *pAllocator,
960 uint64_t uStrLen,
961 UsefulInputBuf *pUInBuf,
962 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700963{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800964 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800965
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800966 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
967 * CPUs. This check makes the casts to size_t below safe.
968 *
969 * The max is 4 bytes less than the largest sizeof() so this can be
970 * tested by putting a SIZE_MAX length in the CBOR test input (no
971 * one will care the limit on strings is 4 bytes shorter).
972 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800973 if(uStrLen > SIZE_MAX-4) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800974 uReturn = QCBOR_ERR_STRING_TOO_LONG;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800975 goto Done;
976 }
977
978 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530979 if(UsefulBuf_IsNULLC(Bytes)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800980 /* Failed to get the bytes for this string item */
981 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530982 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700983 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530984
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800985#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800986 /* Note that this is not where allocation to coalesce
987 * indefinite-length strings is done. This is for when the caller
988 * has requested all strings be allocated. Disabling indefinite
989 * length strings also disables this allocate-all option.
990 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800991 if(pAllocator) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800992 /* request to use the string allocator to make a copy */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800993 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530994 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800995 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530996 goto Done;
997 }
998 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800999 pDecodedItem->uDataAlloc = 1;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001000 goto Done;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301001 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001002#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1003 (void)pAllocator;
1004#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1005
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001006 /* Normal case with no string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001007 pDecodedItem->val.string = Bytes;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001008
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301009Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001010 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001011}
1012
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001013
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001014/**
1015 * @brief Map the CBOR major types for strings to the QCBOR types.
1016 *
1017 * @param[in] nCBORMajorType The CBOR major type to convert.
1018 * @retturns QCBOR type number.
1019 *
1020 * This only works for the two string types.
1021 */
1022static inline uint8_t ConvertStringMajorTypes(int nCBORMajorType)
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001023{
1024 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
1025 #error QCBOR_TYPE_BYTE_STRING no lined up with major type
1026 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001027
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001028 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
1029 #error QCBOR_TYPE_TEXT_STRING no lined up with major type
1030 #endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001031
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001032 return (uint8_t)(nCBORMajorType + 4);
1033}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001034
1035
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001036/**
1037 * @brief Map the CBOR major types for arrays/maps to the QCBOR types.
1038 *
1039 * @param[in] nCBORMajorType The CBOR major type to convert.
1040 * @retturns QCBOR type number.
1041 *
1042 * This only works for the two aggregate types.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001043 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001044static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001045{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001046 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1047 #error QCBOR_TYPE_ARRAY value not lined up with major type
1048 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001049
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001050 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1051 #error QCBOR_TYPE_MAP value not lined up with major type
1052 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001053
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001054 return (uint8_t)(nCBORMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001055}
1056
1057
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001058/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001059 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001060 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001061 * @param[in] pUInBuf Input buffer to read data item from.
1062 * @param[out] pDecodedItem The filled-in decoded item.
1063 * @param[in] pAllocator The allocator to use for strings or NULL.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001064 *
1065 * @retval QCBOR_ERR_UNSUPPORTED
1066 * @retval QCBOR_ERR_HIT_END
1067 * @retval QCBOR_ERR_INT_OVERFLOW
1068 * @retval QCBOR_ERR_STRING_ALLOCATE
1069 * @retval QCBOR_ERR_STRING_TOO_LONG
1070 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1071 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001072 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1073 *
1074 * This decodes the most primitive / atomic data item. It does
1075 * no combing of data items.
1076 */
1077static QCBORError
1078DecodeAtomicDataItem(UsefulInputBuf *pUInBuf,
1079 QCBORItem *pDecodedItem,
1080 const QCBORInternalAllocator *pAllocator)
1081{
1082 QCBORError uReturn;
1083
1084 /* Get the major type and the argument. The argument could be
1085 * length of more bytes or the value depending on the major
1086 * type. nAdditionalInfo is an encoding of the length of the
1087 * uNumber and is needed to decode floats and doubles.
1088 */
1089 int nMajorType = 0;
1090 uint64_t uArgument = 0;
1091 int nAdditionalInfo = 0;
1092
1093 memset(pDecodedItem, 0, sizeof(QCBORItem));
1094
1095 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1096 if(uReturn) {
1097 goto Done;
1098 }
1099
1100 /* At this point the major type and the argument are valid. We've
1101 * got the type and the argument that starts every CBOR data item.
1102 */
1103 switch (nMajorType) {
1104 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1105 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
1106 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1107 uReturn = QCBOR_ERR_BAD_INT;
1108 } else {
1109 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
1110 }
1111 break;
1112
1113 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1114 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1115 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
1116 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1117 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
1118 } else {
1119 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
1120 }
1121 break;
1122
1123 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1124 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
1125 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1126 /* Indefinite-length string. */
1127#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1128 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1129#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1130 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1131 break;
1132#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1133 } else {
1134 /* Definite-length string. */
1135 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1136 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1137 goto Done;
1138 }
1139 /* cast OK because of check above */
1140 pDecodedItem->val.uCount = (uint16_t)uArgument;
1141 }
1142 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
1143 break;
1144
1145 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
1146 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1147 uReturn = QCBOR_ERR_BAD_INT;
1148 } else {
1149 pDecodedItem->val.uTagV = uArgument;
1150 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1151 }
1152 break;
1153
1154 case CBOR_MAJOR_TYPE_SIMPLE:
1155 /* Major type 7: float, double, true, false, null... */
1156 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
1157 break;
1158
1159 default:
1160 /* Never happens because DecodeHead() should never return > 7 */
1161 uReturn = QCBOR_ERR_UNSUPPORTED;
1162 break;
1163 }
1164
1165Done:
1166 return uReturn;
1167}
1168
1169
1170/**
1171 * @brief Process indefinite-length strings (decode layer 5).
1172 *
1173 * @param[in] pMe Decoder context
1174 * @param[out] pDecodedItem The decoded item that work is done on.
1175 *
1176 * @retval QCBOR_ERR_UNSUPPORTED
1177 * @retval QCBOR_ERR_HIT_END
1178 * @retval QCBOR_ERR_INT_OVERFLOW
1179 * @retval QCBOR_ERR_STRING_ALLOCATE
1180 * @retval QCBOR_ERR_STRING_TOO_LONG
1181 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1182 * @retval QCBOR_ERR_BAD_TYPE_7
1183 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001184 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1185 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001186 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001187 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001188 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001189 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001190 * If it is, this loops getting the subsequent chunk data items that
1191 * make up the string. The string allocator is used to make a
1192 * contiguous buffer for the chunks. When this completes @c
1193 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001194 *
1195 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001196 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001197static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001198QCBORDecode_GetNextFullString(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001199{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001200 /* Aproximate stack usage
1201 * 64-bit 32-bit
1202 * local vars 32 16
1203 * 2 UsefulBufs 32 16
1204 * QCBORItem 56 52
1205 * TOTAL 120 74
1206 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001207
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001208 /* The string allocator is used here for two purposes: 1)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001209 * coalescing the chunks of an indefinite-length string, 2)
1210 * allocating storage for every string returned when requested.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001211 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001212 * The first use is below in this function. Indefinite-length
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001213 * strings cannot be processed at all without a string allocator.
1214 *
1215 * The second used is in DecodeBytes() which is called by
1216 * GetNext_Item() below. This second use unneccessary for most use
1217 * and only happens when requested in the call to
1218 * QCBORDecode_SetMemPool(). If the second use not requested then
1219 * NULL is passed for the string allocator to GetNext_Item().
1220 *
1221 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1222 * allocator altogether and thus both of these uses. It reduced the
1223 * decoder object code by about 400 bytes.
1224 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001225 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001226
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001227#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001228 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001229
1230 if(pMe->StringAllocator.pfAllocator) {
1231 pAllocator = &(pMe->StringAllocator);
1232 if(pMe->bStringAllocateAll) {
1233 pAllocatorForGetNext = pAllocator;
1234 }
1235 }
1236#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1237
1238 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001239 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001240 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001241 goto Done;
1242 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001243
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001244 /* Only do indefinite-length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001245 const uint8_t uStringType = pDecodedItem->uDataType;
1246 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001247 goto Done;
1248 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001249
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001250 /* Is this a string with an indefinite length? */
1251 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1252 goto Done;
1253 }
1254
1255#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001256 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001257 if(pAllocator == NULL) {
1258 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1259 goto Done;
1260 }
1261
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001262 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001263 UsefulBufC FullString = NULLUsefulBufC;
1264
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001265 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001266 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001267 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001268 /* Pass a NULL string allocator to GetNext_Item() because the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001269 * individual string chunks in an indefinite-length should not
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001270 * be allocated. They are always copied in the the contiguous
1271 * buffer allocated here.
1272 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001273 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), &StringChunkItem, NULL);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001274 if(uReturn) {
1275 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001276 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001277
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001278 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001279 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001280 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001281 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301282 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001283 break;
1284 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001285
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001286 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001287 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001288 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001289 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001290 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001291 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001292 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1293 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001294 break;
1295 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001296
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001297 /* The first time throurgh FullString.ptr is NULL and this is
1298 * equivalent to StringAllocator_Allocate(). Subsequently it is
1299 * not NULL and a reallocation happens.
1300 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001301 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001302 FullString.ptr,
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001303 FullString.len + StringChunkItem.val.string.len);
1304
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001305 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001306 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001307 break;
1308 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001309
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001310 /* Copy new string chunk to the end of accumulated string */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001311 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001312 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001313
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001314 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1315 /* Getting the item failed, clean up the allocated memory */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001316 StringAllocator_Free(pAllocator, FullString.ptr);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001317 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001318#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1319 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1320#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001321
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001322Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001323 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001324}
1325
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001326
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001327/**
1328 * @brief This converts a tag number to a shorter mapped value for storage.
1329 *
1330 * @param[in] pMe The decode context.
1331 * @param[in] uUnMappedTag The tag number to map
1332 * @param[out] puMappedTagNumer The stored tag number.
1333 *
1334 * @return error code.
1335 *
1336 * The main point of mapping tag numbers is make QCBORItem
1337 * smaller. With this mapping storage of 4 tags takes up 8
1338 * bytes. Without, it would take up 32 bytes.
1339 *
1340 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1341 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1342 *
1343 * See also UnMapTagNumber() and @ref QCBORItem.
1344 */
1345static inline QCBORError
1346MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1347{
1348 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1349 unsigned uTagMapIndex;
1350 /* Is there room in the tag map, or is it in it already? */
1351 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1352 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1353 break;
1354 }
1355 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1356 break;
1357 }
1358 }
1359 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1360 return QCBOR_ERR_TOO_MANY_TAGS;
1361 }
1362
1363 /* Covers the cases where tag is new and were it is already in the map */
1364 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1365 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1366
1367 } else {
1368 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1369 }
1370
1371 return QCBOR_SUCCESS;
1372}
1373
1374
1375/**
1376 * @brief This converts a mapped tag number to the actual tag number.
1377 *
1378 * @param[in] pMe The decode context.
1379 * @param[in] uMappedTagNumber The stored tag number.
1380 *
1381 * @return The actual tag number is returned or
1382 * @ref CBOR_TAG_INVALID64 on error.
1383 *
1384 * This is the reverse of MapTagNumber()
1385 */
1386static uint64_t
1387UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1388{
1389 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1390 return uMappedTagNumber;
1391 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001392 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001393 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001394 /* This won't be negative because of code below in
1395 * MapTagNumber()
1396 */
1397 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1398 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001399 }
1400}
1401
Laurence Lundblade9b334962020-08-27 10:55:53 -07001402
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001403/**
1404 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1405 *
1406 * @param[in] pMe Decoder context
1407 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001409 * @retval QCBOR_ERR_UNSUPPORTED
1410 * @retval QCBOR_ERR_HIT_END
1411 * @retval QCBOR_ERR_INT_OVERFLOW
1412 * @retval QCBOR_ERR_STRING_ALLOCATE
1413 * @retval QCBOR_ERR_STRING_TOO_LONG
1414 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1415 * @retval QCBOR_ERR_BAD_TYPE_7
1416 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1417 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1418 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1419 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1420 * @retval QCBOR_ERR_TOO_MANY_TAGS
1421 *
1422 * This loops getting atomic data items until one is not a tag
1423 * number. Usually this is largely pass-through because most
1424 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001425 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001426static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001427QCBORDecode_GetNextTagNumber(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001428{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001429 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1430
1431 /* Initialize to CBOR_TAG_INVALID16 */
1432 #if CBOR_TAG_INVALID16 != 0xffff
1433 /* Be sure the memset does the right thing. */
1434 #err CBOR_TAG_INVALID16 tag not defined as expected
1435 #endif
1436 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001437
Laurence Lundblade9b334962020-08-27 10:55:53 -07001438 QCBORError uReturn = QCBOR_SUCCESS;
1439
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001440 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001441 for(;;) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001442 QCBORError uErr = QCBORDecode_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001443 if(uErr != QCBOR_SUCCESS) {
1444 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001445 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001446 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001447
Laurence Lundblade9b334962020-08-27 10:55:53 -07001448 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001449 /* Successful exit from loop; maybe got some tags, maybe not */
1450 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001451 break;
1452 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001453
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001454 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1455 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001456 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001457 /* Continue on to get all tags wrapping this item even though
1458 * it is erroring out in the end. This allows decoding to
1459 * continue. This is a resource limit error, not a problem
1460 * with being well-formed CBOR.
1461 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001462 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001463 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001464 /* Slide tags over one in the array to make room at index 0.
1465 * Must use memmove because the move source and destination
1466 * overlap.
1467 */
1468 memmove(&auItemsTags[1], auItemsTags, sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001469
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001470 /* Map the tag */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001471 uint16_t uMappedTagNumer = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001472 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumer);
1473 /* Continue even on error so as to consume all tags wrapping
1474 * this data item so decoding can go on. If MapTagNumber()
1475 * errors once it will continue to error.
1476 */
1477 auItemsTags[0] = uMappedTagNumer;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001478 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001479
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001480Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001481 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001482}
1483
1484
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001485/**
1486 * @brief Combine a map entry label and value into one item (decode layer 3).
1487 *
1488 * @param[in] pMe Decoder context
1489 * @param[out] pDecodedItem The decoded item that work is done on.
1490 *
1491 * @retval QCBOR_ERR_UNSUPPORTED
1492 * @retval QCBOR_ERR_HIT_END
1493 * @retval QCBOR_ERR_INT_OVERFLOW
1494 * @retval QCBOR_ERR_STRING_ALLOCATE
1495 * @retval QCBOR_ERR_STRING_TOO_LONG
1496 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1497 * @retval QCBOR_ERR_BAD_TYPE_7
1498 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1499 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1500 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1501 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1502 * @retval QCBOR_ERR_TOO_MANY_TAGS
1503 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1504 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1505 *
1506 * If a the current nesting level is a map, then this
1507 * combines pairs of items into one data item with a label
1508 * and value.
1509 *
1510 * This is pass-through if the current nesting leve is
1511 * not a map.
1512 *
1513 * This also implements maps-as-array mode where a map
1514 * is treated like an array to allow caller to do their
1515 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001516 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001517static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001518QCBORDecode_GetNextMapEntry(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001519{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001520 QCBORError uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1521 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001522 goto Done;
1523 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001524
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001525 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1526 /* Break can't be a map entry */
1527 goto Done;
1528 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001529
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001530 if(pMe->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1531 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001532
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001533 if(DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1534 /* Save label in pDecodedItem and get the next which will
1535 * be the real data item.
1536 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001537 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001538 uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1539 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001540 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001541 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001542
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301543 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001544
1545 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001546 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001547 pDecodedItem->label.string = LabelItem.val.string;
1548 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001549 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == pMe->uDecodeMode) {
1550 /* It's not a string and we only want strings */
1551 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001552 goto Done;
1553 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1554 pDecodedItem->label.int64 = LabelItem.val.int64;
1555 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1556 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1557 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1558 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1559 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1560 pDecodedItem->label.string = LabelItem.val.string;
1561 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1562 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1563 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001564 /* label is not an int or a string. It is an arrray
1565 * or a float or such and this implementation doesn't handle that.
1566 * Also, tags on labels are ignored.
1567 */
1568 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001569 goto Done;
1570 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001571 }
1572 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001573 /* Decoding of maps as arrays to let the caller decide what to do
1574 * about labels, particularly lables that are not integers or
1575 * strings.
1576 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001577 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001578 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001579 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001580 goto Done;
1581 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001582 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001583 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1584 * Cast is needed because of integer promotion.
1585 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001586 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001587 }
1588 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001589
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001590Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001591 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001592}
1593
1594
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001595#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001596/**
1597 * @brief Peek and see if next data item is a break;
1598 *
1599 * @param[in] pUIB UsefulInputBuf to read from.
1600 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1601 *
1602 * @return Any decoding error.
1603 *
1604 * See if next item is a CBOR break. If it is, it is consumed,
1605 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001606*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001607static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001608NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1609{
1610 *pbNextIsBreak = false;
1611 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001612 QCBORItem Peek;
1613 size_t uPeek = UsefulInputBuf_Tell(pUIB);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001614 QCBORError uReturn = DecodeAtomicDataItem(pUIB, &Peek, NULL);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001615 if(uReturn != QCBOR_SUCCESS) {
1616 return uReturn;
1617 }
1618 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001619 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001620 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001621 } else {
1622 *pbNextIsBreak = true;
1623 }
1624 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001625
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001626 return QCBOR_SUCCESS;
1627}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001628#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001629
1630
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001631/**
1632 * @brief Ascend up nesting levels if all items in them have been consumed.
1633 *
1634 * @param[in] pMe The decode context.
1635 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1636 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001637 * An item was just consumed, now figure out if it was the
1638 * end of an array/map map that can be closed out. That
1639 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001640*/
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001641static QCBORError
1642QCBORDecode_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001643{
1644 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001645
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001646 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001647 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1648
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001649 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1650 /* Nesting level is bstr-wrapped CBOR */
1651
1652 /* Ascent for bstr-wrapped CBOR is always by explicit call
1653 * so no further ascending can happen.
1654 */
1655 break;
1656
1657 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1658 /* Level is a definite-length array/map */
1659
1660 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001661 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1662 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001663 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001664 break;
1665 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001666 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001667 * is time to ascend one level. This happens below.
1668 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001669
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001670#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001671 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001672 /* Level is an indefinite-length array/map. */
1673
1674 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001675 bool bIsBreak = false;
1676 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1677 if(uReturn != QCBOR_SUCCESS) {
1678 goto Done;
1679 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001680
1681 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001682 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001683 break;
1684 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001685
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001686 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001687 * it is time to ascend one level.
1688 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001689
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001690#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001691 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001692
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001693
1694 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001695
Laurence Lundblade93d89472020-10-03 22:30:50 -07001696 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001697 * QCBORDecode_ExitBoundedMode().
1698 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001699 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001700 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001701 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001702 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001703 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001704 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001705
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001706 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001707 break;
1708 }
1709
1710 /* Finally, actually ascend one level. */
1711 DecodeNesting_Ascend(&(pMe->nesting));
1712 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001713
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001714 uReturn = QCBOR_SUCCESS;
1715
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001716#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001717Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001718#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1719
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001720 return uReturn;
1721}
1722
1723
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001724/**
1725 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1726 *
1727 * @param[in] pMe Decoder context
1728 * @param[out] pDecodedItem The decoded item that work is done on.
1729 *
1730 * @retval QCBOR_ERR_UNSUPPORTED
1731 * @retval QCBOR_ERR_HIT_END
1732 * @retval QCBOR_ERR_INT_OVERFLOW
1733 * @retval QCBOR_ERR_STRING_ALLOCATE
1734 * @retval QCBOR_ERR_STRING_TOO_LONG
1735 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1736 * @retval QCBOR_ERR_BAD_TYPE_7
1737 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1738 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1739 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1740 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1741 * @retval QCBOR_ERR_TOO_MANY_TAGS
1742 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1743 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1744 * @retval QCBOR_ERR_NO_MORE_ITEMS
1745 * @retval QCBOR_ERR_BAD_BREAK
1746 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
1747 *
1748 * This handles the traversal descending into and asecnding out of
1749 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
1750 * definite- and indefinte-length maps and arrays by looking at the
1751 * item count or finding CBOR breaks. It detects the ends of the
1752 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001753 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001754static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001755QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001756{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001757 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001758 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001759
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001760 /* If out of bytes to consume, it is either the end of the
1761 * top-level sequence of some bstr-wrapped CBOR that was entered.
1762 *
1763 * In the case of bstr-wrapped CBOR, the length of the
1764 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
1765 * the bstr-wrapped CBOR is exited, the length is set back to the
1766 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001767 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001768 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001769 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001770 goto Done;
1771 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001772
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001773 /* Check to see if at the end of a bounded definite-length map or
1774 * array. The check for a break ending indefinite-length array is
1775 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001776 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001777 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001778 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001779 goto Done;
1780 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001781
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001782 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001783 uReturn = QCBORDecode_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001784 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1785 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001786 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001787 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301788
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001789 /* Breaks ending arrays/maps are processed later in the call to
1790 * QCBORDecode_NestLevelAscender(). They should never show up here.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001791 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301792 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001793 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301794 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301795 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001796
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001797 /* Record the nesting level for this data item before processing
1798 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001799 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001800 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001801
Laurence Lundblade642282a2020-06-23 12:00:33 -07001802
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001803 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001804 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001805 /* If the new item is a map or array, descend.
1806 *
1807 * Empty indefinite-length maps and arrays are descended into,
1808 * but then ascended out of in the next chunk of code.
1809 *
1810 * Maps and arrays do count as items in the map/array that
1811 * encloses them so a decrement needs to be done for them too,
1812 * but that is done only when all the items in them have been
1813 * processed, not when they are opened with the exception of an
1814 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001815 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001816 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001817 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001818 pDecodedItem->uDataType,
1819 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001820 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001821 /* This error is probably a traversal error and it overrides
1822 * the non-traversal error.
1823 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001824 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001825 goto Done;
1826 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001827 }
1828
Laurence Lundblade02625d42020-06-25 14:41:41 -07001829 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1830 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1831 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001832 /* The following cases are handled here:
1833 * - A non-aggregate item like an integer or string
1834 * - An empty definite-length map or array
1835 * - An indefinite-length map or array that might be empty or might not.
1836 *
1837 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
1838 * for an definite-length map/array and break detection for an
1839 * indefinite-0length map/array. If the end of the map/array was
1840 * reached, then it ascends nesting levels, possibly all the way
1841 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001842 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001843 QCBORError uAscendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001844 uAscendErr = QCBORDecode_NestLevelAscender(pMe, true);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001845 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001846 /* This error is probably a traversal error and it overrides
1847 * the non-traversal error.
1848 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001849 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001850 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001851 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301852 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001853
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001854 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001855 /* Tell the caller what level is next. This tells them what
1856 * maps/arrays were closed out and makes it possible for them to
1857 * reconstruct the tree with just the information returned in a
1858 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001859 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001860 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001861 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001862 pDecodedItem->uNextNestLevel = 0;
1863 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001864 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001865 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001866
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001867Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001868 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001869}
1870
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001871
1872/**
1873 * @brief Shift 0th tag out of the tag list.
1874 *
1875 * pDecodedItem[in,out] The data item to convert.
1876 *
1877 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
1878 * shifted into empty slot at the end of the tag list.
1879 */
1880static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001881{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001882 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
1883 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
1884 }
1885 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001886}
1887
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001888
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001889/**
1890 * @brief Convert different epoch date formats in to the QCBOR epoch date format
1891 *
1892 * pDecodedItem[in,out] The data item to convert.
1893 *
1894 * @retval QCBOR_ERR_DATE_OVERFLOW
1895 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1896 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1897 *
1898 * The epoch date tag defined in QCBOR allows for floating-point
1899 * dates. It even allows a protocol to flop between date formats when
1900 * ever it wants. Floating-point dates aren't that useful as they are
1901 * only needed for dates beyond the age of the earth.
1902 *
1903 * This converts all the date formats into one format of an unsigned
1904 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001905 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001906static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001907{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001908 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001909
1910 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1911
1912 switch (pDecodedItem->uDataType) {
1913
1914 case QCBOR_TYPE_INT64:
1915 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1916 break;
1917
1918 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001919 /* This only happens for CBOR type 0 > INT64_MAX so it is
1920 * always an overflow.
1921 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001922 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1923 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001924 break;
1925
1926 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001927 case QCBOR_TYPE_FLOAT:
1928#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001929 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001930 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001931 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001932 pDecodedItem->val.dfnum :
1933 (double)pDecodedItem->val.fnum;
1934
1935 /* The conversion from float to integer requires overflow
1936 * detection since floats can be much larger than integers.
1937 * This implementation errors out on these large float values
1938 * since they are beyond the age of the earth.
1939 *
1940 * These constants for the overflow check are computed by the
1941 * compiler. They are not computed at run time.
1942 *
1943 * The factor of 0x7ff is added/subtracted to avoid a
1944 * rounding error in the wrong direction when the compiler
1945 * computes these constants. There is rounding because an
1946 * 64-bit integer has 63 bits of precision where a double
1947 * only has 53 bits. Without the 0x7ff factor, the compiler
1948 * may round up and produce a double for the bounds check
1949 * that is larger than can be stored in a 64-bit integer. The
1950 * amount of 0x7ff is picked because it has 11 bits set.
1951 *
1952 * Without the 0x7ff there is a ~30 minute range of time
1953 * values 10 billion years in the past and in the future
1954 * where this code could go wrong. Some compilers correctly
1955 * generate a warning or error without the 0x7ff.
1956 */
1957 const double dDateMax = (double)(INT64_MAX - 0x7ff);
1958 const double dDateMin = (double)(INT64_MIN + 0x7ff);
1959
1960 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07001961 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001962 goto Done;
1963 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001964
1965 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001966 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001967 pDecodedItem->val.epochDate.fSecondsFraction =
1968 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001969 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001970#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07001971
Laurence Lundbladec7114722020-08-13 05:11:40 -07001972 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001973 goto Done;
1974
Laurence Lundblade9682a532020-06-06 18:33:04 -07001975#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001976 break;
1977
1978 default:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001979 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001980 goto Done;
1981 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001982
Laurence Lundblade59289e52019-12-30 13:44:37 -08001983 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1984
1985Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001986 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001987}
1988
1989
Laurence Lundblade46d63e92021-05-13 11:37:10 -07001990/**
1991 * @brief Convert the days epoch date.
1992 *
1993 * pDecodedItem[in,out] The data item to convert.
1994 *
1995 * @retval QCBOR_ERR_DATE_OVERFLOW
1996 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1997 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1998 *
1999 * This is much simpler than the other epoch date format because
2000 * floating-porint is not allowed. This is mostly a simple type check.
2001 */
2002static QCBORError DecodeDaysEpoch(QCBORItem *pDecodedItem)
2003{
2004 QCBORError uReturn = QCBOR_SUCCESS;
2005
2006 switch (pDecodedItem->uDataType) {
2007
2008 case QCBOR_TYPE_INT64:
2009 pDecodedItem->val.epochDays = pDecodedItem->val.int64;
2010 break;
2011
2012 case QCBOR_TYPE_UINT64:
2013 /* This only happens for CBOR type 0 > INT64_MAX so it is
2014 * always an overflow.
2015 */
2016 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2017 goto Done;
2018 break;
2019
2020 default:
2021 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
2022 goto Done;
2023 break;
2024 }
2025
2026 pDecodedItem->uDataType = QCBOR_TYPE_DAYS_EPOCH;
2027
2028Done:
2029 return uReturn;
2030}
2031
2032
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002033#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002034/**
2035 * @brief Decode decimal fractions and big floats.
2036 *
2037 * @param[in] pMe The decode context.
2038 * @param[in,out] pDecodedItem On input the array data item that
2039 * holds the mantissa and exponent. On
2040 * output the decoded mantissa and
2041 * exponent.
2042 *
2043 * @returns Decoding errors from getting primitive data items or
2044 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2045 *
2046 * When called pDecodedItem must be the array that is tagged as a big
2047 * float or decimal fraction, the array that has the two members, the
2048 * exponent and mantissa.
2049 *
2050 * This will fetch and decode the exponent and mantissa and put the
2051 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002052 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002053static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002054QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002055{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002056 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002057
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002058 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002059 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002060 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002061 goto Done;
2062 }
2063
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002064 /* A check for pDecodedItem->val.uCount == 2 would work for
2065 * definite-length arrays, but not for indefnite. Instead remember
2066 * the nesting level the two integers must be at, which is one
2067 * deeper than that of the array.
2068 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002069 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2070
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002071 /* --- Which is it, decimal fraction or a bigfloat? --- */
2072 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002073 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2074
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002075 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002076 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002077 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2078 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002079 goto Done;
2080 }
2081 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002082 /* Array is empty or a map/array encountered when expecting an int */
2083 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002084 goto Done;
2085 }
2086 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002087 /* Data arriving as an unsigned int < INT64_MAX has been
2088 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2089 * also means that the only data arriving here of type
2090 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2091 * and thus an error that will get handled in the next else.
2092 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002093 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2094 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002095 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2096 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002097 goto Done;
2098 }
2099
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002100 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002101 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002102 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2103 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002104 goto Done;
2105 }
2106 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002107 /* Mantissa missing or map/array encountered when expecting number */
2108 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002109 goto Done;
2110 }
2111 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002112 /* Data arriving as an unsigned int < INT64_MAX has been
2113 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2114 * also means that the only data arriving here of type
2115 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2116 * and thus an error that will get handled in an else below.
2117 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002118 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002119 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2120 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002121 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002122 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002123 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002124 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2125 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2126 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002127 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002128 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2129 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002130 goto Done;
2131 }
2132
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002133 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002134 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002135 /* Extra items in the decimal fraction / big float */
2136 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002137 goto Done;
2138 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002139 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002140
2141Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002142 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002143}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002144#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002145
2146
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002147#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002148/**
2149 * @brief Decode the MIME type tag
2150 *
2151 * @param[in,out] pDecodedItem The item to decode.
2152 *
2153 * Handle the text and binary MIME type tags. Slightly too complicated
2154 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2155 * incorreclty text-only.
2156 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002157static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002158{
2159 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2160 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002161 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002162 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2163 } else {
2164 return QCBOR_ERR_BAD_OPT_TAG;
2165 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002166
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002167 return QCBOR_SUCCESS;
2168}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002169#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002170
2171
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002172/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002173 * Table of CBOR tags whose content is either a text string or a byte
2174 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2175 * of uQCBORtype indicates the content should be a byte string rather
2176 * than a text string
2177 */
2178struct StringTagMapEntry {
2179 uint16_t uTagNumber;
2180 uint8_t uQCBORtype;
2181};
2182
2183#define IS_BYTE_STRING_BIT 0x80
2184#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2185
2186static const struct StringTagMapEntry StringTagMap[] = {
2187 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002188 {CBOR_TAG_DAYS_STRING, QCBOR_TYPE_DAYS_STRING},
Laurence Lundblade99615302020-11-29 11:19:47 -08002189 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2190 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2191 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2192 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002193#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002194 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2195 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2196 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2197 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002198#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002199 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2200 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2201};
2202
2203
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002204/**
2205 * @brief Process standard CBOR tags whose content is a string
2206 *
2207 * @param[in] uTag The tag.
2208 * @param[in,out] pDecodedItem The data item.
2209 *
2210 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2211 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2212 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2213 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002214 * Process the CBOR tags that whose content is a byte string or a text
2215 * string and for which the string is just passed on to the caller.
2216 *
2217 * This maps the CBOR tag to the QCBOR type and checks the content
2218 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002219 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002220 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002221 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002222static inline QCBORError
2223ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002224{
Laurence Lundblade99615302020-11-29 11:19:47 -08002225 /* This only works on tags that were not mapped; no need for other yet */
2226 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2227 return QCBOR_ERR_UNSUPPORTED;
2228 }
2229
2230 unsigned uIndex;
2231 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2232 if(StringTagMap[uIndex].uTagNumber == uTag) {
2233 break;
2234 }
2235 }
2236
2237 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2238 if(uQCBORType == QCBOR_TYPE_NONE) {
2239 /* repurpose this error to mean, not handled here */
2240 return QCBOR_ERR_UNSUPPORTED;
2241 }
2242
2243 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2244 if(uQCBORType & IS_BYTE_STRING_BIT) {
2245 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2246 }
2247
2248 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002249 return QCBOR_ERR_BAD_OPT_TAG;
2250 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002251
Laurence Lundblade99615302020-11-29 11:19:47 -08002252 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002253 return QCBOR_SUCCESS;
2254}
2255
2256
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002257/**
2258 * @brief Decode tag content for select tags (decoding layer 1).
2259 *
2260 * @param[in] pMe The decode context.
2261 * @param[out] pDecodedItem The decoded item.
2262 *
2263 * @return Decoding error code.
2264 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002265 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2266 * but the whole tag was not decoded. Here, the whole tags (tag number
2267 * and tag content) that are supported by QCBOR are decoded. This is a
2268 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002269 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002270static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002271QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002272{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002273 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002274
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002275 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002276 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002277 goto Done;
2278 }
2279
Laurence Lundblade99615302020-11-29 11:19:47 -08002280 /* When there are no tag numbers for the item, this exits first
2281 * thing and effectively does nothing.
2282 *
2283 * This loops over all the tag numbers accumulated for this item
2284 * trying to decode and interpret them. This stops at the end of
2285 * the list or at the first tag number that can't be interpreted by
2286 * this code. This is effectively a recursive processing of the
2287 * tags number list that handles nested tags.
2288 */
2289 while(1) {
2290 /* Don't bother to unmap tags via QCBORITem.uTags since this
2291 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2292 */
2293 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002294
Laurence Lundblade99615302020-11-29 11:19:47 -08002295 if(uTagToProcess == CBOR_TAG_INVALID16) {
2296 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002297 break;
2298
Laurence Lundblade99615302020-11-29 11:19:47 -08002299 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002300 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002301
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002302 } else if(uTagToProcess == CBOR_TAG_DAYS_EPOCH) {
2303 uReturn = DecodeDaysEpoch(pDecodedItem);
2304
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002305#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002306 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2307 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002308 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002309#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002310#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002311 } else if(uTagToProcess == CBOR_TAG_MIME ||
2312 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002313 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002314#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002315
Laurence Lundblade99615302020-11-29 11:19:47 -08002316 } else {
2317 /* See if it is a pass-through byte/text string tag; process if so */
2318 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002319
Laurence Lundblade99615302020-11-29 11:19:47 -08002320 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2321 /* It wasn't a pass-through byte/text string tag so it is
2322 * an unknown tag. This is the exit from the loop on the
2323 * first unknown tag. It is a successful exit.
2324 */
2325 uReturn = QCBOR_SUCCESS;
2326 break;
2327 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002328 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002329
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002330 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002331 /* Error exit from the loop */
2332 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002333 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002334
2335 /* A tag was successfully processed, shift it out of the list of
2336 * tags returned. This is the loop increment.
2337 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002338 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002339 }
2340
2341Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002342 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002343}
2344
2345
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002346/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002348 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002349QCBORError
2350QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2351{
2352 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002353 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002354 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002355 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2356 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2357 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002358 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002359}
2360
2361
2362/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002363 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002364 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002365QCBORError
2366QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2367{
2368 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2369 const UsefulInputBuf Save = pMe->InBuf;
2370
2371 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2372
2373 pMe->nesting = SaveNesting;
2374 pMe->InBuf = Save;
2375
2376 return uErr;
2377}
2378
2379
2380/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002381 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002382 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002383void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2384{
2385 if(pMe->uLastError != QCBOR_SUCCESS) {
2386 return;
2387 }
2388
2389 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2390}
2391
2392
2393/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002394 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002395 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002396QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002397QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2398 QCBORItem *pDecodedItem,
2399 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002400{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002401 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002402
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002403 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2404 if(uReturn != QCBOR_SUCCESS) {
2405 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002406 }
2407
2408 if(pTags != NULL) {
2409 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002410 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002411 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2412 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002413 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002414 }
2415 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2416 return QCBOR_ERR_TOO_MANY_TAGS;
2417 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002418 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002419 pTags->uNumUsed++;
2420 }
2421 }
2422
2423 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002424}
2425
2426
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002427/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002428 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302429 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002430bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002431 const QCBORItem *pItem,
2432 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002433{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002434 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2435 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002436 break;
2437 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002438 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002439 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002440 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002441 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002442
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002443 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002444}
2445
2446
2447/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002448 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002449 */
Laurence Lundblade87495732021-02-26 10:05:55 -07002450QCBORError QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002451{
Laurence Lundblade87495732021-02-26 10:05:55 -07002452 if(puConsumed != NULL) {
2453 *puConsumed = pMe->InBuf.cursor;
2454 }
2455
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002456 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002457
2458 if(uReturn != QCBOR_SUCCESS) {
2459 goto Done;
2460 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002461
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002462 /* Error out if all the maps/arrays are not closed out */
2463 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002464 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002465 goto Done;
2466 }
2467
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002468 /* Error out if not all the bytes are consumed */
2469 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002470 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002471 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002472
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002473Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002474 return uReturn;
2475}
2476
2477
2478/*
2479 * Public function, see header qcbor/qcbor_decode.h file
2480 */
2481QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
2482{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002483#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002484 /* Call the destructor for the string allocator if there is one.
2485 * Always called, even if there are errors; always have to clean up.
2486 */
2487 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002488#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002489
Laurence Lundblade87495732021-02-26 10:05:55 -07002490 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002491}
2492
2493
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002494/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002495 * Public function, see header qcbor/qcbor_decode.h file
2496 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002497// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002498uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2499 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002500 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002501{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002502 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2503 return CBOR_TAG_INVALID64;
2504 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002505 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2506 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002507 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002508 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002509 }
2510}
2511
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002512
Laurence Lundblade9b334962020-08-27 10:55:53 -07002513/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002514 * Public function, see header qcbor/qcbor_decode.h file
2515 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002516uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2517 uint32_t uIndex)
2518{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002519 if(pMe->uLastError != QCBOR_SUCCESS) {
2520 return CBOR_TAG_INVALID64;
2521 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002522 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2523 return CBOR_TAG_INVALID64;
2524 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002525 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002526 }
2527}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002528
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002529
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002530
2531
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002532#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002533
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002534/* ===========================================================================
2535 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002536
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002537 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002538 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2539 implements the function type QCBORStringAllocate and allows easy
2540 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002541
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002542 This particular allocator is built-in for convenience. The caller
2543 can implement their own. All of this following code will get
2544 dead-stripped if QCBORDecode_SetMemPool() is not called.
2545
2546 This is a very primitive memory allocator. It does not track
2547 individual allocations, only a high-water mark. A free or
2548 reallocation must be of the last chunk allocated.
2549
2550 The size of the pool and offset to free memory are packed into the
2551 first 8 bytes of the memory pool so we don't have to keep them in
2552 the decode context. Since the address of the pool may not be
2553 aligned, they have to be packed and unpacked as if they were
2554 serialized data of the wire or such.
2555
2556 The sizes packed in are uint32_t to be the same on all CPU types
2557 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002558 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002559
2560
Laurence Lundbladeee851742020-01-08 08:37:05 -08002561static inline int
2562MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002563{
2564 // Use of UsefulInputBuf is overkill, but it is convenient.
2565 UsefulInputBuf UIB;
2566
Laurence Lundbladeee851742020-01-08 08:37:05 -08002567 // Just assume the size here. It was checked during SetUp so
2568 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002569 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002570 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2571 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2572 return UsefulInputBuf_GetError(&UIB);
2573}
2574
2575
Laurence Lundbladeee851742020-01-08 08:37:05 -08002576static inline int
2577MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002578{
2579 // Use of UsefulOutBuf is overkill, but convenient. The
2580 // length check performed here is useful.
2581 UsefulOutBuf UOB;
2582
2583 UsefulOutBuf_Init(&UOB, Pool);
2584 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2585 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2586 return UsefulOutBuf_GetError(&UOB);
2587}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002588
2589
2590/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002591 Internal function for an allocation, reallocation free and destuct.
2592
2593 Having only one function rather than one each per mode saves space in
2594 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002595
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002596 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2597 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002598static UsefulBuf
2599MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002600{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002601 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002602
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002603 uint32_t uPoolSize;
2604 uint32_t uFreeOffset;
2605
2606 if(uNewSize > UINT32_MAX) {
2607 // This allocator is only good up to 4GB. This check should
2608 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2609 goto Done;
2610 }
2611 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2612
2613 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2614 goto Done;
2615 }
2616
2617 if(uNewSize) {
2618 if(pMem) {
2619 // REALLOCATION MODE
2620 // Calculate pointer to the end of the memory pool. It is
2621 // assumed that pPool + uPoolSize won't wrap around by
2622 // assuming the caller won't pass a pool buffer in that is
2623 // not in legitimate memory space.
2624 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2625
2626 // Check that the pointer for reallocation is in the range of the
2627 // pool. This also makes sure that pointer math further down
2628 // doesn't wrap under or over.
2629 if(pMem >= pPool && pMem < pPoolEnd) {
2630 // Offset to start of chunk for reallocation. This won't
2631 // wrap under because of check that pMem >= pPool. Cast
2632 // is safe because the pool is always less than UINT32_MAX
2633 // because of check in QCBORDecode_SetMemPool().
2634 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2635
2636 // Check to see if the allocation will fit. uPoolSize -
2637 // uMemOffset will not wrap under because of check that
2638 // pMem is in the range of the uPoolSize by check above.
2639 if(uNewSize <= uPoolSize - uMemOffset) {
2640 ReturnValue.ptr = pMem;
2641 ReturnValue.len = uNewSize;
2642
2643 // Addition won't wrap around over because uNewSize was
2644 // checked to be sure it is less than the pool size.
2645 uFreeOffset = uMemOffset + uNewSize32;
2646 }
2647 }
2648 } else {
2649 // ALLOCATION MODE
2650 // uPoolSize - uFreeOffset will not underflow because this
2651 // pool implementation makes sure uFreeOffset is always
2652 // smaller than uPoolSize through this check here and
2653 // reallocation case.
2654 if(uNewSize <= uPoolSize - uFreeOffset) {
2655 ReturnValue.len = uNewSize;
2656 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002657 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002658 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002659 }
2660 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002661 if(pMem) {
2662 // FREE MODE
2663 // Cast is safe because of limit on pool size in
2664 // QCBORDecode_SetMemPool()
2665 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2666 } else {
2667 // DESTRUCT MODE
2668 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002669 }
2670 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002671
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002672 UsefulBuf Pool = {pPool, uPoolSize};
2673 MemPool_Pack(Pool, uFreeOffset);
2674
2675Done:
2676 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002677}
2678
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002679
Laurence Lundbladef6531662018-12-04 10:42:22 +09002680/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002681 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002682 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002683QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2684 UsefulBuf Pool,
2685 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002686{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002687 // The pool size and free mem offset are packed into the beginning
2688 // of the pool memory. This compile time check make sure the
2689 // constant in the header is correct. This check should optimize
2690 // down to nothing.
2691 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002692 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002693 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002694
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002695 // The pool size and free offset packed in to the beginning of pool
2696 // memory are only 32-bits. This check will optimize out on 32-bit
2697 // machines.
2698 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002699 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002700 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002701
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002702 // This checks that the pool buffer given is big enough.
2703 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002704 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002705 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002706
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002707 pMe->StringAllocator.pfAllocator = MemPool_Function;
2708 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2709 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002710
Laurence Lundblade30816f22018-11-10 13:40:22 +07002711 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002712}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002713#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002714
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002715
2716
Laurence Lundblade9b334962020-08-27 10:55:53 -07002717static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2718{
2719 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2720}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002721
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002722
2723/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002724 Consume an entire map or array (and do next to
2725 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002726 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002727static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002728ConsumeItem(QCBORDecodeContext *pMe,
2729 const QCBORItem *pItemToConsume,
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02002730 uint8_t *puNextNestLevel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002731{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002732 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002733 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002734
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002735 // If it is a map or array, this will tell if it is empty.
2736 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2737
2738 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2739 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002740
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002741 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002742 * maps and arrays by using the nesting level
2743 */
2744 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002745 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002746 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002747 goto Done;
2748 }
2749 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002750
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002751 *puNextNestLevel = Item.uNextNestLevel;
2752
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002753 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002754
Laurence Lundblade1341c592020-04-11 14:19:05 -07002755 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002756 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002757 /* Just pass the nesting level through */
2758 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2759
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002760 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002761 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002762
2763Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002764 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002765}
2766
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002767
2768void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2769{
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002770 QCBORDecode_VGetNext(pMe, pDecodedItem);
2771
2772 if(pMe->uLastError == QCBOR_SUCCESS) {
Máté Tóth-Pálc6d59682021-05-26 18:55:30 +02002773 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem,
2774 &pDecodedItem->uNextNestLevel);
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002775 }
2776}
2777
2778
2779
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002780/* Call only on maps and arrays. Rewinds the cursor
2781 * to the start as if it was just entered.
2782 */
2783static void RewindMapOrArray(QCBORDecodeContext *pMe)
2784{
2785 /* Reset nesting tracking to the deepest bounded level */
2786 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2787
2788 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2789
2790 /* Reposition traversal cursor to the start of the map/array */
2791 UsefulInputBuf_Seek(&(pMe->InBuf),
2792 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2793}
2794
2795
2796/*
2797 Public function, see header qcbor/qcbor_decode.h file
2798 */
2799void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2800{
2801 if(pMe->nesting.pCurrentBounded != NULL) {
2802 /* In a bounded map, array or bstr-wrapped CBOR */
2803
2804 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2805 /* In bstr-wrapped CBOR. */
2806
2807 /* Reposition traversal cursor to start of wrapping byte string */
2808 UsefulInputBuf_Seek(&(pMe->InBuf),
2809 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2810 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2811
2812 } else {
2813 /* In a map or array */
2814 RewindMapOrArray(pMe);
2815 }
2816
2817 } else {
2818 /* Not in anything bounded */
2819
2820 /* Reposition traversal cursor to the start of input CBOR */
2821 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2822
2823 /* Reset nesting tracking to beginning of input. */
2824 DecodeNesting_Init(&(pMe->nesting));
2825 }
2826
2827 pMe->uLastError = QCBOR_SUCCESS;
2828}
2829
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002830
Laurence Lundblade1341c592020-04-11 14:19:05 -07002831/* Return true if the labels in Item1 and Item2 are the same.
2832 Works only for integer and string labels. Returns false
2833 for any other type. */
2834static inline bool
2835MatchLabel(QCBORItem Item1, QCBORItem Item2)
2836{
2837 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2838 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2839 return true;
2840 }
2841 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002842 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002843 return true;
2844 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002845 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002846 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2847 return true;
2848 }
2849 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2850 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2851 return true;
2852 }
2853 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002854
Laurence Lundblade1341c592020-04-11 14:19:05 -07002855 /* Other label types are never matched */
2856 return false;
2857}
2858
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002859
2860/*
2861 Returns true if Item1 and Item2 are the same type
2862 or if either are of QCBOR_TYPE_ANY.
2863 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002864static inline bool
2865MatchType(QCBORItem Item1, QCBORItem Item2)
2866{
2867 if(Item1.uDataType == Item2.uDataType) {
2868 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002869 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002870 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002871 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002872 return true;
2873 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002874 return false;
2875}
2876
2877
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002878/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002879 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002880
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002881 @param[in] pMe The decode context to search.
2882 @param[in,out] pItemArray The items to search for and the items found.
2883 @param[out] puOffset Byte offset of last item matched.
2884 @param[in] pCBContext Context for the not-found item call back.
2885 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002886
2887 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2888
Laurence Lundblade93d89472020-10-03 22:30:50 -07002889 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2890 were found for one of the labels being
2891 search for. This duplicate detection is
2892 only performed for items in pItemArray,
2893 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002894
Laurence Lundblade93d89472020-10-03 22:30:50 -07002895 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2896 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002897
2898 @retval Also errors returned by QCBORDecode_GetNext().
2899
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002900 On input pItemArray contains a list of labels and data types
2901 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002902
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002903 On output the fully retrieved items are filled in with
2904 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002905
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002906 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002907
2908 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002909 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002910static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002911MapSearch(QCBORDecodeContext *pMe,
2912 QCBORItem *pItemArray,
2913 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002914 void *pCBContext,
2915 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002916{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002917 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002918 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002919
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002920 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002921 uReturn = pMe->uLastError;
2922 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002923 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002924
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002925 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002926 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2927 /* QCBOR_TYPE_NONE as first item indicates just looking
2928 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002929 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2930 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002931 }
2932
Laurence Lundblade085d7952020-07-24 10:26:30 -07002933 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2934 // It is an empty bounded array or map
2935 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2936 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002937 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002938 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002939 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002940 // Nothing is ever found in an empty array or map. All items
2941 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002942 uReturn = QCBOR_SUCCESS;
2943 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002944 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002945 }
2946
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002947 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002948 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2949
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002950 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002951 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002952
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002953 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002954 Loop over all the items in the map or array. Each item
2955 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002956 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002957 length maps and arrays. The only reason this is ever
2958 called on arrays is to find their end position.
2959
2960 This will always run over all items in order to do
2961 duplicate detection.
2962
2963 This will exit with failure if it encounters an
2964 unrecoverable error, but continue on for recoverable
2965 errors.
2966
2967 If a recoverable error occurs on a matched item, then
2968 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002969 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002970 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02002971 uint8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002972 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002973 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002974 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002975
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002976 /* Get the item */
2977 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002978 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002979 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002980 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002981 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002982 goto Done;
2983 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002984 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002985 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002986 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002987 goto Done;
2988 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002989
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002990 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002991 bool bMatched = false;
2992 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2993 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002994 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002995 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2996 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002997 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002998 }
Laurence Lundblade63926052021-03-29 16:05:51 -07002999 if(uResult != QCBOR_SUCCESS) {
3000 /* The label matches, but the data item is in error */
3001 uReturn = uResult;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003002 goto Done;
3003 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003004 if(!MatchType(Item, pItemArray[nIndex])) {
3005 /* The data item is not of the type(s) requested */
3006 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003007 goto Done;
3008 }
3009
Laurence Lundblade1341c592020-04-11 14:19:05 -07003010 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003011 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003012 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003013 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003014 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003015 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003016 bMatched = true;
3017 }
3018 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003019
3020
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003021 if(!bMatched && pfCallback != NULL) {
3022 /*
3023 Call the callback on unmatched labels.
3024 (It is tempting to do duplicate detection here, but that would
3025 require dynamic memory allocation because the number of labels
3026 that might be encountered is unbounded.)
3027 */
3028 uReturn = (*pfCallback)(pCBContext, &Item);
3029 if(uReturn != QCBOR_SUCCESS) {
3030 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003031 }
3032 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003033
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003034 /*
3035 Consume the item whether matched or not. This
3036 does the work of traversing maps and array and
3037 everything in them. In this loop only the
3038 items at the current nesting level are examined
3039 to match the labels.
3040 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003041 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003042 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003043 goto Done;
3044 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003045
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003046 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003047
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003048 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003049
3050 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003051
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003052 // Check here makes sure that this won't accidentally be
3053 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003054 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003055 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3056 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003057 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3058 goto Done;
3059 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003060 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3061 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003062
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003063 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003064 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
3065
3066 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003067 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003068 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003069 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003070 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3071 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003072 }
3073 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003074
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003075 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003076}
3077
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003078
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003079/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003080 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003081*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003082void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3083 int64_t nLabel,
3084 uint8_t uQcborType,
3085 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003086{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003087 if(pMe->uLastError != QCBOR_SUCCESS) {
3088 return;
3089 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003090
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003091 QCBORItem OneItemSeach[2];
3092 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3093 OneItemSeach[0].label.int64 = nLabel;
3094 OneItemSeach[0].uDataType = uQcborType;
3095 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003096
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003097 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003098
3099 *pItem = OneItemSeach[0];
3100
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003101 if(uReturn != QCBOR_SUCCESS) {
3102 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003103 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003104 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003105 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003106 }
3107
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003108 Done:
3109 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003110}
3111
3112
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003113/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003114 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003115*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003116void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3117 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003118 uint8_t uQcborType,
3119 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003120{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003121 if(pMe->uLastError != QCBOR_SUCCESS) {
3122 return;
3123 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003124
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003125 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003126 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3127 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3128 OneItemSeach[0].uDataType = uQcborType;
3129 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003130
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003131 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3132 if(uReturn != QCBOR_SUCCESS) {
3133 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003134 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003135 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003136 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003137 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003138 }
3139
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003140 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003141
3142Done:
3143 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003144}
3145
3146
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003147
Laurence Lundblade93d89472020-10-03 22:30:50 -07003148static QCBORError
3149CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003150{
3151 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3152 if(uDataType == puTypeList[i]) {
3153 return QCBOR_SUCCESS;
3154 }
3155 }
3156 return QCBOR_ERR_UNEXPECTED_TYPE;
3157}
3158
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003159
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003160/**
3161 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003162 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003163
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003164 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3165 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003166
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003167 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3168 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003169 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003170static QCBORError
3171CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003172{
3173 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3174 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3175 /* There are tags that QCBOR couldn't process on this item and
3176 the caller has told us there should not be. */
3177 return QCBOR_ERR_UNEXPECTED_TYPE;
3178 }
3179
3180 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3181 const int nItemType = pItem->uDataType;
3182
3183 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3184 // Must match the tag and only the tag
3185 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3186 }
3187
3188 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3189 if(uReturn == QCBOR_SUCCESS) {
3190 return QCBOR_SUCCESS;
3191 }
3192
3193 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3194 /* Must match the content type and only the content type.
3195 There was no match just above so it is a fail. */
3196 return QCBOR_ERR_UNEXPECTED_TYPE;
3197 }
3198
3199 /* If here it can match either the tag or the content
3200 and it hasn't matched the content, so the end
3201 result is whether it matches the tag. This is
3202 also the case that the CBOR standard discourages. */
3203
3204 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3205}
3206
Laurence Lundblade9b334962020-08-27 10:55:53 -07003207
Laurence Lundblade9b334962020-08-27 10:55:53 -07003208
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003209// This could be semi-private if need be
3210static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003211void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3212 int64_t nLabel,
3213 TagSpecification TagSpec,
3214 QCBORItem *pItem)
3215{
3216 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3217 if(pMe->uLastError != QCBOR_SUCCESS) {
3218 return;
3219 }
3220
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003221 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003222}
3223
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003224
3225// This could be semi-private if need be
3226static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003227void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3228 const char *szLabel,
3229 TagSpecification TagSpec,
3230 QCBORItem *pItem)
3231{
3232 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3233 if(pMe->uLastError != QCBOR_SUCCESS) {
3234 return;
3235 }
3236
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003237 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003238}
3239
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003240// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003241void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3242 int64_t nLabel,
3243 TagSpecification TagSpec,
3244 UsefulBufC *pString)
3245{
3246 QCBORItem Item;
3247 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3248 if(pMe->uLastError == QCBOR_SUCCESS) {
3249 *pString = Item.val.string;
3250 }
3251}
3252
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003253// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003254void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3255 const char * szLabel,
3256 TagSpecification TagSpec,
3257 UsefulBufC *pString)
3258{
3259 QCBORItem Item;
3260 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3261 if(pMe->uLastError == QCBOR_SUCCESS) {
3262 *pString = Item.val.string;
3263 }
3264}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003265
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003266/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003267 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003268*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003269void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003270{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003271 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3272 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003273}
3274
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003275/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003276 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003277*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003278void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3279 QCBORItem *pItemList,
3280 void *pCallbackCtx,
3281 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003282{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003283 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3284 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003285}
3286
3287
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003288/**
3289 * @brief Search for a map/array by label and enter it
3290 *
3291 * @param[in] pMe The decode context.
3292 * @param[in] pSearch The map/array to search for.
3293 *
3294 * @c pSearch is expected to contain one item of type map or array
3295 * with the label specified. The current bounded map will be searched for
3296 * this and if found will be entered.
3297 *
3298 * If the label is not found, or the item found is not a map or array,
3299 * the error state is set.
3300 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003301static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003302{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003303 // The first item in pSearch is the one that is to be
3304 // entered. It should be the only one filled in. Any other
3305 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003306 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003307 return;
3308 }
3309
3310 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003311 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003312 if(pMe->uLastError != QCBOR_SUCCESS) {
3313 return;
3314 }
3315
Laurence Lundblade9b334962020-08-27 10:55:53 -07003316 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003317 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003318 return;
3319 }
3320
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003321
3322 /* The map or array was found. Now enter it.
3323 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003324 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3325 * next item for the pre-order traversal cursor to be the map/array
3326 * found by MapSearch(). The next few lines of code force the
3327 * cursor to that.
3328 *
3329 * There is no need to retain the old cursor because
3330 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3331 * beginning of the map/array being entered.
3332 *
3333 * The cursor is forced by: 1) setting the input buffer position to
3334 * the item offset found by MapSearch(), 2) setting the map/array
3335 * counter to the total in the map/array, 3) setting the nesting
3336 * level. Setting the map/array counter to the total is not
3337 * strictly correct, but this is OK because this cursor only needs
3338 * to be used to get one item and MapSearch() has already found it
3339 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003340 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003341 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003342
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003343 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3344
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003345 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003346
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003347 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003348}
3349
3350
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003351/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003352 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003353*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003354void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003355{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003356 QCBORItem OneItemSeach[2];
3357 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3358 OneItemSeach[0].label.int64 = nLabel;
3359 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3360 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003361
Laurence Lundblade9b334962020-08-27 10:55:53 -07003362 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003363 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003364}
3365
3366
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003367/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003368 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003369*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003370void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003371{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003372 QCBORItem OneItemSeach[2];
3373 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3374 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3375 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3376 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003377
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003378 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003379}
3380
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003381/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003382 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003383*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003384void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003385{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003386 QCBORItem OneItemSeach[2];
3387 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3388 OneItemSeach[0].label.int64 = nLabel;
3389 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3390 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003391
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003392 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003393}
3394
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003395/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003396 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003397*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003398void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3399{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003400 QCBORItem OneItemSeach[2];
3401 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3402 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3403 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3404 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003405
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003406 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003407}
3408
3409
Laurence Lundblade02625d42020-06-25 14:41:41 -07003410// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003411void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003412{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003413 QCBORError uErr;
3414
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003415 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003416 if(pMe->uLastError != QCBOR_SUCCESS) {
3417 // Already in error state; do nothing.
3418 return;
3419 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003420
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003421 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003422 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003423 uErr = QCBORDecode_GetNext(pMe, &Item);
3424 if(uErr != QCBOR_SUCCESS) {
3425 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003426 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003427 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003428 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3429 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003430 }
3431
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003432 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003433
3434
Laurence Lundbladef0499502020-08-01 11:55:57 -07003435 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003436 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003437 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3438 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003439 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003440 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3441 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003442 // Special case to increment nesting level for zero-length maps
3443 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003444 DecodeNesting_Descend(&(pMe->nesting), uType);
3445 }
3446
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003447 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003448
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003449 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3450 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003451
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003452 if(pItem != NULL) {
3453 *pItem = Item;
3454 }
3455
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003456Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003457 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003458}
3459
Laurence Lundblade02625d42020-06-25 14:41:41 -07003460
3461/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003462 This is the common work for exiting a level that is a bounded map,
3463 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003464
3465 One chunk of work is to set up the pre-order traversal so it is at
3466 the item just after the bounded map, array or bstr that is being
3467 exited. This is somewhat complex.
3468
3469 The other work is to level-up the bounded mode to next higest bounded
3470 mode or the top level if there isn't one.
3471 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003472static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003473ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003474{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003475 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003476
Laurence Lundblade02625d42020-06-25 14:41:41 -07003477 /*
3478 First the pre-order-traversal byte offset is positioned to the
3479 item just after the bounded mode item that was just consumed.
3480 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003481 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3482
Laurence Lundblade02625d42020-06-25 14:41:41 -07003483 /*
3484 Next, set the current nesting level to one above the bounded level
3485 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003486
Laurence Lundblade02625d42020-06-25 14:41:41 -07003487 DecodeNesting_CheckBoundedType() is always called before this and
3488 makes sure pCurrentBounded is valid.
3489 */
3490 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3491
3492 /*
3493 This does the complex work of leveling up the pre-order traversal
3494 when the end of a map or array or another bounded level is
3495 reached. It may do nothing, or ascend all the way to the top
3496 level.
3497 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003498 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003499 if(uErr != QCBOR_SUCCESS) {
3500 goto Done;
3501 }
3502
Laurence Lundblade02625d42020-06-25 14:41:41 -07003503 /*
3504 This makes the next highest bounded level the current bounded
3505 level. If there is no next highest level, then no bounded mode is
3506 in effect.
3507 */
3508 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003509
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003510 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003511
3512Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003513 return uErr;
3514}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003515
Laurence Lundblade02625d42020-06-25 14:41:41 -07003516
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003517// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003518void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003519{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003520 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003521 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003522 return;
3523 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003524
Laurence Lundblade02625d42020-06-25 14:41:41 -07003525 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003526
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003527 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003528 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003529 goto Done;
3530 }
3531
Laurence Lundblade02625d42020-06-25 14:41:41 -07003532 /*
3533 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003534 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003535 from previous map search, then do a dummy search.
3536 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003537 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003538 QCBORItem Dummy;
3539 Dummy.uLabelType = QCBOR_TYPE_NONE;
3540 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3541 if(uErr != QCBOR_SUCCESS) {
3542 goto Done;
3543 }
3544 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003545
Laurence Lundblade02625d42020-06-25 14:41:41 -07003546 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003547
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003548Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003549 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003550}
3551
3552
Laurence Lundblade1341c592020-04-11 14:19:05 -07003553
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003554static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003555 const QCBORItem *pItem,
3556 uint8_t uTagRequirement,
3557 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003558{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003559 if(pBstr) {
3560 *pBstr = NULLUsefulBufC;
3561 }
3562
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003563 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003564 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003565 return pMe->uLastError;
3566 }
3567
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003568 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003569
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003570 const TagSpecification TagSpec =
3571 {
3572 uTagRequirement,
3573 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3574 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3575 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003576
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003577 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003578 if(uError != QCBOR_SUCCESS) {
3579 goto Done;
3580 }
3581
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003582 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003583 /* Reverse the decrement done by GetNext() for the bstr so the
3584 * increment in QCBORDecode_NestLevelAscender() called by
3585 * ExitBoundedLevel() will work right.
3586 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003587 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003588 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003589
3590 if(pBstr) {
3591 *pBstr = pItem->val.string;
3592 }
3593
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003594 /* This saves the current length of the UsefulInputBuf and then
3595 * narrows the UsefulInputBuf to start and length of the wrapped
3596 * CBOR that is being entered.
3597 *
3598 * Most of these calls are simple inline accessors so this doesn't
3599 * amount to much code.
3600 */
3601
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003602 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003603 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3604 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003605 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003606 goto Done;
3607 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003608
3609 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3610 pItem->val.string.ptr);
3611 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3612 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3613 /* This should never happen because pItem->val.string.ptr should
3614 * always be valid since it was just returned.
3615 */
3616 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3617 goto Done;
3618 }
3619
3620 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3621
3622 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003623 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003624
Laurence Lundblade02625d42020-06-25 14:41:41 -07003625 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003626 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003627 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003628Done:
3629 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003630}
3631
3632
Laurence Lundblade02625d42020-06-25 14:41:41 -07003633/*
3634 Public function, see header qcbor/qcbor_decode.h file
3635 */
3636void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003637 uint8_t uTagRequirement,
3638 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003639{
3640 if(pMe->uLastError != QCBOR_SUCCESS) {
3641 // Already in error state; do nothing.
3642 return;
3643 }
3644
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003645 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003646 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003647 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3648 if(pMe->uLastError != QCBOR_SUCCESS) {
3649 return;
3650 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003651
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003652 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003653 &Item,
3654 uTagRequirement,
3655 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003656}
3657
3658
Laurence Lundblade02625d42020-06-25 14:41:41 -07003659/*
3660 Public function, see header qcbor/qcbor_decode.h file
3661 */
3662void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003663 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003664 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003665 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003666{
3667 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003668 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003669
Laurence Lundblade93d89472020-10-03 22:30:50 -07003670 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3671 &Item,
3672 uTagRequirement,
3673 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003674}
3675
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003676
Laurence Lundblade02625d42020-06-25 14:41:41 -07003677/*
3678 Public function, see header qcbor/qcbor_decode.h file
3679 */
3680void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003681 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003682 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003683 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003684{
3685 QCBORItem Item;
3686 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3687
Laurence Lundblade93d89472020-10-03 22:30:50 -07003688 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3689 &Item,
3690 uTagRequirement,
3691 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003692}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003693
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003694
Laurence Lundblade02625d42020-06-25 14:41:41 -07003695/*
3696 Public function, see header qcbor/qcbor_decode.h file
3697 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003698void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003699{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003700 if(pMe->uLastError != QCBOR_SUCCESS) {
3701 // Already in error state; do nothing.
3702 return;
3703 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003704
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003705 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003706 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003707 return;
3708 }
3709
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003710 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3711
Laurence Lundblade02625d42020-06-25 14:41:41 -07003712 /*
3713 Reset the length of the UsefulInputBuf to what it was before
3714 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003715 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003716 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003717 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003718
3719
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003720 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003721 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003722}
3723
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003724
Laurence Lundbladee6430642020-03-14 21:15:44 -07003725
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003726
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003727static inline void
3728ProcessBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003729{
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003730 if(pMe->uLastError != QCBOR_SUCCESS) {
3731 /* Already in error state, do nothing */
3732 return;
3733 }
3734
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003735 switch(pItem->uDataType) {
3736 case QCBOR_TYPE_TRUE:
3737 *pBool = true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003738 break;
3739
3740 case QCBOR_TYPE_FALSE:
3741 *pBool = false;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003742 break;
3743
3744 default:
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003745 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003746 break;
3747 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003748 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003749}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003750
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003751
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003752/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003753 * Public function, see header qcbor/qcbor_decode.h file
3754 */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003755void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003756{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003757 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003758 /* Already in error state, do nothing */
Laurence Lundbladee6430642020-03-14 21:15:44 -07003759 return;
3760 }
3761
Laurence Lundbladec4537442020-04-14 18:53:22 -07003762 QCBORItem Item;
3763
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003764 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3765
3766 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003767}
3768
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003769
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003770/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003771 * Public function, see header qcbor/qcbor_decode.h file
3772 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003773void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003774{
3775 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003776 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003777
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003778 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003779}
3780
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003781
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003782/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003783 * Public function, see header qcbor/qcbor_decode.h file
3784 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003785void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3786{
3787 QCBORItem Item;
3788 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3789
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003790 ProcessBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003791}
3792
3793
3794
Laurence Lundbladec7114722020-08-13 05:11:40 -07003795
3796static void ProcessEpochDate(QCBORDecodeContext *pMe,
3797 QCBORItem *pItem,
3798 uint8_t uTagRequirement,
3799 int64_t *pnTime)
3800{
3801 if(pMe->uLastError != QCBOR_SUCCESS) {
3802 // Already in error state, do nothing
3803 return;
3804 }
3805
3806 QCBORError uErr;
3807
3808 const TagSpecification TagSpec =
3809 {
3810 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003811 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3812 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003813 };
3814
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003815 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003816 if(uErr != QCBOR_SUCCESS) {
3817 goto Done;
3818 }
3819
3820 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3821 uErr = DecodeDateEpoch(pItem);
3822 if(uErr != QCBOR_SUCCESS) {
3823 goto Done;
3824 }
3825 }
3826
Laurence Lundblade9b334962020-08-27 10:55:53 -07003827 // Save the tags in the last item's tags in the decode context
3828 // for QCBORDecode_GetNthTagOfLast()
3829 CopyTags(pMe, pItem);
3830
Laurence Lundbladec7114722020-08-13 05:11:40 -07003831 *pnTime = pItem->val.epochDate.nSeconds;
3832
3833Done:
3834 pMe->uLastError = (uint8_t)uErr;
3835}
3836
3837
3838void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003839 uint8_t uTagRequirement,
3840 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003841{
3842 if(pMe->uLastError != QCBOR_SUCCESS) {
3843 // Already in error state, do nothing
3844 return;
3845 }
3846
3847 QCBORItem Item;
3848 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3849
3850 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3851}
3852
3853
3854void
3855QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3856 int64_t nLabel,
3857 uint8_t uTagRequirement,
3858 int64_t *pnTime)
3859{
3860 QCBORItem Item;
3861 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3862 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3863}
3864
3865
3866void
3867QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3868 const char *szLabel,
3869 uint8_t uTagRequirement,
3870 int64_t *pnTime)
3871{
3872 QCBORItem Item;
3873 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3874 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3875}
3876
3877
3878
Laurence Lundblade46d63e92021-05-13 11:37:10 -07003879/*
3880 * Common processing for the RFC 8943 day-count tag. Mostly
3881 * make sure the tag content is correct and copy forward any
3882 * further other tag numbers.
3883 */
3884static void ProcessEpochDays(QCBORDecodeContext *pMe,
3885 QCBORItem *pItem,
3886 uint8_t uTagRequirement,
3887 int64_t *pnDays)
3888{
3889 if(pMe->uLastError != QCBOR_SUCCESS) {
3890 /* Already in error state, do nothing */
3891 return;
3892 }
3893
3894 QCBORError uErr;
3895
3896 const TagSpecification TagSpec =
3897 {
3898 uTagRequirement,
3899 {QCBOR_TYPE_DAYS_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3900 {QCBOR_TYPE_INT64, QCBOR_TYPE_UINT64, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3901 };
3902
3903 uErr = CheckTagRequirement(TagSpec, pItem);
3904 if(uErr != QCBOR_SUCCESS) {
3905 goto Done;
3906 }
3907
3908 if(pItem->uDataType != QCBOR_TYPE_DAYS_EPOCH) {
3909 uErr = DecodeDaysEpoch(pItem);
3910 if(uErr != QCBOR_SUCCESS) {
3911 goto Done;
3912 }
3913 }
3914
3915 /* Save the tags in the last item's tags in the decode context
3916 * for QCBORDecode_GetNthTagOfLast()
3917 */
3918 CopyTags(pMe, pItem);
3919
3920 *pnDays = pItem->val.epochDays;
3921
3922Done:
3923 pMe->uLastError = (uint8_t)uErr;
3924}
3925
3926
3927/*
3928 * Public function, see header qcbor/qcbor_decode.h
3929 */
3930void QCBORDecode_GetEpochDays(QCBORDecodeContext *pMe,
3931 uint8_t uTagRequirement,
3932 int64_t *pnDays)
3933{
3934 if(pMe->uLastError != QCBOR_SUCCESS) {
3935 /* Already in error state, do nothing */
3936 return;
3937 }
3938
3939 QCBORItem Item;
3940 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3941
3942 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3943}
3944
3945
3946/*
3947 * Public function, see header qcbor/qcbor_decode.h
3948 */
3949void
3950QCBORDecode_GetEpochDaysInMapN(QCBORDecodeContext *pMe,
3951 int64_t nLabel,
3952 uint8_t uTagRequirement,
3953 int64_t *pnDays)
3954{
3955 QCBORItem Item;
3956 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3957 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3958}
3959
3960
3961/*
3962 * Public function, see header qcbor/qcbor_decode.h
3963 */
3964void
3965QCBORDecode_GetEpochDaysInMapSZ(QCBORDecodeContext *pMe,
3966 const char *szLabel,
3967 uint8_t uTagRequirement,
3968 int64_t *pnDays)
3969{
3970 QCBORItem Item;
3971 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3972 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3973}
3974
3975
3976
Laurence Lundbladec7114722020-08-13 05:11:40 -07003977
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003978void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3979 TagSpecification TagSpec,
3980 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003981{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003982 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003983 // Already in error state, do nothing
3984 return;
3985 }
3986
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003987 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003988 QCBORItem Item;
3989
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003990 uError = QCBORDecode_GetNext(pMe, &Item);
3991 if(uError != QCBOR_SUCCESS) {
3992 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003993 return;
3994 }
3995
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003996 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003997
3998 if(pMe->uLastError == QCBOR_SUCCESS) {
3999 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07004000 } else {
4001 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004002 }
4003}
4004
Laurence Lundbladec4537442020-04-14 18:53:22 -07004005
4006
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004007
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004008static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004009 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004010 UsefulBufC *pValue,
4011 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004012{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004013 const TagSpecification TagSpec =
4014 {
4015 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004016 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4017 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004018 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004019
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004020 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004021 if(uErr != QCBOR_SUCCESS) {
4022 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004023 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004024
4025 *pValue = pItem->val.string;
4026
4027 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
4028 *pbIsNegative = false;
4029 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
4030 *pbIsNegative = true;
4031 }
4032
4033 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004034}
4035
4036
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004037/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004038 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004039 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004040void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
4041 uint8_t uTagRequirement,
4042 UsefulBufC *pValue,
4043 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004044{
4045 if(pMe->uLastError != QCBOR_SUCCESS) {
4046 // Already in error state, do nothing
4047 return;
4048 }
4049
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004050 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004051 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4052 if(uError != QCBOR_SUCCESS) {
4053 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004054 return;
4055 }
4056
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004057 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004058}
4059
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004060
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004061/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004062 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004063*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004064void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
4065 int64_t nLabel,
4066 uint8_t uTagRequirement,
4067 UsefulBufC *pValue,
4068 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004069{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004070 QCBORItem Item;
4071 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004072 if(pMe->uLastError != QCBOR_SUCCESS) {
4073 return;
4074 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004075
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004076 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004077}
4078
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004079
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004080/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004081 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004082*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004083void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
4084 const char *szLabel,
4085 uint8_t uTagRequirement,
4086 UsefulBufC *pValue,
4087 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004088{
4089 QCBORItem Item;
4090 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004091 if(pMe->uLastError != QCBOR_SUCCESS) {
4092 return;
4093 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004094
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004095 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004096}
4097
4098
4099
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004100
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004101// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004102QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
4103 const QCBORItem *pItem,
4104 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07004105 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004106{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004107 const TagSpecification TagSpecText =
4108 {
4109 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004110 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4111 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004112 };
4113 const TagSpecification TagSpecBinary =
4114 {
4115 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004116 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4117 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004118 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004119
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004120 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004121
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004122 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004123 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004124 if(pbIsTag257 != NULL) {
4125 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004126 }
4127 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004128 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004129 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004130 if(pbIsTag257 != NULL) {
4131 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004132 }
4133 uReturn = QCBOR_SUCCESS;
4134
4135 } else {
4136 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
4137 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07004138
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004139 return uReturn;
4140}
4141
Laurence Lundblade93d89472020-10-03 22:30:50 -07004142// Improvement: add methods for wrapped CBOR, a simple alternate
4143// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004144
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004145
4146
4147
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004148#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07004149
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004150typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004151
4152
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004153// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004154static QCBORError
4155Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004156{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004157 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004158
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004159 if(uResult != 0) {
4160 /* This loop will run a maximum of 19 times because
4161 * UINT64_MAX < 10 ^^ 19. More than that will cause
4162 * exit with the overflow error
4163 */
4164 for(; nExponent > 0; nExponent--) {
4165 if(uResult > UINT64_MAX / 10) {
4166 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4167 }
4168 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004169 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004170
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004171 for(; nExponent < 0; nExponent++) {
4172 uResult = uResult / 10;
4173 if(uResult == 0) {
4174 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4175 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004176 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004177 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004178 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004179
4180 *puResult = uResult;
4181
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004182 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004183}
4184
4185
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004186// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004187static QCBORError
4188Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004189{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004190 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004191
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004192 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004193
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004194 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004195 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004196 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004197 */
4198 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004199 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004200 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004201 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004202 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004203 nExponent--;
4204 }
4205
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004206 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004207 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004208 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4209 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004210 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004211 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004212 }
4213
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004214 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004215
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004216 return QCBOR_SUCCESS;
4217}
4218
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004219
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004220/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004221 Compute value with signed mantissa and signed result. Works with
4222 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004223 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004224static inline QCBORError ExponentiateNN(int64_t nMantissa,
4225 int64_t nExponent,
4226 int64_t *pnResult,
4227 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004228{
4229 uint64_t uResult;
4230
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004231 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004232 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004233 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4234
4235 // Do the exponentiation of the positive mantissa
4236 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4237 if(uReturn) {
4238 return uReturn;
4239 }
4240
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004241
Laurence Lundblade983500d2020-05-14 11:49:34 -07004242 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4243 of INT64_MIN. This assumes two's compliment representation where
4244 INT64_MIN is one increment farther from 0 than INT64_MAX.
4245 Trying to write -INT64_MIN doesn't work to get this because the
4246 compiler tries to work with an int64_t which can't represent
4247 -INT64_MIN.
4248 */
4249 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4250
4251 // Error out if too large
4252 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004253 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4254 }
4255
4256 // Casts are safe because of checks above
4257 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4258
4259 return QCBOR_SUCCESS;
4260}
4261
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004262
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004263/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004264 Compute value with signed mantissa and unsigned result. Works with
4265 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004266 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004267static inline QCBORError ExponentitateNU(int64_t nMantissa,
4268 int64_t nExponent,
4269 uint64_t *puResult,
4270 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004271{
4272 if(nMantissa < 0) {
4273 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4274 }
4275
4276 // Cast to unsigned is OK because of check for negative
4277 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4278 // Exponentiation is straight forward
4279 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4280}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004281
4282
4283/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004284 Compute value with signed mantissa and unsigned result. Works with
4285 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004286 */
4287static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4288 int64_t nExponent,
4289 uint64_t *puResult,
4290 fExponentiator pfExp)
4291{
4292 return (*pfExp)(uMantissa, nExponent, puResult);
4293}
4294
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004295#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004296
4297
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004298
4299
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004300
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004301static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004302{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004303 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004304
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004305 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004306 const uint8_t *pByte = BigNum.ptr;
4307 size_t uLen = BigNum.len;
4308 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004309 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004310 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004311 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004312 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004313 }
4314
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004315 *pResult = uResult;
4316 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004317}
4318
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004319
Laurence Lundblade887add82020-05-17 05:50:34 -07004320static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004321{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004322 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004323}
4324
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004325
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004326static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004327{
4328 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004329 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4330 if(uError) {
4331 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004332 }
4333 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4334 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004335 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004336}
4337
4338
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004339static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004340{
4341 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004342 /* The negative integer furthest from zero for a C int64_t is
4343 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4344 negative number in CBOR is computed as -n - 1 where n is the
4345 encoded integer, where n is what is in the variable BigNum. When
4346 converting BigNum to a uint64_t, the maximum value is thus
4347 INT64_MAX, so that when it -n - 1 is applied to it the result will
4348 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004349
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004350 -n - 1 <= INT64_MIN.
4351 -n - 1 <= -INT64_MAX - 1
4352 n <= INT64_MAX.
4353 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004354 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004355 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004356 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004357 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004358
4359 /// Now apply -n - 1. The cast is safe because
4360 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4361 // is the largest positive integer that an int64_t can
4362 // represent. */
4363 *pnResult = -(int64_t)uResult - 1;
4364
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004365 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004366}
4367
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004368
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004369
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004370
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004371
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004372/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004373Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004374
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004375\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004376
Laurence Lundblade93d89472020-10-03 22:30:50 -07004377\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4378 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004379
4380\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4381
Laurence Lundblade93d89472020-10-03 22:30:50 -07004382\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4383 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004384*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004385static QCBORError
4386ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004387{
4388 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004389 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004390 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004391#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004392 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004393 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4394 http://www.cplusplus.com/reference/cmath/llround/
4395 */
4396 // Not interested in FE_INEXACT
4397 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004398 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4399 *pnValue = llround(pItem->val.dfnum);
4400 } else {
4401 *pnValue = lroundf(pItem->val.fnum);
4402 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004403 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4404 // llround() shouldn't result in divide by zero, but catch
4405 // it here in case it unexpectedly does. Don't try to
4406 // distinguish between the various exceptions because it seems
4407 // they vary by CPU, compiler and OS.
4408 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004409 }
4410 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004411 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004412 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004413#else
4414 return QCBOR_ERR_HW_FLOAT_DISABLED;
4415#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004416 break;
4417
4418 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004419 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004420 *pnValue = pItem->val.int64;
4421 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004422 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004423 }
4424 break;
4425
4426 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004427 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004428 if(pItem->val.uint64 < INT64_MAX) {
4429 *pnValue = pItem->val.int64;
4430 } else {
4431 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4432 }
4433 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004434 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004435 }
4436 break;
4437
4438 default:
4439 return QCBOR_ERR_UNEXPECTED_TYPE;
4440 }
4441 return QCBOR_SUCCESS;
4442}
4443
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004444
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004445void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004446 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004447 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004448 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004449{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004450 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004451 return;
4452 }
4453
Laurence Lundbladee6430642020-03-14 21:15:44 -07004454 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004455 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4456 if(uError) {
4457 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004458 return;
4459 }
4460
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004461 if(pItem) {
4462 *pItem = Item;
4463 }
4464
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004465 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004466}
4467
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004468
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004469void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4470 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004471 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004472 int64_t *pnValue,
4473 QCBORItem *pItem)
4474{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004475 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004476 if(pMe->uLastError != QCBOR_SUCCESS) {
4477 return;
4478 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004479
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004480 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004481}
4482
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004483
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004484void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4485 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004486 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004487 int64_t *pnValue,
4488 QCBORItem *pItem)
4489{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004490 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004491 if(pMe->uLastError != QCBOR_SUCCESS) {
4492 return;
4493 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004494
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004495 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004496}
4497
4498
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004499/*
4500 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004501
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004502 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004503
Laurence Lundblade93d89472020-10-03 22:30:50 -07004504 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4505 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004506
4507 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4508
Laurence Lundblade93d89472020-10-03 22:30:50 -07004509 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4510 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004511 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004512static QCBORError
4513Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004514{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004515 switch(pItem->uDataType) {
4516
4517 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004518 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004519 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004520 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004521 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004522 }
4523 break;
4524
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004525 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004526 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004527 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004528 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004529 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004530 }
4531 break;
4532
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004533#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004534 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004535 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004536 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004537 pItem->val.expAndMantissa.nExponent,
4538 pnValue,
4539 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004540 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004541 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004542 }
4543 break;
4544
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004545 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004546 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004547 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004548 pItem->val.expAndMantissa.nExponent,
4549 pnValue,
4550 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004551 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004552 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004553 }
4554 break;
4555
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004556 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004557 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004558 int64_t nMantissa;
4559 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004560 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4561 if(uErr) {
4562 return uErr;
4563 }
4564 return ExponentiateNN(nMantissa,
4565 pItem->val.expAndMantissa.nExponent,
4566 pnValue,
4567 Exponentitate10);
4568 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004569 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004570 }
4571 break;
4572
4573 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004574 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004575 int64_t nMantissa;
4576 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004577 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4578 if(uErr) {
4579 return uErr;
4580 }
4581 return ExponentiateNN(nMantissa,
4582 pItem->val.expAndMantissa.nExponent,
4583 pnValue,
4584 Exponentitate10);
4585 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004586 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004587 }
4588 break;
4589
4590 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004591 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004592 int64_t nMantissa;
4593 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004594 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4595 if(uErr) {
4596 return uErr;
4597 }
4598 return ExponentiateNN(nMantissa,
4599 pItem->val.expAndMantissa.nExponent,
4600 pnValue,
4601 Exponentitate2);
4602 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004603 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004604 }
4605 break;
4606
4607 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004608 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004609 int64_t nMantissa;
4610 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004611 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4612 if(uErr) {
4613 return uErr;
4614 }
4615 return ExponentiateNN(nMantissa,
4616 pItem->val.expAndMantissa.nExponent,
4617 pnValue,
4618 Exponentitate2);
4619 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004620 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004621 }
4622 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004623#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004624
Laurence Lundbladee6430642020-03-14 21:15:44 -07004625
Laurence Lundbladec4537442020-04-14 18:53:22 -07004626 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004627 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004628}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004629
4630
Laurence Lundbladec4537442020-04-14 18:53:22 -07004631/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004632 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004633 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004634void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004635{
4636 QCBORItem Item;
4637
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004638 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004639
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004640 if(pMe->uLastError == QCBOR_SUCCESS) {
4641 // The above conversion succeeded
4642 return;
4643 }
4644
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004645 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004646 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004647 return;
4648 }
4649
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004650 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004651}
4652
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004653
4654/*
4655Public function, see header qcbor/qcbor_decode.h file
4656*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004657void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4658 int64_t nLabel,
4659 uint32_t uConvertTypes,
4660 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004661{
4662 QCBORItem Item;
4663
Laurence Lundblade93d89472020-10-03 22:30:50 -07004664 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4665 nLabel,
4666 uConvertTypes,
4667 pnValue,
4668 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004669
4670 if(pMe->uLastError == QCBOR_SUCCESS) {
4671 // The above conversion succeeded
4672 return;
4673 }
4674
4675 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4676 // The above conversion failed in a way that code below can't correct
4677 return;
4678 }
4679
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004680 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004681}
4682
4683
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004684/*
4685Public function, see header qcbor/qcbor_decode.h file
4686*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004687void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4688 const char *szLabel,
4689 uint32_t uConvertTypes,
4690 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004691{
4692 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004693 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4694 szLabel,
4695 uConvertTypes,
4696 pnValue,
4697 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004698
4699 if(pMe->uLastError == QCBOR_SUCCESS) {
4700 // The above conversion succeeded
4701 return;
4702 }
4703
4704 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4705 // The above conversion failed in a way that code below can't correct
4706 return;
4707 }
4708
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004709 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004710}
4711
4712
Laurence Lundblade93d89472020-10-03 22:30:50 -07004713static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004714{
4715 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004716 case QCBOR_TYPE_DOUBLE:
4717 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004718#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004719 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004720 // Can't use llround here because it will not convert values
4721 // greater than INT64_MAX and less than UINT64_MAX that
4722 // need to be converted so it is more complicated.
4723 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4724 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4725 if(isnan(pItem->val.dfnum)) {
4726 return QCBOR_ERR_FLOAT_EXCEPTION;
4727 } else if(pItem->val.dfnum < 0) {
4728 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4729 } else {
4730 double dRounded = round(pItem->val.dfnum);
4731 // See discussion in DecodeDateEpoch() for
4732 // explanation of - 0x7ff
4733 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4734 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4735 }
4736 *puValue = (uint64_t)dRounded;
4737 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004738 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004739 if(isnan(pItem->val.fnum)) {
4740 return QCBOR_ERR_FLOAT_EXCEPTION;
4741 } else if(pItem->val.fnum < 0) {
4742 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4743 } else {
4744 float fRounded = roundf(pItem->val.fnum);
4745 // See discussion in DecodeDateEpoch() for
4746 // explanation of - 0x7ff
4747 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4748 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4749 }
4750 *puValue = (uint64_t)fRounded;
4751 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004752 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004753 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4754 // round() and roundf() shouldn't result in exceptions here, but
4755 // catch them to be robust and thorough. Don't try to
4756 // distinguish between the various exceptions because it seems
4757 // they vary by CPU, compiler and OS.
4758 return QCBOR_ERR_FLOAT_EXCEPTION;
4759 }
4760
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004761 } else {
4762 return QCBOR_ERR_UNEXPECTED_TYPE;
4763 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004764#else
4765 return QCBOR_ERR_HW_FLOAT_DISABLED;
4766#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004767 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004768
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004769 case QCBOR_TYPE_INT64:
4770 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4771 if(pItem->val.int64 >= 0) {
4772 *puValue = (uint64_t)pItem->val.int64;
4773 } else {
4774 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4775 }
4776 } else {
4777 return QCBOR_ERR_UNEXPECTED_TYPE;
4778 }
4779 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004780
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004781 case QCBOR_TYPE_UINT64:
4782 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4783 *puValue = pItem->val.uint64;
4784 } else {
4785 return QCBOR_ERR_UNEXPECTED_TYPE;
4786 }
4787 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004788
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004789 default:
4790 return QCBOR_ERR_UNEXPECTED_TYPE;
4791 }
4792
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004793 return QCBOR_SUCCESS;
4794}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004795
4796
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004797void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004798 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004799 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004800 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004801{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004802 if(pMe->uLastError != QCBOR_SUCCESS) {
4803 return;
4804 }
4805
Laurence Lundbladec4537442020-04-14 18:53:22 -07004806 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004807
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004808 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4809 if(uError) {
4810 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004811 return;
4812 }
4813
Laurence Lundbladea826c502020-05-10 21:07:00 -07004814 if(pItem) {
4815 *pItem = Item;
4816 }
4817
Laurence Lundblade93d89472020-10-03 22:30:50 -07004818 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004819}
4820
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004821
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004822void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004823 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004824 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004825 uint64_t *puValue,
4826 QCBORItem *pItem)
4827{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004828 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004829 if(pMe->uLastError != QCBOR_SUCCESS) {
4830 return;
4831 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004832
Laurence Lundblade93d89472020-10-03 22:30:50 -07004833 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004834}
4835
4836
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004837void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004838 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004839 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004840 uint64_t *puValue,
4841 QCBORItem *pItem)
4842{
4843 if(pMe->uLastError != QCBOR_SUCCESS) {
4844 return;
4845 }
4846
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004847 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004848 if(pMe->uLastError != QCBOR_SUCCESS) {
4849 return;
4850 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004851
Laurence Lundblade93d89472020-10-03 22:30:50 -07004852 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004853}
4854
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004855
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004856
Laurence Lundblade93d89472020-10-03 22:30:50 -07004857static QCBORError
4858UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004859{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004860 switch(pItem->uDataType) {
4861
4862 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004863 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004864 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4865 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004866 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004867 }
4868 break;
4869
4870 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004871 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004872 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4873 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004874 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004875 }
4876 break;
4877
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004878#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004879
4880 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004881 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004882 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004883 pItem->val.expAndMantissa.nExponent,
4884 puValue,
4885 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004886 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004887 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004888 }
4889 break;
4890
4891 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004892 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004893 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4894 pItem->val.expAndMantissa.nExponent,
4895 puValue,
4896 Exponentitate2);
4897 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004898 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004899 }
4900 break;
4901
4902 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004903 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004904 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004905 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004906 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004907 if(uErr != QCBOR_SUCCESS) {
4908 return uErr;
4909 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004910 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004911 pItem->val.expAndMantissa.nExponent,
4912 puValue,
4913 Exponentitate10);
4914 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004915 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004916 }
4917 break;
4918
4919 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004920 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004921 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4922 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004923 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004924 }
4925 break;
4926
4927 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004928 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004929 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004930 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004931 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004932 if(uErr != QCBOR_SUCCESS) {
4933 return uErr;
4934 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004935 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004936 pItem->val.expAndMantissa.nExponent,
4937 puValue,
4938 Exponentitate2);
4939 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004940 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004941 }
4942 break;
4943
4944 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004945 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004946 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4947 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004948 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004949 }
4950 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004951#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004952 default:
4953 return QCBOR_ERR_UNEXPECTED_TYPE;
4954 }
4955}
4956
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004957
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004958/*
4959 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004960 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004961void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004962{
4963 QCBORItem Item;
4964
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004965 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004966
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004967 if(pMe->uLastError == QCBOR_SUCCESS) {
4968 // The above conversion succeeded
4969 return;
4970 }
4971
4972 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4973 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004974 return;
4975 }
4976
Laurence Lundblade93d89472020-10-03 22:30:50 -07004977 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004978}
4979
Laurence Lundbladec4537442020-04-14 18:53:22 -07004980
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004981/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004982 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004983*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004984void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004985 int64_t nLabel,
4986 uint32_t uConvertTypes,
4987 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004988{
4989 QCBORItem Item;
4990
Laurence Lundblade93d89472020-10-03 22:30:50 -07004991 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4992 nLabel,
4993 uConvertTypes,
4994 puValue,
4995 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004996
4997 if(pMe->uLastError == QCBOR_SUCCESS) {
4998 // The above conversion succeeded
4999 return;
5000 }
5001
5002 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5003 // The above conversion failed in a way that code below can't correct
5004 return;
5005 }
5006
Laurence Lundblade93d89472020-10-03 22:30:50 -07005007 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005008}
5009
5010
5011/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005012 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005013*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07005014void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07005015 const char *szLabel,
5016 uint32_t uConvertTypes,
5017 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005018{
5019 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07005020 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
5021 szLabel,
5022 uConvertTypes,
5023 puValue,
5024 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005025
5026 if(pMe->uLastError == QCBOR_SUCCESS) {
5027 // The above conversion succeeded
5028 return;
5029 }
5030
5031 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5032 // The above conversion failed in a way that code below can't correct
5033 return;
5034 }
5035
Laurence Lundblade93d89472020-10-03 22:30:50 -07005036 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005037}
5038
5039
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07005040
5041
Laurence Lundblade9b334962020-08-27 10:55:53 -07005042static QCBORError ConvertDouble(const QCBORItem *pItem,
5043 uint32_t uConvertTypes,
5044 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005045{
5046 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005047 case QCBOR_TYPE_FLOAT:
5048#ifndef QCBOR_DISABLE_FLOAT_HW_USE
5049 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5050 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005051 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005052 *pdValue = (double)pItem->val.fnum;
5053 } else {
5054 return QCBOR_ERR_UNEXPECTED_TYPE;
5055 }
5056 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005057#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005058 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005059#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005060 break;
5061
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005062 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005063 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5064 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005065 *pdValue = pItem->val.dfnum;
5066 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005067 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005068 }
5069 }
5070 break;
5071
5072 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005073#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005074 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005075 // A simple cast seems to do the job with no worry of exceptions.
5076 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005077 *pdValue = (double)pItem->val.int64;
5078
5079 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005080 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005081 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005082#else
5083 return QCBOR_ERR_HW_FLOAT_DISABLED;
5084#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005085 break;
5086
5087 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005088#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005089 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005090 // A simple cast seems to do the job with no worry of exceptions.
5091 // There will be precision loss for some values.
5092 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005093 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005094 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005095 }
5096 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005097#else
5098 return QCBOR_ERR_HW_FLOAT_DISABLED;
5099#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005100
5101 default:
5102 return QCBOR_ERR_UNEXPECTED_TYPE;
5103 }
5104
5105 return QCBOR_SUCCESS;
5106}
5107
5108
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005109void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005110 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005111 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005112 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005113{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005114 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07005115 return;
5116 }
5117
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005118 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005119
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005120 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005121 if(uError) {
5122 pMe->uLastError = (uint8_t)uError;
5123 return;
5124 }
5125
5126 if(pItem) {
5127 *pItem = Item;
5128 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005129
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005130 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005131}
Laurence Lundbladec4537442020-04-14 18:53:22 -07005132
Laurence Lundbladec4537442020-04-14 18:53:22 -07005133
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005134void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
5135 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005136 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005137 double *pdValue,
5138 QCBORItem *pItem)
5139{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005140 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005141 if(pMe->uLastError != QCBOR_SUCCESS) {
5142 return;
5143 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005144
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005145 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005146}
5147
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005148
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005149void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
5150 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005151 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005152 double *pdValue,
5153 QCBORItem *pItem)
5154{
5155 if(pMe->uLastError != QCBOR_SUCCESS) {
5156 return;
5157 }
5158
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005159 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005160 if(pMe->uLastError != QCBOR_SUCCESS) {
5161 return;
5162 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005163
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005164 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005165}
5166
5167
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005168#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005169static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5170{
5171 double dResult;
5172
5173 dResult = 0.0;
5174 const uint8_t *pByte = BigNum.ptr;
5175 size_t uLen = BigNum.len;
5176 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005177 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005178 while(uLen--) {
5179 dResult = (dResult * 256.0) + (double)*pByte++;
5180 }
5181
5182 return dResult;
5183}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005184#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5185
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005186
Laurence Lundblade93d89472020-10-03 22:30:50 -07005187static QCBORError
5188DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005189{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005190#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005191 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005192 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5193
5194 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005195 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005196
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005197#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005198 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005199 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005200 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005201 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5202 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5203 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005204 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005205 }
5206 break;
5207
5208 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005209 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005210 // Underflow gives 0, overflow gives infinity
5211 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5212 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005213 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005214 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005215 }
5216 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005217#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005218
5219 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005220 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005221 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5222 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005223 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005224 }
5225 break;
5226
5227 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005228 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005229 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005230 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005231 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005232 }
5233 break;
5234
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005235#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005236 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005237 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005238 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5239 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5240 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005241 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005242 }
5243 break;
5244
5245 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005246 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005247 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5248 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5249 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005250 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005251 }
5252 break;
5253
5254 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005255 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005256 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5257 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5258 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005259 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005260 }
5261 break;
5262
5263 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005264 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005265 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005266 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5267 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005268 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005269 }
5270 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005271#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005272
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005273 default:
5274 return QCBOR_ERR_UNEXPECTED_TYPE;
5275 }
5276
5277 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005278
5279#else
5280 (void)pItem;
5281 (void)uConvertTypes;
5282 (void)pdValue;
5283 return QCBOR_ERR_HW_FLOAT_DISABLED;
5284#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5285
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005286}
5287
5288
5289/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005290 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005291*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005292void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5293 uint32_t uConvertTypes,
5294 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005295{
5296
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005297 QCBORItem Item;
5298
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005299 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005300
5301 if(pMe->uLastError == QCBOR_SUCCESS) {
5302 // The above conversion succeeded
5303 return;
5304 }
5305
5306 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5307 // The above conversion failed in a way that code below can't correct
5308 return;
5309 }
5310
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005311 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005312}
5313
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005314
5315/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005316 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005317*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005318void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5319 int64_t nLabel,
5320 uint32_t uConvertTypes,
5321 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005322{
5323 QCBORItem Item;
5324
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005325 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005326
5327 if(pMe->uLastError == QCBOR_SUCCESS) {
5328 // The above conversion succeeded
5329 return;
5330 }
5331
5332 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5333 // The above conversion failed in a way that code below can't correct
5334 return;
5335 }
5336
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005337 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005338}
5339
5340
5341/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005342 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005343*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005344void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5345 const char *szLabel,
5346 uint32_t uConvertTypes,
5347 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005348{
5349 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005350 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005351
5352 if(pMe->uLastError == QCBOR_SUCCESS) {
5353 // The above conversion succeeded
5354 return;
5355 }
5356
5357 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5358 // The above conversion failed in a way that code below can't correct
5359 return;
5360 }
5361
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005362 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005363}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005364
5365
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005366
5367
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005368#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005369static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5370{
5371 while((uInt & 0xff00000000000000UL) == 0) {
5372 uInt = uInt << 8;
5373 };
5374
5375 UsefulOutBuf UOB;
5376
5377 UsefulOutBuf_Init(&UOB, Buffer);
5378
5379 while(uInt) {
5380 const uint64_t xx = uInt & 0xff00000000000000UL;
5381 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5382 uInt = uInt << 8;
5383 (void)xx;
5384 }
5385
5386 return UsefulOutBuf_OutUBuf(&UOB);
5387}
5388
5389
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005390static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5391 TagSpecification TagSpec,
5392 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005393{
5394 QCBORError uErr;
5395 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005396 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005397 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005398 if(uErr != QCBOR_SUCCESS) {
5399 goto Done;
5400 }
5401
5402 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5403 break; // Successful exit. Moving on to finish decoding.
5404 }
5405
5406 // The item is an array, which means an undecoded
5407 // mantissa and exponent, so decode it. It will then
5408 // have a different type and exit the loop if.
5409 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5410 if(uErr != QCBOR_SUCCESS) {
5411 goto Done;
5412 }
5413
5414 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005415 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005416 }
5417Done:
5418 return uErr;
5419}
5420
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005421
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005422static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005423 TagSpecification TagSpec,
5424 QCBORItem *pItem,
5425 int64_t *pnMantissa,
5426 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005427{
5428 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005429
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005430 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005431 if(uErr != QCBOR_SUCCESS) {
5432 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005433 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005434
Laurence Lundblade9b334962020-08-27 10:55:53 -07005435 switch (pItem->uDataType) {
5436
5437 case QCBOR_TYPE_DECIMAL_FRACTION:
5438 case QCBOR_TYPE_BIGFLOAT:
5439 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5440 *pnExponent = pItem->val.expAndMantissa.nExponent;
5441 break;
5442
5443 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5444 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5445 *pnExponent = pItem->val.expAndMantissa.nExponent;
5446 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5447 break;
5448
5449 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5450 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5451 *pnExponent = pItem->val.expAndMantissa.nExponent;
5452 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5453 break;
5454
5455 default:
5456 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5457 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005458
5459 Done:
5460 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005461}
5462
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005463
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005464static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005465 TagSpecification TagSpec,
5466 QCBORItem *pItem,
5467 UsefulBuf BufferForMantissa,
5468 UsefulBufC *pMantissa,
5469 bool *pbIsNegative,
5470 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005471{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005472 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005473
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005474 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005475 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005476 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005477 }
5478
5479 uint64_t uMantissa;
5480
5481 switch (pItem->uDataType) {
5482
5483 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005484 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005485 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5486 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5487 *pbIsNegative = false;
5488 } else {
5489 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5490 *pbIsNegative = true;
5491 }
5492 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5493 *pnExponent = pItem->val.expAndMantissa.nExponent;
5494 break;
5495
5496 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005497 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005498 *pnExponent = pItem->val.expAndMantissa.nExponent;
5499 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5500 *pbIsNegative = false;
5501 break;
5502
5503 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005504 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005505 *pnExponent = pItem->val.expAndMantissa.nExponent;
5506 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5507 *pbIsNegative = true;
5508 break;
5509
5510 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005511 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005512 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005513
5514Done:
5515 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005516}
5517
5518
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005519/*
5520 Public function, see header qcbor/qcbor_decode.h file
5521*/
5522void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5523 uint8_t uTagRequirement,
5524 int64_t *pnMantissa,
5525 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005526{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005527 if(pMe->uLastError != QCBOR_SUCCESS) {
5528 return;
5529 }
5530
5531 QCBORItem Item;
5532 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5533 if(uError) {
5534 pMe->uLastError = (uint8_t)uError;
5535 return;
5536 }
5537
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005538 const TagSpecification TagSpec =
5539 {
5540 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005541 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5542 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5543 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005544 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005545
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005546 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005547}
5548
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005549
5550/*
5551 Public function, see header qcbor/qcbor_decode.h file
5552*/
5553void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005554 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005555 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005556 int64_t *pnMantissa,
5557 int64_t *pnExponent)
5558{
5559 if(pMe->uLastError != QCBOR_SUCCESS) {
5560 return;
5561 }
5562
5563 QCBORItem Item;
5564 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5565
5566 const TagSpecification TagSpec =
5567 {
5568 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005569 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5570 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5571 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005572 };
5573
5574 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5575}
5576
5577
5578/*
5579 Public function, see header qcbor/qcbor_decode.h file
5580*/
5581void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005582 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005583 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005584 int64_t *pnMantissa,
5585 int64_t *pnExponent)
5586{
5587 if(pMe->uLastError != QCBOR_SUCCESS) {
5588 return;
5589 }
5590
5591 QCBORItem Item;
5592 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5593
5594 const TagSpecification TagSpec =
5595 {
5596 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005597 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5598 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5599 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005600 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005601
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005602 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5603}
5604
5605
5606/*
5607 Public function, see header qcbor/qcbor_decode.h file
5608*/
5609void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5610 uint8_t uTagRequirement,
5611 UsefulBuf MantissaBuffer,
5612 UsefulBufC *pMantissa,
5613 bool *pbMantissaIsNegative,
5614 int64_t *pnExponent)
5615{
5616 if(pMe->uLastError != QCBOR_SUCCESS) {
5617 return;
5618 }
5619
5620 QCBORItem Item;
5621 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5622 if(uError) {
5623 pMe->uLastError = (uint8_t)uError;
5624 return;
5625 }
5626
5627 const TagSpecification TagSpec =
5628 {
5629 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005630 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5631 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5632 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005633 };
5634
Laurence Lundblade93d89472020-10-03 22:30:50 -07005635 ProcessMantissaAndExponentBig(pMe,
5636 TagSpec,
5637 &Item,
5638 MantissaBuffer,
5639 pMantissa,
5640 pbMantissaIsNegative,
5641 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005642}
5643
5644
5645/*
5646 Public function, see header qcbor/qcbor_decode.h file
5647*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005648void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005649 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005650 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005651 UsefulBuf BufferForMantissa,
5652 UsefulBufC *pMantissa,
5653 bool *pbIsNegative,
5654 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005655{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005656 if(pMe->uLastError != QCBOR_SUCCESS) {
5657 return;
5658 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005659
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005660 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005661 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005662 if(pMe->uLastError != QCBOR_SUCCESS) {
5663 return;
5664 }
5665
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005666 const TagSpecification TagSpec =
5667 {
5668 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005669 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5670 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5671 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005672 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005673
Laurence Lundblade93d89472020-10-03 22:30:50 -07005674 ProcessMantissaAndExponentBig(pMe,
5675 TagSpec,
5676 &Item,
5677 BufferForMantissa,
5678 pMantissa,
5679 pbIsNegative,
5680 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005681}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005682
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005683
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005684/*
5685 Public function, see header qcbor/qcbor_decode.h file
5686*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005687void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005688 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005689 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005690 UsefulBuf BufferForMantissa,
5691 UsefulBufC *pMantissa,
5692 bool *pbIsNegative,
5693 int64_t *pnExponent)
5694{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005695 if(pMe->uLastError != QCBOR_SUCCESS) {
5696 return;
5697 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005698
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005699 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005700 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5701 if(pMe->uLastError != QCBOR_SUCCESS) {
5702 return;
5703 }
5704
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005705 const TagSpecification TagSpec =
5706 {
5707 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005708 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5709 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5710 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005711 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005712
5713 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5714}
5715
5716
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005717/*
5718 Public function, see header qcbor/qcbor_decode.h file
5719*/
5720void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5721 uint8_t uTagRequirement,
5722 int64_t *pnMantissa,
5723 int64_t *pnExponent)
5724{
5725 if(pMe->uLastError != QCBOR_SUCCESS) {
5726 return;
5727 }
5728
5729 QCBORItem Item;
5730 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5731 if(uError) {
5732 pMe->uLastError = (uint8_t)uError;
5733 return;
5734 }
5735 const TagSpecification TagSpec =
5736 {
5737 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005738 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5739 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5740 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005741 };
5742
5743 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5744}
5745
5746
5747/*
5748 Public function, see header qcbor/qcbor_decode.h file
5749*/
5750void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005751 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005752 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005753 int64_t *pnMantissa,
5754 int64_t *pnExponent)
5755{
5756 if(pMe->uLastError != QCBOR_SUCCESS) {
5757 return;
5758 }
5759
5760 QCBORItem Item;
5761 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5762 if(pMe->uLastError != QCBOR_SUCCESS) {
5763 return;
5764 }
5765
5766 const TagSpecification TagSpec =
5767 {
5768 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005769 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5770 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5771 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005772 };
5773
5774 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5775}
5776
5777
5778/*
5779 Public function, see header qcbor/qcbor_decode.h file
5780*/
5781void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005782 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005783 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005784 int64_t *pnMantissa,
5785 int64_t *pnExponent)
5786{
5787 if(pMe->uLastError != QCBOR_SUCCESS) {
5788 return;
5789 }
5790
5791 QCBORItem Item;
5792 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5793 if(pMe->uLastError != QCBOR_SUCCESS) {
5794 return;
5795 }
5796
5797 const TagSpecification TagSpec =
5798 {
5799 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005800 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5801 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5802 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005803 };
5804
5805 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5806}
5807
5808
5809/*
5810 Public function, see header qcbor/qcbor_decode.h file
5811*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005812void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5813 uint8_t uTagRequirement,
5814 UsefulBuf MantissaBuffer,
5815 UsefulBufC *pMantissa,
5816 bool *pbMantissaIsNegative,
5817 int64_t *pnExponent)
5818{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005819 if(pMe->uLastError != QCBOR_SUCCESS) {
5820 return;
5821 }
5822
5823 QCBORItem Item;
5824 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5825 if(uError) {
5826 pMe->uLastError = (uint8_t)uError;
5827 return;
5828 }
5829
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005830 const TagSpecification TagSpec =
5831 {
5832 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005833 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5834 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5835 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005836 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005837
5838 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005839}
5840
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005841
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005842/*
5843 Public function, see header qcbor/qcbor_decode.h file
5844*/
5845void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005846 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005847 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005848 UsefulBuf BufferForMantissa,
5849 UsefulBufC *pMantissa,
5850 bool *pbIsNegative,
5851 int64_t *pnExponent)
5852{
5853 if(pMe->uLastError != QCBOR_SUCCESS) {
5854 return;
5855 }
5856
5857 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005858 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5859 if(pMe->uLastError != QCBOR_SUCCESS) {
5860 return;
5861 }
5862
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005863 const TagSpecification TagSpec =
5864 {
5865 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005866 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5867 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5868 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005869 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005870
Laurence Lundblade93d89472020-10-03 22:30:50 -07005871 ProcessMantissaAndExponentBig(pMe,
5872 TagSpec,
5873 &Item,
5874 BufferForMantissa,
5875 pMantissa,
5876 pbIsNegative,
5877 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005878}
5879
5880
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005881/*
5882 Public function, see header qcbor/qcbor_decode.h file
5883*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005884void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005885 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005886 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005887 UsefulBuf BufferForMantissa,
5888 UsefulBufC *pMantissa,
5889 bool *pbIsNegative,
5890 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005891{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005892 if(pMe->uLastError != QCBOR_SUCCESS) {
5893 return;
5894 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005895
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005896 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005897 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5898 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005899 return;
5900 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005901
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005902 const TagSpecification TagSpec =
5903 {
5904 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005905 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5906 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5907 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005908 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005909
Laurence Lundblade93d89472020-10-03 22:30:50 -07005910 ProcessMantissaAndExponentBig(pMe,
5911 TagSpec,
5912 &Item,
5913 BufferForMantissa,
5914 pMantissa,
5915 pbIsNegative,
5916 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005917}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005918
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005919#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */