Mbed TLS v2.28.10
crypto_extra.h
Go to the documentation of this file.
1 
11 /*
12  * Copyright The Mbed TLS Contributors
13  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
14  */
15 
16 #ifndef PSA_CRYPTO_EXTRA_H
17 #define PSA_CRYPTO_EXTRA_H
18 
19 #include "mbedtls/platform_util.h"
20 
21 #include "crypto_types.h"
22 #include "crypto_compat.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* UID for secure storage seed */
29 #define PSA_CRYPTO_ITS_RANDOM_SEED_UID 0xFFFFFF52
30 
31 /* See config.h for definition */
32 #if !defined(MBEDTLS_PSA_KEY_SLOT_COUNT)
33 #define MBEDTLS_PSA_KEY_SLOT_COUNT 32
34 #endif
35 
60  psa_key_attributes_t *attributes,
61  psa_algorithm_t alg2)
62 {
63  attributes->core.policy.alg2 = alg2;
64 }
65 
73  const psa_key_attributes_t *attributes)
74 {
75  return attributes->core.policy.alg2;
76 }
77 
78 #if defined(MBEDTLS_PSA_CRYPTO_SE_C)
79 
102 psa_status_t psa_get_key_slot_number(
103  const psa_key_attributes_t *attributes,
104  psa_key_slot_number_t *slot_number);
105 
129 static inline void psa_set_key_slot_number(
130  psa_key_attributes_t *attributes,
131  psa_key_slot_number_t slot_number)
132 {
134  attributes->slot_number = slot_number;
135 }
136 
143 static inline void psa_clear_key_slot_number(
144  psa_key_attributes_t *attributes)
145 {
147 }
148 
197 psa_status_t mbedtls_psa_register_se_key(
198  const psa_key_attributes_t *attributes);
199 
200 #endif /* MBEDTLS_PSA_CRYPTO_SE_C */
201 
212 void mbedtls_psa_crypto_free(void);
213 
220 typedef struct mbedtls_psa_stats_s {
233  size_t cache_slots;
235  size_t empty_slots;
237  size_t locked_slots;
243 
252 
320 psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
321  size_t seed_size);
322 
334 #define PSA_KEY_TYPE_DSA_PUBLIC_KEY ((psa_key_type_t) 0x4002)
335 
352 #define PSA_KEY_TYPE_DSA_KEY_PAIR ((psa_key_type_t) 0x7002)
353 
355 #define PSA_KEY_TYPE_IS_DSA(type) \
356  (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_DSA_PUBLIC_KEY)
357 
358 #define PSA_ALG_DSA_BASE ((psa_algorithm_t) 0x06000400)
359 
373 #define PSA_ALG_DSA(hash_alg) \
374  (PSA_ALG_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
375 #define PSA_ALG_DETERMINISTIC_DSA_BASE ((psa_algorithm_t) 0x06000500)
376 #define PSA_ALG_DSA_DETERMINISTIC_FLAG PSA_ALG_ECDSA_DETERMINISTIC_FLAG
377 
391 #define PSA_ALG_DETERMINISTIC_DSA(hash_alg) \
392  (PSA_ALG_DETERMINISTIC_DSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
393 #define PSA_ALG_IS_DSA(alg) \
394  (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_DSA_DETERMINISTIC_FLAG) == \
395  PSA_ALG_DSA_BASE)
396 #define PSA_ALG_DSA_IS_DETERMINISTIC(alg) \
397  (((alg) & PSA_ALG_DSA_DETERMINISTIC_FLAG) != 0)
398 #define PSA_ALG_IS_DETERMINISTIC_DSA(alg) \
399  (PSA_ALG_IS_DSA(alg) && PSA_ALG_DSA_IS_DETERMINISTIC(alg))
400 #define PSA_ALG_IS_RANDOMIZED_DSA(alg) \
401  (PSA_ALG_IS_DSA(alg) && !PSA_ALG_DSA_IS_DETERMINISTIC(alg))
402 
403 
404 /* We need to expand the sample definition of this macro from
405  * the API definition. */
406 #undef PSA_ALG_IS_VENDOR_HASH_AND_SIGN
407 #define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg) \
408  PSA_ALG_IS_DSA(alg)
409 
422 #define PSA_DH_FAMILY_CUSTOM ((psa_dh_family_t) 0x7e)
423 
424 
492  psa_key_type_t type,
493  const uint8_t *data,
494  size_t data_length);
495 
520  const psa_key_attributes_t *attributes,
521  uint8_t *data,
522  size_t data_size,
523  size_t *data_length);
524 
550 #define PSA_KEY_DOMAIN_PARAMETERS_SIZE(key_type, key_bits) \
551  (PSA_KEY_TYPE_IS_RSA(key_type) ? sizeof(int) : \
552  PSA_KEY_TYPE_IS_DH(key_type) ? PSA_DH_KEY_DOMAIN_PARAMETERS_SIZE(key_bits) : \
553  PSA_KEY_TYPE_IS_DSA(key_type) ? PSA_DSA_KEY_DOMAIN_PARAMETERS_SIZE(key_bits) : \
554  0)
555 #define PSA_DH_KEY_DOMAIN_PARAMETERS_SIZE(key_bits) \
556  (4 + (PSA_BITS_TO_BYTES(key_bits) + 5) * 3 /*without optional parts*/)
557 #define PSA_DSA_KEY_DOMAIN_PARAMETERS_SIZE(key_bits) \
558  (4 + (PSA_BITS_TO_BYTES(key_bits) + 5) * 2 /*p, g*/ + 34 /*q*/)
559 
566 #if defined(MBEDTLS_ECP_C)
567 #include <mbedtls/ecp.h>
568 
583  size_t *bits)
584 {
585  switch (grpid) {
587  *bits = 192;
588  return PSA_ECC_FAMILY_SECP_R1;
590  *bits = 224;
591  return PSA_ECC_FAMILY_SECP_R1;
593  *bits = 256;
594  return PSA_ECC_FAMILY_SECP_R1;
596  *bits = 384;
597  return PSA_ECC_FAMILY_SECP_R1;
599  *bits = 521;
600  return PSA_ECC_FAMILY_SECP_R1;
602  *bits = 256;
605  *bits = 384;
608  *bits = 512;
611  *bits = 255;
614  *bits = 192;
615  return PSA_ECC_FAMILY_SECP_K1;
617  *bits = 224;
618  return PSA_ECC_FAMILY_SECP_K1;
620  *bits = 256;
621  return PSA_ECC_FAMILY_SECP_K1;
623  *bits = 448;
625  default:
626  *bits = 0;
627  return 0;
628  }
629 }
630 
651  size_t bits,
652  int bits_is_sloppy);
653 #endif /* MBEDTLS_ECP_C */
654 
661 #if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
662 
701 psa_status_t mbedtls_psa_external_get_random(
702  mbedtls_psa_external_random_context_t *context,
703  uint8_t *output, size_t output_size, size_t *output_length);
704 #endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
705 
723 #define MBEDTLS_PSA_KEY_ID_BUILTIN_MIN ((psa_key_id_t) 0x7fff0000)
724 
730 #define MBEDTLS_PSA_KEY_ID_BUILTIN_MAX ((psa_key_id_t) 0x7fffefff)
731 
736 typedef uint64_t psa_drv_slot_number_t;
737 
738 #if defined(MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS)
739 
748 static inline int psa_key_id_is_builtin(psa_key_id_t key_id)
749 {
750  return (key_id >= MBEDTLS_PSA_KEY_ID_BUILTIN_MIN) &&
751  (key_id <= MBEDTLS_PSA_KEY_ID_BUILTIN_MAX);
752 }
753 
798 psa_status_t mbedtls_psa_platform_get_builtin_key(
799  mbedtls_svc_key_id_t key_id,
800  psa_key_lifetime_t *lifetime,
801  psa_drv_slot_number_t *slot_number);
802 #endif /* MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS */
803 
806 #ifdef __cplusplus
807 }
808 #endif
809 
810 #endif /* PSA_CRYPTO_EXTRA_H */
static psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid, size_t *bits)
Definition: crypto_extra.h:582
void mbedtls_psa_crypto_free(void)
Library deinitialization.
#define PSA_ECC_FAMILY_MONTGOMERY
PSA cryptography module: Backward compatibility aliases.
static void psa_set_key_enrollment_algorithm(psa_key_attributes_t *attributes, psa_algorithm_t alg2)
Declare the enrollment algorithm for a key.
Definition: crypto_extra.h:59
#define MBEDTLS_PSA_KEY_ID_BUILTIN_MIN
Definition: crypto_extra.h:723
This file provides an API for Elliptic Curves over GF(P) (ECP).
psa_algorithm_t alg2
psa_key_attributes_flag_t flags
PSA cryptography module: type aliases.
uint32_t psa_key_id_t
Definition: crypto_types.h:266
psa_core_key_attributes_t core
void mbedtls_psa_get_stats(mbedtls_psa_stats_t *stats)
Get statistics about resource consumption related to the PSA keystore.
struct mbedtls_psa_stats_s mbedtls_psa_stats_t
Statistics about resource consumption related to the PSA keystore.
Common and shared functions used by multiple modules in the Mbed TLS library.
psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed, size_t seed_size)
Inject an initial entropy seed for the random generator into secure storage.
uint64_t psa_drv_slot_number_t
Definition: crypto_extra.h:736
#define MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER
psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes, psa_key_type_t type, const uint8_t *data, size_t data_length)
Set domain parameters for a key.
#define PSA_ECC_FAMILY_BRAINPOOL_P_R1
uint64_t psa_key_slot_number_t
mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve, size_t bits, int bits_is_sloppy)
static psa_algorithm_t psa_get_key_enrollment_algorithm(const psa_key_attributes_t *attributes)
Definition: crypto_extra.h:72
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: crypto_types.h:125
#define PSA_ECC_FAMILY_SECP_R1
mbedtls_ecp_group_id
Definition: ecp.h:113
uint16_t psa_key_type_t
Encoding of a key type.
Definition: crypto_types.h:69
psa_key_id_t max_open_internal_key_id
Definition: crypto_extra.h:239
#define MBEDTLS_PSA_KEY_ID_BUILTIN_MAX
Definition: crypto_extra.h:730
psa_key_id_t mbedtls_svc_key_id_t
Definition: crypto_types.h:283
psa_key_policy_t policy
psa_status_t psa_get_key_domain_parameters(const psa_key_attributes_t *attributes, uint8_t *data, size_t data_size, size_t *data_length)
Get domain parameters for a key.
#define PSA_ECC_FAMILY_SECP_K1
uint32_t psa_key_lifetime_t
Definition: crypto_types.h:174
psa_key_id_t max_open_external_key_id
Definition: crypto_extra.h:241
uint8_t psa_ecc_family_t
Definition: crypto_types.h:88
int32_t psa_status_t
Function return status.
Definition: crypto_types.h:50
Statistics about resource consumption related to the PSA keystore.
Definition: crypto_extra.h:220