include/psa/crypto_se_driver.h

5  * This header declares types and function signatures for cryptography
106 /** \brief A driver initialization function.
144  * a secure element can be done either as a single function call (via the
159 /** \brief A function that starts a secure element  MAC operation for a PSA
178 /** \brief A function that continues a previously started secure element MAC
192 /** \brief a function that completes a previously started secure element MAC
213 /** \brief A function that completes a previously started secure element MAC
233 /** \brief A function that aborts a previous started secure element MAC
241 /** \brief A function that performs a secure element MAC operation in one
268 /** \brief A function that performs a secure element MAC operation in one
296 /** \brief A struct containing all of the function pointers needed to
316     /** Function that performs a MAC setup operation
319     /** Function that performs a MAC update operation
322     /** Function that completes a MAC operation
325     /** Function that completes a MAC operation with a verify check
328     /** Function that aborts a previously started MAC operation
331     /** Function that performs a MAC operation in one call
334     /** Function that performs a MAC and verify operation in one call
358  * the block mode itself, while calling the `psa_drv_se_cipher_ecb_t` function
363 /** \brief A function that provides the cipher setup function for a
385 /** \brief A function that sets the initialization vector (if
390  * generate function is not necessary for the drivers to implement as the PSA
404 /** \brief A function that continues a previously started secure element cipher
429 /** \brief A function that completes a previously started secure element cipher
448 /** \brief A function that aborts a previously started secure element cipher
456 /** \brief A function that performs the ECB block mode for secure element
459  * Note: this function should only be used with implementations that do not
489  * \brief A struct containing all of the function pointers needed to implement
503     /** Function that performs a cipher setup operation */
505     /** Function that sets a cipher IV (if necessary) */
507     /** Function that performs a cipher update operation */
509     /** Function that completes a cipher operation */
511     /** Function that aborts a cipher operation */
513     /** Function that performs ECB mode for a cipher operation
526  * keys in a secure element must be done in single function calls.
531  * \brief A function that signs a hash or short message with a private key in
557  * \brief A function that verifies the signature a hash or short message using
582  * \brief A function that encrypts a short message with an asymmetric public
623  * \brief A function that decrypts a short message with an asymmetric private
663  * \brief A struct containing all of the function pointers needed to implement
672     /** Function that performs an asymmetric sign operation */
674     /** Function that performs an asymmetric verify operation */
676     /** Function that performs an asymmetric encrypt operation */
678     /** Function that performs an asymmetric decrypt operation */
686  * elements must be done in one function call. While this creates a burden for
693 /** \brief A function that performs a secure element authenticated encryption
737 /** A function that performs a secure element authenticated decryption operation
780  * \brief A struct containing all of the function pointers needed to implement
789     /** Function that performs the AEAD encrypt operation */
791     /** Function that performs the AEAD decrypt operation */
834 /** \brief A function that allocates a slot for a key.
837  * first calls this function to determine a valid slot number,
838  * then calls a function to create the key material in that slot.
840  * the effect of a call to a key creation function in the PSA Cryptography
848  * -# The core calls a key creation function in the driver.
871  *   was allocated (or validated) instead of calling a key creation function.
874  *   was allocated (or validated) instead of calling a key creation function.
905 /** \brief A function that determines whether a slot number is valid
909  * first calls this function to validate the choice of slot number,
910  * then calls a function to create the key material in that slot.
914  * for applications to trigger a call to this function. However some
920  * This function may update the driver's persistent data through
942  *         creation function instead.
951 /** \brief A function that imports a key into a secure element in binary format
953  * This function can support any output from psa_export_key(). Refer to the
975  *                              This value is not used if the function fails.
989  * \brief A function that destroys a secure element key and restore the slot to
992  * This function destroys the content of the key from a secure element.
996  * This function returns the specified slot to its default state.
1012  * \brief A function that exports a secure element key in binary format
1014  * The output of this function can be passed to psa_import_key() to
1018  * this function, it is not guaranteed that the resulting data is
1022  * This function should generate output in the same format that
1049  * \brief A function that generates a symmetric or asymmetric key on a secure
1061  * implement the psa_drv_key_management_t::p_export_public function.
1092  *                              function to export the public key when needed.
1101  * \brief A struct containing all of the function pointers needed to for secure
1110     /** Function that allocates a slot for a key. */
1112     /** Function that checks the validity of a slot for a key. */
1114     /** Function that performs a key import operation */
1116     /** Function that performs a generation */
1118     /** Function that performs a key destroy operation */
1120     /** Function that performs a key export operation */
1122     /** Function that performs a public key export operation */
1131  * cryptographic function, such as a hash.
1148  * to the driver via a function, `psa_drv_se_key_derivation_collateral`, that
1177 /** \brief A function that Sets up a secure element key derivation operation by
1194 /** \brief A function that provides collateral (parameters) needed for a secure
1198  * expected that this function may be called multiple times for the same
1214 /** \brief A function that performs the final secure element key derivation
1227 /** \brief A function that performs the final step of a secure element key
1244  * \brief A struct containing all of the function pointers needed to for secure
1255     /** Function that performs a key derivation setup */
1257     /** Function that sets key derivation collateral */
1259     /** Function that performs a final key derivation step */
1261     /** Function that performs a final key derivation or agreement and
1296     /** The driver initialization function.
1298      * This function is called once during the initialization of the
1299      * PSA Cryptography subsystem, before any other function of the
1300      * driver is called. If this function returns a failure status,
1303      * If this field is \c NULL, it is equivalent to a function that does
1323  * This function is only intended to be used by driver code, not by
1325  * PSA cryptography module and applications, this function should
1330  * This function may be called before psa_crypto_init(). It is
1331  * implementation-defined whether this function may be called
1357  *         this function.
1359  *         This function was called after the initialization of the