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