mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-02-11 00:40:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document the key_ext functions as deprecated

Browse Source 
Don't formally deprecate them because we don't do that in a
long-time support branch. But do point readers away from them.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2024-06-06 21:27:16 +02:00
parent 603b5b842b
commit e65cca2ee5
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/psa/crypto.h
View File

@ -3842,13 +3842,11 @@ psa_status_t psa_key_derivation_output_key_custom(
/** Derive a key from an ongoing key derivation operation with custom /** Derive a key from an ongoing key derivation operation with custom
* production parameters. * production parameters.
* *
* See the description of psa_key_derivation_out_key() for the operation of * \note
* this function with the default production parameters. * This is a deprecated variant of psa_key_derivation_output_key_custom().
* Mbed TLS currently does not currently support any non-default production * It is equivalent except that the associated variable-length data
* parameters. * is passed in `params->data` instead of a separate parameter.
* * This function will be removed in a future version of Mbed TLS.
* \note This function is experimental and may change in future minor
* versions of Mbed TLS.
* *
* \param[in] attributes The attributes for the new key. * \param[in] attributes The attributes for the new key.
* If the key type to be created is * If the key type to be created is
@ -4265,15 +4263,11 @@ psa_status_t psa_generate_key_custom(const psa_key_attributes_t *attributes,
/** /**
* \brief Generate a key or key pair using custom production parameters. * \brief Generate a key or key pair using custom production parameters.
* *
* See the description of psa_generate_key() for the operation of this * \note
* function with the default production parameters. In addition, this function * This is a deprecated variant of psa_key_derivation_output_key_custom().
* supports the following production customizations, described in more detail * It is equivalent except that the associated variable-length data
* in the documentation of ::psa_key_production_parameters_t: * is passed in `params->data` instead of a separate parameter.
* * This function will be removed in a future version of Mbed TLS.
* - RSA keys: generation with a custom public exponent.
*
* \note This function is experimental and may change in future minor
* versions of Mbed TLS.
* *
* \param[in] attributes The attributes for the new key. * \param[in] attributes The attributes for the new key.
* \param[in] params Customization parameters for the key generation. * \param[in] params Customization parameters for the key generation.