Class WiFiSSLClient

WiFiSSLClient Class

Description

A class for Wi-Fi Secure Socket Layer Client implementation for Ameba.

Syntax

class WiFiSSLClient

Members

Public Constructors
WiFiSSLClient::WiFiSSLClient	Constructs a WiFiSSLClient instance that always connects in SSL to the specified IP address and port.
Public Methods
WiFiSSLClient::connect	Connect to the IP address and port.
WiFiSSLClient::write	Write data (single byte) to the server.
WiFiSSLClient::available	Get the availability of the Wi-Fi SSL socket for reading.
WiFiSSLClient::read	Read the incoming byte from the server.
WiFiSSLClient::peek	Get the next byte from the current packet without moving on to the next byte.
WiFiSSLClient::flush	Clear all the bytes that have been written to the client but not yet read.
WiFiSSLClient::stop	Disconnect from the server.
WiFiSSLClient::connected	Check if SSL client is connected.
WiFiSSLClient::setRootCA	Set Root CA for authentication.
WiFiSSLClient::setClientCertificate	Set certificate of the client.
WiFiSSLClient::setRecvTimeout	Set receiving timeout.
WiFiSSLClient::setPreSharedKey	Set the Pre Shared Key (PSK) to use for authentication.

WiFiSSLClient::WiFiSSLClient

Description

Constructs a WiFiSSLClient instance that always connects in SSL to the specified IP address and port.

Syntax

WiFiSSLClient(void);
WiFiSSLClient(uint8_t sock);

Example Code

Example: SSLClient

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::connect

Syntax

virtual int connect(IPAddress ip, uint16_t port);
virtual int connect(const char *host, uint16_t port);
virtual uint8_t connected(void);
int connect(const char *host, uint16_t port, unsigned char *rootCABuff, unsigned char *cli_cert, unsigned char *cli_key);
int connect(IPAddress ip, uint16_t port, unsigned char *rootCABuff, unsigned char *cli_cert, unsigned char *cli_key);
int connect(const char *host, uint16_t port, unsigned char *pskIdent, unsigned char *psKey);
int connect(IPAddress ip, uint16_t port, unsigned char *pskIdent, unsigned char *psKey);

Parameters

ip: IP address.

host: Host name.

port: the port to listen to.

rootCABuff: buffer that store root CA.

cli_cert: buffer that store client certificate.

cli_key: buffer that store client key pair.

pskIdent: identity for PSK.

psKey: Pre shared key.

Returns

This function returns “1” if successful, else returns “0”.

Example Code

Example: SSLClient

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::write

Description

Write data (single byte) to the server the SSL client is connected to.

Syntax

virtual size_t write(uint8_t);
virtual size_t write(const uint8_t *buf, size_t size);

Parameters

buf: a pointer to an array containing the outgoing message.

size: the size of the buffer.

Returns

This function returns the byte / character that will be written to the server or the size of the buffer.

Example Code

NA

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::available

Description

Get the availability of the Wi-Fi SSL socket for reading.

Syntax

virtual int available(void);

Returns

This function returns “1” and number of bytes available for reading if there are available data, else returns 0.

Example Code

Example: SSLClient

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::read

Description

Read the incoming byte from the server that the SSL client is connected to.

Syntax

virtual int read(void);
virtual int read(uint8_t *buf, size_t size);

Parameters

buf: buffer that holds incoming data in 8-bit.

size: maximum size of the buffer.

Returns

This function returns the size of the buffer or returns “-1” if no buffer is available.

Example Code

Example: SSLClient

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::peek

Description

Get the next byte from the current packet without moving on to the next byte.

Syntax

virtual int peek(void);

Returns

This function returns the next byte or character, else returns -1 if none is available.

Example Code

NA

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::flush

Description

Clear all the bytes that have been written to the client but not yet read.

Syntax

virtual void flush(void);

Example Code

NA

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::stop

Syntax

virtual void stop (void);

Example Code

Example: SSLClient

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::connected

Syntax

virtual uint8_t connected(void);

Returns

The function returns “1” if the SSLClient socket is connected, else returns “0” if not connected.

Example Code

Example: SSLClient

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::setRootCA

Description

Set Root CA(certification authority) for SSL authentication.

Syntax

void setRootCA(unsigned char *rootCA);

Example Code

NA

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::setClientCertificate

Syntax

void setClientCertificate(unsigned char *client_ca, unsigned char *private_key);

Parameters

client_ca: Client certificate.

private_key: client’s private key pair.

Example Code

NA

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::setRecvTimeout

Description

This function sets the SSL client socket receiving timeout.

Syntax

int setRecvTimeout(int timeout);

Example Code

NA

Note

“WiFiSSLClient.h” must be included to use the class function.

WiFiSSLClient::setPreSharedKey

Description

Set the Pre Shared Key (PSK) to use for authentication.

Syntax

void setPreSharedKey(unsigned char *pskIdent, unsigned char *psKey);

Parameters

pskIdent: identity for PSK.

psKey: Pre shared key.

Do not set a root CA and client certificate if PSK should be used for authentication. If root CA, client certificate and PSK are all set, certificate-based authentication will be used. “WiFiSSLClient.h” must be included to use the class function.