resource/csdk/stack/src/ocpayloadconvert.c

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