1 /**
2 * \file pk_internal.h
3 *
4 * \brief Public Key abstraction layer: internal (i.e. library only) functions
5 * and definitions.
6 */
7 /*
8 * Copyright The Mbed TLS Contributors
9 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
10 */
11 #ifndef MBEDTLS_PK_INTERNAL_H
12 #define MBEDTLS_PK_INTERNAL_H
13
14 #include "mbedtls/pk.h"
15
16 #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
17 #include "mbedtls/ecp.h"
18 #endif
19
20 #if defined(MBEDTLS_USE_PSA_CRYPTO)
21 #include "psa/crypto.h"
22 #endif
23
24 #if defined(MBEDTLS_PSA_CRYPTO_C)
25 #include "psa_util_internal.h"
26 #define PSA_PK_TO_MBEDTLS_ERR(status) psa_pk_status_to_mbedtls(status)
27 #define PSA_PK_RSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
28 psa_to_pk_rsa_errors, \
29 psa_pk_status_to_mbedtls)
30 #define PSA_PK_ECDSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
31 psa_to_pk_ecdsa_errors, \
32 psa_pk_status_to_mbedtls)
33 #endif
34
35 #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
36 /**
37 * Public function mbedtls_pk_ec() can be used to get direct access to the
38 * wrapped ecp_keypair structure pointed to the pk_ctx. However this is not
39 * ideal because it bypasses the PK module on the control of its internal
40 * structure (pk_context) fields.
41 * For backward compatibility we keep mbedtls_pk_ec() when ECP_C is defined, but
42 * we provide 2 very similar functions when only ECP_LIGHT is enabled and not
43 * ECP_C.
44 * These variants embed the "ro" or "rw" keywords in their name to make the
45 * usage of the returned pointer explicit. Of course the returned value is
46 * const or non-const accordingly.
47 */
mbedtls_pk_ec_ro(const mbedtls_pk_context pk)48 static inline const mbedtls_ecp_keypair *mbedtls_pk_ec_ro(const mbedtls_pk_context pk)
49 {
50 switch (mbedtls_pk_get_type(&pk)) {
51 case MBEDTLS_PK_ECKEY:
52 case MBEDTLS_PK_ECKEY_DH:
53 case MBEDTLS_PK_ECDSA:
54 return (const mbedtls_ecp_keypair *) (pk).MBEDTLS_PRIVATE(pk_ctx);
55 default:
56 return NULL;
57 }
58 }
59
mbedtls_pk_ec_rw(const mbedtls_pk_context pk)60 static inline mbedtls_ecp_keypair *mbedtls_pk_ec_rw(const mbedtls_pk_context pk)
61 {
62 switch (mbedtls_pk_get_type(&pk)) {
63 case MBEDTLS_PK_ECKEY:
64 case MBEDTLS_PK_ECKEY_DH:
65 case MBEDTLS_PK_ECDSA:
66 return (mbedtls_ecp_keypair *) (pk).MBEDTLS_PRIVATE(pk_ctx);
67 default:
68 return NULL;
69 }
70 }
71
mbedtls_pk_get_group_id(const mbedtls_pk_context * pk)72 static inline mbedtls_ecp_group_id mbedtls_pk_get_group_id(const mbedtls_pk_context *pk)
73 {
74 mbedtls_ecp_group_id id;
75
76 #if defined(MBEDTLS_USE_PSA_CRYPTO)
77 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
78 psa_key_attributes_t opaque_attrs = PSA_KEY_ATTRIBUTES_INIT;
79 psa_key_type_t opaque_key_type;
80 psa_ecc_family_t curve;
81
82 if (psa_get_key_attributes(pk->priv_id, &opaque_attrs) != PSA_SUCCESS) {
83 return MBEDTLS_ECP_DP_NONE;
84 }
85 opaque_key_type = psa_get_key_type(&opaque_attrs);
86 curve = PSA_KEY_TYPE_ECC_GET_FAMILY(opaque_key_type);
87 id = mbedtls_ecc_group_of_psa(curve, psa_get_key_bits(&opaque_attrs), 0);
88 psa_reset_key_attributes(&opaque_attrs);
89 } else
90 #endif /* MBEDTLS_USE_PSA_CRYPTO */
91 {
92 #if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
93 id = mbedtls_ecc_group_of_psa(pk->ec_family, pk->ec_bits, 0);
94 #else /* MBEDTLS_PK_USE_PSA_EC_DATA */
95 id = mbedtls_pk_ec_ro(*pk)->grp.id;
96 #endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
97 }
98
99 return id;
100 }
101
102 /* Helper for Montgomery curves */
103 #if defined(MBEDTLS_ECP_HAVE_CURVE25519) || defined(MBEDTLS_ECP_HAVE_CURVE448)
104 #define MBEDTLS_PK_HAVE_RFC8410_CURVES
105 #endif /* MBEDTLS_ECP_HAVE_CURVE25519 || MBEDTLS_ECP_DP_CURVE448 */
106 #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
107
108 #if defined(MBEDTLS_TEST_HOOKS)
109
110 MBEDTLS_STATIC_TESTABLE int mbedtls_pk_parse_key_pkcs8_encrypted_der(
111 mbedtls_pk_context *pk,
112 unsigned char *key, size_t keylen,
113 const unsigned char *pwd, size_t pwdlen,
114 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
115
116 #endif
117
118 #endif /* MBEDTLS_PK_INTERNAL_H */
119
