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 * *****************************************************************/
20 #ifndef _POSIX_C_SOURCE
21 #define _POSIX_C_SOURCE 200112L
24 #include "iotivity_config.h"
33 #include "oic_malloc.h"
34 #include "oic_string.h"
39 #include "ocpayload.h"
41 #include "securevirtualresourcetypes.h"
42 #include "srmresourcestrings.h" //@note: SRM's internal header
43 #include "doxmresource.h" //@note: SRM's internal header
44 #include "pstatresource.h" //@note: SRM's internal header
45 #include "verresource.h" //@note: SRM's internal header
48 #include "pmutility.h"
50 #include "srmutility.h"
52 #define TAG ("OIC_PM_UTILITY")
54 typedef struct _DiscoveryInfo{
55 OCProvisionDev_t **ppDevicesList;
56 OCProvisionDev_t *pCandidateList;
57 bool isOwnedDiscovery;
58 bool isSingleDiscovery;
60 const OicUuid_t *targetId;
64 * Function to discover secre port information through unicast
66 * @param[in] discoveryInfo The pointer of discovery information to matain result of discovery
67 * @param[in] clientResponse Response information(It will contain payload)
69 * @return OC_STACK_OK on success otherwise error.
71 static OCStackResult SecurePortDiscovery(DiscoveryInfo* discoveryInfo,
72 const OCClientResponse *clientResponse);
75 * Function to discover security version information through unicast
77 * @param[in] discoveryInfo The pointer of discovery information to matain result of discovery
78 * @param[in] clientResponse Response information(It will contain payload)
80 * @return OC_STACK_OK on success otherwise error.
82 static OCStackResult SecurityVersionDiscovery(DiscoveryInfo* discoveryInfo,
83 const OCClientResponse *clientResponse);
86 * Callback handler for PMDeviceDiscovery API.
88 * @param[in] ctx User context
89 * @param[in] handle Handler for response
90 * @param[in] clientResponse Response information (It will contain payload)
91 * @return OC_STACK_KEEP_TRANSACTION to keep transaction and
92 * OC_STACK_DELETE_TRANSACTION to delete it.
94 static OCStackApplicationResult DeviceDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
95 OCClientResponse *clientResponse);
98 * Callback handler for getting secure port information using /oic/res discovery.
100 * @param[in] ctx user context
101 * @param[in] handle Handle for response
102 * @param[in] clientResponse Response information(It will contain payload)
104 * @return OC_STACK_KEEP_TRANSACTION to keep transaction and
105 * OC_STACK_DELETE_TRANSACTION to delete it.
107 static OCStackApplicationResult SecurePortDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
108 OCClientResponse *clientResponse);
111 * Callback handler for security version discovery.
113 * @param[in] ctx User context
114 * @param[in] handle Handler for response
115 * @param[in] clientResponse Response information (It will contain payload)
116 * @return OC_STACK_KEEP_TRANSACTION to keep transaction and
117 * OC_STACK_DELETE_TRANSACTION to delete it.
119 static OCStackApplicationResult SecVersionDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
120 OCClientResponse *clientResponse);
123 * Function to search node in linked list that matches given IP and port.
125 * @param[in] pList List of OCProvisionDev_t.
126 * @param[in] addr address of target device.
127 * @param[in] port port of remote server.
129 * @return pointer of OCProvisionDev_t if exist, otherwise NULL
131 OCProvisionDev_t* GetDevice(OCProvisionDev_t **ppDevicesList, const char* addr, const uint16_t port)
133 if(NULL == addr || NULL == *ppDevicesList)
135 OIC_LOG_V(ERROR, TAG, "Invalid Input parameters in [%s]\n", __FUNCTION__);
139 OCProvisionDev_t *ptr = NULL;
140 LL_FOREACH(*ppDevicesList, ptr)
142 if( strcmp(ptr->endpoint.addr, addr) == 0 && port == ptr->endpoint.port)
153 * Add device information to list.
155 * @param[in] pList List of OCProvisionDev_t.
156 * @param[in] endpoint target device endpoint.
157 * @param[in] connType connectivity type of endpoint
158 * @param[in] doxm pointer to doxm instance.
160 * @return OC_STACK_OK for success and error code otherwise.
162 OCStackResult AddDevice(OCProvisionDev_t **ppDevicesList, OCDevAddr* endpoint,
163 OCConnectivityType connType, OicSecDoxm_t *doxm)
165 if (NULL == endpoint)
167 return OC_STACK_INVALID_PARAM;
170 OCProvisionDev_t *ptr = GetDevice(ppDevicesList, endpoint->addr, endpoint->port);
173 ptr = (OCProvisionDev_t *)OICCalloc(1, sizeof (OCProvisionDev_t));
176 OIC_LOG(ERROR, TAG, "Error while allocating memory for linkedlist node !!");
177 return OC_STACK_NO_MEMORY;
180 ptr->endpoint = *endpoint;
182 ptr->securePort = DEFAULT_SECURE_PORT;
184 ptr->connType = connType;
185 ptr->devStatus = DEV_STATUS_ON; //AddDevice is called when discovery(=alive)
186 OICStrcpy(ptr->secVer, MAX_VERSION_LEN, DEFAULT_SEC_VERSION); // version initialization
189 LL_PREPEND(*ppDevicesList, ptr);
196 * Move device object between two device lists.
198 * @param[in] ppDstDevicesList Destination list of OCProvisionDev_t.
199 * @param[in] ppSrcDevicesList Source list of OCProvisionDev_t.
200 * @param[in] endpoint target device endpoint.
202 * @return OC_STACK_OK for success and error code otherwise.
204 OCStackResult MoveDeviceList(OCProvisionDev_t **ppDstDevicesList,
205 OCProvisionDev_t **ppSrcDevicesList, OCDevAddr* endpoint)
207 if (NULL == ppSrcDevicesList || NULL == endpoint)
209 return OC_STACK_INVALID_PARAM;
212 OCProvisionDev_t *ptr = GetDevice(ppSrcDevicesList, endpoint->addr, endpoint->port);
215 LL_DELETE(*ppSrcDevicesList, ptr);
216 LL_PREPEND(*ppDstDevicesList, ptr);
217 OIC_LOG_V(DEBUG, TAG, "MoveDeviceList success : %s(%d)", endpoint->addr, endpoint->port);
221 return OC_STACK_ERROR;
225 * Function to set secure port information from the given list of devices.
227 * @param[in] pList List of OCProvisionDev_t.
228 * @param[in] addr address of target device.
229 * @param[in] port port of remote server.
230 * @param[in] secureport secure port information.
232 * @return OC_STACK_OK for success and errorcode otherwise.
234 static OCStackResult UpdateSecurePortOfDevice(OCProvisionDev_t **ppDevicesList, const char *addr,
235 uint16_t port, uint16_t securePort
241 OCProvisionDev_t *ptr = GetDevice(ppDevicesList, addr, port);
245 OIC_LOG(ERROR, TAG, "Can not find device information in the discovery device list");
246 return OC_STACK_ERROR;
249 ptr->securePort = securePort;
252 ptr->tcpPort = tcpPort;
259 * Function to set security version information from the given list of devices.
261 * @param[in] pList List of OCProvisionDev_t.
262 * @param[in] addr address of target device.
263 * @param[in] port port of remote server.
264 * @param[in] secVer security version information.
266 * @return OC_STACK_OK for success and errorcode otherwise.
268 OCStackResult UpdateSecVersionOfDevice(OCProvisionDev_t **ppDevicesList, const char *addr,
269 uint16_t port, const char* secVer)
273 return OC_STACK_INVALID_PARAM;
276 OCProvisionDev_t *ptr = GetDevice(ppDevicesList, addr, port);
280 OIC_LOG(ERROR, TAG, "Can not find device information in the discovery device list");
281 return OC_STACK_ERROR;
284 OICStrcpy(ptr->secVer, MAX_VERSION_LEN, secVer);
290 * This function deletes list of provision target devices
292 * @param[in] pDevicesList List of OCProvisionDev_t.
294 void PMDeleteDeviceList(OCProvisionDev_t *pDevicesList)
298 OCProvisionDev_t *del = NULL, *tmp = NULL;
299 LL_FOREACH_SAFE(pDevicesList, del, tmp)
301 LL_DELETE(pDevicesList, del);
303 DeleteDoxmBinData(del->doxm);
304 DeletePstatBinData(del->pstat);
310 OCProvisionDev_t* PMCloneOCProvisionDev(const OCProvisionDev_t* src)
312 OIC_LOG(DEBUG, TAG, "IN PMCloneOCProvisionDev");
316 OIC_LOG(ERROR, TAG, "PMCloneOCProvisionDev : Invalid parameter");
320 // TODO: Consider use VERIFY_NON_NULL instead of if ( null check ) { goto exit; }
321 OCProvisionDev_t* newDev = (OCProvisionDev_t*)OICCalloc(1, sizeof(OCProvisionDev_t));
322 VERIFY_NON_NULL(TAG, newDev, ERROR);
324 memcpy(&newDev->endpoint, &src->endpoint, sizeof(OCDevAddr));
328 newDev->pstat= (OicSecPstat_t*)OICCalloc(1, sizeof(OicSecPstat_t));
329 VERIFY_NON_NULL(TAG, newDev->pstat, ERROR);
331 memcpy(newDev->pstat, src->pstat, sizeof(OicSecPstat_t));
332 // We have to assign NULL for not necessary information to prevent memory corruption.
333 newDev->pstat->sm = NULL;
338 newDev->doxm = (OicSecDoxm_t*)OICCalloc(1, sizeof(OicSecDoxm_t));
339 VERIFY_NON_NULL(TAG, newDev->doxm, ERROR);
341 memcpy(newDev->doxm, src->doxm, sizeof(OicSecDoxm_t));
342 // We have to assign NULL for not necessary information to prevent memory corruption.
343 newDev->doxm->oxmType = NULL;
344 newDev->doxm->oxm = NULL;
347 if (0 == strlen(src->secVer))
349 OICStrcpy(newDev->secVer, MAX_VERSION_LEN, DEFAULT_SEC_VERSION);
353 OICStrcpy(newDev->secVer, MAX_VERSION_LEN, src->secVer);
356 newDev->securePort = src->securePort;
357 newDev->devStatus = src->devStatus;
358 newDev->connType = src->connType;
361 OIC_LOG(DEBUG, TAG, "OUT PMCloneOCProvisionDev");
366 OIC_LOG(ERROR, TAG, "PMCloneOCProvisionDev : Failed to allocate memory");
369 OICFree(newDev->pstat);
370 OICFree(newDev->doxm);
377 * Timeout implementation for secure discovery. When performing secure discovery,
378 * we should wait a certain period of time for getting response of each devices.
380 * @param[in] waittime Timeout in seconds.
381 * @param[in] waitForStackResponse if true timeout function will call OCProcess while waiting.
382 * @return OC_STACK_OK on success otherwise error.
384 OCStackResult PMTimeout(unsigned short waittime, bool waitForStackResponse)
386 OCStackResult res = OC_STACK_OK;
388 uint64_t startTime = OICGetCurrentTime(TIME_IN_MS);
389 while (OC_STACK_OK == res)
391 uint64_t currTime = OICGetCurrentTime(TIME_IN_MS);
393 long elapsed = (long)((currTime - startTime) / MS_PER_SEC);
394 if (elapsed > waittime)
398 if (waitForStackResponse)
407 * Extract secure port information from payload of discovery response.
409 * @param[in] jsonStr response payload of /oic/res discovery.
411 * @return Secure port
413 uint16_t GetSecurePortFromJSON(char* jsonStr)
415 // TODO: Modify error handling
420 cJSON *jsonProp = NULL;
422 cJSON *jsonPort = NULL;
424 cJSON *jsonRoot = cJSON_Parse(jsonStr);
427 // TODO: Add error log & return default secure port
431 jsonProp = cJSON_GetObjectItem(jsonRoot, "prop");
434 // TODO: Add error log & return default secure port
438 jsonP = cJSON_GetObjectItem(jsonProp, "p");
441 // TODO: Add error log & return default secure port
445 jsonPort = cJSON_GetObjectItem(jsonP, "port");
448 // TODO: Add error log & return default secure port
452 return (uint16_t)jsonPort->valueint;
455 bool PMGenerateQuery(bool isSecure,
456 const char* address, uint16_t port,
457 OCConnectivityType connType,
458 char* buffer, size_t bufferSize, const char* uri)
460 if(!address || !buffer || !uri)
462 OIC_LOG(ERROR, TAG, "PMGenerateQuery : Invalid parameters.");
467 char* prefix = (isSecure == true) ? COAPS_PREFIX : COAP_PREFIX;
469 switch(connType & CT_MASK_ADAPTER)
472 prefix = (isSecure == true) ? COAPS_TCP_PREFIX : COAP_TCP_PREFIX;
474 switch(connType & CT_MASK_FLAGS & ~CT_FLAG_SECURE)
477 snRet = snprintf(buffer, bufferSize, "%s%s:%d%s",
478 prefix, address, port, uri);
482 char addressEncoded[128] = {0};
484 OCStackResult result = OCEncodeAddressForRFC6874(addressEncoded,
485 sizeof(addressEncoded),
487 if (OC_STACK_OK != result)
489 OIC_LOG_V(ERROR, TAG, "PMGenerateQuery : encoding error %d\n", result);
493 snRet = snprintf(buffer, bufferSize, "%s[%s]:%d%s",
494 prefix, addressEncoded, port, uri);
498 OIC_LOG(ERROR, TAG, "Unknown address format.");
501 // snprintf return value check
504 OIC_LOG_V(ERROR, TAG, "PMGenerateQuery : Error (snprintf) %d\n", snRet);
507 else if ((size_t)snRet >= bufferSize)
509 OIC_LOG_V(ERROR, TAG, "PMGenerateQuery : Truncated (snprintf) %d\n", snRet);
514 // TODO: We need to verify tinyDTLS in below cases
515 case CT_ADAPTER_GATT_BTLE:
516 case CT_ADAPTER_RFCOMM_BTEDR:
517 OIC_LOG(ERROR, TAG, "Not supported connectivity adapter.");
521 OIC_LOG(ERROR, TAG, "Unknown connectivity adapter.");
528 static OCStackApplicationResult SecurityVersionDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
529 OCClientResponse *clientResponse)
533 OIC_LOG(ERROR, TAG, "Lost List of device information");
534 return OC_STACK_KEEP_TRANSACTION;
539 if (NULL == clientResponse->payload)
541 OIC_LOG(INFO, TAG, "Skiping Null payload");
542 return OC_STACK_KEEP_TRANSACTION;
544 if (OC_STACK_OK != clientResponse->result)
546 OIC_LOG(INFO, TAG, "Error in response");
547 return OC_STACK_KEEP_TRANSACTION;
551 if (PAYLOAD_TYPE_SECURITY != clientResponse->payload->type)
553 OIC_LOG(INFO, TAG, "Unknown payload type");
554 return OC_STACK_KEEP_TRANSACTION;
557 OicSecVer_t *ptrVer = NULL;
558 uint8_t *payload = ((OCSecurityPayload*)clientResponse->payload)->securityData;
559 size_t size = ((OCSecurityPayload*)clientResponse->payload)->payloadSize;
561 OCStackResult res = CBORPayloadToVer(payload, size, &ptrVer);
562 if ((NULL == ptrVer) && (OC_STACK_OK != res))
564 OIC_LOG(INFO, TAG, "Ignoring malformed CBOR");
565 return OC_STACK_KEEP_TRANSACTION;
569 OIC_LOG(DEBUG, TAG, "Successfully converted ver cbor to bin.");
571 //If this is owend device discovery we have to filter out the responses.
572 DiscoveryInfo* pDInfo = (DiscoveryInfo*)ctx;
573 res = UpdateSecVersionOfDevice(pDInfo->ppDevicesList, clientResponse->devAddr.addr,
574 clientResponse->devAddr.port, ptrVer->secv);
575 if (OC_STACK_OK != res)
577 OIC_LOG(ERROR, TAG, "Error while getting security version.");
578 DeleteVerBinData(ptrVer);
579 return OC_STACK_KEEP_TRANSACTION;
582 OIC_LOG(INFO, TAG, "= Discovered security version =");
583 OIC_LOG_V(DEBUG, TAG, "IP %s", clientResponse->devAddr.addr);
584 OIC_LOG_V(DEBUG, TAG, "PORT %d", clientResponse->devAddr.port);
585 OIC_LOG_V(DEBUG, TAG, "VERSION %s", ptrVer->secv);
587 OIC_LOG(INFO, TAG, "Exiting SecVersionDiscoveryHandler.");
588 DeleteVerBinData(ptrVer);
594 OIC_LOG(INFO, TAG, "Skiping Null response");
595 return OC_STACK_KEEP_TRANSACTION;
598 return OC_STACK_DELETE_TRANSACTION;
601 static OCStackApplicationResult SecurePortDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
602 OCClientResponse *clientResponse)
606 OIC_LOG(ERROR, TAG, "Lost List of device information");
607 return OC_STACK_DELETE_TRANSACTION;
612 if (NULL == clientResponse->payload)
614 OIC_LOG(INFO, TAG, "Skiping Null payload");
618 if (PAYLOAD_TYPE_DISCOVERY != clientResponse->payload->type)
620 OIC_LOG(INFO, TAG, "Wrong payload type");
621 return OC_STACK_DELETE_TRANSACTION;
624 uint16_t securePort = 0;
625 OCResourcePayload* resPayload = ((OCDiscoveryPayload*)clientResponse->payload)->resources;
627 // Use seure port of doxm for OTM and Provision.
630 if (0 == strncmp(resPayload->uri, OIC_RSRC_DOXM_URI, strlen(OIC_RSRC_DOXM_URI)))
632 OIC_LOG_V(INFO,TAG,"resPaylod->uri:%s",resPayload->uri);
633 OIC_LOG(INFO, TAG, "Found doxm resource.");
638 resPayload = resPayload->next;
641 if (NULL == resPayload)
643 OIC_LOG(ERROR, TAG, "Can not find doxm resource.");
644 return OC_STACK_DELETE_TRANSACTION;
646 if (resPayload && resPayload->secure)
648 securePort = resPayload->port;
652 OIC_LOG(INFO, TAG, "Can not find secure port information.");
653 return OC_STACK_DELETE_TRANSACTION;
656 OIC_LOG_V(DEBUG, TAG, "%s: TCP port from discovery = %d", __func__, resPayload->tcpPort);
658 DiscoveryInfo* pDInfo = (DiscoveryInfo*)ctx;
659 OCProvisionDev_t *ptr = GetDevice(&pDInfo->pCandidateList,
660 clientResponse->devAddr.addr,
661 clientResponse->devAddr.port);
664 OIC_LOG(ERROR, TAG, "Can not find device information in the discovery candidate device list");
665 return OC_STACK_DELETE_TRANSACTION;
668 OCStackResult res = UpdateSecurePortOfDevice(&pDInfo->pCandidateList,
669 clientResponse->devAddr.addr,
670 clientResponse->devAddr.port,
676 if (OC_STACK_OK != res)
678 OIC_LOG(ERROR, TAG, "Error while getting secure port.");
679 return OC_STACK_DELETE_TRANSACTION;
682 res = MoveDeviceList(pDInfo->ppDevicesList, &pDInfo->pCandidateList, &clientResponse->devAddr);
683 if(OC_STACK_OK != res)
685 OIC_LOG(ERROR, TAG, "Error while move the discovered device to list.");
686 return OC_STACK_DELETE_TRANSACTION;
689 if(pDInfo->isSingleDiscovery)
691 pDInfo->isFound = true;
695 * Since security version discovery does not used anymore, disable security version discovery.
696 * Need to discussion to removing all version discovery related codes.
699 res = SecurityVersionDiscovery(pDInfo, clientResponse);
700 if(OC_STACK_OK != res)
702 OIC_LOG(ERROR, TAG, "Failed to SecurityVersionDiscovery");
703 return OC_STACK_DELETE_TRANSACTION;
707 OIC_LOG(INFO, TAG, "Exiting SecurePortDiscoveryHandler.");
710 return OC_STACK_DELETE_TRANSACTION;
714 OIC_LOG(INFO, TAG, "Skiping Null response");
717 return OC_STACK_DELETE_TRANSACTION;
720 static OCStackApplicationResult DeviceDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
721 OCClientResponse *clientResponse)
725 OIC_LOG(ERROR, TAG, "Lost List of device information");
726 return OC_STACK_KEEP_TRANSACTION;
731 if (NULL == clientResponse->payload)
733 OIC_LOG(INFO, TAG, "Skiping Null payload");
734 return OC_STACK_KEEP_TRANSACTION;
736 if (OC_STACK_OK != clientResponse->result)
738 OIC_LOG(INFO, TAG, "Error in response");
739 return OC_STACK_KEEP_TRANSACTION;
743 if (PAYLOAD_TYPE_SECURITY != clientResponse->payload->type)
745 OIC_LOG(INFO, TAG, "Unknown payload type");
746 return OC_STACK_KEEP_TRANSACTION;
749 OicSecDoxm_t *ptrDoxm = NULL;
750 uint8_t *payload = ((OCSecurityPayload*)clientResponse->payload)->securityData;
751 size_t size = ((OCSecurityPayload*)clientResponse->payload)->payloadSize;
753 OCStackResult res = CBORPayloadToDoxm(payload, size, &ptrDoxm);
754 if ((NULL == ptrDoxm) || (OC_STACK_OK != res))
756 OIC_LOG(INFO, TAG, "Ignoring malformed CBOR");
757 return OC_STACK_KEEP_TRANSACTION;
761 OIC_LOG(DEBUG, TAG, "Successfully converted doxm cbor to bin.");
763 //If this is owend device discovery we have to filter out the responses.
764 DiscoveryInfo* pDInfo = (DiscoveryInfo*)ctx;
765 OCProvisionDev_t **ppDevicesList = &pDInfo->pCandidateList;
767 // Get my device ID from doxm resource
769 memset(&myId, 0, sizeof(myId));
770 OCStackResult res = GetDoxmDevOwnerId(&myId);
771 if(OC_STACK_OK != res)
773 OIC_LOG(ERROR, TAG, "Error while getting my device ID.");
774 DeleteDoxmBinData(ptrDoxm);
775 return OC_STACK_KEEP_TRANSACTION;
778 // If this is owned discovery response but owner is not me then discard it.
779 if( (pDInfo->isOwnedDiscovery) &&
780 (0 != memcmp(&ptrDoxm->owner.id, &myId.id, sizeof(myId.id))) )
782 OIC_LOG(DEBUG, TAG, "Discovered device is not owend by me");
783 DeleteDoxmBinData(ptrDoxm);
784 return OC_STACK_KEEP_TRANSACTION;
787 res = GetDoxmDeviceID(&myId);
788 if(OC_STACK_OK != res)
790 OIC_LOG(ERROR, TAG, "Error while getting my UUID.");
791 DeleteDoxmBinData(ptrDoxm);
792 return OC_STACK_KEEP_TRANSACTION;
794 //if targetId and discovered deviceID are different, discard it
795 if ((pDInfo->isSingleDiscovery) &&
796 (0 != memcmp(&ptrDoxm->deviceID.id, &pDInfo->targetId->id, sizeof(pDInfo->targetId->id))) )
798 OIC_LOG(DEBUG, TAG, "Discovered device is not target device");
799 DeleteDoxmBinData(ptrDoxm);
800 return OC_STACK_KEEP_TRANSACTION;
802 //if this is owned discovery and this is PT's reply, discard it
803 if (((pDInfo->isSingleDiscovery) || (pDInfo->isOwnedDiscovery)) &&
804 (0 == memcmp(&ptrDoxm->deviceID.id, &myId.id, sizeof(myId.id))) )
806 OIC_LOG(DEBUG, TAG, "discarding provision tool's reply");
807 DeleteDoxmBinData(ptrDoxm);
808 return OC_STACK_KEEP_TRANSACTION;
811 res = AddDevice(ppDevicesList, &clientResponse->devAddr,
812 clientResponse->connType, ptrDoxm);
813 if (OC_STACK_OK != res)
815 OIC_LOG(ERROR, TAG, "Error while adding data to linkedlist.");
816 DeleteDoxmBinData(ptrDoxm);
817 return OC_STACK_KEEP_TRANSACTION;
820 res = SecurePortDiscovery(pDInfo, clientResponse);
821 if(OC_STACK_OK != res)
823 OIC_LOG(ERROR, TAG, "Failed to SecurePortDiscovery");
824 DeleteDoxmBinData(ptrDoxm);
825 return OC_STACK_KEEP_TRANSACTION;
828 OIC_LOG(INFO, TAG, "Exiting ProvisionDiscoveryHandler.");
831 return OC_STACK_KEEP_TRANSACTION;
836 OIC_LOG(INFO, TAG, "Skiping Null response");
837 return OC_STACK_KEEP_TRANSACTION;
840 return OC_STACK_DELETE_TRANSACTION;
843 static void DeviceDiscoveryDeleteHandler(void *ctx)
845 OIC_LOG(DEBUG, TAG, "IN DeviceDiscoveryDeleteHandler");
848 OIC_LOG(WARNING, TAG, "Not found context in DeviceDiscoveryDeleteHandler");
852 DiscoveryInfo* pDInfo = (DiscoveryInfo*)ctx;
853 if (NULL != pDInfo->pCandidateList)
855 OCProvisionDev_t *pDev = NULL;
856 LL_FOREACH(pDInfo->pCandidateList, pDev)
858 OIC_LOG_V(DEBUG, TAG, "OCCancel - %s : %d",
859 pDev->endpoint.addr, pDev->endpoint.port);
860 if(OC_STACK_OK != OCCancel(pDev->handle,OC_HIGH_QOS,NULL,0))
862 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
865 PMDeleteDeviceList(pDInfo->pCandidateList);
867 OIC_LOG(DEBUG, TAG, "OUT DeviceDiscoveryDeleteHandler");
871 * Discover owned/unowned device in the specified endpoint/deviceID.
872 * It will return the found device even though timeout is not exceeded.
874 * @param[in] waittime Timeout in seconds
875 * @param[in] deviceID deviceID of target device.
876 * @param[out] ppFoundDevice OCProvisionDev_t of found device
878 * @return OC_STACK_OK on success otherwise error.\n
879 * OC_STACK_INVALID_PARAM when deviceID is NULL or ppFoundDevice is not initailized.
881 OCStackResult PMSingleDeviceDiscovery(unsigned short waittime, const OicUuid_t* deviceID,
882 OCProvisionDev_t **ppFoundDevice)
884 OIC_LOG(DEBUG, TAG, "IN PMSingleDeviceDiscovery");
886 if (NULL != *ppFoundDevice)
888 OIC_LOG(ERROR, TAG, "List is not null can cause memory leak");
889 return OC_STACK_INVALID_PARAM;
892 if (NULL == deviceID)
894 OIC_LOG(ERROR, TAG, "Invalid device ID");
895 return OC_STACK_INVALID_PARAM;
899 DiscoveryInfo *pDInfo = OICCalloc(1, sizeof(DiscoveryInfo));
902 OIC_LOG(ERROR, TAG, "PMSingleDeviceDiscovery : Memory allocation failed.");
903 return OC_STACK_NO_MEMORY;
906 pDInfo->ppDevicesList = ppFoundDevice;
907 pDInfo->pCandidateList = NULL;
908 pDInfo->isOwnedDiscovery = false;
909 pDInfo->isSingleDiscovery = true;
910 pDInfo->isFound = false;
911 pDInfo->targetId = deviceID;
913 OCCallbackData cbData;
914 cbData.cb = &DeviceDiscoveryHandler;
915 cbData.context = (void *)pDInfo;
916 cbData.cd = &DeviceDiscoveryDeleteHandler;
918 OCStackResult res = OC_STACK_ERROR;
920 char query[MAX_URI_LENGTH + MAX_QUERY_LENGTH + 1] = { '\0' };
921 snprintf(query, MAX_URI_LENGTH + MAX_QUERY_LENGTH + 1, "/oic/sec/doxm");
923 OCDoHandle handle = NULL;
924 res = OCDoResource(&handle, OC_REST_DISCOVER, query, 0, 0,
925 CT_DEFAULT, OC_HIGH_QOS, &cbData, NULL, 0);
926 if (res != OC_STACK_OK)
928 OIC_LOG(ERROR, TAG, "OCStack resource error");
933 //Waiting for each response.
935 uint64_t startTime = OICGetCurrentTime(TIME_IN_MS);
936 while (OC_STACK_OK == res && !pDInfo->isFound)
938 uint64_t currTime = OICGetCurrentTime(TIME_IN_MS);
940 long elapsed = (long)((currTime - startTime) / MS_PER_SEC);
941 if (elapsed > waittime)
948 if(OC_STACK_OK != res)
950 OIC_LOG(ERROR, TAG, "Failed to wait response for secure discovery.");
952 OCStackResult resCancel = OCCancel(handle, OC_HIGH_QOS, NULL, 0);
953 if(OC_STACK_OK != resCancel)
955 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
960 res = OCCancel(handle,OC_HIGH_QOS,NULL,0);
961 if (OC_STACK_OK != res)
963 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
967 OIC_LOG(DEBUG, TAG, "OUT PMSingleDeviceDiscovery");
974 * Discover owned/unowned devices in the same IP subnet. .
976 * @param[in] waittime Timeout in seconds.
977 * @param[in] isOwned bool flag for owned / unowned discovery
978 * @param[in] ppDevicesList List of OCProvisionDev_t.
980 * @return OC_STACK_OK on success otherwise error.
982 OCStackResult PMDeviceDiscovery(unsigned short waittime, bool isOwned, OCProvisionDev_t **ppDevicesList)
984 OIC_LOG(DEBUG, TAG, "IN PMDeviceDiscovery");
986 if (NULL != *ppDevicesList)
988 OIC_LOG(ERROR, TAG, "List is not null can cause memory leak");
989 return OC_STACK_INVALID_PARAM;
992 const char DOXM_OWNED_FALSE_MULTICAST_QUERY[] = "/oic/sec/doxm?Owned=FALSE";
993 const char DOXM_OWNED_TRUE_MULTICAST_QUERY[] = "/oic/sec/doxm?Owned=TRUE";
995 DiscoveryInfo *pDInfo = OICCalloc(1, sizeof(DiscoveryInfo));
998 OIC_LOG(ERROR, TAG, "PMDeviceDiscovery : Memory allocation failed.");
999 return OC_STACK_NO_MEMORY;
1002 pDInfo->ppDevicesList = ppDevicesList;
1003 pDInfo->pCandidateList = NULL;
1004 pDInfo->isOwnedDiscovery = isOwned;
1005 pDInfo->isSingleDiscovery = false;
1006 pDInfo->targetId = NULL;
1008 OCCallbackData cbData;
1009 cbData.cb = &DeviceDiscoveryHandler;
1010 cbData.context = (void *)pDInfo;
1011 cbData.cd = &DeviceDiscoveryDeleteHandler;
1012 OCStackResult res = OC_STACK_ERROR;
1014 const char* query = isOwned ? DOXM_OWNED_TRUE_MULTICAST_QUERY :
1015 DOXM_OWNED_FALSE_MULTICAST_QUERY;
1017 OCDoHandle handle = NULL;
1018 res = OCDoResource(&handle, OC_REST_DISCOVER, query, 0, 0,
1019 CT_DEFAULT, OC_HIGH_QOS, &cbData, NULL, 0);
1020 if (res != OC_STACK_OK)
1022 OIC_LOG(ERROR, TAG, "OCStack resource error");
1027 //Waiting for each response.
1028 res = PMTimeout(waittime, true);
1029 if(OC_STACK_OK != res)
1031 OIC_LOG(ERROR, TAG, "Failed to wait response for secure discovery.");
1033 OCStackResult resCancel = OCCancel(handle, OC_HIGH_QOS, NULL, 0);
1034 if(OC_STACK_OK != resCancel)
1036 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
1040 res = OCCancel(handle,OC_HIGH_QOS,NULL,0);
1041 if (OC_STACK_OK != res)
1043 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
1047 OIC_LOG(DEBUG, TAG, "OUT PMDeviceDiscovery");
1052 #ifdef _ENABLE_MULTIPLE_OWNER_
1053 static OCStackApplicationResult MOTDeviceDiscoveryHandler(void *ctx, OCDoHandle UNUSED,
1054 OCClientResponse *clientResponse)
1058 OIC_LOG(ERROR, TAG, "Lost List of device information");
1059 return OC_STACK_KEEP_TRANSACTION;
1064 if (NULL == clientResponse->payload)
1066 OIC_LOG(INFO, TAG, "Skipping Null payload");
1067 return OC_STACK_KEEP_TRANSACTION;
1069 if (OC_STACK_OK != clientResponse->result)
1071 OIC_LOG(INFO, TAG, "Error in response");
1072 return OC_STACK_KEEP_TRANSACTION;
1076 if (PAYLOAD_TYPE_SECURITY != clientResponse->payload->type)
1078 OIC_LOG(INFO, TAG, "Unknown payload type");
1079 return OC_STACK_KEEP_TRANSACTION;
1082 OicSecDoxm_t *ptrDoxm = NULL;
1083 uint8_t *payload = ((OCSecurityPayload*)clientResponse->payload)->securityData;
1084 size_t size = ((OCSecurityPayload*)clientResponse->payload)->payloadSize;
1086 OCStackResult res = CBORPayloadToDoxm(payload, size, &ptrDoxm);
1087 if ((NULL == ptrDoxm) || (OC_STACK_OK != res))
1089 OIC_LOG(INFO, TAG, "Ignoring malformed CBOR");
1090 return OC_STACK_KEEP_TRANSACTION;
1094 OIC_LOG(DEBUG, TAG, "Successfully converted doxm cbor to bin.");
1096 //If this is owend device discovery we have to filter out the responses.
1097 DiscoveryInfo* pDInfo = (DiscoveryInfo*)ctx;
1098 OCProvisionDev_t **ppDevicesList = &pDInfo->pCandidateList;
1100 // Get my device ID from doxm resource
1102 memset(&myId, 0, sizeof(myId));
1103 OCStackResult res = GetDoxmDevOwnerId(&myId);
1104 if(OC_STACK_OK != res)
1106 OIC_LOG(ERROR, TAG, "Error while getting my device ID.");
1107 DeleteDoxmBinData(ptrDoxm);
1108 return OC_STACK_KEEP_TRANSACTION;
1111 res = GetDoxmDeviceID(&myId);
1112 if(OC_STACK_OK != res)
1114 OIC_LOG(ERROR, TAG, "Error while getting my UUID.");
1115 DeleteDoxmBinData(ptrDoxm);
1116 return OC_STACK_KEEP_TRANSACTION;
1118 //if this is owned discovery and this is PT's reply, discard it
1119 if((pDInfo->isOwnedDiscovery) &&
1120 (0 == memcmp(&ptrDoxm->deviceID.id, &myId.id, sizeof(myId.id))) )
1122 OIC_LOG(DEBUG, TAG, "discarding provision tool's reply");
1123 DeleteDoxmBinData(ptrDoxm);
1124 return OC_STACK_KEEP_TRANSACTION;
1127 if(pDInfo->isOwnedDiscovery)
1129 OicSecSubOwner_t* subOwner = NULL;
1130 LL_FOREACH(ptrDoxm->subOwners, subOwner)
1132 if(memcmp(myId.id, subOwner->uuid.id, sizeof(myId.id)) == 0)
1140 res = AddDevice(ppDevicesList, &clientResponse->devAddr,
1141 clientResponse->connType, ptrDoxm);
1142 if (OC_STACK_OK != res)
1144 OIC_LOG(ERROR, TAG, "Error while adding data to linkedlist.");
1145 DeleteDoxmBinData(ptrDoxm);
1146 return OC_STACK_KEEP_TRANSACTION;
1149 res = SecurePortDiscovery(pDInfo, clientResponse);
1150 if(OC_STACK_OK != res)
1152 OIC_LOG(ERROR, TAG, "Failed to SecurePortDiscovery");
1153 DeleteDoxmBinData(ptrDoxm);
1154 return OC_STACK_KEEP_TRANSACTION;
1159 OIC_LOG(ERROR, TAG, "discarding device's reply, because not a SubOwner.");
1160 DeleteDoxmBinData(ptrDoxm);
1161 return OC_STACK_KEEP_TRANSACTION;
1166 if(ptrDoxm->mom && OIC_MULTIPLE_OWNER_DISABLE != ptrDoxm->mom->mode)
1168 res = AddDevice(ppDevicesList, &clientResponse->devAddr,
1169 clientResponse->connType, ptrDoxm);
1170 if (OC_STACK_OK != res)
1172 OIC_LOG(ERROR, TAG, "Error while adding data to linkedlist.");
1173 DeleteDoxmBinData(ptrDoxm);
1174 return OC_STACK_KEEP_TRANSACTION;
1177 res = SecurePortDiscovery(pDInfo, clientResponse);
1178 if(OC_STACK_OK != res)
1180 OIC_LOG(ERROR, TAG, "Failed to SecurePortDiscovery");
1181 DeleteDoxmBinData(ptrDoxm);
1182 return OC_STACK_KEEP_TRANSACTION;
1187 OIC_LOG(ERROR, TAG, "discarding mom disabled device's reply");
1188 DeleteDoxmBinData(ptrDoxm);
1189 return OC_STACK_KEEP_TRANSACTION;
1193 OIC_LOG(INFO, TAG, "Exiting ProvisionDiscoveryHandler.");
1196 return OC_STACK_KEEP_TRANSACTION;
1201 OIC_LOG(INFO, TAG, "Skiping Null response");
1202 return OC_STACK_KEEP_TRANSACTION;
1205 return OC_STACK_DELETE_TRANSACTION;
1210 * Discover multiple OTM enabled devices in the same IP subnet.
1212 * @param[in] waittime Timeout in seconds.
1213 * @param[in] ppDevicesList List of OCProvisionDev_t.
1215 * @return OC_STACK_OK on success otherwise error.
1217 OCStackResult PMMultipleOwnerDeviceDiscovery(unsigned short waittime, bool isMultipleOwned, OCProvisionDev_t **ppDevicesList)
1219 OIC_LOG(DEBUG, TAG, "IN PMMultipleOwnerEnabledDeviceDiscovery");
1221 if (NULL != *ppDevicesList)
1223 OIC_LOG(ERROR, TAG, "List is not null can cause memory leak");
1224 return OC_STACK_INVALID_PARAM;
1227 const char *DOXM_MOM_ENABLE_MULTICAST_QUERY = "/oic/sec/doxm?mom!=0&owned=TRUE";
1228 const char *DOXM_MULTIPLE_OWNED_MULTICAST_QUERY = "/oic/sec/doxm?owned=TRUE";
1230 DiscoveryInfo *pDInfo = OICCalloc(1, sizeof(DiscoveryInfo));
1233 OIC_LOG(ERROR, TAG, "PMDeviceDiscovery : Memory allocation failed.");
1234 return OC_STACK_NO_MEMORY;
1237 pDInfo->ppDevicesList = ppDevicesList;
1238 pDInfo->pCandidateList = NULL;
1239 pDInfo->isOwnedDiscovery = isMultipleOwned;
1241 OCCallbackData cbData;
1242 cbData.cb = &MOTDeviceDiscoveryHandler;
1243 cbData.context = (void *)pDInfo;
1245 OCStackResult res = OC_STACK_ERROR;
1247 const char* query = isMultipleOwned ? DOXM_MULTIPLE_OWNED_MULTICAST_QUERY :
1248 DOXM_MOM_ENABLE_MULTICAST_QUERY;
1250 OCDoHandle handle = NULL;
1251 res = OCDoResource(&handle, OC_REST_DISCOVER, query, 0, 0,
1252 CT_DEFAULT, OC_HIGH_QOS, &cbData, NULL, 0);
1253 if (res != OC_STACK_OK)
1255 OIC_LOG(ERROR, TAG, "OCStack resource error");
1260 //Waiting for each response.
1261 res = PMTimeout(waittime, true);
1262 if(OC_STACK_OK != res)
1264 OIC_LOG(ERROR, TAG, "Failed to wait response for secure discovery.");
1266 OCStackResult resCancel = OCCancel(handle, OC_HIGH_QOS, NULL, 0);
1267 if(OC_STACK_OK != resCancel)
1269 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
1273 res = OCCancel(handle,OC_HIGH_QOS,NULL,0);
1274 if (OC_STACK_OK != res)
1276 OIC_LOG(ERROR, TAG, "Failed to remove registered callback");
1280 OIC_LOG(DEBUG, TAG, "OUT PMMultipleOwnerEnabledDeviceDiscovery");
1285 #endif //_ENABLE_MULTIPLE_OWNER_
1287 static OCStackResult SecurePortDiscovery(DiscoveryInfo* discoveryInfo,
1288 const OCClientResponse *clientResponse)
1290 OIC_LOG(DEBUG, TAG, "IN SecurePortDiscovery");
1292 if(NULL == discoveryInfo || NULL == clientResponse)
1294 return OC_STACK_INVALID_PARAM;
1297 OCProvisionDev_t *pDev = GetDevice(&discoveryInfo->pCandidateList,
1298 clientResponse->devAddr.addr, clientResponse->devAddr.port);
1301 OIC_LOG(ERROR, TAG, "SecurePortDiscovery : Failed to get device");
1302 return OC_STACK_ERROR;
1305 //Try to the unicast discovery to getting secure port
1306 char query[MAX_URI_LENGTH+MAX_QUERY_LENGTH+1] = {0};
1307 if(!PMGenerateQuery(false,
1308 pDev->endpoint.addr, pDev->endpoint.port,
1310 query, sizeof(query), OC_RSRVD_WELL_KNOWN_URI))
1312 OIC_LOG(ERROR, TAG, "SecurePortDiscovery : Failed to generate query");
1313 return OC_STACK_ERROR;
1315 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
1317 // Set filter query with rt=oic.r.doxm
1318 const char RES_DOXM_QUERY_FMT[] = "%s?%s=%s";
1319 char uri[MAX_URI_LENGTH + MAX_QUERY_LENGTH] = {0};
1320 snprintf(uri, sizeof(uri), RES_DOXM_QUERY_FMT, query,
1321 OC_RSRVD_RESOURCE_TYPE, OIC_RSRC_TYPE_SEC_DOXM);
1323 OIC_LOG_V(DEBUG, TAG, "URI=%s", uri);
1325 OCCallbackData cbData;
1326 cbData.cb = &SecurePortDiscoveryHandler;
1327 cbData.context = (void*)discoveryInfo;
1329 OCStackResult ret = OCDoResource(&pDev->handle, OC_REST_DISCOVER, uri, 0, 0,
1330 pDev->connType, OC_HIGH_QOS, &cbData, NULL, 0);
1331 if(OC_STACK_OK != ret)
1333 OIC_LOG(ERROR, TAG, "Failed to Secure Port Discovery");
1338 OIC_LOG_V(INFO, TAG, "OCDoResource with [%s] Success", query);
1341 OIC_LOG(DEBUG, TAG, "OUT SecurePortDiscovery");
1346 static OCStackResult SecurityVersionDiscovery(DiscoveryInfo* discoveryInfo,
1347 const OCClientResponse *clientResponse)
1349 OIC_LOG(DEBUG, TAG, "IN SecurityVersionDiscovery");
1351 if(NULL == discoveryInfo || NULL == clientResponse)
1353 return OC_STACK_INVALID_PARAM;
1356 //Try to the unicast discovery to getting security version
1357 char query[MAX_URI_LENGTH+MAX_QUERY_LENGTH+1] = {0};
1358 if(!PMGenerateQuery(false,
1359 clientResponse->devAddr.addr, clientResponse->devAddr.port,
1360 clientResponse->connType,
1361 query, sizeof(query), OIC_RSRC_VER_URI))
1363 OIC_LOG(ERROR, TAG, "SecurityVersionDiscovery : Failed to generate query");
1364 return OC_STACK_ERROR;
1366 OIC_LOG_V(DEBUG, TAG, "Query=%s", query);
1368 OCCallbackData cbData;
1369 cbData.cb = &SecurityVersionDiscoveryHandler;
1370 cbData.context = (void*)discoveryInfo;
1372 OCStackResult ret = OCDoResource(NULL, OC_REST_DISCOVER, query, 0, 0,
1373 clientResponse->connType, OC_HIGH_QOS, &cbData, NULL, 0);
1374 if(OC_STACK_OK != ret)
1376 OIC_LOG(ERROR, TAG, "Failed to Security Version Discovery");
1381 OIC_LOG_V(INFO, TAG, "OCDoResource with [%s] Success", query);
1384 OIC_LOG(DEBUG, TAG, "OUT SecurityVersionDiscovery");
1390 * Function to print OCProvisionDev_t for debug purpose.
1392 * @param[in] pDev Pointer to OCProvisionDev_t. It's information will be printed by OIC_LOG_XX
1395 void PMPrintOCProvisionDev(const OCProvisionDev_t* pDev)
1399 OIC_LOG(DEBUG, TAG, "+++++ OCProvisionDev_t Information +++++");
1400 OIC_LOG_V(DEBUG, TAG, "IP %s", pDev->endpoint.addr);
1401 OIC_LOG_V(DEBUG, TAG, "PORT %d", pDev->endpoint.port);
1402 OIC_LOG_V(DEBUG, TAG, "S-PORT %d", pDev->securePort);
1403 OIC_LOG(DEBUG, TAG, "++++++++++++++++++++++++++++++++++++++++");
1407 OIC_LOG(DEBUG, TAG, "+++++ OCProvisionDev_t is NULL +++++");
1411 bool PMDeleteFromUUIDList(OCUuidList_t **pUuidList, OicUuid_t *targetId)
1413 if(*pUuidList == NULL || targetId == NULL)
1417 OCUuidList_t *tmp1 = NULL,*tmp2=NULL;
1418 LL_FOREACH_SAFE(*pUuidList, tmp1, tmp2)
1420 if(0 == memcmp(tmp1->dev.id, targetId->id, sizeof(targetId->id)))
1422 LL_DELETE(*pUuidList, tmp1);