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 case PAYLOAD_TYPE_RD:
145 return OCRDPayloadToCbor((OCRDPayload*)payload, outPayload, size);
148 OC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
149 return OC_STACK_NOTIMPL;
153 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
155 if (err == CborErrorOutOfMemory)
157 *size += encoder->ptr - encoder->end;
162 OC_LOG_V(ERROR, TAG, "Convert Payload failed", err);
167 *size = encoder->ptr - outPayload;
171 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
177 cbor_encoder_init(&encoder, outPayload, *size, 0);
179 CborEncoder rootArray;
180 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
183 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
185 if(payload->securityData)
187 err = err | AddTextStringToMap(&map, OC_RSRVD_REPRESENTATION,
188 sizeof(OC_RSRVD_REPRESENTATION) - 1,
189 payload->securityData);
192 err = err | cbor_encoder_close_container(&rootArray, &map);
194 err = err | cbor_encoder_close_container(&encoder, &rootArray);
195 return checkError(err, &encoder, outPayload, size);
199 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
202 CborEncoder encoder = {0};
204 size_t resourceCount = OCDiscoveryPayloadGetResourceCount(payload);
206 cbor_encoder_init(&encoder, outPayload, *size, 0);
208 CborEncoder rootArray;
209 err = err | cbor_encoder_create_array(&encoder, &rootArray, resourceCount);
211 for(size_t i = 0; i < resourceCount; ++i)
214 OCResourcePayload* resource = OCDiscoveryPayloadGetResource(payload, i);
218 return OC_STACK_INVALID_PARAM;
221 err = err | cbor_encoder_create_map(&rootArray, &map, 3);
223 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF,
224 sizeof(OC_RSRVD_HREF) - 1,
228 err = err | cbor_encode_text_string(&map, OC_RSRVD_SERVER_INSTANCE_ID,
229 sizeof(OC_RSRVD_SERVER_INSTANCE_ID) - 1);
230 err = err | cbor_encode_byte_string(&map, resource->sid, UUID_SIZE);
234 err = err | cbor_encode_text_string(&map, OC_RSRVD_PROPERTY,
235 sizeof(OC_RSRVD_PROPERTY) -1 );
236 err = err | cbor_encoder_create_map(&map, &propMap, 3);
241 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_RESOURCE_TYPE,
242 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
243 err = err | cbor_encoder_create_array(&propMap, &rtArray, CborIndefiniteLength);
245 OCStringLL* rtPtr = resource->types;
248 err = err | cbor_encode_text_string(&rtArray, rtPtr->value,
249 strlen(rtPtr->value));
253 err = err | cbor_encoder_close_container(&propMap, &rtArray);
259 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_INTERFACE,
260 sizeof(OC_RSRVD_INTERFACE) - 1);
261 err = err | cbor_encoder_create_array(&propMap, &ifArray, CborIndefiniteLength);
262 OCStringLL* ifPtr = resource->interfaces;
266 err = err | cbor_encode_text_string(&ifArray, ifPtr->value,
267 strlen(ifPtr->value));
271 err = err | cbor_encoder_close_container(&propMap, &ifArray);
275 CborEncoder policyMap;
276 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_POLICY,
277 sizeof(OC_RSRVD_POLICY) - 1);
278 err = err | cbor_encoder_create_map(&propMap, &policyMap, CborIndefiniteLength);
281 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP,
282 sizeof(OC_RSRVD_BITMAP) - 1);
283 err = err | cbor_encode_uint(&policyMap, resource->bitmap);
287 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
288 sizeof(OC_RSRVD_SECURE) - 1);
289 err = err | cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
291 if(resource->port != 0)
293 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
294 sizeof(OC_RSRVD_HOSTING_PORT) - 1);
295 err = err | cbor_encode_uint(&policyMap, resource->port);
299 err = err | cbor_encoder_close_container(&propMap, &policyMap);
302 err = err | cbor_encoder_close_container(&map, &propMap);
305 err = err | cbor_encoder_close_container(&rootArray, &map);
308 err = err | cbor_encoder_close_container(&encoder, &rootArray);
310 return checkError(err, &encoder, outPayload, size);
313 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
316 CborEncoder encoder = {0};
319 cbor_encoder_init(&encoder, outPayload, *size, 0);
320 CborEncoder rootArray;
321 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
325 err = err | cbor_encoder_create_map(&rootArray, &map, 2);
328 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
334 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
335 sizeof(OC_RSRVD_REPRESENTATION) - 1);
336 err = err | cbor_encoder_create_map(&map, &repMap, 4);
339 err = err | cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID,
340 sizeof(OC_RSRVD_DEVICE_ID) - 1);
341 err = err | cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
344 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
345 sizeof(OC_RSRVD_DEVICE_NAME) - 1,
346 payload->deviceName);
348 // Device Spec Version
349 err = err | AddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
350 sizeof(OC_RSRVD_SPEC_VERSION) - 1,
351 payload->specVersion);
353 // Device data Model Version
354 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
355 sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1,
356 payload->dataModelVersion);
358 err = err | cbor_encoder_close_container(&map, &repMap);
362 err = err | cbor_encoder_close_container(&rootArray, &map);
366 err = err | cbor_encoder_close_container(&encoder, &rootArray);
368 return checkError(err, &encoder, outPayload, size);
371 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
374 CborEncoder encoder = {0};
377 cbor_encoder_init(&encoder, outPayload, *size, 0);
378 CborEncoder rootArray;
379 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
382 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
385 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
391 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
392 sizeof(OC_RSRVD_REPRESENTATION) - 1);
393 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
396 err = err | AddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
397 sizeof(OC_RSRVD_PLATFORM_ID) - 1,
398 payload->info.platformID);
401 err = err | AddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
402 sizeof(OC_RSRVD_MFG_NAME) - 1,
403 payload->info.manufacturerName);
406 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
407 sizeof(OC_RSRVD_MFG_URL) - 1,
408 payload->info.manufacturerUrl);
411 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
412 sizeof(OC_RSRVD_MODEL_NUM) - 1,
413 payload->info.modelNumber);
416 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
417 sizeof(OC_RSRVD_MFG_DATE) - 1,
418 payload->info.dateOfManufacture);
421 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
422 sizeof(OC_RSRVD_PLATFORM_VERSION) - 1,
423 payload->info.platformVersion);
426 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
427 sizeof(OC_RSRVD_OS_VERSION) - 1,
428 payload->info.operatingSystemVersion);
431 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
432 sizeof(OC_RSRVD_HARDWARE_VERSION) - 1,
433 payload->info.hardwareVersion);
436 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
437 sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1,
438 payload->info.firmwareVersion);
441 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
442 sizeof(OC_RSRVD_SUPPORT_URL) - 1,
443 payload->info.supportUrl);
446 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
447 sizeof(OC_RSRVD_SYSTEM_TIME) - 1,
448 payload->info.systemTime);
449 err = err | cbor_encoder_close_container(&map, &repMap);
453 err = err | cbor_encoder_close_container(&rootArray, &map);
457 err = err | cbor_encoder_close_container(&encoder, &rootArray);
459 return checkError(err, &encoder, outPayload, size);
462 static int64_t OCConvertArrayItem(CborEncoder* array, const OCRepPayloadValueArray* valArray,
466 switch (valArray->type)
468 case OCREP_PROP_NULL:
469 OC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
470 err = CborUnknownError;
473 err = err | cbor_encode_int(array, valArray->iArray[index]);
475 case OCREP_PROP_DOUBLE:
476 err = err | cbor_encode_double(array, valArray->dArray[index]);
478 case OCREP_PROP_BOOL:
479 err = err | cbor_encode_boolean(array, valArray->bArray[index]);
481 case OCREP_PROP_STRING:
482 if (!valArray->strArray[index])
484 err = err | cbor_encode_null(array);
488 err = err | cbor_encode_text_string(array, valArray->strArray[index],
489 strlen(valArray->strArray[index]));
492 case OCREP_PROP_OBJECT:
493 if (!valArray->objArray[index])
495 err = err | cbor_encode_null(array);
499 err = OCConvertSingleRepPayload(array, valArray->objArray[index]);
502 case OCREP_PROP_ARRAY:
503 OC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
504 err = CborUnknownError;
510 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray)
515 err = err | cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
517 for (size_t i = 0; i < valArray->dimensions[0];++i)
519 if (valArray->dimensions[1] != 0)
522 err = err | cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
524 for (size_t j = 0; j < valArray->dimensions[1]; ++j)
526 if (valArray->dimensions[2] != 0)
529 err = err | cbor_encoder_create_array(&array2, &array3,
530 valArray->dimensions[2]);
532 for(size_t k = 0; k < valArray->dimensions[2]; ++k)
534 OCConvertArrayItem(&array3, valArray,
535 j * valArray->dimensions[2] +
536 i * valArray->dimensions[2] * valArray->dimensions[1] +
539 err = err | cbor_encoder_close_container(&array2, &array3);
543 OCConvertArrayItem(&array2, valArray,
544 i * valArray->dimensions[1] + j);
547 err = err | cbor_encoder_close_container(&array, &array2);
551 OCConvertArrayItem(&array, valArray, i);
554 err = err | cbor_encoder_close_container(parent, &array);
558 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload)
562 err = err | cbor_encoder_create_map(parent, &map, CborIndefiniteLength);
565 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF,
566 sizeof(OC_RSRVD_HREF) - 1,
570 // resource types, interfaces
571 if(payload->types || payload->interfaces)
573 OC_LOG(INFO, TAG, "Payload has types or interfaces");
574 err = err | cbor_encode_text_string(&map,
576 sizeof(OC_RSRVD_PROPERTY) - 1);
578 err = err | cbor_encoder_create_map(&map, &propMap, 2);
580 CborEncoder curArray;
583 err = err | cbor_encode_text_string(&propMap,
584 OC_RSRVD_RESOURCE_TYPE,
585 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
586 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
587 OCStringLL* val = payload->types;
590 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
593 err = err | cbor_encoder_close_container(&propMap, &curArray);
595 if(payload->interfaces)
597 err = err | cbor_encode_text_string(&propMap,
599 sizeof(OC_RSRVD_INTERFACE) - 1);
600 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
601 OCStringLL* val = payload->interfaces;
604 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
607 err = err | cbor_encoder_close_container(&propMap, &curArray);
609 err = err | cbor_encoder_close_container(&map, &propMap);
615 err = err | cbor_encode_text_string(&map,
616 OC_RSRVD_REPRESENTATION,
617 sizeof(OC_RSRVD_REPRESENTATION) - 1);
618 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
619 OCRepPayloadValue* value = payload->values;
622 err = err | cbor_encode_text_string(&repMap,
624 strlen(value->name));
627 case OCREP_PROP_NULL:
628 err = err | cbor_encode_null(&repMap);
631 err = err | cbor_encode_int(&repMap,
634 case OCREP_PROP_DOUBLE:
635 err = err | cbor_encode_double(&repMap,
638 case OCREP_PROP_BOOL:
639 err = err | cbor_encode_boolean(&repMap,
642 case OCREP_PROP_STRING:
643 err = err | cbor_encode_text_string(&repMap,
644 value->str, strlen(value->str));
646 case OCREP_PROP_OBJECT:
647 err = err | OCConvertSingleRepPayload(&repMap, value->obj);
649 case OCREP_PROP_ARRAY:
650 err = err | OCConvertArray(&repMap, &value->arr);
653 OC_LOG_V(ERROR, TAG, "Invalid Prop type: %d",
660 err = err | cbor_encoder_close_container(&map, &repMap);
664 err = err | cbor_encoder_close_container(parent, &map);
669 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size)
671 CborEncoder encoder = {0};
674 cbor_encoder_init(&encoder, outPayload, *size, 0);
675 CborEncoder rootArray;
676 err = err | cbor_encoder_create_array(&encoder, &rootArray, CborIndefiniteLength);
678 while(payload != NULL && (err == 0 || err == CborErrorOutOfMemory))
680 err = err | OCConvertSingleRepPayload(&rootArray, payload);
681 payload = payload->next;
685 err = err | cbor_encoder_close_container(&encoder, &rootArray);
687 return checkError(err, &encoder, outPayload, size);
690 static int64_t OCConvertPresencePayload(OCPresencePayload* payload,
691 uint8_t* outPayload, size_t* size)
693 CborEncoder encoder = {0};
696 cbor_encoder_init(&encoder, outPayload, *size, 0);
697 CborEncoder rootArray;
699 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
702 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
705 err = err | cbor_encode_text_string(&map,
707 sizeof(OC_RSRVD_NONCE) - 1);
708 err = err | cbor_encode_uint(&map, payload->sequenceNumber);
711 err = err | cbor_encode_text_string(&map,
713 sizeof(OC_RSRVD_TTL) - 1);
714 err = err | cbor_encode_uint(&map, payload->maxAge);
717 const char* triggerStr = convertTriggerEnumToString(payload->trigger);
718 err = err | AddTextStringToMap(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1,
721 // Resource type name
722 if(payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
724 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
725 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
729 err = err | cbor_encoder_close_container(&rootArray, &map);
730 err = err | cbor_encoder_close_container(&encoder, &rootArray);
732 return checkError(err, &encoder, outPayload, size);
735 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
738 return cbor_encode_text_string(map, key, keylen) |
739 cbor_encode_text_string(map, value, strlen(value));
742 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
745 return value ? AddTextStringToMap(map, key, keylen, value) : 0;