#ifndef ES_COMMON_H_
#define ES_COMMON_H_
-#include <iostream>
-#include <string>
-#ifndef WITH_ARDUINO
-#include <memory>
-#endif
-
#include "ocstack.h"
#include "octypes.h"
-using namespace std;
+#ifdef __cplusplus
+extern "C"
+{
+#endif
// Defines
-#define OIC_STRING_MAX_VALUE 100
-#define IPV4_ADDR_SIZE 16
-#define IP_PORT 55555
-#define NET_WIFI_SSID_SIZE 100
-#define NET_WIFI_PWD_SIZE 100
+#define OC_RSRVD_ES_RES_TYPE_COL "oic.wk.col"
+#define OC_RSRVD_ES_INTERFACE "if"
+#define OC_RSRVD_ES_RES_TYPE "rt"
+
-/**
- * @brief Mac address length for BT port
- */
-#define NET_MACADDR_SIZE 18
+
+#define OIC_STRING_MAX_VALUE 256
+#define OIC_STRING_ACCESS_TOKEN_MAX_VALUE 1024
+#define MAX_WEBLINKLEN 3
+#define NUM_WIFIMODE 10
+#define NUM_CONNECT_TYPE 3
/**
* Attributes used to form a proper easysetup conforming JSON message.
*/
-#define OC_RSRVD_ES_PS "ps"
-#define OC_RSRVD_ES_TNN "tnn"
-#define OC_RSRVD_ES_CD "cd"
-#define OC_RSRVD_ES_TR "tr"
-#define OC_RSRVD_ES_TNT "tnt"
-#define OC_RSRVD_ES_ANT "ant"
+#define OC_RSRVD_ES_PROVSTATUS "ps"
+#define OC_RSRVD_ES_LAST_ERRORCODE "lec"
+#define OC_RSRVD_ES_LINKS "links"
+#define OC_RSRVD_ES_SUPPORTEDWIFIMODE "swmt"
+#define OC_RSRVD_ES_SUPPORTEDWIFIFREQ "swf"
+#define OC_RSRVD_ES_SSID "tnn"
+#define OC_RSRVD_ES_CRED "cd"
+#define OC_RSRVD_ES_AUTHTYPE "wat"
+#define OC_RSRVD_ES_ENCTYPE "wet"
+#define OC_RSRVD_ES_AUTHCODE "ac"
+#define OC_RSRVD_ES_ACCESSTOKEN "at"
+#define OC_RSRVD_ES_ACCESSTOKEN_TYPE "att"
+#define OC_RSRVD_ES_AUTHPROVIDER "apn"
+#define OC_RSRVD_ES_CISERVER "cis"
+#define OC_RSRVD_ES_SERVERID "sid"
+#define OC_RSRVD_ES_DEVNAME "dn"
+#define OC_RSRVD_ES_HREF "href"
+#define OC_RSRVD_ES_CONNECT "cn"
/**
* Easysetup defined resoruce types and uris.
*/
-#define OC_RSRVD_ES_PROV_RES_TYPE "oic.r.prov"
-#define OC_RSRVD_ES_URI_PROV "/oic/prov"
-#define OC_RSRVD_ES_URI_NET "/oic/net"
+#define OC_RSRVD_ES_RES_TYPE_EASYSETUP "oic.r.easysetup"
+#define OC_RSRVD_ES_URI_EASYSETUP "/EasySetupResURI"
+#define OC_RSRVD_ES_RES_TYPE_WIFICONF "oic.r.wificonf"
+#define OC_RSRVD_ES_URI_WIFICONF "/WiFiConfResURI"
+#define OC_RSRVD_ES_RES_TYPE_COAPCLOUDCONF "oic.r.coapcloudconf"
+#define OC_RSRVD_ES_URI_COAPCLOUDCONF "/CoapCloudConfResURI"
+#define OC_RSRVD_ES_RES_TYPE_DEVCONF "oic.r.devconf"
+#define OC_RSRVD_ES_URI_DEVCONF "/DevConfResURI"
+
/**
- * @brief Defines for Provisioning status accepted values
+ * @brief Supported WIFI frequency like 2.4G and 5G
*/
-#define ES_PS_NEED_PROVISIONING 1
-#define ES_PS_PROVISIONING_COMPLETED 2
+typedef enum
+{
+ WIFI_24G = 0, /**< 2.4G **/
+ WIFI_5G, /**< 5G **/
+ WIFI_BOTH, /**< 2.4G and 5G **/
+ WIFI_FREQ_NONE /**< EOF **/
+} WIFI_FREQ;
/**
-* Device Roles defined for each device type used in easy setup
-*/
+ * @brief Supported WIFI mode like 802.11g and 802.11n
+ */
typedef enum
{
- ENROLLEE,
- MEDIATOR,
- ENROLLER,
-} DeviceRole;
+ WIFI_11A = 0, /**< 802.11a **/
+ WIFI_11B, /**< 802.11b **/
+ WIFI_11G, /**< 802.11g **/
+ WIFI_11N, /**< 802.11n **/
+ WIFI_11AC, /**< 802.11ac **/
+ WiFi_EOF = 999
+} WIFI_MODE;
+
/**
-* On-boarding connection to create Adhoc network.
-*/
+ * @brief WIFI Authentication tlype of the Enroller
+ */
typedef enum
{
- SOFTAP,
- BLE,
-} OBConnection;
+ NONE_AUTH = 0, /**< NO authentication **/
+ WEP, /**< WEP **/
+ WPA_PSK, /**< WPA-PSK **/
+ WPA2_PSK, /**< WPA2-PSK **/
+ FT_PSK /**< FT-PSK **/
+} WIFI_AUTHTYPE;
+/**
+ * @brief WIFI encryption type of the Enroller
+ */
typedef enum
{
- ES_ERROR = -1,
- ES_OK = 0,
- ES_NETWORKFOUND = 1,
- ES_NETWORKCONNECTED,
- ES_NETWORKNOTCONNECTED,
- ES_RESOURCECREATED = 11,
- ES_RECVREQOFPROVRES = 21,
- ES_RECVREQOFNETRES,
- ES_RECVUPDATEOFPROVRES,
- ES_RECVTRIGGEROFPROVRES,
-} ESResult;
+ NONE_ENC = 0, /**< NO encryption **/
+ WEP_64, /**< WEP-64 **/
+ WEP_128, /**< WEP-128**/
+ TKIP, /**< TKIP **/
+ AES, /**< AES **/
+ TKIP_AES /**< TKIP-AES **/
+} WIFI_ENCTYPE;
+/**
+ * @brief OAuth Access Token Types. "bearer" and "mac" types are supported.
+ */
+typedef enum
+{
+ NONE_OAUTH_TOKENTYPE = 0,
+ OAUTH_TOKENTYPE_BEARER,
+ OAUTH_TOKENTYPE_MAC
+} OAUTH_TOKENTYPE;
+
+/**
+ * @brief A target configuration type to be connected (or executed)
+ */
+typedef enum
+{
+ ES_CONNECT_NONE = 0, /**< Init value **/
+ ES_CONNECT_WIFI = 1, /**< WiFi Conf resource **/
+ ES_CONNECT_COAPCLOUD = 2 /**< Coap Cloud Conf resource **/
+} ES_CONNECT_TYPE;
+
+/**
+ * @brief A result of Easy Setup
+ */
typedef enum
{
/**
- * Default state of the device
+ * Provisioning succeeds.
*/
- ES_INIT_STATE,
+ ES_OK = 0,
/**
- * Device will move to this state once the on boarding begins
+ * Secure resource is discovered.
*/
- ES_ON_BOARDING_STATE,
+ ES_SECURE_RESOURCE_IS_DISCOVERED = 1,
/**
- * Device will move to this state after successful on-boarding of the device
+ * Enrollee discovery fails in cloud provisioning
*/
- ES_ON_BOARDED_STATE,
+ ES_ENROLLEE_DISCOVERY_FAILURE = 11,
/**
- * Device will move to this state once the on boarding is done
+ * Valid GET or POST request fails for some reason.
+ * This failure may happen when it failed to receive any response from Enrollee by a timeout threshold
*/
- ES_PROVISIONING_STATE,
+ ES_COMMUNICATION_ERROR,
/**
- * Easy setup process is successful.
+ * Security opertion is not supported because Mediator is built as unsecured mode.
*/
- ES_PROVISIONED_STATE,
+ ES_SEC_OPERATION_IS_NOT_SUPPORTED,
/**
- * This state is arbitrary one, any time device can come into this state
- * Device will move to this state if the ownership transfer initiated by the Application
+ * Security resource discovery fails due to loss of discovery packet or absence of the resource in a network
*/
- ES_OWNERSHIP_TRANSFERRING_STATE,
+ ES_SECURE_RESOURCE_DISCOVERY_FAILURE,
/**
- * This state is arbitrary one, any time device can come into this state
- * Device will move to this state if the ownership transfer is completed
+ * Ownership transfer fails due to one of unexpected reasons.
+ * E.g. A packet loss even with retransmission happens during ownership transfer.
+ * E.g. Mediator's owned status is 'unowned'
+ * E.g. A user confirmation for random pin-based or certificate-based OT fails
*/
- ES_OWNERSHIP_TRANSFERRED_STATE,
+ ES_OWNERSHIP_TRANSFER_FAILURE = 20,
/**
- * This state is arbitrary one, any time device can come into this state
- * Device will move to this state once the Application factory reset the device
+ * Ownership transfer which is cert-based method fails due to user confirmation is denied.
*/
- ES_FACTORY_RESET_STATE,
+ ES_USER_DENIED_CONFIRMATION_REQ,
/**
- * Enrollee moves to this state after connecting to target network
+ * Ownership transfer which is cert-based method fails due to wrong certificate.
*/
- ES_ON_BOARDED_TARGET_NETWORK_STATE,
-}EnrolleeState;
+ ES_AUTHENTICATION_FAILURE_WITH_WRONG_CERT,
-/**
- * Provisioning Device Status
- */
-typedef struct
-{
- // Address of remote server
- OCDevAddr * addr;
- // Indicates adaptor type on which the response was received
- OCConnectivityType connType;
-} EasySetupDeviceInfo;
+ /**
+ * Ownership transfer which is random-pin method fails due to wrong pin.
+ */
+ ES_AUTHENTICATION_FAILURE_WITH_WRONG_PIN,
+
+ /**
+ * Ownership information is not synchronized between Mediator and Enrollee.
+ * e.g. A mediator's PDM DB has an ownership information to the found enrollee
+ * but it is actually owned by other mediator.
+ * That can happen where the found enrollee is reset and performed in easy setup without any inform to the first mediator.
+ * e.g. A list of owned devices managed in mediator's PMD db has no element for the found enrollee.
+ * That can happen where only mediator is reset without any inform to the enrollee.
+ * To proceed an ownership transfer to the enrollee, it needs to reset the enrollee's SVR DB for its owner, i.e. the mediator
+ */
+ ES_OWNERSHIP_IS_NOT_SYNCHRONIZED,
+
+ /**
+ * MOT is not supported at the target Enrollee device.
+ *
+ * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
+ * @note If the mediator gets this values, it means OT has been successfully done
+ * (or already took an ownership, before), but failed MOT configuration.
+ */
+ ES_MOT_NOT_SUPPORTED = 30,
+
+ /**
+ * MOT enabling is failed.
+ *
+ * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
+ * @note If the mediator gets this values, it means OT has been successfully done
+ * (or already took an ownership, before), but failed MOT configuration.
+ */
+ ES_MOT_ENABLING_FAILURE,
+
+ /**
+ * MOT method selection is failed
+ *
+ * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
+ * @note If the mediator gets this values, it means OT has been successfully done
+ * (or already took an ownership, before), but failed MOT configuration.
+ */
+ ES_MOT_METHOD_SELECTION_FAILURE,
+
+ /**
+ * A provisioning of Pre-configured pin number for MOT is failed
+ *
+ * @note This ESResult values will be returned ONLY IF a mediator is a first owner to an Enrollee.
+ * @note If the mediator gets this values, it means OT has been successfully done
+ * (or already took an ownership, before), but failed MOT configuration.
+ */
+ ES_PRE_CONFIG_PIN_PROVISIONING_FAILURE,
+
+ /**
+ * ACL provisioning fails in cloud provisioning.
+ * It could be that UUID format of cloud server is wrong.
+ * Or any response for the provisioning request is not arrived at Mediator
+ */
+ ES_ACL_PROVISIONING_FAILURE = 40,
+
+ /**
+ * Cert. provisioning fails in cloud provisioning.
+ * It could be that you put a wrong cred ID of which the corresponding certificate does not exist in SVR DB.
+ * Or any response for the provisioning request is not arrived at Mediator
+ */
+ ES_CERT_PROVISIONING_FAILURE,
+
+ /**
+ * Provisioning fails for some reason.
+ */
+
+ ES_ERROR = 255
+} ESResult;
/**
- * Provosioning Status
+ * @brief Indicate which resource is created in Enrollee
*/
typedef enum
{
- DEVICE_PROVISIONED = 0,
- DEVICE_NOT_PROVISIONED,
- DEVICE_OWNED,
- DEVICE_NOT_OWNED
-} EasySetupState, ProvStatus;
+ ES_WIFICONF_RESOURCE = 0x01,
+ ES_COAPCLOUDCONF_RESOURCE = 0x02,
+ ES_DEVCONF_RESOURCE = 0x04
+} ESResourceMask;
/**
- * Response from queries to remote servers.
+ * @brief Indicate enrollee and provisioning status. Provisioning status is shown in "provisioning
+ * status" property in easysetup resource.
*/
-typedef struct
+typedef enum
{
- // EasySetup Status
- EasySetupState provStatus;
- // EasySetup Device Info
- EasySetupDeviceInfo provDeviceInfo;
-} EasySetupInfo, ProvisioningInfo;
+ /**
+ * Default state of the device
+ */
+ ES_STATE_INIT = 0,
-/**
- * @brief Network information of the Enroller
- */
-typedef union
-{
/**
- * @brief BT Mac Information
+ * Status indicating being connecting to target network
*/
- struct
- {
- char btMacAddress[NET_MACADDR_SIZE]; /**< BT mac address **/
- } BT;
+ ES_STATE_CONNECTING_TO_ENROLLER,
/**
- * @brief LE MAC Information
+ * Status indicating successful conection to target network
*/
- struct
- {
- char leMacAddress[NET_MACADDR_SIZE]; /**< BLE mac address **/
- } LE;
+ ES_STATE_CONNECTED_TO_ENROLLER,
/**
- * @brief IP Information
+ * Status indicating connection failure to target network
*/
- struct
- {
- char ipAddress[IPV4_ADDR_SIZE]; /**< IP Address of the Enroller**/
- char ssid[NET_WIFI_SSID_SIZE]; /**< ssid of the Enroller**/
- char pwd[NET_WIFI_PWD_SIZE]; /**< pwd of the Enroller**/
- } WIFI;
-} EnrolleeInfo;
+ ES_STATE_FAILED_TO_CONNECT_TO_ENROLLER,
+ /**
+ * Status indicating being registering to cloud
+ */
+ ES_STATE_REGISTERING_TO_CLOUD,
+
+ /**
+ * Status indicating successful registration to cloud
+ */
+ ES_STATE_REGISTERED_TO_CLOUD,
+
+ /**
+ * Status indicating registeration failure to cloud
+ */
+ ES_STATE_FAILED_TO_REGISTER_TO_CLOUD,
+
+ /**
+ * Status indicating being publishing resources to cloud
+ */
+ ES_STATE_PUBLISHING_RESOURCES_TO_CLOUD,
+
+ /**
+ * Status indicating successful resource publish to cloud
+ */
+ ES_STATE_PUBLISHED_RESOURCES_TO_CLOUD,
+
+ /**
+ * Status indicating resource publish failure to cloud
+ */
+ ES_STATE_FAILED_TO_PUBLISH_RESOURCES_TO_CLOUD,
+
+ /**
+ * Status indicating aborted provisioning by enrollee
+ */
+ ES_STATE_ABORTED_PROVISIONING_BY_ENROLLEE,
+
+ /**
+ * End of Easy setup status
+ */
+ ES_STATE_EOF = 255
+} ESEnrolleeState, ProvStatus;
/**
- * @brief Network Information
+ * @brief Indicate last error code to describe a reason of error during easy setup.
*/
-typedef struct
+typedef enum
{
- EnrolleeInfo netAddressInfo; /**< Enroller Network Info**/
- OCConnectivityType connType; /**< Connectivity Type**/
- bool isSecured; /**< Secure connection**/
- // TODO : Ideally isSecured should be renamed to needSecuredEasysetup.
- // To provide backward compatibility to v1.0 release, a new variable is being added.
- // If isSecured is not used by other applications, isSecured will be depricated.
- bool needSecuredEasysetup; /**< Need of secure ownership transfer during easysetup**/
-} EnrolleeNWProvInfo;
+ /**
+ * Init Error Code
+ */
+ ES_ERRCODE_NO_ERROR = 0,
-/**
- * Client applications implement this callback to consume responses received from Servers.
- */
-typedef void (*OCProvisioningStatusCB)(EasySetupInfo *easySetupInfo);
+ /**
+ * Error Code that given WiFi's SSID is not found
+ */
+ ES_ERRCODE_SSID_NOT_FOUND,
+
+ /**
+ * Error Code that given WiFi's Password is wrong
+ */
+ ES_ERRCODE_PW_WRONG,
+
+ /**
+ * Error Code that IP address is not allocated
+ */
+ ES_ERRCODE_IP_NOT_ALLOCATED,
+
+ /**
+ * Error Code that there is no Internet connection
+ */
+ ES_ERRCODE_NO_INTERNETCONNECTION,
+
+ /**
+ * Error Code that Timeout occured
+ */
+ ES_ERRCODE_TIMEOUT,
+
+ /**
+ * Error Code that cloud server is not reachable due to wrong URL of cloud server, for example.
+ */
+ ES_ERRCODE_FAILED_TO_ACCESS_CLOUD_SERVER,
+
+ /**
+ * Error Code that no response is arrived from cloud server
+ */
+ ES_ERRCODE_NO_RESPONSE_FROM_CLOUD_SERVER,
+
+ /**
+ * Error Code that a delivered authcode is not valid.
+ */
+ ES_ERRCODE_INVALID_AUTHCODE,
+
+ /**
+ * Error Code that a given access token is not valid due to its expiration, for example.
+ */
+ ES_ERRCODE_INVALID_ACCESSTOKEN,
+
+ /**
+ * Error Code that a refresh of expired access token is failed due to some reasons.
+ */
+ ES_ERRCODE_FAILED_TO_REFRESH_ACCESSTOKEN,
+
+ /**
+ * Error Code that a target device is not discovered in cloud server
+ */
+ ES_ERRCODE_FAILED_TO_FIND_REGISTERED_DEVICE_IN_CLOUD,
+
+ /**
+ * Error Code that a target user does not exist in cloud server.
+ */
+ ES_ERRCODE_FAILED_TO_FIND_REGISTERED_USER_IN_CLOUD,
+
+ /**
+ * Error Code that an enrollee can not connect to a target WiFi AP because the AP resides in
+ * an unsupported WiFi frequency.
+ */
+ ES_ERRCODE_UNSUPPORTED_WIFI_FREQUENCY,
+
+ /**
+ * Error Code that Unknown error occured
+ */
+ ES_ERRCODE_UNKNOWN = 255
+} ESErrorCode;
+
+#ifdef __cplusplus
+}
+#endif
#endif //ES_COMMON_H_
projects / platform / upstream / iotivity.git / blobdiff