blob: 23e90372594ca69c60606f41d9d50139e383e35f [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 Lundblade30816f22018-11-10 13:40:22 +0700113inline static QCBORError Nesting_Increment(QCBORTrackNesting *pNesting, uint16_t uAmount)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700114{
115 if(uAmount >= QCBOR_MAX_ITEMS_IN_ARRAY - pNesting->pCurrentNesting->uCount) {
116 return QCBOR_ERR_ARRAY_TOO_LONG;
117 }
118
119 pNesting->pCurrentNesting->uCount += uAmount;
120 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 Lundblade2296db52018-09-14 18:08:39 -0700213 if(Storage.len > UINT32_MAX) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700214 me->uError = QCBOR_ERR_BUFFER_TOO_LARGE;
215 } else {
Laurence Lundblade2296db52018-09-14 18:08:39 -0700216 UsefulOutBuf_Init(&(me->OutBuf), Storage);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700217 Nesting_Init(&(me->nesting));
218 }
219}
220
221
222
223
224/*
225 All CBOR data items have a type and a number. The number is either
226 the value of the item for integer types, the length of the content
227 for string, byte, array and map types, a tag for major type 6, and
228 has serveral uses for major type 7.
229
230 This function encodes the type and the number. There are several
231 encodings for the number depending on how large it is and how it is
232 used.
233
234 Every encoding of the type and number has at least one byte, the
235 "initial byte".
236
237 The top three bits of the initial byte are the major type for the
238 CBOR data item. The eight major types defined by the standard are
239 defined as CBOR_MAJOR_TYPE_xxxx in qcbor.h.
240
241 The remaining five bits, known as "additional information", and
242 possibly more bytes encode the number. If the number is less than 24,
243 then it is encoded entirely in the five bits. This is neat because it
244 allows you to encode an entire CBOR data item in 1 byte for many
245 values and types (integers 0-23, true, false, and tags).
246
247 If the number is larger than 24, then it is encoded in 1,2,4 or 8
248 additional bytes, with the number of these bytes indicated by the
249 values of the 5 bits 24, 25, 25 and 27.
250
251 It is possible to encode a particular number in many ways with this
252 representation. This implementation always uses the smallest
253 possible representation. This is also the suggestion made in the RFC
254 for cannonical CBOR.
255
256 This function inserts them into the output buffer at the specified
Laurence Lundblade067035b2018-11-28 17:35:25 -0800257 position. AppendEncodedTypeAndNumber() appends to the end.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700258
259 This function takes care of converting to network byte order.
260
261 This function is also used to insert floats and doubles. Before this
262 function is called the float or double must be copied into a
263 uint64_t. That is how they are passed in. They are then converted to
264 network byte order correctly. The uMinLen param makes sure that even
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800265 if all the digits of a half, float or double are 0 it is still correctly
Laurence Lundblade067035b2018-11-28 17:35:25 -0800266 encoded in 2, 4 or 8 bytes.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700267
268 */
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800269#ifndef FORMAL_UNOPTIMIZED_INSERTENCODEDTYPEANDNUMBER
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800270/* This code does endian conversion without hton or knowing the
271 endianness of the machine with masks and shifts. It avoids the
272 dependency on hton and any mess of figuring out how to find
273 the machines's endianness.
274
275 It is a good efficient implementation on little endian machines.
276 A better implementation is possible on big endian machines
277 because CBOR/network byte order is big endian. However big
278 endian machines are uncommon.
279
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800280 On x86, it is about 200 bytes instead of 500 bytes for the
281 more formal unoptimized code.
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800282
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800283 This also does the CBOR preferred shortest encoding for integers
284 and is called to do endian conversion for floats.
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800285
286 It works backwards from the LSB to the MSB as needed.
287
288 Code Reviewers: THIS FUNCTION DOES POINTER MATH
289 */
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800290#include <stdio.h>
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800291static void InsertEncodedTypeAndNumber(QCBOREncodeContext *me, uint8_t uMajorType, int nMinLen, uint64_t uNumber, size_t uPos)
292{
293 uint8_t bytes[sizeof(uint64_t)+2];
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800294 uint8_t *pByte = &bytes[sizeof(bytes)-1];
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800295 uint8_t ib;
296
297 if(uNumber < CBOR_TWENTY_FOUR && nMinLen == 0) {
298 ib = uNumber;
299 } else {
300 static const uint8_t aIterate[] = {1,1,2,4};
301 ib = 0;
302 while(uNumber || nMinLen > 0) {
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800303 const uint8_t uIterations = aIterate[ib];
304 nMinLen -= uIterations;
305 for (int i = 0; i < uIterations; i++) {
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800306 *--pByte = uNumber & 0xff;
307 uNumber = uNumber >> 8;
308 }
309 ib++;
310 }
311 ib += LEN_IS_ONE_BYTE-1;
312 }
313 *--pByte = (uMajorType << 5) + ib;
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800314
315 UsefulOutBuf_InsertData(&(me->OutBuf), pByte, &bytes[sizeof(bytes)-1] - pByte, uPos);
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800316}
317
318#else
319
320/* This does the same as the above, but is easier to understand. This also does no pointer math. */
321static void InsertEncodedTypeAndNumber(QCBOREncodeContext *me, uint8_t uMajorType, int nMinLen, uint64_t uNumber, size_t uPos)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700322{
323 // No need to worry about integer overflow here because a) uMajorType is
324 // always generated internally, not by the caller, b) this is for CBOR
325 // _generation_, not parsing c) a mistake will result in bad CBOR generation,
326 // not a security vulnerability.
Laurence Lundblade56230d12018-11-01 11:14:51 +0700327 uMajorType <<= 5;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700328
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800329 if(uNumber > 0xffffffff || nMinLen >= 8) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700330 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_EIGHT_BYTES, uPos);
331 UsefulOutBuf_InsertUint64(&(me->OutBuf), (uint64_t)uNumber, uPos+1);
332
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800333 } else if(uNumber > 0xffff || nMinLen >= 4) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700334 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_FOUR_BYTES, uPos);
335 UsefulOutBuf_InsertUint32(&(me->OutBuf), (uint32_t)uNumber, uPos+1);
336
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800337 } else if (uNumber > 0xff || nMinLen>= 2) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700338 // Between 0 and 65535
339 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_TWO_BYTES, uPos);
340 UsefulOutBuf_InsertUint16(&(me->OutBuf), (uint16_t)uNumber, uPos+1);
341
342 } else if(uNumber >= 24) {
343 // Between 0 and 255, but only between 24 and 255 is ever encoded here
344 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + LEN_IS_ONE_BYTE, uPos);
345 UsefulOutBuf_InsertByte(&(me->OutBuf), (uint8_t)uNumber, uPos+1);
346
347 } else {
348 // Between 0 and 23
349 UsefulOutBuf_InsertByte(&(me->OutBuf), uMajorType + (uint8_t)uNumber, uPos);
350 }
351}
Laurence Lundblade351bfea2018-12-07 21:34:31 +0900352
Laurence Lundblade351bfea2018-12-07 21:34:31 +0900353#endif
354
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700355
356
357/*
358 Append the type and number info to the end of the buffer.
359
360 See InsertEncodedTypeAndNumber() function above for details
361*/
362inline static void AppendEncodedTypeAndNumber(QCBOREncodeContext *me, uint8_t uMajorType, uint64_t uNumber)
363{
364 // An append is an insert at the end.
365 InsertEncodedTypeAndNumber(me, uMajorType, 0, uNumber, UsefulOutBuf_GetEndPosition(&(me->OutBuf)));
366}
367
368
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700369
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700370/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800371 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700372 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800373void QCBOREncode_AddUInt64(QCBOREncodeContext *me, uint64_t uValue)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700374{
Laurence Lundblade067035b2018-11-28 17:35:25 -0800375 if(me->uError == QCBOR_SUCCESS) {
376 AppendEncodedTypeAndNumber(me, CBOR_MAJOR_TYPE_POSITIVE_INT, uValue);
377 me->uError = Nesting_Increment(&(me->nesting), 1);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700378 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700379}
380
Laurence Lundblade56230d12018-11-01 11:14:51 +0700381
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700382/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800383 Public functions for closing arrays and maps. See header qcbor.h
384 */
385void QCBOREncode_AddInt64(QCBOREncodeContext *me, int64_t nNum)
386{
387 if(me->uError == QCBOR_SUCCESS) {
388 uint8_t uMajorType;
389 uint64_t uValue;
390
391 if(nNum < 0) {
392 uValue = (uint64_t)(-nNum - 1); // This is the way negative ints work in CBOR. -1 encodes as 0x00 with major type negative int.
393 uMajorType = CBOR_MAJOR_TYPE_NEGATIVE_INT;
394 } else {
395 uValue = (uint64_t)nNum;
396 uMajorType = CBOR_MAJOR_TYPE_POSITIVE_INT;
397 }
398
399 AppendEncodedTypeAndNumber(me, uMajorType, uValue);
400 me->uError = Nesting_Increment(&(me->nesting), 1);
401 }
402}
403
404
405/*
406 Semi-private function. It is exposed to user of the interface,
407 but they will usually call one of the inline wrappers rather than this.
408
409 See header qcbor.h
410
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700411 Does the work of adding some bytes to the CBOR output. Works for a
412 byte and text strings, which are the same in in CBOR though they have
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700413 different major types. This is also used to insert raw
414 pre-encoded CBOR.
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700415 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800416void QCBOREncode_AddBuffer(QCBOREncodeContext *me, uint8_t uMajorType, UsefulBufC Bytes)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700417{
418 if(Bytes.len >= UINT32_MAX) {
Laurence Lundblade56230d12018-11-01 11:14:51 +0700419 // This implementation doesn't allow buffers larger than UINT32_MAX.
420 // This is primarily because QCBORTrackNesting.pArrays[].uStart is
421 // an uint32 rather than size_t to keep the stack usage down. Also
422 // it is entirely impractical to create tokens bigger than 4GB in
423 // contiguous RAM
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700424 me->uError = QCBOR_ERR_BUFFER_TOO_LARGE;
425
426 } else {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700427 if(!me->uError) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700428 // If it is not Raw CBOR, add the type and the length
429 if(uMajorType != CBOR_MAJOR_NONE_TYPE_RAW) {
Laurence Lundblade067035b2018-11-28 17:35:25 -0800430 AppendEncodedTypeAndNumber(me, uMajorType, Bytes.len);
Laurence Lundblade56230d12018-11-01 11:14:51 +0700431 // The increment in uPos is to account for bytes added for
432 // type and number so the buffer being added goes to the
433 // right place
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700434 }
435
436 // Actually add the bytes
Laurence Lundblade067035b2018-11-28 17:35:25 -0800437 UsefulOutBuf_AppendUsefulBuf(&(me->OutBuf), Bytes);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700438
439 // Update the array counting if there is any nesting at all
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700440 me->uError = Nesting_Increment(&(me->nesting), 1);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700441 }
442 }
443}
444
Laurence Lundbladecafcfe12018-10-31 21:59:50 +0700445
Laurence Lundblade55a24832018-10-30 04:35:08 +0700446/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800447 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundblade55a24832018-10-30 04:35:08 +0700448 */
449void QCBOREncode_AddTag(QCBOREncodeContext *me, uint64_t uTag)
450{
Laurence Lundblade55a24832018-10-30 04:35:08 +0700451 AppendEncodedTypeAndNumber(me, CBOR_MAJOR_TYPE_OPTIONAL, uTag);
452}
453
454
Laurence Lundblade487930f2018-11-30 11:01:45 -0800455
456
Laurence Lundblade56230d12018-11-01 11:14:51 +0700457/*
Laurence Lundblade487930f2018-11-30 11:01:45 -0800458 Semi-private function. It is exposed to user of the interface,
459 but they will usually call one of the inline wrappers rather than this.
460
461 See header qcbor.h
Laurence Lundblade56230d12018-11-01 11:14:51 +0700462 */
Laurence Lundblade487930f2018-11-30 11:01:45 -0800463void QCBOREncode_AddType7(QCBOREncodeContext *me, size_t uSize, uint64_t uNum)
Laurence Lundblade55a24832018-10-30 04:35:08 +0700464{
Laurence Lundblade487930f2018-11-30 11:01:45 -0800465 if(me->uError == QCBOR_SUCCESS) {
466 // This function call takes care of endian swapping for the float / double
467 InsertEncodedTypeAndNumber(me,
468 CBOR_MAJOR_TYPE_SIMPLE, // The major type for
469 // floats and doubles
Laurence Lundblade04a859b2018-12-11 12:13:02 -0800470 (int)uSize, // min size / tells
Laurence Lundblade487930f2018-11-30 11:01:45 -0800471 // encoder to do it right
472 uNum, // Bytes of the floating
473 // point number as a uint
474 UsefulOutBuf_GetEndPosition(&(me->OutBuf))); // end position for append
475
476 me->uError = Nesting_Increment(&(me->nesting), 1);
477 }
Laurence Lundblade55a24832018-10-30 04:35:08 +0700478}
479
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700480
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700481/*
Laurence Lundblade067035b2018-11-28 17:35:25 -0800482 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700483 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800484void QCBOREncode_AddDouble(QCBOREncodeContext *me, double dNum)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700485{
Laurence Lundblade067035b2018-11-28 17:35:25 -0800486 const IEEE754_union uNum = IEEE754_DoubleToSmallest(dNum);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700487
Laurence Lundblade487930f2018-11-30 11:01:45 -0800488 QCBOREncode_AddType7(me, uNum.uSize, uNum.uValue);
Laurence Lundblade067035b2018-11-28 17:35:25 -0800489}
490
491
492/*
493 Semi-public function. It is exposed to user of the interface,
494 but they will usually call one of the inline wrappers rather than this.
495
496 See header qcbor.h
497*/
498void QCBOREncode_OpenMapOrArray(QCBOREncodeContext *me, uint8_t uMajorType)
499{
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700500 // Add one item to the nesting level we are in for the new map or array
501 me->uError = Nesting_Increment(&(me->nesting), 1);
502 if(!me->uError) {
503 // Increase nesting level because this is a map or array
504 // Cast from size_t to uin32_t is safe because the UsefulOutBuf
505 // size is limited to UINT32_MAX in QCBOR_Init().
Laurence Lundbladea954db92018-09-28 19:27:31 -0700506 me->uError = Nesting_Increase(&(me->nesting), uMajorType, (uint32_t)UsefulOutBuf_GetEndPosition(&(me->OutBuf)));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700507 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700508}
509
510
511/*
Laurence Lundbladecafcfe12018-10-31 21:59:50 +0700512 Public functions for closing arrays and maps. See header qcbor.h
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700513 */
Laurence Lundblade067035b2018-11-28 17:35:25 -0800514void QCBOREncode_CloseMapOrArray(QCBOREncodeContext *me, uint8_t uMajorType, UsefulBufC *pWrappedCBOR)
Laurence Lundbladea954db92018-09-28 19:27:31 -0700515{
516 if(!me->uError) {
517 if(!Nesting_IsInNest(&(me->nesting))) {
518 me->uError = QCBOR_ERR_TOO_MANY_CLOSES;
519 } else if( Nesting_GetMajorType(&(me->nesting)) != uMajorType) {
Laurence Lundblade067035b2018-11-28 17:35:25 -0800520 me->uError = QCBOR_ERR_CLOSE_MISMATCH;
Laurence Lundbladea954db92018-09-28 19:27:31 -0700521 } else {
Laurence Lundblade56230d12018-11-01 11:14:51 +0700522 // When the array, map or bstr wrap was started, nothing was done
523 // except note the position of the start of it. This code goes back
524 // and inserts the actual CBOR array, map or bstr and its length.
525 // That means all the data that is in the array, map or wrapped
526 // needs to be slid to the right. This is done by UsefulOutBuf's
527 // insert function that is called from inside
528 // InsertEncodedTypeAndNumber()
529 const size_t uInsertPosition = Nesting_GetStartPos(&(me->nesting));
530 const size_t uEndPosition = UsefulOutBuf_GetEndPosition(&(me->OutBuf));
531 // This can't go negative because the UsefulOutBuf always only grows
532 // and never shrinks. UsefulOutBut itself also has defenses such that
533 // it won't write were it should not even if given hostile input lengths
534 const size_t uLenOfEncodedMapOrArray = uEndPosition - uInsertPosition;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700535
Laurence Lundblade56230d12018-11-01 11:14:51 +0700536 // Length is number of bytes for a bstr and number of items a for map & array
537 const size_t uLength = uMajorType == CBOR_MAJOR_TYPE_BYTE_STRING ?
Laurence Lundbladea954db92018-09-28 19:27:31 -0700538 uLenOfEncodedMapOrArray : Nesting_GetCount(&(me->nesting));
539
540 // Actually insert
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700541 InsertEncodedTypeAndNumber(me,
Laurence Lundbladea954db92018-09-28 19:27:31 -0700542 uMajorType, // major type bstr, array or map
543 0, // no minimum length for encoding
544 uLength, // either len of bstr or num items in array or map
545 uInsertPosition); // position in out buffer
546
547 // Return pointer and length to the enclosed encoded CBOR. The intended
548 // use is for it to be hashed (e.g., SHA-256) in a COSE implementation.
549 // This must be used right away, as the pointer and length go invalid
550 // on any subsequent calls to this function because of the
551 // InsertEncodedTypeAndNumber() call that slides data to the right.
552 if(pWrappedCBOR) {
553 UsefulBufC PartialResult = UsefulOutBuf_OutUBuf(&(me->OutBuf));
Laurence Lundblade56230d12018-11-01 11:14:51 +0700554 size_t uBstrLen = UsefulOutBuf_GetEndPosition(&(me->OutBuf)) - uEndPosition;
Laurence Lundbladea954db92018-09-28 19:27:31 -0700555 *pWrappedCBOR = UsefulBuf_Tail(PartialResult, uInsertPosition+uBstrLen);
556 }
557 Nesting_Decrease(&(me->nesting));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700558 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700559 }
560}
561
562
Laurence Lundblade56230d12018-11-01 11:14:51 +0700563
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700564/*
565 Public functions to finish and get the encoded result. See header qcbor.h
566 */
Laurence Lundblade30816f22018-11-10 13:40:22 +0700567QCBORError QCBOREncode_Finish(QCBOREncodeContext *me, UsefulBufC *pEncodedCBOR)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700568{
Laurence Lundblade067035b2018-11-28 17:35:25 -0800569 QCBORError uReturn = me->uError;
570
571 if(uReturn != QCBOR_SUCCESS) {
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700572 goto Done;
Laurence Lundblade067035b2018-11-28 17:35:25 -0800573 }
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700574
575 if (Nesting_IsInNest(&(me->nesting))) {
Laurence Lundblade067035b2018-11-28 17:35:25 -0800576 uReturn = QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700577 goto Done;
578 }
579
580 if(UsefulOutBuf_GetError(&(me->OutBuf))) {
581 // Stuff didn't fit in the buffer.
Laurence Lundblade56230d12018-11-01 11:14:51 +0700582 // This check catches this condition for all the appends and inserts
583 // so checks aren't needed when the appends and inserts are performed.
584 // And of course UsefulBuf will never overrun the input buffer given
585 // to it. No complex analysis of the error handling in this file is
586 // needed to know that is true. Just read the UsefulBuf code.
Laurence Lundblade067035b2018-11-28 17:35:25 -0800587 uReturn = QCBOR_ERR_BUFFER_TOO_SMALL;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700588 goto Done;
589 }
Laurence Lundblade2296db52018-09-14 18:08:39 -0700590
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700591 *pEncodedCBOR = UsefulOutBuf_OutUBuf(&(me->OutBuf));
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700592
593Done:
Laurence Lundblade067035b2018-11-28 17:35:25 -0800594 return uReturn;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700595}
596
Laurence Lundblade0595e932018-11-02 22:22:47 +0700597
Laurence Lundblade067035b2018-11-28 17:35:25 -0800598/*
599 Public functions to finish and get the encoded result. See header qcbor.h
600 */
Laurence Lundblade30816f22018-11-10 13:40:22 +0700601QCBORError QCBOREncode_FinishGetSize(QCBOREncodeContext *me, size_t *puEncodedLen)
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700602{
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700603 UsefulBufC Enc;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700604
Laurence Lundblade30816f22018-11-10 13:40:22 +0700605 QCBORError nReturn = QCBOREncode_Finish(me, &Enc);
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700606
607 if(nReturn == QCBOR_SUCCESS) {
Laurence Lundbladeda3f0822018-09-18 19:49:02 -0700608 *puEncodedLen = Enc.len;
Laurence Lundbladeb69cad72018-09-13 11:09:01 -0700609 }
610
611 return nReturn;
612}
613
614
Laurence Lundblade067035b2018-11-28 17:35:25 -0800615
616
617/*
618 Notes on the code
619
620 CBOR Major Type Public Function
621 0 QCBOREncode_AddUInt64
622 0, 1 QCBOREncode_AddUInt64, QCBOREncode_AddInt64
623 2, 3 QCBOREncode_AddBuffer, Also QCBOREncode_OpenMapOrArray
624 4, 5 QCBOREncode_OpenMapOrArray
625 6 QCBOREncode_AddTag
626 7 QCBOREncode_AddDouble, QCBOREncode_AddSimple
627
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800628 Object code sizes on X86 with LLVM compiler and -Os (Dec 13, 2018)
Laurence Lundblade067035b2018-11-28 17:35:25 -0800629
630 _QCBOREncode_Init 84
631 _QCBOREncode_AddUInt64 76
632 _QCBOREncode_AddInt64 87
633 _QCBOREncode_AddBuffer 131
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800634 _QCBOREncode_AddTag 27
Laurence Lundblade067035b2018-11-28 17:35:25 -0800635 _QCBOREncode_AddSimple 30
636 _AppendType7 83
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800637 _QCBOREncode_AddDouble 36
Laurence Lundblade067035b2018-11-28 17:35:25 -0800638 _QCBOREncode_OpenMapOrArray 89
639 _QCBOREncode_CloseMapOrArray 181
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800640 _InsertEncodedTypeAndNumber 190
Laurence Lundblade067035b2018-11-28 17:35:25 -0800641 _QCBOREncode_Finish 72
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800642 _QCBOREncode_FinishGetSize 70
Laurence Lundblade067035b2018-11-28 17:35:25 -0800643
Laurence Lundbladef970f1d2018-12-14 01:44:23 -0800644 Total is about 1.1KB
Laurence Lundblade067035b2018-11-28 17:35:25 -0800645
Laurence Lundblade067035b2018-11-28 17:35:25 -0800646 _QCBOREncode_CloseMapOrArray is larger because it has a lot
647 of nesting tracking to do and much of Nesting_ inlines
648 into it. It probably can't be reduced much.
649
650 If the error returned by Nesting_Increment() can be ignored
651 because the limit is so high and the consequence of exceeding
652 is proved to be inconsequential, then a lot of if(me->uError)
653 instance can be removed, saving some code.
654
655 */
656
657
Laurence Lundblade067035b2018-11-28 17:35:25 -0800658
659