13#if defined(MBEDTLS_PSA_CRYPTO_PLATFORM_FILE)
14#include MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
21#ifdef __DOXYGEN_ONLY__
49#define PSA_CRYPTO_API_VERSION_MAJOR 1
54#define PSA_CRYPTO_API_VERSION_MINOR 2
68#if defined(MBEDTLS_PSA_CRYPTO_STRUCT_FILE)
69#include MBEDTLS_PSA_CRYPTO_STRUCT_FILE
151#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
167 mbedtls_key_owner_id_t owner);
755 size_t *data_length);
830 size_t *data_length);
872 const uint8_t *input,
876 size_t *hash_length);
907 const uint8_t *input,
1027 const uint8_t *input,
1028 size_t input_length);
1075 size_t *hash_length);
1114 const uint8_t *hash,
1115 size_t hash_length);
1290 const uint8_t *context,
size_t context_length);
1318 const uint8_t *input,
size_t input_length);
1344 uint8_t *output,
size_t output_length);
1413 const uint8_t *input,
1414 size_t input_length,
1417 size_t *mac_length);
1454 const uint8_t *input,
1455 size_t input_length,
1651 const uint8_t *input,
1652 size_t input_length);
1702 size_t *mac_length);
1820 const uint8_t *input,
1821 size_t input_length,
1824 size_t *output_length);
1867 const uint8_t *input,
1868 size_t input_length,
1871 size_t *output_length);
2156 const uint8_t *input,
2157 size_t input_length,
2160 size_t *output_length);
2210 size_t *output_length);
2308 const uint8_t *nonce,
2309 size_t nonce_length,
2310 const uint8_t *additional_data,
2311 size_t additional_data_length,
2312 const uint8_t *plaintext,
2313 size_t plaintext_length,
2314 uint8_t *ciphertext,
2315 size_t ciphertext_size,
2316 size_t *ciphertext_length);
2381 const uint8_t *nonce,
2382 size_t nonce_length,
2383 const uint8_t *additional_data,
2384 size_t additional_data_length,
2385 const uint8_t *ciphertext,
2386 size_t ciphertext_length,
2388 size_t plaintext_size,
2389 size_t *plaintext_length);
2605 size_t *nonce_length);
2643 const uint8_t *nonce,
2644 size_t nonce_length);
2689 size_t plaintext_length);
2736 const uint8_t *input,
2737 size_t input_length);
2820 const uint8_t *input,
2821 size_t input_length,
2824 size_t *output_length);
2906 uint8_t *ciphertext,
2907 size_t ciphertext_size,
2908 size_t *ciphertext_length,
2911 size_t *tag_length);
2990 size_t plaintext_size,
2991 size_t *plaintext_length,
3088 const uint8_t *input,
3089 size_t input_length,
3091 size_t signature_size,
3092 size_t *signature_length);
3140 const uint8_t *input,
3141 size_t input_length,
3142 const uint8_t *signature,
3143 size_t signature_length);
3193 const uint8_t *hash,
3196 size_t signature_size,
3197 size_t *signature_length);
3244 const uint8_t *hash,
3246 const uint8_t *signature,
3247 size_t signature_length);
3302 const uint8_t *input,
3303 size_t input_length,
3304 const uint8_t *salt,
3308 size_t *output_length);
3363 const uint8_t *input,
3364 size_t input_length,
3365 const uint8_t *salt,
3369 size_t *output_length);
3539#define PSA_KEY_DERIVATION_UNLIMITED_CAPACITY ((size_t) (-1))
3584 const uint8_t *data,
3585 size_t data_length);
3764 const uint8_t *peer_key,
3765 size_t peer_key_length);
3810 size_t output_length);
4030 const uint8_t *custom_data,
4031 size_t custom_data_length,
4089 const uint8_t *expected,
4090 size_t expected_length);
4234 const uint8_t *peer_key,
4235 size_t peer_key_length,
4238 size_t *output_length);
4318 const uint8_t *peer_key,
4319 size_t peer_key_length,
4354 size_t output_size);
4459 const uint8_t *custom_data,
4460 size_t custom_data_length,
4759 const uint8_t *hash,
size_t hash_length);
4851 uint8_t *signature,
size_t signature_size,
4852 size_t *signature_length);
4971 const uint8_t *hash,
size_t hash_length,
4972 const uint8_t *signature,
size_t signature_length);
5316 const uint8_t *peer_key,
5317 size_t peer_key_length,
5948 size_t *data_length);
PSA cryptography module: Mbed TLS buffer size macros.
PSA cryptography module: Mbed TLS structured type implementations.
PSA cryptography module: type aliases.
PSA cryptography module: macros to build and analyze integer values.
psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg)
psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg)
static psa_mac_operation_t psa_mac_operation_init(void)
psa_status_t psa_mac_update(psa_mac_operation_t *operation, const uint8_t *input, size_t input_length)
struct psa_mac_operation_s psa_mac_operation_t
psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, uint8_t *mac, size_t mac_size, size_t *mac_length)
psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation, uint8_t *mac, size_t mac_size, size_t *mac_length)
psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation, const uint8_t *mac, size_t mac_length)
psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *mac, size_t mac_length)
psa_status_t psa_xof_set_context(psa_xof_operation_t *operation, const uint8_t *context, size_t context_length)
psa_status_t psa_xof_update(psa_xof_operation_t *operation, const uint8_t *input, size_t input_length)
static psa_xof_operation_t psa_xof_operation_init(void)
psa_status_t psa_xof_abort(psa_xof_operation_t *operation)
struct psa_xof_operation_s psa_xof_operation_t
psa_status_t psa_xof_output(psa_xof_operation_t *operation, uint8_t *output, size_t output_length)
psa_status_t psa_xof_setup(psa_xof_operation_t *operation, psa_algorithm_t alg)
struct psa_aead_operation_s psa_aead_operation_t
psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg)
static psa_aead_operation_t psa_aead_operation_init(void)
psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation, uint8_t *nonce, size_t nonce_size, size_t *nonce_length)
psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation, const uint8_t *nonce, size_t nonce_length)
psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation, const uint8_t *input, size_t input_length)
psa_status_t psa_aead_finish(psa_aead_operation_t *operation, uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length, uint8_t *tag, size_t tag_size, size_t *tag_length)
psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg)
psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation, size_t ad_length, size_t plaintext_length)
psa_status_t psa_aead_verify(psa_aead_operation_t *operation, uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length, const uint8_t *tag, size_t tag_length)
psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *nonce, size_t nonce_length, const uint8_t *additional_data, size_t additional_data_length, const uint8_t *plaintext, size_t plaintext_length, uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length)
psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *nonce, size_t nonce_length, const uint8_t *additional_data, size_t additional_data_length, const uint8_t *ciphertext, size_t ciphertext_length, uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length)
psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
psa_status_t psa_aead_update(psa_aead_operation_t *operation, const uint8_t *input, size_t input_length, uint8_t *output, size_t output_size, size_t *output_length)
psa_status_t psa_verify_message(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *signature, size_t signature_length)
Verify the signature of a message with a public key, using a hash-and-sign verification algorithm.
psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *salt, size_t salt_length, uint8_t *output, size_t output_size, size_t *output_length)
Decrypt a short message with a private key.
psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *hash, size_t hash_length, uint8_t *signature, size_t signature_size, size_t *signature_length)
Sign a hash or short message with a private key.
psa_status_t psa_sign_message(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, uint8_t *signature, size_t signature_size, size_t *signature_length)
Sign a message with a private key. For hash-and-sign algorithms, this includes the hashing step.
psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *salt, size_t salt_length, uint8_t *output, size_t output_size, size_t *output_length)
Encrypt a short message with a public key.
psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *hash, size_t hash_length, const uint8_t *signature, size_t signature_length)
Verify the signature of a hash or short message using a public key.
static psa_key_attributes_t psa_key_attributes_init(void)
struct psa_key_attributes_s psa_key_attributes_t
void psa_reset_key_attributes(psa_key_attributes_t *attributes)
static void psa_set_key_usage_flags(psa_key_attributes_t *attributes, psa_key_usage_t usage_flags)
static size_t psa_get_key_bits(const psa_key_attributes_t *attributes)
static void psa_set_key_type(psa_key_attributes_t *attributes, psa_key_type_t type)
static psa_key_lifetime_t psa_get_key_lifetime(const psa_key_attributes_t *attributes)
static psa_key_usage_t psa_get_key_usage_flags(const psa_key_attributes_t *attributes)
static void psa_set_key_lifetime(psa_key_attributes_t *attributes, psa_key_lifetime_t lifetime)
static psa_algorithm_t psa_get_key_algorithm(const psa_key_attributes_t *attributes)
psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key, psa_key_attributes_t *attributes)
static void psa_set_key_id(psa_key_attributes_t *attributes, mbedtls_svc_key_id_t key)
static psa_key_type_t psa_get_key_type(const psa_key_attributes_t *attributes)
static void psa_set_key_algorithm(psa_key_attributes_t *attributes, psa_algorithm_t alg)
static void psa_set_key_bits(psa_key_attributes_t *attributes, size_t bits)
static mbedtls_svc_key_id_t psa_get_key_id(const psa_key_attributes_t *attributes)
static psa_cipher_operation_t psa_cipher_operation_init(void)
struct psa_cipher_operation_s psa_cipher_operation_t
psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation, uint8_t *output, size_t output_size, size_t *output_length)
psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation, uint8_t *iv, size_t iv_size, size_t *iv_length)
psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg)
psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, uint8_t *output, size_t output_size, size_t *output_length)
psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation, const uint8_t *iv, size_t iv_length)
psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg)
psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *input, size_t input_length, uint8_t *output, size_t output_size, size_t *output_length)
psa_status_t psa_cipher_update(psa_cipher_operation_t *operation, const uint8_t *input, size_t input_length, uint8_t *output, size_t output_size, size_t *output_length)
uint16_t psa_key_type_t
Encoding of a key type.
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
struct psa_custom_key_parameters_s psa_custom_key_parameters_t
Custom parameters for key generation or key derivation.
uint16_t psa_key_derivation_step_t
Encoding of the step of a key derivation.
int32_t psa_status_t
Function return status.
psa_status_t psa_hash_compare(psa_algorithm_t alg, const uint8_t *input, size_t input_length, const uint8_t *hash, size_t hash_length)
psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation, psa_hash_operation_t *target_operation)
struct psa_hash_operation_s psa_hash_operation_t
psa_status_t psa_hash_finish(psa_hash_operation_t *operation, uint8_t *hash, size_t hash_size, size_t *hash_length)
static psa_hash_operation_t psa_hash_operation_init(void)
psa_status_t psa_hash_update(psa_hash_operation_t *operation, const uint8_t *input, size_t input_length)
psa_status_t psa_hash_verify(psa_hash_operation_t *operation, const uint8_t *hash, size_t hash_length)
psa_status_t psa_hash_setup(psa_hash_operation_t *operation, psa_algorithm_t alg)
psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
psa_status_t psa_hash_compute(psa_algorithm_t alg, const uint8_t *input, size_t input_length, uint8_t *hash, size_t hash_size, size_t *hash_length)
psa_status_t psa_import_key(const psa_key_attributes_t *attributes, const uint8_t *data, size_t data_length, mbedtls_svc_key_id_t *key)
Import a key in binary format.
psa_status_t psa_export_key(mbedtls_svc_key_id_t key, uint8_t *data, size_t data_size, size_t *data_length)
Export a key in binary format.
psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key, uint8_t *data, size_t data_size, size_t *data_length)
Export a public key or the public part of a key pair in binary format.
psa_status_t psa_crypto_init(void)
Library initialization.
uint32_t psa_export_public_key_iop_get_num_ops(psa_export_public_key_iop_t *operation)
Get the number of ops that an export public-key operation has taken so far. If the operation has comp...
struct psa_export_public_key_iop_s psa_export_public_key_iop_t
psa_status_t psa_export_public_key_iop_abort(psa_export_public_key_iop_t *operation)
Abort an interruptible public-key export operation.
psa_status_t psa_export_public_key_iop_setup(psa_export_public_key_iop_t *operation, mbedtls_svc_key_id_t key)
Start an interruptible operation to export a public key or the public part of a key pair in binary fo...
psa_status_t psa_export_public_key_iop_complete(psa_export_public_key_iop_t *operation, uint8_t *data, size_t data_size, size_t *data_length)
Continue and eventually complete the action of exporting a public key, in an interruptible manner.
struct psa_generate_key_iop_s psa_generate_key_iop_t
psa_status_t psa_generate_key_iop_complete(psa_generate_key_iop_t *operation, mbedtls_svc_key_id_t *key)
Continue and eventually complete the action of key generation, in an interruptible manner.
psa_status_t psa_generate_key_iop_abort(psa_generate_key_iop_t *operation)
Abort a key generation operation.
psa_status_t psa_generate_key_iop_setup(psa_generate_key_iop_t *operation, const psa_key_attributes_t *attributes)
Start a key generation operation, in an interruptible manner.
uint32_t psa_generate_key_iop_get_num_ops(psa_generate_key_iop_t *operation)
Get the number of ops that a key generation operation has taken so far. If the operation has complete...
uint32_t psa_verify_hash_get_num_ops(const psa_verify_hash_interruptible_operation_t *operation)
Get the number of ops that a hash verification operation has taken so far. If the operation has compl...
psa_status_t psa_verify_hash_abort(psa_verify_hash_interruptible_operation_t *operation)
Abort a verify hash operation.
uint32_t psa_sign_hash_get_num_ops(const psa_sign_hash_interruptible_operation_t *operation)
Get the number of ops that a hash signing operation has taken so far. If the operation has completed,...
psa_status_t psa_sign_hash_start(psa_sign_hash_interruptible_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *hash, size_t hash_length)
Start signing a hash or short message with a private key, in an interruptible manner.
struct psa_verify_hash_interruptible_operation_s psa_verify_hash_interruptible_operation_t
psa_status_t psa_verify_hash_complete(psa_verify_hash_interruptible_operation_t *operation)
Continue and eventually complete the action of reading and verifying a hash or short message signed w...
struct psa_sign_hash_interruptible_operation_s psa_sign_hash_interruptible_operation_t
void psa_interruptible_set_max_ops(uint32_t max_ops)
Set the maximum number of ops allowed to be executed by an interruptible function in a single call.
uint32_t psa_interruptible_get_max_ops(void)
Get the maximum number of ops allowed to be executed by an interruptible function in a single call....
psa_status_t psa_sign_hash_complete(psa_sign_hash_interruptible_operation_t *operation, uint8_t *signature, size_t signature_size, size_t *signature_length)
Continue and eventually complete the action of signing a hash or short message with a private key,...
psa_status_t psa_verify_hash_start(psa_verify_hash_interruptible_operation_t *operation, mbedtls_svc_key_id_t key, psa_algorithm_t alg, const uint8_t *hash, size_t hash_length, const uint8_t *signature, size_t signature_length)
Start reading and verifying a hash or short message, in an interruptible manner.
psa_status_t psa_sign_hash_abort(psa_sign_hash_interruptible_operation_t *operation)
Abort a sign hash operation.
psa_status_t psa_key_agreement_iop_complete(psa_key_agreement_iop_t *operation, mbedtls_svc_key_id_t *key)
Start a key agreement operation, in an interruptible manner.
uint32_t psa_key_agreement_iop_get_num_ops(psa_key_agreement_iop_t *operation)
Get the number of ops that a key agreement operation has taken so far. If the operation has completed...
struct psa_key_agreement_iop_s psa_key_agreement_iop_t
psa_status_t psa_key_agreement_iop_abort(psa_key_agreement_iop_t *operation)
Abort a key agreement operation.
psa_status_t psa_key_derivation_output_bytes(psa_key_derivation_operation_t *operation, uint8_t *output, size_t output_length)
psa_status_t psa_key_derivation_output_key_custom(const psa_key_attributes_t *attributes, psa_key_derivation_operation_t *operation, const psa_custom_key_parameters_t *custom, const uint8_t *custom_data, size_t custom_data_length, mbedtls_svc_key_id_t *key)
psa_status_t psa_raw_key_agreement(psa_algorithm_t alg, mbedtls_svc_key_id_t private_key, const uint8_t *peer_key, size_t peer_key_length, uint8_t *output, size_t output_size, size_t *output_length)
psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation, psa_key_derivation_step_t step, mbedtls_svc_key_id_t private_key, const uint8_t *peer_key, size_t peer_key_length)
struct psa_key_derivation_s psa_key_derivation_operation_t
psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation, size_t capacity)
static psa_key_derivation_operation_t psa_key_derivation_operation_init(void)
psa_status_t psa_key_derivation_input_bytes(psa_key_derivation_operation_t *operation, psa_key_derivation_step_t step, const uint8_t *data, size_t data_length)
psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation, size_t *capacity)
psa_status_t psa_key_derivation_input_key(psa_key_derivation_operation_t *operation, psa_key_derivation_step_t step, mbedtls_svc_key_id_t key)
psa_status_t psa_key_derivation_verify_key(psa_key_derivation_operation_t *operation, psa_key_id_t expected)
psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation, psa_algorithm_t alg)
psa_status_t psa_key_derivation_input_integer(psa_key_derivation_operation_t *operation, psa_key_derivation_step_t step, uint64_t value)
psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes, psa_key_derivation_operation_t *operation, mbedtls_svc_key_id_t *key)
psa_status_t psa_key_derivation_verify_bytes(psa_key_derivation_operation_t *operation, const uint8_t *expected, size_t expected_length)
psa_status_t psa_key_agreement(mbedtls_svc_key_id_t private_key, const uint8_t *peer_key, size_t peer_key_length, psa_algorithm_t alg, const psa_key_attributes_t *attributes, mbedtls_svc_key_id_t *key)
uint32_t psa_key_lifetime_t
psa_key_id_t mbedtls_svc_key_id_t
psa_status_t psa_purge_key(mbedtls_svc_key_id_t key)
psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Destroy a key.
psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key, const psa_key_attributes_t *attributes, mbedtls_svc_key_id_t *target_key)
uint32_t psa_key_usage_t
Encoding of permitted usage on a key.
psa_status_t psa_generate_random(uint8_t *output, size_t output_size)
Generate random bytes.
psa_status_t psa_generate_key(const psa_key_attributes_t *attributes, mbedtls_svc_key_id_t *key)
Generate a key or key pair.
psa_status_t psa_generate_key_custom(const psa_key_attributes_t *attributes, const psa_custom_key_parameters_t *custom, const uint8_t *custom_data, size_t custom_data_length, mbedtls_svc_key_id_t *key)
Generate a key or key pair using custom production parameters.
The context for PSA interruptible export public-key.
The context for PSA interruptible key generation.
The context for PSA interruptible key agreement.
The context for PSA interruptible hash signing.
The context for PSA interruptible hash verification.