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 #define STRINGIFY(s) XSTRINGIFY(s)
58 #define XSTRINGIFY(s) #s
60 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
62 // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
63 // strategy to work. If you receive the following assertion error, please do a git-pull
64 // from the extlibs/tinycbor/tinycbor directory
65 #define CborNeedsUpdating (CborErrorOutOfMemory < CborErrorDataTooLarge)
66 OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
67 #undef CborNeedsUpdating
70 OC_LOG(ERROR, TAG, "Payload parameter NULL");
71 return OC_STACK_INVALID_PARAM;
74 if (!outPayload || !size)
76 OC_LOG(ERROR, TAG, "Out parameter/s parameter NULL");
77 return OC_STACK_INVALID_PARAM;
80 OC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
82 size_t curSize = INIT_SIZE;
83 uint8_t* out = (uint8_t*)OICCalloc(1, curSize);
84 int64_t err = OCConvertPayloadHelper(payload, out, &curSize);
86 if (err == CborErrorOutOfMemory)
88 // reallocate "out" and try again!
89 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
94 return OC_STACK_NO_MEMORY;
98 err = OCConvertPayloadHelper(payload, out, &curSize);
103 if (curSize < INIT_SIZE)
105 uint8_t* out2 = (uint8_t*)OICRealloc(out, curSize);
110 return OC_STACK_NO_MEMORY;
122 return (OCStackResult)-err;
126 return OC_STACK_ERROR;
130 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
132 switch(payload->type)
134 case PAYLOAD_TYPE_DISCOVERY:
135 return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
136 case PAYLOAD_TYPE_DEVICE:
137 return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
138 case PAYLOAD_TYPE_PLATFORM:
139 return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
140 case PAYLOAD_TYPE_REPRESENTATION:
141 return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
142 case PAYLOAD_TYPE_PRESENCE:
143 return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
144 case PAYLOAD_TYPE_SECURITY:
145 return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
147 OC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
148 return OC_STACK_NOTIMPL;
152 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
154 if (err == CborErrorOutOfMemory)
156 *size += encoder->ptr - encoder->end;
161 OC_LOG_V(ERROR, TAG, "Convert Payload failed", err);
166 *size = encoder->ptr - outPayload;
170 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
176 cbor_encoder_init(&encoder, outPayload, *size, 0);
178 CborEncoder rootArray;
179 err = err | cbor_encoder_create_array(&encoder, &rootArray, 2);
180 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_SECURITY);
184 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
186 if(payload->securityData)
188 err = err | AddTextStringToMap(&map, OC_RSRVD_REPRESENTATION,
189 sizeof(OC_RSRVD_REPRESENTATION) - 1,
190 payload->securityData);
193 err = err | cbor_encoder_close_container(&rootArray, &map);
195 err = err | cbor_encoder_close_container(&encoder, &rootArray);
196 return checkError(err, &encoder, outPayload, size);
200 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
203 CborEncoder encoder = {0};
205 size_t resourceCount = OCDiscoveryPayloadGetResourceCount(payload);
207 cbor_encoder_init(&encoder, outPayload, *size, 0);
209 CborEncoder rootArray;
210 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1 + resourceCount);
211 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_DISCOVERY);
213 for(size_t i = 0; i < resourceCount; ++i)
216 OCResourcePayload* resource = OCDiscoveryPayloadGetResource(payload, i);
220 return OC_STACK_INVALID_PARAM;
223 err = err | cbor_encoder_create_map(&rootArray, &map, 3);
225 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF,
226 sizeof(OC_RSRVD_HREF) - 1,
230 err = err | cbor_encode_text_string(&map, OC_RSRVD_SERVER_INSTANCE_ID,
231 sizeof(OC_RSRVD_SERVER_INSTANCE_ID) - 1);
232 err = err | cbor_encode_byte_string(&map, resource->sid, UUID_SIZE);
236 err = err | cbor_encode_text_string(&map, OC_RSRVD_PROPERTY,
237 sizeof(OC_RSRVD_PROPERTY) -1 );
238 err = err | cbor_encoder_create_map(&map, &propMap, 3);
243 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_RESOURCE_TYPE,
244 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
245 err = err | cbor_encoder_create_array(&propMap, &rtArray, CborIndefiniteLength);
247 OCStringLL* rtPtr = resource->types;
250 err = err | cbor_encode_text_string(&rtArray, rtPtr->value,
251 strlen(rtPtr->value));
255 err = err | cbor_encoder_close_container(&propMap, &rtArray);
261 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_INTERFACE,
262 sizeof(OC_RSRVD_INTERFACE) - 1);
263 err = err | cbor_encoder_create_array(&propMap, &ifArray, CborIndefiniteLength);
264 OCStringLL* ifPtr = resource->interfaces;
268 err = err | cbor_encode_text_string(&ifArray, ifPtr->value,
269 strlen(ifPtr->value));
273 err = err | cbor_encoder_close_container(&propMap, &ifArray);
277 CborEncoder policyMap;
278 err = err | cbor_encode_text_string(&propMap, OC_RSRVD_POLICY,
279 sizeof(OC_RSRVD_POLICY) - 1);
280 err = err | cbor_encoder_create_map(&propMap, &policyMap, CborIndefiniteLength);
283 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP,
284 sizeof(OC_RSRVD_BITMAP) - 1);
285 err = err | cbor_encode_uint(&policyMap, resource->bitmap);
289 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
290 sizeof(OC_RSRVD_SECURE) - 1);
291 err = err | cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
293 if(resource->port != 0)
295 err = err | cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
296 sizeof(OC_RSRVD_HOSTING_PORT) - 1);
297 err = err | cbor_encode_uint(&policyMap, resource->port);
301 err = err | cbor_encoder_close_container(&propMap, &policyMap);
304 err = err | cbor_encoder_close_container(&map, &propMap);
307 err = err | cbor_encoder_close_container(&rootArray, &map);
310 err = err | cbor_encoder_close_container(&encoder, &rootArray);
312 return checkError(err, &encoder, outPayload, size);
315 static int64_t OCConvertDevicePayload(OCDevicePayload* payload, uint8_t* outPayload,
318 CborEncoder encoder = {0};
321 cbor_encoder_init(&encoder, outPayload, *size, 0);
322 CborEncoder rootArray;
323 err = err | cbor_encoder_create_array(&encoder, &rootArray, 2);
324 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_DEVICE);
328 err = err | cbor_encoder_create_map(&rootArray, &map, 2);
331 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
337 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
338 sizeof(OC_RSRVD_REPRESENTATION) - 1);
339 err = err | cbor_encoder_create_map(&map, &repMap, 4);
342 err = err | cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID,
343 sizeof(OC_RSRVD_DEVICE_ID) - 1);
344 err = err | cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
347 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
348 sizeof(OC_RSRVD_DEVICE_NAME) - 1,
349 payload->deviceName);
351 // Device Spec Version
352 err = err | AddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
353 sizeof(OC_RSRVD_SPEC_VERSION) - 1,
354 payload->specVersion);
356 // Device data Model Version
357 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
358 sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1,
359 payload->dataModelVersion);
361 err = err | cbor_encoder_close_container(&map, &repMap);
365 err = err | cbor_encoder_close_container(&rootArray, &map);
369 err = err | cbor_encoder_close_container(&encoder, &rootArray);
371 return checkError(err, &encoder, outPayload, size);
374 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
377 CborEncoder encoder = {0};
380 cbor_encoder_init(&encoder, outPayload, *size, 0);
381 CborEncoder rootArray;
382 err = err | cbor_encoder_create_array(&encoder, &rootArray, 2);
383 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_PLATFORM);
386 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
389 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
395 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
396 sizeof(OC_RSRVD_REPRESENTATION) - 1);
397 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
400 err = err | AddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
401 sizeof(OC_RSRVD_PLATFORM_ID) - 1,
402 payload->info.platformID);
405 err = err | AddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
406 sizeof(OC_RSRVD_MFG_NAME) - 1,
407 payload->info.manufacturerName);
410 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
411 sizeof(OC_RSRVD_MFG_URL) - 1,
412 payload->info.manufacturerUrl);
415 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
416 sizeof(OC_RSRVD_MODEL_NUM) - 1,
417 payload->info.modelNumber);
420 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
421 sizeof(OC_RSRVD_MFG_DATE) - 1,
422 payload->info.dateOfManufacture);
425 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
426 sizeof(OC_RSRVD_PLATFORM_VERSION) - 1,
427 payload->info.platformVersion);
430 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
431 sizeof(OC_RSRVD_OS_VERSION) - 1,
432 payload->info.operatingSystemVersion);
435 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
436 sizeof(OC_RSRVD_HARDWARE_VERSION) - 1,
437 payload->info.hardwareVersion);
440 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
441 sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1,
442 payload->info.firmwareVersion);
445 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
446 sizeof(OC_RSRVD_SUPPORT_URL) - 1,
447 payload->info.supportUrl);
450 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
451 sizeof(OC_RSRVD_SYSTEM_TIME) - 1,
452 payload->info.systemTime);
453 err = err | cbor_encoder_close_container(&map, &repMap);
457 err = err | cbor_encoder_close_container(&rootArray, &map);
461 err = err | cbor_encoder_close_container(&encoder, &rootArray);
463 return checkError(err, &encoder, outPayload, size);
466 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray)
471 err = err | cbor_encoder_create_array(parent, &array, CborIndefiniteLength);
472 err = err | cbor_encode_uint(&array, valArray->type);
473 for(int i = 0; i < MAX_REP_ARRAY_DEPTH; ++i)
475 err = err | cbor_encode_uint(&array, valArray->dimensions[i]);
478 size_t dimTotal = calcDimTotal(valArray->dimensions);
480 for(size_t i = 0; i < dimTotal; ++i)
482 switch(valArray->type)
484 case OCREP_PROP_NULL:
485 OC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
486 err = CborUnknownError;
489 err = err | cbor_encode_int(&array, valArray->iArray[i]);
491 case OCREP_PROP_DOUBLE:
492 err = err | cbor_encode_double(&array, valArray->dArray[i]);
494 case OCREP_PROP_BOOL:
495 err = err | cbor_encode_boolean(&array, valArray->bArray[i]);
497 case OCREP_PROP_STRING:
498 err = err | cbor_encode_text_string(&array, valArray->strArray[i],
499 strlen(valArray->strArray[i]));
501 case OCREP_PROP_OBJECT:
502 err = OCConvertSingleRepPayload(&array, valArray->objArray[i]);
504 case OCREP_PROP_ARRAY:
505 OC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
506 err = CborUnknownError;
511 err = err | cbor_encoder_close_container(parent, &array);
515 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload)
519 err = err | cbor_encoder_create_map(parent, &map, CborIndefiniteLength);
522 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF,
523 sizeof(OC_RSRVD_HREF) - 1,
527 // resource types, interfaces
528 if(payload->types || payload->interfaces)
530 OC_LOG(INFO, TAG, "Payload has types or interfaces");
531 err = err | cbor_encode_text_string(&map,
533 sizeof(OC_RSRVD_PROPERTY) - 1);
535 err = err | cbor_encoder_create_map(&map, &propMap, 2);
537 CborEncoder curArray;
540 err = err | cbor_encode_text_string(&propMap,
541 OC_RSRVD_RESOURCE_TYPE,
542 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
543 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
544 OCStringLL* val = payload->types;
547 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
550 err = err | cbor_encoder_close_container(&propMap, &curArray);
552 if(payload->interfaces)
554 err = err | cbor_encode_text_string(&propMap,
556 sizeof(OC_RSRVD_INTERFACE) - 1);
557 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
558 OCStringLL* val = payload->interfaces;
561 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
564 err = err | cbor_encoder_close_container(&propMap, &curArray);
566 err = err | cbor_encoder_close_container(&map, &propMap);
572 err = err | cbor_encode_text_string(&map,
573 OC_RSRVD_REPRESENTATION,
574 sizeof(OC_RSRVD_REPRESENTATION) - 1);
575 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
576 OCRepPayloadValue* value = payload->values;
579 err = err | cbor_encode_text_string(&repMap,
581 strlen(value->name));
584 case OCREP_PROP_NULL:
585 err = err | cbor_encode_null(&repMap);
588 err = err | cbor_encode_int(&repMap,
591 case OCREP_PROP_DOUBLE:
592 err = err | cbor_encode_double(&repMap,
595 case OCREP_PROP_BOOL:
596 err = err | cbor_encode_boolean(&repMap,
599 case OCREP_PROP_STRING:
600 err = err | cbor_encode_text_string(&repMap,
601 value->str, strlen(value->str));
603 case OCREP_PROP_OBJECT:
604 err = err | OCConvertSingleRepPayload(&repMap, value->obj);
606 case OCREP_PROP_ARRAY:
607 err = err | OCConvertArray(&repMap, &value->arr);
610 OC_LOG_V(ERROR, TAG, "Invalid Prop type: %d",
617 err = err | cbor_encoder_close_container(&map, &repMap);
621 err = err | cbor_encoder_close_container(parent, &map);
626 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size)
628 CborEncoder encoder = {0};
631 cbor_encoder_init(&encoder, outPayload, *size, 0);
632 CborEncoder rootArray;
633 err = err | cbor_encoder_create_array(&encoder, &rootArray, CborIndefiniteLength);
634 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_REPRESENTATION);
636 while(payload != NULL && (err == 0 || err == CborErrorOutOfMemory))
638 err = err | OCConvertSingleRepPayload(&rootArray, payload);
639 payload = payload->next;
643 err = err | cbor_encoder_close_container(&encoder, &rootArray);
645 return checkError(err, &encoder, outPayload, size);
648 static int64_t OCConvertPresencePayload(OCPresencePayload* payload,
649 uint8_t* outPayload, size_t* size)
651 CborEncoder encoder = {0};
654 cbor_encoder_init(&encoder, outPayload, *size, 0);
655 CborEncoder rootArray;
657 err = err | cbor_encoder_create_array(&encoder, &rootArray, 2);
658 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_PRESENCE);
662 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
665 err = err | cbor_encode_text_string(&map,
667 sizeof(OC_RSRVD_NONCE) - 1);
668 err = err | cbor_encode_uint(&map, payload->sequenceNumber);
671 err = err | cbor_encode_text_string(&map,
673 sizeof(OC_RSRVD_TTL) - 1);
674 err = err | cbor_encode_uint(&map, payload->maxAge);
677 const char* triggerStr = convertTriggerEnumToString(payload->trigger);
678 err = err | AddTextStringToMap(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1,
681 // Resource type name
682 if(payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
684 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
685 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
689 err = err | cbor_encoder_close_container(&rootArray, &map);
690 err = err | cbor_encoder_close_container(&encoder, &rootArray);
692 return checkError(err, &encoder, outPayload, size);
695 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
698 return cbor_encode_text_string(map, key, keylen) |
699 cbor_encode_text_string(map, value, strlen(value));
702 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
705 return value ? AddTextStringToMap(map, key, keylen, value) : 0;