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"
26 #include "ocpayload.h"
28 #include "ocresourcehandler.h"
31 #define TAG "OCPayloadConvert"
32 // Arbitrarily chosen size that seems to contain the majority of packages
33 #define INIT_SIZE (255)
35 // Functions all return either a CborError, or a negative version of the OC_STACK return values
36 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size);
37 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
39 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
41 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
43 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size);
44 static int64_t OCConvertPresencePayload(OCPresencePayload* payload, uint8_t* outPayload,
46 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
48 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload);
49 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray);
51 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
54 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
57 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
59 // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
60 // strategy to work. If you receive the following assertion error, please do a git-pull
61 // from the extlibs/tinycbor/tinycbor directory
62 #define CborNeedsUpdating (CborErrorOutOfMemory < CborErrorDataTooLarge)
63 OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
64 #undef CborNeedsUpdating
67 OC_LOG(ERROR, TAG, "Payload parameter NULL");
68 return OC_STACK_INVALID_PARAM;
71 if (!outPayload || !size)
73 OC_LOG(ERROR, TAG, "Out parameter/s parameter NULL");
74 return OC_STACK_INVALID_PARAM;
77 OC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
79 size_t curSize = INIT_SIZE;
80 uint8_t* out = (uint8_t*)OICCalloc(1, curSize);
81 int64_t err = OCConvertPayloadHelper(payload, out, &curSize);
83 if (err == CborErrorOutOfMemory)
85 // reallocate "out" and try again!
86 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
91 return OC_STACK_NO_MEMORY;
95 err = OCConvertPayloadHelper(payload, out, &curSize);
100 if (curSize < INIT_SIZE)
102 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
107 return OC_STACK_NO_MEMORY;
119 return (OCStackResult)-err;
123 return OC_STACK_ERROR;
127 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
129 switch(payload->type)
131 case PAYLOAD_TYPE_DISCOVERY:
132 return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
133 case PAYLOAD_TYPE_DEVICE:
134 return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
135 case PAYLOAD_TYPE_PLATFORM:
136 return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
137 case PAYLOAD_TYPE_REPRESENTATION:
138 return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
139 case PAYLOAD_TYPE_PRESENCE:
140 return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
141 case PAYLOAD_TYPE_SECURITY:
142 return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
144 OC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
145 return OC_STACK_NOTIMPL;
149 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
151 if (err == CborErrorOutOfMemory)
153 *size += encoder->ptr - encoder->end;
158 OC_LOG_V(ERROR, TAG, "Convert Payload failed", err);
163 *size = encoder->ptr - outPayload;
167 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
173 cbor_encoder_init(&encoder, outPayload, *size, 0);
175 CborEncoder rootArray;
176 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
179 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
181 if(payload->securityData)
183 err = err | AddTextStringToMap(&map, OC_RSRVD_REPRESENTATION,
184 sizeof(OC_RSRVD_REPRESENTATION) - 1,
185 payload->securityData);
188 err = err | cbor_encoder_close_container(&rootArray, &map);
190 err = err | cbor_encoder_close_container(&encoder, &rootArray);
191 return checkError(err, &encoder, outPayload, size);
195 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
198 CborEncoder encoder = {0};
200 size_t resourceCount = OCDiscoveryPayloadGetResourceCount(payload);
202 cbor_encoder_init(&encoder, outPayload, *size, 0);
204 CborEncoder rootArray;
205 err = err | cbor_encoder_create_array(&encoder, &rootArray, resourceCount);
207 for(size_t i = 0; i < resourceCount; ++i)
210 OCResourcePayload* resource = OCDiscoveryPayloadGetResource(payload, i);
214 return OC_STACK_INVALID_PARAM;
217 err = err | cbor_encoder_create_map(&rootArray, &map, 3);
219 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF,
220 sizeof(OC_RSRVD_HREF) - 1,
224 err = err | cbor_encode_text_string(&map, OC_RSRVD_SERVER_INSTANCE_ID,
225 sizeof(OC_RSRVD_SERVER_INSTANCE_ID) - 1);
226 err = err | cbor_encode_byte_string(&map, resource->sid, UUID_SIZE);
230 err = err | cbor_encode_text_string(&map, OC_RSRVD_PROPERTY,
231 sizeof(OC_RSRVD_PROPERTY) -1 );
232 err = err | cbor_encoder_create_map(&map, &propMap, 3);
237 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_RESOURCE_TYPE,
238 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
239 err = err | cbor_encoder_create_array(&propMap, &rtArray, CborIndefiniteLength);
241 OCStringLL* rtPtr = resource->types;
244 err = err | cbor_encode_text_string(&rtArray, rtPtr->value,
245 strlen(rtPtr->value));
249 err = err | cbor_encoder_close_container(&propMap, &rtArray);
255 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_INTERFACE,
256 sizeof(OC_RSRVD_INTERFACE) - 1);
257 err = err | cbor_encoder_create_array(&propMap, &ifArray, CborIndefiniteLength);
258 OCStringLL* ifPtr = resource->interfaces;
262 err = err | cbor_encode_text_string(&ifArray, ifPtr->value,
263 strlen(ifPtr->value));
267 err = err | cbor_encoder_close_container(&propMap, &ifArray);
271 CborEncoder policyMap;
272 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_POLICY,
273 sizeof(OC_RSRVD_POLICY) - 1);
274 err = err | cbor_encoder_create_map(&propMap, &policyMap, CborIndefiniteLength);
277 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP,
278 sizeof(OC_RSRVD_BITMAP) - 1);
279 err = err | cbor_encode_uint(&policyMap, resource->bitmap);
283 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
284 sizeof(OC_RSRVD_SECURE) - 1);
285 err = err | cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
287 if(resource->port != 0)
289 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
290 sizeof(OC_RSRVD_HOSTING_PORT) - 1);
291 err = err | cbor_encode_uint(&policyMap, resource->port);
295 err = err | cbor_encoder_close_container(&propMap, &policyMap);
298 err = err | cbor_encoder_close_container(&map, &propMap);
301 err = err | cbor_encoder_close_container(&rootArray, &map);
304 err = err | cbor_encoder_close_container(&encoder, &rootArray);
306 return checkError(err, &encoder, outPayload, size);
309 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
312 CborEncoder encoder = {0};
315 cbor_encoder_init(&encoder, outPayload, *size, 0);
316 CborEncoder rootArray;
317 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
321 err = err | cbor_encoder_create_map(&rootArray, &map, 2);
324 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
330 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
331 sizeof(OC_RSRVD_REPRESENTATION) - 1);
332 err = err | cbor_encoder_create_map(&map, &repMap, 4);
335 err = err | cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID,
336 sizeof(OC_RSRVD_DEVICE_ID) - 1);
337 err = err | cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
340 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
341 sizeof(OC_RSRVD_DEVICE_NAME) - 1,
342 payload->deviceName);
344 // Device Spec Version
345 err = err | AddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
346 sizeof(OC_RSRVD_SPEC_VERSION) - 1,
347 payload->specVersion);
349 // Device data Model Version
350 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
351 sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1,
352 payload->dataModelVersion);
354 err = err | cbor_encoder_close_container(&map, &repMap);
358 err = err | cbor_encoder_close_container(&rootArray, &map);
362 err = err | cbor_encoder_close_container(&encoder, &rootArray);
364 return checkError(err, &encoder, outPayload, size);
367 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
370 CborEncoder encoder = {0};
373 cbor_encoder_init(&encoder, outPayload, *size, 0);
374 CborEncoder rootArray;
375 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
378 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
381 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
387 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
388 sizeof(OC_RSRVD_REPRESENTATION) - 1);
389 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
392 err = err | AddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
393 sizeof(OC_RSRVD_PLATFORM_ID) - 1,
394 payload->info.platformID);
397 err = err | AddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
398 sizeof(OC_RSRVD_MFG_NAME) - 1,
399 payload->info.manufacturerName);
402 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
403 sizeof(OC_RSRVD_MFG_URL) - 1,
404 payload->info.manufacturerUrl);
407 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
408 sizeof(OC_RSRVD_MODEL_NUM) - 1,
409 payload->info.modelNumber);
412 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
413 sizeof(OC_RSRVD_MFG_DATE) - 1,
414 payload->info.dateOfManufacture);
417 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
418 sizeof(OC_RSRVD_PLATFORM_VERSION) - 1,
419 payload->info.platformVersion);
422 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
423 sizeof(OC_RSRVD_OS_VERSION) - 1,
424 payload->info.operatingSystemVersion);
427 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
428 sizeof(OC_RSRVD_HARDWARE_VERSION) - 1,
429 payload->info.hardwareVersion);
432 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
433 sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1,
434 payload->info.firmwareVersion);
437 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
438 sizeof(OC_RSRVD_SUPPORT_URL) - 1,
439 payload->info.supportUrl);
442 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
443 sizeof(OC_RSRVD_SYSTEM_TIME) - 1,
444 payload->info.systemTime);
445 err = err | cbor_encoder_close_container(&map, &repMap);
449 err = err | cbor_encoder_close_container(&rootArray, &map);
453 err = err | cbor_encoder_close_container(&encoder, &rootArray);
455 return checkError(err, &encoder, outPayload, size);
458 static int64_t OCConvertArrayItem(CborEncoder* array, const OCRepPayloadValueArray* valArray,
462 switch (valArray->type)
464 case OCREP_PROP_NULL:
465 OC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
466 err = CborUnknownError;
469 err = err | cbor_encode_int(array, valArray->iArray[index]);
471 case OCREP_PROP_DOUBLE:
472 err = err | cbor_encode_double(array, valArray->dArray[index]);
474 case OCREP_PROP_BOOL:
475 err = err | cbor_encode_boolean(array, valArray->bArray[index]);
477 case OCREP_PROP_STRING:
478 if (!valArray->strArray[index])
480 err = err | cbor_encode_null(array);
484 err = err | cbor_encode_text_string(array, valArray->strArray[index],
485 strlen(valArray->strArray[index]));
488 case OCREP_PROP_OBJECT:
489 if (!valArray->objArray[index])
491 err = err | cbor_encode_null(array);
495 err = OCConvertSingleRepPayload(array, valArray->objArray[index]);
498 case OCREP_PROP_ARRAY:
499 OC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
500 err = CborUnknownError;
506 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray)
511 err = err | cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
513 for (size_t i = 0; i < valArray->dimensions[0];++i)
515 if (valArray->dimensions[1] != 0)
518 err = err | cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
520 for (size_t j = 0; j < valArray->dimensions[1]; ++j)
522 if (valArray->dimensions[2] != 0)
525 err = err | cbor_encoder_create_array(&array2, &array3,
526 valArray->dimensions[2]);
528 for(size_t k = 0; k < valArray->dimensions[2]; ++k)
530 OCConvertArrayItem(&array3, valArray,
531 j * valArray->dimensions[2] +
532 i * valArray->dimensions[2] * valArray->dimensions[1] +
535 err = err | cbor_encoder_close_container(&array2, &array3);
539 OCConvertArrayItem(&array2, valArray,
540 i * valArray->dimensions[1] + j);
543 err = err | cbor_encoder_close_container(&array, &array2);
547 OCConvertArrayItem(&array, valArray, i);
550 err = err | cbor_encoder_close_container(parent, &array);
554 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload)
558 err = err | cbor_encoder_create_map(parent, &map, CborIndefiniteLength);
561 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF,
562 sizeof(OC_RSRVD_HREF) - 1,
566 // resource types, interfaces
567 if(payload->types || payload->interfaces)
569 OC_LOG(INFO, TAG, "Payload has types or interfaces");
570 err = err | cbor_encode_text_string(&map,
572 sizeof(OC_RSRVD_PROPERTY) - 1);
574 err = err | cbor_encoder_create_map(&map, &propMap, 2);
576 CborEncoder curArray;
579 err = err | cbor_encode_text_string(&propMap,
580 OC_RSRVD_RESOURCE_TYPE,
581 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
582 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
583 OCStringLL* val = payload->types;
586 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
589 err = err | cbor_encoder_close_container(&propMap, &curArray);
591 if(payload->interfaces)
593 err = err | cbor_encode_text_string(&propMap,
595 sizeof(OC_RSRVD_INTERFACE) - 1);
596 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
597 OCStringLL* val = payload->interfaces;
600 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
603 err = err | cbor_encoder_close_container(&propMap, &curArray);
605 err = err | cbor_encoder_close_container(&map, &propMap);
611 err = err | cbor_encode_text_string(&map,
612 OC_RSRVD_REPRESENTATION,
613 sizeof(OC_RSRVD_REPRESENTATION) - 1);
614 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
615 OCRepPayloadValue* value = payload->values;
618 err = err | cbor_encode_text_string(&repMap,
620 strlen(value->name));
623 case OCREP_PROP_NULL:
624 err = err | cbor_encode_null(&repMap);
627 err = err | cbor_encode_int(&repMap,
630 case OCREP_PROP_DOUBLE:
631 err = err | cbor_encode_double(&repMap,
634 case OCREP_PROP_BOOL:
635 err = err | cbor_encode_boolean(&repMap,
638 case OCREP_PROP_STRING:
639 err = err | cbor_encode_text_string(&repMap,
640 value->str, strlen(value->str));
642 case OCREP_PROP_OBJECT:
643 err = err | OCConvertSingleRepPayload(&repMap, value->obj);
645 case OCREP_PROP_ARRAY:
646 err = err | OCConvertArray(&repMap, &value->arr);
649 OC_LOG_V(ERROR, TAG, "Invalid Prop type: %d",
656 err = err | cbor_encoder_close_container(&map, &repMap);
660 err = err | cbor_encoder_close_container(parent, &map);
665 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size)
667 CborEncoder encoder = {0};
670 cbor_encoder_init(&encoder, outPayload, *size, 0);
671 CborEncoder rootArray;
672 err = err | cbor_encoder_create_array(&encoder, &rootArray, CborIndefiniteLength);
674 while(payload != NULL && (err == 0 || err == CborErrorOutOfMemory))
676 err = err | OCConvertSingleRepPayload(&rootArray, payload);
677 payload = payload->next;
681 err = err | cbor_encoder_close_container(&encoder, &rootArray);
683 return checkError(err, &encoder, outPayload, size);
686 static int64_t OCConvertPresencePayload(OCPresencePayload* payload,
687 uint8_t* outPayload, size_t* size)
689 CborEncoder encoder = {0};
692 cbor_encoder_init(&encoder, outPayload, *size, 0);
693 CborEncoder rootArray;
695 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
698 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
701 err = err | cbor_encode_text_string(&map,
703 sizeof(OC_RSRVD_NONCE) - 1);
704 err = err | cbor_encode_uint(&map, payload->sequenceNumber);
707 err = err | cbor_encode_text_string(&map,
709 sizeof(OC_RSRVD_TTL) - 1);
710 err = err | cbor_encode_uint(&map, payload->maxAge);
713 const char* triggerStr = convertTriggerEnumToString(payload->trigger);
714 err = err | AddTextStringToMap(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1,
717 // Resource type name
718 if(payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
720 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
721 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
725 err = err | cbor_encoder_close_container(&rootArray, &map);
726 err = err | cbor_encoder_close_container(&encoder, &rootArray);
728 return checkError(err, &encoder, outPayload, size);
731 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
734 return cbor_encode_text_string(map, key, keylen) |
735 cbor_encode_text_string(map, value, strlen(value));
738 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
741 return value ? AddTextStringToMap(map, key, keylen, value) : 0;