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