aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValerio Setti <valerio.setti@nordicsemi.no>2024-03-19 11:32:51 +0100
committerValerio Setti <valerio.setti@nordicsemi.no>2024-03-21 16:55:24 +0100
commit55ed91e0aa45d96fb676551d761076a0bc7c6c48 (patch)
treecb644949210928bd23b96678d0ec25440e4eb318
parent622f90597ecc21435aa48698eca0ff93220e8dbf (diff)
downloadmbedtls-55ed91e0aa45d96fb676551d761076a0bc7c6c48.zip
mbedtls-55ed91e0aa45d96fb676551d761076a0bc7c6c48.tar.gz
mbedtls-55ed91e0aa45d96fb676551d761076a0bc7c6c48.tar.bz2
pk: fix documentation for mbedtls_pk_setup_opaque()
Signed-off-by: Valerio Setti <valerio.setti@nordicsemi.no>
-rw-r--r--include/mbedtls/pk.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/include/mbedtls/pk.h b/include/mbedtls/pk.h
index 4113895..60942d7e 100644
--- a/include/mbedtls/pk.h
+++ b/include/mbedtls/pk.h
@@ -373,9 +373,9 @@ int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info);
* Under the hood PSA functions are used to perform the required
* operations and, based on the key type, used algorithms will be:
* * EC:
- * * verify: #PSA_ALG_ECDSA_ANY;
- * * sign: try #PSA_ALG_DETERMINISTIC_ECDSA() first and, in
- * case it fails, try with #PSA_ALG_ECDSA().
+ * * verify, verify_ext: #PSA_ALG_ECDSA_ANY;
+ * * sign, sign_ext: try #PSA_ALG_DETERMINISTIC_ECDSA()
+ * first and, in case it fails, try with #PSA_ALG_ECDSA().
* * RSA:
* * sign: #PSA_ALG_RSA_PKCS1V15_SIGN();
* * sign_ext: use the algorithm associated with the wrapped
@@ -384,9 +384,8 @@ int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info);
* * verify_ext: not supported;
* * decrypt: #PSA_ALG_RSA_PKCS1V15_CRYPT;
* * encrypt: not supported.
- * In order to have above mentioned operations to succeed it is
- * mandatory that the wrapped PSA key allows the specified
- * algorithm in its policy.
+ * In order for the above operations to succeed, the policy of
+ * the wrapped PSA key must allow the specified algorithm.
*
* \param ctx The context to initialize. It must be empty (type NONE).
* \param key The PSA key to wrap, which must hold an ECC or RSA key