1 /* *****************************************************************
3 * Copyright 2015 Samsung Electronics All Rights Reserved.
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 * *****************************************************************/
25 #include "ocprovisioningmanager.h"
26 #include "secureresourceprovider.h"
28 #include "oic_malloc.h"
29 #include "aclresource.h"
30 #include "pstatresource.h"
31 #include "srmresourcestrings.h"
32 #include "credresource.h"
33 #include "doxmresource.h"
34 #include "pconfresource.h"
35 #include "credentialgenerator.h"
36 #include "cainterface.h"
39 #include "pmutility.h"
40 #include "provisioningdatabasemanager.h"
43 #include "ocpayload.h"
46 #include "crlresource.h"
52 * Macro to verify argument is not equal to NULL.
53 * eg: VERIFY_NON_NULL(TAG, ptrData, ERROR,OC_STACK_ERROR);
55 #define VERIFY_NON_NULL(tag, arg, logLevel, retValue) { if (NULL == (arg)) \
56 { OIC_LOG((logLevel), tag, #arg " is NULL"); return retValue; } }
59 * Macro to verify success of operation.
60 * eg: VERIFY_SUCCESS(TAG, OC_STACK_OK == foo(), ERROR, OC_STACK_ERROR);
62 #define VERIFY_SUCCESS(tag, op, logLevel, retValue) { if (!(op)) \
63 {OIC_LOG((logLevel), tag, #op " failed!!"); return retValue;} }
66 * Structure to carry credential data to callback.
68 typedef struct CredentialData CredentialData_t;
71 void *ctx; /**< Pointer to user context.**/
72 const OCProvisionDev_t *deviceInfo1; /**< Pointer to OCProvisionDev_t.**/
73 const OCProvisionDev_t *deviceInfo2; /**< Pointer to OCProvisionDev_t.**/
74 OicSecCred_t *credInfo; /**< Pointer to OicSecCred_t.**/
75 OicSecCred_t *credInfoFirst; /**< Pointer to OicSecCred_t.**/
76 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
77 OCProvisionResult_t *resArr; /**< Result array.**/
78 int numOfResults; /**< Number of results in result array.**/
82 * Structure to carry ACL provision API data to callback.
84 typedef struct ACLData ACLData_t;
87 void *ctx; /**< Pointer to user context.**/
88 const OCProvisionDev_t *deviceInfo; /**< Pointer to PMDevInfo_t.**/
89 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
90 OCProvisionResult_t *resArr; /**< Result array.**/
91 int numOfResults; /**< Number of results in result array.**/
95 * Structure to carry PCONF provision API data to callback.
97 typedef struct PconfData PconfData_t;
100 void *ctx; /**< Pointer to user context.**/
101 const OCProvisionDev_t *deviceInfo; /**< Pointer to PMDevInfo_t.**/
102 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
103 OCProvisionResult_t *resArr; /**< Result array.**/
104 int numOfResults; /**< Number of results in result array.**/
107 // Enum type index for unlink callback.
109 IDX_FIRST_DEVICE_RES = 0, // index for resulf of the first device
110 IDX_SECOND_DEVICE_RES, // index for result of the second device
111 IDX_DB_UPDATE_RES // index for result of updating provisioning database.
114 // Structure to carry unlink APIs data to callback.
115 typedef struct UnlinkData UnlinkData_t;
118 OCProvisionDev_t* unlinkDev; /**< Pointer to OCProvisionDev_t to be unlinked.**/
119 OCProvisionResult_t* unlinkRes; /**< Result array.**/
120 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
121 int numOfResults; /**< Number of results in result array.**/
124 //Example of DELETE cred request -> coaps://0.0.0.0:5684/oic/sec/cred?sub=(BASE64 ENCODED UUID)
125 const char * SRP_FORM_DELETE_CREDENTIAL = "coaps://[%s]:%d%s?%s=%s";
127 // Structure to carry remove APIs data to callback.
128 typedef struct RemoveData RemoveData_t;
131 OCProvisionDev_t* revokeTargetDev; /**< Device which is going to be revoked..**/
132 OCProvisionDev_t* linkedDevList; /**< A list of devices which have invalid credential.**/
133 OCProvisionResult_t* removeRes; /**< Result array.**/
134 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
135 size_t numOfResults; /**< Number of results in result array.**/
136 size_t sizeOfResArray;
143 static OCStackResult provisionCredentials(const OicSecCred_t *cred,
144 const OCProvisionDev_t *deviceInfo, CredentialData_t *credData,
145 OCClientResponseHandler responseHandler);
149 * Internal function to update result in result array.
151 static void registerResultForCredProvisioning(CredentialData_t *credData,
152 OCStackResult stackresult, int cause)
155 OIC_LOG_V(INFO,TAG,"value of credData->numOfResults is %d",credData->numOfResults);
158 memcpy(credData->resArr[(credData->numOfResults)].deviceId.id,
159 credData->deviceInfo1->doxm->deviceID.id,UUID_LENGTH);
163 memcpy(credData->resArr[(credData->numOfResults)].deviceId.id,
164 credData->deviceInfo2->doxm->deviceID.id,UUID_LENGTH);
166 credData->resArr[(credData->numOfResults)].res = stackresult;
167 ++(credData->numOfResults);
171 * Callback handler for handling callback of provisioning device 2.
173 * @param[in] ctx ctx value passed to callback from calling function.
174 * @param[in] UNUSED handle to an invocation
175 * @param[in] clientResponse Response from queries to remote servers.
176 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
177 * and OC_STACK_KEEP_TRANSACTION to keep it.
179 static OCStackApplicationResult provisionCredentialCB2(void *ctx, OCDoHandle UNUSED,
180 OCClientResponse *clientResponse)
182 VERIFY_NON_NULL(TAG, ctx, ERROR, OC_STACK_DELETE_TRANSACTION);
183 CredentialData_t *credData = (CredentialData_t *) ctx;
186 OCProvisionResultCB resultCallback = credData->resultCallback;
187 OIC_LOG(INFO, TAG, "provisionCredentialCB2 called");
190 if(OC_STACK_RESOURCE_CREATED == clientResponse->result)
192 registerResultForCredProvisioning(credData, OC_STACK_RESOURCE_CREATED, 2);
193 OCStackResult res = PDMLinkDevices(&credData->deviceInfo1->doxm->deviceID,
194 &credData->deviceInfo2->doxm->deviceID);
195 if (OC_STACK_OK != res)
197 OIC_LOG(ERROR, TAG, "Error occured on PDMLinkDevices");
198 return OC_STACK_DELETE_TRANSACTION;
200 OIC_LOG(INFO, TAG, "Link created successfully");
202 ((OCProvisionResultCB)(resultCallback))(credData->ctx, credData->numOfResults,
205 OICFree(credData->resArr);
207 return OC_STACK_DELETE_TRANSACTION;
211 OIC_LOG(INFO, TAG, "provisionCredentialCB2 received Null clientResponse");
212 registerResultForCredProvisioning(credData, OC_STACK_ERROR, 2);
213 ((OCProvisionResultCB)(resultCallback))(credData->ctx, credData->numOfResults,
216 OICFree(credData->resArr);
218 return OC_STACK_DELETE_TRANSACTION;
222 * Callback handler for handling callback of provisioning device 1.
224 * @param[in] ctx ctx value passed to callback from calling function.
225 * @param[in] UNUSED handle to an invocation
226 * @param[in] clientResponse Response from queries to remote servers.
227 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
228 * and OC_STACK_KEEP_TRANSACTION to keep it.
230 static OCStackApplicationResult provisionCredentialCB1(void *ctx, OCDoHandle UNUSED,
231 OCClientResponse *clientResponse)
233 VERIFY_NON_NULL(TAG, ctx, ERROR, OC_STACK_DELETE_TRANSACTION);
235 CredentialData_t* credData = (CredentialData_t*) ctx;
236 OICFree(credData->credInfoFirst);
237 const OCProvisionDev_t *deviceInfo = credData->deviceInfo2;
238 OicSecCred_t *credInfo = credData->credInfo;
239 const OCProvisionResultCB resultCallback = credData->resultCallback;
242 if (OC_STACK_RESOURCE_CREATED == clientResponse->result)
244 // send credentials to second device
245 registerResultForCredProvisioning(credData, OC_STACK_RESOURCE_CREATED,1);
246 OCStackResult res = provisionCredentials(credInfo, deviceInfo, credData,
247 provisionCredentialCB2);
248 DeleteCredList(credInfo);
249 if (OC_STACK_OK != res)
251 registerResultForCredProvisioning(credData, res,2);
252 ((OCProvisionResultCB)(resultCallback))(credData->ctx, credData->numOfResults,
255 OICFree(credData->resArr);
262 registerResultForCredProvisioning(credData, OC_STACK_ERROR,1);
263 ((OCProvisionResultCB)(resultCallback))(credData->ctx, credData->numOfResults,
266 OICFree(credData->resArr);
273 OIC_LOG(INFO, TAG, "provisionCredentialCB received Null clientResponse for first device");
274 registerResultForCredProvisioning(credData, OC_STACK_ERROR,1);
275 ((OCProvisionResultCB)(resultCallback))(credData->ctx, credData->numOfResults,
278 DeleteCredList(credInfo);
279 OICFree(credData->resArr);
283 return OC_STACK_DELETE_TRANSACTION;
289 * Internal function for handling credential generation and sending credential to resource server.
291 * @param[in] cred Instance of cred resource.
292 * @param[in] deviceInfo information about device to which credential is to be provisioned.
293 * @param[in] responseHandler callbak called by OC stack when request API receives response.
294 * @return OC_STACK_OK in case of success and other value otherwise.
296 static OCStackResult provisionCredentials(const OicSecCred_t *cred,
297 const OCProvisionDev_t *deviceInfo, CredentialData_t *credData,
298 OCClientResponseHandler responseHandler)
300 OCSecurityPayload* secPayload = (OCSecurityPayload*)OICCalloc(1, sizeof(OCSecurityPayload));
303 OIC_LOG(ERROR, TAG, "Failed to memory allocation");
304 return OC_STACK_NO_MEMORY;
306 secPayload->base.type = PAYLOAD_TYPE_SECURITY;
307 OCStackResult res = CredToCBORPayload(cred, &secPayload->securityData1, &secPayload->payloadSize);
308 if((OC_STACK_OK != res) && (NULL == secPayload->securityData1))
310 OCPayloadDestroy((OCPayload *)secPayload);
311 OIC_LOG(ERROR, TAG, "Failed to CredToCBORPayload");
312 return OC_STACK_NO_MEMORY;
315 OIC_LOG_V(INFO, TAG, "Credential for provisioning : %s",secPayload->securityData1);
316 char query[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
317 if(!PMGenerateQuery(true,
318 deviceInfo->endpoint.addr,
319 deviceInfo->securePort,
320 deviceInfo->connType,
321 query, sizeof(query), OIC_RSRC_CRED_URI))
323 OIC_LOG(ERROR, TAG, "DeviceDiscoveryHandler : Failed to generate query");
324 return OC_STACK_ERROR;
326 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
328 OCCallbackData cbData = {.context=NULL, .cb=NULL, .cd=NULL};
329 cbData.cb = responseHandler;
330 cbData.context = (void *) credData;
333 OCDoHandle handle = NULL;
334 OCMethod method = OC_REST_POST;
335 OCStackResult ret = OCDoResource(&handle, method, query, 0, (OCPayload*)secPayload,
336 deviceInfo->connType, OC_HIGH_QOS, &cbData, NULL, 0);
337 OIC_LOG_V(INFO, TAG, "OCDoResource::Credential provisioning returned : %d",ret);
338 if (ret != OC_STACK_OK)
340 OIC_LOG(ERROR, TAG, "OCStack resource error");
348 * Structure to carry certificate data to callback.
350 typedef struct CertificateData CertData_t;
351 struct CertificateData
353 void *ctx; /**< Pointer to user context.**/
354 const OCProvisionDev_t *deviceInfo; /**< Pointer to OCProvisionDev_t.**/
355 OicSecCred_t *credInfo; /**< Pointer to OicSecCred_t.**/
356 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
357 OCProvisionResult_t *resArr; /**< Result array.**/
358 int numOfResults; /**< Number of results in result array.**/
362 * Structure to carry CRL provision API data to callback.
364 typedef struct CRLData CRLData_t;
367 void *ctx; /**< Pointer to user context.**/
368 const OCProvisionDev_t *deviceInfo; /**< Pointer to PMDevInfo_t.**/
369 OCProvisionResultCB resultCallback; /**< Pointer to result callback.**/
370 OCProvisionResult_t *resArr; /**< Result array.**/
371 int numOfResults; /**< Number of results in result array.**/
375 * Internal function to update result in result array.
377 static void registerResultForCertProvisioning(CertData_t *certData,
378 OCStackResult stackresult)
381 OIC_LOG_V(INFO,TAG,"value of credData->numOfResults is %d",certData->numOfResults);
382 memcpy(certData->resArr[(certData->numOfResults)].deviceId.id,
383 certData->deviceInfo->doxm->deviceID.id,UUID_LENGTH);
384 certData->resArr[(certData->numOfResults)].res = stackresult;
385 ++(certData->numOfResults);
389 * Internal Function to store results in result array during ACL provisioning.
391 static void registerResultForCRLProvisioning(CRLData_t *crlData,
392 OCStackResult stackresult)
394 OIC_LOG_V(INFO, TAG, "Inside registerResultForCRLProvisioning crlData->numOfResults is %d\n",
395 crlData->numOfResults);
396 memcpy(crlData->resArr[(crlData->numOfResults)].deviceId.id,
397 crlData->deviceInfo->doxm->deviceID.id, UUID_LENGTH);
398 crlData->resArr[(crlData->numOfResults)].res = stackresult;
399 ++(crlData->numOfResults);
404 * Callback handler of SRPProvisionCRL.
406 * @param[in] ctx ctx value passed to callback from calling function.
407 * @param[in] UNUSED handle to an invocation
408 * @param[in] clientResponse Response from queries to remote servers.
409 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
410 * and OC_STACK_KEEP_TRANSACTION to keep it.
412 static OCStackApplicationResult SRPProvisionCRLCB(void *ctx, OCDoHandle UNUSED,
413 OCClientResponse *clientResponse)
415 OIC_LOG_V(INFO, TAG, "Inside SRPProvisionCRLCB.");
417 VERIFY_NON_NULL(TAG, ctx, ERROR, OC_STACK_DELETE_TRANSACTION);
418 CRLData_t *crlData = (CRLData_t*)ctx;
419 OCProvisionResultCB resultCallback = crlData->resultCallback;
423 if(OC_STACK_RESOURCE_CREATED == clientResponse->result)
425 registerResultForCRLProvisioning(crlData, OC_STACK_RESOURCE_CREATED);
426 ((OCProvisionResultCB)(resultCallback))(crlData->ctx, crlData->numOfResults,
429 OICFree(crlData->resArr);
431 return OC_STACK_DELETE_TRANSACTION;
434 registerResultForCRLProvisioning(crlData, OC_STACK_ERROR);
435 ((OCProvisionResultCB)(resultCallback))(crlData->ctx, crlData->numOfResults,
438 OIC_LOG_V(ERROR, TAG, "SRPProvisionCRLCB received Null clientResponse");
439 OICFree(crlData->resArr);
441 return OC_STACK_DELETE_TRANSACTION;
444 OCStackResult SRPProvisionCRL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
445 OicSecCrl_t *crl, OCProvisionResultCB resultCallback)
447 VERIFY_NON_NULL(TAG, selectedDeviceInfo, ERROR, OC_STACK_INVALID_PARAM);
448 VERIFY_NON_NULL(TAG, crl, ERROR, OC_STACK_INVALID_PARAM);
449 VERIFY_NON_NULL(TAG, resultCallback, ERROR, OC_STACK_INVALID_CALLBACK);
451 OCSecurityPayload* secPayload = (OCSecurityPayload*)OICCalloc(1, sizeof(OCSecurityPayload));
454 OIC_LOG(ERROR, TAG, "Failed to memory allocation");
455 return OC_STACK_NO_MEMORY;
458 secPayload->base.type = PAYLOAD_TYPE_SECURITY;
459 OCStackResult res = CrlToCBORPayload(crl, &secPayload->securityData1, &secPayload->payloadSize);
460 if((OC_STACK_OK != res) && (NULL == secPayload->securityData1))
463 OIC_LOG(ERROR, TAG, "Failed to BinToCrlJSON");
464 return OC_STACK_NO_MEMORY;
466 OIC_LOG_V(INFO, TAG, "CRL : %s", secPayload->securityData1);
468 char query[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
469 if(!PMGenerateQuery(true,
470 selectedDeviceInfo->endpoint.addr,
471 selectedDeviceInfo->securePort,
472 selectedDeviceInfo->connType,
473 query, sizeof(query), OIC_RSRC_CRL_URI))
475 OIC_LOG(ERROR, TAG, "DeviceDiscoveryHandler : Failed to generate query");
476 OCPayloadDestroy((OCPayload *)secPayload);
477 return OC_STACK_ERROR;
479 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
481 OCCallbackData cbData = {.context=NULL, .cb=NULL, .cd=NULL};
482 cbData.cb = &SRPProvisionCRLCB;
483 CRLData_t *crlData = (CRLData_t *) OICCalloc(1, sizeof(CRLData_t));
486 OCPayloadDestroy((OCPayload *)secPayload);
487 OIC_LOG(ERROR, TAG, "Unable to allocate memory");
488 return OC_STACK_NO_MEMORY;
491 crlData->deviceInfo = selectedDeviceInfo;
492 crlData->resultCallback = resultCallback;
493 crlData->numOfResults=0;
496 crlData->resArr = (OCProvisionResult_t*)OICCalloc(1, sizeof(OCProvisionResult_t));
497 if (crlData->resArr == NULL)
499 OCPayloadDestroy((OCPayload *)secPayload);
500 OIC_LOG(ERROR, TAG, "Unable to allocate memory");
501 return OC_STACK_NO_MEMORY;
504 cbData.context = (void *)crlData;
506 OCMethod method = OC_REST_POST;
507 OCDoHandle handle = NULL;
508 OIC_LOG(DEBUG, TAG, "Sending CRL info to resource server");
510 OCStackResult ret = OCDoResource(&handle, method, query,
511 &selectedDeviceInfo->endpoint, (OCPayload*)secPayload,
512 selectedDeviceInfo->connType, OC_HIGH_QOS, &cbData, NULL, 0);
514 if (ret != OC_STACK_OK)
516 OICFree(crlData->resArr);
524 * Internal function for handling credential generation and sending cretificate credential.
526 * @param[in] cred Instance of cred resource.
527 * @param[in] deviceInfo information about device to which credential is to be provisioned.
528 * @param[in] responseHandler callbak called by OC stack when request API receives response.
529 * @return OC_STACK_OK in case of success and other value otherwise.
531 static OCStackResult provisionCertCred(const OicSecCred_t *cred,
532 const OCProvisionDev_t *deviceInfo, CertData_t *certData,
533 OCClientResponseHandler responseHandler)
535 OCSecurityPayload* secPayload = (OCSecurityPayload*)OICCalloc(1, sizeof(OCSecurityPayload));
538 OIC_LOG(ERROR, TAG, "Failed to memory allocation");
539 return OC_STACK_NO_MEMORY;
541 secPayload->base.type = PAYLOAD_TYPE_SECURITY;
542 OCStackResult res = CredToCBORPayload(cred, &secPayload->securityData1,
543 &secPayload->payloadSize);
545 if ((OC_STACK_OK != res) || (NULL == secPayload->securityData1))
548 OIC_LOG(ERROR, TAG, "Failed to CredToCBORPayload");
549 return OC_STACK_NO_MEMORY;
552 OIC_LOG_V(INFO, TAG, "Credential for provisioning : %s",secPayload->securityData1);
553 char query[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
554 if(!PMGenerateQuery(true,
555 deviceInfo->endpoint.addr,
556 deviceInfo->securePort,
557 deviceInfo->connType,
558 query, sizeof(query), OIC_RSRC_CRED_URI))
560 OIC_LOG(ERROR, TAG, "DeviceDiscoveryHandler : Failed to generate query");
561 OCPayloadDestroy((OCPayload *)secPayload);
562 return OC_STACK_ERROR;
564 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
566 OCCallbackData cbData = {.context=NULL, .cb=NULL, .cd=NULL};
567 cbData.cb = responseHandler;
568 cbData.context = (void *) certData;
571 OCDoHandle handle = NULL;
572 OCMethod method = OC_REST_POST;
573 OCStackResult ret = OCDoResource(&handle, method, query, 0, (OCPayload*)secPayload,
574 deviceInfo->connType, OC_HIGH_QOS, &cbData, NULL, 0);
575 OIC_LOG_V(INFO, TAG, "OCDoResource::Certificate provisioning returned : %d",ret);
576 if (ret != OC_STACK_OK)
578 OIC_LOG(ERROR, TAG, "OCStack resource error");
585 * Callback handler for handling callback of certificate provisioning device.
587 * @param[in] ctx ctx value passed to callback from calling function.
588 * @param[in] UNUSED handle to an invocation
589 * @param[in] clientResponse Response from queries to remote servers.
590 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
591 * and OC_STACK_KEEP_TRANSACTION to keep it.
593 static OCStackApplicationResult provisionCertCB(void *ctx, OCDoHandle UNUSED,
594 OCClientResponse *clientResponse)
596 VERIFY_NON_NULL(TAG, ctx, ERROR, OC_STACK_DELETE_TRANSACTION);
597 CertData_t *certData = (CertData_t *) ctx;
600 OCProvisionResultCB resultCallback = certData->resultCallback;
601 OIC_LOG(INFO, TAG, "provisionCertCred called");
604 if(OC_STACK_RESOURCE_CREATED == clientResponse->result)
606 registerResultForCertProvisioning(certData, OC_STACK_RESOURCE_CREATED);
607 ((OCProvisionResultCB)(resultCallback))(certData->ctx, certData->numOfResults,
610 OICFree(certData->resArr);
612 return OC_STACK_DELETE_TRANSACTION;
616 OIC_LOG(INFO, TAG, "provisionCertCredCB received Null clientResponse");
617 registerResultForCertProvisioning(certData, OC_STACK_ERROR);
618 ((OCProvisionResultCB)(resultCallback))(certData->ctx, certData->numOfResults,
621 OICFree(certData->resArr);
623 return OC_STACK_DELETE_TRANSACTION;
625 #endif // __WITH_X509__
627 OCStackResult SRPProvisionCredentials(void *ctx, OicSecCredType_t type, size_t keySize,
628 const OCProvisionDev_t *pDev1,
629 const OCProvisionDev_t *pDev2,
630 OCProvisionResultCB resultCallback)
632 VERIFY_NON_NULL(TAG, pDev1, ERROR, OC_STACK_INVALID_PARAM);
633 if (SYMMETRIC_PAIR_WISE_KEY == type)
635 VERIFY_NON_NULL(TAG, pDev2, ERROR, OC_STACK_INVALID_PARAM);
637 VERIFY_NON_NULL(TAG, resultCallback, ERROR, OC_STACK_INVALID_CALLBACK);
639 if (SYMMETRIC_PAIR_WISE_KEY == type &&
640 !(OWNER_PSK_LENGTH_128 == keySize || OWNER_PSK_LENGTH_256 == keySize))
642 OIC_LOG(INFO, TAG, "Invalid key size");
643 return OC_STACK_INVALID_PARAM;
646 OIC_LOG(INFO, TAG, "In SRPProvisionCredentials");
648 if (SYMMETRIC_PAIR_WISE_KEY == type)
650 bool linkExisits = true;
651 OCStackResult res = PDMIsLinkExists(&pDev1->doxm->deviceID, &pDev2->doxm->deviceID, &linkExisits);
653 if (res != OC_STACK_OK)
655 OIC_LOG(ERROR, TAG, "Internal error occured");
660 OIC_LOG(ERROR, TAG, "Link already exists");
661 return OC_STACK_INVALID_PARAM;
665 OicUuid_t provTooldeviceID = {{0,}};
666 if (OC_STACK_OK != GetDoxmDeviceID(&provTooldeviceID))
668 OIC_LOG(ERROR, TAG, "Error while retrieving provisioning tool's device ID");
669 return OC_STACK_ERROR;
671 OIC_LOG(INFO, TAG, "retrieved deviceid");
674 case SYMMETRIC_PAIR_WISE_KEY:
676 const OCProvisionDev_t *firstDevice = pDev1;
677 const OCProvisionDev_t *secondDevice = pDev2;
679 OicSecCred_t *firstCred = NULL;
680 OicSecCred_t *secondCred = NULL;
681 OCStackResult res = PMGeneratePairWiseCredentials(type, keySize, &provTooldeviceID,
682 &firstDevice->doxm->deviceID, &secondDevice->doxm->deviceID,
683 &firstCred, &secondCred);
684 VERIFY_SUCCESS(TAG, (res==OC_STACK_OK), ERROR, OC_STACK_ERROR);
685 OIC_LOG(INFO, TAG, "Credentials generated successfully");
686 CredentialData_t *credData =
687 (CredentialData_t *) OICCalloc(1, sizeof(CredentialData_t));
688 if (NULL == credData)
692 OIC_LOG(ERROR, TAG, "Memory allocation problem");
693 return OC_STACK_NO_MEMORY;
695 credData->deviceInfo1 = firstDevice;
696 credData->deviceInfo2 = secondDevice;
697 credData->credInfo = secondCred;
699 credData->credInfoFirst = firstCred;
700 credData->numOfResults = 0;
701 credData->resultCallback = resultCallback;
702 // first call to provision creds to device1.
703 // second call to provision creds to device2.
706 (OCProvisionResult_t*)OICCalloc(noOfRiCalls, sizeof(OCProvisionResult_t));
707 if (NULL == credData->resArr)
712 OIC_LOG(ERROR, TAG, "Memory allocation problem");
713 return OC_STACK_NO_MEMORY;
715 res = provisionCredentials(firstCred, firstDevice, credData, &provisionCredentialCB1);
716 if (OC_STACK_OK != res)
718 DeleteCredList(firstCred);
719 DeleteCredList(secondCred);
720 OICFree(credData->resArr);
723 OIC_LOG_V(INFO, TAG, "provisionCredentials returned: %d",res);
724 VERIFY_SUCCESS(TAG, (res==OC_STACK_OK), ERROR, OC_STACK_ERROR);
728 case SIGNED_ASYMMETRIC_KEY:
730 const OCProvisionDev_t *firstDevice = pDev1;
731 OicSecCred_t *cred = NULL;
732 OCStackResult res = PMGenerateCertificateCredentials(&provTooldeviceID,
733 &firstDevice->doxm->deviceID,&cred);
734 VERIFY_SUCCESS(TAG, (res==OC_STACK_OK), ERROR, OC_STACK_ERROR);
735 OIC_LOG(INFO, TAG, "Certificate credentials generated successfully");
736 CertData_t *certData = (CertData_t *) OICCalloc(1, sizeof(CertData_t));
737 if (NULL == certData)
740 OIC_LOG(ERROR, TAG, "Memory allocation problem");
741 return OC_STACK_NO_MEMORY;
744 certData->deviceInfo = firstDevice;
746 certData->credInfo = cred;
747 certData->numOfResults = 0;
748 certData->resultCallback = resultCallback;
750 certData->resArr = (OCProvisionResult_t*)OICCalloc(1, sizeof(OCProvisionResult_t));
751 if (NULL == certData->resArr)
753 DeleteCredList(cred);
755 OIC_LOG(ERROR, TAG, "Memory allocation problem");
756 return OC_STACK_NO_MEMORY;
759 res = provisionCertCred(cred, firstDevice, certData, &provisionCertCB);
760 if (OC_STACK_OK != res)
762 OICFree(certData->resArr);
765 DeleteCredList(cred);
766 OIC_LOG_V(INFO, TAG, "provisionCertCredentials returned: %d",res);
773 OIC_LOG(ERROR, TAG, "Invalid option.");
774 return OC_STACK_INVALID_PARAM;
777 return OC_STACK_ERROR;
781 * Internal Function to store results in result array during ACL provisioning.
783 static void registerResultForACLProvisioning(ACLData_t *aclData,
784 OCStackResult stackresult)
786 OIC_LOG_V(INFO, TAG, "Inside registerResultForACLProvisioning aclData->numOfResults is %d\n",
787 aclData->numOfResults);
788 memcpy(aclData->resArr[(aclData->numOfResults)].deviceId.id,
789 aclData->deviceInfo->doxm->deviceID.id, UUID_LENGTH);
790 aclData->resArr[(aclData->numOfResults)].res = stackresult;
791 ++(aclData->numOfResults);
795 * Callback handler of SRPProvisionACL.
797 * @param[in] ctx ctx value passed to callback from calling function.
798 * @param[in] UNUSED handle to an invocation
799 * @param[in] clientResponse Response from queries to remote servers.
800 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
801 * and OC_STACK_KEEP_TRANSACTION to keep it.
803 static OCStackApplicationResult SRPProvisionACLCB(void *ctx, OCDoHandle UNUSED,
804 OCClientResponse *clientResponse)
806 OIC_LOG_V(INFO, TAG, "Inside SRPProvisionACLCB.");
808 VERIFY_NON_NULL(TAG, ctx, ERROR, OC_STACK_DELETE_TRANSACTION);
809 ACLData_t *aclData = (ACLData_t*)ctx;
810 OCProvisionResultCB resultCallback = aclData->resultCallback;
814 if(OC_STACK_RESOURCE_CREATED == clientResponse->result)
816 registerResultForACLProvisioning(aclData, OC_STACK_RESOURCE_CREATED);
817 ((OCProvisionResultCB)(resultCallback))(aclData->ctx, aclData->numOfResults,
820 OICFree(aclData->resArr);
822 return OC_STACK_DELETE_TRANSACTION;
825 registerResultForACLProvisioning(aclData, OC_STACK_ERROR);
826 ((OCProvisionResultCB)(resultCallback))(aclData->ctx, aclData->numOfResults,
829 OIC_LOG_V(ERROR, TAG, "SRPProvisionACLCB received Null clientResponse");
830 OICFree(aclData->resArr);
832 return OC_STACK_DELETE_TRANSACTION;
835 OCStackResult SRPProvisionACL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
836 OicSecAcl_t *acl, OCProvisionResultCB resultCallback)
838 VERIFY_NON_NULL(TAG, selectedDeviceInfo, ERROR, OC_STACK_INVALID_PARAM);
839 VERIFY_NON_NULL(TAG, acl, ERROR, OC_STACK_INVALID_PARAM);
840 VERIFY_NON_NULL(TAG, resultCallback, ERROR, OC_STACK_INVALID_CALLBACK);
842 OCSecurityPayload* secPayload = (OCSecurityPayload*)OICCalloc(1, sizeof(OCSecurityPayload));
845 OIC_LOG(ERROR, TAG, "Failed to memory allocation");
846 return OC_STACK_NO_MEMORY;
848 secPayload->base.type = PAYLOAD_TYPE_SECURITY;
849 if(OC_STACK_OK != AclToCBORPayload(acl, &secPayload->securityData1, &secPayload->payloadSize))
851 OCPayloadDestroy((OCPayload *)secPayload);
852 OIC_LOG(ERROR, TAG, "Failed to AclToCBORPayload");
853 return OC_STACK_NO_MEMORY;
855 char query[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
856 if(!PMGenerateQuery(true,
857 selectedDeviceInfo->endpoint.addr,
858 selectedDeviceInfo->securePort,
859 selectedDeviceInfo->connType,
860 query, sizeof(query), OIC_RSRC_ACL_URI))
862 OIC_LOG(ERROR, TAG, "DeviceDiscoveryHandler : Failed to generate query");
863 return OC_STACK_ERROR;
865 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
867 OCCallbackData cbData = {.context=NULL, .cb=NULL, .cd=NULL};
868 cbData.cb = &SRPProvisionACLCB;
869 ACLData_t *aclData = (ACLData_t *) OICCalloc(1, sizeof(ACLData_t));
872 OCPayloadDestroy((OCPayload *)secPayload);
873 OIC_LOG(ERROR, TAG, "Unable to allocate memory");
874 return OC_STACK_NO_MEMORY;
876 aclData->deviceInfo = selectedDeviceInfo;
877 aclData->resultCallback = resultCallback;
878 aclData->numOfResults=0;
880 // call to provision ACL to device1.
882 aclData->resArr = (OCProvisionResult_t*)OICCalloc(noOfRiCalls, sizeof(OCProvisionResult_t));
883 if (aclData->resArr == NULL)
886 OCPayloadDestroy((OCPayload *)secPayload);
887 OIC_LOG(ERROR, TAG, "Unable to allocate memory");
888 return OC_STACK_NO_MEMORY;
890 cbData.context = (void *)aclData;
892 OCMethod method = OC_REST_POST;
893 OCDoHandle handle = NULL;
894 OIC_LOG(DEBUG, TAG, "Sending ACL info to resource server");
895 OCStackResult ret = OCDoResource(&handle, method, query,
896 &selectedDeviceInfo->endpoint, (OCPayload*)secPayload,
897 selectedDeviceInfo->connType, OC_HIGH_QOS, &cbData, NULL, 0);
898 if (ret != OC_STACK_OK)
900 OICFree(aclData->resArr);
903 VERIFY_SUCCESS(TAG, (OC_STACK_OK == ret), ERROR, OC_STACK_ERROR);
908 * Internal Function to store results in result array during Direct-Pairing provisioning.
910 static void registerResultForDirectPairingProvisioning(PconfData_t *pconfData,
911 OCStackResult stackresult)
913 OIC_LOG_V(INFO, TAG, "Inside registerResultForDirectPairingProvisioning "
914 "pconfData->numOfResults is %d\n", pconfData->numOfResults);
915 memcpy(pconfData->resArr[(pconfData->numOfResults)].deviceId.id,
916 pconfData->deviceInfo->doxm->deviceID.id, UUID_LENGTH);
917 pconfData->resArr[(pconfData->numOfResults)].res = stackresult;
918 ++(pconfData->numOfResults);
922 * Callback handler of SRPProvisionDirectPairing.
924 * @param[in] ctx ctx value passed to callback from calling function.
925 * @param[in] UNUSED handle to an invocation
926 * @param[in] clientResponse Response from queries to remote servers.
927 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
928 * and OC_STACK_KEEP_TRANSACTION to keep it.
930 static OCStackApplicationResult SRPProvisionDirectPairingCB(void *ctx, OCDoHandle UNUSED,
931 OCClientResponse *clientResponse)
933 OIC_LOG_V(INFO, TAG, "Inside SRPProvisionDirectPairingCB.");
935 VERIFY_NON_NULL(TAG, ctx, ERROR, OC_STACK_DELETE_TRANSACTION);
936 PconfData_t *pconfData = (PconfData_t*)ctx;
937 OCProvisionResultCB resultCallback = pconfData->resultCallback;
941 if(OC_STACK_RESOURCE_CREATED == clientResponse->result)
943 registerResultForDirectPairingProvisioning(pconfData, OC_STACK_RESOURCE_CREATED);
944 ((OCProvisionResultCB)(resultCallback))(pconfData->ctx, pconfData->numOfResults,
947 OICFree(pconfData->resArr);
949 return OC_STACK_DELETE_TRANSACTION;
952 registerResultForDirectPairingProvisioning(pconfData, OC_STACK_ERROR);
953 ((OCProvisionResultCB)(resultCallback))(pconfData->ctx, pconfData->numOfResults,
956 OIC_LOG_V(ERROR, TAG, "SRPProvisionDirectPairingCB received Null clientResponse");
957 OICFree(pconfData->resArr);
959 return OC_STACK_DELETE_TRANSACTION;
962 OCStackResult SRPProvisionDirectPairing(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
963 OicSecPconf_t *pconf, OCProvisionResultCB resultCallback)
965 VERIFY_NON_NULL(TAG, selectedDeviceInfo, ERROR, OC_STACK_INVALID_PARAM);
966 VERIFY_NON_NULL(TAG, pconf, ERROR, OC_STACK_INVALID_PARAM);
967 VERIFY_NON_NULL(TAG, resultCallback, ERROR, OC_STACK_INVALID_CALLBACK);
969 // check direct-pairing capability
970 if (true != selectedDeviceInfo->doxm->dpc)
972 OIC_LOG(ERROR, TAG, "Resouce server does not have Direct-Pairing Capability ");
973 return OC_STACK_UNAUTHORIZED_REQ;
976 OicUuid_t provTooldeviceID = {.id={0}};
977 if (OC_STACK_OK != GetDoxmDeviceID(&provTooldeviceID))
979 OIC_LOG(ERROR, TAG, "Error while retrieving provisioning tool's device ID");
980 return OC_STACK_ERROR;
982 memcpy(&pconf->rowner, &provTooldeviceID, sizeof(OicUuid_t));
984 OCSecurityPayload* secPayload = (OCSecurityPayload*)OICCalloc(1, sizeof(OCSecurityPayload));
987 OIC_LOG(ERROR, TAG, "Failed to memory allocation");
988 return OC_STACK_NO_MEMORY;
990 secPayload->base.type = PAYLOAD_TYPE_SECURITY;
992 if (OC_STACK_OK != PconfToCBORPayload(pconf, &(secPayload->securityData1),
993 &(secPayload->payloadSize)))
995 OCPayloadDestroy((OCPayload*)secPayload);
996 OIC_LOG(ERROR, TAG, "Failed to PconfToCborPayload");
997 return OC_STACK_NO_MEMORY;
999 OIC_LOG_V(INFO, TAG, "PCONF : %s", secPayload->securityData1);
1001 char query[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
1002 if(!PMGenerateQuery(true,
1003 selectedDeviceInfo->endpoint.addr,
1004 selectedDeviceInfo->securePort,
1005 selectedDeviceInfo->connType,
1006 query, sizeof(query), OIC_RSRC_PCONF_URI))
1008 OIC_LOG(ERROR, TAG, "SRPProvisionDirectPairing : Failed to generate query");
1009 return OC_STACK_ERROR;
1011 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
1013 OCCallbackData cbData = {.context=NULL, .cb=NULL, .cd=NULL};
1014 cbData.cb = &SRPProvisionDirectPairingCB;
1015 PconfData_t *pconfData = (PconfData_t *) OICCalloc(1, sizeof(PconfData_t));
1016 if (NULL == pconfData)
1018 OCPayloadDestroy((OCPayload*)secPayload);
1019 OIC_LOG(ERROR, TAG, "Unable to allocate memory");
1020 return OC_STACK_NO_MEMORY;
1022 pconfData->deviceInfo = selectedDeviceInfo;
1023 pconfData->resultCallback = resultCallback;
1024 pconfData->numOfResults=0;
1025 pconfData->ctx = ctx;
1026 // call to provision PCONF to device1.
1027 int noOfRiCalls = 1;
1028 pconfData->resArr = (OCProvisionResult_t*)OICCalloc(noOfRiCalls, sizeof(OCProvisionResult_t));
1029 if (NULL == pconfData->resArr)
1032 OCPayloadDestroy((OCPayload*)secPayload);
1033 OIC_LOG(ERROR, TAG, "Unable to allocate memory");
1034 return OC_STACK_NO_MEMORY;
1036 cbData.context = (void *)pconfData;
1038 OCMethod method = OC_REST_POST;
1039 OCDoHandle handle = NULL;
1040 OIC_LOG(DEBUG, TAG, "Sending PCONF info to resource server");
1041 OCStackResult ret = OCDoResource(&handle, method, query,
1042 &selectedDeviceInfo->endpoint, (OCPayload*)secPayload,
1043 selectedDeviceInfo->connType, OC_LOW_QOS, &cbData, NULL, 0);
1044 if (OC_STACK_OK != ret)
1046 OICFree(pconfData->resArr);
1049 VERIFY_SUCCESS(TAG, (OC_STACK_OK == ret), ERROR, OC_STACK_ERROR);
1053 static void DeleteUnlinkData_t(UnlinkData_t *unlinkData)
1057 OICFree(unlinkData->unlinkDev);
1058 OICFree(unlinkData->unlinkRes);
1059 OICFree(unlinkData);
1063 static void registerResultForUnlinkDevices(UnlinkData_t *unlinkData, OCStackResult stackresult,
1066 if (NULL != unlinkData)
1068 OIC_LOG_V(INFO, TAG, "Inside registerResultForUnlinkDevices unlinkData->numOfResults is %d\n",
1069 unlinkData->numOfResults);
1070 OIC_LOG_V(INFO, TAG, "Stack result :: %d", stackresult);
1072 OicUuid_t *pUuid = &unlinkData->unlinkRes[(unlinkData->numOfResults)].deviceId;
1074 // Set result in the result array according to the position (devNum).
1075 if (idx != IDX_DB_UPDATE_RES)
1077 memcpy(pUuid->id, unlinkData->unlinkDev[idx].doxm->deviceID.id, sizeof(pUuid->id));
1080 { // When deivce ID is 000... this means it's the result of database update.
1081 memset(pUuid->id, 0, sizeof(pUuid->id));
1083 unlinkData->unlinkRes[(unlinkData->numOfResults)].res = stackresult;
1084 ++(unlinkData->numOfResults);
1085 OIC_LOG (INFO, TAG, "Out registerResultForUnlinkDevices");
1089 static OCStackResult SendDeleteCredentialRequest(void* ctx,
1090 OCClientResponseHandler respHandler,
1091 const OCProvisionDev_t* revokedDev,
1092 const OCProvisionDev_t* destDev)
1094 OIC_LOG(DEBUG, TAG, "IN SendDeleteCredentialRequest");
1096 if (NULL == ctx || NULL == respHandler || NULL == revokedDev || NULL == destDev)
1098 return OC_STACK_INVALID_PARAM;
1101 char base64Buff[B64ENCODE_OUT_SAFESIZE(sizeof(revokedDev->doxm->deviceID.id)) + 1] = {};
1102 uint32_t base64Len = 0;
1103 if (B64_OK != b64Encode(revokedDev->doxm->deviceID.id, sizeof(revokedDev->doxm->deviceID.id),
1104 base64Buff, sizeof(base64Buff), &base64Len))
1106 OIC_LOG(ERROR, TAG, "SendDeleteCredentialRequest : Failed to base64 encoding");
1107 return OC_STACK_ERROR;
1110 char reqBuf[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
1112 //coaps://0.0.0.0:5684/oic/sec/cred?sub=(BASE64 ENCODED UUID)
1113 snRet = snprintf(reqBuf, sizeof(reqBuf), SRP_FORM_DELETE_CREDENTIAL, destDev->endpoint.addr,
1114 destDev->securePort, OIC_RSRC_CRED_URI, OIC_JSON_SUBJECT_NAME, base64Buff);
1117 OIC_LOG_V(ERROR, TAG, "SendDeleteCredentialRequest : Error (snprintf) %d\n", snRet);
1118 return OC_STACK_ERROR;
1120 else if ((size_t)snRet >= sizeof(reqBuf))
1122 OIC_LOG_V(ERROR, TAG, "SendDeleteCredentialRequest : Truncated (snprintf) %d\n", snRet);
1123 return OC_STACK_ERROR;
1126 OCCallbackData cbData;
1127 memset(&cbData, 0, sizeof(cbData));
1128 cbData.context = ctx;
1129 cbData.cb = respHandler;
1131 OIC_LOG_V(INFO, TAG, "URI: %s",reqBuf);
1133 OIC_LOG(DEBUG, TAG, "Sending remove credential request to resource server");
1135 OCStackResult ret = OCDoResource(NULL, OC_REST_DELETE, reqBuf,
1136 &destDev->endpoint, NULL,
1137 CT_ADAPTER_IP, OC_HIGH_QOS, &cbData, NULL, 0);
1138 if (OC_STACK_OK != ret)
1140 OIC_LOG_V(ERROR, TAG, "SendDeleteCredentialRequest : Error in OCDoResource %d", ret);
1142 OIC_LOG(DEBUG, TAG, "OUT SendDeleteCredentialRequest");
1148 * Callback handler of unlink second device.
1150 * @param[in] ctx ctx value passed to callback from calling function.
1151 * @param[in] handle handle to an invocation
1152 * @param[in] clientResponse Response from queries to remote servers.
1153 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction and
1154 * OC_STACK_KEEP_TRANSACTION to keep it.
1156 static OCStackApplicationResult SRPUnlinkDevice2CB(void *unlinkCtx, OCDoHandle handle,
1157 OCClientResponse *clientResponse)
1160 OIC_LOG(DEBUG, TAG, "IN SRPUnlinkDevice2CB");
1161 VERIFY_NON_NULL(TAG, unlinkCtx, ERROR, OC_STACK_DELETE_TRANSACTION);
1162 UnlinkData_t* unlinkData = (UnlinkData_t*)unlinkCtx;
1166 OIC_LOG(DEBUG, TAG, "Valid client response for device 2");
1167 registerResultForUnlinkDevices(unlinkData, clientResponse->result, IDX_SECOND_DEVICE_RES);
1169 if (OC_STACK_RESOURCE_DELETED == clientResponse->result)
1171 OIC_LOG(DEBUG, TAG, "Credential of device2 revoked");
1175 OIC_LOG(ERROR, TAG, "Unable to delete credential information from device 2");
1176 unlinkData->resultCallback(unlinkData->ctx,
1177 unlinkData->numOfResults, unlinkData->unlinkRes, true);
1183 registerResultForUnlinkDevices(unlinkData, OC_STACK_INVALID_REQUEST_HANDLE,
1184 IDX_SECOND_DEVICE_RES);
1185 unlinkData->resultCallback(unlinkData->ctx,
1186 unlinkData->numOfResults, unlinkData->unlinkRes, true);
1187 OIC_LOG(ERROR, TAG, "SRPUnlinkDevice2CB received Null clientResponse");
1191 //Update provisioning DB when succes case.
1192 if (OC_STACK_OK != PDMUnlinkDevices(&unlinkData->unlinkDev[0].doxm->deviceID,
1193 &unlinkData->unlinkDev[1].doxm->deviceID))
1195 OIC_LOG(FATAL, TAG, "All requests are successfully done but update provisioning DB FAILED.");
1196 registerResultForUnlinkDevices(unlinkData, OC_STACK_INCONSISTENT_DB, IDX_DB_UPDATE_RES);
1197 unlinkData->resultCallback(unlinkData->ctx,
1198 unlinkData->numOfResults, unlinkData->unlinkRes, true);
1201 unlinkData->resultCallback(unlinkData->ctx, unlinkData->numOfResults, unlinkData->unlinkRes,
1205 DeleteUnlinkData_t(unlinkData);
1206 OIC_LOG(DEBUG, TAG, "OUT SRPUnlinkDevice2CB");
1207 return OC_STACK_DELETE_TRANSACTION;
1212 * Callback handler of unlink first device.
1214 * @param[in] ctx ctx value passed to callback from calling function.
1215 * @param[in] handle handle to an invocation
1216 * @param[in] clientResponse Response from queries to remote servers.
1217 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction and
1218 * OC_STACK_KEEP_TRANSACTION to keep it.
1220 static OCStackApplicationResult SRPUnlinkDevice1CB(void *unlinkCtx, OCDoHandle handle,
1221 OCClientResponse *clientResponse)
1223 OIC_LOG_V(INFO, TAG, "Inside SRPUnlinkDevice1CB ");
1224 VERIFY_NON_NULL(TAG, unlinkCtx, ERROR, OC_STACK_DELETE_TRANSACTION);
1225 UnlinkData_t* unlinkData = (UnlinkData_t*)unlinkCtx;
1230 OIC_LOG(DEBUG, TAG, "Valid client response for device 1");
1231 registerResultForUnlinkDevices(unlinkData, clientResponse->result, IDX_FIRST_DEVICE_RES);
1233 if (OC_STACK_RESOURCE_DELETED == clientResponse->result)
1235 OIC_LOG(DEBUG, TAG, "Credential of device 1 is revoked");
1237 // Second revocation request to second device.
1238 OCStackResult res = SendDeleteCredentialRequest((void*)unlinkData, &SRPUnlinkDevice2CB,
1239 &unlinkData->unlinkDev[0],
1240 &unlinkData->unlinkDev[1] /*Dest*/);
1241 OIC_LOG_V(DEBUG, TAG, "Credential revocation request device 2, result :: %d",res);
1242 if (OC_STACK_OK != res)
1244 OIC_LOG(ERROR, TAG, "Error while sending revocation request for device 2");
1245 registerResultForUnlinkDevices(unlinkData, OC_STACK_INVALID_REQUEST_HANDLE,
1246 IDX_SECOND_DEVICE_RES);
1247 unlinkData->resultCallback(unlinkData->ctx,
1248 unlinkData->numOfResults, unlinkData->unlinkRes, true);
1253 OIC_LOG(DEBUG, TAG, "Request for credential revocation successfully sent");
1254 return OC_STACK_DELETE_TRANSACTION;
1259 OIC_LOG(ERROR, TAG, "Unable to delete credential information from device 1");
1261 unlinkData->resultCallback(unlinkData->ctx, unlinkData->numOfResults,
1262 unlinkData->unlinkRes, true);
1268 OIC_LOG(DEBUG, TAG, "Invalid response from server");
1269 registerResultForUnlinkDevices(unlinkData, OC_STACK_INVALID_REQUEST_HANDLE,
1270 IDX_FIRST_DEVICE_RES );
1271 unlinkData->resultCallback(unlinkData->ctx,
1272 unlinkData->numOfResults, unlinkData->unlinkRes,
1274 OIC_LOG(ERROR, TAG, "SRPUnlinkDevice1CB received Null clientResponse");
1278 OIC_LOG_V(INFO, TAG, "Out SRPUnlinkDevice1CB");
1279 DeleteUnlinkData_t(unlinkData);
1280 return OC_STACK_DELETE_TRANSACTION;
1284 * Function to unlink devices.
1285 * This function will remove the credential & relationship between the two devices.
1287 * @param[in] ctx Application context would be returned in result callback
1288 * @param[in] pTargetDev1 first device information to be unlinked.
1289 * @param[in] pTargetDev2 second device information to be unlinked.
1290 * @param[in] resultCallback callback provided by API user, callback will be called when
1291 * device unlink is finished.
1292 * @return OC_STACK_OK in case of success and other value otherwise.
1294 OCStackResult SRPUnlinkDevices(void* ctx,
1295 const OCProvisionDev_t* pTargetDev1,
1296 const OCProvisionDev_t* pTargetDev2,
1297 OCProvisionResultCB resultCallback)
1299 OIC_LOG(INFO, TAG, "IN SRPUnlinkDevices");
1301 if (!pTargetDev1 || !pTargetDev2 || !resultCallback)
1303 OIC_LOG(INFO, TAG, "SRPUnlinkDevices : NULL parameters");
1304 return OC_STACK_INVALID_PARAM;
1306 OIC_LOG(INFO, TAG, "Unlinking following devices: ");
1307 PMPrintOCProvisionDev(pTargetDev1);
1308 PMPrintOCProvisionDev(pTargetDev2);
1310 // Mark the link status stale
1311 OCStackResult res = PDMSetLinkStale(&pTargetDev1->doxm->deviceID, &pTargetDev2->doxm->deviceID);
1312 if (OC_STACK_OK != res)
1314 OIC_LOG(FATAL, TAG, "unable to update DB. Try again.");
1318 UnlinkData_t* unlinkData = (UnlinkData_t*)OICCalloc(1, sizeof(UnlinkData_t));
1319 VERIFY_NON_NULL(TAG, unlinkData, ERROR, OC_STACK_NO_MEMORY);
1321 //Initialize unlink data
1322 unlinkData->ctx = ctx;
1323 unlinkData->unlinkDev = (OCProvisionDev_t*)OICCalloc(2, sizeof(OCProvisionDev_t));
1324 if (NULL == unlinkData->unlinkDev)
1326 OIC_LOG(ERROR, TAG, "Memory allocation failed");
1327 res = OC_STACK_NO_MEMORY;
1331 unlinkData->unlinkRes = (OCProvisionResult_t*)OICCalloc(3, sizeof(OCProvisionResult_t));
1332 if (NULL == unlinkData->unlinkRes)
1334 OIC_LOG(ERROR, TAG, "Memory allocation failed");
1335 res = OC_STACK_NO_MEMORY;
1339 memcpy(&unlinkData->unlinkDev[0], pTargetDev1, sizeof(OCProvisionDev_t));
1340 memcpy(&unlinkData->unlinkDev[1], pTargetDev2, sizeof(OCProvisionDev_t));
1342 unlinkData->numOfResults = 0;
1343 unlinkData->resultCallback = resultCallback;
1345 res = SendDeleteCredentialRequest((void*)unlinkData, &SRPUnlinkDevice1CB,
1346 &unlinkData->unlinkDev[1], &unlinkData->unlinkDev[0]);
1347 if (OC_STACK_OK != res)
1349 OIC_LOG(ERROR, TAG, "SRPUnlinkDevices : SendDeleteCredentialRequest failed");
1356 OIC_LOG(INFO, TAG, "OUT SRPUnlinkDevices");
1357 DeleteUnlinkData_t(unlinkData);
1361 static void DeleteRemoveData_t(RemoveData_t* pRemoveData)
1365 OICFree(pRemoveData->revokeTargetDev);
1366 OCDeleteDiscoveredDevices(pRemoveData->linkedDevList);
1367 OICFree(pRemoveData->removeRes);
1368 OICFree(pRemoveData);
1372 static void registerResultForRemoveDevice(RemoveData_t *removeData, OicUuid_t *pLinkedDevId,
1373 OCStackResult stackresult, bool hasError)
1375 OIC_LOG_V(INFO, TAG, "Inside registerResultForRemoveDevice removeData->numOfResults is %zu\n",
1376 removeData->numOfResults + 1);
1379 memcpy(removeData->removeRes[(removeData->numOfResults)].deviceId.id,
1380 &pLinkedDevId->id, sizeof(pLinkedDevId->id));
1384 memset(removeData->removeRes[(removeData->numOfResults)].deviceId.id,
1385 0, sizeof(pLinkedDevId->id) );
1387 removeData->removeRes[(removeData->numOfResults)].res = stackresult;
1388 removeData->hasError = hasError;
1389 ++(removeData->numOfResults);
1391 // If we get suffcient result from linked devices, we have to call user callback and do free
1392 if (removeData->sizeOfResArray == removeData->numOfResults)
1394 if(!removeData->hasError)
1396 // Remove device info from prvisioning database
1397 if (OC_STACK_OK != PDMDeleteDevice(&removeData->revokeTargetDev->doxm->deviceID))
1399 OIC_LOG(ERROR, TAG, "ResultForRemoveDevice : Failed to remove device in PDM.");
1400 removeData->hasError = true;
1403 removeData->resultCallback(removeData->ctx, removeData->numOfResults, removeData->removeRes,
1404 removeData->hasError);
1405 DeleteRemoveData_t(removeData);
1410 * Callback handler of unlink first device.
1412 * @param[in] ctx ctx value passed to callback from calling function.
1413 * @param[in] handle handle to an invocation
1414 * @param[in] clientResponse Response from queries to remote servers.
1415 * @return OC_STACK_DELETE_TRANSACTION to delete the transaction
1416 * and OC_STACK_KEEP_TRANSACTION to keep it.
1418 static OCStackApplicationResult SRPRemoveDeviceCB(void *delDevCtx, OCDoHandle handle,
1419 OCClientResponse *clientResponse)
1421 //Update the delete credential into delete device context
1422 //Save the deleted status in delDevCtx
1424 OIC_LOG_V(INFO, TAG, "Inside SRPRemoveDeviceCB.");
1425 VERIFY_NON_NULL(TAG, delDevCtx, ERROR, OC_STACK_DELETE_TRANSACTION);
1426 OCStackResult res = OC_STACK_ERROR;
1428 RemoveData_t* removeData = (RemoveData_t*)delDevCtx;
1433 OicUuid_t revDevUuid = {.id={0}};
1434 if(UUID_LENGTH == clientResponse->identity.id_length)
1436 memcpy(revDevUuid.id, clientResponse->identity.id, sizeof(revDevUuid.id));
1437 if (OC_STACK_RESOURCE_DELETED == clientResponse->result)
1439 res = PDMUnlinkDevices(&removeData->revokeTargetDev->doxm->deviceID, &revDevUuid);
1440 if (OC_STACK_OK != res)
1442 OIC_LOG(ERROR, TAG, "PDMSetLinkStale() FAIL: PDB is an obsolete one.");
1443 registerResultForRemoveDevice(removeData, &revDevUuid,
1444 OC_STACK_INCONSISTENT_DB, true);
1446 return OC_STACK_DELETE_TRANSACTION;
1449 registerResultForRemoveDevice(removeData, &revDevUuid,
1450 OC_STACK_RESOURCE_DELETED, false);
1454 registerResultForRemoveDevice(removeData, &revDevUuid,
1455 clientResponse->result, true);
1456 OIC_LOG(ERROR, TAG, "Unexpected result from DELETE credential request!");
1461 OIC_LOG_V(WARNING, TAG, "Incorrect length of device UUID was sent from %s:%d",
1462 clientResponse->devAddr.addr, clientResponse->devAddr.port);
1464 if (OC_STACK_RESOURCE_DELETED == clientResponse->result)
1467 * Since server's credential was deleted,
1468 * register result as OC_STACK_INCONSISTENT_DB with NULL UUID.
1471 OIC_LOG_V(ERROR, TAG, "But server's credential was deleted.");
1472 registerResultForRemoveDevice(removeData, NULL, OC_STACK_INCONSISTENT_DB, true);
1476 registerResultForRemoveDevice(removeData, NULL, clientResponse->result, true);
1482 registerResultForRemoveDevice(removeData, NULL, OC_STACK_ERROR, true);
1483 OIC_LOG(ERROR, TAG, "SRPRemoveDevices received Null clientResponse");
1488 OIC_LOG(WARNING, TAG, "SRPRemoveDevices received null context");
1491 return OC_STACK_DELETE_TRANSACTION;
1494 static OCStackResult GetListofDevToReqDeleteCred(const OCProvisionDev_t* pRevokeTargetDev,
1495 OCProvisionDev_t* pOwnedDevList,
1496 OCUuidList_t* pLinkedUuidList,
1497 OCProvisionDev_t** ppLinkedDevList,
1498 size_t *numOfLinkedDev)
1500 // pOwnedDevList could be NULL. It means no alived and owned device now.
1501 if (pRevokeTargetDev == NULL || pLinkedUuidList == NULL ||\
1502 ppLinkedDevList == NULL || numOfLinkedDev == NULL)
1504 return OC_STACK_INVALID_PARAM;
1508 OCUuidList_t *curUuid = NULL, *tmpUuid = NULL;
1509 LL_FOREACH_SAFE(pLinkedUuidList, curUuid, tmpUuid)
1511 // Mark the link status stale.
1512 OCStackResult res = PDMSetLinkStale(&curUuid->dev, &pRevokeTargetDev->doxm->deviceID);
1513 if (OC_STACK_OK != res)
1515 OIC_LOG(FATAL, TAG, "PDMSetLinkStale() FAIL: PDB is an obsolete one.");
1516 return OC_STACK_INCONSISTENT_DB;
1521 // If this linked device is alive (power-on), add the deivce to the list.
1522 OCProvisionDev_t *curDev = NULL, *tmpDev = NULL;
1523 LL_FOREACH_SAFE(pOwnedDevList, curDev, tmpDev)
1525 if (memcmp(curDev->doxm->deviceID.id, curUuid->dev.id, sizeof(curUuid->dev.id)) == 0)
1527 OCProvisionDev_t* targetDev = PMCloneOCProvisionDev(curDev);
1528 if (NULL == targetDev)
1530 OIC_LOG(ERROR, TAG, "SRPRemoveDevice : Cloning OCProvisionDev_t Failed.");
1531 return OC_STACK_NO_MEMORY;
1534 LL_PREPEND(*ppLinkedDevList, targetDev);
1541 *numOfLinkedDev = cnt;
1546 * Function to device revocation
1547 * This function will remove credential of target device from all devices in subnet.
1549 * @param[in] ctx Application context would be returned in result callback
1550 * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)
1551 * @param[in] pTargetDev Device information to be revoked.
1552 * @param[in] resultCallback callback provided by API user, callback will be called when
1553 * credential revocation is finished.
1554 * @return OC_STACK_OK in case of success and other value otherwise.
1555 * If OC_STACK_OK is returned, the caller of this API should wait for callback.
1556 * OC_STACK_CONTINUE means operation is success but no request is need to be initiated.
1558 OCStackResult SRPRemoveDevice(void* ctx, unsigned short waitTimeForOwnedDeviceDiscovery,
1559 const OCProvisionDev_t* pTargetDev, OCProvisionResultCB resultCallback)
1561 OIC_LOG(INFO, TAG, "IN SRPRemoveDevice");
1563 if (!pTargetDev || !resultCallback || 0 == waitTimeForOwnedDeviceDiscovery)
1565 OIC_LOG(INFO, TAG, "SRPRemoveDevice : NULL parameters");
1566 return OC_STACK_INVALID_PARAM;
1569 // Declare variables in here to handle error cases with goto statement.
1570 OCProvisionDev_t* pOwnedDevList = NULL;
1571 OCProvisionDev_t* pLinkedDevList = NULL;
1572 RemoveData_t* removeData = NULL;
1574 //1. Find all devices that has a credential of the revoked device
1575 OCUuidList_t* pLinkedUuidList = NULL;
1576 size_t numOfDevices = 0;
1577 OCStackResult res = OC_STACK_ERROR;
1578 res = PDMGetLinkedDevices(&pTargetDev->doxm->deviceID, &pLinkedUuidList, &numOfDevices);
1579 if (OC_STACK_OK != res)
1581 OIC_LOG(ERROR, TAG, "SRPRemoveDevice : Failed to get linked devices information");
1584 // if there is no related device, we can skip further process.
1585 if (0 == numOfDevices)
1587 OIC_LOG(DEBUG, TAG, "SRPRemoveDevice : No linked device found.");
1588 res = OC_STACK_CONTINUE;
1592 //2. Find owned device from the network
1593 res = PMDeviceDiscovery(waitTimeForOwnedDeviceDiscovery, true, &pOwnedDevList);
1594 if (OC_STACK_OK != res)
1596 OIC_LOG(ERROR, TAG, "SRPRemoveDevice : Failed to PMDeviceDiscovery");
1600 //3. Make a list of devices to send DELETE credential request
1601 // by comparing owned devices from provisioning database with mutlicast discovery result.
1602 size_t numOfLinkedDev = 0;
1603 res = GetListofDevToReqDeleteCred(pTargetDev, pOwnedDevList, pLinkedUuidList,
1604 &pLinkedDevList, &numOfLinkedDev);
1605 if (OC_STACK_OK != res)
1607 OIC_LOG(ERROR, TAG, "SRPRemoveDevice : GetListofDevToReqDeleteCred() failed");
1610 if (0 == numOfLinkedDev) // This case means, there is linked device but it's not alive now.
1611 { // So we don't have to send request message.
1612 OIC_LOG(DEBUG, TAG, "SRPRemoveDevice : No alived & linked device found.");
1613 res = OC_STACK_CONTINUE;
1617 // 4. Prepare RemoveData Context data.
1618 removeData = (RemoveData_t*)OICCalloc(1, sizeof(RemoveData_t));
1621 OIC_LOG(ERROR, TAG, "SRPRemoveDevices : Failed to memory allocation");
1622 res = OC_STACK_NO_MEMORY;
1626 removeData->revokeTargetDev = PMCloneOCProvisionDev(pTargetDev);
1627 if (!removeData->revokeTargetDev)
1629 OIC_LOG(ERROR, TAG, "SRPRemoveDevices : PMCloneOCProvisionDev Failed");
1630 res = OC_STACK_NO_MEMORY;
1634 removeData->removeRes =
1635 (OCProvisionResult_t*)OICCalloc(numOfLinkedDev, sizeof(OCProvisionResult_t));
1636 if (!removeData->removeRes)
1638 OIC_LOG(ERROR, TAG, "SRPRemoveDevices : Failed to memory allocation");
1639 res = OC_STACK_NO_MEMORY;
1643 removeData->ctx = ctx;
1644 removeData->linkedDevList = pLinkedDevList;
1645 removeData->resultCallback = resultCallback;
1646 removeData->numOfResults = 0;
1647 removeData->sizeOfResArray = numOfLinkedDev;
1648 removeData->hasError = false;
1650 // 5. Send DELETE credential request to linked devices.
1651 OCProvisionDev_t *curDev = NULL, *tmpDev = NULL;
1652 OCStackResult totalRes = OC_STACK_ERROR; /* variable for checking request is sent or not */
1653 LL_FOREACH_SAFE(pLinkedDevList, curDev, tmpDev)
1655 res = SendDeleteCredentialRequest((void*)removeData, &SRPRemoveDeviceCB,
1656 removeData->revokeTargetDev, curDev);
1657 if (OC_STACK_OK != res)
1659 OIC_LOG_V(ERROR, TAG, "SRPRemoveDevice : Fail to send the DELETE credential request to\
1660 %s:%u", curDev->endpoint.addr, curDev->endpoint.port);
1664 totalRes = OC_STACK_OK; // This means at least one request is successfully sent.
1668 PDMDestoryOicUuidLinkList(pLinkedUuidList); //TODO: Modify API name to have unified convention.
1669 PMDeleteDeviceList(pOwnedDevList);
1670 OIC_LOG(INFO, TAG, "OUT SRPRemoveDevice");
1672 return totalRes; // Caller of this API should wait callback if totalRes == OC_STACK_OK.
1675 PDMDestoryOicUuidLinkList(pLinkedUuidList);
1676 PMDeleteDeviceList(pOwnedDevList);
1677 PMDeleteDeviceList(pLinkedDevList);
1680 OICFree(removeData->revokeTargetDev);
1681 OICFree(removeData->removeRes);
1682 OICFree(removeData);
1684 OIC_LOG(INFO, TAG, "OUT ERROR case SRPRemoveDevice");