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