resource/csdk/stack/src/ocpayloadparse.c

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  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
  29 #include <string.h>
  30 #include <stdlib.h>
  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
  39 #define TAG "OIC_RI_PAYLOADPARSE"
  40
  41 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *arrayVal);
  42 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *arrayVal);
  43 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *arrayVal);
  44 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *repParent, bool isRoot);
  45 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *arrayVal);
  46 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *arrayVal);
  47 static OCStackResult OCParseSecurityPayload(OCPayload **outPayload, CborValue * rrayVal);
  48
  49 OCStackResult OCParsePayload(OCPayload **outPayload, OCPayloadType payloadType,
  50         const uint8_t *payload, size_t payloadSize)
  51 {
  52     OCStackResult result = OC_STACK_MALFORMED_RESPONSE;
  53     CborError err;
  54
  55     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Conversion of outPayload failed");
  56     VERIFY_PARAM_NON_NULL(TAG, payload, "Invalid cbor payload value");
  57
  58     OIC_LOG_V(INFO, TAG, "CBOR Parsing size: %zu", payloadSize);
  59
  60     CborParser parser;
  61     CborValue rootValue;
  62
  63     err = cbor_parser_init(payload, payloadSize, 0, &parser, &rootValue);
  64     VERIFY_CBOR_SUCCESS(TAG, err, "Failed initializing init value")
  65
  66     switch(payloadType)
  67     {
  68         case PAYLOAD_TYPE_DISCOVERY:
  69             result = OCParseDiscoveryPayload(outPayload, &rootValue);
  70             break;
  71         case PAYLOAD_TYPE_DEVICE:
  72             result = OCParseDevicePayload(outPayload, &rootValue);
  73             break;
  74         case PAYLOAD_TYPE_PLATFORM:
  75             result = OCParsePlatformPayload(outPayload, &rootValue);
  76             break;
  77         case PAYLOAD_TYPE_REPRESENTATION:
  78             result = OCParseRepPayload(outPayload, &rootValue);
  79             break;
  80         case PAYLOAD_TYPE_PRESENCE:
  81             result = OCParsePresencePayload(outPayload, &rootValue);
  82             break;
  83         case PAYLOAD_TYPE_SECURITY:
  84             result = OCParseSecurityPayload(outPayload, &rootValue);
  85             break;
  86         case PAYLOAD_TYPE_RD:
  87             result = OCRDCborToPayload(&rootValue, outPayload);
  88             break;
  89         default:
  90             OIC_LOG_V(ERROR, TAG, "ParsePayload Type default: %d", payloadType);
  91             result = OC_STACK_INVALID_PARAM;
  92             break;
  93     }
  94
  95     OIC_LOG_V(INFO, TAG, "Finished parse payload, result is %d", result);
  96
  97 exit:
  98     return result;
  99 }
 100
 101 void OCFreeOCStringLL(OCStringLL* ll);
 102
 103 static OCStackResult OCParseSecurityPayload(OCPayload** outPayload, CborValue* rootValue)
 104 {
 105     OCStackResult ret = OC_STACK_MALFORMED_RESPONSE;
 106     CborError err;
 107     char *securityData = NULL;
 108
 109     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid parameter");
 110     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid cbor");
 111
 112     CborValue strVal;
 113
 114     err = cbor_value_enter_container(rootValue, &strVal);
 115     VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering container");
 116     if (cbor_value_is_text_string(&strVal))
 117     {
 118         size_t len = 0;
 119         err = cbor_value_dup_text_string(&strVal, &securityData, &len, NULL);
 120         VERIFY_CBOR_SUCCESS(TAG, err, "Failed reading security data");
 121         *outPayload = (OCPayload *)OCSecurityPayloadCreate(securityData);
 122         VERIFY_PARAM_NON_NULL(TAG, *outPayload, "Invalid cbor");
 123         ret = OC_STACK_OK;
 124     }
 125
 126 exit:
 127     OICFree(securityData);
 128     return ret;
 129
 130 }
 131
 132 static char* InPlaceStringTrim(char* str)
 133 {
 134     while (str[0] == ' ')
 135     {
 136         ++str;
 137     }
 138
 139     size_t lastchar = strlen(str);
 140
 141     while (str[lastchar] == ' ')
 142     {
 143         str[lastchar] = '\0';
 144         --lastchar;
 145     }
 146
 147     return str;
 148 }
 149
 150 static CborError OCParseStringLL(CborValue *map, char *type, OCStringLL **resource)
 151 {
 152     CborValue val;
 153     CborError err = cbor_value_map_find_value(map, type, &val);
 154     VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL TAG");
 155
 156     if (cbor_value_is_text_string(&val))
 157     {
 158         char *input = NULL;
 159         char *savePtr = NULL;
 160         size_t len = 0;
 161
 162         err = cbor_value_dup_text_string(&val, &input, &len, NULL);
 163         VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL value");
 164
 165         if (input)
 166         {
 167             char *curPtr = strtok_r(input, " ", &savePtr);
 168             while (curPtr)
 169             {
 170                 char *trimmed = InPlaceStringTrim(curPtr);
 171                 if (trimmed[0] !='\0')
 172                 {
 173                     if (!OCResourcePayloadAddStringLL(resource, trimmed))
 174                     {
 175                         return CborErrorOutOfMemory;
 176                     }
 177                 }
 178                 curPtr = strtok_r(NULL, " ", &savePtr);
 179             }
 180             OICFree(input);
 181         }
 182     }
 183 exit:
 184     return err;
 185 }
 186
 187 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *rootValue)
 188 {
 189     OCStackResult ret = OC_STACK_INVALID_PARAM;
 190     OCResourcePayload *resource = NULL;
 191     OCDiscoveryPayload *out = NULL;
 192     size_t len = 0;
 193     CborError err = CborNoError;
 194     *outPayload = NULL;
 195
 196     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
 197     VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid Parameter rootValue");
 198
 199     // Root value is already inside the main root array
 200     CborValue rootMap;
 201     ret = OC_STACK_NO_MEMORY;
 202     out = OCDiscoveryPayloadCreate();
 203     VERIFY_PARAM_NON_NULL(TAG, out, "Failed error initializing discovery payload");
 204
 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
 210     // Look for DI
 211     CborValue curVal;
 212     err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_ID, &curVal);
 213     VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
 214     if (cbor_value_is_valid(&curVal))
 215     {
 216         if (cbor_value_is_byte_string(&curVal))
 217         {
 218             err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&(out->sid), &len, NULL);
 219             VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
 220         }
 221         else if (cbor_value_is_text_string(&curVal))
 222         {
 223             err = cbor_value_dup_text_string(&curVal, &(out->sid), &len, NULL);
 224             VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
 225         }
 226     }
 227
 228     // BaseURI - Not a mandatory field
 229     err = cbor_value_map_find_value(&rootMap, OC_RSRVD_BASE_URI, &curVal);
 230     if (cbor_value_is_valid(&curVal))
 231     {
 232         err = cbor_value_dup_text_string(&curVal, &(out->baseURI), &len, NULL);
 233         VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
 234     }
 235
 236     // Look for Links which will have an array as the value
 237     CborValue linkMap;
 238     err = cbor_value_map_find_value(&rootMap, OC_RSRVD_LINKS, &linkMap);
 239     VERIFY_CBOR_SUCCESS(TAG, err, "to find links tag");
 240
 241     // Enter the links array and start iterating through the array processing
 242     // each resource which shows up as a map.
 243     CborValue resourceMap;
 244     err = cbor_value_enter_container(&linkMap, &resourceMap);
 245     VERIFY_CBOR_SUCCESS(TAG, err, "to enter link map");
 246
 247     while (cbor_value_is_map(&resourceMap))
 248     {
 249         resource = (OCResourcePayload *)OICCalloc(1, sizeof(OCResourcePayload));
 250         VERIFY_PARAM_NON_NULL(TAG, resource, "Failed allocating resource payload");
 251
 252         // Uri
 253         err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_HREF, &curVal);
 254         VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
 255         err = cbor_value_dup_text_string(&curVal, &(resource->uri), &len, NULL);
 256         VERIFY_CBOR_SUCCESS(TAG, err, "to find href value");
 257
 258         // ResourceTypes
 259         err =  OCParseStringLL(&resourceMap, OC_RSRVD_RESOURCE_TYPE, &resource->types);
 260         VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag/value");
 261
 262         // Interface Types
 263         err =  OCParseStringLL(&resourceMap, OC_RSRVD_INTERFACE, &resource->interfaces);
 264         if (CborNoError != err)
 265         {
 266             if (!OCResourcePayloadAddStringLL(&resource->interfaces, OC_RSRVD_INTERFACE_LL))
 267             {
 268                 err = CborErrorOutOfMemory;
 269             }
 270         }
 271
 272         // Policy
 273         CborValue policyMap;
 274         err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_POLICY, &policyMap);
 275         VERIFY_CBOR_SUCCESS(TAG, err, "to find policy tag");
 276
 277         // Bitmap
 278         err = cbor_value_map_find_value(&policyMap, OC_RSRVD_BITMAP, &curVal);
 279         VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap tag");
 280         err = cbor_value_get_int(&curVal, (int *)&resource->bitmap);
 281         VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap value");
 282
 283         // Secure Flag
 284         err = cbor_value_map_find_value(&policyMap, OC_RSRVD_SECURE, &curVal);
 285         if (cbor_value_is_valid(&curVal))
 286         {
 287             err = cbor_value_get_boolean(&curVal, &(resource->secure));
 288             VERIFY_CBOR_SUCCESS(TAG, err, "to find secure value");
 289         }
 290
 291         // Port
 292         err = cbor_value_map_find_value(&policyMap, OC_RSRVD_HOSTING_PORT, &curVal);
 293         if (cbor_value_is_valid(&curVal))
 294         {
 295             err = cbor_value_get_int(&curVal, (int *)&resource->port);
 296             VERIFY_CBOR_SUCCESS(TAG, err, "to find port value");
 297         }
 298
 299         err = cbor_value_advance(&resourceMap);
 300         VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
 301
 302         OCDiscoveryPayloadAddNewResource(out, resource);
 303     }
 304
 305     err = cbor_value_leave_container(rootValue, &resourceMap);
 306     VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
 307
 308     *outPayload = (OCPayload *)out;
 309     return OC_STACK_OK;
 310
 311 exit:
 312     OCDiscoveryResourceDestroy(resource);
 313     OCDiscoveryPayloadDestroy(out);
 314     return ret;
 315 }
 316
 317 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *rootValue)
 318 {
 319     OCStackResult ret = OC_STACK_INVALID_PARAM;
 320     CborError err = CborNoError;
 321     OCDevicePayload *out = NULL;
 322     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid param outPayload");
 323     VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid param rootValue");
 324
 325     *outPayload = NULL;
 326
 327     out = (OCDevicePayload *)OICCalloc(1, sizeof(OCDevicePayload));
 328     VERIFY_PARAM_NON_NULL(TAG, out, "Failed allocating device payload")
 329     out->base.type = PAYLOAD_TYPE_DEVICE;
 330     ret = OC_STACK_MALFORMED_RESPONSE;
 331
 332     if (cbor_value_is_map(rootValue))
 333     {
 334         // Device ID
 335         size_t len = 0;
 336         CborValue curVal;
 337         err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_ID, &curVal);
 338         if (cbor_value_is_valid(&curVal))
 339         {
 340             if (cbor_value_is_byte_string(&curVal))
 341             {
 342                 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&out->sid, &len, NULL);
 343                 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
 344             }
 345             else if (cbor_value_is_text_string(&curVal))
 346             {
 347                 err = cbor_value_dup_text_string(&curVal, &out->sid, &len, NULL);
 348                 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
 349             }
 350         }
 351         // Device Name
 352         err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_NAME, &curVal);
 353         if (cbor_value_is_valid(&curVal))
 354         {
 355             err = cbor_value_dup_text_string(&curVal, &out->deviceName, &len, NULL);
 356             VERIFY_CBOR_SUCCESS(TAG, err, "to find device name in device payload");
 357         }
 358         // Device Spec Version
 359         err = cbor_value_map_find_value(rootValue, OC_RSRVD_SPEC_VERSION, &curVal);
 360         if (cbor_value_is_valid(&curVal))
 361         {
 362             err = cbor_value_dup_text_string(&curVal, &out->specVersion, &len, NULL);
 363             VERIFY_CBOR_SUCCESS(TAG, err, "to find spec version in device payload");
 364         }
 365         // Data Model Version
 366         err = cbor_value_map_find_value(rootValue, OC_RSRVD_DATA_MODEL_VERSION, &curVal);
 367         if (cbor_value_is_valid(&curVal))
 368         {
 369             err = cbor_value_dup_text_string(&curVal, &out->dataModelVersion, &len, NULL);
 370             VERIFY_CBOR_SUCCESS(TAG, err, "to find data model version in device payload");
 371         }
 372         err = cbor_value_advance(rootValue);
 373         VERIFY_CBOR_SUCCESS(TAG, err, "to advance device payload");
 374
 375         *outPayload = (OCPayload *)out;
 376         return OC_STACK_OK;
 377     }
 378
 379 exit:
 380     OCDevicePayloadDestroy(out);
 381     return ret;
 382 }
 383
 384 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *rootValue)
 385 {
 386     OCStackResult ret = OC_STACK_INVALID_PARAM;
 387     CborError err = CborNoError;
 388     OCPlatformInfo info = {0};
 389
 390     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
 391
 392     if (cbor_value_is_map(rootValue))
 393     {
 394         CborValue repVal;
 395         size_t len = 0;
 396         ret = OC_STACK_MALFORMED_RESPONSE;
 397
 398         // Platform ID
 399         err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_ID, &repVal);
 400         if (cbor_value_is_valid(&repVal))
 401         {
 402             err = cbor_value_dup_text_string(&repVal, &(info.platformID), &len, NULL);
 403             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformID in the platform payload");
 404         }
 405          // MFG Name
 406         err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_NAME, &repVal);
 407         if (cbor_value_is_valid(&repVal))
 408         {
 409             err = cbor_value_dup_text_string(&repVal, &(info.manufacturerName), &len, NULL);
 410             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureName in the platform payload");
 411         }
 412         // MFG URL
 413         err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_URL, &repVal);
 414         if (cbor_value_is_valid(&repVal))
 415         {
 416             err = cbor_value_dup_text_string(&repVal, &(info.manufacturerUrl), &len, NULL);
 417             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureUrl in the platform payload");
 418         }
 419         // Model Num
 420         err = cbor_value_map_find_value(rootValue, OC_RSRVD_MODEL_NUM, &repVal);
 421         if (cbor_value_is_valid(&repVal))
 422         {
 423             err = cbor_value_dup_text_string(&repVal, &(info.modelNumber), &len, NULL);
 424             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find modelNumber in the platform payload");
 425         }
 426         // Date of Mfg
 427         err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_DATE, &repVal);
 428         if (cbor_value_is_valid(&repVal))
 429         {
 430             err = cbor_value_dup_text_string(&repVal, &(info.dateOfManufacture), &len, NULL);
 431             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find dateOfManufacture in the platform payload");
 432         }
 433         // Platform Version
 434         err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_VERSION, &repVal);
 435         if (cbor_value_is_valid(&repVal))
 436         {
 437             err = cbor_value_dup_text_string(&repVal, &(info.platformVersion), &len, NULL);
 438             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformVersion in the platform payload");
 439         }
 440         // OS Version
 441         err = cbor_value_map_find_value(rootValue, OC_RSRVD_OS_VERSION, &repVal);
 442         if (cbor_value_is_valid(&repVal))
 443         {
 444             err = cbor_value_dup_text_string(&repVal, &(info.operatingSystemVersion), &len, NULL);
 445             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find OSVersion in the platform payload");
 446         }
 447         // Hardware Version
 448         err = cbor_value_map_find_value(rootValue, OC_RSRVD_HARDWARE_VERSION, &repVal);
 449         if(cbor_value_is_valid(&repVal))
 450         {
 451             err = cbor_value_dup_text_string(&repVal, &(info.hardwareVersion), &len, NULL);
 452             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find HWVersion in the platform payload");
 453         }
 454         // Firmware Version
 455         err = cbor_value_map_find_value(rootValue, OC_RSRVD_FIRMWARE_VERSION, &repVal);
 456         if(cbor_value_is_valid(&repVal))
 457         {
 458             err = cbor_value_dup_text_string(&repVal, &(info.firmwareVersion), &len, NULL);
 459             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find firmwareVersion in the platform payload");
 460         }
 461         // Support URL
 462         err = cbor_value_map_find_value(rootValue, OC_RSRVD_SUPPORT_URL, &repVal);
 463         if(cbor_value_is_valid(&repVal))
 464         {
 465             err = cbor_value_dup_text_string(&repVal, &(info.supportUrl), &len, NULL);
 466             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
 467         }
 468         // System Time
 469         err = cbor_value_map_find_value(rootValue, OC_RSRVD_SYSTEM_TIME, &repVal);
 470         if(cbor_value_is_valid(&repVal))
 471         {
 472             err = cbor_value_dup_text_string(&repVal, &(info.systemTime), &len, NULL);
 473             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find systemTume in the platform payload");
 474         }
 475
 476         err = cbor_value_advance(rootValue);
 477         VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
 478
 479         *outPayload = (OCPayload *)OCPlatformPayloadCreateAsOwner(&info);
 480         return OC_STACK_OK;
 481     }
 482
 483 exit:
 484     OCPlatformInfoDestroy(&info);
 485     OIC_LOG(ERROR, TAG, "CBOR error In ParsePlatformPayload");
 486     return ret;
 487 }
 488
 489 static OCRepPayloadPropType DecodeCborType(CborType type)
 490 {
 491     switch (type)
 492     {
 493         case CborNullType:
 494             return OCREP_PROP_NULL;
 495         case CborIntegerType:
 496             return OCREP_PROP_INT;
 497         case CborDoubleType:
 498             return OCREP_PROP_DOUBLE;
 499         case CborBooleanType:
 500             return OCREP_PROP_BOOL;
 501         case CborTextStringType:
 502             return OCREP_PROP_STRING;
 503         case CborByteStringType:
 504             return OCREP_PROP_BYTE_STRING;
 505         case CborMapType:
 506             return OCREP_PROP_OBJECT;
 507         case CborArrayType:
 508             return OCREP_PROP_ARRAY;
 509         default:
 510             return OCREP_PROP_NULL;
 511     }
 512 }
 513 static CborError OCParseArrayFindDimensionsAndType(const CborValue *parent,
 514         size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType *type)
 515 {
 516     CborValue insideArray;
 517     *type = OCREP_PROP_NULL;
 518     dimensions[0] = dimensions[1] = dimensions[2] = 0;
 519
 520     CborError err = cbor_value_enter_container(parent, &insideArray);
 521     VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
 522
 523     while (cbor_value_is_valid(&insideArray))
 524     {
 525         OCRepPayloadPropType tempType = DecodeCborType(cbor_value_get_type(&insideArray));
 526
 527         if (tempType == OCREP_PROP_ARRAY)
 528         {
 529             size_t subdim[MAX_REP_ARRAY_DEPTH];
 530             tempType = OCREP_PROP_NULL;
 531             err = OCParseArrayFindDimensionsAndType(&insideArray, subdim, &tempType);
 532             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse array");
 533
 534             if (subdim[2] != 0)
 535             {
 536                 OIC_LOG(ERROR, TAG, "Parse array helper, sub-array too deep");
 537             }
 538
 539             dimensions[1] = dimensions[1] >= subdim[0] ? dimensions[1] : subdim[0];
 540             dimensions[2] = dimensions[2] >= subdim[1] ? dimensions[2] : subdim[1];
 541
 542             if (*type != OCREP_PROP_NULL && tempType != OCREP_PROP_NULL && *type != tempType)
 543             {
 544                 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed (subtype)");
 545                 return CborUnknownError;
 546             }
 547             else if (*type == OCREP_PROP_NULL)
 548             {
 549                 // We don't know the type of this array yet, so the assignment is OK
 550                 *type = tempType;
 551             }
 552         }
 553         else if (*type == OCREP_PROP_NULL)
 554         {
 555             // We don't know the type of this array yet, so the assignment is OK
 556             *type = tempType;
 557         }
 558         // tempType is allowed to be NULL, since it might now know the answer yet
 559         else if (tempType != OCREP_PROP_NULL && *type != tempType)
 560         {
 561             // this is an invalid situation!
 562             OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed");
 563             return CborUnknownError;
 564         }
 565
 566         ++dimensions[0];
 567         err = cbor_value_advance(&insideArray);
 568         VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance array");
 569     }
 570
 571 exit:
 572     return err;
 573 }
 574
 575 static size_t getAllocSize(OCRepPayloadPropType type)
 576 {
 577     switch (type)
 578     {
 579         case OCREP_PROP_INT:
 580             return sizeof (int64_t);
 581         case OCREP_PROP_DOUBLE:
 582             return sizeof (double);
 583         case OCREP_PROP_BOOL:
 584             return sizeof (bool);
 585         case OCREP_PROP_STRING:
 586             return sizeof (char*);
 587         case OCREP_PROP_BYTE_STRING:
 588             return sizeof (OCByteString);
 589         case OCREP_PROP_OBJECT:
 590             return sizeof (OCRepPayload*);
 591         default:
 592             return 0;
 593     }
 594 }
 595
 596 static size_t arrayStep(size_t dimensions[MAX_REP_ARRAY_DEPTH], size_t elementNum)
 597 {
 598     return
 599         (dimensions[1] == 0 ? 1 : dimensions[1]) *
 600         (dimensions[2] == 0 ? 1 : dimensions[2]) *
 601         elementNum;
 602 }
 603
 604 static CborError OCParseArrayFillArray(const CborValue *parent,
 605         size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType type, void *targetArray)
 606 {
 607     CborValue insideArray;
 608
 609     size_t i = 0;
 610     char *tempStr = NULL;
 611     OCByteString ocByteStr = { .bytes = NULL, .len = 0};
 612     size_t tempLen = 0;
 613     OCRepPayload *tempPl = NULL;
 614
 615     size_t newdim[MAX_REP_ARRAY_DEPTH];
 616     newdim[0] = dimensions[1];
 617     newdim[1] = dimensions[2];
 618     newdim[2] = 0;
 619
 620     CborError err = cbor_value_enter_container(parent, &insideArray);
 621     VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
 622
 623     while (!err && i < dimensions[0] && cbor_value_is_valid(&insideArray))
 624     {
 625         bool noAdvance = false;
 626         if (cbor_value_get_type(&insideArray) != CborNullType)
 627         {
 628             switch (type)
 629             {
 630                 case OCREP_PROP_INT:
 631                     if (dimensions[1] == 0)
 632                     {
 633                         err = cbor_value_get_int64(&insideArray, &(((int64_t*)targetArray)[i]));
 634                     }
 635                     else
 636                     {
 637                         err = OCParseArrayFillArray(&insideArray, newdim, type,
 638                             &(((int64_t*)targetArray)[arrayStep(dimensions, i)]));
 639                     }
 640                     break;
 641                 case OCREP_PROP_DOUBLE:
 642                     if (dimensions[1] == 0)
 643                     {
 644                         err = cbor_value_get_double(&insideArray, &(((double*)targetArray)[i]));
 645                     }
 646                     else
 647                     {
 648                         err = OCParseArrayFillArray(&insideArray, newdim, type,
 649                             &(((double*)targetArray)[arrayStep(dimensions, i)]));
 650                     }
 651                     break;
 652                 case OCREP_PROP_BOOL:
 653                     if (dimensions[1] == 0)
 654                     {
 655                         err = cbor_value_get_boolean(&insideArray, &(((bool*)targetArray)[i]));
 656                     }
 657                     else
 658                     {
 659                         err = OCParseArrayFillArray(&insideArray, newdim, type,
 660                             &(((bool*)targetArray)[arrayStep(dimensions, i)]));
 661                     }
 662                     break;
 663                 case OCREP_PROP_STRING:
 664                     if (dimensions[1] == 0)
 665                     {
 666                         err = cbor_value_dup_text_string(&insideArray, &tempStr, &tempLen, NULL);
 667                         ((char**)targetArray)[i] = tempStr;
 668                         tempStr = NULL;
 669                     }
 670                     else
 671                     {
 672                         err = OCParseArrayFillArray(&insideArray, newdim, type,
 673                             &(((char**)targetArray)[arrayStep(dimensions, i)]));
 674                     }
 675                     break;
 676                 case OCREP_PROP_BYTE_STRING:
 677                     if (dimensions[1] == 0)
 678                     {
 679                         err = cbor_value_dup_byte_string(&insideArray, &(ocByteStr.bytes),
 680                                 &(ocByteStr.len), NULL);
 681                         ((OCByteString*)targetArray)[i] = ocByteStr;
 682                     }
 683                     else
 684                     {
 685                         err = OCParseArrayFillArray(&insideArray, newdim, type,
 686                                 &(((OCByteString*)targetArray)[arrayStep(dimensions, i)]));
 687                     }
 688                     break;
 689                 case OCREP_PROP_OBJECT:
 690                     if (dimensions[1] == 0)
 691                     {
 692                         err = OCParseSingleRepPayload(&tempPl, &insideArray, false);
 693                         ((OCRepPayload**)targetArray)[i] = tempPl;
 694                         tempPl = NULL;
 695                         noAdvance = true;
 696                     }
 697                     else
 698                     {
 699                         err = OCParseArrayFillArray(&insideArray, newdim, type,
 700                             &(((OCRepPayload**)targetArray)[arrayStep(dimensions, i)]));
 701                     }
 702                     break;
 703                 default:
 704                     OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
 705                     err = CborErrorUnknownType;
 706                     break;
 707             }
 708             VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting repPayload");
 709         }
 710         ++i;
 711         if (!noAdvance && cbor_value_is_valid(&insideArray))
 712         {
 713             err = cbor_value_advance(&insideArray);
 714             VERIFY_CBOR_SUCCESS(TAG, err, "Failed advnce insideArray");
 715         }
 716     }
 717
 718 exit:
 719     return err;
 720 }
 721
 722 static CborError OCParseArray(OCRepPayload *out, const char *name, CborValue *container)
 723 {
 724     void *arr = NULL;
 725     OCRepPayloadPropType type = OCREP_PROP_NULL;
 726     size_t dimensions[MAX_REP_ARRAY_DEPTH] = { 0 };
 727     size_t dimTotal = 0;
 728     size_t allocSize = 0;
 729     bool res = true;
 730     CborError err = OCParseArrayFindDimensionsAndType(container, dimensions, &type);
 731     VERIFY_CBOR_SUCCESS(TAG, err, "Array details weren't clear");
 732
 733     if (type == OCREP_PROP_NULL)
 734     {
 735         res = OCRepPayloadSetNull(out, name);
 736         err = (CborError) !res;
 737         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
 738         err = cbor_value_advance(container);
 739         VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing container");
 740         return err;
 741     }
 742
 743     dimTotal = calcDimTotal(dimensions);
 744     allocSize = getAllocSize(type);
 745     arr = OICCalloc(dimTotal, allocSize);
 746     VERIFY_PARAM_NON_NULL(TAG, arr, "Array Parse allocation failed");
 747
 748     res = OCParseArrayFillArray(container, dimensions, type, arr);
 749     VERIFY_CBOR_SUCCESS(TAG, err, "Failed parse array");
 750
 751     switch (type)
 752     {
 753         case OCREP_PROP_INT:
 754             res = OCRepPayloadSetIntArrayAsOwner(out, name, (int64_t *)arr, dimensions);
 755             break;
 756         case OCREP_PROP_DOUBLE:
 757             res = OCRepPayloadSetDoubleArrayAsOwner(out, name, (double *)arr, dimensions);
 758             break;
 759         case OCREP_PROP_BOOL:
 760             res = OCRepPayloadSetBoolArrayAsOwner(out, name, (bool *)arr, dimensions);
 761             break;
 762         case OCREP_PROP_STRING:
 763             res = OCRepPayloadSetStringArrayAsOwner(out, name, (char **)arr, dimensions);
 764             break;
 765         case OCREP_PROP_BYTE_STRING:
 766             res = OCRepPayloadSetByteStringArrayAsOwner(out, name, (OCByteString *)arr, dimensions);
 767             break;
 768         case OCREP_PROP_OBJECT:
 769             res = OCRepPayloadSetPropObjectArrayAsOwner(out, name, (OCRepPayload**)arr, dimensions);
 770             break;
 771         default:
 772             OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
 773             break;
 774     }
 775     err = (CborError) !res;
 776     VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting array parameter");
 777     return CborNoError;
 778 exit:
 779     if (type == OCREP_PROP_STRING)
 780     {
 781         for(size_t i = 0; i < dimTotal; ++i)
 782         {
 783             OICFree(((char**)arr)[i]);
 784         }
 785     }
 786     if (type == OCREP_PROP_BYTE_STRING)
 787     {
 788         for(size_t i = 0; i < dimTotal; ++i)
 789         {
 790             OICFree(((OCByteString*)arr)[i].bytes);
 791         }
 792     }
 793     if (type == OCREP_PROP_OBJECT)
 794     {
 795         for(size_t i = 0; i < dimTotal; ++i)
 796         {
 797             OCRepPayloadDestroy(((OCRepPayload**)arr)[i]);
 798         }
 799     }
 800     OICFree(arr);
 801     return err;
 802 }
 803
 804 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *objMap, bool isRoot)
 805 {
 806     CborError err = CborUnknownError;
 807     char *name = NULL;
 808     bool res = false;
 809     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
 810     VERIFY_PARAM_NON_NULL(TAG, objMap, "Invalid Parameter objMap");
 811
 812     if (cbor_value_is_map(objMap))
 813     {
 814         if (!*outPayload)
 815         {
 816             *outPayload = OCRepPayloadCreate();
 817             if (!*outPayload)
 818             {
 819                 return CborErrorOutOfMemory;
 820             }
 821         }
 822
 823         OCRepPayload *curPayload = *outPayload;
 824
 825         size_t len = 0;
 826         CborValue repMap;
 827         err = cbor_value_enter_container(objMap, &repMap);
 828         VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
 829
 830         while (!err && cbor_value_is_valid(&repMap))
 831         {
 832             if (cbor_value_is_text_string(&repMap))
 833             {
 834                 err = cbor_value_dup_text_string(&repMap, &name, &len, NULL);
 835                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding tag name in the map");
 836                 err = cbor_value_advance(&repMap);
 837                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing rootMap");
 838                 if (name &&
 839                     isRoot &&
 840                     ((0 == strcmp(OC_RSRVD_HREF, name)) ||
 841                      (0 == strcmp(OC_RSRVD_RESOURCE_TYPE, name)) ||
 842                     (0 == strcmp(OC_RSRVD_INTERFACE, name))))
 843                 {
 844                     err = cbor_value_advance(&repMap);
 845                     OICFree(name);
 846                     continue;
 847                 }
 848             }
 849             CborType type = cbor_value_get_type(&repMap);
 850             switch (type)
 851             {
 852                 case CborNullType:
 853                     res = OCRepPayloadSetNull(curPayload, name);
 854                     break;
 855                 case CborIntegerType:
 856                     {
 857                         int64_t intval = 0;
 858                         err = cbor_value_get_int64(&repMap, &intval);
 859                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting int value");
 860                         res = OCRepPayloadSetPropInt(curPayload, name, intval);
 861                     }
 862                     break;
 863                 case CborDoubleType:
 864                     {
 865                         double doubleval = 0;
 866                         err = cbor_value_get_double(&repMap, &doubleval);
 867                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting double value");
 868                         res = OCRepPayloadSetPropDouble(curPayload, name, doubleval);
 869                     }
 870                     break;
 871                 case CborBooleanType:
 872                     {
 873                         bool boolval = false;
 874                         err = cbor_value_get_boolean(&repMap, &boolval);
 875                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting boolean value");
 876                         res = OCRepPayloadSetPropBool(curPayload, name, boolval);
 877                     }
 878                     break;
 879                 case CborTextStringType:
 880                     {
 881                         char *strval = NULL;
 882                         err = cbor_value_dup_text_string(&repMap, &strval, &len, NULL);
 883                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting string value");
 884                         res = OCRepPayloadSetPropStringAsOwner(curPayload, name, strval);
 885                     }
 886                     break;
 887                 case CborByteStringType:
 888                     {
 889                         uint8_t* bytestrval = NULL;
 890                         err = cbor_value_dup_byte_string(&repMap, &bytestrval, &len, NULL);
 891                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting byte string value");
 892                         OCByteString tmp = {.bytes = bytestrval, .len = len};
 893                         res = OCRepPayloadSetPropByteStringAsOwner(curPayload, name, &tmp);
 894                     }
 895                     break;
 896                 case CborMapType:
 897                     {
 898                         OCRepPayload *pl = NULL;
 899                         err = OCParseSingleRepPayload(&pl, &repMap, false);
 900                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting parse single rep");
 901                         res = OCRepPayloadSetPropObjectAsOwner(curPayload, name, pl);
 902                     }
 903                     break;
 904                 case CborArrayType:
 905                     err = OCParseArray(curPayload, name, &repMap);
 906                     break;
 907                 default:
 908                     OIC_LOG_V(ERROR, TAG, "Parsing rep property, unknown type %d", repMap.type);
 909                     res = false;
 910             }
 911             if (type != CborArrayType)
 912             {
 913                 err = (CborError) !res;
 914             }
 915             VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
 916
 917             if (type != CborMapType && cbor_value_is_valid(&repMap))
 918             {
 919                 err = cbor_value_advance(&repMap);
 920                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advance repMap");
 921             }
 922             OICFree(name);
 923             name = NULL;
 924         }
 925         if (cbor_value_is_container(objMap))
 926         {
 927             err = cbor_value_leave_container(objMap, &repMap);
 928             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to leave container");
 929         }
 930         return err;
 931     }
 932
 933 exit:
 934     OICFree(name);
 935     OCRepPayloadDestroy(*outPayload);
 936     *outPayload = NULL;
 937     return err;
 938 }
 939
 940 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *root)
 941 {
 942     OCStackResult ret = OC_STACK_INVALID_PARAM;
 943     CborError err;
 944     OCRepPayload *temp = NULL;
 945     OCRepPayload *rootPayload = NULL;
 946     OCRepPayload *curPayload = NULL;
 947     CborValue rootMap = *root;
 948     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
 949     VERIFY_PARAM_NON_NULL(TAG, root, "Invalid Parameter root");
 950
 951     *outPayload = NULL;
 952     if (cbor_value_is_array(root))
 953     {
 954         err = cbor_value_enter_container(root, &rootMap);
 955     }
 956     while (cbor_value_is_valid(&rootMap))
 957     {
 958         temp = OCRepPayloadCreate();
 959         ret = OC_STACK_NO_MEMORY;
 960         VERIFY_PARAM_NON_NULL(TAG, temp, "Failed allocating memory");
 961
 962         CborValue curVal;
 963         ret = OC_STACK_MALFORMED_RESPONSE;
 964
 965         if (cbor_value_is_map(&rootMap))
 966         {
 967             err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
 968             if (cbor_value_is_valid(&curVal))
 969             {
 970                 size_t len = 0;
 971                 err = cbor_value_dup_text_string(&curVal, &temp->uri, &len, NULL);
 972                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find uri");
 973             }
 974         }
 975         // Resource types
 976         if (cbor_value_is_map(&rootMap))
 977         {
 978             if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal))
 979             {
 980                 err =  OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &temp->types);
 981                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
 982             }
 983         }
 984
 985         // Interface Types
 986         if (cbor_value_is_map(&rootMap))
 987         {
 988             if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal))
 989             {
 990                 err =  OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &temp->interfaces);
 991                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
 992             }
 993         }
 994
 995         if (cbor_value_is_map(&rootMap))
 996         {
 997             err = OCParseSingleRepPayload(&temp, &rootMap, true);
 998             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse single rep payload");
 999         }
1000         if(rootPayload == NULL)
1001         {
1002             rootPayload = temp;
1003             curPayload = temp;
1004         }
1005         else
1006         {
1007             curPayload->next = temp;
1008             curPayload = curPayload->next;
1009         }
1010
1011         if (cbor_value_is_array(&rootMap))
1012         {
1013             err = cbor_value_advance(&rootMap);
1014             VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance single rep payload");
1015         }
1016     }
1017     *outPayload = (OCPayload *)rootPayload;
1018     return OC_STACK_OK;
1019
1020 exit:
1021     OCRepPayloadDestroy(temp);
1022     OCRepPayloadDestroy(rootPayload);
1023     OIC_LOG(ERROR, TAG, "CBOR error in ParseRepPayload");
1024     return ret;
1025 }
1026
1027 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *rootValue)
1028 {
1029     OCStackResult ret = OC_STACK_INVALID_PARAM;
1030     OCPresencePayload *payload = NULL;
1031     VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1032
1033     *outPayload = NULL;
1034
1035     payload = (OCPresencePayload *)OICCalloc(1, sizeof(OCPresencePayload));
1036     ret = OC_STACK_NO_MEMORY;
1037     VERIFY_PARAM_NON_NULL(TAG, payload, "Failed allocating presence payload");
1038     payload->base.type = PAYLOAD_TYPE_PRESENCE;
1039     ret = OC_STACK_MALFORMED_RESPONSE;
1040
1041     if (cbor_value_is_map(rootValue))
1042     {
1043         CborValue curVal;
1044
1045         // Sequence Number
1046         CborError err = cbor_value_map_find_value(rootValue, OC_RSRVD_NONCE, &curVal);
1047         VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce tag");
1048         err = cbor_value_get_uint64(&curVal, (uint64_t *)&payload->sequenceNumber);
1049         VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce value");
1050
1051         // Max Age
1052         err = cbor_value_map_find_value(rootValue, OC_RSRVD_TTL, &curVal);
1053         VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl tag");
1054         err = cbor_value_get_uint64(&curVal, (uint64_t *)&payload->maxAge);
1055         VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl value");
1056
1057         // Trigger
1058         err = cbor_value_map_find_value(rootValue, OC_RSRVD_TRIGGER, &curVal);
1059         VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger tag");
1060         err = cbor_value_get_simple_type(&curVal, (uint8_t *)&payload->trigger);
1061         VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger value");
1062
1063         // Resource type name
1064         err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
1065         if (cbor_value_is_valid(&curVal))
1066         {
1067             size_t len = 0;
1068             err = cbor_value_dup_text_string(&curVal, &payload->resourceType, &len, NULL);
1069             VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding resource type value");
1070         }
1071
1072         err = cbor_value_advance(rootValue);
1073         VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing root value");
1074
1075         *outPayload = (OCPayload *)payload;
1076         return OC_STACK_OK;
1077     }
1078 exit:
1079     OIC_LOG(ERROR, TAG, "CBOR error Parse Presence Payload");
1080     OCPresencePayloadDestroy(payload);
1081     return ret;
1082 }