Enumerations

Enum which encapsulates errors which can occur in the Security handshake with the device.

Enum type which encapsulates different states of a session.

Enum type which encapsulates different states of a secured session.

Type encapsulates session status of device.

Type encapsulated provision status of device.

Supported mode of communication with device.

Security options on data transmission.

Undocumented

‘ESPScanStatus’ defines intermediate stages of reading and processing QR code.

Undocumented

Undocumented

Undocumented

A message must be of type Cmd0 / Cmd1 / Resp0 / Resp1

Allowed values for the type of security being used in a protocomm session

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Enum type which encapsulates different states of a secured session.

Possible authentication failure modes.

SRP Group Parameters

The 1024-, 1536-, and 2048-bit groups are taken from software developed by Tom Wu and Eugene Jhong for the Stanford SRP distribution, and subsequently proven to be prime. The larger primes are taken from [MODP], but generators have been calculated that are primitive roots of N, unlike the generators in [MODP].

The values of N and g used in this protocol must be agreed upon by the two parties in question. They can be set in advance, or the host can supply them to the client. In the latter case, the host should send the parameters in the first message along with the salt. For maximum security, N should be a safe prime (i.e. a number of the form N = 2q + 1, where q is also prime). Also, g should be a generator modulo N (see [SRP] for details), which means that for any X where 0 < X < N, there exists a value x for which g^x % N == X.

[MODP] Kivinen, T. and M. Kojo, “More Modular Exponentiation (MODP) Diffie-Hellman groups for Internet Key Exchange (IKE)”, RFC 3526, May 2003.

[SRP] T. Wu, “The Secure Remote Password Protocol”, In Proceedings of the 1998 Internet Society Symposium on Network and Distributed Systems Security, San Diego, CA, pp. 97-111.

Undocumented

Enum type representing errors encountered while communicating with ESPDevice.

‘ESPWifiScanError’ consist of error cases that will be generated in the process of fetching available Wi-FI network list from an ESPDevice,

‘ESPSessionError’ covers error cases that are generated throughout the life cycle of ESPDevice session right from the beginning of session establishment till termination.

‘ESPDeviceCSSError’ consist of error case that are generated while creating objects of physical ESPDevice. List covers failed cases of operation like Create, Scan and Search of ESPDevice.

‘ESPProvsionError’ covers reason for failed cases that occurs while provisioning of ESPDevice.