• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * \file pk_internal.h
3  *
4  * \brief Public Key abstraction layer: wrapper functions
5  */
6 /*
7  *  Copyright The Mbed TLS Contributors
8  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  */
10 
11 #ifndef MBEDTLS_PK_WRAP_H
12 #define MBEDTLS_PK_WRAP_H
13 
14 #if !defined(MBEDTLS_CONFIG_FILE)
15 #include "mbedtls/config.h"
16 #else
17 #include MBEDTLS_CONFIG_FILE
18 #endif
19 
20 #include "mbedtls/pk.h"
21 
22 struct mbedtls_pk_info_t {
23     /** Public key type */
24     mbedtls_pk_type_t type;
25 
26     /** Type name */
27     const char *name;
28 
29     /** Get key size in bits */
30     size_t (*get_bitlen)(const void *);
31 
32     /** Tell if the context implements this type (e.g. ECKEY can do ECDSA) */
33     int (*can_do)(mbedtls_pk_type_t type);
34 
35     /** Verify signature */
36     int (*verify_func)(void *ctx, mbedtls_md_type_t md_alg,
37                        const unsigned char *hash, size_t hash_len,
38                        const unsigned char *sig, size_t sig_len);
39 
40     /** Make signature */
41     int (*sign_func)(void *ctx, mbedtls_md_type_t md_alg,
42                      const unsigned char *hash, size_t hash_len,
43                      unsigned char *sig, size_t *sig_len,
44                      int (*f_rng)(void *, unsigned char *, size_t),
45                      void *p_rng);
46 
47 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
48     /** Verify signature (restartable) */
49     int (*verify_rs_func)(void *ctx, mbedtls_md_type_t md_alg,
50                           const unsigned char *hash, size_t hash_len,
51                           const unsigned char *sig, size_t sig_len,
52                           void *rs_ctx);
53 
54     /** Make signature (restartable) */
55     int (*sign_rs_func)(void *ctx, mbedtls_md_type_t md_alg,
56                         const unsigned char *hash, size_t hash_len,
57                         unsigned char *sig, size_t *sig_len,
58                         int (*f_rng)(void *, unsigned char *, size_t),
59                         void *p_rng, void *rs_ctx);
60 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
61 
62     /** Decrypt message */
63     int (*decrypt_func)(void *ctx, const unsigned char *input, size_t ilen,
64                         unsigned char *output, size_t *olen, size_t osize,
65                         int (*f_rng)(void *, unsigned char *, size_t),
66                         void *p_rng);
67 
68     /** Encrypt message */
69     int (*encrypt_func)(void *ctx, const unsigned char *input, size_t ilen,
70                         unsigned char *output, size_t *olen, size_t osize,
71                         int (*f_rng)(void *, unsigned char *, size_t),
72                         void *p_rng);
73 
74     /** Check public-private key pair */
75     int (*check_pair_func)(const void *pub, const void *prv);
76 
77     /** Allocate a new context */
78     void * (*ctx_alloc_func)(void);
79 
80     /** Free the given context */
81     void (*ctx_free_func)(void *ctx);
82 
83 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
84     /** Allocate the restart context */
85     void *(*rs_alloc_func)(void);
86 
87     /** Free the restart context */
88     void (*rs_free_func)(void *rs_ctx);
89 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
90 
91     /** Interface with the debug module */
92     void (*debug_func)(const void *ctx, mbedtls_pk_debug_item *items);
93 
94 };
95 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
96 /* Container for RSA-alt */
97 typedef struct {
98     void *key;
99     mbedtls_pk_rsa_alt_decrypt_func decrypt_func;
100     mbedtls_pk_rsa_alt_sign_func sign_func;
101     mbedtls_pk_rsa_alt_key_len_func key_len_func;
102 } mbedtls_rsa_alt_context;
103 #endif
104 
105 #if defined(MBEDTLS_RSA_C)
106 extern const mbedtls_pk_info_t mbedtls_rsa_info;
107 #endif
108 
109 #if defined(MBEDTLS_ECP_C)
110 extern const mbedtls_pk_info_t mbedtls_eckey_info;
111 extern const mbedtls_pk_info_t mbedtls_eckeydh_info;
112 #endif
113 
114 #if defined(MBEDTLS_ECDSA_C)
115 extern const mbedtls_pk_info_t mbedtls_ecdsa_info;
116 #endif
117 
118 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
119 extern const mbedtls_pk_info_t mbedtls_rsa_alt_info;
120 #endif
121 
122 #if defined(MBEDTLS_USE_PSA_CRYPTO)
123 extern const mbedtls_pk_info_t mbedtls_pk_opaque_info;
124 #endif
125 
126 #endif /* MBEDTLS_PK_WRAP_H */
127