service/easy-setup/inc/escommon.h

   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 #ifndef ES_COMMON_H_
  22 #define ES_COMMON_H_
  23
  24 #include "ocstack.h"
  25 #include "octypes.h"
  26
  27 #ifdef __cplusplus
  28 extern "C"
  29 {
  30 #endif
  31
  32 // Defines
  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"
  36
  37
  38
  39 #define OIC_STRING_MAX_VALUE    256
  40 #define MAX_WEBLINKLEN          3
  41 #define NUM_WIFIMODE            10
  42 #define NUM_CONNECT_TYPE        3
  43
  44 /**
  45  * Attributes used to form a proper easysetup conforming JSON message.
  46  */
  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"
  65
  66 /**
  67  * Easysetup defined resoruce types and uris.
  68  */
  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"
  77
  78
  79 /**
  80  * @brief  Supported WIFI frequency like 2.4G and 5G
  81  */
  82 typedef enum
  83 {
  84     WIFI_24G = 0,       /**< 2.4G **/
  85     WIFI_5G,            /**< 5G **/
  86     WIFI_BOTH,          /**< 2.4G and 5G **/
  87     WIFI_FREQ_NONE      /**< EOF **/
  88 } WIFI_FREQ;
  89
  90 /**
  91  * @brief  Supported WIFI mode like 802.11g and 802.11n
  92  */
  93 typedef enum
  94 {
  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 **/
 100     WiFi_EOF = 999
 101 } WIFI_MODE;
 102
 103
 104 /**
 105  * @brief  WIFI Authentication tlype of the Enroller
 106  */
 107 typedef enum
 108 {
 109     NONE_AUTH = 0,      /**< NO authentication **/
 110     WEP,                /**< WEP **/
 111     WPA_PSK,            /**< WPA-PSK **/
 112     WPA2_PSK,           /**< WPA2-PSK **/
 113     FT_PSK              /**< FT-PSK **/
 114 } WIFI_AUTHTYPE;
 115
 116 /**
 117  * @brief  WIFI encryption type of the Enroller
 118  */
 119 typedef enum
 120 {
 121     NONE_ENC = 0,       /**< NO encryption **/
 122     WEP_64,             /**< WEP-64 **/
 123     WEP_128,            /**< WEP-128**/
 124     TKIP,               /**< TKIP **/
 125     AES,                /**< AES **/
 126     TKIP_AES            /**< TKIP-AES **/
 127 } WIFI_ENCTYPE;
 128
 129 /**
 130  * @brief OAuth Access Token Types. "bearer" and "mac" types are supported.
 131  */
 132 typedef enum
 133 {
 134     NONE_OAUTH_TOKENTYPE = 0,
 135     OAUTH_TOKENTYPE_BEARER,
 136     OAUTH_TOKENTYPE_MAC
 137 } OAUTH_TOKENTYPE;
 138
 139 /**
 140  * @brief  A target configuration type to be connected (or executed)
 141  */
 142 typedef enum
 143 {
 144     ES_CONNECT_NONE = 0,        /**< Init value **/
 145     ES_CONNECT_WIFI = 1,        /**< WiFi Conf resource **/
 146     ES_CONNECT_COAPCLOUD = 2    /**< Coap Cloud Conf resource **/
 147 } ES_CONNECT_TYPE;
 148
 149 /**
 150  * @brief A result of Easy Setup
 151  */
 152 typedef enum
 153 {
 154     /**
 155      * Provisioning succeeds.
 156      */
 157     ES_OK = 0,
 158
 159     /**
 160      * Secure resource is discovered.
 161      */
 162     ES_SECURE_RESOURCE_IS_DISCOVERED = 1,
 163
 164     /**
 165      * Enrollee discovery fails in cloud provisioning
 166      */
 167     ES_ENROLLEE_DISCOVERY_FAILURE = 11,
 168
 169     /**
 170      * Valid GET or POST request fails for some reason.
 171      * This failure may happen when it failed to receive any response from Enrollee by a timeout threshold
 172      */
 173     ES_COMMUNICATION_ERROR,
 174
 175     /**
 176      * Security opertion is not supported because Mediator is built as unsecured mode.
 177      */
 178     ES_SEC_OPERATION_IS_NOT_SUPPORTED,
 179
 180     /**
 181      * Security resource discovery fails due to loss of discovery packet or absence of the resource in a network
 182      */
 183     ES_SECURE_RESOURCE_DISCOVERY_FAILURE,
 184
 185     /**
 186      * Ownership transfer fails due to one of unexpected reasons.
 187      * E.g. A packet loss even with retransmission happens during ownership transfer.
 188      * E.g. Mediator's owned status is 'unowned'
 189      * E.g. A user confirmation for random pin-based or certificate-based OT fails
 190      */
 191     ES_OWNERSHIP_TRANSFER_FAILURE = 20,
 192
 193     /**
 194      * Ownership transfer which is cert-based method fails due to user confirmation is denied.
 195      */
 196     ES_USER_DENIED_CONFIRMATION_REQ,
 197
 198     /**
 199      * Ownership transfer which is cert-based method fails due to wrong certificate.
 200      */
 201     ES_AUTHENTICATION_FAILURE_WITH_WRONG_CERT,
 202
 203     /**
 204      * Ownership transfer which is random-pin method fails due to wrong pin.
 205      */
 206     ES_AUTHENTICATION_FAILURE_WITH_WRONG_PIN,
 207
 208     /**
 209      * Ownership information is not synchronized between Mediator and Enrollee.
 210      * e.g. A mediator's PDM DB has an ownership information to the found enrollee
 211      *      but it is actually owned by other mediator.
 212      *      That can happen where the found enrollee is reset and performed in easy setup without any inform to the first mediator.
 213      * e.g. A list of owned devices managed in mediator's PMD db has no element for the found enrollee.
 214      *      That can happen where only mediator is reset without any inform to the enrollee.
 215      * 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      */
 217     ES_OWNERSHIP_IS_NOT_SYNCHRONIZED,
 218
 219     /**
 220      * MOT is not supported at the target Enrollee device.
 221      *
 222      * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
 223      * @note If the mediator gets this values, it means OT has been successfully done
 224      * (or already took an ownership, before), but failed MOT configuration.
 225      */
 226     ES_MOT_NOT_SUPPORTED = 30,
 227
 228     /**
 229      * MOT enabling is failed.
 230      *
 231      * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
 232      * @note If the mediator gets this values, it means OT has been successfully done
 233      * (or already took an ownership, before), but failed MOT configuration.
 234      */
 235     ES_MOT_ENABLING_FAILURE,
 236
 237     /**
 238      * MOT method selection is failed
 239      *
 240      * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
 241      * @note If the mediator gets this values, it means OT has been successfully done
 242      * (or already took an ownership, before), but failed MOT configuration.
 243      */
 244     ES_MOT_METHOD_SELECTION_FAILURE,
 245
 246     /**
 247      * A provisioning of Pre-configured pin number for MOT is failed
 248      *
 249      * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
 250      * @note If the mediator gets this values, it means OT has been successfully done
 251      * (or already took an ownership, before), but failed MOT configuration.
 252      */
 253     ES_PRE_CONFIG_PIN_PROVISIONING_FAILURE,
 254
 255     /**
 256      * ACL provisioning fails in cloud provisioning.
 257      * It could be that UUID format of cloud server is wrong.
 258      * Or any response for the provisioning request is not arrived at Mediator
 259      */
 260     ES_ACL_PROVISIONING_FAILURE = 40,
 261
 262     /**
 263      * Cert. provisioning fails in cloud provisioning.
 264      * It could be that you put a wrong cred ID of which the corresponding certificate does not exist in SVR DB.
 265      * Or any response for the provisioning request is not arrived at Mediator
 266      */
 267     ES_CERT_PROVISIONING_FAILURE,
 268
 269     /**
 270      * Provisioning fails for some reason.
 271      */
 272
 273     ES_ERROR = 255
 274 } ESResult;
 275
 276 /**
 277  * @brief Indicate which resource is created in Enrollee
 278  */
 279 typedef enum
 280 {
 281     ES_WIFICONF_RESOURCE = 0x01,
 282     ES_COAPCLOUDCONF_RESOURCE = 0x02,
 283     ES_DEVCONF_RESOURCE = 0x04
 284 } ESResourceMask;
 285
 286 /**
 287  * @brief Indicate enrollee and provisioning status. Provisioning status is shown in "provisioning
 288  *        status" property in easysetup resource.
 289  */
 290 typedef enum
 291 {
 292     /**
 293      * Default state of the device
 294      */
 295     ES_STATE_INIT = 0,
 296
 297     /**
 298      * Status indicating being connecting to target network
 299      */
 300     ES_STATE_CONNECTING_TO_ENROLLER,
 301
 302     /**
 303      * Status indicating successful conection to target network
 304      */
 305     ES_STATE_CONNECTED_TO_ENROLLER,
 306
 307     /**
 308      * Status indicating connection failure to target network
 309      */
 310     ES_STATE_FAILED_TO_CONNECT_TO_ENROLLER,
 311
 312     /**
 313      * Status indicating being registering to cloud
 314      */
 315     ES_STATE_REGISTERING_TO_CLOUD,
 316
 317     /**
 318      * Status indicating successful registration to cloud
 319      */
 320     ES_STATE_REGISTERED_TO_CLOUD,
 321
 322     /**
 323      * Status indicating registeration failure to cloud
 324      */
 325     ES_STATE_FAILED_TO_REGISTER_TO_CLOUD,
 326
 327     /**
 328      * Status indicating being publishing resources to cloud
 329      */
 330     ES_STATE_PUBLISHING_RESOURCES_TO_CLOUD,
 331
 332     /**
 333      * Status indicating successful resource publish to cloud
 334      */
 335     ES_STATE_PUBLISHED_RESOURCES_TO_CLOUD,
 336
 337     /**
 338      * Status indicating resource publish failure to cloud
 339      */
 340     ES_STATE_FAILED_TO_PUBLISH_RESOURCES_TO_CLOUD,
 341
 342     /**
 343      * Status indicating aborted provisioning by enrollee
 344      */
 345     ES_STATE_ABORTED_PROVISIONING_BY_ENROLLEE,
 346
 347     /**
 348      * End of Easy setup status
 349      */
 350     ES_STATE_EOF = 255
 351 } ESEnrolleeState, ProvStatus;
 352
 353 /**
 354  * @brief Indicate last error code to describe a reason of error during easy setup.
 355  */
 356 typedef enum
 357 {
 358     /**
 359      * Init Error Code
 360      */
 361     ES_ERRCODE_NO_ERROR = 0,
 362
 363     /**
 364      * Error Code that given WiFi's SSID is not found
 365      */
 366     ES_ERRCODE_SSID_NOT_FOUND,
 367
 368     /**
 369      * Error Code that given WiFi's Password is wrong
 370      */
 371     ES_ERRCODE_PW_WRONG,
 372
 373     /**
 374      * Error Code that IP address is not allocated
 375      */
 376     ES_ERRCODE_IP_NOT_ALLOCATED,
 377
 378     /**
 379      * Error Code that there is no Internet connection
 380      */
 381     ES_ERRCODE_NO_INTERNETCONNECTION,
 382
 383     /**
 384      * Error Code that Timeout occured
 385      */
 386     ES_ERRCODE_TIMEOUT,
 387
 388     /**
 389      * Error Code that cloud server is not reachable due to wrong URL of cloud server, for example.
 390      */
 391     ES_ERRCODE_FAILED_TO_ACCESS_CLOUD_SERVER,
 392
 393     /**
 394      * Error Code that no response is arrived from cloud server
 395      */
 396     ES_ERRCODE_NO_RESPONSE_FROM_CLOUD_SERVER,
 397
 398     /**
 399      * Error Code that a delivered authcode is not valid.
 400      */
 401     ES_ERRCODE_INVALID_AUTHCODE,
 402
 403     /**
 404      * Error Code that a given access token is not valid due to its expiration, for example.
 405      */
 406     ES_ERRCODE_INVALID_ACCESSTOKEN,
 407
 408     /**
 409      * Error Code that a refresh of expired access token is failed due to some reasons.
 410      */
 411     ES_ERRCODE_FAILED_TO_REFRESH_ACCESSTOKEN,
 412
 413     /**
 414      * Error Code that a target device is not discovered in cloud server
 415      */
 416     ES_ERRCODE_FAILED_TO_FIND_REGISTERED_DEVICE_IN_CLOUD,
 417
 418     /**
 419      * Error Code that a target user does not exist in cloud server.
 420      */
 421     ES_ERRCODE_FAILED_TO_FIND_REGISTERED_USER_IN_CLOUD,
 422
 423     /**
 424      * Error Code that an enrollee can not connect to a target WiFi AP because the AP resides in
 425      * an unsupported WiFi frequency.
 426      */
 427     ES_ERRCODE_UNSUPPORTED_WIFI_FREQUENCY,
 428
 429     /**
 430      * Error Code that Unknown error occured
 431      */
 432     ES_ERRCODE_UNKNOWN = 255
 433 } ESErrorCode;
 434
 435 #ifdef __cplusplus
 436 }
 437 #endif
 438
 439 #endif //ES_COMMON_H_