nrfxlib API 0.1.0
Loading...
Searching...
No Matches

TLS socket API. More...

Modules

 DTLS Connection ID settings
 Allowed values for DTLS connection ID setting socket option.
 
 DTLS Connection ID statuses
 Allowed values for DTLS connection ID status socket option.
 
 DTLS handshake timeout values
 Allowed timeout values for DTLS handshake timeout socket option according to RFC6347 section 4.2.4.1. Default is 123 seconds. (https://tools.ietf.org/html/rfc6347#section-4.2.4.1)
 
 Role for the socket connection
 Allowed roles for the socket connection.
 
 Security tags for decrypting TLS traffic
 Reserved security tags used for decrypting TLS traffic using Nordic tools.
 
 TLS Cipher suites
 Allowed IANA cipher suites for the nRF modem.
 
 TLS peer verification options
 Allowed TLS peer verification options. By default, peer verification is optional.
 
 TLS session cache options
 Allowed options for the TLS session cache. By default, the session cache is enabled.
 
 TLS/DTLS Handshake statuses
 Allowed values for DTLS connection ID status socket option.
 

Macros

#define NRF_SOCKET_TLS_MAX_MESSAGE_SIZE   2048
 Maximum TLS message size in bytes.
 
#define NRF_SOCKET_TLS_MAX_SEC_TAG_LIST_SIZE   7
 Maximum number of security tags that can be associated with a socket.
 
#define NRF_SO_SEC_TAG_LIST   1
 Write-only socket option to select the security tags to be used. This option accepts a list of.
 
#define NRF_SO_SEC_HOSTNAME   2
 Socket option to set the hostname used for peer verification. This option accepts a string containing the hostname, and its length. The length may be set to zero to disable hostname verification.
 
#define NRF_SO_SEC_CIPHERSUITE_LIST   3
 Write-only socket option to select which ciphersuites to use. This option accepts a prioritized array of selected cipher suites. See TLS Cipher suites for a list of allowed values.
 
#define NRF_SO_SEC_CIPHERSUITE_USED   4
 Socket option to retrieve the cipher suite used during the TLS/DTLS handshake.
 
#define NRF_SO_SEC_PEER_VERIFY   5
 Socket option to set peer verification level. See TLS peer verification options for a list of allowed values.
 
#define NRF_SO_SEC_ROLE   6
 Write-only socket option to set role for the connection. See Role for the socket connection for a list of allowed values.
 
#define NRF_SO_SEC_SESSION_CACHE   12
 Socket option to control TLS session caching. See TLS session cache options for a list of allowed values.
 
#define NRF_SO_SEC_SESSION_CACHE_PURGE   13
 Socket option to purge session cache immediately. This option accepts any value.
 
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEO   14
 Socket option to set DTLS handshake timeout value. See DTLS handshake timeout values for allowed values.
 
#define NRF_SO_SEC_DTLS_CID   15
 Socket option to enable/disable the connection ID. See DTLS Connection ID settings for allowed values.
 
#define NRF_SO_SEC_DTLS_CID_STATUS   16
 Socket option to get the connection ID status. See DTLS Connection ID statuses for allowed values.
 
#define NRF_SO_SEC_DTLS_CONN_SAVE   17
 Socket option to save DTLS connection.
 
#define NRF_SO_SEC_DTLS_CONN_LOAD   18
 Socket option to load DTLS connection.
 
#define NRF_SO_SEC_HANDSHAKE_STATUS   19
 Socket option to get end status of last completed TLS/DTLS handshake procedure. See TLS/DTLS Handshake statuses for allowed values.
 

Typedefs

typedef uint32_t nrf_sec_role_t
 TLS role for the connection.
 
typedef uint32_t nrf_sec_tag_t
 Security tags used on the TLS socket.
 
typedef uint32_t nrf_sec_session_cache_t
 Session cache configuration for the TLS connection.
 
typedef uint32_t nrf_sec_peer_verify_t
 Peer verification level for the TLS connection.
 
typedef uint32_t nrf_sec_cipher_t
 An IANA cipher suite identifier.
 

Detailed Description

TLS socket API.