1 /* *****************************************************************
3 * Copyright 2016 Samsung Electronics All Rights Reserved.
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 * *****************************************************************/
25 #include "oic_malloc.h"
26 #include "oic_string.h"
29 #include "ocpayload.h"
30 #include "payload_logging.h"
31 #include "resourcemanager.h"
32 #include "pconfresource.h"
33 #include "psinterface.h"
35 #include "srmresourcestrings.h"
36 #include "doxmresource.h"
37 #include "srmutility.h"
38 #include "ocserverrequest.h"
40 #include "psinterface.h"
41 #include "security_internals.h"
48 #define TAG "SRM-PCONF"
50 static const uint16_t CBOR_SIZE = 1024;
51 static const uint64_t CBOR_MAX_SIZE = 4400;
52 static const uint8_t PCONF_MAP_SIZE = 4;
53 static const uint8_t PCONF_RESOURCE_MAP_SIZE = 3;
55 static OicSecPconf_t *gPconf = NULL;
56 static OCResourceHandle gPconfHandle = NULL;
57 static OicSecPconf_t gDefaultPconf =
60 NULL, /* OicSecPrm *prm */
61 0, /* size_t prmLen */
62 {.val = {0}}, /* OicDpPin_t pin */
63 NULL, /* OicSecPdAcl_t *pdacls */
64 NULL, /* OicUuid_t *pddevs */
65 0, /* size_t pddevLen */
66 {.id = {0}}, /* OicUuid_t deviceID */
67 {.id = {0}}, /* OicUuid_t rowner */
71 * This function frees OicSecPdAcl_t object's fields and object itself.
73 void FreePdAclList(OicSecPdAcl_t* pdacls)
80 OicSecPdAcl_t *aclTmp1 = NULL;
81 OicSecPdAcl_t *aclTmp2 = NULL;
82 LL_FOREACH_SAFE(pdacls, aclTmp1, aclTmp2)
84 LL_DELETE(pdacls, aclTmp1);
87 for (i = 0; i < aclTmp1->resourcesLen; i++)
89 OICFree(aclTmp1->resources[i]);
91 OICFree(aclTmp1->resources);
96 for(i = 0; i < aclTmp1->prdRecrLen; i++)
98 OICFree(aclTmp1->periods[i]);
100 OICFree(aclTmp1->periods);
104 if(aclTmp1->recurrences)
106 for(i = 0; i < aclTmp1->prdRecrLen; i++)
108 OICFree(aclTmp1->recurrences[i]);
110 OICFree(aclTmp1->recurrences);
119 void DeletePconfBinData(OicSecPconf_t* pconf)
129 FreePdAclList(pconf->pdacls);
133 OICFree(pconf->pddevs);
140 static size_t OicPdAclSize(const OicSecPdAcl_t *pdAcl)
147 OicSecPdAcl_t *tmp = (OicSecPdAcl_t *)pdAcl;
157 OCStackResult PconfToCBORPayload(const OicSecPconf_t *pconf,uint8_t **payload,size_t *size)
159 if (NULL == pconf || NULL == payload || NULL != *payload || NULL == size)
161 return OC_STACK_INVALID_PARAM;
163 size_t cborLen = *size;
170 OCStackResult ret = OC_STACK_ERROR;
171 CborEncoder encoder = { {.ptr = NULL}, .end = 0};
172 CborEncoder pconfMap = { {.ptr = NULL}, .end = 0};
174 int64_t cborEncoderResult = CborNoError;
175 uint8_t mapSize = PCONF_MAP_SIZE;
177 if (pconf->prmLen > 0)
190 uint8_t *outPayload = (uint8_t *)OICCalloc(1, cborLen);
191 VERIFY_NON_NULL(TAG, outPayload, ERROR);
193 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
194 cborEncoderResult = cbor_encoder_create_map(&encoder, &pconfMap, mapSize);
195 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Creating Pconf Map.");
198 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_EDP_NAME,
199 strlen(OIC_JSON_EDP_NAME));
200 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Encode EDP String.");
201 cborEncoderResult = cbor_encode_boolean(&pconfMap, pconf->edp);
202 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Convert PconfEDP value");
204 //PRM type -- Not Mandatory
205 if(pconf->prmLen > 0)
207 CborEncoder prm = { {.ptr = NULL }, .end = 0 };
208 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_PRM_NAME,
209 strlen(OIC_JSON_PRM_NAME));
210 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Convert Pconf PRM NAME");
211 cborEncoderResult = cbor_encoder_create_array(&pconfMap, &prm, pconf->prmLen);
212 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Convert Pconf PRM value");
214 for (size_t i = 0; i < pconf->prmLen; i++)
216 cborEncoderResult = cbor_encode_int(&prm, pconf->prm[i]);
217 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Convert Pconf PRM Array");
219 cborEncoderResult = cbor_encoder_close_container(&pconfMap, &prm);
220 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close encode array");
224 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_PIN_NAME,
225 strlen(OIC_JSON_PIN_NAME));
226 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create OIC_JSON_PIN_NAME");
227 cborEncoderResult = cbor_encode_byte_string(&pconfMap, pconf->pin.val, sizeof(pconf->pin.val));
228 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to convert pin value");
233 OicSecPdAcl_t *pdacl = pconf->pdacls;
234 CborEncoder pdAclArray = {{.ptr = NULL }, .end = 0 };
235 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_PDACL_NAME,
236 strlen(OIC_JSON_PDACL_NAME));
237 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create OIC_JSON_PDACL_NAME");
238 cborEncoderResult = cbor_encoder_create_array(&pconfMap, &pdAclArray,
239 OicPdAclSize(pconf->pdacls));
240 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to creeate _pdacl array");
244 CborEncoder pdAclMap = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
245 // PDACL Map size - Number of mandatory items
246 uint8_t aclMapSize = 2;
248 if (pdacl->prdRecrLen)
252 if (pdacl->recurrences)
257 cborEncoderResult = cbor_encoder_create_map(&pdAclArray, &pdAclMap, aclMapSize);
258 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to creeate _pdacl array");
260 // Resources -- Mandatory
261 cborEncoderResult = cbor_encode_text_string(&pdAclMap, OIC_JSON_RESOURCES_NAME,
262 strlen(OIC_JSON_RESOURCES_NAME));
263 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode resource result");
265 CborEncoder resources = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
266 cborEncoderResult = cbor_encoder_create_array(&pdAclMap, &resources,
267 pdacl->resourcesLen);
268 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create resource array");
270 for (size_t i = 0; i < pdacl->resourcesLen; i++)
272 CborEncoder rMap = { {.ptr = NULL }, .end = 0 };
273 cborEncoderResult = cbor_encoder_create_map(&resources, &rMap,
274 PCONF_RESOURCE_MAP_SIZE);
275 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding Resource Map.");
277 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_HREF_NAME,
278 strlen(OIC_JSON_HREF_NAME));
279 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding HREF Name Tag.");
280 cborEncoderResult = cbor_encode_text_string(&rMap, pdacl->resources[i],
281 strlen(pdacl->resources[i]));
282 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding HREF Value in Map.");
284 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_RT_NAME,
285 strlen(OIC_JSON_RT_NAME));
286 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
288 // TODO : Need to assign real value of RT
289 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_EMPTY_STRING,
290 strlen(OIC_JSON_EMPTY_STRING));
291 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
293 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_IF_NAME,
294 strlen(OIC_JSON_IF_NAME));
295 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
297 // TODO : Need to assign real value of IF
298 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_EMPTY_STRING,
299 strlen(OIC_JSON_EMPTY_STRING));
300 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
302 cborEncoderResult = cbor_encoder_close_container(&resources, &rMap);
303 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Resource Map.");
306 cborEncoderResult = cbor_encoder_close_container(&pdAclMap, &resources);
307 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close resource array");
309 // Permissions -- Mandatory
310 cborEncoderResult = cbor_encode_text_string(&pdAclMap, OIC_JSON_PERMISSION_NAME,
311 strlen(OIC_JSON_PERMISSION_NAME));
312 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create permition string");
313 cborEncoderResult = cbor_encode_int(&pdAclMap, pdacl->permission);
314 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode permition calue");
316 // Period -- Not Mandatory
319 CborEncoder period = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
320 cborEncoderResult = cbor_encode_text_string(&pdAclMap, OIC_JSON_PERIODS_NAME,
321 strlen(OIC_JSON_PERIODS_NAME));
322 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode period value");
323 cborEncoderResult = cbor_encoder_create_array(&pdAclMap, &period,
325 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create array");
327 for (size_t i = 0; i < pdacl->prdRecrLen; i++)
329 cborEncoderResult = cbor_encode_text_string(&period, pdacl->periods[i],
330 strlen(pdacl->periods[i]));
331 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode period");
333 cborEncoderResult = cbor_encoder_close_container(&pdAclMap, &period);
334 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult,"Failed to close period array");
337 // Period -- Not Mandatory
338 if(0 != pdacl->prdRecrLen && pdacl->recurrences)
340 CborEncoder recurrences = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
341 cborEncoderResult = cbor_encode_text_string(&pdAclMap, OIC_JSON_RECURRENCES_NAME,
342 strlen(OIC_JSON_RECURRENCES_NAME));
343 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult,"Failed to encode recurrences");
344 cborEncoderResult = cbor_encoder_create_array(&pdAclMap, &recurrences,
346 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create rec array");
348 for (size_t i = 0; i < pdacl->prdRecrLen; i++)
350 cborEncoderResult = cbor_encode_text_string(&recurrences,
351 pdacl->recurrences[i], strlen(pdacl->recurrences[i]));
352 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode recurrences");
354 cborEncoderResult = cbor_encoder_close_container(&pdAclMap, &recurrences);
355 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close rec array");
357 cborEncoderResult = cbor_encoder_close_container(&pdAclArray, &pdAclMap);
358 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close acl map");
363 cborEncoderResult = cbor_encoder_close_container(&pconfMap, &pdAclArray);
364 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close acl array");
368 //There may not be paired devices if it did not pairing before
369 if (pconf->pddevs && 0 < pconf->pddevLen)
371 CborEncoder pddev = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
372 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_PDDEV_LIST_NAME,
373 strlen(OIC_JSON_PDDEV_LIST_NAME));
374 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode pddev");
375 cborEncoderResult = cbor_encoder_create_array(&pconfMap, &pddev, pconf->pddevLen);
376 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to create array");
378 for (size_t i = 0; i < pconf->pddevLen; i++)
380 char *pddevId = NULL;
381 ret = ConvertUuidToStr(&pconf->pddevs[i], &pddevId);
382 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
383 cborEncoderResult = cbor_encode_text_string(&pddev, pddevId, strlen(pddevId));
384 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding pddev Id Value.");
387 cborEncoderResult = cbor_encoder_close_container(&pconfMap, &pddev);
388 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close pddev array");
391 //DeviceId -- Mandatory
392 //There may not be devicd id if caller is provisoning tool
393 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_DEVICE_ID_NAME,
394 strlen(OIC_JSON_DEVICE_ID_NAME));
395 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode device id");
397 char *deviceId = NULL;
398 ret = ConvertUuidToStr(&pconf->deviceID, &deviceId);
399 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
400 cborEncoderResult = cbor_encode_text_string(&pconfMap, deviceId, strlen(deviceId));
401 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode deviceID value");
405 //ROwner -- Mandatory
406 cborEncoderResult = cbor_encode_text_string(&pconfMap, OIC_JSON_ROWNERID_NAME,
407 strlen(OIC_JSON_ROWNERID_NAME));
408 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode rowner string");
411 ret = ConvertUuidToStr(&pconf->rowner, &rowner);
412 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
413 cborEncoderResult = cbor_encode_text_string(&pconfMap, rowner, strlen(rowner));
414 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to encode rwoner value");
418 cborEncoderResult = cbor_encoder_close_container(&encoder, &pconfMap);
419 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed to close pconfMap");
421 *size = encoder.ptr - outPayload;
422 *payload = outPayload;
425 if ((CborErrorOutOfMemory == cborEncoderResult) && (cborLen < CBOR_MAX_SIZE))
427 // reallocate and try again!
429 // Since the allocated initial memory failed, double the memory.
430 cborLen += encoder.ptr - encoder.end;
431 cborEncoderResult = CborNoError;
432 ret = PconfToCBORPayload(pconf, payload, &cborLen);
435 if ((CborNoError != cborEncoderResult) || (OC_STACK_OK != ret))
441 ret = OC_STACK_ERROR;
446 OCStackResult CBORPayloadToPconf(const uint8_t *cborPayload, size_t size, OicSecPconf_t **secPconf)
448 if (NULL == cborPayload || NULL == secPconf || NULL != *secPconf || 0 == size)
450 return OC_STACK_INVALID_PARAM;
452 OCStackResult ret = OC_STACK_ERROR;
454 CborValue pconfCbor = { .parser = NULL };
455 CborParser parser = { .end = NULL };
456 CborError cborFindResult = CborNoError;
459 cbor_parser_init(cborPayload, cborLen, 0, &parser, &pconfCbor);
460 CborValue pconfMap = { .parser = NULL } ;
461 OicSecPconf_t *pconf = NULL;
462 cborFindResult = cbor_value_enter_container(&pconfCbor, &pconfMap);
463 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter map");
464 pconf = (OicSecPconf_t *)OICCalloc(1, sizeof(*pconf));
465 VERIFY_NON_NULL(TAG, pconf, ERROR);
466 while (cbor_value_is_valid(&pconfMap))
470 CborType type = cbor_value_get_type(&pconfMap);
471 if (type == CborTextStringType)
473 cborFindResult = cbor_value_dup_text_string(&pconfMap, &name, &len, NULL);
474 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
475 cborFindResult = cbor_value_advance(&pconfMap);
476 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance value");
482 if(0 == strcmp(OIC_JSON_EDP_NAME, name))
484 cborFindResult = cbor_value_get_boolean(&pconfMap, &pconf->edp);
485 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
487 if (0 == strcmp(OIC_JSON_PRM_NAME, name))
490 CborValue prm = { .parser = NULL };
491 cborFindResult = cbor_value_get_array_length(&pconfMap, &pconf->prmLen);
492 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get length");
493 VERIFY_SUCCESS(TAG, pconf->prmLen != 0, ERROR);
495 pconf->prm = (OicSecPrm_t *)OICCalloc(pconf->prmLen, sizeof(OicSecPrm_t));
496 VERIFY_NON_NULL(TAG, pconf->prm, ERROR);
497 cborFindResult = cbor_value_enter_container(&pconfMap, &prm);
498 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to eneter array");
500 while (cbor_value_is_valid(&prm))
502 cborFindResult = cbor_value_get_int(&prm, (int *)&pconf->prm[i++]);
503 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
504 cborFindResult = cbor_value_advance(&prm);
505 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance value");
509 if (0 == strcmp(OIC_JSON_PIN_NAME, name))
512 cborFindResult = cbor_value_dup_byte_string(&pconfMap, &pin, &len, NULL);
513 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
514 memcpy(pconf->pin.val, pin, len);
519 if (0 == strcmp(OIC_JSON_PDACL_NAME, name))
521 CborValue pdAclArray = { .parser = NULL};
522 OicSecPdAcl_t *headPdacl = NULL;
524 cborFindResult = cbor_value_enter_container(&pconfMap, &pdAclArray);
525 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter");
527 while (cbor_value_is_valid(&pdAclArray))
529 CborValue pdAclMap = { .parser = NULL};
530 OicSecPdAcl_t *pdacl = (OicSecPdAcl_t *) OICCalloc(1, sizeof(OicSecPdAcl_t));
531 VERIFY_NON_NULL(TAG, pdacl, ERROR);
533 cborFindResult = cbor_value_enter_container(&pdAclArray, &pdAclMap);
534 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter");
536 while (cbor_value_is_valid(&pdAclMap))
540 CborType type = cbor_value_get_type(&pdAclMap);
541 if (type == CborTextStringType)
543 cborFindResult = cbor_value_dup_text_string(&pdAclMap, &name,
545 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get text");
546 cborFindResult = cbor_value_advance(&pdAclMap);
547 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance value");
551 // Resources -- Mandatory
552 if (strcmp(name, OIC_JSON_RESOURCES_NAME) == 0)
555 CborValue resources = { .parser = NULL };
556 cborFindResult = cbor_value_get_array_length(&pdAclMap,
557 &pdacl->resourcesLen);
558 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get length");
559 cborFindResult = cbor_value_enter_container(&pdAclMap, &resources);
560 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter");
561 pdacl->resources = (char **) OICCalloc(pdacl->resourcesLen,
563 VERIFY_NON_NULL(TAG, pdacl->resources, ERROR);
565 while (cbor_value_is_valid(&resources))
567 CborValue rMap = { .parser = NULL };
568 cborFindResult = cbor_value_enter_container(&resources, &rMap);
569 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering Resource Map");
571 while(cbor_value_is_valid(&rMap))
573 char *rMapName = NULL;
574 size_t rMapNameLen = 0;
575 cborFindResult = cbor_value_dup_text_string(&rMap, &rMapName, &rMapNameLen, NULL);
576 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RMap Data Name Tag.");
577 cborFindResult = cbor_value_advance(&rMap);
578 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RMap Data Value.");
581 if (0 == strcmp(OIC_JSON_HREF_NAME, rMapName))
583 // TODO : Need to check data structure of OicSecPdAcl_t based on RAML spec.
584 cborFindResult = cbor_value_dup_text_string(&rMap, &pdacl->resources[i++], &len, NULL);
585 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Href Value.");
589 if (0 == strcmp(OIC_JSON_RT_NAME, rMapName))
591 // TODO : Need to check data structure of OicSecPdAcl_t and assign based on RAML spec.
593 cborFindResult = cbor_value_dup_text_string(&rMap, &rtData, &len, NULL);
594 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RT Value.");
599 if (0 == strcmp(OIC_JSON_IF_NAME, rMapName))
601 // TODO : Need to check data structure of OicSecPdAcl_t and assign based on RAML spec.
603 cborFindResult = cbor_value_dup_text_string(&rMap, &ifData, &len, NULL);
604 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding IF Value.");
608 if (cbor_value_is_valid(&rMap))
610 cborFindResult = cbor_value_advance(&rMap);
611 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Rlist Map.");
616 if (cbor_value_is_valid(&resources))
618 cborFindResult = cbor_value_advance(&resources);
619 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
624 // Permissions -- Mandatory
625 if (strcmp(name, OIC_JSON_PERMISSION_NAME) == 0)
627 cborFindResult = cbor_value_get_uint64(&pdAclMap,
628 (uint64_t *) &pdacl->permission);
629 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
632 // Period -- Not mandatory
633 if (strcmp(name, OIC_JSON_PERIODS_NAME) == 0)
636 CborValue period = { .parser = NULL };
637 cborFindResult = cbor_value_get_array_length(&pdAclMap,
639 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get length");
640 cborFindResult = cbor_value_enter_container(&pdAclMap, &period);
641 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter");
642 pdacl->periods = (char **) OICCalloc(pdacl->prdRecrLen, sizeof(char*));
643 VERIFY_NON_NULL(TAG, pdacl->periods, ERROR);
645 while (cbor_value_is_text_string(&period))
647 cborFindResult = cbor_value_dup_text_string(&period,
648 &pdacl->periods[i++], &len, NULL);
649 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get text");
650 cborFindResult = cbor_value_advance(&period);
651 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
656 // Recurrence -- Not mandatory
657 if (strcmp(name, OIC_JSON_RECURRENCES_NAME) == 0)
660 CborValue recurrences = { .parser = NULL };
661 cborFindResult = cbor_value_get_array_length(&pdAclMap, &pdacl->prdRecrLen);
662 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get length");
663 cborFindResult = cbor_value_enter_container(&pdAclMap, &recurrences);
664 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter");
665 pdacl->recurrences = (char **) OICCalloc(pdacl->prdRecrLen, sizeof(char*));
666 VERIFY_NON_NULL(TAG, pdacl->recurrences, ERROR);
668 while (cbor_value_is_text_string(&recurrences))
670 cborFindResult = cbor_value_dup_text_string(&recurrences,
671 &pdacl->recurrences[i++], &len, NULL);
672 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
673 cborFindResult = cbor_value_advance(&recurrences);
674 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
677 if (type != CborMapType && cbor_value_is_valid(&pdAclMap))
679 cborFindResult = cbor_value_advance(&pdAclMap);
680 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
683 if (cbor_value_is_valid(&pdAclArray))
685 cborFindResult = cbor_value_advance(&pdAclArray);
686 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
692 if (headPdacl == NULL)
698 OicSecPdAcl_t *temp = headPdacl;
706 pconf->pdacls = headPdacl;
710 if (strcmp(name, OIC_JSON_PDDEV_LIST_NAME) == 0)
713 CborValue pddevs = { .parser = NULL };
714 cborFindResult = cbor_value_get_array_length(&pconfMap, &pconf->pddevLen);
715 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get length");
716 cborFindResult = cbor_value_enter_container(&pconfMap, &pddevs);
717 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to enter");
719 pconf->pddevs = (OicUuid_t *)OICMalloc(pconf->pddevLen * sizeof(OicUuid_t));
720 VERIFY_NON_NULL(TAG, pconf->pddevs, ERROR);
721 while (cbor_value_is_valid(&pddevs))
724 cborFindResult = cbor_value_dup_text_string(&pddevs, &pddev, &len, NULL);
725 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get value");
726 cborFindResult = cbor_value_advance(&pddevs);
727 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
728 ret = ConvertStrToUuid(pddev, &pconf->pddevs[i++]);
729 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
734 //Mandatory - Device Id
735 if (0 == strcmp(OIC_JSON_DEVICE_ID_NAME, name))
737 char *deviceId = NULL;
738 cborFindResult = cbor_value_dup_text_string(&pconfMap, &deviceId, &len, NULL);
739 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get deviceID");
740 ret = ConvertStrToUuid(deviceId, &pconf->deviceID);
741 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
745 // ROwner -- Mandatory
746 if (0 == strcmp(OIC_JSON_ROWNERID_NAME, name))
749 cborFindResult = cbor_value_dup_text_string(&pconfMap, &rowner, &len, NULL);
750 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get rowner");
751 ret = ConvertStrToUuid(rowner, &pconf->rowner);
752 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
756 if (CborMapType != type && cbor_value_is_valid(&pconfMap))
758 cborFindResult = cbor_value_advance(&pconfMap);
759 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance");
767 if (CborNoError != cborFindResult)
769 OIC_LOG (ERROR, TAG, "CBORPayloadToPconf failed");
770 DeletePconfBinData(pconf);
773 ret = OC_STACK_ERROR;
778 static bool UpdatePersistentStorage(const OicSecPconf_t * pconf)
782 // Convert PCONF data into Cborpayload for update to persistent storage
783 uint8_t *payload = NULL;
785 if (OC_STACK_OK == PconfToCBORPayload(pconf, &payload, &size) && NULL !=payload)
787 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_PCONF_NAME, payload, size))
796 static OCEntityHandlerResult HandlePconfGetRequest (const OCEntityHandlerRequest * ehRequest)
798 uint8_t* payload = NULL;
800 OCEntityHandlerResult ehRet = OC_EH_OK;
803 memset(&pconf, 0, sizeof(OicSecPconf_t));
805 OIC_LOG (DEBUG, TAG, "Pconf EntityHandle processing GET request");
807 if (true == GetDoxmResourceData()->dpc)
809 //Making response elements for Get request
810 if( (true == gPconf->edp) && (gPconf->prm && 0 < gPconf->prmLen) &&
811 (0 < strlen((const char*)gPconf->deviceID.id)) && (0 < strlen((const char*)gPconf->rowner.id)))
814 pconf.prm = gPconf->prm;
815 pconf.prmLen = gPconf->prmLen;
816 memcpy(&pconf.deviceID, &gPconf->deviceID, sizeof(OicUuid_t));
817 memcpy(&pconf.rowner, &gPconf->rowner, sizeof(OicUuid_t));
818 OIC_LOG (DEBUG, TAG, "PCONF - direct pairing enabled");
820 else if (false == gPconf->edp)
823 memcpy(&pconf.rowner, &gPconf->rowner, sizeof(OicUuid_t));
824 OIC_LOG (DEBUG, TAG, "PCONF - direct pairing disable");
829 OIC_LOG (DEBUG, TAG, "PCONF - error");
834 OIC_LOG (DEBUG, TAG, "DPC == false : Direct-Pairing Disabled");
838 if (OC_STACK_OK != PconfToCBORPayload(gPconf, &payload, &size))
843 if(OC_EH_OK == ehRet)
845 ehRet = (payload ? OC_EH_OK : OC_EH_ERROR);
854 // Send response payload to request originator
855 SendSRMCBORResponse(ehRequest, ehRet, payload, size);
856 OIC_LOG_V(DEBUG, TAG, "%s RetVal %d", __func__, ehRet);
861 static OCEntityHandlerResult HandlePconfPostRequest (const OCEntityHandlerRequest * ehRequest)
863 OCEntityHandlerResult ehRet = OC_EH_OK;
864 OCStackResult res=OC_STACK_OK;
865 OicSecPconf_t* newPconf = NULL;
867 if (true == GetDoxmResourceData()->dpc)
869 // Convert CBOR PCONF data into binary. This will also validate the PCONF data received.
870 uint8_t *payload = ((OCSecurityPayload *) ehRequest->payload)->securityData1;
871 size_t size = ((OCSecurityPayload *) ehRequest->payload)->payloadSize;
874 res = CBORPayloadToPconf(payload, size, &newPconf);
879 OIC_LOG (DEBUG, TAG, "DPC == false : Direct-Pairing Disabled");
883 if (newPconf && res == OC_STACK_OK)
885 // Check if valid Post request
886 if ((true == newPconf->edp) && (0 < newPconf->prmLen) &&
887 DP_PIN_LENGTH == sizeof((const char*)newPconf->pin.val))
889 OicSecPrm_t *oldPrm = gPconf->prm;
890 OicSecPdAcl_t *oldPdacl = gPconf->pdacls;
892 // Update local PCONF with new PCONF
894 memcpy(&gPconf->pin, &newPconf->pin, sizeof(OicDpPin_t));
895 gPconf->prm = newPconf->prm;
896 gPconf->prmLen = newPconf->prmLen;
897 gPconf->pdacls = newPconf->pdacls;
898 memcpy(&gPconf->rowner, &newPconf->rowner, sizeof(OicUuid_t));
900 // to delete old value(prm, pdacl)
901 newPconf->prm = oldPrm;
902 newPconf->pdacls = oldPdacl;
904 else if (false == newPconf->edp)
914 if(OC_EH_ERROR != ehRet && true == UpdatePersistentStorage(gPconf))
916 ehRet = OC_EH_RESOURCE_CREATED;
919 DeletePconfBinData(newPconf);
926 // Send payload to request originator
927 SendSRMCBORResponse(ehRequest, ehRet, NULL, 0);
929 OIC_LOG_V (DEBUG, TAG, "%s RetVal %d", __func__ , ehRet);
934 * This internal method is the entity handler for PCONF resources and
935 * will handle REST request (POST) for them.
937 OCEntityHandlerResult PconfEntityHandler (OCEntityHandlerFlag flag,
938 OCEntityHandlerRequest * ehRequest,
939 void* callbackParameter)
941 OIC_LOG(DEBUG, TAG, "Received request PconfEntityHandler");
942 (void)callbackParameter;
943 OCEntityHandlerResult ehRet = OC_EH_ERROR;
950 if (flag & OC_REQUEST_FLAG)
952 OIC_LOG (DEBUG, TAG, "Flag includes OC_REQUEST_FLAG");
953 switch (ehRequest->method)
956 ehRet = HandlePconfGetRequest(ehRequest);
960 ehRet = HandlePconfPostRequest(ehRequest);
968 SendSRMCBORResponse(ehRequest, ehRet, NULL, 0);
976 * This internal method is used to create '/oic/sec/pconf' resource.
978 OCStackResult CreatePconfResource()
982 ret = OCCreateResource(&gPconfHandle,
983 OIC_RSRC_TYPE_SEC_PCONF,
988 OC_SECURE | OC_EXPLICIT_DISCOVERABLE);
990 if (OC_STACK_OK != ret)
992 OIC_LOG (ERROR, TAG, "Unable to instantiate PCONF resource");
993 DeInitPconfResource();
999 * Get the default value.
1000 * @retval the gDefaultPconf pointer;
1002 static OicSecPconf_t* GetPconfDefault()
1004 OIC_LOG (DEBUG, TAG, "GetPconfDefault");
1006 return &gDefaultPconf;
1010 * This method is used by SRM to retrieve PCONF resource data..
1012 * @retval reference to @ref OicSecPconf_t, binary format of Pconf resource data
1014 const OicSecPconf_t* GetPconfResourceData()
1020 * Initialize PCONF resource by loading data from persistent storage.
1022 * @retval OC_STACK_OK for Success, otherwise some error value
1024 OCStackResult InitPconfResource()
1026 OCStackResult ret = OC_STACK_ERROR;
1028 uint8_t *data = NULL;
1031 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_PCONF_NAME, &data, &size);
1032 // If database read failed
1033 if (ret != OC_STACK_OK)
1035 OIC_LOG(DEBUG, TAG, "ReadSVDataFromPS failed");
1039 CBORPayloadToPconf(data, size, &gPconf);
1042 if (!data || !gPconf)
1044 gPconf = GetPconfDefault();
1046 // device id from doxm
1047 OicUuid_t deviceId = {.id = {0}};
1048 OCStackResult ret = GetDoxmDeviceID( &deviceId);
1049 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
1050 memcpy(&gPconf->deviceID, &deviceId, sizeof(OicUuid_t));
1052 VERIFY_NON_NULL(TAG, gPconf, ERROR);
1054 // Instantiate 'oic.sec.pconf'
1055 ret = CreatePconfResource();
1058 if (OC_STACK_OK != ret)
1060 DeInitPconfResource();
1067 * Perform cleanup for PCONF resources.
1070 * OC_STACK_OK - no error
1071 * OC_STACK_ERROR - stack process error
1074 OCStackResult DeInitPconfResource()
1076 OCStackResult ret = OCDeleteResource(gPconfHandle);
1077 if(gPconf!= &gDefaultPconf)
1079 DeletePconfBinData(gPconf);
1083 if(OC_STACK_OK == ret)
1089 return OC_STACK_ERROR;
1094 * This method might be used to add a paired device id after direct-pairing process complete.
1096 * @param pdeviceId ID of the paired device.
1098 * @retval OC_STACK_OK for Success, otherwise some error value
1100 OCStackResult AddPairedDevice(OicUuid_t *pdeviceId)
1102 if (!gPconf || !pdeviceId)
1104 return OC_STACK_INVALID_PARAM;
1108 OicUuid_t *prevList = gPconf->pddevs;
1109 gPconf->pddevs = (OicUuid_t *)OICCalloc(gPconf->pddevLen+1, sizeof(OicUuid_t));
1112 return OC_STACK_NO_MEMORY;
1114 for (size_t i=0; i<gPconf->pddevLen; i++)
1116 memcpy(&gPconf->pddevs[i], &prevList[i], sizeof(OicUuid_t));
1119 // add new paired device id
1120 memcpy(&gPconf->pddevs[gPconf->pddevLen], pdeviceId, sizeof(OicUuid_t));
1124 if(true != UpdatePersistentStorage(gPconf))
1126 OIC_LOG (ERROR, TAG, "Fail to update pconf resource");
1127 return OC_STACK_ERROR;
1130 OIC_LOG (ERROR, TAG, "Add paired device success");
1135 * This method might be used by PolicyEngine to retrieve PDACL for a Subject.
1137 * @param subjectId ID of the subject for which PDACL is required.
1138 * @param savePtr is used internally by @ref GetACLResourceData to maintain index between
1139 * successive calls for same subjectId.
1141 * @retval reference to @ref OicSecPdAcl_t if PDACL is found, else NULL
1143 const OicSecPdAcl_t* GetPdAclData(const OicUuid_t* subjectId, OicSecPdAcl_t **savePtr)
1145 OicSecPdAcl_t *pdacl = NULL;
1147 if ( NULL == subjectId)
1153 * savePtr MUST point to NULL if this is the 'first' call to retrieve PDACL for
1156 if (NULL == *savePtr)
1158 pdacl = gPconf->pdacls;
1160 // Find if 'subjectID' is in paired device list.
1161 for(size_t i=0; i<gPconf->pddevLen; i++)
1163 if (memcmp(&(gPconf->pddevs[i]), subjectId, sizeof(OicUuid_t)) == 0)
1172 OicSecPdAcl_t *temp = NULL;
1175 * If this is a 'successive' call, search for location pointed by
1176 * savePtr and assign 'begin' to the next PDACL after it in the linked
1177 * list and start searching from there.
1179 LL_FOREACH(gPconf->pdacls, temp)
1181 if (temp == *savePtr)
1190 // Cleanup in case no PDACL is found
1196 * This method return whether device is paired or not.
1198 * @param pdeviceId Target device ID to find in paired list.
1199 * @retval ture if device is already paired, else false
1201 bool IsPairedDevice(const OicUuid_t* pdeviceId)
1203 // Find if 'pdeviceId' is in paired device list.
1204 for(size_t i=0; i<gPconf->pddevLen; i++)
1206 if (memcmp(&(gPconf->pddevs[i]), pdeviceId, sizeof(OicUuid_t)) == 0)