resource/csdk/stack/src/ocpayloadconvert.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 #include "ocpayloadcbor.h"
  22 #include "platform_features.h"
  23 #include <stdlib.h>
  24 #include "oic_malloc.h"
  25 #include "oic_string.h"
  26 #include "logger.h"
  27 #include "ocpayload.h"
  28 #include "ocrandom.h"
  29 #include "ocresourcehandler.h"
  30 #include "cbor.h"
  31 #include "rdpayload.h"
  32
  33 #define TAG "OIC_RI_PAYLOADCONVERT"
  34
  35 // Arbitrarily chosen size that seems to contain the majority of packages
  36 #define INIT_SIZE (255)
  37
  38 // Discovery Links Map Length.
  39 #define LINKS_MAP_LEN 4
  40
  41 // Functions all return either a CborError, or a negative version of the OC_STACK return values
  42 static int64_t OCConvertPayloadHelper(OCPayload *payload, uint8_t *outPayload, size_t *size);
  43 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
  44         size_t *size);
  45 static int64_t OCConvertDevicePayload(OCDevicePayload *payload, uint8_t *outPayload,
  46         size_t *size);
  47 static int64_t OCConvertPlatformPayload(OCPlatformPayload *payload, uint8_t *outPayload,
  48         size_t *size);
  49 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size);
  50 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload);
  51 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
  52         size_t *size);
  53 static int64_t OCConvertSecurityPayload(OCSecurityPayload *payload, uint8_t *outPayload,
  54         size_t *size);
  55 static int64_t OCConvertSingleRepPayload(CborEncoder *parent, const OCRepPayload *payload);
  56 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray);
  57
  58 static int64_t AddTextStringToMap(CborEncoder *map, const char *key, size_t keylen,
  59         const char *value);
  60 static int64_t ConditionalAddTextStringToMap(CborEncoder *map, const char *key, size_t keylen,
  61         const char *value);
  62
  63 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
  64 {
  65     // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
  66     // strategy to work.  If you receive the following assertion error, please do a git-pull
  67     // from the extlibs/tinycbor/tinycbor directory
  68     #define CborNeedsUpdating  (CborErrorOutOfMemory < CborErrorDataTooLarge)
  69     OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
  70     #undef CborNeedsUpdating
  71
  72     OCStackResult ret = OC_STACK_INVALID_PARAM;
  73     int64_t err;
  74     uint8_t *out = NULL;
  75     size_t curSize = INIT_SIZE;
  76
  77     VERIFY_PARAM_NON_NULL(TAG, payload, "Input param, payload is NULL");
  78     VERIFY_PARAM_NON_NULL(TAG, outPayload, "OutPayload parameter is NULL");
  79     VERIFY_PARAM_NON_NULL(TAG, size, "size parameter is NULL");
  80
  81     OIC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
  82
  83     out = (uint8_t *)OICCalloc(1, curSize);
  84     VERIFY_PARAM_NON_NULL(TAG, out, "Failed to allocate payload");
  85     err = OCConvertPayloadHelper(payload, out, &curSize);
  86     ret = OC_STACK_NO_MEMORY;
  87
  88     if (err == CborErrorOutOfMemory)
  89     {
  90         // reallocate "out" and try again!
  91         uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
  92         VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
  93         out = out2;
  94         err = OCConvertPayloadHelper(payload, out, &curSize);
  95         while (err == CborErrorOutOfMemory)
  96         {
  97             uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
  98             VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
  99             out = out2;
 100             err = OCConvertPayloadHelper(payload, out, &curSize);
 101         }
 102     }
 103
 104     if (err == CborNoError)
 105     {
 106         if (curSize < INIT_SIZE)
 107         {
 108             uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
 109             VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
 110             out = out2;
 111         }
 112
 113         *size = curSize;
 114         *outPayload = out;
 115         OIC_LOG_V(DEBUG, TAG, "Payload Size: %zd Payload : %s \n", *size, *outPayload);
 116         return OC_STACK_OK;
 117     }
 118
 119     //TODO: Proper conversion from CborError to OCStackResult.
 120     ret = (OCStackResult)-err;
 121
 122 exit:
 123     OICFree(out);
 124     return ret;
 125 }
 126
 127 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
 128 {
 129     switch(payload->type)
 130     {
 131         case PAYLOAD_TYPE_DISCOVERY:
 132             return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
 133         case PAYLOAD_TYPE_DEVICE:
 134             return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
 135         case PAYLOAD_TYPE_PLATFORM:
 136             return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
 137         case PAYLOAD_TYPE_REPRESENTATION:
 138             return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
 139         case PAYLOAD_TYPE_PRESENCE:
 140             return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
 141         case PAYLOAD_TYPE_SECURITY:
 142             return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
 143         case PAYLOAD_TYPE_RD:
 144             return OCRDPayloadToCbor((OCRDPayload*)payload, outPayload, size);
 145         default:
 146             OIC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
 147             return CborErrorUnknownType;
 148     }
 149 }
 150
 151 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
 152 {
 153     if (err == CborErrorOutOfMemory)
 154     {
 155         *size += encoder->ptr - encoder->end;
 156         return err;
 157     }
 158     else if (err != CborNoError)
 159     {
 160         OIC_LOG_V(ERROR, TAG, "Convert Payload failed : %s", cbor_error_string(err));
 161         return err;
 162     }
 163     else
 164     {
 165         *size = encoder->ptr - outPayload;
 166         return err;
 167     }
 168 }
 169
 170 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
 171         size_t* size)
 172 {
 173     CborEncoder encoder;
 174     cbor_encoder_init(&encoder, outPayload, *size, 0);
 175
 176     CborEncoder map;
 177     int64_t err = cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
 178     VERIFY_CBOR_SUCCESS(TAG, err, "Creating security map");
 179
 180     if (payload->securityData)
 181     {
 182         err |= cbor_encode_text_string(&map, payload->securityData,
 183                                       strlen(payload->securityData));
 184         VERIFY_CBOR_SUCCESS(TAG, err, "Retrieving security data");
 185     }
 186
 187     err |= cbor_encoder_close_container(&encoder, &map);
 188     VERIFY_CBOR_SUCCESS(TAG, err, "closing security map");
 189 exit:
 190     return checkError(err, &encoder, outPayload, size);
 191 }
 192
 193 static char* OCStringLLJoin(OCStringLL* val)
 194 {
 195     OCStringLL* temp = val;
 196     size_t size = strlen(temp->value);
 197
 198     while (temp->next)
 199     {
 200         ++size;
 201         temp = temp->next;
 202         size += strlen(temp->value);
 203     }
 204
 205     char* joinedStr = (char*)OICCalloc(sizeof(char), size + 1);
 206
 207     if (!joinedStr)
 208     {
 209         return NULL;
 210     }
 211
 212     OICStrcat(joinedStr, size + 1, val->value);
 213     while (val->next)
 214     {
 215         val = val->next;
 216         OICStrcat(joinedStr, size + 1, " ");
 217         OICStrcat(joinedStr, size + 1, val->value);
 218     }
 219     return joinedStr;
 220 }
 221
 222 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
 223         size_t *size)
 224 {
 225     CborEncoder encoder;
 226     int64_t err = CborNoError;
 227
 228     cbor_encoder_init(&encoder, outPayload, *size, 0);
 229
 230     if (payload->resources)
 231     {
 232         /*
 233         The format for the payload is "modelled" as JSON.
 234
 235         [                                                       // rootArray
 236             {                                                   // rootMap
 237                 "di" : UUID,                                    // device ID
 238                 links :[                                        // linksArray contains maps of resources
 239                             {
 240                                 href, rt, if, policy            // Resource 1
 241                             },
 242                             {
 243                                 href, rt, if, policy            // Resource 2
 244                             },
 245                             .
 246                             .
 247                             .
 248                         ]
 249             }
 250         ]
 251         */
 252         // Open the main root array
 253         CborEncoder rootArray;
 254         size_t resourceCount =  OCDiscoveryPayloadGetResourceCount(payload);
 255         err |= cbor_encoder_create_array(&encoder, &rootArray, 1);
 256         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery root array");
 257
 258         // Open the root map in the root array
 259         CborEncoder rootMap;
 260         err |= cbor_encoder_create_map(&rootArray, &rootMap, CborIndefiniteLength);
 261         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery map");
 262
 263         // Insert Device ID into the root map
 264         err |= cbor_encode_text_string(&rootMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1);
 265         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting tag device id");
 266         err |= cbor_encode_byte_string(&rootMap, payload->sid, UUID_SIZE);
 267         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value of device id");
 268
 269         // Insert baseURI if present
 270         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_BASE_URI,
 271                                             sizeof(OC_RSRVD_BASE_URI) - 1,
 272                                             payload->baseURI);
 273         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting baseURI");
 274
 275         // Insert Links into the root map.
 276         CborEncoder linkArray;
 277         err |= cbor_encode_text_string(&rootMap, OC_RSRVD_LINKS, sizeof(OC_RSRVD_LINKS) - 1);
 278         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array tag");
 279         err |= cbor_encoder_create_array(&rootMap, &linkArray, resourceCount);
 280         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array");
 281
 282         for(size_t i = 0; i < resourceCount; ++i)
 283         {
 284             CborEncoder linkMap;
 285             OCResourcePayload *resource = OCDiscoveryPayloadGetResource(payload, i);
 286             VERIFY_PARAM_NON_NULL(TAG, resource, "Failed retrieving resource");
 287
 288             // resource map inside the links array.
 289             err |= cbor_encoder_create_map(&linkArray, &linkMap, LINKS_MAP_LEN);
 290             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating links map");
 291
 292             // Below are insertions of the resource properties into the map.
 293             // Uri
 294             err |= AddTextStringToMap(&linkMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 295                     resource->uri);
 296             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding uri to links map");
 297
 298             // Resource Type
 299             if (resource->types)
 300             {
 301                 err |= cbor_encode_text_string(&linkMap, OC_RSRVD_RESOURCE_TYPE,
 302                         sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
 303                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource types tag to links map");
 304                 char *joinedTypes = OCStringLLJoin(resource->types);
 305                 VERIFY_PARAM_NON_NULL(TAG, joinedTypes, "Failed creating joined string");
 306                 err |= cbor_encode_text_string(&linkMap, joinedTypes, strlen(joinedTypes));
 307                 OICFree(joinedTypes);
 308                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource types value to links map");
 309             }
 310             // Interface Types
 311             if (resource->interfaces)
 312             {
 313                 err |= cbor_encode_text_string(&linkMap, OC_RSRVD_INTERFACE,
 314                         sizeof(OC_RSRVD_INTERFACE) - 1);
 315                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interfaces tag to links map");
 316                 char* joinedInterfaces = OCStringLLJoin(resource->interfaces);
 317                 VERIFY_PARAM_NON_NULL(TAG, joinedInterfaces, "Failed creating joined string");
 318                 err |= cbor_encode_text_string(&linkMap, joinedInterfaces, strlen(joinedInterfaces));
 319                 OICFree(joinedInterfaces);
 320                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interfaces value to links map");
 321             }
 322
 323             // Policy
 324             CborEncoder policyMap;
 325             err |= cbor_encode_text_string(&linkMap, OC_RSRVD_POLICY, sizeof(OC_RSRVD_POLICY) - 1);
 326             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy tag to links map");
 327             err |= cbor_encoder_create_map(&linkMap, &policyMap, CborIndefiniteLength);
 328             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy map to links map");
 329
 330             // Bitmap
 331             err |=  cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP, sizeof(OC_RSRVD_BITMAP) - 1);
 332             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap tag to policy map");
 333             err |= cbor_encode_uint(&policyMap, resource->bitmap);
 334             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap value to policy map");
 335
 336             if (resource->secure)
 337             {
 338                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
 339                         sizeof(OC_RSRVD_SECURE) - 1);
 340                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure tag to policy map");
 341                 err |= cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
 342                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure value to policy map");
 343             }
 344             if ((resource->secure && resource->port != 0) || payload->baseURI)
 345             {
 346                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
 347                         sizeof(OC_RSRVD_HOSTING_PORT) - 1);
 348                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port tag");
 349                 err |= cbor_encode_uint(&policyMap, resource->port);
 350                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port value");
 351             }
 352
 353             err |= cbor_encoder_close_container(&linkMap, &policyMap);
 354             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing policy map");
 355
 356             // Finsihed encoding a resource, close the map.
 357             err |= cbor_encoder_close_container(&linkArray, &linkMap);
 358             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link map");
 359         }
 360         // Close links array inside the root map.
 361         err |= cbor_encoder_close_container(&rootMap, &linkArray);
 362         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link array");
 363         // close root map inside the root array.
 364         err |= cbor_encoder_close_container(&rootArray, &rootMap);
 365         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 366         // Close the final root array.
 367         err |= cbor_encoder_close_container(&encoder, &rootArray);
 368         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 369     }
 370
 371 exit:
 372     return checkError(err, &encoder, outPayload, size);
 373 }
 374
 375 static int64_t OCConvertDevicePayload(OCDevicePayload *payload, uint8_t *outPayload,
 376         size_t *size)
 377 {
 378     int64_t err = CborNoError;
 379     CborEncoder encoder;
 380
 381     cbor_encoder_init(&encoder, outPayload, *size, 0);
 382     CborEncoder repMap;
 383     err |= cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
 384     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating device map");
 385
 386     // Device ID
 387     err |= cbor_encode_text_string(&repMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1);
 388     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding device id tag");
 389     err |= cbor_encode_byte_string(&repMap, payload->sid, UUID_SIZE);
 390     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data device id");
 391
 392     // Device Name
 393     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
 394             sizeof(OC_RSRVD_DEVICE_NAME) - 1, payload->deviceName);
 395     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding device name");
 396
 397     // Device Spec Version
 398     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
 399             sizeof(OC_RSRVD_SPEC_VERSION) - 1, payload->specVersion);
 400     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data spec version");
 401
 402     // Device data Model Version
 403     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
 404             sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1, payload->dataModelVersion);
 405     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data model version");
 406
 407     err |= cbor_encoder_close_container(&encoder, &repMap);
 408     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing device map");
 409
 410 exit:
 411     return checkError(err, &encoder, outPayload, size);
 412 }
 413
 414 static int64_t OCConvertPlatformPayload(OCPlatformPayload *payload, uint8_t *outPayload,
 415         size_t *size)
 416 {
 417     int64_t err = CborNoError;
 418     CborEncoder encoder;
 419
 420     cbor_encoder_init(&encoder, outPayload, *size, 0);
 421
 422     CborEncoder repMap;
 423     err |= cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
 424     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating platform map");
 425
 426     // Platform ID
 427     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
 428             sizeof(OC_RSRVD_PLATFORM_ID) - 1, payload->info.platformID);
 429     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform id");
 430
 431     // MFG Name
 432     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
 433         sizeof(OC_RSRVD_MFG_NAME) - 1, payload->info.manufacturerName);
 434     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg name");
 435
 436     // MFG Url
 437     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
 438         sizeof(OC_RSRVD_MFG_URL) - 1, payload->info.manufacturerUrl);
 439     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg url");
 440
 441     // Model Num
 442     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
 443             sizeof(OC_RSRVD_MODEL_NUM) -1, payload->info.modelNumber);
 444     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding model num");
 445
 446     // Date of Mfg
 447     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
 448             sizeof(OC_RSRVD_MFG_DATE) - 1, payload->info.dateOfManufacture);
 449     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg date");
 450
 451     // Platform Version
 452     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
 453             sizeof(OC_RSRVD_PLATFORM_VERSION) - 1, payload->info.platformVersion);
 454     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform version");
 455
 456     // OS Version
 457     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
 458             sizeof(OC_RSRVD_OS_VERSION) - 1, payload->info.operatingSystemVersion);
 459     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding OS version");
 460
 461     // Hardware Version
 462     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
 463             sizeof(OC_RSRVD_HARDWARE_VERSION) - 1, payload->info.hardwareVersion);
 464     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding HW version");
 465
 466     // Firmware Version
 467     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
 468             sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1, payload->info.firmwareVersion);
 469     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding firmware version");
 470
 471     // Support URL
 472     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
 473             sizeof(OC_RSRVD_SUPPORT_URL) - 1, payload->info.supportUrl);
 474     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding support url");
 475
 476     // System Time
 477     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
 478             sizeof(OC_RSRVD_SYSTEM_TIME) - 1, payload->info.systemTime);
 479     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding system time");
 480
 481     // Close Map
 482     err |= cbor_encoder_close_container(&encoder, &repMap);
 483     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 484
 485 exit:
 486     return checkError(err, &encoder, outPayload, size);
 487 }
 488
 489 static int64_t OCConvertArrayItem(CborEncoder *array, const OCRepPayloadValueArray *valArray,
 490         size_t index)
 491 {
 492     int64_t err = CborNoError;
 493     switch (valArray->type)
 494     {
 495         case OCREP_PROP_NULL:
 496             OIC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
 497             err = CborUnknownError;
 498             break;
 499         case OCREP_PROP_INT:
 500             err |= cbor_encode_int(array, valArray->iArray[index]);
 501             break;
 502         case OCREP_PROP_DOUBLE:
 503             err |= cbor_encode_double(array, valArray->dArray[index]);
 504             break;
 505         case OCREP_PROP_BOOL:
 506             err |= cbor_encode_boolean(array, valArray->bArray[index]);
 507             break;
 508         case OCREP_PROP_STRING:
 509             if (!valArray->strArray[index])
 510             {
 511                 err |= cbor_encode_null(array);
 512             }
 513             else
 514             {
 515                 err |= cbor_encode_text_string(array, valArray->strArray[index],
 516                         strlen(valArray->strArray[index]));
 517             }
 518             break;
 519         case OCREP_PROP_BYTE_STRING:
 520             if (!valArray->strArray[index])
 521             {
 522                 err |= cbor_encode_null(array);
 523             }
 524             else
 525             {
 526                 err |= cbor_encode_byte_string(array, valArray->ocByteStrArray[index].bytes,
 527                         valArray->ocByteStrArray[index].len);
 528             }
 529             break;
 530         case OCREP_PROP_OBJECT:
 531             if (!valArray->objArray[index])
 532             {
 533                 err |= cbor_encode_null(array);
 534             }
 535             else
 536             {
 537                 err |= OCConvertRepMap(array, valArray->objArray[index]);
 538             }
 539             break;
 540         case OCREP_PROP_ARRAY:
 541             OIC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
 542             err = CborUnknownError;
 543             break;
 544     }
 545
 546     return err;
 547 }
 548
 549 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray)
 550 {
 551     int64_t err = CborNoError;
 552     CborEncoder array;
 553     err |= cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
 554     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array");
 555
 556     for (size_t i = 0; i < valArray->dimensions[0]; ++i)
 557     {
 558         if (0 != valArray->dimensions[1])
 559         {
 560             CborEncoder array2;
 561             err |= cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
 562             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array2");
 563
 564             for (size_t j = 0; j < valArray->dimensions[1]; ++j)
 565             {
 566                 if (0 != valArray->dimensions[2])
 567                 {
 568                     CborEncoder array3;
 569                     err |= cbor_encoder_create_array(&array2, &array3, valArray->dimensions[2]);
 570                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array3");
 571
 572                     for(size_t k = 0; k < valArray->dimensions[2]; ++k)
 573                     {
 574                         err |= OCConvertArrayItem(&array3, valArray,
 575                             j * valArray->dimensions[2] +
 576                             i * valArray->dimensions[2] * valArray->dimensions[1] +
 577                             k);
 578                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array3 value");
 579                     }
 580                     err |= cbor_encoder_close_container(&array2, &array3);
 581                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array3");
 582                 }
 583                 else
 584                 {
 585                     err |= OCConvertArrayItem(&array2, valArray, i * valArray->dimensions[1] + j);
 586                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array2 value");
 587                 }
 588             }
 589             err |= cbor_encoder_close_container(&array, &array2);
 590             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array2");
 591         }
 592         else
 593         {
 594             err |= OCConvertArrayItem(&array, valArray, i);
 595             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array value");
 596         }
 597     }
 598     err |= cbor_encoder_close_container(parent, &array);
 599     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array");
 600
 601 exit:
 602     return err;
 603 }
 604
 605 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload)
 606 {
 607     int64_t err = CborNoError;
 608     CborEncoder repMap;
 609     err |= cbor_encoder_create_map(map, &repMap, CborIndefiniteLength);
 610     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep map");
 611     err |= OCConvertSingleRepPayload(&repMap, payload);
 612     VERIFY_CBOR_SUCCESS(TAG, err, "Failed converting single rep payload");
 613     err |= cbor_encoder_close_container(map, &repMap);
 614     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 615 exit:
 616     return err;
 617 }
 618
 619 static int64_t OCConvertSingleRepPayload(CborEncoder *repMap, const OCRepPayload *payload)
 620 {
 621     int64_t err = CborNoError;
 622     OCRepPayloadValue *value = payload->values;
 623     while (value)
 624     {
 625         err |= cbor_encode_text_string(repMap, value->name, strlen(value->name));
 626         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tag name");
 627
 628         switch (value->type)
 629         {
 630             case OCREP_PROP_NULL:
 631                 err |= cbor_encode_null(repMap);
 632                 break;
 633             case OCREP_PROP_INT:
 634                 err |= cbor_encode_int(repMap, value->i);
 635                 break;
 636             case OCREP_PROP_DOUBLE:
 637                 err |= cbor_encode_double(repMap, value->d);
 638                 break;
 639             case OCREP_PROP_BOOL:
 640                 err |= cbor_encode_boolean(repMap, value->b);
 641                 break;
 642             case OCREP_PROP_STRING:
 643                 err |= cbor_encode_text_string(repMap, value->str, strlen(value->str));
 644                 break;
 645             case OCREP_PROP_BYTE_STRING:
 646                 err |= cbor_encode_byte_string(repMap, value->ocByteStr.bytes, value->ocByteStr.len);
 647                 break;
 648             case OCREP_PROP_OBJECT:
 649                 err |= OCConvertRepMap(repMap, value->obj);
 650                 break;
 651             case OCREP_PROP_ARRAY:
 652                 err |= OCConvertArray(repMap, &value->arr);
 653                 break;
 654             default:
 655                 OIC_LOG_V(ERROR, TAG, "Invalid Prop type: %d", value->type);
 656                 break;
 657         }
 658         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding single rep value");
 659         value = value->next;
 660     }
 661
 662 exit:
 663     return err;
 664 }
 665
 666 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size)
 667 {
 668     CborEncoder encoder;
 669     int64_t err = CborNoError;
 670
 671     cbor_encoder_init(&encoder, outPayload, *size, 0);
 672
 673     size_t arrayCount = 0;
 674     for (OCRepPayload *temp = payload; temp; temp = temp->next)
 675     {
 676         arrayCount++;
 677     }
 678     CborEncoder rootArray;
 679     if (arrayCount > 1)
 680     {
 681         err |= cbor_encoder_create_array(&encoder, &rootArray, arrayCount);
 682         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep root map");
 683     }
 684
 685     while (payload != NULL && (err == CborNoError))
 686     {
 687         CborEncoder rootMap;
 688         err |= cbor_encoder_create_map(((arrayCount == 1)? &encoder: &rootArray),
 689                                             &rootMap, CborIndefiniteLength);
 690         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating root map");
 691
 692         // Only in case of collection href is included.
 693         if (arrayCount > 1 && payload->uri && strlen(payload->uri) > 0)
 694         {
 695             OIC_LOG(INFO, TAG, "Payload has uri");
 696             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_HREF, strlen(OC_RSRVD_HREF));
 697             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href tag");
 698             err |= cbor_encode_text_string(&rootMap, payload->uri, strlen(payload->uri));
 699             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href value");
 700         }
 701         if (payload->types)
 702         {
 703             OIC_LOG(INFO, TAG, "Payload has types");
 704             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_RESOURCE_TYPE,
 705                     sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
 706             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep resource type tag");
 707             char* joinedTypes = OCStringLLJoin(payload->types);
 708             VERIFY_PARAM_NON_NULL(TAG, joinedTypes, "Failed creating joined string");
 709             err |= cbor_encode_text_string(&rootMap, joinedTypes, strlen(joinedTypes));
 710             OICFree(joinedTypes);
 711             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep resource type value");
 712         }
 713         if (payload->interfaces)
 714         {
 715             OIC_LOG(INFO, TAG, "Payload has interfaces");
 716             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_INTERFACE,
 717                     sizeof(OC_RSRVD_INTERFACE) - 1);
 718             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep interface tag");
 719             char* joinedInterfaces = OCStringLLJoin(payload->interfaces);
 720             VERIFY_PARAM_NON_NULL(TAG, joinedInterfaces, "Failed creating joined string");
 721             err |= cbor_encode_text_string(&rootMap, joinedInterfaces, strlen(joinedInterfaces));
 722             OICFree(joinedInterfaces);
 723             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep interface value");
 724         }
 725
 726         err |= OCConvertSingleRepPayload(&rootMap, payload);
 727         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting rep payload");
 728
 729         // Close main array
 730         err |= cbor_encoder_close_container(((arrayCount == 1) ? &encoder: &rootArray),
 731                 &rootMap);
 732         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 733         payload = payload->next;
 734     }
 735     if (arrayCount > 1)
 736     {
 737         err |= cbor_encoder_close_container(&encoder, &rootArray);
 738         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 739     }
 740
 741 exit:
 742     return checkError(err, &encoder, outPayload, size);
 743 }
 744
 745 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
 746         size_t *size)
 747 {
 748     int64_t err = CborNoError;
 749     CborEncoder encoder;
 750
 751     cbor_encoder_init(&encoder, outPayload, *size, 0);
 752     CborEncoder map;
 753     err |= cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
 754     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating presence map");
 755
 756     // Sequence Number
 757     err |= cbor_encode_text_string(&map, OC_RSRVD_NONCE, sizeof(OC_RSRVD_NONCE) - 1);
 758     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce tag to presence map");
 759     err |= cbor_encode_uint(&map, payload->sequenceNumber);
 760     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce value to presence map");
 761
 762     // Max Age
 763     err |= cbor_encode_text_string(&map, OC_RSRVD_TTL, sizeof(OC_RSRVD_TTL) - 1);
 764     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl tag to presence map");
 765     err |= cbor_encode_uint(&map, payload->maxAge);
 766     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl value to presence map");
 767
 768     // Trigger
 769     err |= cbor_encode_text_string(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1);
 770     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger tag to presence map");
 771     err |= cbor_encode_simple_value(&map, payload->trigger);
 772     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger value to presence map");
 773
 774     // Resource type name
 775     if (payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
 776     {
 777         err |= ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
 778                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
 779         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type to presence map");
 780     }
 781
 782     // Close Map
 783     err |= cbor_encoder_close_container(&encoder, &map);
 784     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing presence map");
 785
 786 exit:
 787     return checkError(err, &encoder, outPayload, size);
 788 }
 789
 790 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 791         const char* value)
 792 {
 793     int64_t err = cbor_encode_text_string(map, key, keylen);
 794     if (CborNoError != err)
 795     {
 796         return err;
 797     }
 798     return cbor_encode_text_string(map, value, strlen(value));
 799 }
 800
 801 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 802         const char* value)
 803 {
 804     return value ? AddTextStringToMap(map, key, keylen, value) : 0;
 805 }