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