blob: b3301c789245cd666bbabbe5d183dd157a702b14 [file] [log] [blame]
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001/*==============================================================================
Laurence Lundbladed92a6162018-11-01 11:38:35 +07002 Copyright (c) 2016-2018, The Linux Foundation.
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003 Copyright (c) 2018-2021, Laurence Lundblade.
Laurence Lundbladed92a6162018-11-01 11:38:35 +07004 All rights reserved.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08005
Laurence Lundblade0dbc9172018-11-01 14:17:21 +07006Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are
8met:
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above
12 copyright notice, this list of conditions and the following
13 disclaimer in the documentation and/or other materials provided
14 with the distribution.
15 * Neither the name of The Linux Foundation nor the names of its
16 contributors, nor the name "Laurence Lundblade" may be used to
17 endorse or promote products derived from this software without
18 specific prior written permission.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080019
Laurence Lundblade0dbc9172018-11-01 14:17:21 +070020THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
21WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Laurence Lundbladeee851742020-01-08 08:37:05 -080031 =============================================================================*/
Laurence Lundblade624405d2018-09-18 20:10:47 -070032
Laurence Lundblade3aee3a32018-12-17 16:17:45 -080033
Laurence Lundblade844bb5c2020-03-01 17:27:25 -080034#include "qcbor/qcbor_decode.h"
Laurence Lundblade67257dc2020-07-27 03:33:37 -070035#include "qcbor/qcbor_spiffy_decode.h"
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080036#include "ieee754.h" /* Does not use math.h */
Laurence Lundbladec7114722020-08-13 05:11:40 -070037
38#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080039
40#include <math.h> /* For isnan(), llround(), llroudf(), round(), roundf(),
41 * pow(), exp2()
42 */
43#include <fenv.h> /* feclearexcept(), fetestexcept() */
44
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080045#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070046
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070047
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080048
Laurence Lundbladea9489f82020-09-12 13:50:56 -070049#define SIZEOF_C_ARRAY(array,type) (sizeof(array)/sizeof(type))
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070050
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070051
Laurence Lundblade3f1318a2021-01-04 18:26:44 -080052
53
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070054static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070055QCBORItem_IsMapOrArray(const QCBORItem *pMe)
56{
57 const uint8_t uDataType = pMe->uDataType;
58 return uDataType == QCBOR_TYPE_MAP ||
59 uDataType == QCBOR_TYPE_ARRAY ||
60 uDataType == QCBOR_TYPE_MAP_AS_ARRAY;
61}
62
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070063static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070064QCBORItem_IsEmptyDefiniteLengthMapOrArray(const QCBORItem *pMe)
65{
66 if(!QCBORItem_IsMapOrArray(pMe)){
67 return false;
68 }
69
70 if(pMe->val.uCount != 0) {
71 return false;
72 }
73 return true;
74}
75
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -070076static inline bool
Laurence Lundblade02625d42020-06-25 14:41:41 -070077QCBORItem_IsIndefiniteLengthMapOrArray(const QCBORItem *pMe)
78{
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080079#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade02625d42020-06-25 14:41:41 -070080 if(!QCBORItem_IsMapOrArray(pMe)){
81 return false;
82 }
83
84 if(pMe->val.uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
85 return false;
86 }
87 return true;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -080088#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
89 (void)pMe;
90 return false;
91#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade02625d42020-06-25 14:41:41 -070092}
93
94
Laurence Lundbladeee851742020-01-08 08:37:05 -080095/*===========================================================================
Laurence Lundbladea8edadb2020-06-27 22:35:37 -070096 DecodeNesting -- Tracking array/map/sequence/bstr-wrapped nesting
Laurence Lundbladeee851742020-01-08 08:37:05 -080097 ===========================================================================*/
98
Laurence Lundblade9c905e82020-04-25 11:31:38 -070099/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800100 * See comments about and typedef of QCBORDecodeNesting in qcbor_private.h,
101 * the data structure all these functions work on.
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700102 */
103
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700104
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700105static inline uint8_t
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700106DecodeNesting_GetCurrentLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700107{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700108 const ptrdiff_t nLevel = pNesting->pCurrent - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800109 /* Limit in DecodeNesting_Descend against more than
110 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700111 */
Laurence Lundblade5e87da62020-06-07 03:24:28 -0700112 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700113}
114
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700115
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700116static inline uint8_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700117DecodeNesting_GetBoundedModeLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700118{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700119 const ptrdiff_t nLevel = pNesting->pCurrentBounded - &(pNesting->pLevels[0]);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800120 /* Limit in DecodeNesting_Descend against more than
121 * QCBOR_MAX_ARRAY_NESTING gaurantees cast is safe
Laurence Lundblade02625d42020-06-25 14:41:41 -0700122 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700123 return (uint8_t)nLevel;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700124}
125
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700126
Laurence Lundblade5f4e8712020-07-25 11:44:43 -0700127static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700128DecodeNesting_GetMapOrArrayStart(const QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700129{
130 return pNesting->pCurrentBounded->u.ma.uStartOffset;
131}
132
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700133
Laurence Lundblade085d7952020-07-24 10:26:30 -0700134static inline bool
135DecodeNesting_IsBoundedEmpty(const QCBORDecodeNesting *pNesting)
136{
137 if(pNesting->pCurrentBounded->u.ma.uCountCursor == QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
138 return true;
139 } else {
140 return false;
141 }
142}
143
144
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700145static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700146DecodeNesting_IsCurrentAtTop(const QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700147{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700148 if(pNesting->pCurrent == &(pNesting->pLevels[0])) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700149 return true;
150 } else {
151 return false;
152 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700153}
154
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700155
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700156static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700157DecodeNesting_IsCurrentDefiniteLength(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700158{
159 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800160 /* Not a map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700161 return false;
162 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800163
164#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700165 if(pNesting->pCurrent->u.ma.uCountTotal == QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800166 /* Is indefinite */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700167 return false;
168 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800169
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800170#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
171
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800172 /* All checks passed; is a definte length map or array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700173 return true;
174}
175
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700176static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700177DecodeNesting_IsCurrentBstrWrapped(const QCBORDecodeNesting *pNesting)
Laurence Lundblade642282a2020-06-23 12:00:33 -0700178{
179 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800180 /* is a byte string */
Laurence Lundblade642282a2020-06-23 12:00:33 -0700181 return true;
182 }
183 return false;
184}
185
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700186
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700187static inline bool DecodeNesting_IsCurrentBounded(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700188{
189 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
190 return true;
191 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700192 if(pNesting->pCurrent->u.ma.uStartOffset != QCBOR_NON_BOUNDED_OFFSET) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700193 return true;
194 }
195 return false;
196}
197
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700198
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700199static inline void DecodeNesting_SetMapOrArrayBoundedMode(QCBORDecodeNesting *pNesting, bool bIsEmpty, size_t uStart)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700200{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800201 /* Should be only called on maps and arrays */
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700202 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800203 * DecodeNesting_EnterBoundedMode() checks to be sure uStart is not
204 * larger than DecodeNesting_EnterBoundedMode which keeps it less than
205 * uin32_t so the cast is safe.
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700206 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700207 pNesting->pCurrent->u.ma.uStartOffset = (uint32_t)uStart;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700208
209 if(bIsEmpty) {
210 pNesting->pCurrent->u.ma.uCountCursor = QCBOR_COUNT_INDICATES_ZERO_LENGTH;
211 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700212}
213
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700214
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700215static inline void DecodeNesting_ClearBoundedMode(QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700216{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700217 pNesting->pCurrent->u.ma.uStartOffset = QCBOR_NON_BOUNDED_OFFSET;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700218}
219
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700220
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700221static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700222DecodeNesting_IsAtEndOfBoundedLevel(const QCBORDecodeNesting *pNesting)
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700223{
224 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800225 /* No bounded map or array set up */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700226 return false;
227 }
228 if(pNesting->pCurrent->uLevelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800229 /* Not a map or array; end of those is by byte count */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700230 return false;
231 }
Laurence Lundblade6ab01fb2020-10-01 13:04:49 -0700232 if(!DecodeNesting_IsCurrentBounded(pNesting)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800233 /* In a traveral at a level deeper than the bounded level */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700234 return false;
235 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800236 /* Works for both definite- and indefinitelength maps/arrays */
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800237 if(pNesting->pCurrentBounded->u.ma.uCountCursor != 0 &&
238 pNesting->pCurrentBounded->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800239 /* Count is not zero, still unconsumed item */
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700240 return false;
241 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800242 /* All checks passed, got to the end of an array or map*/
Laurence Lundblade2c1faf92020-06-26 22:43:56 -0700243 return true;
244}
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700245
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700246
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700247static inline bool
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700248DecodeNesting_IsEndOfDefiniteLengthMapOrArray(const QCBORDecodeNesting *pNesting)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700249{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800250 /* Must only be called on map / array */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700251 if(pNesting->pCurrent->u.ma.uCountCursor == 0) {
252 return true;
Laurence Lundblade9c905e82020-04-25 11:31:38 -0700253 } else {
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700254 return false;
255 }
Laurence Lundblade3f9ef042020-04-14 13:15:51 -0700256}
257
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700258
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700259static inline bool
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700260DecodeNesting_IsCurrentTypeMap(const QCBORDecodeNesting *pNesting)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700261{
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700262 if(pNesting->pCurrent->uLevelType == CBOR_MAJOR_TYPE_MAP) {
263 return true;
264 } else {
265 return false;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700266 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700267}
268
Laurence Lundblade410c7e02020-06-25 23:35:29 -0700269
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700270static inline bool
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700271DecodeNesting_IsBoundedType(const QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700272{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700273 if(pNesting->pCurrentBounded == NULL) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700274 return false;
275 }
Laurence Lundblade02625d42020-06-25 14:41:41 -0700276
277 if(pNesting->pCurrentBounded->uLevelType != uType) {
278 return false;
279 }
280
281 return true;
Laurence Lundblade2b843b52020-06-16 20:51:03 -0700282}
283
Laurence Lundblade02625d42020-06-25 14:41:41 -0700284
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700285static inline void
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700286DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700287{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800288 /* Only call on a definite-length array / map */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700289 pNesting->pCurrent->u.ma.uCountCursor--;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -0700290}
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700291
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700292
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700293static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700294DecodeNesting_ReverseDecrement(QCBORDecodeNesting *pNesting)
295{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800296 /* Only call on a definite-length array / map */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700297 pNesting->pCurrent->u.ma.uCountCursor++;
298}
299
300
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700301static inline void
Laurence Lundblade0a042a92020-06-12 14:09:50 -0700302DecodeNesting_Ascend(QCBORDecodeNesting *pNesting)
303{
304 pNesting->pCurrent--;
305}
306
Laurence Lundblade02625d42020-06-25 14:41:41 -0700307
308static QCBORError
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700309DecodeNesting_Descend(QCBORDecodeNesting *pNesting, uint8_t uType)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700310{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800311 /* Error out if nesting is too deep */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700312 if(pNesting->pCurrent >= &(pNesting->pLevels[QCBOR_MAX_ARRAY_NESTING])) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700313 return QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP;
Laurence Lundblade02625d42020-06-25 14:41:41 -0700314 }
315
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800316 /* The actual descend */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700317 pNesting->pCurrent++;
318
319 pNesting->pCurrent->uLevelType = uType;
320
321 return QCBOR_SUCCESS;
322}
323
324
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700325static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800326DecodeNesting_EnterBoundedMapOrArray(QCBORDecodeNesting *pNesting,
327 bool bIsEmpty,
328 size_t uOffset)
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700329{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700330 /*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800331 * Should only be called on map/array.
332 *
333 * Have descended into this before this is called. The job here is
334 * just to mark it in bounded mode.
335 *
336 * Check against QCBOR_MAX_DECODE_INPUT_SIZE make sure that
337 * uOffset doesn't collide with QCBOR_NON_BOUNDED_OFFSET.
338 *
339 * Cast of uOffset to uint32_t for cases where SIZE_MAX < UINT32_MAX.
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700340 */
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -0800341 if((uint32_t)uOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700342 return QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700343 }
344
Laurence Lundblade0750fc42020-06-20 21:02:34 -0700345 pNesting->pCurrentBounded = pNesting->pCurrent;
Laurence Lundblade085d7952020-07-24 10:26:30 -0700346
347 DecodeNesting_SetMapOrArrayBoundedMode(pNesting, bIsEmpty, uOffset);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -0700348
349 return QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -0700350}
351
Laurence Lundblade64b607e2020-05-13 13:05:57 -0700352
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700353static inline QCBORError
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700354DecodeNesting_DescendMapOrArray(QCBORDecodeNesting *pNesting,
Laurence Lundblade02625d42020-06-25 14:41:41 -0700355 uint8_t uQCBORType,
356 uint64_t uCount)
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700357{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700358 QCBORError uError = QCBOR_SUCCESS;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700359
360 if(uCount == 0) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800361 /* Nothing to do for empty definite-length arrays. They are just are
362 * effectively the same as an item that is not a map or array.
363 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700364 goto Done;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800365 /* Empty indefinite-length maps and arrays are handled elsewhere */
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700366 }
367
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800368 /* Error out if arrays is too long to handle */
Laurence Lundblade02625d42020-06-25 14:41:41 -0700369 if(uCount != QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH &&
370 uCount > QCBOR_MAX_ITEMS_IN_ARRAY) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -0700371 uError = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700372 goto Done;
373 }
374
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700375 uError = DecodeNesting_Descend(pNesting, uQCBORType);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700376 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700377 goto Done;
378 }
379
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800380 /* Fill in the new map/array level. Check above makes casts OK. */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -0700381 pNesting->pCurrent->u.ma.uCountCursor = (uint16_t)uCount;
382 pNesting->pCurrent->u.ma.uCountTotal = (uint16_t)uCount;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700383
384 DecodeNesting_ClearBoundedMode(pNesting);
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700385
386Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700387 return uError;;
388}
389
390
391static inline void
392DecodeNesting_LevelUpCurrent(QCBORDecodeNesting *pNesting)
393{
394 pNesting->pCurrent = pNesting->pCurrentBounded - 1;
395}
396
397
398static inline void
399DecodeNesting_LevelUpBounded(QCBORDecodeNesting *pNesting)
400{
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700401 while(pNesting->pCurrentBounded != &(pNesting->pLevels[0])) {
Laurence Lundblade02625d42020-06-25 14:41:41 -0700402 pNesting->pCurrentBounded--;
403 if(DecodeNesting_IsCurrentBounded(pNesting)) {
404 break;
405 }
406 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700407}
408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800409
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700410static inline void
411DecodeNesting_SetCurrentToBoundedLevel(QCBORDecodeNesting *pNesting)
412{
413 pNesting->pCurrent = pNesting->pCurrentBounded;
414}
415
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700416
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700417static inline QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -0700418DecodeNesting_DescendIntoBstrWrapped(QCBORDecodeNesting *pNesting,
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700419 uint32_t uEndOffset,
420 uint32_t uStartOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700421{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700422 QCBORError uError;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700423
Laurence Lundbladee6f15112020-07-23 18:44:16 -0700424 uError = DecodeNesting_Descend(pNesting, QCBOR_TYPE_BYTE_STRING);
Laurence Lundblade02625d42020-06-25 14:41:41 -0700425 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700426 goto Done;
427 }
428
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800429 /* Fill in the new byte string level */
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700430 pNesting->pCurrent->u.bs.uSavedEndOffset = uEndOffset;
431 pNesting->pCurrent->u.bs.uBstrStartOffset = uStartOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700432
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800433 /* Bstr wrapped levels are always bounded */
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700434 pNesting->pCurrentBounded = pNesting->pCurrent;
435
436Done:
Laurence Lundblade02625d42020-06-25 14:41:41 -0700437 return uError;;
438}
439
Laurence Lundbladed0304932020-06-27 10:59:38 -0700440
441static inline void
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700442DecodeNesting_ZeroMapOrArrayCount(QCBORDecodeNesting *pNesting)
Laurence Lundblade02625d42020-06-25 14:41:41 -0700443{
444 pNesting->pCurrent->u.ma.uCountCursor = 0;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700445}
446
Laurence Lundblade24d509a2020-06-06 18:43:15 -0700447
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700448static inline void
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800449DecodeNesting_ResetMapOrArrayCount(QCBORDecodeNesting *pNesting)
450{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700451 if(pNesting->pCurrent->u.ma.uCountCursor != QCBOR_COUNT_INDICATES_ZERO_LENGTH) {
452 pNesting->pCurrentBounded->u.ma.uCountCursor = pNesting->pCurrentBounded->u.ma.uCountTotal;
453 }
Laurence Lundbladeddebabe2020-11-22 11:32:17 -0800454}
455
456
457static inline void
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700458DecodeNesting_Init(QCBORDecodeNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700459{
Laurence Lundblade02625d42020-06-25 14:41:41 -0700460 /* Assumes that *pNesting has been zero'd before this call. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700461 pNesting->pLevels[0].uLevelType = QCBOR_TYPE_BYTE_STRING;
462 pNesting->pCurrent = &(pNesting->pLevels[0]);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700463}
464
465
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700466static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800467DecodeNesting_PrepareForMapSearch(QCBORDecodeNesting *pNesting,
468 QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700469{
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -0700470 *pSave = *pNesting;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700471}
472
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700473
Laurence Lundblade02625d42020-06-25 14:41:41 -0700474static inline void
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800475DecodeNesting_RestoreFromMapSearch(QCBORDecodeNesting *pNesting,
476 const QCBORDecodeNesting *pSave)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -0700477{
478 *pNesting = *pSave;
479}
480
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700481
Laurence Lundblade02625d42020-06-25 14:41:41 -0700482static inline uint32_t
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700483DecodeNesting_GetPreviousBoundedEnd(const QCBORDecodeNesting *pMe)
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700484{
Laurence Lundbladecf41c522021-02-20 10:19:07 -0700485 return pMe->pCurrentBounded->u.bs.uSavedEndOffset;
Laurence Lundblade1d85d522020-06-22 13:24:59 -0700486}
487
488
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800489
490
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800491#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladeee851742020-01-08 08:37:05 -0800492/*===========================================================================
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800493 QCBORStringAllocate -- STRING ALLOCATOR INVOCATION
494
495 The following four functions are pretty wrappers for invocation of
496 the string allocator supplied by the caller.
497
Laurence Lundbladeee851742020-01-08 08:37:05 -0800498 ===========================================================================*/
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800499
Laurence Lundbladeee851742020-01-08 08:37:05 -0800500static inline void
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800501StringAllocator_Free(const QCBORInternalAllocator *pMe, const void *pMem)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800502{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800503 /* These pragmas allow the "-Wcast-qual" warnings flag to be set for
504 * gcc and clang. This is the one place where the const needs to be
505 * cast away so const can be use in the rest of the code.
506 */
507#pragma GCC diagnostic push
508#pragma GCC diagnostic ignored "-Wcast-qual"
509 (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, 0);
510#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800511}
512
Laurence Lundbladeee851742020-01-08 08:37:05 -0800513// StringAllocator_Reallocate called with pMem NULL is
514// equal to StringAllocator_Allocate()
515static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800516StringAllocator_Reallocate(const QCBORInternalAllocator *pMe,
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800517 const void *pMem,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800518 size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800519{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800520 /* See comment in StringAllocator_Free() */
521#pragma GCC diagnostic push
522#pragma GCC diagnostic ignored "-Wcast-qual"
523 return (pMe->pfAllocator)(pMe->pAllocateCxt, (void *)pMem, uSize);
524#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800525}
526
Laurence Lundbladeee851742020-01-08 08:37:05 -0800527static inline UsefulBuf
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800528StringAllocator_Allocate(const QCBORInternalAllocator *pMe, size_t uSize)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800529{
530 return (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, uSize);
531}
532
Laurence Lundbladeee851742020-01-08 08:37:05 -0800533static inline void
Laurence Lundblade3a691a02020-12-28 04:15:16 -0800534StringAllocator_Destruct(const QCBORInternalAllocator *pMe)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800535{
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800536 /* See comment in StringAllocator_Free() */
537#pragma GCC diagnostic push
538#pragma GCC diagnostic ignored "-Wcast-qual"
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800539 if(pMe->pfAllocator) {
540 (pMe->pfAllocator)(pMe->pAllocateCxt, NULL, 0);
541 }
Laurence Lundbladeb9702452021-03-08 21:02:57 -0800542#pragma GCC diagnostic pop
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800543}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800544#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800545
546
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800547
548
Laurence Lundbladeee851742020-01-08 08:37:05 -0800549/*===========================================================================
550 QCBORDecode -- The main implementation of CBOR decoding
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700551
Laurence Lundblade844bb5c2020-03-01 17:27:25 -0800552 See qcbor/qcbor_decode.h for definition of the object
553 used here: QCBORDecodeContext
Laurence Lundbladeee851742020-01-08 08:37:05 -0800554 ===========================================================================*/
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700555/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800556 * Public function, see header file
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700557 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800558void QCBORDecode_Init(QCBORDecodeContext *pMe,
559 UsefulBufC EncodedCBOR,
560 QCBORDecodeMode nDecodeMode)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700561{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800562 memset(pMe, 0, sizeof(QCBORDecodeContext));
563 UsefulInputBuf_Init(&(pMe->InBuf), EncodedCBOR);
564 /* Don't bother with error check on decode mode. If a bad value is
565 * passed it will just act as if the default normal mode of 0 was set.
566 */
567 pMe->uDecodeMode = (uint8_t)nDecodeMode;
568 DecodeNesting_Init(&(pMe->nesting));
569
570 /* Inialize me->auMappedTags to CBOR_TAG_INVALID16. See
571 * GetNext_TaggedItem() and MapTagNumber(). */
572 memset(pMe->auMappedTags, 0xff, sizeof(pMe->auMappedTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700573}
574
575
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800576#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
577
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800579 * Public function, see header file
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700580 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800581void QCBORDecode_SetUpAllocator(QCBORDecodeContext *pMe,
582 QCBORStringAllocate pfAllocateFunction,
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800583 void *pAllocateContext,
584 bool bAllStrings)
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700585{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800586 pMe->StringAllocator.pfAllocator = pfAllocateFunction;
587 pMe->StringAllocator.pAllocateCxt = pAllocateContext;
588 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700589}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800590#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700591
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800592
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800593
594
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800595/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800596 * Deprecated public function, see header file
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800597 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800598void QCBORDecode_SetCallerConfiguredTagList(QCBORDecodeContext *pMe,
Laurence Lundbladeee851742020-01-08 08:37:05 -0800599 const QCBORTagListIn *pTagList)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700600{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800601 /* This does nothing now. It is retained for backwards compatibility */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -0700602 (void)pMe;
603 (void)pTagList;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +0700604}
605
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700606
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800607
608
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700609/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800610 * Decoding items is done in six layers, one calling the next one
611 * down. If a layer has no work to do for a particular item, it
612 * returns quickly.
613 *
614 * 1. QCBORDecode_GetNextTagContent - The top layer processes tagged
615 * data items, turning them into the local C representation. For the
616 * most simple it is just associating a QCBOR_TYPE with the data. For
617 * the complex ones that an aggregate of data items, there is some
618 * further decoding and some limited recursion.
619 *
620 * 2. QCBORDecode_GetNextMapOrArray - This manages the beginnings and
621 * ends of maps and arrays. It tracks descending into and ascending
622 * out of maps/arrays. It processes breaks that terminate
623 * indefinite-length maps and arrays.
624 *
625 * 3. QCBORDecode_GetNextMapEntry - This handles the combining of two
626 * items, the label and the data, that make up a map entry. It only
627 * does work on maps. It combines the label and data items into one
628 * labeled item.
629 *
630 * 4. QCBORDecode_GetNextTagNumber - This decodes type 6 tag
631 * numbers. It turns the tag numbers into bit flags associated with
632 * the data item. No actual decoding of the contents of the tag is
633 * performed here.
634 *
635 * 5. QCBORDecode_GetNextFullString - This assembles the sub-items
636 * that make up an indefinite-length string into one string item. It
637 * uses the string allocator to create contiguous space for the
638 * item. It processes all breaks that are part of indefinite-length
639 * strings.
640 *
641 * 6. DecodeAtomicDataItem - This decodes the atomic data items in
642 * CBOR. Each atomic data item has a "major type", an integer
643 * "argument" and optionally some content. For text and byte strings,
644 * the content is the bytes that make up the string. These are the
645 * smallest data items that are considered to be well-formed. The
646 * content may also be other data items in the case of aggregate
647 * types. They are not handled in this layer.
648 *
649 * Roughly this takes 300 bytes of stack for vars. TODO: evaluate this
650 * more carefully and correctly.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700651 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800652
653
654/*
655 * Note about use of int and unsigned variables.
656 *
657 * See http://www.unix.org/whitepapers/64bit.html for reasons int is
658 * used carefully here, and in particular why it isn't used in the
659 * public interface. Also see
660 * https://stackoverflow.com/questions/17489857/why-is-int-typically-32-bit-on-64-bit-compilers
661 *
662 * Int is used for values that need less than 16-bits and would be
663 * subject to integer promotion and result in complaining from static
664 * analyzers.
665 */
666
667
668/**
669 * @brief Decode the CBOR head, the type and argument.
670 *
671 * @param[in] pUInBuf The input buffer to read from.
672 * @param[out] pnMajorType The decoded major type.
673 * @param[out] puArgument The decoded argument.
674 * @param[out] pnAdditionalInfo The decoded Lower 5 bits of initial byte.
675 *
676 * @retval QCBOR_ERR_UNSUPPORTED
677 * @retval QCBOR_ERR_HIT_END
678 *
679 * This decodes the CBOR "head" that every CBOR data item has. See
680 * longer explaination of the head in documentation for
681 * QCBOREncode_EncodeHead().
682 *
683 * This does the network->host byte order conversion. The conversion
684 * here also results in the conversion for floats in addition to that
685 * for lengths, tags and integer values.
686 *
687 * The int type is preferred to uint8_t for some variables as this
688 * avoids integer promotions, can reduce code size and makes static
689 * analyzers happier.
690 */
691static inline QCBORError
692DecodeHead(UsefulInputBuf *pUInBuf,
693 int *pnMajorType,
694 uint64_t *puArgument,
695 int *pnAdditionalInfo)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700696{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800697 QCBORError uReturn;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800698
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800699 /* Get the initial byte that every CBOR data item has and break it
700 * down. */
701 const int nInitialByte = (int)UsefulInputBuf_GetByte(pUInBuf);
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800702 const int nTmpMajorType = nInitialByte >> 5;
703 const int nAdditionalInfo = nInitialByte & 0x1f;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800704
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800705 /* Where the argument accumulates */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800706 uint64_t uArgument;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800707
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800708 if(nAdditionalInfo >= LEN_IS_ONE_BYTE && nAdditionalInfo <= LEN_IS_EIGHT_BYTES) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800709 /* Need to get 1,2,4 or 8 additional argument bytes. Map
710 * LEN_IS_ONE_BYTE..LEN_IS_EIGHT_BYTES to actual length.
711 */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800712 static const uint8_t aIterate[] = {1,2,4,8};
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800713
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800714 /* Loop getting all the bytes in the argument */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800715 uArgument = 0;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800716 for(int i = aIterate[nAdditionalInfo - LEN_IS_ONE_BYTE]; i; i--) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800717 /* This shift and add gives the endian conversion. */
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800718 uArgument = (uArgument << 8) + UsefulInputBuf_GetByte(pUInBuf);
719 }
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800720 } else if(nAdditionalInfo >= ADDINFO_RESERVED1 && nAdditionalInfo <= ADDINFO_RESERVED3) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800721 /* The reserved and thus-far unused additional info values */
722 uReturn = QCBOR_ERR_UNSUPPORTED;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800723 goto Done;
724 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800725 /* Less than 24, additional info is argument or 31, an
726 * indefinite-length. No more bytes to get.
727 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800728 uArgument = (uint64_t)nAdditionalInfo;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700729 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800730
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700731 if(UsefulInputBuf_GetError(pUInBuf)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800732 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700733 goto Done;
734 }
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800735
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800736 /* All successful if arrived here. */
737 uReturn = QCBOR_SUCCESS;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800738 *pnMajorType = nTmpMajorType;
Laurence Lundblade4c0cf842019-01-12 03:25:44 -0800739 *puArgument = uArgument;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800740 *pnAdditionalInfo = nAdditionalInfo;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800741
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700742Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800743 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700744}
745
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800746
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800747/**
748 * @brief Decode integer types, major types 0 and 1.
749 *
750 * @param[in] nMajorType The CBOR major type (0 or 1).
751 * @param[in] uArgument The argument from the head.
752 * @param[out] pDecodedItem The filled in decoded item.
753 *
754 * @retval QCBOR_ERR_INT_OVERFLOW
755 *
756 * Must only be called when major type is 0 or 1.
757 *
758 * CBOR doesn't explicitly specify two's compliment for integers but
759 * all CPUs use it these days and the test vectors in the RFC are
760 * so. All integers in the CBOR structure are positive and the major
761 * type indicates positive or negative. CBOR can express positive
762 * integers up to 2^x - 1 where x is the number of bits and negative
763 * integers down to 2^x. Note that negative numbers can be one more
764 * away from zero than positive. Stdint, as far as I can tell, uses
765 * two's compliment to represent negative integers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700766 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -0700767static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800768DecodeInteger(int nMajorType, uint64_t uArgument, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700769{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800770 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800771
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700772 if(nMajorType == CBOR_MAJOR_TYPE_POSITIVE_INT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800773 if (uArgument <= INT64_MAX) {
774 pDecodedItem->val.int64 = (int64_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700775 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800776
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700777 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800778 pDecodedItem->val.uint64 = uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700779 pDecodedItem->uDataType = QCBOR_TYPE_UINT64;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700780 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800781
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700782 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800783 if(uArgument <= INT64_MAX) {
784 /* CBOR's representation of negative numbers lines up with
785 * the two-compliment representation. A negative integer has
786 * one more in range than a positive integer. INT64_MIN is
787 * equal to (-INT64_MAX) - 1.
788 */
789 pDecodedItem->val.int64 = (-(int64_t)uArgument) - 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700790 pDecodedItem->uDataType = QCBOR_TYPE_INT64;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800791
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700792 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800793 /* C can't represent a negative integer in this range so it
794 * is an error.
795 */
796 uReturn = QCBOR_ERR_INT_OVERFLOW;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700797 }
798 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800799
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800800 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700801}
802
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800803
804/* Make sure #define value line up as DecodeSimple counts on this. */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700805#if QCBOR_TYPE_FALSE != CBOR_SIMPLEV_FALSE
806#error QCBOR_TYPE_FALSE macro value wrong
807#endif
808
809#if QCBOR_TYPE_TRUE != CBOR_SIMPLEV_TRUE
810#error QCBOR_TYPE_TRUE macro value wrong
811#endif
812
813#if QCBOR_TYPE_NULL != CBOR_SIMPLEV_NULL
814#error QCBOR_TYPE_NULL macro value wrong
815#endif
816
817#if QCBOR_TYPE_UNDEF != CBOR_SIMPLEV_UNDEF
818#error QCBOR_TYPE_UNDEF macro value wrong
819#endif
820
Laurence Lundblade0f99d692018-09-26 14:39:28 -0700821#if QCBOR_TYPE_BREAK != CBOR_SIMPLE_BREAK
822#error QCBOR_TYPE_BREAK macro value wrong
823#endif
824
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700825#if QCBOR_TYPE_DOUBLE != DOUBLE_PREC_FLOAT
826#error QCBOR_TYPE_DOUBLE macro value wrong
827#endif
828
829#if QCBOR_TYPE_FLOAT != SINGLE_PREC_FLOAT
830#error QCBOR_TYPE_FLOAT macro value wrong
831#endif
832
Laurence Lundblade9b334962020-08-27 10:55:53 -0700833
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800834/**
835 * @brief Decode major type 7 -- true, false, floating-point, break...
836 *
837 * @param[in] nAdditionalInfo The lower five bits from the initial byte.
838 * @param[in] uArgument The argument from the head.
839 * @param[out] pDecodedItem The filled in decoded item.
840 *
841 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
842 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700843 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800844
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800845static inline QCBORError
846DecodeType7(int nAdditionalInfo, uint64_t uArgument, QCBORItem *pDecodedItem)
847{
848 QCBORError uReturn = QCBOR_SUCCESS;
849
850 /* uAdditionalInfo is 5 bits from the initial byte. Compile time
851 * checks above make sure uAdditionalInfo values line up with
852 * uDataType values. DecodeHead() never returns an AdditionalInfo
853 * > 0x1f so cast is safe.
854 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800855 pDecodedItem->uDataType = (uint8_t)nAdditionalInfo;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800856
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800857 switch(nAdditionalInfo) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800858 /* No check for ADDINFO_RESERVED1 - ADDINFO_RESERVED3 as they
859 * are caught before this is called.
860 */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800861
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800862 case HALF_PREC_FLOAT: /* 25 */
Laurence Lundbladeb275cdc2020-07-12 12:34:38 -0700863#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800864 /* Half-precision is returned as a double. The cast to
865 * uint16_t is safe because the encoded value was 16 bits. It
866 * was widened to 64 bits to be passed in here.
867 */
868 pDecodedItem->val.dfnum = IEEE754_HalfToDouble((uint16_t)uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700869 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800870#else /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800871 uReturn = QCBOR_ERR_HALF_PRECISION_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800872#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700873 break;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800874 case SINGLE_PREC_FLOAT: /* 26 */
875 /* Single precision is normally returned as a double since
876 * double is widely supported, there is no loss of precision,
877 * it makes it easy for the caller in most cases and it can
878 * be converted back to single with no loss of precision
879 *
880 * The cast to uint32_t is safe because the encoded value was
881 * 32 bits. It was widened to 64 bits to be passed in here.
882 */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700883 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800884 const float f = UsefulBufUtil_CopyUint32ToFloat((uint32_t)uArgument);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700885#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800886 /* In the normal case, use HW to convert float to
887 * double. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700888 pDecodedItem->val.dfnum = (double)f;
889 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800890#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800891 /* Use of float HW is disabled, return as a float. */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700892 pDecodedItem->val.fnum = f;
893 pDecodedItem->uDataType = QCBOR_TYPE_FLOAT;
894
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800895 /* IEEE754_FloatToDouble() could be used here to return as
896 * a double, but it adds object code and most likely
897 * anyone disabling FLOAT HW use doesn't care about floats
898 * and wants to save object code.
899 */
Laurence Lundbladee2c893c2020-12-26 17:41:53 -0800900#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700901 }
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700902 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -0700903
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800904 case DOUBLE_PREC_FLOAT: /* 27 */
905 pDecodedItem->val.dfnum = UsefulBufUtil_CopyUint64ToDouble(uArgument);
Laurence Lundblade67bd5512018-11-02 21:44:06 +0700906 pDecodedItem->uDataType = QCBOR_TYPE_DOUBLE;
Laurence Lundblade12d32c52018-09-19 11:25:27 -0700907 break;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800908
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800909 case CBOR_SIMPLEV_FALSE: /* 20 */
910 case CBOR_SIMPLEV_TRUE: /* 21 */
911 case CBOR_SIMPLEV_NULL: /* 22 */
912 case CBOR_SIMPLEV_UNDEF: /* 23 */
913 case CBOR_SIMPLE_BREAK: /* 31 */
914 break; /* nothing to do */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800915
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800916 case CBOR_SIMPLEV_ONEBYTE: /* 24 */
917 if(uArgument <= CBOR_SIMPLE_BREAK) {
918 /* This takes out f8 00 ... f8 1f which should be encoded
919 * as e0 … f7
920 */
921 uReturn = QCBOR_ERR_BAD_TYPE_7;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700922 goto Done;
923 }
Laurence Lundblade5e390822019-01-06 12:35:01 -0800924 /* FALLTHROUGH */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800925
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800926 default: /* 0-19 */
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700927 pDecodedItem->uDataType = QCBOR_TYPE_UKNOWN_SIMPLE;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800928 /* DecodeHead() will make uArgument equal to
929 * nAdditionalInfo when nAdditionalInfo is < 24. This cast is
930 * safe because the 2, 4 and 8 byte lengths of uNumber are in
931 * the double/float cases above
Laurence Lundbladeee851742020-01-08 08:37:05 -0800932 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800933 pDecodedItem->val.uSimple = (uint8_t)uArgument;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700934 break;
935 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800936
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700937Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800938 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700939}
940
941
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800942/**
943 * @brief Decode text and byte strings
944 *
945 * @param[in] pAllocator The string allocator or NULL.
946 * @param[in] uStrLen The length of the string.
947 * @param[in] pUInBuf The surce from which to read the string's bytes.
948 * @param[out] pDecodedItem The filled in decoded item.
949 *
950 * @retval QCBOR_ERR_HIT_END
951 * @retval QCBOR_ERR_STRING_ALLOCATE
952 * @retval QCBOR_ERR_STRING_TOO_LONG
953 *
954 * The reads @c uStrlen bytes from @c pUInBuf and fills in @c
955 * pDecodedItem. If @c pAllocator is not NULL then memory for the
956 * string is allocated.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700957 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800958static inline QCBORError
959DecodeBytes(const QCBORInternalAllocator *pAllocator,
960 uint64_t uStrLen,
961 UsefulInputBuf *pUInBuf,
962 QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700963{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800964 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -0800965
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800966 /* CBOR lengths can be 64 bits, but size_t is not 64 bits on all
967 * CPUs. This check makes the casts to size_t below safe.
968 *
969 * The max is 4 bytes less than the largest sizeof() so this can be
970 * tested by putting a SIZE_MAX length in the CBOR test input (no
971 * one will care the limit on strings is 4 bytes shorter).
972 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800973 if(uStrLen > SIZE_MAX-4) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800974 uReturn = QCBOR_ERR_STRING_TOO_LONG;
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800975 goto Done;
976 }
977
978 const UsefulBufC Bytes = UsefulInputBuf_GetUsefulBuf(pUInBuf, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530979 if(UsefulBuf_IsNULLC(Bytes)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800980 /* Failed to get the bytes for this string item */
981 uReturn = QCBOR_ERR_HIT_END;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530982 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +0700983 }
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530984
Laurence Lundbladef6da33c2020-11-26 18:15:05 -0800985#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800986 /* Note that this is not where allocation to coalesce
987 * indefinite-length strings is done. This is for when the caller
988 * has requested all strings be allocated. Disabling indefinite
989 * length strings also disables this allocate-all option.
990 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800991 if(pAllocator) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800992 /* request to use the string allocator to make a copy */
Laurence Lundbladec5fef682020-01-25 11:38:45 -0800993 UsefulBuf NewMem = StringAllocator_Allocate(pAllocator, (size_t)uStrLen);
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530994 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -0800995 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +0530996 goto Done;
997 }
998 pDecodedItem->val.string = UsefulBuf_Copy(NewMem, Bytes);
Laurence Lundblade1d7eb632019-02-17 17:23:38 -0800999 pDecodedItem->uDataAlloc = 1;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001000 goto Done;
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301001 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001002#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1003 (void)pAllocator;
1004#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1005
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001006 /* Normal case with no string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001007 pDecodedItem->val.string = Bytes;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001008
Laurence Lundblade471a3fd2018-10-18 21:27:45 +05301009Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001010 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001011}
1012
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001013
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001014/**
1015 * @brief Map the CBOR major types for strings to the QCBOR types.
1016 *
1017 * @param[in] nCBORMajorType The CBOR major type to convert.
1018 * @retturns QCBOR type number.
1019 *
1020 * This only works for the two string types.
1021 */
1022static inline uint8_t ConvertStringMajorTypes(int nCBORMajorType)
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001023{
1024 #if CBOR_MAJOR_TYPE_BYTE_STRING + 4 != QCBOR_TYPE_BYTE_STRING
1025 #error QCBOR_TYPE_BYTE_STRING no lined up with major type
1026 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001027
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001028 #if CBOR_MAJOR_TYPE_TEXT_STRING + 4 != QCBOR_TYPE_TEXT_STRING
1029 #error QCBOR_TYPE_TEXT_STRING no lined up with major type
1030 #endif
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001031
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001032 return (uint8_t)(nCBORMajorType + 4);
1033}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001034
1035
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001036/**
1037 * @brief Map the CBOR major types for arrays/maps to the QCBOR types.
1038 *
1039 * @param[in] nCBORMajorType The CBOR major type to convert.
1040 * @retturns QCBOR type number.
1041 *
1042 * This only works for the two aggregate types.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001043 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001044static inline uint8_t ConvertArrayOrMapType(int nCBORMajorType)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001045{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001046 #if QCBOR_TYPE_ARRAY != CBOR_MAJOR_TYPE_ARRAY
1047 #error QCBOR_TYPE_ARRAY value not lined up with major type
1048 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001049
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001050 #if QCBOR_TYPE_MAP != CBOR_MAJOR_TYPE_MAP
1051 #error QCBOR_TYPE_MAP value not lined up with major type
1052 #endif
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001053
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001054 return (uint8_t)(nCBORMajorType);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001055}
1056
1057
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001058/**
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001059 * @brief Decode a single primitive data item (decode layer 6).
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001060 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001061 * @param[in] pUInBuf Input buffer to read data item from.
1062 * @param[out] pDecodedItem The filled-in decoded item.
1063 * @param[in] pAllocator The allocator to use for strings or NULL.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001064 *
1065 * @retval QCBOR_ERR_UNSUPPORTED
1066 * @retval QCBOR_ERR_HIT_END
1067 * @retval QCBOR_ERR_INT_OVERFLOW
1068 * @retval QCBOR_ERR_STRING_ALLOCATE
1069 * @retval QCBOR_ERR_STRING_TOO_LONG
1070 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1071 * @retval QCBOR_ERR_BAD_TYPE_7
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001072 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1073 *
1074 * This decodes the most primitive / atomic data item. It does
1075 * no combing of data items.
1076 */
1077static QCBORError
1078DecodeAtomicDataItem(UsefulInputBuf *pUInBuf,
1079 QCBORItem *pDecodedItem,
1080 const QCBORInternalAllocator *pAllocator)
1081{
1082 QCBORError uReturn;
1083
1084 /* Get the major type and the argument. The argument could be
1085 * length of more bytes or the value depending on the major
1086 * type. nAdditionalInfo is an encoding of the length of the
1087 * uNumber and is needed to decode floats and doubles.
1088 */
1089 int nMajorType = 0;
1090 uint64_t uArgument = 0;
1091 int nAdditionalInfo = 0;
1092
1093 memset(pDecodedItem, 0, sizeof(QCBORItem));
1094
1095 uReturn = DecodeHead(pUInBuf, &nMajorType, &uArgument, &nAdditionalInfo);
1096 if(uReturn) {
1097 goto Done;
1098 }
1099
1100 /* At this point the major type and the argument are valid. We've
1101 * got the type and the argument that starts every CBOR data item.
1102 */
1103 switch (nMajorType) {
1104 case CBOR_MAJOR_TYPE_POSITIVE_INT: /* Major type 0 */
1105 case CBOR_MAJOR_TYPE_NEGATIVE_INT: /* Major type 1 */
1106 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1107 uReturn = QCBOR_ERR_BAD_INT;
1108 } else {
1109 uReturn = DecodeInteger(nMajorType, uArgument, pDecodedItem);
1110 }
1111 break;
1112
1113 case CBOR_MAJOR_TYPE_BYTE_STRING: /* Major type 2 */
1114 case CBOR_MAJOR_TYPE_TEXT_STRING: /* Major type 3 */
1115 pDecodedItem->uDataType = ConvertStringMajorTypes(nMajorType);
1116 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1117 pDecodedItem->val.string = (UsefulBufC){NULL, QCBOR_STRING_LENGTH_INDEFINITE};
1118 } else {
1119 uReturn = DecodeBytes(pAllocator, uArgument, pUInBuf, pDecodedItem);
1120 }
1121 break;
1122
1123 case CBOR_MAJOR_TYPE_ARRAY: /* Major type 4 */
1124 case CBOR_MAJOR_TYPE_MAP: /* Major type 5 */
1125 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1126 /* Indefinite-length string. */
1127#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
1128 pDecodedItem->val.uCount = QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH;
1129#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1130 uReturn = QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED;
1131 break;
1132#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1133 } else {
1134 /* Definite-length string. */
1135 if(uArgument > QCBOR_MAX_ITEMS_IN_ARRAY) {
1136 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
1137 goto Done;
1138 }
1139 /* cast OK because of check above */
1140 pDecodedItem->val.uCount = (uint16_t)uArgument;
1141 }
1142 pDecodedItem->uDataType = ConvertArrayOrMapType(nMajorType);
1143 break;
1144
1145 case CBOR_MAJOR_TYPE_TAG: /* Major type 6, tag numbers */
1146 if(nAdditionalInfo == LEN_IS_INDEFINITE) {
1147 uReturn = QCBOR_ERR_BAD_INT;
1148 } else {
1149 pDecodedItem->val.uTagV = uArgument;
1150 pDecodedItem->uDataType = QCBOR_TYPE_TAG;
1151 }
1152 break;
1153
1154 case CBOR_MAJOR_TYPE_SIMPLE:
1155 /* Major type 7: float, double, true, false, null... */
1156 uReturn = DecodeType7(nAdditionalInfo, uArgument, pDecodedItem);
1157 break;
1158
1159 default:
1160 /* Never happens because DecodeHead() should never return > 7 */
1161 uReturn = QCBOR_ERR_UNSUPPORTED;
1162 break;
1163 }
1164
1165Done:
1166 return uReturn;
1167}
1168
1169
1170/**
1171 * @brief Process indefinite-length strings (decode layer 5).
1172 *
1173 * @param[in] pMe Decoder context
1174 * @param[out] pDecodedItem The decoded item that work is done on.
1175 *
1176 * @retval QCBOR_ERR_UNSUPPORTED
1177 * @retval QCBOR_ERR_HIT_END
1178 * @retval QCBOR_ERR_INT_OVERFLOW
1179 * @retval QCBOR_ERR_STRING_ALLOCATE
1180 * @retval QCBOR_ERR_STRING_TOO_LONG
1181 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1182 * @retval QCBOR_ERR_BAD_TYPE_7
1183 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001184 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1185 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001186 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001187 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001188 * If @c pDecodedItem is not an indefinite-length string, this does nothing.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001189 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001190 * If it is, this loops getting the subsequent chunk data items that
1191 * make up the string. The string allocator is used to make a
1192 * contiguous buffer for the chunks. When this completes @c
1193 * pDecodedItem contains the put-together string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001194 *
1195 * Code Reviewers: THIS FUNCTION DOES A LITTLE POINTER MATH
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001196 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001197static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001198QCBORDecode_GetNextFullString(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001199{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001200 /* Aproximate stack usage
1201 * 64-bit 32-bit
1202 * local vars 32 16
1203 * 2 UsefulBufs 32 16
1204 * QCBORItem 56 52
1205 * TOTAL 120 74
1206 */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001207
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001208 /* The string allocator is used here for two purposes: 1)
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001209 * coalescing the chunks of an indefinite-length string, 2)
1210 * allocating storage for every string returned when requested.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001211 *
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001212 * The first use is below in this function. Indefinite-length
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001213 * strings cannot be processed at all without a string allocator.
1214 *
1215 * The second used is in DecodeBytes() which is called by
1216 * GetNext_Item() below. This second use unneccessary for most use
1217 * and only happens when requested in the call to
1218 * QCBORDecode_SetMemPool(). If the second use not requested then
1219 * NULL is passed for the string allocator to GetNext_Item().
1220 *
1221 * QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS disables the string
1222 * allocator altogether and thus both of these uses. It reduced the
1223 * decoder object code by about 400 bytes.
1224 */
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001225 const QCBORInternalAllocator *pAllocatorForGetNext = NULL;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001226
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001227#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3a691a02020-12-28 04:15:16 -08001228 const QCBORInternalAllocator *pAllocator = NULL;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001229
1230 if(pMe->StringAllocator.pfAllocator) {
1231 pAllocator = &(pMe->StringAllocator);
1232 if(pMe->bStringAllocateAll) {
1233 pAllocatorForGetNext = pAllocator;
1234 }
1235 }
1236#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1237
1238 QCBORError uReturn;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001239 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), pDecodedItem, pAllocatorForGetNext);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001240 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001241 goto Done;
1242 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001243
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001244 /* Only do indefinite-length processing on strings */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001245 const uint8_t uStringType = pDecodedItem->uDataType;
1246 if(uStringType!= QCBOR_TYPE_BYTE_STRING && uStringType != QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001247 goto Done;
1248 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001249
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001250 /* Is this a string with an indefinite length? */
1251 if(pDecodedItem->val.string.len != QCBOR_STRING_LENGTH_INDEFINITE) {
1252 goto Done;
1253 }
1254
1255#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001256 /* Can't decode indefinite-length strings without a string allocator */
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001257 if(pAllocator == NULL) {
1258 uReturn = QCBOR_ERR_NO_STRING_ALLOCATOR;
1259 goto Done;
1260 }
1261
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001262 /* Loop getting chunks of the indefinite-length string */
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001263 UsefulBufC FullString = NULLUsefulBufC;
1264
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001265 for(;;) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001266 /* Get QCBORItem for next chunk */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001267 QCBORItem StringChunkItem;
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001268 /* Pass a NULL string allocator to GetNext_Item() because the
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001269 * individual string chunks in an indefinite-length should not
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001270 * be allocated. They are always copied in the the contiguous
1271 * buffer allocated here.
1272 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001273 uReturn = DecodeAtomicDataItem(&(pMe->InBuf), &StringChunkItem, NULL);
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001274 if(uReturn) {
1275 break;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001276 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001277
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001278 /* Is item is the marker for end of the indefinite-length string? */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001279 if(StringChunkItem.uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001280 /* String is complete */
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001281 pDecodedItem->val.string = FullString;
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301282 pDecodedItem->uDataAlloc = 1;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001283 break;
1284 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001285
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001286 /* All chunks must be of the same type, the type of the item
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001287 * that introduces the indefinite-length string. This also
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001288 * catches errors where the chunk is not a string at all and an
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001289 * indefinite-length string inside an indefinite-length string.
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001290 */
Laurence Lundbladec5fef682020-01-25 11:38:45 -08001291 if(StringChunkItem.uDataType != uStringType ||
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001292 StringChunkItem.val.string.len == QCBOR_STRING_LENGTH_INDEFINITE) {
1293 uReturn = QCBOR_ERR_INDEFINITE_STRING_CHUNK;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001294 break;
1295 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001296
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001297 /* The first time throurgh FullString.ptr is NULL and this is
1298 * equivalent to StringAllocator_Allocate(). Subsequently it is
1299 * not NULL and a reallocation happens.
1300 */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001301 UsefulBuf NewMem = StringAllocator_Reallocate(pAllocator,
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001302 FullString.ptr,
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08001303 FullString.len + StringChunkItem.val.string.len);
1304
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001305 if(UsefulBuf_IsNULL(NewMem)) {
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001306 uReturn = QCBOR_ERR_STRING_ALLOCATE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001307 break;
1308 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001309
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001310 /* Copy new string chunk to the end of accumulated string */
Laurence Lundblade2a6850e2018-10-28 20:13:44 +07001311 FullString = UsefulBuf_CopyOffset(NewMem, FullString.len, StringChunkItem.val.string);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001312 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001313
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001314 if(uReturn != QCBOR_SUCCESS && !UsefulBuf_IsNULLC(FullString)) {
1315 /* Getting the item failed, clean up the allocated memory */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001316 StringAllocator_Free(pAllocator, FullString.ptr);
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001317 }
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001318#else /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
1319 uReturn = QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED;
1320#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001321
Laurence Lundbladed6dfe6d2020-04-09 10:21:36 -07001322Done:
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001323 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001324}
1325
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08001326
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001327/**
1328 * @brief This converts a tag number to a shorter mapped value for storage.
1329 *
1330 * @param[in] pMe The decode context.
1331 * @param[in] uUnMappedTag The tag number to map
1332 * @param[out] puMappedTagNumer The stored tag number.
1333 *
1334 * @return error code.
1335 *
1336 * The main point of mapping tag numbers is make QCBORItem
1337 * smaller. With this mapping storage of 4 tags takes up 8
1338 * bytes. Without, it would take up 32 bytes.
1339 *
1340 * This maps tag numbers greater than QCBOR_LAST_UNMAPPED_TAG.
1341 * QCBOR_LAST_UNMAPPED_TAG is a little smaller than MAX_UINT16.
1342 *
1343 * See also UnMapTagNumber() and @ref QCBORItem.
1344 */
1345static inline QCBORError
1346MapTagNumber(QCBORDecodeContext *pMe, uint64_t uUnMappedTag, uint16_t *puMappedTagNumer)
1347{
1348 if(uUnMappedTag > QCBOR_LAST_UNMAPPED_TAG) {
1349 unsigned uTagMapIndex;
1350 /* Is there room in the tag map, or is it in it already? */
1351 for(uTagMapIndex = 0; uTagMapIndex < QCBOR_NUM_MAPPED_TAGS; uTagMapIndex++) {
1352 if(pMe->auMappedTags[uTagMapIndex] == CBOR_TAG_INVALID64) {
1353 break;
1354 }
1355 if(pMe->auMappedTags[uTagMapIndex] == uUnMappedTag) {
1356 break;
1357 }
1358 }
1359 if(uTagMapIndex >= QCBOR_NUM_MAPPED_TAGS) {
1360 return QCBOR_ERR_TOO_MANY_TAGS;
1361 }
1362
1363 /* Covers the cases where tag is new and were it is already in the map */
1364 pMe->auMappedTags[uTagMapIndex] = uUnMappedTag;
1365 *puMappedTagNumer = (uint16_t)(uTagMapIndex + QCBOR_LAST_UNMAPPED_TAG + 1);
1366
1367 } else {
1368 *puMappedTagNumer = (uint16_t)uUnMappedTag;
1369 }
1370
1371 return QCBOR_SUCCESS;
1372}
1373
1374
1375/**
1376 * @brief This converts a mapped tag number to the actual tag number.
1377 *
1378 * @param[in] pMe The decode context.
1379 * @param[in] uMappedTagNumber The stored tag number.
1380 *
1381 * @return The actual tag number is returned or
1382 * @ref CBOR_TAG_INVALID64 on error.
1383 *
1384 * This is the reverse of MapTagNumber()
1385 */
1386static uint64_t
1387UnMapTagNumber(const QCBORDecodeContext *pMe, uint16_t uMappedTagNumber)
1388{
1389 if(uMappedTagNumber <= QCBOR_LAST_UNMAPPED_TAG) {
1390 return uMappedTagNumber;
1391 } else if(uMappedTagNumber == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07001392 return CBOR_TAG_INVALID64;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001393 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001394 /* This won't be negative because of code below in
1395 * MapTagNumber()
1396 */
1397 const unsigned uIndex = uMappedTagNumber - (QCBOR_LAST_UNMAPPED_TAG + 1);
1398 return pMe->auMappedTags[uIndex];
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001399 }
1400}
1401
Laurence Lundblade9b334962020-08-27 10:55:53 -07001402
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001403/**
1404 * @brief Aggregate all tags wrapping a data item (decode layer 4).
1405 *
1406 * @param[in] pMe Decoder context
1407 * @param[out] pDecodedItem The decoded item that work is done on.
Laurence Lundblade9b334962020-08-27 10:55:53 -07001408
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001409 * @retval QCBOR_ERR_UNSUPPORTED
1410 * @retval QCBOR_ERR_HIT_END
1411 * @retval QCBOR_ERR_INT_OVERFLOW
1412 * @retval QCBOR_ERR_STRING_ALLOCATE
1413 * @retval QCBOR_ERR_STRING_TOO_LONG
1414 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1415 * @retval QCBOR_ERR_BAD_TYPE_7
1416 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1417 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1418 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1419 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1420 * @retval QCBOR_ERR_TOO_MANY_TAGS
1421 *
1422 * This loops getting atomic data items until one is not a tag
1423 * number. Usually this is largely pass-through because most
1424 * item are not tag numbers.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001425 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001426static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001427QCBORDecode_GetNextTagNumber(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001428{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001429 uint16_t auItemsTags[QCBOR_MAX_TAGS_PER_ITEM];
1430
1431 /* Initialize to CBOR_TAG_INVALID16 */
1432 #if CBOR_TAG_INVALID16 != 0xffff
1433 /* Be sure the memset does the right thing. */
1434 #err CBOR_TAG_INVALID16 tag not defined as expected
1435 #endif
1436 memset(auItemsTags, 0xff, sizeof(auItemsTags));
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001437
Laurence Lundblade9b334962020-08-27 10:55:53 -07001438 QCBORError uReturn = QCBOR_SUCCESS;
1439
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001440 /* Loop fetching data items until the item fetched is not a tag */
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001441 for(;;) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001442 QCBORError uErr = QCBORDecode_GetNextFullString(pMe, pDecodedItem);
Laurence Lundblade9b334962020-08-27 10:55:53 -07001443 if(uErr != QCBOR_SUCCESS) {
1444 uReturn = uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001445 goto Done;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001446 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001447
Laurence Lundblade9b334962020-08-27 10:55:53 -07001448 if(pDecodedItem->uDataType != QCBOR_TYPE_TAG) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001449 /* Successful exit from loop; maybe got some tags, maybe not */
1450 memcpy(pDecodedItem->uTags, auItemsTags, sizeof(auItemsTags));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001451 break;
1452 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001453
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001454 if(auItemsTags[QCBOR_MAX_TAGS_PER_ITEM - 1] != CBOR_TAG_INVALID16) {
1455 /* No room in the tag list */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001456 uReturn = QCBOR_ERR_TOO_MANY_TAGS;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001457 /* Continue on to get all tags wrapping this item even though
1458 * it is erroring out in the end. This allows decoding to
1459 * continue. This is a resource limit error, not a problem
1460 * with being well-formed CBOR.
1461 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001462 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001463 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001464 /* Slide tags over one in the array to make room at index 0.
1465 * Must use memmove because the move source and destination
1466 * overlap.
1467 */
1468 memmove(&auItemsTags[1], auItemsTags, sizeof(auItemsTags) - sizeof(auItemsTags[0]));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001469
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001470 /* Map the tag */
Laurence Lundbladeb9702452021-03-08 21:02:57 -08001471 uint16_t uMappedTagNumer = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001472 uReturn = MapTagNumber(pMe, pDecodedItem->val.uTagV, &uMappedTagNumer);
1473 /* Continue even on error so as to consume all tags wrapping
1474 * this data item so decoding can go on. If MapTagNumber()
1475 * errors once it will continue to error.
1476 */
1477 auItemsTags[0] = uMappedTagNumer;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07001478 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001479
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001480Done:
Laurence Lundblade9b334962020-08-27 10:55:53 -07001481 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001482}
1483
1484
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001485/**
1486 * @brief Combine a map entry label and value into one item (decode layer 3).
1487 *
1488 * @param[in] pMe Decoder context
1489 * @param[out] pDecodedItem The decoded item that work is done on.
1490 *
1491 * @retval QCBOR_ERR_UNSUPPORTED
1492 * @retval QCBOR_ERR_HIT_END
1493 * @retval QCBOR_ERR_INT_OVERFLOW
1494 * @retval QCBOR_ERR_STRING_ALLOCATE
1495 * @retval QCBOR_ERR_STRING_TOO_LONG
1496 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1497 * @retval QCBOR_ERR_BAD_TYPE_7
1498 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1499 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1500 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1501 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1502 * @retval QCBOR_ERR_TOO_MANY_TAGS
1503 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1504 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1505 *
1506 * If a the current nesting level is a map, then this
1507 * combines pairs of items into one data item with a label
1508 * and value.
1509 *
1510 * This is pass-through if the current nesting leve is
1511 * not a map.
1512 *
1513 * This also implements maps-as-array mode where a map
1514 * is treated like an array to allow caller to do their
1515 * own label processing.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001516 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08001517static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001518QCBORDecode_GetNextMapEntry(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001519{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001520 QCBORError uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1521 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade742df4a2018-10-13 20:07:17 +08001522 goto Done;
1523 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001524
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001525 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
1526 /* Break can't be a map entry */
1527 goto Done;
1528 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001529
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001530 if(pMe->uDecodeMode != QCBOR_DECODE_MODE_MAP_AS_ARRAY) {
1531 /* Normal decoding of maps -- combine label and value into one item. */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001532
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001533 if(DecodeNesting_IsCurrentTypeMap(&(pMe->nesting))) {
1534 /* Save label in pDecodedItem and get the next which will
1535 * be the real data item.
1536 */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001537 QCBORItem LabelItem = *pDecodedItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001538 uReturn = QCBORDecode_GetNextTagNumber(pMe, pDecodedItem);
1539 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001540 goto Done;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07001541 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001542
Laurence Lundblade57dd1442018-10-15 20:26:28 +05301543 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001544
1545 if(LabelItem.uDataType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001546 /* strings are always good labels */
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001547 pDecodedItem->label.string = LabelItem.val.string;
1548 pDecodedItem->uLabelType = QCBOR_TYPE_TEXT_STRING;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001549 } else if (QCBOR_DECODE_MODE_MAP_STRINGS_ONLY == pMe->uDecodeMode) {
1550 /* It's not a string and we only want strings */
1551 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001552 goto Done;
1553 } else if(LabelItem.uDataType == QCBOR_TYPE_INT64) {
1554 pDecodedItem->label.int64 = LabelItem.val.int64;
1555 pDecodedItem->uLabelType = QCBOR_TYPE_INT64;
1556 } else if(LabelItem.uDataType == QCBOR_TYPE_UINT64) {
1557 pDecodedItem->label.uint64 = LabelItem.val.uint64;
1558 pDecodedItem->uLabelType = QCBOR_TYPE_UINT64;
1559 } else if(LabelItem.uDataType == QCBOR_TYPE_BYTE_STRING) {
1560 pDecodedItem->label.string = LabelItem.val.string;
1561 pDecodedItem->uLabelAlloc = LabelItem.uDataAlloc;
1562 pDecodedItem->uLabelType = QCBOR_TYPE_BYTE_STRING;
1563 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001564 /* label is not an int or a string. It is an arrray
1565 * or a float or such and this implementation doesn't handle that.
1566 * Also, tags on labels are ignored.
1567 */
1568 uReturn = QCBOR_ERR_MAP_LABEL_TYPE;
Laurence Lundbladeccfb8cd2018-12-07 21:11:30 +09001569 goto Done;
1570 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001571 }
1572 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001573 /* Decoding of maps as arrays to let the caller decide what to do
1574 * about labels, particularly lables that are not integers or
1575 * strings.
1576 */
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001577 if(pDecodedItem->uDataType == QCBOR_TYPE_MAP) {
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001578 if(pDecodedItem->val.uCount > QCBOR_MAX_ITEMS_IN_ARRAY/2) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001579 uReturn = QCBOR_ERR_ARRAY_DECODE_TOO_LONG;
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001580 goto Done;
1581 }
Laurence Lundbladed61cbf32018-12-09 11:42:21 -08001582 pDecodedItem->uDataType = QCBOR_TYPE_MAP_AS_ARRAY;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001583 /* Cast is safe because of check against QCBOR_MAX_ITEMS_IN_ARRAY/2.
1584 * Cast is needed because of integer promotion.
1585 */
Laurence Lundbladee6bcef12020-04-01 10:56:27 -07001586 pDecodedItem->val.uCount = (uint16_t)(pDecodedItem->val.uCount * 2);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001587 }
1588 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001589
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001590Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001591 return uReturn;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001592}
1593
1594
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001595#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001596/**
1597 * @brief Peek and see if next data item is a break;
1598 *
1599 * @param[in] pUIB UsefulInputBuf to read from.
1600 * @param[out] pbNextIsBreak Indicate if next was a break or not.
1601 *
1602 * @return Any decoding error.
1603 *
1604 * See if next item is a CBOR break. If it is, it is consumed,
1605 * if not it is not consumed.
Laurence Lundblade02625d42020-06-25 14:41:41 -07001606*/
Laurence Lundblade642282a2020-06-23 12:00:33 -07001607static inline QCBORError
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001608NextIsBreak(UsefulInputBuf *pUIB, bool *pbNextIsBreak)
1609{
1610 *pbNextIsBreak = false;
1611 if(UsefulInputBuf_BytesUnconsumed(pUIB) != 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001612 QCBORItem Peek;
1613 size_t uPeek = UsefulInputBuf_Tell(pUIB);
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001614 QCBORError uReturn = DecodeAtomicDataItem(pUIB, &Peek, NULL);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001615 if(uReturn != QCBOR_SUCCESS) {
1616 return uReturn;
1617 }
1618 if(Peek.uDataType != QCBOR_TYPE_BREAK) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001619 /* It is not a break, rewind so it can be processed normally. */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001620 UsefulInputBuf_Seek(pUIB, uPeek);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001621 } else {
1622 *pbNextIsBreak = true;
1623 }
1624 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001625
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001626 return QCBOR_SUCCESS;
1627}
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001628#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001629
1630
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001631/**
1632 * @brief Ascend up nesting levels if all items in them have been consumed.
1633 *
1634 * @param[in] pMe The decode context.
1635 * @param[in] bMarkEnd If true mark end of maps/arrays with count of zero.
1636 *
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001637 * An item was just consumed, now figure out if it was the
1638 * end of an array/map map that can be closed out. That
1639 * may in turn close out the above array/map...
Laurence Lundblade642282a2020-06-23 12:00:33 -07001640*/
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001641static QCBORError
1642QCBORDecode_NestLevelAscender(QCBORDecodeContext *pMe, bool bMarkEnd)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001643{
1644 QCBORError uReturn;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07001645
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001646 /* Loop ascending nesting levels as long as there is ascending to do */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001647 while(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
1648
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001649 if(DecodeNesting_IsCurrentBstrWrapped(&(pMe->nesting))) {
1650 /* Nesting level is bstr-wrapped CBOR */
1651
1652 /* Ascent for bstr-wrapped CBOR is always by explicit call
1653 * so no further ascending can happen.
1654 */
1655 break;
1656
1657 } else if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
1658 /* Level is a definite-length array/map */
1659
1660 /* Decrement the item count the definite-length array/map */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001661 DecodeNesting_DecrementDefiniteLengthMapOrArrayCount(&(pMe->nesting));
1662 if(!DecodeNesting_IsEndOfDefiniteLengthMapOrArray(&(pMe->nesting))) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001663 /* Didn't close out array/map, so all work here is done */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001664 break;
1665 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001666 /* All items in a definite-length array were consumed so it
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001667 * is time to ascend one level. This happens below.
1668 */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001669
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001670#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001671 } else {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001672 /* Level is an indefinite-length array/map. */
1673
1674 /* Check for a break which is what ends indefinite-length arrays/maps */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001675 bool bIsBreak = false;
1676 uReturn = NextIsBreak(&(pMe->InBuf), &bIsBreak);
1677 if(uReturn != QCBOR_SUCCESS) {
1678 goto Done;
1679 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001680
1681 if(!bIsBreak) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001682 /* Not a break so array/map does not close out. All work is done */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001683 break;
1684 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001685
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001686 /* It was a break in an indefinitelength map / array so
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001687 * it is time to ascend one level.
1688 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07001689
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001690#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001691 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001692
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001693
1694 /* All items in the array/map have been consumed. */
Laurence Lundblade642282a2020-06-23 12:00:33 -07001695
Laurence Lundblade93d89472020-10-03 22:30:50 -07001696 /* But ascent in bounded mode is only by explicit call to
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001697 * QCBORDecode_ExitBoundedMode().
1698 */
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07001699 if(DecodeNesting_IsCurrentBounded(&(pMe->nesting))) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001700 /* Set the count to zero for definite-length arrays to indicate
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001701 * cursor is at end of bounded array/map */
Laurence Lundbladed0304932020-06-27 10:59:38 -07001702 if(bMarkEnd) {
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001703 /* Used for definite and indefinite to signal end */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07001704 DecodeNesting_ZeroMapOrArrayCount(&(pMe->nesting));
Laurence Lundbladed0304932020-06-27 10:59:38 -07001705
Laurence Lundblade2c1faf92020-06-26 22:43:56 -07001706 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001707 break;
1708 }
1709
1710 /* Finally, actually ascend one level. */
1711 DecodeNesting_Ascend(&(pMe->nesting));
1712 }
Laurence Lundblade642282a2020-06-23 12:00:33 -07001713
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001714 uReturn = QCBOR_SUCCESS;
1715
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001716#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001717Done:
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001718#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_ARRAYS */
1719
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001720 return uReturn;
1721}
1722
1723
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001724/**
1725 * @brief Ascending & Descending out of nesting levels (decode layer 2).
1726 *
1727 * @param[in] pMe Decoder context
1728 * @param[out] pDecodedItem The decoded item that work is done on.
1729 *
1730 * @retval QCBOR_ERR_UNSUPPORTED
1731 * @retval QCBOR_ERR_HIT_END
1732 * @retval QCBOR_ERR_INT_OVERFLOW
1733 * @retval QCBOR_ERR_STRING_ALLOCATE
1734 * @retval QCBOR_ERR_STRING_TOO_LONG
1735 * @retval QCBOR_ERR_HALF_PRECISION_DISABLED
1736 * @retval QCBOR_ERR_BAD_TYPE_7
1737 * @retval QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED
1738 * @retval QCBOR_ERR_NO_STRING_ALLOCATOR
1739 * @retval QCBOR_ERR_INDEFINITE_STRING_CHUNK
1740 * @retval QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED
1741 * @retval QCBOR_ERR_TOO_MANY_TAGS
1742 * @retval QCBOR_ERR_ARRAY_DECODE_TOO_LONG
1743 * @retval QCBOR_ERR_MAP_LABEL_TYPE
1744 * @retval QCBOR_ERR_NO_MORE_ITEMS
1745 * @retval QCBOR_ERR_BAD_BREAK
1746 * @retval QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP
1747 *
1748 * This handles the traversal descending into and asecnding out of
1749 * maps, arrays and bstr-wrapped CBOR. It figures out the ends of
1750 * definite- and indefinte-length maps and arrays by looking at the
1751 * item count or finding CBOR breaks. It detects the ends of the
1752 * top-level sequence and of bstr-wrapped CBOR by byte count.
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001753 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07001754static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001755QCBORDecode_GetNextMapOrArray(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001756{
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001757 QCBORError uReturn;
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001758 /* ==== First: figure out if at the end of a traversal ==== */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001759
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001760 /* If out of bytes to consume, it is either the end of the
1761 * top-level sequence of some bstr-wrapped CBOR that was entered.
1762 *
1763 * In the case of bstr-wrapped CBOR, the length of the
1764 * UsefulInputBuf was set to that of the bstr-wrapped CBOR. When
1765 * the bstr-wrapped CBOR is exited, the length is set back to the
1766 * top-level's length or to the next highest bstr-wrapped CBOR.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001767 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001768 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf)) == 0) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001769 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001770 goto Done;
1771 }
Laurence Lundblade937ea812020-05-08 11:38:23 -07001772
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001773 /* Check to see if at the end of a bounded definite-length map or
1774 * array. The check for a break ending indefinite-length array is
1775 * later in QCBORDecode_NestLevelAscender().
Laurence Lundblade24d509a2020-06-06 18:43:15 -07001776 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001777 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001778 uReturn = QCBOR_ERR_NO_MORE_ITEMS;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07001779 goto Done;
1780 }
Laurence Lundbladebb1062e2019-08-12 23:28:54 -07001781
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08001782 /* ==== Next: not at the end, so get another item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001783 uReturn = QCBORDecode_GetNextMapEntry(pMe, pDecodedItem);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001784 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
1785 /* Error is so bad that traversal is not possible. */
Laurence Lundblade20b533d2018-10-08 20:44:53 +08001786 goto Done;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07001787 }
Laurence Lundblade7e0d13b2018-10-16 19:54:13 +05301788
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001789 /* Breaks ending arrays/maps are processed later in the call to
1790 * QCBORDecode_NestLevelAscender(). They should never show up here.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001791 */
Laurence Lundblade6de37062018-10-15 12:22:42 +05301792 if(pDecodedItem->uDataType == QCBOR_TYPE_BREAK) {
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001793 uReturn = QCBOR_ERR_BAD_BREAK;
Laurence Lundblade6de37062018-10-15 12:22:42 +05301794 goto Done;
Laurence Lundblade5b8c5852018-10-14 21:11:42 +05301795 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001796
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001797 /* Record the nesting level for this data item before processing
1798 * any of decrementing and descending.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001799 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001800 pDecodedItem->uNestingLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001801
Laurence Lundblade642282a2020-06-23 12:00:33 -07001802
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001803 /* ==== Next: Process the item for descent, ascent, decrement... ==== */
Laurence Lundblade02625d42020-06-25 14:41:41 -07001804 if(QCBORItem_IsMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001805 /* If the new item is a map or array, descend.
1806 *
1807 * Empty indefinite-length maps and arrays are descended into,
1808 * but then ascended out of in the next chunk of code.
1809 *
1810 * Maps and arrays do count as items in the map/array that
1811 * encloses them so a decrement needs to be done for them too,
1812 * but that is done only when all the items in them have been
1813 * processed, not when they are opened with the exception of an
1814 * empty map or array.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001815 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001816 QCBORError uDescendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001817 uDescendErr = DecodeNesting_DescendMapOrArray(&(pMe->nesting),
Laurence Lundblade642282a2020-06-23 12:00:33 -07001818 pDecodedItem->uDataType,
1819 pDecodedItem->val.uCount);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001820 if(uDescendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001821 /* This error is probably a traversal error and it overrides
1822 * the non-traversal error.
1823 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001824 uReturn = uDescendErr;
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001825 goto Done;
1826 }
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001827 }
1828
Laurence Lundblade02625d42020-06-25 14:41:41 -07001829 if(!QCBORItem_IsMapOrArray(pDecodedItem) ||
1830 QCBORItem_IsEmptyDefiniteLengthMapOrArray(pDecodedItem) ||
1831 QCBORItem_IsIndefiniteLengthMapOrArray(pDecodedItem)) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001832 /* The following cases are handled here:
1833 * - A non-aggregate item like an integer or string
1834 * - An empty definite-length map or array
1835 * - An indefinite-length map or array that might be empty or might not.
1836 *
1837 * QCBORDecode_NestLevelAscender() does the work of decrementing the count
1838 * for an definite-length map/array and break detection for an
1839 * indefinite-0length map/array. If the end of the map/array was
1840 * reached, then it ascends nesting levels, possibly all the way
1841 * to the top level.
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001842 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001843 QCBORError uAscendErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001844 uAscendErr = QCBORDecode_NestLevelAscender(pMe, true);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001845 if(uAscendErr != QCBOR_SUCCESS) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001846 /* This error is probably a traversal error and it overrides
1847 * the non-traversal error.
1848 */
Laurence Lundbladea9489f82020-09-12 13:50:56 -07001849 uReturn = uAscendErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07001850 goto Done;
Laurence Lundblade5e87da62020-06-07 03:24:28 -07001851 }
Laurence Lundblade6de37062018-10-15 12:22:42 +05301852 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001853
Laurence Lundbladeeaa75a52020-07-09 18:13:23 -07001854 /* ==== Last: tell the caller the nest level of the next item ==== */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001855 /* Tell the caller what level is next. This tells them what
1856 * maps/arrays were closed out and makes it possible for them to
1857 * reconstruct the tree with just the information returned in a
1858 * QCBORItem.
Laurence Lundblade642282a2020-06-23 12:00:33 -07001859 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001860 if(DecodeNesting_IsAtEndOfBoundedLevel(&(pMe->nesting))) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07001861 /* At end of a bounded map/array; uNextNestLevel 0 to indicate this */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001862 pDecodedItem->uNextNestLevel = 0;
1863 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001864 pDecodedItem->uNextNestLevel = DecodeNesting_GetCurrentLevel(&(pMe->nesting));
Laurence Lundblade9c905e82020-04-25 11:31:38 -07001865 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08001866
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001867Done:
Laurence Lundblade0a042a92020-06-12 14:09:50 -07001868 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001869}
1870
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001871
1872/**
1873 * @brief Shift 0th tag out of the tag list.
1874 *
1875 * pDecodedItem[in,out] The data item to convert.
1876 *
1877 * The 0th tag is discarded. \ref CBOR_TAG_INVALID16 is
1878 * shifted into empty slot at the end of the tag list.
1879 */
1880static inline void ShiftTags(QCBORItem *pDecodedItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07001881{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001882 for(int i = 0; i < QCBOR_MAX_TAGS_PER_ITEM-1; i++) {
1883 pDecodedItem->uTags[i] = pDecodedItem->uTags[i+1];
1884 }
1885 pDecodedItem->uTags[QCBOR_MAX_TAGS_PER_ITEM-1] = CBOR_TAG_INVALID16;
Laurence Lundblade9b334962020-08-27 10:55:53 -07001886}
1887
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07001888
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001889/**
1890 * @brief Convert different epoch date formats in to the QCBOR epoch date format
1891 *
1892 * pDecodedItem[in,out] The data item to convert.
1893 *
1894 * @retval QCBOR_ERR_DATE_OVERFLOW
1895 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1896 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1897 *
1898 * The epoch date tag defined in QCBOR allows for floating-point
1899 * dates. It even allows a protocol to flop between date formats when
1900 * ever it wants. Floating-point dates aren't that useful as they are
1901 * only needed for dates beyond the age of the earth.
1902 *
1903 * This converts all the date formats into one format of an unsigned
1904 * integer plus a floating-point fraction.
Laurence Lundblade59289e52019-12-30 13:44:37 -08001905 */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08001906static QCBORError DecodeDateEpoch(QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08001907{
Laurence Lundbladec7114722020-08-13 05:11:40 -07001908 QCBORError uReturn = QCBOR_SUCCESS;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001909
1910 pDecodedItem->val.epochDate.fSecondsFraction = 0;
1911
1912 switch (pDecodedItem->uDataType) {
1913
1914 case QCBOR_TYPE_INT64:
1915 pDecodedItem->val.epochDate.nSeconds = pDecodedItem->val.int64;
1916 break;
1917
1918 case QCBOR_TYPE_UINT64:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001919 /* This only happens for CBOR type 0 > INT64_MAX so it is
1920 * always an overflow.
1921 */
Laurence Lundbladec7114722020-08-13 05:11:40 -07001922 uReturn = QCBOR_ERR_DATE_OVERFLOW;
1923 goto Done;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001924 break;
1925
1926 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade9682a532020-06-06 18:33:04 -07001927 case QCBOR_TYPE_FLOAT:
1928#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade59289e52019-12-30 13:44:37 -08001929 {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001930 /* Convert working value to double if input was a float */
Laurence Lundblade3ed0bca2020-07-14 22:50:10 -07001931 const double d = pDecodedItem->uDataType == QCBOR_TYPE_DOUBLE ?
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001932 pDecodedItem->val.dfnum :
1933 (double)pDecodedItem->val.fnum;
1934
1935 /* The conversion from float to integer requires overflow
1936 * detection since floats can be much larger than integers.
1937 * This implementation errors out on these large float values
1938 * since they are beyond the age of the earth.
1939 *
1940 * These constants for the overflow check are computed by the
1941 * compiler. They are not computed at run time.
1942 *
1943 * The factor of 0x7ff is added/subtracted to avoid a
1944 * rounding error in the wrong direction when the compiler
1945 * computes these constants. There is rounding because an
1946 * 64-bit integer has 63 bits of precision where a double
1947 * only has 53 bits. Without the 0x7ff factor, the compiler
1948 * may round up and produce a double for the bounds check
1949 * that is larger than can be stored in a 64-bit integer. The
1950 * amount of 0x7ff is picked because it has 11 bits set.
1951 *
1952 * Without the 0x7ff there is a ~30 minute range of time
1953 * values 10 billion years in the past and in the future
1954 * where this code could go wrong. Some compilers correctly
1955 * generate a warning or error without the 0x7ff.
1956 */
1957 const double dDateMax = (double)(INT64_MAX - 0x7ff);
1958 const double dDateMin = (double)(INT64_MIN + 0x7ff);
1959
1960 if(isnan(d) || d > dDateMax || d < dDateMin) {
Laurence Lundbladec7114722020-08-13 05:11:40 -07001961 uReturn = QCBOR_ERR_DATE_OVERFLOW;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001962 goto Done;
1963 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001964
1965 /* The actual conversion */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001966 pDecodedItem->val.epochDate.nSeconds = (int64_t)d;
Laurence Lundblade2feb1e12020-07-15 03:50:45 -07001967 pDecodedItem->val.epochDate.fSecondsFraction =
1968 d - (double)pDecodedItem->val.epochDate.nSeconds;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001969 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001970#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade4b270642020-08-14 12:53:07 -07001971
Laurence Lundbladec7114722020-08-13 05:11:40 -07001972 uReturn = QCBOR_ERR_FLOAT_DATE_DISABLED;
Laurence Lundblade4b270642020-08-14 12:53:07 -07001973 goto Done;
1974
Laurence Lundblade9682a532020-06-06 18:33:04 -07001975#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade59289e52019-12-30 13:44:37 -08001976 break;
1977
1978 default:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08001979 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001980 goto Done;
1981 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07001982
Laurence Lundblade59289e52019-12-30 13:44:37 -08001983 pDecodedItem->uDataType = QCBOR_TYPE_DATE_EPOCH;
1984
1985Done:
Laurence Lundbladec7114722020-08-13 05:11:40 -07001986 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08001987}
1988
1989
Laurence Lundblade46d63e92021-05-13 11:37:10 -07001990/**
1991 * @brief Convert the days epoch date.
1992 *
1993 * pDecodedItem[in,out] The data item to convert.
1994 *
1995 * @retval QCBOR_ERR_DATE_OVERFLOW
1996 * @retval QCBOR_ERR_FLOAT_DATE_DISABLED
1997 * @retval QCBOR_ERR_BAD_TAG_CONTENT
1998 *
1999 * This is much simpler than the other epoch date format because
2000 * floating-porint is not allowed. This is mostly a simple type check.
2001 */
2002static QCBORError DecodeDaysEpoch(QCBORItem *pDecodedItem)
2003{
2004 QCBORError uReturn = QCBOR_SUCCESS;
2005
2006 switch (pDecodedItem->uDataType) {
2007
2008 case QCBOR_TYPE_INT64:
2009 pDecodedItem->val.epochDays = pDecodedItem->val.int64;
2010 break;
2011
2012 case QCBOR_TYPE_UINT64:
2013 /* This only happens for CBOR type 0 > INT64_MAX so it is
2014 * always an overflow.
2015 */
2016 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2017 goto Done;
2018 break;
2019
2020 default:
2021 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
2022 goto Done;
2023 break;
2024 }
2025
2026 pDecodedItem->uDataType = QCBOR_TYPE_DAYS_EPOCH;
2027
2028Done:
2029 return uReturn;
2030}
2031
2032
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002033#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002034/**
2035 * @brief Decode decimal fractions and big floats.
2036 *
2037 * @param[in] pMe The decode context.
2038 * @param[in,out] pDecodedItem On input the array data item that
2039 * holds the mantissa and exponent. On
2040 * output the decoded mantissa and
2041 * exponent.
2042 *
2043 * @returns Decoding errors from getting primitive data items or
2044 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2045 *
2046 * When called pDecodedItem must be the array that is tagged as a big
2047 * float or decimal fraction, the array that has the two members, the
2048 * exponent and mantissa.
2049 *
2050 * This will fetch and decode the exponent and mantissa and put the
2051 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002052 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002053static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002054QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002055{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002056 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002057
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002058 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002059 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002060 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002061 goto Done;
2062 }
2063
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002064 /* A check for pDecodedItem->val.uCount == 2 would work for
2065 * definite-length arrays, but not for indefnite. Instead remember
2066 * the nesting level the two integers must be at, which is one
2067 * deeper than that of the array.
2068 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002069 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2070
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002071 /* --- Which is it, decimal fraction or a bigfloat? --- */
2072 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002073 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2074
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002075 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002076 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002077 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2078 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002079 goto Done;
2080 }
2081 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002082 /* Array is empty or a map/array encountered when expecting an int */
2083 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002084 goto Done;
2085 }
2086 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002087 /* Data arriving as an unsigned int < INT64_MAX has been
2088 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2089 * also means that the only data arriving here of type
2090 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2091 * and thus an error that will get handled in the next else.
2092 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002093 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2094 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002095 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2096 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002097 goto Done;
2098 }
2099
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002100 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002101 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002102 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2103 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002104 goto Done;
2105 }
2106 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002107 /* Mantissa missing or map/array encountered when expecting number */
2108 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002109 goto Done;
2110 }
2111 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002112 /* Data arriving as an unsigned int < INT64_MAX has been
2113 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2114 * also means that the only data arriving here of type
2115 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2116 * and thus an error that will get handled in an else below.
2117 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002118 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002119 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2120 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002121 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002122 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002123 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002124 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2125 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2126 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002127 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002128 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2129 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002130 goto Done;
2131 }
2132
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002133 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002134 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002135 /* Extra items in the decimal fraction / big float */
2136 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002137 goto Done;
2138 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002139 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002140
2141Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002142 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002143}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002144#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002145
2146
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002147#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002148/**
2149 * @brief Decode the MIME type tag
2150 *
2151 * @param[in,out] pDecodedItem The item to decode.
2152 *
2153 * Handle the text and binary MIME type tags. Slightly too complicated
2154 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2155 * incorreclty text-only.
2156 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002157static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002158{
2159 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2160 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002161 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002162 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2163 } else {
2164 return QCBOR_ERR_BAD_OPT_TAG;
2165 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002166
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002167 return QCBOR_SUCCESS;
2168}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002169#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002170
2171
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002172/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002173 * Table of CBOR tags whose content is either a text string or a byte
2174 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2175 * of uQCBORtype indicates the content should be a byte string rather
2176 * than a text string
2177 */
2178struct StringTagMapEntry {
2179 uint16_t uTagNumber;
2180 uint8_t uQCBORtype;
2181};
2182
2183#define IS_BYTE_STRING_BIT 0x80
2184#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2185
2186static const struct StringTagMapEntry StringTagMap[] = {
2187 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002188 {CBOR_TAG_DAYS_STRING, QCBOR_TYPE_DAYS_STRING},
Laurence Lundblade99615302020-11-29 11:19:47 -08002189 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2190 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2191 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2192 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002193#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002194 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2195 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2196 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2197 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002198#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002199 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2200 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2201};
2202
2203
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002204/**
2205 * @brief Process standard CBOR tags whose content is a string
2206 *
2207 * @param[in] uTag The tag.
2208 * @param[in,out] pDecodedItem The data item.
2209 *
2210 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2211 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2212 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2213 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002214 * Process the CBOR tags that whose content is a byte string or a text
2215 * string and for which the string is just passed on to the caller.
2216 *
2217 * This maps the CBOR tag to the QCBOR type and checks the content
2218 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002219 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002220 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002221 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002222static inline QCBORError
2223ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002224{
Laurence Lundblade99615302020-11-29 11:19:47 -08002225 /* This only works on tags that were not mapped; no need for other yet */
2226 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2227 return QCBOR_ERR_UNSUPPORTED;
2228 }
2229
2230 unsigned uIndex;
2231 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2232 if(StringTagMap[uIndex].uTagNumber == uTag) {
2233 break;
2234 }
2235 }
2236
2237 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2238 if(uQCBORType == QCBOR_TYPE_NONE) {
2239 /* repurpose this error to mean, not handled here */
2240 return QCBOR_ERR_UNSUPPORTED;
2241 }
2242
2243 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2244 if(uQCBORType & IS_BYTE_STRING_BIT) {
2245 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2246 }
2247
2248 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002249 return QCBOR_ERR_BAD_OPT_TAG;
2250 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002251
Laurence Lundblade99615302020-11-29 11:19:47 -08002252 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002253 return QCBOR_SUCCESS;
2254}
2255
2256
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002257/**
2258 * @brief Decode tag content for select tags (decoding layer 1).
2259 *
2260 * @param[in] pMe The decode context.
2261 * @param[out] pDecodedItem The decoded item.
2262 *
2263 * @return Decoding error code.
2264 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002265 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2266 * but the whole tag was not decoded. Here, the whole tags (tag number
2267 * and tag content) that are supported by QCBOR are decoded. This is a
2268 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002269 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002270static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002271QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002272{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002273 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002274
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002275 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002276 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002277 goto Done;
2278 }
2279
Laurence Lundblade99615302020-11-29 11:19:47 -08002280 /* When there are no tag numbers for the item, this exits first
2281 * thing and effectively does nothing.
2282 *
2283 * This loops over all the tag numbers accumulated for this item
2284 * trying to decode and interpret them. This stops at the end of
2285 * the list or at the first tag number that can't be interpreted by
2286 * this code. This is effectively a recursive processing of the
2287 * tags number list that handles nested tags.
2288 */
2289 while(1) {
2290 /* Don't bother to unmap tags via QCBORITem.uTags since this
2291 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2292 */
2293 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002294
Laurence Lundblade99615302020-11-29 11:19:47 -08002295 if(uTagToProcess == CBOR_TAG_INVALID16) {
2296 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002297 break;
2298
Laurence Lundblade99615302020-11-29 11:19:47 -08002299 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002300 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002301
Laurence Lundblade46d63e92021-05-13 11:37:10 -07002302 } else if(uTagToProcess == CBOR_TAG_DAYS_EPOCH) {
2303 uReturn = DecodeDaysEpoch(pDecodedItem);
2304
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002305#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002306 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2307 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002308 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002309#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002310#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002311 } else if(uTagToProcess == CBOR_TAG_MIME ||
2312 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002313 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002314#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002315
Laurence Lundblade99615302020-11-29 11:19:47 -08002316 } else {
2317 /* See if it is a pass-through byte/text string tag; process if so */
2318 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002319
Laurence Lundblade99615302020-11-29 11:19:47 -08002320 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2321 /* It wasn't a pass-through byte/text string tag so it is
2322 * an unknown tag. This is the exit from the loop on the
2323 * first unknown tag. It is a successful exit.
2324 */
2325 uReturn = QCBOR_SUCCESS;
2326 break;
2327 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002328 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002329
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002330 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002331 /* Error exit from the loop */
2332 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002333 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002334
2335 /* A tag was successfully processed, shift it out of the list of
2336 * tags returned. This is the loop increment.
2337 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002338 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002339 }
2340
2341Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002342 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002343}
2344
2345
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002346/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002347 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002348 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002349QCBORError
2350QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2351{
2352 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002353 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002354 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002355 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2356 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2357 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002358 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002359}
2360
2361
2362/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002363 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002364 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002365QCBORError
2366QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2367{
2368 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2369 const UsefulInputBuf Save = pMe->InBuf;
2370
2371 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2372
2373 pMe->nesting = SaveNesting;
2374 pMe->InBuf = Save;
2375
2376 return uErr;
2377}
2378
2379
2380/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002381 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002382 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002383void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2384{
2385 if(pMe->uLastError != QCBOR_SUCCESS) {
2386 return;
2387 }
2388
2389 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2390}
2391
2392
2393/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002394 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002395 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002396QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002397QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2398 QCBORItem *pDecodedItem,
2399 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002400{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002401 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002402
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002403 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2404 if(uReturn != QCBOR_SUCCESS) {
2405 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002406 }
2407
2408 if(pTags != NULL) {
2409 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002410 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002411 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2412 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002413 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002414 }
2415 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2416 return QCBOR_ERR_TOO_MANY_TAGS;
2417 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002418 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002419 pTags->uNumUsed++;
2420 }
2421 }
2422
2423 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002424}
2425
2426
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002427/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002428 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302429 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002430bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002431 const QCBORItem *pItem,
2432 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002433{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002434 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2435 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002436 break;
2437 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002438 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002439 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002440 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002441 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002442
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002443 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002444}
2445
2446
2447/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002448 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002449 */
Laurence Lundblade87495732021-02-26 10:05:55 -07002450QCBORError QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002451{
Laurence Lundblade87495732021-02-26 10:05:55 -07002452 if(puConsumed != NULL) {
2453 *puConsumed = pMe->InBuf.cursor;
2454 }
2455
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002456 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002457
2458 if(uReturn != QCBOR_SUCCESS) {
2459 goto Done;
2460 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002461
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002462 /* Error out if all the maps/arrays are not closed out */
2463 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002464 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002465 goto Done;
2466 }
2467
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002468 /* Error out if not all the bytes are consumed */
2469 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002470 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002471 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002472
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002473Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002474 return uReturn;
2475}
2476
2477
2478/*
2479 * Public function, see header qcbor/qcbor_decode.h file
2480 */
2481QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
2482{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002483#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002484 /* Call the destructor for the string allocator if there is one.
2485 * Always called, even if there are errors; always have to clean up.
2486 */
2487 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002488#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002489
Laurence Lundblade87495732021-02-26 10:05:55 -07002490 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002491}
2492
2493
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002494/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002495 * Public function, see header qcbor/qcbor_decode.h file
2496 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002497// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002498uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2499 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002500 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002501{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002502 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2503 return CBOR_TAG_INVALID64;
2504 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002505 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2506 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002507 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002508 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002509 }
2510}
2511
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002512
Laurence Lundblade9b334962020-08-27 10:55:53 -07002513/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002514 * Public function, see header qcbor/qcbor_decode.h file
2515 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002516uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2517 uint32_t uIndex)
2518{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002519 if(pMe->uLastError != QCBOR_SUCCESS) {
2520 return CBOR_TAG_INVALID64;
2521 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002522 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2523 return CBOR_TAG_INVALID64;
2524 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002525 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002526 }
2527}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002528
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002529
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002530
2531
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002532#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002533
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002534/* ===========================================================================
2535 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002536
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002537 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002538 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2539 implements the function type QCBORStringAllocate and allows easy
2540 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002541
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002542 This particular allocator is built-in for convenience. The caller
2543 can implement their own. All of this following code will get
2544 dead-stripped if QCBORDecode_SetMemPool() is not called.
2545
2546 This is a very primitive memory allocator. It does not track
2547 individual allocations, only a high-water mark. A free or
2548 reallocation must be of the last chunk allocated.
2549
2550 The size of the pool and offset to free memory are packed into the
2551 first 8 bytes of the memory pool so we don't have to keep them in
2552 the decode context. Since the address of the pool may not be
2553 aligned, they have to be packed and unpacked as if they were
2554 serialized data of the wire or such.
2555
2556 The sizes packed in are uint32_t to be the same on all CPU types
2557 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002558 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002559
2560
Laurence Lundbladeee851742020-01-08 08:37:05 -08002561static inline int
2562MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002563{
2564 // Use of UsefulInputBuf is overkill, but it is convenient.
2565 UsefulInputBuf UIB;
2566
Laurence Lundbladeee851742020-01-08 08:37:05 -08002567 // Just assume the size here. It was checked during SetUp so
2568 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002569 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002570 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2571 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2572 return UsefulInputBuf_GetError(&UIB);
2573}
2574
2575
Laurence Lundbladeee851742020-01-08 08:37:05 -08002576static inline int
2577MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002578{
2579 // Use of UsefulOutBuf is overkill, but convenient. The
2580 // length check performed here is useful.
2581 UsefulOutBuf UOB;
2582
2583 UsefulOutBuf_Init(&UOB, Pool);
2584 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2585 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2586 return UsefulOutBuf_GetError(&UOB);
2587}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002588
2589
2590/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002591 Internal function for an allocation, reallocation free and destuct.
2592
2593 Having only one function rather than one each per mode saves space in
2594 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002595
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002596 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2597 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002598static UsefulBuf
2599MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002600{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002601 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002602
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002603 uint32_t uPoolSize;
2604 uint32_t uFreeOffset;
2605
2606 if(uNewSize > UINT32_MAX) {
2607 // This allocator is only good up to 4GB. This check should
2608 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2609 goto Done;
2610 }
2611 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2612
2613 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2614 goto Done;
2615 }
2616
2617 if(uNewSize) {
2618 if(pMem) {
2619 // REALLOCATION MODE
2620 // Calculate pointer to the end of the memory pool. It is
2621 // assumed that pPool + uPoolSize won't wrap around by
2622 // assuming the caller won't pass a pool buffer in that is
2623 // not in legitimate memory space.
2624 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2625
2626 // Check that the pointer for reallocation is in the range of the
2627 // pool. This also makes sure that pointer math further down
2628 // doesn't wrap under or over.
2629 if(pMem >= pPool && pMem < pPoolEnd) {
2630 // Offset to start of chunk for reallocation. This won't
2631 // wrap under because of check that pMem >= pPool. Cast
2632 // is safe because the pool is always less than UINT32_MAX
2633 // because of check in QCBORDecode_SetMemPool().
2634 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2635
2636 // Check to see if the allocation will fit. uPoolSize -
2637 // uMemOffset will not wrap under because of check that
2638 // pMem is in the range of the uPoolSize by check above.
2639 if(uNewSize <= uPoolSize - uMemOffset) {
2640 ReturnValue.ptr = pMem;
2641 ReturnValue.len = uNewSize;
2642
2643 // Addition won't wrap around over because uNewSize was
2644 // checked to be sure it is less than the pool size.
2645 uFreeOffset = uMemOffset + uNewSize32;
2646 }
2647 }
2648 } else {
2649 // ALLOCATION MODE
2650 // uPoolSize - uFreeOffset will not underflow because this
2651 // pool implementation makes sure uFreeOffset is always
2652 // smaller than uPoolSize through this check here and
2653 // reallocation case.
2654 if(uNewSize <= uPoolSize - uFreeOffset) {
2655 ReturnValue.len = uNewSize;
2656 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002657 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002658 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002659 }
2660 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002661 if(pMem) {
2662 // FREE MODE
2663 // Cast is safe because of limit on pool size in
2664 // QCBORDecode_SetMemPool()
2665 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2666 } else {
2667 // DESTRUCT MODE
2668 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002669 }
2670 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002671
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002672 UsefulBuf Pool = {pPool, uPoolSize};
2673 MemPool_Pack(Pool, uFreeOffset);
2674
2675Done:
2676 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002677}
2678
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002679
Laurence Lundbladef6531662018-12-04 10:42:22 +09002680/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002681 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002682 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002683QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2684 UsefulBuf Pool,
2685 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002686{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002687 // The pool size and free mem offset are packed into the beginning
2688 // of the pool memory. This compile time check make sure the
2689 // constant in the header is correct. This check should optimize
2690 // down to nothing.
2691 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002692 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002693 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002694
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002695 // The pool size and free offset packed in to the beginning of pool
2696 // memory are only 32-bits. This check will optimize out on 32-bit
2697 // machines.
2698 if(Pool.len > UINT32_MAX) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002699 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002700 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002701
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002702 // This checks that the pool buffer given is big enough.
2703 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002704 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002705 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002706
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002707 pMe->StringAllocator.pfAllocator = MemPool_Function;
2708 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2709 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002710
Laurence Lundblade30816f22018-11-10 13:40:22 +07002711 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002712}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002713#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002714
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002715
2716
Laurence Lundblade9b334962020-08-27 10:55:53 -07002717static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2718{
2719 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2720}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002721
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002722
2723/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002724 Consume an entire map or array (and do next to
2725 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002726 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002727static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002728ConsumeItem(QCBORDecodeContext *pMe,
2729 const QCBORItem *pItemToConsume,
2730 uint_fast8_t *puNextNestLevel)
2731{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002732 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002733 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002734
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002735 // If it is a map or array, this will tell if it is empty.
2736 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2737
2738 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2739 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002740
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002741 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002742 * maps and arrays by using the nesting level
2743 */
2744 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002745 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002746 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002747 goto Done;
2748 }
2749 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002750
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002751 *puNextNestLevel = Item.uNextNestLevel;
2752
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002753 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002754
Laurence Lundblade1341c592020-04-11 14:19:05 -07002755 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002756 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002757 /* Just pass the nesting level through */
2758 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2759
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002760 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002761 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002762
2763Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002764 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002765}
2766
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002767
2768void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2769{
2770 uint8_t uNextNestLevel;
2771
2772 QCBORDecode_VGetNext(pMe, pDecodedItem);
2773
2774 if(pMe->uLastError == QCBOR_SUCCESS) {
2775 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem, &uNextNestLevel);
2776 pDecodedItem->uNextNestLevel = uNextNestLevel;
2777 }
2778}
2779
2780
2781
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002782/* Call only on maps and arrays. Rewinds the cursor
2783 * to the start as if it was just entered.
2784 */
2785static void RewindMapOrArray(QCBORDecodeContext *pMe)
2786{
2787 /* Reset nesting tracking to the deepest bounded level */
2788 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2789
2790 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2791
2792 /* Reposition traversal cursor to the start of the map/array */
2793 UsefulInputBuf_Seek(&(pMe->InBuf),
2794 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2795}
2796
2797
2798/*
2799 Public function, see header qcbor/qcbor_decode.h file
2800 */
2801void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2802{
2803 if(pMe->nesting.pCurrentBounded != NULL) {
2804 /* In a bounded map, array or bstr-wrapped CBOR */
2805
2806 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2807 /* In bstr-wrapped CBOR. */
2808
2809 /* Reposition traversal cursor to start of wrapping byte string */
2810 UsefulInputBuf_Seek(&(pMe->InBuf),
2811 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2812 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2813
2814 } else {
2815 /* In a map or array */
2816 RewindMapOrArray(pMe);
2817 }
2818
2819 } else {
2820 /* Not in anything bounded */
2821
2822 /* Reposition traversal cursor to the start of input CBOR */
2823 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2824
2825 /* Reset nesting tracking to beginning of input. */
2826 DecodeNesting_Init(&(pMe->nesting));
2827 }
2828
2829 pMe->uLastError = QCBOR_SUCCESS;
2830}
2831
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002832
Laurence Lundblade1341c592020-04-11 14:19:05 -07002833/* Return true if the labels in Item1 and Item2 are the same.
2834 Works only for integer and string labels. Returns false
2835 for any other type. */
2836static inline bool
2837MatchLabel(QCBORItem Item1, QCBORItem Item2)
2838{
2839 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2840 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2841 return true;
2842 }
2843 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002844 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002845 return true;
2846 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002847 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002848 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2849 return true;
2850 }
2851 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2852 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2853 return true;
2854 }
2855 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002856
Laurence Lundblade1341c592020-04-11 14:19:05 -07002857 /* Other label types are never matched */
2858 return false;
2859}
2860
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002861
2862/*
2863 Returns true if Item1 and Item2 are the same type
2864 or if either are of QCBOR_TYPE_ANY.
2865 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002866static inline bool
2867MatchType(QCBORItem Item1, QCBORItem Item2)
2868{
2869 if(Item1.uDataType == Item2.uDataType) {
2870 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002871 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002872 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002873 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002874 return true;
2875 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002876 return false;
2877}
2878
2879
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002880/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002881 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002882
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002883 @param[in] pMe The decode context to search.
2884 @param[in,out] pItemArray The items to search for and the items found.
2885 @param[out] puOffset Byte offset of last item matched.
2886 @param[in] pCBContext Context for the not-found item call back.
2887 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002888
2889 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2890
Laurence Lundblade93d89472020-10-03 22:30:50 -07002891 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2892 were found for one of the labels being
2893 search for. This duplicate detection is
2894 only performed for items in pItemArray,
2895 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002896
Laurence Lundblade93d89472020-10-03 22:30:50 -07002897 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2898 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002899
2900 @retval Also errors returned by QCBORDecode_GetNext().
2901
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002902 On input pItemArray contains a list of labels and data types
2903 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002904
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002905 On output the fully retrieved items are filled in with
2906 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002907
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002908 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002909
2910 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002911 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002912static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002913MapSearch(QCBORDecodeContext *pMe,
2914 QCBORItem *pItemArray,
2915 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002916 void *pCBContext,
2917 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002918{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002919 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002920 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002921
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002922 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002923 uReturn = pMe->uLastError;
2924 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002925 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002926
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002927 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002928 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2929 /* QCBOR_TYPE_NONE as first item indicates just looking
2930 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002931 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2932 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002933 }
2934
Laurence Lundblade085d7952020-07-24 10:26:30 -07002935 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2936 // It is an empty bounded array or map
2937 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2938 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002939 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002940 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002941 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002942 // Nothing is ever found in an empty array or map. All items
2943 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002944 uReturn = QCBOR_SUCCESS;
2945 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002946 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002947 }
2948
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002949 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002950 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2951
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002952 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002953 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002954
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002955 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002956 Loop over all the items in the map or array. Each item
2957 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002958 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002959 length maps and arrays. The only reason this is ever
2960 called on arrays is to find their end position.
2961
2962 This will always run over all items in order to do
2963 duplicate detection.
2964
2965 This will exit with failure if it encounters an
2966 unrecoverable error, but continue on for recoverable
2967 errors.
2968
2969 If a recoverable error occurs on a matched item, then
2970 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002971 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002972 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002973 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002974 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002975 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002976 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002977
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002978 /* Get the item */
2979 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002980 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002981 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002982 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002983 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002984 goto Done;
2985 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002986 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002987 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002988 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002989 goto Done;
2990 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002991
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002992 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002993 bool bMatched = false;
2994 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
2995 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002996 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002997 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
2998 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002999 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003000 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003001 if(uResult != QCBOR_SUCCESS) {
3002 /* The label matches, but the data item is in error */
3003 uReturn = uResult;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003004 goto Done;
3005 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003006 if(!MatchType(Item, pItemArray[nIndex])) {
3007 /* The data item is not of the type(s) requested */
3008 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003009 goto Done;
3010 }
3011
Laurence Lundblade1341c592020-04-11 14:19:05 -07003012 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003013 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003014 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003015 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003016 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003017 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003018 bMatched = true;
3019 }
3020 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003021
3022
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003023 if(!bMatched && pfCallback != NULL) {
3024 /*
3025 Call the callback on unmatched labels.
3026 (It is tempting to do duplicate detection here, but that would
3027 require dynamic memory allocation because the number of labels
3028 that might be encountered is unbounded.)
3029 */
3030 uReturn = (*pfCallback)(pCBContext, &Item);
3031 if(uReturn != QCBOR_SUCCESS) {
3032 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003033 }
3034 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003035
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003036 /*
3037 Consume the item whether matched or not. This
3038 does the work of traversing maps and array and
3039 everything in them. In this loop only the
3040 items at the current nesting level are examined
3041 to match the labels.
3042 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003043 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003044 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003045 goto Done;
3046 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003047
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003048 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003049
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003050 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003051
3052 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003053
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003054 // Check here makes sure that this won't accidentally be
3055 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003056 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003057 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3058 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003059 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3060 goto Done;
3061 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003062 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3063 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003064
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003065 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003066 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
3067
3068 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003069 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003070 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003071 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003072 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3073 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003074 }
3075 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003076
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003077 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003078}
3079
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003080
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003081/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003082 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003083*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003084void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3085 int64_t nLabel,
3086 uint8_t uQcborType,
3087 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003088{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003089 if(pMe->uLastError != QCBOR_SUCCESS) {
3090 return;
3091 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003092
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003093 QCBORItem OneItemSeach[2];
3094 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3095 OneItemSeach[0].label.int64 = nLabel;
3096 OneItemSeach[0].uDataType = uQcborType;
3097 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003098
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003099 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003100
3101 *pItem = OneItemSeach[0];
3102
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003103 if(uReturn != QCBOR_SUCCESS) {
3104 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003105 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003106 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003107 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003108 }
3109
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003110 Done:
3111 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003112}
3113
3114
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003115/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003116 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003117*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003118void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3119 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003120 uint8_t uQcborType,
3121 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003122{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003123 if(pMe->uLastError != QCBOR_SUCCESS) {
3124 return;
3125 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003126
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003127 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003128 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3129 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3130 OneItemSeach[0].uDataType = uQcborType;
3131 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003132
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003133 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3134 if(uReturn != QCBOR_SUCCESS) {
3135 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003136 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003137 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003138 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003139 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003140 }
3141
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003142 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003143
3144Done:
3145 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003146}
3147
3148
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003149
Laurence Lundblade93d89472020-10-03 22:30:50 -07003150static QCBORError
3151CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003152{
3153 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3154 if(uDataType == puTypeList[i]) {
3155 return QCBOR_SUCCESS;
3156 }
3157 }
3158 return QCBOR_ERR_UNEXPECTED_TYPE;
3159}
3160
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003161
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003162/**
3163 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003164 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003165
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003166 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3167 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003168
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003169 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3170 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003171 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003172static QCBORError
3173CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003174{
3175 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3176 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3177 /* There are tags that QCBOR couldn't process on this item and
3178 the caller has told us there should not be. */
3179 return QCBOR_ERR_UNEXPECTED_TYPE;
3180 }
3181
3182 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3183 const int nItemType = pItem->uDataType;
3184
3185 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3186 // Must match the tag and only the tag
3187 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3188 }
3189
3190 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3191 if(uReturn == QCBOR_SUCCESS) {
3192 return QCBOR_SUCCESS;
3193 }
3194
3195 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3196 /* Must match the content type and only the content type.
3197 There was no match just above so it is a fail. */
3198 return QCBOR_ERR_UNEXPECTED_TYPE;
3199 }
3200
3201 /* If here it can match either the tag or the content
3202 and it hasn't matched the content, so the end
3203 result is whether it matches the tag. This is
3204 also the case that the CBOR standard discourages. */
3205
3206 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3207}
3208
Laurence Lundblade9b334962020-08-27 10:55:53 -07003209
Laurence Lundblade9b334962020-08-27 10:55:53 -07003210
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003211// This could be semi-private if need be
3212static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003213void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3214 int64_t nLabel,
3215 TagSpecification TagSpec,
3216 QCBORItem *pItem)
3217{
3218 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3219 if(pMe->uLastError != QCBOR_SUCCESS) {
3220 return;
3221 }
3222
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003223 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003224}
3225
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003226
3227// This could be semi-private if need be
3228static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003229void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3230 const char *szLabel,
3231 TagSpecification TagSpec,
3232 QCBORItem *pItem)
3233{
3234 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3235 if(pMe->uLastError != QCBOR_SUCCESS) {
3236 return;
3237 }
3238
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003239 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003240}
3241
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003242// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003243void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3244 int64_t nLabel,
3245 TagSpecification TagSpec,
3246 UsefulBufC *pString)
3247{
3248 QCBORItem Item;
3249 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3250 if(pMe->uLastError == QCBOR_SUCCESS) {
3251 *pString = Item.val.string;
3252 }
3253}
3254
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003255// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003256void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3257 const char * szLabel,
3258 TagSpecification TagSpec,
3259 UsefulBufC *pString)
3260{
3261 QCBORItem Item;
3262 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3263 if(pMe->uLastError == QCBOR_SUCCESS) {
3264 *pString = Item.val.string;
3265 }
3266}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003267
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003268/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003269 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003270*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003271void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003272{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003273 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3274 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003275}
3276
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003277/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003278 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003279*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003280void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3281 QCBORItem *pItemList,
3282 void *pCallbackCtx,
3283 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003284{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003285 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3286 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003287}
3288
3289
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003290/**
3291 * @brief Search for a map/array by label and enter it
3292 *
3293 * @param[in] pMe The decode context.
3294 * @param[in] pSearch The map/array to search for.
3295 *
3296 * @c pSearch is expected to contain one item of type map or array
3297 * with the label specified. The current bounded map will be searched for
3298 * this and if found will be entered.
3299 *
3300 * If the label is not found, or the item found is not a map or array,
3301 * the error state is set.
3302 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003303static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003304{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003305 // The first item in pSearch is the one that is to be
3306 // entered. It should be the only one filled in. Any other
3307 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003308 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003309 return;
3310 }
3311
3312 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003313 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003314 if(pMe->uLastError != QCBOR_SUCCESS) {
3315 return;
3316 }
3317
Laurence Lundblade9b334962020-08-27 10:55:53 -07003318 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003319 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003320 return;
3321 }
3322
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003323
3324 /* The map or array was found. Now enter it.
3325 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003326 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3327 * next item for the pre-order traversal cursor to be the map/array
3328 * found by MapSearch(). The next few lines of code force the
3329 * cursor to that.
3330 *
3331 * There is no need to retain the old cursor because
3332 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3333 * beginning of the map/array being entered.
3334 *
3335 * The cursor is forced by: 1) setting the input buffer position to
3336 * the item offset found by MapSearch(), 2) setting the map/array
3337 * counter to the total in the map/array, 3) setting the nesting
3338 * level. Setting the map/array counter to the total is not
3339 * strictly correct, but this is OK because this cursor only needs
3340 * to be used to get one item and MapSearch() has already found it
3341 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003342 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003343 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003344
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003345 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3346
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003347 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003348
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003349 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003350}
3351
3352
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003353/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003354 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003355*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003356void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003357{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003358 QCBORItem OneItemSeach[2];
3359 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3360 OneItemSeach[0].label.int64 = nLabel;
3361 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3362 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003363
Laurence Lundblade9b334962020-08-27 10:55:53 -07003364 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003365 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003366}
3367
3368
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003369/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003370 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003371*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003372void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003373{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003374 QCBORItem OneItemSeach[2];
3375 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3376 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3377 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3378 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003379
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003380 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003381}
3382
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003383/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003384 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003385*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003386void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003387{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003388 QCBORItem OneItemSeach[2];
3389 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3390 OneItemSeach[0].label.int64 = nLabel;
3391 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3392 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003393
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003394 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003395}
3396
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003397/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003398 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003399*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003400void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3401{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003402 QCBORItem OneItemSeach[2];
3403 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3404 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3405 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3406 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003407
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003408 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003409}
3410
3411
Laurence Lundblade02625d42020-06-25 14:41:41 -07003412// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003413void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003414{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003415 QCBORError uErr;
3416
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003417 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003418 if(pMe->uLastError != QCBOR_SUCCESS) {
3419 // Already in error state; do nothing.
3420 return;
3421 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003422
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003423 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003424 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003425 uErr = QCBORDecode_GetNext(pMe, &Item);
3426 if(uErr != QCBOR_SUCCESS) {
3427 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003428 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003429 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003430 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3431 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003432 }
3433
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003434 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003435
3436
Laurence Lundbladef0499502020-08-01 11:55:57 -07003437 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003438 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003439 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3440 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003441 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003442 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3443 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003444 // Special case to increment nesting level for zero-length maps
3445 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003446 DecodeNesting_Descend(&(pMe->nesting), uType);
3447 }
3448
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003449 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003450
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003451 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3452 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003453
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003454 if(pItem != NULL) {
3455 *pItem = Item;
3456 }
3457
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003458Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003459 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003460}
3461
Laurence Lundblade02625d42020-06-25 14:41:41 -07003462
3463/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003464 This is the common work for exiting a level that is a bounded map,
3465 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003466
3467 One chunk of work is to set up the pre-order traversal so it is at
3468 the item just after the bounded map, array or bstr that is being
3469 exited. This is somewhat complex.
3470
3471 The other work is to level-up the bounded mode to next higest bounded
3472 mode or the top level if there isn't one.
3473 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003474static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003475ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003476{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003477 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003478
Laurence Lundblade02625d42020-06-25 14:41:41 -07003479 /*
3480 First the pre-order-traversal byte offset is positioned to the
3481 item just after the bounded mode item that was just consumed.
3482 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003483 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3484
Laurence Lundblade02625d42020-06-25 14:41:41 -07003485 /*
3486 Next, set the current nesting level to one above the bounded level
3487 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003488
Laurence Lundblade02625d42020-06-25 14:41:41 -07003489 DecodeNesting_CheckBoundedType() is always called before this and
3490 makes sure pCurrentBounded is valid.
3491 */
3492 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3493
3494 /*
3495 This does the complex work of leveling up the pre-order traversal
3496 when the end of a map or array or another bounded level is
3497 reached. It may do nothing, or ascend all the way to the top
3498 level.
3499 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003500 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003501 if(uErr != QCBOR_SUCCESS) {
3502 goto Done;
3503 }
3504
Laurence Lundblade02625d42020-06-25 14:41:41 -07003505 /*
3506 This makes the next highest bounded level the current bounded
3507 level. If there is no next highest level, then no bounded mode is
3508 in effect.
3509 */
3510 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003511
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003512 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003513
3514Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003515 return uErr;
3516}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003517
Laurence Lundblade02625d42020-06-25 14:41:41 -07003518
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003519// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003520void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003521{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003522 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003523 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003524 return;
3525 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003526
Laurence Lundblade02625d42020-06-25 14:41:41 -07003527 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003528
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003529 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003530 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003531 goto Done;
3532 }
3533
Laurence Lundblade02625d42020-06-25 14:41:41 -07003534 /*
3535 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003536 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003537 from previous map search, then do a dummy search.
3538 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003539 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003540 QCBORItem Dummy;
3541 Dummy.uLabelType = QCBOR_TYPE_NONE;
3542 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3543 if(uErr != QCBOR_SUCCESS) {
3544 goto Done;
3545 }
3546 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003547
Laurence Lundblade02625d42020-06-25 14:41:41 -07003548 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003549
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003550Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003551 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003552}
3553
3554
Laurence Lundblade1341c592020-04-11 14:19:05 -07003555
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003556static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003557 const QCBORItem *pItem,
3558 uint8_t uTagRequirement,
3559 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003560{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003561 if(pBstr) {
3562 *pBstr = NULLUsefulBufC;
3563 }
3564
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003565 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003566 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003567 return pMe->uLastError;
3568 }
3569
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003570 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003571
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003572 const TagSpecification TagSpec =
3573 {
3574 uTagRequirement,
3575 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3576 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3577 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003578
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003579 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003580 if(uError != QCBOR_SUCCESS) {
3581 goto Done;
3582 }
3583
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003584 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003585 /* Reverse the decrement done by GetNext() for the bstr so the
3586 * increment in QCBORDecode_NestLevelAscender() called by
3587 * ExitBoundedLevel() will work right.
3588 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003589 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003590 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003591
3592 if(pBstr) {
3593 *pBstr = pItem->val.string;
3594 }
3595
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003596 /* This saves the current length of the UsefulInputBuf and then
3597 * narrows the UsefulInputBuf to start and length of the wrapped
3598 * CBOR that is being entered.
3599 *
3600 * Most of these calls are simple inline accessors so this doesn't
3601 * amount to much code.
3602 */
3603
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003604 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003605 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3606 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003607 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003608 goto Done;
3609 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003610
3611 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3612 pItem->val.string.ptr);
3613 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3614 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3615 /* This should never happen because pItem->val.string.ptr should
3616 * always be valid since it was just returned.
3617 */
3618 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3619 goto Done;
3620 }
3621
3622 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3623
3624 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003625 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003626
Laurence Lundblade02625d42020-06-25 14:41:41 -07003627 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003628 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003629 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003630Done:
3631 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003632}
3633
3634
Laurence Lundblade02625d42020-06-25 14:41:41 -07003635/*
3636 Public function, see header qcbor/qcbor_decode.h file
3637 */
3638void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003639 uint8_t uTagRequirement,
3640 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003641{
3642 if(pMe->uLastError != QCBOR_SUCCESS) {
3643 // Already in error state; do nothing.
3644 return;
3645 }
3646
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003647 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003648 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003649 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3650 if(pMe->uLastError != QCBOR_SUCCESS) {
3651 return;
3652 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003653
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003654 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003655 &Item,
3656 uTagRequirement,
3657 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003658}
3659
3660
Laurence Lundblade02625d42020-06-25 14:41:41 -07003661/*
3662 Public function, see header qcbor/qcbor_decode.h file
3663 */
3664void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003665 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003666 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003667 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003668{
3669 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003670 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003671
Laurence Lundblade93d89472020-10-03 22:30:50 -07003672 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3673 &Item,
3674 uTagRequirement,
3675 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003676}
3677
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003678
Laurence Lundblade02625d42020-06-25 14:41:41 -07003679/*
3680 Public function, see header qcbor/qcbor_decode.h file
3681 */
3682void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003683 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003684 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003685 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003686{
3687 QCBORItem Item;
3688 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3689
Laurence Lundblade93d89472020-10-03 22:30:50 -07003690 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3691 &Item,
3692 uTagRequirement,
3693 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003694}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003695
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003696
Laurence Lundblade02625d42020-06-25 14:41:41 -07003697/*
3698 Public function, see header qcbor/qcbor_decode.h file
3699 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003700void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003701{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003702 if(pMe->uLastError != QCBOR_SUCCESS) {
3703 // Already in error state; do nothing.
3704 return;
3705 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003706
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003707 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003708 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003709 return;
3710 }
3711
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003712 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3713
Laurence Lundblade02625d42020-06-25 14:41:41 -07003714 /*
3715 Reset the length of the UsefulInputBuf to what it was before
3716 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003717 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003718 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003719 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003720
3721
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003722 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003723 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003724}
3725
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003726
Laurence Lundbladee6430642020-03-14 21:15:44 -07003727
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003728
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003729static inline void
3730ProcessBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003731{
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003732 if(pMe->uLastError != QCBOR_SUCCESS) {
3733 /* Already in error state, do nothing */
3734 return;
3735 }
3736
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003737 switch(pItem->uDataType) {
3738 case QCBOR_TYPE_TRUE:
3739 *pBool = true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003740 break;
3741
3742 case QCBOR_TYPE_FALSE:
3743 *pBool = false;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003744 break;
3745
3746 default:
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003747 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003748 break;
3749 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003750 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003751}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003752
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003753
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003754/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003755 * Public function, see header qcbor/qcbor_decode.h file
3756 */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003757void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003758{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003759 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003760 /* Already in error state, do nothing */
Laurence Lundbladee6430642020-03-14 21:15:44 -07003761 return;
3762 }
3763
Laurence Lundbladec4537442020-04-14 18:53:22 -07003764 QCBORItem Item;
3765
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003766 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3767
3768 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003769}
3770
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003771
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003772/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003773 * Public function, see header qcbor/qcbor_decode.h file
3774 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003775void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003776{
3777 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003778 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003779
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003780 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003781}
3782
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003783
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003784/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003785 * Public function, see header qcbor/qcbor_decode.h file
3786 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003787void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3788{
3789 QCBORItem Item;
3790 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3791
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003792 ProcessBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003793}
3794
3795
3796
Laurence Lundbladec7114722020-08-13 05:11:40 -07003797
3798static void ProcessEpochDate(QCBORDecodeContext *pMe,
3799 QCBORItem *pItem,
3800 uint8_t uTagRequirement,
3801 int64_t *pnTime)
3802{
3803 if(pMe->uLastError != QCBOR_SUCCESS) {
3804 // Already in error state, do nothing
3805 return;
3806 }
3807
3808 QCBORError uErr;
3809
3810 const TagSpecification TagSpec =
3811 {
3812 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003813 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3814 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003815 };
3816
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003817 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003818 if(uErr != QCBOR_SUCCESS) {
3819 goto Done;
3820 }
3821
3822 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3823 uErr = DecodeDateEpoch(pItem);
3824 if(uErr != QCBOR_SUCCESS) {
3825 goto Done;
3826 }
3827 }
3828
Laurence Lundblade9b334962020-08-27 10:55:53 -07003829 // Save the tags in the last item's tags in the decode context
3830 // for QCBORDecode_GetNthTagOfLast()
3831 CopyTags(pMe, pItem);
3832
Laurence Lundbladec7114722020-08-13 05:11:40 -07003833 *pnTime = pItem->val.epochDate.nSeconds;
3834
3835Done:
3836 pMe->uLastError = (uint8_t)uErr;
3837}
3838
3839
3840void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003841 uint8_t uTagRequirement,
3842 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003843{
3844 if(pMe->uLastError != QCBOR_SUCCESS) {
3845 // Already in error state, do nothing
3846 return;
3847 }
3848
3849 QCBORItem Item;
3850 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3851
3852 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3853}
3854
3855
3856void
3857QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3858 int64_t nLabel,
3859 uint8_t uTagRequirement,
3860 int64_t *pnTime)
3861{
3862 QCBORItem Item;
3863 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3864 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3865}
3866
3867
3868void
3869QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3870 const char *szLabel,
3871 uint8_t uTagRequirement,
3872 int64_t *pnTime)
3873{
3874 QCBORItem Item;
3875 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3876 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3877}
3878
3879
3880
Laurence Lundblade46d63e92021-05-13 11:37:10 -07003881/*
3882 * Common processing for the RFC 8943 day-count tag. Mostly
3883 * make sure the tag content is correct and copy forward any
3884 * further other tag numbers.
3885 */
3886static void ProcessEpochDays(QCBORDecodeContext *pMe,
3887 QCBORItem *pItem,
3888 uint8_t uTagRequirement,
3889 int64_t *pnDays)
3890{
3891 if(pMe->uLastError != QCBOR_SUCCESS) {
3892 /* Already in error state, do nothing */
3893 return;
3894 }
3895
3896 QCBORError uErr;
3897
3898 const TagSpecification TagSpec =
3899 {
3900 uTagRequirement,
3901 {QCBOR_TYPE_DAYS_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3902 {QCBOR_TYPE_INT64, QCBOR_TYPE_UINT64, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3903 };
3904
3905 uErr = CheckTagRequirement(TagSpec, pItem);
3906 if(uErr != QCBOR_SUCCESS) {
3907 goto Done;
3908 }
3909
3910 if(pItem->uDataType != QCBOR_TYPE_DAYS_EPOCH) {
3911 uErr = DecodeDaysEpoch(pItem);
3912 if(uErr != QCBOR_SUCCESS) {
3913 goto Done;
3914 }
3915 }
3916
3917 /* Save the tags in the last item's tags in the decode context
3918 * for QCBORDecode_GetNthTagOfLast()
3919 */
3920 CopyTags(pMe, pItem);
3921
3922 *pnDays = pItem->val.epochDays;
3923
3924Done:
3925 pMe->uLastError = (uint8_t)uErr;
3926}
3927
3928
3929/*
3930 * Public function, see header qcbor/qcbor_decode.h
3931 */
3932void QCBORDecode_GetEpochDays(QCBORDecodeContext *pMe,
3933 uint8_t uTagRequirement,
3934 int64_t *pnDays)
3935{
3936 if(pMe->uLastError != QCBOR_SUCCESS) {
3937 /* Already in error state, do nothing */
3938 return;
3939 }
3940
3941 QCBORItem Item;
3942 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3943
3944 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3945}
3946
3947
3948/*
3949 * Public function, see header qcbor/qcbor_decode.h
3950 */
3951void
3952QCBORDecode_GetEpochDaysInMapN(QCBORDecodeContext *pMe,
3953 int64_t nLabel,
3954 uint8_t uTagRequirement,
3955 int64_t *pnDays)
3956{
3957 QCBORItem Item;
3958 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3959 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3960}
3961
3962
3963/*
3964 * Public function, see header qcbor/qcbor_decode.h
3965 */
3966void
3967QCBORDecode_GetEpochDaysInMapSZ(QCBORDecodeContext *pMe,
3968 const char *szLabel,
3969 uint8_t uTagRequirement,
3970 int64_t *pnDays)
3971{
3972 QCBORItem Item;
3973 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3974 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
3975}
3976
3977
3978
Laurence Lundbladec7114722020-08-13 05:11:40 -07003979
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003980void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3981 TagSpecification TagSpec,
3982 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003983{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003984 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003985 // Already in error state, do nothing
3986 return;
3987 }
3988
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003989 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003990 QCBORItem Item;
3991
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003992 uError = QCBORDecode_GetNext(pMe, &Item);
3993 if(uError != QCBOR_SUCCESS) {
3994 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003995 return;
3996 }
3997
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003998 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003999
4000 if(pMe->uLastError == QCBOR_SUCCESS) {
4001 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07004002 } else {
4003 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004004 }
4005}
4006
Laurence Lundbladec4537442020-04-14 18:53:22 -07004007
4008
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004009
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004010static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004011 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004012 UsefulBufC *pValue,
4013 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004014{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004015 const TagSpecification TagSpec =
4016 {
4017 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004018 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4019 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004020 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004021
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004022 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004023 if(uErr != QCBOR_SUCCESS) {
4024 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004025 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004026
4027 *pValue = pItem->val.string;
4028
4029 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
4030 *pbIsNegative = false;
4031 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
4032 *pbIsNegative = true;
4033 }
4034
4035 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004036}
4037
4038
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004039/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004040 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004041 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004042void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
4043 uint8_t uTagRequirement,
4044 UsefulBufC *pValue,
4045 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004046{
4047 if(pMe->uLastError != QCBOR_SUCCESS) {
4048 // Already in error state, do nothing
4049 return;
4050 }
4051
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004052 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004053 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4054 if(uError != QCBOR_SUCCESS) {
4055 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004056 return;
4057 }
4058
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004059 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004060}
4061
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004062
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004063/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004064 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004065*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004066void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
4067 int64_t nLabel,
4068 uint8_t uTagRequirement,
4069 UsefulBufC *pValue,
4070 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004071{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004072 QCBORItem Item;
4073 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004074 if(pMe->uLastError != QCBOR_SUCCESS) {
4075 return;
4076 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004077
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004078 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004079}
4080
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004081
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004082/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004083 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004084*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004085void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
4086 const char *szLabel,
4087 uint8_t uTagRequirement,
4088 UsefulBufC *pValue,
4089 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004090{
4091 QCBORItem Item;
4092 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004093 if(pMe->uLastError != QCBOR_SUCCESS) {
4094 return;
4095 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004096
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004097 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004098}
4099
4100
4101
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004102
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004103// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004104QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
4105 const QCBORItem *pItem,
4106 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07004107 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004108{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004109 const TagSpecification TagSpecText =
4110 {
4111 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004112 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4113 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004114 };
4115 const TagSpecification TagSpecBinary =
4116 {
4117 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004118 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4119 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004120 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004121
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004122 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004123
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004124 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004125 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004126 if(pbIsTag257 != NULL) {
4127 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004128 }
4129 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004130 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004131 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004132 if(pbIsTag257 != NULL) {
4133 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004134 }
4135 uReturn = QCBOR_SUCCESS;
4136
4137 } else {
4138 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
4139 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07004140
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004141 return uReturn;
4142}
4143
Laurence Lundblade93d89472020-10-03 22:30:50 -07004144// Improvement: add methods for wrapped CBOR, a simple alternate
4145// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004146
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004147
4148
4149
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004150#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07004151
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004152typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004153
4154
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004155// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004156static QCBORError
4157Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004158{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004159 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004160
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004161 if(uResult != 0) {
4162 /* This loop will run a maximum of 19 times because
4163 * UINT64_MAX < 10 ^^ 19. More than that will cause
4164 * exit with the overflow error
4165 */
4166 for(; nExponent > 0; nExponent--) {
4167 if(uResult > UINT64_MAX / 10) {
4168 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4169 }
4170 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004171 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004172
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004173 for(; nExponent < 0; nExponent++) {
4174 uResult = uResult / 10;
4175 if(uResult == 0) {
4176 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4177 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004178 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004179 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004180 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004181
4182 *puResult = uResult;
4183
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004184 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004185}
4186
4187
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004188// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004189static QCBORError
4190Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004191{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004192 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004193
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004194 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004195
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004196 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004197 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004198 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004199 */
4200 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004201 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004202 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004203 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004204 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004205 nExponent--;
4206 }
4207
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004208 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004209 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004210 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4211 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004212 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004213 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004214 }
4215
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004216 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004217
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004218 return QCBOR_SUCCESS;
4219}
4220
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004221
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004222/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004223 Compute value with signed mantissa and signed result. Works with
4224 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004225 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004226static inline QCBORError ExponentiateNN(int64_t nMantissa,
4227 int64_t nExponent,
4228 int64_t *pnResult,
4229 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004230{
4231 uint64_t uResult;
4232
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004233 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004234 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004235 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4236
4237 // Do the exponentiation of the positive mantissa
4238 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4239 if(uReturn) {
4240 return uReturn;
4241 }
4242
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004243
Laurence Lundblade983500d2020-05-14 11:49:34 -07004244 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4245 of INT64_MIN. This assumes two's compliment representation where
4246 INT64_MIN is one increment farther from 0 than INT64_MAX.
4247 Trying to write -INT64_MIN doesn't work to get this because the
4248 compiler tries to work with an int64_t which can't represent
4249 -INT64_MIN.
4250 */
4251 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4252
4253 // Error out if too large
4254 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004255 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4256 }
4257
4258 // Casts are safe because of checks above
4259 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4260
4261 return QCBOR_SUCCESS;
4262}
4263
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004264
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004265/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004266 Compute value with signed mantissa and unsigned result. Works with
4267 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004268 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004269static inline QCBORError ExponentitateNU(int64_t nMantissa,
4270 int64_t nExponent,
4271 uint64_t *puResult,
4272 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004273{
4274 if(nMantissa < 0) {
4275 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4276 }
4277
4278 // Cast to unsigned is OK because of check for negative
4279 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4280 // Exponentiation is straight forward
4281 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4282}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004283
4284
4285/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004286 Compute value with signed mantissa and unsigned result. Works with
4287 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004288 */
4289static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4290 int64_t nExponent,
4291 uint64_t *puResult,
4292 fExponentiator pfExp)
4293{
4294 return (*pfExp)(uMantissa, nExponent, puResult);
4295}
4296
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004297#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004298
4299
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004300
4301
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004302
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004303static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004304{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004305 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004306
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004307 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004308 const uint8_t *pByte = BigNum.ptr;
4309 size_t uLen = BigNum.len;
4310 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004311 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004312 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004313 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004314 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004315 }
4316
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004317 *pResult = uResult;
4318 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004319}
4320
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004321
Laurence Lundblade887add82020-05-17 05:50:34 -07004322static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004323{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004324 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004325}
4326
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004327
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004328static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004329{
4330 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004331 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4332 if(uError) {
4333 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004334 }
4335 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4336 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004337 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004338}
4339
4340
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004341static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004342{
4343 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004344 /* The negative integer furthest from zero for a C int64_t is
4345 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4346 negative number in CBOR is computed as -n - 1 where n is the
4347 encoded integer, where n is what is in the variable BigNum. When
4348 converting BigNum to a uint64_t, the maximum value is thus
4349 INT64_MAX, so that when it -n - 1 is applied to it the result will
4350 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004351
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004352 -n - 1 <= INT64_MIN.
4353 -n - 1 <= -INT64_MAX - 1
4354 n <= INT64_MAX.
4355 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004356 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004357 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004358 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004359 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004360
4361 /// Now apply -n - 1. The cast is safe because
4362 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4363 // is the largest positive integer that an int64_t can
4364 // represent. */
4365 *pnResult = -(int64_t)uResult - 1;
4366
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004367 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004368}
4369
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004370
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004371
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004372
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004373
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004374/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004375Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004376
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004377\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004378
Laurence Lundblade93d89472020-10-03 22:30:50 -07004379\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4380 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004381
4382\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4383
Laurence Lundblade93d89472020-10-03 22:30:50 -07004384\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4385 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004386*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004387static QCBORError
4388ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004389{
4390 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004391 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004392 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004393#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004394 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004395 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4396 http://www.cplusplus.com/reference/cmath/llround/
4397 */
4398 // Not interested in FE_INEXACT
4399 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004400 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4401 *pnValue = llround(pItem->val.dfnum);
4402 } else {
4403 *pnValue = lroundf(pItem->val.fnum);
4404 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004405 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4406 // llround() shouldn't result in divide by zero, but catch
4407 // it here in case it unexpectedly does. Don't try to
4408 // distinguish between the various exceptions because it seems
4409 // they vary by CPU, compiler and OS.
4410 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004411 }
4412 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004413 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004414 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004415#else
4416 return QCBOR_ERR_HW_FLOAT_DISABLED;
4417#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004418 break;
4419
4420 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004421 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004422 *pnValue = pItem->val.int64;
4423 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004424 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004425 }
4426 break;
4427
4428 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004429 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004430 if(pItem->val.uint64 < INT64_MAX) {
4431 *pnValue = pItem->val.int64;
4432 } else {
4433 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4434 }
4435 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004436 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004437 }
4438 break;
4439
4440 default:
4441 return QCBOR_ERR_UNEXPECTED_TYPE;
4442 }
4443 return QCBOR_SUCCESS;
4444}
4445
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004446
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004447void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004448 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004449 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004450 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004451{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004452 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004453 return;
4454 }
4455
Laurence Lundbladee6430642020-03-14 21:15:44 -07004456 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004457 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4458 if(uError) {
4459 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004460 return;
4461 }
4462
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004463 if(pItem) {
4464 *pItem = Item;
4465 }
4466
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004467 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004468}
4469
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004470
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004471void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4472 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004473 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004474 int64_t *pnValue,
4475 QCBORItem *pItem)
4476{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004477 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004478 if(pMe->uLastError != QCBOR_SUCCESS) {
4479 return;
4480 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004481
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004482 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004483}
4484
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004485
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004486void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4487 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004488 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004489 int64_t *pnValue,
4490 QCBORItem *pItem)
4491{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004492 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004493 if(pMe->uLastError != QCBOR_SUCCESS) {
4494 return;
4495 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004496
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004497 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004498}
4499
4500
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004501/*
4502 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004503
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004504 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004505
Laurence Lundblade93d89472020-10-03 22:30:50 -07004506 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4507 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004508
4509 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4510
Laurence Lundblade93d89472020-10-03 22:30:50 -07004511 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4512 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004513 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004514static QCBORError
4515Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004516{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004517 switch(pItem->uDataType) {
4518
4519 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004520 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004521 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004522 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004523 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004524 }
4525 break;
4526
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004527 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004528 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004529 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004530 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004531 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004532 }
4533 break;
4534
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004535#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004536 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004537 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004538 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004539 pItem->val.expAndMantissa.nExponent,
4540 pnValue,
4541 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004542 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004543 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004544 }
4545 break;
4546
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004547 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004548 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004549 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004550 pItem->val.expAndMantissa.nExponent,
4551 pnValue,
4552 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004553 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004554 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004555 }
4556 break;
4557
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004558 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004559 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004560 int64_t nMantissa;
4561 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004562 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4563 if(uErr) {
4564 return uErr;
4565 }
4566 return ExponentiateNN(nMantissa,
4567 pItem->val.expAndMantissa.nExponent,
4568 pnValue,
4569 Exponentitate10);
4570 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004571 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004572 }
4573 break;
4574
4575 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004576 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004577 int64_t nMantissa;
4578 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004579 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4580 if(uErr) {
4581 return uErr;
4582 }
4583 return ExponentiateNN(nMantissa,
4584 pItem->val.expAndMantissa.nExponent,
4585 pnValue,
4586 Exponentitate10);
4587 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004588 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004589 }
4590 break;
4591
4592 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004593 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004594 int64_t nMantissa;
4595 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004596 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4597 if(uErr) {
4598 return uErr;
4599 }
4600 return ExponentiateNN(nMantissa,
4601 pItem->val.expAndMantissa.nExponent,
4602 pnValue,
4603 Exponentitate2);
4604 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004605 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004606 }
4607 break;
4608
4609 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004610 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004611 int64_t nMantissa;
4612 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004613 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4614 if(uErr) {
4615 return uErr;
4616 }
4617 return ExponentiateNN(nMantissa,
4618 pItem->val.expAndMantissa.nExponent,
4619 pnValue,
4620 Exponentitate2);
4621 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004622 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004623 }
4624 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004625#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004626
Laurence Lundbladee6430642020-03-14 21:15:44 -07004627
Laurence Lundbladec4537442020-04-14 18:53:22 -07004628 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004629 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004630}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004631
4632
Laurence Lundbladec4537442020-04-14 18:53:22 -07004633/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004634 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004635 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004636void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004637{
4638 QCBORItem Item;
4639
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004640 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004641
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004642 if(pMe->uLastError == QCBOR_SUCCESS) {
4643 // The above conversion succeeded
4644 return;
4645 }
4646
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004647 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004648 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004649 return;
4650 }
4651
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004652 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004653}
4654
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004655
4656/*
4657Public function, see header qcbor/qcbor_decode.h file
4658*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004659void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4660 int64_t nLabel,
4661 uint32_t uConvertTypes,
4662 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004663{
4664 QCBORItem Item;
4665
Laurence Lundblade93d89472020-10-03 22:30:50 -07004666 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4667 nLabel,
4668 uConvertTypes,
4669 pnValue,
4670 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004671
4672 if(pMe->uLastError == QCBOR_SUCCESS) {
4673 // The above conversion succeeded
4674 return;
4675 }
4676
4677 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4678 // The above conversion failed in a way that code below can't correct
4679 return;
4680 }
4681
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004682 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004683}
4684
4685
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004686/*
4687Public function, see header qcbor/qcbor_decode.h file
4688*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004689void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4690 const char *szLabel,
4691 uint32_t uConvertTypes,
4692 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004693{
4694 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004695 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4696 szLabel,
4697 uConvertTypes,
4698 pnValue,
4699 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004700
4701 if(pMe->uLastError == QCBOR_SUCCESS) {
4702 // The above conversion succeeded
4703 return;
4704 }
4705
4706 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4707 // The above conversion failed in a way that code below can't correct
4708 return;
4709 }
4710
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004711 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004712}
4713
4714
Laurence Lundblade93d89472020-10-03 22:30:50 -07004715static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004716{
4717 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004718 case QCBOR_TYPE_DOUBLE:
4719 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004720#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004721 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004722 // Can't use llround here because it will not convert values
4723 // greater than INT64_MAX and less than UINT64_MAX that
4724 // need to be converted so it is more complicated.
4725 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4726 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4727 if(isnan(pItem->val.dfnum)) {
4728 return QCBOR_ERR_FLOAT_EXCEPTION;
4729 } else if(pItem->val.dfnum < 0) {
4730 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4731 } else {
4732 double dRounded = round(pItem->val.dfnum);
4733 // See discussion in DecodeDateEpoch() for
4734 // explanation of - 0x7ff
4735 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4736 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4737 }
4738 *puValue = (uint64_t)dRounded;
4739 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004740 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004741 if(isnan(pItem->val.fnum)) {
4742 return QCBOR_ERR_FLOAT_EXCEPTION;
4743 } else if(pItem->val.fnum < 0) {
4744 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4745 } else {
4746 float fRounded = roundf(pItem->val.fnum);
4747 // See discussion in DecodeDateEpoch() for
4748 // explanation of - 0x7ff
4749 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4750 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4751 }
4752 *puValue = (uint64_t)fRounded;
4753 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004754 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004755 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4756 // round() and roundf() shouldn't result in exceptions here, but
4757 // catch them to be robust and thorough. Don't try to
4758 // distinguish between the various exceptions because it seems
4759 // they vary by CPU, compiler and OS.
4760 return QCBOR_ERR_FLOAT_EXCEPTION;
4761 }
4762
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004763 } else {
4764 return QCBOR_ERR_UNEXPECTED_TYPE;
4765 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004766#else
4767 return QCBOR_ERR_HW_FLOAT_DISABLED;
4768#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004769 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004770
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004771 case QCBOR_TYPE_INT64:
4772 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4773 if(pItem->val.int64 >= 0) {
4774 *puValue = (uint64_t)pItem->val.int64;
4775 } else {
4776 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4777 }
4778 } else {
4779 return QCBOR_ERR_UNEXPECTED_TYPE;
4780 }
4781 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004782
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004783 case QCBOR_TYPE_UINT64:
4784 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4785 *puValue = pItem->val.uint64;
4786 } else {
4787 return QCBOR_ERR_UNEXPECTED_TYPE;
4788 }
4789 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004790
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004791 default:
4792 return QCBOR_ERR_UNEXPECTED_TYPE;
4793 }
4794
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004795 return QCBOR_SUCCESS;
4796}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004797
4798
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004799void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004800 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004801 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004802 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004803{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004804 if(pMe->uLastError != QCBOR_SUCCESS) {
4805 return;
4806 }
4807
Laurence Lundbladec4537442020-04-14 18:53:22 -07004808 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004809
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004810 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4811 if(uError) {
4812 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004813 return;
4814 }
4815
Laurence Lundbladea826c502020-05-10 21:07:00 -07004816 if(pItem) {
4817 *pItem = Item;
4818 }
4819
Laurence Lundblade93d89472020-10-03 22:30:50 -07004820 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004821}
4822
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004823
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004824void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004825 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004826 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004827 uint64_t *puValue,
4828 QCBORItem *pItem)
4829{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004830 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004831 if(pMe->uLastError != QCBOR_SUCCESS) {
4832 return;
4833 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004834
Laurence Lundblade93d89472020-10-03 22:30:50 -07004835 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004836}
4837
4838
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004839void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004840 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004841 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004842 uint64_t *puValue,
4843 QCBORItem *pItem)
4844{
4845 if(pMe->uLastError != QCBOR_SUCCESS) {
4846 return;
4847 }
4848
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004849 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004850 if(pMe->uLastError != QCBOR_SUCCESS) {
4851 return;
4852 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004853
Laurence Lundblade93d89472020-10-03 22:30:50 -07004854 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004855}
4856
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004857
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004858
Laurence Lundblade93d89472020-10-03 22:30:50 -07004859static QCBORError
4860UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004861{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004862 switch(pItem->uDataType) {
4863
4864 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004865 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004866 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4867 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004868 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004869 }
4870 break;
4871
4872 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004873 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004874 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4875 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004876 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004877 }
4878 break;
4879
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004880#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004881
4882 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004883 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004884 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004885 pItem->val.expAndMantissa.nExponent,
4886 puValue,
4887 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004888 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004889 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004890 }
4891 break;
4892
4893 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004894 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004895 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4896 pItem->val.expAndMantissa.nExponent,
4897 puValue,
4898 Exponentitate2);
4899 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004900 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004901 }
4902 break;
4903
4904 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004905 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004906 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004907 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004908 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004909 if(uErr != QCBOR_SUCCESS) {
4910 return uErr;
4911 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004912 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004913 pItem->val.expAndMantissa.nExponent,
4914 puValue,
4915 Exponentitate10);
4916 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004917 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004918 }
4919 break;
4920
4921 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004922 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004923 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4924 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004925 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004926 }
4927 break;
4928
4929 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004930 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004931 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004932 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004933 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004934 if(uErr != QCBOR_SUCCESS) {
4935 return uErr;
4936 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004937 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004938 pItem->val.expAndMantissa.nExponent,
4939 puValue,
4940 Exponentitate2);
4941 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004942 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004943 }
4944 break;
4945
4946 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004947 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004948 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4949 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004950 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004951 }
4952 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004953#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004954 default:
4955 return QCBOR_ERR_UNEXPECTED_TYPE;
4956 }
4957}
4958
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004959
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004960/*
4961 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004962 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004963void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004964{
4965 QCBORItem Item;
4966
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004967 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004968
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004969 if(pMe->uLastError == QCBOR_SUCCESS) {
4970 // The above conversion succeeded
4971 return;
4972 }
4973
4974 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4975 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004976 return;
4977 }
4978
Laurence Lundblade93d89472020-10-03 22:30:50 -07004979 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004980}
4981
Laurence Lundbladec4537442020-04-14 18:53:22 -07004982
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004983/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004984 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004985*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004986void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004987 int64_t nLabel,
4988 uint32_t uConvertTypes,
4989 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004990{
4991 QCBORItem Item;
4992
Laurence Lundblade93d89472020-10-03 22:30:50 -07004993 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4994 nLabel,
4995 uConvertTypes,
4996 puValue,
4997 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004998
4999 if(pMe->uLastError == QCBOR_SUCCESS) {
5000 // The above conversion succeeded
5001 return;
5002 }
5003
5004 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5005 // The above conversion failed in a way that code below can't correct
5006 return;
5007 }
5008
Laurence Lundblade93d89472020-10-03 22:30:50 -07005009 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005010}
5011
5012
5013/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005014 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005015*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07005016void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07005017 const char *szLabel,
5018 uint32_t uConvertTypes,
5019 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005020{
5021 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07005022 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
5023 szLabel,
5024 uConvertTypes,
5025 puValue,
5026 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005027
5028 if(pMe->uLastError == QCBOR_SUCCESS) {
5029 // The above conversion succeeded
5030 return;
5031 }
5032
5033 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5034 // The above conversion failed in a way that code below can't correct
5035 return;
5036 }
5037
Laurence Lundblade93d89472020-10-03 22:30:50 -07005038 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005039}
5040
5041
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07005042
5043
Laurence Lundblade9b334962020-08-27 10:55:53 -07005044static QCBORError ConvertDouble(const QCBORItem *pItem,
5045 uint32_t uConvertTypes,
5046 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005047{
5048 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005049 case QCBOR_TYPE_FLOAT:
5050#ifndef QCBOR_DISABLE_FLOAT_HW_USE
5051 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5052 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005053 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005054 *pdValue = (double)pItem->val.fnum;
5055 } else {
5056 return QCBOR_ERR_UNEXPECTED_TYPE;
5057 }
5058 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005059#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005060 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005061#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005062 break;
5063
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005064 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005065 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5066 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005067 *pdValue = pItem->val.dfnum;
5068 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005069 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005070 }
5071 }
5072 break;
5073
5074 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005075#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005076 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005077 // A simple cast seems to do the job with no worry of exceptions.
5078 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005079 *pdValue = (double)pItem->val.int64;
5080
5081 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005082 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005083 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005084#else
5085 return QCBOR_ERR_HW_FLOAT_DISABLED;
5086#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005087 break;
5088
5089 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005090#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005091 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005092 // A simple cast seems to do the job with no worry of exceptions.
5093 // There will be precision loss for some values.
5094 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005095 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005096 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005097 }
5098 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005099#else
5100 return QCBOR_ERR_HW_FLOAT_DISABLED;
5101#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005102
5103 default:
5104 return QCBOR_ERR_UNEXPECTED_TYPE;
5105 }
5106
5107 return QCBOR_SUCCESS;
5108}
5109
5110
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005111void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005112 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005113 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005114 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005115{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005116 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07005117 return;
5118 }
5119
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005120 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005121
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005122 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005123 if(uError) {
5124 pMe->uLastError = (uint8_t)uError;
5125 return;
5126 }
5127
5128 if(pItem) {
5129 *pItem = Item;
5130 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005131
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005132 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005133}
Laurence Lundbladec4537442020-04-14 18:53:22 -07005134
Laurence Lundbladec4537442020-04-14 18:53:22 -07005135
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005136void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
5137 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005138 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005139 double *pdValue,
5140 QCBORItem *pItem)
5141{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005142 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005143 if(pMe->uLastError != QCBOR_SUCCESS) {
5144 return;
5145 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005146
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005147 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005148}
5149
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005150
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005151void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
5152 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005153 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005154 double *pdValue,
5155 QCBORItem *pItem)
5156{
5157 if(pMe->uLastError != QCBOR_SUCCESS) {
5158 return;
5159 }
5160
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005161 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005162 if(pMe->uLastError != QCBOR_SUCCESS) {
5163 return;
5164 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005165
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005166 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005167}
5168
5169
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005170#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005171static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5172{
5173 double dResult;
5174
5175 dResult = 0.0;
5176 const uint8_t *pByte = BigNum.ptr;
5177 size_t uLen = BigNum.len;
5178 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005179 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005180 while(uLen--) {
5181 dResult = (dResult * 256.0) + (double)*pByte++;
5182 }
5183
5184 return dResult;
5185}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005186#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5187
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005188
Laurence Lundblade93d89472020-10-03 22:30:50 -07005189static QCBORError
5190DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005191{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005192#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005193 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005194 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5195
5196 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005197 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005198
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005199#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005200 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005201 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005202 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005203 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5204 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5205 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005206 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005207 }
5208 break;
5209
5210 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005211 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005212 // Underflow gives 0, overflow gives infinity
5213 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5214 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005215 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005216 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005217 }
5218 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005219#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005220
5221 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005222 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005223 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5224 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005225 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005226 }
5227 break;
5228
5229 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005230 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005231 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005232 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005233 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005234 }
5235 break;
5236
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005237#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005238 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005239 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005240 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5241 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5242 } 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
5247 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005248 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005249 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5250 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5251 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005252 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005253 }
5254 break;
5255
5256 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005257 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005258 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5259 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5260 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005261 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005262 }
5263 break;
5264
5265 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005266 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005267 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005268 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5269 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005270 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005271 }
5272 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005273#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005274
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005275 default:
5276 return QCBOR_ERR_UNEXPECTED_TYPE;
5277 }
5278
5279 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005280
5281#else
5282 (void)pItem;
5283 (void)uConvertTypes;
5284 (void)pdValue;
5285 return QCBOR_ERR_HW_FLOAT_DISABLED;
5286#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5287
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005288}
5289
5290
5291/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005292 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005293*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005294void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5295 uint32_t uConvertTypes,
5296 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005297{
5298
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005299 QCBORItem Item;
5300
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005301 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005302
5303 if(pMe->uLastError == QCBOR_SUCCESS) {
5304 // The above conversion succeeded
5305 return;
5306 }
5307
5308 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5309 // The above conversion failed in a way that code below can't correct
5310 return;
5311 }
5312
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005313 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005314}
5315
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005316
5317/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005318 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005319*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005320void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5321 int64_t nLabel,
5322 uint32_t uConvertTypes,
5323 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005324{
5325 QCBORItem Item;
5326
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005327 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005328
5329 if(pMe->uLastError == QCBOR_SUCCESS) {
5330 // The above conversion succeeded
5331 return;
5332 }
5333
5334 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5335 // The above conversion failed in a way that code below can't correct
5336 return;
5337 }
5338
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005339 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005340}
5341
5342
5343/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005344 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005345*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005346void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5347 const char *szLabel,
5348 uint32_t uConvertTypes,
5349 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005350{
5351 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005352 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005353
5354 if(pMe->uLastError == QCBOR_SUCCESS) {
5355 // The above conversion succeeded
5356 return;
5357 }
5358
5359 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5360 // The above conversion failed in a way that code below can't correct
5361 return;
5362 }
5363
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005364 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005365}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005366
5367
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005368
5369
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005370#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005371static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5372{
5373 while((uInt & 0xff00000000000000UL) == 0) {
5374 uInt = uInt << 8;
5375 };
5376
5377 UsefulOutBuf UOB;
5378
5379 UsefulOutBuf_Init(&UOB, Buffer);
5380
5381 while(uInt) {
5382 const uint64_t xx = uInt & 0xff00000000000000UL;
5383 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5384 uInt = uInt << 8;
5385 (void)xx;
5386 }
5387
5388 return UsefulOutBuf_OutUBuf(&UOB);
5389}
5390
5391
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005392static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5393 TagSpecification TagSpec,
5394 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005395{
5396 QCBORError uErr;
5397 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005398 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005399 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005400 if(uErr != QCBOR_SUCCESS) {
5401 goto Done;
5402 }
5403
5404 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5405 break; // Successful exit. Moving on to finish decoding.
5406 }
5407
5408 // The item is an array, which means an undecoded
5409 // mantissa and exponent, so decode it. It will then
5410 // have a different type and exit the loop if.
5411 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5412 if(uErr != QCBOR_SUCCESS) {
5413 goto Done;
5414 }
5415
5416 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005417 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005418 }
5419Done:
5420 return uErr;
5421}
5422
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005423
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005424static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005425 TagSpecification TagSpec,
5426 QCBORItem *pItem,
5427 int64_t *pnMantissa,
5428 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005429{
5430 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005431
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005432 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005433 if(uErr != QCBOR_SUCCESS) {
5434 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005435 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005436
Laurence Lundblade9b334962020-08-27 10:55:53 -07005437 switch (pItem->uDataType) {
5438
5439 case QCBOR_TYPE_DECIMAL_FRACTION:
5440 case QCBOR_TYPE_BIGFLOAT:
5441 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5442 *pnExponent = pItem->val.expAndMantissa.nExponent;
5443 break;
5444
5445 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5446 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5447 *pnExponent = pItem->val.expAndMantissa.nExponent;
5448 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5449 break;
5450
5451 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5452 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5453 *pnExponent = pItem->val.expAndMantissa.nExponent;
5454 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5455 break;
5456
5457 default:
5458 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5459 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005460
5461 Done:
5462 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005463}
5464
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005465
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005466static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005467 TagSpecification TagSpec,
5468 QCBORItem *pItem,
5469 UsefulBuf BufferForMantissa,
5470 UsefulBufC *pMantissa,
5471 bool *pbIsNegative,
5472 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005473{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005474 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005475
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005476 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005477 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005478 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005479 }
5480
5481 uint64_t uMantissa;
5482
5483 switch (pItem->uDataType) {
5484
5485 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005486 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005487 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5488 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5489 *pbIsNegative = false;
5490 } else {
5491 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5492 *pbIsNegative = true;
5493 }
5494 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5495 *pnExponent = pItem->val.expAndMantissa.nExponent;
5496 break;
5497
5498 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005499 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005500 *pnExponent = pItem->val.expAndMantissa.nExponent;
5501 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5502 *pbIsNegative = false;
5503 break;
5504
5505 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005506 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005507 *pnExponent = pItem->val.expAndMantissa.nExponent;
5508 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5509 *pbIsNegative = true;
5510 break;
5511
5512 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005513 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005514 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005515
5516Done:
5517 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005518}
5519
5520
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005521/*
5522 Public function, see header qcbor/qcbor_decode.h file
5523*/
5524void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5525 uint8_t uTagRequirement,
5526 int64_t *pnMantissa,
5527 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005528{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005529 if(pMe->uLastError != QCBOR_SUCCESS) {
5530 return;
5531 }
5532
5533 QCBORItem Item;
5534 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5535 if(uError) {
5536 pMe->uLastError = (uint8_t)uError;
5537 return;
5538 }
5539
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005540 const TagSpecification TagSpec =
5541 {
5542 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005543 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5544 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5545 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005546 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005547
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005548 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005549}
5550
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005551
5552/*
5553 Public function, see header qcbor/qcbor_decode.h file
5554*/
5555void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005556 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005557 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005558 int64_t *pnMantissa,
5559 int64_t *pnExponent)
5560{
5561 if(pMe->uLastError != QCBOR_SUCCESS) {
5562 return;
5563 }
5564
5565 QCBORItem Item;
5566 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5567
5568 const TagSpecification TagSpec =
5569 {
5570 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005571 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5572 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5573 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005574 };
5575
5576 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5577}
5578
5579
5580/*
5581 Public function, see header qcbor/qcbor_decode.h file
5582*/
5583void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005584 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005585 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005586 int64_t *pnMantissa,
5587 int64_t *pnExponent)
5588{
5589 if(pMe->uLastError != QCBOR_SUCCESS) {
5590 return;
5591 }
5592
5593 QCBORItem Item;
5594 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5595
5596 const TagSpecification TagSpec =
5597 {
5598 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005599 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5600 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5601 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005602 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005603
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005604 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5605}
5606
5607
5608/*
5609 Public function, see header qcbor/qcbor_decode.h file
5610*/
5611void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5612 uint8_t uTagRequirement,
5613 UsefulBuf MantissaBuffer,
5614 UsefulBufC *pMantissa,
5615 bool *pbMantissaIsNegative,
5616 int64_t *pnExponent)
5617{
5618 if(pMe->uLastError != QCBOR_SUCCESS) {
5619 return;
5620 }
5621
5622 QCBORItem Item;
5623 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5624 if(uError) {
5625 pMe->uLastError = (uint8_t)uError;
5626 return;
5627 }
5628
5629 const TagSpecification TagSpec =
5630 {
5631 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005632 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5633 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5634 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005635 };
5636
Laurence Lundblade93d89472020-10-03 22:30:50 -07005637 ProcessMantissaAndExponentBig(pMe,
5638 TagSpec,
5639 &Item,
5640 MantissaBuffer,
5641 pMantissa,
5642 pbMantissaIsNegative,
5643 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005644}
5645
5646
5647/*
5648 Public function, see header qcbor/qcbor_decode.h file
5649*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005650void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005651 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005652 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005653 UsefulBuf BufferForMantissa,
5654 UsefulBufC *pMantissa,
5655 bool *pbIsNegative,
5656 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005657{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005658 if(pMe->uLastError != QCBOR_SUCCESS) {
5659 return;
5660 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005661
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005662 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005663 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005664 if(pMe->uLastError != QCBOR_SUCCESS) {
5665 return;
5666 }
5667
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005668 const TagSpecification TagSpec =
5669 {
5670 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005671 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5672 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5673 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005674 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005675
Laurence Lundblade93d89472020-10-03 22:30:50 -07005676 ProcessMantissaAndExponentBig(pMe,
5677 TagSpec,
5678 &Item,
5679 BufferForMantissa,
5680 pMantissa,
5681 pbIsNegative,
5682 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005683}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005684
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005685
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005686/*
5687 Public function, see header qcbor/qcbor_decode.h file
5688*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005689void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005690 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005691 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005692 UsefulBuf BufferForMantissa,
5693 UsefulBufC *pMantissa,
5694 bool *pbIsNegative,
5695 int64_t *pnExponent)
5696{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005697 if(pMe->uLastError != QCBOR_SUCCESS) {
5698 return;
5699 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005700
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005701 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005702 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5703 if(pMe->uLastError != QCBOR_SUCCESS) {
5704 return;
5705 }
5706
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005707 const TagSpecification TagSpec =
5708 {
5709 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005710 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5711 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5712 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005713 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005714
5715 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5716}
5717
5718
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005719/*
5720 Public function, see header qcbor/qcbor_decode.h file
5721*/
5722void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5723 uint8_t uTagRequirement,
5724 int64_t *pnMantissa,
5725 int64_t *pnExponent)
5726{
5727 if(pMe->uLastError != QCBOR_SUCCESS) {
5728 return;
5729 }
5730
5731 QCBORItem Item;
5732 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5733 if(uError) {
5734 pMe->uLastError = (uint8_t)uError;
5735 return;
5736 }
5737 const TagSpecification TagSpec =
5738 {
5739 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005740 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5741 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5742 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005743 };
5744
5745 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5746}
5747
5748
5749/*
5750 Public function, see header qcbor/qcbor_decode.h file
5751*/
5752void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005753 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005754 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005755 int64_t *pnMantissa,
5756 int64_t *pnExponent)
5757{
5758 if(pMe->uLastError != QCBOR_SUCCESS) {
5759 return;
5760 }
5761
5762 QCBORItem Item;
5763 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5764 if(pMe->uLastError != QCBOR_SUCCESS) {
5765 return;
5766 }
5767
5768 const TagSpecification TagSpec =
5769 {
5770 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005771 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5772 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5773 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005774 };
5775
5776 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5777}
5778
5779
5780/*
5781 Public function, see header qcbor/qcbor_decode.h file
5782*/
5783void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005784 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005785 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005786 int64_t *pnMantissa,
5787 int64_t *pnExponent)
5788{
5789 if(pMe->uLastError != QCBOR_SUCCESS) {
5790 return;
5791 }
5792
5793 QCBORItem Item;
5794 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5795 if(pMe->uLastError != QCBOR_SUCCESS) {
5796 return;
5797 }
5798
5799 const TagSpecification TagSpec =
5800 {
5801 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005802 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5803 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5804 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005805 };
5806
5807 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5808}
5809
5810
5811/*
5812 Public function, see header qcbor/qcbor_decode.h file
5813*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005814void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5815 uint8_t uTagRequirement,
5816 UsefulBuf MantissaBuffer,
5817 UsefulBufC *pMantissa,
5818 bool *pbMantissaIsNegative,
5819 int64_t *pnExponent)
5820{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005821 if(pMe->uLastError != QCBOR_SUCCESS) {
5822 return;
5823 }
5824
5825 QCBORItem Item;
5826 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5827 if(uError) {
5828 pMe->uLastError = (uint8_t)uError;
5829 return;
5830 }
5831
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005832 const TagSpecification TagSpec =
5833 {
5834 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005835 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5836 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5837 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005838 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005839
5840 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005841}
5842
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005843
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005844/*
5845 Public function, see header qcbor/qcbor_decode.h file
5846*/
5847void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005848 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005849 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005850 UsefulBuf BufferForMantissa,
5851 UsefulBufC *pMantissa,
5852 bool *pbIsNegative,
5853 int64_t *pnExponent)
5854{
5855 if(pMe->uLastError != QCBOR_SUCCESS) {
5856 return;
5857 }
5858
5859 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005860 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5861 if(pMe->uLastError != QCBOR_SUCCESS) {
5862 return;
5863 }
5864
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005865 const TagSpecification TagSpec =
5866 {
5867 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005868 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5869 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5870 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005871 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005872
Laurence Lundblade93d89472020-10-03 22:30:50 -07005873 ProcessMantissaAndExponentBig(pMe,
5874 TagSpec,
5875 &Item,
5876 BufferForMantissa,
5877 pMantissa,
5878 pbIsNegative,
5879 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005880}
5881
5882
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005883/*
5884 Public function, see header qcbor/qcbor_decode.h file
5885*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005886void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005887 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005888 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005889 UsefulBuf BufferForMantissa,
5890 UsefulBufC *pMantissa,
5891 bool *pbIsNegative,
5892 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005893{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005894 if(pMe->uLastError != QCBOR_SUCCESS) {
5895 return;
5896 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005897
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005898 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005899 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5900 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005901 return;
5902 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005903
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005904 const TagSpecification TagSpec =
5905 {
5906 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005907 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5908 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5909 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005910 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005911
Laurence Lundblade93d89472020-10-03 22:30:50 -07005912 ProcessMantissaAndExponentBig(pMe,
5913 TagSpec,
5914 &Item,
5915 BufferForMantissa,
5916 pMantissa,
5917 pbIsNegative,
5918 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005919}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005920
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005921#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */