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