blob: 6f33b5e4f6807351b17a582cb8e5c64ac817a65f [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.
3 Copyright (c) 2018, Laurence Lundblade.
4 All rights reserved.
Laurence Lundblade624405d2018-09-18 20:10:47 -07005
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 Lundblade624405d2018-09-18 20:10:47 -070019
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 Lundblade624405d2018-09-18 20:10:47 -070031 ==============================================================================*/
32
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070033/*===================================================================================
34 FILE: qcbor_encode.c
35
36 DESCRIPTION: This file contains the implementation of QCBOR.
37
38 EDIT HISTORY FOR FILE:
39
40 This section contains comments describing changes made to the module.
41 Notice that changes are listed in reverse chronological order.
42
43 when who what, where, why
44 -------- ---- ---------------------------------------------------
Laurence Lundblade067035b2018-11-28 17:35:25 -080045 11/29/18 llundblade Rework to simpler handling of tags and labels.
46 11/9/18 llundblade Error codes are now enums.
47 11/1/18 llundblade Floating support.
48 10/31/18 llundblade Switch to one license that is almost BSD-3.
49 09/28/18 llundblade Added bstr wrapping feature for COSE implementation.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070050 02/05/18 llundbla Works on CPUs which require integer alignment.
51 Requires new version of UsefulBuf.
52 07/05/17 llundbla Add bstr wrapping of maps/arrays for COSE
53 03/01/17 llundbla More data types
54 11/13/16 llundbla Integrate most TZ changes back into github version.
55 09/30/16 gkanike Porting to TZ.
56 03/15/16 llundbla Initial Version.
57
58 =====================================================================================*/
59
60#include "qcbor.h"
Laurence Lundblade12d32c52018-09-19 11:25:27 -070061#include "ieee754.h"
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070062
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070063
64/*...... This is a ruler that is 80 characters long...........................*/
65
66
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070067/*
68 CBOR's two nesting types, arrays and maps, are tracked here. There is a
69 limit of QCBOR_MAX_ARRAY_NESTING to the number of arrays and maps
70 that can be nested in one encoding so the encoding context stays
71 small enough to fit on the stack.
72
73 When an array / map is opened, pCurrentNesting points to the element
74 in pArrays that records the type, start position and accumluates a
75 count of the number of items added. When closed the start position is
76 used to go back and fill in the type and number of items in the array
77 / map.
78
79 Encoded output be just items like ints and strings that are
80 not part of any array / map. That is, the first thing encoded
81 does not have to be an array or a map.
82 */
83inline static void Nesting_Init(QCBORTrackNesting *pNesting)
84{
85 // assumes pNesting has been zeroed
86 pNesting->pCurrentNesting = &pNesting->pArrays[0];
87 // Implied CBOR array at the top nesting level. This is never returned,
88 // but makes the item count work correctly.
89 pNesting->pCurrentNesting->uMajorType = CBOR_MAJOR_TYPE_ARRAY;
90}
91
Laurence Lundblade30816f22018-11-10 13:40:22 +070092inline static QCBORError Nesting_Increase(QCBORTrackNesting *pNesting, uint8_t uMajorType, uint32_t uPos)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070093{
Laurence Lundblade30816f22018-11-10 13:40:22 +070094 QCBORError nReturn = QCBOR_SUCCESS;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -070095
96 if(pNesting->pCurrentNesting == &pNesting->pArrays[QCBOR_MAX_ARRAY_NESTING]) {
97 // trying to open one too many
98 nReturn = QCBOR_ERR_ARRAY_NESTING_TOO_DEEP;
99 } else {
100 pNesting->pCurrentNesting++;
101 pNesting->pCurrentNesting->uCount = 0;
102 pNesting->pCurrentNesting->uStart = uPos;
103 pNesting->pCurrentNesting->uMajorType = uMajorType;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700104 }
105 return nReturn;
106}
107
108inline static void Nesting_Decrease(QCBORTrackNesting *pNesting)
109{
110 pNesting->pCurrentNesting--;
111}
112
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800113inline static QCBORError Nesting_Increment(QCBORTrackNesting *pNesting)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700114{
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800115 if(1 >= QCBOR_MAX_ITEMS_IN_ARRAY - pNesting->pCurrentNesting->uCount) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700116 return QCBOR_ERR_ARRAY_TOO_LONG;
117 }
118
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800119 pNesting->pCurrentNesting->uCount += 1;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700120 return QCBOR_SUCCESS;
121}
122
123inline static uint16_t Nesting_GetCount(QCBORTrackNesting *pNesting)
124{
125 // The nesting count recorded is always the actual number of individiual
126 // data items in the array or map. For arrays CBOR uses the actual item
127 // count. For maps, CBOR uses the number of pairs. This function returns
128 // the number needed for the CBOR encoding, so it divides the number of
129 // items by two for maps to get the number of pairs. This implementation
130 // takes advantage of the map major type being one larger the array major
131 // type, hence the subtraction returns either 1 or 2.
132 return pNesting->pCurrentNesting->uCount / (pNesting->pCurrentNesting->uMajorType - CBOR_MAJOR_TYPE_ARRAY+1);
133}
134
135inline static uint32_t Nesting_GetStartPos(QCBORTrackNesting *pNesting)
136{
137 return pNesting->pCurrentNesting->uStart;
138}
139
140inline static uint8_t Nesting_GetMajorType(QCBORTrackNesting *pNesting)
141{
142 return pNesting->pCurrentNesting->uMajorType;
143}
144
145inline static int Nesting_IsInNest(QCBORTrackNesting *pNesting)
146{
147 return pNesting->pCurrentNesting == &pNesting->pArrays[0] ? 0 : 1;
148}
149
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700150
151
152
153/*
154 Error tracking plan -- Errors are tracked internally and not returned
155 until Finish is called. The CBOR errors are in me->uError.
Laurence Lundblade067035b2018-11-28 17:35:25 -0800156 UsefulOutBuf also tracks whether the buffer is full or not in its
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700157 context. Once either of these errors is set they are never
158 cleared. Only Init() resets them. Or said another way, they must
159 never be cleared or we'll tell the caller all is good when it is not.
160
161 Only one error code is reported by Finish() even if there are
162 multiple errors. The last one set wins. The caller might have to fix
163 one error to reveal the next one they have to fix. This is OK.
164
165 The buffer full error tracked by UsefulBuf is only pulled out of
166 UsefulBuf in Finish() so it is the one that usually wins. UsefulBuf
167 will never go off the end of the buffer even if it is called again
168 and again when full.
169
170 It is really tempting to not check for overflow on the count in the
171 number of items in an array. It would save a lot of code, it is
172 extremely unlikely that any one will every put 65,000 items in an
173 array, and the only bad thing that would happen is the CBOR would be
174 bogus. Once we prove that is the only consequence, then we can make
175 the change.
176
177 Since this does not parse any input, you could in theory remove all
178 error checks in this code if you knew the caller called it
179 correctly. Maybe someday CDDL or some such language will be able to
180 generate the code to call this and the calling code would always be
Laurence Lundblade56230d12018-11-01 11:14:51 +0700181 correct. This could also automatically size some of the data
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700182 structures like array/map nesting resulting in some good memory
183 savings.
Laurence Lundblade067035b2018-11-28 17:35:25 -0800184
185 Errors returned here fall into three categories:
186
187 Sizes
188 QCBOR_ERR_BUFFER_TOO_LARGE -- A buffer passed in > UINT32_MAX
189 QCBOR_ERR_BUFFER_TOO_SMALL -- output buffer too small
190
191 QCBOR_ERR_ARRAY_NESTING_TOO_DEEP -- Too many opens without closes
192 QCBOR_ERR_ARRAY_TOO_LONG -- Too many things added to an array/map
193
194 Nesting constructed incorrectly
195 QCBOR_ERR_TOO_MANY_CLOSES -- more close calls than opens
196 QCBOR_ERR_CLOSE_MISMATCH -- Type of close does not match open
197 QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN -- Finish called without enough closes
198
199 Bad data
200 QCBOR_ERR_BAD_SIMPLE -- Simple value integer not valid
201
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700202 */
203
204
205
206
207/*
208 Public function for initialization. See header qcbor.h
209 */
Laurence Lundblade2296db52018-09-14 18:08:39 -0700210void QCBOREncode_Init(QCBOREncodeContext *me, UsefulBuf Storage)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700211{
212 memset(me, 0, sizeof(QCBOREncodeContext));
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800213 UsefulOutBuf_Init(&(me->OutBuf), Storage);
214 Nesting_Init(&(me->nesting));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700215}
216
217
218
219
220/*
221 All CBOR data items have a type and a number. The number is either
222 the value of the item for integer types, the length of the content
223 for string, byte, array and map types, a tag for major type 6, and
224 has serveral uses for major type 7.
225
226 This function encodes the type and the number. There are several
227 encodings for the number depending on how large it is and how it is
228 used.
229
230 Every encoding of the type and number has at least one byte, the
231 "initial byte".
232
233 The top three bits of the initial byte are the major type for the
234 CBOR data item. The eight major types defined by the standard are
235 defined as CBOR_MAJOR_TYPE_xxxx in qcbor.h.
236
237 The remaining five bits, known as "additional information", and
238 possibly more bytes encode the number. If the number is less than 24,
239 then it is encoded entirely in the five bits. This is neat because it
240 allows you to encode an entire CBOR data item in 1 byte for many
241 values and types (integers 0-23, true, false, and tags).
242
243 If the number is larger than 24, then it is encoded in 1,2,4 or 8
244 additional bytes, with the number of these bytes indicated by the
245 values of the 5 bits 24, 25, 25 and 27.
246
247 It is possible to encode a particular number in many ways with this
248 representation. This implementation always uses the smallest
249 possible representation. This is also the suggestion made in the RFC
250 for cannonical CBOR.
251
252 This function inserts them into the output buffer at the specified
Laurence Lundblade067035b2018-11-28 17:35:25 -0800253 position. AppendEncodedTypeAndNumber() appends to the end.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700254
255 This function takes care of converting to network byte order.
256
257 This function is also used to insert floats and doubles. Before this
258 function is called the float or double must be copied into a
259 uint64_t. That is how they are passed in. They are then converted to
260 network byte order correctly. The uMinLen param makes sure that even
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800261 if all the digits of a half, float or double are 0 it is still correctly
Laurence Lundblade067035b2018-11-28 17:35:25 -0800262 encoded in 2, 4 or 8 bytes.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700263
264 */
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800265#ifndef FORMAL_UNOPTIMIZED_INSERTENCODEDTYPEANDNUMBER
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800266/* This code does endian conversion without hton or knowing the
267 endianness of the machine with masks and shifts. It avoids the
268 dependency on hton and any mess of figuring out how to find
269 the machines's endianness.
270
271 It is a good efficient implementation on little endian machines.
272 A better implementation is possible on big endian machines
273 because CBOR/network byte order is big endian. However big
274 endian machines are uncommon.
275
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800276 On x86, it is about 200 bytes instead of 500 bytes for the
277 more formal unoptimized code.
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800278
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800279 This also does the CBOR preferred shortest encoding for integers
280 and is called to do endian conversion for floats.
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800281
282 It works backwards from the LSB to the MSB as needed.
283
284 Code Reviewers: THIS FUNCTION DOES POINTER MATH
285 */
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800286#include <stdio.h>
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800287static void InsertEncodedTypeAndNumber(QCBOREncodeContext *me, uint8_t uMajorType, int nMinLen, uint64_t uNumber, size_t uPos)
288{
289 uint8_t bytes[sizeof(uint64_t)+2];
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800290 uint8_t *pByte = &bytes[sizeof(bytes)-1];
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800291 uint8_t ib;
292
293 if(uNumber < CBOR_TWENTY_FOUR && nMinLen == 0) {
294 ib = uNumber;
295 } else {
296 static const uint8_t aIterate[] = {1,1,2,4};
297 ib = 0;
298 while(uNumber || nMinLen > 0) {
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800299 const uint8_t uIterations = aIterate[ib];
300 nMinLen -= uIterations;
301 for (int i = 0; i < uIterations; i++) {
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800302 *--pByte = uNumber & 0xff;
303 uNumber = uNumber >> 8;
304 }
305 ib++;
306 }
307 ib += LEN_IS_ONE_BYTE-1;
308 }
309 *--pByte = (uMajorType << 5) + ib;
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800310
311 UsefulOutBuf_InsertData(&(me->OutBuf), pByte, &bytes[sizeof(bytes)-1] - pByte, uPos);
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800312}
313
314#else
315
316/* This does the same as the above, but is easier to understand. This also does no pointer math. */
317static void InsertEncodedTypeAndNumber(QCBOREncodeContext *me, uint8_t uMajorType, int nMinLen, uint64_t uNumber, size_t uPos)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700318{
319 // No need to worry about integer overflow here because a) uMajorType is
320 // always generated internally, not by the caller, b) this is for CBOR
321 // _generation_, not parsing c) a mistake will result in bad CBOR generation,
322 // not a security vulnerability.
Laurence Lundblade56230d12018-11-01 11:14:51 +0700323 uMajorType <<= 5;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700324
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800325 if(uNumber > 0xffffffff || nMinLen >= 8) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700326 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_EIGHT_BYTES, uPos);
327 UsefulOutBuf_InsertUint64(&(me->OutBuf), (uint64_t)uNumber, uPos+1);
328
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800329 } else if(uNumber > 0xffff || nMinLen >= 4) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700330 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_FOUR_BYTES, uPos);
331 UsefulOutBuf_InsertUint32(&(me->OutBuf), (uint32_t)uNumber, uPos+1);
332
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800333 } else if (uNumber > 0xff || nMinLen>= 2) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700334 // Between 0 and 65535
335 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_TWO_BYTES, uPos);
336 UsefulOutBuf_InsertUint16(&(me->OutBuf), (uint16_t)uNumber, uPos+1);
337
338 } else if(uNumber >= 24) {
339 // Between 0 and 255, but only between 24 and 255 is ever encoded here
340 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_ONE_BYTE, uPos);
341 UsefulOutBuf_InsertByte(&(me->OutBuf), (uint8_t)uNumber, uPos+1);
342
343 } else {
344 // Between 0 and 23
345 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + (uint8_t)uNumber, uPos);
346 }
347}
Laurence Lundblade351bfea2018-12-07 21:34:31 +0900348
Laurence Lundblade351bfea2018-12-07 21:34:31 +0900349#endif
350
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700351
352
353/*
354 Append the type and number info to the end of the buffer.
355
356 See InsertEncodedTypeAndNumber() function above for details
357*/
358inline static void AppendEncodedTypeAndNumber(QCBOREncodeContext *me, uint8_t uMajorType, uint64_t uNumber)
359{
360 // An append is an insert at the end.
361 InsertEncodedTypeAndNumber(me, uMajorType, 0, uNumber, UsefulOutBuf_GetEndPosition(&(me->OutBuf)));
362}
363
364
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700365
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700366/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800367 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700368 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800369void QCBOREncode_AddUInt64(QCBOREncodeContext *me, uint64_t uValue)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700370{
Laurence Lundblade067035b2018-11-28 17:35:25 -0800371 if(me->uError == QCBOR_SUCCESS) {
372 AppendEncodedTypeAndNumber(me, CBOR_MAJOR_TYPE_POSITIVE_INT, uValue);
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800373 me->uError = Nesting_Increment(&(me->nesting));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700374 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700375}
376
Laurence Lundblade56230d12018-11-01 11:14:51 +0700377
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700378/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800379 Public functions for closing arrays and maps. See header qcbor.h
380 */
381void QCBOREncode_AddInt64(QCBOREncodeContext *me, int64_t nNum)
382{
383 if(me->uError == QCBOR_SUCCESS) {
384 uint8_t uMajorType;
385 uint64_t uValue;
386
387 if(nNum < 0) {
388 uValue = (uint64_t)(-nNum - 1); // This is the way negative ints work in CBOR. -1 encodes as 0x00 with major type negative int.
389 uMajorType = CBOR_MAJOR_TYPE_NEGATIVE_INT;
390 } else {
391 uValue = (uint64_t)nNum;
392 uMajorType = CBOR_MAJOR_TYPE_POSITIVE_INT;
393 }
394
395 AppendEncodedTypeAndNumber(me, uMajorType, uValue);
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800396 me->uError = Nesting_Increment(&(me->nesting));
Laurence Lundblade067035b2018-11-28 17:35:25 -0800397 }
398}
399
400
401/*
402 Semi-private function. It is exposed to user of the interface,
403 but they will usually call one of the inline wrappers rather than this.
404
405 See header qcbor.h
406
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700407 Does the work of adding some bytes to the CBOR output. Works for a
408 byte and text strings, which are the same in in CBOR though they have
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700409 different major types. This is also used to insert raw
410 pre-encoded CBOR.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700411 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800412void QCBOREncode_AddBuffer(QCBOREncodeContext *me, uint8_t uMajorType, UsefulBufC Bytes)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700413{
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800414 if(!me->uError) {
415 // If it is not Raw CBOR, add the type and the length
416 if(uMajorType != CBOR_MAJOR_NONE_TYPE_RAW) {
417 AppendEncodedTypeAndNumber(me, uMajorType, Bytes.len);
418 // The increment in uPos is to account for bytes added for
419 // type and number so the buffer being added goes to the
420 // right place
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700421 }
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800422
423 // Actually add the bytes
424 UsefulOutBuf_AppendUsefulBuf(&(me->OutBuf), Bytes);
425
426 // Update the array counting if there is any nesting at all
427 me->uError = Nesting_Increment(&(me->nesting));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700428 }
429}
430
Laurence Lundbladecafcfe12018-10-31 21:59:50 +0700431
Laurence Lundblade55a24832018-10-30 04:35:08 +0700432/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800433 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundblade55a24832018-10-30 04:35:08 +0700434 */
435void QCBOREncode_AddTag(QCBOREncodeContext *me, uint64_t uTag)
436{
Laurence Lundblade55a24832018-10-30 04:35:08 +0700437 AppendEncodedTypeAndNumber(me, CBOR_MAJOR_TYPE_OPTIONAL, uTag);
438}
439
440
Laurence Lundblade487930f2018-11-30 11:01:45 -0800441
442
Laurence Lundblade56230d12018-11-01 11:14:51 +0700443/*
Laurence Lundblade487930f2018-11-30 11:01:45 -0800444 Semi-private function. It is exposed to user of the interface,
445 but they will usually call one of the inline wrappers rather than this.
446
447 See header qcbor.h
Laurence Lundblade56230d12018-11-01 11:14:51 +0700448 */
Laurence Lundblade487930f2018-11-30 11:01:45 -0800449void QCBOREncode_AddType7(QCBOREncodeContext *me, size_t uSize, uint64_t uNum)
Laurence Lundblade55a24832018-10-30 04:35:08 +0700450{
Laurence Lundblade487930f2018-11-30 11:01:45 -0800451 if(me->uError == QCBOR_SUCCESS) {
452 // This function call takes care of endian swapping for the float / double
453 InsertEncodedTypeAndNumber(me,
454 CBOR_MAJOR_TYPE_SIMPLE, // The major type for
455 // floats and doubles
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800456 (int)uSize, // min size / tells
Laurence Lundblade487930f2018-11-30 11:01:45 -0800457 // encoder to do it right
458 uNum, // Bytes of the floating
459 // point number as a uint
460 UsefulOutBuf_GetEndPosition(&(me->OutBuf))); // end position for append
461
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800462 me->uError = Nesting_Increment(&(me->nesting));
Laurence Lundblade487930f2018-11-30 11:01:45 -0800463 }
Laurence Lundblade55a24832018-10-30 04:35:08 +0700464}
465
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700466
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700467/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800468 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700469 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800470void QCBOREncode_AddDouble(QCBOREncodeContext *me, double dNum)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700471{
Laurence Lundblade067035b2018-11-28 17:35:25 -0800472 const IEEE754_union uNum = IEEE754_DoubleToSmallest(dNum);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700473
Laurence Lundblade487930f2018-11-30 11:01:45 -0800474 QCBOREncode_AddType7(me, uNum.uSize, uNum.uValue);
Laurence Lundblade067035b2018-11-28 17:35:25 -0800475}
476
477
478/*
479 Semi-public function. It is exposed to user of the interface,
480 but they will usually call one of the inline wrappers rather than this.
481
482 See header qcbor.h
483*/
484void QCBOREncode_OpenMapOrArray(QCBOREncodeContext *me, uint8_t uMajorType)
485{
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800486 // Add one item to the nesting level we are in for the new map or array
487 me->uError = Nesting_Increment(&(me->nesting));
488 if(!me->uError) {
489 size_t uEndPosition = UsefulOutBuf_GetEndPosition(&(me->OutBuf));
490 if(uEndPosition >= UINT32_MAX-sizeof(uint64_t)) {
491 me->uError = QCBOR_ERR_BUFFER_TOO_LARGE;
492 } else {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700493 // Increase nesting level because this is a map or array
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800494 // Cast from size_t to uin32_t is safe because of check above
495 me->uError = Nesting_Increase(&(me->nesting), uMajorType, (uint32_t)uEndPosition);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700496 }
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800497 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700498}
499
500
501/*
Laurence Lundbladecafcfe12018-10-31 21:59:50 +0700502 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700503 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800504void QCBOREncode_CloseMapOrArray(QCBOREncodeContext *me, uint8_t uMajorType, UsefulBufC *pWrappedCBOR)
Laurence Lundbladea954db92018-09-28 19:27:31 -0700505{
506 if(!me->uError) {
507 if(!Nesting_IsInNest(&(me->nesting))) {
508 me->uError = QCBOR_ERR_TOO_MANY_CLOSES;
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800509 } else if(Nesting_GetMajorType(&(me->nesting)) != uMajorType) {
Laurence Lundblade067035b2018-11-28 17:35:25 -0800510 me->uError = QCBOR_ERR_CLOSE_MISMATCH;
Laurence Lundbladea954db92018-09-28 19:27:31 -0700511 } else {
Laurence Lundblade56230d12018-11-01 11:14:51 +0700512 // When the array, map or bstr wrap was started, nothing was done
513 // except note the position of the start of it. This code goes back
514 // and inserts the actual CBOR array, map or bstr and its length.
515 // That means all the data that is in the array, map or wrapped
516 // needs to be slid to the right. This is done by UsefulOutBuf's
517 // insert function that is called from inside
518 // InsertEncodedTypeAndNumber()
519 const size_t uInsertPosition = Nesting_GetStartPos(&(me->nesting));
520 const size_t uEndPosition = UsefulOutBuf_GetEndPosition(&(me->OutBuf));
521 // This can't go negative because the UsefulOutBuf always only grows
522 // and never shrinks. UsefulOutBut itself also has defenses such that
523 // it won't write were it should not even if given hostile input lengths
524 const size_t uLenOfEncodedMapOrArray = uEndPosition - uInsertPosition;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700525
Laurence Lundblade56230d12018-11-01 11:14:51 +0700526 // Length is number of bytes for a bstr and number of items a for map & array
527 const size_t uLength = uMajorType == CBOR_MAJOR_TYPE_BYTE_STRING ?
Laurence Lundbladea954db92018-09-28 19:27:31 -0700528 uLenOfEncodedMapOrArray : Nesting_GetCount(&(me->nesting));
529
530 // Actually insert
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700531 InsertEncodedTypeAndNumber(me,
Laurence Lundbladea954db92018-09-28 19:27:31 -0700532 uMajorType, // major type bstr, array or map
533 0, // no minimum length for encoding
534 uLength, // either len of bstr or num items in array or map
535 uInsertPosition); // position in out buffer
536
537 // Return pointer and length to the enclosed encoded CBOR. The intended
538 // use is for it to be hashed (e.g., SHA-256) in a COSE implementation.
539 // This must be used right away, as the pointer and length go invalid
540 // on any subsequent calls to this function because of the
541 // InsertEncodedTypeAndNumber() call that slides data to the right.
542 if(pWrappedCBOR) {
543 UsefulBufC PartialResult = UsefulOutBuf_OutUBuf(&(me->OutBuf));
Laurence Lundblade56230d12018-11-01 11:14:51 +0700544 size_t uBstrLen = UsefulOutBuf_GetEndPosition(&(me->OutBuf)) - uEndPosition;
Laurence Lundbladea954db92018-09-28 19:27:31 -0700545 *pWrappedCBOR = UsefulBuf_Tail(PartialResult, uInsertPosition+uBstrLen);
546 }
547 Nesting_Decrease(&(me->nesting));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700548 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700549 }
550}
551
552
Laurence Lundblade56230d12018-11-01 11:14:51 +0700553
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700554/*
555 Public functions to finish and get the encoded result. See header qcbor.h
556 */
Laurence Lundblade30816f22018-11-10 13:40:22 +0700557QCBORError QCBOREncode_Finish(QCBOREncodeContext *me, UsefulBufC *pEncodedCBOR)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700558{
Laurence Lundblade067035b2018-11-28 17:35:25 -0800559 QCBORError uReturn = me->uError;
560
561 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700562 goto Done;
Laurence Lundblade067035b2018-11-28 17:35:25 -0800563 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700564
565 if (Nesting_IsInNest(&(me->nesting))) {
Laurence Lundblade067035b2018-11-28 17:35:25 -0800566 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700567 goto Done;
568 }
569
570 if(UsefulOutBuf_GetError(&(me->OutBuf))) {
571 // Stuff didn't fit in the buffer.
Laurence Lundblade56230d12018-11-01 11:14:51 +0700572 // This check catches this condition for all the appends and inserts
573 // so checks aren't needed when the appends and inserts are performed.
574 // And of course UsefulBuf will never overrun the input buffer given
575 // to it. No complex analysis of the error handling in this file is
576 // needed to know that is true. Just read the UsefulBuf code.
Laurence Lundblade067035b2018-11-28 17:35:25 -0800577 uReturn = QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700578 goto Done;
579 }
Laurence Lundblade2296db52018-09-14 18:08:39 -0700580
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700581 *pEncodedCBOR = UsefulOutBuf_OutUBuf(&(me->OutBuf));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700582
583Done:
Laurence Lundblade067035b2018-11-28 17:35:25 -0800584 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700585}
586
Laurence Lundblade0595e932018-11-02 22:22:47 +0700587
Laurence Lundblade067035b2018-11-28 17:35:25 -0800588/*
589 Public functions to finish and get the encoded result. See header qcbor.h
590 */
Laurence Lundblade30816f22018-11-10 13:40:22 +0700591QCBORError QCBOREncode_FinishGetSize(QCBOREncodeContext *me, size_t *puEncodedLen)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700592{
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700593 UsefulBufC Enc;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700594
Laurence Lundblade30816f22018-11-10 13:40:22 +0700595 QCBORError nReturn = QCBOREncode_Finish(me, &Enc);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700596
597 if(nReturn == QCBOR_SUCCESS) {
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700598 *puEncodedLen = Enc.len;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700599 }
600
601 return nReturn;
602}
603
604
Laurence Lundblade067035b2018-11-28 17:35:25 -0800605
606
607/*
608 Notes on the code
609
610 CBOR Major Type Public Function
611 0 QCBOREncode_AddUInt64
612 0, 1 QCBOREncode_AddUInt64, QCBOREncode_AddInt64
613 2, 3 QCBOREncode_AddBuffer, Also QCBOREncode_OpenMapOrArray
614 4, 5 QCBOREncode_OpenMapOrArray
615 6 QCBOREncode_AddTag
616 7 QCBOREncode_AddDouble, QCBOREncode_AddSimple
617
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800618 Object code sizes on X86 with LLVM compiler and -Os (Dec 13, 2018)
Laurence Lundblade067035b2018-11-28 17:35:25 -0800619
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800620 _QCBOREncode_Init 71
Laurence Lundblade067035b2018-11-28 17:35:25 -0800621 _QCBOREncode_AddUInt64 76
622 _QCBOREncode_AddInt64 87
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800623 _QCBOREncode_AddBuffer 113
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800624 _QCBOREncode_AddTag 27
Laurence Lundblade067035b2018-11-28 17:35:25 -0800625 _QCBOREncode_AddSimple 30
626 _AppendType7 83
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800627 _QCBOREncode_AddDouble 36
Laurence Lundblade1ef8b2d2018-12-14 23:13:34 -0800628 _QCBOREncode_OpenMapOrArray 103
Laurence Lundblade067035b2018-11-28 17:35:25 -0800629 _QCBOREncode_CloseMapOrArray 181
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800630 _InsertEncodedTypeAndNumber 190
Laurence Lundblade067035b2018-11-28 17:35:25 -0800631 _QCBOREncode_Finish 72
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800632 _QCBOREncode_FinishGetSize 70
Laurence Lundblade067035b2018-11-28 17:35:25 -0800633
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800634 Total is about 1.1KB
Laurence Lundblade067035b2018-11-28 17:35:25 -0800635
Laurence Lundblade067035b2018-11-28 17:35:25 -0800636 _QCBOREncode_CloseMapOrArray is larger because it has a lot
637 of nesting tracking to do and much of Nesting_ inlines
638 into it. It probably can't be reduced much.
639
640 If the error returned by Nesting_Increment() can be ignored
641 because the limit is so high and the consequence of exceeding
642 is proved to be inconsequential, then a lot of if(me->uError)
643 instance can be removed, saving some code.
644
645 */
646
647
Laurence Lundblade067035b2018-11-28 17:35:25 -0800648
649