22#ifndef PSA_CRYPTO_SE_DRIVER_H
23#define PSA_CRYPTO_SE_DRIVER_H
124 void *persistent_data,
127#if defined(__DOXYGEN_ONLY__) || !defined(MBEDTLS_PSA_CRYPTO_SE_C)
188 const uint8_t *p_input,
189 size_t input_length);
210 size_t *p_mac_length);
229 const uint8_t *p_mac,
259 const uint8_t *p_input,
265 size_t *p_mac_length);
288 const uint8_t *p_input,
292 const uint8_t *p_mac,
422 const uint8_t *p_input,
426 size_t *p_output_length);
445 size_t *p_output_length);
482 const uint8_t *p_input,
549 const uint8_t *p_hash,
551 uint8_t *p_signature,
552 size_t signature_size,
553 size_t *p_signature_length);
575 const uint8_t *p_hash,
577 const uint8_t *p_signature,
578 size_t signature_length);
613 const uint8_t *p_input,
615 const uint8_t *p_salt,
619 size_t *p_output_length);
653 const uint8_t *p_input,
655 const uint8_t *p_salt,
659 size_t *p_output_length);
726 const uint8_t *p_nonce,
728 const uint8_t *p_additional_data,
729 size_t additional_data_length,
730 const uint8_t *p_plaintext,
731 size_t plaintext_length,
732 uint8_t *p_ciphertext,
733 size_t ciphertext_size,
734 size_t *p_ciphertext_length);
768 const uint8_t *p_nonce,
770 const uint8_t *p_additional_data,
771 size_t additional_data_length,
772 const uint8_t *p_ciphertext,
773 size_t ciphertext_length,
774 uint8_t *p_plaintext,
775 size_t plaintext_size,
776 size_t *p_plaintext_length);
811#ifndef __DOXYGEN_ONLY__
899 void *persistent_data,
945 void *persistent_data,
1007 void *persistent_data,
1045 size_t *p_data_length);
1097 uint8_t *pubkey,
size_t pubkey_size,
size_t *pubkey_length);
1209 uint32_t collateral_id,
1210 const uint8_t *p_collateral,
1211 size_t collateral_size);
1240 size_t *p_output_length);
1318#define PSA_DRV_SE_HAL_VERSION 0x00000005
Definitions for all PSA crypto drivers.
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
psa_status_t(* psa_drv_se_key_derivation_export_t)(void *op_context, uint8_t *p_output, size_t output_size, size_t *p_output_length)
A function that performs the final step of a secure element key agreement and place the generated key...
psa_status_t(* psa_drv_se_key_derivation_derive_t)(void *op_context, psa_key_slot_number_t dest_key)
A function that performs the final secure element key derivation step and place the generated key mat...
psa_status_t(* psa_drv_se_key_derivation_collateral_t)(void *op_context, uint32_t collateral_id, const uint8_t *p_collateral, size_t collateral_size)
A function that provides collateral (parameters) needed for a secure element key derivation or key ag...
psa_status_t(* psa_drv_se_key_derivation_setup_t)(psa_drv_se_context_t *drv_context, void *op_context, psa_algorithm_t kdf_alg, psa_key_slot_number_t source_key)
A function that Sets up a secure element key derivation operation by specifying the algorithm and the...
int32_t psa_status_t
Function return status.
uint32_t psa_key_location_t
psa_status_t(* psa_drv_se_aead_encrypt_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t algorithm, const uint8_t *p_nonce, size_t nonce_length, const uint8_t *p_additional_data, size_t additional_data_length, const uint8_t *p_plaintext, size_t plaintext_length, uint8_t *p_ciphertext, size_t ciphertext_size, size_t *p_ciphertext_length)
A function that performs a secure element authenticated encryption operation.
psa_status_t(* psa_drv_se_aead_decrypt_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t algorithm, const uint8_t *p_nonce, size_t nonce_length, const uint8_t *p_additional_data, size_t additional_data_length, const uint8_t *p_ciphertext, size_t ciphertext_length, uint8_t *p_plaintext, size_t plaintext_size, size_t *p_plaintext_length)
psa_status_t(* psa_drv_se_asymmetric_decrypt_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t alg, const uint8_t *p_input, size_t input_length, const uint8_t *p_salt, size_t salt_length, uint8_t *p_output, size_t output_size, size_t *p_output_length)
A function that decrypts a short message with an asymmetric private key in a secure element.
psa_status_t(* psa_drv_se_asymmetric_encrypt_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t alg, const uint8_t *p_input, size_t input_length, const uint8_t *p_salt, size_t salt_length, uint8_t *p_output, size_t output_size, size_t *p_output_length)
A function that encrypts a short message with an asymmetric public key in a secure element.
psa_status_t(* psa_drv_se_asymmetric_sign_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t alg, const uint8_t *p_hash, size_t hash_length, uint8_t *p_signature, size_t signature_size, size_t *p_signature_length)
A function that signs a hash or short message with a private key in a secure element.
psa_status_t(* psa_drv_se_asymmetric_verify_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t alg, const uint8_t *p_hash, size_t hash_length, const uint8_t *p_signature, size_t signature_length)
A function that verifies the signature a hash or short message using an asymmetric public key in a se...
psa_status_t(* psa_drv_se_cipher_finish_t)(void *op_context, uint8_t *p_output, size_t output_size, size_t *p_output_length)
A function that completes a previously started secure element cipher operation.
psa_status_t(* psa_drv_se_cipher_abort_t)(void *op_context)
A function that aborts a previously started secure element cipher operation.
psa_status_t(* psa_drv_se_cipher_set_iv_t)(void *op_context, const uint8_t *p_iv, size_t iv_length)
A function that sets the initialization vector (if necessary) for a secure element cipher operation.
psa_status_t(* psa_drv_se_cipher_setup_t)(psa_drv_se_context_t *drv_context, void *op_context, psa_key_slot_number_t key_slot, psa_algorithm_t algorithm, psa_encrypt_or_decrypt_t direction)
A function that provides the cipher setup function for a secure element driver.
psa_status_t(* psa_drv_se_cipher_ecb_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, psa_algorithm_t algorithm, psa_encrypt_or_decrypt_t direction, const uint8_t *p_input, size_t input_size, uint8_t *p_output, size_t output_size)
A function that performs the ECB block mode for secure element cipher operations.
psa_status_t(* psa_drv_se_cipher_update_t)(void *op_context, const uint8_t *p_input, size_t input_size, uint8_t *p_output, size_t output_size, size_t *p_output_length)
A function that continues a previously started secure element cipher operation.
psa_status_t(* psa_drv_se_init_t)(psa_drv_se_context_t *drv_context, void *persistent_data, psa_key_location_t location)
A driver initialization function.
uint64_t psa_key_slot_number_t
psa_status_t(* psa_drv_se_validate_slot_number_t)(psa_drv_se_context_t *drv_context, void *persistent_data, const psa_key_attributes_t *attributes, psa_key_creation_method_t method, psa_key_slot_number_t key_slot)
A function that determines whether a slot number is valid for a key.
psa_status_t(* psa_drv_se_generate_key_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, const psa_key_attributes_t *attributes, uint8_t *pubkey, size_t pubkey_size, size_t *pubkey_length)
A function that generates a symmetric or asymmetric key on a secure element.
psa_status_t(* psa_drv_se_export_key_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key, uint8_t *p_data, size_t data_size, size_t *p_data_length)
A function that exports a secure element key in binary format.
psa_key_creation_method_t
psa_status_t(* psa_drv_se_import_key_t)(psa_drv_se_context_t *drv_context, psa_key_slot_number_t key_slot, const psa_key_attributes_t *attributes, const uint8_t *data, size_t data_length, size_t *bits)
A function that imports a key into a secure element in binary format.
psa_status_t(* psa_drv_se_allocate_key_t)(psa_drv_se_context_t *drv_context, void *persistent_data, const psa_key_attributes_t *attributes, psa_key_creation_method_t method, psa_key_slot_number_t *key_slot)
A function that allocates a slot for a key.
psa_status_t(* psa_drv_se_destroy_key_t)(psa_drv_se_context_t *drv_context, void *persistent_data, psa_key_slot_number_t key_slot)
A function that destroys a secure element key and restore the slot to its default state.
@ PSA_KEY_CREATION_IMPORT
@ PSA_KEY_CREATION_DERIVE
@ PSA_KEY_CREATION_GENERATE
@ PSA_KEY_CREATION_REGISTER
psa_status_t(* psa_drv_se_mac_setup_t)(psa_drv_se_context_t *drv_context, void *op_context, psa_key_slot_number_t key_slot, psa_algorithm_t algorithm)
A function that starts a secure element MAC operation for a PSA Crypto Driver implementation.
psa_status_t(* psa_drv_se_mac_update_t)(void *op_context, const uint8_t *p_input, size_t input_length)
A function that continues a previously started secure element MAC operation.
psa_status_t(* psa_drv_se_mac_finish_verify_t)(void *op_context, const uint8_t *p_mac, size_t mac_length)
A function that completes a previously started secure element MAC operation by comparing the resultin...
psa_status_t(* psa_drv_se_mac_abort_t)(void *op_context)
A function that aborts a previous started secure element MAC operation.
psa_status_t(* psa_drv_se_mac_verify_t)(psa_drv_se_context_t *drv_context, const uint8_t *p_input, size_t input_length, psa_key_slot_number_t key_slot, psa_algorithm_t alg, const uint8_t *p_mac, size_t mac_length)
A function that performs a secure element MAC operation in one command and compares the resulting MAC...
psa_status_t(* psa_drv_se_mac_finish_t)(void *op_context, uint8_t *p_mac, size_t mac_size, size_t *p_mac_length)
a function that completes a previously started secure element MAC operation by returning the resultin...
psa_status_t(* psa_drv_se_mac_generate_t)(psa_drv_se_context_t *drv_context, const uint8_t *p_input, size_t input_length, psa_key_slot_number_t key_slot, psa_algorithm_t alg, uint8_t *p_mac, size_t mac_size, size_t *p_mac_length)
A function that performs a secure element MAC operation in one command and returns the calculated MAC...
psa_status_t psa_register_se_driver(psa_key_location_t location, const psa_drv_se_t *methods)
A struct containing all of the function pointers needed to implement secure element Authenticated Enc...
psa_drv_se_aead_encrypt_t p_encrypt
psa_drv_se_aead_decrypt_t p_decrypt
A struct containing all of the function pointers needed to implement asymmetric cryptographic operati...
psa_drv_se_asymmetric_verify_t p_verify
psa_drv_se_asymmetric_sign_t p_sign
psa_drv_se_asymmetric_encrypt_t p_encrypt
psa_drv_se_asymmetric_decrypt_t p_decrypt
A struct containing all of the function pointers needed to implement cipher operations using secure e...
psa_drv_se_cipher_setup_t p_setup
psa_drv_se_cipher_finish_t p_finish
psa_drv_se_cipher_set_iv_t p_set_iv
psa_drv_se_cipher_ecb_t p_ecb
psa_drv_se_cipher_abort_t p_abort
psa_drv_se_cipher_update_t p_update
Driver context structure.
const void *const persistent_data
const size_t persistent_data_size
A struct containing all of the function pointers needed to for secure element key derivation and agre...
psa_drv_se_key_derivation_setup_t p_setup
psa_drv_se_key_derivation_collateral_t p_collateral
psa_drv_se_key_derivation_export_t p_export
psa_drv_se_key_derivation_derive_t p_derive
A struct containing all of the function pointers needed to for secure element key management.
psa_drv_se_export_key_t p_export
psa_drv_se_validate_slot_number_t p_validate_slot_number
psa_drv_se_import_key_t p_import
psa_drv_se_destroy_key_t p_destroy
psa_drv_se_generate_key_t p_generate
psa_drv_se_allocate_key_t p_allocate
psa_drv_se_export_key_t p_export_public
A struct containing all of the function pointers needed to perform secure element MAC operations.
psa_drv_se_mac_setup_t p_setup
psa_drv_se_mac_update_t p_update
psa_drv_se_mac_verify_t p_mac_verify
psa_drv_se_mac_finish_t p_finish
psa_drv_se_mac_abort_t p_abort
psa_drv_se_mac_finish_verify_t p_finish_verify
psa_drv_se_mac_generate_t p_mac
size_t persistent_data_size
const psa_drv_se_key_management_t * key_management
const psa_drv_se_aead_t * aead
const psa_drv_se_cipher_t * cipher
const psa_drv_se_asymmetric_t * asymmetric
const psa_drv_se_mac_t * mac
const psa_drv_se_key_derivation_t * derivation