lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-10-26 00:37:41 +03:00
Code Activity

Improve documentation

Browse Source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2025-09-11 18:34:29 +02:00
parent 447134b704
commit 6e1b66320a
1 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/psa/crypto_extra.h
View File

@@ -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 * This means that PSA core was built with the corresponding PSA_WANT_ALG_xxx
* set and that psa_crypto_init has already been called. * 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 * \note When using the built-in version of the PSA core (i.e.
* set) for now this function only checks the state of the driver * #MBEDTLS_PSA_CRYPTO_C is set), for now, this function only checks
* subsystem, not the algorithm. This might be improved in the future. * the state of the driver subsystem, not the algorithm.
* This might be improved in the future.
* *
* \param hash_alg The hash algorithm. * \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. * Tell if PSA is ready for this cipher.
* *
* \note For now, only checks the state of the driver subsystem, * \note When using the built-in version of the PSA core (i.e.
* not the algorithm. Might do more in the future. * #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); int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg);