mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-04-09 21:44:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix Doxygen documentation of mbedtls_ssl_tls1_3_derive_secret()

Browse Source 
Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
Hanno Becker 2020-09-09 12:58:29 +01:00
parent 97a21567df
commit 0c42fd94bb
2 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
library/ssl_tls13_keys.c
View File

@ -235,7 +235,7 @@ int mbedtls_ssl_tls1_3_derive_secret(
const unsigned char *secret, size_t slen, const unsigned char *secret, size_t slen,
const unsigned char *label, size_t llen, const unsigned char *label, size_t llen,
const unsigned char *ctx, size_t clen, const unsigned char *ctx, size_t clen,
int context_already_hashed, int ctx_hashed,
unsigned char *dstbuf, size_t buflen ) unsigned char *dstbuf, size_t buflen )
{ {
int ret; int ret;
@ -246,7 +246,7 @@ int mbedtls_ssl_tls1_3_derive_secret(
if( md == NULL ) if( md == NULL )
return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ); return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
if( context_already_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED ) if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
{ {
ret = mbedtls_md( md, ctx, clen, hashed_context ); ret = mbedtls_md( md, ctx, clen, hashed_context );
if( ret != 0 ) if( ret != 0 )
@ -258,7 +258,7 @@ int mbedtls_ssl_tls1_3_derive_secret(
if( clen > sizeof(hashed_context) ) if( clen > sizeof(hashed_context) )
{ {
/* This should never happen since this function is internal /* This should never happen since this function is internal
* and the code sets `context_already_hashed` correctly. * and the code sets `ctx_hashed` correctly.
* Let's double-check nonetheless to not run at the risk * Let's double-check nonetheless to not run at the risk
* of getting a stack overflow. */ * of getting a stack overflow. */
return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );

40
library/ssl_tls13_keys.h
View File

@ -162,21 +162,29 @@ int mbedtls_ssl_tls1_3_make_traffic_keys(
* the parameter message contains the already hashed value and * the parameter message contains the already hashed value and
* the Derive-Secret function does not need to hash it again. * the Derive-Secret function does not need to hash it again.
* *
* \param hash_alg The identifier for the hash function used for the * \param hash_alg The identifier for the hash function used for the
* applications of HKDF. * applications of HKDF.
* \param secret The \c Secret argument to the \c Derive-Secret function. * \param secret The \c Secret argument to the \c Derive-Secret function.
* This must be a readable buffer of length \p slen Bytes. * This must be a readable buffer of length \p slen Bytes.
* \param slen The length of \p secret in Bytes. * \param slen The length of \p secret in Bytes.
* \param label The \c Label argument to the \c Derive-Secret function. * \param label The \c Label argument to the \c Derive-Secret function.
* This must be a readable buffer of length \p llen Bytes. * This must be a readable buffer of length \p llen Bytes.
* \param llen The length of \p label in Bytes. * \param llen The length of \p label in Bytes.
* \param hash The hash of the \c Messages argument to the \c Derive-Secret * \param ctx The hash of the \c Messages argument to the
* function. This must be a readable buffer of length \p mlen * \c Derive-Secret function, or the \c Messages argument
* hlen Bytes. * itself, depending on \p context_already_hashed.
* \param hlen The length of \p hash. * \param clen The length of \p hash.
* \param dstbuf The target buffer to write the output of \c Derive-Secret to. * \param ctx_hashed This indicates whether the \p ctx contains the hash of
* This must be a writable buffer of size \p buflen Bytes. * the \c Messages argument in the application of the
* \param buflen The length of \p dstbuf in Bytes. * \c Derive-Secret function
* (value MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED), or whether
* it is the content of \c Messages itself, in which case
* the function takes care of the hashing
* (value MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED).
* \param dstbuf The target buffer to write the output of
* \c Derive-Secret to. This must be a writable buffer of
* size \p buflen Bytes.
* \param buflen The length of \p dstbuf in Bytes.
* *
* \returns \c 0 on success. * \returns \c 0 on success.
* \returns A negative error code on failure. * \returns A negative error code on failure.
@ -186,7 +194,7 @@ int mbedtls_ssl_tls1_3_derive_secret(
const unsigned char *secret, size_t slen, const unsigned char *secret, size_t slen,
const unsigned char *label, size_t llen, const unsigned char *label, size_t llen,
const unsigned char *ctx, size_t clen, const unsigned char *ctx, size_t clen,
int context_already_hashed, int ctx_hashed,
unsigned char *dstbuf, size_t buflen ); unsigned char *dstbuf, size_t buflen );
/** /**