From 6e1b66320a5cfd1c36c0caa86abed5dce896cc85 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Thu, 11 Sep 2025 18:34:29 +0200 Subject: [PATCH] Improve documentation Signed-off-by: Gilles Peskine --- include/psa/crypto_extra.h | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/include/psa/crypto_extra.h b/include/psa/crypto_extra.h index d24911f18c..b36ec6f9b5 100644 --- a/include/psa/crypto_extra.h +++ b/include/psa/crypto_extra.h @@ -600,9 +600,10 @@ psa_status_t mbedtls_psa_platform_get_builtin_key( * This means that PSA core was built with the corresponding PSA_WANT_ALG_xxx * set and that psa_crypto_init has already been called. * - * \note When using Mbed TLS version of PSA core (i.e. MBEDTLS_PSA_CRYPTO_C is - * set) for now this function only checks the state of the driver - * subsystem, not the algorithm. This might be improved in the future. + * \note When using the built-in version of the PSA core (i.e. + * #MBEDTLS_PSA_CRYPTO_C is set), for now, this function only checks + * the state of the driver subsystem, not the algorithm. + * This might be improved in the future. * * \param hash_alg The hash algorithm. * @@ -613,12 +614,15 @@ int psa_can_do_hash(psa_algorithm_t hash_alg); /** * Tell if PSA is ready for this cipher. * - * \note For now, only checks the state of the driver subsystem, - * not the algorithm. Might do more in the future. + * \note When using the built-in version of the PSA core (i.e. + * #MBEDTLS_PSA_CRYPTO_C is set), for now, this function only checks + * the state of the driver subsystem, not the key type and algorithm. + * This might be improved in the future. * - * \param cipher_alg The cipher algorithm (ignored for now). + * \param key_type The key type. + * \param cipher_alg The cipher algorithm. * - * \return 1 if the driver subsytem is ready, 0 otherwise. + * \return 1 if the PSA can handle \p hash_alg, 0 otherwise. */ int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg);