16#ifndef PSA_CRYPTO_EXTRA_H
17#define PSA_CRYPTO_EXTRA_H
18#include "mbedtls/private_access.h"
29#define PSA_CRYPTO_ITS_RANDOM_SEED_UID 0xFFFFFF52
32#if !defined(MBEDTLS_PSA_KEY_SLOT_COUNT)
33#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
39#if !defined(MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE)
41#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 1
43#if PSA_EXPORT_ASYMMETRIC_KEY_MAX_SIZE > MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
44#undef MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
45#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE PSA_EXPORT_ASYMMETRIC_KEY_MAX_SIZE
49#if PSA_CIPHER_MAX_KEY_LENGTH > MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
50#undef MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
51#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE PSA_CIPHER_MAX_KEY_LENGTH
56#if defined(PSA_WANT_ALG_HMAC)
57#if PSA_HASH_MAX_SIZE > MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
58#undef MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
59#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE PSA_HASH_MAX_SIZE
92 attributes->MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg2) = alg2;
104 return attributes->MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg2);
129 size_t MBEDTLS_PRIVATE(volatile_slots);
132 size_t MBEDTLS_PRIVATE(persistent_slots);
135 size_t MBEDTLS_PRIVATE(external_slots);
138 size_t MBEDTLS_PRIVATE(half_filled_slots);
140 size_t MBEDTLS_PRIVATE(cache_slots);
142 size_t MBEDTLS_PRIVATE(empty_slots);
144 size_t MBEDTLS_PRIVATE(locked_slots);
171#define PSA_KEY_TYPE_DSA_PUBLIC_KEY ((psa_key_type_t) 0x4002)
189#define PSA_KEY_TYPE_DSA_KEY_PAIR ((psa_key_type_t) 0x7002)
192#define PSA_KEY_TYPE_IS_DSA(type) \
193 (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_DSA_PUBLIC_KEY)
195#define PSA_ALG_DSA_BASE ((psa_algorithm_t) 0x06000400)
210#define PSA_ALG_DSA(hash_alg) \
211 (PSA_ALG_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
212#define PSA_ALG_DETERMINISTIC_DSA_BASE ((psa_algorithm_t) 0x06000500)
213#define PSA_ALG_DSA_DETERMINISTIC_FLAG PSA_ALG_ECDSA_DETERMINISTIC_FLAG
228#define PSA_ALG_DETERMINISTIC_DSA(hash_alg) \
229 (PSA_ALG_DETERMINISTIC_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
230#define PSA_ALG_IS_DSA(alg) \
231 (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_DSA_DETERMINISTIC_FLAG) == \
233#define PSA_ALG_DSA_IS_DETERMINISTIC(alg) \
234 (((alg) & PSA_ALG_DSA_DETERMINISTIC_FLAG) != 0)
235#define PSA_ALG_IS_DETERMINISTIC_DSA(alg) \
236 (PSA_ALG_IS_DSA(alg) && PSA_ALG_DSA_IS_DETERMINISTIC(alg))
237#define PSA_ALG_IS_RANDOMIZED_DSA(alg) \
238 (PSA_ALG_IS_DSA(alg) && !PSA_ALG_DSA_IS_DETERMINISTIC(alg))
243#undef PSA_ALG_IS_VENDOR_HASH_AND_SIGN
244#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg) \
254#define PSA_PAKE_OPERATION_STAGE_SETUP 0
255#define PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS 1
256#define PSA_PAKE_OPERATION_STAGE_COMPUTATION 2
265#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
306 mbedtls_psa_external_random_context_t *context,
307 uint8_t *output,
size_t output_size,
size_t *output_length);
476#define MBEDTLS_PSA_KEY_ID_BUILTIN_MIN ((psa_key_id_t) 0x7fff0000)
483#define MBEDTLS_PSA_KEY_ID_BUILTIN_MAX ((psa_key_id_t) 0x7fffefff)
506#if defined(MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS)
577#define PSA_ALG_CATEGORY_PAKE ((psa_algorithm_t) 0x0a000000)
588#define PSA_ALG_IS_PAKE(alg) \
589 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_PAKE)
591#define PSA_ALG_JPAKE_BASE ((psa_algorithm_t) 0x0a000100)
718#define PSA_ALG_JPAKE(hash_alg) \
719 (PSA_ALG_JPAKE_BASE | ((hash_alg) & (PSA_ALG_HASH_MASK)))
730#define PSA_ALG_IS_JPAKE(alg) \
731 (((alg) & (~(PSA_ALG_HASH_MASK))) == PSA_ALG_JPAKE_BASE)
733#define PSA_KEY_TYPE_SPAKE2P_PUBLIC_KEY_BASE ((psa_key_type_t) 0x4400)
734#define PSA_KEY_TYPE_SPAKE2P_KEY_PAIR_BASE ((psa_key_type_t) 0x7400)
740#define PSA_KEY_TYPE_SPAKE2P_KEY_PAIR(curve) \
741 (PSA_KEY_TYPE_SPAKE2P_KEY_PAIR_BASE | (curve))
747#define PSA_KEY_TYPE_SPAKE2P_PUBLIC_KEY(curve) \
748 (PSA_KEY_TYPE_SPAKE2P_PUBLIC_KEY_BASE | (curve))
751#define PSA_KEY_TYPE_IS_SPAKE2P_KEY_PAIR(type) \
752 (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
753 PSA_KEY_TYPE_SPAKE2P_KEY_PAIR_BASE)
756#define PSA_KEY_TYPE_IS_SPAKE2P_PUBLIC_KEY(type) \
757 (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
758 PSA_KEY_TYPE_SPAKE2P_PUBLIC_KEY_BASE)
761#define PSA_KEY_TYPE_IS_SPAKE2P(type) \
762 ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
763 ~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_SPAKE2P_PUBLIC_KEY_BASE)
765#define PSA_ALG_SPAKE2P_HMAC_BASE ((psa_algorithm_t) 0x0a000400)
771#define PSA_ALG_SPAKE2P_HMAC(hash_alg) \
772 (PSA_ALG_SPAKE2P_HMAC_BASE | ((hash_alg) & (PSA_ALG_HASH_MASK)))
773#define PSA_ALG_IS_SPAKE2P_HMAC(alg) \
774 (((alg) & (~(PSA_ALG_HASH_MASK))) == PSA_ALG_SPAKE2P_HMAC_BASE)
780#define PSA_ALG_SPAKE2P_CMAC_BASE ((psa_algorithm_t) 0x0a000500)
781#define PSA_ALG_SPAKE2P_CMAC(hash_alg) \
782 (PSA_ALG_SPAKE2P_CMAC_BASE | ((hash_alg) & (PSA_ALG_HASH_MASK)))
783#define PSA_ALG_IS_SPAKE2P_CMAC(alg) \
784 (((alg) & (~(PSA_ALG_HASH_MASK))) == PSA_ALG_SPAKE2P_CMAC_BASE)
790#define PSA_ALG_SPAKE2P_MATTER ((psa_algorithm_t) 0x0a000609)
802#define PSA_ALG_IS_SPAKE2P(alg) \
803 (PSA_ALG_IS_SPAKE2P_HMAC(alg) || \
804 PSA_ALG_IS_SPAKE2P_CMAC(alg) || \
805 (alg) == PSA_ALG_SPAKE2P_MATTER)
864#define PSA_PAKE_ROLE_NONE ((psa_pake_role_t) 0x00)
873#define PSA_PAKE_ROLE_FIRST ((psa_pake_role_t) 0x01)
882#define PSA_PAKE_ROLE_SECOND ((psa_pake_role_t) 0x02)
888#define PSA_PAKE_ROLE_CLIENT ((psa_pake_role_t) 0x11)
894#define PSA_PAKE_ROLE_SERVER ((psa_pake_role_t) 0x12)
914#define PSA_PAKE_PRIMITIVE_TYPE_ECC ((psa_pake_primitive_type_t) 0x01)
934#define PSA_PAKE_PRIMITIVE_TYPE_DH ((psa_pake_primitive_type_t) 0x02)
955#define PSA_PAKE_PRIMITIVE(pake_type, pake_family, pake_bits) \
956 (((pake_bits & 0xFFFF) != pake_bits) ? 0 : \
957 ((psa_pake_primitive_t) (((pake_type) << 24 | \
958 (pake_family) << 16) | (pake_bits))))
972#define PSA_PAKE_STEP_KEY_SHARE ((psa_pake_step_t) 0x01)
989#define PSA_PAKE_STEP_ZK_PUBLIC ((psa_pake_step_t) 0x02)
1010#define PSA_PAKE_STEP_ZK_PROOF ((psa_pake_step_t) 0x03)
1020#define PSA_PAKE_STEP_CONFIRM ((psa_pake_step_t) 0x04)
1044#define PSA_PAKE_OUTPUT_SIZE(alg, primitive, output_step) \
1045 (PSA_ALG_IS_JPAKE(alg) && \
1046 primitive == PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC, \
1047 PSA_ECC_FAMILY_SECP_R1, 256) ? \
1049 output_step == PSA_PAKE_STEP_KEY_SHARE ? 65 : \
1050 output_step == PSA_PAKE_STEP_ZK_PUBLIC ? 65 : \
1074#define PSA_PAKE_INPUT_SIZE(alg, primitive, input_step) \
1075 (PSA_ALG_IS_JPAKE(alg) && \
1076 primitive == PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC, \
1077 PSA_ECC_FAMILY_SECP_R1, 256) ? \
1079 input_step == PSA_PAKE_STEP_KEY_SHARE ? 65 : \
1080 input_step == PSA_PAKE_STEP_ZK_PUBLIC ? 65 : \
1095#define PSA_PAKE_OUTPUT_MAX_SIZE 65
1107#define PSA_PAKE_INPUT_MAX_SIZE 65
1112#define PSA_PAKE_CIPHER_SUITE_INIT { PSA_ALG_NONE, 0, 0, 0, 0 }
1117#if defined(MBEDTLS_PSA_CRYPTO_CLIENT) && !defined(MBEDTLS_PSA_CRYPTO_C)
1118#define PSA_PAKE_OPERATION_INIT { 0 }
1120#define PSA_PAKE_OPERATION_INIT { 0, PSA_ALG_NONE, 0, PSA_PAKE_OPERATION_STAGE_SETUP, \
1133#define PSA_PAKE_CONFIRMED_KEY 0
1147#define PSA_PAKE_UNCONFIRMED_KEY 1
1158 uint8_t *MBEDTLS_PRIVATE(password);
1159 size_t MBEDTLS_PRIVATE(password_len);
1160 uint8_t *MBEDTLS_PRIVATE(user);
1161 size_t MBEDTLS_PRIVATE(user_len);
1162 uint8_t *MBEDTLS_PRIVATE(peer);
1163 size_t MBEDTLS_PRIVATE(peer_len);
1201 uint8_t MBEDTLS_PRIVATE(inputs);
1203 uint8_t MBEDTLS_PRIVATE(outputs);
1208#define PSA_JPAKE_EXPECTED_INPUTS(round) ((round) == PSA_JPAKE_FINISHED ? 0 : \
1209 ((round) == PSA_JPAKE_FIRST ? 2 : 1))
1210#define PSA_JPAKE_EXPECTED_OUTPUTS(round) ((round) == PSA_JPAKE_FINISHED ? 0 : \
1211 ((round) == PSA_JPAKE_FIRST ? 2 : 1))
1214#if defined(MBEDTLS_PSA_CRYPTO_CLIENT) && !defined(MBEDTLS_PSA_CRYPTO_C)
1215 mbedtls_psa_client_handle_t handle;
1223 unsigned int MBEDTLS_PRIVATE(
id);
1230 uint8_t MBEDTLS_PRIVATE(stage);
1233 uint8_t MBEDTLS_PRIVATE(dummy);
1234#if defined(PSA_WANT_ALG_JPAKE)
1237 } MBEDTLS_PRIVATE(computation_stage);
1241 } MBEDTLS_PRIVATE(data);
1405 size_t *password_len);
1421 uint8_t *buffer,
size_t buffer_size,
size_t *buffer_length);
1467 uint8_t *user_id,
size_t user_id_size,
size_t *user_id_len);
1485 uint8_t *peer_id,
size_t peer_id_size,
size_t *peer_id_length);
1645 const uint8_t *user_id,
1646 size_t user_id_len);
1691 const uint8_t *peer_id,
1692 size_t peer_id_len);
1767 const uint8_t *context,
1768 size_t context_len);
1829 size_t *output_length);
1882 const uint8_t *input,
1883 size_t input_length);
2063 cipher_suite->
bits);
2072 cipher_suite->
bits = (uint16_t) (0xFFFF & primitive);
2078 return cipher_suite->
family;
2084 return cipher_suite->
bits;
2094 uint32_t key_confirmation)
PSA cryptography module: Backward compatibility aliases.
PSA cryptography module: type aliases.
PSA cryptography module: macros to build and analyze integer values.
struct psa_key_attributes_s psa_key_attributes_t
static psa_algorithm_t psa_get_key_enrollment_algorithm(const psa_key_attributes_t *attributes)
static void psa_set_key_enrollment_algorithm(psa_key_attributes_t *attributes, psa_algorithm_t alg2)
Declare the enrollment algorithm for a key.
#define PSA_ALG_IS_PAKE(alg)
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
int32_t psa_status_t
Function return status.
uint32_t psa_key_lifetime_t
psa_key_id_t mbedtls_svc_key_id_t
static uint16_t psa_pake_cs_get_bits(const psa_pake_cipher_suite_t *cipher_suite)
static psa_pake_primitive_t psa_pake_cs_get_primitive(const psa_pake_cipher_suite_t *cipher_suite)
struct psa_pake_cipher_suite_s psa_pake_cipher_suite_t
psa_status_t psa_pake_abort(psa_pake_operation_t *operation)
psa_status_t psa_crypto_driver_pake_get_password(const psa_crypto_driver_pake_inputs_t *inputs, uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
struct psa_pake_operation_s psa_pake_operation_t
psa_status_t psa_pake_input(psa_pake_operation_t *operation, psa_pake_step_t step, const uint8_t *input, size_t input_length)
uint32_t psa_pake_primitive_t
Encoding of the primitive associated with the PAKE.
psa_status_t psa_pake_output(psa_pake_operation_t *operation, psa_pake_step_t step, uint8_t *output, size_t output_size, size_t *output_length)
psa_status_t psa_pake_set_user(psa_pake_operation_t *operation, const uint8_t *user_id, size_t user_id_len)
static void psa_pake_cs_set_primitive(psa_pake_cipher_suite_t *cipher_suite, psa_pake_primitive_t primitive)
static psa_pake_cipher_suite_t psa_pake_cipher_suite_init(void)
psa_status_t psa_pake_setup(psa_pake_operation_t *operation, mbedtls_svc_key_id_t password_key, const psa_pake_cipher_suite_t *cipher_suite)
psa_status_t psa_crypto_driver_pake_get_password_len(const psa_crypto_driver_pake_inputs_t *inputs, size_t *password_len)
struct psa_crypto_driver_pake_inputs_s psa_crypto_driver_pake_inputs_t
static void psa_pake_cs_set_algorithm(psa_pake_cipher_suite_t *cipher_suite, psa_algorithm_t algorithm)
uint8_t psa_pake_role_t
Encoding of the application role of PAKE.
static psa_pake_family_t psa_pake_cs_get_family(const psa_pake_cipher_suite_t *cipher_suite)
psa_status_t psa_pake_set_peer(psa_pake_operation_t *operation, const uint8_t *peer_id, size_t peer_id_len)
static psa_pake_operation_t psa_pake_operation_init(void)
psa_status_t psa_crypto_driver_pake_get_peer(const psa_crypto_driver_pake_inputs_t *inputs, uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
uint8_t psa_pake_primitive_type_t
static void psa_pake_cs_set_key_confirmation(psa_pake_cipher_suite_t *cipher_suite, uint32_t key_confirmation)
struct psa_jpake_computation_stage_s psa_jpake_computation_stage_t
psa_status_t psa_crypto_driver_pake_get_peer_len(const psa_crypto_driver_pake_inputs_t *inputs, size_t *peer_len)
psa_status_t psa_crypto_driver_pake_get_user_len(const psa_crypto_driver_pake_inputs_t *inputs, size_t *user_len)
uint8_t psa_pake_family_t
Encoding of the family of the primitive associated with the PAKE.
psa_status_t psa_crypto_driver_pake_get_user(const psa_crypto_driver_pake_inputs_t *inputs, uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
psa_status_t psa_pake_get_shared_key(psa_pake_operation_t *operation, const psa_key_attributes_t *attributes, mbedtls_svc_key_id_t *key)
static psa_algorithm_t psa_pake_cs_get_algorithm(const psa_pake_cipher_suite_t *cipher_suite)
#define PSA_PAKE_PRIMITIVE(pake_type, pake_family, pake_bits)
psa_status_t psa_pake_set_role(psa_pake_operation_t *operation, psa_pake_role_t role)
static uint32_t psa_pake_cs_get_key_confirmation(const psa_pake_cipher_suite_t *cipher_suite)
psa_status_t psa_crypto_driver_pake_get_cipher_suite(const psa_crypto_driver_pake_inputs_t *inputs, psa_pake_cipher_suite_t *cipher_suite)
psa_status_t psa_pake_set_context(psa_pake_operation_t *operation, const uint8_t *context, size_t context_len)
#define MBEDTLS_PSA_KEY_ID_BUILTIN_MAX
uint64_t psa_drv_slot_number_t
#define MBEDTLS_PSA_KEY_ID_BUILTIN_MIN
static int psa_key_id_is_builtin(psa_key_id_t key_id)
psa_status_t psa_random_set_prediction_resistance(unsigned enabled)
psa_status_t psa_random_reseed(const uint8_t *perso, size_t perso_size)
psa_status_t psa_random_deplete(void)
Statistics about resource consumption related to the PSA keystore.
psa_algorithm_t algorithm
psa_pake_primitive_type_t type
uint32_t key_confirmation