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