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