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