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 #include "iotivity_config.h"
24 #elif defined(HAVE_STRINGS_H)
32 #include "ocserverrequest.h"
33 #include "oic_malloc.h"
34 #include "oic_string.h"
36 #include "ocpayload.h"
38 #include "payload_logging.h"
39 #include "srmresourcestrings.h"
40 #include "aclresource.h"
41 #include "doxmresource.h"
42 #include "resourcemanager.h"
43 #include "srmutility.h"
44 #include "psinterface.h"
45 #include "ocpayloadcbor.h"
47 #include "security_internals.h"
50 #define NUMBER_OF_SEC_PROV_RSCS 4
51 #define NUMBER_OF_DEFAULT_SEC_RSCS 2
52 #define STRING_UUID_SIZE (UUID_LENGTH * 2 + 5)
54 static const uint8_t ACL_MAP_SIZE = 4;
55 static const uint8_t ACL_ACLIST_MAP_SIZE = 1;
56 static const uint8_t ACL_ACES_MAP_SIZE = 3;
57 static const uint8_t ACL_RESOURCE_MAP_SIZE = 3;
60 // CborSize is the default cbor payload size being used.
61 static const uint16_t CBOR_SIZE = 2048*8;
63 static OicSecAcl_t *gAcl = NULL;
64 static OCResourceHandle gAclHandle = NULL;
66 void FreeRsrc(OicSecRsrc_t *rsrc)
68 //Clean each member of resource
72 if(0 < rsrc->typeLen && rsrc->types)
74 for(size_t i = 0; i < rsrc->typeLen; i++)
76 OICFree(rsrc->types[i]);
82 if(0 < rsrc->interfaceLen && rsrc->interfaces)
84 for(size_t i = 0; i < rsrc->interfaceLen; i++)
86 OICFree(rsrc->interfaces[i]);
88 OICFree(rsrc->interfaces);
89 rsrc->interfaces = NULL;
96 * This function frees OicSecAcl_t object's fields and object itself.
98 static void FreeACE(OicSecAce_t *ace)
102 OIC_LOG(ERROR, TAG, "Invalid Parameter");
107 OicSecRsrc_t* rsrc = NULL;
108 OicSecRsrc_t* tmpRsrc = NULL;
109 LL_FOREACH_SAFE(ace->resources, rsrc, tmpRsrc)
111 LL_DELETE(ace->resources, rsrc);
116 OicSecValidity_t *validity = NULL;
117 OicSecValidity_t *tmpValidity = NULL;
118 LL_FOREACH_SAFE(ace->validities, validity, tmpValidity)
120 LL_DELETE(ace->validities, validity);
123 OICFree(validity->period);
126 for(size_t i = 0; i < validity->recurrenceLen; i++)
128 OICFree(validity->recurrences[i]);
130 OICFree(validity->recurrences);
140 void DeleteACLList(OicSecAcl_t* acl)
144 OicSecAce_t *ace = NULL;
145 OicSecAce_t *tmpAce = NULL;
146 LL_FOREACH_SAFE(acl->aces, ace, tmpAce)
148 LL_DELETE(acl->aces, ace);
156 OicSecAce_t* DuplicateACE(const OicSecAce_t* ace)
158 OicSecAce_t* newAce = NULL;
159 size_t allocateSize = 0;
163 newAce = (OicSecAce_t*)OICCalloc(1, sizeof(OicSecAce_t));
164 VERIFY_NON_NULL(TAG, newAce, ERROR);
167 memcpy(&newAce->subjectuuid, &ace->subjectuuid, sizeof(OicUuid_t));
169 OicSecRsrc_t* rsrc = NULL;
170 LL_FOREACH(ace->resources, rsrc)
172 OicSecRsrc_t* newRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
173 VERIFY_NON_NULL(TAG, newRsrc, ERROR);
174 LL_APPEND(newAce->resources, newRsrc);
177 VERIFY_NON_NULL(TAG, rsrc->href, ERROR);
178 allocateSize = strlen(rsrc->href) + 1;
179 newRsrc->href = (char*)OICMalloc(sizeof(char) * allocateSize);
180 VERIFY_NON_NULL(TAG, newRsrc->href, ERROR);
181 OICStrcpy(newRsrc->href, allocateSize, rsrc->href);
185 allocateSize = strlen(rsrc->rel) + 1;
186 newRsrc->rel = (char*)OICMalloc(sizeof(char) * allocateSize);
187 VERIFY_NON_NULL(TAG, newRsrc->rel, ERROR);
188 OICStrcpy(newRsrc->rel, allocateSize, rsrc->rel);
191 if(rsrc->types && 0 < rsrc->typeLen)
193 newRsrc->typeLen = rsrc->typeLen;
194 newRsrc->types = (char**)OICCalloc(rsrc->typeLen, sizeof(char*));
195 VERIFY_NON_NULL(TAG, (newRsrc->types), ERROR);
196 for(size_t i = 0; i < rsrc->typeLen; i++)
198 newRsrc->types[i] = OICStrdup(rsrc->types[i]);
199 VERIFY_NON_NULL(TAG, (newRsrc->types[i]), ERROR);
203 if(rsrc->interfaces && 0 < rsrc->interfaceLen)
205 newRsrc->interfaceLen = rsrc->interfaceLen;
206 newRsrc->interfaces = (char**)OICCalloc(rsrc->interfaceLen, sizeof(char*));
207 VERIFY_NON_NULL(TAG, (newRsrc->interfaces), ERROR);
208 for(size_t i = 0; i < rsrc->interfaceLen; i++)
210 newRsrc->interfaces[i] = OICStrdup(rsrc->interfaces[i]);
211 VERIFY_NON_NULL(TAG, (newRsrc->interfaces[i]), ERROR);
217 newAce->permission = ace->permission;
222 OicSecValidity_t* validity = NULL;
223 LL_FOREACH(ace->validities, validity)
225 OicSecValidity_t* newValidity = (OicSecValidity_t*)OICCalloc(1, sizeof(OicSecValidity_t));
226 VERIFY_NON_NULL(TAG, newValidity, ERROR);
227 LL_APPEND(newAce->validities, newValidity);
231 allocateSize = strlen(validity->period) + 1;
232 newValidity->period = (char*)OICMalloc(sizeof(char) * allocateSize);
233 VERIFY_NON_NULL(TAG, newValidity->period, ERROR);
234 OICStrcpy(newValidity->period, allocateSize, validity->period);
237 if(validity->recurrences && 0 < validity->recurrenceLen)
239 newValidity->recurrenceLen = validity->recurrenceLen;
241 newValidity->recurrences = (char**)OICMalloc(sizeof(char*) * validity->recurrenceLen);
242 VERIFY_NON_NULL(TAG, newValidity->recurrences, ERROR);
244 for(size_t i = 0; i < validity->recurrenceLen; i++)
246 allocateSize = strlen(validity->recurrences[i]) + 1;
247 newValidity->recurrences[i] = (char*)OICMalloc(sizeof(char) * allocateSize);
248 VERIFY_NON_NULL(TAG, (newValidity->recurrences[i]), ERROR);
249 OICStrcpy(newValidity->recurrences[i], allocateSize, validity->recurrences[i]);
265 static size_t OicSecAclSize(const OicSecAcl_t *secAcl)
271 OicSecAce_t *ace= (OicSecAce_t *)secAcl->aces;
281 OCStackResult AclToCBORPayload(const OicSecAcl_t *secAcl, uint8_t **payload, size_t *size)
283 if (NULL == secAcl || NULL == payload || NULL != *payload || NULL == size)
285 return OC_STACK_INVALID_PARAM;
288 OCStackResult ret = OC_STACK_ERROR;
289 CborError cborEncoderResult = CborNoError;
290 OicSecAcl_t *acl = (OicSecAcl_t *)secAcl;
291 OicSecAce_t* ace = NULL;
294 CborEncoder aclListMap;
295 CborEncoder acesArray;
296 uint8_t *outPayload = NULL;
297 size_t cborLen = *size;
306 outPayload = (uint8_t *)OICCalloc(1, cborLen);
307 VERIFY_NON_NULL(TAG, outPayload, ERROR);
308 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
310 // Create ACL Map (aclist, rownerid)
311 cborEncoderResult = cbor_encoder_create_map(&encoder, &aclMap, ACL_MAP_SIZE);
312 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Creating ACL Map.");
314 cborEncoderResult = cbor_encode_text_string(&aclMap, OIC_JSON_ACLIST_NAME,
315 strlen(OIC_JSON_ACLIST_NAME));
316 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding aclist Name Tag.");
318 // Create ACLIST Map (aces)
319 cborEncoderResult = cbor_encoder_create_map(&aclMap, &aclListMap, ACL_ACLIST_MAP_SIZE);
320 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Creating ACLIST Map.");
322 cborEncoderResult = cbor_encode_text_string(&aclListMap, OIC_JSON_ACES_NAME,
323 strlen(OIC_JSON_ACES_NAME));
324 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ACES Name Tag.");
327 cborEncoderResult = cbor_encoder_create_array(&aclListMap, &acesArray, OicSecAclSize(secAcl));
328 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Creating ACES Array.");
331 LL_FOREACH (acl->aces, ace)
333 CborEncoder oicSecAclMap;
334 // ACL Map size - Number of mandatory items
335 uint8_t aclMapSize = ACL_ACES_MAP_SIZE;
338 OicSecValidity_t* validityElts = ace->validities;
341 if(validityElts->period)
345 if(validityElts->recurrences)
351 cborEncoderResult = cbor_encoder_create_map(&acesArray, &oicSecAclMap, aclMapSize);
352 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Creating ACES Map");
354 // Subject -- Mandatory
355 cborEncoderResult = cbor_encode_text_string(&oicSecAclMap, OIC_JSON_SUBJECTID_NAME,
356 strlen(OIC_JSON_SUBJECTID_NAME));
357 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Subject Name Tag.");
358 inLen = (memcmp(&(ace->subjectuuid), &WILDCARD_SUBJECT_ID, sizeof(OicUuid_t)) == 0) ?
359 WILDCARD_SUBJECT_ID_LEN : sizeof(OicUuid_t);
360 if(inLen == WILDCARD_SUBJECT_ID_LEN)
362 cborEncoderResult = cbor_encode_text_string(&oicSecAclMap, WILDCARD_RESOURCE_URI,
363 strlen(WILDCARD_RESOURCE_URI));
364 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding Subject Id wildcard Value.");
368 char *subject = NULL;
369 ret = ConvertUuidToStr(&ace->subjectuuid, &subject);
370 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
371 cborEncoderResult = cbor_encode_text_string(&oicSecAclMap, subject, strlen(subject));
372 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding Subject UUID Value.");
378 CborEncoder resources;
379 cborEncoderResult = cbor_encode_text_string(&oicSecAclMap, OIC_JSON_RESOURCES_NAME,
380 strlen(OIC_JSON_RESOURCES_NAME));
381 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Resource Name Tag.");
384 OicSecRsrc_t* rsrcElts = NULL;
385 LL_FOREACH(ace->resources, rsrcElts)
390 cborEncoderResult = cbor_encoder_create_array(&oicSecAclMap, &resources, rsrcLen);
391 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Resource Name Array.");
393 OicSecRsrc_t* rsrc = NULL;
394 LL_FOREACH(ace->resources, rsrc)
398 size_t rsrcMapSize = ACL_RESOURCE_MAP_SIZE;
404 cborEncoderResult = cbor_encoder_create_map(&resources, &rMap, rsrcMapSize);
405 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding Resource Map.");
408 VERIFY_NON_NULL(TAG, rsrc->href, ERROR);
409 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_HREF_NAME,
410 strlen(OIC_JSON_HREF_NAME));
411 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding HREF Name Tag.");
412 cborEncoderResult = cbor_encode_text_string(&rMap, rsrc->href, strlen(rsrc->href));
413 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding HREF Value in Map.");
415 //resource type -- Mandatory
416 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_RT_NAME,
417 strlen(OIC_JSON_RT_NAME));
418 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
420 CborEncoder resourceTypes;
421 cborEncoderResult = cbor_encoder_create_array(&rMap, &resourceTypes, rsrc->typeLen);
422 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding RT Array.");
423 for(size_t i = 0; i < rsrc->typeLen; i++)
425 cborEncoderResult = cbor_encode_text_string(&resourceTypes, rsrc->types[i], strlen(rsrc->types[i]));
426 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
428 cborEncoderResult = cbor_encoder_close_container(&rMap, &resourceTypes);
429 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing resourceTypes.");
431 //interface -- Mandatory
432 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_IF_NAME,
433 strlen(OIC_JSON_IF_NAME));
434 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
436 CborEncoder interfaces;
437 cborEncoderResult = cbor_encoder_create_array(&rMap, &interfaces, rsrc->interfaceLen);
438 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding IF Array.");
439 for(size_t i = 0; i < rsrc->interfaceLen; i++)
441 cborEncoderResult = cbor_encode_text_string(&interfaces, rsrc->interfaces[i], strlen(rsrc->interfaces[i]));
442 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
444 cborEncoderResult = cbor_encoder_close_container(&rMap, &interfaces);
445 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing interfaces.");
450 cborEncoderResult = cbor_encode_text_string(&rMap, OIC_JSON_REL_NAME,
451 strlen(OIC_JSON_REL_NAME));
452 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding REL Name Tag.");
453 cborEncoderResult = cbor_encode_text_string(&rMap, rsrc->rel, strlen(rsrc->rel));
454 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding REL Value.");
457 cborEncoderResult = cbor_encoder_close_container(&resources, &rMap);
458 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Resource Map.");
460 cborEncoderResult = cbor_encoder_close_container(&oicSecAclMap, &resources);
461 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Resource Name Array.");
464 // Permissions -- Mandatory
465 cborEncoderResult = cbor_encode_text_string(&oicSecAclMap, OIC_JSON_PERMISSION_NAME,
466 strlen(OIC_JSON_PERMISSION_NAME));
467 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Permission Name Tag.");
468 cborEncoderResult = cbor_encode_int(&oicSecAclMap, ace->permission);
469 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Permission Name Value.");
471 // TODO: Need to verfication for validity
472 // Validity(Time-interval) -- Not Mandatory
475 size_t validityLen = 0;
477 LL_FOREACH(ace->validities, validityElts)
482 CborEncoder validities;
483 cborEncoderResult = cbor_encode_text_string(&oicSecAclMap, OIC_JSON_VALIDITY_NAME,
484 strlen(OIC_JSON_VALIDITY_NAME));
485 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Validity Tag.");
486 cborEncoderResult = cbor_encoder_create_array(&oicSecAclMap, &validities, validityLen);
487 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Validities Array.");
489 //How to add the value w/o "title" using tinycobr...? :(
492 LL_FOREACH(ace->validities, validityElts)
494 CborEncoder validity;
495 size_t validitySize = 0;
496 if(validityElts->period)
500 if(validityElts->recurrences)
505 cborEncoderResult = cbor_encoder_create_array(&validities, &validity, validitySize);
506 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Validity Array.");
509 if (validityElts->period)
511 cborEncoderResult = cbor_encode_text_string(&validity, validityElts->period,
512 strlen(validityElts->period));
513 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Period Value.");
517 if (validityElts->recurrences)
519 CborEncoder recurrences;
520 cborEncoderResult = cbor_encoder_create_array(&validity, &recurrences, validityElts->recurrenceLen);
521 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Recurrence Array.");
523 for (size_t i = 0; i < validityElts->recurrenceLen; i++)
525 cborEncoderResult = cbor_encode_text_string(&recurrences, validityElts->recurrences[i],
526 strlen(validityElts->recurrences[i]));
527 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Recurrence Array Value.");
529 cborEncoderResult = cbor_encoder_close_container(&validity, &recurrences);
530 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Recurrence Array");
533 cborEncoderResult = cbor_encoder_close_container(&validities, &validity);
534 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Validity Array.");
537 cborEncoderResult = cbor_encoder_close_container(&oicSecAclMap, &validities);
538 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Validities Array.");
541 cborEncoderResult = cbor_encoder_close_container(&acesArray, &oicSecAclMap);
542 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing ACES Map.");
546 cborEncoderResult = cbor_encoder_close_container(&aclListMap, &acesArray);
547 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing ACES Array.");
550 cborEncoderResult = cbor_encoder_close_container(&aclMap, &aclListMap);
551 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing ACLIST Map.");
556 cborEncoderResult = cbor_encode_text_string(&aclMap, OIC_JSON_ROWNERID_NAME,
557 strlen(OIC_JSON_ROWNERID_NAME));
558 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding rownerid Name.");
559 ret = ConvertUuidToStr(&secAcl->rownerID, &rowner);
560 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
561 cborEncoderResult = cbor_encode_text_string(&aclMap, rowner, strlen(rowner));
562 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding rownerid Value.");
568 cborEncoderResult = cbor_encode_text_string(&aclMap, OIC_JSON_RT_NAME,
569 strlen(OIC_JSON_RT_NAME));
570 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
571 cborEncoderResult = cbor_encoder_create_array(&aclMap, &rtArray, 1);
572 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
573 for (size_t i = 0; i < 1; i++)
575 cborEncoderResult = cbor_encode_text_string(&rtArray, OIC_RSRC_TYPE_SEC_ACL,
576 strlen(OIC_RSRC_TYPE_SEC_ACL));
577 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding RT Value.");
579 cborEncoderResult = cbor_encoder_close_container(&aclMap, &rtArray);
580 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing RT.");
584 cborEncoderResult = cbor_encode_text_string(&aclMap, OIC_JSON_IF_NAME,
585 strlen(OIC_JSON_IF_NAME));
586 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
587 cborEncoderResult = cbor_encoder_create_array(&aclMap, &ifArray, 1);
588 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
589 for (size_t i = 0; i < 1; i++)
591 cborEncoderResult = cbor_encode_text_string(&ifArray, OC_RSRVD_INTERFACE_DEFAULT,
592 strlen(OC_RSRVD_INTERFACE_DEFAULT));
593 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding IF Value.");
595 cborEncoderResult = cbor_encoder_close_container(&aclMap, &ifArray);
596 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing IF.");
599 cborEncoderResult = cbor_encoder_close_container(&encoder, &aclMap);
600 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing ACL Map.");
602 if (CborNoError == cborEncoderResult)
604 OIC_LOG(DEBUG, TAG, "AclToCBORPayload Successed");
605 *size = encoder.ptr - outPayload;
606 *payload = outPayload;
610 if (CborErrorOutOfMemory == cborEncoderResult)
612 OIC_LOG(DEBUG, TAG, "AclToCBORPayload:CborErrorOutOfMemory : retry with more memory");
614 // reallocate and try again!
616 // Since the allocated initial memory failed, double the memory.
617 cborLen += encoder.ptr - encoder.end;
618 cborEncoderResult = CborNoError;
619 ret = AclToCBORPayload(secAcl, payload, &cborLen);
622 else if (cborEncoderResult != CborNoError)
624 OIC_LOG(ERROR, TAG, "Failed to AclToCBORPayload");
629 ret = OC_STACK_ERROR;
635 // This function converts CBOR format to ACL data.
636 // Caller needs to invoke 'free' when done using
637 // It parses { "aclist" : [ { ... } ] } instead of { "aclist" : { "aces" : [ ] } }
638 OicSecAcl_t* CBORPayloadToAcl2(const uint8_t *cborPayload, const size_t size)
640 if (NULL == cborPayload || 0 == size)
644 OCStackResult ret = OC_STACK_ERROR;
645 CborValue aclCbor = { .parser = NULL };
646 CborParser parser = { .end = NULL };
647 CborError cborFindResult = CborNoError;
648 cbor_parser_init(cborPayload, size, 0, &parser, &aclCbor);
650 OicSecAcl_t *acl = (OicSecAcl_t *) OICCalloc(1, sizeof(OicSecAcl_t));
653 CborValue aclMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
654 cborFindResult = cbor_value_enter_container(&aclCbor, &aclMap);
655 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACL Map.");
657 while (cbor_value_is_valid(&aclMap))
659 char* tagName = NULL;
661 CborType type = cbor_value_get_type(&aclMap);
662 if (type == CborTextStringType)
664 cborFindResult = cbor_value_dup_text_string(&aclMap, &tagName, &len, NULL);
665 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in ACL Map.");
666 cborFindResult = cbor_value_advance(&aclMap);
667 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in ACL Map.");
671 if (strcmp(tagName, OIC_JSON_ACLIST_NAME) == 0)
674 CborValue acesArray = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
675 cborFindResult = cbor_value_enter_container(&aclMap, &acesArray);
676 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACES Array.");
679 while (cbor_value_is_valid(&acesArray))
682 CborValue aceMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
683 cborFindResult = cbor_value_enter_container(&acesArray, &aceMap);
684 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACE Map.");
686 OicSecAce_t *ace = NULL;
687 ace = (OicSecAce_t *) OICCalloc(1, sizeof(OicSecAce_t));
688 VERIFY_NON_NULL(TAG, ace, ERROR);
689 LL_APPEND(acl->aces, ace);
691 VERIFY_NON_NULL(TAG, acl, ERROR);
693 while (cbor_value_is_valid(&aceMap))
697 CborType type = cbor_value_get_type(&aceMap);
698 if (type == CborTextStringType)
700 cborFindResult = cbor_value_dup_text_string(&aceMap, &name, &len, NULL);
701 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in ACE Map.");
702 cborFindResult = cbor_value_advance(&aceMap);
703 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in ACE Map.");
707 // Subject -- Mandatory
708 if (strcmp(name, OIC_JSON_SUBJECTID_NAME) == 0)
710 char *subject = NULL;
711 cborFindResult = cbor_value_dup_text_string(&aceMap, &subject, &len, NULL);
712 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding subject Value.");
713 if(strcmp(subject, WILDCARD_RESOURCE_URI) == 0)
715 ace->subjectuuid.id[0] = '*';
719 OIC_LOG_V(DEBUG, TAG, "Converting subjectuuid = %s to uuid...", subject);
720 ret = ConvertStrToUuid(subject, &ace->subjectuuid);
721 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
726 // Resources -- Mandatory
727 if (strcmp(name, OIC_JSON_RESOURCES_NAME) == 0)
729 CborValue resources = { .parser = NULL };
730 cborFindResult = cbor_value_enter_container(&aceMap, &resources);
731 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering a Resource Array.");
733 while (cbor_value_is_valid(&resources))
736 CborValue rMap = { .parser = NULL };
737 cborFindResult = cbor_value_enter_container(&resources, &rMap);
738 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering Resource Map");
740 OicSecRsrc_t* rsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
741 VERIFY_NON_NULL(TAG, rsrc, ERROR);
742 LL_APPEND(ace->resources, rsrc);
744 while(cbor_value_is_valid(&rMap))
746 char *rMapName = NULL;
747 size_t rMapNameLen = 0;
748 cborFindResult = cbor_value_dup_text_string(&rMap, &rMapName, &rMapNameLen, NULL);
749 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RMap Data Name Tag.");
750 cborFindResult = cbor_value_advance(&rMap);
751 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RMap Data Value.");
754 if (0 == strcmp(OIC_JSON_HREF_NAME, rMapName))
756 cborFindResult = cbor_value_dup_text_string(&rMap, &rsrc->href, &len, NULL);
757 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Href Value.");
761 if (0 == strcmp(OIC_JSON_RT_NAME, rMapName) && cbor_value_is_array(&rMap))
763 cbor_value_get_array_length(&rMap, &rsrc->typeLen);
764 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RT array length.");
765 VERIFY_SUCCESS(TAG, (0 != rsrc->typeLen), ERROR);
767 rsrc->types = (char**)OICCalloc(rsrc->typeLen, sizeof(char*));
768 VERIFY_NON_NULL(TAG, rsrc->types, ERROR);
770 CborValue resourceTypes;
771 cborFindResult = cbor_value_enter_container(&rMap, &resourceTypes);
772 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering RT Array.");
774 for(size_t i = 0; cbor_value_is_valid(&resourceTypes) && cbor_value_is_text_string(&resourceTypes); i++)
777 cborFindResult = cbor_value_dup_text_string(&resourceTypes, &(rsrc->types[i]), &readLen, NULL);
778 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding resource type.");
779 cborFindResult = cbor_value_advance(&resourceTypes);
780 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing resource type.");
785 if (0 == strcmp(OIC_JSON_IF_NAME, rMapName) && cbor_value_is_array(&rMap))
787 cbor_value_get_array_length(&rMap, &rsrc->interfaceLen);
788 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding IF array length.");
789 VERIFY_SUCCESS(TAG, (0 != rsrc->interfaceLen), ERROR);
791 rsrc->interfaces = (char**)OICCalloc(rsrc->interfaceLen, sizeof(char*));
792 VERIFY_NON_NULL(TAG, rsrc->interfaces, ERROR);
794 CborValue interfaces;
795 cborFindResult = cbor_value_enter_container(&rMap, &interfaces);
796 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering IF Array.");
798 for(size_t i = 0; cbor_value_is_valid(&interfaces) && cbor_value_is_text_string(&interfaces); i++)
801 cborFindResult = cbor_value_dup_text_string(&interfaces, &(rsrc->interfaces[i]), &readLen, NULL);
802 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding IF type.");
803 cborFindResult = cbor_value_advance(&interfaces);
804 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing IF type.");
809 if (0 == strcmp(OIC_JSON_REL_NAME, rMapName))
811 cborFindResult = cbor_value_dup_text_string(&rMap, &rsrc->rel, &len, NULL);
812 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding REL Value.");
815 if (cbor_value_is_valid(&rMap))
817 cborFindResult = cbor_value_advance(&rMap);
818 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Rlist Map.");
823 if (cbor_value_is_valid(&resources))
825 cborFindResult = cbor_value_advance(&resources);
826 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Resource Array.");
831 // Permissions -- Mandatory
832 if (strcmp(name, OIC_JSON_PERMISSION_NAME) == 0)
835 cborFindResult = cbor_value_get_uint64(&aceMap, &tmp64);
836 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a PERM Value.");
837 ace->permission = (uint16_t)tmp64;
840 // TODO: Need to verfication for validity
841 // Validity -- Not mandatory
842 if(strcmp(name, OIC_JSON_VALIDITY_NAME) == 0)
844 CborValue validitiesMap = {.parser = NULL};
845 size_t validitySize = 0;
847 cborFindResult = cbor_value_get_array_length(&aceMap, &validitySize);
848 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a Validity Array Length.");
850 cborFindResult = cbor_value_enter_container(&aceMap, &validitiesMap);
851 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a validity Array Map.");
853 while(cbor_value_is_valid(&validitiesMap))
855 OicSecValidity_t* validity = (OicSecValidity_t*)OICCalloc(1, sizeof(OicSecValidity_t));
856 VERIFY_NON_NULL(TAG, validity, ERROR);
857 LL_APPEND(ace->validities, validity);
859 CborValue validityMap = {.parser = NULL};
861 cborFindResult = cbor_value_enter_container(&validitiesMap, &validityMap);
862 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a validity Map.");
865 cborFindResult =cbor_value_dup_text_string(&validityMap, &validity->period, &len, NULL);
866 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a Period value.");
868 //recurrence (string array)
869 CborValue recurrenceMap = {.parser = NULL};
870 cborFindResult = cbor_value_enter_container(&validityMap, &recurrenceMap);
871 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a recurrence array.");
873 cborFindResult = cbor_value_get_array_length(&recurrenceMap, &validity->recurrenceLen);
874 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Adding Recurrence Array.");
876 validity->recurrences = (char**)OICCalloc(validity->recurrenceLen, sizeof(char*));
877 VERIFY_NON_NULL(TAG, validity->recurrences, ERROR);
879 for(size_t i = 0; cbor_value_is_text_string(&recurrenceMap) && i < validity->recurrenceLen; i++)
881 cborFindResult = cbor_value_dup_text_string(&recurrenceMap, &validity->recurrences[i], &len, NULL);
882 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a recurrence Value.");
884 cborFindResult = cbor_value_advance(&recurrenceMap);
885 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing a recurrences Array.");
888 cborFindResult = cbor_value_advance(&validitiesMap);
889 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing a validities Array.");
895 if (type != CborMapType && cbor_value_is_valid(&aceMap))
897 cborFindResult = cbor_value_advance(&aceMap);
898 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing the Array.");
902 if (cbor_value_is_valid(&acesArray))
904 cborFindResult = cbor_value_advance(&acesArray);
905 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing ACL Array.");
910 //rownerID -- Mandatory
911 if (strcmp(tagName, OIC_JSON_ROWNERID_NAME) == 0)
913 char *stRowner = NULL;
914 cborFindResult = cbor_value_dup_text_string(&aclMap, &stRowner, &len, NULL);
915 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Rownerid Value.");
916 OIC_LOG_V(DEBUG, TAG, "Converting rownerid = %s to uuid...", stRowner);
917 ret = ConvertStrToUuid(stRowner, &acl->rownerID);
918 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
923 if (cbor_value_is_valid(&aclMap))
925 cborFindResult = cbor_value_advance(&aclMap);
926 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing ACL Map.");
931 if (cborFindResult != CborNoError)
933 OIC_LOG(ERROR, TAG, "Failed to CBORPayloadToAcl");
941 // This function converts CBOR format to ACL data.
942 // Caller needs to invoke 'free' when done using
943 // note: This function is used in unit test hence not declared static,
944 OicSecAcl_t* CBORPayloadToAcl(const uint8_t *cborPayload, const size_t size)
946 if (NULL == cborPayload || 0 == size)
950 OCStackResult ret = OC_STACK_ERROR;
951 CborValue aclCbor = { .parser = NULL };
952 CborParser parser = { .end = NULL };
953 CborError cborFindResult = CborNoError;
954 cbor_parser_init(cborPayload, size, 0, &parser, &aclCbor);
956 OicSecAcl_t *acl = (OicSecAcl_t *) OICCalloc(1, sizeof(OicSecAcl_t));
959 CborValue aclMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
960 cborFindResult = cbor_value_enter_container(&aclCbor, &aclMap);
961 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACL Map.");
963 while (cbor_value_is_valid(&aclMap))
965 char* tagName = NULL;
967 CborType type = cbor_value_get_type(&aclMap);
968 if (type == CborTextStringType)
970 cborFindResult = cbor_value_dup_text_string(&aclMap, &tagName, &len, NULL);
971 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in ACL Map.");
972 cborFindResult = cbor_value_advance(&aclMap);
973 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in ACL Map.");
977 if (strcmp(tagName, OIC_JSON_ACLIST_NAME) == 0)
980 CborValue aclistMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
981 cborFindResult = cbor_value_enter_container(&aclMap, &aclistMap);
982 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACLIST Map.");
985 while (cbor_value_is_valid(&aclistMap))
989 CborType acType = cbor_value_get_type(&aclistMap);
990 if (acType == CborTextStringType)
992 cborFindResult = cbor_value_dup_text_string(&aclistMap, &acName, &readLen, NULL);
993 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in ACLIST Map.");
994 cborFindResult = cbor_value_advance(&aclistMap);
995 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in ACLIST Map.");
1000 if (strcmp(acName, OIC_JSON_ACES_NAME) == 0)
1003 CborValue acesArray = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
1004 cborFindResult = cbor_value_enter_container(&aclistMap, &acesArray);
1005 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACES Array.");
1008 while (cbor_value_is_valid(&acesArray))
1011 CborValue aceMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
1012 cborFindResult = cbor_value_enter_container(&acesArray, &aceMap);
1013 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering ACE Map.");
1015 OicSecAce_t *ace = NULL;
1016 ace = (OicSecAce_t *) OICCalloc(1, sizeof(OicSecAce_t));
1017 VERIFY_NON_NULL(TAG, ace, ERROR);
1018 LL_APPEND(acl->aces, ace);
1020 VERIFY_NON_NULL(TAG, acl, ERROR);
1022 while (cbor_value_is_valid(&aceMap))
1026 CborType type = cbor_value_get_type(&aceMap);
1027 if (type == CborTextStringType)
1029 cborFindResult = cbor_value_dup_text_string(&aceMap, &name, &len, NULL);
1030 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in ACE Map.");
1031 cborFindResult = cbor_value_advance(&aceMap);
1032 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in ACE Map.");
1036 // Subject -- Mandatory
1037 if (strcmp(name, OIC_JSON_SUBJECTID_NAME) == 0)
1039 char *subject = NULL;
1040 cborFindResult = cbor_value_dup_text_string(&aceMap, &subject, &len, NULL);
1041 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding subject Value.");
1042 if(strcmp(subject, WILDCARD_RESOURCE_URI) == 0)
1044 ace->subjectuuid.id[0] = '*';
1048 ret = ConvertStrToUuid(subject, &ace->subjectuuid);
1049 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
1054 // Resources -- Mandatory
1055 if (strcmp(name, OIC_JSON_RESOURCES_NAME) == 0)
1057 CborValue resources = { .parser = NULL };
1058 cborFindResult = cbor_value_enter_container(&aceMap, &resources);
1059 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering a Resource Array.");
1061 while (cbor_value_is_valid(&resources))
1064 CborValue rMap = { .parser = NULL };
1065 cborFindResult = cbor_value_enter_container(&resources, &rMap);
1066 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering Resource Map");
1068 OicSecRsrc_t* rsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
1069 VERIFY_NON_NULL(TAG, rsrc, ERROR);
1070 LL_APPEND(ace->resources, rsrc);
1072 while(cbor_value_is_valid(&rMap))
1074 char *rMapName = NULL;
1075 size_t rMapNameLen = 0;
1076 cborFindResult = cbor_value_dup_text_string(&rMap, &rMapName, &rMapNameLen, NULL);
1077 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RMap Data Name Tag.");
1078 cborFindResult = cbor_value_advance(&rMap);
1079 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RMap Data Value.");
1082 if (0 == strcmp(OIC_JSON_HREF_NAME, rMapName))
1084 cborFindResult = cbor_value_dup_text_string(&rMap, &rsrc->href, &len, NULL);
1085 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Href Value.");
1089 if (0 == strcmp(OIC_JSON_RT_NAME, rMapName) && cbor_value_is_array(&rMap))
1091 cbor_value_get_array_length(&rMap, &rsrc->typeLen);
1092 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding RT array length.");
1093 VERIFY_SUCCESS(TAG, (0 != rsrc->typeLen), ERROR);
1095 rsrc->types = (char**)OICCalloc(rsrc->typeLen, sizeof(char*));
1096 VERIFY_NON_NULL(TAG, rsrc->types, ERROR);
1098 CborValue resourceTypes;
1099 cborFindResult = cbor_value_enter_container(&rMap, &resourceTypes);
1100 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering RT Array.");
1102 for(size_t i = 0; cbor_value_is_valid(&resourceTypes) && cbor_value_is_text_string(&resourceTypes); i++)
1104 cborFindResult = cbor_value_dup_text_string(&resourceTypes, &(rsrc->types[i]), &readLen, NULL);
1105 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding resource type.");
1106 cborFindResult = cbor_value_advance(&resourceTypes);
1107 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing resource type.");
1112 if (0 == strcmp(OIC_JSON_IF_NAME, rMapName) && cbor_value_is_array(&rMap))
1114 cbor_value_get_array_length(&rMap, &rsrc->interfaceLen);
1115 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding IF array length.");
1116 VERIFY_SUCCESS(TAG, (0 != rsrc->interfaceLen), ERROR);
1118 rsrc->interfaces = (char**)OICCalloc(rsrc->interfaceLen, sizeof(char*));
1119 VERIFY_NON_NULL(TAG, rsrc->interfaces, ERROR);
1121 CborValue interfaces;
1122 cborFindResult = cbor_value_enter_container(&rMap, &interfaces);
1123 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering IF Array.");
1125 for(size_t i = 0; cbor_value_is_valid(&interfaces) && cbor_value_is_text_string(&interfaces); i++)
1127 cborFindResult = cbor_value_dup_text_string(&interfaces, &(rsrc->interfaces[i]), &readLen, NULL);
1128 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding IF type.");
1129 cborFindResult = cbor_value_advance(&interfaces);
1130 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing IF type.");
1135 if (0 == strcmp(OIC_JSON_REL_NAME, rMapName))
1137 cborFindResult = cbor_value_dup_text_string(&rMap, &rsrc->rel, &len, NULL);
1138 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding REL Value.");
1141 if (cbor_value_is_valid(&rMap))
1143 cborFindResult = cbor_value_advance(&rMap);
1144 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Rlist Map.");
1149 if (cbor_value_is_valid(&resources))
1151 cborFindResult = cbor_value_advance(&resources);
1152 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Resource Array.");
1157 // Permissions -- Mandatory
1158 if (strcmp(name, OIC_JSON_PERMISSION_NAME) == 0)
1161 cborFindResult = cbor_value_get_uint64(&aceMap, &tmp64);
1162 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a PERM Value.");
1163 ace->permission = (uint16_t)tmp64;
1166 // TODO: Need to verfication for validity
1167 // Validity -- Not mandatory
1168 if(strcmp(name, OIC_JSON_VALIDITY_NAME) == 0)
1170 CborValue validitiesMap = {.parser = NULL};
1171 size_t validitySize = 0;
1173 cborFindResult = cbor_value_get_array_length(&aceMap, &validitySize);
1174 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a Validity Array Length.");
1176 cborFindResult = cbor_value_enter_container(&aceMap, &validitiesMap);
1177 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a validity Array Map.");
1179 while(cbor_value_is_valid(&validitiesMap))
1181 OicSecValidity_t* validity = (OicSecValidity_t*)OICCalloc(1, sizeof(OicSecValidity_t));
1182 VERIFY_NON_NULL(TAG, validity, ERROR);
1183 LL_APPEND(ace->validities, validity);
1185 CborValue validityMap = {.parser = NULL};
1187 cborFindResult = cbor_value_enter_container(&validitiesMap, &validityMap);
1188 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a validity Map.");
1191 cborFindResult =cbor_value_dup_text_string(&validityMap, &validity->period, &len, NULL);
1192 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a Period value.");
1194 //recurrence (string array)
1195 CborValue recurrenceMap = {.parser = NULL};
1196 cborFindResult = cbor_value_enter_container(&validityMap, &recurrenceMap);
1197 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a recurrence array.");
1199 cborFindResult = cbor_value_get_array_length(&recurrenceMap, &validity->recurrenceLen);
1200 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Adding Recurrence Array.");
1202 validity->recurrences = (char**)OICCalloc(validity->recurrenceLen, sizeof(char*));
1203 VERIFY_NON_NULL(TAG, validity->recurrences, ERROR);
1205 for(size_t i = 0; cbor_value_is_text_string(&recurrenceMap) && i < validity->recurrenceLen; i++)
1207 cborFindResult = cbor_value_dup_text_string(&recurrenceMap, &validity->recurrences[i], &len, NULL);
1208 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding a recurrence Value.");
1210 cborFindResult = cbor_value_advance(&recurrenceMap);
1211 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing a recurrences Array.");
1214 cborFindResult = cbor_value_advance(&validitiesMap);
1215 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing a validities Array.");
1221 if (type != CborMapType && cbor_value_is_valid(&aceMap))
1223 cborFindResult = cbor_value_advance(&aceMap);
1224 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing the Array.");
1228 if (cbor_value_is_valid(&acesArray))
1230 cborFindResult = cbor_value_advance(&acesArray);
1231 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing ACL Array.");
1238 if (cbor_value_is_valid(&aclistMap))
1240 cborFindResult = cbor_value_advance(&aclistMap);
1241 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing ACLIST Map.");
1246 //rownerID -- Mandatory
1247 if (strcmp(tagName, OIC_JSON_ROWNERID_NAME) == 0)
1249 char *stRowner = NULL;
1250 cborFindResult = cbor_value_dup_text_string(&aclMap, &stRowner, &len, NULL);
1251 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Rownerid Value.");
1252 ret = ConvertStrToUuid(stRowner, &acl->rownerID);
1253 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
1256 else if (NULL != gAcl)
1258 memcpy(&(acl->rownerID), &(gAcl->rownerID), sizeof(OicUuid_t));
1262 if (cbor_value_is_valid(&aclMap))
1264 cborFindResult = cbor_value_advance(&aclMap);
1265 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing ACL Map.");
1270 if (cborFindResult != CborNoError)
1272 OIC_LOG(ERROR, TAG, "Failed to CBORPayloadToAcl");
1281 * This method removes ACE for the subject and resource from the ACL
1283 * @param subject of the ACE
1284 * @param resource of the ACE
1287 * ::OC_STACK_RESOURCE_DELETED on success
1288 * ::OC_STACK_NO_RESOURCE on failure to find the appropriate ACE
1289 * ::OC_STACK_INVALID_PARAM on invalid parameter
1291 OCStackResult RemoveACE(const OicUuid_t * subject, const char * resource)
1293 OIC_LOG(DEBUG, TAG, "IN RemoveACE");
1295 OicSecAce_t *ace = NULL;
1296 OicSecAce_t *tempAce = NULL;
1297 bool deleteFlag = false;
1298 OCStackResult ret = OC_STACK_NO_RESOURCE;
1300 if (memcmp(subject->id, &WILDCARD_SUBJECT_ID, sizeof(subject->id)) == 0)
1302 OIC_LOG_V(ERROR, TAG, "%s received invalid parameter", __func__ );
1303 return OC_STACK_INVALID_PARAM;
1306 //If resource is NULL then delete all the ACE for the subject.
1307 if (NULL == resource || resource[0] == '\0')
1309 LL_FOREACH_SAFE(gAcl->aces, ace, tempAce)
1311 if (memcmp(ace->subjectuuid.id, subject->id, sizeof(subject->id)) == 0)
1313 LL_DELETE(gAcl->aces, ace);
1321 //Looping through ACL to find the right ACE to delete. If the required resource is the only
1322 //resource in the ACE for the subject then delete the whole ACE. If there are more resources
1323 //than the required resource in the ACE, for the subject then just delete the resource from
1324 //the resource array
1325 LL_FOREACH_SAFE(gAcl->aces, ace, tempAce)
1327 if (memcmp(ace->subjectuuid.id, subject->id, sizeof(subject->id)) == 0)
1329 OicSecRsrc_t* rsrc = NULL;
1330 OicSecRsrc_t* tempRsrc = NULL;
1331 LL_FOREACH_SAFE(ace->resources, rsrc, tempRsrc)
1333 if(strcmp(rsrc->href, resource) == 0)
1335 LL_DELETE(ace->resources, rsrc);
1341 //If resource list is empty
1342 if(NULL == ace->resources && true == deleteFlag)
1344 //Remove the ACE from ACL
1345 LL_DELETE(gAcl->aces, ace);
1354 // In case of unit test do not update persistant storage.
1355 if (memcmp(subject->id, &WILDCARD_SUBJECT_B64_ID, sizeof(subject->id)) == 0)
1357 ret = OC_STACK_RESOURCE_DELETED;
1361 uint8_t *payload = NULL;
1363 if (OC_STACK_OK == AclToCBORPayload(gAcl, &payload, &size))
1365 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, payload, size))
1367 ret = OC_STACK_RESOURCE_DELETED;
1377 * This method parses the query string received for REST requests and
1378 * retrieves the 'subject' field.
1380 * @param query querystring passed in REST request
1381 * @param subject subject UUID parsed from query string
1383 * @return true if query parsed successfully and found 'subject', else false.
1385 static bool GetSubjectFromQueryString(const char *query, OicUuid_t *subject)
1387 OicParseQueryIter_t parseIter = { .attrPos = NULL };
1389 ParseQueryIterInit((unsigned char *) query, &parseIter);
1391 while (GetNextQuery (&parseIter))
1393 if (strncasecmp((char *) parseIter.attrPos, OIC_JSON_SUBJECTID_NAME, parseIter.attrLen) == 0)
1395 char strUuid[STRING_UUID_SIZE] = {0};
1396 VERIFY_SUCCESS(TAG, 0 != parseIter.valLen, ERROR);
1397 memcpy(strUuid, parseIter.valPos, parseIter.valLen);
1398 OCStackResult res = ConvertStrToUuid(strUuid, subject);
1399 VERIFY_SUCCESS(TAG, OC_STACK_OK == res, ERROR);
1409 * This method parses the query string received for REST requests and
1410 * retrieves the 'resource' field.
1412 * @param query querystring passed in REST request
1413 * @param resource resource parsed from query string
1414 * @param resourceSize size of the memory pointed to resource
1416 * @return true if query parsed successfully and found 'resource', else false.
1418 static bool GetResourceFromQueryString(const char *query, char *resource, size_t resourceSize)
1420 OicParseQueryIter_t parseIter = { .attrPos = NULL };
1422 ParseQueryIterInit((unsigned char *) query, &parseIter);
1424 while (GetNextQuery (&parseIter))
1426 if (strncasecmp((char *) parseIter.attrPos, OIC_JSON_RESOURCES_NAME, parseIter.attrLen)
1429 VERIFY_SUCCESS(TAG, 0 != parseIter.valLen, ERROR);
1430 OICStrcpy(resource, resourceSize, (char *) parseIter.valPos);
1440 static size_t GetNumberOfResource(OicSecRsrc_t* resources)
1445 OicSecRsrc_t* rsrc = NULL;
1446 LL_FOREACH(resources, rsrc)
1454 static size_t GetNumberOfValidity(OicSecValidity_t* val)
1460 OicSecValidity_t* temp = NULL;
1461 LL_FOREACH(val, temp)
1470 static bool IsSameStringArray(char** strArr1, size_t strArr1Len,
1471 char** strArr2, size_t strArr2Len)
1474 if(NULL == strArr1 && NULL == strArr2)
1479 if(strArr1 && strArr2 && NULL == *strArr1 && NULL == *strArr2)
1484 if(strArr1 && strArr2)
1486 if(*strArr1 && *strArr2 && strArr1Len == strArr2Len)
1488 size_t matchedStr = 0;
1489 for(size_t i = 0; i < strArr1Len; i++)
1491 for(size_t j = 0; j < strArr2Len; j++)
1493 if(strcmp(strArr1[i], strArr2[j]) == 0)
1499 if(matchedStr == strArr1Len)
1509 static bool IsSameResources(OicSecRsrc_t* resources1, OicSecRsrc_t* resources2)
1511 size_t numOfRsrc1 = 0;
1512 size_t numOfRsrc2 = 0;
1513 size_t numOfMatchedRsrc = 0;
1514 OicSecRsrc_t* rsrc1 = NULL;
1515 OicSecRsrc_t* rsrc2 = NULL;
1517 if(NULL == resources1 && NULL == resources2)
1522 if(resources1 && resources2)
1524 numOfRsrc1 = GetNumberOfResource(resources1);
1525 numOfRsrc2 = GetNumberOfResource(resources2);
1527 if(0 == numOfRsrc1 && 0 == numOfRsrc2)
1532 LL_FOREACH(resources1, rsrc1)
1535 LL_FOREACH(resources2, rsrc2)
1539 if(strcmp(rsrc1->href, rsrc2->href) == 0 &&
1540 IsSameStringArray(rsrc1->interfaces, rsrc1->interfaceLen,
1541 rsrc2->interfaces, rsrc2->interfaceLen) &&
1542 IsSameStringArray(rsrc1->types, rsrc1->typeLen,
1543 rsrc2->types, rsrc2->typeLen))
1545 // TODO: Update codes to compare 'rel' property
1552 if(numOfMatchedRsrc == numOfRsrc1)
1561 static bool IsSameValidities(OicSecValidity_t* validities1, OicSecValidity_t* validities2)
1563 size_t numOfVal1 = 0;
1564 size_t numOfVal2 = 0;
1565 size_t numOfMatchedVal = 0;
1566 OicSecValidity_t* val1 = NULL;
1567 OicSecValidity_t* val2 = NULL;
1569 if(NULL == validities1 && NULL == validities2)
1574 if(validities1 && validities2)
1576 numOfVal1 = GetNumberOfValidity(validities1);
1577 numOfVal2 = GetNumberOfValidity(validities2);
1578 if(0 == numOfVal1 && 0 == numOfVal2)
1583 if(numOfVal1 == numOfVal2)
1585 LL_FOREACH(validities1, val1)
1587 LL_FOREACH(validities2, val2)
1589 if(strcmp(val1->period, val2->period) == 0 &&
1590 IsSameStringArray(val1->recurrences, val1->recurrenceLen,
1591 val2->recurrences, val2->recurrenceLen))
1597 if(numOfVal1 == numOfMatchedVal)
1607 static bool IsSameACE(OicSecAce_t* ace1, OicSecAce_t* ace2)
1611 if(memcmp(ace1->subjectuuid.id, ace2->subjectuuid.id, sizeof(ace1->subjectuuid.id)) != 0)
1616 if(false == IsSameResources(ace1->resources, ace2->resources))
1621 if(ace1->permission != ace2->permission)
1626 if(false == IsSameValidities(ace1->validities, ace2->validities))
1638 * Internal function to remove all ACL data on ACL resource and persistent storage
1641 * OC_STACK_RESOURCE_DELETED - no errors
1644 static OCStackResult RemoveAllAce(void)
1646 OCStackResult ret = OC_STACK_ERROR;
1647 uint8_t* aclBackup = NULL;
1648 size_t backupSize = 0;
1649 uint8_t* payload = NULL;
1651 OicSecAce_t* aceItem = NULL;
1652 OicSecAce_t* tempAce = NULL;
1654 OIC_LOG(INFO, TAG, "IN RemoveAllAce");
1656 //Backup the current ACL
1657 ret = AclToCBORPayload(gAcl, &aclBackup, &backupSize);
1658 if(OC_STACK_OK == ret)
1660 // Remove all ACE from ACL
1661 LL_FOREACH_SAFE(gAcl->aces, aceItem, tempAce)
1663 LL_DELETE(gAcl->aces, aceItem);
1667 //Generate empty ACL payload
1668 ret = AclToCBORPayload(gAcl, &payload, &size);
1669 if (OC_STACK_OK == ret )
1672 ret = UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, payload, size);
1673 if (OC_STACK_OK != ret)
1675 OIC_LOG_V(ERROR, TAG, "Error in UpdateSecureResourceInPS : %d", ret);
1679 if(OC_STACK_OK != ret)
1681 OIC_LOG_V(ERROR, TAG, "Error while DELETE ACE : %d", ret);
1683 //If some erorr is occured, revert back.
1684 OicSecAcl_t* originAcl = CBORPayloadToAcl(aclBackup, backupSize);
1687 ret = UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, aclBackup, backupSize);
1688 if (OC_STACK_OK == ret)
1690 DeleteACLList(gAcl);
1695 OIC_LOG_V(ERROR, TAG, "Error in UpdateSecureResourceInPS : %d", ret);
1700 OIC_LOG(FATAL, TAG, "Error in CBORPayloadToAcl");
1701 ret = OC_STACK_ERROR;
1709 OIC_LOG(INFO, TAG, "OUT RemoveAllAce");
1711 return (OC_STACK_OK == ret ? OC_STACK_RESOURCE_DELETED : ret);
1714 static OCEntityHandlerResult HandleACLGetRequest(const OCEntityHandlerRequest *ehRequest)
1716 OIC_LOG(INFO, TAG, "HandleACLGetRequest processing the request");
1717 uint8_t* payload = NULL;
1719 OCEntityHandlerResult ehRet;
1721 OicUuid_t subject = {.id= { 0 } };
1723 // In case, 'subject' field is included in REST request.
1724 if (ehRequest->query && GetSubjectFromQueryString(ehRequest->query, &subject))
1726 OIC_LOG(DEBUG,TAG,"'subject' field is inculded in REST request.");
1727 OIC_LOG(DEBUG, TAG, "HandleACLGetRequest processing query");
1729 char resource[MAX_URI_LENGTH] = { 0 };
1731 OicSecAce_t *savePtr = NULL;
1732 const OicSecAce_t *currentAce = NULL;
1733 OicSecAcl_t targetAcl;
1735 memcpy(&targetAcl.rownerID, &gAcl->rownerID, sizeof(OicUuid_t));
1736 targetAcl.aces = NULL;
1738 // 'Subject' field is MUST for processing a querystring in REST request.
1739 GetResourceFromQueryString(ehRequest->query, resource, sizeof(resource));
1742 * TODO : Currently, this code only provides one ACE for a Subject.
1743 * Below code needs to be updated for scenarios when Subject have
1744 * multiple ACE's in ACL resource.
1746 while ((currentAce = GetACLResourceData(&subject, &savePtr)))
1748 targetAcl.aces = (OicSecAce_t*)currentAce;
1751 * If REST querystring contains a specific resource, we need
1752 * to search for that resource in ACE.
1754 if (resource[0] != '\0')
1756 OicSecRsrc_t *rsrc = NULL;
1757 LL_FOREACH(currentAce->resources, rsrc)
1759 if(0 == strcmp(rsrc->href, resource) ||
1760 0 == strcmp(WILDCARD_RESOURCE_URI, rsrc->href))
1762 // Convert ACL data into CBOR format for transmission
1763 if (OC_STACK_OK != AclToCBORPayload(&targetAcl, &payload, &size))
1765 ehRet = OC_EH_ERROR;
1773 // Convert ACL data into CBOR format for transmission
1774 if (OC_STACK_OK != AclToCBORPayload(&targetAcl, &payload, &size))
1776 ehRet = OC_EH_ERROR;
1782 // In case, 'subject' field is not included in REST request.
1785 OIC_LOG(DEBUG,TAG,"'subject' field is not inculded in REST request.");
1786 // Convert ACL data into CBOR format for transmission.
1787 if (OC_STACK_OK != AclToCBORPayload(gAcl, &payload, &size))
1789 ehRet = OC_EH_ERROR;
1793 // A device should always have a default acl. Therefore, payload should never be NULL.
1794 ehRet = (payload ? OC_EH_OK : OC_EH_ERROR);
1795 OIC_LOG(DEBUG, TAG, "ACL payload with GET response");
1796 OIC_LOG_BUFFER(DEBUG, TAG, payload, size);
1798 //Send payload to request originator
1799 ehRet = ((SendSRMResponse(ehRequest, ehRet, payload, size)) == OC_STACK_OK) ?
1800 OC_EH_OK : OC_EH_ERROR;
1804 OIC_LOG_V(DEBUG, TAG, "%s RetVal %d", __func__, ehRet);
1808 static OCEntityHandlerResult HandleACLPostRequest(const OCEntityHandlerRequest *ehRequest)
1810 OIC_LOG(INFO, TAG, "HandleACLPostRequest processing the request");
1811 OCEntityHandlerResult ehRet = OC_EH_OK;
1813 // Convert CBOR into ACL data and update to SVR buffers. This will also validate the ACL data received.
1814 uint8_t *payload = ((OCSecurityPayload *) ehRequest->payload)->securityData;
1815 size_t size = ((OCSecurityPayload *) ehRequest->payload)->payloadSize;
1818 OicSecAcl_t *newAcl = NULL;
1819 OIC_LOG(DEBUG, TAG, "ACL payload from POST request << ");
1820 OIC_LOG_BUFFER(DEBUG, TAG, payload, size);
1822 newAcl = CBORPayloadToAcl(payload, size);
1825 bool isNewAce = true;
1826 OicSecAce_t* existAce = NULL;
1827 OicSecAce_t* newAce = NULL;
1828 OicSecAce_t* tempAce1 = NULL;
1829 OicSecAce_t* tempAce2 = NULL;
1831 LL_FOREACH_SAFE(newAcl->aces, newAce, tempAce1)
1834 LL_FOREACH_SAFE(gAcl->aces, existAce, tempAce2)
1836 if(IsSameACE(newAce, existAce))
1843 OIC_LOG(DEBUG, TAG, "NEW ACE dectected.");
1845 OicSecAce_t* insertAce = DuplicateACE(newAce);
1848 OIC_LOG(DEBUG, TAG, "Appending new ACE..");
1849 LL_PREPEND(gAcl->aces, insertAce);
1853 OIC_LOG(ERROR, TAG, "Failed to duplicate ACE.");
1854 ehRet = OC_EH_ERROR;
1858 memcpy(&(gAcl->rownerID), &(newAcl->rownerID), sizeof(OicUuid_t));
1860 DeleteACLList(newAcl);
1862 if(OC_EH_OK == ehRet)
1865 uint8_t *cborPayload = NULL;
1867 if (OC_STACK_OK == AclToCBORPayload(gAcl, &cborPayload, &size))
1869 if (UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, cborPayload, size) == OC_STACK_OK)
1871 ehRet = OC_EH_CHANGED;
1873 OICFree(cborPayload);
1876 if(OC_EH_CHANGED != ehRet)
1878 ehRet = OC_EH_ERROR;
1884 //Send response to request originator
1885 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
1886 OC_EH_OK : OC_EH_ERROR;
1888 OIC_LOG_V(DEBUG, TAG, "%s RetVal %d", __func__, ehRet);
1892 static OCEntityHandlerResult HandleACLDeleteRequest(const OCEntityHandlerRequest *ehRequest)
1894 OIC_LOG(DEBUG, TAG, "Processing ACLDeleteRequest");
1895 OCEntityHandlerResult ehRet = OC_EH_ERROR;
1896 OicUuid_t subject = { .id= { 0 } };
1897 char resource[MAX_URI_LENGTH] = { 0 };
1899 VERIFY_NON_NULL(TAG, ehRequest->query, ERROR);
1901 // If 'Subject' field exist, processing a querystring in REST request.
1902 if(GetSubjectFromQueryString(ehRequest->query, &subject))
1904 GetResourceFromQueryString(ehRequest->query, resource, sizeof(resource));
1906 if (OC_STACK_RESOURCE_DELETED == RemoveACE(&subject, resource))
1908 ehRet = OC_EH_RESOURCE_DELETED;
1911 // If 'subject field not exist, remove all ACL data from ACL resource
1914 OIC_LOG(WARNING, TAG, "Can not find the 'subject' in querystring, All ACL list will be removed.");
1916 if(OC_STACK_RESOURCE_DELETED == RemoveAllAce())
1918 ehRet = OC_EH_RESOURCE_DELETED;
1923 //Send response to request originator
1924 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
1925 OC_EH_OK : OC_EH_ERROR;
1930 OCEntityHandlerResult ACLEntityHandler(OCEntityHandlerFlag flag, OCEntityHandlerRequest * ehRequest,
1931 void* callbackParameter)
1933 OIC_LOG(DEBUG, TAG, "Received request ACLEntityHandler");
1934 (void)callbackParameter;
1935 OCEntityHandlerResult ehRet = OC_EH_ERROR;
1942 if (flag & OC_REQUEST_FLAG)
1944 // TODO : Handle PUT method
1945 OIC_LOG(DEBUG, TAG, "Flag includes OC_REQUEST_FLAG");
1946 switch (ehRequest->method)
1949 ehRet = HandleACLGetRequest(ehRequest);
1953 ehRet = HandleACLPostRequest(ehRequest);
1956 case OC_REST_DELETE:
1957 ehRet = HandleACLDeleteRequest(ehRequest);
1961 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
1962 OC_EH_OK : OC_EH_ERROR;
1970 * This internal method is used to create '/oic/sec/acl' resource.
1972 static OCStackResult CreateACLResource()
1976 ret = OCCreateResource(&gAclHandle,
1977 OIC_RSRC_TYPE_SEC_ACL,
1978 OC_RSRVD_INTERFACE_DEFAULT,
1984 if (OC_STACK_OK != ret)
1986 OIC_LOG(FATAL, TAG, "Unable to instantiate ACL resource");
1987 DeInitACLResource();
1992 // This function sets the default ACL and is defined for the unit test only.
1993 OCStackResult SetDefaultACL(OicSecAcl_t *acl)
1999 OCStackResult GetDefaultACL(OicSecAcl_t** defaultAcl)
2001 OCStackResult ret = OC_STACK_ERROR;
2002 OicUuid_t ownerId = { .id = { 0 } };
2003 OicSecAcl_t *acl = NULL;
2004 OicSecAce_t *ace = NULL;
2005 OicSecRsrc_t* resRsrc = NULL;
2006 OicSecRsrc_t* deviceRsrc = NULL;
2007 OicSecRsrc_t* platformRsrc = NULL;
2008 OicSecRsrc_t* aclRsrc = NULL;
2009 OicSecRsrc_t* doxmRsrc = NULL;
2010 OicSecRsrc_t* pstatRsrc = NULL;
2013 * TODO In future, when new virtual resources will be added in OIC
2014 * specification, Iotivity stack should be able to add them in
2015 * existing SVR database. To support this, we need to add 'versioning'
2016 * mechanism in SVR database.
2021 return OC_STACK_INVALID_PARAM;
2024 acl = (OicSecAcl_t *) OICCalloc(1, sizeof(OicSecAcl_t));
2025 VERIFY_NON_NULL(TAG, acl, ERROR);
2027 ace = (OicSecAce_t *) OICCalloc(1, sizeof(OicSecAce_t));
2028 VERIFY_NON_NULL(TAG, ace, ERROR);
2030 LL_APPEND(acl->aces, ace);
2032 // Subject -- Mandatory
2033 memcpy(ace->subjectuuid.id, &WILDCARD_SUBJECT_ID, sizeof(OicUuid_t));
2035 // Resources -- Mandatory
2037 resRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2038 VERIFY_NON_NULL(TAG, resRsrc, ERROR);
2039 LL_APPEND(ace->resources, resRsrc);
2040 resRsrc->href = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
2041 VERIFY_NON_NULL(TAG, (resRsrc->href), ERROR);
2042 resRsrc->typeLen = 1;
2043 resRsrc->types = (char**)OICCalloc(1, sizeof(char*));
2044 VERIFY_NON_NULL(TAG, resRsrc->types, ERROR);
2045 resRsrc->types[0] = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
2046 VERIFY_NON_NULL(TAG, resRsrc->types[0], ERROR);
2047 resRsrc->interfaceLen = 2;
2048 resRsrc->interfaces = (char**)OICCalloc(resRsrc->interfaceLen, sizeof(char*));
2049 VERIFY_NON_NULL(TAG, resRsrc->interfaces, ERROR);
2050 resRsrc->interfaces[0] = OICStrdup(OC_RSRVD_INTERFACE_DEFAULT);
2051 VERIFY_NON_NULL(TAG, resRsrc->interfaces[0], ERROR);
2052 resRsrc->interfaces[1] = OICStrdup(OC_RSRVD_INTERFACE_READ);
2053 VERIFY_NON_NULL(TAG, resRsrc->interfaces[1], ERROR);
2056 deviceRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2057 VERIFY_NON_NULL(TAG, deviceRsrc, ERROR);
2058 LL_APPEND(ace->resources, deviceRsrc);
2059 deviceRsrc->href = OICStrdup(OC_RSRVD_DEVICE_URI);
2060 VERIFY_NON_NULL(TAG, (deviceRsrc->href), ERROR);
2061 deviceRsrc->typeLen = 1;
2062 deviceRsrc->types = (char**)OICCalloc(1, sizeof(char*));
2063 VERIFY_NON_NULL(TAG, deviceRsrc->types, ERROR);
2064 deviceRsrc->types[0] = OICStrdup(OC_RSRVD_RESOURCE_TYPE_DEVICE);
2065 VERIFY_NON_NULL(TAG, deviceRsrc->types[0], ERROR);
2066 deviceRsrc->interfaceLen = 2;
2067 deviceRsrc->interfaces = (char**)OICCalloc(deviceRsrc->interfaceLen, sizeof(char*));
2068 VERIFY_NON_NULL(TAG, deviceRsrc->interfaces, ERROR);
2069 deviceRsrc->interfaces[0] = OICStrdup(OC_RSRVD_INTERFACE_DEFAULT);
2070 VERIFY_NON_NULL(TAG, deviceRsrc->interfaces[0], ERROR);
2071 deviceRsrc->interfaces[1] = OICStrdup(OC_RSRVD_INTERFACE_READ);
2072 VERIFY_NON_NULL(TAG, deviceRsrc->interfaces[1], ERROR);
2075 platformRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2076 VERIFY_NON_NULL(TAG, platformRsrc, ERROR);
2077 LL_APPEND(ace->resources, platformRsrc);
2078 platformRsrc->href = OICStrdup(OC_RSRVD_PLATFORM_URI);
2079 VERIFY_NON_NULL(TAG, (platformRsrc->href), ERROR);
2080 platformRsrc->typeLen = 1;
2081 platformRsrc->types = (char**)OICCalloc(1, sizeof(char*));
2082 VERIFY_NON_NULL(TAG, platformRsrc->types, ERROR);
2083 platformRsrc->types[0] = OICStrdup(OC_RSRVD_RESOURCE_TYPE_PLATFORM);
2084 VERIFY_NON_NULL(TAG, platformRsrc->types[0], ERROR);
2085 platformRsrc->interfaceLen = 2;
2086 platformRsrc->interfaces = (char**)OICCalloc(platformRsrc->interfaceLen, sizeof(char*));
2087 VERIFY_NON_NULL(TAG, platformRsrc->interfaces, ERROR);
2088 platformRsrc->interfaces[0] = OICStrdup(OC_RSRVD_INTERFACE_DEFAULT);
2089 VERIFY_NON_NULL(TAG, platformRsrc->interfaces[0], ERROR);
2090 platformRsrc->interfaces[1] = OICStrdup(OC_RSRVD_INTERFACE_READ);
2091 VERIFY_NON_NULL(TAG, platformRsrc->interfaces[1], ERROR);
2094 aclRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2095 VERIFY_NON_NULL(TAG, aclRsrc, ERROR);
2096 LL_APPEND(ace->resources, aclRsrc);
2097 aclRsrc->href = OICStrdup(OIC_RSRC_ACL_URI);
2098 VERIFY_NON_NULL(TAG, (aclRsrc->href), ERROR);
2099 aclRsrc->typeLen = 1;
2100 aclRsrc->types = (char**)OICCalloc(1, sizeof(char*));
2101 VERIFY_NON_NULL(TAG, aclRsrc->types, ERROR);
2102 aclRsrc->types[0] = OICStrdup(OIC_RSRC_TYPE_SEC_ACL);
2103 VERIFY_NON_NULL(TAG, aclRsrc->types[0], ERROR);
2104 aclRsrc->interfaceLen = 1;
2105 aclRsrc->interfaces = (char**)OICCalloc(aclRsrc->interfaceLen, sizeof(char*));
2106 VERIFY_NON_NULL(TAG, aclRsrc->interfaces, ERROR);
2107 aclRsrc->interfaces[0] = OICStrdup(OC_RSRVD_INTERFACE_DEFAULT);
2108 VERIFY_NON_NULL(TAG, aclRsrc->interfaces[0], ERROR);
2111 doxmRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2112 VERIFY_NON_NULL(TAG, doxmRsrc, ERROR);
2113 LL_APPEND(ace->resources, doxmRsrc);
2114 doxmRsrc->href = OICStrdup(OIC_RSRC_DOXM_URI);
2115 VERIFY_NON_NULL(TAG, (doxmRsrc->href), ERROR);
2116 doxmRsrc->typeLen = 1;
2117 doxmRsrc->types = (char**)OICCalloc(1, sizeof(char*));
2118 VERIFY_NON_NULL(TAG, doxmRsrc->types, ERROR);
2119 doxmRsrc->types[0] = OICStrdup(OIC_RSRC_TYPE_SEC_DOXM);
2120 VERIFY_NON_NULL(TAG, doxmRsrc->types[0], ERROR);
2121 doxmRsrc->interfaceLen = 1;
2122 doxmRsrc->interfaces = (char**)OICCalloc(doxmRsrc->interfaceLen, sizeof(char*));
2123 VERIFY_NON_NULL(TAG, doxmRsrc->interfaces, ERROR);
2124 doxmRsrc->interfaces[0] = OICStrdup(OC_RSRVD_INTERFACE_DEFAULT);
2125 VERIFY_NON_NULL(TAG, doxmRsrc->interfaces[0], ERROR);
2128 pstatRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2129 VERIFY_NON_NULL(TAG, pstatRsrc, ERROR);
2130 LL_APPEND(ace->resources, pstatRsrc);
2131 pstatRsrc->href = OICStrdup(OIC_RSRC_PSTAT_URI);
2132 VERIFY_NON_NULL(TAG, (pstatRsrc->href), ERROR);
2133 pstatRsrc->typeLen = 1;
2134 pstatRsrc->types = (char**)OICCalloc(1, sizeof(char*));
2135 VERIFY_NON_NULL(TAG, pstatRsrc->types, ERROR);
2136 pstatRsrc->types[0] = OICStrdup(OIC_RSRC_TYPE_SEC_PSTAT);
2137 VERIFY_NON_NULL(TAG, pstatRsrc->types[0], ERROR);
2138 pstatRsrc->interfaceLen = 1;
2139 pstatRsrc->interfaces = (char**)OICCalloc(pstatRsrc->interfaceLen, sizeof(char*));
2140 VERIFY_NON_NULL(TAG, pstatRsrc->interfaces, ERROR);
2141 pstatRsrc->interfaces[0] = OICStrdup(OC_RSRVD_INTERFACE_DEFAULT);
2142 VERIFY_NON_NULL(TAG, pstatRsrc->interfaces[0], ERROR);
2144 ace->permission = PERMISSION_READ;
2145 ace->validities = NULL;
2147 // Device ID is the owner of this default ACL
2148 if (GetDoxmResourceData() != NULL)
2150 ret = GetDoxmDeviceID(&ownerId);
2151 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, FATAL);
2155 OCRandomUuidResult rdm = OCGenerateUuid(ownerId.id);
2156 VERIFY_SUCCESS(TAG, RAND_UUID_OK == rdm, FATAL);
2159 memcpy(&acl->rownerID, &ownerId, sizeof(OicUuid_t));
2166 if (ret != OC_STACK_OK)
2175 OCStackResult InitACLResource()
2177 OCStackResult ret = OC_STACK_ERROR;
2179 uint8_t *data = NULL;
2181 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_ACL_NAME, &data, &size);
2182 // If database read failed
2183 if (OC_STACK_OK != ret)
2185 OIC_LOG(DEBUG, TAG, "ReadSVDataFromPS failed");
2189 // Read ACL resource from PS
2190 gAcl = CBORPayloadToAcl(data, size);
2194 * If SVR database in persistent storage got corrupted or
2195 * is not available for some reason, a default ACL is created
2196 * which allows user to initiate ACL provisioning again.
2200 ret = GetDefaultACL(&gAcl);
2201 if (OC_STACK_OK != ret)
2203 OIC_LOG(ERROR, TAG, "Failed to create default ACL");
2205 // TODO Needs to update persistent storage
2207 VERIFY_NON_NULL(TAG, gAcl, FATAL);
2209 // Instantiate 'oic.sec.acl'
2210 ret = CreateACLResource();
2213 if (OC_STACK_OK != ret)
2215 DeInitACLResource();
2220 OCStackResult DeInitACLResource()
2222 OCStackResult ret = OCDeleteResource(gAclHandle);
2227 DeleteACLList(gAcl);
2233 const OicSecAce_t* GetACLResourceData(const OicUuid_t* subjectId, OicSecAce_t **savePtr)
2235 OicSecAce_t *ace = NULL;
2236 OicSecAce_t *begin = NULL;
2238 if (NULL == subjectId)
2244 * savePtr MUST point to NULL if this is the 'first' call to retrieve ACL for
2247 if (NULL == *savePtr)
2254 * If this is a 'successive' call, search for location pointed by
2255 * savePtr and assign 'begin' to the next ACL after it in the linked
2256 * list and start searching from there.
2258 LL_FOREACH(gAcl->aces, ace)
2260 if (ace == *savePtr)
2267 // Find the next ACL corresponding to the 'subjectID' and return it.
2268 LL_FOREACH(begin, ace)
2270 if (memcmp(&(ace->subjectuuid), subjectId, sizeof(OicUuid_t)) == 0)
2277 // Cleanup in case no ACL is found
2282 void printACL(const OicSecAcl_t* acl)
2284 OIC_LOG(INFO, TAG, "Print ACL:");
2288 OIC_LOG(INFO, TAG, "Received NULL acl");
2292 char *rowner = NULL;
2293 if (OC_STACK_OK == ConvertUuidToStr(&acl->rownerID, &rowner))
2295 OIC_LOG_V(INFO, TAG, "rowner id = %s", rowner);
2299 OIC_LOG(ERROR, TAG, "Can't convert rowner uuid to string");
2303 const OicSecAce_t *ace = acl->aces;
2308 OIC_LOG_V(INFO, TAG, "Print ace[%d]:", ace_count);
2310 OIC_LOG_V(INFO, TAG, "ace permission = %d", ace->permission);
2312 char *subjectuuid = NULL;
2313 if (OC_STACK_OK == ConvertUuidToStr(&ace->subjectuuid, &subjectuuid))
2315 OIC_LOG_V(INFO, TAG, "ace subject uuid = %s", subjectuuid);
2319 OIC_LOG(ERROR, TAG, "Can't convert subjectuuid to string");
2321 OICFree(subjectuuid);
2323 OicSecRsrc_t *res = ace->resources;
2328 OIC_LOG_V(INFO, TAG, "Print resources[%d]:", res_count);
2330 OIC_LOG_V(INFO, TAG, "href = %s", res->href);
2332 for (size_t i = 0; i < res->typeLen; i++)
2334 OIC_LOG_V(INFO, TAG, "if[%zu] = %s", i, res->types[i]);
2336 for (size_t i = 0; i < res->interfaceLen; i++)
2338 OIC_LOG_V(INFO, TAG, "if[%zu] = %s", i, res->interfaces[i]);
2344 OicSecValidity_t *vals = ace->validities;
2349 OIC_LOG_V(INFO, TAG, "Print validities[%d]:", vals_count);
2351 OIC_LOG_V(INFO, TAG, "period = %s", vals->period);
2352 for (size_t i = 0; i < vals->recurrenceLen; i++)
2354 OIC_LOG_V(INFO, TAG, "recurrences[%zu] = %s", i, vals->recurrences[i]);
2362 OCStackResult InstallNewACL2(const OicSecAcl_t* acl)
2364 OCStackResult ret = OC_STACK_ERROR;
2368 return OC_STACK_INVALID_PARAM;
2371 // Append the new ACE to existing ACE list
2372 // Can't use LL_APPEND because it sets ace->next to NULL
2373 OicSecAce_t* ace = gAcl->aces;
2380 ace->next = acl->aces;
2384 gAcl->aces = acl->aces;
2390 uint8_t *payload = NULL;
2391 ret = AclToCBORPayload(gAcl, &payload, &size);
2392 if (OC_STACK_OK == ret)
2394 ret = UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, payload, size);
2401 OCStackResult InstallNewACL(const uint8_t *cborPayload, const size_t size)
2403 // Convert CBOR format to ACL data. This will also validate the ACL data received.
2404 OicSecAcl_t* newAcl = CBORPayloadToAcl(cborPayload, size);
2406 return InstallNewACL2(newAcl);
2410 * This function generates default ACE for security resource in case of owned status.
2412 * @return Default ACE for security resource.
2414 static OicSecAce_t* GetSecDefaultACE()
2416 const int NUM_OF_DOXM_RT = 1;
2417 const int NUM_OF_DOXM_IF = 1;
2418 const int NUM_OF_PSTAT_RT = 1;
2419 const int NUM_OF_PSTAT_IF = 1;
2420 const char *doxmRt[] = { OIC_RSRC_TYPE_SEC_DOXM };
2421 const char *pstatRt[] = { OIC_RSRC_TYPE_SEC_PSTAT };
2422 const char *doxmIf[] = { OC_RSRVD_INTERFACE_DEFAULT };
2423 const char *pstatIf[] = { OC_RSRVD_INTERFACE_DEFAULT };
2424 OicSecRsrc_t* doxmRsrc = NULL;
2425 OicSecRsrc_t* pstatRsrc = NULL;
2427 //Generate default ACE
2428 OicSecAce_t* newAce = (OicSecAce_t*)OICCalloc(1, sizeof(OicSecAce_t));
2429 VERIFY_NON_NULL(TAG, newAce, ERROR);
2431 // Subject -- Mandatory
2432 memcpy(newAce->subjectuuid.id, &WILDCARD_SUBJECT_ID, WILDCARD_SUBJECT_ID_LEN);
2434 //Resources -- Mandatory
2436 doxmRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2437 VERIFY_NON_NULL(TAG, doxmRsrc, ERROR);
2438 LL_APPEND(newAce->resources, doxmRsrc);
2440 doxmRsrc->href = OICStrdup(OIC_RSRC_DOXM_URI);
2441 VERIFY_NON_NULL(TAG, (doxmRsrc->href), ERROR);
2443 doxmRsrc->typeLen = NUM_OF_DOXM_RT;
2444 doxmRsrc->types = (char**)OICCalloc(NUM_OF_DOXM_RT, sizeof(char*));
2445 VERIFY_NON_NULL(TAG, (doxmRsrc->types), ERROR);
2446 for(int i = 0; i < NUM_OF_DOXM_RT; i++)
2448 doxmRsrc->types[i] = OICStrdup(doxmRt[i]);
2449 VERIFY_NON_NULL(TAG, (doxmRsrc->types[i]), ERROR);
2452 doxmRsrc->interfaceLen = NUM_OF_DOXM_IF;
2453 doxmRsrc->interfaces = (char**)OICCalloc(NUM_OF_DOXM_IF, sizeof(char*));
2454 VERIFY_NON_NULL(TAG, (doxmRsrc->interfaces), ERROR);
2455 for(int i = 0; i < NUM_OF_DOXM_IF; i++)
2457 doxmRsrc->interfaces[i] = OICStrdup(doxmIf[i]);
2458 VERIFY_NON_NULL(TAG, (doxmRsrc->interfaces[i]), ERROR);
2462 pstatRsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
2463 VERIFY_NON_NULL(TAG, pstatRsrc, ERROR);
2464 LL_APPEND(newAce->resources, pstatRsrc);
2466 pstatRsrc->href = OICStrdup(OIC_RSRC_PSTAT_URI);
2467 VERIFY_NON_NULL(TAG, (pstatRsrc->href), ERROR);
2469 pstatRsrc->typeLen = NUM_OF_PSTAT_RT;
2470 pstatRsrc->types = (char**)OICCalloc(NUM_OF_PSTAT_RT, sizeof(char*));
2471 VERIFY_NON_NULL(TAG, (pstatRsrc->types), ERROR);
2472 for(int i = 0; i < NUM_OF_PSTAT_RT; i++)
2474 pstatRsrc->types[i] = OICStrdup(pstatRt[i]);
2475 VERIFY_NON_NULL(TAG, (pstatRsrc->types[i]), ERROR);
2478 pstatRsrc->interfaceLen = NUM_OF_PSTAT_IF;
2479 pstatRsrc->interfaces = (char**)OICCalloc(NUM_OF_PSTAT_IF, sizeof(char*));
2480 VERIFY_NON_NULL(TAG, (pstatRsrc->interfaces), ERROR);
2481 for(int i = 0; i < NUM_OF_PSTAT_IF; i++)
2483 pstatRsrc->interfaces[i] = OICStrdup(pstatIf[i]);
2484 VERIFY_NON_NULL(TAG, (pstatRsrc->interfaces[i]), ERROR);
2487 // Permissions -- Mandatory
2488 newAce->permission = PERMISSION_READ;
2490 //Period -- Not Mandatory
2491 newAce->validities = NULL;
2500 OCStackResult UpdateDefaultSecProvACE()
2502 OCStackResult ret = OC_STACK_OK;
2503 OicSecAce_t *ace = NULL;
2504 OicSecAce_t *tempAce = NULL;
2508 int matchedRsrc = 0;
2509 bool isRemoved = false;
2511 LL_FOREACH_SAFE(gAcl->aces, ace, tempAce)
2513 //Find default security resource ACL
2514 if(memcmp(&ace->subjectuuid, &WILDCARD_SUBJECT_ID, sizeof(OicUuid_t)) == 0 &&
2515 ((PERMISSION_READ | PERMISSION_WRITE) == ace->permission))
2519 OicSecRsrc_t* rsrc = NULL;
2520 LL_FOREACH(ace->resources, rsrc)
2522 if(strncmp(rsrc->href, OIC_RSRC_DOXM_URI,
2523 strlen(OIC_RSRC_DOXM_URI) + 1) == 0 ||
2524 strncmp(rsrc->href, OIC_RSRC_CRED_URI,
2525 strlen(OIC_RSRC_CRED_URI) + 1) == 0 ||
2526 strncmp(rsrc->href, OIC_RSRC_ACL_URI,
2527 strlen(OIC_RSRC_ACL_URI) + 1) == 0 ||
2528 strncmp(rsrc->href, OIC_RSRC_PSTAT_URI,
2529 strlen(OIC_RSRC_PSTAT_URI) + 1) == 0)
2535 //If default security resource ACL is detected, delete it.
2536 if(NUMBER_OF_SEC_PROV_RSCS == matchedRsrc)
2538 LL_DELETE(gAcl->aces, ace);
2548 * Generate new security resource ACE as follows :
2550 * resources : '/oic/sec/doxm', '/oic/sec/pstat'
2553 OicSecAce_t *secDefaultAce = GetSecDefaultACE();
2556 LL_APPEND(gAcl->aces, secDefaultAce);
2559 uint8_t *payload = NULL;
2560 if (OC_STACK_OK == AclToCBORPayload(gAcl, &payload, &size))
2562 if (UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, payload, size) == OC_STACK_OK)
2575 OCStackResult SetAclRownerId(const OicUuid_t* newROwner)
2577 OCStackResult ret = OC_STACK_ERROR;
2578 uint8_t *cborPayload = NULL;
2580 OicUuid_t prevId = {.id={0}};
2582 if(NULL == newROwner)
2584 ret = OC_STACK_INVALID_PARAM;
2588 ret = OC_STACK_NO_RESOURCE;
2591 if(newROwner && gAcl)
2593 memcpy(prevId.id, gAcl->rownerID.id, sizeof(prevId.id));
2594 memcpy(gAcl->rownerID.id, newROwner->id, sizeof(newROwner->id));
2596 ret = AclToCBORPayload(gAcl, &cborPayload, &size);
2597 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
2599 ret = UpdateSecureResourceInPS(OIC_JSON_ACL_NAME, cborPayload, size);
2600 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
2602 OICFree(cborPayload);
2608 OICFree(cborPayload);
2609 memcpy(gAcl->rownerID.id, prevId.id, sizeof(prevId.id));
2613 OCStackResult GetAclRownerId(OicUuid_t *rowneruuid)
2615 OCStackResult retVal = OC_STACK_ERROR;
2618 *rowneruuid = gAcl->rownerID;
2619 retVal = OC_STACK_OK;