Espressif ESP32-S2 - Page 682

Chapter 2. API Reference
uint16_t len
Length (in bytes) of the proof of possession data
struct protocomm_security
Protocomm security object structure.
The member functions are used for implementing secure protocomm sessions.
Note This structure should not have any dynamic members to allow re-entrancy
Public Members
int ver
Unique version number of security implementation
esp_err_t (*init)(protocomm_security_handle_t *handle)
Function for initializing/allocating security infrastructure
esp_err_t (*cleanup)(protocomm_security_handle_t handle)
Function for deallocating security infrastructure
esp_err_t (*new_transport_session)(protocomm_security_handle_t handle, uint32_t ses-
sion_id)
Starts new secure transport session with specified ID
esp_err_t (*close_transport_session)(protocomm_security_handle_t handle, uint32_t ses-
sion_id)
Closes a secure transport session with specified ID
esp_err_t (*security_req_handler)(protocomm_security_handle_t handle, const proto-
comm_security_pop_t *pop, uint32_t session_id, const
uint8_t *inbuf, ssize_t inlen, uint8_t **outbuf, ssize_t
*outlen, void *priv_data)
Handler function for authenticating connection request and establishing secure session
esp_err_t (*encrypt)(protocomm_security_handle_t handle, uint32_t session_id, const uint8_t *in-
buf, ssize_t inlen, uint8_t *outbuf, ssize_t *outlen)
Function which implements the encryption algorithm
esp_err_t (*decrypt)(protocomm_security_handle_t handle, uint32_t session_id, const uint8_t *in-
buf, ssize_t inlen, uint8_t *outbuf, ssize_t *outlen)
Function which implements the decryption algorithm
Type Definitions
typedef struct protocomm_security_pop protocomm_security_pop_t
Proof Of Possession for authenticating a secure session.
typedef void *protocomm_security_handle_t
typedef struct protocomm_security protocomm_security_t
Protocomm security object structure.
The member functions are used for implementing secure protocomm sessions.
Note This structure should not have any dynamic members to allow re-entrancy
Header File
• components/protocomm/include/security/protocomm_security0.h
Header File
• components/protocomm/include/security/protocomm_security1.h
Espressif Systems 671
Submit Document Feedback
Release v4.4