lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-30 22:43:08 +03:00
Code Activity

Documentation improvements

Browse Source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2024-07-18 10:59:53 +02:00
parent 52504f8568
commit 0d619b2dc7
3 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/psa/crypto_struct.h
View File

@ -245,7 +245,7 @@ struct psa_custom_key_parameters_s {
*/ */
/* This is a deprecated variant of `struct psa_custom_key_parameters_s`. /* This is a deprecated variant of `struct psa_custom_key_parameters_s`.
* It has exactly the same layout, plus an extra field which is a flexible * It has exactly the same layout, plus an extra field which is a flexible
* array members. Thus a `const struct psa_key_production_parameters_s*` * array member. Thus a `const struct psa_key_production_parameters_s*`
* can be passed to any function that reads a * can be passed to any function that reads a
* `const struct psa_custom_key_parameters_s*`. * `const struct psa_custom_key_parameters_s*`.
*/ */

3
library/psa_crypto_core.h
View File

@ -365,8 +365,7 @@ int psa_custom_key_parameters_are_default(
* \param[in] attributes The attributes for the key to generate. * \param[in] attributes The attributes for the key to generate.
* \param[in] custom Custom parameters for the key generation. * \param[in] custom Custom parameters for the key generation.
* \param[in] custom_data Variable-length data associated with \c custom. * \param[in] custom_data Variable-length data associated with \c custom.
* \param custom_data_length * \param custom_data_length Length of `custom_data` in bytes.
* Length of `custom_data` in bytes.
* \param[out] key_buffer Buffer where the key data is to be written. * \param[out] key_buffer Buffer where the key data is to be written.
* \param[in] key_buffer_size Size of \p key_buffer in bytes. * \param[in] key_buffer_size Size of \p key_buffer in bytes.
* \param[out] key_buffer_length On success, the number of bytes written in * \param[out] key_buffer_length On success, the number of bytes written in

4
library/psa_crypto_rsa.h
View File

@ -106,7 +106,7 @@ psa_status_t mbedtls_psa_rsa_export_public_key(
* \brief Generate an RSA key. * \brief Generate an RSA key.
* *
* \param[in] attributes The attributes for the RSA key to generate. * \param[in] attributes The attributes for the RSA key to generate.
* \param[in] custom The public exponent to use. * \param[in] custom_data The public exponent to use.
* This can be a null pointer if * This can be a null pointer if
* \c params_data_length is 0. * \c params_data_length is 0.
* \param custom_data_length Length of \p custom_data in bytes. * \param custom_data_length Length of \p custom_data in bytes.
@ -126,7 +126,7 @@ psa_status_t mbedtls_psa_rsa_export_public_key(
*/ */
psa_status_t mbedtls_psa_rsa_generate_key( psa_status_t mbedtls_psa_rsa_generate_key(
const psa_key_attributes_t *attributes, const psa_key_attributes_t *attributes,
const uint8_t *custom, size_t custom_data_length, const uint8_t *custom_data, size_t custom_data_length,
uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length); uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length);
/** Sign an already-calculated hash with an RSA private key. /** Sign an already-calculated hash with an RSA private key.