blob: 76540c5c800b735100af7a678fb29104a9e928cf [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 Lundbladedd6e76e2021-03-10 01:54:01 -07001990#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001991/**
1992 * @brief Decode decimal fractions and big floats.
1993 *
1994 * @param[in] pMe The decode context.
1995 * @param[in,out] pDecodedItem On input the array data item that
1996 * holds the mantissa and exponent. On
1997 * output the decoded mantissa and
1998 * exponent.
1999 *
2000 * @returns Decoding errors from getting primitive data items or
2001 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2002 *
2003 * When called pDecodedItem must be the array that is tagged as a big
2004 * float or decimal fraction, the array that has the two members, the
2005 * exponent and mantissa.
2006 *
2007 * This will fetch and decode the exponent and mantissa and put the
2008 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002009 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002010static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002011QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002012{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002013 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002014
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002015 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002016 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002017 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002018 goto Done;
2019 }
2020
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002021 /* A check for pDecodedItem->val.uCount == 2 would work for
2022 * definite-length arrays, but not for indefnite. Instead remember
2023 * the nesting level the two integers must be at, which is one
2024 * deeper than that of the array.
2025 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002026 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2027
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002028 /* --- Which is it, decimal fraction or a bigfloat? --- */
2029 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002030 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2031
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002032 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002033 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002034 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2035 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002036 goto Done;
2037 }
2038 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002039 /* Array is empty or a map/array encountered when expecting an int */
2040 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002041 goto Done;
2042 }
2043 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002044 /* Data arriving as an unsigned int < INT64_MAX has been
2045 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2046 * also means that the only data arriving here of type
2047 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2048 * and thus an error that will get handled in the next else.
2049 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002050 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2051 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002052 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2053 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002054 goto Done;
2055 }
2056
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002057 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002058 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002059 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2060 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002061 goto Done;
2062 }
2063 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002064 /* Mantissa missing or map/array encountered when expecting number */
2065 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002066 goto Done;
2067 }
2068 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002069 /* Data arriving as an unsigned int < INT64_MAX has been
2070 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2071 * also means that the only data arriving here of type
2072 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2073 * and thus an error that will get handled in an else below.
2074 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002075 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002076 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2077 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002078 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002079 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002080 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002081 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2082 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2083 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002084 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002085 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2086 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002087 goto Done;
2088 }
2089
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002090 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002091 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002092 /* Extra items in the decimal fraction / big float */
2093 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002094 goto Done;
2095 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002096 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002097
2098Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002099 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002100}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002101#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002102
2103
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002104#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002105/**
2106 * @brief Decode the MIME type tag
2107 *
2108 * @param[in,out] pDecodedItem The item to decode.
2109 *
2110 * Handle the text and binary MIME type tags. Slightly too complicated
2111 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2112 * incorreclty text-only.
2113 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002114static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002115{
2116 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2117 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002118 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002119 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2120 } else {
2121 return QCBOR_ERR_BAD_OPT_TAG;
2122 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002123
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002124 return QCBOR_SUCCESS;
2125}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002126#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002127
2128
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002129/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002130 * Table of CBOR tags whose content is either a text string or a byte
2131 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2132 * of uQCBORtype indicates the content should be a byte string rather
2133 * than a text string
2134 */
2135struct StringTagMapEntry {
2136 uint16_t uTagNumber;
2137 uint8_t uQCBORtype;
2138};
2139
2140#define IS_BYTE_STRING_BIT 0x80
2141#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2142
2143static const struct StringTagMapEntry StringTagMap[] = {
2144 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
2145 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2146 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2147 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2148 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002149#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002150 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2151 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2152 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2153 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002154#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002155 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2156 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2157};
2158
2159
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002160/**
2161 * @brief Process standard CBOR tags whose content is a string
2162 *
2163 * @param[in] uTag The tag.
2164 * @param[in,out] pDecodedItem The data item.
2165 *
2166 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2167 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2168 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2169 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002170 * Process the CBOR tags that whose content is a byte string or a text
2171 * string and for which the string is just passed on to the caller.
2172 *
2173 * This maps the CBOR tag to the QCBOR type and checks the content
2174 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002175 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002176 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002177 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002178static inline QCBORError
2179ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002180{
Laurence Lundblade99615302020-11-29 11:19:47 -08002181 /* This only works on tags that were not mapped; no need for other yet */
2182 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2183 return QCBOR_ERR_UNSUPPORTED;
2184 }
2185
2186 unsigned uIndex;
2187 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2188 if(StringTagMap[uIndex].uTagNumber == uTag) {
2189 break;
2190 }
2191 }
2192
2193 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2194 if(uQCBORType == QCBOR_TYPE_NONE) {
2195 /* repurpose this error to mean, not handled here */
2196 return QCBOR_ERR_UNSUPPORTED;
2197 }
2198
2199 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2200 if(uQCBORType & IS_BYTE_STRING_BIT) {
2201 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2202 }
2203
2204 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002205 return QCBOR_ERR_BAD_OPT_TAG;
2206 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002207
Laurence Lundblade99615302020-11-29 11:19:47 -08002208 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002209 return QCBOR_SUCCESS;
2210}
2211
2212
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002213/**
2214 * @brief Decode tag content for select tags (decoding layer 1).
2215 *
2216 * @param[in] pMe The decode context.
2217 * @param[out] pDecodedItem The decoded item.
2218 *
2219 * @return Decoding error code.
2220 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002221 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2222 * but the whole tag was not decoded. Here, the whole tags (tag number
2223 * and tag content) that are supported by QCBOR are decoded. This is a
2224 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002225 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002226static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002227QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002228{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002229 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002230
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002231 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002232 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002233 goto Done;
2234 }
2235
Laurence Lundblade99615302020-11-29 11:19:47 -08002236 /* When there are no tag numbers for the item, this exits first
2237 * thing and effectively does nothing.
2238 *
2239 * This loops over all the tag numbers accumulated for this item
2240 * trying to decode and interpret them. This stops at the end of
2241 * the list or at the first tag number that can't be interpreted by
2242 * this code. This is effectively a recursive processing of the
2243 * tags number list that handles nested tags.
2244 */
2245 while(1) {
2246 /* Don't bother to unmap tags via QCBORITem.uTags since this
2247 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2248 */
2249 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002250
Laurence Lundblade99615302020-11-29 11:19:47 -08002251 if(uTagToProcess == CBOR_TAG_INVALID16) {
2252 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002253 break;
2254
Laurence Lundblade99615302020-11-29 11:19:47 -08002255 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002256 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002257
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002258#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002259 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2260 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002261 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002262#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002263#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002264 } else if(uTagToProcess == CBOR_TAG_MIME ||
2265 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002266 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002267#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002268
Laurence Lundblade99615302020-11-29 11:19:47 -08002269 } else {
2270 /* See if it is a pass-through byte/text string tag; process if so */
2271 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002272
Laurence Lundblade99615302020-11-29 11:19:47 -08002273 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2274 /* It wasn't a pass-through byte/text string tag so it is
2275 * an unknown tag. This is the exit from the loop on the
2276 * first unknown tag. It is a successful exit.
2277 */
2278 uReturn = QCBOR_SUCCESS;
2279 break;
2280 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002281 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002282
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002283 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002284 /* Error exit from the loop */
2285 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002286 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002287
2288 /* A tag was successfully processed, shift it out of the list of
2289 * tags returned. This is the loop increment.
2290 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002291 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002292 }
2293
2294Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002295 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002296}
2297
2298
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002299/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002300 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002301 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002302QCBORError
2303QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2304{
2305 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002306 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002307 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002308 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2309 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2310 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002311 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002312}
2313
2314
2315/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002316 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002317 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002318QCBORError
2319QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2320{
2321 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2322 const UsefulInputBuf Save = pMe->InBuf;
2323
2324 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2325
2326 pMe->nesting = SaveNesting;
2327 pMe->InBuf = Save;
2328
2329 return uErr;
2330}
2331
2332
2333/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002334 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002335 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002336void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2337{
2338 if(pMe->uLastError != QCBOR_SUCCESS) {
2339 return;
2340 }
2341
2342 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2343}
2344
2345
2346/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002348 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002349QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002350QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2351 QCBORItem *pDecodedItem,
2352 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002353{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002354 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002355
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002356 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2357 if(uReturn != QCBOR_SUCCESS) {
2358 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002359 }
2360
2361 if(pTags != NULL) {
2362 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002363 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002364 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2365 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002366 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002367 }
2368 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2369 return QCBOR_ERR_TOO_MANY_TAGS;
2370 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002371 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002372 pTags->uNumUsed++;
2373 }
2374 }
2375
2376 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002377}
2378
2379
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002380/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002381 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302382 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002383bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002384 const QCBORItem *pItem,
2385 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002386{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002387 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2388 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002389 break;
2390 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002391 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002392 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002393 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002394 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002395
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002396 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002397}
2398
2399
2400/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002401 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002402 */
Laurence Lundblade87495732021-02-26 10:05:55 -07002403QCBORError QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002404{
Laurence Lundblade87495732021-02-26 10:05:55 -07002405 if(puConsumed != NULL) {
2406 *puConsumed = pMe->InBuf.cursor;
2407 }
2408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002409 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002410
2411 if(uReturn != QCBOR_SUCCESS) {
2412 goto Done;
2413 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002414
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002415 /* Error out if all the maps/arrays are not closed out */
2416 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002417 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002418 goto Done;
2419 }
2420
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002421 /* Error out if not all the bytes are consumed */
2422 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002423 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002424 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002425
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002426Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002427 return uReturn;
2428}
2429
2430
2431/*
2432 * Public function, see header qcbor/qcbor_decode.h file
2433 */
2434QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
2435{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002436#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002437 /* Call the destructor for the string allocator if there is one.
2438 * Always called, even if there are errors; always have to clean up.
2439 */
2440 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002441#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002442
Laurence Lundblade87495732021-02-26 10:05:55 -07002443 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002444}
2445
2446
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002447/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002448 * Public function, see header qcbor/qcbor_decode.h file
2449 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002450// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002451uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2452 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002453 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002454{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002455 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2456 return CBOR_TAG_INVALID64;
2457 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002458 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2459 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002460 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002461 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002462 }
2463}
2464
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002465
Laurence Lundblade9b334962020-08-27 10:55:53 -07002466/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002467 * Public function, see header qcbor/qcbor_decode.h file
2468 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002469uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2470 uint32_t uIndex)
2471{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002472 if(pMe->uLastError != QCBOR_SUCCESS) {
2473 return CBOR_TAG_INVALID64;
2474 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002475 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2476 return CBOR_TAG_INVALID64;
2477 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002478 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002479 }
2480}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002481
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002482
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002483
2484
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002485#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002486
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002487/* ===========================================================================
2488 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002489
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002490 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002491 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2492 implements the function type QCBORStringAllocate and allows easy
2493 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002494
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002495 This particular allocator is built-in for convenience. The caller
2496 can implement their own. All of this following code will get
2497 dead-stripped if QCBORDecode_SetMemPool() is not called.
2498
2499 This is a very primitive memory allocator. It does not track
2500 individual allocations, only a high-water mark. A free or
2501 reallocation must be of the last chunk allocated.
2502
2503 The size of the pool and offset to free memory are packed into the
2504 first 8 bytes of the memory pool so we don't have to keep them in
2505 the decode context. Since the address of the pool may not be
2506 aligned, they have to be packed and unpacked as if they were
2507 serialized data of the wire or such.
2508
2509 The sizes packed in are uint32_t to be the same on all CPU types
2510 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002511 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002512
2513
Laurence Lundbladeee851742020-01-08 08:37:05 -08002514static inline int
2515MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002516{
2517 // Use of UsefulInputBuf is overkill, but it is convenient.
2518 UsefulInputBuf UIB;
2519
Laurence Lundbladeee851742020-01-08 08:37:05 -08002520 // Just assume the size here. It was checked during SetUp so
2521 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002522 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002523 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2524 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2525 return UsefulInputBuf_GetError(&UIB);
2526}
2527
2528
Laurence Lundbladeee851742020-01-08 08:37:05 -08002529static inline int
2530MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002531{
2532 // Use of UsefulOutBuf is overkill, but convenient. The
2533 // length check performed here is useful.
2534 UsefulOutBuf UOB;
2535
2536 UsefulOutBuf_Init(&UOB, Pool);
2537 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2538 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2539 return UsefulOutBuf_GetError(&UOB);
2540}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002541
2542
2543/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002544 Internal function for an allocation, reallocation free and destuct.
2545
2546 Having only one function rather than one each per mode saves space in
2547 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002548
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002549 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2550 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002551static UsefulBuf
2552MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002553{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002554 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002555
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002556 uint32_t uPoolSize;
2557 uint32_t uFreeOffset;
2558
2559 if(uNewSize > UINT32_MAX) {
2560 // This allocator is only good up to 4GB. This check should
2561 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2562 goto Done;
2563 }
2564 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2565
2566 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2567 goto Done;
2568 }
2569
2570 if(uNewSize) {
2571 if(pMem) {
2572 // REALLOCATION MODE
2573 // Calculate pointer to the end of the memory pool. It is
2574 // assumed that pPool + uPoolSize won't wrap around by
2575 // assuming the caller won't pass a pool buffer in that is
2576 // not in legitimate memory space.
2577 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2578
2579 // Check that the pointer for reallocation is in the range of the
2580 // pool. This also makes sure that pointer math further down
2581 // doesn't wrap under or over.
2582 if(pMem >= pPool && pMem < pPoolEnd) {
2583 // Offset to start of chunk for reallocation. This won't
2584 // wrap under because of check that pMem >= pPool. Cast
2585 // is safe because the pool is always less than UINT32_MAX
2586 // because of check in QCBORDecode_SetMemPool().
2587 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2588
2589 // Check to see if the allocation will fit. uPoolSize -
2590 // uMemOffset will not wrap under because of check that
2591 // pMem is in the range of the uPoolSize by check above.
2592 if(uNewSize <= uPoolSize - uMemOffset) {
2593 ReturnValue.ptr = pMem;
2594 ReturnValue.len = uNewSize;
2595
2596 // Addition won't wrap around over because uNewSize was
2597 // checked to be sure it is less than the pool size.
2598 uFreeOffset = uMemOffset + uNewSize32;
2599 }
2600 }
2601 } else {
2602 // ALLOCATION MODE
2603 // uPoolSize - uFreeOffset will not underflow because this
2604 // pool implementation makes sure uFreeOffset is always
2605 // smaller than uPoolSize through this check here and
2606 // reallocation case.
2607 if(uNewSize <= uPoolSize - uFreeOffset) {
2608 ReturnValue.len = uNewSize;
2609 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002610 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002611 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002612 }
2613 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002614 if(pMem) {
2615 // FREE MODE
2616 // Cast is safe because of limit on pool size in
2617 // QCBORDecode_SetMemPool()
2618 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2619 } else {
2620 // DESTRUCT MODE
2621 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002622 }
2623 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002624
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002625 UsefulBuf Pool = {pPool, uPoolSize};
2626 MemPool_Pack(Pool, uFreeOffset);
2627
2628Done:
2629 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002630}
2631
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002632
Laurence Lundbladef6531662018-12-04 10:42:22 +09002633/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002634 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002635 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002636QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2637 UsefulBuf Pool,
2638 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002639{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002640 // The pool size and free mem offset are packed into the beginning
2641 // of the pool memory. This compile time check make sure the
2642 // constant in the header is correct. This check should optimize
2643 // down to nothing.
2644 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002645 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002646 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002647
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002648 // The pool size and free offset packed in to the beginning of pool
2649 // memory are only 32-bits. This check will optimize out on 32-bit
2650 // machines.
2651 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002652 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002653 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002654
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002655 // This checks that the pool buffer given is big enough.
2656 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002657 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002658 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002659
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002660 pMe->StringAllocator.pfAllocator = MemPool_Function;
2661 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2662 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002663
Laurence Lundblade30816f22018-11-10 13:40:22 +07002664 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002665}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002666#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002667
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002668
2669
Laurence Lundblade9b334962020-08-27 10:55:53 -07002670static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2671{
2672 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2673}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002674
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002675
2676/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002677 Consume an entire map or array (and do next to
2678 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002679 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002680static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002681ConsumeItem(QCBORDecodeContext *pMe,
2682 const QCBORItem *pItemToConsume,
2683 uint_fast8_t *puNextNestLevel)
2684{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002685 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002686 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002687
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002688 // If it is a map or array, this will tell if it is empty.
2689 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2690
2691 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2692 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002693
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002694 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002695 * maps and arrays by using the nesting level
2696 */
2697 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002698 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002699 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002700 goto Done;
2701 }
2702 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002703
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002704 *puNextNestLevel = Item.uNextNestLevel;
2705
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002706 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002707
Laurence Lundblade1341c592020-04-11 14:19:05 -07002708 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002709 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002710 /* Just pass the nesting level through */
2711 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2712
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002713 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002714 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002715
2716Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002717 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002718}
2719
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002720
2721void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2722{
2723 uint8_t uNextNestLevel;
2724
2725 QCBORDecode_VGetNext(pMe, pDecodedItem);
2726
2727 if(pMe->uLastError == QCBOR_SUCCESS) {
2728 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem, &uNextNestLevel);
2729 pDecodedItem->uNextNestLevel = uNextNestLevel;
2730 }
2731}
2732
2733
2734
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002735/* Call only on maps and arrays. Rewinds the cursor
2736 * to the start as if it was just entered.
2737 */
2738static void RewindMapOrArray(QCBORDecodeContext *pMe)
2739{
2740 /* Reset nesting tracking to the deepest bounded level */
2741 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2742
2743 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2744
2745 /* Reposition traversal cursor to the start of the map/array */
2746 UsefulInputBuf_Seek(&(pMe->InBuf),
2747 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2748}
2749
2750
2751/*
2752 Public function, see header qcbor/qcbor_decode.h file
2753 */
2754void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2755{
2756 if(pMe->nesting.pCurrentBounded != NULL) {
2757 /* In a bounded map, array or bstr-wrapped CBOR */
2758
2759 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2760 /* In bstr-wrapped CBOR. */
2761
2762 /* Reposition traversal cursor to start of wrapping byte string */
2763 UsefulInputBuf_Seek(&(pMe->InBuf),
2764 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2765 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2766
2767 } else {
2768 /* In a map or array */
2769 RewindMapOrArray(pMe);
2770 }
2771
2772 } else {
2773 /* Not in anything bounded */
2774
2775 /* Reposition traversal cursor to the start of input CBOR */
2776 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2777
2778 /* Reset nesting tracking to beginning of input. */
2779 DecodeNesting_Init(&(pMe->nesting));
2780 }
2781
2782 pMe->uLastError = QCBOR_SUCCESS;
2783}
2784
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002785
Laurence Lundblade1341c592020-04-11 14:19:05 -07002786/* Return true if the labels in Item1 and Item2 are the same.
2787 Works only for integer and string labels. Returns false
2788 for any other type. */
2789static inline bool
2790MatchLabel(QCBORItem Item1, QCBORItem Item2)
2791{
2792 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2793 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2794 return true;
2795 }
2796 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002797 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002798 return true;
2799 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002800 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002801 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2802 return true;
2803 }
2804 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2805 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2806 return true;
2807 }
2808 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002809
Laurence Lundblade1341c592020-04-11 14:19:05 -07002810 /* Other label types are never matched */
2811 return false;
2812}
2813
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002814
2815/*
2816 Returns true if Item1 and Item2 are the same type
2817 or if either are of QCBOR_TYPE_ANY.
2818 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002819static inline bool
2820MatchType(QCBORItem Item1, QCBORItem Item2)
2821{
2822 if(Item1.uDataType == Item2.uDataType) {
2823 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002824 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002825 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002826 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002827 return true;
2828 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002829 return false;
2830}
2831
2832
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002833/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002834 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002835
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002836 @param[in] pMe The decode context to search.
2837 @param[in,out] pItemArray The items to search for and the items found.
2838 @param[out] puOffset Byte offset of last item matched.
2839 @param[in] pCBContext Context for the not-found item call back.
2840 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002841
2842 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2843
Laurence Lundblade93d89472020-10-03 22:30:50 -07002844 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2845 were found for one of the labels being
2846 search for. This duplicate detection is
2847 only performed for items in pItemArray,
2848 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002849
Laurence Lundblade93d89472020-10-03 22:30:50 -07002850 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2851 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002852
2853 @retval Also errors returned by QCBORDecode_GetNext().
2854
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002855 On input pItemArray contains a list of labels and data types
2856 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002857
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002858 On output the fully retrieved items are filled in with
2859 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002860
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002861 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002862
2863 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002864 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002865static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002866MapSearch(QCBORDecodeContext *pMe,
2867 QCBORItem *pItemArray,
2868 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002869 void *pCBContext,
2870 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002871{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002872 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002873 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002874
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002875 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002876 uReturn = pMe->uLastError;
2877 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002878 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002879
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002880 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002881 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2882 /* QCBOR_TYPE_NONE as first item indicates just looking
2883 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002884 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2885 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002886 }
2887
Laurence Lundblade085d7952020-07-24 10:26:30 -07002888 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2889 // It is an empty bounded array or map
2890 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2891 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002892 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002893 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002894 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002895 // Nothing is ever found in an empty array or map. All items
2896 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002897 uReturn = QCBOR_SUCCESS;
2898 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002899 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002900 }
2901
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002902 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002903 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2904
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002905 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002906 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002907
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002908 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002909 Loop over all the items in the map or array. Each item
2910 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002911 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002912 length maps and arrays. The only reason this is ever
2913 called on arrays is to find their end position.
2914
2915 This will always run over all items in order to do
2916 duplicate detection.
2917
2918 This will exit with failure if it encounters an
2919 unrecoverable error, but continue on for recoverable
2920 errors.
2921
2922 If a recoverable error occurs on a matched item, then
2923 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002924 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002925 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002926 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002927 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002928 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002929 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002930
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002931 /* Get the item */
2932 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002933 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002934 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002935 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002936 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002937 goto Done;
2938 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002939 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002940 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002941 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002942 goto Done;
2943 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002944
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002945 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002946 bool bMatched = false;
2947 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2948 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002949 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002950 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2951 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002952 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002953 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002954 /* Also try to match its type */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002955 if(!MatchType(Item, pItemArray[nIndex])) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002956 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002957 goto Done;
2958 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002959
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002960 if(uResult != QCBOR_SUCCESS) {
2961 uReturn = uResult;
2962 goto Done;
2963 }
2964
Laurence Lundblade1341c592020-04-11 14:19:05 -07002965 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002966 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002967 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002968 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002969 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002970 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002971 bMatched = true;
2972 }
2973 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002974
2975
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002976 if(!bMatched && pfCallback != NULL) {
2977 /*
2978 Call the callback on unmatched labels.
2979 (It is tempting to do duplicate detection here, but that would
2980 require dynamic memory allocation because the number of labels
2981 that might be encountered is unbounded.)
2982 */
2983 uReturn = (*pfCallback)(pCBContext, &Item);
2984 if(uReturn != QCBOR_SUCCESS) {
2985 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002986 }
2987 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002988
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002989 /*
2990 Consume the item whether matched or not. This
2991 does the work of traversing maps and array and
2992 everything in them. In this loop only the
2993 items at the current nesting level are examined
2994 to match the labels.
2995 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002996 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07002997 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002998 goto Done;
2999 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003000
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003001 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003002
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003003 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003004
3005 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003006
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003007 // Check here makes sure that this won't accidentally be
3008 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003009 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003010 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3011 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003012 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3013 goto Done;
3014 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003015 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3016 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003017
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003018 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003019 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
3020
3021 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003022 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003023 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003024 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003025 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3026 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003027 }
3028 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003029
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003030 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003031}
3032
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003033
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003034/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003035 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003036*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003037void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3038 int64_t nLabel,
3039 uint8_t uQcborType,
3040 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003041{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003042 if(pMe->uLastError != QCBOR_SUCCESS) {
3043 return;
3044 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003045
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003046 QCBORItem OneItemSeach[2];
3047 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3048 OneItemSeach[0].label.int64 = nLabel;
3049 OneItemSeach[0].uDataType = uQcborType;
3050 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003051
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003052 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003053
3054 *pItem = OneItemSeach[0];
3055
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003056 if(uReturn != QCBOR_SUCCESS) {
3057 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003058 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003059 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003060 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003061 }
3062
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003063 Done:
3064 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003065}
3066
3067
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003068/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003069 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003070*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003071void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3072 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003073 uint8_t uQcborType,
3074 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003075{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003076 if(pMe->uLastError != QCBOR_SUCCESS) {
3077 return;
3078 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003079
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003080 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003081 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3082 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3083 OneItemSeach[0].uDataType = uQcborType;
3084 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003085
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003086 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3087 if(uReturn != QCBOR_SUCCESS) {
3088 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003089 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003090 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003091 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003092 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003093 }
3094
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003095 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003096
3097Done:
3098 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003099}
3100
3101
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003102
Laurence Lundblade93d89472020-10-03 22:30:50 -07003103static QCBORError
3104CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003105{
3106 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3107 if(uDataType == puTypeList[i]) {
3108 return QCBOR_SUCCESS;
3109 }
3110 }
3111 return QCBOR_ERR_UNEXPECTED_TYPE;
3112}
3113
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003114
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003115/**
3116 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003117 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003118
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003119 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3120 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003121
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003122 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3123 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003124 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003125static QCBORError
3126CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003127{
3128 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3129 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3130 /* There are tags that QCBOR couldn't process on this item and
3131 the caller has told us there should not be. */
3132 return QCBOR_ERR_UNEXPECTED_TYPE;
3133 }
3134
3135 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3136 const int nItemType = pItem->uDataType;
3137
3138 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3139 // Must match the tag and only the tag
3140 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3141 }
3142
3143 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3144 if(uReturn == QCBOR_SUCCESS) {
3145 return QCBOR_SUCCESS;
3146 }
3147
3148 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3149 /* Must match the content type and only the content type.
3150 There was no match just above so it is a fail. */
3151 return QCBOR_ERR_UNEXPECTED_TYPE;
3152 }
3153
3154 /* If here it can match either the tag or the content
3155 and it hasn't matched the content, so the end
3156 result is whether it matches the tag. This is
3157 also the case that the CBOR standard discourages. */
3158
3159 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3160}
3161
Laurence Lundblade9b334962020-08-27 10:55:53 -07003162
Laurence Lundblade9b334962020-08-27 10:55:53 -07003163
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003164// This could be semi-private if need be
3165static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003166void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3167 int64_t nLabel,
3168 TagSpecification TagSpec,
3169 QCBORItem *pItem)
3170{
3171 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3172 if(pMe->uLastError != QCBOR_SUCCESS) {
3173 return;
3174 }
3175
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003176 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003177}
3178
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003179
3180// This could be semi-private if need be
3181static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003182void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3183 const char *szLabel,
3184 TagSpecification TagSpec,
3185 QCBORItem *pItem)
3186{
3187 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3188 if(pMe->uLastError != QCBOR_SUCCESS) {
3189 return;
3190 }
3191
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003192 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003193}
3194
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003195// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003196void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3197 int64_t nLabel,
3198 TagSpecification TagSpec,
3199 UsefulBufC *pString)
3200{
3201 QCBORItem Item;
3202 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3203 if(pMe->uLastError == QCBOR_SUCCESS) {
3204 *pString = Item.val.string;
3205 }
3206}
3207
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003208// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003209void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3210 const char * szLabel,
3211 TagSpecification TagSpec,
3212 UsefulBufC *pString)
3213{
3214 QCBORItem Item;
3215 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3216 if(pMe->uLastError == QCBOR_SUCCESS) {
3217 *pString = Item.val.string;
3218 }
3219}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003220
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003221/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003222 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003223*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003224void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003225{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003226 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3227 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003228}
3229
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003230/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003231 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003232*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003233void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3234 QCBORItem *pItemList,
3235 void *pCallbackCtx,
3236 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003237{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003238 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3239 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003240}
3241
3242
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003243/**
3244 * @brief Search for a map/array by label and enter it
3245 *
3246 * @param[in] pMe The decode context.
3247 * @param[in] pSearch The map/array to search for.
3248 *
3249 * @c pSearch is expected to contain one item of type map or array
3250 * with the label specified. The current bounded map will be searched for
3251 * this and if found will be entered.
3252 *
3253 * If the label is not found, or the item found is not a map or array,
3254 * the error state is set.
3255 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003256static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003257{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003258 // The first item in pSearch is the one that is to be
3259 // entered. It should be the only one filled in. Any other
3260 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003261 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003262 return;
3263 }
3264
3265 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003266 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003267 if(pMe->uLastError != QCBOR_SUCCESS) {
3268 return;
3269 }
3270
Laurence Lundblade9b334962020-08-27 10:55:53 -07003271 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003272 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003273 return;
3274 }
3275
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003276
3277 /* The map or array was found. Now enter it.
3278 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003279 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3280 * next item for the pre-order traversal cursor to be the map/array
3281 * found by MapSearch(). The next few lines of code force the
3282 * cursor to that.
3283 *
3284 * There is no need to retain the old cursor because
3285 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3286 * beginning of the map/array being entered.
3287 *
3288 * The cursor is forced by: 1) setting the input buffer position to
3289 * the item offset found by MapSearch(), 2) setting the map/array
3290 * counter to the total in the map/array, 3) setting the nesting
3291 * level. Setting the map/array counter to the total is not
3292 * strictly correct, but this is OK because this cursor only needs
3293 * to be used to get one item and MapSearch() has already found it
3294 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003295 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003296 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003297
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003298 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3299
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003300 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003301
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003302 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003303}
3304
3305
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003306/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003307 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003308*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003309void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003310{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003311 QCBORItem OneItemSeach[2];
3312 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3313 OneItemSeach[0].label.int64 = nLabel;
3314 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3315 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003316
Laurence Lundblade9b334962020-08-27 10:55:53 -07003317 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003318 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003319}
3320
3321
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003322/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003323 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003324*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003325void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003326{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003327 QCBORItem OneItemSeach[2];
3328 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3329 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3330 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3331 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003332
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003333 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003334}
3335
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003336/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003337 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003338*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003339void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003340{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003341 QCBORItem OneItemSeach[2];
3342 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3343 OneItemSeach[0].label.int64 = nLabel;
3344 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3345 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003346
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003347 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003348}
3349
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003350/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003351 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003352*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003353void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3354{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003355 QCBORItem OneItemSeach[2];
3356 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3357 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3358 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3359 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003360
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003361 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003362}
3363
3364
Laurence Lundblade02625d42020-06-25 14:41:41 -07003365// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003366void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003367{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003368 QCBORError uErr;
3369
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003370 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003371 if(pMe->uLastError != QCBOR_SUCCESS) {
3372 // Already in error state; do nothing.
3373 return;
3374 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003375
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003376 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003377 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003378 uErr = QCBORDecode_GetNext(pMe, &Item);
3379 if(uErr != QCBOR_SUCCESS) {
3380 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003381 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003382 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003383 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3384 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003385 }
3386
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003387 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003388
3389
Laurence Lundbladef0499502020-08-01 11:55:57 -07003390 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003391 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003392 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3393 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003394 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003395 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3396 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003397 // Special case to increment nesting level for zero-length maps
3398 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003399 DecodeNesting_Descend(&(pMe->nesting), uType);
3400 }
3401
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003402 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003403
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003404 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3405 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003406
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003407 if(pItem != NULL) {
3408 *pItem = Item;
3409 }
3410
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003411Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003412 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003413}
3414
Laurence Lundblade02625d42020-06-25 14:41:41 -07003415
3416/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003417 This is the common work for exiting a level that is a bounded map,
3418 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003419
3420 One chunk of work is to set up the pre-order traversal so it is at
3421 the item just after the bounded map, array or bstr that is being
3422 exited. This is somewhat complex.
3423
3424 The other work is to level-up the bounded mode to next higest bounded
3425 mode or the top level if there isn't one.
3426 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003427static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003428ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003429{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003430 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003431
Laurence Lundblade02625d42020-06-25 14:41:41 -07003432 /*
3433 First the pre-order-traversal byte offset is positioned to the
3434 item just after the bounded mode item that was just consumed.
3435 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003436 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3437
Laurence Lundblade02625d42020-06-25 14:41:41 -07003438 /*
3439 Next, set the current nesting level to one above the bounded level
3440 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003441
Laurence Lundblade02625d42020-06-25 14:41:41 -07003442 DecodeNesting_CheckBoundedType() is always called before this and
3443 makes sure pCurrentBounded is valid.
3444 */
3445 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3446
3447 /*
3448 This does the complex work of leveling up the pre-order traversal
3449 when the end of a map or array or another bounded level is
3450 reached. It may do nothing, or ascend all the way to the top
3451 level.
3452 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003453 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003454 if(uErr != QCBOR_SUCCESS) {
3455 goto Done;
3456 }
3457
Laurence Lundblade02625d42020-06-25 14:41:41 -07003458 /*
3459 This makes the next highest bounded level the current bounded
3460 level. If there is no next highest level, then no bounded mode is
3461 in effect.
3462 */
3463 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003464
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003465 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003466
3467Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003468 return uErr;
3469}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003470
Laurence Lundblade02625d42020-06-25 14:41:41 -07003471
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003472// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003473void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003474{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003475 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003476 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003477 return;
3478 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003479
Laurence Lundblade02625d42020-06-25 14:41:41 -07003480 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003481
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003482 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003483 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003484 goto Done;
3485 }
3486
Laurence Lundblade02625d42020-06-25 14:41:41 -07003487 /*
3488 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003489 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003490 from previous map search, then do a dummy search.
3491 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003492 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003493 QCBORItem Dummy;
3494 Dummy.uLabelType = QCBOR_TYPE_NONE;
3495 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3496 if(uErr != QCBOR_SUCCESS) {
3497 goto Done;
3498 }
3499 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003500
Laurence Lundblade02625d42020-06-25 14:41:41 -07003501 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003502
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003503Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003504 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003505}
3506
3507
Laurence Lundblade1341c592020-04-11 14:19:05 -07003508
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003509static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003510 const QCBORItem *pItem,
3511 uint8_t uTagRequirement,
3512 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003513{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003514 if(pBstr) {
3515 *pBstr = NULLUsefulBufC;
3516 }
3517
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003518 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003519 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003520 return pMe->uLastError;
3521 }
3522
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003523 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003524
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003525 const TagSpecification TagSpec =
3526 {
3527 uTagRequirement,
3528 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3529 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3530 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003531
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003532 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003533 if(uError != QCBOR_SUCCESS) {
3534 goto Done;
3535 }
3536
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003537 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003538 /* Reverse the decrement done by GetNext() for the bstr so the
3539 * increment in QCBORDecode_NestLevelAscender() called by
3540 * ExitBoundedLevel() will work right.
3541 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003542 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003543 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003544
3545 if(pBstr) {
3546 *pBstr = pItem->val.string;
3547 }
3548
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003549 /* This saves the current length of the UsefulInputBuf and then
3550 * narrows the UsefulInputBuf to start and length of the wrapped
3551 * CBOR that is being entered.
3552 *
3553 * Most of these calls are simple inline accessors so this doesn't
3554 * amount to much code.
3555 */
3556
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003557 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003558 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3559 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003560 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003561 goto Done;
3562 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003563
3564 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3565 pItem->val.string.ptr);
3566 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3567 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3568 /* This should never happen because pItem->val.string.ptr should
3569 * always be valid since it was just returned.
3570 */
3571 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3572 goto Done;
3573 }
3574
3575 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3576
3577 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003578 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003579
Laurence Lundblade02625d42020-06-25 14:41:41 -07003580 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003581 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003582 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003583Done:
3584 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003585}
3586
3587
Laurence Lundblade02625d42020-06-25 14:41:41 -07003588/*
3589 Public function, see header qcbor/qcbor_decode.h file
3590 */
3591void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003592 uint8_t uTagRequirement,
3593 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003594{
3595 if(pMe->uLastError != QCBOR_SUCCESS) {
3596 // Already in error state; do nothing.
3597 return;
3598 }
3599
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003600 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003601 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003602 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3603 if(pMe->uLastError != QCBOR_SUCCESS) {
3604 return;
3605 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003606
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003607 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003608 &Item,
3609 uTagRequirement,
3610 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003611}
3612
3613
Laurence Lundblade02625d42020-06-25 14:41:41 -07003614/*
3615 Public function, see header qcbor/qcbor_decode.h file
3616 */
3617void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003618 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003619 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003620 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003621{
3622 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003623 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003624
Laurence Lundblade93d89472020-10-03 22:30:50 -07003625 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3626 &Item,
3627 uTagRequirement,
3628 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003629}
3630
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003631
Laurence Lundblade02625d42020-06-25 14:41:41 -07003632/*
3633 Public function, see header qcbor/qcbor_decode.h file
3634 */
3635void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003636 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003637 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003638 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003639{
3640 QCBORItem Item;
3641 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3642
Laurence Lundblade93d89472020-10-03 22:30:50 -07003643 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3644 &Item,
3645 uTagRequirement,
3646 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003647}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003648
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003649
Laurence Lundblade02625d42020-06-25 14:41:41 -07003650/*
3651 Public function, see header qcbor/qcbor_decode.h file
3652 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003653void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003654{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003655 if(pMe->uLastError != QCBOR_SUCCESS) {
3656 // Already in error state; do nothing.
3657 return;
3658 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003659
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003660 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003661 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003662 return;
3663 }
3664
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003665 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3666
Laurence Lundblade02625d42020-06-25 14:41:41 -07003667 /*
3668 Reset the length of the UsefulInputBuf to what it was before
3669 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003670 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003671 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003672 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003673
3674
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003675 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003676 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003677}
3678
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003679
Laurence Lundbladee6430642020-03-14 21:15:44 -07003680
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003681
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003682
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003683
Laurence Lundblade11a064e2020-05-07 13:13:42 -07003684
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003685
Laurence Lundblade93d89472020-10-03 22:30:50 -07003686static QCBORError
3687InterpretBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003688{
3689 switch(pItem->uDataType) {
3690 case QCBOR_TYPE_TRUE:
3691 *pBool = true;
3692 return QCBOR_SUCCESS;
3693 break;
3694
3695 case QCBOR_TYPE_FALSE:
3696 *pBool = false;
3697 return QCBOR_SUCCESS;
3698 break;
3699
3700 default:
3701 return QCBOR_ERR_UNEXPECTED_TYPE;
3702 break;
3703 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003704 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003705}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003706
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003707
Laurence Lundblade9b334962020-08-27 10:55:53 -07003708
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003709/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003710 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003711*/
Laurence Lundbladec4537442020-04-14 18:53:22 -07003712void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003713{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003714 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003715 // Already in error state, do nothing
Laurence Lundbladee6430642020-03-14 21:15:44 -07003716 return;
3717 }
3718
Laurence Lundbladec4537442020-04-14 18:53:22 -07003719 QCBORError nError;
3720 QCBORItem Item;
3721
3722 nError = QCBORDecode_GetNext(pMe, &Item);
3723 if(nError != QCBOR_SUCCESS) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003724 pMe->uLastError = (uint8_t)nError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003725 return;
3726 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003727 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003728}
3729
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003730
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003731/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003732 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003733*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003734void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003735{
3736 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003737 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003738
Laurence Lundblade9b334962020-08-27 10:55:53 -07003739 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003740}
3741
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003742
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003743/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003744 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003745*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003746void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3747{
3748 QCBORItem Item;
3749 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3750
Laurence Lundblade9b334962020-08-27 10:55:53 -07003751 pMe->uLastError = (uint8_t)InterpretBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003752}
3753
3754
3755
Laurence Lundbladec7114722020-08-13 05:11:40 -07003756
3757static void ProcessEpochDate(QCBORDecodeContext *pMe,
3758 QCBORItem *pItem,
3759 uint8_t uTagRequirement,
3760 int64_t *pnTime)
3761{
3762 if(pMe->uLastError != QCBOR_SUCCESS) {
3763 // Already in error state, do nothing
3764 return;
3765 }
3766
3767 QCBORError uErr;
3768
3769 const TagSpecification TagSpec =
3770 {
3771 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003772 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3773 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003774 };
3775
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003776 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003777 if(uErr != QCBOR_SUCCESS) {
3778 goto Done;
3779 }
3780
3781 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3782 uErr = DecodeDateEpoch(pItem);
3783 if(uErr != QCBOR_SUCCESS) {
3784 goto Done;
3785 }
3786 }
3787
Laurence Lundblade9b334962020-08-27 10:55:53 -07003788 // Save the tags in the last item's tags in the decode context
3789 // for QCBORDecode_GetNthTagOfLast()
3790 CopyTags(pMe, pItem);
3791
Laurence Lundbladec7114722020-08-13 05:11:40 -07003792 *pnTime = pItem->val.epochDate.nSeconds;
3793
3794Done:
3795 pMe->uLastError = (uint8_t)uErr;
3796}
3797
3798
3799void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003800 uint8_t uTagRequirement,
3801 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003802{
3803 if(pMe->uLastError != QCBOR_SUCCESS) {
3804 // Already in error state, do nothing
3805 return;
3806 }
3807
3808 QCBORItem Item;
3809 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3810
3811 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3812}
3813
3814
3815void
3816QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3817 int64_t nLabel,
3818 uint8_t uTagRequirement,
3819 int64_t *pnTime)
3820{
3821 QCBORItem Item;
3822 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3823 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3824}
3825
3826
3827void
3828QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3829 const char *szLabel,
3830 uint8_t uTagRequirement,
3831 int64_t *pnTime)
3832{
3833 QCBORItem Item;
3834 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3835 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3836}
3837
3838
3839
3840
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003841void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3842 TagSpecification TagSpec,
3843 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003844{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003845 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003846 // Already in error state, do nothing
3847 return;
3848 }
3849
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003850 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003851 QCBORItem Item;
3852
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003853 uError = QCBORDecode_GetNext(pMe, &Item);
3854 if(uError != QCBOR_SUCCESS) {
3855 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003856 return;
3857 }
3858
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003859 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003860
3861 if(pMe->uLastError == QCBOR_SUCCESS) {
3862 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07003863 } else {
3864 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003865 }
3866}
3867
Laurence Lundbladec4537442020-04-14 18:53:22 -07003868
3869
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003870
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003871static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003872 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003873 UsefulBufC *pValue,
3874 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003875{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003876 const TagSpecification TagSpec =
3877 {
3878 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003879 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3880 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003881 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003882
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003883 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003884 if(uErr != QCBOR_SUCCESS) {
3885 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003886 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003887
3888 *pValue = pItem->val.string;
3889
3890 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
3891 *pbIsNegative = false;
3892 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
3893 *pbIsNegative = true;
3894 }
3895
3896 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003897}
3898
3899
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003900/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003901 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003902 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003903void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
3904 uint8_t uTagRequirement,
3905 UsefulBufC *pValue,
3906 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003907{
3908 if(pMe->uLastError != QCBOR_SUCCESS) {
3909 // Already in error state, do nothing
3910 return;
3911 }
3912
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003913 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003914 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
3915 if(uError != QCBOR_SUCCESS) {
3916 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003917 return;
3918 }
3919
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003920 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003921}
3922
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003923
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003924/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003925 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003926*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003927void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
3928 int64_t nLabel,
3929 uint8_t uTagRequirement,
3930 UsefulBufC *pValue,
3931 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003932{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003933 QCBORItem Item;
3934 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003935 if(pMe->uLastError != QCBOR_SUCCESS) {
3936 return;
3937 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07003938
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003939 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07003940}
3941
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003942
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003943/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003944 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003945*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003946void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
3947 const char *szLabel,
3948 uint8_t uTagRequirement,
3949 UsefulBufC *pValue,
3950 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003951{
3952 QCBORItem Item;
3953 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003954 if(pMe->uLastError != QCBOR_SUCCESS) {
3955 return;
3956 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003957
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003958 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003959}
3960
3961
3962
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003963
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003964// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003965QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
3966 const QCBORItem *pItem,
3967 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07003968 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003969{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003970 const TagSpecification TagSpecText =
3971 {
3972 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003973 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3974 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003975 };
3976 const TagSpecification TagSpecBinary =
3977 {
3978 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003979 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3980 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003981 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003982
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003983 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003984
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003985 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003986 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003987 if(pbIsTag257 != NULL) {
3988 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003989 }
3990 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003991 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003992 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07003993 if(pbIsTag257 != NULL) {
3994 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07003995 }
3996 uReturn = QCBOR_SUCCESS;
3997
3998 } else {
3999 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
4000 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07004001
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004002 return uReturn;
4003}
4004
Laurence Lundblade93d89472020-10-03 22:30:50 -07004005// Improvement: add methods for wrapped CBOR, a simple alternate
4006// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004007
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004008
4009
4010
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004011#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07004012
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004013typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004014
4015
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004016// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004017static QCBORError
4018Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004019{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004020 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004021
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004022 if(uResult != 0) {
4023 /* This loop will run a maximum of 19 times because
4024 * UINT64_MAX < 10 ^^ 19. More than that will cause
4025 * exit with the overflow error
4026 */
4027 for(; nExponent > 0; nExponent--) {
4028 if(uResult > UINT64_MAX / 10) {
4029 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4030 }
4031 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004032 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004033
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004034 for(; nExponent < 0; nExponent++) {
4035 uResult = uResult / 10;
4036 if(uResult == 0) {
4037 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4038 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004039 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004040 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004041 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004042
4043 *puResult = uResult;
4044
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004045 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004046}
4047
4048
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004049// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004050static QCBORError
4051Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004052{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004053 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004054
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004055 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004056
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004057 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004058 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004059 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004060 */
4061 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004062 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004063 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004064 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004065 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004066 nExponent--;
4067 }
4068
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004069 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004070 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004071 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4072 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004073 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004074 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004075 }
4076
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004077 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004078
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004079 return QCBOR_SUCCESS;
4080}
4081
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004082
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004083/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004084 Compute value with signed mantissa and signed result. Works with
4085 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004086 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004087static inline QCBORError ExponentiateNN(int64_t nMantissa,
4088 int64_t nExponent,
4089 int64_t *pnResult,
4090 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004091{
4092 uint64_t uResult;
4093
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004094 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004095 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004096 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4097
4098 // Do the exponentiation of the positive mantissa
4099 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4100 if(uReturn) {
4101 return uReturn;
4102 }
4103
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004104
Laurence Lundblade983500d2020-05-14 11:49:34 -07004105 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4106 of INT64_MIN. This assumes two's compliment representation where
4107 INT64_MIN is one increment farther from 0 than INT64_MAX.
4108 Trying to write -INT64_MIN doesn't work to get this because the
4109 compiler tries to work with an int64_t which can't represent
4110 -INT64_MIN.
4111 */
4112 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4113
4114 // Error out if too large
4115 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004116 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4117 }
4118
4119 // Casts are safe because of checks above
4120 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4121
4122 return QCBOR_SUCCESS;
4123}
4124
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004125
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004126/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004127 Compute value with signed mantissa and unsigned result. Works with
4128 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004129 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004130static inline QCBORError ExponentitateNU(int64_t nMantissa,
4131 int64_t nExponent,
4132 uint64_t *puResult,
4133 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004134{
4135 if(nMantissa < 0) {
4136 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4137 }
4138
4139 // Cast to unsigned is OK because of check for negative
4140 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4141 // Exponentiation is straight forward
4142 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4143}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004144
4145
4146/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004147 Compute value with signed mantissa and unsigned result. Works with
4148 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004149 */
4150static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4151 int64_t nExponent,
4152 uint64_t *puResult,
4153 fExponentiator pfExp)
4154{
4155 return (*pfExp)(uMantissa, nExponent, puResult);
4156}
4157
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004158#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004159
4160
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004161
4162
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004163
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004164static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004165{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004166 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004167
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004168 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004169 const uint8_t *pByte = BigNum.ptr;
4170 size_t uLen = BigNum.len;
4171 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004172 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004173 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004174 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004175 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004176 }
4177
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004178 *pResult = uResult;
4179 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004180}
4181
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004182
Laurence Lundblade887add82020-05-17 05:50:34 -07004183static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004184{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004185 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004186}
4187
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004188
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004189static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004190{
4191 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004192 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4193 if(uError) {
4194 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004195 }
4196 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4197 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004198 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004199}
4200
4201
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004202static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004203{
4204 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004205 /* The negative integer furthest from zero for a C int64_t is
4206 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4207 negative number in CBOR is computed as -n - 1 where n is the
4208 encoded integer, where n is what is in the variable BigNum. When
4209 converting BigNum to a uint64_t, the maximum value is thus
4210 INT64_MAX, so that when it -n - 1 is applied to it the result will
4211 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004212
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004213 -n - 1 <= INT64_MIN.
4214 -n - 1 <= -INT64_MAX - 1
4215 n <= INT64_MAX.
4216 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004217 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004218 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004219 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004220 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004221
4222 /// Now apply -n - 1. The cast is safe because
4223 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4224 // is the largest positive integer that an int64_t can
4225 // represent. */
4226 *pnResult = -(int64_t)uResult - 1;
4227
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004228 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004229}
4230
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004231
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004232
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004233
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004234
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004235/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004236Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004237
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004238\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004239
Laurence Lundblade93d89472020-10-03 22:30:50 -07004240\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4241 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004242
4243\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4244
Laurence Lundblade93d89472020-10-03 22:30:50 -07004245\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4246 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004247*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004248static QCBORError
4249ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004250{
4251 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004252 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004253 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004254#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004255 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004256 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4257 http://www.cplusplus.com/reference/cmath/llround/
4258 */
4259 // Not interested in FE_INEXACT
4260 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004261 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4262 *pnValue = llround(pItem->val.dfnum);
4263 } else {
4264 *pnValue = lroundf(pItem->val.fnum);
4265 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004266 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4267 // llround() shouldn't result in divide by zero, but catch
4268 // it here in case it unexpectedly does. Don't try to
4269 // distinguish between the various exceptions because it seems
4270 // they vary by CPU, compiler and OS.
4271 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004272 }
4273 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004274 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004275 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004276#else
4277 return QCBOR_ERR_HW_FLOAT_DISABLED;
4278#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004279 break;
4280
4281 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004282 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004283 *pnValue = pItem->val.int64;
4284 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004285 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004286 }
4287 break;
4288
4289 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004290 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004291 if(pItem->val.uint64 < INT64_MAX) {
4292 *pnValue = pItem->val.int64;
4293 } else {
4294 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4295 }
4296 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004297 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004298 }
4299 break;
4300
4301 default:
4302 return QCBOR_ERR_UNEXPECTED_TYPE;
4303 }
4304 return QCBOR_SUCCESS;
4305}
4306
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004307
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004308void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004309 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004310 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004311 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004312{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004313 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004314 return;
4315 }
4316
Laurence Lundbladee6430642020-03-14 21:15:44 -07004317 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004318 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4319 if(uError) {
4320 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004321 return;
4322 }
4323
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004324 if(pItem) {
4325 *pItem = Item;
4326 }
4327
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004328 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004329}
4330
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004331
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004332void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4333 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004334 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004335 int64_t *pnValue,
4336 QCBORItem *pItem)
4337{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004338 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004339 if(pMe->uLastError != QCBOR_SUCCESS) {
4340 return;
4341 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004342
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004343 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004344}
4345
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004346
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004347void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4348 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004349 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004350 int64_t *pnValue,
4351 QCBORItem *pItem)
4352{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004353 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004354 if(pMe->uLastError != QCBOR_SUCCESS) {
4355 return;
4356 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004357
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004358 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004359}
4360
4361
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004362/*
4363 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004364
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004365 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004366
Laurence Lundblade93d89472020-10-03 22:30:50 -07004367 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4368 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004369
4370 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4371
Laurence Lundblade93d89472020-10-03 22:30:50 -07004372 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4373 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004374 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004375static QCBORError
4376Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004377{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004378 switch(pItem->uDataType) {
4379
4380 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004381 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004382 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004383 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004384 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004385 }
4386 break;
4387
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004388 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004389 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004390 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004391 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004392 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004393 }
4394 break;
4395
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004396#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004397 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004398 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004399 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004400 pItem->val.expAndMantissa.nExponent,
4401 pnValue,
4402 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004403 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004404 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004405 }
4406 break;
4407
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004408 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004409 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004410 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004411 pItem->val.expAndMantissa.nExponent,
4412 pnValue,
4413 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004414 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004415 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004416 }
4417 break;
4418
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004419 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004420 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004421 int64_t nMantissa;
4422 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004423 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4424 if(uErr) {
4425 return uErr;
4426 }
4427 return ExponentiateNN(nMantissa,
4428 pItem->val.expAndMantissa.nExponent,
4429 pnValue,
4430 Exponentitate10);
4431 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004432 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004433 }
4434 break;
4435
4436 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004437 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004438 int64_t nMantissa;
4439 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004440 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4441 if(uErr) {
4442 return uErr;
4443 }
4444 return ExponentiateNN(nMantissa,
4445 pItem->val.expAndMantissa.nExponent,
4446 pnValue,
4447 Exponentitate10);
4448 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004449 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004450 }
4451 break;
4452
4453 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004454 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004455 int64_t nMantissa;
4456 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004457 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4458 if(uErr) {
4459 return uErr;
4460 }
4461 return ExponentiateNN(nMantissa,
4462 pItem->val.expAndMantissa.nExponent,
4463 pnValue,
4464 Exponentitate2);
4465 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004466 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004467 }
4468 break;
4469
4470 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004471 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004472 int64_t nMantissa;
4473 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004474 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4475 if(uErr) {
4476 return uErr;
4477 }
4478 return ExponentiateNN(nMantissa,
4479 pItem->val.expAndMantissa.nExponent,
4480 pnValue,
4481 Exponentitate2);
4482 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004483 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004484 }
4485 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004486#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004487
Laurence Lundbladee6430642020-03-14 21:15:44 -07004488
Laurence Lundbladec4537442020-04-14 18:53:22 -07004489 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004490 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004491}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004492
4493
Laurence Lundbladec4537442020-04-14 18:53:22 -07004494/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004495 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004496 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004497void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004498{
4499 QCBORItem Item;
4500
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004501 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004502
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004503 if(pMe->uLastError == QCBOR_SUCCESS) {
4504 // The above conversion succeeded
4505 return;
4506 }
4507
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004508 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004509 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004510 return;
4511 }
4512
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004513 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004514}
4515
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004516
4517/*
4518Public function, see header qcbor/qcbor_decode.h file
4519*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004520void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4521 int64_t nLabel,
4522 uint32_t uConvertTypes,
4523 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004524{
4525 QCBORItem Item;
4526
Laurence Lundblade93d89472020-10-03 22:30:50 -07004527 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4528 nLabel,
4529 uConvertTypes,
4530 pnValue,
4531 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004532
4533 if(pMe->uLastError == QCBOR_SUCCESS) {
4534 // The above conversion succeeded
4535 return;
4536 }
4537
4538 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4539 // The above conversion failed in a way that code below can't correct
4540 return;
4541 }
4542
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004543 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004544}
4545
4546
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004547/*
4548Public function, see header qcbor/qcbor_decode.h file
4549*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004550void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4551 const char *szLabel,
4552 uint32_t uConvertTypes,
4553 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004554{
4555 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004556 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4557 szLabel,
4558 uConvertTypes,
4559 pnValue,
4560 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004561
4562 if(pMe->uLastError == QCBOR_SUCCESS) {
4563 // The above conversion succeeded
4564 return;
4565 }
4566
4567 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4568 // The above conversion failed in a way that code below can't correct
4569 return;
4570 }
4571
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004572 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004573}
4574
4575
Laurence Lundblade93d89472020-10-03 22:30:50 -07004576static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004577{
4578 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004579 case QCBOR_TYPE_DOUBLE:
4580 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004581#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004582 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004583 // Can't use llround here because it will not convert values
4584 // greater than INT64_MAX and less than UINT64_MAX that
4585 // need to be converted so it is more complicated.
4586 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4587 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4588 if(isnan(pItem->val.dfnum)) {
4589 return QCBOR_ERR_FLOAT_EXCEPTION;
4590 } else if(pItem->val.dfnum < 0) {
4591 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4592 } else {
4593 double dRounded = round(pItem->val.dfnum);
4594 // See discussion in DecodeDateEpoch() for
4595 // explanation of - 0x7ff
4596 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4597 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4598 }
4599 *puValue = (uint64_t)dRounded;
4600 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004601 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004602 if(isnan(pItem->val.fnum)) {
4603 return QCBOR_ERR_FLOAT_EXCEPTION;
4604 } else if(pItem->val.fnum < 0) {
4605 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4606 } else {
4607 float fRounded = roundf(pItem->val.fnum);
4608 // See discussion in DecodeDateEpoch() for
4609 // explanation of - 0x7ff
4610 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4611 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4612 }
4613 *puValue = (uint64_t)fRounded;
4614 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004615 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004616 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4617 // round() and roundf() shouldn't result in exceptions here, but
4618 // catch them to be robust and thorough. Don't try to
4619 // distinguish between the various exceptions because it seems
4620 // they vary by CPU, compiler and OS.
4621 return QCBOR_ERR_FLOAT_EXCEPTION;
4622 }
4623
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004624 } else {
4625 return QCBOR_ERR_UNEXPECTED_TYPE;
4626 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004627#else
4628 return QCBOR_ERR_HW_FLOAT_DISABLED;
4629#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004630 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004631
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004632 case QCBOR_TYPE_INT64:
4633 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4634 if(pItem->val.int64 >= 0) {
4635 *puValue = (uint64_t)pItem->val.int64;
4636 } else {
4637 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4638 }
4639 } else {
4640 return QCBOR_ERR_UNEXPECTED_TYPE;
4641 }
4642 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004643
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004644 case QCBOR_TYPE_UINT64:
4645 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4646 *puValue = pItem->val.uint64;
4647 } else {
4648 return QCBOR_ERR_UNEXPECTED_TYPE;
4649 }
4650 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004651
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004652 default:
4653 return QCBOR_ERR_UNEXPECTED_TYPE;
4654 }
4655
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004656 return QCBOR_SUCCESS;
4657}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004658
4659
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004660void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004661 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004662 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004663 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004664{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004665 if(pMe->uLastError != QCBOR_SUCCESS) {
4666 return;
4667 }
4668
Laurence Lundbladec4537442020-04-14 18:53:22 -07004669 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004670
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004671 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4672 if(uError) {
4673 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004674 return;
4675 }
4676
Laurence Lundbladea826c502020-05-10 21:07:00 -07004677 if(pItem) {
4678 *pItem = Item;
4679 }
4680
Laurence Lundblade93d89472020-10-03 22:30:50 -07004681 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004682}
4683
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004684
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004685void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004686 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004687 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004688 uint64_t *puValue,
4689 QCBORItem *pItem)
4690{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004691 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004692 if(pMe->uLastError != QCBOR_SUCCESS) {
4693 return;
4694 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004695
Laurence Lundblade93d89472020-10-03 22:30:50 -07004696 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004697}
4698
4699
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004700void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004701 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004702 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004703 uint64_t *puValue,
4704 QCBORItem *pItem)
4705{
4706 if(pMe->uLastError != QCBOR_SUCCESS) {
4707 return;
4708 }
4709
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004710 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004711 if(pMe->uLastError != QCBOR_SUCCESS) {
4712 return;
4713 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004714
Laurence Lundblade93d89472020-10-03 22:30:50 -07004715 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004716}
4717
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004718
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004719
Laurence Lundblade93d89472020-10-03 22:30:50 -07004720static QCBORError
4721UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004722{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004723 switch(pItem->uDataType) {
4724
4725 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004726 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004727 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4728 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004729 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004730 }
4731 break;
4732
4733 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004734 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004735 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4736 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004737 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004738 }
4739 break;
4740
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004741#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004742
4743 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004744 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004745 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004746 pItem->val.expAndMantissa.nExponent,
4747 puValue,
4748 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004749 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004750 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004751 }
4752 break;
4753
4754 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004755 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004756 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4757 pItem->val.expAndMantissa.nExponent,
4758 puValue,
4759 Exponentitate2);
4760 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004761 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004762 }
4763 break;
4764
4765 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004766 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004767 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004768 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004769 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004770 if(uErr != QCBOR_SUCCESS) {
4771 return uErr;
4772 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004773 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004774 pItem->val.expAndMantissa.nExponent,
4775 puValue,
4776 Exponentitate10);
4777 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004778 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004779 }
4780 break;
4781
4782 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004783 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004784 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4785 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004786 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004787 }
4788 break;
4789
4790 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004791 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004792 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004793 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004794 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004795 if(uErr != QCBOR_SUCCESS) {
4796 return uErr;
4797 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004798 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004799 pItem->val.expAndMantissa.nExponent,
4800 puValue,
4801 Exponentitate2);
4802 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004803 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004804 }
4805 break;
4806
4807 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004808 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004809 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4810 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004811 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004812 }
4813 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004814#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004815 default:
4816 return QCBOR_ERR_UNEXPECTED_TYPE;
4817 }
4818}
4819
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004820
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004821/*
4822 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004823 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004824void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004825{
4826 QCBORItem Item;
4827
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004828 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004829
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004830 if(pMe->uLastError == QCBOR_SUCCESS) {
4831 // The above conversion succeeded
4832 return;
4833 }
4834
4835 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4836 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004837 return;
4838 }
4839
Laurence Lundblade93d89472020-10-03 22:30:50 -07004840 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004841}
4842
Laurence Lundbladec4537442020-04-14 18:53:22 -07004843
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004844/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004845 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004846*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004847void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004848 int64_t nLabel,
4849 uint32_t uConvertTypes,
4850 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004851{
4852 QCBORItem Item;
4853
Laurence Lundblade93d89472020-10-03 22:30:50 -07004854 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4855 nLabel,
4856 uConvertTypes,
4857 puValue,
4858 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004859
4860 if(pMe->uLastError == QCBOR_SUCCESS) {
4861 // The above conversion succeeded
4862 return;
4863 }
4864
4865 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4866 // The above conversion failed in a way that code below can't correct
4867 return;
4868 }
4869
Laurence Lundblade93d89472020-10-03 22:30:50 -07004870 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004871}
4872
4873
4874/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004875 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004876*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004877void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004878 const char *szLabel,
4879 uint32_t uConvertTypes,
4880 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004881{
4882 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004883 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
4884 szLabel,
4885 uConvertTypes,
4886 puValue,
4887 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004888
4889 if(pMe->uLastError == QCBOR_SUCCESS) {
4890 // The above conversion succeeded
4891 return;
4892 }
4893
4894 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4895 // The above conversion failed in a way that code below can't correct
4896 return;
4897 }
4898
Laurence Lundblade93d89472020-10-03 22:30:50 -07004899 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004900}
4901
4902
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004903
4904
Laurence Lundblade9b334962020-08-27 10:55:53 -07004905static QCBORError ConvertDouble(const QCBORItem *pItem,
4906 uint32_t uConvertTypes,
4907 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004908{
4909 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004910 case QCBOR_TYPE_FLOAT:
4911#ifndef QCBOR_DISABLE_FLOAT_HW_USE
4912 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4913 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004914 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004915 *pdValue = (double)pItem->val.fnum;
4916 } else {
4917 return QCBOR_ERR_UNEXPECTED_TYPE;
4918 }
4919 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004920#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004921 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08004922#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004923 break;
4924
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004925 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004926 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
4927 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004928 *pdValue = pItem->val.dfnum;
4929 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004930 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004931 }
4932 }
4933 break;
4934
4935 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004936#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004937 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004938 // A simple cast seems to do the job with no worry of exceptions.
4939 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004940 *pdValue = (double)pItem->val.int64;
4941
4942 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004943 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004944 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004945#else
4946 return QCBOR_ERR_HW_FLOAT_DISABLED;
4947#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004948 break;
4949
4950 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004951#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004952 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004953 // A simple cast seems to do the job with no worry of exceptions.
4954 // There will be precision loss for some values.
4955 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004956 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004957 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004958 }
4959 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004960#else
4961 return QCBOR_ERR_HW_FLOAT_DISABLED;
4962#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004963
4964 default:
4965 return QCBOR_ERR_UNEXPECTED_TYPE;
4966 }
4967
4968 return QCBOR_SUCCESS;
4969}
4970
4971
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004972void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004973 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004974 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004975 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004976{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004977 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004978 return;
4979 }
4980
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004981 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004982
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004983 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004984 if(uError) {
4985 pMe->uLastError = (uint8_t)uError;
4986 return;
4987 }
4988
4989 if(pItem) {
4990 *pItem = Item;
4991 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004992
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004993 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07004994}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004995
Laurence Lundbladec4537442020-04-14 18:53:22 -07004996
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004997void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
4998 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004999 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005000 double *pdValue,
5001 QCBORItem *pItem)
5002{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005003 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005004 if(pMe->uLastError != QCBOR_SUCCESS) {
5005 return;
5006 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005007
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005008 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005009}
5010
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005011
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005012void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
5013 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005014 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005015 double *pdValue,
5016 QCBORItem *pItem)
5017{
5018 if(pMe->uLastError != QCBOR_SUCCESS) {
5019 return;
5020 }
5021
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005022 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005023 if(pMe->uLastError != QCBOR_SUCCESS) {
5024 return;
5025 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005026
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005027 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005028}
5029
5030
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005031#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005032static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5033{
5034 double dResult;
5035
5036 dResult = 0.0;
5037 const uint8_t *pByte = BigNum.ptr;
5038 size_t uLen = BigNum.len;
5039 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005040 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005041 while(uLen--) {
5042 dResult = (dResult * 256.0) + (double)*pByte++;
5043 }
5044
5045 return dResult;
5046}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005047#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5048
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005049
Laurence Lundblade93d89472020-10-03 22:30:50 -07005050static QCBORError
5051DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005052{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005053#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005054 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005055 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5056
5057 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005058 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005059
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005060#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005061 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005062 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005063 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005064 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5065 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5066 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005067 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005068 }
5069 break;
5070
5071 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005072 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005073 // Underflow gives 0, overflow gives infinity
5074 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5075 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005076 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005077 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005078 }
5079 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005080#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005081
5082 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005083 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005084 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5085 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005086 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005087 }
5088 break;
5089
5090 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005091 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005092 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
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;
5097
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005098#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005099 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005100 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005101 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5102 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5103 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005104 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005105 }
5106 break;
5107
5108 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005109 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005110 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5111 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5112 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005113 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005114 }
5115 break;
5116
5117 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005118 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005119 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5120 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5121 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005122 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005123 }
5124 break;
5125
5126 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005127 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005128 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005129 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5130 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005131 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005132 }
5133 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005134#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005135
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005136 default:
5137 return QCBOR_ERR_UNEXPECTED_TYPE;
5138 }
5139
5140 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005141
5142#else
5143 (void)pItem;
5144 (void)uConvertTypes;
5145 (void)pdValue;
5146 return QCBOR_ERR_HW_FLOAT_DISABLED;
5147#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5148
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005149}
5150
5151
5152/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005153 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005154*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005155void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5156 uint32_t uConvertTypes,
5157 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005158{
5159
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005160 QCBORItem Item;
5161
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005162 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005163
5164 if(pMe->uLastError == QCBOR_SUCCESS) {
5165 // The above conversion succeeded
5166 return;
5167 }
5168
5169 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5170 // The above conversion failed in a way that code below can't correct
5171 return;
5172 }
5173
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005174 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005175}
5176
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005177
5178/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005179 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005180*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005181void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5182 int64_t nLabel,
5183 uint32_t uConvertTypes,
5184 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005185{
5186 QCBORItem Item;
5187
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005188 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005189
5190 if(pMe->uLastError == QCBOR_SUCCESS) {
5191 // The above conversion succeeded
5192 return;
5193 }
5194
5195 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5196 // The above conversion failed in a way that code below can't correct
5197 return;
5198 }
5199
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005200 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005201}
5202
5203
5204/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005205 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005206*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005207void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5208 const char *szLabel,
5209 uint32_t uConvertTypes,
5210 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005211{
5212 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005213 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005214
5215 if(pMe->uLastError == QCBOR_SUCCESS) {
5216 // The above conversion succeeded
5217 return;
5218 }
5219
5220 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5221 // The above conversion failed in a way that code below can't correct
5222 return;
5223 }
5224
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005225 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005226}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005227
5228
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005229
5230
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005231#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005232static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5233{
5234 while((uInt & 0xff00000000000000UL) == 0) {
5235 uInt = uInt << 8;
5236 };
5237
5238 UsefulOutBuf UOB;
5239
5240 UsefulOutBuf_Init(&UOB, Buffer);
5241
5242 while(uInt) {
5243 const uint64_t xx = uInt & 0xff00000000000000UL;
5244 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5245 uInt = uInt << 8;
5246 (void)xx;
5247 }
5248
5249 return UsefulOutBuf_OutUBuf(&UOB);
5250}
5251
5252
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005253static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5254 TagSpecification TagSpec,
5255 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005256{
5257 QCBORError uErr;
5258 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005259 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005260 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005261 if(uErr != QCBOR_SUCCESS) {
5262 goto Done;
5263 }
5264
5265 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5266 break; // Successful exit. Moving on to finish decoding.
5267 }
5268
5269 // The item is an array, which means an undecoded
5270 // mantissa and exponent, so decode it. It will then
5271 // have a different type and exit the loop if.
5272 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5273 if(uErr != QCBOR_SUCCESS) {
5274 goto Done;
5275 }
5276
5277 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005278 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005279 }
5280Done:
5281 return uErr;
5282}
5283
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005284
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005285static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005286 TagSpecification TagSpec,
5287 QCBORItem *pItem,
5288 int64_t *pnMantissa,
5289 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005290{
5291 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005292
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005293 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005294 if(uErr != QCBOR_SUCCESS) {
5295 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005296 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005297
Laurence Lundblade9b334962020-08-27 10:55:53 -07005298 switch (pItem->uDataType) {
5299
5300 case QCBOR_TYPE_DECIMAL_FRACTION:
5301 case QCBOR_TYPE_BIGFLOAT:
5302 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5303 *pnExponent = pItem->val.expAndMantissa.nExponent;
5304 break;
5305
5306 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5307 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5308 *pnExponent = pItem->val.expAndMantissa.nExponent;
5309 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5310 break;
5311
5312 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5313 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5314 *pnExponent = pItem->val.expAndMantissa.nExponent;
5315 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5316 break;
5317
5318 default:
5319 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5320 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005321
5322 Done:
5323 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005324}
5325
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005326
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005327static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005328 TagSpecification TagSpec,
5329 QCBORItem *pItem,
5330 UsefulBuf BufferForMantissa,
5331 UsefulBufC *pMantissa,
5332 bool *pbIsNegative,
5333 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005334{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005335 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005336
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005337 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005338 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005339 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005340 }
5341
5342 uint64_t uMantissa;
5343
5344 switch (pItem->uDataType) {
5345
5346 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005347 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005348 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5349 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5350 *pbIsNegative = false;
5351 } else {
5352 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5353 *pbIsNegative = true;
5354 }
5355 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5356 *pnExponent = pItem->val.expAndMantissa.nExponent;
5357 break;
5358
5359 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005360 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005361 *pnExponent = pItem->val.expAndMantissa.nExponent;
5362 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5363 *pbIsNegative = false;
5364 break;
5365
5366 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005367 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005368 *pnExponent = pItem->val.expAndMantissa.nExponent;
5369 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5370 *pbIsNegative = true;
5371 break;
5372
5373 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005374 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005375 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005376
5377Done:
5378 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005379}
5380
5381
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005382/*
5383 Public function, see header qcbor/qcbor_decode.h file
5384*/
5385void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5386 uint8_t uTagRequirement,
5387 int64_t *pnMantissa,
5388 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005389{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005390 if(pMe->uLastError != QCBOR_SUCCESS) {
5391 return;
5392 }
5393
5394 QCBORItem Item;
5395 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5396 if(uError) {
5397 pMe->uLastError = (uint8_t)uError;
5398 return;
5399 }
5400
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005401 const TagSpecification TagSpec =
5402 {
5403 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005404 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5405 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5406 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005407 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005408
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005409 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005410}
5411
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005412
5413/*
5414 Public function, see header qcbor/qcbor_decode.h file
5415*/
5416void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005417 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005418 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005419 int64_t *pnMantissa,
5420 int64_t *pnExponent)
5421{
5422 if(pMe->uLastError != QCBOR_SUCCESS) {
5423 return;
5424 }
5425
5426 QCBORItem Item;
5427 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5428
5429 const TagSpecification TagSpec =
5430 {
5431 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005432 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5433 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5434 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005435 };
5436
5437 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5438}
5439
5440
5441/*
5442 Public function, see header qcbor/qcbor_decode.h file
5443*/
5444void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005445 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005446 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005447 int64_t *pnMantissa,
5448 int64_t *pnExponent)
5449{
5450 if(pMe->uLastError != QCBOR_SUCCESS) {
5451 return;
5452 }
5453
5454 QCBORItem Item;
5455 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5456
5457 const TagSpecification TagSpec =
5458 {
5459 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005460 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5461 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5462 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005463 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005464
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005465 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5466}
5467
5468
5469/*
5470 Public function, see header qcbor/qcbor_decode.h file
5471*/
5472void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5473 uint8_t uTagRequirement,
5474 UsefulBuf MantissaBuffer,
5475 UsefulBufC *pMantissa,
5476 bool *pbMantissaIsNegative,
5477 int64_t *pnExponent)
5478{
5479 if(pMe->uLastError != QCBOR_SUCCESS) {
5480 return;
5481 }
5482
5483 QCBORItem Item;
5484 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5485 if(uError) {
5486 pMe->uLastError = (uint8_t)uError;
5487 return;
5488 }
5489
5490 const TagSpecification TagSpec =
5491 {
5492 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005493 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5494 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5495 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005496 };
5497
Laurence Lundblade93d89472020-10-03 22:30:50 -07005498 ProcessMantissaAndExponentBig(pMe,
5499 TagSpec,
5500 &Item,
5501 MantissaBuffer,
5502 pMantissa,
5503 pbMantissaIsNegative,
5504 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005505}
5506
5507
5508/*
5509 Public function, see header qcbor/qcbor_decode.h file
5510*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005511void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005512 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005513 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005514 UsefulBuf BufferForMantissa,
5515 UsefulBufC *pMantissa,
5516 bool *pbIsNegative,
5517 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005518{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005519 if(pMe->uLastError != QCBOR_SUCCESS) {
5520 return;
5521 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005522
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005523 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005524 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005525 if(pMe->uLastError != QCBOR_SUCCESS) {
5526 return;
5527 }
5528
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005529 const TagSpecification TagSpec =
5530 {
5531 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005532 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5533 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5534 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005535 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005536
Laurence Lundblade93d89472020-10-03 22:30:50 -07005537 ProcessMantissaAndExponentBig(pMe,
5538 TagSpec,
5539 &Item,
5540 BufferForMantissa,
5541 pMantissa,
5542 pbIsNegative,
5543 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005544}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005545
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005546
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005547/*
5548 Public function, see header qcbor/qcbor_decode.h file
5549*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005550void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005551 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005552 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005553 UsefulBuf BufferForMantissa,
5554 UsefulBufC *pMantissa,
5555 bool *pbIsNegative,
5556 int64_t *pnExponent)
5557{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005558 if(pMe->uLastError != QCBOR_SUCCESS) {
5559 return;
5560 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005561
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005562 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005563 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5564 if(pMe->uLastError != QCBOR_SUCCESS) {
5565 return;
5566 }
5567
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005568 const TagSpecification TagSpec =
5569 {
5570 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005571 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5572 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5573 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005574 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005575
5576 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5577}
5578
5579
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005580/*
5581 Public function, see header qcbor/qcbor_decode.h file
5582*/
5583void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5584 uint8_t uTagRequirement,
5585 int64_t *pnMantissa,
5586 int64_t *pnExponent)
5587{
5588 if(pMe->uLastError != QCBOR_SUCCESS) {
5589 return;
5590 }
5591
5592 QCBORItem Item;
5593 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5594 if(uError) {
5595 pMe->uLastError = (uint8_t)uError;
5596 return;
5597 }
5598 const TagSpecification TagSpec =
5599 {
5600 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005601 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5602 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5603 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005604 };
5605
5606 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5607}
5608
5609
5610/*
5611 Public function, see header qcbor/qcbor_decode.h file
5612*/
5613void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005614 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005615 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005616 int64_t *pnMantissa,
5617 int64_t *pnExponent)
5618{
5619 if(pMe->uLastError != QCBOR_SUCCESS) {
5620 return;
5621 }
5622
5623 QCBORItem Item;
5624 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5625 if(pMe->uLastError != QCBOR_SUCCESS) {
5626 return;
5627 }
5628
5629 const TagSpecification TagSpec =
5630 {
5631 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005632 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5633 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5634 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005635 };
5636
5637 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5638}
5639
5640
5641/*
5642 Public function, see header qcbor/qcbor_decode.h file
5643*/
5644void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005645 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005646 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005647 int64_t *pnMantissa,
5648 int64_t *pnExponent)
5649{
5650 if(pMe->uLastError != QCBOR_SUCCESS) {
5651 return;
5652 }
5653
5654 QCBORItem Item;
5655 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5656 if(pMe->uLastError != QCBOR_SUCCESS) {
5657 return;
5658 }
5659
5660 const TagSpecification TagSpec =
5661 {
5662 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005663 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5664 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5665 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005666 };
5667
5668 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5669}
5670
5671
5672/*
5673 Public function, see header qcbor/qcbor_decode.h file
5674*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005675void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5676 uint8_t uTagRequirement,
5677 UsefulBuf MantissaBuffer,
5678 UsefulBufC *pMantissa,
5679 bool *pbMantissaIsNegative,
5680 int64_t *pnExponent)
5681{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005682 if(pMe->uLastError != QCBOR_SUCCESS) {
5683 return;
5684 }
5685
5686 QCBORItem Item;
5687 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5688 if(uError) {
5689 pMe->uLastError = (uint8_t)uError;
5690 return;
5691 }
5692
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005693 const TagSpecification TagSpec =
5694 {
5695 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005696 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5697 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5698 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005699 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005700
5701 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005702}
5703
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005704
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005705/*
5706 Public function, see header qcbor/qcbor_decode.h file
5707*/
5708void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005709 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005710 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005711 UsefulBuf BufferForMantissa,
5712 UsefulBufC *pMantissa,
5713 bool *pbIsNegative,
5714 int64_t *pnExponent)
5715{
5716 if(pMe->uLastError != QCBOR_SUCCESS) {
5717 return;
5718 }
5719
5720 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005721 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5722 if(pMe->uLastError != QCBOR_SUCCESS) {
5723 return;
5724 }
5725
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005726 const TagSpecification TagSpec =
5727 {
5728 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005729 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5730 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5731 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005732 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005733
Laurence Lundblade93d89472020-10-03 22:30:50 -07005734 ProcessMantissaAndExponentBig(pMe,
5735 TagSpec,
5736 &Item,
5737 BufferForMantissa,
5738 pMantissa,
5739 pbIsNegative,
5740 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005741}
5742
5743
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005744/*
5745 Public function, see header qcbor/qcbor_decode.h file
5746*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005747void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005748 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005749 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005750 UsefulBuf BufferForMantissa,
5751 UsefulBufC *pMantissa,
5752 bool *pbIsNegative,
5753 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005754{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005755 if(pMe->uLastError != QCBOR_SUCCESS) {
5756 return;
5757 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005758
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005759 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005760 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5761 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005762 return;
5763 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005764
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005765 const TagSpecification TagSpec =
5766 {
5767 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005768 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5769 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5770 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005771 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005772
Laurence Lundblade93d89472020-10-03 22:30:50 -07005773 ProcessMantissaAndExponentBig(pMe,
5774 TagSpec,
5775 &Item,
5776 BufferForMantissa,
5777 pMantissa,
5778 pbIsNegative,
5779 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005780}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005781
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005782#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */