library: ssl: fix documentation of IANA TLS group info

Signed-off-by: Valerio Setti <[email protected]>
This commit is contained in:
Valerio Setti
2026-01-27 17:56:34 +01:00
parent d658f3d41e
commit 9b49d5dbde
+10 -6
View File
@@ -3660,21 +3660,25 @@ void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
#endif /* MBEDTLS_SSL_SRV_C */ #endif /* MBEDTLS_SSL_SRV_C */
#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */ #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
/* /**
* This structure defines the correpondence between IANA's TLS-ID and its * This structure defines the correpondence between IANA's TLS-ID and its
* corresponding group name. * corresponding group name.
* This is used in macro #MBEDTLS_SSL_IANA_TLS_GROUPS_INFO to define the list * This is used in macro #MBEDTLS_SSL_IANA_TLS_GROUPS_INFO to define the list
* of known TLS IDs and corresponding group names. * of known TLS IDs and corresponding group names.
*
* Future versions of the library might add new fields to this structure.
*/ */
typedef struct { typedef struct {
uint16_t tls_id; uint16_t tls_id;
const char *group_name; const char *group_name;
} mbedtls_ssl_iana_tls_group_info_t; } mbedtls_ssl_iana_tls_group_info_t;
/* /**
* Initializer for a list of known "TLS ID" <-> "group name". * Initializer for a list of known TLS 1.2 named elliptic curves and
* Each entry is a structure of type mbedtls_ssl_iana_tls_group_info_t. * TLS 1.3 groups, with their names.
* The last entry has 'tls_id = 0' and 'group_name = NULL'. *
* Each entry is a structure of type #mbedtls_ssl_iana_tls_group_info_t.
* The last entry has `tls_id = 0` and `group_name = NULL`.
*/ */
#define MBEDTLS_SSL_IANA_TLS_GROUPS_INFO \ #define MBEDTLS_SSL_IANA_TLS_GROUPS_INFO \
{ \ { \
@@ -3696,7 +3700,7 @@ typedef struct {
} }
#if defined(MBEDTLS_DEBUG_C) #if defined(MBEDTLS_DEBUG_C)
/* /**
* List of known "TLS ID" <-> "group name". * List of known "TLS ID" <-> "group name".
* #MBEDTLS_SSL_IANA_TLS_GROUPS_INFO is used to initialized the list. * #MBEDTLS_SSL_IANA_TLS_GROUPS_INFO is used to initialized the list.
*/ */