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 #ifdef ARDUINO
  22 #define __STDC_LIMIT_MACROS
  23 #endif
  24
  25 #include "ocpayloadcbor.h"
  26 #include "platform_features.h"
  27 #include <stdlib.h>
  28 #include "oic_malloc.h"
  29 #include "oic_string.h"
  30 #include "logger.h"
  31 #include "ocpayload.h"
  32 #include "ocrandom.h"
  33 #include "ocresourcehandler.h"
  34 #include "cbor.h"
  35 #include "ocendpoint.h"
  36
  37 #define TAG "OIC_RI_PAYLOADCONVERT"
  38
  39 // Arbitrarily chosen size that seems to contain the majority of packages
  40 #define INIT_SIZE (255)
  41
  42 // Discovery Links Map with endpoints Length.
  43 #define LINKS_MAP_LEN_WITH_EPS (5)
  44
  45 // Discovery Links Map without endpoints Length.
  46 #define LINKS_MAP_LEN_WITHOUT_EPS (4)
  47
  48 // Endpoint Map length, it contains "ep", "pri".
  49 #define EP_MAP_LEN (2)
  50
  51 // Functions all return either a CborError, or a negative version of the OC_STACK return values
  52 static int64_t OCConvertPayloadHelper(OCPayload *payload, uint8_t *outPayload, size_t *size);
  53 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
  54         size_t *size);
  55 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size);
  56 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload);
  57 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
  58         size_t *size);
  59 static int64_t OCConvertSecurityPayload(OCSecurityPayload *payload, uint8_t *outPayload,
  60         size_t *size);
  61 static int64_t OCConvertSingleRepPayloadValue(CborEncoder *parent, const OCRepPayloadValue *value);
  62 static int64_t OCConvertSingleRepPayload(CborEncoder *parent, const OCRepPayload *payload);
  63 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray);
  64
  65 static int64_t AddTextStringToMap(CborEncoder *map, const char *key, size_t keylen,
  66         const char *value);
  67 static int64_t ConditionalAddTextStringToMap(CborEncoder *map, const char *key, size_t keylen,
  68         const char *value);
  69
  70 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
  71 {
  72     // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
  73     // strategy to work.  If you receive the following assertion error, please do a git-pull
  74     // from the extlibs/tinycbor/tinycbor directory
  75     #define CborNeedsUpdating  (((unsigned int)CborErrorOutOfMemory) < ((unsigned int)CborErrorDataTooLarge))
  76     OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
  77     #undef CborNeedsUpdating
  78
  79     OCStackResult ret = OC_STACK_INVALID_PARAM;
  80     int64_t err = CborErrorOutOfMemory;
  81     uint8_t *out = NULL;
  82     size_t curSize = INIT_SIZE;
  83
  84     VERIFY_PARAM_NON_NULL(TAG, payload, "Input param, payload is NULL");
  85     VERIFY_PARAM_NON_NULL(TAG, outPayload, "OutPayload parameter is NULL");
  86     VERIFY_PARAM_NON_NULL(TAG, size, "size parameter is NULL");
  87
  88     OIC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
  89     if (PAYLOAD_TYPE_SECURITY == payload->type)
  90     {
  91         size_t securityPayloadSize = ((OCSecurityPayload *)payload)->payloadSize;
  92         if (securityPayloadSize > 0)
  93         {
  94             curSize = securityPayloadSize;
  95         }
  96     }
  97
  98     ret = OC_STACK_NO_MEMORY;
  99
 100     for (;;)
 101     {
 102         out = (uint8_t *)OICCalloc(1, curSize);
 103         VERIFY_PARAM_NON_NULL(TAG, out, "Failed to allocate payload");
 104         err = OCConvertPayloadHelper(payload, out, &curSize);
 105
 106         if (CborErrorOutOfMemory != err)
 107         {
 108             break;
 109         }
 110
 111         OICFree(out);
 112     }
 113
 114     if (err == CborNoError)
 115     {
 116         if ((curSize < INIT_SIZE) &&
 117             (PAYLOAD_TYPE_SECURITY != payload->type))
 118         {
 119             uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
 120             VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
 121             out = out2;
 122         }
 123
 124         *size = curSize;
 125         *outPayload = out;
 126         OIC_LOG_V(DEBUG, TAG, "Payload Size: %zd Payload : ", *size);
 127         OIC_LOG_BUFFER(DEBUG, TAG, *outPayload, *size);
 128         return OC_STACK_OK;
 129     }
 130
 131     //TODO: Proper conversion from CborError to OCStackResult.
 132     ret = (OCStackResult)-err;
 133
 134 exit:
 135     OICFree(out);
 136     return ret;
 137 }
 138
 139 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
 140 {
 141     switch(payload->type)
 142     {
 143         case PAYLOAD_TYPE_DISCOVERY:
 144             return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
 145         case PAYLOAD_TYPE_REPRESENTATION:
 146             return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
 147         case PAYLOAD_TYPE_PRESENCE:
 148             return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
 149         case PAYLOAD_TYPE_SECURITY:
 150             return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
 151         default:
 152             OIC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
 153             return CborErrorUnknownType;
 154     }
 155 }
 156
 157 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
 158 {
 159     if (err == CborErrorOutOfMemory)
 160     {
 161         *size += cbor_encoder_get_extra_bytes_needed(encoder);
 162         return err;
 163     }
 164     else if (err != CborNoError)
 165     {
 166         OIC_LOG_V(ERROR, TAG, "Convert Payload failed : %s", cbor_error_string(err));
 167         return err;
 168     }
 169     else
 170     {
 171         *size = cbor_encoder_get_buffer_size(encoder, outPayload);
 172         return err;
 173     }
 174 }
 175
 176 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
 177         size_t* size)
 178 {
 179     memcpy(outPayload, payload->securityData, payload->payloadSize);
 180     *size = payload->payloadSize;
 181
 182     return CborNoError;
 183 }
 184
 185 static int64_t OCStringLLJoin(CborEncoder *map, char *type, OCStringLL *val)
 186 {
 187     uint16_t count = 0;
 188     int64_t err = CborNoError;
 189
 190     for (OCStringLL *temp = val; temp; temp = temp->next)
 191     {
 192         ++count;
 193     }
 194     if (count > 0)
 195     {
 196         CborEncoder array;
 197         err |= cbor_encode_text_string(map, type, strlen(type));
 198         err |= cbor_encoder_create_array(map, &array, count);
 199         while (val)
 200         {
 201             err |= cbor_encode_text_string(&array, val->value, strlen(val->value));
 202             val = val->next;
 203         }
 204         err |= cbor_encoder_close_container(map, &array);
 205     }
 206
 207     return err;
 208 }
 209
 210 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
 211                                          size_t *size)
 212 {
 213     CborEncoder encoder;
 214     int64_t err = CborNoError;
 215
 216     cbor_encoder_init(&encoder, outPayload, *size, 0);
 217
 218     /*
 219     The format for the payload is "modelled" as JSON.
 220
 221     [                                                  // rootArray
 222         {                                              // rootMap
 223             "di" : UUID,                               // device ID
 224             "rt": ["oic.wk.res"]
 225             "n":"MyDevice"
 226             "if":"oic.if.ll oic.if.baseline"
 227             "di": "0685B960-736F-46F7-BEC0-9E6CBD61ADC1",
 228             links :[                                   // linksArray contains maps of resources
 229                         {
 230                             href, rt, if, policy, eps  // Resource 1
 231                         },
 232                         {
 233                             href, rt, if, policy, eps  // Resource 2
 234                         },
 235                         .
 236                         .
 237                         .
 238                     ]
 239         }
 240         {                                              // rootMap
 241             ...
 242         }
 243     ]
 244     */
 245
 246     // Open the main root array
 247     size_t arrayCount = 0;
 248     for (OCDiscoveryPayload *temp = payload; temp; temp = temp->next)
 249     {
 250         arrayCount++;
 251     }
 252     CborEncoder rootArray;
 253     err |= cbor_encoder_create_array(&encoder, &rootArray, arrayCount);
 254     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery root array");
 255
 256     while (payload && payload->resources)
 257     {
 258         // Open the root map in the root array
 259         CborEncoder rootMap;
 260         err |= cbor_encoder_create_map(&rootArray, &rootMap, CborIndefiniteLength);
 261         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery map");
 262
 263         // Insert Name
 264         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_NAME,
 265                 sizeof(OC_RSRVD_DEVICE_NAME) - 1, payload->name);
 266         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting name");
 267
 268         // Insert Device ID into the root map
 269         err |= AddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1,
 270                 payload->sid);
 271         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting device id");
 272
 273         // Insert Resource Type
 274         err |= OCStringLLJoin(&rootMap, OC_RSRVD_RESOURCE_TYPE, payload->type);
 275         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting RT");
 276
 277         // Insert interfaces
 278         if (payload->iface)
 279         {
 280             err |= OCStringLLJoin(&rootMap, OC_RSRVD_INTERFACE, payload->iface);
 281             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interface types tag/value");
 282         }
 283
 284         // Insert baseURI if present
 285         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_BASE_URI,
 286                                              sizeof(OC_RSRVD_BASE_URI) - 1,
 287                                              payload->baseURI);
 288         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting baseURI");
 289
 290         // Insert Links into the root map.
 291         CborEncoder linkArray;
 292         err |= cbor_encode_text_string(&rootMap, OC_RSRVD_LINKS, sizeof(OC_RSRVD_LINKS) - 1);
 293         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array tag");
 294         size_t resourceCount =  OCDiscoveryPayloadGetResourceCount(payload);
 295         err |= cbor_encoder_create_array(&rootMap, &linkArray, resourceCount);
 296         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array");
 297
 298         for (size_t i = 0; i < resourceCount; ++i)
 299         {
 300             CborEncoder linkMap;
 301             size_t linkMapLen;
 302             OCResourcePayload *resource = OCDiscoveryPayloadGetResource(payload, i);
 303             VERIFY_PARAM_NON_NULL(TAG, resource, "Failed retrieving resource");
 304
 305             // resource map inside the links array.
 306             linkMapLen = resource->eps ? LINKS_MAP_LEN_WITH_EPS : LINKS_MAP_LEN_WITHOUT_EPS;
 307             if (resource->rel)
 308             {
 309                 ++linkMapLen;
 310             }
 311             err |= cbor_encoder_create_map(&linkArray, &linkMap, linkMapLen);
 312             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating links map");
 313
 314             // Below are insertions of the resource properties into the map.
 315             // Uri
 316             err |= AddTextStringToMap(&linkMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 317                     resource->uri);
 318             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding uri to links map");
 319
 320             // Rel - Not a mandatory field
 321             if (resource->rel)
 322             {
 323                 err |= AddTextStringToMap(&linkMap, OC_RSRVD_REL, sizeof(OC_RSRVD_REL) - 1,
 324                         resource->rel);
 325                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rel to links map");
 326             }
 327
 328             // Resource Type
 329             if (resource->types)
 330             {
 331                 err |= OCStringLLJoin(&linkMap, OC_RSRVD_RESOURCE_TYPE, resource->types);
 332                 VERIFY_CBOR_SUCCESS(TAG, err,
 333                                     "Failed adding resourceType tag/value to links map");
 334             }
 335             // Interface Types
 336             if (resource->interfaces)
 337             {
 338                 err |= OCStringLLJoin(&linkMap, OC_RSRVD_INTERFACE, resource->interfaces);
 339                 VERIFY_CBOR_SUCCESS(TAG, err,
 340                                     "Failed adding interfaces tag/value to links map");
 341             }
 342
 343             // Policy
 344             CborEncoder policyMap;
 345             err |= cbor_encode_text_string(&linkMap, OC_RSRVD_POLICY,
 346                                            sizeof(OC_RSRVD_POLICY) - 1);
 347             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy tag to links map");
 348             err |= cbor_encoder_create_map(&linkMap, &policyMap, CborIndefiniteLength);
 349             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy map to links map");
 350
 351             // Bitmap
 352             err |=  cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP,
 353                                             sizeof(OC_RSRVD_BITMAP) - 1);
 354             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap tag to policy map");
 355             err |= cbor_encode_uint(&policyMap, resource->bitmap);
 356             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap value to policy map");
 357
 358             // Secure
 359             err |= cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
 360                                            sizeof(OC_RSRVD_SECURE) - 1);
 361             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure tag to policy map");
 362             err |= cbor_encode_boolean(&policyMap, resource->secure);
 363             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure value to policy map");
 364
 365             if (resource->secure || payload->baseURI)
 366             {
 367                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
 368                                                sizeof(OC_RSRVD_HOSTING_PORT) - 1);
 369                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port tag");
 370                 err |= cbor_encode_uint(&policyMap, resource->port);
 371                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port value");
 372             }
 373
 374 #ifdef TCP_ADAPTER
 375 #ifdef __WITH_TLS__
 376             // tls
 377             if (resource->secure)
 378             {
 379                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_TLS_PORT,
 380                                                sizeof(OC_RSRVD_TLS_PORT) - 1);
 381                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tcp secure port tag");
 382                 err |= cbor_encode_uint(&policyMap, resource->tcpPort);
 383                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tcp secure port value");
 384             }
 385
 386             // tcp
 387             else
 388 #endif
 389             {
 390                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_TCP_PORT,
 391                                                sizeof(OC_RSRVD_TCP_PORT) - 1);
 392                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tcp port tag");
 393                 err |= cbor_encode_uint(&policyMap, resource->tcpPort);
 394                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tcp port value");
 395             }
 396 #endif
 397             err |= cbor_encoder_close_container(&linkMap, &policyMap);
 398             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing policy map");
 399
 400             // Endpoints
 401             size_t epsCount = OCEndpointPayloadGetEndpointCount(resource->eps);
 402
 403             // Embed Endpoints in discovery response when any endpoint exist on the resource.
 404             if (epsCount > 0)
 405             {
 406                 CborEncoder epsArray;
 407                 err |= cbor_encode_text_string(&linkMap, OC_RSRVD_ENDPOINTS,
 408                                                          sizeof(OC_RSRVD_ENDPOINTS) - 1);
 409                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting endpoints array tag");
 410
 411                 err |= cbor_encoder_create_array(&linkMap, &epsArray, epsCount);
 412                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting endpoints array");
 413
 414                 for (size_t j = 0; j < epsCount; ++j)
 415                 {
 416                     CborEncoder endpointMap;
 417                     OCEndpointPayload* endpoint = OCEndpointPayloadGetEndpoint(resource->eps, j);
 418                     VERIFY_PARAM_NON_NULL(TAG, endpoint, "Failed retrieving endpoint");
 419
 420                     char* endpointStr = OCCreateEndpointString(endpoint);
 421                     VERIFY_PARAM_NON_NULL(TAG, endpointStr, "Failed creating endpoint string");
 422
 423                     err |= cbor_encoder_create_map(&epsArray, &endpointMap, EP_MAP_LEN);
 424                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating endpoint map");
 425
 426                     err |= AddTextStringToMap(&endpointMap, OC_RSRVD_ENDPOINT,
 427                                               sizeof(OC_RSRVD_ENDPOINT) - 1, endpointStr);
 428                     OICFree(endpointStr);
 429                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding endpoint to endpoint map");
 430
 431                     err |= cbor_encode_text_string(&endpointMap, OC_RSRVD_PRIORITY,
 432                                                    sizeof(OC_RSRVD_PRIORITY) - 1);
 433                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding priority tag to endpoint map");
 434                     err |= cbor_encode_uint(&endpointMap, endpoint->pri);
 435                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding priority value to endpoint map");
 436
 437                     err |= cbor_encoder_close_container(&epsArray, &endpointMap);
 438                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing endpoint map");
 439                 }
 440
 441                 err |= cbor_encoder_close_container(&linkMap, &epsArray);
 442                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing endpoints map");
 443             }
 444             // Finsihed encoding a resource, close the map.
 445             err |= cbor_encoder_close_container(&linkArray, &linkMap);
 446             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link map");
 447         }
 448         // Close links array inside the root map.
 449         err |= cbor_encoder_close_container(&rootMap, &linkArray);
 450         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link array");
 451         // close root map inside the root array.
 452         err |= cbor_encoder_close_container(&rootArray, &rootMap);
 453         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 454
 455         payload = payload->next;
 456     }
 457
 458     // Close the final root array.
 459     err |= cbor_encoder_close_container(&encoder, &rootArray);
 460     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 461
 462 exit:
 463     return checkError(err, &encoder, outPayload, size);
 464 }
 465
 466 static int64_t OCConvertArrayItem(CborEncoder *array, const OCRepPayloadValueArray *valArray,
 467         size_t index)
 468 {
 469     int64_t err = CborNoError;
 470     switch (valArray->type)
 471     {
 472         case OCREP_PROP_NULL:
 473             OIC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
 474             err = CborUnknownError;
 475             break;
 476         case OCREP_PROP_INT:
 477             if (valArray->iArray != 0)
 478             {
 479                 err |= cbor_encode_int(array, valArray->iArray[index]);
 480             }
 481             break;
 482         case OCREP_PROP_DOUBLE:
 483             if (valArray->dArray != 0)
 484             {
 485                 err |= cbor_encode_double(array, valArray->dArray[index]);
 486             }
 487             break;
 488         case OCREP_PROP_BOOL:
 489             if (valArray->bArray != 0)
 490             {
 491                 err |= cbor_encode_boolean(array, valArray->bArray[index]);
 492             }
 493             break;
 494         case OCREP_PROP_STRING:
 495             if (valArray->strArray != 0)
 496             {
 497                 err |= (!valArray->strArray[index]) ? cbor_encode_null(array) : cbor_encode_text_string(array,
 498                     valArray->strArray[index], strlen(valArray->strArray[index]));
 499             }
 500             break;
 501         case OCREP_PROP_BYTE_STRING:
 502             err |= (!valArray->ocByteStrArray[index].len) ? cbor_encode_null(array) : cbor_encode_byte_string(array,
 503                 valArray->ocByteStrArray[index].bytes, valArray->ocByteStrArray[index].len);
 504             break;
 505         case OCREP_PROP_OBJECT:
 506             if (valArray->objArray != 0)
 507             {
 508                 err |= (!valArray->objArray[index]) ? cbor_encode_null(array): OCConvertRepMap(array,
 509                         valArray->objArray[index]);
 510             }
 511             break;
 512         case OCREP_PROP_ARRAY:
 513             OIC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
 514             err = CborUnknownError;
 515             break;
 516     }
 517
 518     return err;
 519 }
 520
 521 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray)
 522 {
 523     int64_t err = CborNoError;
 524     CborEncoder array;
 525     err |= cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
 526     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array");
 527     // empty array
 528     if (valArray->dimensions[0] == 0)
 529     {
 530         err |= OCConvertArrayItem(&array, valArray, 0);
 531         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array value");
 532     }
 533     else
 534     {
 535         for (size_t i = 0; i < valArray->dimensions[0]; ++i)
 536         {
 537             if (0 != valArray->dimensions[1])
 538             {
 539                 CborEncoder array2;
 540                 err |= cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
 541                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array2");
 542
 543                 for (size_t j = 0; j < valArray->dimensions[1]; ++j)
 544                 {
 545                     if (0 != valArray->dimensions[2])
 546                     {
 547                         CborEncoder array3;
 548                         err |= cbor_encoder_create_array(&array2, &array3, valArray->dimensions[2]);
 549                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array3");
 550
 551                         for(size_t k = 0; k < valArray->dimensions[2]; ++k)
 552                         {
 553                             err |= OCConvertArrayItem(&array3, valArray,
 554                                 j * valArray->dimensions[2] +
 555                                 i * valArray->dimensions[2] * valArray->dimensions[1] +
 556                                 k);
 557                             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array3 value");
 558                         }
 559                         err |= cbor_encoder_close_container(&array2, &array3);
 560                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array3");
 561                     }
 562                     else
 563                     {
 564                         err |= OCConvertArrayItem(&array2, valArray, i * valArray->dimensions[1] + j);
 565                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array2 value");
 566                     }
 567                 }
 568                 err |= cbor_encoder_close_container(&array, &array2);
 569                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array2");
 570             }
 571             else
 572             {
 573                 err |= OCConvertArrayItem(&array, valArray, i);
 574                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array value");
 575             }
 576         }
 577     }
 578     err |= cbor_encoder_close_container(parent, &array);
 579     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array");
 580
 581 exit:
 582     return err;
 583 }
 584
 585 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload)
 586 {
 587     int64_t err = CborNoError;
 588     CborEncoder encoder;
 589     OCRepPayloadValue *value = NULL;
 590     size_t arrayLength = 0;
 591
 592     // Encode payload as an array when value names are consecutive
 593     // non-negative integers.  Otherwise encode as a map.
 594     arrayLength = 0;
 595     for (value = payload->values; value; value = value->next)
 596     {
 597         char *endp;
 598         long i = strtol(value->name, &endp, 0);
 599         if (*endp != '\0' || i < 0 || arrayLength != (size_t)i)
 600         {
 601             break;
 602         }
 603         ++arrayLength;
 604     }
 605
 606     if (value)
 607     {
 608         err |= cbor_encoder_create_map(map, &encoder, CborIndefiniteLength);
 609         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep map");
 610         err |= OCConvertSingleRepPayload(&encoder, payload);
 611         VERIFY_CBOR_SUCCESS(TAG, err, "Failed converting single rep payload");
 612         err |= cbor_encoder_close_container(map, &encoder);
 613         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 614     }
 615     else
 616     {
 617         err |= cbor_encoder_create_array(map, &encoder, arrayLength);
 618         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep map");
 619         for (value = payload->values; value; value = value->next)
 620         {
 621             err |= OCConvertSingleRepPayloadValue(&encoder, value);
 622             VERIFY_CBOR_SUCCESS(TAG, err, "Failed converting single rep value");
 623         }
 624         err |= cbor_encoder_close_container(map, &encoder);
 625         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 626     }
 627
 628 exit:
 629     return err;
 630 }
 631
 632 static int64_t OCConvertSingleRepPayloadValue(CborEncoder *parent, const OCRepPayloadValue *value)
 633 {
 634     int64_t err = CborNoError;
 635     switch (value->type)
 636     {
 637         case OCREP_PROP_NULL:
 638             err = cbor_encode_null(parent);
 639             break;
 640         case OCREP_PROP_INT:
 641             err = cbor_encode_int(parent, value->i);
 642             break;
 643         case OCREP_PROP_DOUBLE:
 644             err = cbor_encode_double(parent, value->d);
 645             break;
 646         case OCREP_PROP_BOOL:
 647             err = cbor_encode_boolean(parent, value->b);
 648             break;
 649         case OCREP_PROP_STRING:
 650             err = cbor_encode_text_string(parent, value->str, strlen(value->str));
 651             break;
 652         case OCREP_PROP_BYTE_STRING:
 653             err = cbor_encode_byte_string(parent, value->ocByteStr.bytes, value->ocByteStr.len);
 654             break;
 655         case OCREP_PROP_OBJECT:
 656             err = OCConvertRepMap(parent, value->obj);
 657             break;
 658         case OCREP_PROP_ARRAY:
 659             err = OCConvertArray(parent, &value->arr);
 660             break;
 661         default:
 662             OIC_LOG_V(ERROR, TAG, "Invalid Prop type: %d", value->type);
 663             break;
 664     }
 665     return err;
 666 }
 667
 668 static int64_t OCConvertSingleRepPayload(CborEncoder *repMap, const OCRepPayload *payload)
 669 {
 670     int64_t err = CborNoError;
 671     OCRepPayloadValue *value = payload->values;
 672     while (value)
 673     {
 674         err |= cbor_encode_text_string(repMap, value->name, strlen(value->name));
 675         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tag name");
 676
 677         err |= OCConvertSingleRepPayloadValue(repMap, value);
 678         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding single rep value");
 679         value = value->next;
 680     }
 681
 682 exit:
 683     return err;
 684 }
 685
 686 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size)
 687 {
 688     CborEncoder encoder;
 689     int64_t err = CborNoError;
 690
 691     cbor_encoder_init(&encoder, outPayload, *size, 0);
 692
 693     size_t arrayCount = 0;
 694     for (OCRepPayload *temp = payload; temp; temp = temp->next)
 695     {
 696         arrayCount++;
 697     }
 698     CborEncoder rootArray;
 699     if (arrayCount > 1)
 700     {
 701         err |= cbor_encoder_create_array(&encoder, &rootArray, arrayCount);
 702         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep root map");
 703     }
 704
 705     while (payload != NULL && (err == CborNoError))
 706     {
 707         CborEncoder rootMap;
 708         err |= cbor_encoder_create_map(((arrayCount == 1)? &encoder: &rootArray),
 709                                             &rootMap, CborIndefiniteLength);
 710         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating root map");
 711
 712         // Only in case of collection href is included.
 713         if (arrayCount > 1 && payload->uri && strlen(payload->uri) > 0)
 714         {
 715             OIC_LOG(INFO, TAG, "Payload has uri");
 716             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_HREF, strlen(OC_RSRVD_HREF));
 717             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href tag");
 718             err |= cbor_encode_text_string(&rootMap, payload->uri, strlen(payload->uri));
 719             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href value");
 720         }
 721         if (payload->types)
 722         {
 723             OIC_LOG(INFO, TAG, "Payload has types");
 724             err |= OCStringLLJoin(&rootMap, OC_RSRVD_RESOURCE_TYPE, payload->types);
 725             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type.");
 726         }
 727         if (payload->interfaces)
 728         {
 729             OIC_LOG(INFO, TAG, "Payload has interfaces");
 730             err |= OCStringLLJoin(&rootMap, OC_RSRVD_INTERFACE, payload->interfaces);
 731             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface type.");
 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 }