ARMmbed/mbedtls
1
0
Fork 0
mirror of https://github.com/ARMmbed/mbedtls.git synced 2025-06-10 16:43:47 +08:00
Code Issues Releases Wiki Activity

Add psa_export_public_key_iop_abort() header/doc

Browse Source 
Signed-off-by: Waleed Elmelegy <waleed.elmelegy@arm.com>
This commit is contained in:
Waleed Elmelegy 2024-11-15 17:13:58 +00:00
parent e5b3e66fba
commit cee3af2ca8
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
tf-psa-crypto/include/psa/crypto.h
View File

@ -5768,6 +5768,49 @@ psa_status_t psa_export_public_key_iop_complete(psa_export_public_key_iop_t *ope
size_t data_size,
size_t *data_length);
/**
* \brief Abort an interruptible public-key export operation.
*
* \warning This is a beta API, and thus subject to change
* at any point. It is not bound by the usual
* interface stability promises.
*
* \note This function clears the number of ops completed
* as part of the operation. Please ensure you copy
* this value via
* \c psa_export_public_key_iop_get_num_ops() if
* required before calling.
*
* \note Aborting an operation frees all
* associated resources except for the operation
* structure itself. Once aborted, the operation
* object can be reused for another operation by
* calling \c psa_export_public_key_iop_setup() again.
*
* \note You may call this function any time after the
* operation object has been initialized.
* In particular, calling
* \c psa_export_public_key_iop_abort() after the
* operation has already been terminated by a call
* to \c psa_export_public_key_iop_abort() or
* \c psa_export_public_key_iop_complete() is safe.
*
* \param[in,out] operation The \c psa_export_public_key_iop_t to use
*
* \retval #PSA_SUCCESS
* The operation was aborted successfully.
*
* \retval #PSA_ERROR_NOT_SUPPORTED \emptydescription
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by
* \c psa_crypto_init().
* \retval #PSA_ERROR_CORRUPTION_DETECTED \emptydescription
*
*/
psa_status_t psa_export_public_key_iop_abort(psa_export_public_key_iop_t *operation);
/**@}*/
#ifdef __cplusplus
}
#endif