The structure used for defining the Client PSK setup data to be used. More...
#include <coap_dtls.h>
Collaboration diagram for coap_dtls_cpsk_t:Data Fields | |
| uint8_t | version |
| uint8_t | ec_jpake |
| Set to COAP_DTLS_CPSK_SETUP_VERSION to support this version of the struct. | |
| uint8_t | use_cid |
| Set to 1 if DTLS Connection ID is to be used. | |
| uint8_t | reserved [5] |
| Reserved - must be set to 0 for future compatibility. | |
| coap_dtls_ih_callback_t | validate_ih_call_back |
| Identity Hint check callback function. | |
| void * | ih_call_back_arg |
| Passed in to the Identity Hint callback function. | |
| char * | client_sni |
| If not NULL, SNI to use in client TLS setup. | |
| coap_dtls_cpsk_info_t | psk_info |
| Client PSK definition. | |
Detailed Description
The structure used for defining the Client PSK setup data to be used.
Definition at line 410 of file coap_dtls.h.
Field Documentation
◆ client_sni
| char* coap_dtls_cpsk_t::client_sni |
If not NULL, SNI to use in client TLS setup.
Owned by the client app and must remain valid during the call to coap_new_client_session_psk2(). Note: Ignored if literal IPv4 or IPv6 address. Note: Not supported by TinyDTLS.
Definition at line 437 of file coap_dtls.h.
◆ ec_jpake
| uint8_t coap_dtls_cpsk_t::ec_jpake |
Set to COAP_DTLS_CPSK_SETUP_VERSION to support this version of the struct.
Set to 1 if EC-JPAKE is to be used. Currently Mbed TLS only
Definition at line 415 of file coap_dtls.h.
◆ ih_call_back_arg
| void* coap_dtls_cpsk_t::ih_call_back_arg |
Passed in to the Identity Hint callback function.
Definition at line 434 of file coap_dtls.h.
◆ psk_info
| coap_dtls_cpsk_info_t coap_dtls_cpsk_t::psk_info |
Client PSK definition.
Definition at line 443 of file coap_dtls.h.
◆ reserved
| uint8_t coap_dtls_cpsk_t::reserved[5] |
Reserved - must be set to 0 for future compatibility.
Definition at line 418 of file coap_dtls.h.
◆ use_cid
| uint8_t coap_dtls_cpsk_t::use_cid |
Set to 1 if DTLS Connection ID is to be used.
Definition at line 417 of file coap_dtls.h.
◆ validate_ih_call_back
| coap_dtls_ih_callback_t coap_dtls_cpsk_t::validate_ih_call_back |
Identity Hint check callback function.
If not NULL, is called when the Identity Hint (TLS1.2 or earlier) is provided by the server. The appropriate Identity and Pre-shared Key to use can then be returned.
Definition at line 433 of file coap_dtls.h.
◆ version
| uint8_t coap_dtls_cpsk_t::version |
Definition at line 411 of file coap_dtls.h.
The documentation for this struct was generated from the following file:
