1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 #include "ocpayloadcbor.h"
22 #include "platform_features.h"
24 #include "oic_malloc.h"
25 #include "oic_string.h"
27 #include "ocpayload.h"
29 #include "ocresourcehandler.h"
31 #include "rdpayload.h"
33 #define TAG "OCPayloadConvert"
34 // Arbitrarily chosen size that seems to contain the majority of packages
35 #define INIT_SIZE (255)
37 // CBOR Links Map Length
38 #define DISCOVERY_CBOR_LINKS_MAP_LEN 4
40 // Functions all return either a CborError, or a negative version of the OC_STACK return values
41 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size);
42 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
44 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
46 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
48 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size);
49 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload* payload);
50 static int64_t OCConvertPresencePayload(OCPresencePayload* payload, uint8_t* outPayload,
52 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
54 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload);
55 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray);
57 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
60 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
63 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
65 // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
66 // strategy to work. If you receive the following assertion error, please do a git-pull
67 // from the extlibs/tinycbor/tinycbor directory
68 #define CborNeedsUpdating (CborErrorOutOfMemory < CborErrorDataTooLarge)
69 OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
70 #undef CborNeedsUpdating
73 OC_LOG(ERROR, TAG, "Payload parameter NULL");
74 return OC_STACK_INVALID_PARAM;
77 if (!outPayload || !size)
79 OC_LOG(ERROR, TAG, "Out parameter/s parameter NULL");
80 return OC_STACK_INVALID_PARAM;
83 OC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
85 size_t curSize = INIT_SIZE;
86 uint8_t* out = (uint8_t*)OICCalloc(1, curSize);
87 int64_t err = OCConvertPayloadHelper(payload, out, &curSize);
89 if (err == CborErrorOutOfMemory)
91 // reallocate "out" and try again!
92 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
97 return OC_STACK_NO_MEMORY;
101 err = OCConvertPayloadHelper(payload, out, &curSize);
106 if (curSize < INIT_SIZE)
108 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
113 return OC_STACK_NO_MEMORY;
125 return (OCStackResult)-err;
129 return OC_STACK_ERROR;
133 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
135 switch(payload->type)
137 case PAYLOAD_TYPE_DISCOVERY:
138 return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
139 case PAYLOAD_TYPE_DEVICE:
140 return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
141 case PAYLOAD_TYPE_PLATFORM:
142 return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
143 case PAYLOAD_TYPE_REPRESENTATION:
144 return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
145 case PAYLOAD_TYPE_PRESENCE:
146 return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
147 case PAYLOAD_TYPE_SECURITY:
148 return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
149 case PAYLOAD_TYPE_RD:
150 return OCRDPayloadToCbor((OCRDPayload*)payload, outPayload, size);
152 OC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
153 return OC_STACK_NOTIMPL;
157 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
159 if (err == CborErrorOutOfMemory)
161 *size += encoder->ptr - encoder->end;
166 OC_LOG_V(ERROR, TAG, "Convert Payload failed : %zd", err);
171 *size = encoder->ptr - outPayload;
176 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
182 cbor_encoder_init(&encoder, outPayload, *size, 0);
186 err = err | cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
188 if(payload->securityData)
190 err = err | cbor_encode_text_string(&map, payload->securityData,
191 strlen(payload->securityData));
194 err = err | cbor_encoder_close_container(&encoder, &map);
195 return checkError(err, &encoder, outPayload, size);
198 static char* OCStringLLJoin(OCStringLL* val)
200 OCStringLL* temp = val;
201 size_t size = strlen(temp->value);
207 size += strlen(temp->value);
210 char* joinedStr = (char*)OICCalloc(sizeof(char), size + 1);
217 OICStrcat(joinedStr, size + 1, val->value);
221 OICStrcat(joinedStr, size + 1, " ");
222 OICStrcat(joinedStr, size + 1, val->value);
227 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
230 CborEncoder encoder = {0};
231 CborEncoder rootArray = {0};
234 cbor_encoder_init(&encoder, outPayload, *size, 0);
236 if (payload->resources)
239 The format for the payload is "modelled" as JSON.
243 "di" : UUID, // device ID
244 links :[ // linksArray contains maps of resources
246 href, rt, if, policy // Resource 1
249 href, rt, if, policy // Resource 2
258 CborEncoder rootMap = {0};
259 size_t resourceCount = OCDiscoveryPayloadGetResourceCount(payload);
261 // Open the main root array
262 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
264 // Open the root map in the root array
265 err = err | cbor_encoder_create_map(&rootArray, &rootMap, CborIndefiniteLength);
267 // Insert Device ID into the root map
268 err = err | cbor_encode_text_string(&rootMap, OC_RSRVD_DEVICE_ID,
269 sizeof(OC_RSRVD_DEVICE_ID) - 1);
270 err = err | cbor_encode_byte_string(&rootMap, payload->sid, UUID_SIZE);
272 // Insert baseURI if present
273 err = err | ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_BASE_URI,
274 sizeof(OC_RSRVD_BASE_URI) - 1,
277 // Insert Links into the root map.
278 CborEncoder linkArray = {0};
279 err = err | cbor_encode_text_string(&rootMap, OC_RSRVD_LINKS,
280 sizeof(OC_RSRVD_LINKS) - 1);
281 err = err | cbor_encoder_create_array(&rootMap, &linkArray, resourceCount);
283 for(size_t i = 0; i < resourceCount; ++i)
285 CborEncoder resourceMapElement = {0};
286 OCResourcePayload* resource = OCDiscoveryPayloadGetResource(payload, i);
290 return OC_STACK_INVALID_PARAM;
293 // resource map inside the links array.
294 err = err | cbor_encoder_create_map(&linkArray, &resourceMapElement,
295 DISCOVERY_CBOR_LINKS_MAP_LEN);
297 // Below are insertions of the resource properties into the map.
299 err = err | AddTextStringToMap(&resourceMapElement, OC_RSRVD_HREF,
300 sizeof(OC_RSRVD_HREF) - 1,
305 char* joinedTypes = OCStringLLJoin(resource->types);
308 err = err | cbor_encode_text_string(&resourceMapElement, OC_RSRVD_RESOURCE_TYPE,
309 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
310 err = err | cbor_encode_text_string(&resourceMapElement, joinedTypes,
311 strlen(joinedTypes));
312 OICFree(joinedTypes);
316 return OC_STACK_NO_MEMORY;
320 if (resource->interfaces)
322 char* joinedInterfaces = OCStringLLJoin(resource->interfaces);
323 if (joinedInterfaces)
325 err = err | cbor_encode_text_string(&resourceMapElement, OC_RSRVD_INTERFACE,
326 sizeof(OC_RSRVD_INTERFACE) - 1);
327 err = err | cbor_encode_text_string(&resourceMapElement, joinedInterfaces,
328 strlen(joinedInterfaces));
329 OICFree(joinedInterfaces);
333 return OC_STACK_NO_MEMORY;
338 CborEncoder policyMap = {0};
339 err = err | cbor_encode_text_string(&resourceMapElement, OC_RSRVD_POLICY,
340 sizeof(OC_RSRVD_POLICY) - 1);
341 err = err | cbor_encoder_create_map(&resourceMapElement, &policyMap, CborIndefiniteLength);
344 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP,
345 sizeof(OC_RSRVD_BITMAP) - 1);
346 err = err | cbor_encode_uint(&policyMap, resource->bitmap);
350 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
351 sizeof(OC_RSRVD_SECURE) - 1);
352 err = err | cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
354 if(resource->port != 0)
356 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
357 sizeof(OC_RSRVD_HOSTING_PORT) - 1);
358 err = err | cbor_encode_uint(&policyMap, resource->port);
361 if (payload->baseURI)
363 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
364 sizeof(OC_RSRVD_HOSTING_PORT) - 1);
365 err = err | cbor_encode_uint(&policyMap, resource->port);
368 err = err | cbor_encoder_close_container(&resourceMapElement, &policyMap);
370 // Finsihed encoding a resource, close the map.
371 err = err | cbor_encoder_close_container(&linkArray, &resourceMapElement);
373 // Close links array inside the root map.
374 err = err | cbor_encoder_close_container(&rootMap, &linkArray);
375 // close root map inside the root array.
376 err = err | cbor_encoder_close_container(&rootArray, &rootMap);
377 // Close the final root array.
378 err = err | cbor_encoder_close_container(&encoder, &rootArray);
381 return checkError(err, &encoder, outPayload, size);
384 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
387 CborEncoder encoder = {0};
390 cbor_encoder_init(&encoder, outPayload, *size, 0);
392 err = err | cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
395 err = err | cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID,
396 sizeof(OC_RSRVD_DEVICE_ID) - 1);
397 err = err | cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
400 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
401 sizeof(OC_RSRVD_DEVICE_NAME) - 1,
402 payload->deviceName);
404 // Device Spec Version
405 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
406 sizeof(OC_RSRVD_SPEC_VERSION) - 1,
407 payload->specVersion);
409 // Device data Model Version
410 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
411 sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1,
412 payload->dataModelVersion);
414 err = err | cbor_encoder_close_container(&encoder, &repMap);
416 return checkError(err, &encoder, outPayload, size);
419 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
422 CborEncoder encoder = {0};
425 cbor_encoder_init(&encoder, outPayload, *size, 0);
428 err = err | cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
431 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
432 sizeof(OC_RSRVD_PLATFORM_ID) - 1,
433 payload->info.platformID);
436 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
437 sizeof(OC_RSRVD_MFG_NAME) - 1,
438 payload->info.manufacturerName);
441 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
442 sizeof(OC_RSRVD_MFG_URL) - 1,
443 payload->info.manufacturerUrl);
446 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
447 sizeof(OC_RSRVD_MODEL_NUM) - 1,
448 payload->info.modelNumber);
451 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
452 sizeof(OC_RSRVD_MFG_DATE) - 1,
453 payload->info.dateOfManufacture);
456 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
457 sizeof(OC_RSRVD_PLATFORM_VERSION) - 1,
458 payload->info.platformVersion);
461 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
462 sizeof(OC_RSRVD_OS_VERSION) - 1,
463 payload->info.operatingSystemVersion);
466 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
467 sizeof(OC_RSRVD_HARDWARE_VERSION) - 1,
468 payload->info.hardwareVersion);
471 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
472 sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1,
473 payload->info.firmwareVersion);
476 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
477 sizeof(OC_RSRVD_SUPPORT_URL) - 1,
478 payload->info.supportUrl);
481 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
482 sizeof(OC_RSRVD_SYSTEM_TIME) - 1,
483 payload->info.systemTime);
486 err = err | cbor_encoder_close_container(&encoder, &repMap);
489 return checkError(err, &encoder, outPayload, size);
492 static int64_t OCConvertArrayItem(CborEncoder* array, const OCRepPayloadValueArray* valArray,
496 switch (valArray->type)
498 case OCREP_PROP_NULL:
499 OC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
500 err = CborUnknownError;
503 err = err | cbor_encode_int(array, valArray->iArray[index]);
505 case OCREP_PROP_DOUBLE:
506 err = err | cbor_encode_double(array, valArray->dArray[index]);
508 case OCREP_PROP_BOOL:
509 err = err | cbor_encode_boolean(array, valArray->bArray[index]);
511 case OCREP_PROP_STRING:
512 if (!valArray->strArray[index])
514 err = err | cbor_encode_null(array);
518 err = err | cbor_encode_text_string(array, valArray->strArray[index],
519 strlen(valArray->strArray[index]));
522 case OCREP_PROP_BYTE_STRING:
523 if (!valArray->strArray[index])
525 err = err | cbor_encode_null(array);
529 err = err | cbor_encode_byte_string(array, valArray->ocByteStrArray[index].bytes,
530 valArray->ocByteStrArray[index].len);
533 case OCREP_PROP_OBJECT:
534 if (!valArray->objArray[index])
536 err = err | cbor_encode_null(array);
540 err = OCConvertRepMap(array, valArray->objArray[index]);
543 case OCREP_PROP_ARRAY:
544 OC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
545 err = CborUnknownError;
551 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray)
556 err = err | cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
558 for (size_t i = 0; i < valArray->dimensions[0];++i)
560 if (valArray->dimensions[1] != 0)
563 err = err | cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
565 for (size_t j = 0; j < valArray->dimensions[1]; ++j)
567 if (valArray->dimensions[2] != 0)
570 err = err | cbor_encoder_create_array(&array2, &array3,
571 valArray->dimensions[2]);
573 for(size_t k = 0; k < valArray->dimensions[2]; ++k)
575 OCConvertArrayItem(&array3, valArray,
576 j * valArray->dimensions[2] +
577 i * valArray->dimensions[2] * valArray->dimensions[1] +
580 err = err | cbor_encoder_close_container(&array2, &array3);
584 OCConvertArrayItem(&array2, valArray,
585 i * valArray->dimensions[1] + j);
588 err = err | cbor_encoder_close_container(&array, &array2);
592 OCConvertArrayItem(&array, valArray, i);
595 err = err | cbor_encoder_close_container(parent, &array);
599 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload* payload)
603 err = err | cbor_encoder_create_map(map, &repMap, CborIndefiniteLength);
604 err = err | OCConvertSingleRepPayload(&repMap, payload);
605 err = err | cbor_encoder_close_container(map, &repMap);
609 static int64_t OCConvertSingleRepPayload(CborEncoder* repMap, const OCRepPayload* payload)
612 OCRepPayloadValue* value = payload->values;
615 err = err | cbor_encode_text_string(repMap,
617 strlen(value->name));
620 case OCREP_PROP_NULL:
621 err = err | cbor_encode_null(repMap);
624 err = err | cbor_encode_int(repMap,
627 case OCREP_PROP_DOUBLE:
628 err = err | cbor_encode_double(repMap,
631 case OCREP_PROP_BOOL:
632 err = err | cbor_encode_boolean(repMap,
635 case OCREP_PROP_STRING:
636 err = err | cbor_encode_text_string(repMap,
637 value->str, strlen(value->str));
639 case OCREP_PROP_BYTE_STRING:
640 err = err | cbor_encode_byte_string(repMap,
641 value->ocByteStr.bytes, value->ocByteStr.len);
643 case OCREP_PROP_OBJECT:
644 err = err | OCConvertRepMap(repMap, value->obj);
646 case OCREP_PROP_ARRAY:
647 err = err | OCConvertArray(repMap, &value->arr);
650 OC_LOG_V(ERROR, TAG, "Invalid Prop type: %d",
660 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size)
662 CborEncoder encoder = {0};
665 cbor_encoder_init(&encoder, outPayload, *size, 0);
667 err = err | cbor_encoder_create_map(&encoder, &rootMap, CborIndefiniteLength);
671 OC_LOG(INFO, TAG, "Payload has types or interfaces");
672 char* joinedTypes = OCStringLLJoin(payload->types);
675 err = err | cbor_encode_text_string(&rootMap, OC_RSRVD_RESOURCE_TYPE,
676 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
677 err = err | cbor_encode_text_string(&rootMap, joinedTypes,
678 strlen(joinedTypes));
679 OICFree(joinedTypes);
683 return OC_STACK_NO_MEMORY;
686 if (payload->interfaces)
688 char* joinedInterfaces = OCStringLLJoin(payload->interfaces);
689 if (joinedInterfaces)
691 err = err | cbor_encode_text_string(&rootMap, OC_RSRVD_INTERFACE,
692 sizeof(OC_RSRVD_INTERFACE) - 1);
693 err = err | cbor_encode_text_string(&rootMap, joinedInterfaces,
694 strlen(joinedInterfaces));
695 OICFree(joinedInterfaces);
699 return OC_STACK_NO_MEMORY;
703 while(payload != NULL && (err == 0 || err == CborErrorOutOfMemory))
705 err = err | OCConvertSingleRepPayload(&rootMap, payload);
706 payload = payload->next;
710 err = err | cbor_encoder_close_container(&encoder, &rootMap);
712 return checkError(err, &encoder, outPayload, size);
715 static int64_t OCConvertPresencePayload(OCPresencePayload* payload,
716 uint8_t* outPayload, size_t* size)
718 CborEncoder encoder = {0};
721 cbor_encoder_init(&encoder, outPayload, *size, 0);
723 err = err | cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
726 err = err | cbor_encode_text_string(&map,
728 sizeof(OC_RSRVD_NONCE) - 1);
729 err = err | cbor_encode_uint(&map, payload->sequenceNumber);
732 err = err | cbor_encode_text_string(&map,
734 sizeof(OC_RSRVD_TTL) - 1);
735 err = err | cbor_encode_uint(&map, payload->maxAge);
738 const char* triggerStr = convertTriggerEnumToString(payload->trigger);
739 err = err | AddTextStringToMap(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1,
742 // Resource type name
743 if(payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
745 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
746 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
750 err = err | cbor_encoder_close_container(&encoder, &map);
752 return checkError(err, &encoder, outPayload, size);
755 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
758 return cbor_encode_text_string(map, key, keylen) |
759 cbor_encode_text_string(map, value, strlen(value));
762 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
765 return value ? AddTextStringToMap(map, key, keylen, value) : 0;