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
  22 #include "oic_malloc.h"
  23 #include "policyengine.h"
  24 #include "amsmgr.h"
  25 #include "resourcemanager.h"
  26 #include "securevirtualresourcetypes.h"
  27 #include "srmresourcestrings.h"
  28 #include "logger.h"
  29 #include "aclresource.h"
  30 #include "srmutility.h"
  31 #include "doxmresource.h"
  32 #include "iotvticalendar.h"
  33 #include "pstatresource.h"
  34 #include "dpairingresource.h"
  35 #include "pconfresource.h"
  36 #include "amaclresource.h"
  37 #include "credresource.h"
  38
  39 #define TAG "SRM-PE"
  40
  41 uint16_t GetPermissionFromCAMethod_t(const CAMethod_t method)
  42 {
  43     uint16_t perm = 0;
  44     switch (method)
  45     {
  46         case CA_GET:
  47             perm = (uint16_t)PERMISSION_READ;
  48             break;
  49         case CA_POST: // For now we treat all PUT & POST as Write
  50         case CA_PUT:  // because we don't know if resource exists yet.
  51             perm = (uint16_t)PERMISSION_WRITE;
  52             break;
  53         case CA_DELETE:
  54             perm = (uint16_t)PERMISSION_DELETE;
  55             break;
  56         default: // if not recognized, must assume requesting full control
  57             perm = (uint16_t)PERMISSION_FULL_CONTROL;
  58             break;
  59     }
  60     return perm;
  61 }
  62
  63 /**
  64  * Compares two OicUuid_t structs.
  65  *
  66  * @return true if the two OicUuid_t structs are equal, else false.
  67  */
  68 static bool UuidCmp(OicUuid_t *firstId, OicUuid_t *secondId)
  69 {
  70     // TODO use VERIFY macros to check for null when they are merged.
  71     if(NULL == firstId || NULL == secondId)
  72     {
  73         return false;
  74     }
  75     // Check empty uuid string
  76     if('\0' == firstId->id[0] || '\0' == secondId->id[0])
  77     {
  78         return false;
  79     }
  80     for(int i = 0; i < UUID_LENGTH; i++)
  81     {
  82         if(firstId->id[i] != secondId->id[i])
  83         {
  84             return false;
  85         }
  86     }
  87     return true;
  88 }
  89
  90 void SetPolicyEngineState(PEContext_t *context, const PEState_t state)
  91 {
  92     if (NULL == context)
  93     {
  94         return;
  95     }
  96
  97     // Clear stateful context variables.
  98     memset(&context->subject, 0, sizeof(context->subject));
  99     memset(&context->resource, 0, sizeof(context->resource));
 100     context->permission = 0x0;
 101     context->matchingAclFound = false;
 102     context->amsProcessing = false;
 103     context->retVal = ACCESS_DENIED_POLICY_ENGINE_ERROR;
 104
 105     FreeCARequestInfo(context->amsMgrContext->requestInfo);
 106     OICFree(context->amsMgrContext->endpoint);
 107     memset(context->amsMgrContext, 0, sizeof(AmsMgrContext_t));
 108
 109     // Set state.
 110     context->state = state;
 111 }
 112
 113 /**
 114  * Compare the request's subject to DevOwner.
 115  *
 116  * @return true if context->subjectId == GetDoxmDevOwner(), else false.
 117  */
 118 static bool IsRequestFromDevOwner(PEContext_t *context)
 119 {
 120     bool retVal = false;
 121     OicUuid_t ownerid;
 122
 123     if(NULL == context)
 124     {
 125         return retVal;
 126     }
 127
 128     if(OC_STACK_OK == GetDoxmDevOwnerId(&ownerid))
 129     {
 130         retVal = UuidCmp(&context->subject, &ownerid);
 131     }
 132
 133     return retVal;
 134 }
 135
 136 // TODO - remove these function placeholders as they are implemented
 137 // in the resource entity handler code.
 138 // Note that because many SVRs do not have a rowner, in those cases we
 139 // just return "OC_STACK_ERROR" which results in a "false" return by
 140 // IsRequestFromResourceOwner().
 141 // As these SVRs are revised to have a rowner, these functions should be
 142 // replaced (see pstatresource.c for example of GetPstatRownerId).
 143
 144 OCStackResult GetCrlRownerId(OicUuid_t *rowner)
 145 {
 146     rowner = NULL;
 147     return OC_STACK_ERROR;
 148 }
 149
 150 OCStackResult GetSaclRownerId(OicUuid_t *rowner)
 151 {
 152     rowner = NULL;
 153     return OC_STACK_ERROR;
 154 }
 155
 156 OCStackResult GetSvcRownerId(OicUuid_t *rowner)
 157 {
 158     rowner = NULL;
 159     return OC_STACK_ERROR;
 160 }
 161
 162 static GetSvrRownerId_t GetSvrRownerId[OIC_SEC_SVR_TYPE_COUNT] = {
 163     GetAclRownerId,
 164     GetAmaclRownerId,
 165     GetCredRownerId,
 166     GetCrlRownerId,
 167     GetDoxmRownerId,
 168     GetDpairingRownerId,
 169     GetPconfRownerId,
 170     GetPstatRownerId,
 171     GetSaclRownerId,
 172     GetSvcRownerId
 173 };
 174
 175 /**
 176  * Compare the request's subject to resource.ROwner.
 177  *
 178  * @return true if context->subjectId equals SVR rowner id, else return false
 179  */
 180 bool IsRequestFromResourceOwner(PEContext_t *context)
 181 {
 182     bool retVal = false;
 183     OicUuid_t resourceOwner;
 184
 185     if(NULL == context)
 186     {
 187         return false;
 188     }
 189
 190     if((OIC_R_ACL_TYPE <= context->resourceType) && \
 191         (OIC_SEC_SVR_TYPE_COUNT > context->resourceType))
 192     {
 193         if(OC_STACK_OK == GetSvrRownerId[(int)context->resourceType](&resourceOwner))
 194         {
 195             retVal = UuidCmp(&context->subject, &resourceOwner);
 196         }
 197     }
 198
 199     if(true == retVal)
 200     {
 201         OIC_LOG(INFO, TAG, "PE.IsRequestFromResourceOwner(): returning true");
 202     }
 203     else
 204     {
 205         OIC_LOG(INFO, TAG, "PE.IsRequestFromResourceOwner(): returning false");
 206     }
 207
 208     return retVal;
 209 }
 210
 211 inline static bool IsRequestSubjectEmpty(PEContext_t *context)
 212 {
 213     OicUuid_t emptySubject = {.id={}};
 214
 215     if(NULL == context)
 216     {
 217         return false;
 218     }
 219
 220     return (memcmp(&context->subject, &emptySubject, sizeof(OicUuid_t)) == 0) ?
 221             true : false;
 222 }
 223
 224 /**
 225  * Bitwise check to see if 'permission' contains 'request'.
 226  *
 227  * @param permission is the allowed CRUDN permission.
 228  * @param request is the CRUDN permission being requested.
 229  *
 230  * @return true if 'permission' bits include all 'request' bits.
 231  */
 232 static inline bool IsPermissionAllowingRequest(const uint16_t permission,
 233     const uint16_t request)
 234 {
 235     if (request == (request & permission))
 236     {
 237         return true;
 238     }
 239     else
 240     {
 241         return false;
 242     }
 243 }
 244
 245 /**
 246  * Compare the passed subject to the wildcard (aka anonymous) subjectId.
 247  *
 248  * @return true if 'subject' is the wildcard, false if it is not.
 249  */
 250 static inline bool IsWildCardSubject(OicUuid_t *subject)
 251 {
 252     if(NULL == subject)
 253     {
 254         return false;
 255     }
 256
 257     // Because always comparing to string literal, use strcmp()
 258     if(0 == memcmp(subject, &WILDCARD_SUBJECT_ID, sizeof(OicUuid_t)))
 259     {
 260         return true;
 261     }
 262     else
 263     {
 264         return false;
 265     }
 266 }
 267
 268 /**
 269  * Copy the subject, resource and permission into the context fields.
 270  */
 271 static void CopyParamsToContext(PEContext_t     *context,
 272                                 const OicUuid_t *subjectId,
 273                                 const char      *resource,
 274                                 const uint16_t  requestedPermission)
 275 {
 276     size_t length = 0;
 277
 278     if (NULL == context || NULL == subjectId || NULL == resource)
 279     {
 280         return;
 281     }
 282
 283     memcpy(&context->subject, subjectId, sizeof(OicUuid_t));
 284
 285     // Copy the resource string into context.
 286     length = strlen(resource) + 1;
 287     if (0 < length)
 288     {
 289         strncpy(context->resource, resource, length);
 290         context->resource[length - 1] = '\0';
 291     }
 292
 293     // Assign the permission field.
 294     context->permission = requestedPermission;
 295 }
 296
 297 /**
 298  * Check whether 'resource' is getting accessed within the valid time period.
 299  *
 300  * @param acl is the ACL to check.
 301  *
 302  * @return true if access is within valid time period or if the period or recurrence is not present.
 303  * false if period and recurrence present and the access is not within valid time period.
 304  */
 305 static bool IsAccessWithinValidTime(const OicSecAcl_t *acl)
 306 {
 307 #ifndef WITH_ARDUINO //Period & Recurrence not supported on Arduino due
 308                      //lack of absolute time
 309     if (NULL== acl || NULL == acl->periods || 0 == acl->prdRecrLen)
 310     {
 311         return true;
 312     }
 313
 314     //periods & recurrences rules are paired.
 315     if (NULL == acl->recurrences)
 316     {
 317         return false;
 318     }
 319
 320     for (size_t i = 0; i < acl->prdRecrLen; i++)
 321     {
 322         if (IOTVTICAL_VALID_ACCESS ==  IsRequestWithinValidTime(acl->periods[i],
 323             acl->recurrences[i]))
 324         {
 325             OIC_LOG(INFO, TAG, "Access request is in allowed time period");
 326             return true;
 327         }
 328     }
 329     OIC_LOG(ERROR, TAG, "Access request is in invalid time period");
 330     return false;
 331
 332 #else
 333     return true;
 334 #endif
 335 }
 336
 337 /**
 338  * Check whether 'resource' is in the passed ACL.
 339  *
 340  * @param resource is the resource being searched.
 341  * @param acl is the ACL to check.
 342  *
 343  * @return true if 'resource' found, otherwise false.
 344  */
 345  static bool IsResourceInAcl(const char *resource, const OicSecAcl_t *acl)
 346 {
 347     if (NULL== acl || NULL == resource)
 348     {
 349         return false;
 350     }
 351
 352      for (size_t n = 0; n < acl->resourcesLen; n++)
 353      {
 354          if (0 == strcmp(resource, acl->resources[n]) || // TODO null terms?
 355              0 == strcmp(WILDCARD_RESOURCE_URI, acl->resources[n]))
 356          {
 357              return true;
 358          }
 359     }
 360     return false;
 361 }
 362
 363
 364 /**
 365  * Find ACLs containing context->subject.
 366  * Search each ACL for requested resource.
 367  * If resource found, check for context->permission and period validity.
 368  * If the ACL is not found locally and AMACL for the resource is found
 369  * then sends the request to AMS service for the ACL.
 370  * Set context->retVal to result from first ACL found which contains
 371  * correct subject AND resource.
 372  */
 373 static void ProcessAccessRequest(PEContext_t *context)
 374 {
 375     OIC_LOG(DEBUG, TAG, "Entering ProcessAccessRequest()");
 376     if (NULL != context)
 377     {
 378         const OicSecAcl_t *currentAcl = NULL;
 379         OicSecAcl_t *savePtr = NULL;
 380
 381         // Start out assuming subject not found.
 382         context->retVal = ACCESS_DENIED_SUBJECT_NOT_FOUND;
 383
 384         // Loop through all ACLs with a matching Subject searching for the right
 385         // ACL for this request.
 386         do
 387         {
 388             OIC_LOG_V(DEBUG, TAG, "%s: getting ACL..." ,__func__);
 389             currentAcl = GetACLResourceData(&context->subject, &savePtr);
 390
 391             if (NULL != currentAcl)
 392             {
 393                 // Found the subject, so how about resource?
 394                 OIC_LOG_V(DEBUG, TAG, "%s:found ACL matching subject" ,__func__);
 395
 396                 // Subject was found, so err changes to Rsrc not found for now.
 397                 context->retVal = ACCESS_DENIED_RESOURCE_NOT_FOUND;
 398                 OIC_LOG_V(DEBUG, TAG, "%s:Searching for resource..." ,__func__);
 399                 if (IsResourceInAcl(context->resource, currentAcl))
 400                 {
 401                     OIC_LOG_V(INFO, TAG, "%s:found matching resource in ACL" ,__func__);
 402                     context->matchingAclFound = true;
 403
 404                     // Found the resource, so it's down to valid period & permission.
 405                     context->retVal = ACCESS_DENIED_INVALID_PERIOD;
 406                     if (IsAccessWithinValidTime(currentAcl))
 407                     {
 408                         context->retVal = ACCESS_DENIED_INSUFFICIENT_PERMISSION;
 409                         if (IsPermissionAllowingRequest(currentAcl->permission, context->permission))
 410                         {
 411                             context->retVal = ACCESS_GRANTED;
 412                         }
 413                     }
 414                 }
 415             }
 416             else
 417             {
 418                 OIC_LOG_V(INFO, TAG, "%s:no ACL found matching subject for resource %s",__func__, context->resource);
 419             }
 420         } while ((NULL != currentAcl) && (false == context->matchingAclFound));
 421
 422         if (IsAccessGranted(context->retVal))
 423         {
 424             OIC_LOG_V(INFO, TAG, "%s:Leaving ProcessAccessRequest(ACCESS_GRANTED)", __func__);
 425         }
 426         else
 427         {
 428             OIC_LOG_V(INFO, TAG, "%s:Leaving ProcessAccessRequest(ACCESS_DENIED)", __func__);
 429         }
 430     }
 431     else
 432     {
 433         OIC_LOG_V(ERROR, TAG, "%s:Leaving ProcessAccessRequest(context is NULL)", __func__);
 434     }
 435 }
 436
 437 SRMAccessResponse_t CheckPermission(PEContext_t     *context,
 438                                     const OicUuid_t *subjectId,
 439                                     const char      *resource,
 440                                     const uint16_t  requestedPermission)
 441 {
 442     SRMAccessResponse_t retVal = ACCESS_DENIED_POLICY_ENGINE_ERROR;
 443
 444     VERIFY_NON_NULL(TAG, context, ERROR);
 445     VERIFY_NON_NULL(TAG, subjectId, ERROR);
 446     VERIFY_NON_NULL(TAG, resource, ERROR);
 447
 448     // Each state machine context can only be processing one request at a time.
 449     // Therefore if the context is not in AWAITING_REQUEST or AWAITING_AMS_RESPONSE
 450     // state, return error. Otherwise, change to BUSY state and begin processing request.
 451     if (AWAITING_REQUEST == context->state || AWAITING_AMS_RESPONSE == context->state)
 452     {
 453         if (AWAITING_REQUEST == context->state)
 454         {
 455             SetPolicyEngineState(context, BUSY);
 456             CopyParamsToContext(context, subjectId, resource, requestedPermission);
 457         }
 458
 459         // Before doing any processing, check if request coming
 460         // from DevOwner and if so, always GRANT.
 461         if (IsRequestFromDevOwner(context))
 462         {
 463             context->retVal = ACCESS_GRANTED;
 464         }
 465         // Then check if request is for a SVR and coming from rowner
 466         else if (IsRequestFromResourceOwner(context))
 467         {
 468             context->retVal = ACCESS_GRANTED;
 469         }
 470         // Else request is a "normal" request that must be tested against ACL
 471         else
 472         {
 473             OicUuid_t saveSubject = {.id={}};
 474             bool isSubEmpty = IsRequestSubjectEmpty(context);
 475
 476             ProcessAccessRequest(context);
 477
 478             // If matching ACL not found, and subject != wildcard, try wildcard.
 479             if ((false == context->matchingAclFound) && \
 480               (false == IsWildCardSubject(&context->subject)))
 481             {
 482                 //Saving subject for Amacl check
 483                 memcpy(&saveSubject, &context->subject,sizeof(OicUuid_t));
 484
 485                 //Setting context subject to WILDCARD_SUBJECT_ID
 486                 //TODO: change ProcessAccessRequest method signature to
 487                 //ProcessAccessRequest(context, subject) so that context
 488                 //subject is not tempered.
 489                 memset(&context->subject, 0, sizeof(context->subject));
 490                 memcpy(&context->subject, &WILDCARD_SUBJECT_ID,sizeof(OicUuid_t));
 491                 ProcessAccessRequest(context); // TODO anonymous subj can result
 492                                                // in confusing err code return.
 493             }
 494
 495             //No local ACE found for the request so checking Amacl resource
 496             if (ACCESS_GRANTED != context->retVal)
 497             {
 498                 //If subject is not empty then restore the original subject
 499                 //else keep the subject to WILDCARD_SUBJECT_ID
 500                 if(!isSubEmpty)
 501                 {
 502                     memcpy(&context->subject, &saveSubject, sizeof(OicUuid_t));
 503                 }
 504
 505                 //FoundAmaclForRequest method checks for Amacl and fills up
 506                 //context->amsMgrContext->amsDeviceId with the AMS deviceId
 507                 //if Amacl was found for the requested resource.
 508                 if(FoundAmaclForRequest(context))
 509                 {
 510                     ProcessAMSRequest(context);
 511                 }
 512             }
 513         }
 514     }
 515     else
 516     {
 517         context->retVal = ACCESS_DENIED_POLICY_ENGINE_ERROR;
 518     }
 519
 520     // Capture retVal before resetting state for next request.
 521     retVal = context->retVal;
 522
 523    if (!context->amsProcessing)
 524     {
 525         OIC_LOG(INFO, TAG, "Resetting PE context and PE State to AWAITING_REQUEST");
 526         SetPolicyEngineState(context, AWAITING_REQUEST);
 527     }
 528
 529 exit:
 530     return retVal;
 531 }
 532
 533 OCStackResult InitPolicyEngine(PEContext_t *context)
 534 {
 535     if(NULL == context)
 536     {
 537         return OC_STACK_ERROR;
 538     }
 539
 540     context->amsMgrContext = (AmsMgrContext_t *)OICCalloc(1, sizeof(AmsMgrContext_t));
 541     if(NULL == context->amsMgrContext)
 542     {
 543         return OC_STACK_ERROR;
 544     }
 545
 546     SetPolicyEngineState(context, AWAITING_REQUEST);
 547     return OC_STACK_OK;
 548 }
 549
 550 void DeInitPolicyEngine(PEContext_t *context)
 551 {
 552     if(NULL != context)
 553     {
 554         SetPolicyEngineState(context, STOPPED);
 555         OICFree(context->amsMgrContext);
 556     }
 557     return;
 558 }