** More...

Typedefs
typedef void *	mtls_t
	mxchip TLS handler type More...

Enumerations

Functions
int32_t	MX_WIFI_TLS_set_ver (MX_WIFIObject_t *Obj, mtls_ver_t version)
	set the TLS protocol version. More...

int32_t	MX_WIFI_TLS_set_clientCertificate (MX_WIFIObject_t Obj, uint8_t client_cert, uint16_t cert_len)
	TLS set client certificate. More...

int32_t	MX_WIFI_TLS_set_clientPrivateKey (MX_WIFIObject_t Obj, uint8_t client_private_key, uint16_t key_len)
	TLS set client private key. More...

int32_t	MX_WIFI_TLS_connect (MX_WIFIObject_t Obj, int32_t domain, int32_t type, int32_t protocol, const struct sockaddr addr, int32_t addrlen, char *ca, int32_t calen)
	TLS client create a TLS connection. More...

int32_t	MX_WIFI_TLS_connect_sni (MX_WIFIObject_t Obj, const char sni_servername, int32_t sni_servername_len, const struct sockaddr addr, int32_t addrlen, char ca, int32_t calen)
	TLS client create a TLS connection with SNI. More...

int32_t	MX_WIFI_TLS_send (MX_WIFIObject_t Obj, mtls_t tls, void data, int32_t len)
	TLS send data. More...

int32_t	MX_WIFI_TLS_recv (MX_WIFIObject_t Obj, mtls_t tls, void buf, int32_t len)
	TLS redeive data. More...

int32_t	MX_WIFI_TLS_close (MX_WIFIObject_t *Obj, mtls_t tls)
	Close the TLS session, release resource. More...

int32_t	MX_WIFI_TLS_set_nonblock (MX_WIFIObject_t *Obj, mtls_t tls, int32_t nonblock)
	Set TLS nonblock mode. More...

Detailed Description

**

TLS related API **

Typedef Documentation

typedef void* mtls_t

mxchip TLS handler type

Definition at line 1316 of file mx_wifi.h.

Enumeration Type Documentation

anonymous enum

mxchip TLS version

Enumerator
SSL_V3_MODE	SSL V3.
TLS_V1_0_MODE	TLS V1.0.
TLS_V1_1_MODE	TLS V1.1.
TLS_V1_2_MODE	TLS V1.2.

Definition at line 1321 of file mx_wifi.h.

Function Documentation

int32_t MX_WIFI_TLS_close	(	MX_WIFIObject_t *	Obj,
		mtls_t	tls
	)

Close the TLS session, release resource.

Parameters

Obj	pointer to module handle
tls	Point to the TLS context.

Return values

Operation Status.

int32_t MX_WIFI_TLS_connect	(	MX_WIFIObject_t *	Obj,
		int32_t	domain,
		int32_t	type,
		int32_t	protocol,
		const struct sockaddr *	addr,
		int32_t	addrlen,
		char *	ca,
		int32_t	calen
	)

TLS client create a TLS connection.

Parameters

Obj	pointer to module handle

This function is called on the client side and initiates an TLS/TLS handshake with a server. When this function is called, the underlying communication channel has already been set up. This function is called after TCP 3-way handshak finished.

Parameters

domain	Specifies a communication domain
type	Specifies the communication semantics.
protocol	specifies a particular protocol to be used with the socket.
addr	Point to the target address to be connected
addrlen	containing the size of the buffer pointed to by addr
ca	pointer to the CA certificate string, used to verify server's certificate.
calen	the string length of ca. 0=do not verify server's certificate.

Return values

return the TLS context pointer on success or NULL for fail.

int32_t MX_WIFI_TLS_connect_sni	(	MX_WIFIObject_t *	Obj,
		const char *	sni_servername,
		int32_t	sni_servername_len,
		const struct sockaddr *	addr,
		int32_t	addrlen,
		char *	ca,
		int32_t	calen
	)

TLS client create a TLS connection with SNI.

Parameters

Obj	pointer to module handle

This function is called on the client side and initiates an TLS/TLS handshake with a server. When this function is called, the underlying communication channel has already been set up. This function is called after TCP 3-way handshak finished.

Parameters

sni_servername	Specifies the SNI servername
sni_servername_len	Specifies the SNI servername length, max size MX_TLS_SNI_SERVERNAME_SIZE
addr	Point to the target address to be connected
addrlen	containing the size of the buffer pointed to by addr
ca	pointer to the CA certificate string, used to verify server's certificate.
calen	the string length of ca. 0=do not verify server's certificate.

Return values

return the TLS context pointer on success or NULL for fail.

int32_t MX_WIFI_TLS_recv	(	MX_WIFIObject_t *	Obj,
		mtls_t	tls,
		void *	buf,
		int32_t	len
	)

TLS redeive data.

Parameters

Obj	pointer to module handle
tls	Point to the TLS context.
data	Point to buffer to receive TLS data.
len	max receive buffer length.

Return values

On	success, return the number of bytes received. On error, error code (< 0) is returned.

int32_t MX_WIFI_TLS_send	(	MX_WIFIObject_t *	Obj,
		mtls_t	tls,
		void *	data,
		int32_t	len
	)

TLS send data.

Parameters

Obj	pointer to module handle
tls	Point to the TLS context.
data	Point to data to send.
len	data length.

Return values

On	success, return the number of bytes sent. On error, error code (< 0) is returned.

int32_t MX_WIFI_TLS_set_clientCertificate	(	MX_WIFIObject_t *	Obj,
		uint8_t *	client_cert,
		uint16_t	cert_len
	)

TLS set client certificate.

Parameters

Obj	pointer to module handle
client_cert	Point to buffer of client cert.
cert_len	length of the client cert.

Return values

Operation Status.

int32_t MX_WIFI_TLS_set_clientPrivateKey	(	MX_WIFIObject_t *	Obj,
		uint8_t *	client_private_key,
		uint16_t	key_len
	)

TLS set client private key.

Parameters

Obj	pointer to module handle
client_private_key	Point to buffer of client private key.
key_len	length of the client cert.

Return values

Operation Status.

int32_t MX_WIFI_TLS_set_nonblock	(	MX_WIFIObject_t *	Obj,
		mtls_t	tls,
		int32_t	nonblock
	)

Set TLS nonblock mode.

Parameters

Obj	pointer to module handle
tls	Point to the TLS context.
nonblock	true - nonblock, flase - block

Return values

Operation Status.

int32_t MX_WIFI_TLS_set_ver	(	MX_WIFIObject_t *	Obj,
		mtls_ver_t	version
	)

set the TLS protocol version.

Parameters

Obj	pointer to module handle
version	TLS protocol version

Return values

Operation Status.

Note: This function should be called before TLS is ready to function (before mtls_connect and mtls_accept is called by application ).

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Important Information for this Arm website