88b652bd0e08d41111ad160434439aed88211b88
[iotivity.git] / resource / csdk / security / src / policyengine.c
1 //******************************************************************
2 //
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
4 //
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6 //
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
10 //
11 //      http://www.apache.org/licenses/LICENSE-2.0
12 //
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
18 //
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20 #include <string.h>
21 #include <assert.h>
22
23 #include "utlist.h"
24 #include "oic_malloc.h"
25 #include "ocrandom.h"
26 #include "policyengine.h"
27 #include "resourcemanager.h"
28 #include "securevirtualresourcetypes.h"
29 #include "srmresourcestrings.h"
30 #include "logger.h"
31 #include "aclresource.h"
32 #include "srmutility.h"
33 #include "doxmresource.h"
34 #include "iotvticalendar.h"
35 #include "pstatresource.h"
36 #include "dpairingresource.h"
37 #include "pconfresource.h"
38 #include "amaclresource.h"
39 #include "credresource.h"
40 #include "rolesresource.h"
41 #include "deviceonboardingstate.h"
42
43 #define TAG "OIC_SRM_PE"
44
45 uint16_t GetPermissionFromCAMethod_t(const CAMethod_t method)
46 {
47     uint16_t perm = 0;
48     switch (method)
49     {
50         case CA_GET:
51             perm = (uint16_t)PERMISSION_READ;
52             break;
53         case CA_POST: // Treat all POST as Write (Update) because
54                       // we don't know if resource exists yet.
55                       // This will be addressed in IoTivity impl of OCF 1.0
56             perm = (uint16_t)PERMISSION_WRITE;
57             break;
58         case CA_PUT: // Per convention, OIC/OCF uses PUT only for Create,
59                      // never for Update.
60             perm = (uint16_t)PERMISSION_CREATE;
61             break;
62         case CA_DELETE:
63             perm = (uint16_t)PERMISSION_DELETE;
64             break;
65         default: // if not recognized, must assume requesting full control
66             perm = (uint16_t)PERMISSION_FULL_CONTROL;
67             break;
68     }
69
70     OIC_LOG_V(INFO, TAG, "%s: CA method %d requires permission %#x",
71         __func__, method, (uint32_t)perm);
72     return perm;
73 }
74
75 /**
76  * Compare the request's subject to DevOwner.
77  *
78  * @return true if context->subjectId == GetDoxmDevOwner(), else false.
79  */
80 static bool IsRequestFromDevOwner(SRMRequestContext_t *context)
81 {
82     bool retVal = false;
83     OicSecDoxm_t* doxm = NULL;
84
85     if (NULL == context)
86     {
87         return false;
88     }
89
90     if (IsNilUuid(&context->subjectUuid))
91     {
92         // Nil subject is never devOwner
93         retVal = false;
94         goto exit;
95     }
96
97     doxm = (OicSecDoxm_t*) GetDoxmResourceData();
98     if (doxm)
99     {
100         retVal = UuidCmp(&doxm->owner, &context->subjectUuid);
101         if (!retVal)
102         {
103             OIC_LOG(DEBUG, TAG, "Owner UUID  :");
104             OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)&doxm->owner.id, sizeof(OicUuid_t));
105             OIC_LOG(DEBUG, TAG, "Request UUID:");
106             OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)&context->subjectUuid.id, sizeof(OicUuid_t));
107         }
108     }
109 exit:
110     OIC_LOG_V(DEBUG, TAG, "%s: request was %sreceived from device owner",
111             __func__, retVal ? "" : "NOT ");
112     return retVal;
113 }
114
115 /**
116  * Check if the request has been received from a session used for Ownership Transfer.
117  *
118  * @return true if the CA_SECURE_ENDPOINT_ATTRIBUTE_ADMINISTRATOR bit is set, else false.
119  */
120 static bool IsRequestFromOwnershipTransferSession(SRMRequestContext_t *context)
121 {
122     bool retVal = false;
123
124 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
125     //Ownership Transfer sessions are allowed to bypass SVR ACEs, while this
126     //Device is not ready for normal operation yet.
127     if ((NULL != context) && (NULL != context->endPoint))
128     {
129         uint32_t allAttributes;
130         if (CAGetSecureEndpointAttributes(context->endPoint, &allAttributes) &&
131             (allAttributes & CA_SECURE_ENDPOINT_ATTRIBUTE_ADMINISTRATOR))
132         {
133             retVal = true;
134         }
135
136         OIC_LOG_V(DEBUG, TAG, "%s: request was %sreceived from Ownership Transfer session",
137             __func__, retVal ? "" : "NOT ");
138     }
139 #else
140     OC_UNUSED(context);
141 #endif
142
143     return retVal;
144 }
145
146 #ifdef MULTIPLE_OWNER
147 /**
148  * Compare the request's subject to SubOwner.
149  *
150  * @return true if context->subjectId exist subowner list, else false.
151  */
152 static bool IsRequestFromSubOwner(SRMRequestContext_t *context)
153 {
154     bool retVal = false;
155
156     if (IsNilUuid(&context->subjectUuid))
157     {
158         // Nil subject is never subOwner
159         retVal = false;
160         goto exit;
161     }
162
163     if (NULL != context)
164     {
165         retVal = IsSubOwner(&context->subjectUuid);
166     }
167
168 exit:
169     OIC_LOG_V(INFO, TAG, "%s: returning %s", __func__, retVal ? "true" : "false");
170     return retVal;
171 }
172
173 /**
174  * Verify the SubOwner's request.
175  *
176  * @return true if request is valid, else false.
177  */
178 static bool IsValidRequestFromSubOwner(SRMRequestContext_t *context)
179 {
180     bool isValidRequest = false;
181
182     if(NULL == context)
183     {
184         return isValidRequest;
185     }
186
187     switch(context->resourceType)
188     {
189         case OIC_R_DOXM_TYPE:
190             //SubOwner has READ permission only for DOXM
191             if(PERMISSION_READ == context->requestedPermission)
192             {
193                 isValidRequest = true;
194             }
195             break;
196         case OIC_R_PSTAT_TYPE:
197             //SubOwner has full permsion for PSTAT
198             isValidRequest = true;
199             break;
200         case OIC_R_CRED_TYPE:
201             //SubOwner can only access the credential which is registered as the eowner.
202             isValidRequest = IsValidCredentialAccessForSubOwner(&context->subjectUuid,
203              context->payload, context->payloadSize);
204             break;
205         case OIC_R_ACL_TYPE:
206             //SubOwner can only access the ACL which is registered as the eowner.
207             isValidRequest = IsValidAclAccessForSubOwner(&context->subjectUuid,
208                 context->payload, context->payloadSize);
209             break;
210         default:
211             //SubOwner has full permission for all resource except the security resource
212             isValidRequest = true;
213             break;
214     }
215
216     OIC_LOG_V(INFO, TAG, "%s: returning %s", __func__, isValidRequest ? "true" : "false");
217     return isValidRequest;
218 }
219 #endif //MULTIPLE_OWNER
220
221 static GetSvrRownerId_t GetSvrRownerId[OIC_SEC_SVR_TYPE_COUNT + 1] = {
222     NULL,
223     GetAclRownerId,
224     NULL,               // amacl's rowneruuid has been removed from the OCF 1.0 Security spec.
225     GetCredRownerId,
226     NULL,               // crl doesn't have rowneruuid.
227     GetDoxmRownerId,
228     GetDpairingRownerId,
229     GetPconfRownerId,
230     GetPstatRownerId,
231     NULL,               // sacl is not implemented yet.
232     NULL                // svc has been removed from the OCF 1.0 Security spec.
233 };
234
235 /**
236  * Compare the request's subject to resource.ROwner.
237  *
238  * @return true if context->subjectId equals SVR rowner id, else return false
239  */
240 bool IsRequestFromResourceOwner(SRMRequestContext_t *context)
241 {
242     bool retVal = false;
243     OicUuid_t resourceOwner;
244
245     if (NULL == context)
246     {
247         retVal = false;
248         goto exit;
249     }
250
251     if (SUBJECT_ID_TYPE_UUID != context->subjectIdType)
252     {
253         OIC_LOG_V(DEBUG, TAG, "%s: Non-UUID subject type cannot be rowner.", __func__);
254         retVal = false;
255         goto exit;
256     }
257
258     if (IsNilUuid(&context->subjectUuid))
259     {
260         // Nil subject is never rOwner
261         OIC_LOG_V(DEBUG, TAG, "%s: Nil UUID cannot be rowner.", __func__);
262         retVal = false;
263         goto exit;
264     }
265
266     if((OIC_R_ACL_TYPE <= context->resourceType) && \
267         (OIC_SEC_SVR_TYPE_COUNT > context->resourceType))
268     {
269         GetSvrRownerId_t getRownerId = NULL;
270         OCStackResult getRownerResult = OC_STACK_ERROR;
271
272         getRownerId = GetSvrRownerId[(int)context->resourceType];
273
274         if (NULL != getRownerId)
275         {
276             getRownerResult = getRownerId(&resourceOwner);
277         }
278
279 #ifndef NDEBUG // if debug build, log the IDs being used for matching rowner
280         char strUuid[UUID_STRING_SIZE] = "UUID_ERROR";
281         if (OCConvertUuidToString(context->subjectUuid.id, strUuid))
282         {
283             OIC_LOG_V(DEBUG, TAG, "context->subjectUuid for request: %s.", strUuid);
284         }
285         else
286         {
287             OIC_LOG(ERROR, TAG, "failed to convert context->subjectUuid to str.");
288         }
289         if (OCConvertUuidToString(resourceOwner.id, strUuid))
290         {
291             OIC_LOG_V(DEBUG, TAG, "rowneruuid for requested SVR: %s.", strUuid);
292         }
293         else
294         {
295             OIC_LOG(ERROR, TAG, "failed to convert rowneruuid to str.");
296         }
297 #endif
298
299         if(OC_STACK_OK == getRownerResult)
300         {
301             retVal = UuidCmp(&context->subjectUuid, &resourceOwner);
302         }
303     }
304 exit:
305     OIC_LOG_V(INFO, TAG, "%s: returning %s", __func__, retVal ? "true" : "false");
306     return retVal;
307 }
308
309 /**
310  * Bitwise check to see if 'permission' contains 'request'.
311  *
312  * @param permission is the allowed CRUDN permission.
313  * @param request is the CRUDN permission being requested.
314  *
315  * @return true if 'permission' bits include all 'request' bits.
316  */
317 INLINE_API bool IsPermissionAllowingRequest(const uint16_t permission,
318     const uint16_t request)
319 {
320     bool allowed = (request == (request & permission));
321
322     OIC_LOG_V(INFO, TAG, "%s: ACE allows permission %#x, "
323         "requested permission %#x -> allowed = %u", __func__,
324         (uint32_t)permission, (uint32_t)request, (uint32_t)allowed);
325
326     return allowed;
327 }
328
329 /**
330  * Compare the passed subject to the wildcard (aka anonymous) subjectId.
331  *
332  * @return true if 'subject' is the wildcard, false if it is not.
333  */
334 INLINE_API bool IsWildCardSubject(OicUuid_t *subject)
335 {
336     if(NULL == subject)
337     {
338         return false;
339     }
340
341     // Because always comparing to string literal, use strcmp()
342     if(0 == memcmp(subject, &WILDCARD_SUBJECT_ID, sizeof(OicUuid_t)))
343     {
344         return true;
345     }
346     else
347     {
348         return false;
349     }
350 }
351
352 /**
353  * Check whether 'resource' is getting accessed within the valid time period.
354  *
355  * @param acl is the ACL to check.
356  *
357  * @return true if access is within valid time period or if the period or recurrence is not present.
358  * false if period and recurrence present and the access is not within valid time period.
359  */
360 static bool IsAccessWithinValidTime(const OicSecAce_t *ace)
361 {
362 #ifndef WITH_ARDUINO //Period & Recurrence not supported on Arduino due
363     //lack of absolute time
364     if (NULL== ace || NULL == ace->validities)
365     {
366         return true;
367     }
368
369     //periods & recurrences rules are paired.
370     if (NULL == ace->validities->recurrences)
371     {
372         return false;
373     }
374
375     OicSecValidity_t* validity =  NULL;
376     LL_FOREACH(ace->validities, validity)
377     {
378         for(size_t i = 0; i < validity->recurrenceLen; i++)
379         {
380             if (IOTVTICAL_VALID_ACCESS == IsRequestWithinValidTime(validity->period,
381                 validity->recurrences[i]))
382             {
383                 OIC_LOG(INFO, TAG, "Access request is in allowed time period");
384                 return true;
385             }
386         }
387     }
388     OIC_LOG(ERROR, TAG, "Access request is in invalid time period");
389     return false;
390
391 #else
392     return true;
393 #endif
394 }
395
396 /**
397  * Check whether 'resource' is in the passed ACE.
398  *
399  * @param[in] context Context->resourceUri contains the Resource being checked,
400  *                    as well as the discoverability of the Resource.
401  * @param[in] ace The ACE to check.
402  *
403  * @return true if match found, otherwise false.
404  */
405 static bool IsResourceInAce(SRMRequestContext_t *context, const OicSecAce_t *ace)
406 {
407     if (NULL == context || NULL == ace)
408     {
409         return false;
410     }
411
412     OicSecRsrc_t* rsrc = NULL;
413     LL_FOREACH(ace->resources, rsrc)
414     {
415         if (NULL == rsrc->href)
416         {
417             if (NO_WILDCARD != rsrc->wildcard)
418             {
419                 if ((ALL_RESOURCES == rsrc->wildcard) ||
420                     (ALL_DISCOVERABLE == rsrc->wildcard &&
421                         DISCOVERABLE_TRUE == context->discoverable) ||
422                     (ALL_NON_DISCOVERABLE == rsrc->wildcard &&
423                         DISCOVERABLE_FALSE == context->discoverable))
424                 {
425                     OIC_LOG_V(DEBUG, TAG, "%s: found wc type %d matching resource.",
426                         __func__, rsrc->wildcard);
427                     return true;
428                 }
429             }
430         }
431         else if (0 == strcmp(context->resourceUri, rsrc->href) ||
432                  0 == strcmp(WILDCARD_RESOURCE_URI, rsrc->href))
433         {
434             OIC_LOG_V(DEBUG, TAG, "%s: found href %s matching resource.",
435                         __func__, rsrc->href);
436             return true;
437         }
438     }
439     return false;
440 }
441
442 static void ProcessMatchingACE(SRMRequestContext_t *context, const OicSecAce_t *currentAce)
443 {
444     // Found the subject, so how about resource?
445     OIC_LOG_V(DEBUG, TAG, "%s: found ACE matching subject.", __func__);
446
447     // Subject was found, so err changes to Rsrc not found for now.
448     context->responseVal = ACCESS_DENIED_RESOURCE_NOT_FOUND;
449     OIC_LOG_V(DEBUG, TAG, "%s: Searching for resource...", __func__);
450     if (IsResourceInAce(context, currentAce))
451     {
452         OIC_LOG_V(INFO, TAG, "%s: found matching resource in ACE.", __func__);
453
454         // Found the resource, so it's down to valid period & permission.
455         context->responseVal = ACCESS_DENIED_INVALID_PERIOD;
456         if (IsAccessWithinValidTime(currentAce))
457         {
458             context->responseVal = ACCESS_DENIED_INSUFFICIENT_PERMISSION;
459             if (IsPermissionAllowingRequest(currentAce->permission,
460                 context->requestedPermission))
461             {
462                 context->responseVal = ACCESS_GRANTED;
463             }
464         }
465     }
466 }
467
468 /**
469  * Search for an ACE that matches the Resource URI, by conntype, subjectuuid, or roles.
470  * For each matching ACE, check whether it grants permission.
471  * If any ACE grants permission, set responseVal to ACCESS_GRANTED.
472  */
473 static void ProcessAccessRequest(SRMRequestContext_t *context)
474 {
475     if (NULL == context)
476     {
477         OIC_LOG(ERROR, TAG, "ProcessAccessRequest(): context is NULL, returning.");
478         return;
479     }
480
481     OIC_LOG_V(DEBUG, TAG, "Entering %s(%s)", __func__, context->resourceUri);
482
483     const OicSecAce_t *currentAce = NULL;
484     OicSecAce_t *aceSavePtr = NULL;
485
486     // Start out assuming subject not found.
487     context->responseVal = ACCESS_DENIED_SUBJECT_NOT_FOUND;
488
489     // First, check for a conntype ACE that matches.
490     OicSecConntype_t conntype;
491     if (context->secureChannel)
492     {
493         conntype = AUTH_CRYPT;
494     }
495     else
496     {
497         conntype = ANON_CLEAR;
498     }
499     do
500     {
501         currentAce = GetACLResourceDataByConntype(conntype, &aceSavePtr);
502
503         if (NULL != currentAce)
504         {
505             OIC_LOG_V(DEBUG, TAG, "%s: found conntype %s match; processing for access.",
506                 __func__, (AUTH_CRYPT == conntype?"auth-crypt":"anon-clear"));
507             ProcessMatchingACE(context, currentAce);
508         }
509         else
510         {
511             OIC_LOG_V(INFO, TAG, "%s:no ACL found matching conntype %s for resource %s",
512                 __func__, (AUTH_CRYPT == conntype?"auth-crypt":"anon-clear"), context->resourceUri);
513         }
514     } while ((NULL != currentAce) && !IsAccessGranted(context->responseVal));
515
516     // If not granted via conntype, try Subject-based match.
517     if (!IsAccessGranted(context->responseVal))
518     {
519         currentAce = NULL;
520         aceSavePtr = NULL;
521         do
522         {
523             currentAce = GetACLResourceData(&context->subjectUuid, &aceSavePtr);
524
525             if (NULL != currentAce)
526             {
527                 ProcessMatchingACE(context, currentAce);
528             }
529             else
530             {
531                 OIC_LOG_V(INFO, TAG, "%s:no ACL found matching subject for resource %s",
532                     __func__, context->resourceUri);
533             }
534         } while ((NULL != currentAce) && !IsAccessGranted(context->responseVal));
535     }
536
537 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
538     // If no subject ACE granted access, try role ACEs.
539     if (!IsAccessGranted(context->responseVal))
540     {
541         currentAce = NULL;
542         aceSavePtr = NULL;
543         OicSecRole_t *roles = NULL;
544         size_t roleCount = 0;
545         OCStackResult res = GetEndpointRoles(context->endPoint, &roles, &roleCount);
546         if (OC_STACK_OK != res)
547         {
548             OIC_LOG_V(ERROR, TAG, "Error getting asserted roles for endpoint: %d", res);
549         }
550         else
551         {
552             OIC_LOG_V(DEBUG, TAG, "Found %u asserted roles for endpoint", (unsigned int) roleCount);
553             do
554             {
555                 currentAce = GetACLResourceDataByRoles(roles, roleCount, &aceSavePtr);
556                 if (NULL != currentAce)
557                 {
558                     ProcessMatchingACE(context, currentAce);
559                 }
560                 else
561                 {
562                     OIC_LOG_V(INFO, TAG, "%s:no ACL found matching roles for resource %s",
563                         __func__, context->resourceUri);
564                 }
565             } while ((NULL != currentAce) && !IsAccessGranted(context->responseVal));
566
567             OICFree(roles);
568         }
569     }
570 #endif /* defined(__WITH_DTLS__) || defined(__WITH_TLS__) */
571
572     OIC_LOG_V(INFO, TAG, "%s: returning with responseVal = %s", __func__,
573         IsAccessGranted(context->responseVal) ? "ACCESS_GRANTED" : "ACCESS_DENIED");
574     return;
575 }
576
577 void CheckPermission(SRMRequestContext_t *context)
578 {
579     assert(NULL != context);
580     assert(0 != context->requestedPermission);
581     assert(0 == (context->requestedPermission & ~PERMISSION_FULL_CONTROL));
582
583     context->responseVal = ACCESS_DENIED_POLICY_ENGINE_ERROR;
584
585     // Before doing any ACL processing, check if request is a) coming
586     // from DevOwner AND b) the device is in Ready for OTM or SRESET state
587     // AND c) the request is for a SVR resource.
588     // If all 3 conditions are met, grant request.
589     OicSecDostype_t dos;
590     VERIFY_SUCCESS(TAG, OC_STACK_OK == GetDos(&dos), ERROR);
591
592     // Test for implicit access.
593     if (IsRequestFromDevOwner(context) &&
594         ((DOS_RFOTM == dos.state) || (DOS_SRESET == dos.state)) &&
595         (NOT_A_SVR_RESOURCE != context->resourceType))
596     {
597         OIC_LOG_V(INFO, TAG, "%s: granting implicit access to device owner", __func__);
598         context->responseVal = ACCESS_GRANTED;
599     }
600     // If not granted via DevOwner status and not a subowner,
601     // then check if request is for a SVR and coming from rowner.
602     else if (IsRequestFromResourceOwner(context))
603     {
604         OIC_LOG_V(INFO, TAG, "%s: granting implicit access to resource owner", __func__);
605         context->responseVal = ACCESS_GRANTED;
606     }
607 #ifdef MULTIPLE_OWNER
608     // Then check if request from SubOwner.
609     else if (IsRequestFromSubOwner(context))
610     {
611         if (IsValidRequestFromSubOwner(context))
612         {
613             OIC_LOG_V(INFO, TAG, "%s: granting implicit access to device sub-owner", __func__);
614             context->responseVal = ACCESS_GRANTED;
615         }
616     }
617 #endif //MULTIPLE_OWNER
618     else if ((DOS_RFNOP != dos.state) &&
619              (NOT_A_SVR_RESOURCE != context->resourceType) &&
620              IsRequestFromOwnershipTransferSession(context))
621     {
622         OIC_LOG_V(INFO, TAG, "%s: granting implicit access to OT session request", __func__);
623         context->responseVal = ACCESS_GRANTED;
624     }
625     // Else request is a "normal" request that must be tested against ACL.
626     else
627     {
628         ProcessAccessRequest(context);
629     }
630
631 exit:
632     return;
633 }