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"
32 #define TAG "OCPayloadConvert"
33 // Arbitrarily chosen size that seems to contain the majority of packages
34 #define INIT_SIZE (255)
36 // Functions all return either a CborError, or a negative version of the OC_STACK return values
37 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size);
38 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
40 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
42 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
44 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size);
45 static int64_t OCConvertPresencePayload(OCPresencePayload* payload, uint8_t* outPayload,
47 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
49 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload);
50 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray);
52 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
55 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
58 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
60 // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
61 // strategy to work. If you receive the following assertion error, please do a git-pull
62 // from the extlibs/tinycbor/tinycbor directory
63 #define CborNeedsUpdating (CborErrorOutOfMemory < CborErrorDataTooLarge)
64 OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
65 #undef CborNeedsUpdating
68 OC_LOG(ERROR, TAG, "Payload parameter NULL");
69 return OC_STACK_INVALID_PARAM;
72 if (!outPayload || !size)
74 OC_LOG(ERROR, TAG, "Out parameter/s parameter NULL");
75 return OC_STACK_INVALID_PARAM;
78 OC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
80 size_t curSize = INIT_SIZE;
81 uint8_t* out = (uint8_t*)OICCalloc(1, curSize);
82 int64_t err = OCConvertPayloadHelper(payload, out, &curSize);
84 if (err == CborErrorOutOfMemory)
86 // reallocate "out" and try again!
87 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
92 return OC_STACK_NO_MEMORY;
96 err = OCConvertPayloadHelper(payload, out, &curSize);
101 if (curSize < INIT_SIZE)
103 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
108 return OC_STACK_NO_MEMORY;
120 return (OCStackResult)-err;
124 return OC_STACK_ERROR;
128 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
130 switch(payload->type)
132 case PAYLOAD_TYPE_DISCOVERY:
133 return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
134 case PAYLOAD_TYPE_DEVICE:
135 return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
136 case PAYLOAD_TYPE_PLATFORM:
137 return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
138 case PAYLOAD_TYPE_REPRESENTATION:
139 return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
140 case PAYLOAD_TYPE_PRESENCE:
141 return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
142 case PAYLOAD_TYPE_SECURITY:
143 return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
145 OC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
146 return OC_STACK_NOTIMPL;
150 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
152 if (err == CborErrorOutOfMemory)
154 *size += encoder->ptr - encoder->end;
159 OC_LOG_V(ERROR, TAG, "Convert Payload failed", err);
164 *size = encoder->ptr - outPayload;
168 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
174 cbor_encoder_init(&encoder, outPayload, *size, 0);
176 CborEncoder rootArray;
177 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
180 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
182 if(payload->securityData)
184 err = err | AddTextStringToMap(&map, OC_RSRVD_REPRESENTATION,
185 sizeof(OC_RSRVD_REPRESENTATION) - 1,
186 payload->securityData);
189 err = err | cbor_encoder_close_container(&rootArray, &map);
191 err = err | cbor_encoder_close_container(&encoder, &rootArray);
192 return checkError(err, &encoder, outPayload, size);
196 static char* OCStringLLJoin(OCStringLL* val)
198 OCStringLL* temp = val;
199 size_t size = strlen(temp->value);
205 size += strlen(temp->value);
208 char* joinedStr = (char*)OICCalloc(sizeof(char), size + 1);
215 OICStrcat(joinedStr, size + 1, val->value);
219 OICStrcat(joinedStr, size + 1, " ");
220 OICStrcat(joinedStr, size + 1, val->value);
225 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
228 CborEncoder encoder = {0};
230 size_t resourceCount = OCDiscoveryPayloadGetResourceCount(payload);
232 cbor_encoder_init(&encoder, outPayload, *size, 0);
234 CborEncoder rootArray;
235 err = err | cbor_encoder_create_array(&encoder, &rootArray, resourceCount);
237 for(size_t i = 0; i < resourceCount; ++i)
240 OCResourcePayload* resource = OCDiscoveryPayloadGetResource(payload, i);
244 return OC_STACK_INVALID_PARAM;
247 err = err | cbor_encoder_create_map(&rootArray, &map, 3);
249 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF,
250 sizeof(OC_RSRVD_HREF) - 1,
254 err = err | cbor_encode_text_string(&map, OC_RSRVD_SERVER_INSTANCE_ID,
255 sizeof(OC_RSRVD_SERVER_INSTANCE_ID) - 1);
256 err = err | cbor_encode_byte_string(&map, resource->sid, UUID_SIZE);
260 err = err | cbor_encode_text_string(&map, OC_RSRVD_PROPERTY,
261 sizeof(OC_RSRVD_PROPERTY) -1 );
262 err = err | cbor_encoder_create_map(&map, &propMap, 3);
267 char* joinedTypes = OCStringLLJoin(resource->types);
270 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_RESOURCE_TYPE,
271 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
272 err = err | cbor_encode_text_string(&propMap, joinedTypes,
273 strlen(joinedTypes));
274 OICFree(joinedTypes);
278 return OC_STACK_NO_MEMORY;
282 if (resource->interfaces)
284 char* joinedInterfaces = OCStringLLJoin(resource->interfaces);
285 if (joinedInterfaces)
287 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_INTERFACE,
288 sizeof(OC_RSRVD_INTERFACE) - 1);
289 err = err | cbor_encode_text_string(&propMap, joinedInterfaces,
290 strlen(joinedInterfaces));
291 OICFree(joinedInterfaces);
295 return OC_STACK_NO_MEMORY;
301 CborEncoder policyMap;
302 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_POLICY,
303 sizeof(OC_RSRVD_POLICY) - 1);
304 err = err | cbor_encoder_create_map(&propMap, &policyMap, CborIndefiniteLength);
307 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP,
308 sizeof(OC_RSRVD_BITMAP) - 1);
309 err = err | cbor_encode_uint(&policyMap, resource->bitmap);
313 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
314 sizeof(OC_RSRVD_SECURE) - 1);
315 err = err | cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
317 if(resource->port != 0)
319 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
320 sizeof(OC_RSRVD_HOSTING_PORT) - 1);
321 err = err | cbor_encode_uint(&policyMap, resource->port);
325 err = err | cbor_encoder_close_container(&propMap, &policyMap);
328 err = err | cbor_encoder_close_container(&map, &propMap);
331 err = err | cbor_encoder_close_container(&rootArray, &map);
334 err = err | cbor_encoder_close_container(&encoder, &rootArray);
336 return checkError(err, &encoder, outPayload, size);
339 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
342 CborEncoder encoder = {0};
345 cbor_encoder_init(&encoder, outPayload, *size, 0);
346 CborEncoder rootArray;
347 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
351 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
354 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
360 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
361 sizeof(OC_RSRVD_REPRESENTATION) - 1);
362 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
365 err = err | cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID,
366 sizeof(OC_RSRVD_DEVICE_ID) - 1);
367 err = err | cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
370 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
371 sizeof(OC_RSRVD_DEVICE_NAME) - 1,
372 payload->deviceName);
374 // Device Spec Version
375 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
376 sizeof(OC_RSRVD_SPEC_VERSION) - 1,
377 payload->specVersion);
379 // Device data Model Version
380 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
381 sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1,
382 payload->dataModelVersion);
384 err = err | cbor_encoder_close_container(&map, &repMap);
388 err = err | cbor_encoder_close_container(&rootArray, &map);
392 err = err | cbor_encoder_close_container(&encoder, &rootArray);
394 return checkError(err, &encoder, outPayload, size);
397 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
400 CborEncoder encoder = {0};
403 cbor_encoder_init(&encoder, outPayload, *size, 0);
404 CborEncoder rootArray;
405 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
408 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
411 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
417 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
418 sizeof(OC_RSRVD_REPRESENTATION) - 1);
419 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
422 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
423 sizeof(OC_RSRVD_PLATFORM_ID) - 1,
424 payload->info.platformID);
427 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
428 sizeof(OC_RSRVD_MFG_NAME) - 1,
429 payload->info.manufacturerName);
432 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
433 sizeof(OC_RSRVD_MFG_URL) - 1,
434 payload->info.manufacturerUrl);
437 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
438 sizeof(OC_RSRVD_MODEL_NUM) - 1,
439 payload->info.modelNumber);
442 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
443 sizeof(OC_RSRVD_MFG_DATE) - 1,
444 payload->info.dateOfManufacture);
447 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
448 sizeof(OC_RSRVD_PLATFORM_VERSION) - 1,
449 payload->info.platformVersion);
452 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
453 sizeof(OC_RSRVD_OS_VERSION) - 1,
454 payload->info.operatingSystemVersion);
457 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
458 sizeof(OC_RSRVD_HARDWARE_VERSION) - 1,
459 payload->info.hardwareVersion);
462 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
463 sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1,
464 payload->info.firmwareVersion);
467 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
468 sizeof(OC_RSRVD_SUPPORT_URL) - 1,
469 payload->info.supportUrl);
472 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
473 sizeof(OC_RSRVD_SYSTEM_TIME) - 1,
474 payload->info.systemTime);
475 err = err | cbor_encoder_close_container(&map, &repMap);
479 err = err | cbor_encoder_close_container(&rootArray, &map);
483 err = err | cbor_encoder_close_container(&encoder, &rootArray);
485 return checkError(err, &encoder, outPayload, size);
488 static int64_t OCConvertArrayItem(CborEncoder* array, const OCRepPayloadValueArray* valArray,
492 switch (valArray->type)
494 case OCREP_PROP_NULL:
495 OC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
496 err = CborUnknownError;
499 err = err | cbor_encode_int(array, valArray->iArray[index]);
501 case OCREP_PROP_DOUBLE:
502 err = err | cbor_encode_double(array, valArray->dArray[index]);
504 case OCREP_PROP_BOOL:
505 err = err | cbor_encode_boolean(array, valArray->bArray[index]);
507 case OCREP_PROP_STRING:
508 if (!valArray->strArray[index])
510 err = err | cbor_encode_null(array);
514 err = err | cbor_encode_text_string(array, valArray->strArray[index],
515 strlen(valArray->strArray[index]));
518 case OCREP_PROP_OBJECT:
519 if (!valArray->objArray[index])
521 err = err | cbor_encode_null(array);
525 err = OCConvertSingleRepPayload(array, valArray->objArray[index]);
528 case OCREP_PROP_ARRAY:
529 OC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
530 err = CborUnknownError;
536 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray)
541 err = err | cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
543 for (size_t i = 0; i < valArray->dimensions[0];++i)
545 if (valArray->dimensions[1] != 0)
548 err = err | cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
550 for (size_t j = 0; j < valArray->dimensions[1]; ++j)
552 if (valArray->dimensions[2] != 0)
555 err = err | cbor_encoder_create_array(&array2, &array3,
556 valArray->dimensions[2]);
558 for(size_t k = 0; k < valArray->dimensions[2]; ++k)
560 OCConvertArrayItem(&array3, valArray,
561 j * valArray->dimensions[2] +
562 i * valArray->dimensions[2] * valArray->dimensions[1] +
565 err = err | cbor_encoder_close_container(&array2, &array3);
569 OCConvertArrayItem(&array2, valArray,
570 i * valArray->dimensions[1] + j);
573 err = err | cbor_encoder_close_container(&array, &array2);
577 OCConvertArrayItem(&array, valArray, i);
580 err = err | cbor_encoder_close_container(parent, &array);
584 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload)
588 err = err | cbor_encoder_create_map(parent, &map, CborIndefiniteLength);
591 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF,
592 sizeof(OC_RSRVD_HREF) - 1,
596 // resource types, interfaces
597 if(payload->types || payload->interfaces)
599 OC_LOG(INFO, TAG, "Payload has types or interfaces");
600 err = err | cbor_encode_text_string(&map,
602 sizeof(OC_RSRVD_PROPERTY) - 1);
604 err = err | cbor_encoder_create_map(&map, &propMap, 2);
608 char* joinedTypes = OCStringLLJoin(payload->types);
611 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_RESOURCE_TYPE,
612 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
613 err = err | cbor_encode_text_string(&propMap, joinedTypes,
614 strlen(joinedTypes));
615 OICFree(joinedTypes);
619 return OC_STACK_NO_MEMORY;
622 if (payload->interfaces)
624 char* joinedInterfaces = OCStringLLJoin(payload->interfaces);
625 if (joinedInterfaces)
627 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_INTERFACE,
628 sizeof(OC_RSRVD_INTERFACE) - 1);
629 err = err | cbor_encode_text_string(&propMap, joinedInterfaces,
630 strlen(joinedInterfaces));
631 OICFree(joinedInterfaces);
635 return OC_STACK_NO_MEMORY;
638 err = err | cbor_encoder_close_container(&map, &propMap);
644 err = err | cbor_encode_text_string(&map,
645 OC_RSRVD_REPRESENTATION,
646 sizeof(OC_RSRVD_REPRESENTATION) - 1);
647 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
648 OCRepPayloadValue* value = payload->values;
651 err = err | cbor_encode_text_string(&repMap,
653 strlen(value->name));
656 case OCREP_PROP_NULL:
657 err = err | cbor_encode_null(&repMap);
660 err = err | cbor_encode_int(&repMap,
663 case OCREP_PROP_DOUBLE:
664 err = err | cbor_encode_double(&repMap,
667 case OCREP_PROP_BOOL:
668 err = err | cbor_encode_boolean(&repMap,
671 case OCREP_PROP_STRING:
672 err = err | cbor_encode_text_string(&repMap,
673 value->str, strlen(value->str));
675 case OCREP_PROP_OBJECT:
676 err = err | OCConvertSingleRepPayload(&repMap, value->obj);
678 case OCREP_PROP_ARRAY:
679 err = err | OCConvertArray(&repMap, &value->arr);
682 OC_LOG_V(ERROR, TAG, "Invalid Prop type: %d",
689 err = err | cbor_encoder_close_container(&map, &repMap);
693 err = err | cbor_encoder_close_container(parent, &map);
698 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size)
700 CborEncoder encoder = {0};
703 cbor_encoder_init(&encoder, outPayload, *size, 0);
704 CborEncoder rootArray;
705 err = err | cbor_encoder_create_array(&encoder, &rootArray, CborIndefiniteLength);
707 while(payload != NULL && (err == 0 || err == CborErrorOutOfMemory))
709 err = err | OCConvertSingleRepPayload(&rootArray, payload);
710 payload = payload->next;
714 err = err | cbor_encoder_close_container(&encoder, &rootArray);
716 return checkError(err, &encoder, outPayload, size);
719 static int64_t OCConvertPresencePayload(OCPresencePayload* payload,
720 uint8_t* outPayload, size_t* size)
722 CborEncoder encoder = {0};
725 cbor_encoder_init(&encoder, outPayload, *size, 0);
726 CborEncoder rootArray;
728 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1);
731 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
734 err = err | cbor_encode_text_string(&map,
736 sizeof(OC_RSRVD_NONCE) - 1);
737 err = err | cbor_encode_uint(&map, payload->sequenceNumber);
740 err = err | cbor_encode_text_string(&map,
742 sizeof(OC_RSRVD_TTL) - 1);
743 err = err | cbor_encode_uint(&map, payload->maxAge);
746 const char* triggerStr = convertTriggerEnumToString(payload->trigger);
747 err = err | AddTextStringToMap(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1,
750 // Resource type name
751 if(payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
753 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
754 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
758 err = err | cbor_encoder_close_container(&rootArray, &map);
759 err = err | cbor_encoder_close_container(&encoder, &rootArray);
761 return checkError(err, &encoder, outPayload, size);
764 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
767 return cbor_encode_text_string(map, key, keylen) |
768 cbor_encode_text_string(map, value, strlen(value));
771 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
774 return value ? AddTextStringToMap(map, key, keylen, value) : 0;