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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
24 #include "cainterface.h"
25 #include "resourcemanager.h"
26 #include "credresource.h"
27 #include "policyengine.h"
28 #include "srmutility.h"
30 #include "oic_string.h"
31 #include "oic_malloc.h"
32 #include "securevirtualresourcetypes.h"
33 #include "secureresourcemanager.h"
34 #include "srmresourcestrings.h"
39 #include "crlresource.h"
40 #endif // __WITH_X509__
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;
54 * A single global Policy Engine context will suffice as long
55 * as SRM is single-threaded.
57 PEContext_t g_policyEngineContext;
60 * Function to register provisoning API's response callback.
61 * @param respHandler response handler callback.
63 void SRMRegisterProvisioningResponseHandler(SPResponseCallback respHandler)
65 gSPResponseHandler = respHandler;
68 void SetResourceRequestType(PEContext_t *context, const char *resourceUri)
70 context->resourceType = GetSvrTypeFromUri(resourceUri);
73 static void SRMSendUnAuthorizedAccessresponse(PEContext_t *context)
75 CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
77 if (NULL == context ||
78 NULL == context->amsMgrContext->requestInfo)
80 OIC_LOG_V(ERROR, TAG, "%s : NULL Parameter(s)",__func__);
84 memcpy(&responseInfo.info, &(context->amsMgrContext->requestInfo->info),
85 sizeof(responseInfo.info));
86 responseInfo.info.payload = NULL;
87 responseInfo.result = CA_UNAUTHORIZED_REQ;
89 if (CA_STATUS_OK == CASendResponse(context->amsMgrContext->endpoint, &responseInfo))
91 OIC_LOG(DEBUG, TAG, "Succeed in sending response to a unauthorized request!");
95 OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
99 void SRMSendResponse(SRMAccessResponse_t responseVal)
101 OIC_LOG(DEBUG, TAG, "Sending response to remote device");
103 if (IsAccessGranted(responseVal) && gRequestHandler)
105 OIC_LOG_V(INFO, TAG, "%s : Access granted. Passing Request to RI layer", __func__);
106 if (!g_policyEngineContext.amsMgrContext->endpoint ||
107 !g_policyEngineContext.amsMgrContext->requestInfo)
109 OIC_LOG_V(ERROR, TAG, "%s : Invalid arguments", __func__);
110 SRMSendUnAuthorizedAccessresponse(&g_policyEngineContext);
113 gRequestHandler(g_policyEngineContext.amsMgrContext->endpoint,
114 g_policyEngineContext.amsMgrContext->requestInfo);
118 OIC_LOG_V(INFO, TAG, "%s : ACCESS_DENIED.", __func__);
119 SRMSendUnAuthorizedAccessresponse(&g_policyEngineContext);
123 //Resetting PE state to AWAITING_REQUEST
124 SetPolicyEngineState(&g_policyEngineContext, AWAITING_REQUEST);
128 * Handle the request from the SRM.
130 * @param endPoint object from which the response is received.
131 * @param requestInfo contains information for the request.
133 void SRMRequestHandler(const CAEndpoint_t *endPoint, const CARequestInfo_t *requestInfo)
135 OIC_LOG(DEBUG, TAG, "Received request from remote device");
137 if (!endPoint || !requestInfo)
139 OIC_LOG(ERROR, TAG, "Invalid arguments");
143 // Copy the subjectID
144 OicUuid_t subjectId = {.id = {0}};
145 memcpy(subjectId.id, requestInfo->info.identity.id, sizeof(subjectId.id));
147 //Check the URI has the query and skip it before checking the permission
148 char *uri = strstr(requestInfo->info.resourceUri, "?");
152 //Skip query and pass the resource uri
153 position = uri - requestInfo->info.resourceUri;
157 position = strlen(requestInfo->info.resourceUri);
159 if (MAX_URI_LENGTH < position || 0 > position)
161 OIC_LOG(ERROR, TAG, "Incorrect URI length");
164 SRMAccessResponse_t response = ACCESS_DENIED;
165 char newUri[MAX_URI_LENGTH + 1];
166 OICStrcpyPartial(newUri, MAX_URI_LENGTH + 1, requestInfo->info.resourceUri, position);
168 SetResourceRequestType(&g_policyEngineContext, newUri);
170 //New request are only processed if the policy engine state is AWAITING_REQUEST.
171 if (AWAITING_REQUEST == g_policyEngineContext.state)
173 OIC_LOG_V(DEBUG, TAG, "Processing request with uri, %s for method, %d",
174 requestInfo->info.resourceUri, requestInfo->method);
175 response = CheckPermission(&g_policyEngineContext, &subjectId, newUri,
176 GetPermissionFromCAMethod_t(requestInfo->method));
180 OIC_LOG_V(INFO, TAG, "PE state %d. Ignoring request with uri, %s for method, %d",
181 g_policyEngineContext.state, requestInfo->info.resourceUri, requestInfo->method);
184 if (IsAccessGranted(response) && gRequestHandler)
186 gRequestHandler(endPoint, requestInfo);
190 // Form a 'Error', 'slow response' or 'access deny' response and send to peer
191 CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
192 memcpy(&responseInfo.info, &(requestInfo->info), sizeof(responseInfo.info));
193 responseInfo.info.payload = NULL;
195 VERIFY_NON_NULL(TAG, gRequestHandler, ERROR);
197 if (ACCESS_WAITING_FOR_AMS == response)
199 OIC_LOG(INFO, TAG, "Sending slow response");
201 UpdateAmsMgrContext(&g_policyEngineContext, endPoint, requestInfo);
202 responseInfo.result = CA_EMPTY;
203 responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
208 * TODO Enhance this logic more to decide between
209 * CA_UNAUTHORIZED_REQ or CA_FORBIDDEN_REQ depending
210 * upon SRMAccessResponseReasonCode_t
212 OIC_LOG(INFO, TAG, "Sending for regular response");
213 responseInfo.result = CA_UNAUTHORIZED_REQ;
216 if (CA_STATUS_OK != CASendResponse(endPoint, &responseInfo))
218 OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
222 responseInfo.result = CA_INTERNAL_SERVER_ERROR;
223 if (CA_STATUS_OK != CASendResponse(endPoint, &responseInfo))
225 OIC_LOG(ERROR, TAG, "Failed in sending response to a unauthorized request!");
230 * Handle the response from the SRM.
232 * @param endPoint points to the remote endpoint.
233 * @param responseInfo contains response information from the endpoint.
235 void SRMResponseHandler(const CAEndpoint_t *endPoint, const CAResponseInfo_t *responseInfo)
237 OIC_LOG(DEBUG, TAG, "Received response from remote device");
239 // isProvResponse flag is to check whether response is catered by provisioning APIs or not.
240 // When token sent by CA response matches with token generated by provisioning request,
241 // gSPResponseHandler returns true and response is not sent to RI layer. In case
242 // gSPResponseHandler is null and isProvResponse is false response then the response is for
244 bool isProvResponse = false;
246 if (gSPResponseHandler)
248 isProvResponse = gSPResponseHandler(endPoint, responseInfo);
250 if (!isProvResponse && gResponseHandler)
252 gResponseHandler(endPoint, responseInfo);
257 * Handle the error from the SRM.
259 * @param endPoint is the remote endpoint.
260 * @param errorInfo contains error information from the endpoint.
262 void SRMErrorHandler(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errorInfo)
264 OIC_LOG_V(INFO, TAG, "Received error from remote device with result, %d for request uri, %s",
265 errorInfo->result, errorInfo->info.resourceUri);
268 gErrorHandler(endPoint, errorInfo);
272 OCStackResult SRMRegisterHandler(CARequestCallback reqHandler,
273 CAResponseCallback respHandler,
274 CAErrorCallback errHandler)
276 OIC_LOG(DEBUG, TAG, "SRMRegisterHandler !!");
277 if( !reqHandler || !respHandler || !errHandler)
279 OIC_LOG(ERROR, TAG, "Callback handlers are invalid");
280 return OC_STACK_INVALID_PARAM;
282 gRequestHandler = reqHandler;
283 gResponseHandler = respHandler;
284 gErrorHandler = errHandler;
287 #if defined(__WITH_DTLS__)
288 CARegisterHandler(SRMRequestHandler, SRMResponseHandler, SRMErrorHandler);
290 CARegisterHandler(reqHandler, respHandler, errHandler);
291 #endif /* __WITH_DTLS__ */
295 OCStackResult SRMRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
297 OIC_LOG(DEBUG, TAG, "SRMRegisterPersistentStorageHandler !!");
298 if(!persistentStorageHandler)
300 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
301 return OC_STACK_INVALID_PARAM;
303 gPersistentStorageHandler = persistentStorageHandler;
307 OCPersistentStorage* SRMGetPersistentStorageHandler()
309 return gPersistentStorageHandler;
312 OCStackResult SRMInitSecureResources()
314 // TODO: temporarily returning OC_STACK_OK every time until default
315 // behavior (for when SVR DB is missing) is settled.
316 InitSecureResources();
317 OCStackResult ret = OC_STACK_OK;
318 #if defined(__WITH_DTLS__)
319 if(CA_STATUS_OK != CARegisterDTLSCredentialsHandler(GetDtlsPskCredentials))
321 OIC_LOG(ERROR, TAG, "Failed to revert DTLS credential handler.");
322 ret = OC_STACK_ERROR;
325 #endif // (__WITH_DTLS__)
326 #if defined(__WITH_X509__)
327 CARegisterDTLSX509CredentialsHandler(GetDtlsX509Credentials);
328 CARegisterDTLSCrlHandler(GetDerCrl);
329 #endif // (__WITH_X509__)
334 void SRMDeInitSecureResources()
336 DestroySecureResources();
339 OCStackResult SRMInitPolicyEngine()
341 return InitPolicyEngine(&g_policyEngineContext);
344 void SRMDeInitPolicyEngine()
346 DeInitPolicyEngine(&g_policyEngineContext);
349 bool SRMIsSecurityResourceURI(const char* uri)
356 const char *rsrcs[] = {
365 OIC_RSRC_DPAIRING_URI,
369 // Remove query from Uri for resource string comparison
370 size_t uriLen = strlen(uri);
371 char *query = strchr (uri, '?');
374 uriLen = query - uri;
377 for (size_t i = 0; i < sizeof(rsrcs)/sizeof(rsrcs[0]); i++)
379 size_t svrLen = strlen(rsrcs[i]);
381 if ((uriLen == svrLen) &&
382 (strncmp(uri, rsrcs[i], svrLen) == 0))
392 * Get the Secure Virtual Resource (SVR) type from the URI.
393 * @param uri [IN] Pointer to URI in question.
394 * @return The OicSecSvrType_t of the URI passed (note: if not a Secure Virtual
395 Resource, e.g. /a/light, will return "NOT_A_SVR_TYPE" enum value)
397 static const char URI_QUERY_CHAR = '?';
398 OicSecSvrType_t GetSvrTypeFromUri(const char* uri)
402 return NOT_A_SVR_RESOURCE;
405 // Remove query from Uri for resource string comparison
406 size_t uriLen = strlen(uri);
407 char *query = strchr (uri, URI_QUERY_CHAR);
410 uriLen = query - uri;
415 svrLen = strlen(OIC_RSRC_ACL_URI);
418 if(0 == strncmp(uri, OIC_RSRC_ACL_URI, svrLen))
420 return OIC_R_ACL_TYPE;
424 svrLen = strlen(OIC_RSRC_AMACL_URI);
427 if(0 == strncmp(uri, OIC_RSRC_AMACL_URI, svrLen))
429 return OIC_R_AMACL_TYPE;
433 svrLen = strlen(OIC_RSRC_CRED_URI);
436 if(0 == strncmp(uri, OIC_RSRC_CRED_URI, svrLen))
438 return OIC_R_CRED_TYPE;
442 svrLen = strlen(OIC_RSRC_CRL_URI);
445 if(0 == strncmp(uri, OIC_RSRC_CRL_URI, svrLen))
447 return OIC_R_CRL_TYPE;
451 svrLen = strlen(OIC_RSRC_DOXM_URI);
454 if(0 == strncmp(uri, OIC_RSRC_DOXM_URI, svrLen))
456 return OIC_R_DOXM_TYPE;
460 svrLen = strlen(OIC_RSRC_DPAIRING_URI);
463 if(0 == strncmp(uri, OIC_RSRC_DPAIRING_URI, svrLen))
465 return OIC_R_DPAIRING_TYPE;
469 svrLen = strlen(OIC_RSRC_PCONF_URI);
472 if(0 == strncmp(uri, OIC_RSRC_PCONF_URI, svrLen))
474 return OIC_R_PCONF_TYPE;
478 svrLen = strlen(OIC_RSRC_PSTAT_URI);
481 if(0 == strncmp(uri, OIC_RSRC_PSTAT_URI, svrLen))
483 return OIC_R_PSTAT_TYPE;
487 svrLen = strlen(OIC_RSRC_SVC_URI);
490 if(0 == strncmp(uri, OIC_RSRC_SVC_URI, svrLen))
492 return OIC_R_SVC_TYPE;
496 svrLen = strlen(OIC_RSRC_SACL_URI);
499 if(0 == strncmp(uri, OIC_RSRC_SACL_URI, svrLen))
501 return OIC_R_SACL_TYPE;
505 return NOT_A_SVR_RESOURCE;