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