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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
33 #define OC_RSRVD_ES_RES_TYPE_COL "oic.wk.col"
34 #define OC_RSRVD_ES_INTERFACE "if"
35 #define OC_RSRVD_ES_RES_TYPE "rt"
39 #define OIC_STRING_MAX_VALUE 256
40 #define MAX_WEBLINKLEN 3
41 #define NUM_WIFIMODE 10
42 #define NUM_CONNECT_TYPE 3
45 * Attributes used to form a proper easysetup conforming JSON message.
47 #define OC_RSRVD_ES_PROVSTATUS "ps"
48 #define OC_RSRVD_ES_LAST_ERRORCODE "lec"
49 #define OC_RSRVD_ES_LINKS "links"
50 #define OC_RSRVD_ES_SUPPORTEDWIFIMODE "swmt"
51 #define OC_RSRVD_ES_SUPPORTEDWIFIFREQ "swf"
52 #define OC_RSRVD_ES_SSID "tnn"
53 #define OC_RSRVD_ES_CRED "cd"
54 #define OC_RSRVD_ES_AUTHTYPE "wat"
55 #define OC_RSRVD_ES_ENCTYPE "wet"
56 #define OC_RSRVD_ES_AUTHCODE "ac"
57 #define OC_RSRVD_ES_ACCESSTOKEN "at"
58 #define OC_RSRVD_ES_ACCESSTOKEN_TYPE "att"
59 #define OC_RSRVD_ES_AUTHPROVIDER "apn"
60 #define OC_RSRVD_ES_CISERVER "cis"
61 #define OC_RSRVD_ES_SERVERID "sid"
62 #define OC_RSRVD_ES_DEVNAME "dn"
63 #define OC_RSRVD_ES_HREF "href"
64 #define OC_RSRVD_ES_CONNECT "cn"
67 * Easysetup defined resoruce types and uris.
69 #define OC_RSRVD_ES_RES_TYPE_EASYSETUP "oic.r.easysetup"
70 #define OC_RSRVD_ES_URI_EASYSETUP "/EasySetupResURI"
71 #define OC_RSRVD_ES_RES_TYPE_WIFICONF "oic.r.wificonf"
72 #define OC_RSRVD_ES_URI_WIFICONF "/WiFiConfResURI"
73 #define OC_RSRVD_ES_RES_TYPE_COAPCLOUDCONF "oic.r.coapcloudconf"
74 #define OC_RSRVD_ES_URI_COAPCLOUDCONF "/CoapCloudConfResURI"
75 #define OC_RSRVD_ES_RES_TYPE_DEVCONF "oic.r.devconf"
76 #define OC_RSRVD_ES_URI_DEVCONF "/DevConfResURI"
80 * @brief Supported WIFI frequency like 2.4G and 5G
84 WIFI_24G = 0, /**< 2.4G **/
86 WIFI_BOTH, /**< 2.4G and 5G **/
87 WIFI_FREQ_NONE /**< EOF **/
91 * @brief Supported WIFI mode like 802.11g and 802.11n
95 WIFI_11A = 0, /**< 802.11a **/
96 WIFI_11B, /**< 802.11b **/
97 WIFI_11G, /**< 802.11g **/
98 WIFI_11N, /**< 802.11n **/
99 WIFI_11AC, /**< 802.11ac **/
105 * @brief WIFI Authentication tlype of the Enroller
109 NONE_AUTH = 0, /**< NO authentication **/
111 WPA_PSK, /**< WPA-PSK **/
112 WPA2_PSK /**< WPA2-PSK **/
116 * @brief WIFI encryption type of the Enroller
120 NONE_ENC = 0, /**< NO encryption **/
121 WEP_64, /**< WEP-64 **/
122 WEP_128, /**< WEP-128**/
125 TKIP_AES /**< TKIP-AES **/
129 * @brief OAuth Access Token Types. "bearer" and "mac" types are supported.
133 NONE_OAUTH_TOKENTYPE = 0,
134 OAUTH_TOKENTYPE_BEARER,
139 * @brief A target configuration type to be connected (or executed)
143 ES_CONNECT_NONE = 0, /**< Init value **/
144 ES_CONNECT_WIFI = 1, /**< WiFi Conf resource **/
145 ES_CONNECT_COAPCLOUD = 2 /**< Coap Cloud Conf resource **/
149 * @brief A result of Easy Setup
154 * Provisioning succeeds.
159 * Secure resource is discovered.
161 ES_SECURE_RESOURCE_IS_DISCOVERED = 1,
164 * Enrollee discovery fails in cloud provisioning
166 ES_ENROLLEE_DISCOVERY_FAILURE = 11,
169 * Valid GET or POST request fails for some reason.
170 * This failure may happen when it failed to receive any response from Enrollee by a timeout threshold
172 ES_COMMUNICATION_ERROR,
175 * Security opertion is not supported because Mediator is built as unsecured mode.
177 ES_SEC_OPERATION_IS_NOT_SUPPORTED,
180 * Security resource discovery fails due to loss of discovery packet or absence of the resource in a network
182 ES_SECURE_RESOURCE_DISCOVERY_FAILURE,
185 * Ownership transfer fails due to one of unexpected reasons.
186 * E.g. A packet loss even with retransmission happens during ownership transfer.
187 * E.g. Mediator's owned status is 'unowned'
188 * E.g. A user confirmation for random pin-based or certificate-based OT fails
190 ES_OWNERSHIP_TRANSFER_FAILURE = 20,
193 * Ownership transfer which is cert-based method fails due to user confirmation is denied.
195 ES_USER_DENIED_CONFIRMATION_REQ,
198 * Ownership transfer which is cert-based method fails due to wrong certificate.
200 ES_AUTHENTICATION_FAILURE_WITH_WRONG_CERT,
203 * Ownership transfer which is random-pin method fails due to wrong pin.
205 ES_AUTHENTICATION_FAILURE_WITH_WRONG_PIN,
208 * Ownership information is not synchronized between Mediator and Enrollee.
209 * e.g. A mediator's PDM DB has an ownership information to the found enrollee
210 * but it is actually owned by other mediator.
211 * That can happen where the found enrollee is reset and performed in easy setup without any inform to the first mediator.
212 * e.g. A list of owned devices managed in mediator's PMD db has no element for the found enrollee.
213 * That can happen where only mediator is reset without any inform to the enrollee.
214 * To proceed an ownership transfer to the enrollee, it needs to reset the enrollee's SVR DB for its owner, i.e. the mediator
216 ES_OWNERSHIP_IS_NOT_SYNCHRONIZED,
219 * MOT is not supported at the target Enrollee device.
221 * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
222 * @note If the mediator gets this values, it means OT has been successfully done
223 * (or already took an ownership, before), but failed MOT configuration.
225 ES_MOT_NOT_SUPPORTED = 30,
228 * MOT enabling is failed.
230 * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
231 * @note If the mediator gets this values, it means OT has been successfully done
232 * (or already took an ownership, before), but failed MOT configuration.
234 ES_MOT_ENABLING_FAILURE,
237 * MOT method selection is failed
239 * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
240 * @note If the mediator gets this values, it means OT has been successfully done
241 * (or already took an ownership, before), but failed MOT configuration.
243 ES_MOT_METHOD_SELECTION_FAILURE,
246 * A provisioning of Pre-configured pin number for MOT is failed
248 * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
249 * @note If the mediator gets this values, it means OT has been successfully done
250 * (or already took an ownership, before), but failed MOT configuration.
252 ES_PRE_CONFIG_PIN_PROVISIONING_FAILURE,
255 * ACL provisioning fails in cloud provisioning.
256 * It could be that UUID format of cloud server is wrong.
257 * Or any response for the provisioning request is not arrived at Mediator
259 ES_ACL_PROVISIONING_FAILURE = 40,
262 * Cert. provisioning fails in cloud provisioning.
263 * It could be that you put a wrong cred ID of which the corresponding certificate does not exist in SVR DB.
264 * Or any response for the provisioning request is not arrived at Mediator
266 ES_CERT_PROVISIONING_FAILURE,
269 * Provisioning fails for some reason.
276 * @brief Indicate which resource is created in Enrollee
280 ES_WIFICONF_RESOURCE = 0x01,
281 ES_COAPCLOUDCONF_RESOURCE = 0x02,
282 ES_DEVCONF_RESOURCE = 0x04
286 * @brief Indicate enrollee and provisioning status. Provisioning status is shown in "provisioning
287 * status" property in easysetup resource.
292 * Default state of the device
297 * Status indicating being connecting to target network
299 ES_STATE_CONNECTING_TO_ENROLLER,
302 * Status indicating successful conection to target network
304 ES_STATE_CONNECTED_TO_ENROLLER,
307 * Status indicating connection failure to target network
309 ES_STATE_FAILED_TO_CONNECT_TO_ENROLLER,
312 * Status indicating being registering to cloud
314 ES_STATE_REGISTERING_TO_CLOUD,
317 * Status indicating successful registration to cloud
319 ES_STATE_REGISTERED_TO_CLOUD,
322 * Status indicating registeration failure to cloud
324 ES_STATE_FAILED_TO_REGISTER_TO_CLOUD,
327 * Status indicating being publishing resources to cloud
329 ES_STATE_PUBLISHING_RESOURCES_TO_CLOUD,
332 * Status indicating successful resource publish to cloud
334 ES_STATE_PUBLISHED_RESOURCES_TO_CLOUD,
337 * Status indicating resource publish failure to cloud
339 ES_STATE_FAILED_TO_PUBLISH_RESOURCES_TO_CLOUD,
342 * Status indicating aborted provisioning by enrollee
344 ES_STATE_ABORTED_PROVISIONING_BY_ENROLLEE,
347 * End of Easy setup status
350 } ESEnrolleeState, ProvStatus;
353 * @brief Indicate last error code to describe a reason of error during easy setup.
360 ES_ERRCODE_NO_ERROR = 0,
363 * Error Code that given WiFi's SSID is not found
365 ES_ERRCODE_SSID_NOT_FOUND,
368 * Error Code that given WiFi's Password is wrong
373 * Error Code that IP address is not allocated
375 ES_ERRCODE_IP_NOT_ALLOCATED,
378 * Error Code that there is no Internet connection
380 ES_ERRCODE_NO_INTERNETCONNECTION,
383 * Error Code that Timeout occured
388 * Error Code that cloud server is not reachable due to wrong URL of cloud server, for example.
390 ES_ERRCODE_FAILED_TO_ACCESS_CLOUD_SERVER,
393 * Error Code that no response is arrived from cloud server
395 ES_ERRCODE_NO_RESPONSE_FROM_CLOUD_SERVER,
398 * Error Code that a delivered authcode is not valid.
400 ES_ERRCODE_INVALID_AUTHCODE,
403 * Error Code that a given access token is not valid due to its expiration, for example.
405 ES_ERRCODE_INVALID_ACCESSTOKEN,
408 * Error Code that a refresh of expired access token is failed due to some reasons.
410 ES_ERRCODE_FAILED_TO_REFRESH_ACCESSTOKEN,
413 * Error Code that a target device is not discovered in cloud server
415 ES_ERRCODE_FAILED_TO_FIND_REGISTERED_DEVICE_IN_CLOUD,
418 * Error Code that a target user does not exist in cloud server.
420 ES_ERRCODE_FAILED_TO_FIND_REGISTERED_USER_IN_CLOUD,
423 * Error Code that an enrollee can not connect to a target WiFi AP because the AP resides in
424 * an unsupported WiFi frequency.
426 ES_ERRCODE_UNSUPPORTED_WIFI_FREQUENCY,
429 * Error Code that Unknown error occured
431 ES_ERRCODE_UNKNOWN = 255
438 #endif //ES_COMMON_H_