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