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