blob: 2be12d96a08d493383bd04c9e12f8d23d9db5f47 [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003 Copyright (c) 2018-2021, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080036#include "ieee754.h" /* Does not use math.h */
Laurence Lundbladec7114722020-08-13 05:11:40 -070037
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080039
40#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
41 * pow(), exp2()
42 */
43#include <fenv.h> /* feclearexcept(), fetestexcept() */
44
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080045#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070046
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070047
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080048
Laurence Lundbladea9489f82020-09-12 13:50:56 -070049#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070050
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070051
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080052
53
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070054static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070055QCBORItem_IsMapOrArray(const QCBORItem *pMe)
56{
57 const uint8_t uDataType = pMe->uDataType;
58 return uDataType == QCBOR_TYPE_MAP ||
59 uDataType == QCBOR_TYPE_ARRAY ||
60 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
61}
62
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070063static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070064QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
65{
66 if(!QCBORItem_IsMapOrArray(pMe)){
67 return false;
68 }
69
70 if(pMe->val.uCount != 0) {
71 return false;
72 }
73 return true;
74}
75
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070076static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070077QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
78{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080079#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -070080 if(!QCBORItem_IsMapOrArray(pMe)){
81 return false;
82 }
83
84 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
85 return false;
86 }
87 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080088#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
89 (void)pMe;
90 return false;
91#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -070092}
93
94
Laurence Lundbladeee851742020-01-08 08:37:05 -080095/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070096 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080097 ===========================================================================*/
98
Laurence Lundblade9c905e82020-04-25 11:31:38 -070099/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800100 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
101 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700102 */
103
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700104
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700105static inline uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700106DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700107{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700108 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800109 /* Limit in DecodeNesting_Descend against more than
110 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700111 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700112 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700113}
114
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700115
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700116static inline uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700117DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700118{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700119 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800120 /* Limit in DecodeNesting_Descend against more than
121 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700122 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700123 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700124}
125
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700126
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700127static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700128DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700129{
130 return pNesting->pCurrentBounded->u.ma.uStartOffset;
131}
132
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700133
Laurence Lundblade085d7952020-07-24 10:26:30 -0700134static inline bool
135DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
136{
137 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
138 return true;
139 } else {
140 return false;
141 }
142}
143
144
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700145static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700146DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700147{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700148 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700149 return true;
150 } else {
151 return false;
152 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700153}
154
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700155
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700156static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700157DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700158{
159 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800160 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700161 return false;
162 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800163
164#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700165 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800166 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700167 return false;
168 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800169
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800170#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
171
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800172 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700173 return true;
174}
175
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700176static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700177DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700178{
179 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800180 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700181 return true;
182 }
183 return false;
184}
185
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700186
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700187static inline bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700188{
189 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
190 return true;
191 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700192 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700193 return true;
194 }
195 return false;
196}
197
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700198
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700199static inline void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700200{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800201 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700202 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800203 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
204 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
205 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700206 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700207 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700208
209 if(bIsEmpty) {
210 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
211 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700212}
213
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700214
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700215static inline void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700216{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700217 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700218}
219
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700220
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700221static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700222DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700223{
224 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800225 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700226 return false;
227 }
228 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800229 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700230 return false;
231 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700232 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800233 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700234 return false;
235 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800236 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800237 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
238 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800239 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700240 return false;
241 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800242 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700243 return true;
244}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700245
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700246
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700247static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700248DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700249{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800250 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700251 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
252 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700253 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700254 return false;
255 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700256}
257
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700258
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700259static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700260DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700261{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700262 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
263 return true;
264 } else {
265 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700266 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700267}
268
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700269
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700270static inline bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700271DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700272{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700273 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700274 return false;
275 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700276
277 if(pNesting->pCurrentBounded->uLevelType != uType) {
278 return false;
279 }
280
281 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700282}
283
Laurence Lundblade02625d42020-06-25 14:41:41 -0700284
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700285static inline void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700286DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700287{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800288 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700289 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700290}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700291
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700292
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700293static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700294DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
295{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800296 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700297 pNesting->pCurrent->u.ma.uCountCursor++;
298}
299
300
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700301static inline void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700302DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
303{
304 pNesting->pCurrent--;
305}
306
Laurence Lundblade02625d42020-06-25 14:41:41 -0700307
308static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700309DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700310{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800311 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700312 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700313 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700314 }
315
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800316 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700317 pNesting->pCurrent++;
318
319 pNesting->pCurrent->uLevelType = uType;
320
321 return QCBOR_SUCCESS;
322}
323
324
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700325static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800326DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
327 bool bIsEmpty,
328 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700329{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700330 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800331 * Should only be called on map/array.
332 *
333 * Have descended into this before this is called. The job here is
334 * just to mark it in bounded mode.
335 *
336 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
337 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
338 *
339 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700340 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800341 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700342 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700343 }
344
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700345 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700346
347 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700348
349 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700350}
351
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700352
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700353static inline QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700354DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700355 uint8_t uQCBORType,
356 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700357{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700358 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700359
360 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800361 /* Nothing to do for empty definite-length arrays. They are just are
362 * effectively the same as an item that is not a map or array.
363 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700364 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800365 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700366 }
367
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800368 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700369 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
370 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700371 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700372 goto Done;
373 }
374
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700375 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700376 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700377 goto Done;
378 }
379
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800380 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700381 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
382 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700383
384 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700385
386Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700387 return uError;;
388}
389
390
391static inline void
392DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
393{
394 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
395}
396
397
398static inline void
399DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
400{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700401 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700402 pNesting->pCurrentBounded--;
403 if(DecodeNesting_IsCurrentBounded(pNesting)) {
404 break;
405 }
406 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700407}
408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800409
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700410static inline void
411DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
412{
413 pNesting->pCurrent = pNesting->pCurrentBounded;
414}
415
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700416
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700417static inline QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700418DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700419 uint32_t uEndOffset,
420 uint32_t uStartOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700421{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700422 QCBORError uError;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700423
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700424 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700425 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700426 goto Done;
427 }
428
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800429 /* Fill in the new byte string level */
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700430 pNesting->pCurrent->u.bs.uSavedEndOffset = uEndOffset;
431 pNesting->pCurrent->u.bs.uBstrStartOffset = uStartOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700432
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800433 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700434 pNesting->pCurrentBounded = pNesting->pCurrent;
435
436Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700437 return uError;;
438}
439
Laurence Lundbladed0304932020-06-27 10:59:38 -0700440
441static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700442DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700443{
444 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700445}
446
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700447
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700448static inline void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800449DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
450{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700451 if(pNesting->pCurrent->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
452 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
453 }
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800454}
455
456
457static inline void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700458DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700459{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700460 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700461 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
462 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700463}
464
465
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700466static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800467DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
468 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700469{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700470 *pSave = *pNesting;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700471}
472
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700473
Laurence Lundblade02625d42020-06-25 14:41:41 -0700474static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800475DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
476 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700477{
478 *pNesting = *pSave;
479}
480
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700481
Laurence Lundblade02625d42020-06-25 14:41:41 -0700482static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700483DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700484{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700485 return pMe->pCurrentBounded->u.bs.uSavedEndOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700486}
487
488
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800489
490
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800491#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800492/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800493 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
494
495 The following four functions are pretty wrappers for invocation of
496 the string allocator supplied by the caller.
497
Laurence Lundbladeee851742020-01-08 08:37:05 -0800498 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800499
Laurence Lundbladeee851742020-01-08 08:37:05 -0800500static inline void
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800501StringAllocator_Free(const QCBORInternalAllocator *pMe, const void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800502{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800503 /* These pragmas allow the "-Wcast-qual" warnings flag to be set for
504 * gcc and clang. This is the one place where the const needs to be
505 * cast away so const can be use in the rest of the code.
506 */
507#pragma GCC diagnostic push
508#pragma GCC diagnostic ignored "-Wcast-qual"
509 (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, 0);
510#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800511}
512
Laurence Lundbladeee851742020-01-08 08:37:05 -0800513// StringAllocator_Reallocate called with pMem NULL is
514// equal to StringAllocator_Allocate()
515static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800516StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800517 const void *pMem,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800518 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800519{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800520 /* See comment in StringAllocator_Free() */
521#pragma GCC diagnostic push
522#pragma GCC diagnostic ignored "-Wcast-qual"
523 return (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, uSize);
524#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800525}
526
Laurence Lundbladeee851742020-01-08 08:37:05 -0800527static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800528StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800529{
530 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
531}
532
Laurence Lundbladeee851742020-01-08 08:37:05 -0800533static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800534StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800535{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800536 /* See comment in StringAllocator_Free() */
537#pragma GCC diagnostic push
538#pragma GCC diagnostic ignored "-Wcast-qual"
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800539 if(pMe->pfAllocator) {
540 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
541 }
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800542#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800544#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800545
546
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800547
548
Laurence Lundbladeee851742020-01-08 08:37:05 -0800549/*===========================================================================
550 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700551
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800552 See qcbor/qcbor_decode.h for definition of the object
553 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800554 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700555/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800556 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700557 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800558void QCBORDecode_Init(QCBORDecodeContext *pMe,
559 UsefulBufC EncodedCBOR,
560 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700561{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800562 memset(pMe, 0, sizeof(QCBORDecodeContext));
563 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
564 /* Don't bother with error check on decode mode. If a bad value is
565 * passed it will just act as if the default normal mode of 0 was set.
566 */
567 pMe->uDecodeMode = (uint8_t)nDecodeMode;
568 DecodeNesting_Init(&(pMe->nesting));
569
570 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
571 * GetNext_TaggedItem() and MapTagNumber(). */
572 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700573}
574
575
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800576#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
577
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800579 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700580 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800581void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
582 QCBORStringAllocate pfAllocateFunction,
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800583 void *pAllocateContext,
584 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700585{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800586 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
587 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
588 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700589}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800590#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700591
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800592
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800593
594
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800595/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800596 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800597 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800598void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800599 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700600{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800601 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700602 (void)pMe;
603 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700604}
605
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700606
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800607
608
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700609/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800610 * Decoding items is done in six layers, one calling the next one
611 * down. If a layer has no work to do for a particular item, it
612 * returns quickly.
613 *
614 * 1. QCBORDecode_GetNextTagContent - The top layer processes tagged
615 * data items, turning them into the local C representation. For the
616 * most simple it is just associating a QCBOR_TYPE with the data. For
617 * the complex ones that an aggregate of data items, there is some
618 * further decoding and some limited recursion.
619 *
620 * 2. QCBORDecode_GetNextMapOrArray - This manages the beginnings and
621 * ends of maps and arrays. It tracks descending into and ascending
622 * out of maps/arrays. It processes breaks that terminate
623 * indefinite-length maps and arrays.
624 *
625 * 3. QCBORDecode_GetNextMapEntry - This handles the combining of two
626 * items, the label and the data, that make up a map entry. It only
627 * does work on maps. It combines the label and data items into one
628 * labeled item.
629 *
630 * 4. QCBORDecode_GetNextTagNumber - This decodes type 6 tag
631 * numbers. It turns the tag numbers into bit flags associated with
632 * the data item. No actual decoding of the contents of the tag is
633 * performed here.
634 *
635 * 5. QCBORDecode_GetNextFullString - This assembles the sub-items
636 * that make up an indefinite-length string into one string item. It
637 * uses the string allocator to create contiguous space for the
638 * item. It processes all breaks that are part of indefinite-length
639 * strings.
640 *
641 * 6. DecodeAtomicDataItem - This decodes the atomic data items in
642 * CBOR. Each atomic data item has a "major type", an integer
643 * "argument" and optionally some content. For text and byte strings,
644 * the content is the bytes that make up the string. These are the
645 * smallest data items that are considered to be well-formed. The
646 * content may also be other data items in the case of aggregate
647 * types. They are not handled in this layer.
648 *
649 * Roughly this takes 300 bytes of stack for vars. TODO: evaluate this
650 * more carefully and correctly.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700651 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800652
653
654/*
655 * Note about use of int and unsigned variables.
656 *
657 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
658 * used carefully here, and in particular why it isn't used in the
659 * public interface. Also see
660 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
661 *
662 * Int is used for values that need less than 16-bits and would be
663 * subject to integer promotion and result in complaining from static
664 * analyzers.
665 */
666
667
668/**
669 * @brief Decode the CBOR head, the type and argument.
670 *
671 * @param[in] pUInBuf The input buffer to read from.
672 * @param[out] pnMajorType The decoded major type.
673 * @param[out] puArgument The decoded argument.
674 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
675 *
676 * @retval QCBOR_ERR_UNSUPPORTED
677 * @retval QCBOR_ERR_HIT_END
678 *
679 * This decodes the CBOR "head" that every CBOR data item has. See
680 * longer explaination of the head in documentation for
681 * QCBOREncode_EncodeHead().
682 *
683 * This does the network->host byte order conversion. The conversion
684 * here also results in the conversion for floats in addition to that
685 * for lengths, tags and integer values.
686 *
687 * The int type is preferred to uint8_t for some variables as this
688 * avoids integer promotions, can reduce code size and makes static
689 * analyzers happier.
690 */
691static inline QCBORError
692DecodeHead(UsefulInputBuf *pUInBuf,
693 int *pnMajorType,
694 uint64_t *puArgument,
695 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700696{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800697 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800698
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800699 /* Get the initial byte that every CBOR data item has and break it
700 * down. */
701 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800702 const int nTmpMajorType = nInitialByte >> 5;
703 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800704
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800705 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800706 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800707
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800708 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800709 /* Need to get 1,2,4 or 8 additional argument bytes. Map
710 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
711 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800712 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800713
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800714 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800715 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800716 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800717 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800718 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
719 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800720 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800721 /* The reserved and thus-far unused additional info values */
722 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800723 goto Done;
724 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800725 /* Less than 24, additional info is argument or 31, an
726 * indefinite-length. No more bytes to get.
727 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800728 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700729 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800730
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700731 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800732 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700733 goto Done;
734 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800735
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800736 /* All successful if arrived here. */
737 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800738 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800739 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800740 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800741
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800743 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700744}
745
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800746
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800747/**
748 * @brief Decode integer types, major types 0 and 1.
749 *
750 * @param[in] nMajorType The CBOR major type (0 or 1).
751 * @param[in] uArgument The argument from the head.
752 * @param[out] pDecodedItem The filled in decoded item.
753 *
754 * @retval QCBOR_ERR_INT_OVERFLOW
755 *
756 * Must only be called when major type is 0 or 1.
757 *
758 * CBOR doesn't explicitly specify two's compliment for integers but
759 * all CPUs use it these days and the test vectors in the RFC are
760 * so. All integers in the CBOR structure are positive and the major
761 * type indicates positive or negative. CBOR can express positive
762 * integers up to 2^x - 1 where x is the number of bits and negative
763 * integers down to 2^x. Note that negative numbers can be one more
764 * away from zero than positive. Stdint, as far as I can tell, uses
765 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700766 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700767static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800768DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700769{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800770 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800771
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700772 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800773 if (uArgument <= INT64_MAX) {
774 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700775 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800776
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700777 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800778 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700779 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700780 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800781
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700782 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800783 if(uArgument <= INT64_MAX) {
784 /* CBOR's representation of negative numbers lines up with
785 * the two-compliment representation. A negative integer has
786 * one more in range than a positive integer. INT64_MIN is
787 * equal to (-INT64_MAX) - 1.
788 */
789 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700790 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800791
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700792 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800793 /* C can't represent a negative integer in this range so it
794 * is an error.
795 */
796 uReturn = QCBOR_ERR_INT_OVERFLOW;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700797 }
798 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800799
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800800 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700801}
802
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800803
804/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700805#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
806#error QCBOR_TYPE_FALSE macro value wrong
807#endif
808
809#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
810#error QCBOR_TYPE_TRUE macro value wrong
811#endif
812
813#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
814#error QCBOR_TYPE_NULL macro value wrong
815#endif
816
817#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
818#error QCBOR_TYPE_UNDEF macro value wrong
819#endif
820
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700821#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
822#error QCBOR_TYPE_BREAK macro value wrong
823#endif
824
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700825#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
826#error QCBOR_TYPE_DOUBLE macro value wrong
827#endif
828
829#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
830#error QCBOR_TYPE_FLOAT macro value wrong
831#endif
832
Laurence Lundblade9b334962020-08-27 10:55:53 -0700833
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800834/**
835 * @brief Decode major type 7 -- true, false, floating-point, break...
836 *
837 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
838 * @param[in] uArgument The argument from the head.
839 * @param[out] pDecodedItem The filled in decoded item.
840 *
841 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
842 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700843 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800844
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800845static inline QCBORError
846DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
847{
848 QCBORError uReturn = QCBOR_SUCCESS;
849
850 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
851 * checks above make sure uAdditionalInfo values line up with
852 * uDataType values. DecodeHead() never returns an AdditionalInfo
853 * > 0x1f so cast is safe.
854 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800855 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800856
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800857 switch(nAdditionalInfo) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800858 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
859 * are caught before this is called.
860 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800861
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800862 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700863#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800864 /* Half-precision is returned as a double. The cast to
865 * uint16_t is safe because the encoded value was 16 bits. It
866 * was widened to 64 bits to be passed in here.
867 */
868 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700869 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800870#else /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800871 uReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800872#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700873 break;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800874 case SINGLE_PREC_FLOAT: /* 26 */
875 /* Single precision is normally returned as a double since
876 * double is widely supported, there is no loss of precision,
877 * it makes it easy for the caller in most cases and it can
878 * be converted back to single with no loss of precision
879 *
880 * The cast to uint32_t is safe because the encoded value was
881 * 32 bits. It was widened to 64 bits to be passed in here.
882 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700883 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800884 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700885#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800886 /* In the normal case, use HW to convert float to
887 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700888 pDecodedItem->val.dfnum = (double)f;
889 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800890#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800891 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700892 pDecodedItem->val.fnum = f;
893 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
894
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800895 /* IEEE754_FloatToDouble() could be used here to return as
896 * a double, but it adds object code and most likely
897 * anyone disabling FLOAT HW use doesn't care about floats
898 * and wants to save object code.
899 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800900#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700901 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700902 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700903
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800904 case DOUBLE_PREC_FLOAT: /* 27 */
905 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700906 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700907 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800908
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800909 case CBOR_SIMPLEV_FALSE: /* 20 */
910 case CBOR_SIMPLEV_TRUE: /* 21 */
911 case CBOR_SIMPLEV_NULL: /* 22 */
912 case CBOR_SIMPLEV_UNDEF: /* 23 */
913 case CBOR_SIMPLE_BREAK: /* 31 */
914 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800915
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800916 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
917 if(uArgument <= CBOR_SIMPLE_BREAK) {
918 /* This takes out f8 00 ... f8 1f which should be encoded
919 * as e0 … f7
920 */
921 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700922 goto Done;
923 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800924 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800925
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800926 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700927 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800928 /* DecodeHead() will make uArgument equal to
929 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
930 * safe because the 2, 4 and 8 byte lengths of uNumber are in
931 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -0800932 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800933 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700934 break;
935 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800936
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700937Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800938 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700939}
940
941
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800942/**
943 * @brief Decode text and byte strings
944 *
945 * @param[in] pAllocator The string allocator or NULL.
946 * @param[in] uStrLen The length of the string.
947 * @param[in] pUInBuf The surce from which to read the string's bytes.
948 * @param[out] pDecodedItem The filled in decoded item.
949 *
950 * @retval QCBOR_ERR_HIT_END
951 * @retval QCBOR_ERR_STRING_ALLOCATE
952 * @retval QCBOR_ERR_STRING_TOO_LONG
953 *
954 * The reads @c uStrlen bytes from @c pUInBuf and fills in @c
955 * pDecodedItem. If @c pAllocator is not NULL then memory for the
956 * string is allocated.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700957 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800958static inline QCBORError
959DecodeBytes(const QCBORInternalAllocator *pAllocator,
960 uint64_t uStrLen,
961 UsefulInputBuf *pUInBuf,
962 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700963{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800964 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800965
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800966 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
967 * CPUs. This check makes the casts to size_t below safe.
968 *
969 * The max is 4 bytes less than the largest sizeof() so this can be
970 * tested by putting a SIZE_MAX length in the CBOR test input (no
971 * one will care the limit on strings is 4 bytes shorter).
972 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800973 if(uStrLen > SIZE_MAX-4) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800974 uReturn = QCBOR_ERR_STRING_TOO_LONG;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800975 goto Done;
976 }
977
978 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530979 if(UsefulBuf_IsNULLC(Bytes)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800980 /* Failed to get the bytes for this string item */
981 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530982 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700983 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530984
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800985#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800986 /* Note that this is not where allocation to coalesce
987 * indefinite-length strings is done. This is for when the caller
988 * has requested all strings be allocated. Disabling indefinite
989 * length strings also disables this allocate-all option.
990 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800991 if(pAllocator) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800992 /* request to use the string allocator to make a copy */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800993 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530994 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800995 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530996 goto Done;
997 }
998 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800999 pDecodedItem->uDataAlloc = 1;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001000 goto Done;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301001 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001002#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1003 (void)pAllocator;
1004#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1005
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001006 /* Normal case with no string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001007 pDecodedItem->val.string = Bytes;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001008
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301009Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001010 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001011}
1012
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001013
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001014/**
1015 * @brief Map the CBOR major types for strings to the QCBOR types.
1016 *
1017 * @param[in] nCBORMajorType The CBOR major type to convert.
1018 * @retturns QCBOR type number.
1019 *
1020 * This only works for the two string types.
1021 */
1022static inline uint8_t ConvertStringMajorTypes(int nCBORMajorType)
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001023{
1024 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
1025 #error QCBOR_TYPE_BYTE_STRING no lined up with major type
1026 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001027
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001028 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
1029 #error QCBOR_TYPE_TEXT_STRING no lined up with major type
1030 #endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001031
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001032 return (uint8_t)(nCBORMajorType + 4);
1033}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001034
1035
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001036/**
1037 * @brief Map the CBOR major types for arrays/maps to the QCBOR types.
1038 *
1039 * @param[in] nCBORMajorType The CBOR major type to convert.
1040 * @retturns QCBOR type number.
1041 *
1042 * This only works for the two aggregate types.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001043 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001044static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001045{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001046 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1047 #error QCBOR_TYPE_ARRAY value not lined up with major type
1048 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001049
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001050 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1051 #error QCBOR_TYPE_MAP value not lined up with major type
1052 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001053
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001054 return (uint8_t)(nCBORMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001055}
1056
1057
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001058/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001059 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001060 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001061 * @param[in] pUInBuf Input buffer to read data item from.
1062 * @param[out] pDecodedItem The filled-in decoded item.
1063 * @param[in] pAllocator The allocator to use for strings or NULL.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001064 *
1065 * @retval QCBOR_ERR_UNSUPPORTED
1066 * @retval QCBOR_ERR_HIT_END
1067 * @retval QCBOR_ERR_INT_OVERFLOW
1068 * @retval QCBOR_ERR_STRING_ALLOCATE
1069 * @retval QCBOR_ERR_STRING_TOO_LONG
1070 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1071 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001072 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1073 *
1074 * This decodes the most primitive / atomic data item. It does
1075 * no combing of data items.
1076 */
1077static QCBORError
1078DecodeAtomicDataItem(UsefulInputBuf *pUInBuf,
1079 QCBORItem *pDecodedItem,
1080 const QCBORInternalAllocator *pAllocator)
1081{
1082 QCBORError uReturn;
1083
1084 /* Get the major type and the argument. The argument could be
1085 * length of more bytes or the value depending on the major
1086 * type. nAdditionalInfo is an encoding of the length of the
1087 * uNumber and is needed to decode floats and doubles.
1088 */
1089 int nMajorType = 0;
1090 uint64_t uArgument = 0;
1091 int nAdditionalInfo = 0;
1092
1093 memset(pDecodedItem, 0, sizeof(QCBORItem));
1094
1095 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1096 if(uReturn) {
1097 goto Done;
1098 }
1099
1100 /* At this point the major type and the argument are valid. We've
1101 * got the type and the argument that starts every CBOR data item.
1102 */
1103 switch (nMajorType) {
1104 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1105 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
1106 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1107 uReturn = QCBOR_ERR_BAD_INT;
1108 } else {
1109 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
1110 }
1111 break;
1112
1113 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1114 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1115 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
1116 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1117 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
1118 } else {
1119 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
1120 }
1121 break;
1122
1123 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1124 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
1125 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1126 /* Indefinite-length string. */
1127#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1128 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1129#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1130 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1131 break;
1132#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1133 } else {
1134 /* Definite-length string. */
1135 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1136 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1137 goto Done;
1138 }
1139 /* cast OK because of check above */
1140 pDecodedItem->val.uCount = (uint16_t)uArgument;
1141 }
1142 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
1143 break;
1144
1145 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
1146 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1147 uReturn = QCBOR_ERR_BAD_INT;
1148 } else {
1149 pDecodedItem->val.uTagV = uArgument;
1150 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1151 }
1152 break;
1153
1154 case CBOR_MAJOR_TYPE_SIMPLE:
1155 /* Major type 7: float, double, true, false, null... */
1156 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
1157 break;
1158
1159 default:
1160 /* Never happens because DecodeHead() should never return > 7 */
1161 uReturn = QCBOR_ERR_UNSUPPORTED;
1162 break;
1163 }
1164
1165Done:
1166 return uReturn;
1167}
1168
1169
1170/**
1171 * @brief Process indefinite-length strings (decode layer 5).
1172 *
1173 * @param[in] pMe Decoder context
1174 * @param[out] pDecodedItem The decoded item that work is done on.
1175 *
1176 * @retval QCBOR_ERR_UNSUPPORTED
1177 * @retval QCBOR_ERR_HIT_END
1178 * @retval QCBOR_ERR_INT_OVERFLOW
1179 * @retval QCBOR_ERR_STRING_ALLOCATE
1180 * @retval QCBOR_ERR_STRING_TOO_LONG
1181 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1182 * @retval QCBOR_ERR_BAD_TYPE_7
1183 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001184 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1185 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001186 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001187 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001188 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001189 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001190 * If it is, this loops getting the subsequent chunk data items that
1191 * make up the string. The string allocator is used to make a
1192 * contiguous buffer for the chunks. When this completes @c
1193 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001194 *
1195 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001196 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001197static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001198QCBORDecode_GetNextFullString(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001199{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001200 /* Aproximate stack usage
1201 * 64-bit 32-bit
1202 * local vars 32 16
1203 * 2 UsefulBufs 32 16
1204 * QCBORItem 56 52
1205 * TOTAL 120 74
1206 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001207
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001208 /* The string allocator is used here for two purposes: 1)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001209 * coalescing the chunks of an indefinite-length string, 2)
1210 * allocating storage for every string returned when requested.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001211 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001212 * The first use is below in this function. Indefinite-length
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001213 * strings cannot be processed at all without a string allocator.
1214 *
1215 * The second used is in DecodeBytes() which is called by
1216 * GetNext_Item() below. This second use unneccessary for most use
1217 * and only happens when requested in the call to
1218 * QCBORDecode_SetMemPool(). If the second use not requested then
1219 * NULL is passed for the string allocator to GetNext_Item().
1220 *
1221 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1222 * allocator altogether and thus both of these uses. It reduced the
1223 * decoder object code by about 400 bytes.
1224 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001225 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001226
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001227#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001228 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001229
1230 if(pMe->StringAllocator.pfAllocator) {
1231 pAllocator = &(pMe->StringAllocator);
1232 if(pMe->bStringAllocateAll) {
1233 pAllocatorForGetNext = pAllocator;
1234 }
1235 }
1236#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1237
1238 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001239 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001240 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001241 goto Done;
1242 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001243
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001244 /* Only do indefinite-length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001245 const uint8_t uStringType = pDecodedItem->uDataType;
1246 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001247 goto Done;
1248 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001249
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001250 /* Is this a string with an indefinite length? */
1251 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1252 goto Done;
1253 }
1254
1255#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001256 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001257 if(pAllocator == NULL) {
1258 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1259 goto Done;
1260 }
1261
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001262 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001263 UsefulBufC FullString = NULLUsefulBufC;
1264
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001265 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001266 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001267 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001268 /* Pass a NULL string allocator to GetNext_Item() because the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001269 * individual string chunks in an indefinite-length should not
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001270 * be allocated. They are always copied in the the contiguous
1271 * buffer allocated here.
1272 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001273 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), &StringChunkItem, NULL);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001274 if(uReturn) {
1275 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001276 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001277
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001278 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001279 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001280 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001281 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301282 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001283 break;
1284 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001285
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001286 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001287 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001288 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001289 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001290 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001291 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001292 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1293 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001294 break;
1295 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001296
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001297 /* The first time throurgh FullString.ptr is NULL and this is
1298 * equivalent to StringAllocator_Allocate(). Subsequently it is
1299 * not NULL and a reallocation happens.
1300 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001301 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001302 FullString.ptr,
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001303 FullString.len + StringChunkItem.val.string.len);
1304
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001305 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001306 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001307 break;
1308 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001309
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001310 /* Copy new string chunk to the end of accumulated string */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001311 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001312 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001313
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001314 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1315 /* Getting the item failed, clean up the allocated memory */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001316 StringAllocator_Free(pAllocator, FullString.ptr);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001317 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001318#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1319 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1320#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001321
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001322Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001323 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001324}
1325
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001326
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001327/**
1328 * @brief This converts a tag number to a shorter mapped value for storage.
1329 *
1330 * @param[in] pMe The decode context.
1331 * @param[in] uUnMappedTag The tag number to map
1332 * @param[out] puMappedTagNumer The stored tag number.
1333 *
1334 * @return error code.
1335 *
1336 * The main point of mapping tag numbers is make QCBORItem
1337 * smaller. With this mapping storage of 4 tags takes up 8
1338 * bytes. Without, it would take up 32 bytes.
1339 *
1340 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1341 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1342 *
1343 * See also UnMapTagNumber() and @ref QCBORItem.
1344 */
1345static inline QCBORError
1346MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1347{
1348 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1349 unsigned uTagMapIndex;
1350 /* Is there room in the tag map, or is it in it already? */
1351 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1352 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1353 break;
1354 }
1355 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1356 break;
1357 }
1358 }
1359 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1360 return QCBOR_ERR_TOO_MANY_TAGS;
1361 }
1362
1363 /* Covers the cases where tag is new and were it is already in the map */
1364 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1365 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1366
1367 } else {
1368 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1369 }
1370
1371 return QCBOR_SUCCESS;
1372}
1373
1374
1375/**
1376 * @brief This converts a mapped tag number to the actual tag number.
1377 *
1378 * @param[in] pMe The decode context.
1379 * @param[in] uMappedTagNumber The stored tag number.
1380 *
1381 * @return The actual tag number is returned or
1382 * @ref CBOR_TAG_INVALID64 on error.
1383 *
1384 * This is the reverse of MapTagNumber()
1385 */
1386static uint64_t
1387UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1388{
1389 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1390 return uMappedTagNumber;
1391 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001392 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001393 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001394 /* This won't be negative because of code below in
1395 * MapTagNumber()
1396 */
1397 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1398 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001399 }
1400}
1401
Laurence Lundblade9b334962020-08-27 10:55:53 -07001402
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001403/**
1404 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1405 *
1406 * @param[in] pMe Decoder context
1407 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001409 * @retval QCBOR_ERR_UNSUPPORTED
1410 * @retval QCBOR_ERR_HIT_END
1411 * @retval QCBOR_ERR_INT_OVERFLOW
1412 * @retval QCBOR_ERR_STRING_ALLOCATE
1413 * @retval QCBOR_ERR_STRING_TOO_LONG
1414 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1415 * @retval QCBOR_ERR_BAD_TYPE_7
1416 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1417 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1418 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1419 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1420 * @retval QCBOR_ERR_TOO_MANY_TAGS
1421 *
1422 * This loops getting atomic data items until one is not a tag
1423 * number. Usually this is largely pass-through because most
1424 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001425 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001426static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001427QCBORDecode_GetNextTagNumber(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001428{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001429 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1430
1431 /* Initialize to CBOR_TAG_INVALID16 */
1432 #if CBOR_TAG_INVALID16 != 0xffff
1433 /* Be sure the memset does the right thing. */
1434 #err CBOR_TAG_INVALID16 tag not defined as expected
1435 #endif
1436 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001437
Laurence Lundblade9b334962020-08-27 10:55:53 -07001438 QCBORError uReturn = QCBOR_SUCCESS;
1439
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001440 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001441 for(;;) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001442 QCBORError uErr = QCBORDecode_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001443 if(uErr != QCBOR_SUCCESS) {
1444 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001445 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001446 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001447
Laurence Lundblade9b334962020-08-27 10:55:53 -07001448 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001449 /* Successful exit from loop; maybe got some tags, maybe not */
1450 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001451 break;
1452 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001453
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001454 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1455 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001456 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001457 /* Continue on to get all tags wrapping this item even though
1458 * it is erroring out in the end. This allows decoding to
1459 * continue. This is a resource limit error, not a problem
1460 * with being well-formed CBOR.
1461 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001462 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001463 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001464 /* Slide tags over one in the array to make room at index 0.
1465 * Must use memmove because the move source and destination
1466 * overlap.
1467 */
1468 memmove(&auItemsTags[1], auItemsTags, sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001469
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001470 /* Map the tag */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001471 uint16_t uMappedTagNumer = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001472 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumer);
1473 /* Continue even on error so as to consume all tags wrapping
1474 * this data item so decoding can go on. If MapTagNumber()
1475 * errors once it will continue to error.
1476 */
1477 auItemsTags[0] = uMappedTagNumer;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001478 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001479
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001480Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001481 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001482}
1483
1484
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001485/**
1486 * @brief Combine a map entry label and value into one item (decode layer 3).
1487 *
1488 * @param[in] pMe Decoder context
1489 * @param[out] pDecodedItem The decoded item that work is done on.
1490 *
1491 * @retval QCBOR_ERR_UNSUPPORTED
1492 * @retval QCBOR_ERR_HIT_END
1493 * @retval QCBOR_ERR_INT_OVERFLOW
1494 * @retval QCBOR_ERR_STRING_ALLOCATE
1495 * @retval QCBOR_ERR_STRING_TOO_LONG
1496 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1497 * @retval QCBOR_ERR_BAD_TYPE_7
1498 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1499 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1500 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1501 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1502 * @retval QCBOR_ERR_TOO_MANY_TAGS
1503 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1504 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1505 *
1506 * If a the current nesting level is a map, then this
1507 * combines pairs of items into one data item with a label
1508 * and value.
1509 *
1510 * This is pass-through if the current nesting leve is
1511 * not a map.
1512 *
1513 * This also implements maps-as-array mode where a map
1514 * is treated like an array to allow caller to do their
1515 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001516 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001517static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001518QCBORDecode_GetNextMapEntry(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001519{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001520 QCBORError uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1521 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001522 goto Done;
1523 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001524
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001525 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1526 /* Break can't be a map entry */
1527 goto Done;
1528 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001529
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001530 if(pMe->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1531 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001532
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001533 if(DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1534 /* Save label in pDecodedItem and get the next which will
1535 * be the real data item.
1536 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001537 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001538 uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1539 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001540 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001541 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001542
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301543 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001544
1545 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001546 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001547 pDecodedItem->label.string = LabelItem.val.string;
1548 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001549 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == pMe->uDecodeMode) {
1550 /* It's not a string and we only want strings */
1551 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001552 goto Done;
1553 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1554 pDecodedItem->label.int64 = LabelItem.val.int64;
1555 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1556 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1557 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1558 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1559 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1560 pDecodedItem->label.string = LabelItem.val.string;
1561 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1562 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1563 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001564 /* label is not an int or a string. It is an arrray
1565 * or a float or such and this implementation doesn't handle that.
1566 * Also, tags on labels are ignored.
1567 */
1568 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001569 goto Done;
1570 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001571 }
1572 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001573 /* Decoding of maps as arrays to let the caller decide what to do
1574 * about labels, particularly lables that are not integers or
1575 * strings.
1576 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001577 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001578 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001579 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001580 goto Done;
1581 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001582 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001583 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1584 * Cast is needed because of integer promotion.
1585 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001586 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001587 }
1588 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001589
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001590Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001591 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001592}
1593
1594
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001595#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001596/**
1597 * @brief Peek and see if next data item is a break;
1598 *
1599 * @param[in] pUIB UsefulInputBuf to read from.
1600 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1601 *
1602 * @return Any decoding error.
1603 *
1604 * See if next item is a CBOR break. If it is, it is consumed,
1605 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001606*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001607static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001608NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1609{
1610 *pbNextIsBreak = false;
1611 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001612 QCBORItem Peek;
1613 size_t uPeek = UsefulInputBuf_Tell(pUIB);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001614 QCBORError uReturn = DecodeAtomicDataItem(pUIB, &Peek, NULL);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001615 if(uReturn != QCBOR_SUCCESS) {
1616 return uReturn;
1617 }
1618 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001619 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001620 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001621 } else {
1622 *pbNextIsBreak = true;
1623 }
1624 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001625
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001626 return QCBOR_SUCCESS;
1627}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001628#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001629
1630
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001631/**
1632 * @brief Ascend up nesting levels if all items in them have been consumed.
1633 *
1634 * @param[in] pMe The decode context.
1635 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1636 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001637 * An item was just consumed, now figure out if it was the
1638 * end of an array/map map that can be closed out. That
1639 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001640*/
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001641static QCBORError
1642QCBORDecode_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001643{
1644 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001645
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001646 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001647 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1648
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001649 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1650 /* Nesting level is bstr-wrapped CBOR */
1651
1652 /* Ascent for bstr-wrapped CBOR is always by explicit call
1653 * so no further ascending can happen.
1654 */
1655 break;
1656
1657 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1658 /* Level is a definite-length array/map */
1659
1660 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001661 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1662 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001663 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001664 break;
1665 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001666 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001667 * is time to ascend one level. This happens below.
1668 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001669
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001670#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001671 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001672 /* Level is an indefinite-length array/map. */
1673
1674 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001675 bool bIsBreak = false;
1676 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1677 if(uReturn != QCBOR_SUCCESS) {
1678 goto Done;
1679 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001680
1681 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001682 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001683 break;
1684 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001685
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001686 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001687 * it is time to ascend one level.
1688 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001689
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001690#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001691 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001692
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001693
1694 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001695
Laurence Lundblade93d89472020-10-03 22:30:50 -07001696 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001697 * QCBORDecode_ExitBoundedMode().
1698 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001699 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001700 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001701 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001702 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001703 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001704 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001705
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001706 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001707 break;
1708 }
1709
1710 /* Finally, actually ascend one level. */
1711 DecodeNesting_Ascend(&(pMe->nesting));
1712 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001713
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001714 uReturn = QCBOR_SUCCESS;
1715
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001716#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001717Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001718#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1719
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001720 return uReturn;
1721}
1722
1723
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001724/**
1725 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1726 *
1727 * @param[in] pMe Decoder context
1728 * @param[out] pDecodedItem The decoded item that work is done on.
1729 *
1730 * @retval QCBOR_ERR_UNSUPPORTED
1731 * @retval QCBOR_ERR_HIT_END
1732 * @retval QCBOR_ERR_INT_OVERFLOW
1733 * @retval QCBOR_ERR_STRING_ALLOCATE
1734 * @retval QCBOR_ERR_STRING_TOO_LONG
1735 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1736 * @retval QCBOR_ERR_BAD_TYPE_7
1737 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1738 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1739 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1740 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1741 * @retval QCBOR_ERR_TOO_MANY_TAGS
1742 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1743 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1744 * @retval QCBOR_ERR_NO_MORE_ITEMS
1745 * @retval QCBOR_ERR_BAD_BREAK
1746 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
1747 *
1748 * This handles the traversal descending into and asecnding out of
1749 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
1750 * definite- and indefinte-length maps and arrays by looking at the
1751 * item count or finding CBOR breaks. It detects the ends of the
1752 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001753 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001754static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001755QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001756{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001757 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001758 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001759
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001760 /* If out of bytes to consume, it is either the end of the
1761 * top-level sequence of some bstr-wrapped CBOR that was entered.
1762 *
1763 * In the case of bstr-wrapped CBOR, the length of the
1764 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
1765 * the bstr-wrapped CBOR is exited, the length is set back to the
1766 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001767 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001768 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001769 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001770 goto Done;
1771 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001772
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001773 /* Check to see if at the end of a bounded definite-length map or
1774 * array. The check for a break ending indefinite-length array is
1775 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001776 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001777 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001778 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001779 goto Done;
1780 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001781
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001782 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001783 uReturn = QCBORDecode_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001784 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1785 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001786 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001787 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301788
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001789 /* Breaks ending arrays/maps are processed later in the call to
1790 * QCBORDecode_NestLevelAscender(). They should never show up here.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001791 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301792 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001793 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301794 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301795 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001796
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001797 /* Record the nesting level for this data item before processing
1798 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001799 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001800 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001801
Laurence Lundblade642282a2020-06-23 12:00:33 -07001802
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001803 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001804 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001805 /* If the new item is a map or array, descend.
1806 *
1807 * Empty indefinite-length maps and arrays are descended into,
1808 * but then ascended out of in the next chunk of code.
1809 *
1810 * Maps and arrays do count as items in the map/array that
1811 * encloses them so a decrement needs to be done for them too,
1812 * but that is done only when all the items in them have been
1813 * processed, not when they are opened with the exception of an
1814 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001815 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001816 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001817 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001818 pDecodedItem->uDataType,
1819 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001820 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001821 /* This error is probably a traversal error and it overrides
1822 * the non-traversal error.
1823 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001824 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001825 goto Done;
1826 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001827 }
1828
Laurence Lundblade02625d42020-06-25 14:41:41 -07001829 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1830 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1831 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001832 /* The following cases are handled here:
1833 * - A non-aggregate item like an integer or string
1834 * - An empty definite-length map or array
1835 * - An indefinite-length map or array that might be empty or might not.
1836 *
1837 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
1838 * for an definite-length map/array and break detection for an
1839 * indefinite-0length map/array. If the end of the map/array was
1840 * reached, then it ascends nesting levels, possibly all the way
1841 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001842 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001843 QCBORError uAscendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001844 uAscendErr = QCBORDecode_NestLevelAscender(pMe, true);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001845 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001846 /* This error is probably a traversal error and it overrides
1847 * the non-traversal error.
1848 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001849 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001850 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001851 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301852 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001853
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001854 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001855 /* Tell the caller what level is next. This tells them what
1856 * maps/arrays were closed out and makes it possible for them to
1857 * reconstruct the tree with just the information returned in a
1858 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001859 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001860 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001861 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001862 pDecodedItem->uNextNestLevel = 0;
1863 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001864 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001865 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001866
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001867Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001868 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001869}
1870
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001871
1872/**
1873 * @brief Shift 0th tag out of the tag list.
1874 *
1875 * pDecodedItem[in,out] The data item to convert.
1876 *
1877 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
1878 * shifted into empty slot at the end of the tag list.
1879 */
1880static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001881{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001882 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
1883 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
1884 }
1885 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001886}
1887
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001888
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001889/**
1890 * @brief Convert different epoch date formats in to the QCBOR epoch date format
1891 *
1892 * pDecodedItem[in,out] The data item to convert.
1893 *
1894 * @retval QCBOR_ERR_DATE_OVERFLOW
1895 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1896 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1897 *
1898 * The epoch date tag defined in QCBOR allows for floating-point
1899 * dates. It even allows a protocol to flop between date formats when
1900 * ever it wants. Floating-point dates aren't that useful as they are
1901 * only needed for dates beyond the age of the earth.
1902 *
1903 * This converts all the date formats into one format of an unsigned
1904 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001905 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001906static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001907{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001908 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001909
1910 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1911
1912 switch (pDecodedItem->uDataType) {
1913
1914 case QCBOR_TYPE_INT64:
1915 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1916 break;
1917
1918 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001919 /* This only happens for CBOR type 0 > INT64_MAX so it is
1920 * always an overflow.
1921 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001922 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1923 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001924 break;
1925
1926 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001927 case QCBOR_TYPE_FLOAT:
1928#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001929 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001930 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001931 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001932 pDecodedItem->val.dfnum :
1933 (double)pDecodedItem->val.fnum;
1934
1935 /* The conversion from float to integer requires overflow
1936 * detection since floats can be much larger than integers.
1937 * This implementation errors out on these large float values
1938 * since they are beyond the age of the earth.
1939 *
1940 * These constants for the overflow check are computed by the
1941 * compiler. They are not computed at run time.
1942 *
1943 * The factor of 0x7ff is added/subtracted to avoid a
1944 * rounding error in the wrong direction when the compiler
1945 * computes these constants. There is rounding because an
1946 * 64-bit integer has 63 bits of precision where a double
1947 * only has 53 bits. Without the 0x7ff factor, the compiler
1948 * may round up and produce a double for the bounds check
1949 * that is larger than can be stored in a 64-bit integer. The
1950 * amount of 0x7ff is picked because it has 11 bits set.
1951 *
1952 * Without the 0x7ff there is a ~30 minute range of time
1953 * values 10 billion years in the past and in the future
1954 * where this code could go wrong. Some compilers correctly
1955 * generate a warning or error without the 0x7ff.
1956 */
1957 const double dDateMax = (double)(INT64_MAX - 0x7ff);
1958 const double dDateMin = (double)(INT64_MIN + 0x7ff);
1959
1960 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07001961 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001962 goto Done;
1963 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001964
1965 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001966 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001967 pDecodedItem->val.epochDate.fSecondsFraction =
1968 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001969 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001970#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07001971
Laurence Lundbladec7114722020-08-13 05:11:40 -07001972 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001973 goto Done;
1974
Laurence Lundblade9682a532020-06-06 18:33:04 -07001975#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001976 break;
1977
1978 default:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001979 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001980 goto Done;
1981 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001982
Laurence Lundblade59289e52019-12-30 13:44:37 -08001983 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1984
1985Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001986 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001987}
1988
1989
Laurence Lundblade46d63e92021-05-13 11:37:10 -07001990/**
1991 * @brief Convert the days epoch date.
1992 *
1993 * pDecodedItem[in,out] The data item to convert.
1994 *
1995 * @retval QCBOR_ERR_DATE_OVERFLOW
1996 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1997 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1998 *
1999 * This is much simpler than the other epoch date format because
2000 * floating-porint is not allowed. This is mostly a simple type check.
2001 */
2002static QCBORError DecodeDaysEpoch(QCBORItem *pDecodedItem)
2003{
2004 QCBORError uReturn = QCBOR_SUCCESS;
2005
2006 switch (pDecodedItem->uDataType) {
2007
2008 case QCBOR_TYPE_INT64:
2009 pDecodedItem->val.epochDays = pDecodedItem->val.int64;
2010 break;
2011
2012 case QCBOR_TYPE_UINT64:
2013 /* This only happens for CBOR type 0 > INT64_MAX so it is
2014 * always an overflow.
2015 */
2016 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2017 goto Done;
2018 break;
2019
2020 default:
2021 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
2022 goto Done;
2023 break;
2024 }
2025
2026 pDecodedItem->uDataType = QCBOR_TYPE_DAYS_EPOCH;
2027
2028Done:
2029 return uReturn;
2030}
2031
2032
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002033#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002034/**
2035 * @brief Decode decimal fractions and big floats.
2036 *
2037 * @param[in] pMe The decode context.
2038 * @param[in,out] pDecodedItem On input the array data item that
2039 * holds the mantissa and exponent. On
2040 * output the decoded mantissa and
2041 * exponent.
2042 *
2043 * @returns Decoding errors from getting primitive data items or
2044 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2045 *
2046 * When called pDecodedItem must be the array that is tagged as a big
2047 * float or decimal fraction, the array that has the two members, the
2048 * exponent and mantissa.
2049 *
2050 * This will fetch and decode the exponent and mantissa and put the
2051 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002052 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002053static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002054QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002055{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002056 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002057
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002058 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002059 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002060 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002061 goto Done;
2062 }
2063
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002064 /* A check for pDecodedItem->val.uCount == 2 would work for
2065 * definite-length arrays, but not for indefnite. Instead remember
2066 * the nesting level the two integers must be at, which is one
2067 * deeper than that of the array.
2068 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002069 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2070
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002071 /* --- Which is it, decimal fraction or a bigfloat? --- */
2072 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002073 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2074
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002075 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002076 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002077 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2078 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002079 goto Done;
2080 }
2081 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002082 /* Array is empty or a map/array encountered when expecting an int */
2083 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002084 goto Done;
2085 }
2086 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002087 /* Data arriving as an unsigned int < INT64_MAX has been
2088 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2089 * also means that the only data arriving here of type
2090 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2091 * and thus an error that will get handled in the next else.
2092 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002093 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2094 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002095 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2096 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002097 goto Done;
2098 }
2099
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002100 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002101 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002102 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2103 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002104 goto Done;
2105 }
2106 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002107 /* Mantissa missing or map/array encountered when expecting number */
2108 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002109 goto Done;
2110 }
2111 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002112 /* Data arriving as an unsigned int < INT64_MAX has been
2113 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2114 * also means that the only data arriving here of type
2115 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2116 * and thus an error that will get handled in an else below.
2117 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002118 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002119 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2120 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002121 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002122 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002123 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002124 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2125 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2126 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002127 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002128 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2129 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002130 goto Done;
2131 }
2132
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002133 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002134 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002135 /* Extra items in the decimal fraction / big float */
2136 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002137 goto Done;
2138 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002139 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002140
2141Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002142 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002143}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002144#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002145
2146
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002147#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002148/**
2149 * @brief Decode the MIME type tag
2150 *
2151 * @param[in,out] pDecodedItem The item to decode.
2152 *
2153 * Handle the text and binary MIME type tags. Slightly too complicated
2154 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2155 * incorreclty text-only.
2156 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002157static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002158{
2159 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2160 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002161 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002162 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2163 } else {
2164 return QCBOR_ERR_BAD_OPT_TAG;
2165 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002166
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002167 return QCBOR_SUCCESS;
2168}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002169#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002170
2171
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002172/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002173 * Table of CBOR tags whose content is either a text string or a byte
2174 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2175 * of uQCBORtype indicates the content should be a byte string rather
2176 * than a text string
2177 */
2178struct StringTagMapEntry {
2179 uint16_t uTagNumber;
2180 uint8_t uQCBORtype;
2181};
2182
2183#define IS_BYTE_STRING_BIT 0x80
2184#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2185
2186static const struct StringTagMapEntry StringTagMap[] = {
2187 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002188 {CBOR_TAG_DAYS_STRING, QCBOR_TYPE_DAYS_STRING},
Laurence Lundblade99615302020-11-29 11:19:47 -08002189 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2190 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2191 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2192 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002193#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002194 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2195 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2196 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2197 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002198#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002199 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2200 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2201};
2202
2203
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002204/**
2205 * @brief Process standard CBOR tags whose content is a string
2206 *
2207 * @param[in] uTag The tag.
2208 * @param[in,out] pDecodedItem The data item.
2209 *
2210 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2211 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2212 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2213 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002214 * Process the CBOR tags that whose content is a byte string or a text
2215 * string and for which the string is just passed on to the caller.
2216 *
2217 * This maps the CBOR tag to the QCBOR type and checks the content
2218 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002219 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002220 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002221 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002222static inline QCBORError
2223ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002224{
Laurence Lundblade99615302020-11-29 11:19:47 -08002225 /* This only works on tags that were not mapped; no need for other yet */
2226 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2227 return QCBOR_ERR_UNSUPPORTED;
2228 }
2229
2230 unsigned uIndex;
2231 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2232 if(StringTagMap[uIndex].uTagNumber == uTag) {
2233 break;
2234 }
2235 }
2236
2237 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2238 if(uQCBORType == QCBOR_TYPE_NONE) {
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002239 /* repurpose this error to mean not handled here */
Laurence Lundblade99615302020-11-29 11:19:47 -08002240 return QCBOR_ERR_UNSUPPORTED;
2241 }
2242
2243 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2244 if(uQCBORType & IS_BYTE_STRING_BIT) {
2245 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2246 }
2247
2248 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002249 return QCBOR_ERR_BAD_OPT_TAG;
2250 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002251
Laurence Lundblade99615302020-11-29 11:19:47 -08002252 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002253 return QCBOR_SUCCESS;
2254}
2255
2256
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002257/**
2258 * @brief Decode tag content for select tags (decoding layer 1).
2259 *
2260 * @param[in] pMe The decode context.
2261 * @param[out] pDecodedItem The decoded item.
2262 *
2263 * @return Decoding error code.
2264 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002265 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2266 * but the whole tag was not decoded. Here, the whole tags (tag number
2267 * and tag content) that are supported by QCBOR are decoded. This is a
2268 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002269 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002270static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002271QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002272{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002273 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002274
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002275 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002276 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002277 goto Done;
2278 }
2279
Laurence Lundblade99615302020-11-29 11:19:47 -08002280 /* When there are no tag numbers for the item, this exits first
2281 * thing and effectively does nothing.
2282 *
2283 * This loops over all the tag numbers accumulated for this item
2284 * trying to decode and interpret them. This stops at the end of
2285 * the list or at the first tag number that can't be interpreted by
2286 * this code. This is effectively a recursive processing of the
2287 * tags number list that handles nested tags.
2288 */
2289 while(1) {
2290 /* Don't bother to unmap tags via QCBORITem.uTags since this
2291 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2292 */
2293 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002294
Laurence Lundblade99615302020-11-29 11:19:47 -08002295 if(uTagToProcess == CBOR_TAG_INVALID16) {
2296 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002297 break;
2298
Laurence Lundblade99615302020-11-29 11:19:47 -08002299 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002300 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002301
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002302 } else if(uTagToProcess == CBOR_TAG_DAYS_EPOCH) {
2303 uReturn = DecodeDaysEpoch(pDecodedItem);
2304
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002305#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002306 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2307 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002308 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002309#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002310#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002311 } else if(uTagToProcess == CBOR_TAG_MIME ||
2312 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002313 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002314#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002315
Laurence Lundblade99615302020-11-29 11:19:47 -08002316 } else {
2317 /* See if it is a pass-through byte/text string tag; process if so */
2318 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002319
Laurence Lundblade99615302020-11-29 11:19:47 -08002320 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2321 /* It wasn't a pass-through byte/text string tag so it is
2322 * an unknown tag. This is the exit from the loop on the
2323 * first unknown tag. It is a successful exit.
2324 */
2325 uReturn = QCBOR_SUCCESS;
2326 break;
2327 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002328 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002329
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002330 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002331 /* Error exit from the loop */
2332 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002333 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002334
2335 /* A tag was successfully processed, shift it out of the list of
2336 * tags returned. This is the loop increment.
2337 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002338 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002339 }
2340
2341Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002342 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002343}
2344
2345
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002346/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002348 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002349QCBORError
2350QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2351{
2352 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002353 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002354 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002355 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2356 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2357 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002358 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002359}
2360
2361
2362/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002363 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002364 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002365QCBORError
2366QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2367{
2368 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2369 const UsefulInputBuf Save = pMe->InBuf;
2370
2371 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2372
2373 pMe->nesting = SaveNesting;
2374 pMe->InBuf = Save;
2375
2376 return uErr;
2377}
2378
2379
2380/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002381 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002382 */
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002383void
2384QCBORDecode_VPeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2385{
2386 if(pMe->uLastError != QCBOR_SUCCESS) {
2387 return;
2388 }
2389
2390 pMe->uLastError = (uint8_t)QCBORDecode_PeekNext(pMe, pDecodedItem);
2391}
2392
2393
2394/*
2395 * Public function, see header qcbor/qcbor_decode.h file
2396 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002397void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2398{
2399 if(pMe->uLastError != QCBOR_SUCCESS) {
2400 return;
2401 }
2402
2403 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2404}
2405
2406
2407/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002408 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002409 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002410QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002411QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2412 QCBORItem *pDecodedItem,
2413 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002414{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002415 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002416
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002417 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2418 if(uReturn != QCBOR_SUCCESS) {
2419 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002420 }
2421
2422 if(pTags != NULL) {
2423 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002424 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002425 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2426 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002427 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002428 }
2429 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2430 return QCBOR_ERR_TOO_MANY_TAGS;
2431 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002432 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002433 pTags->uNumUsed++;
2434 }
2435 }
2436
2437 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002438}
2439
2440
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002441/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002442 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302443 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002444bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002445 const QCBORItem *pItem,
2446 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002447{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002448 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2449 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002450 break;
2451 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002452 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002453 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002454 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002455 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002456
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002457 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002458}
2459
2460
2461/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002462 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002463 */
Laurence Lundblade87495732021-02-26 10:05:55 -07002464QCBORError QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002465{
Laurence Lundblade87495732021-02-26 10:05:55 -07002466 if(puConsumed != NULL) {
2467 *puConsumed = pMe->InBuf.cursor;
2468 }
2469
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002470 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002471
2472 if(uReturn != QCBOR_SUCCESS) {
2473 goto Done;
2474 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002475
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002476 /* Error out if all the maps/arrays are not closed out */
2477 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002478 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002479 goto Done;
2480 }
2481
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002482 /* Error out if not all the bytes are consumed */
2483 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002484 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002485 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002486
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002487Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002488 return uReturn;
2489}
2490
2491
2492/*
2493 * Public function, see header qcbor/qcbor_decode.h file
2494 */
2495QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
2496{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002497#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002498 /* Call the destructor for the string allocator if there is one.
2499 * Always called, even if there are errors; always have to clean up.
2500 */
2501 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002502#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002503
Laurence Lundblade87495732021-02-26 10:05:55 -07002504 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002505}
2506
2507
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002508/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002509 * Public function, see header qcbor/qcbor_decode.h file
2510 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002511// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002512uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2513 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002514 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002515{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002516 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2517 return CBOR_TAG_INVALID64;
2518 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002519 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2520 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002521 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002522 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002523 }
2524}
2525
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002526
Laurence Lundblade9b334962020-08-27 10:55:53 -07002527/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002528 * Public function, see header qcbor/qcbor_decode.h file
2529 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002530uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2531 uint32_t uIndex)
2532{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002533 if(pMe->uLastError != QCBOR_SUCCESS) {
2534 return CBOR_TAG_INVALID64;
2535 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002536 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2537 return CBOR_TAG_INVALID64;
2538 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002539 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002540 }
2541}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002542
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002543
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002544
2545
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002546#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002547
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002548/* ===========================================================================
2549 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002550
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002551 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002552 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2553 implements the function type QCBORStringAllocate and allows easy
2554 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002555
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002556 This particular allocator is built-in for convenience. The caller
2557 can implement their own. All of this following code will get
2558 dead-stripped if QCBORDecode_SetMemPool() is not called.
2559
2560 This is a very primitive memory allocator. It does not track
2561 individual allocations, only a high-water mark. A free or
2562 reallocation must be of the last chunk allocated.
2563
2564 The size of the pool and offset to free memory are packed into the
2565 first 8 bytes of the memory pool so we don't have to keep them in
2566 the decode context. Since the address of the pool may not be
2567 aligned, they have to be packed and unpacked as if they were
2568 serialized data of the wire or such.
2569
2570 The sizes packed in are uint32_t to be the same on all CPU types
2571 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002572 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002573
2574
Laurence Lundbladeee851742020-01-08 08:37:05 -08002575static inline int
2576MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002577{
2578 // Use of UsefulInputBuf is overkill, but it is convenient.
2579 UsefulInputBuf UIB;
2580
Laurence Lundbladeee851742020-01-08 08:37:05 -08002581 // Just assume the size here. It was checked during SetUp so
2582 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002583 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002584 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2585 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2586 return UsefulInputBuf_GetError(&UIB);
2587}
2588
2589
Laurence Lundbladeee851742020-01-08 08:37:05 -08002590static inline int
2591MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002592{
2593 // Use of UsefulOutBuf is overkill, but convenient. The
2594 // length check performed here is useful.
2595 UsefulOutBuf UOB;
2596
2597 UsefulOutBuf_Init(&UOB, Pool);
2598 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2599 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2600 return UsefulOutBuf_GetError(&UOB);
2601}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002602
2603
2604/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002605 Internal function for an allocation, reallocation free and destuct.
2606
2607 Having only one function rather than one each per mode saves space in
2608 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002609
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002610 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2611 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002612static UsefulBuf
2613MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002614{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002615 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002616
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002617 uint32_t uPoolSize;
2618 uint32_t uFreeOffset;
2619
2620 if(uNewSize > UINT32_MAX) {
2621 // This allocator is only good up to 4GB. This check should
2622 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2623 goto Done;
2624 }
2625 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2626
2627 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2628 goto Done;
2629 }
2630
2631 if(uNewSize) {
2632 if(pMem) {
2633 // REALLOCATION MODE
2634 // Calculate pointer to the end of the memory pool. It is
2635 // assumed that pPool + uPoolSize won't wrap around by
2636 // assuming the caller won't pass a pool buffer in that is
2637 // not in legitimate memory space.
2638 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2639
2640 // Check that the pointer for reallocation is in the range of the
2641 // pool. This also makes sure that pointer math further down
2642 // doesn't wrap under or over.
2643 if(pMem >= pPool && pMem < pPoolEnd) {
2644 // Offset to start of chunk for reallocation. This won't
2645 // wrap under because of check that pMem >= pPool. Cast
2646 // is safe because the pool is always less than UINT32_MAX
2647 // because of check in QCBORDecode_SetMemPool().
2648 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2649
2650 // Check to see if the allocation will fit. uPoolSize -
2651 // uMemOffset will not wrap under because of check that
2652 // pMem is in the range of the uPoolSize by check above.
2653 if(uNewSize <= uPoolSize - uMemOffset) {
2654 ReturnValue.ptr = pMem;
2655 ReturnValue.len = uNewSize;
2656
2657 // Addition won't wrap around over because uNewSize was
2658 // checked to be sure it is less than the pool size.
2659 uFreeOffset = uMemOffset + uNewSize32;
2660 }
2661 }
2662 } else {
2663 // ALLOCATION MODE
2664 // uPoolSize - uFreeOffset will not underflow because this
2665 // pool implementation makes sure uFreeOffset is always
2666 // smaller than uPoolSize through this check here and
2667 // reallocation case.
2668 if(uNewSize <= uPoolSize - uFreeOffset) {
2669 ReturnValue.len = uNewSize;
2670 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002671 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002672 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002673 }
2674 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002675 if(pMem) {
2676 // FREE MODE
2677 // Cast is safe because of limit on pool size in
2678 // QCBORDecode_SetMemPool()
2679 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2680 } else {
2681 // DESTRUCT MODE
2682 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002683 }
2684 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002685
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002686 UsefulBuf Pool = {pPool, uPoolSize};
2687 MemPool_Pack(Pool, uFreeOffset);
2688
2689Done:
2690 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002691}
2692
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002693
Laurence Lundbladef6531662018-12-04 10:42:22 +09002694/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002695 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002696 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002697QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2698 UsefulBuf Pool,
2699 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002700{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002701 // The pool size and free mem offset are packed into the beginning
2702 // of the pool memory. This compile time check make sure the
2703 // constant in the header is correct. This check should optimize
2704 // down to nothing.
2705 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002706 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002707 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002708
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002709 // The pool size and free offset packed in to the beginning of pool
2710 // memory are only 32-bits. This check will optimize out on 32-bit
2711 // machines.
2712 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002713 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002714 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002715
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002716 // This checks that the pool buffer given is big enough.
2717 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002718 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002719 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002720
Laurence Lundblade3427dee2021-06-20 11:11:24 -07002721 QCBORDecode_SetUpAllocator(pMe, MemPool_Function, Pool.ptr, bAllStrings);
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002722
Laurence Lundblade30816f22018-11-10 13:40:22 +07002723 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002724}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002725#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002726
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002727
2728
Laurence Lundblade9b334962020-08-27 10:55:53 -07002729static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2730{
2731 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2732}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002733
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002734
2735/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002736 Consume an entire map or array (and do next to
2737 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002738 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002739static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002740ConsumeItem(QCBORDecodeContext *pMe,
2741 const QCBORItem *pItemToConsume,
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02002742 uint8_t *puNextNestLevel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002743{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002744 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002745 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002746
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002747 // If it is a map or array, this will tell if it is empty.
2748 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2749
2750 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2751 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002752
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002753 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002754 * maps and arrays by using the nesting level
2755 */
2756 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002757 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002758 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002759 goto Done;
2760 }
2761 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002762
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002763 *puNextNestLevel = Item.uNextNestLevel;
2764
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002765 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002766
Laurence Lundblade1341c592020-04-11 14:19:05 -07002767 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002768 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002769 /* Just pass the nesting level through */
2770 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2771
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002772 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002773 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002774
2775Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002776 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002777}
2778
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002779
2780void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2781{
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002782 QCBORDecode_VGetNext(pMe, pDecodedItem);
2783
2784 if(pMe->uLastError == QCBOR_SUCCESS) {
Máté Tóth-Pálc6d59682021-05-26 18:55:30 +02002785 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem,
2786 &pDecodedItem->uNextNestLevel);
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002787 }
2788}
2789
2790
2791
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002792/* Call only on maps and arrays. Rewinds the cursor
2793 * to the start as if it was just entered.
2794 */
2795static void RewindMapOrArray(QCBORDecodeContext *pMe)
2796{
2797 /* Reset nesting tracking to the deepest bounded level */
2798 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2799
2800 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2801
2802 /* Reposition traversal cursor to the start of the map/array */
2803 UsefulInputBuf_Seek(&(pMe->InBuf),
2804 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2805}
2806
2807
2808/*
2809 Public function, see header qcbor/qcbor_decode.h file
2810 */
2811void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2812{
2813 if(pMe->nesting.pCurrentBounded != NULL) {
2814 /* In a bounded map, array or bstr-wrapped CBOR */
2815
2816 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2817 /* In bstr-wrapped CBOR. */
2818
2819 /* Reposition traversal cursor to start of wrapping byte string */
2820 UsefulInputBuf_Seek(&(pMe->InBuf),
2821 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2822 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2823
2824 } else {
2825 /* In a map or array */
2826 RewindMapOrArray(pMe);
2827 }
2828
2829 } else {
2830 /* Not in anything bounded */
2831
2832 /* Reposition traversal cursor to the start of input CBOR */
2833 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2834
2835 /* Reset nesting tracking to beginning of input. */
2836 DecodeNesting_Init(&(pMe->nesting));
2837 }
2838
2839 pMe->uLastError = QCBOR_SUCCESS;
2840}
2841
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002842
Laurence Lundblade1341c592020-04-11 14:19:05 -07002843/* Return true if the labels in Item1 and Item2 are the same.
2844 Works only for integer and string labels. Returns false
2845 for any other type. */
2846static inline bool
2847MatchLabel(QCBORItem Item1, QCBORItem Item2)
2848{
2849 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2850 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2851 return true;
2852 }
2853 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002854 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002855 return true;
2856 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002857 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002858 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2859 return true;
2860 }
2861 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2862 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2863 return true;
2864 }
2865 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002866
Laurence Lundblade1341c592020-04-11 14:19:05 -07002867 /* Other label types are never matched */
2868 return false;
2869}
2870
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002871
2872/*
2873 Returns true if Item1 and Item2 are the same type
2874 or if either are of QCBOR_TYPE_ANY.
2875 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002876static inline bool
2877MatchType(QCBORItem Item1, QCBORItem Item2)
2878{
2879 if(Item1.uDataType == Item2.uDataType) {
2880 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002881 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002882 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002883 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002884 return true;
2885 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002886 return false;
2887}
2888
2889
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002890/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002891 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002892
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002893 @param[in] pMe The decode context to search.
2894 @param[in,out] pItemArray The items to search for and the items found.
2895 @param[out] puOffset Byte offset of last item matched.
2896 @param[in] pCBContext Context for the not-found item call back.
2897 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002898
2899 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2900
Laurence Lundblade93d89472020-10-03 22:30:50 -07002901 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2902 were found for one of the labels being
2903 search for. This duplicate detection is
2904 only performed for items in pItemArray,
2905 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002906
Laurence Lundblade93d89472020-10-03 22:30:50 -07002907 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2908 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002909
2910 @retval Also errors returned by QCBORDecode_GetNext().
2911
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002912 On input pItemArray contains a list of labels and data types
2913 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002914
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002915 On output the fully retrieved items are filled in with
2916 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002917
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002918 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002919
2920 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002921 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002922static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002923MapSearch(QCBORDecodeContext *pMe,
2924 QCBORItem *pItemArray,
2925 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002926 void *pCBContext,
2927 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002928{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002929 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002930 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002931
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002932 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002933 uReturn = pMe->uLastError;
2934 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002935 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002936
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002937 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002938 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2939 /* QCBOR_TYPE_NONE as first item indicates just looking
2940 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002941 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2942 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002943 }
2944
Laurence Lundblade085d7952020-07-24 10:26:30 -07002945 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2946 // It is an empty bounded array or map
2947 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2948 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002949 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002950 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002951 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002952 // Nothing is ever found in an empty array or map. All items
2953 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002954 uReturn = QCBOR_SUCCESS;
2955 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002956 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002957 }
2958
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002959 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002960 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2961
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002962 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002963 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002964
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002965 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002966 Loop over all the items in the map or array. Each item
2967 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002968 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002969 length maps and arrays. The only reason this is ever
2970 called on arrays is to find their end position.
2971
2972 This will always run over all items in order to do
2973 duplicate detection.
2974
2975 This will exit with failure if it encounters an
2976 unrecoverable error, but continue on for recoverable
2977 errors.
2978
2979 If a recoverable error occurs on a matched item, then
2980 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002981 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002982 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Máté Tóth-Pál2f2aa5f2021-05-17 21:35:09 +02002983 uint8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002984 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002985 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002986 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002987
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002988 /* Get the item */
2989 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002990 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002991 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002992 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002993 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002994 goto Done;
2995 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002996 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002997 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002998 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002999 goto Done;
3000 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003001
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003002 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003003 bool bMatched = false;
3004 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
3005 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003006 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003007 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
3008 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003009 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003010 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003011 if(uResult != QCBOR_SUCCESS) {
3012 /* The label matches, but the data item is in error */
3013 uReturn = uResult;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003014 goto Done;
3015 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003016 if(!MatchType(Item, pItemArray[nIndex])) {
3017 /* The data item is not of the type(s) requested */
3018 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003019 goto Done;
3020 }
3021
Laurence Lundblade1341c592020-04-11 14:19:05 -07003022 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003023 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003024 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003025 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003026 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003027 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003028 bMatched = true;
3029 }
3030 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003031
3032
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003033 if(!bMatched && pfCallback != NULL) {
3034 /*
3035 Call the callback on unmatched labels.
3036 (It is tempting to do duplicate detection here, but that would
3037 require dynamic memory allocation because the number of labels
3038 that might be encountered is unbounded.)
3039 */
3040 uReturn = (*pfCallback)(pCBContext, &Item);
3041 if(uReturn != QCBOR_SUCCESS) {
3042 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003043 }
3044 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003045
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003046 /*
3047 Consume the item whether matched or not. This
3048 does the work of traversing maps and array and
3049 everything in them. In this loop only the
3050 items at the current nesting level are examined
3051 to match the labels.
3052 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003053 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003054 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003055 goto Done;
3056 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003057
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003058 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003059
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003060 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003061
3062 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003063
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003064 // Check here makes sure that this won't accidentally be
3065 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003066 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003067 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3068 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003069 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3070 goto Done;
3071 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003072 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3073 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003074
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003075 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003076 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
3077
3078 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003079 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003080 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003081 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003082 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3083 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003084 }
3085 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003086
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003087 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003088}
3089
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003090
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003091/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003092 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003093*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003094void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3095 int64_t nLabel,
3096 uint8_t uQcborType,
3097 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003098{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003099 if(pMe->uLastError != QCBOR_SUCCESS) {
3100 return;
3101 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003102
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003103 QCBORItem OneItemSeach[2];
3104 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3105 OneItemSeach[0].label.int64 = nLabel;
3106 OneItemSeach[0].uDataType = uQcborType;
3107 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003108
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003109 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003110
3111 *pItem = OneItemSeach[0];
3112
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003113 if(uReturn != QCBOR_SUCCESS) {
3114 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003115 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003116 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003117 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003118 }
3119
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003120 Done:
3121 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003122}
3123
3124
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003125/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003126 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003127*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003128void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3129 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003130 uint8_t uQcborType,
3131 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003132{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003133 if(pMe->uLastError != QCBOR_SUCCESS) {
3134 return;
3135 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003136
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003137 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003138 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3139 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3140 OneItemSeach[0].uDataType = uQcborType;
3141 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003142
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003143 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3144 if(uReturn != QCBOR_SUCCESS) {
3145 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003146 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003147 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003148 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003149 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003150 }
3151
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003152 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003153
3154Done:
3155 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003156}
3157
3158
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003159
Laurence Lundblade93d89472020-10-03 22:30:50 -07003160static QCBORError
3161CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003162{
3163 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3164 if(uDataType == puTypeList[i]) {
3165 return QCBOR_SUCCESS;
3166 }
3167 }
3168 return QCBOR_ERR_UNEXPECTED_TYPE;
3169}
3170
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003171
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003172/**
3173 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003174 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003175
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003176 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3177 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003178
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003179 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3180 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003181 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003182static QCBORError
3183CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003184{
3185 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3186 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3187 /* There are tags that QCBOR couldn't process on this item and
3188 the caller has told us there should not be. */
3189 return QCBOR_ERR_UNEXPECTED_TYPE;
3190 }
3191
3192 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3193 const int nItemType = pItem->uDataType;
3194
3195 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3196 // Must match the tag and only the tag
3197 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3198 }
3199
3200 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3201 if(uReturn == QCBOR_SUCCESS) {
3202 return QCBOR_SUCCESS;
3203 }
3204
3205 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3206 /* Must match the content type and only the content type.
3207 There was no match just above so it is a fail. */
3208 return QCBOR_ERR_UNEXPECTED_TYPE;
3209 }
3210
3211 /* If here it can match either the tag or the content
3212 and it hasn't matched the content, so the end
3213 result is whether it matches the tag. This is
3214 also the case that the CBOR standard discourages. */
3215
3216 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3217}
3218
Laurence Lundblade9b334962020-08-27 10:55:53 -07003219
Laurence Lundblade9b334962020-08-27 10:55:53 -07003220
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003221// This could be semi-private if need be
3222static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003223void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3224 int64_t nLabel,
3225 TagSpecification TagSpec,
3226 QCBORItem *pItem)
3227{
3228 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3229 if(pMe->uLastError != QCBOR_SUCCESS) {
3230 return;
3231 }
3232
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003233 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003234}
3235
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003236
3237// This could be semi-private if need be
3238static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003239void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3240 const char *szLabel,
3241 TagSpecification TagSpec,
3242 QCBORItem *pItem)
3243{
3244 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3245 if(pMe->uLastError != QCBOR_SUCCESS) {
3246 return;
3247 }
3248
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003249 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003250}
3251
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003252// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003253void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3254 int64_t nLabel,
3255 TagSpecification TagSpec,
3256 UsefulBufC *pString)
3257{
3258 QCBORItem Item;
3259 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3260 if(pMe->uLastError == QCBOR_SUCCESS) {
3261 *pString = Item.val.string;
3262 }
3263}
3264
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003265// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003266void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3267 const char * szLabel,
3268 TagSpecification TagSpec,
3269 UsefulBufC *pString)
3270{
3271 QCBORItem Item;
3272 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3273 if(pMe->uLastError == QCBOR_SUCCESS) {
3274 *pString = Item.val.string;
3275 }
3276}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003277
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003278/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003279 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003280*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003281void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003282{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003283 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3284 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003285}
3286
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003287/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003288 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003289*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003290void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3291 QCBORItem *pItemList,
3292 void *pCallbackCtx,
3293 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003294{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003295 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3296 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003297}
3298
3299
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003300/**
3301 * @brief Search for a map/array by label and enter it
3302 *
3303 * @param[in] pMe The decode context.
3304 * @param[in] pSearch The map/array to search for.
3305 *
3306 * @c pSearch is expected to contain one item of type map or array
3307 * with the label specified. The current bounded map will be searched for
3308 * this and if found will be entered.
3309 *
3310 * If the label is not found, or the item found is not a map or array,
3311 * the error state is set.
3312 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003313static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003314{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003315 // The first item in pSearch is the one that is to be
3316 // entered. It should be the only one filled in. Any other
3317 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003318 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003319 return;
3320 }
3321
3322 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003323 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003324 if(pMe->uLastError != QCBOR_SUCCESS) {
3325 return;
3326 }
3327
Laurence Lundblade9b334962020-08-27 10:55:53 -07003328 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003329 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003330 return;
3331 }
3332
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003333
3334 /* The map or array was found. Now enter it.
3335 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003336 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3337 * next item for the pre-order traversal cursor to be the map/array
3338 * found by MapSearch(). The next few lines of code force the
3339 * cursor to that.
3340 *
3341 * There is no need to retain the old cursor because
3342 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3343 * beginning of the map/array being entered.
3344 *
3345 * The cursor is forced by: 1) setting the input buffer position to
3346 * the item offset found by MapSearch(), 2) setting the map/array
3347 * counter to the total in the map/array, 3) setting the nesting
3348 * level. Setting the map/array counter to the total is not
3349 * strictly correct, but this is OK because this cursor only needs
3350 * to be used to get one item and MapSearch() has already found it
3351 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003352 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003353 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003354
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003355 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3356
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003357 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003358
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003359 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003360}
3361
3362
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003363/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003364 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003365*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003366void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003367{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003368 QCBORItem OneItemSeach[2];
3369 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3370 OneItemSeach[0].label.int64 = nLabel;
3371 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3372 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003373
Laurence Lundblade9b334962020-08-27 10:55:53 -07003374 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003375 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003376}
3377
3378
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003379/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003380 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003381*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003382void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003383{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003384 QCBORItem OneItemSeach[2];
3385 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3386 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3387 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3388 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003389
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003390 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003391}
3392
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003393/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003394 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003395*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003396void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003397{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003398 QCBORItem OneItemSeach[2];
3399 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3400 OneItemSeach[0].label.int64 = nLabel;
3401 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3402 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003403
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003404 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003405}
3406
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003407/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003408 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003409*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003410void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3411{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003412 QCBORItem OneItemSeach[2];
3413 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3414 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3415 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3416 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003417
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003418 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003419}
3420
3421
Laurence Lundblade02625d42020-06-25 14:41:41 -07003422// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003423void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003424{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003425 QCBORError uErr;
3426
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003427 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003428 if(pMe->uLastError != QCBOR_SUCCESS) {
3429 // Already in error state; do nothing.
3430 return;
3431 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003432
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003433 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003434 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003435 uErr = QCBORDecode_GetNext(pMe, &Item);
3436 if(uErr != QCBOR_SUCCESS) {
3437 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003438 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003439 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003440 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3441 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003442 }
3443
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003444 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003445
3446
Laurence Lundbladef0499502020-08-01 11:55:57 -07003447 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003448 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003449 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3450 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003451 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003452 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3453 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003454 // Special case to increment nesting level for zero-length maps
3455 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003456 DecodeNesting_Descend(&(pMe->nesting), uType);
3457 }
3458
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003459 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003460
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003461 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3462 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003463
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003464 if(pItem != NULL) {
3465 *pItem = Item;
3466 }
3467
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003468Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003469 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003470}
3471
Laurence Lundblade02625d42020-06-25 14:41:41 -07003472
3473/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003474 This is the common work for exiting a level that is a bounded map,
3475 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003476
3477 One chunk of work is to set up the pre-order traversal so it is at
3478 the item just after the bounded map, array or bstr that is being
3479 exited. This is somewhat complex.
3480
3481 The other work is to level-up the bounded mode to next higest bounded
3482 mode or the top level if there isn't one.
3483 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003484static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003485ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003486{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003487 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003488
Laurence Lundblade02625d42020-06-25 14:41:41 -07003489 /*
3490 First the pre-order-traversal byte offset is positioned to the
3491 item just after the bounded mode item that was just consumed.
3492 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003493 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3494
Laurence Lundblade02625d42020-06-25 14:41:41 -07003495 /*
3496 Next, set the current nesting level to one above the bounded level
3497 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003498
Laurence Lundblade02625d42020-06-25 14:41:41 -07003499 DecodeNesting_CheckBoundedType() is always called before this and
3500 makes sure pCurrentBounded is valid.
3501 */
3502 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3503
3504 /*
3505 This does the complex work of leveling up the pre-order traversal
3506 when the end of a map or array or another bounded level is
3507 reached. It may do nothing, or ascend all the way to the top
3508 level.
3509 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003510 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003511 if(uErr != QCBOR_SUCCESS) {
3512 goto Done;
3513 }
3514
Laurence Lundblade02625d42020-06-25 14:41:41 -07003515 /*
3516 This makes the next highest bounded level the current bounded
3517 level. If there is no next highest level, then no bounded mode is
3518 in effect.
3519 */
3520 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003521
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003522 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003523
3524Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003525 return uErr;
3526}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003527
Laurence Lundblade02625d42020-06-25 14:41:41 -07003528
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003529// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003530void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003531{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003532 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003533 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003534 return;
3535 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003536
Laurence Lundblade02625d42020-06-25 14:41:41 -07003537 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003538
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003539 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003540 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003541 goto Done;
3542 }
3543
Laurence Lundblade02625d42020-06-25 14:41:41 -07003544 /*
3545 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003546 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003547 from previous map search, then do a dummy search.
3548 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003549 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003550 QCBORItem Dummy;
3551 Dummy.uLabelType = QCBOR_TYPE_NONE;
3552 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3553 if(uErr != QCBOR_SUCCESS) {
3554 goto Done;
3555 }
3556 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003557
Laurence Lundblade02625d42020-06-25 14:41:41 -07003558 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003559
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003560Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003561 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003562}
3563
3564
Laurence Lundblade1341c592020-04-11 14:19:05 -07003565
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003566static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003567 const QCBORItem *pItem,
3568 uint8_t uTagRequirement,
3569 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003570{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003571 if(pBstr) {
3572 *pBstr = NULLUsefulBufC;
3573 }
3574
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003575 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003576 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003577 return pMe->uLastError;
3578 }
3579
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003580 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003581
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003582 const TagSpecification TagSpec =
3583 {
3584 uTagRequirement,
3585 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3586 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3587 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003588
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003589 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003590 if(uError != QCBOR_SUCCESS) {
3591 goto Done;
3592 }
3593
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003594 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003595 /* Reverse the decrement done by GetNext() for the bstr so the
3596 * increment in QCBORDecode_NestLevelAscender() called by
3597 * ExitBoundedLevel() will work right.
3598 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003599 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003600 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003601
3602 if(pBstr) {
3603 *pBstr = pItem->val.string;
3604 }
3605
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003606 /* This saves the current length of the UsefulInputBuf and then
3607 * narrows the UsefulInputBuf to start and length of the wrapped
3608 * CBOR that is being entered.
3609 *
3610 * Most of these calls are simple inline accessors so this doesn't
3611 * amount to much code.
3612 */
3613
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003614 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003615 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3616 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003617 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003618 goto Done;
3619 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003620
3621 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3622 pItem->val.string.ptr);
3623 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3624 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3625 /* This should never happen because pItem->val.string.ptr should
3626 * always be valid since it was just returned.
3627 */
3628 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3629 goto Done;
3630 }
3631
3632 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3633
3634 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003635 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003636
Laurence Lundblade02625d42020-06-25 14:41:41 -07003637 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003638 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003639 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003640Done:
3641 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003642}
3643
3644
Laurence Lundblade02625d42020-06-25 14:41:41 -07003645/*
3646 Public function, see header qcbor/qcbor_decode.h file
3647 */
3648void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003649 uint8_t uTagRequirement,
3650 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003651{
3652 if(pMe->uLastError != QCBOR_SUCCESS) {
3653 // Already in error state; do nothing.
3654 return;
3655 }
3656
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003657 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003658 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003659 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3660 if(pMe->uLastError != QCBOR_SUCCESS) {
3661 return;
3662 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003663
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003664 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003665 &Item,
3666 uTagRequirement,
3667 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003668}
3669
3670
Laurence Lundblade02625d42020-06-25 14:41:41 -07003671/*
3672 Public function, see header qcbor/qcbor_decode.h file
3673 */
3674void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003675 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003676 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003677 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003678{
3679 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003680 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003681
Laurence Lundblade93d89472020-10-03 22:30:50 -07003682 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3683 &Item,
3684 uTagRequirement,
3685 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003686}
3687
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003688
Laurence Lundblade02625d42020-06-25 14:41:41 -07003689/*
3690 Public function, see header qcbor/qcbor_decode.h file
3691 */
3692void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003693 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003694 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003695 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003696{
3697 QCBORItem Item;
3698 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3699
Laurence Lundblade93d89472020-10-03 22:30:50 -07003700 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3701 &Item,
3702 uTagRequirement,
3703 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003704}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003705
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003706
Laurence Lundblade02625d42020-06-25 14:41:41 -07003707/*
3708 Public function, see header qcbor/qcbor_decode.h file
3709 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003710void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003711{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003712 if(pMe->uLastError != QCBOR_SUCCESS) {
3713 // Already in error state; do nothing.
3714 return;
3715 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003716
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003717 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003718 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003719 return;
3720 }
3721
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003722 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3723
Laurence Lundblade02625d42020-06-25 14:41:41 -07003724 /*
3725 Reset the length of the UsefulInputBuf to what it was before
3726 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003727 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003728 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003729 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003730
3731
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003732 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003733 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003734}
3735
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003736
Laurence Lundbladee6430642020-03-14 21:15:44 -07003737
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003738
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003739static inline void
3740ProcessBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003741{
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003742 if(pMe->uLastError != QCBOR_SUCCESS) {
3743 /* Already in error state, do nothing */
3744 return;
3745 }
3746
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003747 switch(pItem->uDataType) {
3748 case QCBOR_TYPE_TRUE:
3749 *pBool = true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003750 break;
3751
3752 case QCBOR_TYPE_FALSE:
3753 *pBool = false;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003754 break;
3755
3756 default:
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003757 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003758 break;
3759 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003760 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003761}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003762
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003763
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003764/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003765 * Public function, see header qcbor/qcbor_decode.h file
3766 */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003767void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003768{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003769 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003770 /* Already in error state, do nothing */
Laurence Lundbladee6430642020-03-14 21:15:44 -07003771 return;
3772 }
3773
Laurence Lundbladec4537442020-04-14 18:53:22 -07003774 QCBORItem Item;
3775
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003776 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3777
3778 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003779}
3780
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003781
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003782/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003783 * Public function, see header qcbor/qcbor_decode.h file
3784 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003785void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003786{
3787 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003788 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003789
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003790 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003791}
3792
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003793
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003794/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003795 * Public function, see header qcbor/qcbor_decode.h file
3796 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003797void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3798{
3799 QCBORItem Item;
3800 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3801
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003802 ProcessBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003803}
3804
3805
3806
Laurence Lundbladec7114722020-08-13 05:11:40 -07003807
3808static void ProcessEpochDate(QCBORDecodeContext *pMe,
3809 QCBORItem *pItem,
3810 uint8_t uTagRequirement,
3811 int64_t *pnTime)
3812{
3813 if(pMe->uLastError != QCBOR_SUCCESS) {
3814 // Already in error state, do nothing
3815 return;
3816 }
3817
3818 QCBORError uErr;
3819
3820 const TagSpecification TagSpec =
3821 {
3822 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003823 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3824 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003825 };
3826
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003827 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003828 if(uErr != QCBOR_SUCCESS) {
3829 goto Done;
3830 }
3831
3832 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3833 uErr = DecodeDateEpoch(pItem);
3834 if(uErr != QCBOR_SUCCESS) {
3835 goto Done;
3836 }
3837 }
3838
Laurence Lundblade9b334962020-08-27 10:55:53 -07003839 // Save the tags in the last item's tags in the decode context
3840 // for QCBORDecode_GetNthTagOfLast()
3841 CopyTags(pMe, pItem);
3842
Laurence Lundbladec7114722020-08-13 05:11:40 -07003843 *pnTime = pItem->val.epochDate.nSeconds;
3844
3845Done:
3846 pMe->uLastError = (uint8_t)uErr;
3847}
3848
3849
3850void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003851 uint8_t uTagRequirement,
3852 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003853{
3854 if(pMe->uLastError != QCBOR_SUCCESS) {
3855 // Already in error state, do nothing
3856 return;
3857 }
3858
3859 QCBORItem Item;
3860 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3861
3862 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3863}
3864
3865
3866void
3867QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3868 int64_t nLabel,
3869 uint8_t uTagRequirement,
3870 int64_t *pnTime)
3871{
3872 QCBORItem Item;
3873 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3874 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3875}
3876
3877
3878void
3879QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3880 const char *szLabel,
3881 uint8_t uTagRequirement,
3882 int64_t *pnTime)
3883{
3884 QCBORItem Item;
3885 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3886 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3887}
3888
3889
3890
Laurence Lundblade46d63e92021-05-13 11:37:10 -07003891/*
3892 * Common processing for the RFC 8943 day-count tag. Mostly
3893 * make sure the tag content is correct and copy forward any
3894 * further other tag numbers.
3895 */
3896static void ProcessEpochDays(QCBORDecodeContext *pMe,
3897 QCBORItem *pItem,
3898 uint8_t uTagRequirement,
3899 int64_t *pnDays)
3900{
3901 if(pMe->uLastError != QCBOR_SUCCESS) {
3902 /* Already in error state, do nothing */
3903 return;
3904 }
3905
3906 QCBORError uErr;
3907
3908 const TagSpecification TagSpec =
3909 {
3910 uTagRequirement,
3911 {QCBOR_TYPE_DAYS_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3912 {QCBOR_TYPE_INT64, QCBOR_TYPE_UINT64, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3913 };
3914
3915 uErr = CheckTagRequirement(TagSpec, pItem);
3916 if(uErr != QCBOR_SUCCESS) {
3917 goto Done;
3918 }
3919
3920 if(pItem->uDataType != QCBOR_TYPE_DAYS_EPOCH) {
3921 uErr = DecodeDaysEpoch(pItem);
3922 if(uErr != QCBOR_SUCCESS) {
3923 goto Done;
3924 }
3925 }
3926
3927 /* Save the tags in the last item's tags in the decode context
3928 * for QCBORDecode_GetNthTagOfLast()
3929 */
3930 CopyTags(pMe, pItem);
3931
3932 *pnDays = pItem->val.epochDays;
3933
3934Done:
3935 pMe->uLastError = (uint8_t)uErr;
3936}
3937
3938
3939/*
3940 * Public function, see header qcbor/qcbor_decode.h
3941 */
3942void QCBORDecode_GetEpochDays(QCBORDecodeContext *pMe,
3943 uint8_t uTagRequirement,
3944 int64_t *pnDays)
3945{
3946 if(pMe->uLastError != QCBOR_SUCCESS) {
3947 /* Already in error state, do nothing */
3948 return;
3949 }
3950
3951 QCBORItem Item;
3952 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3953
3954 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3955}
3956
3957
3958/*
3959 * Public function, see header qcbor/qcbor_decode.h
3960 */
3961void
3962QCBORDecode_GetEpochDaysInMapN(QCBORDecodeContext *pMe,
3963 int64_t nLabel,
3964 uint8_t uTagRequirement,
3965 int64_t *pnDays)
3966{
3967 QCBORItem Item;
3968 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3969 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3970}
3971
3972
3973/*
3974 * Public function, see header qcbor/qcbor_decode.h
3975 */
3976void
3977QCBORDecode_GetEpochDaysInMapSZ(QCBORDecodeContext *pMe,
3978 const char *szLabel,
3979 uint8_t uTagRequirement,
3980 int64_t *pnDays)
3981{
3982 QCBORItem Item;
3983 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3984 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3985}
3986
3987
3988
Laurence Lundbladec7114722020-08-13 05:11:40 -07003989
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003990void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3991 TagSpecification TagSpec,
3992 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003993{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003994 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003995 // Already in error state, do nothing
3996 return;
3997 }
3998
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003999 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004000 QCBORItem Item;
4001
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07004002 uError = QCBORDecode_GetNext(pMe, &Item);
4003 if(uError != QCBOR_SUCCESS) {
4004 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004005 return;
4006 }
4007
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004008 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004009
4010 if(pMe->uLastError == QCBOR_SUCCESS) {
4011 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07004012 } else {
4013 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004014 }
4015}
4016
Laurence Lundbladec4537442020-04-14 18:53:22 -07004017
4018
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004019
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004020static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004021 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004022 UsefulBufC *pValue,
4023 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004024{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004025 const TagSpecification TagSpec =
4026 {
4027 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004028 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4029 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004030 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004031
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004032 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004033 if(uErr != QCBOR_SUCCESS) {
4034 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004035 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004036
4037 *pValue = pItem->val.string;
4038
4039 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
4040 *pbIsNegative = false;
4041 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
4042 *pbIsNegative = true;
4043 }
4044
4045 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004046}
4047
4048
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004049/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004050 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004051 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004052void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
4053 uint8_t uTagRequirement,
4054 UsefulBufC *pValue,
4055 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004056{
4057 if(pMe->uLastError != QCBOR_SUCCESS) {
4058 // Already in error state, do nothing
4059 return;
4060 }
4061
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004062 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004063 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4064 if(uError != QCBOR_SUCCESS) {
4065 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004066 return;
4067 }
4068
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004069 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004070}
4071
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004072
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004073/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004074 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004075*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004076void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
4077 int64_t nLabel,
4078 uint8_t uTagRequirement,
4079 UsefulBufC *pValue,
4080 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004081{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004082 QCBORItem Item;
4083 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004084 if(pMe->uLastError != QCBOR_SUCCESS) {
4085 return;
4086 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004087
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004088 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004089}
4090
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004091
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004092/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004093 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004094*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004095void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
4096 const char *szLabel,
4097 uint8_t uTagRequirement,
4098 UsefulBufC *pValue,
4099 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004100{
4101 QCBORItem Item;
4102 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004103 if(pMe->uLastError != QCBOR_SUCCESS) {
4104 return;
4105 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004106
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004107 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004108}
4109
4110
4111
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004112
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004113// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004114QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
4115 const QCBORItem *pItem,
4116 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07004117 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004118{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004119 const TagSpecification TagSpecText =
4120 {
4121 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004122 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4123 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004124 };
4125 const TagSpecification TagSpecBinary =
4126 {
4127 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004128 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4129 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004130 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004131
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004132 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004133
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004134 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004135 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004136 if(pbIsTag257 != NULL) {
4137 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004138 }
4139 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004140 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004141 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004142 if(pbIsTag257 != NULL) {
4143 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004144 }
4145 uReturn = QCBOR_SUCCESS;
4146
4147 } else {
4148 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
4149 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07004150
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004151 return uReturn;
4152}
4153
Laurence Lundblade93d89472020-10-03 22:30:50 -07004154// Improvement: add methods for wrapped CBOR, a simple alternate
4155// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004156
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004157
4158
4159
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004160#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07004161
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004162typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004163
4164
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004165// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004166static QCBORError
4167Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004168{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004169 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004170
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004171 if(uResult != 0) {
4172 /* This loop will run a maximum of 19 times because
4173 * UINT64_MAX < 10 ^^ 19. More than that will cause
4174 * exit with the overflow error
4175 */
4176 for(; nExponent > 0; nExponent--) {
4177 if(uResult > UINT64_MAX / 10) {
4178 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4179 }
4180 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004181 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004182
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004183 for(; nExponent < 0; nExponent++) {
4184 uResult = uResult / 10;
4185 if(uResult == 0) {
4186 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4187 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004188 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004189 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004190 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004191
4192 *puResult = uResult;
4193
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004194 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004195}
4196
4197
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004198// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004199static QCBORError
4200Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004201{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004202 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004203
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004204 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004205
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004206 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004207 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004208 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004209 */
4210 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004211 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004212 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004213 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004214 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004215 nExponent--;
4216 }
4217
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004218 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004219 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004220 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4221 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004222 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004223 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004224 }
4225
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004226 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004227
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004228 return QCBOR_SUCCESS;
4229}
4230
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004231
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004232/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004233 Compute value with signed mantissa and signed result. Works with
4234 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004235 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004236static inline QCBORError ExponentiateNN(int64_t nMantissa,
4237 int64_t nExponent,
4238 int64_t *pnResult,
4239 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004240{
4241 uint64_t uResult;
4242
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004243 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004244 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004245 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4246
4247 // Do the exponentiation of the positive mantissa
4248 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4249 if(uReturn) {
4250 return uReturn;
4251 }
4252
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004253
Laurence Lundblade983500d2020-05-14 11:49:34 -07004254 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4255 of INT64_MIN. This assumes two's compliment representation where
4256 INT64_MIN is one increment farther from 0 than INT64_MAX.
4257 Trying to write -INT64_MIN doesn't work to get this because the
4258 compiler tries to work with an int64_t which can't represent
4259 -INT64_MIN.
4260 */
4261 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4262
4263 // Error out if too large
4264 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004265 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4266 }
4267
4268 // Casts are safe because of checks above
4269 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4270
4271 return QCBOR_SUCCESS;
4272}
4273
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004274
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004275/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004276 Compute value with signed mantissa and unsigned result. Works with
4277 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004278 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004279static inline QCBORError ExponentitateNU(int64_t nMantissa,
4280 int64_t nExponent,
4281 uint64_t *puResult,
4282 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004283{
4284 if(nMantissa < 0) {
4285 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4286 }
4287
4288 // Cast to unsigned is OK because of check for negative
4289 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4290 // Exponentiation is straight forward
4291 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4292}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004293
4294
4295/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004296 Compute value with signed mantissa and unsigned result. Works with
4297 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004298 */
4299static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4300 int64_t nExponent,
4301 uint64_t *puResult,
4302 fExponentiator pfExp)
4303{
4304 return (*pfExp)(uMantissa, nExponent, puResult);
4305}
4306
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004307#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004308
4309
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004310
4311
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004312
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004313static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004314{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004315 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004316
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004317 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004318 const uint8_t *pByte = BigNum.ptr;
4319 size_t uLen = BigNum.len;
4320 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004321 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004322 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004323 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004324 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004325 }
4326
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004327 *pResult = uResult;
4328 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004329}
4330
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004331
Laurence Lundblade887add82020-05-17 05:50:34 -07004332static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004333{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004334 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004335}
4336
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004337
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004338static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004339{
4340 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004341 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4342 if(uError) {
4343 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004344 }
4345 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4346 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004347 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004348}
4349
4350
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004351static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004352{
4353 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004354 /* The negative integer furthest from zero for a C int64_t is
4355 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4356 negative number in CBOR is computed as -n - 1 where n is the
4357 encoded integer, where n is what is in the variable BigNum. When
4358 converting BigNum to a uint64_t, the maximum value is thus
4359 INT64_MAX, so that when it -n - 1 is applied to it the result will
4360 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004361
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004362 -n - 1 <= INT64_MIN.
4363 -n - 1 <= -INT64_MAX - 1
4364 n <= INT64_MAX.
4365 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004366 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004367 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004368 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004369 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004370
4371 /// Now apply -n - 1. The cast is safe because
4372 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4373 // is the largest positive integer that an int64_t can
4374 // represent. */
4375 *pnResult = -(int64_t)uResult - 1;
4376
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004377 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004378}
4379
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004380
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004381
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004382
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004383
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004384/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004385Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004386
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004387\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004388
Laurence Lundblade93d89472020-10-03 22:30:50 -07004389\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4390 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004391
4392\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4393
Laurence Lundblade93d89472020-10-03 22:30:50 -07004394\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4395 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004396*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004397static QCBORError
4398ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004399{
4400 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004401 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004402 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004403#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004404 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004405 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4406 http://www.cplusplus.com/reference/cmath/llround/
4407 */
4408 // Not interested in FE_INEXACT
4409 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004410 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4411 *pnValue = llround(pItem->val.dfnum);
4412 } else {
4413 *pnValue = lroundf(pItem->val.fnum);
4414 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004415 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4416 // llround() shouldn't result in divide by zero, but catch
4417 // it here in case it unexpectedly does. Don't try to
4418 // distinguish between the various exceptions because it seems
4419 // they vary by CPU, compiler and OS.
4420 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004421 }
4422 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004423 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004424 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004425#else
4426 return QCBOR_ERR_HW_FLOAT_DISABLED;
4427#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004428 break;
4429
4430 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004431 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004432 *pnValue = pItem->val.int64;
4433 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004434 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004435 }
4436 break;
4437
4438 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004439 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004440 if(pItem->val.uint64 < INT64_MAX) {
4441 *pnValue = pItem->val.int64;
4442 } else {
4443 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4444 }
4445 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004446 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004447 }
4448 break;
4449
4450 default:
4451 return QCBOR_ERR_UNEXPECTED_TYPE;
4452 }
4453 return QCBOR_SUCCESS;
4454}
4455
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004456
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004457void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004458 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004459 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004460 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004461{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004462 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004463 return;
4464 }
4465
Laurence Lundbladee6430642020-03-14 21:15:44 -07004466 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004467 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4468 if(uError) {
4469 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004470 return;
4471 }
4472
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004473 if(pItem) {
4474 *pItem = Item;
4475 }
4476
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004477 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004478}
4479
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004480
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004481void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4482 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004483 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004484 int64_t *pnValue,
4485 QCBORItem *pItem)
4486{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004487 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004488 if(pMe->uLastError != QCBOR_SUCCESS) {
4489 return;
4490 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004491
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004492 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004493}
4494
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004495
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004496void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4497 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004498 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004499 int64_t *pnValue,
4500 QCBORItem *pItem)
4501{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004502 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004503 if(pMe->uLastError != QCBOR_SUCCESS) {
4504 return;
4505 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004506
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004507 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004508}
4509
4510
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004511/*
4512 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004513
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004514 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004515
Laurence Lundblade93d89472020-10-03 22:30:50 -07004516 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4517 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004518
4519 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4520
Laurence Lundblade93d89472020-10-03 22:30:50 -07004521 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4522 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004523 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004524static QCBORError
4525Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004526{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004527 switch(pItem->uDataType) {
4528
4529 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004530 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004531 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004532 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004533 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004534 }
4535 break;
4536
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004537 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004538 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004539 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004540 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004541 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004542 }
4543 break;
4544
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004545#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004546 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004547 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004548 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004549 pItem->val.expAndMantissa.nExponent,
4550 pnValue,
4551 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004552 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004553 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004554 }
4555 break;
4556
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004557 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004558 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004559 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004560 pItem->val.expAndMantissa.nExponent,
4561 pnValue,
4562 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004563 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004564 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004565 }
4566 break;
4567
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004568 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004569 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004570 int64_t nMantissa;
4571 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004572 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4573 if(uErr) {
4574 return uErr;
4575 }
4576 return ExponentiateNN(nMantissa,
4577 pItem->val.expAndMantissa.nExponent,
4578 pnValue,
4579 Exponentitate10);
4580 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004581 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004582 }
4583 break;
4584
4585 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004586 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004587 int64_t nMantissa;
4588 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004589 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4590 if(uErr) {
4591 return uErr;
4592 }
4593 return ExponentiateNN(nMantissa,
4594 pItem->val.expAndMantissa.nExponent,
4595 pnValue,
4596 Exponentitate10);
4597 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004598 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004599 }
4600 break;
4601
4602 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004603 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004604 int64_t nMantissa;
4605 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004606 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4607 if(uErr) {
4608 return uErr;
4609 }
4610 return ExponentiateNN(nMantissa,
4611 pItem->val.expAndMantissa.nExponent,
4612 pnValue,
4613 Exponentitate2);
4614 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004615 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004616 }
4617 break;
4618
4619 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004620 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004621 int64_t nMantissa;
4622 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004623 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4624 if(uErr) {
4625 return uErr;
4626 }
4627 return ExponentiateNN(nMantissa,
4628 pItem->val.expAndMantissa.nExponent,
4629 pnValue,
4630 Exponentitate2);
4631 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004632 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004633 }
4634 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004635#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004636
Laurence Lundbladee6430642020-03-14 21:15:44 -07004637
Laurence Lundbladec4537442020-04-14 18:53:22 -07004638 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004639 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004640}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004641
4642
Laurence Lundbladec4537442020-04-14 18:53:22 -07004643/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004644 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004645 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004646void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004647{
4648 QCBORItem Item;
4649
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004650 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004651
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004652 if(pMe->uLastError == QCBOR_SUCCESS) {
4653 // The above conversion succeeded
4654 return;
4655 }
4656
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004657 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004658 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004659 return;
4660 }
4661
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004662 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004663}
4664
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004665
4666/*
4667Public function, see header qcbor/qcbor_decode.h file
4668*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004669void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4670 int64_t nLabel,
4671 uint32_t uConvertTypes,
4672 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004673{
4674 QCBORItem Item;
4675
Laurence Lundblade93d89472020-10-03 22:30:50 -07004676 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4677 nLabel,
4678 uConvertTypes,
4679 pnValue,
4680 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004681
4682 if(pMe->uLastError == QCBOR_SUCCESS) {
4683 // The above conversion succeeded
4684 return;
4685 }
4686
4687 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4688 // The above conversion failed in a way that code below can't correct
4689 return;
4690 }
4691
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004692 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004693}
4694
4695
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004696/*
4697Public function, see header qcbor/qcbor_decode.h file
4698*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004699void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4700 const char *szLabel,
4701 uint32_t uConvertTypes,
4702 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004703{
4704 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004705 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4706 szLabel,
4707 uConvertTypes,
4708 pnValue,
4709 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004710
4711 if(pMe->uLastError == QCBOR_SUCCESS) {
4712 // The above conversion succeeded
4713 return;
4714 }
4715
4716 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4717 // The above conversion failed in a way that code below can't correct
4718 return;
4719 }
4720
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004721 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004722}
4723
4724
Laurence Lundblade93d89472020-10-03 22:30:50 -07004725static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004726{
4727 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004728 case QCBOR_TYPE_DOUBLE:
4729 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004730#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004731 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004732 // Can't use llround here because it will not convert values
4733 // greater than INT64_MAX and less than UINT64_MAX that
4734 // need to be converted so it is more complicated.
4735 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4736 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4737 if(isnan(pItem->val.dfnum)) {
4738 return QCBOR_ERR_FLOAT_EXCEPTION;
4739 } else if(pItem->val.dfnum < 0) {
4740 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4741 } else {
4742 double dRounded = round(pItem->val.dfnum);
4743 // See discussion in DecodeDateEpoch() for
4744 // explanation of - 0x7ff
4745 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4746 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4747 }
4748 *puValue = (uint64_t)dRounded;
4749 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004750 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004751 if(isnan(pItem->val.fnum)) {
4752 return QCBOR_ERR_FLOAT_EXCEPTION;
4753 } else if(pItem->val.fnum < 0) {
4754 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4755 } else {
4756 float fRounded = roundf(pItem->val.fnum);
4757 // See discussion in DecodeDateEpoch() for
4758 // explanation of - 0x7ff
4759 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4760 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4761 }
4762 *puValue = (uint64_t)fRounded;
4763 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004764 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004765 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4766 // round() and roundf() shouldn't result in exceptions here, but
4767 // catch them to be robust and thorough. Don't try to
4768 // distinguish between the various exceptions because it seems
4769 // they vary by CPU, compiler and OS.
4770 return QCBOR_ERR_FLOAT_EXCEPTION;
4771 }
4772
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004773 } else {
4774 return QCBOR_ERR_UNEXPECTED_TYPE;
4775 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004776#else
4777 return QCBOR_ERR_HW_FLOAT_DISABLED;
4778#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004779 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004780
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004781 case QCBOR_TYPE_INT64:
4782 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4783 if(pItem->val.int64 >= 0) {
4784 *puValue = (uint64_t)pItem->val.int64;
4785 } else {
4786 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4787 }
4788 } else {
4789 return QCBOR_ERR_UNEXPECTED_TYPE;
4790 }
4791 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004792
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004793 case QCBOR_TYPE_UINT64:
4794 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4795 *puValue = pItem->val.uint64;
4796 } else {
4797 return QCBOR_ERR_UNEXPECTED_TYPE;
4798 }
4799 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004800
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004801 default:
4802 return QCBOR_ERR_UNEXPECTED_TYPE;
4803 }
4804
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004805 return QCBOR_SUCCESS;
4806}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004807
4808
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004809void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004810 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004811 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004812 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004813{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004814 if(pMe->uLastError != QCBOR_SUCCESS) {
4815 return;
4816 }
4817
Laurence Lundbladec4537442020-04-14 18:53:22 -07004818 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004819
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004820 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4821 if(uError) {
4822 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004823 return;
4824 }
4825
Laurence Lundbladea826c502020-05-10 21:07:00 -07004826 if(pItem) {
4827 *pItem = Item;
4828 }
4829
Laurence Lundblade93d89472020-10-03 22:30:50 -07004830 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004831}
4832
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004833
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004834void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004835 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004836 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004837 uint64_t *puValue,
4838 QCBORItem *pItem)
4839{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004840 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004841 if(pMe->uLastError != QCBOR_SUCCESS) {
4842 return;
4843 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004844
Laurence Lundblade93d89472020-10-03 22:30:50 -07004845 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004846}
4847
4848
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004849void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004850 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004851 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004852 uint64_t *puValue,
4853 QCBORItem *pItem)
4854{
4855 if(pMe->uLastError != QCBOR_SUCCESS) {
4856 return;
4857 }
4858
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004859 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004860 if(pMe->uLastError != QCBOR_SUCCESS) {
4861 return;
4862 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004863
Laurence Lundblade93d89472020-10-03 22:30:50 -07004864 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004865}
4866
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004867
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004868
Laurence Lundblade93d89472020-10-03 22:30:50 -07004869static QCBORError
4870UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004871{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004872 switch(pItem->uDataType) {
4873
4874 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004875 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004876 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4877 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004878 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004879 }
4880 break;
4881
4882 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004883 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004884 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4885 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004886 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004887 }
4888 break;
4889
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004890#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004891
4892 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004893 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004894 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004895 pItem->val.expAndMantissa.nExponent,
4896 puValue,
4897 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004898 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004899 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004900 }
4901 break;
4902
4903 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004904 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004905 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4906 pItem->val.expAndMantissa.nExponent,
4907 puValue,
4908 Exponentitate2);
4909 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004910 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004911 }
4912 break;
4913
4914 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004915 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004916 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004917 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004918 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004919 if(uErr != QCBOR_SUCCESS) {
4920 return uErr;
4921 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004922 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004923 pItem->val.expAndMantissa.nExponent,
4924 puValue,
4925 Exponentitate10);
4926 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004927 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004928 }
4929 break;
4930
4931 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004932 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004933 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4934 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004935 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004936 }
4937 break;
4938
4939 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004940 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004941 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004942 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004943 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004944 if(uErr != QCBOR_SUCCESS) {
4945 return uErr;
4946 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004947 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004948 pItem->val.expAndMantissa.nExponent,
4949 puValue,
4950 Exponentitate2);
4951 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004952 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004953 }
4954 break;
4955
4956 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004957 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004958 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4959 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004960 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004961 }
4962 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004963#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004964 default:
4965 return QCBOR_ERR_UNEXPECTED_TYPE;
4966 }
4967}
4968
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004969
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004970/*
4971 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004972 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004973void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004974{
4975 QCBORItem Item;
4976
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004977 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004978
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004979 if(pMe->uLastError == QCBOR_SUCCESS) {
4980 // The above conversion succeeded
4981 return;
4982 }
4983
4984 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4985 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004986 return;
4987 }
4988
Laurence Lundblade93d89472020-10-03 22:30:50 -07004989 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004990}
4991
Laurence Lundbladec4537442020-04-14 18:53:22 -07004992
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004993/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004994 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004995*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004996void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004997 int64_t nLabel,
4998 uint32_t uConvertTypes,
4999 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005000{
5001 QCBORItem Item;
5002
Laurence Lundblade93d89472020-10-03 22:30:50 -07005003 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
5004 nLabel,
5005 uConvertTypes,
5006 puValue,
5007 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005008
5009 if(pMe->uLastError == QCBOR_SUCCESS) {
5010 // The above conversion succeeded
5011 return;
5012 }
5013
5014 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5015 // The above conversion failed in a way that code below can't correct
5016 return;
5017 }
5018
Laurence Lundblade93d89472020-10-03 22:30:50 -07005019 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005020}
5021
5022
5023/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005024 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005025*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07005026void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07005027 const char *szLabel,
5028 uint32_t uConvertTypes,
5029 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005030{
5031 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07005032 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
5033 szLabel,
5034 uConvertTypes,
5035 puValue,
5036 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005037
5038 if(pMe->uLastError == QCBOR_SUCCESS) {
5039 // The above conversion succeeded
5040 return;
5041 }
5042
5043 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5044 // The above conversion failed in a way that code below can't correct
5045 return;
5046 }
5047
Laurence Lundblade93d89472020-10-03 22:30:50 -07005048 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005049}
5050
5051
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07005052
5053
Laurence Lundblade9b334962020-08-27 10:55:53 -07005054static QCBORError ConvertDouble(const QCBORItem *pItem,
5055 uint32_t uConvertTypes,
5056 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005057{
5058 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005059 case QCBOR_TYPE_FLOAT:
5060#ifndef QCBOR_DISABLE_FLOAT_HW_USE
5061 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5062 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005063 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005064 *pdValue = (double)pItem->val.fnum;
5065 } else {
5066 return QCBOR_ERR_UNEXPECTED_TYPE;
5067 }
5068 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005069#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005070 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005071#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005072 break;
5073
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005074 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005075 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5076 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005077 *pdValue = pItem->val.dfnum;
5078 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005079 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005080 }
5081 }
5082 break;
5083
5084 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005085#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005086 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005087 // A simple cast seems to do the job with no worry of exceptions.
5088 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005089 *pdValue = (double)pItem->val.int64;
5090
5091 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005092 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005093 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005094#else
5095 return QCBOR_ERR_HW_FLOAT_DISABLED;
5096#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005097 break;
5098
5099 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005100#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005101 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005102 // A simple cast seems to do the job with no worry of exceptions.
5103 // There will be precision loss for some values.
5104 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005105 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005106 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005107 }
5108 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005109#else
5110 return QCBOR_ERR_HW_FLOAT_DISABLED;
5111#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005112
5113 default:
5114 return QCBOR_ERR_UNEXPECTED_TYPE;
5115 }
5116
5117 return QCBOR_SUCCESS;
5118}
5119
5120
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005121void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005122 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005123 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005124 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005125{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005126 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07005127 return;
5128 }
5129
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005130 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005131
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005132 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005133 if(uError) {
5134 pMe->uLastError = (uint8_t)uError;
5135 return;
5136 }
5137
5138 if(pItem) {
5139 *pItem = Item;
5140 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005141
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005142 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005143}
Laurence Lundbladec4537442020-04-14 18:53:22 -07005144
Laurence Lundbladec4537442020-04-14 18:53:22 -07005145
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005146void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
5147 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005148 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005149 double *pdValue,
5150 QCBORItem *pItem)
5151{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005152 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005153 if(pMe->uLastError != QCBOR_SUCCESS) {
5154 return;
5155 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005156
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005157 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005158}
5159
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005160
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005161void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
5162 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005163 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005164 double *pdValue,
5165 QCBORItem *pItem)
5166{
5167 if(pMe->uLastError != QCBOR_SUCCESS) {
5168 return;
5169 }
5170
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005171 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005172 if(pMe->uLastError != QCBOR_SUCCESS) {
5173 return;
5174 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005175
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005176 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005177}
5178
5179
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005180#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005181static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5182{
5183 double dResult;
5184
5185 dResult = 0.0;
5186 const uint8_t *pByte = BigNum.ptr;
5187 size_t uLen = BigNum.len;
5188 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005189 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005190 while(uLen--) {
5191 dResult = (dResult * 256.0) + (double)*pByte++;
5192 }
5193
5194 return dResult;
5195}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005196#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5197
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005198
Laurence Lundblade93d89472020-10-03 22:30:50 -07005199static QCBORError
5200DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005201{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005202#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005203 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005204 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5205
5206 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005207 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005208
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005209#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005210 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005211 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005212 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005213 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5214 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5215 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005216 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005217 }
5218 break;
5219
5220 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005221 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005222 // Underflow gives 0, overflow gives infinity
5223 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5224 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005225 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005226 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005227 }
5228 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005229#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005230
5231 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005232 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005233 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5234 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005235 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005236 }
5237 break;
5238
5239 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005240 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005241 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005242 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005243 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005244 }
5245 break;
5246
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005247#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005248 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005249 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005250 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5251 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5252 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005253 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005254 }
5255 break;
5256
5257 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005258 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005259 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5260 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5261 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005262 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005263 }
5264 break;
5265
5266 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005267 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005268 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5269 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5270 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005271 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005272 }
5273 break;
5274
5275 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005276 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005277 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005278 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5279 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005280 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005281 }
5282 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005283#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005284
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005285 default:
5286 return QCBOR_ERR_UNEXPECTED_TYPE;
5287 }
5288
5289 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005290
5291#else
5292 (void)pItem;
5293 (void)uConvertTypes;
5294 (void)pdValue;
5295 return QCBOR_ERR_HW_FLOAT_DISABLED;
5296#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5297
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005298}
5299
5300
5301/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005302 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005303*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005304void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5305 uint32_t uConvertTypes,
5306 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005307{
5308
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005309 QCBORItem Item;
5310
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005311 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005312
5313 if(pMe->uLastError == QCBOR_SUCCESS) {
5314 // The above conversion succeeded
5315 return;
5316 }
5317
5318 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5319 // The above conversion failed in a way that code below can't correct
5320 return;
5321 }
5322
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005323 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005324}
5325
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005326
5327/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005328 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005329*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005330void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5331 int64_t nLabel,
5332 uint32_t uConvertTypes,
5333 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005334{
5335 QCBORItem Item;
5336
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005337 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005338
5339 if(pMe->uLastError == QCBOR_SUCCESS) {
5340 // The above conversion succeeded
5341 return;
5342 }
5343
5344 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5345 // The above conversion failed in a way that code below can't correct
5346 return;
5347 }
5348
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005349 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005350}
5351
5352
5353/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005354 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005355*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005356void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5357 const char *szLabel,
5358 uint32_t uConvertTypes,
5359 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005360{
5361 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005362 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005363
5364 if(pMe->uLastError == QCBOR_SUCCESS) {
5365 // The above conversion succeeded
5366 return;
5367 }
5368
5369 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5370 // The above conversion failed in a way that code below can't correct
5371 return;
5372 }
5373
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005374 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005375}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005376
5377
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005378
5379
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005380#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005381static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5382{
5383 while((uInt & 0xff00000000000000UL) == 0) {
5384 uInt = uInt << 8;
5385 };
5386
5387 UsefulOutBuf UOB;
5388
5389 UsefulOutBuf_Init(&UOB, Buffer);
5390
5391 while(uInt) {
5392 const uint64_t xx = uInt & 0xff00000000000000UL;
5393 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5394 uInt = uInt << 8;
5395 (void)xx;
5396 }
5397
5398 return UsefulOutBuf_OutUBuf(&UOB);
5399}
5400
5401
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005402static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5403 TagSpecification TagSpec,
5404 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005405{
5406 QCBORError uErr;
5407 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005408 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005409 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005410 if(uErr != QCBOR_SUCCESS) {
5411 goto Done;
5412 }
5413
5414 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5415 break; // Successful exit. Moving on to finish decoding.
5416 }
5417
5418 // The item is an array, which means an undecoded
5419 // mantissa and exponent, so decode it. It will then
5420 // have a different type and exit the loop if.
5421 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5422 if(uErr != QCBOR_SUCCESS) {
5423 goto Done;
5424 }
5425
5426 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005427 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005428 }
5429Done:
5430 return uErr;
5431}
5432
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005433
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005434static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005435 TagSpecification TagSpec,
5436 QCBORItem *pItem,
5437 int64_t *pnMantissa,
5438 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005439{
5440 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005441
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005442 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005443 if(uErr != QCBOR_SUCCESS) {
5444 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005445 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005446
Laurence Lundblade9b334962020-08-27 10:55:53 -07005447 switch (pItem->uDataType) {
5448
5449 case QCBOR_TYPE_DECIMAL_FRACTION:
5450 case QCBOR_TYPE_BIGFLOAT:
5451 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5452 *pnExponent = pItem->val.expAndMantissa.nExponent;
5453 break;
5454
5455 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5456 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5457 *pnExponent = pItem->val.expAndMantissa.nExponent;
5458 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5459 break;
5460
5461 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5462 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5463 *pnExponent = pItem->val.expAndMantissa.nExponent;
5464 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5465 break;
5466
5467 default:
5468 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5469 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005470
5471 Done:
5472 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005473}
5474
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005475
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005476static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005477 TagSpecification TagSpec,
5478 QCBORItem *pItem,
5479 UsefulBuf BufferForMantissa,
5480 UsefulBufC *pMantissa,
5481 bool *pbIsNegative,
5482 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005483{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005484 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005485
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005486 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005487 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005488 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005489 }
5490
5491 uint64_t uMantissa;
5492
5493 switch (pItem->uDataType) {
5494
5495 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005496 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005497 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5498 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5499 *pbIsNegative = false;
5500 } else {
5501 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5502 *pbIsNegative = true;
5503 }
5504 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5505 *pnExponent = pItem->val.expAndMantissa.nExponent;
5506 break;
5507
5508 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005509 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005510 *pnExponent = pItem->val.expAndMantissa.nExponent;
5511 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5512 *pbIsNegative = false;
5513 break;
5514
5515 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005516 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005517 *pnExponent = pItem->val.expAndMantissa.nExponent;
5518 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5519 *pbIsNegative = true;
5520 break;
5521
5522 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005523 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005524 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005525
5526Done:
5527 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005528}
5529
5530
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005531/*
5532 Public function, see header qcbor/qcbor_decode.h file
5533*/
5534void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5535 uint8_t uTagRequirement,
5536 int64_t *pnMantissa,
5537 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005538{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005539 if(pMe->uLastError != QCBOR_SUCCESS) {
5540 return;
5541 }
5542
5543 QCBORItem Item;
5544 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5545 if(uError) {
5546 pMe->uLastError = (uint8_t)uError;
5547 return;
5548 }
5549
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005550 const TagSpecification TagSpec =
5551 {
5552 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005553 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5554 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5555 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005556 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005557
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005558 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005559}
5560
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005561
5562/*
5563 Public function, see header qcbor/qcbor_decode.h file
5564*/
5565void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005566 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005567 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005568 int64_t *pnMantissa,
5569 int64_t *pnExponent)
5570{
5571 if(pMe->uLastError != QCBOR_SUCCESS) {
5572 return;
5573 }
5574
5575 QCBORItem Item;
5576 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5577
5578 const TagSpecification TagSpec =
5579 {
5580 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005581 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5582 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5583 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005584 };
5585
5586 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5587}
5588
5589
5590/*
5591 Public function, see header qcbor/qcbor_decode.h file
5592*/
5593void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005594 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005595 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005596 int64_t *pnMantissa,
5597 int64_t *pnExponent)
5598{
5599 if(pMe->uLastError != QCBOR_SUCCESS) {
5600 return;
5601 }
5602
5603 QCBORItem Item;
5604 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5605
5606 const TagSpecification TagSpec =
5607 {
5608 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005609 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5610 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5611 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005612 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005613
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005614 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5615}
5616
5617
5618/*
5619 Public function, see header qcbor/qcbor_decode.h file
5620*/
5621void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5622 uint8_t uTagRequirement,
5623 UsefulBuf MantissaBuffer,
5624 UsefulBufC *pMantissa,
5625 bool *pbMantissaIsNegative,
5626 int64_t *pnExponent)
5627{
5628 if(pMe->uLastError != QCBOR_SUCCESS) {
5629 return;
5630 }
5631
5632 QCBORItem Item;
5633 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5634 if(uError) {
5635 pMe->uLastError = (uint8_t)uError;
5636 return;
5637 }
5638
5639 const TagSpecification TagSpec =
5640 {
5641 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005642 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5643 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5644 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005645 };
5646
Laurence Lundblade93d89472020-10-03 22:30:50 -07005647 ProcessMantissaAndExponentBig(pMe,
5648 TagSpec,
5649 &Item,
5650 MantissaBuffer,
5651 pMantissa,
5652 pbMantissaIsNegative,
5653 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005654}
5655
5656
5657/*
5658 Public function, see header qcbor/qcbor_decode.h file
5659*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005660void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005661 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005662 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005663 UsefulBuf BufferForMantissa,
5664 UsefulBufC *pMantissa,
5665 bool *pbIsNegative,
5666 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005667{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005668 if(pMe->uLastError != QCBOR_SUCCESS) {
5669 return;
5670 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005671
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005672 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005673 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005674 if(pMe->uLastError != QCBOR_SUCCESS) {
5675 return;
5676 }
5677
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005678 const TagSpecification TagSpec =
5679 {
5680 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005681 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5682 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5683 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005684 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005685
Laurence Lundblade93d89472020-10-03 22:30:50 -07005686 ProcessMantissaAndExponentBig(pMe,
5687 TagSpec,
5688 &Item,
5689 BufferForMantissa,
5690 pMantissa,
5691 pbIsNegative,
5692 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005693}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005694
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005695
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005696/*
5697 Public function, see header qcbor/qcbor_decode.h file
5698*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005699void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005700 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005701 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005702 UsefulBuf BufferForMantissa,
5703 UsefulBufC *pMantissa,
5704 bool *pbIsNegative,
5705 int64_t *pnExponent)
5706{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005707 if(pMe->uLastError != QCBOR_SUCCESS) {
5708 return;
5709 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005710
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005711 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005712 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5713 if(pMe->uLastError != QCBOR_SUCCESS) {
5714 return;
5715 }
5716
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005717 const TagSpecification TagSpec =
5718 {
5719 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005720 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5721 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5722 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005723 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005724
5725 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5726}
5727
5728
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005729/*
5730 Public function, see header qcbor/qcbor_decode.h file
5731*/
5732void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5733 uint8_t uTagRequirement,
5734 int64_t *pnMantissa,
5735 int64_t *pnExponent)
5736{
5737 if(pMe->uLastError != QCBOR_SUCCESS) {
5738 return;
5739 }
5740
5741 QCBORItem Item;
5742 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5743 if(uError) {
5744 pMe->uLastError = (uint8_t)uError;
5745 return;
5746 }
5747 const TagSpecification TagSpec =
5748 {
5749 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005750 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5751 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5752 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005753 };
5754
5755 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5756}
5757
5758
5759/*
5760 Public function, see header qcbor/qcbor_decode.h file
5761*/
5762void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005763 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005764 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005765 int64_t *pnMantissa,
5766 int64_t *pnExponent)
5767{
5768 if(pMe->uLastError != QCBOR_SUCCESS) {
5769 return;
5770 }
5771
5772 QCBORItem Item;
5773 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5774 if(pMe->uLastError != QCBOR_SUCCESS) {
5775 return;
5776 }
5777
5778 const TagSpecification TagSpec =
5779 {
5780 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005781 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5782 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5783 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005784 };
5785
5786 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5787}
5788
5789
5790/*
5791 Public function, see header qcbor/qcbor_decode.h file
5792*/
5793void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005794 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005795 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005796 int64_t *pnMantissa,
5797 int64_t *pnExponent)
5798{
5799 if(pMe->uLastError != QCBOR_SUCCESS) {
5800 return;
5801 }
5802
5803 QCBORItem Item;
5804 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5805 if(pMe->uLastError != QCBOR_SUCCESS) {
5806 return;
5807 }
5808
5809 const TagSpecification TagSpec =
5810 {
5811 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005812 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5813 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5814 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005815 };
5816
5817 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5818}
5819
5820
5821/*
5822 Public function, see header qcbor/qcbor_decode.h file
5823*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005824void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5825 uint8_t uTagRequirement,
5826 UsefulBuf MantissaBuffer,
5827 UsefulBufC *pMantissa,
5828 bool *pbMantissaIsNegative,
5829 int64_t *pnExponent)
5830{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005831 if(pMe->uLastError != QCBOR_SUCCESS) {
5832 return;
5833 }
5834
5835 QCBORItem Item;
5836 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5837 if(uError) {
5838 pMe->uLastError = (uint8_t)uError;
5839 return;
5840 }
5841
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005842 const TagSpecification TagSpec =
5843 {
5844 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005845 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5846 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5847 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005848 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005849
5850 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005851}
5852
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005853
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005854/*
5855 Public function, see header qcbor/qcbor_decode.h file
5856*/
5857void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005858 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005859 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005860 UsefulBuf BufferForMantissa,
5861 UsefulBufC *pMantissa,
5862 bool *pbIsNegative,
5863 int64_t *pnExponent)
5864{
5865 if(pMe->uLastError != QCBOR_SUCCESS) {
5866 return;
5867 }
5868
5869 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005870 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5871 if(pMe->uLastError != QCBOR_SUCCESS) {
5872 return;
5873 }
5874
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005875 const TagSpecification TagSpec =
5876 {
5877 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005878 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5879 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5880 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005881 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005882
Laurence Lundblade93d89472020-10-03 22:30:50 -07005883 ProcessMantissaAndExponentBig(pMe,
5884 TagSpec,
5885 &Item,
5886 BufferForMantissa,
5887 pMantissa,
5888 pbIsNegative,
5889 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005890}
5891
5892
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005893/*
5894 Public function, see header qcbor/qcbor_decode.h file
5895*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005896void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005897 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005898 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005899 UsefulBuf BufferForMantissa,
5900 UsefulBufC *pMantissa,
5901 bool *pbIsNegative,
5902 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005903{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005904 if(pMe->uLastError != QCBOR_SUCCESS) {
5905 return;
5906 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005907
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005908 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005909 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5910 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005911 return;
5912 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005913
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005914 const TagSpecification TagSpec =
5915 {
5916 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005917 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5918 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5919 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005920 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005921
Laurence Lundblade93d89472020-10-03 22:30:50 -07005922 ProcessMantissaAndExponentBig(pMe,
5923 TagSpec,
5924 &Item,
5925 BufferForMantissa,
5926 pMantissa,
5927 pbIsNegative,
5928 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005929}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005930
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005931#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */