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 OIC_STRING_MAX_VALUE    64
  34 #define MAX_WEBLINKLEN          3
  35 #define NUM_WIFIMODE            5
  36
  37 /**
  38  * Attributes used to form a proper easysetup conforming JSON message.
  39  */
  40 #define OC_RSRVD_ES_PROVSTATUS             "ps"
  41 #define OC_RSRVD_ES_LAST_ERRORCODE         "lec"
  42 #define OC_RSRVD_ES_LINKS                  "links"
  43 #define OC_RSRVD_ES_SUPPORTEDWIFIMODE      "swmt"
  44 #define OC_RSRVD_ES_SUPPORTEDWIFIFREQ      "swf"
  45 #define OC_RSRVD_ES_SSID                   "tnn"
  46 #define OC_RSRVD_ES_CRED                   "cd"
  47 #define OC_RSRVD_ES_AUTHTYPE               "wat"
  48 #define OC_RSRVD_ES_ENCTYPE                "wet"
  49 #define OC_RSRVD_ES_AUTHCODE               "ac"
  50 #define OC_RSRVD_ES_AUTHPROVIDER           "apn"
  51 #define OC_RSRVD_ES_CISERVER               "cis"
  52 #define OC_RSRVD_ES_SERVERID               "sid"
  53 #define OC_RSRVD_ES_DEVNAME                "dn"
  54 #define OC_RSRVD_ES_LANGUAGE               "lang"
  55 #define OC_RSRVD_ES_COUNTRY                "ctry"
  56 #define OC_RSRVD_ES_MODELNUMBER            "mnmo"
  57 #define OC_RSRVD_ES_LOCATION               "loc"
  58 #define OC_RSRVD_ES_HREF                   "href"
  59
  60 /**
  61  * Easysetup defined resoruce types and uris.
  62  */
  63 #define OC_RSRVD_ES_RES_TYPE_PROV         "oic.wk.prov"
  64 #define OC_RSRVD_ES_URI_PROV              "/ProvisioningResURI"
  65 #define OC_RSRVD_ES_RES_TYPE_WIFI         "oic.wk.wifi"
  66 #define OC_RSRVD_ES_URI_WIFI              "/WiFiProvisioningResURI"
  67 #define OC_RSRVD_ES_RES_TYPE_CLOUDSERVER  "oic.wk.cloudserver"
  68 #define OC_RSRVD_ES_URI_CLOUDSERVER       "/CloudServerProvisioningResURI"
  69 #define OC_RSRVD_ES_RES_TYPE_DEVCONF      "oic.wk.devconf"
  70 #define OC_RSRVD_ES_URI_DEVCONF           "/DevConfProvisioningResURI"
  71
  72
  73 /**
  74  * @brief  Supported WIFI frequency like 2.4G and 5G
  75  */
  76 typedef enum
  77 {
  78     WIFI_24G = 0,       /**< 2.4G **/
  79     WIFI_5G,            /**< 5G **/
  80     WIFI_BOTH,          /**< 2.4G and 5G **/
  81     WIFI_FREQ_NONE      /**< EOF **/
  82 } WIFI_FREQ;
  83
  84 /**
  85  * @brief  Supported WIFI mode like 802.11g and 802.11n
  86  */
  87 typedef enum
  88 {
  89     WIFI_11A = 0,       /**< 802.11a **/
  90     WIFI_11B,           /**< 802.11b **/
  91     WIFI_11G,           /**< 802.11g **/
  92     WIFI_11N,           /**< 802.11n **/
  93     WIFI_11AC,          /**< 802.11ac **/
  94     WiFi_EOF = 999
  95 } WIFI_MODE;
  96
  97
  98 /**
  99  * @brief  WIFI Authentication tlype of the Enroller
 100  */
 101 typedef enum
 102 {
 103     NONE_AUTH = 0,      /**< NO authentication **/
 104     WEP,                /**< WEP **/
 105     WPA_PSK,            /**< WPA-PSK **/
 106     WPA2_PSK            /**< WPA2-PSK **/
 107 } WIFI_AUTHTYPE;
 108
 109 /**
 110  * @brief  WIFI encryption type of the Enroller
 111  */
 112 typedef enum
 113 {
 114     NONE_ENC = 0,       /**< NO encryption **/
 115     WEP_64,             /**< WEP-64 **/
 116     WEP_128,            /**< WEP-128**/
 117     TKIP,               /**< TKIP **/
 118     AES,                /**< AES **/
 119     TKIP_AES            /**< TKIP-AES **/
 120 } WIFI_ENCTYPE;
 121
 122 /**
 123  * @brief A result of Easy Setup
 124  */
 125 typedef enum
 126 {
 127     /**
 128      * Provisioning succeeds.
 129      */
 130     ES_OK = 0,
 131
 132     /**
 133      * Enrollee discovery fails in cloud provisioning
 134      */
 135     ES_ENROLLEE_DISCOVERY_FAILURE = 11,
 136
 137     /**
 138      * Valid GET or POST request fails for some reason.
 139      * This failure may happen when it failed to receive any response from Enrollee by a timeout threshold
 140      */
 141     ES_COMMUNICATION_ERROR,
 142
 143     /**
 144      * Security opertion is not supported because Mediator is built as unsecured mode.
 145      */
 146     ES_SEC_OPERATION_IS_NOT_SUPPORTED = 20,
 147
 148     /**
 149      * Security resource discovery fails due to loss of discovery packet or absence of the resource in a network
 150      */
 151     ES_SECURE_RESOURCE_DISCOVERY_FAILURE,
 152
 153     /**
 154      * Ownership transfer fails because DTLS handshake failure happens
 155      */
 156     ES_OWNERSHIP_TRANSFER_FAILURE,
 157
 158     /**
 159      * ACL provisioning fails in cloud provisioning.
 160      * It could be that UUID format of cloud server is wrong.
 161      * Or any response for the provisioning request is not arrived at Mediator
 162      */
 163     ES_ACL_PROVISIONING_FAILURE,
 164
 165     /**
 166      * Cert. provisioning fails in cloud provisioning.
 167      * It could be that you put a wrong cred ID of which the corresponding certificate does not exist in SVR DB.
 168      * Or any response for the provisioning request is not arrived at Mediator
 169      */
 170     ES_CERT_PROVISIONING_FAILURE,
 171
 172     /**
 173      * Provisioning fails for some reason.
 174      */
 175     ES_ERROR = 255
 176 } ESResult;
 177
 178 /**
 179  * @brief Indicate which resource is created in Enrollee
 180  */
 181 typedef enum
 182 {
 183     ES_WIFI_RESOURCE = 0x01,
 184     ES_CLOUD_RESOURCE = 0x02,
 185     ES_DEVCONF_RESOURCE = 0x04
 186 } ESResourceMask;
 187
 188 /**
 189  * @brief Indicate enrollee and provisioning status. Provisioning status is shown in "provisioning
 190  *        status" property in provisioning resource.
 191  */
 192 typedef enum
 193 {
 194     /**
 195      * Default state of the device
 196      */
 197     ES_STATE_INIT = 0,
 198
 199     /**
 200      * Status indicating being connecting to target network
 201      */
 202     ES_STATE_CONNECTING_TO_ENROLLER,
 203
 204     /**
 205      * Status indicating successful conection to target network
 206      */
 207     ES_STATE_CONNECTED_TO_ENROLLER,
 208
 209     /**
 210      * Status indicating connection failure to target network
 211      */
 212     ES_STATE_FAILED_TO_CONNECT_TO_ENROLLER,
 213
 214     /**
 215      * Status indicating being registering to cloud
 216      */
 217     ES_STATE_REGISTERING_TO_CLOUD,
 218
 219     /**
 220      * Status indicating successful registration to cloud
 221      */
 222     ES_STATE_REGISTERED_TO_CLOUD,
 223
 224     /**
 225      * Status indicating registeration failure to cloud
 226      */
 227     ES_STATE_FAILED_TO_REGISTER_TO_CLOUD,
 228
 229     /**
 230      * Status indicating being publishing resources to cloud
 231      */
 232     ES_STATE_PUBLISHING_RESOURCES_TO_CLOUD,
 233
 234     /**
 235      * Status indicating successful resource publish to cloud
 236      */
 237     ES_STATE_PUBLISHED_RESOURCES_TO_CLOUD,
 238
 239     /**
 240      * Status indicating resource publish failure to cloud
 241      */
 242     ES_STATE_FAILED_TO_PUBLISH_RESOURCES_TO_CLOUD,
 243
 244     /**
 245      * End of Easy setup status
 246      */
 247     ES_STATE_EOF = 255
 248 } ESEnrolleeState, ProvStatus;
 249
 250 /**
 251  * @brief Indicate last error code to describe a reason of error during easy setup.
 252  */
 253 typedef enum
 254 {
 255     /**
 256      * Init Error Code
 257      */
 258     ES_ERRCODE_NO_ERROR = 0,
 259
 260     /**
 261      * Error Code that given WiFi's SSID is not found
 262      */
 263     ES_ERRCODE_SSID_NOT_FOUND,
 264
 265     /**
 266      * Error Code that given WiFi's Password is wrong
 267      */
 268     ES_ERRCODE_PW_WRONG,
 269
 270     /**
 271      * Error Code that IP address is not allocated
 272      */
 273     ES_ERRCODE_IP_NOT_ALLOCATED,
 274
 275     /**
 276      * Error Code that there is no Internet connection
 277      */
 278     ES_ERRCODE_NO_INTERNETCONNECTION,
 279
 280     /**
 281      * Error Code that Timeout occured
 282      */
 283     ES_ERRCODE_TIMEOUT,
 284
 285     /**
 286      * Error Code that cloud server is not reachable due to wrong URL of cloud server, for example.
 287      */
 288     ES_ERRCODE_FAILED_TO_ACCESS_CLOUD_SERVER,
 289
 290     /**
 291      * Error Code that no response is arrived from cloud server
 292      */
 293     ES_ERRCODE_NO_RESPONSE_FROM_CLOUD_SERVER,
 294
 295     /**
 296      * Error Code that a delivered authcode is not valid.
 297      */
 298     ES_ERRCODE_INVALID_AUTHCODE,
 299
 300     /**
 301      * Error Code that a given access token is not valid due to its expiration, for example.
 302      */
 303     ES_ERRCODE_INVALID_ACCESSTOKEN,
 304
 305     /**
 306      * Error Code that a refresh of expired access token is failed due to some reasons.
 307      */
 308     ES_ERRCODE_FAILED_TO_REFRESH_ACCESSTOKEN,
 309
 310     /**
 311      * Error Code that a target device is not discovered in cloud server
 312      */
 313     ES_ERRCODE_FAILED_TO_FIND_REGISTERED_DEVICE_IN_CLOUD,
 314
 315     /**
 316      * Error Code that a target user does not exist in cloud server.
 317      */
 318     ES_ERRCODE_FAILED_TO_FIND_REGISTERED_USER_IN_CLOUD,
 319
 320     /**
 321      * Error Code that Unknown error occured
 322      */
 323     ES_ERRCODE_UNKNOWN = 255
 324 } ESErrorCode;
 325
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330 #endif //ES_COMMON_H_