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 int64_t OCStringLLJoin(CborEncoder *map, char *type, OCStringLL *val)
 194 {
 195     uint16_t count = 0;
 196     int64_t err = CborNoError;
 197
 198     for (OCStringLL *temp = val; temp; temp = temp->next)
 199     {
 200         ++count;
 201     }
 202     if (count > 0)
 203     {
 204         CborEncoder array;
 205         err |= cbor_encode_text_string(map, type, strlen(type));
 206         err |= cbor_encoder_create_array(map, &array, count);
 207         while (val)
 208         {
 209             err |= cbor_encode_text_string(&array, val->value, strlen(val->value));
 210             val = val->next;
 211         }
 212         err |= cbor_encoder_close_container(map, &array);
 213     }
 214
 215     return err;
 216 }
 217
 218 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
 219         size_t *size)
 220 {
 221     CborEncoder encoder;
 222     int64_t err = CborNoError;
 223
 224     cbor_encoder_init(&encoder, outPayload, *size, 0);
 225
 226     if (payload->resources)
 227     {
 228         /*
 229         The format for the payload is "modelled" as JSON.
 230
 231         [                                                       // rootArray
 232             {                                                   // rootMap
 233                 "di" : UUID,                                    // device ID
 234                 "href": "/oic/res"
 235                 "rt": "oic.wk.res"
 236                 "n":"MyDevice"
 237                 "if":"oic.if.ll oic.if.baseline"
 238                 "di": "0685B960-736F-46F7-BEC0-9E6CBD61ADC1",
 239                 links :[                                        // linksArray contains maps of resources
 240                             {
 241                                 href, rt, if, policy            // Resource 1
 242                             },
 243                             {
 244                                 href, rt, if, policy            // Resource 2
 245                             },
 246                             .
 247                             .
 248                             .
 249                         ]
 250             }
 251         ]
 252         */
 253         // Open the main root array
 254         CborEncoder rootArray;
 255         size_t resourceCount =  OCDiscoveryPayloadGetResourceCount(payload);
 256         err |= cbor_encoder_create_array(&encoder, &rootArray, 1);
 257         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery root array");
 258
 259         // Open the root map in the root array
 260         CborEncoder rootMap;
 261         err |= cbor_encoder_create_map(&rootArray, &rootMap, CborIndefiniteLength);
 262         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery map");
 263
 264         // Insert Name
 265         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_NAME,
 266                 sizeof(OC_RSRVD_DEVICE_NAME) - 1, payload->name);
 267         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting name");
 268
 269         // Insert URI
 270         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 271                 payload->uri);
 272         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting href");
 273
 274         // Insert Device ID into the root map
 275         err |= AddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1,
 276                 payload->sid);
 277         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting device id");
 278
 279         // Insert Resource Type
 280         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_RESOURCE_TYPE,
 281                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->type);
 282         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting RT");
 283
 284         // Insert interfaces
 285         if (payload->interface)
 286         {
 287             err |= OCStringLLJoin(&rootMap, OC_RSRVD_INTERFACE, payload->interface);
 288             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interface types tag/value");
 289         }
 290
 291         // Insert baseURI if present
 292         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_BASE_URI,
 293                                             sizeof(OC_RSRVD_BASE_URI) - 1,
 294                                             payload->baseURI);
 295         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting baseURI");
 296
 297         // Insert Links into the root map.
 298         CborEncoder linkArray;
 299         err |= cbor_encode_text_string(&rootMap, OC_RSRVD_LINKS, sizeof(OC_RSRVD_LINKS) - 1);
 300         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array tag");
 301         err |= cbor_encoder_create_array(&rootMap, &linkArray, resourceCount);
 302         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array");
 303
 304         for(size_t i = 0; i < resourceCount; ++i)
 305         {
 306             CborEncoder linkMap;
 307             OCResourcePayload *resource = OCDiscoveryPayloadGetResource(payload, i);
 308             VERIFY_PARAM_NON_NULL(TAG, resource, "Failed retrieving resource");
 309
 310             // resource map inside the links array.
 311             err |= cbor_encoder_create_map(&linkArray, &linkMap, LINKS_MAP_LEN);
 312             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating links map");
 313
 314             // Below are insertions of the resource properties into the map.
 315             // Uri
 316             err |= AddTextStringToMap(&linkMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 317                     resource->uri);
 318             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding uri to links map");
 319
 320             // Resource Type
 321             if (resource->types)
 322             {
 323                 err |= OCStringLLJoin(&linkMap, OC_RSRVD_RESOURCE_TYPE, resource->types);
 324                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resourceType tag/value to links map");
 325             }
 326             // Interface Types
 327             if (resource->interfaces)
 328             {
 329                 err |= OCStringLLJoin(&linkMap, OC_RSRVD_INTERFACE, resource->interfaces);
 330                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interfaces tag/value to links map");
 331             }
 332
 333             // Policy
 334             CborEncoder policyMap;
 335             err |= cbor_encode_text_string(&linkMap, OC_RSRVD_POLICY, sizeof(OC_RSRVD_POLICY) - 1);
 336             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy tag to links map");
 337             err |= cbor_encoder_create_map(&linkMap, &policyMap, CborIndefiniteLength);
 338             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy map to links map");
 339
 340             // Bitmap
 341             err |=  cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP, sizeof(OC_RSRVD_BITMAP) - 1);
 342             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap tag to policy map");
 343             err |= cbor_encode_uint(&policyMap, resource->bitmap);
 344             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap value to policy map");
 345
 346             if (resource->secure)
 347             {
 348                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
 349                         sizeof(OC_RSRVD_SECURE) - 1);
 350                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure tag to policy map");
 351                 err |= cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
 352                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure value to policy map");
 353             }
 354             if ((resource->secure && resource->port != 0) || payload->baseURI)
 355             {
 356                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
 357                         sizeof(OC_RSRVD_HOSTING_PORT) - 1);
 358                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port tag");
 359                 err |= cbor_encode_uint(&policyMap, resource->port);
 360                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port value");
 361             }
 362
 363 #ifdef TCP_ADAPTER
 364             err |= cbor_encode_text_string(&policyMap, OC_RSRVD_TCP_PORT,
 365                                            sizeof(OC_RSRVD_TCP_PORT) - 1);
 366             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tcp port tag");
 367             err |= cbor_encode_uint(&policyMap, resource->tcpPort);
 368             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tcp port value");
 369 #endif
 370
 371             err |= cbor_encoder_close_container(&linkMap, &policyMap);
 372             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing policy map");
 373
 374             // Finsihed encoding a resource, close the map.
 375             err |= cbor_encoder_close_container(&linkArray, &linkMap);
 376             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link map");
 377         }
 378         // Close links array inside the root map.
 379         err |= cbor_encoder_close_container(&rootMap, &linkArray);
 380         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link array");
 381         // close root map inside the root array.
 382         err |= cbor_encoder_close_container(&rootArray, &rootMap);
 383         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 384         // Close the final root array.
 385         err |= cbor_encoder_close_container(&encoder, &rootArray);
 386         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 387     }
 388
 389 exit:
 390     return checkError(err, &encoder, outPayload, size);
 391 }
 392
 393 static int64_t OCConvertDevicePayload(OCDevicePayload *payload, uint8_t *outPayload,
 394         size_t *size)
 395 {
 396     if (!payload)
 397     {
 398         return CborUnknownError;
 399     }
 400     int64_t err = CborNoError;
 401     CborEncoder encoder;
 402
 403     cbor_encoder_init(&encoder, outPayload, *size, 0);
 404     CborEncoder repMap;
 405     err |= cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
 406     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating device map");
 407
 408     // Resource Type
 409     if (payload->types)
 410     {
 411         OIC_LOG(INFO, TAG, "Payload has types");
 412         err |= OCStringLLJoin(&repMap, OC_RSRVD_RESOURCE_TYPE, payload->types);
 413         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type tag/value.");
 414     }
 415
 416     if (payload->interfaces)
 417     {
 418         OIC_LOG(INFO, TAG, "Payload has interface");
 419         err |= OCStringLLJoin(&repMap, OC_RSRVD_INTERFACE, payload->interfaces);
 420         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interface type tag/value.");
 421     }
 422
 423     // Device ID
 424     err |= AddTextStringToMap(&repMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1 , payload->sid);
 425     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding device id");
 426
 427     // Device Name
 428     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
 429             sizeof(OC_RSRVD_DEVICE_NAME) - 1, payload->deviceName);
 430     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding device name");
 431
 432     // Device Spec Version
 433     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
 434             sizeof(OC_RSRVD_SPEC_VERSION) - 1, payload->specVersion);
 435     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data spec version");
 436
 437     // Device data Model Version
 438     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
 439             sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1, payload->dataModelVersion);
 440     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data model version");
 441
 442     err |= cbor_encoder_close_container(&encoder, &repMap);
 443     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing device map");
 444
 445 exit:
 446     return checkError(err, &encoder, outPayload, size);
 447 }
 448
 449 static int64_t OCConvertPlatformPayload(OCPlatformPayload *payload, uint8_t *outPayload,
 450         size_t *size)
 451 {
 452     int64_t err = CborNoError;
 453     CborEncoder encoder;
 454
 455     cbor_encoder_init(&encoder, outPayload, *size, 0);
 456
 457     CborEncoder repMap;
 458     err |= cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
 459     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating platform map");
 460
 461     // Platform ID
 462     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
 463             sizeof(OC_RSRVD_PLATFORM_ID) - 1, payload->info.platformID);
 464     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform id");
 465
 466     // MFG Name
 467     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
 468         sizeof(OC_RSRVD_MFG_NAME) - 1, payload->info.manufacturerName);
 469     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg name");
 470
 471     // MFG Url
 472     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
 473         sizeof(OC_RSRVD_MFG_URL) - 1, payload->info.manufacturerUrl);
 474     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg url");
 475
 476     // Model Num
 477     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
 478             sizeof(OC_RSRVD_MODEL_NUM) -1, payload->info.modelNumber);
 479     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding model num");
 480
 481     // Date of Mfg
 482     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
 483             sizeof(OC_RSRVD_MFG_DATE) - 1, payload->info.dateOfManufacture);
 484     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg date");
 485
 486     // Platform Version
 487     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
 488             sizeof(OC_RSRVD_PLATFORM_VERSION) - 1, payload->info.platformVersion);
 489     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform version");
 490
 491     // OS Version
 492     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
 493             sizeof(OC_RSRVD_OS_VERSION) - 1, payload->info.operatingSystemVersion);
 494     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding OS version");
 495
 496     // Hardware Version
 497     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
 498             sizeof(OC_RSRVD_HARDWARE_VERSION) - 1, payload->info.hardwareVersion);
 499     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding HW version");
 500
 501     // Firmware Version
 502     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
 503             sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1, payload->info.firmwareVersion);
 504     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding firmware version");
 505
 506     // Support URL
 507     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
 508             sizeof(OC_RSRVD_SUPPORT_URL) - 1, payload->info.supportUrl);
 509     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding support url");
 510
 511     // System Time
 512     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
 513             sizeof(OC_RSRVD_SYSTEM_TIME) - 1, payload->info.systemTime);
 514     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding system time");
 515
 516     // Resource type
 517     if (payload->rt)
 518     {
 519         err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_RESOURCE_TYPE,
 520                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->rt);
 521         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type.");
 522     }
 523
 524     // Resource interfaces
 525     if (payload->interfaces)
 526     {
 527         err |= OCStringLLJoin(&repMap, OC_RSRVD_INTERFACE, payload->interfaces);
 528         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface type.");
 529     }
 530
 531     // Close Map
 532     err |= cbor_encoder_close_container(&encoder, &repMap);
 533     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 534
 535 exit:
 536     return checkError(err, &encoder, outPayload, size);
 537 }
 538
 539 static int64_t OCConvertArrayItem(CborEncoder *array, const OCRepPayloadValueArray *valArray,
 540         size_t index)
 541 {
 542     int64_t err = CborNoError;
 543     switch (valArray->type)
 544     {
 545         case OCREP_PROP_NULL:
 546             OIC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
 547             err = CborUnknownError;
 548             break;
 549         case OCREP_PROP_INT:
 550             err |= cbor_encode_int(array, valArray->iArray[index]);
 551             break;
 552         case OCREP_PROP_DOUBLE:
 553             err |= cbor_encode_double(array, valArray->dArray[index]);
 554             break;
 555         case OCREP_PROP_BOOL:
 556             err |= cbor_encode_boolean(array, valArray->bArray[index]);
 557             break;
 558         case OCREP_PROP_STRING:
 559             if (!valArray->strArray[index])
 560             {
 561                 err |= cbor_encode_null(array);
 562             }
 563             else
 564             {
 565                 err |= cbor_encode_text_string(array, valArray->strArray[index],
 566                         strlen(valArray->strArray[index]));
 567             }
 568             break;
 569         case OCREP_PROP_BYTE_STRING:
 570             if (!valArray->strArray[index])
 571             {
 572                 err |= cbor_encode_null(array);
 573             }
 574             else
 575             {
 576                 err |= cbor_encode_byte_string(array, valArray->ocByteStrArray[index].bytes,
 577                         valArray->ocByteStrArray[index].len);
 578             }
 579             break;
 580         case OCREP_PROP_OBJECT:
 581             if (!valArray->objArray[index])
 582             {
 583                 err |= cbor_encode_null(array);
 584             }
 585             else
 586             {
 587                 err |= OCConvertRepMap(array, valArray->objArray[index]);
 588             }
 589             break;
 590         case OCREP_PROP_ARRAY:
 591             OIC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
 592             err = CborUnknownError;
 593             break;
 594     }
 595
 596     return err;
 597 }
 598
 599 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray)
 600 {
 601     int64_t err = CborNoError;
 602     CborEncoder array;
 603     err |= cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
 604     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array");
 605
 606     for (size_t i = 0; i < valArray->dimensions[0]; ++i)
 607     {
 608         if (0 != valArray->dimensions[1])
 609         {
 610             CborEncoder array2;
 611             err |= cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
 612             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array2");
 613
 614             for (size_t j = 0; j < valArray->dimensions[1]; ++j)
 615             {
 616                 if (0 != valArray->dimensions[2])
 617                 {
 618                     CborEncoder array3;
 619                     err |= cbor_encoder_create_array(&array2, &array3, valArray->dimensions[2]);
 620                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array3");
 621
 622                     for(size_t k = 0; k < valArray->dimensions[2]; ++k)
 623                     {
 624                         err |= OCConvertArrayItem(&array3, valArray,
 625                             j * valArray->dimensions[2] +
 626                             i * valArray->dimensions[2] * valArray->dimensions[1] +
 627                             k);
 628                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array3 value");
 629                     }
 630                     err |= cbor_encoder_close_container(&array2, &array3);
 631                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array3");
 632                 }
 633                 else
 634                 {
 635                     err |= OCConvertArrayItem(&array2, valArray, i * valArray->dimensions[1] + j);
 636                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array2 value");
 637                 }
 638             }
 639             err |= cbor_encoder_close_container(&array, &array2);
 640             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array2");
 641         }
 642         else
 643         {
 644             err |= OCConvertArrayItem(&array, valArray, i);
 645             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array value");
 646         }
 647     }
 648     err |= cbor_encoder_close_container(parent, &array);
 649     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array");
 650
 651 exit:
 652     return err;
 653 }
 654
 655 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload)
 656 {
 657     int64_t err = CborNoError;
 658     CborEncoder repMap;
 659     err |= cbor_encoder_create_map(map, &repMap, CborIndefiniteLength);
 660     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep map");
 661     err |= OCConvertSingleRepPayload(&repMap, payload);
 662     VERIFY_CBOR_SUCCESS(TAG, err, "Failed converting single rep payload");
 663     err |= cbor_encoder_close_container(map, &repMap);
 664     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 665 exit:
 666     return err;
 667 }
 668
 669 static int64_t OCConvertSingleRepPayload(CborEncoder *repMap, const OCRepPayload *payload)
 670 {
 671     int64_t err = CborNoError;
 672     OCRepPayloadValue *value = payload->values;
 673     while (value)
 674     {
 675         err |= cbor_encode_text_string(repMap, value->name, strlen(value->name));
 676         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tag name");
 677
 678         switch (value->type)
 679         {
 680             case OCREP_PROP_NULL:
 681                 err |= cbor_encode_null(repMap);
 682                 break;
 683             case OCREP_PROP_INT:
 684                 err |= cbor_encode_int(repMap, value->i);
 685                 break;
 686             case OCREP_PROP_DOUBLE:
 687                 err |= cbor_encode_double(repMap, value->d);
 688                 break;
 689             case OCREP_PROP_BOOL:
 690                 err |= cbor_encode_boolean(repMap, value->b);
 691                 break;
 692             case OCREP_PROP_STRING:
 693                 err |= cbor_encode_text_string(repMap, value->str, strlen(value->str));
 694                 break;
 695             case OCREP_PROP_BYTE_STRING:
 696                 err |= cbor_encode_byte_string(repMap, value->ocByteStr.bytes, value->ocByteStr.len);
 697                 break;
 698             case OCREP_PROP_OBJECT:
 699                 err |= OCConvertRepMap(repMap, value->obj);
 700                 break;
 701             case OCREP_PROP_ARRAY:
 702                 err |= OCConvertArray(repMap, &value->arr);
 703                 break;
 704             default:
 705                 OIC_LOG_V(ERROR, TAG, "Invalid Prop type: %d", value->type);
 706                 break;
 707         }
 708         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding single rep value");
 709         value = value->next;
 710     }
 711
 712 exit:
 713     return err;
 714 }
 715
 716 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size)
 717 {
 718     CborEncoder encoder;
 719     int64_t err = CborNoError;
 720
 721     cbor_encoder_init(&encoder, outPayload, *size, 0);
 722
 723     size_t arrayCount = 0;
 724     for (OCRepPayload *temp = payload; temp; temp = temp->next)
 725     {
 726         arrayCount++;
 727     }
 728     CborEncoder rootArray;
 729     if (arrayCount > 1)
 730     {
 731         err |= cbor_encoder_create_array(&encoder, &rootArray, arrayCount);
 732         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep root map");
 733     }
 734
 735     while (payload != NULL && (err == CborNoError))
 736     {
 737         CborEncoder rootMap;
 738         err |= cbor_encoder_create_map(((arrayCount == 1)? &encoder: &rootArray),
 739                                             &rootMap, CborIndefiniteLength);
 740         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating root map");
 741
 742         // Only in case of collection href is included.
 743         if (arrayCount > 1 && payload->uri && strlen(payload->uri) > 0)
 744         {
 745             OIC_LOG(INFO, TAG, "Payload has uri");
 746             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_HREF, strlen(OC_RSRVD_HREF));
 747             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href tag");
 748             err |= cbor_encode_text_string(&rootMap, payload->uri, strlen(payload->uri));
 749             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href value");
 750         }
 751         if (payload->types)
 752         {
 753             OIC_LOG(INFO, TAG, "Payload has types");
 754             err |= OCStringLLJoin(&rootMap, OC_RSRVD_RESOURCE_TYPE, payload->types);
 755             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type.");
 756         }
 757         if (payload->interfaces)
 758         {
 759             OIC_LOG(INFO, TAG, "Payload has interfaces");
 760             err |= OCStringLLJoin(&rootMap, OC_RSRVD_INTERFACE, payload->interfaces);
 761             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface type.");
 762         }
 763
 764         err |= OCConvertSingleRepPayload(&rootMap, payload);
 765         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting rep payload");
 766
 767         // Close main array
 768         err |= cbor_encoder_close_container(((arrayCount == 1) ? &encoder: &rootArray),
 769                 &rootMap);
 770         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 771         payload = payload->next;
 772     }
 773     if (arrayCount > 1)
 774     {
 775         err |= cbor_encoder_close_container(&encoder, &rootArray);
 776         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 777     }
 778
 779 exit:
 780     return checkError(err, &encoder, outPayload, size);
 781 }
 782
 783 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
 784         size_t *size)
 785 {
 786     int64_t err = CborNoError;
 787     CborEncoder encoder;
 788
 789     cbor_encoder_init(&encoder, outPayload, *size, 0);
 790     CborEncoder map;
 791     err |= cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
 792     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating presence map");
 793
 794     // Sequence Number
 795     err |= cbor_encode_text_string(&map, OC_RSRVD_NONCE, sizeof(OC_RSRVD_NONCE) - 1);
 796     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce tag to presence map");
 797     err |= cbor_encode_uint(&map, payload->sequenceNumber);
 798     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce value to presence map");
 799
 800     // Max Age
 801     err |= cbor_encode_text_string(&map, OC_RSRVD_TTL, sizeof(OC_RSRVD_TTL) - 1);
 802     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl tag to presence map");
 803     err |= cbor_encode_uint(&map, payload->maxAge);
 804     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl value to presence map");
 805
 806     // Trigger
 807     err |= cbor_encode_text_string(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1);
 808     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger tag to presence map");
 809     err |= cbor_encode_simple_value(&map, payload->trigger);
 810     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger value to presence map");
 811
 812     // Resource type name
 813     if (payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
 814     {
 815         err |= ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
 816                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
 817         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type to presence map");
 818     }
 819
 820     // Close Map
 821     err |= cbor_encoder_close_container(&encoder, &map);
 822     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing presence map");
 823
 824 exit:
 825     return checkError(err, &encoder, outPayload, size);
 826 }
 827
 828 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 829         const char* value)
 830 {
 831     int64_t err = cbor_encode_text_string(map, key, keylen);
 832     if (CborNoError != err)
 833     {
 834         return err;
 835     }
 836     return cbor_encode_text_string(map, value, strlen(value));
 837 }
 838
 839 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 840         const char* value)
 841 {
 842     return value ? AddTextStringToMap(map, key, keylen, value) : 0;
 843 }