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 // Defining _POSIX_C_SOURCE macro with 200112L (or greater) as value
22 // causes header files to expose definitions
23 // corresponding to the POSIX.1-2001 base
24 // specification (excluding the XSI extension).
25 // For POSIX.1-2001 base specification,
26 // Refer http://pubs.opengroup.org/onlinepubs/009695399/
27 // Required for strok_r
28 #define _POSIX_C_SOURCE 200112L
31 #include "oic_string.h"
32 #include "oic_malloc.h"
33 #include "ocpayload.h"
34 #include "ocpayloadcbor.h"
35 #include "ocstackinternal.h"
36 #include "payload_logging.h"
37 #include "rdpayload.h"
38 #include "platform_features.h"
40 #define TAG "OIC_RI_PAYLOADPARSE"
42 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *arrayVal);
43 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *arrayVal);
44 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *arrayVal);
45 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *repParent, bool isRoot);
46 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *arrayVal);
47 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *arrayVal);
48 static OCStackResult OCParseSecurityPayload(OCPayload **outPayload, const uint8_t *payload, size_t size);
50 OCStackResult OCParsePayload(OCPayload **outPayload, OCPayloadType payloadType,
51 const uint8_t *payload, size_t payloadSize)
53 OCStackResult result = OC_STACK_MALFORMED_RESPONSE;
56 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Conversion of outPayload failed");
57 VERIFY_PARAM_NON_NULL(TAG, payload, "Invalid cbor payload value");
59 OIC_LOG_V(INFO, TAG, "CBOR Parsing size: %zu of Payload Type: %d, Payload:",
60 payloadSize, payloadType);
61 OIC_LOG_BUFFER(DEBUG, TAG, payload, payloadSize);
66 err = cbor_parser_init(payload, payloadSize, 0, &parser, &rootValue);
67 VERIFY_CBOR_SUCCESS(TAG, err, "Failed initializing init value")
71 case PAYLOAD_TYPE_DISCOVERY:
72 result = OCParseDiscoveryPayload(outPayload, &rootValue);
74 case PAYLOAD_TYPE_DEVICE:
75 result = OCParseDevicePayload(outPayload, &rootValue);
77 case PAYLOAD_TYPE_PLATFORM:
78 result = OCParsePlatformPayload(outPayload, &rootValue);
80 case PAYLOAD_TYPE_REPRESENTATION:
81 result = OCParseRepPayload(outPayload, &rootValue);
83 case PAYLOAD_TYPE_PRESENCE:
84 result = OCParsePresencePayload(outPayload, &rootValue);
86 case PAYLOAD_TYPE_SECURITY:
87 result = OCParseSecurityPayload(outPayload, payload, payloadSize);
90 result = OCRDCborToPayload(&rootValue, outPayload);
93 OIC_LOG_V(ERROR, TAG, "ParsePayload Type default: %d", payloadType);
94 result = OC_STACK_INVALID_PARAM;
98 OIC_LOG_V(INFO, TAG, "Finished parse payload, result is %d", result);
104 void OCFreeOCStringLL(OCStringLL* ll);
106 static OCStackResult OCParseSecurityPayload(OCPayload** outPayload, const uint8_t *payload,
111 *outPayload = (OCPayload *)OCSecurityPayloadCreate(payload, size);
120 static char* InPlaceStringTrim(char* str)
122 while (str[0] == ' ')
127 size_t lastchar = strlen(str);
129 while (str[lastchar] == ' ')
131 str[lastchar] = '\0';
138 static CborError OCParseStringLL(CborValue *map, char *type, OCStringLL **resource)
141 CborError err = cbor_value_map_find_value(map, type, &val);
142 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL TAG");
144 if (cbor_value_is_array(&val))
147 err = cbor_value_enter_container(&val, &txtStr);
148 VERIFY_CBOR_SUCCESS(TAG, err, "to enter container");
149 while (cbor_value_is_text_string(&txtStr))
153 err = cbor_value_dup_text_string(&txtStr, &input, &len, NULL);
154 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL value.");
157 char *savePtr = NULL;
158 char *curPtr = strtok_r(input, " ", &savePtr);
161 char *trimmed = InPlaceStringTrim(curPtr);
162 if (trimmed[0] !='\0')
164 if (!OCResourcePayloadAddStringLL(resource, trimmed))
166 return CborErrorOutOfMemory;
169 curPtr = strtok_r(NULL, " ", &savePtr);
173 if (cbor_value_is_text_string(&txtStr))
175 err = cbor_value_advance(&txtStr);
176 VERIFY_CBOR_SUCCESS(TAG, err, "to advance string value");
184 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *rootValue)
186 OCStackResult ret = OC_STACK_INVALID_PARAM;
187 OCResourcePayload *resource = NULL;
188 OCDiscoveryPayload *out = NULL;
190 CborError err = CborNoError;
193 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
194 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid Parameter rootValue");
195 if (cbor_value_is_array(rootValue))
197 // Root value is already inside the main root array
199 ret = OC_STACK_NO_MEMORY;
200 out = OCDiscoveryPayloadCreate();
201 VERIFY_PARAM_NON_NULL(TAG, out, "Failed error initializing discovery payload");
203 // Enter the main root map
204 ret = OC_STACK_MALFORMED_RESPONSE;
205 err = cbor_value_enter_container(rootValue, &rootMap);
206 VERIFY_CBOR_SUCCESS(TAG, err, "to enter root map container");
210 if (!cbor_value_is_map(&rootMap))
212 OIC_LOG(ERROR, TAG, "Malformed packet!!");
215 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_ID, &curVal);
216 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
217 if (cbor_value_is_valid(&curVal))
219 if (cbor_value_is_byte_string(&curVal))
221 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&(out->sid), &len, NULL);
222 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
224 else if (cbor_value_is_text_string(&curVal))
226 err = cbor_value_dup_text_string(&curVal, &(out->sid), &len, NULL);
227 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
231 // BaseURI - Not a mandatory field
232 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_BASE_URI, &curVal);
233 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri tag");
234 if (cbor_value_is_valid(&curVal))
236 err = cbor_value_dup_text_string(&curVal, &(out->baseURI), &len, NULL);
237 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
240 // HREF - Not a mandatory field
241 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
242 if (cbor_value_is_valid(&curVal))
244 err = cbor_value_dup_text_string(&curVal, &(out->uri), &len, NULL);
245 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri value");
248 // RT - Not a mandatory field
249 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal);
250 if (cbor_value_is_valid(&curVal))
252 err = OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &out->type);
253 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
256 // IF - Not a mandatory field
257 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal);
258 if (cbor_value_is_valid(&curVal))
260 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &out->iface);
264 if (!OCResourcePayloadAddStringLL(&out->iface, OC_RSRVD_INTERFACE_LL))
266 err = CborErrorOutOfMemory;
270 // Name - Not a mandatory field
271 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_NAME, &curVal);
272 if (cbor_value_is_valid(&curVal))
274 err = cbor_value_dup_text_string(&curVal, &out->name, &len, NULL);
275 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name");
278 // Look for Links which will have an array as the value
280 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_LINKS, &linkMap);
281 VERIFY_CBOR_SUCCESS(TAG, err, "to find links tag");
283 // Enter the links array and start iterating through the array processing
284 // each resource which shows up as a map.
285 CborValue resourceMap;
286 err = cbor_value_enter_container(&linkMap, &resourceMap);
287 VERIFY_CBOR_SUCCESS(TAG, err, "to enter link map");
289 while (cbor_value_is_map(&resourceMap))
291 resource = (OCResourcePayload *)OICCalloc(1, sizeof(OCResourcePayload));
292 VERIFY_PARAM_NON_NULL(TAG, resource, "Failed allocating resource payload");
295 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_HREF, &curVal);
296 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
297 err = cbor_value_dup_text_string(&curVal, &(resource->uri), &len, NULL);
298 VERIFY_CBOR_SUCCESS(TAG, err, "to find href value");
301 err = OCParseStringLL(&resourceMap, OC_RSRVD_RESOURCE_TYPE, &resource->types);
302 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag/value");
305 err = OCParseStringLL(&resourceMap, OC_RSRVD_INTERFACE, &resource->interfaces);
306 if (CborNoError != err)
308 if (!OCResourcePayloadAddStringLL(&resource->interfaces, OC_RSRVD_INTERFACE_LL))
310 OIC_LOG(ERROR, TAG, "Failed to add string to StringLL");
317 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_POLICY, &policyMap);
318 VERIFY_CBOR_SUCCESS(TAG, err, "to find policy tag");
321 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_BITMAP, &curVal);
322 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap tag");
323 err = cbor_value_get_int(&curVal, (int *)&resource->bitmap);
324 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap value");
327 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_SECURE, &curVal);
328 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure tag");
329 if (cbor_value_is_valid(&curVal))
331 err = cbor_value_get_boolean(&curVal, &(resource->secure));
332 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure value");
336 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_HOSTING_PORT, &curVal);
337 VERIFY_CBOR_SUCCESS(TAG, err, "to find port tag");
338 if (cbor_value_is_valid(&curVal))
340 err = cbor_value_get_int(&curVal, (int *)&resource->port);
341 VERIFY_CBOR_SUCCESS(TAG, err, "to find port value");
346 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_TCP_PORT, &curVal);
347 if (cbor_value_is_valid(&curVal))
349 err = cbor_value_get_int(&curVal, (int *)&resource->tcpPort);
350 VERIFY_CBOR_SUCCESS(TAG, err, "to find tcp port value");
354 err = cbor_value_advance(&resourceMap);
355 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
357 OCDiscoveryPayloadAddNewResource(out, resource);
360 err = cbor_value_leave_container(rootValue, &resourceMap);
361 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
365 OIC_LOG(ERROR, TAG, "Malformed packet ");
369 *outPayload = (OCPayload *)out;
370 OIC_LOG_PAYLOAD(DEBUG, *outPayload);
375 OCDiscoveryResourceDestroy(resource);
376 OCDiscoveryPayloadDestroy(out);
380 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *rootValue)
382 OCStackResult ret = OC_STACK_INVALID_PARAM;
383 CborError err = CborNoError;
384 OCDevicePayload *out = NULL;
385 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid param outPayload");
386 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid param rootValue");
390 out = (OCDevicePayload *)OICCalloc(1, sizeof(OCDevicePayload));
391 VERIFY_PARAM_NON_NULL(TAG, out, "Failed allocating device payload")
392 out->base.type = PAYLOAD_TYPE_DEVICE;
393 ret = OC_STACK_MALFORMED_RESPONSE;
395 if (cbor_value_is_map(rootValue))
399 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
400 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag");
402 if (cbor_value_is_valid(&curVal))
404 err = OCParseStringLL(rootValue, OC_RSRVD_RESOURCE_TYPE, &out->types);
405 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
408 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &curVal);
409 VERIFY_CBOR_SUCCESS(TAG, err, "to find interface tag");
410 if (cbor_value_is_valid(&curVal))
412 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &out->interfaces);
413 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
417 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_ID, &curVal);
418 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
419 if (cbor_value_is_valid(&curVal))
421 if (cbor_value_is_byte_string(&curVal))
423 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&out->sid, &len, NULL);
424 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
426 else if (cbor_value_is_text_string(&curVal))
428 err = cbor_value_dup_text_string(&curVal, &out->sid, &len, NULL);
429 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
433 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_NAME, &curVal);
434 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name tag");
435 if (cbor_value_is_valid(&curVal))
437 err = cbor_value_dup_text_string(&curVal, &out->deviceName, &len, NULL);
438 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name in device payload");
440 // Device Spec Version
441 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SPEC_VERSION, &curVal);
442 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec ver tag");
443 if (cbor_value_is_valid(&curVal))
445 err = cbor_value_dup_text_string(&curVal, &out->specVersion, &len, NULL);
446 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec version in device payload");
448 // Data Model Versions
449 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DATA_MODEL_VERSION, &curVal);
450 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model versions tag");
451 if (cbor_value_is_valid(&curVal))
455 err = cbor_value_dup_text_string(&curVal, &str, &len, NULL);
456 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model versions in device payload");
457 out->dataModelVersions = OCCreateOCStringLL(str);
460 err = cbor_value_advance(rootValue);
461 VERIFY_CBOR_SUCCESS(TAG, err, "to advance device payload");
463 *outPayload = (OCPayload *)out;
468 OCDevicePayloadDestroy(out);
472 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *rootValue)
474 OCStackResult ret = OC_STACK_INVALID_PARAM;
475 CborError err = CborNoError;
476 OCPlatformInfo info = {0};
477 OCStringLL* rt = NULL;
478 OCStringLL* interfaces = NULL;
479 OCPlatformPayload* out = NULL;
481 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
483 if (cbor_value_is_map(rootValue))
487 ret = OC_STACK_MALFORMED_RESPONSE;
490 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_ID, &repVal);
491 VERIFY_CBOR_SUCCESS(TAG, err, "to find platform id tag");
492 if (cbor_value_is_valid(&repVal))
494 err = cbor_value_dup_text_string(&repVal, &(info.platformID), &len, NULL);
495 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformID in the platform payload");
498 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_NAME, &repVal);
499 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg name tag");
500 if (cbor_value_is_valid(&repVal))
502 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerName), &len, NULL);
503 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureName in the platform payload");
506 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_URL, &repVal);
507 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg url tag");
508 if (cbor_value_is_valid(&repVal))
510 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerUrl), &len, NULL);
511 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureUrl in the platform payload");
514 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MODEL_NUM, &repVal);
515 VERIFY_CBOR_SUCCESS(TAG, err, "to find model num tag");
516 if (cbor_value_is_valid(&repVal))
518 err = cbor_value_dup_text_string(&repVal, &(info.modelNumber), &len, NULL);
519 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find modelNumber in the platform payload");
522 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_DATE, &repVal);
523 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg date tag");
524 if (cbor_value_is_valid(&repVal))
526 err = cbor_value_dup_text_string(&repVal, &(info.dateOfManufacture), &len, NULL);
527 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find dateOfManufacture in the platform payload");
530 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_VERSION, &repVal);
531 VERIFY_CBOR_SUCCESS(TAG, err, "to find platform ver tag");
532 if (cbor_value_is_valid(&repVal))
534 err = cbor_value_dup_text_string(&repVal, &(info.platformVersion), &len, NULL);
535 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformVersion in the platform payload");
538 err = cbor_value_map_find_value(rootValue, OC_RSRVD_OS_VERSION, &repVal);
539 VERIFY_CBOR_SUCCESS(TAG, err, "to find os ver tag");
540 if (cbor_value_is_valid(&repVal))
542 err = cbor_value_dup_text_string(&repVal, &(info.operatingSystemVersion), &len, NULL);
543 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find OSVersion in the platform payload");
546 err = cbor_value_map_find_value(rootValue, OC_RSRVD_HARDWARE_VERSION, &repVal);
547 VERIFY_CBOR_SUCCESS(TAG, err, "to find hw ver tag");
548 if(cbor_value_is_valid(&repVal))
550 err = cbor_value_dup_text_string(&repVal, &(info.hardwareVersion), &len, NULL);
551 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find HWVersion in the platform payload");
554 err = cbor_value_map_find_value(rootValue, OC_RSRVD_FIRMWARE_VERSION, &repVal);
555 VERIFY_CBOR_SUCCESS(TAG, err, "to find fw ver tag");
556 if(cbor_value_is_valid(&repVal))
558 err = cbor_value_dup_text_string(&repVal, &(info.firmwareVersion), &len, NULL);
559 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find firmwareVersion in the platform payload");
562 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SUPPORT_URL, &repVal);
563 VERIFY_CBOR_SUCCESS(TAG, err, "to find support url tag");
564 if(cbor_value_is_valid(&repVal))
566 err = cbor_value_dup_text_string(&repVal, &(info.supportUrl), &len, NULL);
567 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
570 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SYSTEM_TIME, &repVal);
571 VERIFY_CBOR_SUCCESS(TAG, err, "to find sys time tag");
572 if(cbor_value_is_valid(&repVal))
574 err = cbor_value_dup_text_string(&repVal, &(info.systemTime), &len, NULL);
575 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find systemTume in the platform payload");
579 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &repVal);
580 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag");
582 if(cbor_value_is_valid(&repVal))
584 err = OCParseStringLL(rootValue, OC_RSRVD_RESOURCE_TYPE, &rt);
585 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find resource type in the platform payload");
589 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &repVal);
590 VERIFY_CBOR_SUCCESS(TAG, err, "to find interface tag");
592 if(cbor_value_is_valid(&repVal))
594 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &interfaces);
595 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
598 err = cbor_value_advance(rootValue);
599 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
601 out = (OCPlatformPayload *)OCPlatformPayloadCreateAsOwner(&info);
603 out->interfaces = interfaces;
604 *outPayload = (OCPayload *)out;
605 OIC_LOG_PAYLOAD(DEBUG, *outPayload);
610 OCPlatformInfoDestroy(&info);
611 OIC_LOG(ERROR, TAG, "CBOR error In ParsePlatformPayload");
615 static OCRepPayloadPropType DecodeCborType(CborType type)
620 return OCREP_PROP_NULL;
621 case CborIntegerType:
622 return OCREP_PROP_INT;
625 return OCREP_PROP_DOUBLE;
626 case CborBooleanType:
627 return OCREP_PROP_BOOL;
628 case CborTextStringType:
629 return OCREP_PROP_STRING;
630 case CborByteStringType:
631 return OCREP_PROP_BYTE_STRING;
633 return OCREP_PROP_OBJECT;
635 return OCREP_PROP_ARRAY;
637 return OCREP_PROP_NULL;
640 static CborError OCParseArrayFindDimensionsAndType(const CborValue *parent,
641 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType *type)
643 CborValue insideArray;
644 *type = OCREP_PROP_NULL;
645 dimensions[0] = dimensions[1] = dimensions[2] = 0;
647 CborError err = cbor_value_enter_container(parent, &insideArray);
648 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
650 while (cbor_value_is_valid(&insideArray))
652 OCRepPayloadPropType tempType = DecodeCborType(cbor_value_get_type(&insideArray));
654 if (tempType == OCREP_PROP_ARRAY)
656 size_t subdim[MAX_REP_ARRAY_DEPTH];
657 tempType = OCREP_PROP_NULL;
658 err = OCParseArrayFindDimensionsAndType(&insideArray, subdim, &tempType);
659 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse array");
663 OIC_LOG(ERROR, TAG, "Parse array helper, sub-array too deep");
666 dimensions[1] = dimensions[1] >= subdim[0] ? dimensions[1] : subdim[0];
667 dimensions[2] = dimensions[2] >= subdim[1] ? dimensions[2] : subdim[1];
669 if (*type != OCREP_PROP_NULL && tempType != OCREP_PROP_NULL && *type != tempType)
671 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed (subtype)");
672 return CborUnknownError;
674 else if (*type == OCREP_PROP_NULL)
676 // We don't know the type of this array yet, so the assignment is OK
680 else if (*type == OCREP_PROP_NULL)
682 // We don't know the type of this array yet, so the assignment is OK
685 // tempType is allowed to be NULL, since it might now know the answer yet
686 else if (tempType != OCREP_PROP_NULL && *type != tempType)
688 // this is an invalid situation!
689 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed");
690 return CborUnknownError;
694 err = cbor_value_advance(&insideArray);
695 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance array");
702 static size_t getAllocSize(OCRepPayloadPropType type)
707 return sizeof (int64_t);
708 case OCREP_PROP_DOUBLE:
709 return sizeof (double);
710 case OCREP_PROP_BOOL:
711 return sizeof (bool);
712 case OCREP_PROP_STRING:
713 return sizeof (char*);
714 case OCREP_PROP_BYTE_STRING:
715 return sizeof (OCByteString);
716 case OCREP_PROP_OBJECT:
717 return sizeof (OCRepPayload*);
723 static size_t arrayStep(size_t dimensions[MAX_REP_ARRAY_DEPTH], size_t elementNum)
726 (dimensions[1] == 0 ? 1 : dimensions[1]) *
727 (dimensions[2] == 0 ? 1 : dimensions[2]) *
731 static CborError OCParseArrayFillArray(const CborValue *parent,
732 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType type, void *targetArray)
734 CborValue insideArray;
737 char *tempStr = NULL;
738 OCByteString ocByteStr = { .bytes = NULL, .len = 0};
740 OCRepPayload *tempPl = NULL;
742 size_t newdim[MAX_REP_ARRAY_DEPTH];
743 newdim[0] = dimensions[1];
744 newdim[1] = dimensions[2];
747 CborError err = cbor_value_enter_container(parent, &insideArray);
748 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
750 while (!err && i < dimensions[0] && cbor_value_is_valid(&insideArray))
752 bool noAdvance = false;
753 if (cbor_value_get_type(&insideArray) != CborNullType)
758 if (dimensions[1] == 0)
760 err = cbor_value_get_int64(&insideArray, &(((int64_t*)targetArray)[i]));
764 err = OCParseArrayFillArray(&insideArray, newdim, type,
765 &(((int64_t*)targetArray)[arrayStep(dimensions, i)]));
768 case OCREP_PROP_DOUBLE:
769 if (dimensions[1] == 0)
771 double *d = &(((double*)targetArray)[i]);
772 if (cbor_value_get_type(&insideArray) == CborDoubleType)
774 err = cbor_value_get_double(&insideArray, d);
780 err = cbor_value_get_float(&insideArray, &f);
787 err = OCParseArrayFillArray(&insideArray, newdim, type,
788 &(((double*)targetArray)[arrayStep(dimensions, i)]));
791 case OCREP_PROP_BOOL:
792 if (dimensions[1] == 0)
794 err = cbor_value_get_boolean(&insideArray, &(((bool*)targetArray)[i]));
798 err = OCParseArrayFillArray(&insideArray, newdim, type,
799 &(((bool*)targetArray)[arrayStep(dimensions, i)]));
802 case OCREP_PROP_STRING:
803 if (dimensions[1] == 0)
805 err = cbor_value_dup_text_string(&insideArray, &tempStr, &tempLen, NULL);
806 ((char**)targetArray)[i] = tempStr;
811 err = OCParseArrayFillArray(&insideArray, newdim, type,
812 &(((char**)targetArray)[arrayStep(dimensions, i)]));
815 case OCREP_PROP_BYTE_STRING:
816 if (dimensions[1] == 0)
818 err = cbor_value_dup_byte_string(&insideArray, &(ocByteStr.bytes),
819 &(ocByteStr.len), NULL);
820 ((OCByteString*)targetArray)[i] = ocByteStr;
824 err = OCParseArrayFillArray(&insideArray, newdim, type,
825 &(((OCByteString*)targetArray)[arrayStep(dimensions, i)]));
828 case OCREP_PROP_OBJECT:
829 if (dimensions[1] == 0)
831 err = OCParseSingleRepPayload(&tempPl, &insideArray, false);
832 ((OCRepPayload**)targetArray)[i] = tempPl;
838 err = OCParseArrayFillArray(&insideArray, newdim, type,
839 &(((OCRepPayload**)targetArray)[arrayStep(dimensions, i)]));
843 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
844 err = CborErrorUnknownType;
847 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting repPayload");
850 if (!noAdvance && cbor_value_is_valid(&insideArray))
852 err = cbor_value_advance(&insideArray);
853 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advnce insideArray");
861 static CborError OCParseArray(OCRepPayload *out, const char *name, CborValue *container)
865 OCRepPayloadPropType type = OCREP_PROP_NULL;
866 size_t dimensions[MAX_REP_ARRAY_DEPTH] = { 0 };
869 size_t allocSize = 0;
871 CborError err = OCParseArrayFindDimensionsAndType(container, dimensions, &type);
872 VERIFY_CBOR_SUCCESS(TAG, err, "Array details weren't clear");
874 if (type == OCREP_PROP_NULL)
876 res = OCRepPayloadSetNull(out, name);
877 err = (CborError) !res;
878 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
879 err = cbor_value_advance(container);
880 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing container");
884 dimTotal = calcDimTotal(dimensions);
885 allocSize = getAllocSize(type);
886 arr = OICCalloc(dimTotal, allocSize);
887 VERIFY_PARAM_NON_NULL(TAG, arr, "Array Parse allocation failed");
889 res = OCParseArrayFillArray(container, dimensions, type, arr);
890 VERIFY_CBOR_SUCCESS(TAG, err, "Failed parse array");
895 res = OCRepPayloadSetIntArrayAsOwner(out, name, (int64_t *)arr, dimensions);
897 case OCREP_PROP_DOUBLE:
898 res = OCRepPayloadSetDoubleArrayAsOwner(out, name, (double *)arr, dimensions);
900 case OCREP_PROP_BOOL:
901 res = OCRepPayloadSetBoolArrayAsOwner(out, name, (bool *)arr, dimensions);
903 case OCREP_PROP_STRING:
904 res = OCRepPayloadSetStringArrayAsOwner(out, name, (char **)arr, dimensions);
906 case OCREP_PROP_BYTE_STRING:
907 res = OCRepPayloadSetByteStringArrayAsOwner(out, name, (OCByteString *)arr, dimensions);
909 case OCREP_PROP_OBJECT:
910 res = OCRepPayloadSetPropObjectArrayAsOwner(out, name, (OCRepPayload**)arr, dimensions);
913 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
916 err = (CborError) !res;
917 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting array parameter");
920 if (type == OCREP_PROP_STRING)
922 for(size_t i = 0; i < dimTotal; ++i)
924 OICFree(((char**)arr)[i]);
927 if (type == OCREP_PROP_BYTE_STRING)
929 for(size_t i = 0; i < dimTotal; ++i)
931 OICFree(((OCByteString*)arr)[i].bytes);
934 if (type == OCREP_PROP_OBJECT)
936 for(size_t i = 0; i < dimTotal; ++i)
938 OCRepPayloadDestroy(((OCRepPayload**)arr)[i]);
945 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *objMap, bool isRoot)
947 CborError err = CborUnknownError;
950 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
951 VERIFY_PARAM_NON_NULL(TAG, objMap, "Invalid Parameter objMap");
953 if (cbor_value_is_map(objMap))
957 *outPayload = OCRepPayloadCreate();
960 return CborErrorOutOfMemory;
964 OCRepPayload *curPayload = *outPayload;
968 err = cbor_value_enter_container(objMap, &repMap);
969 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
971 while (!err && cbor_value_is_valid(&repMap))
973 if (cbor_value_is_text_string(&repMap))
975 err = cbor_value_dup_text_string(&repMap, &name, &len, NULL);
976 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding tag name in the map");
977 err = cbor_value_advance(&repMap);
978 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing rootMap");
981 ((0 == strcmp(OC_RSRVD_HREF, name)) ||
982 (0 == strcmp(OC_RSRVD_RESOURCE_TYPE, name)) ||
983 (0 == strcmp(OC_RSRVD_INTERFACE, name))))
985 err = cbor_value_advance(&repMap);
990 CborType type = cbor_value_get_type(&repMap);
994 res = OCRepPayloadSetNull(curPayload, name);
996 case CborIntegerType:
999 err = cbor_value_get_int64(&repMap, &intval);
1000 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting int value");
1001 res = OCRepPayloadSetPropInt(curPayload, name, intval);
1004 case CborDoubleType:
1006 double doubleval = 0;
1007 err = cbor_value_get_double(&repMap, &doubleval);
1008 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting double value");
1009 res = OCRepPayloadSetPropDouble(curPayload, name, doubleval);
1012 case CborBooleanType:
1014 bool boolval = false;
1015 err = cbor_value_get_boolean(&repMap, &boolval);
1016 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting boolean value");
1017 res = OCRepPayloadSetPropBool(curPayload, name, boolval);
1020 case CborTextStringType:
1022 char *strval = NULL;
1023 err = cbor_value_dup_text_string(&repMap, &strval, &len, NULL);
1024 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting string value");
1025 res = OCRepPayloadSetPropStringAsOwner(curPayload, name, strval);
1028 case CborByteStringType:
1030 uint8_t* bytestrval = NULL;
1031 err = cbor_value_dup_byte_string(&repMap, &bytestrval, &len, NULL);
1032 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting byte string value");
1033 OCByteString tmp = {.bytes = bytestrval, .len = len};
1034 res = OCRepPayloadSetPropByteStringAsOwner(curPayload, name, &tmp);
1039 OCRepPayload *pl = NULL;
1040 err = OCParseSingleRepPayload(&pl, &repMap, false);
1041 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting parse single rep");
1042 res = OCRepPayloadSetPropObjectAsOwner(curPayload, name, pl);
1046 err = OCParseArray(curPayload, name, &repMap);
1049 OIC_LOG_V(ERROR, TAG, "Parsing rep property, unknown type %d", repMap.type);
1052 if (type != CborArrayType)
1054 err = (CborError) !res;
1056 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
1058 if (type != CborMapType && cbor_value_is_valid(&repMap))
1060 err = cbor_value_advance(&repMap);
1061 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advance repMap");
1066 if (cbor_value_is_container(objMap))
1068 err = cbor_value_leave_container(objMap, &repMap);
1069 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to leave container");
1076 OCRepPayloadDestroy(*outPayload);
1081 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *root)
1083 OCStackResult ret = OC_STACK_INVALID_PARAM;
1085 OCRepPayload *temp = NULL;
1086 OCRepPayload *rootPayload = NULL;
1087 OCRepPayload *curPayload = NULL;
1088 CborValue rootMap = *root;
1089 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1090 VERIFY_PARAM_NON_NULL(TAG, root, "Invalid Parameter root");
1093 if (cbor_value_is_array(root))
1095 err = cbor_value_enter_container(root, &rootMap);
1096 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
1098 while (cbor_value_is_valid(&rootMap))
1100 temp = OCRepPayloadCreate();
1101 ret = OC_STACK_NO_MEMORY;
1102 VERIFY_PARAM_NON_NULL(TAG, temp, "Failed allocating memory");
1105 ret = OC_STACK_MALFORMED_RESPONSE;
1107 // temporary fix to check for malformed cbor payload
1108 if (!cbor_value_is_map(&rootMap) && !cbor_value_is_array(&rootMap)){
1112 if (cbor_value_is_map(&rootMap))
1114 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
1115 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
1116 if (cbor_value_is_valid(&curVal))
1119 err = cbor_value_dup_text_string(&curVal, &temp->uri, &len, NULL);
1120 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find uri");
1125 if (cbor_value_is_map(&rootMap))
1127 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal))
1129 err = OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &temp->types);
1130 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
1135 if (cbor_value_is_map(&rootMap))
1137 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal))
1139 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &temp->interfaces);
1140 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
1144 if (cbor_value_is_map(&rootMap))
1146 err = OCParseSingleRepPayload(&temp, &rootMap, true);
1147 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse single rep payload");
1150 if(rootPayload == NULL)
1157 curPayload->next = temp;
1158 curPayload = curPayload->next;
1161 if (cbor_value_is_array(&rootMap))
1163 err = cbor_value_advance(&rootMap);
1164 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance single rep payload");
1167 *outPayload = (OCPayload *)rootPayload;
1171 OCRepPayloadDestroy(temp);
1172 OCRepPayloadDestroy(rootPayload);
1173 OIC_LOG(ERROR, TAG, "CBOR error in ParseRepPayload");
1177 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *rootValue)
1179 OCStackResult ret = OC_STACK_INVALID_PARAM;
1180 OCPresencePayload *payload = NULL;
1181 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1185 payload = (OCPresencePayload *)OICCalloc(1, sizeof(OCPresencePayload));
1186 ret = OC_STACK_NO_MEMORY;
1187 VERIFY_PARAM_NON_NULL(TAG, payload, "Failed allocating presence payload");
1188 payload->base.type = PAYLOAD_TYPE_PRESENCE;
1189 ret = OC_STACK_MALFORMED_RESPONSE;
1191 if (cbor_value_is_map(rootValue))
1197 CborError err = cbor_value_map_find_value(rootValue, OC_RSRVD_NONCE, &curVal);
1198 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce tag");
1199 err = cbor_value_get_uint64(&curVal, &temp);
1200 payload->sequenceNumber = (uint32_t)temp;
1201 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce value");
1204 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TTL, &curVal);
1205 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl tag");
1207 err = cbor_value_get_uint64(&curVal, &temp);
1208 payload->maxAge = (uint32_t)temp;
1209 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl value");
1212 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TRIGGER, &curVal);
1213 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger tag");
1214 err = cbor_value_get_simple_type(&curVal, (uint8_t *)&payload->trigger);
1215 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger value");
1217 // Resource type name
1218 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
1219 VERIFY_CBOR_SUCCESS(TAG, err, "to find res type tag");
1220 if (cbor_value_is_valid(&curVal))
1223 err = cbor_value_dup_text_string(&curVal, &payload->resourceType, &len, NULL);
1224 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding resource type value");
1227 err = cbor_value_advance(rootValue);
1228 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing root value");
1230 *outPayload = (OCPayload *)payload;
1234 OIC_LOG(ERROR, TAG, "CBOR error Parse Presence Payload");
1235 OCPresencePayloadDestroy(payload);