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