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