cuberite/polarssl
1
0
Fork 0
mirror of https://github.com/cuberite/polarssl.git synced 2025-10-01 17:40:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5549 from AndrzejKurek/doxygen-bad-param-names

Browse Source 
Fix wrong doxygen parameter names and misused `\p` commands
This commit is contained in:
Dave Rodgman 2023-07-20 14:10:10 +01:00 committed by GitHub
commit ed70fd0c39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 64 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/mbedtls/aria.h
View File

@ -259,10 +259,6 @@ int mbedtls_aria_crypt_cfb128(mbedtls_aria_context *ctx,
* \brief This function performs an ARIA-CTR encryption or decryption * \brief This function performs an ARIA-CTR encryption or decryption
* operation. * operation.
* *
* This function performs the operation defined in the \p mode
* parameter (encrypt/decrypt), on the input data buffer
* defined in the \p input parameter.
*
* Due to the nature of CTR, you must use the same key schedule * Due to the nature of CTR, you must use the same key schedule
* for both encryption and decryption operations. Therefore, you * for both encryption and decryption operations. Therefore, you
* must use the context initialized with mbedtls_aria_setkey_enc() * must use the context initialized with mbedtls_aria_setkey_enc()

4
include/mbedtls/asn1.h
View File

@ -474,7 +474,7 @@ void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq);
* on a successful invocation. * on a successful invocation.
* \param end The end of the ASN.1 SEQUENCE container. * \param end The end of the ASN.1 SEQUENCE container.
* \param tag_must_mask A mask to be applied to the ASN.1 tags found within * \param tag_must_mask A mask to be applied to the ASN.1 tags found within
* the SEQUENCE before comparing to \p tag_must_value. * the SEQUENCE before comparing to \p tag_must_val.
* \param tag_must_val The required value of each ASN.1 tag found in the * \param tag_must_val The required value of each ASN.1 tag found in the
* SEQUENCE, after masking with \p tag_must_mask. * SEQUENCE, after masking with \p tag_must_mask.
* Mismatching tags lead to an error. * Mismatching tags lead to an error.
@ -483,7 +483,7 @@ void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq);
* while a value of \c 0xFF for \p tag_must_mask means * while a value of \c 0xFF for \p tag_must_mask means
* that \p tag_must_val is the only allowed tag. * that \p tag_must_val is the only allowed tag.
* \param tag_may_mask A mask to be applied to the ASN.1 tags found within * \param tag_may_mask A mask to be applied to the ASN.1 tags found within
* the SEQUENCE before comparing to \p tag_may_value. * the SEQUENCE before comparing to \p tag_may_val.
* \param tag_may_val The desired value of each ASN.1 tag found in the * \param tag_may_val The desired value of each ASN.1 tag found in the
* SEQUENCE, after masking with \p tag_may_mask. * SEQUENCE, after masking with \p tag_may_mask.
* Mismatching tags will be silently ignored. * Mismatching tags will be silently ignored.

8
include/mbedtls/bignum.h
View File

@ -544,7 +544,7 @@ int mbedtls_mpi_write_file(const char *p, const mbedtls_mpi *X,
* \param X The destination MPI. This must point to an initialized MPI. * \param X The destination MPI. This must point to an initialized MPI.
* \param buf The input buffer. This must be a readable buffer of length * \param buf The input buffer. This must be a readable buffer of length
* \p buflen Bytes. * \p buflen Bytes.
* \param buflen The length of the input buffer \p p in Bytes. * \param buflen The length of the input buffer \p buf in Bytes.
* *
* \return \c 0 if successful. * \return \c 0 if successful.
* \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed. * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed.
@ -559,7 +559,7 @@ int mbedtls_mpi_read_binary(mbedtls_mpi *X, const unsigned char *buf,
* \param X The destination MPI. This must point to an initialized MPI. * \param X The destination MPI. This must point to an initialized MPI.
* \param buf The input buffer. This must be a readable buffer of length * \param buf The input buffer. This must be a readable buffer of length
* \p buflen Bytes. * \p buflen Bytes.
* \param buflen The length of the input buffer \p p in Bytes. * \param buflen The length of the input buffer \p buf in Bytes.
* *
* \return \c 0 if successful. * \return \c 0 if successful.
* \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed. * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if memory allocation failed.
@ -999,8 +999,8 @@ int mbedtls_mpi_gcd(mbedtls_mpi *G, const mbedtls_mpi *A,
* \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if a memory allocation failed. * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if a memory allocation failed.
* \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p N is less than * \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p N is less than
* or equal to one. * or equal to one.
* \return #MBEDTLS_ERR_MPI_NOT_ACCEPTABLE if \p has no modular inverse * \return #MBEDTLS_ERR_MPI_NOT_ACCEPTABLE if \p A has no modular
* with respect to \p N. * inverse with respect to \p N.
*/ */
int mbedtls_mpi_inv_mod(mbedtls_mpi *X, const mbedtls_mpi *A, int mbedtls_mpi_inv_mod(mbedtls_mpi *X, const mbedtls_mpi *A,
const mbedtls_mpi *N); const mbedtls_mpi *N);

2
include/mbedtls/camellia.h
View File

@ -220,7 +220,7 @@ int mbedtls_camellia_crypt_cfb128(mbedtls_camellia_context *ctx,
* *note Due to the nature of CTR mode, you should use the same * *note Due to the nature of CTR mode, you should use the same
* key for both encryption and decryption. In particular, calls * key for both encryption and decryption. In particular, calls
* to this function should be preceded by a key-schedule via * to this function should be preceded by a key-schedule via
* mbedtls_camellia_setkey_enc() regardless of whether \p mode * mbedtls_camellia_setkey_enc() regardless of whether the mode
* is #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. * is #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT.
* *
* \warning You must never reuse a nonce value with the same key. Doing so * \warning You must never reuse a nonce value with the same key. Doing so

8
include/mbedtls/cipher.h
View File

@ -505,7 +505,7 @@ static inline size_t mbedtls_cipher_info_get_key_bitlen(
* *
* \return The cipher name, which is a human readable string, * \return The cipher name, which is a human readable string,
* with static storage duration. * with static storage duration.
* \return \c NULL if \c info is \p NULL. * \return \c NULL if \p info is \c NULL.
*/ */
static inline const char *mbedtls_cipher_info_get_name( static inline const char *mbedtls_cipher_info_get_name(
const mbedtls_cipher_info_t *info) const mbedtls_cipher_info_t *info)
@ -596,7 +596,7 @@ static inline int mbedtls_cipher_info_has_variable_iv_size(
} }
/** /**
* \brief This function initializes a \p cipher_context as NONE. * \brief This function initializes a \p ctx as NONE.
* *
* \param ctx The context to be initialized. This must not be \c NULL. * \param ctx The context to be initialized. This must not be \c NULL.
*/ */
@ -790,7 +790,7 @@ static inline const char *mbedtls_cipher_get_name(
* \param ctx The context of the cipher. This must be initialized. * \param ctx The context of the cipher. This must be initialized.
* *
* \return The key length of the cipher in bits. * \return The key length of the cipher in bits.
* \return #MBEDTLS_KEY_LENGTH_NONE if ctx \p has not been * \return #MBEDTLS_KEY_LENGTH_NONE if \p ctx has not been
* initialized. * initialized.
*/ */
static inline int mbedtls_cipher_get_key_bitlen( static inline int mbedtls_cipher_get_key_bitlen(
@ -990,7 +990,7 @@ int mbedtls_cipher_update(mbedtls_cipher_context_t *ctx,
* \param ctx The generic cipher context. This must be initialized and * \param ctx The generic cipher context. This must be initialized and
* bound to a key. * bound to a key.
* \param output The buffer to write data to. This needs to be a writable * \param output The buffer to write data to. This needs to be a writable
* buffer of at least \p block_size Bytes. * buffer of at least block_size Bytes.
* \param olen The length of the data written to the \p output buffer. * \param olen The length of the data written to the \p output buffer.
* This may not be \c NULL. * This may not be \c NULL.
* *

2
include/mbedtls/dhm.h
View File

@ -325,7 +325,7 @@ size_t mbedtls_dhm_get_len(const mbedtls_dhm_context *ctx);
* initialized. * initialized.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return #MBEDTLS_ERR_DHM_BAD_INPUT_DATA if \p field is invalid. * \return #MBEDTLS_ERR_DHM_BAD_INPUT_DATA if \p param is invalid.
* \return An \c MBEDTLS_ERR_MPI_XXX error code if the copy fails. * \return An \c MBEDTLS_ERR_MPI_XXX error code if the copy fails.
*/ */
int mbedtls_dhm_get_value(const mbedtls_dhm_context *ctx, int mbedtls_dhm_get_value(const mbedtls_dhm_context *ctx,

17
include/mbedtls/ecdsa.h
View File

@ -207,8 +207,9 @@ int mbedtls_ecdsa_sign(mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s,
* \param md_alg The hash algorithm used to hash the original data. * \param md_alg The hash algorithm used to hash the original data.
* \param f_rng_blind The RNG function used for blinding. This must not be * \param f_rng_blind The RNG function used for blinding. This must not be
* \c NULL. * \c NULL.
* \param p_rng_blind The RNG context to be passed to \p f_rng. This may be * \param p_rng_blind The RNG context to be passed to \p f_rng_blind. This
* \c NULL if \p f_rng doesn't need a context parameter. * may be \c NULL if \p f_rng_blind doesn't need a context
* parameter.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX
@ -326,8 +327,8 @@ int mbedtls_ecdsa_sign_restartable(
* \param md_alg The hash algorithm used to hash the original data. * \param md_alg The hash algorithm used to hash the original data.
* \param f_rng_blind The RNG function used for blinding. This must not be * \param f_rng_blind The RNG function used for blinding. This must not be
* \c NULL. * \c NULL.
* \param p_rng_blind The RNG context to be passed to \p f_rng. This may be * \param p_rng_blind The RNG context to be passed to \p f_rng_blind. This may be
* \c NULL if \p f_rng doesn't need a context parameter. * \c NULL if \p f_rng_blind doesn't need a context parameter.
* \param rs_ctx The restart context to use. This may be \c NULL * \param rs_ctx The restart context to use. This may be \c NULL
* to disable restarting. If it is not \c NULL, it * to disable restarting. If it is not \c NULL, it
* must point to an initialized restart context. * must point to an initialized restart context.
@ -459,7 +460,7 @@ int mbedtls_ecdsa_verify_restartable(mbedtls_ecp_group *grp,
* via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair(). * via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair().
* \param md_alg The message digest that was used to hash the message. * \param md_alg The message digest that was used to hash the message.
* \param hash The message hash to be signed. This must be a readable * \param hash The message hash to be signed. This must be a readable
* buffer of length \p blen Bytes. * buffer of length \p hlen Bytes.
* \param hlen The length of the hash \p hash in Bytes. * \param hlen The length of the hash \p hash in Bytes.
* \param sig The buffer to which to write the signature. This must be a * \param sig The buffer to which to write the signature. This must be a
* writable buffer of length at least twice as large as the * writable buffer of length at least twice as large as the
@ -502,7 +503,7 @@ int mbedtls_ecdsa_write_signature(mbedtls_ecdsa_context *ctx,
* via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair(). * via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair().
* \param md_alg The message digest that was used to hash the message. * \param md_alg The message digest that was used to hash the message.
* \param hash The message hash to be signed. This must be a readable * \param hash The message hash to be signed. This must be a readable
* buffer of length \p blen Bytes. * buffer of length \p hlen Bytes.
* \param hlen The length of the hash \p hash in Bytes. * \param hlen The length of the hash \p hash in Bytes.
* \param sig The buffer to which to write the signature. This must be a * \param sig The buffer to which to write the signature. This must be a
* writable buffer of length at least twice as large as the * writable buffer of length at least twice as large as the
@ -549,7 +550,7 @@ int mbedtls_ecdsa_write_signature_restartable(mbedtls_ecdsa_context *ctx,
* \param ctx The ECDSA context to use. This must be initialized * \param ctx The ECDSA context to use. This must be initialized
* and have a group and public key bound to it. * and have a group and public key bound to it.
* \param hash The message hash that was signed. This must be a readable * \param hash The message hash that was signed. This must be a readable
* buffer of length \p size Bytes. * buffer of length \p hlen Bytes.
* \param hlen The size of the hash \p hash. * \param hlen The size of the hash \p hash.
* \param sig The signature to read and verify. This must be a readable * \param sig The signature to read and verify. This must be a readable
* buffer of length \p slen Bytes. * buffer of length \p slen Bytes.
@ -579,7 +580,7 @@ int mbedtls_ecdsa_read_signature(mbedtls_ecdsa_context *ctx,
* \param ctx The ECDSA context to use. This must be initialized * \param ctx The ECDSA context to use. This must be initialized
* and have a group and public key bound to it. * and have a group and public key bound to it.
* \param hash The message hash that was signed. This must be a readable * \param hash The message hash that was signed. This must be a readable
* buffer of length \p size Bytes. * buffer of length \p hlen Bytes.
* \param hlen The size of the hash \p hash. * \param hlen The size of the hash \p hash.
* \param sig The signature to read and verify. This must be a readable * \param sig The signature to read and verify. This must be a readable
* buffer of length \p slen Bytes. * buffer of length \p slen Bytes.

4
include/mbedtls/ecp.h
View File

@ -1083,7 +1083,7 @@ int mbedtls_ecp_muladd_restartable(
* *
* It only checks that the point is non-zero, has * It only checks that the point is non-zero, has
* valid coordinates and lies on the curve. It does not verify * valid coordinates and lies on the curve. It does not verify
* that it is indeed a multiple of \p G. This additional * that it is indeed a multiple of \c G. This additional
* check is computationally more expensive, is not required * check is computationally more expensive, is not required
* by standards, and should not be necessary if the group * by standards, and should not be necessary if the group
* used has a small cofactor. In particular, it is useless for * used has a small cofactor. In particular, it is useless for
@ -1108,7 +1108,7 @@ int mbedtls_ecp_check_pubkey(const mbedtls_ecp_group *grp,
const mbedtls_ecp_point *pt); const mbedtls_ecp_point *pt);
/** /**
* \brief This function checks that an \p mbedtls_mpi is a * \brief This function checks that an \c mbedtls_mpi is a
* valid private key for this curve. * valid private key for this curve.
* *
* \note This function uses bare components rather than an * \note This function uses bare components rather than an

8
include/mbedtls/hmac_drbg.h
View File

@ -183,8 +183,8 @@ void mbedtls_hmac_drbg_init(mbedtls_hmac_drbg_context *ctx);
* \param len The length of the personalization string. * \param len The length of the personalization string.
* This must be at most #MBEDTLS_HMAC_DRBG_MAX_INPUT * This must be at most #MBEDTLS_HMAC_DRBG_MAX_INPUT
* and also at most * and also at most
* #MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT - \p entropy_len * 3 / 2 * #MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT - \c entropy_len * 3 / 2
* where \p entropy_len is the entropy length * where \c entropy_len is the entropy length
* described above. * described above.
* *
* \return \c 0 if successful. * \return \c 0 if successful.
@ -313,8 +313,8 @@ int mbedtls_hmac_drbg_update(mbedtls_hmac_drbg_context *ctx,
* \param len The length of the additional data. * \param len The length of the additional data.
* This must be at most #MBEDTLS_HMAC_DRBG_MAX_INPUT * This must be at most #MBEDTLS_HMAC_DRBG_MAX_INPUT
* and also at most * and also at most
* #MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT - \p entropy_len * #MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT - \c entropy_len
* where \p entropy_len is the entropy length * where \c entropy_len is the entropy length
* (see mbedtls_hmac_drbg_set_entropy_len()). * (see mbedtls_hmac_drbg_set_entropy_len()).
* *
* \return \c 0 if successful. * \return \c 0 if successful.

4
include/mbedtls/mbedtls_config.h
View File

@ -1283,8 +1283,8 @@
* ); * );
* ``` * ```
* The \c context value is initialized to 0 before the first call. * The \c context value is initialized to 0 before the first call.
* The function must fill the \c output buffer with \p output_size bytes * The function must fill the \c output buffer with \c output_size bytes
* of random data and set \c *output_length to \p output_size. * of random data and set \c *output_length to \c output_size.
* *
* Requires: MBEDTLS_PSA_CRYPTO_C * Requires: MBEDTLS_PSA_CRYPTO_C
* *

4
include/mbedtls/pk.h
View File

@ -552,7 +552,7 @@ int mbedtls_pk_can_do_ext(const mbedtls_pk_context *ctx, psa_algorithm_t alg,
* *
* \return 0 on success (signature is valid), * \return 0 on success (signature is valid),
* #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid * #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid
* signature in sig but its length is less than \p siglen, * signature in \p sig but its length is less than \p sig_len,
* or a specific error code. * or a specific error code.
* *
* \note For RSA keys, the default padding type is PKCS#1 v1.5. * \note For RSA keys, the default padding type is PKCS#1 v1.5.
@ -606,7 +606,7 @@ int mbedtls_pk_verify_restartable(mbedtls_pk_context *ctx,
* #MBEDTLS_ERR_PK_TYPE_MISMATCH if the PK context can't be * #MBEDTLS_ERR_PK_TYPE_MISMATCH if the PK context can't be
* used for this type of signatures, * used for this type of signatures,
* #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid * #MBEDTLS_ERR_PK_SIG_LEN_MISMATCH if there is a valid
* signature in sig but its length is less than \p siglen, * signature in \p sig but its length is less than \p sig_len,
* or a specific error code. * or a specific error code.
* *
* \note If hash_len is 0, then the length associated with md_alg * \note If hash_len is 0, then the length associated with md_alg

12
include/mbedtls/rsa.h
View File

@ -282,15 +282,15 @@ int mbedtls_rsa_import_raw(mbedtls_rsa_context *ctx,
* \brief This function completes an RSA context from * \brief This function completes an RSA context from
* a set of imported core parameters. * a set of imported core parameters.
* *
* To setup an RSA public key, precisely \p N and \p E * To setup an RSA public key, precisely \c N and \c E
* must have been imported. * must have been imported.
* *
* To setup an RSA private key, sufficient information must * To setup an RSA private key, sufficient information must
* be present for the other parameters to be derivable. * be present for the other parameters to be derivable.
* *
* The default implementation supports the following: * The default implementation supports the following:
* <ul><li>Derive \p P, \p Q from \p N, \p D, \p E.</li> * <ul><li>Derive \c P, \c Q from \c N, \c D, \c E.</li>
* <li>Derive \p N, \p D from \p P, \p Q, \p E.</li></ul> * <li>Derive \c N, \c D from \c P, \c Q, \c E.</li></ul>
* Alternative implementations need not support these. * Alternative implementations need not support these.
* *
* If this function runs successfully, it guarantees that * If this function runs successfully, it guarantees that
@ -547,7 +547,7 @@ int mbedtls_rsa_check_pub_priv(const mbedtls_rsa_context *pub,
* \note This function does not handle message padding. * \note This function does not handle message padding.
* *
* \note Make sure to set \p input[0] = 0 or ensure that * \note Make sure to set \p input[0] = 0 or ensure that
* input is smaller than \p N. * input is smaller than \c N.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return An \c MBEDTLS_ERR_RSA_XXX error code on failure. * \return An \c MBEDTLS_ERR_RSA_XXX error code on failure.
@ -984,8 +984,8 @@ int mbedtls_rsa_rsassa_pss_sign(mbedtls_rsa_context *ctx,
* verification. * verification.
* *
* \note For PKCS#1 v2.1 encoding, see comments on * \note For PKCS#1 v2.1 encoding, see comments on
* mbedtls_rsa_rsassa_pss_verify() about \p md_alg and * mbedtls_rsa_rsassa_pss_verify() about \c md_alg and
* \p hash_id. * \c hash_id.
* *
* \param ctx The initialized RSA public key context to use. * \param ctx The initialized RSA public key context to use.
* \param md_alg The message-digest algorithm used to hash the original data. * \param md_alg The message-digest algorithm used to hash the original data.

20
include/mbedtls/ssl.h
View File

@ -2170,10 +2170,10 @@ void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
* \param own_cid The address of the readable buffer holding the CID we want * \param own_cid The address of the readable buffer holding the CID we want
* the peer to use when sending encrypted messages to us. * the peer to use when sending encrypted messages to us.
* This may be \c NULL if \p own_cid_len is \c 0. * This may be \c NULL if \p own_cid_len is \c 0.
* This parameter is unused if \p enabled is set to * This parameter is unused if \p enable is set to
* MBEDTLS_SSL_CID_DISABLED. * MBEDTLS_SSL_CID_DISABLED.
* \param own_cid_len The length of \p own_cid. * \param own_cid_len The length of \p own_cid.
* This parameter is unused if \p enabled is set to * This parameter is unused if \p enable is set to
* MBEDTLS_SSL_CID_DISABLED. * MBEDTLS_SSL_CID_DISABLED.
* *
* \note The value of \p own_cid_len must match the value of the * \note The value of \p own_cid_len must match the value of the
@ -3124,8 +3124,8 @@ int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
* *
* \param session The session structure to be saved. * \param session The session structure to be saved.
* \param buf The buffer to write the serialized data to. It must be a * \param buf The buffer to write the serialized data to. It must be a
* writeable buffer of at least \p len bytes, or may be \c * writeable buffer of at least \p buf_len bytes, or may be \c
* NULL if \p len is \c 0. * NULL if \p buf_len is \c 0.
* \param buf_len The number of bytes available for writing in \p buf. * \param buf_len The number of bytes available for writing in \p buf.
* \param olen The size in bytes of the data that has been or would have * \param olen The size in bytes of the data that has been or would have
* been written. It must point to a valid \c size_t. * been written. It must point to a valid \c size_t.
@ -3266,7 +3266,7 @@ void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
* record headers. * record headers.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p len
* is too large. * is too large.
*/ */
int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len, int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len,
@ -3810,8 +3810,8 @@ static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
/** /**
* \brief Retrieve SNI extension value for the current handshake. * \brief Retrieve SNI extension value for the current handshake.
* Available in \p f_cert_cb of \c mbedtls_ssl_conf_cert_cb(), * Available in \c f_cert_cb of \c mbedtls_ssl_conf_cert_cb(),
* this is the same value passed to \p f_sni callback of * this is the same value passed to \c f_sni callback of
* \c mbedtls_ssl_conf_sni() and may be used instead of * \c mbedtls_ssl_conf_sni() and may be used instead of
* \c mbedtls_ssl_conf_sni(). * \c mbedtls_ssl_conf_sni().
* *
@ -3820,7 +3820,7 @@ static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
* 0 if SNI extension is not present or not yet processed. * 0 if SNI extension is not present or not yet processed.
* *
* \return const pointer to SNI extension value. * \return const pointer to SNI extension value.
* - value is valid only when called in \p f_cert_cb * - value is valid only when called in \c f_cert_cb
* registered with \c mbedtls_ssl_conf_cert_cb(). * registered with \c mbedtls_ssl_conf_cert_cb().
* - value is NULL if SNI extension is not present. * - value is NULL if SNI extension is not present.
* - value is not '\0'-terminated. Use \c name_len for len. * - value is not '\0'-terminated. Use \c name_len for len.
@ -4116,7 +4116,7 @@ void MBEDTLS_DEPRECATED mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, i
* negotiated. * negotiated.
* *
* \param conf SSL configuration * \param conf SSL configuration
* \param tls_version TLS protocol version number (\p mbedtls_ssl_protocol_version) * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
* (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid) * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
*/ */
static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf, static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf,
@ -4173,7 +4173,7 @@ void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, i
* negotiated. * negotiated.
* *
* \param conf SSL configuration * \param conf SSL configuration
* \param tls_version TLS protocol version number (\p mbedtls_ssl_protocol_version) * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
* (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid) * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
*/ */
static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf, static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf,

2
include/mbedtls/ssl_cache.h
View File

@ -137,7 +137,7 @@ int mbedtls_ssl_cache_set(void *data,
* *
* \param data The SSL cache context to use. * \param data The SSL cache context to use.
* \param session_id The pointer to the buffer holding the session ID * \param session_id The pointer to the buffer holding the session ID
* associated to \p session. * associated to session.
* \param session_id_len The length of \p session_id in bytes. * \param session_id_len The length of \p session_id in bytes.
* *
* \return \c 0 on success. This indicates the cache entry for * \return \c 0 on success. This indicates the cache entry for

4
include/mbedtls/x509.h
View File

@ -429,7 +429,7 @@ int mbedtls_x509_time_is_future(const mbedtls_x509_time *from);
* \param san_buf The buffer holding the raw data item of the subject * \param san_buf The buffer holding the raw data item of the subject
* alternative name. * alternative name.
* \param san The target structure to populate with the parsed presentation * \param san The target structure to populate with the parsed presentation
* of the subject alternative name encoded in \p san_raw. * of the subject alternative name encoded in \p san_buf.
* *
* \note Supported GeneralName types, as defined in RFC 5280: * \note Supported GeneralName types, as defined in RFC 5280:
* "rfc822Name", "dnsName", "directoryName", * "rfc822Name", "dnsName", "directoryName",
@ -439,7 +439,7 @@ int mbedtls_x509_time_is_future(const mbedtls_x509_time *from);
* \note This function should be called on a single raw data of * \note This function should be called on a single raw data of
* subject alternative name. For example, after successful * subject alternative name. For example, after successful
* certificate parsing, one must iterate on every item in the * certificate parsing, one must iterate on every item in the
* \p crt->subject_alt_names sequence, and pass it to * \c crt->subject_alt_names sequence, and pass it to
* this function. * this function.
* *
* \warning The target structure contains pointers to the raw data of the * \warning The target structure contains pointers to the raw data of the

4
include/psa/crypto.h
View File

@ -4407,9 +4407,9 @@ psa_status_t psa_sign_hash_start(
* \retval #PSA_ERROR_BUFFER_TOO_SMALL * \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p signature buffer is too small. You can * The size of the \p signature buffer is too small. You can
* determine a sufficient buffer size by calling * determine a sufficient buffer size by calling
* #PSA_SIGN_OUTPUT_SIZE(\c key_type, \c key_bits, \p alg) * #PSA_SIGN_OUTPUT_SIZE(\c key_type, \c key_bits, \c alg)
* where \c key_type and \c key_bits are the type and bit-size * where \c key_type and \c key_bits are the type and bit-size
* respectively of \p key. * respectively of \c key.
* *
* \retval #PSA_ERROR_BAD_STATE * \retval #PSA_ERROR_BAD_STATE
* An operation was not previously started on this context via * An operation was not previously started on this context via

22
include/psa/crypto_extra.h
View File

@ -1036,12 +1036,12 @@ typedef uint32_t psa_pake_primitive_t;
* (value of type ::psa_pake_primitive_type_t). * (value of type ::psa_pake_primitive_type_t).
* \param pake_family The family of the primitive * \param pake_family The family of the primitive
* (the type and interpretation of this parameter depends * (the type and interpretation of this parameter depends
* on \p type, for more information consult the * on \p pake_type, for more information consult the
* documentation of individual ::psa_pake_primitive_type_t * documentation of individual ::psa_pake_primitive_type_t
* constants). * constants).
* \param pake_bits The bit-size of the primitive * \param pake_bits The bit-size of the primitive
* (Value of type \c size_t. The interpretation * (Value of type \c size_t. The interpretation
* of this parameter depends on \p family, for more * of this parameter depends on \p pake_family, for more
* information consult the documentation of individual * information consult the documentation of individual
* ::psa_pake_primitive_type_t constants). * ::psa_pake_primitive_type_t constants).
* *
@ -1545,7 +1545,7 @@ psa_status_t psa_pake_set_user(psa_pake_operation_t *operation,
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT * \retval #PSA_ERROR_INVALID_ARGUMENT
* \p user_id is not valid for the \p operation's algorithm and cipher * \p peer_id is not valid for the \p operation's algorithm and cipher
* suite. * suite.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* The algorithm doesn't associate a second identity with the session. * The algorithm doesn't associate a second identity with the session.
@ -1627,8 +1627,8 @@ psa_status_t psa_pake_set_role(psa_pake_operation_t *operation,
* \c PSA_PAKE_STEP_XXX constants for more * \c PSA_PAKE_STEP_XXX constants for more
* information. * information.
* \param output_size Size of the \p output buffer in bytes. This must * \param output_size Size of the \p output buffer in bytes. This must
* be at least #PSA_PAKE_OUTPUT_SIZE(\p alg, \p * be at least #PSA_PAKE_OUTPUT_SIZE(\c alg, \c
* primitive, \p step) where \p alg and * primitive, \p output_step) where \c alg and
* \p primitive are the PAKE algorithm and primitive * \p primitive are the PAKE algorithm and primitive
* in the operation's cipher suite, and \p step is * in the operation's cipher suite, and \p step is
* the output step. * the output step.
@ -1693,9 +1693,9 @@ psa_status_t psa_pake_output(psa_pake_operation_t *operation,
* \retval #PSA_ERROR_INVALID_SIGNATURE * \retval #PSA_ERROR_INVALID_SIGNATURE
* The verification fails for a #PSA_PAKE_STEP_ZK_PROOF input step. * The verification fails for a #PSA_PAKE_STEP_ZK_PROOF input step.
* \retval #PSA_ERROR_INVALID_ARGUMENT * \retval #PSA_ERROR_INVALID_ARGUMENT
* \p is not compatible with the \p operation’s algorithm, or the * \p input_length is not compatible with the \p operation’s algorithm,
* \p input is not valid for the \p operation's algorithm, cipher suite * or the \p input is not valid for the \p operation's algorithm,
* or \p step. * cipher suite or \p step.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* \p step p is not supported with the \p operation's algorithm, or the * \p step p is not supported with the \p operation's algorithm, or the
* \p input is not supported for the \p operation's algorithm, cipher * \p input is not supported for the \p operation's algorithm, cipher
@ -1744,7 +1744,7 @@ psa_status_t psa_pake_input(psa_pake_operation_t *operation,
* *
* When this function returns successfully, \p operation becomes inactive. * When this function returns successfully, \p operation becomes inactive.
* If this function returns an error status, both \p operation * If this function returns an error status, both \p operation
* and \p key_derivation operations enter an error state and must be aborted by * and \c key_derivation operations enter an error state and must be aborted by
* calling psa_pake_abort() and psa_key_derivation_abort() respectively. * calling psa_pake_abort() and psa_key_derivation_abort() respectively.
* *
* \param[in,out] operation Active PAKE operation. * \param[in,out] operation Active PAKE operation.
@ -1877,7 +1877,7 @@ psa_status_t psa_pake_abort(psa_pake_operation_t *operation);
* The value of this macro must be at least as large as the largest value * The value of this macro must be at least as large as the largest value
* returned by PSA_PAKE_OUTPUT_SIZE() * returned by PSA_PAKE_OUTPUT_SIZE()
* *
* See also #PSA_PAKE_OUTPUT_SIZE(\p alg, \p primitive, \p step). * See also #PSA_PAKE_OUTPUT_SIZE(\p alg, \p primitive, \p output_step).
*/ */
#define PSA_PAKE_OUTPUT_MAX_SIZE 65 #define PSA_PAKE_OUTPUT_MAX_SIZE 65
@ -1889,7 +1889,7 @@ psa_status_t psa_pake_abort(psa_pake_operation_t *operation);
* The value of this macro must be at least as large as the largest value * The value of this macro must be at least as large as the largest value
* returned by PSA_PAKE_INPUT_SIZE() * returned by PSA_PAKE_INPUT_SIZE()
* *
* See also #PSA_PAKE_INPUT_SIZE(\p alg, \p primitive, \p step). * See also #PSA_PAKE_INPUT_SIZE(\p alg, \p primitive, \p output_step).
*/ */
#define PSA_PAKE_INPUT_MAX_SIZE 65 #define PSA_PAKE_INPUT_MAX_SIZE 65