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 PCF("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, PCF("Payload parameter NULL"));
71 return OC_STACK_INVALID_PARAM;
74 if (!outPayload || !size)
76 OC_LOG(ERROR, TAG, PCF("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;
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, 2);
178 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_SECURITY);
182 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
184 if(payload->securityData)
186 err = err | AddTextStringToMap(&map, OC_RSRVD_REPRESENTATION,
187 sizeof(OC_RSRVD_REPRESENTATION) - 1,
188 payload->securityData);
191 err = err | cbor_encoder_close_container(&rootArray, &map);
193 err = err | cbor_encoder_close_container(&encoder, &rootArray);
194 return checkError(err, &encoder, outPayload, size);
198 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload* payload, uint8_t* outPayload,
201 CborEncoder encoder = {0};
203 size_t resourceCount = OCDiscoveryPayloadGetResourceCount(payload);
205 cbor_encoder_init(&encoder, outPayload, *size, 0);
207 CborEncoder rootArray;
208 err = err | cbor_encoder_create_array(&encoder, &rootArray, 1 + resourceCount);
209 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_DISCOVERY);
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, 2);
322 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_DEVICE);
326 err = err | cbor_encoder_create_map(&rootArray, &map, 2);
329 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
335 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
336 sizeof(OC_RSRVD_REPRESENTATION) - 1);
337 err = err | cbor_encoder_create_map(&map, &repMap, 4);
340 err = err | cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID,
341 sizeof(OC_RSRVD_DEVICE_ID) - 1);
342 err = err | cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
345 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
346 sizeof(OC_RSRVD_DEVICE_NAME) - 1,
347 payload->deviceName);
349 // Device Spec Version
350 err = err | AddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
351 sizeof(OC_RSRVD_SPEC_VERSION) - 1,
352 payload->specVersion);
354 // Device data Model Version
355 err = err | AddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
356 sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1,
357 payload->dataModelVersion);
359 err = err | cbor_encoder_close_container(&map, &repMap);
363 err = err | cbor_encoder_close_container(&rootArray, &map);
367 err = err | cbor_encoder_close_container(&encoder, &rootArray);
369 return checkError(err, &encoder, outPayload, size);
372 static int64_t OCConvertPlatformPayload(OCPlatformPayload* payload, uint8_t* outPayload,
375 CborEncoder encoder = {0};
378 cbor_encoder_init(&encoder, outPayload, *size, 0);
379 CborEncoder rootArray;
380 err = err | cbor_encoder_create_array(&encoder, &rootArray, 2);
381 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_PLATFORM);
384 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
387 err = err | AddTextStringToMap(&map, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
393 err = err | cbor_encode_text_string(&map, OC_RSRVD_REPRESENTATION,
394 sizeof(OC_RSRVD_REPRESENTATION) - 1);
395 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
398 err = err | AddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
399 sizeof(OC_RSRVD_PLATFORM_ID) - 1,
400 payload->info.platformID);
403 err = err | AddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
404 sizeof(OC_RSRVD_MFG_NAME) - 1,
405 payload->info.manufacturerName);
408 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
409 sizeof(OC_RSRVD_MFG_URL) - 1,
410 payload->info.manufacturerUrl);
413 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
414 sizeof(OC_RSRVD_MODEL_NUM) - 1,
415 payload->info.modelNumber);
418 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
419 sizeof(OC_RSRVD_MFG_DATE) - 1,
420 payload->info.dateOfManufacture);
423 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
424 sizeof(OC_RSRVD_PLATFORM_VERSION) - 1,
425 payload->info.platformVersion);
428 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
429 sizeof(OC_RSRVD_OS_VERSION) - 1,
430 payload->info.operatingSystemVersion);
433 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
434 sizeof(OC_RSRVD_HARDWARE_VERSION) - 1,
435 payload->info.hardwareVersion);
438 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
439 sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1,
440 payload->info.firmwareVersion);
443 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
444 sizeof(OC_RSRVD_SUPPORT_URL) - 1,
445 payload->info.supportUrl);
448 err = err | ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
449 sizeof(OC_RSRVD_SYSTEM_TIME) - 1,
450 payload->info.systemTime);
451 err = err | cbor_encoder_close_container(&map, &repMap);
455 err = err | cbor_encoder_close_container(&rootArray, &map);
459 err = err | cbor_encoder_close_container(&encoder, &rootArray);
461 return checkError(err, &encoder, outPayload, size);
464 static int64_t OCConvertArray(CborEncoder* parent, const OCRepPayloadValueArray* valArray)
469 err = err | cbor_encoder_create_array(parent, &array, CborIndefiniteLength);
470 err = err | cbor_encode_uint(&array, valArray->type);
471 for(int i = 0; i < MAX_REP_ARRAY_DEPTH; ++i)
473 err = err | cbor_encode_uint(&array, valArray->dimensions[i]);
476 size_t dimTotal = calcDimTotal(valArray->dimensions);
478 for(size_t i = 0; i < dimTotal; ++i)
480 switch(valArray->type)
482 case OCREP_PROP_NULL:
483 OC_LOG(ERROR, TAG, PCF("ConvertArray Invalid NULL"));
484 err = CborUnknownError;
487 err = err | cbor_encode_int(&array, valArray->iArray[i]);
489 case OCREP_PROP_DOUBLE:
490 err = err | cbor_encode_double(&array, valArray->dArray[i]);
492 case OCREP_PROP_BOOL:
493 err = err | cbor_encode_boolean(&array, valArray->bArray[i]);
495 case OCREP_PROP_STRING:
496 err = err | cbor_encode_text_string(&array, valArray->strArray[i],
497 strlen(valArray->strArray[i]));
499 case OCREP_PROP_OBJECT:
500 err = OCConvertSingleRepPayload(&array, valArray->objArray[i]);
502 case OCREP_PROP_ARRAY:
503 OC_LOG(ERROR, TAG, PCF("ConvertArray Invalid child array"));
504 err = CborUnknownError;
509 err = err | cbor_encoder_close_container(parent, &array);
513 static int64_t OCConvertSingleRepPayload(CborEncoder* parent, const OCRepPayload* payload)
517 err = err | cbor_encoder_create_map(parent, &map, CborIndefiniteLength);
520 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_HREF,
521 sizeof(OC_RSRVD_HREF) - 1,
525 // resource types, interfaces
526 if(payload->types || payload->interfaces)
528 OC_LOG_V(INFO, TAG, "Payload has types or interfaces");
529 err = err | cbor_encode_text_string(&map,
531 sizeof(OC_RSRVD_PROPERTY) - 1);
533 err = err | cbor_encoder_create_map(&map, &propMap, 2);
535 CborEncoder curArray;
538 err = err | cbor_encode_text_string(&propMap,
539 OC_RSRVD_RESOURCE_TYPE,
540 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
541 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
542 OCStringLL* val = payload->types;
545 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
548 err = err | cbor_encoder_close_container(&propMap, &curArray);
550 if(payload->interfaces)
552 err = err | cbor_encode_text_string(&propMap,
554 sizeof(OC_RSRVD_INTERFACE) - 1);
555 err = err | cbor_encoder_create_array(&propMap, &curArray, CborIndefiniteLength);
556 OCStringLL* val = payload->interfaces;
559 err = err | cbor_encode_text_string(&curArray, val->value, strlen(val->value));
562 err = err | cbor_encoder_close_container(&propMap, &curArray);
564 err = err | cbor_encoder_close_container(&map, &propMap);
570 err = err | cbor_encode_text_string(&map,
571 OC_RSRVD_REPRESENTATION,
572 sizeof(OC_RSRVD_REPRESENTATION) - 1);
573 err = err | cbor_encoder_create_map(&map, &repMap, CborIndefiniteLength);
574 OCRepPayloadValue* value = payload->values;
577 err = err | cbor_encode_text_string(&repMap,
579 strlen(value->name));
582 case OCREP_PROP_NULL:
583 err = err | cbor_encode_null(&repMap);
586 err = err | cbor_encode_int(&repMap,
589 case OCREP_PROP_DOUBLE:
590 err = err | cbor_encode_double(&repMap,
593 case OCREP_PROP_BOOL:
594 err = err | cbor_encode_boolean(&repMap,
597 case OCREP_PROP_STRING:
598 err = err | cbor_encode_text_string(&repMap,
599 value->str, strlen(value->str));
601 case OCREP_PROP_OBJECT:
602 err = err | OCConvertSingleRepPayload(&repMap, value->obj);
604 case OCREP_PROP_ARRAY:
605 err = err | OCConvertArray(&repMap, &value->arr);
608 OC_LOG_V(ERROR, TAG, "Invalid Prop type: %d",
615 err = err | cbor_encoder_close_container(&map, &repMap);
619 err = err | cbor_encoder_close_container(parent, &map);
624 static int64_t OCConvertRepPayload(OCRepPayload* payload, uint8_t* outPayload, size_t* size)
626 CborEncoder encoder = {0};
629 cbor_encoder_init(&encoder, outPayload, *size, 0);
630 CborEncoder rootArray;
631 err = err | cbor_encoder_create_array(&encoder, &rootArray, CborIndefiniteLength);
632 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_REPRESENTATION);
634 while(payload != NULL && (err == 0 || err == CborErrorOutOfMemory))
636 err = err | OCConvertSingleRepPayload(&rootArray, payload);
637 payload = payload->next;
641 err = err | cbor_encoder_close_container(&encoder, &rootArray);
643 return checkError(err, &encoder, outPayload, size);
646 static int64_t OCConvertPresencePayload(OCPresencePayload* payload,
647 uint8_t* outPayload, size_t* size)
649 CborEncoder encoder = {0};
652 cbor_encoder_init(&encoder, outPayload, *size, 0);
653 CborEncoder rootArray;
655 err = err | cbor_encoder_create_array(&encoder, &rootArray, 2);
656 err = err | cbor_encode_uint(&rootArray, PAYLOAD_TYPE_PRESENCE);
660 err = err | cbor_encoder_create_map(&rootArray, &map, CborIndefiniteLength);
663 err = err | cbor_encode_text_string(&map,
665 sizeof(OC_RSRVD_NONCE) - 1);
666 err = err | cbor_encode_uint(&map, payload->sequenceNumber);
669 err = err | cbor_encode_text_string(&map,
671 sizeof(OC_RSRVD_TTL) - 1);
672 err = err | cbor_encode_uint(&map, payload->maxAge);
675 const char* triggerStr = convertTriggerEnumToString(payload->trigger);
676 err = err | AddTextStringToMap(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1,
679 // Resource type name
680 if(payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
682 err = err | ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
683 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
687 err = err | cbor_encoder_close_container(&rootArray, &map);
688 err = err | cbor_encoder_close_container(&encoder, &rootArray);
690 return checkError(err, &encoder, outPayload, size);
693 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
696 return cbor_encode_text_string(map, key, keylen) |
697 cbor_encode_text_string(map, value, strlen(value));
700 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
703 return value ? AddTextStringToMap(map, key, keylen, value) : 0;