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 "oic_malloc.h"
23 #include "resourcemanager.h"
24 #include "securevirtualresourcetypes.h"
25 #include "srmresourcestrings.h"
28 #include "aclresource.h"
29 #include "amaclresource.h"
30 #include "srmutility.h"
32 #include "secureresourcemanager.h"
33 #include "doxmresource.h"
34 #include "policyengine.h"
35 #include "oic_string.h"
36 #include "caremotehandler.h"
39 #define TAG "SRM-AMSMGR"
42 //Callback for AMS service multicast discovery request.
43 static OCStackApplicationResult AmsMgrDiscoveryCallback(void *ctx, OCDoHandle handle,
44 OCClientResponse * clientResponse);
46 //Callback for unicast secured port discovery request.
47 static OCStackApplicationResult SecurePortDiscoveryCallback(void *ctx, OCDoHandle handle,
48 OCClientResponse * clientResponse);
50 //Callback for unicast ACL request
51 static OCStackApplicationResult AmsMgrAclReqCallback(void *ctx, OCDoHandle handle,
52 OCClientResponse * clientResponse);
55 OCStackResult DiscoverAmsService(PEContext_t *context)
57 OC_LOG(INFO, TAG, "IN DiscoverAmsService");
59 OCStackResult ret = OC_STACK_ERROR;
60 const char DOXM_DEVICEID_QUERY_FMT[] = "%s?%s=%s";
61 char uri[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {};
62 OCCallbackData cbData = {.context=NULL};
63 char base64Buff[B64ENCODE_OUT_SAFESIZE(sizeof(((OicUuid_t*)0)->id)) + 1] = {};
67 VERIFY_NON_NULL(TAG, context, ERROR);
68 b64Ret = b64Encode(context->amsMgrContext->amsDeviceId.id,
69 sizeof(context->amsMgrContext->amsDeviceId.id), base64Buff, sizeof(base64Buff), &outLen);
70 VERIFY_SUCCESS(TAG, B64_OK == b64Ret, ERROR);
71 snprintf(uri, sizeof(uri), DOXM_DEVICEID_QUERY_FMT, OIC_RSRC_DOXM_URI,
72 OIC_JSON_DEVICE_ID_NAME, base64Buff);
74 cbData.cb = &AmsMgrDiscoveryCallback;
75 cbData.context = (void*)context;
78 * If no good response was received for this discovery request,
79 * PE would be blocked forever waiting for AMS service to respond with the ACE.
80 * Need logic to reset the PE state and send ACCESS_DENIED response,
81 * when discovery response from AMS service is not received within certain time.
83 OC_LOG_V(INFO, TAG,"AMS Manager Sending Multicast Discovery with URI = %s", uri);
84 ret = OCDoResource(NULL, OC_REST_DISCOVER, uri, NULL, NULL,
85 CT_DEFAULT, OC_LOW_QOS, &cbData, NULL, 0);
88 OC_LOG(INFO, TAG, "Leaving DiscoverAmsService");
93 static OCStackApplicationResult AmsMgrDiscoveryCallback(void *ctx, OCDoHandle handle,
94 OCClientResponse * clientResponse)
96 OC_LOG_V(INFO, TAG, "%s Begin", __func__ );
100 !clientResponse->payload||
101 (PAYLOAD_TYPE_SECURITY != clientResponse->payload->type)||
102 (OC_STACK_OK != clientResponse->result))
104 OC_LOG_V(ERROR, TAG, "%s Invalid Response ", __func__);
105 return OC_STACK_KEEP_TRANSACTION;
109 PEContext_t *context = (PEContext_t *) ctx;
110 if (context->state != AWAITING_AMS_RESPONSE)
112 OC_LOG_V(ERROR, TAG, "%s Invalid PE State ", __func__);
113 return OC_STACK_DELETE_TRANSACTION;
116 OicSecDoxm_t *doxm = NULL;
117 OC_LOG_V(INFO, TAG, "Doxm DeviceId Discovery response = %s\n",
118 ((OCSecurityPayload*)clientResponse->payload)->securityData);
119 doxm = JSONToDoxmBin(((OCSecurityPayload*)clientResponse->payload)->securityData);
121 //As doxm is NULL amsmgr can't test if response from trusted AMS service
122 //so keep the transaction.
125 OC_LOG_V(ERROR, TAG, "%s : Unable to convert JSON to Binary",__func__);
126 return OC_STACK_KEEP_TRANSACTION;
129 OicUuid_t deviceId = {.id={}};
130 memcpy(&deviceId, &doxm->deviceID, sizeof(deviceId));
133 /* TODO : By assuming that the first response received is the actual
134 * AMS service, a 'bad device' can cause DoS attack.
136 if (memcmp(&context->amsMgrContext->amsDeviceId, &deviceId,
137 sizeof(context->amsMgrContext->amsDeviceId)) == 0)
139 OC_LOG(INFO, TAG, "AMS Manager Sending unicast discovery to get secured port info");
140 //Sending Unicast discovery to get secure port information
141 if(OC_STACK_OK == SendUnicastSecurePortDiscovery(context, &clientResponse->devAddr,
142 clientResponse->connType))
144 context->retVal = ACCESS_WAITING_FOR_AMS;
145 return OC_STACK_DELETE_TRANSACTION;
148 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
149 SRMSendResponse(context->retVal);
150 return OC_STACK_DELETE_TRANSACTION;
154 OCStackResult SendUnicastSecurePortDiscovery(PEContext_t *context,OCDevAddr *devAddr,
155 OCConnectivityType connType)
157 OC_LOG(INFO, TAG, "IN SendUnicastSecurePortDiscovery");
159 const char RES_DOXM_QUERY_FMT[] = "%s?%s=%s";
160 OCCallbackData cbData = {.context=NULL};
161 char uri[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {};
162 snprintf(uri, sizeof(uri), RES_DOXM_QUERY_FMT, OC_RSRVD_WELL_KNOWN_URI,
163 OC_RSRVD_RESOURCE_TYPE, OIC_RSRC_TYPE_SEC_DOXM);
165 cbData.cb = &SecurePortDiscoveryCallback;
166 cbData.context = context;
168 OC_LOG_V(INFO, TAG, "AMS Manager Sending Unicast Discovery with URI = %s", uri);
170 return OCDoResource(NULL, OC_REST_DISCOVER, uri, devAddr, NULL,
171 connType, OC_LOW_QOS, &cbData, NULL, 0);
174 static OCStackApplicationResult SecurePortDiscoveryCallback(void *ctx, OCDoHandle handle,
175 OCClientResponse * clientResponse)
177 OC_LOG(INFO, TAG, "In SecurePortDiscoveryCallback");
181 !clientResponse->payload||
182 (PAYLOAD_TYPE_DISCOVERY != clientResponse->payload->type)||
183 (OC_STACK_OK != clientResponse->result))
185 OC_LOG_V(ERROR, TAG, "%s Invalid Response ", __func__);
186 SRMSendResponse(ACCESS_DENIED_AMS_SERVICE_ERROR);
187 return OC_STACK_DELETE_TRANSACTION;
190 PEContext_t *context = (PEContext_t *) ctx;
192 if (context->state != AWAITING_AMS_RESPONSE)
194 OC_LOG_V(ERROR, TAG, "%s Invalid PE State ", __func__);
195 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
196 SRMSendResponse(context->retVal);
197 return OC_STACK_DELETE_TRANSACTION;
199 OCResourcePayload* resPayload = ((OCDiscoveryPayload*)clientResponse->payload)->resources;
201 //Verifying if the ID of the sender is an AMS service that this device trusts.
203 memcmp(context->amsMgrContext->amsDeviceId.id,
204 ((OCDiscoveryPayload*)clientResponse->payload)->sid,
206 sizeof(context->amsMgrContext->amsDeviceId.id)) != 0)
208 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
209 SRMSendResponse(context->retVal);
210 return OC_STACK_DELETE_TRANSACTION;
213 if (resPayload && resPayload->secure)
215 if(OC_STACK_OK == SendAclReq(context, &clientResponse->devAddr, clientResponse->connType,
218 return OC_STACK_DELETE_TRANSACTION;
221 OC_LOG(INFO, TAG, "Can not find secure port information");
222 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
223 SRMSendResponse(context->retVal);
224 return OC_STACK_DELETE_TRANSACTION;
228 OCStackResult SendAclReq(PEContext_t *context, OCDevAddr *devAddr, OCConnectivityType connType,
229 uint16_t securedPort)
231 OCStackResult ret = OC_STACK_ERROR;
232 const char GET_ACE_QUERY_FMT[] = "%s?%s=%s;%s=%s";
233 char base64Buff[B64ENCODE_OUT_SAFESIZE(sizeof(((OicUuid_t*)0)->id)) + 1] = {};
235 char uri[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {};
236 OCCallbackData cbData = {.context=NULL};
237 OCDevAddr destAddr = {.adapter = OC_ADAPTER_IP};
240 VERIFY_NON_NULL(TAG, context, ERROR);
241 VERIFY_NON_NULL(TAG, devAddr, ERROR);
243 b64Ret = b64Encode(context->subject.id, sizeof(context->subject.id),
244 base64Buff, sizeof(base64Buff), &outLen);
245 VERIFY_SUCCESS(TAG, B64_OK == b64Ret, ERROR);
247 snprintf(uri, sizeof(uri), GET_ACE_QUERY_FMT, OIC_RSRC_ACL_URI,
248 OIC_JSON_SUBJECT_NAME, base64Buff,
249 OIC_JSON_RESOURCES_NAME, context->resource);
251 cbData.cb = &AmsMgrAclReqCallback;
252 cbData.context = context;
256 destAddr.flags = (OCTransportFlags)(destAddr.flags | OC_FLAG_SECURE);
257 destAddr.port = securedPort;
259 OC_LOG_V(INFO, TAG, "AMS Manager Sending Unicast ACL request with URI = %s", uri);
260 ret = OCDoResource(NULL, OC_REST_GET, uri, &destAddr, NULL,
261 connType, OC_LOW_QOS, &cbData, NULL, 0);
264 OC_LOG_V(INFO, TAG, "%s returns %d ", __func__, ret);
269 static OCStackApplicationResult AmsMgrAclReqCallback(void *ctx, OCDoHandle handle,
270 OCClientResponse * clientResponse)
272 OC_LOG_V(INFO, TAG, "%s Begin", __func__ );
275 PEContext_t *context = (PEContext_t *) ctx;
276 SRMAccessResponse_t rsps;
280 !clientResponse->payload||
281 (PAYLOAD_TYPE_SECURITY != clientResponse->payload->type) ||
282 (clientResponse->result != OC_STACK_OK))
284 SRMSendResponse(ACCESS_DENIED_AMS_SERVICE_ERROR);
288 if (context->state != AWAITING_AMS_RESPONSE)
290 OC_LOG_V(ERROR, TAG, "%s Invalid State ", __func__);
291 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
292 SRMSendResponse(context->retVal);
293 return OC_STACK_DELETE_TRANSACTION;
296 // Verify before installing ACL if the ID of the sender of this ACL is an AMS
297 //service that this device trusts.
298 rsps = ACCESS_DENIED;
299 if((UUID_LENGTH == clientResponse->identity.id_length) &&
300 memcmp(context->amsMgrContext->amsDeviceId.id, clientResponse->identity.id,
301 sizeof(context->amsMgrContext->amsDeviceId.id)) == 0)
304 InstallNewACL(((OCSecurityPayload*)clientResponse->payload)->securityData);
305 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
307 OC_LOG_V(INFO, TAG, "%s : Calling checkPermission", __func__);
308 rsps = CheckPermission(context, &context->subject, context->resource, context->permission);
309 VERIFY_SUCCESS(TAG, (true == IsAccessGranted(rsps)), ERROR);
311 OC_LOG_V(INFO, TAG, "%sAccess granted, Calling SRMCallCARequestHandler", __func__);
312 context->retVal = ACCESS_GRANTED;
313 SRMSendResponse(context->retVal);
314 return OC_STACK_DELETE_TRANSACTION;
318 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
319 SRMSendResponse(context->retVal);
320 FreeCARequestInfo(context->amsMgrContext->requestInfo);
321 OICFree(context->amsMgrContext->endpoint);
322 return OC_STACK_DELETE_TRANSACTION;
326 OCStackResult UpdateAmsMgrContext(PEContext_t *context, const CAEndpoint_t *endpoint,
327 const CARequestInfo_t *requestInfo)
329 OCStackResult ret = OC_STACK_ERROR;
331 //The AmsMgr context endpoint and requestInfo will be free from ,
332 //AmsMgrAclReqCallback function
333 if(context->amsMgrContext->endpoint)
335 OICFree(context->amsMgrContext->endpoint);
336 context->amsMgrContext->endpoint = NULL;
338 context->amsMgrContext->endpoint = (CAEndpoint_t *)OICCalloc(1, sizeof(CAEndpoint_t ));
339 VERIFY_NON_NULL(TAG, context->amsMgrContext->endpoint, ERROR);
340 *context->amsMgrContext->endpoint = *endpoint;
342 if(context->amsMgrContext->requestInfo)
344 FreeCARequestInfo(context->amsMgrContext->requestInfo);
345 context->amsMgrContext->requestInfo = NULL;
347 context->amsMgrContext->requestInfo = CACloneRequestInfo(requestInfo);
348 VERIFY_NON_NULL(TAG, context->amsMgrContext->requestInfo, ERROR);
354 void FreeCARequestInfo(CARequestInfo_t *requestInfo)
356 OICFree(requestInfo->info.token);
357 OICFree(requestInfo->info.options);
358 OICFree(requestInfo->info.payload);
359 OICFree(requestInfo->info.resourceUri);
360 OICFree(requestInfo);
364 //This method checks for Amacl resource. If Amacl is found then it fills up
365 //context->amsMgrContext->amsDeviceId with amsID of the Amacl else leaves it empty.
366 bool FoundAmaclForRequest(PEContext_t *context)
368 OC_LOG_V(INFO, TAG, "%s:no ACL found. Searching for AMACL",__func__);
371 VERIFY_NON_NULL(TAG, context, ERROR);
372 memset(&context->amsMgrContext->amsDeviceId, 0, sizeof(context->amsMgrContext->amsDeviceId));
374 //Call amacl resource function to get the AMS service deviceID for the resource
375 if(OC_STACK_OK == AmaclGetAmsDeviceId(context->resource, &context->amsMgrContext->amsDeviceId))
377 OC_LOG_V(INFO, TAG, "%s:AMACL found for the requested resource %s",
378 __func__, context->resource);
383 OC_LOG_V(INFO, TAG, "%s:AMACL found for the requested resource %s",
384 __func__, context->resource);
393 void ProcessAMSRequest(PEContext_t *context)
395 OicUuid_t emptyUuid = {.id={}};
396 OC_LOG_V(INFO, TAG, "Entering %s", __func__);
399 if((false == context->matchingAclFound) && (false == context->amsProcessing))
401 context->amsProcessing = true;
403 //Checking if context AMS deviceId is empty
404 if(memcmp(&context->amsMgrContext->amsDeviceId, &emptyUuid, sizeof(OicUuid_t)) != 0 )
406 if(OC_STACK_OK == DiscoverAmsService(context))
408 context->retVal = ACCESS_WAITING_FOR_AMS;
412 context->retVal = ACCESS_DENIED_AMS_SERVICE_ERROR;
419 OC_LOG_V(INFO, TAG, "Leaving %s(context is NULL)", __func__);
422 if(ACCESS_WAITING_FOR_AMS == context->retVal )
424 OC_LOG_V(INFO, TAG, "Leaving %s(WAITING_FOR_AMS)", __func__);