Functions

Functions
NMI_API sint8	m2m_ssl_init (tpfAppSSLCb pfAppSSLCb)
NMI_API sint8	m2m_ssl_handshake_rsp (tstrEccReqInfo *strECCResp, uint8 *pu8RspDataBuff, uint16 u16RspDataSz)
NMI_API sint8	m2m_ssl_send_certs_to_winc (uint8 *pu8Buffer, uint32 u32BufferSz)
NMI_API sint8	m2m_ssl_retrieve_cert (uint16 *pu16CurveType, uint8 *pu8Hash, uint8 *pu8Sig, tstrECPoint *pu8Key)
NMI_API sint8	m2m_ssl_retrieve_hash (uint8 *pu8Hash, uint16 u16HashSz)
NMI_API void	m2m_ssl_stop_processing_certs (void)
NMI_API void	m2m_ssl_ecc_process_done (void)
sint8	m2m_ssl_set_active_ciphersuites (uint32 u32SslCsBMP)

Detailed Description

Function Documentation

m2m_ssl_init()

NMI_API sint8 m2m_ssl_init

(

tpfAppSSLCb

pfAppSSLCb

)

m2m_ssl_handshake_rsp()

NMI_API sint8 m2m_ssl_handshake_rsp	(	tstrEccReqInfo *	strECCResp,
		uint8 *	pu8RspDataBuff,
		uint16	u16RspDataSz
	)

Sends ECC responses to the WINC.

Parameters

[in]	strECCResp	ECC Response struct.
[in]	pu8RspDataBuffe	Pointer of the response data to be sent.
[in]	u16RspDataSz	Response data size.

Returns

The function SHALL return 0 for success and a negative value otherwise.

m2m_ssl_send_certs_to_winc()

NMI_API sint8 m2m_ssl_send_certs_to_winc	(	uint8 *	pu8Buffer,
		uint32	u32BufferSz
	)

Sends certificates to the WINC.

Parameters

[in]	pu8Buffer	Pointer to the certificates.
[in]	u32BufferSz	Size of the certificates.

Returns

The function SHALL return 0 for success and a negative value otherwise.

m2m_ssl_retrieve_cert()

NMI_API sint8 m2m_ssl_retrieve_cert	(	uint16 *	pu16CurveType,
		uint8 *	pu8Hash,
		uint8 *	pu8Sig,
		tstrECPoint *	pu8Key
	)

Retrieve the certificate to be verified from the WINC.

Parameters

[in]	pu16CurveType	Pointer to the certificate curve type.
[in]	pu8Hash	Pointer to the certificate hash.
[in]	pu8Sig	Pointer to the certificate signature.
[in]	pu8Key	Pointer to the certificate Key.

Returns

The function SHALL return 0 for success and a negative value otherwise.

m2m_ssl_retrieve_hash()

NMI_API sint8 m2m_ssl_retrieve_hash	(	uint8 *	pu8Hash,
		uint16	u16HashSz
	)

Retrieve the certificate hash.

Parameters

[in]	pu8Hash	Pointer to the certificate hash.
[in]	u16HashSz	Hash size.

Returns

The function SHALL return 0 for success and a negative value otherwise.

m2m_ssl_stop_processing_certs()

NMI_API void m2m_ssl_stop_processing_certs

(

void

)

Allow ssl driver to tidy up in case application does not read all available certificates.

Warning

This API must only be called if some certificates are left unread.

Returns

None.

m2m_ssl_ecc_process_done()

NMI_API void m2m_ssl_ecc_process_done

(

void

)

Allow ssl driver to tidy up after application has finished processing ecc message.

Warning

This API must be called after receiving a SSL callback with type M2M_SSL_REQ_ECC

Returns

None.

m2m_ssl_set_active_ciphersuites()

NMI_API sint8 m2m_ssl_set_active_ciphersuites

(

uint32

u32SslCsBMP

)

Override the default Active SSL ciphers in the SSL module with a certain combination selected by the caller in the form of a bitmap containing the required ciphers to be on. There is no need to call this function if the application will not change the default ciphersuites.

Parameters

[in]

u32SslCsBMP

Bitmap containing the desired ciphers to be enabled for the SSL module. The ciphersuites are defined in TLS Cipher Suite IDs. The default ciphersuites are all ciphersuites supported by the firmware with the exception of ECC ciphersuites. The caller can override the default with any desired combination, except for combinations involving both RSA and ECC; if any RSA ciphersuite is enabled, then firmware will disable all ECC ciphersuites. If u32SslCsBMP does not contain any ciphersuites supported by firmware, then the current active list will not be changed.

Returns

• SOCK_ERR_NO_ERROR
• SOCK_ERR_INVALID_ARG