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