libcoap 4.3.5-develop-19cef11
coap_dtls_spsk_t Struct Reference

The structure used for defining the Server PSK setup data to be used. More...

#include <coap_dtls.h>

+ Collaboration diagram for coap_dtls_spsk_t:

Data Fields

uint8_t version
 
uint8_t ec_jpake
 Set to COAP_DTLS_SPSK_SETUP_VERSION to support this version of the struct. More...
 
uint8_t reserved [6]
 Reserved - must be set to 0 for future compatibility. More...
 
coap_dtls_id_callback_t validate_id_call_back
 Identity check callback function. More...
 
void * id_call_back_arg
 Passed in to the Identity callback function. More...
 
coap_dtls_psk_sni_callback_t validate_sni_call_back
 SNI check callback function. More...
 
void * sni_call_back_arg
 Passed in to the SNI callback function. More...
 
coap_dtls_spsk_info_t psk_info
 Server PSK definition. More...
 

Detailed Description

The structure used for defining the Server PSK setup data to be used.

Definition at line 501 of file coap_dtls.h.

Field Documentation

◆ ec_jpake

uint8_t coap_dtls_spsk_t::ec_jpake

Set to COAP_DTLS_SPSK_SETUP_VERSION to support this version of the struct.

Set to 1 if EC-JPAKE can be used. Currently Mbed TLS only

Definition at line 506 of file coap_dtls.h.

◆ id_call_back_arg

void* coap_dtls_spsk_t::id_call_back_arg

Passed in to the Identity callback function.

Definition at line 523 of file coap_dtls.h.

◆ psk_info

coap_dtls_spsk_info_t coap_dtls_spsk_t::psk_info

Server PSK definition.

Definition at line 533 of file coap_dtls.h.

◆ reserved

uint8_t coap_dtls_spsk_t::reserved[6]

Reserved - must be set to 0 for future compatibility.

Definition at line 508 of file coap_dtls.h.

◆ sni_call_back_arg

void* coap_dtls_spsk_t::sni_call_back_arg

Passed in to the SNI callback function.

Definition at line 531 of file coap_dtls.h.

◆ validate_id_call_back

coap_dtls_id_callback_t coap_dtls_spsk_t::validate_id_call_back

Identity check callback function.

If not NULL, is called when the Identity is provided by the client. The appropriate Pre-Shared Key to use can then be returned.

Definition at line 522 of file coap_dtls.h.

◆ validate_sni_call_back

coap_dtls_psk_sni_callback_t coap_dtls_spsk_t::validate_sni_call_back

SNI check callback function.

If not NULL, called if the SNI is not previously seen and prior to sending PSK information back to the client so that the appropriate PSK information can be used based on the requesting SNI.

Definition at line 530 of file coap_dtls.h.

◆ version

uint8_t coap_dtls_spsk_t::version

Definition at line 502 of file coap_dtls.h.


The documentation for this struct was generated from the following file: