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