1 //******************************************************************
3 // Copyright 2015 Samsung Electronics 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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
23 #include "EnrolleeSecurity.h"
24 #include "oxmjustworks.h"
25 #include "oxmrandompin.h"
26 #include "RemoteEnrolleeResource.h"
28 #include "ESException.h"
29 #include "oic_malloc.h"
30 #include "oic_string.h"
36 #define MAX_PERMISSION_LENGTH (5)
44 //TODO : Currently discovery timeout for owned and unowned devices is fixed as 5
45 // The value should be accepted from the application as a parameter during ocplatform
47 #define ES_SEC_DISCOVERY_TIMEOUT 5
49 EnrolleeSecurity::EnrolleeSecurity(
50 std::shared_ptr< RemoteEnrolleeResource > remoteEnrolleeResource,
51 std::string secDbPath)
53 m_enrolleeSecState = EnrolleeSecState::ES_SEC_UNKNOWN;
54 m_remoteEnrolleeResource = remoteEnrolleeResource;
57 ESResult EnrolleeSecurity::registerCallbackHandler(EnrolleeSecStatusCb enrolleeSecStatusCb,
58 SecurityPinCb securityPinCb, SecProvisioningDbPathCb secProvisioningDbPathCb)
61 m_enrolleeSecStatusCb = enrolleeSecStatusCb;
62 m_securityPinCb = securityPinCb;
63 m_secProvisioningDbPathCb = secProvisioningDbPathCb;
68 std::shared_ptr< OC::OCSecureResource > EnrolleeSecurity::getEnrollee(DeviceList_t &list)
70 for (unsigned int i = 0; i < list.size(); i++)
72 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Device %d ID %s ", i + 1,
73 list[i]->getDeviceID().c_str());
74 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "From IP :%s", list[i]->getDevAddr().c_str());
76 //Always return the first element of the unOwned devices. This is considering that Mediator is
77 // always connected with only one Enrollee for which ownership transfer is being performed.
78 // Incase of multiple Enrollee devices connected to the Mediator via any OnBoarding method (SoftAp
79 // for example), the Enrollee devices will be provisioned in the first come first serve basis in the order
80 // returned by the security layer.
85 void EnrolleeSecurity::convertUUIDToString(OicUuid_t uuid, std::string& uuidString)
87 char base64Buff[B64ENCODE_OUT_SAFESIZE(sizeof(((OicUuid_t*) 0)->id)) + 1] =
90 B64Result b64Ret = B64_OK;
91 std::ostringstream deviceId("");
93 b64Ret = b64Encode(uuid.id, sizeof(uuid.id),
94 base64Buff, sizeof(base64Buff), &outLen);
98 deviceId << base64Buff;
100 uuidString = deviceId.str();
103 void EnrolleeSecurity::ownershipTransferCb(OC::PMResultList_t *result, int hasError)
107 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG,"Error!!! in OwnershipTransfer");
109 std::shared_ptr< SecProvisioningResult > securityProvisioningStatus = nullptr;
111 convertUUIDToString(result->at(0).deviceId, uuid);
112 securityProvisioningStatus = std::make_shared< SecProvisioningResult >(uuid,
115 m_enrolleeSecStatusCb(securityProvisioningStatus);
120 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "ownershipTransferCb : Received provisioning results: ");
121 for (unsigned int i = 0; i < result->size(); i++)
123 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Result is = %d for device",result->at(i).res);
125 convertUUIDToString(result->at(0).deviceId, uuid);
127 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "UUID : %s",uuid.c_str());
128 std::shared_ptr< SecProvisioningResult > securityProvisioningStatus = nullptr;
129 securityProvisioningStatus = std::make_shared< SecProvisioningResult >(uuid,
132 m_enrolleeSecStatusCb(securityProvisioningStatus);
140 EasySetupState EnrolleeSecurity::performOwnershipTransfer()
142 EasySetupState ownershipStatus = DEVICE_NOT_OWNED;
144 OC::DeviceList_t pUnownedDevList, pOwnedDevList;
146 pOwnedDevList.clear();
147 pUnownedDevList.clear();
149 OCStackResult result;
151 //Developer note : Always test the mediator and enrollee applications on different devices. Running
152 // Mediator and Enrollee in same device will result in returning the same device as already owned.
153 /*result = OCSecure::discoverOwnedDevices(ES_SEC_DISCOVERY_TIMEOUT,
155 if (result != OC_STACK_OK)
157 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "Owned Discovery failed.");
158 ownershipStatus = DEVICE_NOT_OWNED;
160 throw ESPlatformException(result);
161 return ownershipStatus;
163 else if (pOwnedDevList.size())
165 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Found owned devices. Count =%d",
166 pOwnedDevList.size());
167 std::shared_ptr< OC::OCSecureResource > ownedDevice = getEnrollee(pOwnedDevList);
170 ownershipStatus = DEVICE_OWNED;
171 return ownershipStatus;
176 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "No owned devices found.");
177 ownershipStatus = DEVICE_NOT_OWNED;
180 result = OCSecure::discoverUnownedDevices(ES_SEC_DISCOVERY_TIMEOUT, pUnownedDevList);
181 if (result != OC_STACK_OK)
183 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "UnOwned Discovery failed.");
184 ownershipStatus = DEVICE_NOT_OWNED;
186 throw ESPlatformException(result);
187 return ownershipStatus;
189 else if (pUnownedDevList.size())
191 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Found Unowned devices. Count =%d",
192 pUnownedDevList.size());
194 m_unownedDevice = getEnrollee(pUnownedDevList);
197 OTMCallbackData_t justWorksCBData;
198 justWorksCBData.loadSecretCB = LoadSecretJustWorksCallback;
199 justWorksCBData.createSecureSessionCB = CreateSecureSessionJustWorksCallback;
200 justWorksCBData.createSelectOxmPayloadCB = CreateJustWorksSelectOxmPayload;
201 justWorksCBData.createOwnerTransferPayloadCB =
202 CreateJustWorksOwnerTransferPayload;
203 OCSecure::setOwnerTransferCallbackData(OIC_JUST_WORKS, &justWorksCBData, NULL);
205 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Transfering ownership for : %s ",
206 m_unownedDevice->getDeviceID().c_str());
208 OC::ResultCallBack ownershipTransferCb = std::bind(
209 &EnrolleeSecurity::ownershipTransferCb, this, std::placeholders::_1,
210 std::placeholders::_2);
212 if (m_unownedDevice->doOwnershipTransfer(ownershipTransferCb) != OC_STACK_OK)
214 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "OwnershipTransferCallback is failed");
215 ownershipStatus = DEVICE_NOT_OWNED;
216 return ownershipStatus;
218 ownershipStatus = DEVICE_NOT_OWNED;
223 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "No unSecure devices found.");
224 ownershipStatus = DEVICE_NOT_OWNED;
226 return ownershipStatus;
229 return ownershipStatus;