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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
24 #include "RemoteEnrolleeResource.h"
26 #include "OCPlatform.h"
27 #include "ESException.h"
28 #include "OCResource.h"
35 #define ES_REMOTE_ENROLLEE_RES_TAG "ES_REMOTE_ENROLLEE_RES"
36 #define DISCOVERY_TIMEOUT 5
38 static const char ES_BASE_RES_URI[] = "/oic/res";
39 static const char ES_PROV_RES_URI[] = "/oic/prov";
40 static const char ES_PROV_RES_TYPE[] = "oic.r.prov";
42 RemoteEnrolleeResource::RemoteEnrolleeResource(EnrolleeNWProvInfo enrolleeNWProvInfo)
44 m_enrolleeNWProvInfo = enrolleeNWProvInfo;
45 m_discoveryResponse = false;
48 void RemoteEnrolleeResource::checkProvInformationCb(const HeaderOptions& /*headerOptions*/,
49 const OCRepresentation& rep, const int eCode)
51 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "checkProvInformationCb : %s, eCode = %d",
57 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
58 "checkProvInformationCb : Provisioning is failed ");
59 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
60 ProvisioningStatus >(ESResult::ES_ERROR, ESState::ES_PROVISIONING_ERROR);
61 m_provStatusCb(provStatus);
69 rep.getValue(OC_RSRVD_ES_PS, ps);
70 rep.getValue(OC_RSRVD_ES_TNN, tnn);
71 rep.getValue(OC_RSRVD_ES_CD, cd);
73 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "checkProvInformationCb : ps - %d", ps);
74 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
75 "checkProvInformationCb : tnn - %s", tnn.c_str());
76 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
77 "checkProvInformationCb : cd - %s", cd.c_str());
79 //Provisioning status check
80 if (ps == ES_PS_PROVISIONING_COMPLETED)
82 if (tnn != std::string(m_enrolleeNWProvInfo.netAddressInfo.WIFI.ssid))
84 OC_LOG_V (ERROR, ES_REMOTE_ENROLLEE_RES_TAG,
85 "checkProvInformationCb : Network SSID is not the same as the "
87 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
88 ProvisioningStatus >(ESResult::ES_ERROR,
89 ESState::ES_PROVISIONING_ERROR);
90 m_provStatusCb(provStatus);
94 if (cd != std::string(m_enrolleeNWProvInfo.netAddressInfo.WIFI.pwd))
96 OC_LOG_V (ERROR, ES_REMOTE_ENROLLEE_RES_TAG,
97 "checkProvInformationCb : Network PWD is not the same as the "
99 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
100 ProvisioningStatus >(ESResult::ES_ERROR,
101 ESState::ES_PROVISIONING_ERROR);
102 m_provStatusCb(provStatus);
106 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
107 "checkProvInformationCb : Provisioning is success ");
108 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
109 ProvisioningStatus >(ESResult::ES_OK, ESState::ES_PROVISIONING_SUCCESS);
110 m_provStatusCb(provStatus);
115 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
116 "checkProvInformationCb : Provisioning is failed ");
117 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
118 ProvisioningStatus >(ESResult::ES_ERROR, ESState::ES_PROVISIONING_ERROR);
119 m_provStatusCb(provStatus);
124 void RemoteEnrolleeResource::getProvStatusResponse(const HeaderOptions& /*headerOptions*/,
125 const OCRepresentation& rep, const int eCode)
127 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "getProvStatusResponse : %s, eCode = %d",
128 rep.getUri().c_str(),
133 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
134 "getProvStatusResponse : Provisioning is failed ");
135 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
136 ProvisioningStatus >(ESResult::ES_ERROR, ESState::ES_PROVISIONING_ERROR);
137 m_provStatusCb(provStatus);
142 std::string tnn = "";
145 rep.getValue(OC_RSRVD_ES_PS, ps);
146 rep.getValue(OC_RSRVD_ES_TNN, tnn);
147 rep.getValue(OC_RSRVD_ES_CD, cd);
149 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "getProvStatusResponse : ps - %d",
151 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "getProvStatusResponse : tnn - %s",
153 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "getProvStatusResponse : cd - %s",
156 if (ps == ES_PS_NEED_PROVISIONING) //Indicates the need for provisioning
158 OCRepresentation provisioningRepresentation;
160 provisioningRepresentation.setValue(OC_RSRVD_ES_TNN,
161 std::string(m_enrolleeNWProvInfo.netAddressInfo.WIFI.ssid));
162 provisioningRepresentation.setValue(OC_RSRVD_ES_CD,
163 std::string(m_enrolleeNWProvInfo.netAddressInfo.WIFI.pwd));
165 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "getProvStatusResponse : ssid - %s",
166 m_enrolleeNWProvInfo.netAddressInfo.WIFI.ssid);
167 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "getProvStatusResponse : pwd - %s",
168 m_enrolleeNWProvInfo.netAddressInfo.WIFI.pwd);
170 m_ocResource->put(provisioningRepresentation, QueryParamsMap(),
172 void(const HeaderOptions& headerOptions,
173 const OCRepresentation& rep, const int eCode) >(
174 std::bind(&RemoteEnrolleeResource::checkProvInformationCb, this,
175 std::placeholders::_1, std::placeholders::_2,
176 std::placeholders::_3)));
178 else if (ps == ES_PS_PROVISIONING_COMPLETED) //Indicates that provisioning is completed
180 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
181 "getProvStatusResponse : Provisioning is successful");
182 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
183 ProvisioningStatus >(ESResult::ES_OK, ESState::ES_PROVISIONED_ALREADY);
184 m_provStatusCb(provStatus);
188 void RemoteEnrolleeResource::registerProvStatusCallback(ProvStatusCb provStatusCb)
190 m_provStatusCb = provStatusCb;
193 ESResult RemoteEnrolleeResource::ESDiscoveryTimeout(unsigned short waittime)
195 struct timespec startTime;
198 struct timespec currTime;
202 ESResult res = ES_OK;
203 #ifdef _POSIX_MONOTONIC_CLOCK
204 int clock_res = clock_gettime(CLOCK_MONOTONIC, &startTime);
206 int clock_res = clock_gettime(CLOCK_REALTIME, &startTime);
214 while (ES_OK == res || m_discoveryResponse == false)
216 #ifdef _POSIX_MONOTONIC_CLOCK
217 clock_res = clock_gettime(CLOCK_MONOTONIC, &currTime);
219 clock_res = clock_gettime(CLOCK_REALTIME, &currTime);
226 long elapsed = (currTime.tv_sec - startTime.tv_sec);
227 if (elapsed > waittime)
231 if (m_discoveryResponse)
239 void RemoteEnrolleeResource::onDeviceDiscovered(std::shared_ptr<OC::OCResource> resource)
241 OC_LOG (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "onDeviceDiscovered");
243 std::string resourceURI;
244 std::string hostAddress;
249 // Get the resource URI
250 resourceURI = resource->uri();
251 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
252 "URI of the resource: %s", resourceURI.c_str());
254 // Get the resource host address
255 hostAddress = resource->host();
256 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
257 "Host address of the resource: %s", hostAddress.c_str());
259 std::size_t foundIP =
261 std::string(m_enrolleeNWProvInfo.netAddressInfo.WIFI.ipAddress));
263 if(resourceURI == ES_PROV_RES_URI && foundIP!=std::string::npos)
265 m_ocResource = resource;
266 m_discoveryResponse = true;
268 OC_LOG (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
269 "Found the device with the resource");
275 OC_LOG (ERROR, ES_REMOTE_ENROLLEE_RES_TAG, "NOT the intended resource.");
280 OC_LOG (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "Resource is invalid");
284 catch(std::exception& e)
286 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
287 "Exception in foundResource: %s", e.what());
292 ESResult RemoteEnrolleeResource::constructResourceObject()
294 if (m_ocResource != nullptr)
296 throw ESBadRequestException("Remote resource is already created");
299 #ifdef REMOTE_ARDUINO_ENROLEE
300 //This process will create OCResource with port 55555 which is specific
301 // to Arduino WiFi enrollee
305 std::vector< std::string > interface =
306 { DEFAULT_INTERFACE};
307 std::vector< std::string > resTypes =
310 OC_LOG(DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "Before OCPlatform::constructResourceObject");
312 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "m_host = %s",
313 m_enrolleeNWProvInfo.netAddressInfo.WIFI.ipAddress);
314 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "ES_PROV_RES_URI = %s", ES_PROV_RES_URI);
315 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "m_connectivityType = %d",
316 m_enrolleeNWProvInfo.connType);
317 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "resTypes = %s",
318 resTypes.at(0).c_str());
319 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "interface = %s", interface.at(0).c_str());
322 if(m_enrolleeNWProvInfo.needSecuredEasysetup)
324 host.append("coaps://");
328 host.append("coap://");
331 if(m_enrolleeNWProvInfo.connType == CT_ADAPTER_IP)
333 // TODO : RemoteEnrollee is current handling easysetup on IP transport.
334 // WiFiRemoteEnrollee need to extend RemoteEnrollee for providing IP specific
335 // Enrollee easysetup.
337 host.append(m_enrolleeNWProvInfo.netAddressInfo.WIFI.ipAddress);
338 //TODO : If the target Enrollee is not a Arduino Wi-Fi device,
339 // then the port number will be found during resource discovery instead of
341 host.append(":55555");
344 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "HOST = %s", host.c_str());
346 m_ocResource = OC::OCPlatform::constructResourceObject(host,
348 m_enrolleeNWProvInfo.connType,
352 OC_LOG_V(DEBUG, ES_REMOTE_ENROLLEE_RES_TAG,
353 "created OCResource : %s", m_ocResource->uri().c_str());
357 catch (OCException & e)
359 OC_LOG_V(ERROR, ES_REMOTE_ENROLLEE_RES_TAG,
360 "Exception for constructResourceObject : %s", e.reason().c_str());
364 std::string host("");
365 std::string query("");
367 if (m_enrolleeNWProvInfo.needSecuredEasysetup)
369 host.append("coaps://");
373 host.append("coap://");
376 if (m_enrolleeNWProvInfo.connType == CT_ADAPTER_IP)
378 // TODO : RemoteEnrollee is current handling easysetup on IP transport.
379 // WiFiRemoteEnrollee need to extend RemoteEnrollee for providing IP specific
380 // Enrollee easysetup.
382 host.append(m_enrolleeNWProvInfo.netAddressInfo.WIFI.ipAddress);
385 query.append(ES_BASE_RES_URI);
386 query.append("?rt=");
387 query.append(ES_PROV_RES_TYPE);
389 OC_LOG(DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "Before OCPlatform::constructResourceObject");
391 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "host = %s",
393 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "query = %s", query.c_str());
394 OC_LOG_V (DEBUG, ES_REMOTE_ENROLLEE_RES_TAG, "m_connectivityType = %d",
395 m_enrolleeNWProvInfo.connType);
397 m_discoveryResponse = false;
398 std::function< void (std::shared_ptr<OC::OCResource>) > onDeviceDiscoveredCb =
399 std::bind(&RemoteEnrolleeResource::onDeviceDiscovered, this,
400 std::placeholders::_1);
401 OCStackResult result = OC::OCPlatform::findResource("", query, CT_DEFAULT,
402 onDeviceDiscoveredCb);
404 if (result != OCStackResult::OC_STACK_OK)
406 OC_LOG(ERROR,ES_REMOTE_ENROLLEE_RES_TAG,
407 "Failed to create device using constructResourceObject");
412 ESResult foundResponse = ESDiscoveryTimeout (DISCOVERY_TIMEOUT);
414 if (!m_discoveryResponse)
416 OC_LOG(ERROR,ES_REMOTE_ENROLLEE_RES_TAG,
417 "Failed to create device using constructResourceObject");
425 void RemoteEnrolleeResource::provisionEnrollee()
428 if (m_ocResource == nullptr)
430 throw ESBadRequestException("Resource is not initialized");
433 OC::QueryParamsMap query;
434 OC::OCRepresentation rep;
436 std::function< OCStackResult(void) > getProvisioingStatus = [&]
437 { return m_ocResource->get(m_ocResource->getResourceTypes().at(0),
438 m_ocResource->getResourceInterfaces().at(0), query,
440 void(const HeaderOptions& headerOptions, const OCRepresentation& rep,
442 std::bind(&RemoteEnrolleeResource::getProvStatusResponse, this,
443 std::placeholders::_1, std::placeholders::_2,
444 std::placeholders::_3)));
447 OCStackResult result = getProvisioingStatus();
449 if (result != OCStackResult::OC_STACK_OK)
451 std::shared_ptr< ProvisioningStatus > provStatus = std::make_shared<
452 ProvisioningStatus >(ESResult::ES_ERROR, ESState::ES_PROVISIONING_ERROR);
453 m_provStatusCb(provStatus);
458 void RemoteEnrolleeResource::unprovisionEnrollee()
460 if (m_ocResource == nullptr)
462 throw ESBadRequestException("Resource is not initialized");
465 OCRepresentation provisioningRepresentation;
467 provisioningRepresentation.setValue(OC_RSRVD_ES_TNN, "");
468 provisioningRepresentation.setValue(OC_RSRVD_ES_CD, "");
470 m_ocResource->post(provisioningRepresentation, QueryParamsMap(),
472 void(const HeaderOptions& headerOptions, const OCRepresentation& rep,
474 std::bind(&RemoteEnrolleeResource::checkProvInformationCb, this,
475 std::placeholders::_1, std::placeholders::_2,
476 std::placeholders::_3)));