SourceVu will show references to esp_tls_cfg from the following samples and libraries:
Symbols ![]()
loading...
Files ![]()
loading...
esp_tls_cfg struct
ESP-TLS configuration parameters
Syntax
typedef struct esp_tls_cfg
{
const char **alpn_protos;
union {
const unsigned char *cacert_buf;
const unsigned char *cacert_pem_buf;
};
union {
unsigned int cacert_bytes;
unsigned int cacert_pem_bytes;
};
union {
const unsigned char *clientcert_buf;
const unsigned char *clientcert_pem_buf;
};
union {
unsigned int clientcert_bytes;
unsigned int clientcert_pem_bytes;
};
union {
const unsigned char *clientkey_buf;
const unsigned char *clientkey_pem_buf;
};
union {
unsigned int clientkey_bytes;
unsigned int clientkey_pem_bytes;
};
const unsigned char *clientkey_password;
unsigned int clientkey_password_len;
bool use_ecdsa_peripheral;
uint8_t ecdsa_key_efuse_blk;
bool non_block;
bool use_secure_element;
int timeout_ms;
bool use_global_ca_store;
const char *common_name;
bool skip_common_name;
tls_keep_alive_cfg_t *keep_alive_cfg;
const psk_hint_key_t* psk_hint_key;
esp_err_t (*crt_bundle_attach)(void *conf);
void *ds_data;
bool is_plain_tcp;
struct ifreq *if_name;
#ifdef CONFIG_ESP_TLS_CLIENT_SESSION_TICKETS
esp_tls_client_session_t *client_session;
#endif
esp_tls_addr_family_t addr_family;
const int *ciphersuites_list;
esp_tls_proto_ver_t tls_version;
} esp_tls_cfg_t;
Fields
Field
Declared as
Description
const char **
Application protocols required for HTTP2. If HTTP2/ALPN support is required, a list of protocols that should be negotiated. The format is length followed by protocol name. For the most common cases the following is ok: const char **alpn_protos = { "h2", NULL }; - where 'h2' is the protocol name.
unsigned int
String length of the password pointed to by clientkey_password.
bool
Configure non-blocking mode. If set to true the underneath socket will be configured in non blocking mode after tls session is established.
int
Network timeout in milliseconds. Note: If this value is not set, by default the timeout is set to 10 seconds. If you wish that the session should wait indefinitely then please use a larger value e.g., INT32_MAX.
bool
Use a global ca_store for all the connections in which this bool is set.
const char *
If non-NULL, server certificate CN must match this name. If NULL, server certificate CN must match hostname.
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.
Function pointer to esp_crt_bundle_attach. Enables the use of certification bundle for server verification, must be enabled in menuconfig.
bool
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.
The name of interface for data to go through. Use the default interface without setting.
const int *
Pointer to a zero-terminated array of IANA identifiers of TLS ciphersuites. Please check the list validity by esp_tls_get_ciphersuites_list() API.
TLS protocol version of the connection, e.g., TLS 1.2, TLS 1.3 (default - no preference).
Related Functions
Found 12 other functions taking a esp_tls_cfg
argument:
Function
Description
Create a new blocking TLS/SSL connection This function establishes a TLS/SSL connection with the specified host in blocking manner.
Create a new non-blocking TLS/SSL connection This function initiates a non-blocking TLS/SSL connection with the specified host, but due to its non-blocking nature, it doesn't wait for the connection to get established.
Create a new blocking TLS/SSL connection with a given "HTTP" url The behaviour is same as esp_tls_conn_new_sync() API. However this API accepts host's url.
Creates a plain TCP connection, returning a valid socket fd on success or an error handle
Internal Callback for mbedtls_handshake
Internal Callback for set_client_config_function
Create a new blocking TLS/SSL connection with a given "HTTP" url Note: This API is present for backward compatibility reasons. Alternative function with the same functionality is `esp_tls_conn_http_new_sync` (and its asynchronous version `esp_tls_conn_http_new_async`)
Create a new non-blocking TLS/SSL connection with a given "HTTP" url The behaviour is same as esp_tls_conn_new_async() API. However this API accepts host's url.