service/easy-setup/mediator/richsdk/src/RemoteEnrollee.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 "RemoteEnrollee.h"
  22 #include "EnrolleeResource.h"
  23 #include "CloudResource.h"
  24 #include "OCPlatform.h"
  25 #include "ESException.h"
  26 #include "logger.h"
  27 #include "OCResource.h"
  28 #ifdef __WITH_DTLS__
  29 #include "EnrolleeSecurity.h"
  30 #include "base64.h"
  31 #include "oic_malloc.h"
  32 #endif //__WITH_DTLS
  33
  34 namespace OIC
  35 {
  36     namespace Service
  37     {
  38         static const char ES_BASE_RES_URI[] = "/oic/res";
  39         #define ES_REMOTE_ENROLLEE_TAG "ES_REMOTE_ENROLLEE"
  40         #define DISCOVERY_TIMEOUT 5
  41
  42         RemoteEnrollee::RemoteEnrollee(const std::shared_ptr< OC::OCResource > resource)
  43         {
  44             m_ocResource = resource;
  45             m_enrolleeResource = std::make_shared<EnrolleeResource>(m_ocResource);
  46             m_securityProvStatusCb = nullptr;
  47             m_getConfigurationStatusCb = nullptr;
  48             m_securityPinCb = nullptr;
  49             m_secProvisioningDbPathCb = nullptr;
  50             m_devicePropProvStatusCb = nullptr;
  51             m_cloudPropProvStatusCb = nullptr;
  52
  53             m_deviceId = resource->sid();
  54         }
  55
  56 #ifdef __WITH_DTLS__
  57         ESResult RemoteEnrollee::registerSecurityCallbackHandler(
  58                 const SecurityPinCb securityPinCb,
  59                 const SecProvisioningDbPathCb secProvisioningDbPathCb)
  60         {
  61             // No need to check NULL for m_secProvisioningDbPathCB as this is not a mandatory
  62             // callback function. If m_secProvisioningDbPathCB is NULL, provisioning manager
  63             // in security layer will try to find the PDM.db file in the local path.
  64             // If PDM.db is found, the provisioning manager operations will succeed.
  65             // Otherwise all the provisioning manager operations will fail.
  66             m_secProvisioningDbPathCb = secProvisioningDbPathCb;
  67             m_securityPinCb = securityPinCb;
  68             return ES_OK;
  69         }
  70 #endif //__WITH_DTLS__
  71
  72         void RemoteEnrollee::securityStatusHandler(
  73                 const std::shared_ptr< SecProvisioningStatus > status) const
  74         {
  75             OIC_LOG_V(DEBUG, ES_REMOTE_ENROLLEE_TAG, "easySetupStatusCallback status is, UUID = %s,"
  76                     "Status = %d", status->getDeviceUUID().c_str(),
  77                     status->getESResult());
  78
  79             if(status->getESResult() == ES_OK)
  80             {
  81                 OIC_LOG(DEBUG, ES_REMOTE_ENROLLEE_TAG, "Ownership and ACL are successful. "
  82                         "Continue with Network information provisioning");
  83
  84                 OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Before provisionProperties");
  85
  86                 m_securityProvStatusCb(status);
  87             }
  88             else
  89             {
  90                 OIC_LOG(DEBUG, ES_REMOTE_ENROLLEE_TAG, "Ownership and ACL are fail");
  91
  92                 m_securityProvStatusCb(status);
  93             }
  94         }
  95
  96         void RemoteEnrollee::getStatusHandler(
  97                 const std::shared_ptr< GetEnrolleeStatus > status) const
  98         {
  99             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Entering getStatusHandler");
 100
 101             OIC_LOG_V(DEBUG,ES_REMOTE_ENROLLEE_TAG,"getStatusHandler = %d", status->getESResult());
 102
 103             m_getStatusCb(status);
 104         }
 105
 106         void RemoteEnrollee::getConfigurationStatusHandler (
 107                 const std::shared_ptr< GetConfigurationStatus > status) const
 108         {
 109             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Entering getConfigurationStatusHandler");
 110
 111             OIC_LOG_V(DEBUG,ES_REMOTE_ENROLLEE_TAG,"GetConfigurationStatus = %d",
 112                                                     status->getESResult());
 113
 114             m_getConfigurationStatusCb(status);
 115         }
 116
 117         void RemoteEnrollee::devicePropProvisioningStatusHandler(
 118                 const std::shared_ptr< DevicePropProvisioningStatus > status) const
 119         {
 120             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Entering DevicePropProvisioningStatusHandler");
 121
 122             OIC_LOG_V(DEBUG,ES_REMOTE_ENROLLEE_TAG,"ProvStatus = %d", status->getESResult());
 123
 124             m_devicePropProvStatusCb(status);
 125
 126             return;
 127         }
 128
 129         void RemoteEnrollee::cloudPropProvisioningStatusHandler (
 130                 const std::shared_ptr< CloudPropProvisioningStatus > status) const
 131         {
 132             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Entering cloudPropProvisioningStatusHandler");
 133
 134             OIC_LOG_V(DEBUG,ES_REMOTE_ENROLLEE_TAG,"CloudProvStatus = %d",
 135                                                     status->getESResult());
 136
 137             m_cloudPropProvStatusCb(status);
 138             return;
 139         }
 140
 141         void RemoteEnrollee::onDeviceDiscovered(std::shared_ptr<OC::OCResource> resource)
 142         {
 143             OIC_LOG (DEBUG, ES_REMOTE_ENROLLEE_TAG, "onDeviceDiscovered");
 144
 145             std::string resourceURI;
 146             std::string hostAddress;
 147             std::string hostDeviceID;
 148
 149             try
 150             {
 151                 if(resource)
 152                 {
 153                     if(!(resource->connectivityType() & CT_ADAPTER_TCP))
 154                     {
 155                         // Get the resource URI
 156                         resourceURI = resource->uri();
 157                         OIC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_TAG,
 158                                 "URI of the resource: %s", resourceURI.c_str());
 159
 160                         // Get the resource host address
 161                         hostAddress = resource->host();
 162                         OIC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_TAG,
 163                                 "Host address of the resource: %s", hostAddress.c_str());
 164
 165                         hostDeviceID = resource->sid();
 166                         OIC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_TAG,
 167                                 "Host DeviceID of the resource: %s", hostDeviceID.c_str());
 168
 169                         if(!m_deviceId.empty() && m_deviceId == hostDeviceID)
 170                         {
 171                             OIC_LOG (DEBUG, ES_REMOTE_ENROLLEE_TAG, "Find matched CloudResource");
 172                             m_ocResource = resource;
 173                             m_discoveryResponse = true;
 174                             m_cond.notify_all();
 175                         }
 176                     }
 177                 }
 178             }
 179             catch(std::exception& e)
 180             {
 181                 OIC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_TAG,
 182                         "Exception in foundResource: %s", e.what());
 183             }
 184         }
 185
 186         ESResult RemoteEnrollee::discoverResource()
 187         {
 188             OIC_LOG(DEBUG, ES_REMOTE_ENROLLEE_TAG, "Enter discoverResource");
 189
 190             std::string query("");
 191             query.append(ES_BASE_RES_URI);
 192             query.append("?rt=");
 193             query.append(OC_RSRVD_ES_RES_TYPE_PROV);
 194
 195             OIC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_TAG, "query = %s", query.c_str());
 196
 197             m_discoveryResponse = false;
 198
 199             std::function< void (std::shared_ptr<OC::OCResource>) > onDeviceDiscoveredCb =
 200                     std::bind(&RemoteEnrollee::onDeviceDiscovered, this,
 201                                                     std::placeholders::_1);
 202             OCStackResult result = OC::OCPlatform::findResource("", query, CT_DEFAULT,
 203                     onDeviceDiscoveredCb);
 204
 205             if (result != OCStackResult::OC_STACK_OK)
 206             {
 207                 OIC_LOG(ERROR,ES_REMOTE_ENROLLEE_TAG,
 208                         "Failed discoverResource");
 209                 return ES_ERROR;
 210             }
 211
 212             std::unique_lock<std::mutex> lck(m_discoverymtx);
 213             m_cond.wait_for(lck, std::chrono::seconds(DISCOVERY_TIMEOUT));
 214
 215             if (!m_discoveryResponse)
 216             {
 217                 OIC_LOG(ERROR,ES_REMOTE_ENROLLEE_TAG,
 218                         "Failed discoverResource because timeout");
 219                 return ES_ERROR;
 220             }
 221             return ES_OK;
 222         }
 223
 224         void RemoteEnrollee::provisionSecurity(const SecurityProvStatusCb callback)
 225         {
 226 #ifdef __WITH_DTLS__
 227             std::cout << __func__ << std::endl;
 228             if(!callback)
 229             {
 230                 throw ESInvalidParameterException("Callback is empty");
 231             }
 232             m_securityProvStatusCb = callback;
 233
 234             SecurityProvStatusCb securityProvStatusCb = std::bind(
 235                     &RemoteEnrollee::securityStatusHandler,
 236                     this,
 237                     std::placeholders::_1);
 238             //TODO : DBPath is passed empty as of now. Need to take dbpath from application.
 239             m_enrolleeSecurity = std::make_shared <EnrolleeSecurity> (m_ocResource, "");
 240
 241             m_enrolleeSecurity->registerCallbackHandler(securityProvStatusCb, m_securityPinCb,
 242                                                         m_secProvisioningDbPathCb);
 243
 244             try
 245             {
 246                 m_enrolleeSecurity->provisionOwnership();
 247             }
 248             catch (const std::exception& e)
 249             {
 250                 OIC_LOG_V(ERROR, ES_REMOTE_ENROLLEE_TAG,
 251                         "Exception for performOwnershipTransfer : %s", e.what());
 252
 253                 OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Fail performOwnershipTransfer");
 254                 std::shared_ptr< SecProvisioningStatus > securityProvisioningStatus =
 255                         std::make_shared< SecProvisioningStatus >
 256                                                         (m_enrolleeSecurity->getUUID(), ES_ERROR);
 257                     m_securityProvStatusCb(securityProvisioningStatus);
 258                 return ;
 259             }
 260 #else
 261             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Mediator is unsecured.");
 262             if(!callback)
 263             {
 264                 throw ESInvalidParameterException("Callback is empty");
 265             }
 266             std::shared_ptr< SecProvisioningStatus > securityProvisioningStatus =
 267                      std::make_shared< SecProvisioningStatus >
 268                                    ("", ESResult::ES_SEC_OPERATION_IS_NOT_SUPPORTED);
 269             callback(securityProvisioningStatus);
 270 #endif
 271         }
 272
 273         void RemoteEnrollee::getStatus(const GetStatusCb callback)
 274         {
 275             if(!callback)
 276             {
 277                 throw ESInvalidParameterException("Callback is empty");
 278             }
 279
 280             if (m_enrolleeResource == nullptr)
 281             {
 282                 throw ESBadRequestException ("Device not created");
 283             }
 284
 285             m_getStatusCb = callback;
 286
 287             GetStatusCb getStatusCb = std::bind(
 288                 &RemoteEnrollee::getStatusHandler, this, std::placeholders::_1);
 289             m_enrolleeResource->registerGetStatusCallback(getStatusCb);
 290             m_enrolleeResource->getStatus();
 291
 292         }
 293
 294         void RemoteEnrollee::getConfiguration(const GetConfigurationStatusCb callback)
 295         {
 296             if(!callback)
 297             {
 298                 throw ESInvalidParameterException("Callback is empty");
 299             }
 300
 301             if (m_enrolleeResource == nullptr)
 302             {
 303                 throw ESBadRequestException ("Device not created");
 304             }
 305
 306             m_getConfigurationStatusCb = callback;
 307
 308             GetConfigurationStatusCb getConfigurationStatusCb = std::bind(
 309                     &RemoteEnrollee::getConfigurationStatusHandler, this, std::placeholders::_1);
 310             m_enrolleeResource->registerGetConfigurationStatusCallback(getConfigurationStatusCb);
 311             m_enrolleeResource->getConfiguration();
 312         }
 313
 314         void RemoteEnrollee::provisionDeviceProperties(const DeviceProp& deviceProp,
 315                                                             const DevicePropProvStatusCb callback)
 316         {
 317             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Enter provisionDeviceProperties");
 318
 319             if(!callback)
 320             {
 321                 throw ESInvalidParameterException("Callback is empty");
 322             }
 323
 324             m_devicePropProvStatusCb = callback;
 325
 326             if (m_enrolleeResource == nullptr)
 327             {
 328                 throw ESBadRequestException ("Device not created");
 329             }
 330
 331             if(deviceProp.getSsid().empty())
 332             {
 333                 throw ESBadRequestException ("Invalid Provisiong Data.");
 334             }
 335
 336             DevicePropProvStatusCb devicePropProvStatusCb = std::bind(
 337                     &RemoteEnrollee::devicePropProvisioningStatusHandler,
 338                     this, std::placeholders::_1);
 339
 340             m_enrolleeResource->registerDevicePropProvStatusCallback(devicePropProvStatusCb);
 341             m_enrolleeResource->provisionProperties(deviceProp);
 342         }
 343
 344         void RemoteEnrollee::initCloudResource()
 345         {
 346             ESResult result = ES_ERROR;
 347
 348             result = discoverResource();
 349
 350             if (result == ES_ERROR)
 351             {
 352                 OIC_LOG(ERROR,ES_REMOTE_ENROLLEE_TAG,
 353                                     "Failed to create resource object using discoverResource");
 354                 throw ESBadRequestException ("Resource object not created");
 355             }
 356
 357             else
 358             {
 359                 if(m_ocResource != nullptr)
 360                 {
 361                     m_cloudResource = std::make_shared<CloudResource>(m_ocResource);
 362
 363                     std::shared_ptr< CloudPropProvisioningStatus > provStatus = std::make_shared<
 364                         CloudPropProvisioningStatus >(ESResult::ES_FOUND_ENROLLEE);
 365
 366                     m_cloudPropProvStatusCb(provStatus);
 367                 }
 368                 else
 369                 {
 370                     throw ESBadGetException ("Resource handle is invalid");
 371                 }
 372             }
 373         }
 374
 375         void RemoteEnrollee::provisionCloudProperties(const CloudProp& cloudProp,
 376                                                             const CloudPropProvStatusCb callback)
 377         {
 378             OIC_LOG(DEBUG,ES_REMOTE_ENROLLEE_TAG,"Enter provisionCloudProperties");
 379
 380             if(!callback)
 381             {
 382                 throw ESInvalidParameterException("Callback is empty");
 383             }
 384
 385             m_cloudPropProvStatusCb = callback;
 386
 387             if(cloudProp.getAuthCode().empty() ||
 388                 cloudProp.getAuthProvider().empty() ||
 389                 cloudProp.getCiServer().empty())
 390             {
 391                 throw ESBadRequestException ("Invalid Cloud Provisiong Info.");
 392             }
 393
 394             try
 395             {
 396                 initCloudResource();
 397             }
 398
 399             catch (const std::exception& e)
 400             {
 401                 OIC_LOG_V(ERROR, ES_REMOTE_ENROLLEE_TAG,
 402                     "Exception caught in provisionCloudProperties = %s", e.what());
 403
 404                 std::shared_ptr< CloudPropProvisioningStatus > provStatus = std::make_shared<
 405                         CloudPropProvisioningStatus >(ESResult::ES_NOT_FOUND_ENROLLEE);
 406                 m_cloudPropProvStatusCb(provStatus);
 407                 return;
 408             }
 409 #if defined(__WITH_DTLS__) && defined(__WITH_TLS__)
 410             try
 411             {
 412                 m_enrolleeSecurity = std::make_shared <EnrolleeSecurity> (m_ocResource, "");
 413
 414                 if(cloudProp.getCloudID().empty())
 415                 {
 416                     throw ESInvalidParameterException("Invalid Cloud Server UUID.");
 417                 }
 418
 419                 m_enrolleeSecurity->provisionSecurityForCloudServer(cloudProp.getCloudID(),
 420                                                                     cloudProp.getCredID());
 421             }
 422
 423             catch (const std::exception& e)
 424             {
 425                 OIC_LOG_V(ERROR, ES_REMOTE_ENROLLEE_TAG,
 426                     "Exception caught in provisionCloudProperties = %s", e.what());
 427
 428                 m_cloudResource = nullptr;
 429
 430                 std::shared_ptr< CloudPropProvisioningStatus > provStatus = std::make_shared<
 431                         CloudPropProvisioningStatus >(ESResult::ES_ERROR);
 432                 m_cloudPropProvStatusCb(provStatus);
 433                 return;
 434             }
 435 #endif //defined(__WITH_DTLS__) && defined(__WITH_TLS__)
 436
 437             if (m_cloudResource == nullptr)
 438             {
 439                 throw ESBadRequestException ("Cloud Resource not created");
 440             }
 441
 442             CloudPropProvStatusCb cloudPropProvStatusCb = std::bind(
 443                     &RemoteEnrollee::cloudPropProvisioningStatusHandler,
 444                                     this, std::placeholders::_1);
 445
 446             m_cloudResource->registerCloudPropProvisioningStatusCallback(cloudPropProvStatusCb);
 447             m_cloudResource->provisionProperties(cloudProp);
 448         }
 449     }
 450 }