Delta / NNN50_WIFI_API

Dependents:   NNN50_CE_Test_UDP NNN50_linux_firmware NNN50_SoftAP_HelloWorld NNN50_BLEWIFISensor ... more

Embed: (wiki syntax)

« Back to documentation index

Functions

Functions
[SSL]

Functions

NMI_API sint8 m2m_ssl_handshake_rsp (tstrEccReqInfo *strECCResp, uint8 *pu8RspDataBuff, uint16 u16RspDataSz)
 Sends ECC responses to the WINC.
NMI_API sint8 m2m_ssl_send_certs_to_winc (uint8 *pu8Buffer, uint32 u32BufferSz)
 Sends certificates to the WINC.
NMI_API sint8 m2m_ssl_retrieve_cert (uint16 *pu16CurveType, uint8 *pu8Hash, uint8 *pu8Sig, tstrECPoint *pu8Key)
 Retrieve the certificate to be verified from the WINC.
NMI_API sint8 m2m_ssl_retrieve_hash (uint8 *pu8Hash, uint16 u16HashSz)
 Retrieve the certificate hash.
NMI_API void m2m_ssl_stop_processing_certs (void)
 Allow ssl driver to tidy up in case application does not read all available certificates.
NMI_API void m2m_ssl_ecc_process_done (void)
 Allow ssl driver to tidy up after application has finished processing ecc message.
sint8 m2m_ssl_set_active_ciphersuites (uint32 u32SslCsBMP)

Function Documentation

m2m_ssl_ecc_process_done ( void   )

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

Stops receiving from the HIF.

Warning:
This API must be called after receiving a SSL callback with type M2M_SSL_REQ_ECC
Returns:
None.

Definition at line 250 of file m2m_ssl.c.

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

Sends ECC responses to the WINC.

Parameters:
[in]strECCRespECC Response struct.
[in]pu8RspDataBuffePointer of the response data to be sent.
[in]u16RspDataSzResponse data size.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 123 of file m2m_ssl.c.

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]pu16CurveTypePointer to the certificate curve type.
[in]pu8HashPointer to the certificate hash.
[in]pu8SigPointer to the certificate signature.
[in]pu8KeyPointer to the certificate Key.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 163 of file m2m_ssl.c.

NMI_API sint8 m2m_ssl_retrieve_hash ( uint8 pu8Hash,
uint16  u16HashSz 
)

Retrieve the certificate hash.

Parameters:
[in]pu8HashPointer to the certificate hash.
[in]u16HashSzHash size.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 217 of file m2m_ssl.c.

m2m_ssl_send_certs_to_winc ( uint8 sector_buffer,
uint32  sector_size 
)

Sends certificates to the WINC.

Parameters:
[in]pu8BufferPointer to the certificates.
[in]u32BufferSzSize of the certificates.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 141 of file m2m_ssl.c.

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]u32SslCsBMPBitmap 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_NO_ERROR)
  • [SOCK_ERR_INVALID_ARG](SOCK_ERR_INVALID_ARG)

Definition at line 275 of file m2m_ssl.c.

m2m_ssl_stop_processing_certs ( void   )

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

Stops receiving from the HIF.

Warning:
This API must only be called if some certificates are left unread.
Returns:
None.

Definition at line 241 of file m2m_ssl.c.