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