From cee3af2ca892aac5c56b7abc25df9515222e05b9 Mon Sep 17 00:00:00 2001 From: Waleed Elmelegy Date: Fri, 15 Nov 2024 17:13:58 +0000 Subject: [PATCH] Add psa_export_public_key_iop_abort() header/doc Signed-off-by: Waleed Elmelegy --- tf-psa-crypto/include/psa/crypto.h | 43 ++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/tf-psa-crypto/include/psa/crypto.h b/tf-psa-crypto/include/psa/crypto.h index 79a7d5177..62ef39345 100644 --- a/tf-psa-crypto/include/psa/crypto.h +++ b/tf-psa-crypto/include/psa/crypto.h @@ -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