Chapter 2. API Reference
unsigned int clientkey_pem_bytes
Size of client key legacy name
const unsigned char *clientkey_password
Client key decryption password string
unsigned int clientkey_password_len
String length of the password pointed to by clientkey_password
bool non_block
Configure non-blocking mode. If set to true the underneath socket will be configured in non blocking
mode after tls session is established
bool use_secure_element
Enable this option to use secure element or atecc608a chip ( Integrated with ESP32-WROOM-32SE )
int timeout_ms
Network timeout in milliseconds
bool use_global_ca_store
Use a global ca_store for all the connections in which this bool is set.
const char *common_name
If non-NULL, server certificate CN must match this name. If NULL, server certificate CN must match
hostname.
bool skip_common_name
Skip any validation of server certificate CN field
tls_keep_alive_cfg_t *keep_alive_cfg
Enable TCP keep-alive timeout for SSL connection
const psk_hint_key_t *psk_hint_key
Pointer to PSK hint and key. if not NULL (and certificates are NULL) then PSK authentication is enabled
with configured setup. Important note: the pointer must be valid for connection
esp_err_t (*crt_bundle_attach)(void *conf)
Function pointer to esp_crt_bundle_attach. Enables the use of certification bundle for server verification,
must be enabled in menuconfig
void *ds_data
Pointer for digital signature peripheral context
bool is_plain_tcp
Use non-TLS connection: When set to true, the esp-tls uses plain TCP transport rather then
TLS/SSL connection. Note, that it is possible to connect using a plain tcp transport directly with
esp_tls_plain_tcp_connect() API
struct ifreq *if_name
The name of interface for data to go through. Use the default interface without setting
struct esp_tls
ESP-TLS Connection Handle.
Public Members
mbedtls_ssl_context ssl
TLS/SSL context
mbedtls_entropy_context entropy
mbedTLS entropy context structure
mbedtls_ctr_drbg_context ctr_drbg
mbedTLS ctr drbg context structure. CTR_DRBG is deterministic random bit generation based on AES-
256
Espressif Systems 527
Submit Document Feedback
Release v4.4
To Next Page
Loading...