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 "platform_features.h"
39 #if defined(RD_CLIENT) || defined(RD_SERVER)
40 #include "rdpayload.h"
43 #define TAG "OIC_RI_PAYLOADPARSE"
45 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *arrayVal);
46 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *arrayVal);
47 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *arrayVal);
48 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *repParent, bool isRoot);
49 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *arrayVal);
50 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *arrayVal);
51 static OCStackResult OCParseSecurityPayload(OCPayload **outPayload, const uint8_t *payload, size_t size);
53 OCStackResult OCParsePayload(OCPayload **outPayload, OCPayloadType payloadType,
54 const uint8_t *payload, size_t payloadSize)
56 OCStackResult result = OC_STACK_MALFORMED_RESPONSE;
59 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Conversion of outPayload failed");
60 VERIFY_PARAM_NON_NULL(TAG, payload, "Invalid cbor payload value");
62 OIC_LOG_V(INFO, TAG, "CBOR Parsing size: %zu of Payload Type: %d, Payload:",
63 payloadSize, payloadType);
64 OIC_LOG_BUFFER(DEBUG, TAG, payload, payloadSize);
69 err = cbor_parser_init(payload, payloadSize, 0, &parser, &rootValue);
70 VERIFY_CBOR_SUCCESS(TAG, err, "Failed initializing init value")
74 case PAYLOAD_TYPE_DISCOVERY:
75 result = OCParseDiscoveryPayload(outPayload, &rootValue);
77 case PAYLOAD_TYPE_DEVICE:
78 result = OCParseDevicePayload(outPayload, &rootValue);
80 case PAYLOAD_TYPE_PLATFORM:
81 result = OCParsePlatformPayload(outPayload, &rootValue);
83 case PAYLOAD_TYPE_REPRESENTATION:
84 result = OCParseRepPayload(outPayload, &rootValue);
86 case PAYLOAD_TYPE_PRESENCE:
87 result = OCParsePresencePayload(outPayload, &rootValue);
89 case PAYLOAD_TYPE_SECURITY:
90 result = OCParseSecurityPayload(outPayload, payload, payloadSize);
92 #if defined(RD_CLIENT) || defined(RD_SERVER)
94 result = OCRDCborToPayload(&rootValue, outPayload);
98 OIC_LOG_V(ERROR, TAG, "ParsePayload Type default: %d", payloadType);
99 result = OC_STACK_INVALID_PARAM;
103 OIC_LOG_V(INFO, TAG, "Finished parse payload, result is %d", result);
109 static OCStackResult OCParseSecurityPayload(OCPayload** outPayload, const uint8_t *payload,
114 *outPayload = (OCPayload *)OCSecurityPayloadCreate(payload, size);
123 static char* InPlaceStringTrim(char* str)
125 while (str[0] == ' ')
130 size_t lastchar = strlen(str);
132 while (str[lastchar] == ' ')
134 str[lastchar] = '\0';
141 static CborError OCParseStringLL(CborValue *map, char *type, OCStringLL **resource)
144 CborError err = cbor_value_map_find_value(map, type, &val);
145 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL TAG");
147 if (cbor_value_is_array(&val))
150 err = cbor_value_enter_container(&val, &txtStr);
151 VERIFY_CBOR_SUCCESS(TAG, err, "to enter container");
152 while (cbor_value_is_text_string(&txtStr))
156 err = cbor_value_dup_text_string(&txtStr, &input, &len, NULL);
157 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL value.");
160 char *savePtr = NULL;
161 char *curPtr = strtok_r(input, " ", &savePtr);
164 char *trimmed = InPlaceStringTrim(curPtr);
165 if (trimmed[0] !='\0')
167 if (!OCResourcePayloadAddStringLL(resource, trimmed))
169 return CborErrorOutOfMemory;
172 curPtr = strtok_r(NULL, " ", &savePtr);
176 if (cbor_value_is_text_string(&txtStr))
178 err = cbor_value_advance(&txtStr);
179 VERIFY_CBOR_SUCCESS(TAG, err, "to advance string value");
187 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *rootValue)
189 OCStackResult ret = OC_STACK_INVALID_PARAM;
190 OCResourcePayload *resource = NULL;
191 OCDiscoveryPayload *temp = NULL;
192 OCDiscoveryPayload *rootPayload = NULL;
193 OCDiscoveryPayload *curPayload = NULL;
195 CborError err = CborNoError;
198 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
199 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid Parameter rootValue");
200 if (cbor_value_is_array(rootValue))
202 // Root value is already inside the main root array
205 // Enter the main root map
206 ret = OC_STACK_MALFORMED_RESPONSE;
207 err = cbor_value_enter_container(rootValue, &rootMap);
208 VERIFY_CBOR_SUCCESS(TAG, err, "to enter root map container");
209 while (cbor_value_is_map(&rootMap))
211 ret = OC_STACK_NO_MEMORY;
212 temp = OCDiscoveryPayloadCreate();
213 VERIFY_PARAM_NON_NULL(TAG, temp, "Failed error initializing discovery payload");
217 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_ID, &curVal);
218 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
219 if (cbor_value_is_valid(&curVal))
221 if (cbor_value_is_byte_string(&curVal))
223 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&(temp->sid), &len, NULL);
224 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
226 else if (cbor_value_is_text_string(&curVal))
228 err = cbor_value_dup_text_string(&curVal, &(temp->sid), &len, NULL);
229 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
233 // BaseURI - Not a mandatory field
234 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_BASE_URI, &curVal);
235 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri tag");
236 if (cbor_value_is_valid(&curVal))
238 err = cbor_value_dup_text_string(&curVal, &(temp->baseURI), &len, NULL);
239 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
242 // HREF - Not a mandatory field
243 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
244 if (cbor_value_is_valid(&curVal))
246 err = cbor_value_dup_text_string(&curVal, &(temp->uri), &len, NULL);
247 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri value");
250 // RT - Not a mandatory field
251 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal);
252 if (cbor_value_is_valid(&curVal))
254 err = OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &temp->type);
255 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
258 // IF - Not a mandatory field
259 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal);
260 if (cbor_value_is_valid(&curVal))
262 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &temp->iface);
266 if (!OCResourcePayloadAddStringLL(&temp->iface, OC_RSRVD_INTERFACE_LL))
268 err = CborErrorOutOfMemory;
272 // Name - Not a mandatory field
273 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_NAME, &curVal);
274 if (cbor_value_is_valid(&curVal))
276 err = cbor_value_dup_text_string(&curVal, &temp->name, &len, NULL);
277 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name");
280 // Look for Links which will have an array as the value
282 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_LINKS, &linkMap);
283 VERIFY_CBOR_SUCCESS(TAG, err, "to find links tag");
285 // Enter the links array and start iterating through the array processing
286 // each resource which shows up as a map.
287 CborValue resourceMap;
288 err = cbor_value_enter_container(&linkMap, &resourceMap);
289 VERIFY_CBOR_SUCCESS(TAG, err, "to enter link map");
291 while (cbor_value_is_map(&resourceMap))
293 resource = (OCResourcePayload *)OICCalloc(1, sizeof(OCResourcePayload));
294 VERIFY_PARAM_NON_NULL(TAG, resource, "Failed allocating resource payload");
297 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_HREF, &curVal);
298 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
299 err = cbor_value_dup_text_string(&curVal, &(resource->uri), &len, NULL);
300 VERIFY_CBOR_SUCCESS(TAG, err, "to find href value");
303 err = OCParseStringLL(&resourceMap, OC_RSRVD_RESOURCE_TYPE, &resource->types);
304 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag/value");
307 err = OCParseStringLL(&resourceMap, OC_RSRVD_INTERFACE, &resource->interfaces);
308 if (CborNoError != err)
310 if (!OCResourcePayloadAddStringLL(&resource->interfaces, OC_RSRVD_INTERFACE_LL))
312 OIC_LOG(ERROR, TAG, "Failed to add string to StringLL");
319 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_POLICY, &policyMap);
320 VERIFY_CBOR_SUCCESS(TAG, err, "to find policy tag");
323 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_BITMAP, &curVal);
324 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap tag");
325 err = cbor_value_get_int(&curVal, (int *)&resource->bitmap);
326 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap value");
329 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_SECURE, &curVal);
330 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure tag");
331 if (cbor_value_is_valid(&curVal))
333 err = cbor_value_get_boolean(&curVal, &(resource->secure));
334 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure value");
338 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_HOSTING_PORT, &curVal);
339 VERIFY_CBOR_SUCCESS(TAG, err, "to find port tag");
340 if (cbor_value_is_valid(&curVal))
342 err = cbor_value_get_int(&curVal, (int *)&resource->port);
343 VERIFY_CBOR_SUCCESS(TAG, err, "to find port value");
348 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_TCP_PORT, &curVal);
349 if (cbor_value_is_valid(&curVal))
351 err = cbor_value_get_int(&curVal, (int *)&resource->tcpPort);
352 VERIFY_CBOR_SUCCESS(TAG, err, "to find tcp port value");
356 err = cbor_value_advance(&resourceMap);
357 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
359 OCDiscoveryPayloadAddNewResource(temp, resource);
362 err = cbor_value_leave_container(&linkMap, &resourceMap);
363 VERIFY_CBOR_SUCCESS(TAG, err, "to leave resource map");
365 err = cbor_value_advance(&rootMap);
366 VERIFY_CBOR_SUCCESS(TAG, err, "to advance root map");
368 if(rootPayload == NULL)
375 curPayload->next = temp;
376 curPayload = curPayload->next;
380 err = cbor_value_leave_container(rootValue, &rootMap);
381 VERIFY_CBOR_SUCCESS(TAG, err, "to leave root map");
386 OIC_LOG(ERROR, TAG, "Malformed packet ");
390 *outPayload = (OCPayload *)rootPayload;
391 OIC_LOG_PAYLOAD(DEBUG, *outPayload);
396 OCDiscoveryResourceDestroy(resource);
397 OCDiscoveryPayloadDestroy(rootPayload);
401 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *rootValue)
403 OCStackResult ret = OC_STACK_INVALID_PARAM;
404 CborError err = CborNoError;
405 OCDevicePayload *out = NULL;
406 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid param outPayload");
407 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid param rootValue");
411 out = (OCDevicePayload *)OICCalloc(1, sizeof(OCDevicePayload));
412 VERIFY_PARAM_NON_NULL(TAG, out, "Failed allocating device payload")
413 out->base.type = PAYLOAD_TYPE_DEVICE;
414 ret = OC_STACK_MALFORMED_RESPONSE;
416 if (cbor_value_is_map(rootValue))
420 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
421 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag");
423 if (cbor_value_is_valid(&curVal))
425 err = OCParseStringLL(rootValue, OC_RSRVD_RESOURCE_TYPE, &out->types);
426 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
429 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &curVal);
430 VERIFY_CBOR_SUCCESS(TAG, err, "to find interface tag");
431 if (cbor_value_is_valid(&curVal))
433 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &out->interfaces);
434 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
438 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_ID, &curVal);
439 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
440 if (cbor_value_is_valid(&curVal))
442 if (cbor_value_is_byte_string(&curVal))
444 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&out->sid, &len, NULL);
445 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
447 else if (cbor_value_is_text_string(&curVal))
449 err = cbor_value_dup_text_string(&curVal, &out->sid, &len, NULL);
450 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
454 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_NAME, &curVal);
455 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name tag");
456 if (cbor_value_is_valid(&curVal))
458 err = cbor_value_dup_text_string(&curVal, &out->deviceName, &len, NULL);
459 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name in device payload");
461 // Device Spec Version
462 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SPEC_VERSION, &curVal);
463 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec ver tag");
464 if (cbor_value_is_valid(&curVal))
466 err = cbor_value_dup_text_string(&curVal, &out->specVersion, &len, NULL);
467 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec version in device payload");
469 // Data Model Versions
470 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DATA_MODEL_VERSION, &curVal);
471 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model versions tag");
472 if (cbor_value_is_valid(&curVal))
476 err = cbor_value_dup_text_string(&curVal, &str, &len, NULL);
477 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model versions in device payload");
478 out->dataModelVersions = OCCreateOCStringLL(str);
481 err = cbor_value_advance(rootValue);
482 VERIFY_CBOR_SUCCESS(TAG, err, "to advance device payload");
484 *outPayload = (OCPayload *)out;
489 OCDevicePayloadDestroy(out);
493 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *rootValue)
495 OCStackResult ret = OC_STACK_INVALID_PARAM;
496 CborError err = CborNoError;
497 OCPlatformInfo info = {0};
498 OCStringLL* rt = NULL;
499 OCStringLL* interfaces = NULL;
500 OCPlatformPayload* out = NULL;
502 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
504 if (cbor_value_is_map(rootValue))
508 ret = OC_STACK_MALFORMED_RESPONSE;
511 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_ID, &repVal);
512 VERIFY_CBOR_SUCCESS(TAG, err, "to find platform id tag");
513 if (cbor_value_is_valid(&repVal))
515 err = cbor_value_dup_text_string(&repVal, &(info.platformID), &len, NULL);
516 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformID in the platform payload");
519 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_NAME, &repVal);
520 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg name tag");
521 if (cbor_value_is_valid(&repVal))
523 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerName), &len, NULL);
524 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureName in the platform payload");
527 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_URL, &repVal);
528 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg url tag");
529 if (cbor_value_is_valid(&repVal))
531 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerUrl), &len, NULL);
532 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureUrl in the platform payload");
535 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MODEL_NUM, &repVal);
536 VERIFY_CBOR_SUCCESS(TAG, err, "to find model num tag");
537 if (cbor_value_is_valid(&repVal))
539 err = cbor_value_dup_text_string(&repVal, &(info.modelNumber), &len, NULL);
540 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find modelNumber in the platform payload");
543 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_DATE, &repVal);
544 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg date tag");
545 if (cbor_value_is_valid(&repVal))
547 err = cbor_value_dup_text_string(&repVal, &(info.dateOfManufacture), &len, NULL);
548 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find dateOfManufacture in the platform payload");
551 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_VERSION, &repVal);
552 VERIFY_CBOR_SUCCESS(TAG, err, "to find platform ver tag");
553 if (cbor_value_is_valid(&repVal))
555 err = cbor_value_dup_text_string(&repVal, &(info.platformVersion), &len, NULL);
556 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformVersion in the platform payload");
559 err = cbor_value_map_find_value(rootValue, OC_RSRVD_OS_VERSION, &repVal);
560 VERIFY_CBOR_SUCCESS(TAG, err, "to find os ver tag");
561 if (cbor_value_is_valid(&repVal))
563 err = cbor_value_dup_text_string(&repVal, &(info.operatingSystemVersion), &len, NULL);
564 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find OSVersion in the platform payload");
567 err = cbor_value_map_find_value(rootValue, OC_RSRVD_HARDWARE_VERSION, &repVal);
568 VERIFY_CBOR_SUCCESS(TAG, err, "to find hw ver tag");
569 if(cbor_value_is_valid(&repVal))
571 err = cbor_value_dup_text_string(&repVal, &(info.hardwareVersion), &len, NULL);
572 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find HWVersion in the platform payload");
575 err = cbor_value_map_find_value(rootValue, OC_RSRVD_FIRMWARE_VERSION, &repVal);
576 VERIFY_CBOR_SUCCESS(TAG, err, "to find fw ver tag");
577 if(cbor_value_is_valid(&repVal))
579 err = cbor_value_dup_text_string(&repVal, &(info.firmwareVersion), &len, NULL);
580 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find firmwareVersion in the platform payload");
583 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SUPPORT_URL, &repVal);
584 VERIFY_CBOR_SUCCESS(TAG, err, "to find support url tag");
585 if(cbor_value_is_valid(&repVal))
587 err = cbor_value_dup_text_string(&repVal, &(info.supportUrl), &len, NULL);
588 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
591 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SYSTEM_TIME, &repVal);
592 VERIFY_CBOR_SUCCESS(TAG, err, "to find sys time tag");
593 if(cbor_value_is_valid(&repVal))
595 err = cbor_value_dup_text_string(&repVal, &(info.systemTime), &len, NULL);
596 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find systemTume in the platform payload");
600 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &repVal);
601 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag");
603 if(cbor_value_is_valid(&repVal))
605 err = OCParseStringLL(rootValue, OC_RSRVD_RESOURCE_TYPE, &rt);
606 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find resource type in the platform payload");
610 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &repVal);
611 VERIFY_CBOR_SUCCESS(TAG, err, "to find interface tag");
613 if(cbor_value_is_valid(&repVal))
615 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &interfaces);
616 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
619 err = cbor_value_advance(rootValue);
620 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
622 out = (OCPlatformPayload *)OCPlatformPayloadCreateAsOwner(&info);
624 out->interfaces = interfaces;
625 *outPayload = (OCPayload *)out;
626 OIC_LOG_PAYLOAD(DEBUG, *outPayload);
631 OCPlatformInfoDestroy(&info);
632 OIC_LOG(ERROR, TAG, "CBOR error In ParsePlatformPayload");
636 static OCRepPayloadPropType DecodeCborType(CborType type)
641 return OCREP_PROP_NULL;
642 case CborIntegerType:
643 return OCREP_PROP_INT;
646 return OCREP_PROP_DOUBLE;
647 case CborBooleanType:
648 return OCREP_PROP_BOOL;
649 case CborTextStringType:
650 return OCREP_PROP_STRING;
651 case CborByteStringType:
652 return OCREP_PROP_BYTE_STRING;
654 return OCREP_PROP_OBJECT;
656 return OCREP_PROP_ARRAY;
658 return OCREP_PROP_NULL;
661 static CborError OCParseArrayFindDimensionsAndType(const CborValue *parent,
662 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType *type)
664 CborValue insideArray;
665 *type = OCREP_PROP_NULL;
666 dimensions[0] = dimensions[1] = dimensions[2] = 0;
668 CborError err = cbor_value_enter_container(parent, &insideArray);
669 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
671 while (cbor_value_is_valid(&insideArray))
673 OCRepPayloadPropType tempType = DecodeCborType(cbor_value_get_type(&insideArray));
675 if (tempType == OCREP_PROP_ARRAY)
677 size_t subdim[MAX_REP_ARRAY_DEPTH];
678 tempType = OCREP_PROP_NULL;
679 err = OCParseArrayFindDimensionsAndType(&insideArray, subdim, &tempType);
680 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse array");
684 OIC_LOG(ERROR, TAG, "Parse array helper, sub-array too deep");
687 dimensions[1] = dimensions[1] >= subdim[0] ? dimensions[1] : subdim[0];
688 dimensions[2] = dimensions[2] >= subdim[1] ? dimensions[2] : subdim[1];
690 if (*type != OCREP_PROP_NULL && tempType != OCREP_PROP_NULL && *type != tempType)
692 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed (subtype)");
693 return CborUnknownError;
695 else if (*type == OCREP_PROP_NULL)
697 // We don't know the type of this array yet, so the assignment is OK
701 else if (*type == OCREP_PROP_NULL)
703 // We don't know the type of this array yet, so the assignment is OK
706 // tempType is allowed to be NULL, since it might now know the answer yet
707 else if (tempType != OCREP_PROP_NULL && *type != tempType)
709 // this is an invalid situation!
710 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed");
711 return CborUnknownError;
715 err = cbor_value_advance(&insideArray);
716 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance array");
723 static size_t getAllocSize(OCRepPayloadPropType type)
728 return sizeof (int64_t);
729 case OCREP_PROP_DOUBLE:
730 return sizeof (double);
731 case OCREP_PROP_BOOL:
732 return sizeof (bool);
733 case OCREP_PROP_STRING:
734 return sizeof (char*);
735 case OCREP_PROP_BYTE_STRING:
736 return sizeof (OCByteString);
737 case OCREP_PROP_OBJECT:
738 return sizeof (OCRepPayload*);
744 static size_t arrayStep(size_t dimensions[MAX_REP_ARRAY_DEPTH], size_t elementNum)
747 (dimensions[1] == 0 ? 1 : dimensions[1]) *
748 (dimensions[2] == 0 ? 1 : dimensions[2]) *
752 static CborError OCParseArrayFillArray(const CborValue *parent,
753 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType type, void *targetArray)
755 CborValue insideArray;
758 char *tempStr = NULL;
759 OCByteString ocByteStr = { .bytes = NULL, .len = 0};
761 OCRepPayload *tempPl = NULL;
763 size_t newdim[MAX_REP_ARRAY_DEPTH];
764 newdim[0] = dimensions[1];
765 newdim[1] = dimensions[2];
768 CborError err = cbor_value_enter_container(parent, &insideArray);
769 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
771 while (!err && i < dimensions[0] && cbor_value_is_valid(&insideArray))
773 bool noAdvance = false;
774 if (cbor_value_get_type(&insideArray) != CborNullType)
779 if (dimensions[1] == 0)
781 err = cbor_value_get_int64(&insideArray, &(((int64_t*)targetArray)[i]));
785 err = OCParseArrayFillArray(&insideArray, newdim, type,
786 &(((int64_t*)targetArray)[arrayStep(dimensions, i)]));
789 case OCREP_PROP_DOUBLE:
790 if (dimensions[1] == 0)
792 double *d = &(((double*)targetArray)[i]);
793 if (cbor_value_get_type(&insideArray) == CborDoubleType)
795 err = cbor_value_get_double(&insideArray, d);
801 err = cbor_value_get_float(&insideArray, &f);
808 err = OCParseArrayFillArray(&insideArray, newdim, type,
809 &(((double*)targetArray)[arrayStep(dimensions, i)]));
812 case OCREP_PROP_BOOL:
813 if (dimensions[1] == 0)
815 err = cbor_value_get_boolean(&insideArray, &(((bool*)targetArray)[i]));
819 err = OCParseArrayFillArray(&insideArray, newdim, type,
820 &(((bool*)targetArray)[arrayStep(dimensions, i)]));
823 case OCREP_PROP_STRING:
824 if (dimensions[1] == 0)
826 err = cbor_value_dup_text_string(&insideArray, &tempStr, &tempLen, NULL);
827 ((char**)targetArray)[i] = tempStr;
832 err = OCParseArrayFillArray(&insideArray, newdim, type,
833 &(((char**)targetArray)[arrayStep(dimensions, i)]));
836 case OCREP_PROP_BYTE_STRING:
837 if (dimensions[1] == 0)
839 err = cbor_value_dup_byte_string(&insideArray, &(ocByteStr.bytes),
840 &(ocByteStr.len), NULL);
841 ((OCByteString*)targetArray)[i] = ocByteStr;
845 err = OCParseArrayFillArray(&insideArray, newdim, type,
846 &(((OCByteString*)targetArray)[arrayStep(dimensions, i)]));
849 case OCREP_PROP_OBJECT:
850 if (dimensions[1] == 0)
852 err = OCParseSingleRepPayload(&tempPl, &insideArray, false);
853 ((OCRepPayload**)targetArray)[i] = tempPl;
859 err = OCParseArrayFillArray(&insideArray, newdim, type,
860 &(((OCRepPayload**)targetArray)[arrayStep(dimensions, i)]));
864 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
865 err = CborErrorUnknownType;
868 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting repPayload");
871 if (!noAdvance && cbor_value_is_valid(&insideArray))
873 err = cbor_value_advance(&insideArray);
874 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advnce insideArray");
882 static CborError OCParseArray(OCRepPayload *out, const char *name, CborValue *container)
886 OCRepPayloadPropType type = OCREP_PROP_NULL;
887 size_t dimensions[MAX_REP_ARRAY_DEPTH] = { 0 };
890 size_t allocSize = 0;
892 CborError err = OCParseArrayFindDimensionsAndType(container, dimensions, &type);
893 VERIFY_CBOR_SUCCESS(TAG, err, "Array details weren't clear");
895 if (type == OCREP_PROP_NULL)
897 res = OCRepPayloadSetNull(out, name);
898 err = (CborError) !res;
899 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
900 err = cbor_value_advance(container);
901 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing container");
905 dimTotal = calcDimTotal(dimensions);
906 allocSize = getAllocSize(type);
907 arr = OICCalloc(dimTotal, allocSize);
908 VERIFY_PARAM_NON_NULL(TAG, arr, "Array Parse allocation failed");
910 res = OCParseArrayFillArray(container, dimensions, type, arr);
911 VERIFY_CBOR_SUCCESS(TAG, err, "Failed parse array");
916 res = OCRepPayloadSetIntArrayAsOwner(out, name, (int64_t *)arr, dimensions);
918 case OCREP_PROP_DOUBLE:
919 res = OCRepPayloadSetDoubleArrayAsOwner(out, name, (double *)arr, dimensions);
921 case OCREP_PROP_BOOL:
922 res = OCRepPayloadSetBoolArrayAsOwner(out, name, (bool *)arr, dimensions);
924 case OCREP_PROP_STRING:
925 res = OCRepPayloadSetStringArrayAsOwner(out, name, (char **)arr, dimensions);
927 case OCREP_PROP_BYTE_STRING:
928 res = OCRepPayloadSetByteStringArrayAsOwner(out, name, (OCByteString *)arr, dimensions);
930 case OCREP_PROP_OBJECT:
931 res = OCRepPayloadSetPropObjectArrayAsOwner(out, name, (OCRepPayload**)arr, dimensions);
934 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
937 err = (CborError) !res;
938 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting array parameter");
941 if (type == OCREP_PROP_STRING)
943 for(size_t i = 0; i < dimTotal; ++i)
945 OICFree(((char**)arr)[i]);
948 if (type == OCREP_PROP_BYTE_STRING)
950 for(size_t i = 0; i < dimTotal; ++i)
952 OICFree(((OCByteString*)arr)[i].bytes);
955 if (type == OCREP_PROP_OBJECT)
957 for(size_t i = 0; i < dimTotal; ++i)
959 OCRepPayloadDestroy(((OCRepPayload**)arr)[i]);
966 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *objMap, bool isRoot)
968 CborError err = CborUnknownError;
971 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
972 VERIFY_PARAM_NON_NULL(TAG, objMap, "Invalid Parameter objMap");
974 if (cbor_value_is_map(objMap))
978 *outPayload = OCRepPayloadCreate();
981 return CborErrorOutOfMemory;
985 OCRepPayload *curPayload = *outPayload;
989 err = cbor_value_enter_container(objMap, &repMap);
990 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
992 while (!err && cbor_value_is_valid(&repMap))
994 if (cbor_value_is_text_string(&repMap))
996 err = cbor_value_dup_text_string(&repMap, &name, &len, NULL);
997 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding tag name in the map");
998 err = cbor_value_advance(&repMap);
999 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing rootMap");
1002 ((0 == strcmp(OC_RSRVD_HREF, name)) ||
1003 (0 == strcmp(OC_RSRVD_RESOURCE_TYPE, name)) ||
1004 (0 == strcmp(OC_RSRVD_INTERFACE, name))))
1006 err = cbor_value_advance(&repMap);
1011 CborType type = cbor_value_get_type(&repMap);
1015 res = OCRepPayloadSetNull(curPayload, name);
1017 case CborIntegerType:
1020 err = cbor_value_get_int64(&repMap, &intval);
1021 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting int value");
1022 res = OCRepPayloadSetPropInt(curPayload, name, intval);
1025 case CborDoubleType:
1027 double doubleval = 0;
1028 err = cbor_value_get_double(&repMap, &doubleval);
1029 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting double value");
1030 res = OCRepPayloadSetPropDouble(curPayload, name, doubleval);
1033 case CborBooleanType:
1035 bool boolval = false;
1036 err = cbor_value_get_boolean(&repMap, &boolval);
1037 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting boolean value");
1038 res = OCRepPayloadSetPropBool(curPayload, name, boolval);
1041 case CborTextStringType:
1043 char *strval = NULL;
1044 err = cbor_value_dup_text_string(&repMap, &strval, &len, NULL);
1045 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting string value");
1046 res = OCRepPayloadSetPropStringAsOwner(curPayload, name, strval);
1049 case CborByteStringType:
1051 uint8_t* bytestrval = NULL;
1052 err = cbor_value_dup_byte_string(&repMap, &bytestrval, &len, NULL);
1053 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting byte string value");
1054 OCByteString tmp = {.bytes = bytestrval, .len = len};
1055 res = OCRepPayloadSetPropByteStringAsOwner(curPayload, name, &tmp);
1060 OCRepPayload *pl = NULL;
1061 err = OCParseSingleRepPayload(&pl, &repMap, false);
1062 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting parse single rep");
1063 res = OCRepPayloadSetPropObjectAsOwner(curPayload, name, pl);
1067 err = OCParseArray(curPayload, name, &repMap);
1070 OIC_LOG_V(ERROR, TAG, "Parsing rep property, unknown type %d", repMap.type);
1073 if (type != CborArrayType)
1075 err = (CborError) !res;
1077 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
1079 if (type != CborMapType && cbor_value_is_valid(&repMap))
1081 err = cbor_value_advance(&repMap);
1082 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advance repMap");
1087 if (cbor_value_is_container(objMap))
1089 err = cbor_value_leave_container(objMap, &repMap);
1090 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to leave container");
1097 OCRepPayloadDestroy(*outPayload);
1102 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *root)
1104 OCStackResult ret = OC_STACK_INVALID_PARAM;
1106 OCRepPayload *temp = NULL;
1107 OCRepPayload *rootPayload = NULL;
1108 OCRepPayload *curPayload = NULL;
1109 CborValue rootMap = *root;
1110 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1111 VERIFY_PARAM_NON_NULL(TAG, root, "Invalid Parameter root");
1114 if (cbor_value_is_array(root))
1116 err = cbor_value_enter_container(root, &rootMap);
1117 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
1119 while (cbor_value_is_valid(&rootMap))
1121 temp = OCRepPayloadCreate();
1122 ret = OC_STACK_NO_MEMORY;
1123 VERIFY_PARAM_NON_NULL(TAG, temp, "Failed allocating memory");
1126 ret = OC_STACK_MALFORMED_RESPONSE;
1128 // temporary fix to check for malformed cbor payload
1129 if (!cbor_value_is_map(&rootMap) && !cbor_value_is_array(&rootMap)){
1133 if (cbor_value_is_map(&rootMap))
1135 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
1136 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
1137 if (cbor_value_is_valid(&curVal))
1140 err = cbor_value_dup_text_string(&curVal, &temp->uri, &len, NULL);
1141 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find uri");
1146 if (cbor_value_is_map(&rootMap))
1148 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal))
1150 err = OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &temp->types);
1151 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
1156 if (cbor_value_is_map(&rootMap))
1158 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal))
1160 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &temp->interfaces);
1161 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
1165 if (cbor_value_is_map(&rootMap))
1167 err = OCParseSingleRepPayload(&temp, &rootMap, true);
1168 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse single rep payload");
1171 if(rootPayload == NULL)
1178 curPayload->next = temp;
1179 curPayload = curPayload->next;
1182 if (cbor_value_is_array(&rootMap))
1184 err = cbor_value_advance(&rootMap);
1185 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance single rep payload");
1188 *outPayload = (OCPayload *)rootPayload;
1192 OCRepPayloadDestroy(temp);
1193 OCRepPayloadDestroy(rootPayload);
1194 OIC_LOG(ERROR, TAG, "CBOR error in ParseRepPayload");
1198 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *rootValue)
1200 OCStackResult ret = OC_STACK_INVALID_PARAM;
1201 OCPresencePayload *payload = NULL;
1202 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1206 payload = (OCPresencePayload *)OICCalloc(1, sizeof(OCPresencePayload));
1207 ret = OC_STACK_NO_MEMORY;
1208 VERIFY_PARAM_NON_NULL(TAG, payload, "Failed allocating presence payload");
1209 payload->base.type = PAYLOAD_TYPE_PRESENCE;
1210 ret = OC_STACK_MALFORMED_RESPONSE;
1212 if (cbor_value_is_map(rootValue))
1218 CborError err = cbor_value_map_find_value(rootValue, OC_RSRVD_NONCE, &curVal);
1219 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce tag");
1220 err = cbor_value_get_uint64(&curVal, &temp);
1221 payload->sequenceNumber = (uint32_t)temp;
1222 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce value");
1225 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TTL, &curVal);
1226 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl tag");
1228 err = cbor_value_get_uint64(&curVal, &temp);
1229 payload->maxAge = (uint32_t)temp;
1230 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl value");
1233 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TRIGGER, &curVal);
1234 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger tag");
1235 err = cbor_value_get_simple_type(&curVal, (uint8_t *)&payload->trigger);
1236 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger value");
1238 // Resource type name
1239 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
1240 VERIFY_CBOR_SUCCESS(TAG, err, "to find res type tag");
1241 if (cbor_value_is_valid(&curVal))
1244 err = cbor_value_dup_text_string(&curVal, &payload->resourceType, &len, NULL);
1245 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding resource type value");
1248 err = cbor_value_advance(rootValue);
1249 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing root value");
1251 *outPayload = (OCPayload *)payload;
1255 OIC_LOG(ERROR, TAG, "CBOR error Parse Presence Payload");
1256 OCPresencePayloadDestroy(payload);