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