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
  83     out = (uint8_t *)OICCalloc(1, curSize);
  84     VERIFY_PARAM_NON_NULL(TAG, out, "Failed to allocate payload");
  85     err = OCConvertPayloadHelper(payload, out, &curSize);
  86     ret = OC_STACK_NO_MEMORY;
  87
  88     if (err == CborErrorOutOfMemory)
  89     {
  90         // reallocate "out" and try again!
  91         uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
  92         VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
  93         out = out2;
  94         err = OCConvertPayloadHelper(payload, out, &curSize);
  95         while (err == CborErrorOutOfMemory)
  96         {
  97             uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
  98             VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
  99             out = out2;
 100             err = OCConvertPayloadHelper(payload, out, &curSize);
 101         }
 102     }
 103
 104     if (err == CborNoError)
 105     {
 106         if (curSize < INIT_SIZE)
 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         }
 112
 113         *size = curSize;
 114         *outPayload = out;
 115         OIC_LOG_V(DEBUG, TAG, "Payload Size: %zd Payload : %s \n", *size, *outPayload);
 116         return OC_STACK_OK;
 117     }
 118
 119     //TODO: Proper conversion from CborError to OCStackResult.
 120     ret = (OCStackResult)-err;
 121
 122 exit:
 123     OICFree(out);
 124     return ret;
 125 }
 126
 127 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
 128 {
 129     switch(payload->type)
 130     {
 131         case PAYLOAD_TYPE_DISCOVERY:
 132             return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
 133         case PAYLOAD_TYPE_DEVICE:
 134             return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
 135         case PAYLOAD_TYPE_PLATFORM:
 136             return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
 137         case PAYLOAD_TYPE_REPRESENTATION:
 138             return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
 139         case PAYLOAD_TYPE_PRESENCE:
 140             return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
 141         case PAYLOAD_TYPE_SECURITY:
 142             return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
 143         case PAYLOAD_TYPE_RD:
 144             return OCRDPayloadToCbor((OCRDPayload*)payload, outPayload, size);
 145         default:
 146             OIC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
 147             return CborErrorUnknownType;
 148     }
 149 }
 150
 151 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
 152 {
 153     if (err == CborErrorOutOfMemory)
 154     {
 155         *size += encoder->ptr - encoder->end;
 156         return err;
 157     }
 158     else if (err != CborNoError)
 159     {
 160         OIC_LOG_V(ERROR, TAG, "Convert Payload failed : %s", cbor_error_string(err));
 161         return err;
 162     }
 163     else
 164     {
 165         *size = encoder->ptr - outPayload;
 166         return err;
 167     }
 168 }
 169
 170 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
 171         size_t* size)
 172 {
 173     CborEncoder encoder;
 174     cbor_encoder_init(&encoder, outPayload, *size, 0);
 175
 176     CborEncoder map;
 177     int64_t err = cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
 178     VERIFY_CBOR_SUCCESS(TAG, err, "Creating security map");
 179
 180     if (payload->securityData)
 181     {
 182         err |= cbor_encode_text_string(&map, payload->securityData,
 183                                       strlen(payload->securityData));
 184         VERIFY_CBOR_SUCCESS(TAG, err, "Retrieving security data");
 185     }
 186
 187     err |= cbor_encoder_close_container(&encoder, &map);
 188     VERIFY_CBOR_SUCCESS(TAG, err, "closing security map");
 189 exit:
 190     return checkError(err, &encoder, outPayload, size);
 191 }
 192
 193 static int64_t OCStringLLJoin(CborEncoder *map, char *type, OCStringLL *val)
 194 {
 195     uint16_t count = 0;
 196     int64_t err = CborNoError;
 197
 198     for (OCStringLL *temp = val; temp; temp = temp->next)
 199     {
 200         ++count;
 201     }
 202     if (count > 0)
 203     {
 204         CborEncoder array;
 205         err |= cbor_encode_text_string(map, type, strlen(type));
 206         err |= cbor_encoder_create_array(map, &array, count);
 207         while (val)
 208         {
 209             err |= cbor_encode_text_string(&array, val->value, strlen(val->value));
 210             val = val->next;
 211         }
 212         err |= cbor_encoder_close_container(map, &array);
 213     }
 214
 215     return err;
 216 }
 217
 218 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
 219         size_t *size)
 220 {
 221     CborEncoder encoder;
 222     int64_t err = CborNoError;
 223
 224     cbor_encoder_init(&encoder, outPayload, *size, 0);
 225
 226     if (payload->resources)
 227     {
 228         /*
 229         The format for the payload is "modelled" as JSON.
 230
 231         [                                                       // rootArray
 232             {                                                   // rootMap
 233                 "di" : UUID,                                    // device ID
 234                 "href": "/oic/res"
 235                 "rt": "oic.wk.res"
 236                 "n":"MyDevice"
 237                 "if":"oic.if.ll oic.if.baseline"
 238                 "di": "0685B960-736F-46F7-BEC0-9E6CBD61ADC1",
 239                 links :[                                        // linksArray contains maps of resources
 240                             {
 241                                 href, rt, if, policy            // Resource 1
 242                             },
 243                             {
 244                                 href, rt, if, policy            // Resource 2
 245                             },
 246                             .
 247                             .
 248                             .
 249                         ]
 250             }
 251         ]
 252         */
 253         // Open the main root array
 254         CborEncoder rootArray;
 255         size_t resourceCount =  OCDiscoveryPayloadGetResourceCount(payload);
 256         err |= cbor_encoder_create_array(&encoder, &rootArray, 1);
 257         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery root array");
 258
 259         // Open the root map in the root array
 260         CborEncoder rootMap;
 261         err |= cbor_encoder_create_map(&rootArray, &rootMap, CborIndefiniteLength);
 262         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery map");
 263
 264         // Insert Name
 265         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_NAME,
 266                 sizeof(OC_RSRVD_DEVICE_NAME) - 1, payload->name);
 267         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting name");
 268
 269         // Insert URI
 270         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 271                 payload->uri);
 272         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting href");
 273
 274         // Insert Device ID into the root map
 275         err |= AddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1,
 276                 payload->sid);
 277         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting device id");
 278
 279         // Insert Resource Type
 280         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_RESOURCE_TYPE,
 281                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->type);
 282         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting RT");
 283
 284         // Insert interfaces
 285         if (payload->interface)
 286         {
 287             err |= OCStringLLJoin(&rootMap, OC_RSRVD_INTERFACE, payload->interface);
 288             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interface types tag/value");
 289         }
 290
 291         // Insert baseURI if present
 292         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_BASE_URI,
 293                                             sizeof(OC_RSRVD_BASE_URI) - 1,
 294                                             payload->baseURI);
 295         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting baseURI");
 296
 297         // Insert Links into the root map.
 298         CborEncoder linkArray;
 299         err |= cbor_encode_text_string(&rootMap, OC_RSRVD_LINKS, sizeof(OC_RSRVD_LINKS) - 1);
 300         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array tag");
 301         err |= cbor_encoder_create_array(&rootMap, &linkArray, resourceCount);
 302         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array");
 303
 304         for(size_t i = 0; i < resourceCount; ++i)
 305         {
 306             CborEncoder linkMap;
 307             OCResourcePayload *resource = OCDiscoveryPayloadGetResource(payload, i);
 308             VERIFY_PARAM_NON_NULL(TAG, resource, "Failed retrieving resource");
 309
 310             // resource map inside the links array.
 311             err |= cbor_encoder_create_map(&linkArray, &linkMap, LINKS_MAP_LEN);
 312             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating links map");
 313
 314             // Below are insertions of the resource properties into the map.
 315             // Uri
 316             err |= AddTextStringToMap(&linkMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 317                     resource->uri);
 318             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding uri to links map");
 319
 320             // Resource Type
 321             if (resource->types)
 322             {
 323                 err |= OCStringLLJoin(&linkMap, OC_RSRVD_RESOURCE_TYPE, resource->types);
 324                 VERIFY_CBOR_SUCCESS(TAG, err, "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, "Failed adding interfaces tag/value to links map");
 331             }
 332
 333             // Policy
 334             CborEncoder policyMap;
 335             err |= cbor_encode_text_string(&linkMap, OC_RSRVD_POLICY, sizeof(OC_RSRVD_POLICY) - 1);
 336             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy tag to links map");
 337             err |= cbor_encoder_create_map(&linkMap, &policyMap, CborIndefiniteLength);
 338             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy map to links map");
 339
 340             // Bitmap
 341             err |=  cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP, sizeof(OC_RSRVD_BITMAP) - 1);
 342             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap tag to policy map");
 343             err |= cbor_encode_uint(&policyMap, resource->bitmap);
 344             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap value to policy map");
 345
 346             if (resource->secure)
 347             {
 348                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
 349                         sizeof(OC_RSRVD_SECURE) - 1);
 350                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure tag to policy map");
 351                 err |= cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
 352                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure value to policy map");
 353             }
 354             if ((resource->secure && resource->port != 0) || payload->baseURI)
 355             {
 356                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
 357                         sizeof(OC_RSRVD_HOSTING_PORT) - 1);
 358                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port tag");
 359                 err |= cbor_encode_uint(&policyMap, resource->port);
 360                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port value");
 361             }
 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 |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_RESOURCE_TYPE,
 512                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->rt);
 513         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type.");
 514     }
 515
 516     // Resource interfaces
 517     if (payload->interfaces)
 518     {
 519         err |= OCStringLLJoin(&repMap, OC_RSRVD_INTERFACE, payload->interfaces);
 520         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface type.");
 521     }
 522
 523     // Close Map
 524     err |= cbor_encoder_close_container(&encoder, &repMap);
 525     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 526
 527 exit:
 528     return checkError(err, &encoder, outPayload, size);
 529 }
 530
 531 static int64_t OCConvertArrayItem(CborEncoder *array, const OCRepPayloadValueArray *valArray,
 532         size_t index)
 533 {
 534     int64_t err = CborNoError;
 535     switch (valArray->type)
 536     {
 537         case OCREP_PROP_NULL:
 538             OIC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
 539             err = CborUnknownError;
 540             break;
 541         case OCREP_PROP_INT:
 542             err |= cbor_encode_int(array, valArray->iArray[index]);
 543             break;
 544         case OCREP_PROP_DOUBLE:
 545             err |= cbor_encode_double(array, valArray->dArray[index]);
 546             break;
 547         case OCREP_PROP_BOOL:
 548             err |= cbor_encode_boolean(array, valArray->bArray[index]);
 549             break;
 550         case OCREP_PROP_STRING:
 551             if (!valArray->strArray[index])
 552             {
 553                 err |= cbor_encode_null(array);
 554             }
 555             else
 556             {
 557                 err |= cbor_encode_text_string(array, valArray->strArray[index],
 558                         strlen(valArray->strArray[index]));
 559             }
 560             break;
 561         case OCREP_PROP_BYTE_STRING:
 562             if (!valArray->strArray[index])
 563             {
 564                 err |= cbor_encode_null(array);
 565             }
 566             else
 567             {
 568                 err |= cbor_encode_byte_string(array, valArray->ocByteStrArray[index].bytes,
 569                         valArray->ocByteStrArray[index].len);
 570             }
 571             break;
 572         case OCREP_PROP_OBJECT:
 573             if (!valArray->objArray[index])
 574             {
 575                 err |= cbor_encode_null(array);
 576             }
 577             else
 578             {
 579                 err |= OCConvertRepMap(array, valArray->objArray[index]);
 580             }
 581             break;
 582         case OCREP_PROP_ARRAY:
 583             OIC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
 584             err = CborUnknownError;
 585             break;
 586     }
 587
 588     return err;
 589 }
 590
 591 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray)
 592 {
 593     int64_t err = CborNoError;
 594     CborEncoder array;
 595     err |= cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
 596     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array");
 597
 598     for (size_t i = 0; i < valArray->dimensions[0]; ++i)
 599     {
 600         if (0 != valArray->dimensions[1])
 601         {
 602             CborEncoder array2;
 603             err |= cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
 604             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array2");
 605
 606             for (size_t j = 0; j < valArray->dimensions[1]; ++j)
 607             {
 608                 if (0 != valArray->dimensions[2])
 609                 {
 610                     CborEncoder array3;
 611                     err |= cbor_encoder_create_array(&array2, &array3, valArray->dimensions[2]);
 612                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array3");
 613
 614                     for(size_t k = 0; k < valArray->dimensions[2]; ++k)
 615                     {
 616                         err |= OCConvertArrayItem(&array3, valArray,
 617                             j * valArray->dimensions[2] +
 618                             i * valArray->dimensions[2] * valArray->dimensions[1] +
 619                             k);
 620                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array3 value");
 621                     }
 622                     err |= cbor_encoder_close_container(&array2, &array3);
 623                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array3");
 624                 }
 625                 else
 626                 {
 627                     err |= OCConvertArrayItem(&array2, valArray, i * valArray->dimensions[1] + j);
 628                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array2 value");
 629                 }
 630             }
 631             err |= cbor_encoder_close_container(&array, &array2);
 632             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array2");
 633         }
 634         else
 635         {
 636             err |= OCConvertArrayItem(&array, valArray, i);
 637             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array value");
 638         }
 639     }
 640     err |= cbor_encoder_close_container(parent, &array);
 641     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array");
 642
 643 exit:
 644     return err;
 645 }
 646
 647 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload)
 648 {
 649     int64_t err = CborNoError;
 650     CborEncoder repMap;
 651     err |= cbor_encoder_create_map(map, &repMap, CborIndefiniteLength);
 652     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep map");
 653     err |= OCConvertSingleRepPayload(&repMap, payload);
 654     VERIFY_CBOR_SUCCESS(TAG, err, "Failed converting single rep payload");
 655     err |= cbor_encoder_close_container(map, &repMap);
 656     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 657 exit:
 658     return err;
 659 }
 660
 661 static int64_t OCConvertSingleRepPayload(CborEncoder *repMap, const OCRepPayload *payload)
 662 {
 663     int64_t err = CborNoError;
 664     OCRepPayloadValue *value = payload->values;
 665     while (value)
 666     {
 667         err |= cbor_encode_text_string(repMap, value->name, strlen(value->name));
 668         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tag name");
 669
 670         switch (value->type)
 671         {
 672             case OCREP_PROP_NULL:
 673                 err |= cbor_encode_null(repMap);
 674                 break;
 675             case OCREP_PROP_INT:
 676                 err |= cbor_encode_int(repMap, value->i);
 677                 break;
 678             case OCREP_PROP_DOUBLE:
 679                 err |= cbor_encode_double(repMap, value->d);
 680                 break;
 681             case OCREP_PROP_BOOL:
 682                 err |= cbor_encode_boolean(repMap, value->b);
 683                 break;
 684             case OCREP_PROP_STRING:
 685                 err |= cbor_encode_text_string(repMap, value->str, strlen(value->str));
 686                 break;
 687             case OCREP_PROP_BYTE_STRING:
 688                 err |= cbor_encode_byte_string(repMap, value->ocByteStr.bytes, value->ocByteStr.len);
 689                 break;
 690             case OCREP_PROP_OBJECT:
 691                 err |= OCConvertRepMap(repMap, value->obj);
 692                 break;
 693             case OCREP_PROP_ARRAY:
 694                 err |= OCConvertArray(repMap, &value->arr);
 695                 break;
 696             default:
 697                 OIC_LOG_V(ERROR, TAG, "Invalid Prop type: %d", value->type);
 698                 break;
 699         }
 700         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding single rep value");
 701         value = value->next;
 702     }
 703
 704 exit:
 705     return err;
 706 }
 707
 708 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size)
 709 {
 710     CborEncoder encoder;
 711     int64_t err = CborNoError;
 712
 713     cbor_encoder_init(&encoder, outPayload, *size, 0);
 714
 715     size_t arrayCount = 0;
 716     for (OCRepPayload *temp = payload; temp; temp = temp->next)
 717     {
 718         arrayCount++;
 719     }
 720     CborEncoder rootArray;
 721     if (arrayCount > 1)
 722     {
 723         err |= cbor_encoder_create_array(&encoder, &rootArray, arrayCount);
 724         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep root map");
 725     }
 726
 727     while (payload != NULL && (err == CborNoError))
 728     {
 729         CborEncoder rootMap;
 730         err |= cbor_encoder_create_map(((arrayCount == 1)? &encoder: &rootArray),
 731                                             &rootMap, CborIndefiniteLength);
 732         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating root map");
 733
 734         // Only in case of collection href is included.
 735         if (arrayCount > 1 && payload->uri && strlen(payload->uri) > 0)
 736         {
 737             OIC_LOG(INFO, TAG, "Payload has uri");
 738             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_HREF, strlen(OC_RSRVD_HREF));
 739             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href tag");
 740             err |= cbor_encode_text_string(&rootMap, payload->uri, strlen(payload->uri));
 741             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href value");
 742         }
 743         if (payload->types)
 744         {
 745             OIC_LOG(INFO, TAG, "Payload has types");
 746             err |= OCStringLLJoin(&rootMap, OC_RSRVD_RESOURCE_TYPE, payload->types);
 747             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type.");
 748         }
 749         if (payload->interfaces)
 750         {
 751             OIC_LOG(INFO, TAG, "Payload has interfaces");
 752             err |= OCStringLLJoin(&rootMap, OC_RSRVD_INTERFACE, payload->interfaces);
 753             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface type.");
 754         }
 755
 756         err |= OCConvertSingleRepPayload(&rootMap, payload);
 757         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting rep payload");
 758
 759         // Close main array
 760         err |= cbor_encoder_close_container(((arrayCount == 1) ? &encoder: &rootArray),
 761                 &rootMap);
 762         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 763         payload = payload->next;
 764     }
 765     if (arrayCount > 1)
 766     {
 767         err |= cbor_encoder_close_container(&encoder, &rootArray);
 768         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 769     }
 770
 771 exit:
 772     return checkError(err, &encoder, outPayload, size);
 773 }
 774
 775 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
 776         size_t *size)
 777 {
 778     int64_t err = CborNoError;
 779     CborEncoder encoder;
 780
 781     cbor_encoder_init(&encoder, outPayload, *size, 0);
 782     CborEncoder map;
 783     err |= cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
 784     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating presence map");
 785
 786     // Sequence Number
 787     err |= cbor_encode_text_string(&map, OC_RSRVD_NONCE, sizeof(OC_RSRVD_NONCE) - 1);
 788     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce tag to presence map");
 789     err |= cbor_encode_uint(&map, payload->sequenceNumber);
 790     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce value to presence map");
 791
 792     // Max Age
 793     err |= cbor_encode_text_string(&map, OC_RSRVD_TTL, sizeof(OC_RSRVD_TTL) - 1);
 794     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl tag to presence map");
 795     err |= cbor_encode_uint(&map, payload->maxAge);
 796     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl value to presence map");
 797
 798     // Trigger
 799     err |= cbor_encode_text_string(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1);
 800     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger tag to presence map");
 801     err |= cbor_encode_simple_value(&map, payload->trigger);
 802     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger value to presence map");
 803
 804     // Resource type name
 805     if (payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
 806     {
 807         err |= ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
 808                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
 809         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type to presence map");
 810     }
 811
 812     // Close Map
 813     err |= cbor_encoder_close_container(&encoder, &map);
 814     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing presence map");
 815
 816 exit:
 817     return checkError(err, &encoder, outPayload, size);
 818 }
 819
 820 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 821         const char* value)
 822 {
 823     int64_t err = cbor_encode_text_string(map, key, keylen);
 824     if (CborNoError != err)
 825     {
 826         return err;
 827     }
 828     return cbor_encode_text_string(map, value, strlen(value));
 829 }
 830
 831 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 832         const char* value)
 833 {
 834     return value ? AddTextStringToMap(map, key, keylen, value) : 0;
 835 }