Symbols ![]()
loading...
Files ![]()
loading...
esp_transport_ssl_set_psk_key_hint() function
Set PSK key and hint for PSK server/client verification in esp-tls component. Important notes: - This function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up - ESP_TLS_PSK_VERIFICATION config option must be enabled in menuconfig - certificate verification takes priority so it must not be configured to enable PSK method.
Syntax
void esp_transport_ssl_set_psk_key_hint(esp_transport_handle_t t,
const psk_hint_key_t* psk_hint_key);
Related Functions
Found 98 other functions taking a ![]()
esp_transport_item_t
argument:
Function
Description
Get user data context of this transport
Transport read function @note: Please refer to the enum `esp_tcp_transport_err_t` for all the possible return values
Returns esp_tls error handle. Warning: The returned pointer is valid only as long as esp_transport_handle_t exists. Once transport handle gets destroyed, this value (esp_tls_error_handle_t) is freed automatically.
Transport write function
Transport close
Cleanup and free memory the transport
Poll the transport until readable or timeout
Get and clear last captured socket errno Socket errno is internally stored whenever any of public facing API for reading, writing, polling or connection fails returning negative return code. The error code corresponds to the `SO_ERROR` value retrieved from the underlying transport socket using `getsockopt()` API. After reading the captured errno, the internal value is cleared to 0.
Add a transport to the list, and define a scheme to indentify this transport in the list
Set default port number that can be used by this transport
Poll the transport until writeable or timeout
Transport connection function, to make a connection to server
Set transport functions for the transport handle
Captures the current errno
Set websocket sub protocol header
Captures internal tcp connection error This is internally translated to esp-tls return codes of esp_err_t type, since the esp-tls will be used as TCP transport layer
Sets error to common transport handle Note: This function copies the supplied error handle object to tcp_transport's internal error handle object
Set transport functions for the transport handle
Set the user context data for this transport
Set name of interface that socket can be binded on So the data can transport on this interface
Set SSL certificate data (as PEM format). Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Set SSL certificate data (as DER format). Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Enable the use of certification bundle for server verfication for an SSL connection. It must be first enabled in menuconfig.
Enable global CA store for SSL connection
Set SSL client certificate data for mutual authentication (as PEM format). Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Set SSL client certificate data for mutual authentication (as DER format). Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Set SSL client key data for mutual authentication (as PEM format). Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Set SSL client key password if the key is password protected. The configured password is passed to the underlying TLS stack to decrypt the client key
Set SSL client key data for mutual authentication (as DER format). Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Skip validation of certificate's common name field
Set the server certificate's common name field
Set name of interface that socket can be binded on So the data can transport on this interface
Create web socket transport
Set HTTP path to update protocol to websocket
Non-blocking transport connection function, to make a connection to server
Set parent transport function to the handle
Get default port number used by this transport
Set TCP keep-alive configuration
Set TLS protocol version for ESP-TLS connection
Set the list of supported application protocols to be used with ALPN. Note that, this function stores the pointer to data, rather than making a copy. So this data must remain valid until after the connection is cleaned up
Set keep-alive status in current ssl context
Set websocket user-agent header
Set websocket additional headers
Set websocket authorization headers
Polls the active connection for termination This API is typically used by the client to wait for clean connection closure by websocket server
Returns underlying socket for the supplied transport handle
Handles control frames This API is used internally to handle control frames at the transport layer. The API could be possibly promoted to a public API if needed by some clients
Get transport handle of underlying protocol which can access this protocol payload directly (used for receiving longer msg multiple times)
Set websocket transport parameters
Sends websocket raw message with custom opcode and payload Note that generic esp_transport_write for ws handle sends binary massages by default if size is > 0 and ping message if message size is set to 0. This API is provided to support explicit messages with arbitrary opcode, should it be PING, PONG or TEXT message with arbitrary data.
Returns websocket fin flag for last received data
Returns the HTTP status code of the websocket handshake This API should be called after the connection atempt otherwise its result is meaningless
Returns websocket op-code for last received data
Returns payload length of the last received data
Create a proxy transport
Set the ssl context to use secure element (atecc608a) for client(device) private key and certificate
Set the ds_data handle in ssl context.(used for the digital signature operation)
Changes the configuration of the proxy