blob: dcc955b50cda5054e185759fe52fae9af9e6e219 [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 Lundblade58541fe2021-05-07 01:24:49 -07001990/** TODO: fix this documentation
1991 * @brief Convert different epoch date formats in to the QCBOR epoch date format
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 * The epoch date tag defined in QCBOR allows for floating-point
2000 * dates. It even allows a protocol to flop between date formats when
2001 * ever it wants. Floating-point dates aren't that useful as they are
2002 * only needed for dates beyond the age of the earth.
2003 *
2004 * This converts all the date formats into one format of an unsigned
2005 * integer plus a floating-point fraction.
2006 */
2007static QCBORError DecodeDaysEpoch(QCBORItem *pDecodedItem)
2008{
2009 QCBORError uReturn = QCBOR_SUCCESS;
2010
2011 switch (pDecodedItem->uDataType) {
2012
2013 case QCBOR_TYPE_INT64:
2014 pDecodedItem->val.epochDays = pDecodedItem->val.int64;
2015 break;
2016
2017 case QCBOR_TYPE_UINT64:
2018 /* This only happens for CBOR type 0 > INT64_MAX so it is
2019 * always an overflow.
2020 */
2021 uReturn = QCBOR_ERR_DATE_OVERFLOW;
2022 goto Done;
2023 break;
2024
2025 default:
2026 uReturn = QCBOR_ERR_BAD_TAG_CONTENT;
2027 goto Done;
2028 }
2029
2030 pDecodedItem->uDataType = QCBOR_TYPE_DAYS_EPOCH;
2031
2032Done:
2033 return uReturn;
2034}
2035
2036
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002037#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002038/**
2039 * @brief Decode decimal fractions and big floats.
2040 *
2041 * @param[in] pMe The decode context.
2042 * @param[in,out] pDecodedItem On input the array data item that
2043 * holds the mantissa and exponent. On
2044 * output the decoded mantissa and
2045 * exponent.
2046 *
2047 * @returns Decoding errors from getting primitive data items or
2048 * \ref QCBOR_ERR_BAD_EXP_AND_MANTISSA.
2049 *
2050 * When called pDecodedItem must be the array that is tagged as a big
2051 * float or decimal fraction, the array that has the two members, the
2052 * exponent and mantissa.
2053 *
2054 * This will fetch and decode the exponent and mantissa and put the
2055 * result back into pDecodedItem.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002056 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002057static inline QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002058QCBORDecode_MantissaAndExponent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002059{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002060 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002061
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002062 /* --- Make sure it is an array; track nesting level of members --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002063 if(pDecodedItem->uDataType != QCBOR_TYPE_ARRAY) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002064 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002065 goto Done;
2066 }
2067
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002068 /* A check for pDecodedItem->val.uCount == 2 would work for
2069 * definite-length arrays, but not for indefnite. Instead remember
2070 * the nesting level the two integers must be at, which is one
2071 * deeper than that of the array.
2072 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002073 const int nNestLevel = pDecodedItem->uNestingLevel + 1;
2074
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002075 /* --- Which is it, decimal fraction or a bigfloat? --- */
2076 const bool bIsTaggedDecimalFraction = QCBORDecode_IsTagged(pMe, pDecodedItem, CBOR_TAG_DECIMAL_FRACTION);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002077 pDecodedItem->uDataType = bIsTaggedDecimalFraction ? QCBOR_TYPE_DECIMAL_FRACTION : QCBOR_TYPE_BIGFLOAT;
2078
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002079 /* --- Get the exponent --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002080 QCBORItem exponentItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002081 uReturn = QCBORDecode_GetNextMapOrArray(pMe, &exponentItem);
2082 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002083 goto Done;
2084 }
2085 if(exponentItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002086 /* Array is empty or a map/array encountered when expecting an int */
2087 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002088 goto Done;
2089 }
2090 if(exponentItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002091 /* Data arriving as an unsigned int < INT64_MAX has been
2092 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2093 * also means that the only data arriving here of type
2094 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2095 * and thus an error that will get handled in the next else.
2096 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002097 pDecodedItem->val.expAndMantissa.nExponent = exponentItem.val.int64;
2098 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002099 /* Wrong type of exponent or a QCBOR_TYPE_UINT64 > INT64_MAX */
2100 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002101 goto Done;
2102 }
2103
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002104 /* --- Get the mantissa --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002105 QCBORItem mantissaItem;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002106 uReturn = QCBORDecode_GetNextWithTags(pMe, &mantissaItem, NULL);
2107 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002108 goto Done;
2109 }
2110 if(mantissaItem.uNestingLevel != nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002111 /* Mantissa missing or map/array encountered when expecting number */
2112 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002113 goto Done;
2114 }
2115 if(mantissaItem.uDataType == QCBOR_TYPE_INT64) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002116 /* Data arriving as an unsigned int < INT64_MAX has been
2117 * converted to QCBOR_TYPE_INT64 and thus handled here. This is
2118 * also means that the only data arriving here of type
2119 * QCBOR_TYPE_UINT64 data will be too large for this to handle
2120 * and thus an error that will get handled in an else below.
2121 */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002122 pDecodedItem->val.expAndMantissa.Mantissa.nInt = mantissaItem.val.int64;
Laurence Lundblade93d89472020-10-03 22:30:50 -07002123 } else if(mantissaItem.uDataType == QCBOR_TYPE_POSBIGNUM ||
2124 mantissaItem.uDataType == QCBOR_TYPE_NEGBIGNUM) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002125 /* Got a good big num mantissa */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002126 pDecodedItem->val.expAndMantissa.Mantissa.bigNum = mantissaItem.val.bigNum;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002127 /* Depends on numbering of QCBOR_TYPE_XXX */
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002128 pDecodedItem->uDataType = (uint8_t)(pDecodedItem->uDataType +
2129 mantissaItem.uDataType - QCBOR_TYPE_POSBIGNUM +
2130 1);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002131 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002132 /* Wrong type of mantissa or a QCBOR_TYPE_UINT64 > INT64_MAX */
2133 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002134 goto Done;
2135 }
2136
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002137 /* --- Check that array only has the two numbers --- */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002138 if(mantissaItem.uNextNestLevel == nNestLevel) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002139 /* Extra items in the decimal fraction / big float */
2140 uReturn = QCBOR_ERR_BAD_EXP_AND_MANTISSA;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002141 goto Done;
2142 }
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002143 pDecodedItem->uNextNestLevel = mantissaItem.uNextNestLevel;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002144
2145Done:
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002146 return uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002147}
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002148#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002149
2150
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002151#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002152/**
2153 * @brief Decode the MIME type tag
2154 *
2155 * @param[in,out] pDecodedItem The item to decode.
2156 *
2157 * Handle the text and binary MIME type tags. Slightly too complicated
2158 * f or ProcessTaggedString() because the RFC 7049 MIME type was
2159 * incorreclty text-only.
2160 */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002161static inline QCBORError DecodeMIME(QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002162{
2163 if(pDecodedItem->uDataType == QCBOR_TYPE_TEXT_STRING) {
2164 pDecodedItem->uDataType = QCBOR_TYPE_MIME;
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07002165 } else if(pDecodedItem->uDataType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002166 pDecodedItem->uDataType = QCBOR_TYPE_BINARY_MIME;
2167 } else {
2168 return QCBOR_ERR_BAD_OPT_TAG;
2169 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002170
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002171 return QCBOR_SUCCESS;
2172}
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002173#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002174
2175
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002176/**
Laurence Lundblade99615302020-11-29 11:19:47 -08002177 * Table of CBOR tags whose content is either a text string or a byte
2178 * string. The table maps the CBOR tag to the QCBOR type. The high-bit
2179 * of uQCBORtype indicates the content should be a byte string rather
2180 * than a text string
2181 */
2182struct StringTagMapEntry {
2183 uint16_t uTagNumber;
2184 uint8_t uQCBORtype;
2185};
2186
2187#define IS_BYTE_STRING_BIT 0x80
2188#define QCBOR_TYPE_MASK ~IS_BYTE_STRING_BIT
2189
2190static const struct StringTagMapEntry StringTagMap[] = {
2191 {CBOR_TAG_DATE_STRING, QCBOR_TYPE_DATE_STRING},
Laurence Lundblade58541fe2021-05-07 01:24:49 -07002192 {CBOR_TAG_DAYS_STRING, QCBOR_TYPE_DAYS_STRING},
2193
Laurence Lundblade99615302020-11-29 11:19:47 -08002194 {CBOR_TAG_POS_BIGNUM, QCBOR_TYPE_POSBIGNUM | IS_BYTE_STRING_BIT},
2195 {CBOR_TAG_NEG_BIGNUM, QCBOR_TYPE_NEGBIGNUM | IS_BYTE_STRING_BIT},
2196 {CBOR_TAG_CBOR, QBCOR_TYPE_WRAPPED_CBOR | IS_BYTE_STRING_BIT},
2197 {CBOR_TAG_URI, QCBOR_TYPE_URI},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002198#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002199 {CBOR_TAG_B64URL, QCBOR_TYPE_BASE64URL},
2200 {CBOR_TAG_B64, QCBOR_TYPE_BASE64},
2201 {CBOR_TAG_REGEX, QCBOR_TYPE_REGEX},
2202 {CBOR_TAG_BIN_UUID, QCBOR_TYPE_UUID | IS_BYTE_STRING_BIT},
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002203#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade99615302020-11-29 11:19:47 -08002204 {CBOR_TAG_CBOR_SEQUENCE, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE | IS_BYTE_STRING_BIT},
2205 {CBOR_TAG_INVALID16, QCBOR_TYPE_NONE}
2206};
2207
2208
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002209/**
2210 * @brief Process standard CBOR tags whose content is a string
2211 *
2212 * @param[in] uTag The tag.
2213 * @param[in,out] pDecodedItem The data item.
2214 *
2215 * @returns This returns QCBOR_SUCCESS if the tag was procssed,
2216 * \ref QCBOR_ERR_UNSUPPORTED if the tag was not processed and
2217 * \ref QCBOR_ERR_BAD_OPT_TAG if the content type was wrong for the tag.
2218 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002219 * Process the CBOR tags that whose content is a byte string or a text
2220 * string and for which the string is just passed on to the caller.
2221 *
2222 * This maps the CBOR tag to the QCBOR type and checks the content
2223 * type. Nothing more. It may not be the most important
Laurence Lundbladec02e13e2020-12-06 05:45:41 -08002224 * functionality, but it part of implementing as much of RFC 8949 as
Laurence Lundblade99615302020-11-29 11:19:47 -08002225 * possible.
Laurence Lundblade99615302020-11-29 11:19:47 -08002226 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002227static inline QCBORError
2228ProcessTaggedString(uint16_t uTag, QCBORItem *pDecodedItem)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002229{
Laurence Lundblade99615302020-11-29 11:19:47 -08002230 /* This only works on tags that were not mapped; no need for other yet */
2231 if(uTag > QCBOR_LAST_UNMAPPED_TAG) {
2232 return QCBOR_ERR_UNSUPPORTED;
2233 }
2234
2235 unsigned uIndex;
2236 for(uIndex = 0; StringTagMap[uIndex].uTagNumber != CBOR_TAG_INVALID16; uIndex++) {
2237 if(StringTagMap[uIndex].uTagNumber == uTag) {
2238 break;
2239 }
2240 }
2241
2242 const uint8_t uQCBORType = StringTagMap[uIndex].uQCBORtype;
2243 if(uQCBORType == QCBOR_TYPE_NONE) {
2244 /* repurpose this error to mean, not handled here */
2245 return QCBOR_ERR_UNSUPPORTED;
2246 }
2247
2248 uint8_t uExpectedType = QCBOR_TYPE_TEXT_STRING;
2249 if(uQCBORType & IS_BYTE_STRING_BIT) {
2250 uExpectedType = QCBOR_TYPE_BYTE_STRING;
2251 }
2252
2253 if(pDecodedItem->uDataType != uExpectedType) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002254 return QCBOR_ERR_BAD_OPT_TAG;
2255 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002256
Laurence Lundblade99615302020-11-29 11:19:47 -08002257 pDecodedItem->uDataType = (uint8_t)(uQCBORType & QCBOR_TYPE_MASK);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002258 return QCBOR_SUCCESS;
2259}
2260
2261
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002262/**
2263 * @brief Decode tag content for select tags (decoding layer 1).
2264 *
2265 * @param[in] pMe The decode context.
2266 * @param[out] pDecodedItem The decoded item.
2267 *
2268 * @return Decoding error code.
2269 *
Laurence Lundblade99615302020-11-29 11:19:47 -08002270 * CBOR tag numbers for the item were decoded in GetNext_TaggedItem(),
2271 * but the whole tag was not decoded. Here, the whole tags (tag number
2272 * and tag content) that are supported by QCBOR are decoded. This is a
2273 * quick pass through for items that are not tags.
Laurence Lundblade59289e52019-12-30 13:44:37 -08002274 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002275static QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002276QCBORDecode_GetNextTagContent(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
Laurence Lundblade59289e52019-12-30 13:44:37 -08002277{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002278 QCBORError uReturn;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002279
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002280 uReturn = QCBORDecode_GetNextMapOrArray(pMe, pDecodedItem);
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002281 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002282 goto Done;
2283 }
2284
Laurence Lundblade99615302020-11-29 11:19:47 -08002285 /* When there are no tag numbers for the item, this exits first
2286 * thing and effectively does nothing.
2287 *
2288 * This loops over all the tag numbers accumulated for this item
2289 * trying to decode and interpret them. This stops at the end of
2290 * the list or at the first tag number that can't be interpreted by
2291 * this code. This is effectively a recursive processing of the
2292 * tags number list that handles nested tags.
2293 */
2294 while(1) {
2295 /* Don't bother to unmap tags via QCBORITem.uTags since this
2296 * code only works on tags less than QCBOR_LAST_UNMAPPED_TAG.
2297 */
2298 const uint16_t uTagToProcess = pDecodedItem->uTags[0];
Laurence Lundblade59289e52019-12-30 13:44:37 -08002299
Laurence Lundblade99615302020-11-29 11:19:47 -08002300 if(uTagToProcess == CBOR_TAG_INVALID16) {
2301 /* Hit the end of the tag list. A successful exit. */
Laurence Lundblade59289e52019-12-30 13:44:37 -08002302 break;
2303
Laurence Lundblade99615302020-11-29 11:19:47 -08002304 } else if(uTagToProcess == CBOR_TAG_DATE_EPOCH) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002305 uReturn = DecodeDateEpoch(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002306
Laurence Lundblade58541fe2021-05-07 01:24:49 -07002307 } else if(uTagToProcess == CBOR_TAG_DAYS_EPOCH) {
2308 uReturn = DecodeDaysEpoch(pDecodedItem);
2309
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002310#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade99615302020-11-29 11:19:47 -08002311 } else if(uTagToProcess == CBOR_TAG_DECIMAL_FRACTION ||
2312 uTagToProcess == CBOR_TAG_BIGFLOAT) {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002313 uReturn = QCBORDecode_MantissaAndExponent(pMe, pDecodedItem);
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07002314#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002315#ifndef QCBOR_DISABLE_UNCOMMON_TAGS
Laurence Lundblade99615302020-11-29 11:19:47 -08002316 } else if(uTagToProcess == CBOR_TAG_MIME ||
2317 uTagToProcess == CBOR_TAG_BINARY_MIME) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002318 uReturn = DecodeMIME(pDecodedItem);
Laurence Lundblade24bd7e12021-01-09 00:05:11 -08002319#endif /* QCBOR_DISABLE_UNCOMMON_TAGS */
Laurence Lundblade91853ae2020-06-15 19:35:58 -07002320
Laurence Lundblade99615302020-11-29 11:19:47 -08002321 } else {
2322 /* See if it is a pass-through byte/text string tag; process if so */
2323 uReturn = ProcessTaggedString(pDecodedItem->uTags[0], pDecodedItem);
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002324
Laurence Lundblade99615302020-11-29 11:19:47 -08002325 if(uReturn == QCBOR_ERR_UNSUPPORTED) {
2326 /* It wasn't a pass-through byte/text string tag so it is
2327 * an unknown tag. This is the exit from the loop on the
2328 * first unknown tag. It is a successful exit.
2329 */
2330 uReturn = QCBOR_SUCCESS;
2331 break;
2332 }
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002333 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002334
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002335 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade99615302020-11-29 11:19:47 -08002336 /* Error exit from the loop */
2337 break;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002338 }
Laurence Lundblade99615302020-11-29 11:19:47 -08002339
2340 /* A tag was successfully processed, shift it out of the list of
2341 * tags returned. This is the loop increment.
2342 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002343 ShiftTags(pDecodedItem);
Laurence Lundblade59289e52019-12-30 13:44:37 -08002344 }
2345
2346Done:
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002347 return uReturn;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002348}
2349
2350
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002351/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002352 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002353 */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002354QCBORError
2355QCBORDecode_GetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2356{
2357 QCBORError uErr;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002358 uErr = QCBORDecode_GetNextTagContent(pMe, pDecodedItem);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002359 if(uErr != QCBOR_SUCCESS) {
Laurence Lundblade59289e52019-12-30 13:44:37 -08002360 pDecodedItem->uDataType = QCBOR_TYPE_NONE;
2361 pDecodedItem->uLabelType = QCBOR_TYPE_NONE;
2362 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002363 return uErr;
Laurence Lundblade59289e52019-12-30 13:44:37 -08002364}
2365
2366
2367/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002368 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade59289e52019-12-30 13:44:37 -08002369 */
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002370QCBORError
2371QCBORDecode_PeekNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2372{
2373 const QCBORDecodeNesting SaveNesting = pMe->nesting;
2374 const UsefulInputBuf Save = pMe->InBuf;
2375
2376 QCBORError uErr = QCBORDecode_GetNext(pMe, pDecodedItem);
2377
2378 pMe->nesting = SaveNesting;
2379 pMe->InBuf = Save;
2380
2381 return uErr;
2382}
2383
2384
2385/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002386 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade2a26abb2020-11-05 19:06:54 -08002387 */
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002388void QCBORDecode_VGetNext(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2389{
2390 if(pMe->uLastError != QCBOR_SUCCESS) {
2391 return;
2392 }
2393
2394 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, pDecodedItem);
2395}
2396
2397
2398/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002399 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07002400 */
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002401QCBORError
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002402QCBORDecode_GetNextWithTags(QCBORDecodeContext *pMe,
2403 QCBORItem *pDecodedItem,
2404 QCBORTagListOut *pTags)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002405{
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002406 QCBORError uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002407
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002408 uReturn = QCBORDecode_GetNext(pMe, pDecodedItem);
2409 if(uReturn != QCBOR_SUCCESS) {
2410 return uReturn;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002411 }
2412
2413 if(pTags != NULL) {
2414 pTags->uNumUsed = 0;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002415 /* Reverse the order because pTags is reverse of QCBORItem.uTags. */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002416 for(int nTagIndex = QCBOR_MAX_TAGS_PER_ITEM-1; nTagIndex >=0; nTagIndex--) {
2417 if(pDecodedItem->uTags[nTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade9b334962020-08-27 10:55:53 -07002418 continue;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002419 }
2420 if(pTags->uNumUsed >= pTags->uNumAllocated) {
2421 return QCBOR_ERR_TOO_MANY_TAGS;
2422 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002423 pTags->puTags[pTags->uNumUsed] = UnMapTagNumber(pMe,pDecodedItem->uTags[nTagIndex]);
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002424 pTags->uNumUsed++;
2425 }
2426 }
2427
2428 return QCBOR_SUCCESS;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002429}
2430
2431
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002432/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002433 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade0fb2f642018-10-11 19:33:35 +05302434 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002435bool QCBORDecode_IsTagged(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002436 const QCBORItem *pItem,
2437 uint64_t uTag)
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002438{
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002439 for(unsigned uTagIndex = 0; uTagIndex < QCBOR_MAX_TAGS_PER_ITEM; uTagIndex++) {
2440 if(pItem->uTags[uTagIndex] == CBOR_TAG_INVALID16) {
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002441 break;
2442 }
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002443 if(UnMapTagNumber(pMe, pItem->uTags[uTagIndex]) == uTag) {
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002444 return true;
Laurence Lundblade830fbf92020-05-31 17:22:33 -07002445 }
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002446 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002447
Laurence Lundbladef71e1622020-08-06 18:52:13 -07002448 return false;
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002449}
2450
2451
2452/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002453 * Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladedbe6f212018-10-28 11:37:53 +07002454 */
Laurence Lundblade87495732021-02-26 10:05:55 -07002455QCBORError QCBORDecode_PartialFinish(QCBORDecodeContext *pMe, size_t *puConsumed)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002456{
Laurence Lundblade87495732021-02-26 10:05:55 -07002457 if(puConsumed != NULL) {
2458 *puConsumed = pMe->InBuf.cursor;
2459 }
2460
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002461 QCBORError uReturn = pMe->uLastError;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002462
2463 if(uReturn != QCBOR_SUCCESS) {
2464 goto Done;
2465 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002466
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002467 /* Error out if all the maps/arrays are not closed out */
2468 if(!DecodeNesting_IsCurrentAtTop(&(pMe->nesting))) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002469 uReturn = QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002470 goto Done;
2471 }
2472
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002473 /* Error out if not all the bytes are consumed */
2474 if(UsefulInputBuf_BytesUnconsumed(&(pMe->InBuf))) {
Laurence Lundblade085d7952020-07-24 10:26:30 -07002475 uReturn = QCBOR_ERR_EXTRA_BYTES;
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002476 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002477
Laurence Lundblade20b533d2018-10-08 20:44:53 +08002478Done:
Laurence Lundblade87495732021-02-26 10:05:55 -07002479 return uReturn;
2480}
2481
2482
2483/*
2484 * Public function, see header qcbor/qcbor_decode.h file
2485 */
2486QCBORError QCBORDecode_Finish(QCBORDecodeContext *pMe)
2487{
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002488#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002489 /* Call the destructor for the string allocator if there is one.
2490 * Always called, even if there are errors; always have to clean up.
2491 */
2492 StringAllocator_Destruct(&(pMe->StringAllocator));
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002493#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002494
Laurence Lundblade87495732021-02-26 10:05:55 -07002495 return QCBORDecode_PartialFinish(pMe, NULL);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002496}
2497
2498
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002499/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002500 * Public function, see header qcbor/qcbor_decode.h file
2501 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002502// Improvement: make these inline?
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002503uint64_t QCBORDecode_GetNthTag(QCBORDecodeContext *pMe,
2504 const QCBORItem *pItem,
Laurence Lundblade9b334962020-08-27 10:55:53 -07002505 uint32_t uIndex)
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002506{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002507 if(pItem->uDataType == QCBOR_TYPE_NONE) {
2508 return CBOR_TAG_INVALID64;
2509 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002510 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2511 return CBOR_TAG_INVALID64;
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002512 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002513 return UnMapTagNumber(pMe, pItem->uTags[uIndex]);
Laurence Lundbladec75e68b2020-06-15 20:34:46 -07002514 }
2515}
2516
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002517
Laurence Lundblade9b334962020-08-27 10:55:53 -07002518/*
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002519 * Public function, see header qcbor/qcbor_decode.h file
2520 */
Laurence Lundblade9b334962020-08-27 10:55:53 -07002521uint64_t QCBORDecode_GetNthTagOfLast(const QCBORDecodeContext *pMe,
2522 uint32_t uIndex)
2523{
Laurence Lundblade88e9db22020-11-02 03:56:33 -08002524 if(pMe->uLastError != QCBOR_SUCCESS) {
2525 return CBOR_TAG_INVALID64;
2526 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002527 if(uIndex >= QCBOR_MAX_TAGS_PER_ITEM) {
2528 return CBOR_TAG_INVALID64;
2529 } else {
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002530 return UnMapTagNumber(pMe, pMe->uLastTags[uIndex]);
Laurence Lundblade9b334962020-08-27 10:55:53 -07002531 }
2532}
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002533
Laurence Lundbladeb69cad72018-09-13 11:09:01 -07002534
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002535
2536
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002537#ifndef QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS
Laurence Lundbladef6531662018-12-04 10:42:22 +09002538
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002539/* ===========================================================================
2540 MemPool -- BUILT-IN SIMPLE STRING ALLOCATOR
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002541
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002542 This implements a simple sting allocator for indefinite-length
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002543 strings that can be enabled by calling QCBORDecode_SetMemPool(). It
2544 implements the function type QCBORStringAllocate and allows easy
2545 use of it.
Laurence Lundbladef6531662018-12-04 10:42:22 +09002546
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002547 This particular allocator is built-in for convenience. The caller
2548 can implement their own. All of this following code will get
2549 dead-stripped if QCBORDecode_SetMemPool() is not called.
2550
2551 This is a very primitive memory allocator. It does not track
2552 individual allocations, only a high-water mark. A free or
2553 reallocation must be of the last chunk allocated.
2554
2555 The size of the pool and offset to free memory are packed into the
2556 first 8 bytes of the memory pool so we don't have to keep them in
2557 the decode context. Since the address of the pool may not be
2558 aligned, they have to be packed and unpacked as if they were
2559 serialized data of the wire or such.
2560
2561 The sizes packed in are uint32_t to be the same on all CPU types
2562 and simplify the code.
Laurence Lundbladeee851742020-01-08 08:37:05 -08002563 ========================================================================== */
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002564
2565
Laurence Lundbladeee851742020-01-08 08:37:05 -08002566static inline int
2567MemPool_Unpack(const void *pMem, uint32_t *puPoolSize, uint32_t *puFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002568{
2569 // Use of UsefulInputBuf is overkill, but it is convenient.
2570 UsefulInputBuf UIB;
2571
Laurence Lundbladeee851742020-01-08 08:37:05 -08002572 // Just assume the size here. It was checked during SetUp so
2573 // the assumption is safe.
Laurence Lundblade93d89472020-10-03 22:30:50 -07002574 UsefulInputBuf_Init(&UIB, (UsefulBufC){pMem,QCBOR_DECODE_MIN_MEM_POOL_SIZE});
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002575 *puPoolSize = UsefulInputBuf_GetUint32(&UIB);
2576 *puFreeOffset = UsefulInputBuf_GetUint32(&UIB);
2577 return UsefulInputBuf_GetError(&UIB);
2578}
2579
2580
Laurence Lundbladeee851742020-01-08 08:37:05 -08002581static inline int
2582MemPool_Pack(UsefulBuf Pool, uint32_t uFreeOffset)
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002583{
2584 // Use of UsefulOutBuf is overkill, but convenient. The
2585 // length check performed here is useful.
2586 UsefulOutBuf UOB;
2587
2588 UsefulOutBuf_Init(&UOB, Pool);
2589 UsefulOutBuf_AppendUint32(&UOB, (uint32_t)Pool.len); // size of pool
2590 UsefulOutBuf_AppendUint32(&UOB, uFreeOffset); // first free position
2591 return UsefulOutBuf_GetError(&UOB);
2592}
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002593
2594
2595/*
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002596 Internal function for an allocation, reallocation free and destuct.
2597
2598 Having only one function rather than one each per mode saves space in
2599 QCBORDecodeContext.
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002600
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002601 Code Reviewers: THIS FUNCTION DOES POINTER MATH
2602 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002603static UsefulBuf
2604MemPool_Function(void *pPool, void *pMem, size_t uNewSize)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002605{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002606 UsefulBuf ReturnValue = NULLUsefulBuf;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002607
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002608 uint32_t uPoolSize;
2609 uint32_t uFreeOffset;
2610
2611 if(uNewSize > UINT32_MAX) {
2612 // This allocator is only good up to 4GB. This check should
2613 // optimize out if sizeof(size_t) == sizeof(uint32_t)
2614 goto Done;
2615 }
2616 const uint32_t uNewSize32 = (uint32_t)uNewSize;
2617
2618 if(MemPool_Unpack(pPool, &uPoolSize, &uFreeOffset)) {
2619 goto Done;
2620 }
2621
2622 if(uNewSize) {
2623 if(pMem) {
2624 // REALLOCATION MODE
2625 // Calculate pointer to the end of the memory pool. It is
2626 // assumed that pPool + uPoolSize won't wrap around by
2627 // assuming the caller won't pass a pool buffer in that is
2628 // not in legitimate memory space.
2629 const void *pPoolEnd = (uint8_t *)pPool + uPoolSize;
2630
2631 // Check that the pointer for reallocation is in the range of the
2632 // pool. This also makes sure that pointer math further down
2633 // doesn't wrap under or over.
2634 if(pMem >= pPool && pMem < pPoolEnd) {
2635 // Offset to start of chunk for reallocation. This won't
2636 // wrap under because of check that pMem >= pPool. Cast
2637 // is safe because the pool is always less than UINT32_MAX
2638 // because of check in QCBORDecode_SetMemPool().
2639 const uint32_t uMemOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2640
2641 // Check to see if the allocation will fit. uPoolSize -
2642 // uMemOffset will not wrap under because of check that
2643 // pMem is in the range of the uPoolSize by check above.
2644 if(uNewSize <= uPoolSize - uMemOffset) {
2645 ReturnValue.ptr = pMem;
2646 ReturnValue.len = uNewSize;
2647
2648 // Addition won't wrap around over because uNewSize was
2649 // checked to be sure it is less than the pool size.
2650 uFreeOffset = uMemOffset + uNewSize32;
2651 }
2652 }
2653 } else {
2654 // ALLOCATION MODE
2655 // uPoolSize - uFreeOffset will not underflow because this
2656 // pool implementation makes sure uFreeOffset is always
2657 // smaller than uPoolSize through this check here and
2658 // reallocation case.
2659 if(uNewSize <= uPoolSize - uFreeOffset) {
2660 ReturnValue.len = uNewSize;
2661 ReturnValue.ptr = (uint8_t *)pPool + uFreeOffset;
Laurence Lundblade06350ea2020-01-27 19:32:40 -08002662 uFreeOffset += (uint32_t)uNewSize;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002663 }
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002664 }
2665 } else {
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002666 if(pMem) {
2667 // FREE MODE
2668 // Cast is safe because of limit on pool size in
2669 // QCBORDecode_SetMemPool()
2670 uFreeOffset = (uint32_t)((uint8_t *)pMem - (uint8_t *)pPool);
2671 } else {
2672 // DESTRUCT MODE
2673 // Nothing to do for this allocator
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002674 }
2675 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002676
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002677 UsefulBuf Pool = {pPool, uPoolSize};
2678 MemPool_Pack(Pool, uFreeOffset);
2679
2680Done:
2681 return ReturnValue;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002682}
2683
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002684
Laurence Lundbladef6531662018-12-04 10:42:22 +09002685/*
Laurence Lundblade844bb5c2020-03-01 17:27:25 -08002686 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef6531662018-12-04 10:42:22 +09002687 */
Laurence Lundbladeee851742020-01-08 08:37:05 -08002688QCBORError QCBORDecode_SetMemPool(QCBORDecodeContext *pMe,
2689 UsefulBuf Pool,
2690 bool bAllStrings)
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002691{
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002692 // The pool size and free mem offset are packed into the beginning
2693 // of the pool memory. This compile time check make sure the
2694 // constant in the header is correct. This check should optimize
2695 // down to nothing.
2696 if(QCBOR_DECODE_MIN_MEM_POOL_SIZE < 2 * sizeof(uint32_t)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002697 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002698 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002699
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002700 // The pool size and free offset packed in to the beginning of pool
2701 // memory are only 32-bits. This check will optimize out on 32-bit
2702 // machines.
2703 if(Pool.len > UINT32_MAX) {
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 // This checks that the pool buffer given is big enough.
2708 if(MemPool_Pack(Pool, QCBOR_DECODE_MIN_MEM_POOL_SIZE)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002709 return QCBOR_ERR_MEM_POOL_SIZE;
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002710 }
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002711
Laurence Lundblade1d7eb632019-02-17 17:23:38 -08002712 pMe->StringAllocator.pfAllocator = MemPool_Function;
2713 pMe->StringAllocator.pAllocateCxt = Pool.ptr;
2714 pMe->bStringAllocateAll = bAllStrings;
Laurence Lundblade3aee3a32018-12-17 16:17:45 -08002715
Laurence Lundblade30816f22018-11-10 13:40:22 +07002716 return QCBOR_SUCCESS;
Laurence Lundblade041ffa52018-10-07 11:43:51 +07002717}
Laurence Lundbladef6da33c2020-11-26 18:15:05 -08002718#endif /* QCBOR_DISABLE_INDEFINITE_LENGTH_STRINGS */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002719
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002720
2721
Laurence Lundblade9b334962020-08-27 10:55:53 -07002722static inline void CopyTags(QCBORDecodeContext *pMe, const QCBORItem *pItem)
2723{
2724 memcpy(pMe->uLastTags, pItem->uTags, sizeof(pItem->uTags));
2725}
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002726
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002727
2728/*
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002729 Consume an entire map or array (and do next to
2730 nothing for non-aggregate types).
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002731 */
Laurence Lundblade9c905e82020-04-25 11:31:38 -07002732static inline QCBORError
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002733ConsumeItem(QCBORDecodeContext *pMe,
2734 const QCBORItem *pItemToConsume,
2735 uint_fast8_t *puNextNestLevel)
2736{
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002737 QCBORError uReturn;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002738 QCBORItem Item;
Laurence Lundblade9b334962020-08-27 10:55:53 -07002739
Laurence Lundbladed40951e2020-08-28 11:11:14 -07002740 // If it is a map or array, this will tell if it is empty.
2741 const bool bIsEmpty = (pItemToConsume->uNextNestLevel <= pItemToConsume->uNestingLevel);
2742
2743 if(QCBORItem_IsMapOrArray(pItemToConsume) && !bIsEmpty) {
2744 /* There is only real work to do for non-empty maps and arrays */
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002745
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002746 /* This works for definite- and indefinite- length
Laurence Lundblade1341c592020-04-11 14:19:05 -07002747 * maps and arrays by using the nesting level
2748 */
2749 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002750 uReturn = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002751 if(QCBORDecode_IsUnrecoverableError(uReturn)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002752 goto Done;
2753 }
2754 } while(Item.uNextNestLevel >= pItemToConsume->uNextNestLevel);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002755
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002756 *puNextNestLevel = Item.uNextNestLevel;
2757
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002758 uReturn = QCBOR_SUCCESS;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002759
Laurence Lundblade1341c592020-04-11 14:19:05 -07002760 } else {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002761 /* item_to_consume is not a map or array */
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002762 /* Just pass the nesting level through */
2763 *puNextNestLevel = pItemToConsume->uNextNestLevel;
2764
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002765 uReturn = QCBOR_SUCCESS;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002766 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002767
2768Done:
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002769 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002770}
2771
Laurence Lundblade732e52d2021-02-22 20:11:01 -07002772
2773void QCBORDecode_VGetNextConsume(QCBORDecodeContext *pMe, QCBORItem *pDecodedItem)
2774{
2775 uint8_t uNextNestLevel;
2776
2777 QCBORDecode_VGetNext(pMe, pDecodedItem);
2778
2779 if(pMe->uLastError == QCBOR_SUCCESS) {
2780 pMe->uLastError = (uint8_t)ConsumeItem(pMe, pDecodedItem, &uNextNestLevel);
2781 pDecodedItem->uNextNestLevel = uNextNestLevel;
2782 }
2783}
2784
2785
2786
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002787/* Call only on maps and arrays. Rewinds the cursor
2788 * to the start as if it was just entered.
2789 */
2790static void RewindMapOrArray(QCBORDecodeContext *pMe)
2791{
2792 /* Reset nesting tracking to the deepest bounded level */
2793 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2794
2795 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
2796
2797 /* Reposition traversal cursor to the start of the map/array */
2798 UsefulInputBuf_Seek(&(pMe->InBuf),
2799 DecodeNesting_GetMapOrArrayStart(&(pMe->nesting)));
2800}
2801
2802
2803/*
2804 Public function, see header qcbor/qcbor_decode.h file
2805 */
2806void QCBORDecode_Rewind(QCBORDecodeContext *pMe)
2807{
2808 if(pMe->nesting.pCurrentBounded != NULL) {
2809 /* In a bounded map, array or bstr-wrapped CBOR */
2810
2811 if(DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
2812 /* In bstr-wrapped CBOR. */
2813
2814 /* Reposition traversal cursor to start of wrapping byte string */
2815 UsefulInputBuf_Seek(&(pMe->InBuf),
2816 pMe->nesting.pCurrentBounded->u.bs.uBstrStartOffset);
2817 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
2818
2819 } else {
2820 /* In a map or array */
2821 RewindMapOrArray(pMe);
2822 }
2823
2824 } else {
2825 /* Not in anything bounded */
2826
2827 /* Reposition traversal cursor to the start of input CBOR */
2828 UsefulInputBuf_Seek(&(pMe->InBuf), 0ULL);
2829
2830 /* Reset nesting tracking to beginning of input. */
2831 DecodeNesting_Init(&(pMe->nesting));
2832 }
2833
2834 pMe->uLastError = QCBOR_SUCCESS;
2835}
2836
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002837
Laurence Lundblade1341c592020-04-11 14:19:05 -07002838/* Return true if the labels in Item1 and Item2 are the same.
2839 Works only for integer and string labels. Returns false
2840 for any other type. */
2841static inline bool
2842MatchLabel(QCBORItem Item1, QCBORItem Item2)
2843{
2844 if(Item1.uLabelType == QCBOR_TYPE_INT64) {
2845 if(Item2.uLabelType == QCBOR_TYPE_INT64 && Item1.label.int64 == Item2.label.int64) {
2846 return true;
2847 }
2848 } else if(Item1.uLabelType == QCBOR_TYPE_TEXT_STRING) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002849 if(Item2.uLabelType == QCBOR_TYPE_TEXT_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07002850 return true;
2851 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002852 } else if(Item1.uLabelType == QCBOR_TYPE_BYTE_STRING) {
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002853 if(Item2.uLabelType == QCBOR_TYPE_BYTE_STRING && !UsefulBuf_Compare(Item1.label.string, Item2.label.string)) {
2854 return true;
2855 }
2856 } else if(Item1.uLabelType == QCBOR_TYPE_UINT64) {
2857 if(Item2.uLabelType == QCBOR_TYPE_UINT64 && Item1.label.uint64 == Item2.label.uint64) {
2858 return true;
2859 }
2860 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002861
Laurence Lundblade1341c592020-04-11 14:19:05 -07002862 /* Other label types are never matched */
2863 return false;
2864}
2865
Laurence Lundblade2b843b52020-06-16 20:51:03 -07002866
2867/*
2868 Returns true if Item1 and Item2 are the same type
2869 or if either are of QCBOR_TYPE_ANY.
2870 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002871static inline bool
2872MatchType(QCBORItem Item1, QCBORItem Item2)
2873{
2874 if(Item1.uDataType == Item2.uDataType) {
2875 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002876 } else if(Item1.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002877 return true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07002878 } else if(Item2.uDataType == QCBOR_TYPE_ANY) {
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002879 return true;
2880 }
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002881 return false;
2882}
2883
2884
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002885/**
Laurence Lundblade5f53f832020-09-03 12:00:14 -07002886 @brief Search a map for a set of items.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002887
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002888 @param[in] pMe The decode context to search.
2889 @param[in,out] pItemArray The items to search for and the items found.
2890 @param[out] puOffset Byte offset of last item matched.
2891 @param[in] pCBContext Context for the not-found item call back.
2892 @param[in] pfCallback Function to call on items not matched in pItemArray.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002893
2894 @retval QCBOR_ERR_NOT_ENTERED Trying to search without having entered a map
2895
Laurence Lundblade93d89472020-10-03 22:30:50 -07002896 @retval QCBOR_ERR_DUPLICATE_LABEL Duplicate items (items with the same label)
2897 were found for one of the labels being
2898 search for. This duplicate detection is
2899 only performed for items in pItemArray,
2900 not every item in the map.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002901
Laurence Lundblade93d89472020-10-03 22:30:50 -07002902 @retval QCBOR_ERR_UNEXPECTED_TYPE A label was matched, but the type was
2903 wrong for the matchd label.
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002904
2905 @retval Also errors returned by QCBORDecode_GetNext().
2906
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002907 On input pItemArray contains a list of labels and data types
2908 of items to be found.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002909
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002910 On output the fully retrieved items are filled in with
2911 values and such. The label was matched, so it never changes.
Laurence Lundblade9b334962020-08-27 10:55:53 -07002912
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002913 If an item was not found, its data type is set to QCBOR_TYPE_NONE.
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002914
2915 This also finds the ends of maps and arrays when they are exited.
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002916 */
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07002917static QCBORError
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002918MapSearch(QCBORDecodeContext *pMe,
2919 QCBORItem *pItemArray,
2920 size_t *puOffset,
Laurence Lundblade24d509a2020-06-06 18:43:15 -07002921 void *pCBContext,
2922 QCBORItemCallback pfCallback)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002923{
Laurence Lundbladee6f15112020-07-23 18:44:16 -07002924 QCBORError uReturn;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002925 uint64_t uFoundItemBitMap = 0;
Laurence Lundbladefb492ea2020-05-02 11:14:07 -07002926
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002927 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002928 uReturn = pMe->uLastError;
2929 goto Done2;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07002930 }
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002931
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002932 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_MAP) &&
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002933 pItemArray->uLabelType != QCBOR_TYPE_NONE) {
2934 /* QCBOR_TYPE_NONE as first item indicates just looking
2935 for the end of an array, so don't give error. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002936 uReturn = QCBOR_ERR_MAP_NOT_ENTERED;
2937 goto Done2;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07002938 }
2939
Laurence Lundblade085d7952020-07-24 10:26:30 -07002940 if(DecodeNesting_IsBoundedEmpty(&(pMe->nesting))) {
2941 // It is an empty bounded array or map
2942 if(pItemArray->uLabelType == QCBOR_TYPE_NONE) {
2943 // Just trying to find the end of the map or array
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002944 pMe->uMapEndOffsetCache = DecodeNesting_GetMapOrArrayStart(&(pMe->nesting));
Laurence Lundblade085d7952020-07-24 10:26:30 -07002945 uReturn = QCBOR_SUCCESS;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002946 } else {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07002947 // Nothing is ever found in an empty array or map. All items
2948 // are marked as not found below.
Laurence Lundblade085d7952020-07-24 10:26:30 -07002949 uReturn = QCBOR_SUCCESS;
2950 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002951 goto Done2;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002952 }
2953
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002954 QCBORDecodeNesting SaveNesting;
Laurence Lundblade085d7952020-07-24 10:26:30 -07002955 DecodeNesting_PrepareForMapSearch(&(pMe->nesting), &SaveNesting);
2956
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002957 /* Reposition to search from the start of the map / array */
Laurence Lundbladecf41c522021-02-20 10:19:07 -07002958 RewindMapOrArray(pMe);
Laurence Lundblade1341c592020-04-11 14:19:05 -07002959
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002960 /*
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002961 Loop over all the items in the map or array. Each item
2962 could be a map or array, but label matching is only at
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002963 the main level. This handles definite- and indefinite-
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002964 length maps and arrays. The only reason this is ever
2965 called on arrays is to find their end position.
2966
2967 This will always run over all items in order to do
2968 duplicate detection.
2969
2970 This will exit with failure if it encounters an
2971 unrecoverable error, but continue on for recoverable
2972 errors.
2973
2974 If a recoverable error occurs on a matched item, then
2975 that error code is returned.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07002976 */
Laurence Lundblade0a042a92020-06-12 14:09:50 -07002977 const uint8_t uMapNestLevel = DecodeNesting_GetBoundedModeLevel(&(pMe->nesting));
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002978 uint_fast8_t uNextNestLevel;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002979 do {
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07002980 /* Remember offset of the item because sometimes it has to be returned */
Laurence Lundblade1341c592020-04-11 14:19:05 -07002981 const size_t uOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebb87be22020-04-09 19:15:32 -07002982
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002983 /* Get the item */
2984 QCBORItem Item;
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08002985 QCBORError uResult = QCBORDecode_GetNextTagContent(pMe, &Item);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002986 if(QCBORDecode_IsUnrecoverableError(uResult)) {
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07002987 /* Unrecoverable error so map can't even be decoded. */
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002988 uReturn = uResult;
Laurence Lundblade1341c592020-04-11 14:19:05 -07002989 goto Done;
2990 }
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002991 if(uResult == QCBOR_ERR_NO_MORE_ITEMS) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002992 // Unexpected end of map or array.
Laurence Lundblade93d3f532020-09-28 21:09:12 -07002993 uReturn = uResult;
Laurence Lundbladea9489f82020-09-12 13:50:56 -07002994 goto Done;
2995 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07002996
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07002997 /* See if item has one of the labels that are of interest */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07002998 bool bMatched = false;
2999 for(int nIndex = 0; pItemArray[nIndex].uLabelType != QCBOR_TYPE_NONE; nIndex++) {
3000 if(MatchLabel(Item, pItemArray[nIndex])) {
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003001 /* A label match has been found */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003002 if(uFoundItemBitMap & (0x01ULL << nIndex)) {
3003 uReturn = QCBOR_ERR_DUPLICATE_LABEL;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003004 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003005 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003006 if(uResult != QCBOR_SUCCESS) {
3007 /* The label matches, but the data item is in error */
3008 uReturn = uResult;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003009 goto Done;
3010 }
Laurence Lundblade63926052021-03-29 16:05:51 -07003011 if(!MatchType(Item, pItemArray[nIndex])) {
3012 /* The data item is not of the type(s) requested */
3013 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003014 goto Done;
3015 }
3016
Laurence Lundblade1341c592020-04-11 14:19:05 -07003017 /* Successful match. Return the item. */
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003018 pItemArray[nIndex] = Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003019 uFoundItemBitMap |= 0x01ULL << nIndex;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003020 if(puOffset) {
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003021 *puOffset = uOffset;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003022 }
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003023 bMatched = true;
3024 }
3025 }
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003026
3027
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003028 if(!bMatched && pfCallback != NULL) {
3029 /*
3030 Call the callback on unmatched labels.
3031 (It is tempting to do duplicate detection here, but that would
3032 require dynamic memory allocation because the number of labels
3033 that might be encountered is unbounded.)
3034 */
3035 uReturn = (*pfCallback)(pCBContext, &Item);
3036 if(uReturn != QCBOR_SUCCESS) {
3037 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003038 }
3039 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003040
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003041 /*
3042 Consume the item whether matched or not. This
3043 does the work of traversing maps and array and
3044 everything in them. In this loop only the
3045 items at the current nesting level are examined
3046 to match the labels.
3047 */
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003048 uReturn = ConsumeItem(pMe, &Item, &uNextNestLevel);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003049 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundblade1341c592020-04-11 14:19:05 -07003050 goto Done;
3051 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003052
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003053 } while (uNextNestLevel >= uMapNestLevel);
Laurence Lundblade9b334962020-08-27 10:55:53 -07003054
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003055 uReturn = QCBOR_SUCCESS;
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003056
3057 const size_t uEndOffset = UsefulInputBuf_Tell(&(pMe->InBuf));
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003058
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003059 // Check here makes sure that this won't accidentally be
3060 // QCBOR_MAP_OFFSET_CACHE_INVALID which is larger than
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003061 // QCBOR_MAX_DECODE_INPUT_SIZE.
Laurence Lundblade9c1b7b42020-12-12 11:44:16 -08003062 // Cast to uint32_t to possibly address cases where SIZE_MAX < UINT32_MAX
3063 if((uint32_t)uEndOffset >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003064 uReturn = QCBOR_ERR_INPUT_TOO_LARGE;
3065 goto Done;
3066 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003067 /* Cast OK because encoded CBOR is limited to UINT32_MAX */
3068 pMe->uMapEndOffsetCache = (uint32_t)uEndOffset;
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003069
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003070 Done:
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003071 DecodeNesting_RestoreFromMapSearch(&(pMe->nesting), &SaveNesting);
3072
3073 Done2:
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003074 /* For all items not found, set the data and label type to QCBOR_TYPE_NONE */
Laurence Lundbladec7114722020-08-13 05:11:40 -07003075 for(int i = 0; pItemArray[i].uLabelType != 0; i++) {
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003076 if(!(uFoundItemBitMap & (0x01ULL << i))) {
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003077 pItemArray[i].uDataType = QCBOR_TYPE_NONE;
3078 pItemArray[i].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003079 }
3080 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003081
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003082 return uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003083}
3084
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003085
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003086/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003087 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003088*/
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003089void QCBORDecode_GetItemInMapN(QCBORDecodeContext *pMe,
3090 int64_t nLabel,
3091 uint8_t uQcborType,
3092 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003093{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003094 if(pMe->uLastError != QCBOR_SUCCESS) {
3095 return;
3096 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003097
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003098 QCBORItem OneItemSeach[2];
3099 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3100 OneItemSeach[0].label.int64 = nLabel;
3101 OneItemSeach[0].uDataType = uQcborType;
3102 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003103
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003104 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
Laurence Lundblade93d3f532020-09-28 21:09:12 -07003105
3106 *pItem = OneItemSeach[0];
3107
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003108 if(uReturn != QCBOR_SUCCESS) {
3109 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003110 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003111 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003112 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003113 }
3114
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003115 Done:
3116 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003117}
3118
3119
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003120/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003121 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003122*/
Laurence Lundbladeda095972020-06-06 18:35:33 -07003123void QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pMe,
3124 const char *szLabel,
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003125 uint8_t uQcborType,
3126 QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003127{
Laurence Lundbladeda095972020-06-06 18:35:33 -07003128 if(pMe->uLastError != QCBOR_SUCCESS) {
3129 return;
3130 }
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003131
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003132 QCBORItem OneItemSeach[2];
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003133 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3134 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3135 OneItemSeach[0].uDataType = uQcborType;
3136 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE; // Indicates end of array
Laurence Lundblade1341c592020-04-11 14:19:05 -07003137
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003138 QCBORError uReturn = MapSearch(pMe, OneItemSeach, NULL, NULL, NULL);
3139 if(uReturn != QCBOR_SUCCESS) {
3140 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003141 }
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003142 if(OneItemSeach[0].uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003143 uReturn = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003144 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003145 }
3146
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003147 *pItem = OneItemSeach[0];
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003148
3149Done:
3150 pMe->uLastError = (uint8_t)uReturn;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003151}
3152
3153
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003154
Laurence Lundblade93d89472020-10-03 22:30:50 -07003155static QCBORError
3156CheckTypeList(int uDataType, const uint8_t puTypeList[QCBOR_TAGSPEC_NUM_TYPES])
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07003157{
3158 for(size_t i = 0; i < QCBOR_TAGSPEC_NUM_TYPES; i++) {
3159 if(uDataType == puTypeList[i]) {
3160 return QCBOR_SUCCESS;
3161 }
3162 }
3163 return QCBOR_ERR_UNEXPECTED_TYPE;
3164}
3165
Laurence Lundblade67257dc2020-07-27 03:33:37 -07003166
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003167/**
3168 @param[in] TagSpec Specification for matching tags.
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003169 @param[in] pItem The item to check.
Laurence Lundblade9b334962020-08-27 10:55:53 -07003170
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003171 @retval QCBOR_SUCCESS \c uDataType is allowed by @c TagSpec
3172 @retval QCBOR_ERR_UNEXPECTED_TYPE \c uDataType is not allowed by @c TagSpec
Laurence Lundblade9b334962020-08-27 10:55:53 -07003173
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003174 The data type must be one of the QCBOR_TYPEs, not the IETF CBOR Registered
3175 tag value.
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003176 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07003177static QCBORError
3178CheckTagRequirement(const TagSpecification TagSpec, const QCBORItem *pItem)
Laurence Lundblade9b334962020-08-27 10:55:53 -07003179{
3180 if(!(TagSpec.uTagRequirement & QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS) &&
3181 pItem->uTags[0] != CBOR_TAG_INVALID16) {
3182 /* There are tags that QCBOR couldn't process on this item and
3183 the caller has told us there should not be. */
3184 return QCBOR_ERR_UNEXPECTED_TYPE;
3185 }
3186
3187 const int nTagReq = TagSpec.uTagRequirement & ~QCBOR_TAG_REQUIREMENT_ALLOW_ADDITIONAL_TAGS;
3188 const int nItemType = pItem->uDataType;
3189
3190 if(nTagReq == QCBOR_TAG_REQUIREMENT_TAG) {
3191 // Must match the tag and only the tag
3192 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3193 }
3194
3195 QCBORError uReturn = CheckTypeList(nItemType, TagSpec.uAllowedContentTypes);
3196 if(uReturn == QCBOR_SUCCESS) {
3197 return QCBOR_SUCCESS;
3198 }
3199
3200 if(nTagReq == QCBOR_TAG_REQUIREMENT_NOT_A_TAG) {
3201 /* Must match the content type and only the content type.
3202 There was no match just above so it is a fail. */
3203 return QCBOR_ERR_UNEXPECTED_TYPE;
3204 }
3205
3206 /* If here it can match either the tag or the content
3207 and it hasn't matched the content, so the end
3208 result is whether it matches the tag. This is
3209 also the case that the CBOR standard discourages. */
3210
3211 return CheckTypeList(nItemType, TagSpec.uTaggedTypes);
3212}
3213
Laurence Lundblade9b334962020-08-27 10:55:53 -07003214
Laurence Lundblade9b334962020-08-27 10:55:53 -07003215
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003216// This could be semi-private if need be
3217static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003218void QCBORDecode_GetTaggedItemInMapN(QCBORDecodeContext *pMe,
3219 int64_t nLabel,
3220 TagSpecification TagSpec,
3221 QCBORItem *pItem)
3222{
3223 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
3224 if(pMe->uLastError != QCBOR_SUCCESS) {
3225 return;
3226 }
3227
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003228 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003229}
3230
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07003231
3232// This could be semi-private if need be
3233static inline
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003234void QCBORDecode_GetTaggedItemInMapSZ(QCBORDecodeContext *pMe,
3235 const char *szLabel,
3236 TagSpecification TagSpec,
3237 QCBORItem *pItem)
3238{
3239 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
3240 if(pMe->uLastError != QCBOR_SUCCESS) {
3241 return;
3242 }
3243
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003244 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003245}
3246
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003247// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003248void QCBORDecode_GetTaggedStringInMapN(QCBORDecodeContext *pMe,
3249 int64_t nLabel,
3250 TagSpecification TagSpec,
3251 UsefulBufC *pString)
3252{
3253 QCBORItem Item;
3254 QCBORDecode_GetTaggedItemInMapN(pMe, nLabel, TagSpec, &Item);
3255 if(pMe->uLastError == QCBOR_SUCCESS) {
3256 *pString = Item.val.string;
3257 }
3258}
3259
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003260// Semi-private
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003261void QCBORDecode_GetTaggedStringInMapSZ(QCBORDecodeContext *pMe,
3262 const char * szLabel,
3263 TagSpecification TagSpec,
3264 UsefulBufC *pString)
3265{
3266 QCBORItem Item;
3267 QCBORDecode_GetTaggedItemInMapSZ(pMe, szLabel, TagSpec, &Item);
3268 if(pMe->uLastError == QCBOR_SUCCESS) {
3269 *pString = Item.val.string;
3270 }
3271}
Laurence Lundblade1341c592020-04-11 14:19:05 -07003272
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003273/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003274 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003275*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003276void QCBORDecode_GetItemsInMap(QCBORDecodeContext *pMe, QCBORItem *pItemList)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003277{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003278 QCBORError uErr = MapSearch(pMe, pItemList, NULL, NULL, NULL);
3279 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003280}
3281
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003282/*
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003283 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003284*/
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003285void QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pMe,
3286 QCBORItem *pItemList,
3287 void *pCallbackCtx,
3288 QCBORItemCallback pfCB)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003289{
Laurence Lundblade5f53f832020-09-03 12:00:14 -07003290 QCBORError uErr = MapSearch(pMe, pItemList, NULL, pCallbackCtx, pfCB);
3291 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003292}
3293
3294
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003295/**
3296 * @brief Search for a map/array by label and enter it
3297 *
3298 * @param[in] pMe The decode context.
3299 * @param[in] pSearch The map/array to search for.
3300 *
3301 * @c pSearch is expected to contain one item of type map or array
3302 * with the label specified. The current bounded map will be searched for
3303 * this and if found will be entered.
3304 *
3305 * If the label is not found, or the item found is not a map or array,
3306 * the error state is set.
3307 */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003308static void SearchAndEnter(QCBORDecodeContext *pMe, QCBORItem pSearch[])
Laurence Lundblade1341c592020-04-11 14:19:05 -07003309{
Laurence Lundblade323f8a92020-09-06 19:43:09 -07003310 // The first item in pSearch is the one that is to be
3311 // entered. It should be the only one filled in. Any other
3312 // will be ignored unless it causes an error.
Laurence Lundblade34691b92020-05-18 22:25:25 -07003313 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade34691b92020-05-18 22:25:25 -07003314 return;
3315 }
3316
3317 size_t uOffset;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003318 pMe->uLastError = (uint8_t)MapSearch(pMe, pSearch, &uOffset, NULL, NULL);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003319 if(pMe->uLastError != QCBOR_SUCCESS) {
3320 return;
3321 }
3322
Laurence Lundblade9b334962020-08-27 10:55:53 -07003323 if(pSearch->uDataType == QCBOR_TYPE_NONE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003324 pMe->uLastError = QCBOR_ERR_LABEL_NOT_FOUND;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003325 return;
3326 }
3327
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003328
3329 /* The map or array was found. Now enter it.
3330 *
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003331 * QCBORDecode_EnterBoundedMapOrArray() used here, requires the
3332 * next item for the pre-order traversal cursor to be the map/array
3333 * found by MapSearch(). The next few lines of code force the
3334 * cursor to that.
3335 *
3336 * There is no need to retain the old cursor because
3337 * QCBORDecode_EnterBoundedMapOrArray() will set it to the
3338 * beginning of the map/array being entered.
3339 *
3340 * The cursor is forced by: 1) setting the input buffer position to
3341 * the item offset found by MapSearch(), 2) setting the map/array
3342 * counter to the total in the map/array, 3) setting the nesting
3343 * level. Setting the map/array counter to the total is not
3344 * strictly correct, but this is OK because this cursor only needs
3345 * to be used to get one item and MapSearch() has already found it
3346 * confirming it exists.
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003347 */
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003348 UsefulInputBuf_Seek(&(pMe->InBuf), uOffset);
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003349
Laurence Lundbladeddebabe2020-11-22 11:32:17 -08003350 DecodeNesting_ResetMapOrArrayCount(&(pMe->nesting));
3351
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003352 DecodeNesting_SetCurrentToBoundedLevel(&(pMe->nesting));
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003353
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003354 QCBORDecode_EnterBoundedMapOrArray(pMe, pSearch->uDataType, NULL);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003355}
3356
3357
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003358/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003359 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003360*/
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003361void QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003362{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003363 QCBORItem OneItemSeach[2];
3364 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3365 OneItemSeach[0].label.int64 = nLabel;
3366 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3367 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003368
Laurence Lundblade9b334962020-08-27 10:55:53 -07003369 /* The map to enter was found, now finish off entering it. */
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003370 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003371}
3372
3373
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003374/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003375 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003376*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003377void QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003378{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003379 QCBORItem OneItemSeach[2];
3380 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3381 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3382 OneItemSeach[0].uDataType = QCBOR_TYPE_MAP;
3383 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade9b334962020-08-27 10:55:53 -07003384
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003385 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003386}
3387
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003388/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003389 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003390*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003391void QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t nLabel)
Laurence Lundblade1341c592020-04-11 14:19:05 -07003392{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003393 QCBORItem OneItemSeach[2];
3394 OneItemSeach[0].uLabelType = QCBOR_TYPE_INT64;
3395 OneItemSeach[0].label.int64 = nLabel;
3396 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3397 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003398
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003399 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade34691b92020-05-18 22:25:25 -07003400}
3401
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003402/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003403 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003404*/
Laurence Lundblade34691b92020-05-18 22:25:25 -07003405void QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel)
3406{
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003407 QCBORItem OneItemSeach[2];
3408 OneItemSeach[0].uLabelType = QCBOR_TYPE_TEXT_STRING;
3409 OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
3410 OneItemSeach[0].uDataType = QCBOR_TYPE_ARRAY;
3411 OneItemSeach[1].uLabelType = QCBOR_TYPE_NONE;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003412
Laurence Lundbladeb90f5362020-05-25 12:17:40 -07003413 SearchAndEnter(pMe, OneItemSeach);
Laurence Lundblade1341c592020-04-11 14:19:05 -07003414}
3415
3416
Laurence Lundblade02625d42020-06-25 14:41:41 -07003417// Semi-private function
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003418void QCBORDecode_EnterBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType, QCBORItem *pItem)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003419{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003420 QCBORError uErr;
3421
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003422 /* Must only be called on maps and arrays. */
Laurence Lundblade34691b92020-05-18 22:25:25 -07003423 if(pMe->uLastError != QCBOR_SUCCESS) {
3424 // Already in error state; do nothing.
3425 return;
3426 }
Laurence Lundblade1341c592020-04-11 14:19:05 -07003427
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003428 /* Get the data item that is the map or array being entered. */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003429 QCBORItem Item;
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003430 uErr = QCBORDecode_GetNext(pMe, &Item);
3431 if(uErr != QCBOR_SUCCESS) {
3432 goto Done;
Laurence Lundblade3f9ef042020-04-14 13:15:51 -07003433 }
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07003434 if(Item.uDataType != uType) {
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003435 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
3436 goto Done;
Laurence Lundblade1341c592020-04-11 14:19:05 -07003437 }
3438
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003439 CopyTags(pMe, &Item);
Laurence Lundbladed40951e2020-08-28 11:11:14 -07003440
3441
Laurence Lundbladef0499502020-08-01 11:55:57 -07003442 const bool bIsEmpty = (Item.uNextNestLevel <= Item.uNestingLevel);
Laurence Lundblade085d7952020-07-24 10:26:30 -07003443 if(bIsEmpty) {
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003444 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
3445 // Undo decrement done by QCBORDecode_GetNext() so the the
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003446 // the decrement when exiting the map/array works correctly
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003447 pMe->nesting.pCurrent->u.ma.uCountCursor++;
3448 }
Laurence Lundblade93d89472020-10-03 22:30:50 -07003449 // Special case to increment nesting level for zero-length maps
3450 // and arrays entered in bounded mode.
Laurence Lundbladee6f15112020-07-23 18:44:16 -07003451 DecodeNesting_Descend(&(pMe->nesting), uType);
3452 }
3453
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003454 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003455
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003456 uErr = DecodeNesting_EnterBoundedMapOrArray(&(pMe->nesting), bIsEmpty,
3457 UsefulInputBuf_Tell(&(pMe->InBuf)));
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003458
Laurence Lundblade6545d1b2020-10-14 11:13:13 -07003459 if(pItem != NULL) {
3460 *pItem = Item;
3461 }
3462
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003463Done:
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003464 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003465}
3466
Laurence Lundblade02625d42020-06-25 14:41:41 -07003467
3468/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07003469 This is the common work for exiting a level that is a bounded map,
3470 array or bstr wrapped CBOR.
Laurence Lundblade02625d42020-06-25 14:41:41 -07003471
3472 One chunk of work is to set up the pre-order traversal so it is at
3473 the item just after the bounded map, array or bstr that is being
3474 exited. This is somewhat complex.
3475
3476 The other work is to level-up the bounded mode to next higest bounded
3477 mode or the top level if there isn't one.
3478 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003479static QCBORError
Laurence Lundblade02625d42020-06-25 14:41:41 -07003480ExitBoundedLevel(QCBORDecodeContext *pMe, uint32_t uEndOffset)
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003481{
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003482 QCBORError uErr;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003483
Laurence Lundblade02625d42020-06-25 14:41:41 -07003484 /*
3485 First the pre-order-traversal byte offset is positioned to the
3486 item just after the bounded mode item that was just consumed.
3487 */
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003488 UsefulInputBuf_Seek(&(pMe->InBuf), uEndOffset);
3489
Laurence Lundblade02625d42020-06-25 14:41:41 -07003490 /*
3491 Next, set the current nesting level to one above the bounded level
3492 that was just exited.
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003493
Laurence Lundblade02625d42020-06-25 14:41:41 -07003494 DecodeNesting_CheckBoundedType() is always called before this and
3495 makes sure pCurrentBounded is valid.
3496 */
3497 DecodeNesting_LevelUpCurrent(&(pMe->nesting));
3498
3499 /*
3500 This does the complex work of leveling up the pre-order traversal
3501 when the end of a map or array or another bounded level is
3502 reached. It may do nothing, or ascend all the way to the top
3503 level.
3504 */
Laurence Lundblade3f1318a2021-01-04 18:26:44 -08003505 uErr = QCBORDecode_NestLevelAscender(pMe, false);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003506 if(uErr != QCBOR_SUCCESS) {
3507 goto Done;
3508 }
3509
Laurence Lundblade02625d42020-06-25 14:41:41 -07003510 /*
3511 This makes the next highest bounded level the current bounded
3512 level. If there is no next highest level, then no bounded mode is
3513 in effect.
3514 */
3515 DecodeNesting_LevelUpBounded(&(pMe->nesting));
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003516
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003517 pMe->uMapEndOffsetCache = QCBOR_MAP_OFFSET_CACHE_INVALID;
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003518
3519Done:
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003520 return uErr;
3521}
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003522
Laurence Lundblade02625d42020-06-25 14:41:41 -07003523
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003524// Semi-private function
Laurence Lundblade02625d42020-06-25 14:41:41 -07003525void QCBORDecode_ExitBoundedMapOrArray(QCBORDecodeContext *pMe, uint8_t uType)
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003526{
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003527 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade02625d42020-06-25 14:41:41 -07003528 /* Already in error state; do nothing. */
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003529 return;
3530 }
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003531
Laurence Lundblade02625d42020-06-25 14:41:41 -07003532 QCBORError uErr;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003533
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003534 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), uType)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003535 uErr = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003536 goto Done;
3537 }
3538
Laurence Lundblade02625d42020-06-25 14:41:41 -07003539 /*
3540 Have to set the offset to the end of the map/array
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003541 that is being exited. If there is no cached value,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003542 from previous map search, then do a dummy search.
3543 */
Laurence Lundbladebfbf4942020-09-16 23:31:00 -07003544 if(pMe->uMapEndOffsetCache == QCBOR_MAP_OFFSET_CACHE_INVALID) {
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003545 QCBORItem Dummy;
3546 Dummy.uLabelType = QCBOR_TYPE_NONE;
3547 uErr = MapSearch(pMe, &Dummy, NULL, NULL, NULL);
3548 if(uErr != QCBOR_SUCCESS) {
3549 goto Done;
3550 }
3551 }
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003552
Laurence Lundblade02625d42020-06-25 14:41:41 -07003553 uErr = ExitBoundedLevel(pMe, pMe->uMapEndOffsetCache);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003554
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003555Done:
Laurence Lundblade2b843b52020-06-16 20:51:03 -07003556 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladebb87be22020-04-09 19:15:32 -07003557}
3558
3559
Laurence Lundblade1341c592020-04-11 14:19:05 -07003560
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003561static QCBORError InternalEnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003562 const QCBORItem *pItem,
3563 uint8_t uTagRequirement,
3564 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003565{
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003566 if(pBstr) {
3567 *pBstr = NULLUsefulBufC;
3568 }
3569
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003570 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003571 /* Already in error state; do nothing. */
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003572 return pMe->uLastError;
3573 }
3574
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003575 QCBORError uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003576
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003577 const TagSpecification TagSpec =
3578 {
3579 uTagRequirement,
3580 {QBCOR_TYPE_WRAPPED_CBOR, QBCOR_TYPE_WRAPPED_CBOR_SEQUENCE, QCBOR_TYPE_NONE},
3581 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3582 };
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003583
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003584 uError = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003585 if(uError != QCBOR_SUCCESS) {
3586 goto Done;
3587 }
3588
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003589 if(DecodeNesting_IsCurrentDefiniteLength(&(pMe->nesting))) {
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003590 /* Reverse the decrement done by GetNext() for the bstr so the
3591 * increment in QCBORDecode_NestLevelAscender() called by
3592 * ExitBoundedLevel() will work right.
3593 */
Laurence Lundbladea8edadb2020-06-27 22:35:37 -07003594 DecodeNesting_ReverseDecrement(&(pMe->nesting));
Laurence Lundblade6c8a4442020-06-22 22:16:11 -07003595 }
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003596
3597 if(pBstr) {
3598 *pBstr = pItem->val.string;
3599 }
3600
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003601 /* This saves the current length of the UsefulInputBuf and then
3602 * narrows the UsefulInputBuf to start and length of the wrapped
3603 * CBOR that is being entered.
3604 *
3605 * Most of these calls are simple inline accessors so this doesn't
3606 * amount to much code.
3607 */
3608
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003609 const size_t uPreviousLength = UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003610 /* This check makes the cast of uPreviousLength to uint32_t below safe. */
3611 if(uPreviousLength >= QCBOR_MAX_DECODE_INPUT_SIZE) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003612 uError = QCBOR_ERR_INPUT_TOO_LARGE;
Laurence Lundbladef76a2622020-08-06 19:51:03 -07003613 goto Done;
3614 }
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003615
3616 const size_t uStartOfBstr = UsefulInputBuf_PointerToOffset(&(pMe->InBuf),
3617 pItem->val.string.ptr);
3618 /* This check makes the cast of uStartOfBstr to uint32_t below safe. */
3619 if(uStartOfBstr == SIZE_MAX || uStartOfBstr > QCBOR_MAX_DECODE_INPUT_SIZE) {
3620 /* This should never happen because pItem->val.string.ptr should
3621 * always be valid since it was just returned.
3622 */
3623 uError = QCBOR_ERR_INPUT_TOO_LARGE;
3624 goto Done;
3625 }
3626
3627 const size_t uEndOfBstr = uStartOfBstr + pItem->val.string.len;
3628
3629 UsefulInputBuf_Seek(&(pMe->InBuf), uStartOfBstr);
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003630 UsefulInputBuf_SetBufferLength(&(pMe->InBuf), uEndOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003631
Laurence Lundblade02625d42020-06-25 14:41:41 -07003632 uError = DecodeNesting_DescendIntoBstrWrapped(&(pMe->nesting),
Laurence Lundbladea4308a82020-10-03 18:08:57 -07003633 (uint32_t)uPreviousLength,
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003634 (uint32_t)uStartOfBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003635Done:
3636 return uError;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003637}
3638
3639
Laurence Lundblade02625d42020-06-25 14:41:41 -07003640/*
3641 Public function, see header qcbor/qcbor_decode.h file
3642 */
3643void QCBORDecode_EnterBstrWrapped(QCBORDecodeContext *pMe,
Laurence Lundbladec45b5672020-07-25 23:16:36 -07003644 uint8_t uTagRequirement,
3645 UsefulBufC *pBstr)
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003646{
3647 if(pMe->uLastError != QCBOR_SUCCESS) {
3648 // Already in error state; do nothing.
3649 return;
3650 }
3651
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003652 /* Get the data item that is the byte string being entered */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003653 QCBORItem Item;
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003654 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3655 if(pMe->uLastError != QCBOR_SUCCESS) {
3656 return;
3657 }
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003658
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07003659 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003660 &Item,
3661 uTagRequirement,
3662 pBstr);
Laurence Lundblade24d509a2020-06-06 18:43:15 -07003663}
3664
3665
Laurence Lundblade02625d42020-06-25 14:41:41 -07003666/*
3667 Public function, see header qcbor/qcbor_decode.h file
3668 */
3669void QCBORDecode_EnterBstrWrappedFromMapN(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003670 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003671 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003672 UsefulBufC *pBstr)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003673{
3674 QCBORItem Item;
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003675 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003676
Laurence Lundblade93d89472020-10-03 22:30:50 -07003677 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3678 &Item,
3679 uTagRequirement,
3680 pBstr);
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003681}
3682
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003683
Laurence Lundblade02625d42020-06-25 14:41:41 -07003684/*
3685 Public function, see header qcbor/qcbor_decode.h file
3686 */
3687void QCBORDecode_EnterBstrWrappedFromMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003688 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07003689 uint8_t uTagRequirement,
Laurence Lundblade02625d42020-06-25 14:41:41 -07003690 UsefulBufC *pBstr)
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003691{
3692 QCBORItem Item;
3693 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3694
Laurence Lundblade93d89472020-10-03 22:30:50 -07003695 pMe->uLastError = (uint8_t)InternalEnterBstrWrapped(pMe,
3696 &Item,
3697 uTagRequirement,
3698 pBstr);
Laurence Lundbladeaa965d72020-06-17 22:29:22 -07003699}
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003700
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003701
Laurence Lundblade02625d42020-06-25 14:41:41 -07003702/*
3703 Public function, see header qcbor/qcbor_decode.h file
3704 */
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003705void QCBORDecode_ExitBstrWrapped(QCBORDecodeContext *pMe)
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003706{
Laurence Lundblade02625d42020-06-25 14:41:41 -07003707 if(pMe->uLastError != QCBOR_SUCCESS) {
3708 // Already in error state; do nothing.
3709 return;
3710 }
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003711
Laurence Lundblade2cd4b0d2020-07-31 08:29:07 -07003712 if(!DecodeNesting_IsBoundedType(&(pMe->nesting), QCBOR_TYPE_BYTE_STRING)) {
Laurence Lundbladea9489f82020-09-12 13:50:56 -07003713 pMe->uLastError = QCBOR_ERR_EXIT_MISMATCH;
Laurence Lundblade02625d42020-06-25 14:41:41 -07003714 return;
3715 }
3716
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003717 const uint32_t uEndOfBstr = (uint32_t)UsefulInputBuf_GetBufferLength(&(pMe->InBuf));
3718
Laurence Lundblade02625d42020-06-25 14:41:41 -07003719 /*
3720 Reset the length of the UsefulInputBuf to what it was before
3721 the bstr wrapped CBOR was entered.
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003722 */
Laurence Lundblade1ba100d2020-09-19 21:41:02 -07003723 UsefulInputBuf_SetBufferLength(&(pMe->InBuf),
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003724 DecodeNesting_GetPreviousBoundedEnd(&(pMe->nesting)));
Laurence Lundblade0750fc42020-06-20 21:02:34 -07003725
3726
Laurence Lundbladecf41c522021-02-20 10:19:07 -07003727 QCBORError uErr = ExitBoundedLevel(pMe, uEndOfBstr);
Laurence Lundblade1d85d522020-06-22 13:24:59 -07003728 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed8c82c52020-06-12 22:15:52 -07003729}
3730
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003731
Laurence Lundbladee6430642020-03-14 21:15:44 -07003732
Laurence Lundblade82c2a8f2020-04-29 12:40:19 -07003733
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003734static inline void
3735ProcessBool(QCBORDecodeContext *pMe, const QCBORItem *pItem, bool *pBool)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003736{
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003737 if(pMe->uLastError != QCBOR_SUCCESS) {
3738 /* Already in error state, do nothing */
3739 return;
3740 }
3741
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003742 switch(pItem->uDataType) {
3743 case QCBOR_TYPE_TRUE:
3744 *pBool = true;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003745 break;
3746
3747 case QCBOR_TYPE_FALSE:
3748 *pBool = false;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003749 break;
3750
3751 default:
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003752 pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003753 break;
3754 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07003755 CopyTags(pMe, pItem);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003756}
Laurence Lundbladee6430642020-03-14 21:15:44 -07003757
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003758
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003759/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003760 * Public function, see header qcbor/qcbor_decode.h file
3761 */
Laurence Lundbladec4537442020-04-14 18:53:22 -07003762void QCBORDecode_GetBool(QCBORDecodeContext *pMe, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003763{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003764 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003765 /* Already in error state, do nothing */
Laurence Lundbladee6430642020-03-14 21:15:44 -07003766 return;
3767 }
3768
Laurence Lundbladec4537442020-04-14 18:53:22 -07003769 QCBORItem Item;
3770
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003771 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3772
3773 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003774}
3775
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003776
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003777/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003778 * Public function, see header qcbor/qcbor_decode.h file
3779 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003780void QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pMe, int64_t nLabel, bool *pValue)
Laurence Lundbladee6430642020-03-14 21:15:44 -07003781{
3782 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003783 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003784
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003785 ProcessBool(pMe, &Item, pValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07003786}
3787
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003788
Laurence Lundblade4e2da002020-06-13 23:08:31 -07003789/*
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003790 * Public function, see header qcbor/qcbor_decode.h file
3791 */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003792void QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pMe, const char *szLabel, bool *pValue)
3793{
3794 QCBORItem Item;
3795 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3796
Laurence Lundblade9f9c3732021-03-23 09:38:46 -07003797 ProcessBool(pMe, &Item, pValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07003798}
3799
3800
3801
Laurence Lundbladec7114722020-08-13 05:11:40 -07003802
3803static void ProcessEpochDate(QCBORDecodeContext *pMe,
3804 QCBORItem *pItem,
3805 uint8_t uTagRequirement,
3806 int64_t *pnTime)
3807{
3808 if(pMe->uLastError != QCBOR_SUCCESS) {
3809 // Already in error state, do nothing
3810 return;
3811 }
3812
3813 QCBORError uErr;
3814
3815 const TagSpecification TagSpec =
3816 {
3817 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07003818 {QCBOR_TYPE_DATE_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3819 {QCBOR_TYPE_INT64, QCBOR_TYPE_DOUBLE, QCBOR_TYPE_FLOAT, QCBOR_TYPE_UINT64}
Laurence Lundbladec7114722020-08-13 05:11:40 -07003820 };
3821
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07003822 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladec7114722020-08-13 05:11:40 -07003823 if(uErr != QCBOR_SUCCESS) {
3824 goto Done;
3825 }
3826
3827 if(pItem->uDataType != QCBOR_TYPE_DATE_EPOCH) {
3828 uErr = DecodeDateEpoch(pItem);
3829 if(uErr != QCBOR_SUCCESS) {
3830 goto Done;
3831 }
3832 }
3833
Laurence Lundblade9b334962020-08-27 10:55:53 -07003834 // Save the tags in the last item's tags in the decode context
3835 // for QCBORDecode_GetNthTagOfLast()
3836 CopyTags(pMe, pItem);
3837
Laurence Lundbladec7114722020-08-13 05:11:40 -07003838 *pnTime = pItem->val.epochDate.nSeconds;
3839
3840Done:
3841 pMe->uLastError = (uint8_t)uErr;
3842}
3843
3844
3845void QCBORDecode_GetEpochDate(QCBORDecodeContext *pMe,
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07003846 uint8_t uTagRequirement,
3847 int64_t *pnTime)
Laurence Lundbladec7114722020-08-13 05:11:40 -07003848{
3849 if(pMe->uLastError != QCBOR_SUCCESS) {
3850 // Already in error state, do nothing
3851 return;
3852 }
3853
3854 QCBORItem Item;
3855 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3856
3857 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3858}
3859
3860
3861void
3862QCBORDecode_GetEpochDateInMapN(QCBORDecodeContext *pMe,
3863 int64_t nLabel,
3864 uint8_t uTagRequirement,
3865 int64_t *pnTime)
3866{
3867 QCBORItem Item;
3868 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
3869 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3870}
3871
3872
3873void
3874QCBORDecode_GetEpochDateInMapSZ(QCBORDecodeContext *pMe,
3875 const char *szLabel,
3876 uint8_t uTagRequirement,
3877 int64_t *pnTime)
3878{
3879 QCBORItem Item;
3880 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
3881 ProcessEpochDate(pMe, &Item, uTagRequirement, pnTime);
3882}
3883
3884
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003885
3886/*
3887 * Common processing for the RFC 8943 Day-count tag. Mostly
3888 * make sure the tag content is correct and copy forward any
3889 * further other tag numbers.
3890 */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003891static void ProcessEpochDays(QCBORDecodeContext *pMe,
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003892 QCBORItem *pItem,
3893 uint8_t uTagRequirement,
3894 int64_t *pnDays)
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003895{
3896 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003897 /* Already in error state, do nothing */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003898 return;
3899 }
3900
3901 QCBORError uErr;
3902
3903 const TagSpecification TagSpec =
3904 {
3905 uTagRequirement,
3906 {QCBOR_TYPE_DAYS_EPOCH, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
3907 {QCBOR_TYPE_INT64, QCBOR_TYPE_UINT64, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
3908 };
3909
3910 uErr = CheckTagRequirement(TagSpec, pItem);
3911 if(uErr != QCBOR_SUCCESS) {
3912 goto Done;
3913 }
3914
Laurence Lundbladeac425ab2021-05-08 17:17:33 -07003915 if(pItem->uDataType != QCBOR_TYPE_DAYS_EPOCH) {
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003916 uErr = DecodeDaysEpoch(pItem);
3917 if(uErr != QCBOR_SUCCESS) {
3918 goto Done;
3919 }
3920 }
3921
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003922 /* Save the tags in the last item's tags in the decode context
3923 * for QCBORDecode_GetNthTagOfLast()
3924 */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003925 CopyTags(pMe, pItem);
3926
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003927 *pnDays = pItem->val.epochDays;
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003928
3929Done:
3930 pMe->uLastError = (uint8_t)uErr;
3931}
3932
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003933
3934/*
3935 * Public function, see header qcbor/qcbor_decode.h
3936 */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003937void QCBORDecode_GetEpochDays(QCBORDecodeContext *pMe,
3938 uint8_t uTagRequirement,
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003939 int64_t *pnDays)
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003940{
3941 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003942 /* Already in error state, do nothing */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003943 return;
3944 }
3945
3946 QCBORItem Item;
3947 pMe->uLastError = (uint8_t)QCBORDecode_GetNext(pMe, &Item);
3948
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003949 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003950}
3951
3952
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003953/*
3954 * Public function, see header qcbor/qcbor_decode.h
3955 */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003956void
3957QCBORDecode_GetEpochDaysInMapN(QCBORDecodeContext *pMe,
3958 int64_t nLabel,
3959 uint8_t uTagRequirement,
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003960 int64_t *pnDays)
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003961{
3962 QCBORItem Item;
3963 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003964 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003965}
3966
3967
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003968/*
3969 * Public function, see header qcbor/qcbor_decode.h
3970 */
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003971void
3972QCBORDecode_GetEpochDaysInMapSZ(QCBORDecodeContext *pMe,
3973 const char *szLabel,
3974 uint8_t uTagRequirement,
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003975 int64_t *pnDays)
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003976{
3977 QCBORItem Item;
3978 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade7d0f5732021-05-12 00:06:06 -07003979 ProcessEpochDays(pMe, &Item, uTagRequirement, pnDays);
Laurence Lundblade58541fe2021-05-07 01:24:49 -07003980}
3981
3982
Laurence Lundbladec7114722020-08-13 05:11:40 -07003983
3984
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07003985void QCBORDecode_GetTaggedStringInternal(QCBORDecodeContext *pMe,
3986 TagSpecification TagSpec,
3987 UsefulBufC *pBstr)
Laurence Lundbladec4537442020-04-14 18:53:22 -07003988{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07003989 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07003990 // Already in error state, do nothing
3991 return;
3992 }
3993
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003994 QCBORError uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07003995 QCBORItem Item;
3996
Laurence Lundblade5f4e8712020-07-25 11:44:43 -07003997 uError = QCBORDecode_GetNext(pMe, &Item);
3998 if(uError != QCBOR_SUCCESS) {
3999 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004000 return;
4001 }
4002
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004003 pMe->uLastError = (uint8_t)CheckTagRequirement(TagSpec, &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004004
4005 if(pMe->uLastError == QCBOR_SUCCESS) {
4006 *pBstr = Item.val.string;
Laurence Lundbladeab40c6f2020-08-28 11:24:58 -07004007 } else {
4008 *pBstr = NULLUsefulBufC;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004009 }
4010}
4011
Laurence Lundbladec4537442020-04-14 18:53:22 -07004012
4013
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004014
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004015static QCBORError ProcessBigNum(uint8_t uTagRequirement,
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004016 const QCBORItem *pItem,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004017 UsefulBufC *pValue,
4018 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004019{
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004020 const TagSpecification TagSpec =
4021 {
4022 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004023 {QCBOR_TYPE_POSBIGNUM, QCBOR_TYPE_NEGBIGNUM, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4024 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004025 };
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004026
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004027 QCBORError uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004028 if(uErr != QCBOR_SUCCESS) {
4029 return uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004030 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004031
4032 *pValue = pItem->val.string;
4033
4034 if(pItem->uDataType == QCBOR_TYPE_POSBIGNUM) {
4035 *pbIsNegative = false;
4036 } else if(pItem->uDataType == QCBOR_TYPE_NEGBIGNUM) {
4037 *pbIsNegative = true;
4038 }
4039
4040 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004041}
4042
4043
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004044/*
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004045 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004046 */
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004047void QCBORDecode_GetBignum(QCBORDecodeContext *pMe,
4048 uint8_t uTagRequirement,
4049 UsefulBufC *pValue,
4050 bool *pbIsNegative)
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004051{
4052 if(pMe->uLastError != QCBOR_SUCCESS) {
4053 // Already in error state, do nothing
4054 return;
4055 }
4056
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004057 QCBORItem Item;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004058 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4059 if(uError != QCBOR_SUCCESS) {
4060 pMe->uLastError = (uint8_t)uError;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004061 return;
4062 }
4063
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004064 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004065}
4066
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004067
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004068/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004069 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004070*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004071void QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pMe,
4072 int64_t nLabel,
4073 uint8_t uTagRequirement,
4074 UsefulBufC *pValue,
4075 bool *pbIsNegative)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004076{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004077 QCBORItem Item;
4078 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004079 if(pMe->uLastError != QCBOR_SUCCESS) {
4080 return;
4081 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004082
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004083 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004084}
4085
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004086
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004087/*
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004088 Public function, see header qcbor/qcbor_decode.h
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004089*/
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004090void QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pMe,
4091 const char *szLabel,
4092 uint8_t uTagRequirement,
4093 UsefulBufC *pValue,
4094 bool *pbIsNegative)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004095{
4096 QCBORItem Item;
4097 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004098 if(pMe->uLastError != QCBOR_SUCCESS) {
4099 return;
4100 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004101
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07004102 pMe->uLastError = (uint8_t)ProcessBigNum(uTagRequirement, &Item, pValue, pbIsNegative);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004103}
4104
4105
4106
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004107
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004108// Semi private
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004109QCBORError QCBORDecode_GetMIMEInternal(uint8_t uTagRequirement,
4110 const QCBORItem *pItem,
4111 UsefulBufC *pMessage,
Laurence Lundblade4982f412020-09-18 23:02:18 -07004112 bool *pbIsTag257)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004113{
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004114 const TagSpecification TagSpecText =
4115 {
4116 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004117 {QCBOR_TYPE_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4118 {QCBOR_TYPE_TEXT_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004119 };
4120 const TagSpecification TagSpecBinary =
4121 {
4122 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07004123 {QCBOR_TYPE_BINARY_MIME, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE},
4124 {QCBOR_TYPE_BYTE_STRING, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004125 };
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004126
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004127 QCBORError uReturn;
Laurence Lundblade9b334962020-08-27 10:55:53 -07004128
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004129 if(CheckTagRequirement(TagSpecText, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004130 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004131 if(pbIsTag257 != NULL) {
4132 *pbIsTag257 = false;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004133 }
4134 uReturn = QCBOR_SUCCESS;
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07004135 } else if(CheckTagRequirement(TagSpecBinary, pItem) == QCBOR_SUCCESS) {
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004136 *pMessage = pItem->val.string;
Laurence Lundblade4982f412020-09-18 23:02:18 -07004137 if(pbIsTag257 != NULL) {
4138 *pbIsTag257 = true;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004139 }
4140 uReturn = QCBOR_SUCCESS;
4141
4142 } else {
4143 uReturn = QCBOR_ERR_UNEXPECTED_TYPE;
4144 }
Laurence Lundblade9b334962020-08-27 10:55:53 -07004145
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004146 return uReturn;
4147}
4148
Laurence Lundblade93d89472020-10-03 22:30:50 -07004149// Improvement: add methods for wrapped CBOR, a simple alternate
4150// to EnterBstrWrapped
Laurence Lundblade9bb039a2020-08-05 12:25:15 -07004151
Laurence Lundblade91853ae2020-06-15 19:35:58 -07004152
4153
4154
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004155#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladee6430642020-03-14 21:15:44 -07004156
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004157typedef QCBORError (*fExponentiator)(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004158
4159
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004160// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004161static QCBORError
4162Exponentitate10(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004163{
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004164 uint64_t uResult = uMantissa;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004165
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004166 if(uResult != 0) {
4167 /* This loop will run a maximum of 19 times because
4168 * UINT64_MAX < 10 ^^ 19. More than that will cause
4169 * exit with the overflow error
4170 */
4171 for(; nExponent > 0; nExponent--) {
4172 if(uResult > UINT64_MAX / 10) {
4173 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
4174 }
4175 uResult = uResult * 10;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004176 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004177
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004178 for(; nExponent < 0; nExponent++) {
4179 uResult = uResult / 10;
4180 if(uResult == 0) {
4181 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4182 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004183 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004184 }
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004185 /* else, mantissa is zero so this returns zero */
Laurence Lundbladec4537442020-04-14 18:53:22 -07004186
4187 *puResult = uResult;
4188
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004189 return QCBOR_SUCCESS;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004190}
4191
4192
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004193// The exponentiator that works on only positive numbers
Laurence Lundblade93d89472020-10-03 22:30:50 -07004194static QCBORError
4195Exponentitate2(uint64_t uMantissa, int64_t nExponent, uint64_t *puResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004196{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004197 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004198
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004199 uResult = uMantissa;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004200
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004201 /* This loop will run a maximum of 64 times because
Laurence Lundbladee6430642020-03-14 21:15:44 -07004202 * INT64_MAX < 2^31. More than that will cause
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004203 * exit with the overflow error
Laurence Lundbladee6430642020-03-14 21:15:44 -07004204 */
4205 while(nExponent > 0) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004206 if(uResult > UINT64_MAX >> 1) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004207 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Error overflow
Laurence Lundbladee6430642020-03-14 21:15:44 -07004208 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004209 uResult = uResult << 1;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004210 nExponent--;
4211 }
4212
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004213 while(nExponent < 0 ) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004214 if(uResult == 0) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004215 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW; // Underflow error
4216 }
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004217 uResult = uResult >> 1;
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004218 nExponent++;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004219 }
4220
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004221 *puResult = uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004222
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004223 return QCBOR_SUCCESS;
4224}
4225
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004226
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004227/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004228 Compute value with signed mantissa and signed result. Works with
4229 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004230 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004231static inline QCBORError ExponentiateNN(int64_t nMantissa,
4232 int64_t nExponent,
4233 int64_t *pnResult,
4234 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004235{
4236 uint64_t uResult;
4237
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004238 // Take the absolute value of the mantissa and convert to unsigned.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004239 // Improvement: this should be possible in one instruction
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004240 uint64_t uMantissa = nMantissa > 0 ? (uint64_t)nMantissa : (uint64_t)-nMantissa;
4241
4242 // Do the exponentiation of the positive mantissa
4243 QCBORError uReturn = (*pfExp)(uMantissa, nExponent, &uResult);
4244 if(uReturn) {
4245 return uReturn;
4246 }
4247
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004248
Laurence Lundblade983500d2020-05-14 11:49:34 -07004249 /* (uint64_t)INT64_MAX+1 is used to represent the absolute value
4250 of INT64_MIN. This assumes two's compliment representation where
4251 INT64_MIN is one increment farther from 0 than INT64_MAX.
4252 Trying to write -INT64_MIN doesn't work to get this because the
4253 compiler tries to work with an int64_t which can't represent
4254 -INT64_MIN.
4255 */
4256 uint64_t uMax = nMantissa > 0 ? INT64_MAX : (uint64_t)INT64_MAX+1;
4257
4258 // Error out if too large
4259 if(uResult > uMax) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004260 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4261 }
4262
4263 // Casts are safe because of checks above
4264 *pnResult = nMantissa > 0 ? (int64_t)uResult : -(int64_t)uResult;
4265
4266 return QCBOR_SUCCESS;
4267}
4268
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004269
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004270/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004271 Compute value with signed mantissa and unsigned result. Works with
4272 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004273 */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004274static inline QCBORError ExponentitateNU(int64_t nMantissa,
4275 int64_t nExponent,
4276 uint64_t *puResult,
4277 fExponentiator pfExp)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004278{
4279 if(nMantissa < 0) {
4280 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4281 }
4282
4283 // Cast to unsigned is OK because of check for negative
4284 // Cast to unsigned is OK because UINT64_MAX > INT64_MAX
4285 // Exponentiation is straight forward
4286 return (*pfExp)((uint64_t)nMantissa, nExponent, puResult);
4287}
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004288
4289
4290/*
Laurence Lundblade93d89472020-10-03 22:30:50 -07004291 Compute value with signed mantissa and unsigned result. Works with
4292 exponent of 2 or 10 based on exponentiator.
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004293 */
4294static inline QCBORError ExponentitateUU(uint64_t uMantissa,
4295 int64_t nExponent,
4296 uint64_t *puResult,
4297 fExponentiator pfExp)
4298{
4299 return (*pfExp)(uMantissa, nExponent, puResult);
4300}
4301
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004302#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004303
4304
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004305
4306
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004307
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07004308static QCBORError ConvertBigNumToUnsigned(const UsefulBufC BigNum, uint64_t uMax, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004309{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004310 uint64_t uResult;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004311
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004312 uResult = 0;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004313 const uint8_t *pByte = BigNum.ptr;
4314 size_t uLen = BigNum.len;
4315 while(uLen--) {
Laurence Lundblade313b2862020-05-16 01:23:06 -07004316 if(uResult > (uMax >> 8)) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004317 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004318 }
Laurence Lundblade313b2862020-05-16 01:23:06 -07004319 uResult = (uResult << 8) + *pByte++;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004320 }
4321
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004322 *pResult = uResult;
4323 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004324}
4325
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004326
Laurence Lundblade887add82020-05-17 05:50:34 -07004327static inline QCBORError ConvertPositiveBigNumToUnsigned(const UsefulBufC BigNum, uint64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004328{
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004329 return ConvertBigNumToUnsigned(BigNum, UINT64_MAX, pResult);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004330}
4331
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004332
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004333static inline QCBORError ConvertPositiveBigNumToSigned(const UsefulBufC BigNum, int64_t *pResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004334{
4335 uint64_t uResult;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004336 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
4337 if(uError) {
4338 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004339 }
4340 /* Cast is safe because ConvertBigNum is told to limit to INT64_MAX */
4341 *pResult = (int64_t)uResult;
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004342 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004343}
4344
4345
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004346static inline QCBORError ConvertNegativeBigNumToSigned(const UsefulBufC BigNum, int64_t *pnResult)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004347{
4348 uint64_t uResult;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004349 /* The negative integer furthest from zero for a C int64_t is
4350 INT64_MIN which is expressed as -INT64_MAX - 1. The value of a
4351 negative number in CBOR is computed as -n - 1 where n is the
4352 encoded integer, where n is what is in the variable BigNum. When
4353 converting BigNum to a uint64_t, the maximum value is thus
4354 INT64_MAX, so that when it -n - 1 is applied to it the result will
4355 never be further from 0 than INT64_MIN.
Laurence Lundbladeda095972020-06-06 18:35:33 -07004356
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004357 -n - 1 <= INT64_MIN.
4358 -n - 1 <= -INT64_MAX - 1
4359 n <= INT64_MAX.
4360 */
Laurence Lundbladeda095972020-06-06 18:35:33 -07004361 QCBORError uError = ConvertBigNumToUnsigned(BigNum, INT64_MAX, &uResult);
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004362 if(uError != QCBOR_SUCCESS) {
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004363 return uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004364 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004365
4366 /// Now apply -n - 1. The cast is safe because
4367 // ConvertBigNumToUnsigned() is limited to INT64_MAX which does fit
4368 // is the largest positive integer that an int64_t can
4369 // represent. */
4370 *pnResult = -(int64_t)uResult - 1;
4371
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004372 return QCBOR_SUCCESS;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004373}
4374
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004375
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004376
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004377
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004378
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004379/*
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004380Convert integers and floats to an int64_t.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004381
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004382\param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004383
Laurence Lundblade93d89472020-10-03 22:30:50 -07004384\retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4385 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004386
4387\retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4388
Laurence Lundblade93d89472020-10-03 22:30:50 -07004389\retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4390 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004391*/
Laurence Lundblade93d89472020-10-03 22:30:50 -07004392static QCBORError
4393ConvertInt64(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004394{
4395 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004396 case QCBOR_TYPE_FLOAT:
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004397 case QCBOR_TYPE_DOUBLE:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004398#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004399 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004400 /* https://pubs.opengroup.org/onlinepubs/009695399/functions/llround.html
4401 http://www.cplusplus.com/reference/cmath/llround/
4402 */
4403 // Not interested in FE_INEXACT
4404 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004405 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4406 *pnValue = llround(pItem->val.dfnum);
4407 } else {
4408 *pnValue = lroundf(pItem->val.fnum);
4409 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004410 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4411 // llround() shouldn't result in divide by zero, but catch
4412 // it here in case it unexpectedly does. Don't try to
4413 // distinguish between the various exceptions because it seems
4414 // they vary by CPU, compiler and OS.
4415 return QCBOR_ERR_FLOAT_EXCEPTION;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004416 }
4417 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004418 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004419 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004420#else
4421 return QCBOR_ERR_HW_FLOAT_DISABLED;
4422#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004423 break;
4424
4425 case QCBOR_TYPE_INT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004426 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004427 *pnValue = pItem->val.int64;
4428 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004429 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004430 }
4431 break;
4432
4433 case QCBOR_TYPE_UINT64:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004434 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004435 if(pItem->val.uint64 < INT64_MAX) {
4436 *pnValue = pItem->val.int64;
4437 } else {
4438 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4439 }
4440 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004441 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004442 }
4443 break;
4444
4445 default:
4446 return QCBOR_ERR_UNEXPECTED_TYPE;
4447 }
4448 return QCBOR_SUCCESS;
4449}
4450
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004451
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004452void QCBORDecode_GetInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004453 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004454 int64_t *pnValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004455 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07004456{
Laurence Lundbladebf3c42d2020-04-14 19:08:51 -07004457 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07004458 return;
4459 }
4460
Laurence Lundbladee6430642020-03-14 21:15:44 -07004461 QCBORItem Item;
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004462 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4463 if(uError) {
4464 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004465 return;
4466 }
4467
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004468 if(pItem) {
4469 *pItem = Item;
4470 }
4471
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004472 pMe->uLastError = (uint8_t)ConvertInt64(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004473}
4474
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004475
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004476void QCBORDecode_GetInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
4477 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004478 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004479 int64_t *pnValue,
4480 QCBORItem *pItem)
4481{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004482 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004483 if(pMe->uLastError != QCBOR_SUCCESS) {
4484 return;
4485 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004486
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004487 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004488}
4489
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004490
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004491void QCBORDecode_GetInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
4492 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004493 uint32_t uConvertTypes,
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004494 int64_t *pnValue,
4495 QCBORItem *pItem)
4496{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004497 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004498 if(pMe->uLastError != QCBOR_SUCCESS) {
4499 return;
4500 }
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004501
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004502 pMe->uLastError = (uint8_t)ConvertInt64(pItem, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004503}
4504
4505
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004506/*
4507 Convert a large variety of integer types to an int64_t.
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004508
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004509 \param[in] uConvertTypes Bit mask list of conversion options.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004510
Laurence Lundblade93d89472020-10-03 22:30:50 -07004511 \retval QCBOR_ERR_UNEXPECTED_TYPE Conversion, possible, but not requested
4512 in uConvertTypes.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004513
4514 \retval QCBOR_ERR_UNEXPECTED_TYPE Of a type that can't be converted
4515
Laurence Lundblade93d89472020-10-03 22:30:50 -07004516 \retval QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW Conversion result is too large
4517 or too small.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004518 */
Laurence Lundblade93d89472020-10-03 22:30:50 -07004519static QCBORError
4520Int64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004521{
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004522 switch(pItem->uDataType) {
4523
4524 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004525 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004526 return ConvertPositiveBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004527 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004528 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004529 }
4530 break;
4531
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004532 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004533 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004534 return ConvertNegativeBigNumToSigned(pItem->val.bigNum, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004535 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004536 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004537 }
4538 break;
4539
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004540#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004541 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004542 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004543 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004544 pItem->val.expAndMantissa.nExponent,
4545 pnValue,
4546 &Exponentitate10);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004547 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004548 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004549 }
4550 break;
4551
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004552 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004553 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004554 return ExponentiateNN(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004555 pItem->val.expAndMantissa.nExponent,
4556 pnValue,
4557 Exponentitate2);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004558 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004559 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004560 }
4561 break;
4562
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004563 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004564 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004565 int64_t nMantissa;
4566 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004567 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4568 if(uErr) {
4569 return uErr;
4570 }
4571 return ExponentiateNN(nMantissa,
4572 pItem->val.expAndMantissa.nExponent,
4573 pnValue,
4574 Exponentitate10);
4575 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004576 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004577 }
4578 break;
4579
4580 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004581 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004582 int64_t nMantissa;
4583 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004584 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4585 if(uErr) {
4586 return uErr;
4587 }
4588 return ExponentiateNN(nMantissa,
4589 pItem->val.expAndMantissa.nExponent,
4590 pnValue,
4591 Exponentitate10);
4592 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004593 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004594 }
4595 break;
4596
4597 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004598 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004599 int64_t nMantissa;
4600 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004601 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4602 if(uErr) {
4603 return uErr;
4604 }
4605 return ExponentiateNN(nMantissa,
4606 pItem->val.expAndMantissa.nExponent,
4607 pnValue,
4608 Exponentitate2);
4609 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004610 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004611 }
4612 break;
4613
4614 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004615 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004616 int64_t nMantissa;
4617 QCBORError uErr;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004618 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, &nMantissa);
4619 if(uErr) {
4620 return uErr;
4621 }
4622 return ExponentiateNN(nMantissa,
4623 pItem->val.expAndMantissa.nExponent,
4624 pnValue,
4625 Exponentitate2);
4626 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004627 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladee6430642020-03-14 21:15:44 -07004628 }
4629 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004630#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004631
Laurence Lundbladee6430642020-03-14 21:15:44 -07004632
Laurence Lundbladec4537442020-04-14 18:53:22 -07004633 default:
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07004634 return QCBOR_ERR_UNEXPECTED_TYPE; }
Laurence Lundbladec4537442020-04-14 18:53:22 -07004635}
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004636
4637
Laurence Lundbladec4537442020-04-14 18:53:22 -07004638/*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004639 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004640 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004641void QCBORDecode_GetInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, int64_t *pnValue)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004642{
4643 QCBORItem Item;
4644
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004645 QCBORDecode_GetInt64ConvertInternal(pMe, uConvertTypes, pnValue, &Item);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004646
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004647 if(pMe->uLastError == QCBOR_SUCCESS) {
4648 // The above conversion succeeded
4649 return;
4650 }
4651
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004652 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004653 // The above conversion failed in a way that code below can't correct
Laurence Lundbladec4537442020-04-14 18:53:22 -07004654 return;
4655 }
4656
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004657 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004658}
4659
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004660
4661/*
4662Public function, see header qcbor/qcbor_decode.h file
4663*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004664void QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
4665 int64_t nLabel,
4666 uint32_t uConvertTypes,
4667 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004668{
4669 QCBORItem Item;
4670
Laurence Lundblade93d89472020-10-03 22:30:50 -07004671 QCBORDecode_GetInt64ConvertInternalInMapN(pMe,
4672 nLabel,
4673 uConvertTypes,
4674 pnValue,
4675 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004676
4677 if(pMe->uLastError == QCBOR_SUCCESS) {
4678 // The above conversion succeeded
4679 return;
4680 }
4681
4682 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4683 // The above conversion failed in a way that code below can't correct
4684 return;
4685 }
4686
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004687 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004688}
4689
4690
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004691/*
4692Public function, see header qcbor/qcbor_decode.h file
4693*/
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004694void QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
4695 const char *szLabel,
4696 uint32_t uConvertTypes,
4697 int64_t *pnValue)
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004698{
4699 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07004700 QCBORDecode_GetInt64ConvertInternalInMapSZ(pMe,
4701 szLabel,
4702 uConvertTypes,
4703 pnValue,
4704 &Item);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004705
4706 if(pMe->uLastError == QCBOR_SUCCESS) {
4707 // The above conversion succeeded
4708 return;
4709 }
4710
4711 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4712 // The above conversion failed in a way that code below can't correct
4713 return;
4714 }
4715
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004716 pMe->uLastError = (uint8_t)Int64ConvertAll(&Item, uConvertTypes, pnValue);
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004717}
4718
4719
Laurence Lundblade93d89472020-10-03 22:30:50 -07004720static QCBORError ConvertUInt64(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004721{
4722 switch(pItem->uDataType) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004723 case QCBOR_TYPE_DOUBLE:
4724 case QCBOR_TYPE_FLOAT:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004725#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004726 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004727 // Can't use llround here because it will not convert values
4728 // greater than INT64_MAX and less than UINT64_MAX that
4729 // need to be converted so it is more complicated.
4730 feclearexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO);
4731 if(pItem->uDataType == QCBOR_TYPE_DOUBLE) {
4732 if(isnan(pItem->val.dfnum)) {
4733 return QCBOR_ERR_FLOAT_EXCEPTION;
4734 } else if(pItem->val.dfnum < 0) {
4735 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4736 } else {
4737 double dRounded = round(pItem->val.dfnum);
4738 // See discussion in DecodeDateEpoch() for
4739 // explanation of - 0x7ff
4740 if(dRounded > (double)(UINT64_MAX- 0x7ff)) {
4741 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4742 }
4743 *puValue = (uint64_t)dRounded;
4744 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004745 } else {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004746 if(isnan(pItem->val.fnum)) {
4747 return QCBOR_ERR_FLOAT_EXCEPTION;
4748 } else if(pItem->val.fnum < 0) {
4749 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4750 } else {
4751 float fRounded = roundf(pItem->val.fnum);
4752 // See discussion in DecodeDateEpoch() for
4753 // explanation of - 0x7ff
4754 if(fRounded > (float)(UINT64_MAX- 0x7ff)) {
4755 return QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW;
4756 }
4757 *puValue = (uint64_t)fRounded;
4758 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004759 }
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07004760 if(fetestexcept(FE_INVALID|FE_OVERFLOW|FE_UNDERFLOW|FE_DIVBYZERO)) {
4761 // round() and roundf() shouldn't result in exceptions here, but
4762 // catch them to be robust and thorough. Don't try to
4763 // distinguish between the various exceptions because it seems
4764 // they vary by CPU, compiler and OS.
4765 return QCBOR_ERR_FLOAT_EXCEPTION;
4766 }
4767
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004768 } else {
4769 return QCBOR_ERR_UNEXPECTED_TYPE;
4770 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004771#else
4772 return QCBOR_ERR_HW_FLOAT_DISABLED;
4773#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004774 break;
Laurence Lundblade843a10c2020-05-23 13:57:00 -07004775
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004776 case QCBOR_TYPE_INT64:
4777 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4778 if(pItem->val.int64 >= 0) {
4779 *puValue = (uint64_t)pItem->val.int64;
4780 } else {
4781 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4782 }
4783 } else {
4784 return QCBOR_ERR_UNEXPECTED_TYPE;
4785 }
4786 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004787
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004788 case QCBOR_TYPE_UINT64:
4789 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
4790 *puValue = pItem->val.uint64;
4791 } else {
4792 return QCBOR_ERR_UNEXPECTED_TYPE;
4793 }
4794 break;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004795
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004796 default:
4797 return QCBOR_ERR_UNEXPECTED_TYPE;
4798 }
4799
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004800 return QCBOR_SUCCESS;
4801}
Laurence Lundbladec4537442020-04-14 18:53:22 -07004802
4803
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004804void QCBORDecode_GetUInt64ConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004805 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004806 uint64_t *puValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004807 QCBORItem *pItem)
Laurence Lundbladec4537442020-04-14 18:53:22 -07004808{
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004809 if(pMe->uLastError != QCBOR_SUCCESS) {
4810 return;
4811 }
4812
Laurence Lundbladec4537442020-04-14 18:53:22 -07004813 QCBORItem Item;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004814
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07004815 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
4816 if(uError) {
4817 pMe->uLastError = (uint8_t)uError;
Laurence Lundbladec4537442020-04-14 18:53:22 -07004818 return;
4819 }
4820
Laurence Lundbladea826c502020-05-10 21:07:00 -07004821 if(pItem) {
4822 *pItem = Item;
4823 }
4824
Laurence Lundblade93d89472020-10-03 22:30:50 -07004825 pMe->uLastError = (uint8_t)ConvertUInt64(&Item, uConvertTypes, puValue);
Laurence Lundbladec4537442020-04-14 18:53:22 -07004826}
4827
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004828
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004829void QCBORDecode_GetUInt64ConvertInternalInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004830 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004831 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004832 uint64_t *puValue,
4833 QCBORItem *pItem)
4834{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004835 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004836 if(pMe->uLastError != QCBOR_SUCCESS) {
4837 return;
4838 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004839
Laurence Lundblade93d89472020-10-03 22:30:50 -07004840 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004841}
4842
4843
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07004844void QCBORDecode_GetUInt64ConvertInternalInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004845 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004846 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004847 uint64_t *puValue,
4848 QCBORItem *pItem)
4849{
4850 if(pMe->uLastError != QCBOR_SUCCESS) {
4851 return;
4852 }
4853
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07004854 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07004855 if(pMe->uLastError != QCBOR_SUCCESS) {
4856 return;
4857 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004858
Laurence Lundblade93d89472020-10-03 22:30:50 -07004859 pMe->uLastError = (uint8_t)ConvertUInt64(pItem, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004860}
4861
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004862
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004863
Laurence Lundblade93d89472020-10-03 22:30:50 -07004864static QCBORError
4865UInt64ConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004866{
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004867 switch(pItem->uDataType) {
4868
4869 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004870 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004871 return ConvertPositiveBigNumToUnsigned(pItem->val.bigNum, puValue);
4872 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004873 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004874 }
4875 break;
4876
4877 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004878 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004879 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4880 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004881 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004882 }
4883 break;
4884
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004885#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004886
4887 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004888 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004889 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004890 pItem->val.expAndMantissa.nExponent,
4891 puValue,
4892 Exponentitate10);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004893 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004894 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004895 }
4896 break;
4897
4898 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004899 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004900 return ExponentitateNU(pItem->val.expAndMantissa.Mantissa.nInt,
4901 pItem->val.expAndMantissa.nExponent,
4902 puValue,
4903 Exponentitate2);
4904 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004905 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004906 }
4907 break;
4908
4909 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004910 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004911 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004912 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004913 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004914 if(uErr != QCBOR_SUCCESS) {
4915 return uErr;
4916 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004917 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004918 pItem->val.expAndMantissa.nExponent,
4919 puValue,
4920 Exponentitate10);
4921 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004922 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004923 }
4924 break;
4925
4926 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004927 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004928 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4929 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004930 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004931 }
4932 break;
4933
4934 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004935 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004936 uint64_t uMantissa;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07004937 QCBORError uErr;
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004938 uErr = ConvertPositiveBigNumToUnsigned(pItem->val.expAndMantissa.Mantissa.bigNum, &uMantissa);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004939 if(uErr != QCBOR_SUCCESS) {
4940 return uErr;
4941 }
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004942 return ExponentitateUU(uMantissa,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004943 pItem->val.expAndMantissa.nExponent,
4944 puValue,
4945 Exponentitate2);
4946 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004947 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004948 }
4949 break;
4950
4951 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004952 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004953 return QCBOR_ERR_NUMBER_SIGN_CONVERSION;
4954 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004955 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004956 }
4957 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07004958#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004959 default:
4960 return QCBOR_ERR_UNEXPECTED_TYPE;
4961 }
4962}
4963
Laurence Lundblade784b54b2020-08-10 01:24:52 -07004964
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004965/*
4966 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07004967 */
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004968void QCBORDecode_GetUInt64ConvertAll(QCBORDecodeContext *pMe, uint32_t uConvertTypes, uint64_t *puValue)
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004969{
4970 QCBORItem Item;
4971
Laurence Lundblade78f7b932020-07-28 20:02:25 -07004972 QCBORDecode_GetUInt64ConvertInternal(pMe, uConvertTypes, puValue, &Item);
Laurence Lundblade9c905e82020-04-25 11:31:38 -07004973
Laurence Lundbladef6c86662020-05-12 02:08:00 -07004974 if(pMe->uLastError == QCBOR_SUCCESS) {
4975 // The above conversion succeeded
4976 return;
4977 }
4978
4979 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
4980 // The above conversion failed in a way that code below can't correct
Laurence Lundbladee6430642020-03-14 21:15:44 -07004981 return;
4982 }
4983
Laurence Lundblade93d89472020-10-03 22:30:50 -07004984 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07004985}
4986
Laurence Lundbladec4537442020-04-14 18:53:22 -07004987
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004988/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07004989 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004990*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07004991void QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07004992 int64_t nLabel,
4993 uint32_t uConvertTypes,
4994 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07004995{
4996 QCBORItem Item;
4997
Laurence Lundblade93d89472020-10-03 22:30:50 -07004998 QCBORDecode_GetUInt64ConvertInternalInMapN(pMe,
4999 nLabel,
5000 uConvertTypes,
5001 puValue,
5002 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005003
5004 if(pMe->uLastError == QCBOR_SUCCESS) {
5005 // The above conversion succeeded
5006 return;
5007 }
5008
5009 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5010 // The above conversion failed in a way that code below can't correct
5011 return;
5012 }
5013
Laurence Lundblade93d89472020-10-03 22:30:50 -07005014 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005015}
5016
5017
5018/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005019 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005020*/
Laurence Lundblade95b64bb2020-08-30 00:17:38 -07005021void QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundblade9b334962020-08-27 10:55:53 -07005022 const char *szLabel,
5023 uint32_t uConvertTypes,
5024 uint64_t *puValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005025{
5026 QCBORItem Item;
Laurence Lundblade93d89472020-10-03 22:30:50 -07005027 QCBORDecode_GetUInt64ConvertInternalInMapSZ(pMe,
5028 szLabel,
5029 uConvertTypes,
5030 puValue,
5031 &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005032
5033 if(pMe->uLastError == QCBOR_SUCCESS) {
5034 // The above conversion succeeded
5035 return;
5036 }
5037
5038 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5039 // The above conversion failed in a way that code below can't correct
5040 return;
5041 }
5042
Laurence Lundblade93d89472020-10-03 22:30:50 -07005043 pMe->uLastError = (uint8_t)UInt64ConvertAll(&Item, uConvertTypes, puValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005044}
5045
5046
Laurence Lundbladef7a70bc2020-10-24 12:23:25 -07005047
5048
Laurence Lundblade9b334962020-08-27 10:55:53 -07005049static QCBORError ConvertDouble(const QCBORItem *pItem,
5050 uint32_t uConvertTypes,
5051 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005052{
5053 switch(pItem->uDataType) {
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005054 case QCBOR_TYPE_FLOAT:
5055#ifndef QCBOR_DISABLE_FLOAT_HW_USE
5056 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5057 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005058 // Simple cast does the job.
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005059 *pdValue = (double)pItem->val.fnum;
5060 } else {
5061 return QCBOR_ERR_UNEXPECTED_TYPE;
5062 }
5063 }
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005064#else /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005065 return QCBOR_ERR_HW_FLOAT_DISABLED;
Laurence Lundbladee2c893c2020-12-26 17:41:53 -08005066#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005067 break;
5068
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005069 case QCBOR_TYPE_DOUBLE:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005070 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
5071 if(uConvertTypes & QCBOR_CONVERT_TYPE_FLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005072 *pdValue = pItem->val.dfnum;
5073 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005074 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005075 }
5076 }
5077 break;
5078
5079 case QCBOR_TYPE_INT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005080#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005081 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005082 // A simple cast seems to do the job with no worry of exceptions.
5083 // There will be precision loss for some values.
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005084 *pdValue = (double)pItem->val.int64;
5085
5086 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005087 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005088 }
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005089#else
5090 return QCBOR_ERR_HW_FLOAT_DISABLED;
5091#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005092 break;
5093
5094 case QCBOR_TYPE_UINT64:
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005095#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005096 if(uConvertTypes & QCBOR_CONVERT_TYPE_XINT64) {
Laurence Lundbladedfd49fc2020-09-01 14:17:16 -07005097 // A simple cast seems to do the job with no worry of exceptions.
5098 // There will be precision loss for some values.
5099 *pdValue = (double)pItem->val.uint64;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005100 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005101 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005102 }
5103 break;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005104#else
5105 return QCBOR_ERR_HW_FLOAT_DISABLED;
5106#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005107
5108 default:
5109 return QCBOR_ERR_UNEXPECTED_TYPE;
5110 }
5111
5112 return QCBOR_SUCCESS;
5113}
5114
5115
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005116void QCBORDecode_GetDoubleConvertInternal(QCBORDecodeContext *pMe,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005117 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005118 double *pdValue,
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005119 QCBORItem *pItem)
Laurence Lundbladee6430642020-03-14 21:15:44 -07005120{
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005121 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundbladec4537442020-04-14 18:53:22 -07005122 return;
5123 }
5124
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005125 QCBORItem Item;
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005126
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005127 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005128 if(uError) {
5129 pMe->uLastError = (uint8_t)uError;
5130 return;
5131 }
5132
5133 if(pItem) {
5134 *pItem = Item;
5135 }
Laurence Lundbladec4537442020-04-14 18:53:22 -07005136
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005137 pMe->uLastError = (uint8_t)ConvertDouble(&Item, uConvertTypes, pdValue);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005138}
Laurence Lundbladec4537442020-04-14 18:53:22 -07005139
Laurence Lundbladec4537442020-04-14 18:53:22 -07005140
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005141void QCBORDecode_GetDoubleConvertInternalInMapN(QCBORDecodeContext *pMe,
5142 int64_t nLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005143 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005144 double *pdValue,
5145 QCBORItem *pItem)
5146{
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005147 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005148 if(pMe->uLastError != QCBOR_SUCCESS) {
5149 return;
5150 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005151
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005152 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005153}
5154
Laurence Lundblade784b54b2020-08-10 01:24:52 -07005155
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005156void QCBORDecode_GetDoubleConvertInternalInMapSZ(QCBORDecodeContext *pMe,
5157 const char * szLabel,
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005158 uint32_t uConvertTypes,
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005159 double *pdValue,
5160 QCBORItem *pItem)
5161{
5162 if(pMe->uLastError != QCBOR_SUCCESS) {
5163 return;
5164 }
5165
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005166 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, pItem);
Laurence Lundbladeabf5c572020-06-29 21:21:29 -07005167 if(pMe->uLastError != QCBOR_SUCCESS) {
5168 return;
5169 }
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005170
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005171 pMe->uLastError = (uint8_t)ConvertDouble(pItem, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005172}
5173
5174
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005175#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005176static double ConvertBigNumToDouble(const UsefulBufC BigNum)
5177{
5178 double dResult;
5179
5180 dResult = 0.0;
5181 const uint8_t *pByte = BigNum.ptr;
5182 size_t uLen = BigNum.len;
5183 /* This will overflow and become the float value INFINITY if the number
Laurence Lundblade11fd78b2020-09-01 22:13:27 -07005184 is too large to fit. */
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005185 while(uLen--) {
5186 dResult = (dResult * 256.0) + (double)*pByte++;
5187 }
5188
5189 return dResult;
5190}
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005191#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5192
Laurence Lundblade9ab5abb2020-05-20 12:10:45 -07005193
Laurence Lundblade93d89472020-10-03 22:30:50 -07005194static QCBORError
5195DoubleConvertAll(const QCBORItem *pItem, uint32_t uConvertTypes, double *pdValue)
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005196{
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005197#ifndef QCBOR_DISABLE_FLOAT_HW_USE
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005198 /*
Laurence Lundblade54cd99c2020-05-15 02:25:32 -07005199 https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
5200
5201 */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005202 switch(pItem->uDataType) {
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005203
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005204#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005205 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005206 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005207 // Underflow gives 0, overflow gives infinity
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005208 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5209 pow(10.0, (double)pItem->val.expAndMantissa.nExponent);
5210 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005211 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005212 }
5213 break;
5214
5215 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005216 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT ) {
Laurence Lundblade51722fd2020-09-02 13:01:33 -07005217 // Underflow gives 0, overflow gives infinity
5218 *pdValue = (double)pItem->val.expAndMantissa.Mantissa.nInt *
5219 exp2((double)pItem->val.expAndMantissa.nExponent);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005220 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005221 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005222 }
5223 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005224#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005225
5226 case QCBOR_TYPE_POSBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005227 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005228 *pdValue = ConvertBigNumToDouble(pItem->val.bigNum);
5229 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005230 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005231 }
5232 break;
5233
5234 case QCBOR_TYPE_NEGBIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005235 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIG_NUM) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005236 *pdValue = -1-ConvertBigNumToDouble(pItem->val.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005237 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005238 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005239 }
5240 break;
5241
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005242#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005243 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005244 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005245 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5246 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5247 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005248 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005249 }
5250 break;
5251
5252 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005253 if(uConvertTypes & QCBOR_CONVERT_TYPE_DECIMAL_FRACTION) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005254 double dMantissa = -ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5255 *pdValue = dMantissa * pow(10, (double)pItem->val.expAndMantissa.nExponent);
5256 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005257 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005258 }
5259 break;
5260
5261 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005262 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005263 double dMantissa = ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
5264 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5265 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005266 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005267 }
5268 break;
5269
5270 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005271 if(uConvertTypes & QCBOR_CONVERT_TYPE_BIGFLOAT) {
Laurence Lundbladeda095972020-06-06 18:35:33 -07005272 double dMantissa = -1-ConvertBigNumToDouble(pItem->val.expAndMantissa.Mantissa.bigNum);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005273 *pdValue = dMantissa * exp2((double)pItem->val.expAndMantissa.nExponent);
5274 } else {
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005275 return QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005276 }
5277 break;
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005278#endif /* ndef QCBOR_DISABLE_EXP_AND_MANTISSA */
Laurence Lundblade410c7e02020-06-25 23:35:29 -07005279
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005280 default:
5281 return QCBOR_ERR_UNEXPECTED_TYPE;
5282 }
5283
5284 return QCBOR_SUCCESS;
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005285
5286#else
5287 (void)pItem;
5288 (void)uConvertTypes;
5289 (void)pdValue;
5290 return QCBOR_ERR_HW_FLOAT_DISABLED;
5291#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
5292
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005293}
5294
5295
5296/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005297 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005298*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005299void QCBORDecode_GetDoubleConvertAll(QCBORDecodeContext *pMe,
5300 uint32_t uConvertTypes,
5301 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005302{
5303
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005304 QCBORItem Item;
5305
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005306 QCBORDecode_GetDoubleConvertInternal(pMe, uConvertTypes, pdValue, &Item);
Laurence Lundbladeb340ba72020-05-14 11:41:10 -07005307
5308 if(pMe->uLastError == QCBOR_SUCCESS) {
5309 // The above conversion succeeded
5310 return;
5311 }
5312
5313 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5314 // The above conversion failed in a way that code below can't correct
5315 return;
5316 }
5317
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005318 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundbladee6430642020-03-14 21:15:44 -07005319}
5320
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005321
5322/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005323 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005324*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005325void QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pMe,
5326 int64_t nLabel,
5327 uint32_t uConvertTypes,
5328 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005329{
5330 QCBORItem Item;
5331
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005332 QCBORDecode_GetDoubleConvertInternalInMapN(pMe, nLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005333
5334 if(pMe->uLastError == QCBOR_SUCCESS) {
5335 // The above conversion succeeded
5336 return;
5337 }
5338
5339 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5340 // The above conversion failed in a way that code below can't correct
5341 return;
5342 }
5343
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005344 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005345}
5346
5347
5348/*
Laurence Lundblade4e2da002020-06-13 23:08:31 -07005349 Public function, see header qcbor/qcbor_decode.h file
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005350*/
Laurence Lundblade9b334962020-08-27 10:55:53 -07005351void QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pMe,
5352 const char *szLabel,
5353 uint32_t uConvertTypes,
5354 double *pdValue)
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005355{
5356 QCBORItem Item;
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005357 QCBORDecode_GetDoubleConvertInternalInMapSZ(pMe, szLabel, uConvertTypes, pdValue, &Item);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005358
5359 if(pMe->uLastError == QCBOR_SUCCESS) {
5360 // The above conversion succeeded
5361 return;
5362 }
5363
5364 if(pMe->uLastError != QCBOR_ERR_UNEXPECTED_TYPE) {
5365 // The above conversion failed in a way that code below can't correct
5366 return;
5367 }
5368
Laurence Lundblade78f7b932020-07-28 20:02:25 -07005369 pMe->uLastError = (uint8_t)DoubleConvertAll(&Item, uConvertTypes, pdValue);
Laurence Lundblade7e5be1d2020-05-24 21:17:28 -07005370}
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005371
5372
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005373
5374
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005375#ifndef QCBOR_DISABLE_EXP_AND_MANTISSA
Laurence Lundbladef7c0adb2020-08-08 20:20:58 -07005376static inline UsefulBufC ConvertIntToBigNum(uint64_t uInt, UsefulBuf Buffer)
5377{
5378 while((uInt & 0xff00000000000000UL) == 0) {
5379 uInt = uInt << 8;
5380 };
5381
5382 UsefulOutBuf UOB;
5383
5384 UsefulOutBuf_Init(&UOB, Buffer);
5385
5386 while(uInt) {
5387 const uint64_t xx = uInt & 0xff00000000000000UL;
5388 UsefulOutBuf_AppendByte(&UOB, (uint8_t)((uInt & 0xff00000000000000UL) >> 56));
5389 uInt = uInt << 8;
5390 (void)xx;
5391 }
5392
5393 return UsefulOutBuf_OutUBuf(&UOB);
5394}
5395
5396
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005397static QCBORError MantissaAndExponentTypeHandler(QCBORDecodeContext *pMe,
5398 TagSpecification TagSpec,
5399 QCBORItem *pItem)
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005400{
5401 QCBORError uErr;
5402 // Loops runs at most 1.5 times. Making it a loop saves object code.
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005403 while(1) {
Laurence Lundblade6f3f78e2020-08-31 13:09:14 -07005404 uErr = CheckTagRequirement(TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005405 if(uErr != QCBOR_SUCCESS) {
5406 goto Done;
5407 }
5408
5409 if(pItem->uDataType != QCBOR_TYPE_ARRAY) {
5410 break; // Successful exit. Moving on to finish decoding.
5411 }
5412
5413 // The item is an array, which means an undecoded
5414 // mantissa and exponent, so decode it. It will then
5415 // have a different type and exit the loop if.
5416 uErr = QCBORDecode_MantissaAndExponent(pMe, pItem);
5417 if(uErr != QCBOR_SUCCESS) {
5418 goto Done;
5419 }
5420
5421 // Second time around, the type must match.
Laurence Lundblade9b334962020-08-27 10:55:53 -07005422 TagSpec.uTagRequirement = QCBOR_TAG_REQUIREMENT_TAG;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005423 }
5424Done:
5425 return uErr;
5426}
5427
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005428
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005429static void ProcessMantissaAndExponent(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005430 TagSpecification TagSpec,
5431 QCBORItem *pItem,
5432 int64_t *pnMantissa,
5433 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005434{
5435 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005436
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005437 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005438 if(uErr != QCBOR_SUCCESS) {
5439 goto Done;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005440 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005441
Laurence Lundblade9b334962020-08-27 10:55:53 -07005442 switch (pItem->uDataType) {
5443
5444 case QCBOR_TYPE_DECIMAL_FRACTION:
5445 case QCBOR_TYPE_BIGFLOAT:
5446 *pnMantissa = pItem->val.expAndMantissa.Mantissa.nInt;
5447 *pnExponent = pItem->val.expAndMantissa.nExponent;
5448 break;
5449
5450 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
5451 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
5452 *pnExponent = pItem->val.expAndMantissa.nExponent;
5453 uErr = ConvertPositiveBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5454 break;
5455
5456 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
5457 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
5458 *pnExponent = pItem->val.expAndMantissa.nExponent;
5459 uErr = ConvertNegativeBigNumToSigned(pItem->val.expAndMantissa.Mantissa.bigNum, pnMantissa);
5460 break;
5461
5462 default:
5463 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
5464 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005465
5466 Done:
5467 pMe->uLastError = (uint8_t)uErr;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005468}
5469
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005470
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005471static void ProcessMantissaAndExponentBig(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005472 TagSpecification TagSpec,
5473 QCBORItem *pItem,
5474 UsefulBuf BufferForMantissa,
5475 UsefulBufC *pMantissa,
5476 bool *pbIsNegative,
5477 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005478{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005479 QCBORError uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005480
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005481 uErr = MantissaAndExponentTypeHandler(pMe, TagSpec, pItem);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005482 if(uErr != QCBOR_SUCCESS) {
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005483 goto Done;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005484 }
5485
5486 uint64_t uMantissa;
5487
5488 switch (pItem->uDataType) {
5489
5490 case QCBOR_TYPE_DECIMAL_FRACTION:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005491 case QCBOR_TYPE_BIGFLOAT:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005492 if(pItem->val.expAndMantissa.Mantissa.nInt >= 0) {
5493 uMantissa = (uint64_t)pItem->val.expAndMantissa.Mantissa.nInt;
5494 *pbIsNegative = false;
5495 } else {
5496 uMantissa = (uint64_t)-pItem->val.expAndMantissa.Mantissa.nInt;
5497 *pbIsNegative = true;
5498 }
5499 *pMantissa = ConvertIntToBigNum(uMantissa, BufferForMantissa);
5500 *pnExponent = pItem->val.expAndMantissa.nExponent;
5501 break;
5502
5503 case QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005504 case QCBOR_TYPE_BIGFLOAT_POS_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005505 *pnExponent = pItem->val.expAndMantissa.nExponent;
5506 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5507 *pbIsNegative = false;
5508 break;
5509
5510 case QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005511 case QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM:
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005512 *pnExponent = pItem->val.expAndMantissa.nExponent;
5513 *pMantissa = pItem->val.expAndMantissa.Mantissa.bigNum;
5514 *pbIsNegative = true;
5515 break;
5516
5517 default:
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005518 uErr = QCBOR_ERR_UNEXPECTED_TYPE;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005519 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005520
5521Done:
5522 pMe->uLastError = (uint8_t)uErr;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005523}
5524
5525
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005526/*
5527 Public function, see header qcbor/qcbor_decode.h file
5528*/
5529void QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pMe,
5530 uint8_t uTagRequirement,
5531 int64_t *pnMantissa,
5532 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005533{
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005534 if(pMe->uLastError != QCBOR_SUCCESS) {
5535 return;
5536 }
5537
5538 QCBORItem Item;
5539 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5540 if(uError) {
5541 pMe->uLastError = (uint8_t)uError;
5542 return;
5543 }
5544
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005545 const TagSpecification TagSpec =
5546 {
5547 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005548 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5549 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5550 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005551 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005552
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005553 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005554}
5555
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005556
5557/*
5558 Public function, see header qcbor/qcbor_decode.h file
5559*/
5560void QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005561 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005562 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005563 int64_t *pnMantissa,
5564 int64_t *pnExponent)
5565{
5566 if(pMe->uLastError != QCBOR_SUCCESS) {
5567 return;
5568 }
5569
5570 QCBORItem Item;
5571 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5572
5573 const TagSpecification TagSpec =
5574 {
5575 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005576 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5577 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5578 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005579 };
5580
5581 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5582}
5583
5584
5585/*
5586 Public function, see header qcbor/qcbor_decode.h file
5587*/
5588void QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005589 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005590 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005591 int64_t *pnMantissa,
5592 int64_t *pnExponent)
5593{
5594 if(pMe->uLastError != QCBOR_SUCCESS) {
5595 return;
5596 }
5597
5598 QCBORItem Item;
5599 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5600
5601 const TagSpecification TagSpec =
5602 {
5603 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005604 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5605 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5606 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005607 };
Laurence Lundblade9b334962020-08-27 10:55:53 -07005608
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005609 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5610}
5611
5612
5613/*
5614 Public function, see header qcbor/qcbor_decode.h file
5615*/
5616void QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pMe,
5617 uint8_t uTagRequirement,
5618 UsefulBuf MantissaBuffer,
5619 UsefulBufC *pMantissa,
5620 bool *pbMantissaIsNegative,
5621 int64_t *pnExponent)
5622{
5623 if(pMe->uLastError != QCBOR_SUCCESS) {
5624 return;
5625 }
5626
5627 QCBORItem Item;
5628 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5629 if(uError) {
5630 pMe->uLastError = (uint8_t)uError;
5631 return;
5632 }
5633
5634 const TagSpecification TagSpec =
5635 {
5636 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005637 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5638 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5639 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005640 };
5641
Laurence Lundblade93d89472020-10-03 22:30:50 -07005642 ProcessMantissaAndExponentBig(pMe,
5643 TagSpec,
5644 &Item,
5645 MantissaBuffer,
5646 pMantissa,
5647 pbMantissaIsNegative,
5648 pnExponent);
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005649}
5650
5651
5652/*
5653 Public function, see header qcbor/qcbor_decode.h file
5654*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005655void QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005656 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005657 uint8_t uTagRequirement,
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005658 UsefulBuf BufferForMantissa,
5659 UsefulBufC *pMantissa,
5660 bool *pbIsNegative,
5661 int64_t *pnExponent)
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005662{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005663 if(pMe->uLastError != QCBOR_SUCCESS) {
5664 return;
5665 }
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005666
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005667 QCBORItem Item;
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005668 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005669 if(pMe->uLastError != QCBOR_SUCCESS) {
5670 return;
5671 }
5672
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005673 const TagSpecification TagSpec =
5674 {
5675 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005676 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5677 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5678 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005679 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005680
Laurence Lundblade93d89472020-10-03 22:30:50 -07005681 ProcessMantissaAndExponentBig(pMe,
5682 TagSpec,
5683 &Item,
5684 BufferForMantissa,
5685 pMantissa,
5686 pbIsNegative,
5687 pnExponent);
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005688}
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005689
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005690
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005691/*
5692 Public function, see header qcbor/qcbor_decode.h file
5693*/
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005694void QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005695 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005696 uint8_t uTagRequirement,
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005697 UsefulBuf BufferForMantissa,
5698 UsefulBufC *pMantissa,
5699 bool *pbIsNegative,
5700 int64_t *pnExponent)
5701{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005702 if(pMe->uLastError != QCBOR_SUCCESS) {
5703 return;
5704 }
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005705
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005706 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005707 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5708 if(pMe->uLastError != QCBOR_SUCCESS) {
5709 return;
5710 }
5711
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005712 const TagSpecification TagSpec =
5713 {
5714 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005715 {QCBOR_TYPE_DECIMAL_FRACTION, QCBOR_TYPE_DECIMAL_FRACTION_POS_BIGNUM,
5716 QCBOR_TYPE_DECIMAL_FRACTION_NEG_BIGNUM, QCBOR_TYPE_NONE},
5717 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005718 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005719
5720 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, BufferForMantissa, pMantissa, pbIsNegative, pnExponent);
5721}
5722
5723
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005724/*
5725 Public function, see header qcbor/qcbor_decode.h file
5726*/
5727void QCBORDecode_GetBigFloat(QCBORDecodeContext *pMe,
5728 uint8_t uTagRequirement,
5729 int64_t *pnMantissa,
5730 int64_t *pnExponent)
5731{
5732 if(pMe->uLastError != QCBOR_SUCCESS) {
5733 return;
5734 }
5735
5736 QCBORItem Item;
5737 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5738 if(uError) {
5739 pMe->uLastError = (uint8_t)uError;
5740 return;
5741 }
5742 const TagSpecification TagSpec =
5743 {
5744 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005745 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5746 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5747 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005748 };
5749
5750 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5751}
5752
5753
5754/*
5755 Public function, see header qcbor/qcbor_decode.h file
5756*/
5757void QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005758 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005759 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005760 int64_t *pnMantissa,
5761 int64_t *pnExponent)
5762{
5763 if(pMe->uLastError != QCBOR_SUCCESS) {
5764 return;
5765 }
5766
5767 QCBORItem Item;
5768 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5769 if(pMe->uLastError != QCBOR_SUCCESS) {
5770 return;
5771 }
5772
5773 const TagSpecification TagSpec =
5774 {
5775 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005776 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5777 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5778 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005779 };
5780
5781 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5782}
5783
5784
5785/*
5786 Public function, see header qcbor/qcbor_decode.h file
5787*/
5788void QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005789 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005790 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005791 int64_t *pnMantissa,
5792 int64_t *pnExponent)
5793{
5794 if(pMe->uLastError != QCBOR_SUCCESS) {
5795 return;
5796 }
5797
5798 QCBORItem Item;
5799 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5800 if(pMe->uLastError != QCBOR_SUCCESS) {
5801 return;
5802 }
5803
5804 const TagSpecification TagSpec =
5805 {
5806 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005807 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5808 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5809 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005810 };
5811
5812 ProcessMantissaAndExponent(pMe, TagSpec, &Item, pnMantissa, pnExponent);
5813}
5814
5815
5816/*
5817 Public function, see header qcbor/qcbor_decode.h file
5818*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005819void QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pMe,
5820 uint8_t uTagRequirement,
5821 UsefulBuf MantissaBuffer,
5822 UsefulBufC *pMantissa,
5823 bool *pbMantissaIsNegative,
5824 int64_t *pnExponent)
5825{
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005826 if(pMe->uLastError != QCBOR_SUCCESS) {
5827 return;
5828 }
5829
5830 QCBORItem Item;
5831 QCBORError uError = QCBORDecode_GetNext(pMe, &Item);
5832 if(uError) {
5833 pMe->uLastError = (uint8_t)uError;
5834 return;
5835 }
5836
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005837 const TagSpecification TagSpec =
5838 {
5839 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005840 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5841 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5842 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005843 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005844
5845 ProcessMantissaAndExponentBig(pMe, TagSpec, &Item, MantissaBuffer, pMantissa, pbMantissaIsNegative, pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005846}
5847
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005848
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005849/*
5850 Public function, see header qcbor/qcbor_decode.h file
5851*/
5852void QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005853 int64_t nLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005854 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005855 UsefulBuf BufferForMantissa,
5856 UsefulBufC *pMantissa,
5857 bool *pbIsNegative,
5858 int64_t *pnExponent)
5859{
5860 if(pMe->uLastError != QCBOR_SUCCESS) {
5861 return;
5862 }
5863
5864 QCBORItem Item;
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005865 QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_ANY, &Item);
5866 if(pMe->uLastError != QCBOR_SUCCESS) {
5867 return;
5868 }
5869
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005870 const TagSpecification TagSpec =
5871 {
5872 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005873 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5874 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5875 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005876 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005877
Laurence Lundblade93d89472020-10-03 22:30:50 -07005878 ProcessMantissaAndExponentBig(pMe,
5879 TagSpec,
5880 &Item,
5881 BufferForMantissa,
5882 pMantissa,
5883 pbIsNegative,
5884 pnExponent);
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005885}
5886
5887
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005888/*
5889 Public function, see header qcbor/qcbor_decode.h file
5890*/
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005891void QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pMe,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005892 const char *szLabel,
Laurence Lundblade2f5e16d2020-08-04 20:35:23 -07005893 uint8_t uTagRequirement,
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005894 UsefulBuf BufferForMantissa,
5895 UsefulBufC *pMantissa,
5896 bool *pbIsNegative,
5897 int64_t *pnExponent)
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005898{
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005899 if(pMe->uLastError != QCBOR_SUCCESS) {
5900 return;
5901 }
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005902
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005903 QCBORItem Item;
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005904 QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_ANY, &Item);
5905 if(pMe->uLastError != QCBOR_SUCCESS) {
Laurence Lundblade3cd26eb2020-06-29 23:33:13 -07005906 return;
5907 }
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005908
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005909 const TagSpecification TagSpec =
5910 {
5911 uTagRequirement,
Laurence Lundbladec384d4e2020-10-07 09:46:10 -07005912 {QCBOR_TYPE_BIGFLOAT, QCBOR_TYPE_BIGFLOAT_POS_BIGNUM,
5913 QCBOR_TYPE_BIGFLOAT_NEG_BIGNUM, QCBOR_TYPE_NONE},
5914 {QCBOR_TYPE_ARRAY, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE, QCBOR_TYPE_NONE}
Laurence Lundbladefaec39f2020-08-02 21:53:53 -07005915 };
Laurence Lundbladeb3683da2020-08-02 17:44:54 -07005916
Laurence Lundblade93d89472020-10-03 22:30:50 -07005917 ProcessMantissaAndExponentBig(pMe,
5918 TagSpec,
5919 &Item,
5920 BufferForMantissa,
5921 pMantissa,
5922 pbIsNegative,
5923 pnExponent);
Laurence Lundblade91853ae2020-06-15 19:35:58 -07005924}
Laurence Lundbladed4cd7232020-07-03 19:30:48 -07005925
Laurence Lundbladedd6e76e2021-03-10 01:54:01 -07005926#endif /* QCBOR_DISABLE_EXP_AND_MANTISSA */