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

pk: fix indentation in description of mbedtls_pk_setup_opaque()

Browse Source 
Signed-off-by: Valerio Setti <valerio.setti@nordicsemi.no>
This commit is contained in:
Valerio Setti 2024-03-20 16:08:08 +01:00
parent 013fa95222
commit c51b08ca1d
1 changed files with 22 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/mbedtls/pk.h
View File

@ -361,35 +361,31 @@ int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info);
/** /**
* \brief Initialize a PK context to wrap a PSA key. * \brief Initialize a PK context to wrap a PSA key.
* *
* This function helps creating a PK context which wraps a * This function helps creating a PK context which wraps a PSA key. The PSA wrapped
* PSA key. The PSA wrapped key must be an EC or RSA key pair * key must be an EC or RSA key pair (DH is not suported in PK module).
* (DH is not suported in PK module).
* *
* Under the hood PSA functions are used to perform the required * Under the hood PSA functions are used to perform the required
* operations and, based on the key type, used algorithms will be: * operations and, based on the key type, used algorithms will be:
* * EC: * * EC:
* * verify, verify_ext, sign, sign_ext: ECDSA. * * verify, verify_ext, sign, sign_ext: ECDSA.
* * RSA: * * RSA:
* * sign, sign_ext, decrypt: use the primary algorithm in * * sign, sign_ext, decrypt: use the primary algorithm in the wrapped PSA key;
* the wrapped PSA key;
* * verify, verify_ext, encrypt: not supported. * * verify, verify_ext, encrypt: not supported.
* *
* In order for the above operations to succeed, the policy of * In order for the above operations to succeed, the policy of the wrapped PSA
* the wrapped PSA key must allow the specified algorithm. * key must allow the specified algorithm.
* *
* \warning The PSA wrapped key must remain valid as long as the wrapping * \warning The PSA wrapped key must remain valid as long as the wrapping PK
* PK context is in use, that is at least between the point this * context is in use, that is at least between the point this function
* function is called and the point mbedtls_pk_free() is called * is called and the point mbedtls_pk_free() is called on this context.
* on this context.
* *
* \param ctx The context to initialize. It must be empty (type NONE). * \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. * \param key The PSA key to wrap, which must hold an ECC or RSA key pair.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input * \return #MBEDTLS_ERR_PK_BAD_INPUT_DATA on invalid input (context already
* (context already used, invalid key identifier). * used, invalid key identifier).
* \return #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE if the key is not an * \return #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE if the key is not an ECC key pair.
* ECC key pair.
* \return #MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure. * \return #MBEDTLS_ERR_PK_ALLOC_FAILED on allocation failure.
*/ */
int mbedtls_pk_setup_opaque(mbedtls_pk_context *ctx, int mbedtls_pk_setup_opaque(mbedtls_pk_context *ctx,