1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 // Defining _POSIX_C_SOURCE macro with 200112L (or greater) as value
22 // causes header files to expose definitions
23 // corresponding to the POSIX.1-2001 base
24 // specification (excluding the XSI extension).
25 // For POSIX.1-2001 base specification,
26 // Refer http://pubs.opengroup.org/onlinepubs/009695399/
27 // Required for strok_r
28 #define _POSIX_C_SOURCE 200112L
31 #include "oic_string.h"
32 #include "oic_malloc.h"
33 #include "ocpayload.h"
34 #include "ocpayloadcbor.h"
35 #include "ocstackinternal.h"
36 #include "payload_logging.h"
37 #include "rdpayload.h"
39 #define TAG "OIC_RI_PAYLOADPARSE"
41 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *arrayVal);
42 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *arrayVal);
43 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *arrayVal);
44 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *repParent, bool isRoot);
45 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *arrayVal);
46 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *arrayVal);
47 static OCStackResult OCParseSecurityPayload(OCPayload **outPayload, const uint8_t *payload, size_t size);
49 OCStackResult OCParsePayload(OCPayload **outPayload, OCPayloadType payloadType,
50 const uint8_t *payload, size_t payloadSize)
52 OCStackResult result = OC_STACK_MALFORMED_RESPONSE;
55 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Conversion of outPayload failed");
56 VERIFY_PARAM_NON_NULL(TAG, payload, "Invalid cbor payload value");
58 OIC_LOG_V(INFO, TAG, "CBOR Parsing size: %zu of Payload Type: %d, Payload:",
59 payloadSize, payloadType);
60 OIC_LOG_BUFFER(DEBUG, TAG, payload, payloadSize);
65 err = cbor_parser_init(payload, payloadSize, 0, &parser, &rootValue);
66 VERIFY_CBOR_SUCCESS(TAG, err, "Failed initializing init value")
70 case PAYLOAD_TYPE_DISCOVERY:
71 result = OCParseDiscoveryPayload(outPayload, &rootValue);
73 case PAYLOAD_TYPE_DEVICE:
74 result = OCParseDevicePayload(outPayload, &rootValue);
76 case PAYLOAD_TYPE_PLATFORM:
77 result = OCParsePlatformPayload(outPayload, &rootValue);
79 case PAYLOAD_TYPE_REPRESENTATION:
80 result = OCParseRepPayload(outPayload, &rootValue);
82 case PAYLOAD_TYPE_PRESENCE:
83 result = OCParsePresencePayload(outPayload, &rootValue);
85 case PAYLOAD_TYPE_SECURITY:
86 result = OCParseSecurityPayload(outPayload, payload, payloadSize);
89 result = OCRDCborToPayload(&rootValue, outPayload);
92 OIC_LOG_V(ERROR, TAG, "ParsePayload Type default: %d", payloadType);
93 result = OC_STACK_INVALID_PARAM;
97 OIC_LOG_V(INFO, TAG, "Finished parse payload, result is %d", result);
103 void OCFreeOCStringLL(OCStringLL* ll);
105 static OCStackResult OCParseSecurityPayload(OCPayload** outPayload, const uint8_t *payload,
110 *outPayload = (OCPayload *)OCSecurityPayloadCreate(payload, size);
119 static char* InPlaceStringTrim(char* str)
121 while (str[0] == ' ')
126 size_t lastchar = strlen(str);
128 while (str[lastchar] == ' ')
130 str[lastchar] = '\0';
137 static CborError OCParseStringLL(CborValue *map, char *type, OCStringLL **resource)
140 CborError err = cbor_value_map_find_value(map, type, &val);
141 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL TAG");
143 if (cbor_value_is_array(&val))
146 err = cbor_value_enter_container(&val, &txtStr);
147 VERIFY_CBOR_SUCCESS(TAG, err, "to enter container");
148 while (cbor_value_is_text_string(&txtStr))
152 err = cbor_value_dup_text_string(&txtStr, &input, &len, NULL);
153 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL value.");
156 char *savePtr = NULL;
157 char *curPtr = strtok_r(input, " ", &savePtr);
160 char *trimmed = InPlaceStringTrim(curPtr);
161 if (trimmed[0] !='\0')
163 if (!OCResourcePayloadAddStringLL(resource, trimmed))
165 return CborErrorOutOfMemory;
168 curPtr = strtok_r(NULL, " ", &savePtr);
172 if (cbor_value_is_text_string(&txtStr))
174 err = cbor_value_advance(&txtStr);
175 VERIFY_CBOR_SUCCESS(TAG, err, "to advance string value");
183 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *rootValue)
185 OCStackResult ret = OC_STACK_INVALID_PARAM;
186 OCResourcePayload *resource = NULL;
187 OCDiscoveryPayload *out = NULL;
189 CborError err = CborNoError;
192 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
193 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid Parameter rootValue");
194 if (cbor_value_is_array(rootValue))
196 // Root value is already inside the main root array
198 ret = OC_STACK_NO_MEMORY;
199 out = OCDiscoveryPayloadCreate();
200 VERIFY_PARAM_NON_NULL(TAG, out, "Failed error initializing discovery payload");
202 // Enter the main root map
203 ret = OC_STACK_MALFORMED_RESPONSE;
204 err = cbor_value_enter_container(rootValue, &rootMap);
205 VERIFY_CBOR_SUCCESS(TAG, err, "to enter root map container");
209 if (!cbor_value_is_map(&rootMap))
211 OIC_LOG(ERROR, TAG, "Malformed packet!!");
214 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_ID, &curVal);
215 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
216 if (cbor_value_is_valid(&curVal))
218 if (cbor_value_is_byte_string(&curVal))
220 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&(out->sid), &len, NULL);
221 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
223 else if (cbor_value_is_text_string(&curVal))
225 err = cbor_value_dup_text_string(&curVal, &(out->sid), &len, NULL);
226 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
230 // BaseURI - Not a mandatory field
231 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_BASE_URI, &curVal);
232 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri tag");
233 if (cbor_value_is_valid(&curVal))
235 err = cbor_value_dup_text_string(&curVal, &(out->baseURI), &len, NULL);
236 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
239 // HREF - Not a mandatory field
240 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
241 if (cbor_value_is_valid(&curVal))
243 err = cbor_value_dup_text_string(&curVal, &(out->uri), &len, NULL);
244 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri value");
247 // RT - Not a mandatory field
248 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal);
249 if (cbor_value_is_valid(&curVal))
251 err = cbor_value_dup_text_string(&curVal, &(out->type), &len, NULL);
252 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
255 // IF - Not a mandatory field
256 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal);
257 if (cbor_value_is_valid(&curVal))
259 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &out->interface);
263 if (!OCResourcePayloadAddStringLL(&out->interface, OC_RSRVD_INTERFACE_LL))
265 err = CborErrorOutOfMemory;
269 // Name - Not a mandatory field
270 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_NAME, &curVal);
271 if (cbor_value_is_valid(&curVal))
273 err = cbor_value_dup_text_string(&curVal, &out->name, &len, NULL);
274 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name");
277 // Look for Links which will have an array as the value
279 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_LINKS, &linkMap);
280 VERIFY_CBOR_SUCCESS(TAG, err, "to find links tag");
282 // Enter the links array and start iterating through the array processing
283 // each resource which shows up as a map.
284 CborValue resourceMap;
285 err = cbor_value_enter_container(&linkMap, &resourceMap);
286 VERIFY_CBOR_SUCCESS(TAG, err, "to enter link map");
288 while (cbor_value_is_map(&resourceMap))
290 resource = (OCResourcePayload *)OICCalloc(1, sizeof(OCResourcePayload));
291 VERIFY_PARAM_NON_NULL(TAG, resource, "Failed allocating resource payload");
294 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_HREF, &curVal);
295 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
296 err = cbor_value_dup_text_string(&curVal, &(resource->uri), &len, NULL);
297 VERIFY_CBOR_SUCCESS(TAG, err, "to find href value");
300 err = OCParseStringLL(&resourceMap, OC_RSRVD_RESOURCE_TYPE, &resource->types);
301 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag/value");
304 err = OCParseStringLL(&resourceMap, OC_RSRVD_INTERFACE, &resource->interfaces);
305 if (CborNoError != err)
307 if (!OCResourcePayloadAddStringLL(&resource->interfaces, OC_RSRVD_INTERFACE_LL))
309 OIC_LOG(ERROR, TAG, "Failed to add string to StringLL");
316 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_POLICY, &policyMap);
317 VERIFY_CBOR_SUCCESS(TAG, err, "to find policy tag");
320 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_BITMAP, &curVal);
321 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap tag");
322 err = cbor_value_get_int(&curVal, (int *)&resource->bitmap);
323 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap value");
326 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_SECURE, &curVal);
327 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure tag");
328 if (cbor_value_is_valid(&curVal))
330 err = cbor_value_get_boolean(&curVal, &(resource->secure));
331 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure value");
335 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_HOSTING_PORT, &curVal);
336 VERIFY_CBOR_SUCCESS(TAG, err, "to find port tag");
337 if (cbor_value_is_valid(&curVal))
339 err = cbor_value_get_int(&curVal, (int *)&resource->port);
340 VERIFY_CBOR_SUCCESS(TAG, err, "to find port value");
343 err = cbor_value_advance(&resourceMap);
344 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
346 OCDiscoveryPayloadAddNewResource(out, resource);
349 err = cbor_value_leave_container(rootValue, &resourceMap);
350 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
354 OIC_LOG(ERROR, TAG, "Malformed packet ");
358 *outPayload = (OCPayload *)out;
362 OCDiscoveryResourceDestroy(resource);
363 OCDiscoveryPayloadDestroy(out);
367 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *rootValue)
369 OCStackResult ret = OC_STACK_INVALID_PARAM;
370 CborError err = CborNoError;
371 OCDevicePayload *out = NULL;
372 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid param outPayload");
373 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid param rootValue");
377 out = (OCDevicePayload *)OICCalloc(1, sizeof(OCDevicePayload));
378 VERIFY_PARAM_NON_NULL(TAG, out, "Failed allocating device payload")
379 out->base.type = PAYLOAD_TYPE_DEVICE;
380 ret = OC_STACK_MALFORMED_RESPONSE;
382 if (cbor_value_is_map(rootValue))
386 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
387 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag");
388 if (cbor_value_is_valid(&curVal))
390 err = OCParseStringLL(rootValue, OC_RSRVD_RESOURCE_TYPE, &out->types);
391 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
394 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &curVal);
395 VERIFY_CBOR_SUCCESS(TAG, err, "to find interface tag");
396 if (cbor_value_is_valid(&curVal))
398 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &out->interfaces);
399 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
403 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_ID, &curVal);
404 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
405 if (cbor_value_is_valid(&curVal))
407 if (cbor_value_is_byte_string(&curVal))
409 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&out->sid, &len, NULL);
410 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
412 else if (cbor_value_is_text_string(&curVal))
414 err = cbor_value_dup_text_string(&curVal, &out->sid, &len, NULL);
415 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
419 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_NAME, &curVal);
420 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name tag");
421 if (cbor_value_is_valid(&curVal))
423 err = cbor_value_dup_text_string(&curVal, &out->deviceName, &len, NULL);
424 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name in device payload");
426 // Device Spec Version
427 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SPEC_VERSION, &curVal);
428 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec ver tag");
429 if (cbor_value_is_valid(&curVal))
431 err = cbor_value_dup_text_string(&curVal, &out->specVersion, &len, NULL);
432 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec version in device payload");
434 // Data Model Version
435 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DATA_MODEL_VERSION, &curVal);
436 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model ver tag");
437 if (cbor_value_is_valid(&curVal))
439 err = cbor_value_dup_text_string(&curVal, &out->dataModelVersion, &len, NULL);
440 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model version in device payload");
442 err = cbor_value_advance(rootValue);
443 VERIFY_CBOR_SUCCESS(TAG, err, "to advance device payload");
445 *outPayload = (OCPayload *)out;
450 OCDevicePayloadDestroy(out);
454 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *rootValue)
456 OCStackResult ret = OC_STACK_INVALID_PARAM;
457 CborError err = CborNoError;
458 OCPlatformInfo info = {0};
460 OCStringLL* interfaces = NULL;
461 OCPlatformPayload* out = NULL;
463 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
465 if (cbor_value_is_map(rootValue))
469 ret = OC_STACK_MALFORMED_RESPONSE;
472 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_ID, &repVal);
473 VERIFY_CBOR_SUCCESS(TAG, err, "to find platform id tag");
474 if (cbor_value_is_valid(&repVal))
476 err = cbor_value_dup_text_string(&repVal, &(info.platformID), &len, NULL);
477 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformID in the platform payload");
480 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_NAME, &repVal);
481 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg name tag");
482 if (cbor_value_is_valid(&repVal))
484 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerName), &len, NULL);
485 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureName in the platform payload");
488 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_URL, &repVal);
489 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg url tag");
490 if (cbor_value_is_valid(&repVal))
492 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerUrl), &len, NULL);
493 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureUrl in the platform payload");
496 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MODEL_NUM, &repVal);
497 VERIFY_CBOR_SUCCESS(TAG, err, "to find model num tag");
498 if (cbor_value_is_valid(&repVal))
500 err = cbor_value_dup_text_string(&repVal, &(info.modelNumber), &len, NULL);
501 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find modelNumber in the platform payload");
504 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_DATE, &repVal);
505 VERIFY_CBOR_SUCCESS(TAG, err, "to find mfg date tag");
506 if (cbor_value_is_valid(&repVal))
508 err = cbor_value_dup_text_string(&repVal, &(info.dateOfManufacture), &len, NULL);
509 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find dateOfManufacture in the platform payload");
512 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_VERSION, &repVal);
513 VERIFY_CBOR_SUCCESS(TAG, err, "to find platform ver tag");
514 if (cbor_value_is_valid(&repVal))
516 err = cbor_value_dup_text_string(&repVal, &(info.platformVersion), &len, NULL);
517 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformVersion in the platform payload");
520 err = cbor_value_map_find_value(rootValue, OC_RSRVD_OS_VERSION, &repVal);
521 VERIFY_CBOR_SUCCESS(TAG, err, "to find os ver tag");
522 if (cbor_value_is_valid(&repVal))
524 err = cbor_value_dup_text_string(&repVal, &(info.operatingSystemVersion), &len, NULL);
525 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find OSVersion in the platform payload");
528 err = cbor_value_map_find_value(rootValue, OC_RSRVD_HARDWARE_VERSION, &repVal);
529 VERIFY_CBOR_SUCCESS(TAG, err, "to find hw ver tag");
530 if(cbor_value_is_valid(&repVal))
532 err = cbor_value_dup_text_string(&repVal, &(info.hardwareVersion), &len, NULL);
533 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find HWVersion in the platform payload");
536 err = cbor_value_map_find_value(rootValue, OC_RSRVD_FIRMWARE_VERSION, &repVal);
537 VERIFY_CBOR_SUCCESS(TAG, err, "to find fw ver tag");
538 if(cbor_value_is_valid(&repVal))
540 err = cbor_value_dup_text_string(&repVal, &(info.firmwareVersion), &len, NULL);
541 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find firmwareVersion in the platform payload");
544 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SUPPORT_URL, &repVal);
545 VERIFY_CBOR_SUCCESS(TAG, err, "to find support url tag");
546 if(cbor_value_is_valid(&repVal))
548 err = cbor_value_dup_text_string(&repVal, &(info.supportUrl), &len, NULL);
549 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
552 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SYSTEM_TIME, &repVal);
553 VERIFY_CBOR_SUCCESS(TAG, err, "to find sys time tag");
554 if(cbor_value_is_valid(&repVal))
556 err = cbor_value_dup_text_string(&repVal, &(info.systemTime), &len, NULL);
557 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find systemTume in the platform payload");
561 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &repVal);
562 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag");
563 if(cbor_value_is_valid(&repVal))
565 err = cbor_value_dup_text_string(&repVal, &rt, &len, NULL);
566 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find resource type in the platform payload");
570 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &repVal);
571 VERIFY_CBOR_SUCCESS(TAG, err, "to find interface tag");
572 if(cbor_value_is_valid(&repVal))
574 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &interfaces);
575 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
578 err = cbor_value_advance(rootValue);
579 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
581 out = (OCPlatformPayload *)OCPlatformPayloadCreateAsOwner(&info);
583 out->interfaces = interfaces;
584 *outPayload = (OCPayload *)out;
585 OIC_LOG_PAYLOAD(DEBUG, *outPayload);
590 OCPlatformInfoDestroy(&info);
591 OIC_LOG(ERROR, TAG, "CBOR error In ParsePlatformPayload");
595 static OCRepPayloadPropType DecodeCborType(CborType type)
600 return OCREP_PROP_NULL;
601 case CborIntegerType:
602 return OCREP_PROP_INT;
605 return OCREP_PROP_DOUBLE;
606 case CborBooleanType:
607 return OCREP_PROP_BOOL;
608 case CborTextStringType:
609 return OCREP_PROP_STRING;
610 case CborByteStringType:
611 return OCREP_PROP_BYTE_STRING;
613 return OCREP_PROP_OBJECT;
615 return OCREP_PROP_ARRAY;
617 return OCREP_PROP_NULL;
620 static CborError OCParseArrayFindDimensionsAndType(const CborValue *parent,
621 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType *type)
623 CborValue insideArray;
624 *type = OCREP_PROP_NULL;
625 dimensions[0] = dimensions[1] = dimensions[2] = 0;
627 CborError err = cbor_value_enter_container(parent, &insideArray);
628 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
630 while (cbor_value_is_valid(&insideArray))
632 OCRepPayloadPropType tempType = DecodeCborType(cbor_value_get_type(&insideArray));
634 if (tempType == OCREP_PROP_ARRAY)
636 size_t subdim[MAX_REP_ARRAY_DEPTH];
637 tempType = OCREP_PROP_NULL;
638 err = OCParseArrayFindDimensionsAndType(&insideArray, subdim, &tempType);
639 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse array");
643 OIC_LOG(ERROR, TAG, "Parse array helper, sub-array too deep");
646 dimensions[1] = dimensions[1] >= subdim[0] ? dimensions[1] : subdim[0];
647 dimensions[2] = dimensions[2] >= subdim[1] ? dimensions[2] : subdim[1];
649 if (*type != OCREP_PROP_NULL && tempType != OCREP_PROP_NULL && *type != tempType)
651 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed (subtype)");
652 return CborUnknownError;
654 else if (*type == OCREP_PROP_NULL)
656 // We don't know the type of this array yet, so the assignment is OK
660 else if (*type == OCREP_PROP_NULL)
662 // We don't know the type of this array yet, so the assignment is OK
665 // tempType is allowed to be NULL, since it might now know the answer yet
666 else if (tempType != OCREP_PROP_NULL && *type != tempType)
668 // this is an invalid situation!
669 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed");
670 return CborUnknownError;
674 err = cbor_value_advance(&insideArray);
675 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance array");
682 static size_t getAllocSize(OCRepPayloadPropType type)
687 return sizeof (int64_t);
688 case OCREP_PROP_DOUBLE:
689 return sizeof (double);
690 case OCREP_PROP_BOOL:
691 return sizeof (bool);
692 case OCREP_PROP_STRING:
693 return sizeof (char*);
694 case OCREP_PROP_BYTE_STRING:
695 return sizeof (OCByteString);
696 case OCREP_PROP_OBJECT:
697 return sizeof (OCRepPayload*);
703 static size_t arrayStep(size_t dimensions[MAX_REP_ARRAY_DEPTH], size_t elementNum)
706 (dimensions[1] == 0 ? 1 : dimensions[1]) *
707 (dimensions[2] == 0 ? 1 : dimensions[2]) *
711 static CborError OCParseArrayFillArray(const CborValue *parent,
712 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType type, void *targetArray)
714 CborValue insideArray;
717 char *tempStr = NULL;
718 OCByteString ocByteStr = { .bytes = NULL, .len = 0};
720 OCRepPayload *tempPl = NULL;
722 size_t newdim[MAX_REP_ARRAY_DEPTH];
723 newdim[0] = dimensions[1];
724 newdim[1] = dimensions[2];
727 CborError err = cbor_value_enter_container(parent, &insideArray);
728 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
730 while (!err && i < dimensions[0] && cbor_value_is_valid(&insideArray))
732 bool noAdvance = false;
733 if (cbor_value_get_type(&insideArray) != CborNullType)
738 if (dimensions[1] == 0)
740 err = cbor_value_get_int64(&insideArray, &(((int64_t*)targetArray)[i]));
744 err = OCParseArrayFillArray(&insideArray, newdim, type,
745 &(((int64_t*)targetArray)[arrayStep(dimensions, i)]));
748 case OCREP_PROP_DOUBLE:
749 if (dimensions[1] == 0)
751 double *d = &(((double*)targetArray)[i]);
752 if (cbor_value_get_type(&insideArray) == CborDoubleType)
754 err = cbor_value_get_double(&insideArray, d);
760 err = cbor_value_get_float(&insideArray, &f);
767 err = OCParseArrayFillArray(&insideArray, newdim, type,
768 &(((double*)targetArray)[arrayStep(dimensions, i)]));
771 case OCREP_PROP_BOOL:
772 if (dimensions[1] == 0)
774 err = cbor_value_get_boolean(&insideArray, &(((bool*)targetArray)[i]));
778 err = OCParseArrayFillArray(&insideArray, newdim, type,
779 &(((bool*)targetArray)[arrayStep(dimensions, i)]));
782 case OCREP_PROP_STRING:
783 if (dimensions[1] == 0)
785 err = cbor_value_dup_text_string(&insideArray, &tempStr, &tempLen, NULL);
786 ((char**)targetArray)[i] = tempStr;
791 err = OCParseArrayFillArray(&insideArray, newdim, type,
792 &(((char**)targetArray)[arrayStep(dimensions, i)]));
795 case OCREP_PROP_BYTE_STRING:
796 if (dimensions[1] == 0)
798 err = cbor_value_dup_byte_string(&insideArray, &(ocByteStr.bytes),
799 &(ocByteStr.len), NULL);
800 ((OCByteString*)targetArray)[i] = ocByteStr;
804 err = OCParseArrayFillArray(&insideArray, newdim, type,
805 &(((OCByteString*)targetArray)[arrayStep(dimensions, i)]));
808 case OCREP_PROP_OBJECT:
809 if (dimensions[1] == 0)
811 err = OCParseSingleRepPayload(&tempPl, &insideArray, false);
812 ((OCRepPayload**)targetArray)[i] = tempPl;
818 err = OCParseArrayFillArray(&insideArray, newdim, type,
819 &(((OCRepPayload**)targetArray)[arrayStep(dimensions, i)]));
823 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
824 err = CborErrorUnknownType;
827 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting repPayload");
830 if (!noAdvance && cbor_value_is_valid(&insideArray))
832 err = cbor_value_advance(&insideArray);
833 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advnce insideArray");
841 static CborError OCParseArray(OCRepPayload *out, const char *name, CborValue *container)
844 OCRepPayloadPropType type;
845 size_t dimensions[MAX_REP_ARRAY_DEPTH];
847 size_t allocSize = 0;
849 CborError err = OCParseArrayFindDimensionsAndType(container, dimensions, &type);
850 VERIFY_CBOR_SUCCESS(TAG, err, "Array details weren't clear");
852 if (type == OCREP_PROP_NULL)
854 res = OCRepPayloadSetNull(out, name);
855 err = (CborError) !res;
856 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
857 err = cbor_value_advance(container);
858 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing container");
862 dimTotal = calcDimTotal(dimensions);
863 allocSize = getAllocSize(type);
864 arr = OICCalloc(dimTotal, allocSize);
865 VERIFY_PARAM_NON_NULL(TAG, arr, "Array Parse allocation failed");
867 res = OCParseArrayFillArray(container, dimensions, type, arr);
868 VERIFY_CBOR_SUCCESS(TAG, err, "Failed parse array");
873 res = OCRepPayloadSetIntArrayAsOwner(out, name, (int64_t *)arr, dimensions);
875 case OCREP_PROP_DOUBLE:
876 res = OCRepPayloadSetDoubleArrayAsOwner(out, name, (double *)arr, dimensions);
878 case OCREP_PROP_BOOL:
879 res = OCRepPayloadSetBoolArrayAsOwner(out, name, (bool *)arr, dimensions);
881 case OCREP_PROP_STRING:
882 res = OCRepPayloadSetStringArrayAsOwner(out, name, (char **)arr, dimensions);
884 case OCREP_PROP_BYTE_STRING:
885 res = OCRepPayloadSetByteStringArrayAsOwner(out, name, (OCByteString *)arr, dimensions);
887 case OCREP_PROP_OBJECT:
888 res = OCRepPayloadSetPropObjectArrayAsOwner(out, name, (OCRepPayload**)arr, dimensions);
891 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
894 err = (CborError) !res;
895 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting array parameter");
898 if (type == OCREP_PROP_STRING)
900 for(size_t i = 0; i < dimTotal; ++i)
902 OICFree(((char**)arr)[i]);
905 if (type == OCREP_PROP_BYTE_STRING)
907 for(size_t i = 0; i < dimTotal; ++i)
909 OICFree(((OCByteString*)arr)[i].bytes);
912 if (type == OCREP_PROP_OBJECT)
914 for(size_t i = 0; i < dimTotal; ++i)
916 OCRepPayloadDestroy(((OCRepPayload**)arr)[i]);
923 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *objMap, bool isRoot)
925 CborError err = CborUnknownError;
928 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
929 VERIFY_PARAM_NON_NULL(TAG, objMap, "Invalid Parameter objMap");
931 if (cbor_value_is_map(objMap))
935 *outPayload = OCRepPayloadCreate();
938 return CborErrorOutOfMemory;
942 OCRepPayload *curPayload = *outPayload;
946 err = cbor_value_enter_container(objMap, &repMap);
947 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
949 while (!err && cbor_value_is_valid(&repMap))
951 if (cbor_value_is_text_string(&repMap))
953 err = cbor_value_dup_text_string(&repMap, &name, &len, NULL);
954 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding tag name in the map");
955 err = cbor_value_advance(&repMap);
956 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing rootMap");
959 ((0 == strcmp(OC_RSRVD_HREF, name)) ||
960 (0 == strcmp(OC_RSRVD_RESOURCE_TYPE, name)) ||
961 (0 == strcmp(OC_RSRVD_INTERFACE, name))))
963 err = cbor_value_advance(&repMap);
968 CborType type = cbor_value_get_type(&repMap);
972 res = OCRepPayloadSetNull(curPayload, name);
974 case CborIntegerType:
977 err = cbor_value_get_int64(&repMap, &intval);
978 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting int value");
979 res = OCRepPayloadSetPropInt(curPayload, name, intval);
984 double doubleval = 0;
985 err = cbor_value_get_double(&repMap, &doubleval);
986 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting double value");
987 res = OCRepPayloadSetPropDouble(curPayload, name, doubleval);
990 case CborBooleanType:
992 bool boolval = false;
993 err = cbor_value_get_boolean(&repMap, &boolval);
994 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting boolean value");
995 res = OCRepPayloadSetPropBool(curPayload, name, boolval);
998 case CborTextStringType:
1000 char *strval = NULL;
1001 err = cbor_value_dup_text_string(&repMap, &strval, &len, NULL);
1002 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting string value");
1003 res = OCRepPayloadSetPropStringAsOwner(curPayload, name, strval);
1006 case CborByteStringType:
1008 uint8_t* bytestrval = NULL;
1009 err = cbor_value_dup_byte_string(&repMap, &bytestrval, &len, NULL);
1010 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting byte string value");
1011 OCByteString tmp = {.bytes = bytestrval, .len = len};
1012 res = OCRepPayloadSetPropByteStringAsOwner(curPayload, name, &tmp);
1017 OCRepPayload *pl = NULL;
1018 err = OCParseSingleRepPayload(&pl, &repMap, false);
1019 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting parse single rep");
1020 res = OCRepPayloadSetPropObjectAsOwner(curPayload, name, pl);
1024 err = OCParseArray(curPayload, name, &repMap);
1027 OIC_LOG_V(ERROR, TAG, "Parsing rep property, unknown type %d", repMap.type);
1030 if (type != CborArrayType)
1032 err = (CborError) !res;
1034 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
1036 if (type != CborMapType && cbor_value_is_valid(&repMap))
1038 err = cbor_value_advance(&repMap);
1039 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advance repMap");
1044 if (cbor_value_is_container(objMap))
1046 err = cbor_value_leave_container(objMap, &repMap);
1047 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to leave container");
1054 OCRepPayloadDestroy(*outPayload);
1059 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *root)
1061 OCStackResult ret = OC_STACK_INVALID_PARAM;
1063 OCRepPayload *temp = NULL;
1064 OCRepPayload *rootPayload = NULL;
1065 OCRepPayload *curPayload = NULL;
1066 CborValue rootMap = *root;
1067 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1068 VERIFY_PARAM_NON_NULL(TAG, root, "Invalid Parameter root");
1071 if (cbor_value_is_array(root))
1073 err = cbor_value_enter_container(root, &rootMap);
1074 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
1076 while (cbor_value_is_valid(&rootMap))
1078 temp = OCRepPayloadCreate();
1079 ret = OC_STACK_NO_MEMORY;
1080 VERIFY_PARAM_NON_NULL(TAG, temp, "Failed allocating memory");
1083 ret = OC_STACK_MALFORMED_RESPONSE;
1085 // temporary fix to check for malformed cbor payload
1086 if (!cbor_value_is_map(&rootMap) && !cbor_value_is_array(&rootMap)){
1090 if (cbor_value_is_map(&rootMap))
1092 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
1093 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
1094 if (cbor_value_is_valid(&curVal))
1097 err = cbor_value_dup_text_string(&curVal, &temp->uri, &len, NULL);
1098 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find uri");
1103 if (cbor_value_is_map(&rootMap))
1105 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal))
1107 err = OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &temp->types);
1108 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
1113 if (cbor_value_is_map(&rootMap))
1115 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal))
1117 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &temp->interfaces);
1118 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
1122 if (cbor_value_is_map(&rootMap))
1124 err = OCParseSingleRepPayload(&temp, &rootMap, true);
1125 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse single rep payload");
1128 if(rootPayload == NULL)
1135 curPayload->next = temp;
1136 curPayload = curPayload->next;
1139 if (cbor_value_is_array(&rootMap))
1141 err = cbor_value_advance(&rootMap);
1142 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance single rep payload");
1145 *outPayload = (OCPayload *)rootPayload;
1149 OCRepPayloadDestroy(temp);
1150 OCRepPayloadDestroy(rootPayload);
1151 OIC_LOG(ERROR, TAG, "CBOR error in ParseRepPayload");
1155 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *rootValue)
1157 OCStackResult ret = OC_STACK_INVALID_PARAM;
1158 OCPresencePayload *payload = NULL;
1159 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1163 payload = (OCPresencePayload *)OICCalloc(1, sizeof(OCPresencePayload));
1164 ret = OC_STACK_NO_MEMORY;
1165 VERIFY_PARAM_NON_NULL(TAG, payload, "Failed allocating presence payload");
1166 payload->base.type = PAYLOAD_TYPE_PRESENCE;
1167 ret = OC_STACK_MALFORMED_RESPONSE;
1169 if (cbor_value_is_map(rootValue))
1174 CborError err = cbor_value_map_find_value(rootValue, OC_RSRVD_NONCE, &curVal);
1175 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce tag");
1176 err = cbor_value_get_uint64(&curVal, (uint64_t *)&payload->sequenceNumber);
1177 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce value");
1180 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TTL, &curVal);
1181 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl tag");
1182 err = cbor_value_get_uint64(&curVal, (uint64_t *)&payload->maxAge);
1183 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl value");
1186 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TRIGGER, &curVal);
1187 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger tag");
1188 err = cbor_value_get_simple_type(&curVal, (uint8_t *)&payload->trigger);
1189 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger value");
1191 // Resource type name
1192 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
1193 VERIFY_CBOR_SUCCESS(TAG, err, "to find res type tag");
1194 if (cbor_value_is_valid(&curVal))
1197 err = cbor_value_dup_text_string(&curVal, &payload->resourceType, &len, NULL);
1198 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding resource type value");
1201 err = cbor_value_advance(rootValue);
1202 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing root value");
1204 *outPayload = (OCPayload *)payload;
1208 OIC_LOG(ERROR, TAG, "CBOR error Parse Presence Payload");
1209 OCPresencePayloadDestroy(payload);