mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-14 01:26:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

pk: fix documentation for mbedtls_pk_setup_opaque()

Browse Source 
Signed-off-by: Valerio Setti <valerio.setti@nordicsemi.no>
This commit is contained in:
Valerio Setti 2024-03-18 11:06:44 +01:00
parent e146940714
commit 7ab1861163
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
include/mbedtls/pk.h
View File

@ -361,24 +361,28 @@ int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info);
/**
* \brief Initialize a PK context to wrap a PSA key.
*
* \note This function replaces mbedtls_pk_setup() for contexts
* that wrap a (possibly opaque) PSA key instead of
* storing and manipulating the key material directly.
* This function helps creating a PK context which wraps a
* PSA key. The PSA wrapped key must:
* * remain valid as long as the wrapping PK context is in use,
* that is at least between the point this function is
* called and the point mbedtls_pk_free() is called on this
* context;
* * be a key pair;
* * be an EC or RSA type (DH is not suported in PK module).
*
* 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 both deterministic and non-deterministic ECDSA.
* * RSA:
* * sign: #PSA_ALG_RSA_PKCS1V15_SIGN();
* * decrypt: #PSA_ALG_RSA_PKCS1V15_CRYPT.
*
* \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
* pair (see notes below).
*
* \note The wrapped key must remain valid as long as the
* wrapping PK context is in use, that is at least between
* the point this function is called and the point
* mbedtls_pk_free() is called on this context. The wrapped
* key might then be independently used or destroyed.
*
* \note This function is currently only available for ECC or RSA
* key pairs (that is, keys containing private key material).
* Support for other key types may be added later.
*
* \return \c 0 on success.
* \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input
* (context already used, invalid key identifier).