service/easy-setup/mediator/richsdk/src/EnrolleeSecurity.cpp

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #include "base64.h"
  22
  23 #include "EnrolleeSecurity.h"
  24 #include "oxmjustworks.h"
  25 #include "oxmrandompin.h"
  26 #include "EnrolleeResource.h"
  27 #include "logger.h"
  28 #include "ESException.h"
  29 #include "oic_malloc.h"
  30 #include "provisioningdatabasemanager.h"
  31 #include "oic_string.h"
  32 #include "utlist.h"
  33
  34 namespace OIC
  35 {
  36     namespace Service
  37     {
  38         #define MAX_PERMISSION_LENGTH (5)
  39         #define CREATE (1)
  40         #define READ (2)
  41         #define UPDATE (4)
  42         #define DELETE (8)
  43         #define NOTIFY (16)
  44         #define DASH '-'
  45         #define DISCOVERY_TIMEOUT (10)
  46
  47         //TODO : Currently discovery timeout for owned and unowned devices is fixed as 5
  48         // The value should be accepted from the application as a parameter during ocplatform
  49         // config call
  50         #define ES_SEC_DISCOVERY_TIMEOUT 5
  51
  52         EnrolleeSecurity::EnrolleeSecurity(
  53             std::shared_ptr< OC::OCResource > resource,
  54             const std::string secDbPath)
  55         {
  56             (void) secDbPath;
  57             m_ocResource = resource;
  58         }
  59
  60         void EnrolleeSecurity::registerCallbackHandler(
  61             const SecurityProvStatusCb securityProvStatusCb,
  62             const SecurityPinCb securityPinCb,
  63             const SecProvisioningDbPathCb secProvisioningDbPathCb)
  64         {
  65             m_securityProvStatusCb = securityProvStatusCb;
  66             m_securityPinCb = securityPinCb;
  67             m_secProvisioningDbPathCb = secProvisioningDbPathCb;
  68         }
  69
  70         std::shared_ptr< OC::OCSecureResource > EnrolleeSecurity::findEnrolleeSecurityResource(
  71             DeviceList_t &list)
  72         {
  73             for (unsigned int i = 0; i < list.size(); i++)
  74             {
  75                 if(m_ocResource->sid() == list[i]->getDeviceID().c_str())
  76                 {
  77                     OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Device %d ID %s ", i + 1,
  78                             list[i]->getDeviceID().c_str());
  79                     OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "From IP :%s",
  80                                                             list[i]->getDevAddr().c_str());
  81                     return list[i];
  82                 }
  83             }
  84             OIC_LOG(ERROR, ENROLEE_SECURITY_TAG,"Error!!! DeviceList_t is NULL");
  85             return NULL;
  86         }
  87
  88         void EnrolleeSecurity::convertUUIDToString(const uint8_t uuid[UUID_SIZE],
  89                                                               std::string& uuidString)
  90         {
  91             char uuidArray[UUID_STRING_SIZE] = {'\0',};
  92             int ret = snprintf(uuidArray, UUID_STRING_SIZE,
  93                     "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
  94                     uuid[0], uuid[1], uuid[2], uuid[3],
  95                     uuid[4], uuid[5], uuid[6], uuid[7],
  96                     uuid[8], uuid[9], uuid[10], uuid[11],
  97                     uuid[12], uuid[13], uuid[14], uuid[15]
  98                     );
  99
 100             if (ret != UUID_STRING_SIZE - 1)
 101             {
 102                 return;
 103             }
 104
 105             uuidString = uuidArray;
 106         }
 107
 108         void EnrolleeSecurity::convertStringToUUID(OicUuid_t& uuid,
 109                                                               const std::string uuidString)
 110         {
 111             size_t outBufSize = B64DECODE_OUT_SAFESIZE((uuidString.length() + 1));
 112             uint8_t* outKey = (uint8_t*)OICCalloc(1, outBufSize);
 113             uint32_t outKeySize = 0;
 114             if(NULL == outKey)
 115             {
 116                 OIC_LOG (ERROR, ENROLEE_SECURITY_TAG, "Failed to memoray allocation.");
 117                 throw ESBadRequestException ("Failed to memoray allocation.");
 118             }
 119
 120             if(B64_OK == b64Decode((char*)uuidString.c_str(),
 121                                     uuidString.length(),
 122                                     outKey,
 123                                     outBufSize,
 124                                     &outKeySize))
 125             {
 126                 memcpy(uuid.id, outKey, outKeySize);
 127             }
 128             else
 129             {
 130                 OIC_LOG (ERROR, ENROLEE_SECURITY_TAG, "Failed to base64 decoding.");
 131                 throw ESBadRequestException ("Failed to base64 decoding.");
 132             }
 133
 134             OICFree(outKey);
 135         }
 136
 137         void EnrolleeSecurity::ownershipTransferCb(OC::PMResultList_t *result, int hasError)
 138         {
 139             if (hasError)
 140             {
 141                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG,"Error!!! in OwnershipTransfer");
 142
 143                 std::string uuid;
 144                 convertUUIDToString(result->at(0).deviceId.id, uuid);
 145                 std::shared_ptr< SecProvisioningStatus > securityProvisioningStatus =
 146                         std::make_shared< SecProvisioningStatus >(uuid, ES_ERROR);
 147                 m_securityProvStatusCb(securityProvisioningStatus);
 148                 return;
 149             }
 150             else
 151             {
 152                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "ownershipTransferCb : Received provisioning results: ");
 153                 for (unsigned int i = 0; i < result->size(); i++)
 154                 {
 155                     OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Result is = %d for device",result->at(i).res);
 156                     std::string uuid;
 157                     convertUUIDToString(result->at(0).deviceId.id, uuid);
 158
 159                     OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "UUID : %s",uuid.c_str());
 160                     std::shared_ptr< SecProvisioningStatus > securityProvisioningStatus =
 161                             std::make_shared< SecProvisioningStatus >(uuid, ES_OK);
 162                     m_securityProvStatusCb(securityProvisioningStatus);
 163                     return;
 164                 }
 165
 166                 delete result;
 167             }
 168         }
 169
 170         void EnrolleeSecurity::provisionOwnership()
 171         {
 172             OC::DeviceList_t pUnownedDevList, pOwnedDevList;
 173
 174             pOwnedDevList.clear();
 175             pUnownedDevList.clear();
 176
 177             OCStackResult result = OC_STACK_ERROR;
 178
 179             result = OCSecure::discoverOwnedDevices(ES_SEC_DISCOVERY_TIMEOUT,
 180                     pOwnedDevList);
 181             if (result != OC_STACK_OK)
 182             {
 183                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "Owned Discovery failed.");
 184                 //Throw exception
 185                 throw ESPlatformException(result);
 186             }
 187             else if (pOwnedDevList.size())
 188             {
 189                 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Found owned devices. Count =%d",
 190                         pOwnedDevList.size());
 191                 std::shared_ptr< OC::OCSecureResource > ownedDevice =
 192                     findEnrolleeSecurityResource(pOwnedDevList);
 193
 194                 if (ownedDevice)
 195                 {
 196                     std::shared_ptr< SecProvisioningStatus > securityProvisioningStatus =
 197                             std::make_shared< SecProvisioningStatus >(ownedDevice->getDeviceID(), ES_OK);
 198                     m_securityProvStatusCb(securityProvisioningStatus);
 199                     return;
 200                 }
 201             }
 202
 203             result = OCSecure::discoverUnownedDevices(ES_SEC_DISCOVERY_TIMEOUT, pUnownedDevList);
 204             if (result != OC_STACK_OK)
 205             {
 206                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "UnOwned Discovery failed.");
 207                 //Throw exception
 208                 throw ESPlatformException(result);
 209             }
 210             else if (pUnownedDevList.size())
 211             {
 212                 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Found Unowned devices. Count =%d",
 213                         pUnownedDevList.size());
 214
 215                 m_unownedDevice = findEnrolleeSecurityResource(pUnownedDevList);
 216                 if (m_unownedDevice)
 217                 {
 218                     if(isOwnedDeviceRegisteredInSVRDB())
 219                     {
 220                         OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG,
 221                             "Found Unowned device's DevID at DB of ownedDevices list");
 222
 223                         OC::ResultCallBack removeDeviceWithUuidCB = std::bind(
 224                                 &EnrolleeSecurity::removeDeviceWithUuidCB,
 225                                 this, std::placeholders::_1, std::placeholders::_2);
 226
 227                         OCSecure::removeDeviceWithUuid(DISCOVERY_TIMEOUT,
 228                                                        m_ocResource->sid(),
 229                                                        removeDeviceWithUuidCB);
 230                     }
 231                     else
 232                     {
 233                         performOwnershipTransfer();
 234                     }
 235                 }
 236                 else
 237                 {
 238                     OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "No matched unowned devices found.");
 239                     throw ESException("No matched unowned devices found.");
 240                 }
 241             }
 242             else
 243             {
 244                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "No unowned devices found.");
 245                 throw ESException("No unowned devices found.");
 246             }
 247         }
 248
 249         void EnrolleeSecurity::performOwnershipTransfer()
 250         {
 251             OCStackResult result = OC_STACK_ERROR;
 252
 253             OTMCallbackData_t justWorksCBData;
 254             justWorksCBData.loadSecretCB = LoadSecretJustWorksCallback;
 255             justWorksCBData.createSecureSessionCB = CreateSecureSessionJustWorksCallback;
 256             justWorksCBData.createSelectOxmPayloadCB = CreateJustWorksSelectOxmPayload;
 257             justWorksCBData.createOwnerTransferPayloadCB =
 258                     CreateJustWorksOwnerTransferPayload;
 259             OCSecure::setOwnerTransferCallbackData(OIC_JUST_WORKS, &justWorksCBData, NULL);
 260
 261             OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Transfering ownership for : %s ",
 262                     m_unownedDevice->getDeviceID().c_str());
 263
 264             OC::ResultCallBack ownershipTransferCb = std::bind(
 265                     &EnrolleeSecurity::ownershipTransferCb, this, std::placeholders::_1,
 266                     std::placeholders::_2);
 267
 268             result = m_unownedDevice->doOwnershipTransfer(ownershipTransferCb);
 269             if (result != OC_STACK_OK)
 270             {
 271                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "doOwnershipTransfer is failed");
 272                 throw ESPlatformException(result);
 273             }
 274         }
 275
 276         void EnrolleeSecurity::removeDeviceWithUuidCB(OC::PMResultList_t *result, int hasError)
 277         {
 278             if (hasError)
 279             {
 280                OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Error in removeDeviceWithUuid operation!");
 281                throw ESException("removeDeviceWithUuid Error");
 282             }
 283
 284             else
 285             {
 286                OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Received provisioning results: ");
 287
 288                for (unsigned int i = 0; i < result->size(); i++)
 289                {
 290                     std::string uuid;
 291                     convertUUIDToString(result->at(i).deviceId.id, uuid);
 292
 293                     OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG,
 294                         "Result is = %d for device %s",  result->at(i).res, uuid.c_str());
 295                }
 296                performOwnershipTransfer();
 297             }
 298         }
 299
 300         bool EnrolleeSecurity::isOwnedDeviceRegisteredInSVRDB()
 301         {
 302             OCStackResult res = OC_STACK_ERROR;
 303
 304             OCUuidList_t *uuidList = NULL;
 305             size_t numOfDevices = 0;
 306
 307             res = PDMGetOwnedDevices(&uuidList, &numOfDevices);
 308             if (OC_STACK_OK != res)
 309             {
 310                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "Error while getting info from DB");
 311                 return false;
 312             }
 313
 314             OCUuidList_t *pUuidList = uuidList;
 315
 316             while (pUuidList)
 317             {
 318                 std::string uuid;
 319                 convertUUIDToString(pUuidList->dev.id, uuid);
 320                 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG,
 321                     "m_ocResource->sid(): %s, cur DB UUID %s",
 322                     m_ocResource->sid().c_str(), uuid.c_str());
 323                 if(m_ocResource->sid() == uuid.c_str())
 324                 {
 325                     return true;
 326                 }
 327                 pUuidList = pUuidList->next;
 328             }
 329             return false;
 330         }
 331
 332         void EnrolleeSecurity::provisionSecurityForCloudServer(
 333             std::string cloudUuid, int credId)
 334         {
 335             // Need to discover Owned device in a given network, again
 336             OC::DeviceList_t pOwnedDevList;
 337             std::shared_ptr< OC::OCSecureResource > ownedDevice = NULL;
 338
 339             pOwnedDevList.clear();
 340
 341             OCStackResult result;
 342
 343             result = OCSecure::discoverOwnedDevices(ES_SEC_DISCOVERY_TIMEOUT,
 344                     pOwnedDevList);
 345             if (result != OC_STACK_OK)
 346             {
 347                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "Owned Discovery failed.");
 348                 //Throw exception
 349                 throw ESPlatformException(result);
 350             }
 351             else if (pOwnedDevList.size())
 352             {
 353                 OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Found owned devices. Count =%d",
 354                         pOwnedDevList.size());
 355                 ownedDevice = findEnrolleeSecurityResource(pOwnedDevList);
 356
 357                 if (!ownedDevice)
 358                 {
 359                     OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Not found matched owned device.");
 360                     throw ESException("Not found matched owned device.");
 361                 }
 362             }
 363             else
 364             {
 365                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Not found owned devices.");
 366                 throw ESException("Not found owned devices.");
 367             }
 368
 369             if(performACLProvisioningForCloudServer(ownedDevice, cloudUuid) != ESResult::ES_OK)
 370             {
 371                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "error performACLProvisioningForCloudServer");
 372                 throw ESException("error performACLProvisioningForCloudServer");
 373             }
 374
 375             if(performCertProvisioningForCloudServer(ownedDevice, credId) != ESResult::ES_OK)
 376             {
 377                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "error performCertProvisioningForCloudServer");
 378                 throw ESException("error performCertProvisioningForCloudServer");
 379             }
 380         }
 381
 382         ESResult EnrolleeSecurity::performCertProvisioningForCloudServer(
 383             std::shared_ptr< OC::OCSecureResource > ownedDevice, int credId)
 384         {
 385             ESResult res = ESResult::ES_ERROR;
 386
 387             if(!ownedDevice)
 388             {
 389                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Invalid param");
 390                 return res;
 391             }
 392             OC::ResultCallBack CertProvisioningCb = std::bind(
 393                             &EnrolleeSecurity::CertProvisioningCb, this, std::placeholders::_1,
 394                             std::placeholders::_2);
 395             OCStackResult rst = ownedDevice->provisionTrustCertChain(SIGNED_ASYMMETRIC_KEY,
 396                                                                     static_cast<uint16_t>(credId),
 397                                                                     CertProvisioningCb);
 398             if(OC_STACK_OK != rst)
 399             {
 400                 OIC_LOG_V(ERROR, ENROLEE_SECURITY_TAG, "provisionTrustCertChain error: %d", rst);
 401                 return res;
 402             }
 403
 404             std::unique_lock<std::mutex> lck(m_mtx);
 405             m_cond.wait_for(lck, std::chrono::seconds(ES_SEC_DISCOVERY_TIMEOUT));
 406
 407             if(certResult)
 408             {
 409                 res = ESResult::ES_OK;
 410             }
 411
 412             return res;
 413         }
 414
 415         ESResult EnrolleeSecurity::performACLProvisioningForCloudServer(
 416             std::shared_ptr< OC::OCSecureResource > ownedDevice, std::string& cloudUuid)
 417         {
 418             ESResult res = ESResult::ES_ERROR;
 419
 420             if(!ownedDevice)
 421             {
 422                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Invalid param");
 423                 return res;
 424             }
 425             if(cloudUuid.empty())
 426             {
 427                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Invalid param");
 428                 return res;
 429             }
 430
 431             OicUuid_t uuid;
 432             convertStringToUUID(uuid, cloudUuid);
 433
 434             // Create Acl for Cloud Server to be provisioned to Enrollee
 435             OicSecAcl_t* acl = createAcl(uuid);
 436             if(!acl)
 437             {
 438                 OIC_LOG(ERROR, ENROLEE_SECURITY_TAG, "createAcl error return");
 439                 return res;
 440             }
 441
 442             OC::ResultCallBack aclProvisioningCb = std::bind(
 443                             &EnrolleeSecurity::ACLProvisioningCb, this, std::placeholders::_1,
 444                             std::placeholders::_2);
 445             // ACL provisioning to Enrollee
 446             OCStackResult rst = ownedDevice->provisionACL(acl, aclProvisioningCb);
 447             if(OC_STACK_OK != rst)
 448             {
 449                 OIC_LOG_V(ERROR, ENROLEE_SECURITY_TAG, "OCProvisionACL API error: %d", rst);
 450                 return res;
 451             }
 452
 453             std::unique_lock<std::mutex> lck(m_mtx);
 454             m_cond.wait_for(lck, std::chrono::seconds(ES_SEC_DISCOVERY_TIMEOUT));
 455
 456             if(aclResult)
 457             {
 458                 res = ESResult::ES_OK;
 459             }
 460
 461             return res;
 462         }
 463
 464         std::string EnrolleeSecurity::getUUID() const
 465         {
 466             return m_ocResource->sid();
 467         };
 468
 469         OicSecAcl_t* EnrolleeSecurity::createAcl(const OicUuid_t cloudUuid)
 470         {
 471             // allocate memory for |acl| struct
 472             OicSecAcl_t* acl = (OicSecAcl_t*) OICCalloc(1, sizeof(OicSecAcl_t));
 473             if(!acl)
 474             {
 475                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "createAcl: OICCalloc error return");
 476                 return NULL;  // not need to 'goto' |ERROR| before allocating |acl|
 477             }
 478             OicSecAce_t* ace = (OicSecAce_t*) OICCalloc(1, sizeof(OicSecAce_t));
 479             if(!ace)
 480             {
 481                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG,  "createAcl: OICCalloc error return");
 482                 return NULL;  // not need to 'goto' |ERROR| before allocating |acl|
 483             }
 484             LL_APPEND(acl->aces, ace);
 485
 486             memcpy(&ace->subjectuuid, &cloudUuid, UUID_LENGTH);
 487
 488             OicSecRsrc_t* rsrc = (OicSecRsrc_t*)OICCalloc(1, sizeof(OicSecRsrc_t));
 489             if(!rsrc)
 490             {
 491                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "createAcl: OICCalloc error return");
 492                 OCDeleteACLList(acl);
 493                 return NULL;
 494             }
 495
 496             char href[] = "*";
 497             size_t len = strlen(href)+1;  // '1' for null termination
 498             rsrc->href = (char*) OICCalloc(len, sizeof(char));
 499             if(!rsrc->href)
 500             {
 501                 OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG,  "createAcl: OICCalloc error return");
 502                 OCDeleteACLList(acl);
 503                 return NULL;
 504             }
 505             OICStrcpy(rsrc->href, len, href);
 506
 507             size_t arrLen = 1;
 508             rsrc->typeLen = arrLen;
 509             rsrc->types = (char**)OICCalloc(arrLen, sizeof(char*));
 510             rsrc->interfaces = (char**)OICCalloc(arrLen, sizeof(char*));
 511             rsrc->types[0] = OICStrdup("rt");   // ignore
 512             rsrc->interfaces[0] = OICStrdup("if");  // ignore
 513
 514             LL_APPEND(ace->resources, rsrc);
 515
 516             ace->permission = 31;   // R/W/U/D
 517
 518             return acl;
 519         }
 520
 521         void EnrolleeSecurity::ACLProvisioningCb(PMResultList_t *result, int hasError)
 522         {
 523             if (hasError)
 524             {
 525                OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Error in provisioning operation!");
 526                aclResult = false;
 527             }
 528             else
 529             {
 530                OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Received provisioning results: ");
 531
 532                std::string devUuid;
 533                for (unsigned int i = 0; i < result->size(); i++)
 534                {
 535                    convertUUIDToString(result->at(i).deviceId.id, devUuid);
 536                    OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Result is = %d  for device %s",
 537                                                            result->at(i).res, devUuid.c_str());
 538                }
 539                delete result;
 540                aclResult = true;
 541             }
 542             m_cond.notify_all();
 543         }
 544
 545         void EnrolleeSecurity::CertProvisioningCb(PMResultList_t *result, int hasError)
 546         {
 547             if (hasError)
 548             {
 549                OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Error in provisioning operation!");
 550                aclResult = false;
 551             }
 552             else
 553             {
 554                OIC_LOG(DEBUG, ENROLEE_SECURITY_TAG, "Received provisioning results: ");
 555
 556                std::string devUuid;
 557                for (unsigned int i = 0; i < result->size(); i++)
 558                {
 559                    convertUUIDToString(result->at(i).deviceId.id, devUuid);
 560                    OIC_LOG_V(DEBUG, ENROLEE_SECURITY_TAG, "Result is = %d  for device %s",
 561                                                            result->at(i).res, devUuid.c_str());
 562                }
 563                delete result;
 564                certResult= true;
 565             }
 566             m_cond.notify_all();
 567         }
 568     }
 569 }