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 *)OCSecurityPayloadCBORCreate(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_text_string(&val))
146 char *savePtr = NULL;
149 err = cbor_value_dup_text_string(&val, &input, &len, NULL);
150 VERIFY_CBOR_SUCCESS(TAG, err, "to find StringLL value");
154 char *curPtr = strtok_r(input, " ", &savePtr);
157 char *trimmed = InPlaceStringTrim(curPtr);
158 if (trimmed[0] !='\0')
160 if (!OCResourcePayloadAddStringLL(resource, trimmed))
162 return CborErrorOutOfMemory;
165 curPtr = strtok_r(NULL, " ", &savePtr);
174 static OCStackResult OCParseDiscoveryPayload(OCPayload **outPayload, CborValue *rootValue)
176 OCStackResult ret = OC_STACK_INVALID_PARAM;
177 OCResourcePayload *resource = NULL;
178 OCDiscoveryPayload *out = NULL;
180 CborError err = CborNoError;
183 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
184 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid Parameter rootValue");
186 // Root value is already inside the main root array
188 ret = OC_STACK_NO_MEMORY;
189 out = OCDiscoveryPayloadCreate();
190 VERIFY_PARAM_NON_NULL(TAG, out, "Failed error initializing discovery payload");
192 // Enter the main root map
193 ret = OC_STACK_MALFORMED_RESPONSE;
194 err = cbor_value_enter_container(rootValue, &rootMap);
195 VERIFY_CBOR_SUCCESS(TAG, err, "to enter root map container");
199 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_ID, &curVal);
200 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id tag");
201 if (cbor_value_is_valid(&curVal))
203 if (cbor_value_is_byte_string(&curVal))
205 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&(out->sid), &len, NULL);
206 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
208 else if (cbor_value_is_text_string(&curVal))
210 err = cbor_value_dup_text_string(&curVal, &(out->sid), &len, NULL);
211 VERIFY_CBOR_SUCCESS(TAG, err, "to copy device id value");
215 // BaseURI - Not a mandatory field
216 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_BASE_URI, &curVal);
217 if (cbor_value_is_valid(&curVal))
219 err = cbor_value_dup_text_string(&curVal, &(out->baseURI), &len, NULL);
220 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
223 // HREF - Not a mandatory field
224 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
225 if (cbor_value_is_valid(&curVal))
227 err = cbor_value_dup_text_string(&curVal, &(out->uri), &len, NULL);
228 VERIFY_CBOR_SUCCESS(TAG, err, "to find uri value");
231 // RT - Not a mandatory field
232 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal);
233 if (cbor_value_is_valid(&curVal))
235 err = cbor_value_dup_text_string(&curVal, &(out->type), &len, NULL);
236 VERIFY_CBOR_SUCCESS(TAG, err, "to find base uri value");
239 // IF - Not a mandatory field
240 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal);
241 if (cbor_value_is_valid(&curVal))
243 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &out->interface);
247 if (!OCResourcePayloadAddStringLL(&out->interface, OC_RSRVD_INTERFACE_LL))
249 err = CborErrorOutOfMemory;
253 // Name - Not a mandatory field
254 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_DEVICE_NAME, &curVal);
255 if (cbor_value_is_valid(&curVal))
257 err = cbor_value_dup_text_string(&curVal, &out->name, &len, NULL);
258 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name");
261 // Look for Links which will have an array as the value
263 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_LINKS, &linkMap);
264 VERIFY_CBOR_SUCCESS(TAG, err, "to find links tag");
266 // Enter the links array and start iterating through the array processing
267 // each resource which shows up as a map.
268 CborValue resourceMap;
269 err = cbor_value_enter_container(&linkMap, &resourceMap);
270 VERIFY_CBOR_SUCCESS(TAG, err, "to enter link map");
272 while (cbor_value_is_map(&resourceMap))
274 resource = (OCResourcePayload *)OICCalloc(1, sizeof(OCResourcePayload));
275 VERIFY_PARAM_NON_NULL(TAG, resource, "Failed allocating resource payload");
278 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_HREF, &curVal);
279 VERIFY_CBOR_SUCCESS(TAG, err, "to find href tag");
280 err = cbor_value_dup_text_string(&curVal, &(resource->uri), &len, NULL);
281 VERIFY_CBOR_SUCCESS(TAG, err, "to find href value");
284 err = OCParseStringLL(&resourceMap, OC_RSRVD_RESOURCE_TYPE, &resource->types);
285 VERIFY_CBOR_SUCCESS(TAG, err, "to find resource type tag/value");
288 err = OCParseStringLL(&resourceMap, OC_RSRVD_INTERFACE, &resource->interfaces);
289 if (CborNoError != err)
291 if (!OCResourcePayloadAddStringLL(&resource->interfaces, OC_RSRVD_INTERFACE_LL))
293 err = CborErrorOutOfMemory;
299 err = cbor_value_map_find_value(&resourceMap, OC_RSRVD_POLICY, &policyMap);
300 VERIFY_CBOR_SUCCESS(TAG, err, "to find policy tag");
303 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_BITMAP, &curVal);
304 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap tag");
305 err = cbor_value_get_int(&curVal, (int *)&resource->bitmap);
306 VERIFY_CBOR_SUCCESS(TAG, err, "to find bitmap value");
309 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_SECURE, &curVal);
310 if (cbor_value_is_valid(&curVal))
312 err = cbor_value_get_boolean(&curVal, &(resource->secure));
313 VERIFY_CBOR_SUCCESS(TAG, err, "to find secure value");
317 err = cbor_value_map_find_value(&policyMap, OC_RSRVD_HOSTING_PORT, &curVal);
318 if (cbor_value_is_valid(&curVal))
320 err = cbor_value_get_int(&curVal, (int *)&resource->port);
321 VERIFY_CBOR_SUCCESS(TAG, err, "to find port value");
324 err = cbor_value_advance(&resourceMap);
325 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
327 OCDiscoveryPayloadAddNewResource(out, resource);
330 err = cbor_value_leave_container(rootValue, &resourceMap);
331 VERIFY_CBOR_SUCCESS(TAG, err, "to advance resource map");
333 *outPayload = (OCPayload *)out;
334 OIC_LOG_PAYLOAD(DEBUG, *outPayload);
339 OCDiscoveryResourceDestroy(resource);
340 OCDiscoveryPayloadDestroy(out);
344 static OCStackResult OCParseDevicePayload(OCPayload **outPayload, CborValue *rootValue)
346 OCStackResult ret = OC_STACK_INVALID_PARAM;
347 CborError err = CborNoError;
348 OCDevicePayload *out = NULL;
349 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid param outPayload");
350 VERIFY_PARAM_NON_NULL(TAG, rootValue, "Invalid param rootValue");
354 out = (OCDevicePayload *)OICCalloc(1, sizeof(OCDevicePayload));
355 VERIFY_PARAM_NON_NULL(TAG, out, "Failed allocating device payload")
356 out->base.type = PAYLOAD_TYPE_DEVICE;
357 ret = OC_STACK_MALFORMED_RESPONSE;
359 if (cbor_value_is_map(rootValue))
363 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
364 if (cbor_value_is_valid(&curVal))
366 err = OCParseStringLL(rootValue, OC_RSRVD_RESOURCE_TYPE, &out->types);
367 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
371 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_ID, &curVal);
372 if (cbor_value_is_valid(&curVal))
374 if (cbor_value_is_byte_string(&curVal))
376 err = cbor_value_dup_byte_string(&curVal, (uint8_t **)&out->sid, &len, NULL);
377 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
379 else if (cbor_value_is_text_string(&curVal))
381 err = cbor_value_dup_text_string(&curVal, &out->sid, &len, NULL);
382 VERIFY_CBOR_SUCCESS(TAG, err, "to find device id in device payload");
386 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DEVICE_NAME, &curVal);
387 if (cbor_value_is_valid(&curVal))
389 err = cbor_value_dup_text_string(&curVal, &out->deviceName, &len, NULL);
390 VERIFY_CBOR_SUCCESS(TAG, err, "to find device name in device payload");
392 // Device Spec Version
393 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SPEC_VERSION, &curVal);
394 if (cbor_value_is_valid(&curVal))
396 err = cbor_value_dup_text_string(&curVal, &out->specVersion, &len, NULL);
397 VERIFY_CBOR_SUCCESS(TAG, err, "to find spec version in device payload");
399 // Data Model Version
400 err = cbor_value_map_find_value(rootValue, OC_RSRVD_DATA_MODEL_VERSION, &curVal);
401 if (cbor_value_is_valid(&curVal))
403 err = cbor_value_dup_text_string(&curVal, &out->dataModelVersion, &len, NULL);
404 VERIFY_CBOR_SUCCESS(TAG, err, "to find data model version in device payload");
406 err = cbor_value_advance(rootValue);
407 VERIFY_CBOR_SUCCESS(TAG, err, "to advance device payload");
409 *outPayload = (OCPayload *)out;
414 OCDevicePayloadDestroy(out);
418 static OCStackResult OCParsePlatformPayload(OCPayload **outPayload, CborValue *rootValue)
420 OCStackResult ret = OC_STACK_INVALID_PARAM;
421 CborError err = CborNoError;
422 OCPlatformInfo info = {0};
424 OCStringLL* interfaces = NULL;
425 OCPlatformPayload* out = NULL;
427 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
429 if (cbor_value_is_map(rootValue))
433 ret = OC_STACK_MALFORMED_RESPONSE;
436 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_ID, &repVal);
437 if (cbor_value_is_valid(&repVal))
439 err = cbor_value_dup_text_string(&repVal, &(info.platformID), &len, NULL);
440 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformID in the platform payload");
443 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_NAME, &repVal);
444 if (cbor_value_is_valid(&repVal))
446 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerName), &len, NULL);
447 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureName in the platform payload");
450 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_URL, &repVal);
451 if (cbor_value_is_valid(&repVal))
453 err = cbor_value_dup_text_string(&repVal, &(info.manufacturerUrl), &len, NULL);
454 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find manufactureUrl in the platform payload");
457 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MODEL_NUM, &repVal);
458 if (cbor_value_is_valid(&repVal))
460 err = cbor_value_dup_text_string(&repVal, &(info.modelNumber), &len, NULL);
461 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find modelNumber in the platform payload");
464 err = cbor_value_map_find_value(rootValue, OC_RSRVD_MFG_DATE, &repVal);
465 if (cbor_value_is_valid(&repVal))
467 err = cbor_value_dup_text_string(&repVal, &(info.dateOfManufacture), &len, NULL);
468 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find dateOfManufacture in the platform payload");
471 err = cbor_value_map_find_value(rootValue, OC_RSRVD_PLATFORM_VERSION, &repVal);
472 if (cbor_value_is_valid(&repVal))
474 err = cbor_value_dup_text_string(&repVal, &(info.platformVersion), &len, NULL);
475 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find platformVersion in the platform payload");
478 err = cbor_value_map_find_value(rootValue, OC_RSRVD_OS_VERSION, &repVal);
479 if (cbor_value_is_valid(&repVal))
481 err = cbor_value_dup_text_string(&repVal, &(info.operatingSystemVersion), &len, NULL);
482 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find OSVersion in the platform payload");
485 err = cbor_value_map_find_value(rootValue, OC_RSRVD_HARDWARE_VERSION, &repVal);
486 if(cbor_value_is_valid(&repVal))
488 err = cbor_value_dup_text_string(&repVal, &(info.hardwareVersion), &len, NULL);
489 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find HWVersion in the platform payload");
492 err = cbor_value_map_find_value(rootValue, OC_RSRVD_FIRMWARE_VERSION, &repVal);
493 if(cbor_value_is_valid(&repVal))
495 err = cbor_value_dup_text_string(&repVal, &(info.firmwareVersion), &len, NULL);
496 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find firmwareVersion in the platform payload");
499 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SUPPORT_URL, &repVal);
500 if(cbor_value_is_valid(&repVal))
502 err = cbor_value_dup_text_string(&repVal, &(info.supportUrl), &len, NULL);
503 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
506 err = cbor_value_map_find_value(rootValue, OC_RSRVD_SYSTEM_TIME, &repVal);
507 if(cbor_value_is_valid(&repVal))
509 err = cbor_value_dup_text_string(&repVal, &(info.systemTime), &len, NULL);
510 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find systemTume in the platform payload");
514 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &repVal);
515 if(cbor_value_is_valid(&repVal))
517 err = cbor_value_dup_text_string(&repVal, &rt, &len, NULL);
518 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find resource type in the platform payload");
522 err = cbor_value_map_find_value(rootValue, OC_RSRVD_INTERFACE, &repVal);
523 if(cbor_value_is_valid(&repVal))
525 err = OCParseStringLL(rootValue, OC_RSRVD_INTERFACE, &interfaces);
526 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
529 err = cbor_value_advance(rootValue);
530 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find supportUrl in the platform payload");
532 out = (OCPlatformPayload *)OCPlatformPayloadCreateAsOwner(&info);
534 out->interfaces = interfaces;
535 *outPayload = (OCPayload *)out;
540 OCPlatformInfoDestroy(&info);
541 OIC_LOG(ERROR, TAG, "CBOR error In ParsePlatformPayload");
545 static OCRepPayloadPropType DecodeCborType(CborType type)
550 return OCREP_PROP_NULL;
551 case CborIntegerType:
552 return OCREP_PROP_INT;
555 return OCREP_PROP_DOUBLE;
556 case CborBooleanType:
557 return OCREP_PROP_BOOL;
558 case CborTextStringType:
559 return OCREP_PROP_STRING;
560 case CborByteStringType:
561 return OCREP_PROP_BYTE_STRING;
563 return OCREP_PROP_OBJECT;
565 return OCREP_PROP_ARRAY;
567 return OCREP_PROP_NULL;
570 static CborError OCParseArrayFindDimensionsAndType(const CborValue *parent,
571 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType *type)
573 CborValue insideArray;
574 *type = OCREP_PROP_NULL;
575 dimensions[0] = dimensions[1] = dimensions[2] = 0;
577 CborError err = cbor_value_enter_container(parent, &insideArray);
578 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
580 while (cbor_value_is_valid(&insideArray))
582 OCRepPayloadPropType tempType = DecodeCborType(cbor_value_get_type(&insideArray));
584 if (tempType == OCREP_PROP_ARRAY)
586 size_t subdim[MAX_REP_ARRAY_DEPTH];
587 tempType = OCREP_PROP_NULL;
588 err = OCParseArrayFindDimensionsAndType(&insideArray, subdim, &tempType);
589 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse array");
593 OIC_LOG(ERROR, TAG, "Parse array helper, sub-array too deep");
596 dimensions[1] = dimensions[1] >= subdim[0] ? dimensions[1] : subdim[0];
597 dimensions[2] = dimensions[2] >= subdim[1] ? dimensions[2] : subdim[1];
599 if (*type != OCREP_PROP_NULL && tempType != OCREP_PROP_NULL && *type != tempType)
601 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed (subtype)");
602 return CborUnknownError;
604 else if (*type == OCREP_PROP_NULL)
606 // We don't know the type of this array yet, so the assignment is OK
610 else if (*type == OCREP_PROP_NULL)
612 // We don't know the type of this array yet, so the assignment is OK
615 // tempType is allowed to be NULL, since it might now know the answer yet
616 else if (tempType != OCREP_PROP_NULL && *type != tempType)
618 // this is an invalid situation!
619 OIC_LOG(ERROR, TAG, "Array parse failed, mixed arrays not allowed");
620 return CborUnknownError;
624 err = cbor_value_advance(&insideArray);
625 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance array");
632 static size_t getAllocSize(OCRepPayloadPropType type)
637 return sizeof (int64_t);
638 case OCREP_PROP_DOUBLE:
639 return sizeof (double);
640 case OCREP_PROP_BOOL:
641 return sizeof (bool);
642 case OCREP_PROP_STRING:
643 return sizeof (char*);
644 case OCREP_PROP_BYTE_STRING:
645 return sizeof (OCByteString);
646 case OCREP_PROP_OBJECT:
647 return sizeof (OCRepPayload*);
653 static size_t arrayStep(size_t dimensions[MAX_REP_ARRAY_DEPTH], size_t elementNum)
656 (dimensions[1] == 0 ? 1 : dimensions[1]) *
657 (dimensions[2] == 0 ? 1 : dimensions[2]) *
661 static CborError OCParseArrayFillArray(const CborValue *parent,
662 size_t dimensions[MAX_REP_ARRAY_DEPTH], OCRepPayloadPropType type, void *targetArray)
664 CborValue insideArray;
667 char *tempStr = NULL;
668 OCByteString ocByteStr = { .bytes = NULL, .len = 0};
670 OCRepPayload *tempPl = NULL;
672 size_t newdim[MAX_REP_ARRAY_DEPTH];
673 newdim[0] = dimensions[1];
674 newdim[1] = dimensions[2];
677 CborError err = cbor_value_enter_container(parent, &insideArray);
678 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to enter container");
680 while (!err && i < dimensions[0] && cbor_value_is_valid(&insideArray))
682 bool noAdvance = false;
683 if (cbor_value_get_type(&insideArray) != CborNullType)
688 if (dimensions[1] == 0)
690 err = cbor_value_get_int64(&insideArray, &(((int64_t*)targetArray)[i]));
694 err = OCParseArrayFillArray(&insideArray, newdim, type,
695 &(((int64_t*)targetArray)[arrayStep(dimensions, i)]));
698 case OCREP_PROP_DOUBLE:
699 if (dimensions[1] == 0)
701 double *d = &(((double*)targetArray)[i]);
702 if (cbor_value_get_type(&insideArray) == CborDoubleType)
704 err = cbor_value_get_double(&insideArray, d);
710 err = cbor_value_get_float(&insideArray, &f);
717 err = OCParseArrayFillArray(&insideArray, newdim, type,
718 &(((double*)targetArray)[arrayStep(dimensions, i)]));
721 case OCREP_PROP_BOOL:
722 if (dimensions[1] == 0)
724 err = cbor_value_get_boolean(&insideArray, &(((bool*)targetArray)[i]));
728 err = OCParseArrayFillArray(&insideArray, newdim, type,
729 &(((bool*)targetArray)[arrayStep(dimensions, i)]));
732 case OCREP_PROP_STRING:
733 if (dimensions[1] == 0)
735 err = cbor_value_dup_text_string(&insideArray, &tempStr, &tempLen, NULL);
736 ((char**)targetArray)[i] = tempStr;
741 err = OCParseArrayFillArray(&insideArray, newdim, type,
742 &(((char**)targetArray)[arrayStep(dimensions, i)]));
745 case OCREP_PROP_BYTE_STRING:
746 if (dimensions[1] == 0)
748 err = cbor_value_dup_byte_string(&insideArray, &(ocByteStr.bytes),
749 &(ocByteStr.len), NULL);
750 ((OCByteString*)targetArray)[i] = ocByteStr;
754 err = OCParseArrayFillArray(&insideArray, newdim, type,
755 &(((OCByteString*)targetArray)[arrayStep(dimensions, i)]));
758 case OCREP_PROP_OBJECT:
759 if (dimensions[1] == 0)
761 err = OCParseSingleRepPayload(&tempPl, &insideArray, false);
762 ((OCRepPayload**)targetArray)[i] = tempPl;
768 err = OCParseArrayFillArray(&insideArray, newdim, type,
769 &(((OCRepPayload**)targetArray)[arrayStep(dimensions, i)]));
773 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
774 err = CborErrorUnknownType;
777 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting repPayload");
780 if (!noAdvance && cbor_value_is_valid(&insideArray))
782 err = cbor_value_advance(&insideArray);
783 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advnce insideArray");
791 static CborError OCParseArray(OCRepPayload *out, const char *name, CborValue *container)
794 OCRepPayloadPropType type;
795 size_t dimensions[MAX_REP_ARRAY_DEPTH];
797 size_t allocSize = 0;
799 CborError err = OCParseArrayFindDimensionsAndType(container, dimensions, &type);
800 VERIFY_CBOR_SUCCESS(TAG, err, "Array details weren't clear");
802 if (type == OCREP_PROP_NULL)
804 res = OCRepPayloadSetNull(out, name);
805 err = (CborError) !res;
806 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
807 err = cbor_value_advance(container);
808 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing container");
812 dimTotal = calcDimTotal(dimensions);
813 allocSize = getAllocSize(type);
814 arr = OICCalloc(dimTotal, allocSize);
815 VERIFY_PARAM_NON_NULL(TAG, arr, "Array Parse allocation failed");
817 res = OCParseArrayFillArray(container, dimensions, type, arr);
818 VERIFY_CBOR_SUCCESS(TAG, err, "Failed parse array");
823 res = OCRepPayloadSetIntArrayAsOwner(out, name, (int64_t *)arr, dimensions);
825 case OCREP_PROP_DOUBLE:
826 res = OCRepPayloadSetDoubleArrayAsOwner(out, name, (double *)arr, dimensions);
828 case OCREP_PROP_BOOL:
829 res = OCRepPayloadSetBoolArrayAsOwner(out, name, (bool *)arr, dimensions);
831 case OCREP_PROP_STRING:
832 res = OCRepPayloadSetStringArrayAsOwner(out, name, (char **)arr, dimensions);
834 case OCREP_PROP_BYTE_STRING:
835 res = OCRepPayloadSetByteStringArrayAsOwner(out, name, (OCByteString *)arr, dimensions);
837 case OCREP_PROP_OBJECT:
838 res = OCRepPayloadSetPropObjectArrayAsOwner(out, name, (OCRepPayload**)arr, dimensions);
841 OIC_LOG(ERROR, TAG, "Invalid Array type in Parse Array");
844 err = (CborError) !res;
845 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting array parameter");
848 if (type == OCREP_PROP_STRING)
850 for(size_t i = 0; i < dimTotal; ++i)
852 OICFree(((char**)arr)[i]);
855 if (type == OCREP_PROP_BYTE_STRING)
857 for(size_t i = 0; i < dimTotal; ++i)
859 OICFree(((OCByteString*)arr)[i].bytes);
862 if (type == OCREP_PROP_OBJECT)
864 for(size_t i = 0; i < dimTotal; ++i)
866 OCRepPayloadDestroy(((OCRepPayload**)arr)[i]);
873 static CborError OCParseSingleRepPayload(OCRepPayload **outPayload, CborValue *objMap, bool isRoot)
875 CborError err = CborUnknownError;
878 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
879 VERIFY_PARAM_NON_NULL(TAG, objMap, "Invalid Parameter objMap");
881 if (cbor_value_is_map(objMap))
885 *outPayload = OCRepPayloadCreate();
888 return CborErrorOutOfMemory;
892 OCRepPayload *curPayload = *outPayload;
896 err = cbor_value_enter_container(objMap, &repMap);
897 VERIFY_CBOR_SUCCESS(TAG, err, "Failed entering repMap");
899 while (!err && cbor_value_is_valid(&repMap))
901 if (cbor_value_is_text_string(&repMap))
903 err = cbor_value_dup_text_string(&repMap, &name, &len, NULL);
904 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding tag name in the map");
905 err = cbor_value_advance(&repMap);
906 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing rootMap");
909 ((0 == strcmp(OC_RSRVD_HREF, name)) ||
910 (0 == strcmp(OC_RSRVD_RESOURCE_TYPE, name)) ||
911 (0 == strcmp(OC_RSRVD_INTERFACE, name))))
913 err = cbor_value_advance(&repMap);
918 CborType type = cbor_value_get_type(&repMap);
922 res = OCRepPayloadSetNull(curPayload, name);
924 case CborIntegerType:
927 err = cbor_value_get_int64(&repMap, &intval);
928 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting int value");
929 res = OCRepPayloadSetPropInt(curPayload, name, intval);
934 double doubleval = 0;
935 err = cbor_value_get_double(&repMap, &doubleval);
936 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting double value");
937 res = OCRepPayloadSetPropDouble(curPayload, name, doubleval);
940 case CborBooleanType:
942 bool boolval = false;
943 err = cbor_value_get_boolean(&repMap, &boolval);
944 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting boolean value");
945 res = OCRepPayloadSetPropBool(curPayload, name, boolval);
948 case CborTextStringType:
951 err = cbor_value_dup_text_string(&repMap, &strval, &len, NULL);
952 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting string value");
953 res = OCRepPayloadSetPropStringAsOwner(curPayload, name, strval);
956 case CborByteStringType:
958 uint8_t* bytestrval = NULL;
959 err = cbor_value_dup_byte_string(&repMap, &bytestrval, &len, NULL);
960 VERIFY_CBOR_SUCCESS(TAG, err, "Failed getting byte string value");
961 OCByteString tmp = {.bytes = bytestrval, .len = len};
962 res = OCRepPayloadSetPropByteStringAsOwner(curPayload, name, &tmp);
967 OCRepPayload *pl = NULL;
968 err = OCParseSingleRepPayload(&pl, &repMap, false);
969 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting parse single rep");
970 res = OCRepPayloadSetPropObjectAsOwner(curPayload, name, pl);
974 err = OCParseArray(curPayload, name, &repMap);
977 OIC_LOG_V(ERROR, TAG, "Parsing rep property, unknown type %d", repMap.type);
980 if (type != CborArrayType)
982 err = (CborError) !res;
984 VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting value");
986 if (type != CborMapType && cbor_value_is_valid(&repMap))
988 err = cbor_value_advance(&repMap);
989 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advance repMap");
994 if (cbor_value_is_container(objMap))
996 err = cbor_value_leave_container(objMap, &repMap);
997 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to leave container");
1004 OCRepPayloadDestroy(*outPayload);
1009 static OCStackResult OCParseRepPayload(OCPayload **outPayload, CborValue *root)
1011 OCStackResult ret = OC_STACK_INVALID_PARAM;
1013 OCRepPayload *temp = NULL;
1014 OCRepPayload *rootPayload = NULL;
1015 OCRepPayload *curPayload = NULL;
1016 CborValue rootMap = *root;
1017 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1018 VERIFY_PARAM_NON_NULL(TAG, root, "Invalid Parameter root");
1021 if (cbor_value_is_array(root))
1023 err = cbor_value_enter_container(root, &rootMap);
1025 while (cbor_value_is_valid(&rootMap))
1027 temp = OCRepPayloadCreate();
1028 ret = OC_STACK_NO_MEMORY;
1029 VERIFY_PARAM_NON_NULL(TAG, temp, "Failed allocating memory");
1032 ret = OC_STACK_MALFORMED_RESPONSE;
1034 if (cbor_value_is_map(&rootMap))
1036 err = cbor_value_map_find_value(&rootMap, OC_RSRVD_HREF, &curVal);
1037 if (cbor_value_is_valid(&curVal))
1040 err = cbor_value_dup_text_string(&curVal, &temp->uri, &len, NULL);
1041 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find uri");
1045 if (cbor_value_is_map(&rootMap))
1047 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_RESOURCE_TYPE, &curVal))
1049 err = OCParseStringLL(&rootMap, OC_RSRVD_RESOURCE_TYPE, &temp->types);
1050 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find rt type tag/value");
1055 if (cbor_value_is_map(&rootMap))
1057 if (CborNoError == cbor_value_map_find_value(&rootMap, OC_RSRVD_INTERFACE, &curVal))
1059 err = OCParseStringLL(&rootMap, OC_RSRVD_INTERFACE, &temp->interfaces);
1060 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to find interfaces tag/value");
1064 if (cbor_value_is_map(&rootMap))
1066 err = OCParseSingleRepPayload(&temp, &rootMap, true);
1067 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to parse single rep payload");
1069 if(rootPayload == NULL)
1076 curPayload->next = temp;
1077 curPayload = curPayload->next;
1080 if (cbor_value_is_array(&rootMap))
1082 err = cbor_value_advance(&rootMap);
1083 VERIFY_CBOR_SUCCESS(TAG, err, "Failed to advance single rep payload");
1086 *outPayload = (OCPayload *)rootPayload;
1090 OCRepPayloadDestroy(temp);
1091 OCRepPayloadDestroy(rootPayload);
1092 OIC_LOG(ERROR, TAG, "CBOR error in ParseRepPayload");
1096 static OCStackResult OCParsePresencePayload(OCPayload **outPayload, CborValue *rootValue)
1098 OCStackResult ret = OC_STACK_INVALID_PARAM;
1099 OCPresencePayload *payload = NULL;
1100 VERIFY_PARAM_NON_NULL(TAG, outPayload, "Invalid Parameter outPayload");
1104 payload = (OCPresencePayload *)OICCalloc(1, sizeof(OCPresencePayload));
1105 ret = OC_STACK_NO_MEMORY;
1106 VERIFY_PARAM_NON_NULL(TAG, payload, "Failed allocating presence payload");
1107 payload->base.type = PAYLOAD_TYPE_PRESENCE;
1108 ret = OC_STACK_MALFORMED_RESPONSE;
1110 if (cbor_value_is_map(rootValue))
1115 CborError err = cbor_value_map_find_value(rootValue, OC_RSRVD_NONCE, &curVal);
1116 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce tag");
1117 err = cbor_value_get_uint64(&curVal, (uint64_t *)&payload->sequenceNumber);
1118 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding nonce value");
1121 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TTL, &curVal);
1122 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl tag");
1123 err = cbor_value_get_uint64(&curVal, (uint64_t *)&payload->maxAge);
1124 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding ttl value");
1127 err = cbor_value_map_find_value(rootValue, OC_RSRVD_TRIGGER, &curVal);
1128 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger tag");
1129 err = cbor_value_get_simple_type(&curVal, (uint8_t *)&payload->trigger);
1130 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding trigger value");
1132 // Resource type name
1133 err = cbor_value_map_find_value(rootValue, OC_RSRVD_RESOURCE_TYPE, &curVal);
1134 if (cbor_value_is_valid(&curVal))
1137 err = cbor_value_dup_text_string(&curVal, &payload->resourceType, &len, NULL);
1138 VERIFY_CBOR_SUCCESS(TAG, err, "Failed finding resource type value");
1141 err = cbor_value_advance(rootValue);
1142 VERIFY_CBOR_SUCCESS(TAG, err, "Failed advancing root value");
1144 *outPayload = (OCPayload *)payload;
1148 OIC_LOG(ERROR, TAG, "CBOR error Parse Presence Payload");
1149 OCPresencePayloadDestroy(payload);