resource/csdk/security/src/secureresourcemanager.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
  21 #include <string.h>
  22 #include "ocstack.h"
  23 #include "logger.h"
  24 #include "cainterface.h"
  25 #include "resourcemanager.h"
  26 #include "credresource.h"
  27 #include "policyengine.h"
  28 #include "srmutility.h"
  29 #include "amsmgr.h"
  30 #include "oic_string.h"
  31 #include "oic_malloc.h"
  32 #include "securevirtualresourcetypes.h"
  33 #include "secureresourcemanager.h"
  34 #include "srmresourcestrings.h"
  35 #include "ocresourcehandler.h"
  36
  37 #if defined( __WITH_TLS__) || defined(__WITH_DTLS__)
  38 #include "pkix_interface.h"
  39 #endif //__WITH_TLS__ or __WITH_DTLS__
  40 #define TAG  "SRM"
  41
  42 //Request Callback handler
  43 static CARequestCallback gRequestHandler = NULL;
  44 //Response Callback handler
  45 static CAResponseCallback gResponseHandler = NULL;
  46 //Error Callback handler
  47 static CAErrorCallback gErrorHandler = NULL;
  48 //Persistent Storage callback handler for open/read/write/close/unlink
  49 static OCPersistentStorage *gPersistentStorageHandler =  NULL;
  50 //Provisioning response callback
  51 static SPResponseCallback gSPResponseHandler = NULL;
  52
  53 /**
  54  * A single global Policy Engine context will suffice as long
  55  * as SRM is single-threaded.
  56  */
  57 PEContext_t g_policyEngineContext;
  58
  59 /**
  60  * Function to register provisoning API's response callback.
  61  * @param respHandler response handler callback.
  62  */
  63 void SRMRegisterProvisioningResponseHandler(SPResponseCallback respHandler)
  64 {
  65     gSPResponseHandler = respHandler;
  66 }
  67
  68 void SetResourceRequestType(PEContext_t *context, const char *resourceUri)
  69 {
  70     context->resourceType = GetSvrTypeFromUri(resourceUri);
  71 }
  72
  73 static void SRMSendUnAuthorizedAccessresponse(PEContext_t *context)
  74 {
  75     CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
  76
  77     if (NULL == context ||
  78        NULL == context->amsMgrContext->requestInfo)
  79     {
  80         OIC_LOG_V(ERROR, TAG, "%s : NULL Parameter(s)",__func__);
  81         return;
  82     }
  83
  84     memcpy(&responseInfo.info, &(context->amsMgrContext->requestInfo->info),
  85             sizeof(responseInfo.info));
  86     responseInfo.info.payload = NULL;
  87     responseInfo.result = CA_UNAUTHORIZED_REQ;
  88     responseInfo.info.dataType = CA_RESPONSE_DATA;
  89
  90     if (CA_STATUS_OK == CASendResponse(context->amsMgrContext->endpoint, &responseInfo))
  91     {
  92         OIC_LOG(DEBUG, TAG, "Succeed in sending response to a unauthorized request!");
  93     }
  94     else
  95     {
  96         OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
  97     }
  98 }
  99
 100 void SRMSendResponse(SRMAccessResponse_t responseVal)
 101 {
 102     OIC_LOG(DEBUG, TAG, "Sending response to remote device");
 103
 104     if (IsAccessGranted(responseVal) && gRequestHandler)
 105     {
 106         OIC_LOG_V(INFO, TAG, "%s : Access granted. Passing Request to RI layer", __func__);
 107         if (!g_policyEngineContext.amsMgrContext->endpoint ||
 108             !g_policyEngineContext.amsMgrContext->requestInfo)
 109         {
 110             OIC_LOG_V(ERROR, TAG, "%s : Invalid arguments", __func__);
 111             SRMSendUnAuthorizedAccessresponse(&g_policyEngineContext);
 112             goto exit;
 113         }
 114         gRequestHandler(g_policyEngineContext.amsMgrContext->endpoint,
 115                 g_policyEngineContext.amsMgrContext->requestInfo);
 116     }
 117     else
 118     {
 119         OIC_LOG_V(INFO, TAG, "%s : ACCESS_DENIED.", __func__);
 120         SRMSendUnAuthorizedAccessresponse(&g_policyEngineContext);
 121     }
 122
 123 exit:
 124     //Resetting PE state to AWAITING_REQUEST
 125     SetPolicyEngineState(&g_policyEngineContext, AWAITING_REQUEST);
 126 }
 127
 128 /**
 129  * Handle the request from the SRM.
 130  *
 131  * @param endPoint object from which the response is received.
 132  * @param requestInfo contains information for the request.
 133  */
 134 void SRMRequestHandler(const CAEndpoint_t *endPoint, const CARequestInfo_t *requestInfo)
 135 {
 136     OIC_LOG(DEBUG, TAG, "Received request from remote device");
 137
 138     bool isRequestOverSecureChannel = false;
 139     if (!endPoint || !requestInfo)
 140     {
 141         OIC_LOG(ERROR, TAG, "Invalid arguments");
 142         return;
 143     }
 144
 145     // Copy the subjectID
 146     OicUuid_t subjectId = {.id = {0}};
 147     OicUuid_t nullSubjectId = {.id = {0}};
 148     memcpy(subjectId.id, requestInfo->info.identity.id, sizeof(subjectId.id));
 149
 150     // if subject id is null that means request is sent thru coap.
 151     if (memcmp(subjectId.id, nullSubjectId.id, sizeof(subjectId.id)) != 0)
 152     {
 153         OIC_LOG(INFO, TAG, "request over secure channel");
 154         isRequestOverSecureChannel = true;
 155     }
 156
 157     //Check the URI has the query and skip it before checking the permission
 158     char *uri = strstr(requestInfo->info.resourceUri, "?");
 159     int position = 0;
 160     if (uri)
 161     {
 162         //Skip query and pass the resource uri
 163         position = uri - requestInfo->info.resourceUri;
 164     }
 165     else
 166     {
 167         position = strlen(requestInfo->info.resourceUri);
 168     }
 169     if (MAX_URI_LENGTH < position  || 0 > position)
 170     {
 171         OIC_LOG(ERROR, TAG, "Incorrect URI length");
 172         return;
 173     }
 174     SRMAccessResponse_t response = ACCESS_DENIED;
 175     char newUri[MAX_URI_LENGTH + 1];
 176     OICStrcpyPartial(newUri, MAX_URI_LENGTH + 1, requestInfo->info.resourceUri, position);
 177
 178     SetResourceRequestType(&g_policyEngineContext, newUri);
 179
 180      // Form a 'Error', 'slow response' or 'access deny' response and send to peer
 181     CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
 182     memcpy(&responseInfo.info, &(requestInfo->info), sizeof(responseInfo.info));
 183     responseInfo.info.payload = NULL;
 184     responseInfo.info.dataType = CA_RESPONSE_DATA;
 185
 186     OCResource *resPtr = FindResourceByUri(newUri);
 187     if (NULL != resPtr)
 188     {
 189         // check whether request is for secure resource or not and it should not be a SVR resource
 190         if (((resPtr->resourceProperties) & OC_SECURE)
 191                             && (g_policyEngineContext.resourceType == NOT_A_SVR_RESOURCE))
 192         {
 193            // if resource is secure and request is over insecure channel
 194             if (!isRequestOverSecureChannel)
 195             {
 196                 // Reject all the requests over coap for secure resource.
 197                 responseInfo.result = CA_FORBIDDEN_REQ;
 198                 if (CA_STATUS_OK != CASendResponse(endPoint, &responseInfo))
 199                 {
 200                     OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
 201                 }
 202                 return;
 203             }
 204         }
 205     }
 206
 207     //New request are only processed if the policy engine state is AWAITING_REQUEST.
 208     if (AWAITING_REQUEST == g_policyEngineContext.state)
 209     {
 210         OIC_LOG_V(DEBUG, TAG, "Processing request with uri, %s for method, %d",
 211                 requestInfo->info.resourceUri, requestInfo->method);
 212         response = CheckPermission(&g_policyEngineContext, &subjectId, newUri,
 213                 GetPermissionFromCAMethod_t(requestInfo->method));
 214     }
 215     else
 216     {
 217         OIC_LOG_V(INFO, TAG, "PE state %d. Ignoring request with uri, %s for method, %d",
 218                 g_policyEngineContext.state, requestInfo->info.resourceUri, requestInfo->method);
 219     }
 220
 221     if (IsAccessGranted(response) && gRequestHandler)
 222     {
 223         gRequestHandler(endPoint, requestInfo);
 224         return;
 225     }
 226
 227     VERIFY_NON_NULL(TAG, gRequestHandler, ERROR);
 228
 229     if (ACCESS_WAITING_FOR_AMS == response)
 230     {
 231         OIC_LOG(INFO, TAG, "Sending slow response");
 232
 233         UpdateAmsMgrContext(&g_policyEngineContext, endPoint, requestInfo);
 234         responseInfo.result = CA_EMPTY;
 235         responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
 236     }
 237     else
 238     {
 239         /*
 240          * TODO Enhance this logic more to decide between
 241          * CA_UNAUTHORIZED_REQ or CA_FORBIDDEN_REQ depending
 242          * upon SRMAccessResponseReasonCode_t
 243          */
 244         OIC_LOG(INFO, TAG, "Sending for regular response");
 245         responseInfo.result = CA_UNAUTHORIZED_REQ;
 246     }
 247
 248     if (CA_STATUS_OK != CASendResponse(endPoint, &responseInfo))
 249     {
 250         OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
 251     }
 252     return;
 253 exit:
 254     responseInfo.result = CA_INTERNAL_SERVER_ERROR;
 255     if (CA_STATUS_OK != CASendResponse(endPoint, &responseInfo))
 256     {
 257         OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
 258     }
 259 }
 260
 261 /**
 262  * Handle the response from the SRM.
 263  *
 264  * @param endPoint points to the remote endpoint.
 265  * @param responseInfo contains response information from the endpoint.
 266  */
 267 void SRMResponseHandler(const CAEndpoint_t *endPoint, const CAResponseInfo_t *responseInfo)
 268 {
 269     OIC_LOG(DEBUG, TAG, "Received response from remote device");
 270
 271     // isProvResponse flag is to check whether response is catered by provisioning APIs or not.
 272     // When token sent by CA response matches with token generated by provisioning request,
 273     // gSPResponseHandler returns true and response is not sent to RI layer. In case
 274     // gSPResponseHandler is null and isProvResponse is false response then the response is for
 275     // RI layer.
 276     bool isProvResponse = false;
 277
 278     if (gSPResponseHandler)
 279     {
 280         isProvResponse = gSPResponseHandler(endPoint, responseInfo);
 281     }
 282     if (!isProvResponse && gResponseHandler)
 283     {
 284         gResponseHandler(endPoint, responseInfo);
 285     }
 286 }
 287
 288 /**
 289  * Handle the error from the SRM.
 290  *
 291  * @param endPoint is the remote endpoint.
 292  * @param errorInfo contains error information from the endpoint.
 293  */
 294 void SRMErrorHandler(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errorInfo)
 295 {
 296     OIC_LOG_V(INFO, TAG, "Received error from remote device with result, %d for request uri, %s",
 297             errorInfo->result, errorInfo->info.resourceUri);
 298     if (gErrorHandler)
 299     {
 300         gErrorHandler(endPoint, errorInfo);
 301     }
 302 }
 303
 304 OCStackResult SRMRegisterHandler(CARequestCallback reqHandler,
 305                                  CAResponseCallback respHandler,
 306                                  CAErrorCallback errHandler)
 307 {
 308     OIC_LOG(DEBUG, TAG, "SRMRegisterHandler !!");
 309     if( !reqHandler || !respHandler || !errHandler)
 310     {
 311         OIC_LOG(ERROR, TAG, "Callback handlers are invalid");
 312         return OC_STACK_INVALID_PARAM;
 313     }
 314     gRequestHandler = reqHandler;
 315     gResponseHandler = respHandler;
 316     gErrorHandler = errHandler;
 317
 318
 319 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
 320     CARegisterHandler(SRMRequestHandler, SRMResponseHandler, SRMErrorHandler);
 321 #else
 322     CARegisterHandler(reqHandler, respHandler, errHandler);
 323 #endif /* __WITH_DTLS__ */
 324     return OC_STACK_OK;
 325 }
 326
 327 OCStackResult SRMRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
 328 {
 329     OIC_LOG(DEBUG, TAG, "SRMRegisterPersistentStorageHandler !!");
 330     if(!persistentStorageHandler)
 331     {
 332         OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
 333         return OC_STACK_INVALID_PARAM;
 334     }
 335     gPersistentStorageHandler = persistentStorageHandler;
 336     return OC_STACK_OK;
 337 }
 338
 339 OCPersistentStorage* SRMGetPersistentStorageHandler()
 340 {
 341     return gPersistentStorageHandler;
 342 }
 343
 344 OCStackResult SRMInitSecureResources()
 345 {
 346     // TODO: temporarily returning OC_STACK_OK every time until default
 347     // behavior (for when SVR DB is missing) is settled.
 348     InitSecureResources();
 349     OCStackResult ret = OC_STACK_OK;
 350 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
 351     if (CA_STATUS_OK != CAregisterPskCredentialsHandler(GetDtlsPskCredentials))
 352     {
 353         OIC_LOG(ERROR, TAG, "Failed to revert TLS credential handler.");
 354         ret = OC_STACK_ERROR;
 355     }
 356     CAregisterPkixInfoHandler(GetPkixInfo);
 357     CAregisterGetCredentialTypesHandler(InitCipherSuiteList);
 358 #endif // __WITH_DTLS__ or __WITH_TLS__
 359     return ret;
 360 }
 361
 362 void SRMDeInitSecureResources()
 363 {
 364     DestroySecureResources();
 365 }
 366
 367 OCStackResult SRMInitPolicyEngine()
 368 {
 369     return InitPolicyEngine(&g_policyEngineContext);
 370 }
 371
 372 void SRMDeInitPolicyEngine()
 373 {
 374     DeInitPolicyEngine(&g_policyEngineContext);
 375 }
 376
 377 bool SRMIsSecurityResourceURI(const char* uri)
 378 {
 379     if (!uri)
 380     {
 381         return false;
 382     }
 383
 384     const char *rsrcs[] = {
 385         OIC_RSRC_SVC_URI,
 386         OIC_RSRC_AMACL_URI,
 387         OIC_RSRC_CRL_URI,
 388         OIC_RSRC_CRED_URI,
 389         OIC_RSRC_ACL_URI,
 390         OIC_RSRC_DOXM_URI,
 391         OIC_RSRC_PSTAT_URI,
 392         OIC_RSRC_PCONF_URI,
 393         OIC_RSRC_DPAIRING_URI,
 394         OIC_RSRC_VER_URI,
 395         OC_RSRVD_PROV_CRL_URL
 396     };
 397
 398     // Remove query from Uri for resource string comparison
 399     size_t uriLen = strlen(uri);
 400     char *query = strchr (uri, '?');
 401     if (query)
 402     {
 403         uriLen = query - uri;
 404     }
 405
 406     for (size_t i = 0; i < sizeof(rsrcs)/sizeof(rsrcs[0]); i++)
 407     {
 408         size_t svrLen = strlen(rsrcs[i]);
 409
 410         if ((uriLen == svrLen) &&
 411             (strncmp(uri, rsrcs[i], svrLen) == 0))
 412         {
 413             return true;
 414         }
 415     }
 416
 417     return false;
 418 }
 419
 420 /**
 421  * Get the Secure Virtual Resource (SVR) type from the URI.
 422  * @param   uri [IN] Pointer to URI in question.
 423  * @return  The OicSecSvrType_t of the URI passed (note: if not a Secure Virtual
 424             Resource, e.g. /a/light, will return "NOT_A_SVR_TYPE" enum value)
 425  */
 426 static const char URI_QUERY_CHAR = '?';
 427 OicSecSvrType_t GetSvrTypeFromUri(const char* uri)
 428 {
 429     if (!uri)
 430     {
 431         return NOT_A_SVR_RESOURCE;
 432     }
 433
 434     // Remove query from Uri for resource string comparison
 435     size_t uriLen = strlen(uri);
 436     char *query = strchr (uri, URI_QUERY_CHAR);
 437     if (query)
 438     {
 439         uriLen = query - uri;
 440     }
 441
 442     size_t svrLen = 0;
 443
 444     svrLen = strlen(OIC_RSRC_ACL_URI);
 445     if(uriLen == svrLen)
 446     {
 447         if(0 == strncmp(uri, OIC_RSRC_ACL_URI, svrLen))
 448         {
 449             return OIC_R_ACL_TYPE;
 450         }
 451     }
 452
 453     svrLen = strlen(OIC_RSRC_AMACL_URI);
 454     if(uriLen == svrLen)
 455     {
 456         if(0 == strncmp(uri, OIC_RSRC_AMACL_URI, svrLen))
 457         {
 458             return OIC_R_AMACL_TYPE;
 459         }
 460     }
 461
 462     svrLen = strlen(OIC_RSRC_CRED_URI);
 463     if(uriLen == svrLen)
 464     {
 465         if(0 == strncmp(uri, OIC_RSRC_CRED_URI, svrLen))
 466         {
 467             return OIC_R_CRED_TYPE;
 468         }
 469     }
 470
 471     svrLen = strlen(OIC_RSRC_CRL_URI);
 472     if(uriLen == svrLen)
 473     {
 474         if(0 == strncmp(uri, OIC_RSRC_CRL_URI, svrLen))
 475         {
 476             return OIC_R_CRL_TYPE;
 477         }
 478     }
 479
 480     svrLen = strlen(OIC_RSRC_DOXM_URI);
 481     if(uriLen == svrLen)
 482     {
 483         if(0 == strncmp(uri, OIC_RSRC_DOXM_URI, svrLen))
 484         {
 485             return OIC_R_DOXM_TYPE;
 486         }
 487     }
 488
 489     svrLen = strlen(OIC_RSRC_DPAIRING_URI);
 490     if(uriLen == svrLen)
 491     {
 492         if(0 == strncmp(uri, OIC_RSRC_DPAIRING_URI, svrLen))
 493         {
 494             return OIC_R_DPAIRING_TYPE;
 495         }
 496     }
 497
 498     svrLen = strlen(OIC_RSRC_PCONF_URI);
 499     if(uriLen == svrLen)
 500     {
 501         if(0 == strncmp(uri, OIC_RSRC_PCONF_URI, svrLen))
 502         {
 503             return OIC_R_PCONF_TYPE;
 504         }
 505     }
 506
 507     svrLen = strlen(OIC_RSRC_PSTAT_URI);
 508     if(uriLen == svrLen)
 509     {
 510         if(0 == strncmp(uri, OIC_RSRC_PSTAT_URI, svrLen))
 511         {
 512             return OIC_R_PSTAT_TYPE;
 513         }
 514     }
 515
 516     svrLen = strlen(OIC_RSRC_SVC_URI);
 517     if(uriLen == svrLen)
 518     {
 519         if(0 == strncmp(uri, OIC_RSRC_SVC_URI, svrLen))
 520         {
 521             return OIC_R_SVC_TYPE;
 522         }
 523     }
 524
 525     svrLen = strlen(OIC_RSRC_SACL_URI);
 526     if(uriLen == svrLen)
 527     {
 528         if(0 == strncmp(uri, OIC_RSRC_SACL_URI, svrLen))
 529         {
 530             return OIC_R_SACL_TYPE;
 531         }
 532     }
 533
 534     return NOT_A_SVR_RESOURCE;
 535 }