Fix typos in C header files

Signed-off-by: Tobias Nießen <tniessen@tnie.de>
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Tobias Nießen 2021-05-10 19:53:15 +02:00 committed by Gilles Peskine
parent 85bb47596c
commit 02b6fba7f5
7 changed files with 11 additions and 11 deletions

View file

@ -427,7 +427,7 @@
* be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
* must stay untouched. * must stay untouched.
* *
* \note If you use the AES_xxx_ALT macros, then is is recommended to also set * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
* MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
* tables. * tables.
* *
@ -1897,7 +1897,7 @@
/** /**
* \def MBEDTLS_SSL_DTLS_SRTP * \def MBEDTLS_SSL_DTLS_SRTP
* *
* Enable support for negotation of DTLS-SRTP (RFC 5764) * Enable support for negotiation of DTLS-SRTP (RFC 5764)
* through the use_srtp extension. * through the use_srtp extension.
* *
* \note This feature provides the minimum functionality required * \note This feature provides the minimum functionality required

View file

@ -1180,7 +1180,7 @@ int mbedtls_ecp_gen_key( mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key,
* *
* \param grp_id The ECP group identifier. * \param grp_id The ECP group identifier.
* \param key The destination key. * \param key The destination key.
* \param buf The the buffer containing the binary representation of the * \param buf The buffer containing the binary representation of the
* key. (Big endian integer for Weierstrass curves, byte * key. (Big endian integer for Weierstrass curves, byte
* string for Montgomery curves.) * string for Montgomery curves.)
* \param buflen The length of the buffer in bytes. * \param buflen The length of the buffer in bytes.

View file

@ -151,8 +151,8 @@ extern void (*mbedtls_test_hook_error_add)( int, int, const char *, int );
* *
* \param high high-level error code. See error.h for more details. * \param high high-level error code. See error.h for more details.
* \param low low-level error code. See error.h for more details. * \param low low-level error code. See error.h for more details.
* \param file file where this error code addition occured. * \param file file where this error code addition occurred.
* \param line line where this error code addition occured. * \param line line where this error code addition occurred.
*/ */
static inline int mbedtls_error_add( int high, int low, static inline int mbedtls_error_add( int high, int low,
const char *file, int line ) const char *file, int line )

View file

@ -4327,7 +4327,7 @@ void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
/** /**
* \brief TLS-PRF function for key derivation. * \brief TLS-PRF function for key derivation.
* *
* \param prf The tls_prf type funtion type to be used. * \param prf The tls_prf type function type to be used.
* \param secret Secret for the key derivation function. * \param secret Secret for the key derivation function.
* \param slen Length of the secret. * \param slen Length of the secret.
* \param label String label for the key derivation function, * \param label String label for the key derivation function,
@ -4337,7 +4337,7 @@ void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
* \param dstbuf The buffer holding the derived key. * \param dstbuf The buffer holding the derived key.
* \param dlen Length of the output buffer. * \param dlen Length of the output buffer.
* *
* \return 0 on sucess. An SSL specific error on failure. * \return 0 on success. An SSL specific error on failure.
*/ */
int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf, int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
const unsigned char *secret, size_t slen, const unsigned char *secret, size_t slen,

View file

@ -97,7 +97,7 @@ void mbedtls_ssl_ticket_init( mbedtls_ssl_ticket_context *ctx );
* Recommended value: 86400 (one day). * Recommended value: 86400 (one day).
* *
* \note It is highly recommended to select a cipher that is at * \note It is highly recommended to select a cipher that is at
* least as strong as the the strongest ciphersuite * least as strong as the strongest ciphersuite
* supported. Usually that means a 256-bit key. * supported. Usually that means a 256-bit key.
* *
* \note The lifetime of the keys is twice the lifetime of tickets. * \note The lifetime of the keys is twice the lifetime of tickets.

View file

@ -44,7 +44,7 @@ typedef mbedtls_svc_key_id_t psa_key_handle_t;
#define PSA_KEY_HANDLE_INIT MBEDTLS_SVC_KEY_ID_INIT #define PSA_KEY_HANDLE_INIT MBEDTLS_SVC_KEY_ID_INIT
/** Check wether an handle is null. /** Check whether an handle is null.
* *
* \param handle Handle * \param handle Handle
* *

View file

@ -1159,7 +1159,7 @@ typedef struct {
* can be problemmatic to manage on embedded platforms, the inputs are passed * can be problemmatic to manage on embedded platforms, the inputs are passed
* to the driver via a function, `psa_drv_se_key_derivation_collateral`, that * to the driver via a function, `psa_drv_se_key_derivation_collateral`, that
* is called multiple times with different `collateral_id`s. Thus, for a key * is called multiple times with different `collateral_id`s. Thus, for a key
* derivation algorithm that required 3 paramter inputs, the flow would look * derivation algorithm that required 3 parameter inputs, the flow would look
* something like: * something like:
* ~~~~~~~~~~~~~{.c} * ~~~~~~~~~~~~~{.c}
* psa_drv_se_key_derivation_setup(kdf_algorithm, source_key, dest_key_size_bytes); * psa_drv_se_key_derivation_setup(kdf_algorithm, source_key, dest_key_size_bytes);
@ -1207,7 +1207,7 @@ typedef psa_status_t (*psa_drv_se_key_derivation_setup_t)(psa_drv_se_context_t *
* element key derivation or key agreement operation * element key derivation or key agreement operation
* *
* Since many key derivation algorithms require multiple parameters, it is * Since many key derivation algorithms require multiple parameters, it is
* expeced that this function may be called multiple times for the same * expected that this function may be called multiple times for the same
* operation, each with a different algorithm-specific `collateral_id` * operation, each with a different algorithm-specific `collateral_id`
* *
* \param[in,out] op_context A hardware-specific structure containing any * \param[in,out] op_context A hardware-specific structure containing any