Mbed TLS v3.6.3
pk.h
Go to the documentation of this file.
1 
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_H
12 #define MBEDTLS_PK_H
13 #include "mbedtls/private_access.h"
14 
15 #include "mbedtls/build_info.h"
16 
17 #include "mbedtls/md.h"
18 
19 #if defined(MBEDTLS_RSA_C)
20 #include "mbedtls/rsa.h"
21 #endif
22 
23 #if defined(MBEDTLS_ECP_C)
24 #include "mbedtls/ecp.h"
25 #endif
26 
27 #if defined(MBEDTLS_ECDSA_C)
28 #include "mbedtls/ecdsa.h"
29 #endif
30 
31 #if defined(MBEDTLS_PSA_CRYPTO_CLIENT)
32 #include "psa/crypto.h"
33 #endif
34 
36 #define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
37 
38 #define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
39 
40 #define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
41 
42 #define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
43 
44 #define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
45 
46 #define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
47 
48 #define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
49 
50 #define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
51 
52 #define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
53 
54 #define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
55 
56 #define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
57 
58 #define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
59 
60 #define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
61 
62 #define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
63 
64 #define MBEDTLS_ERR_PK_BUFFER_TOO_SMALL -0x3880
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
73 typedef enum {
83 
98 
107 
109 
113 /* We need to set MBEDTLS_PK_SIGNATURE_MAX_SIZE to the maximum signature
114  * size among the supported signature types. Do it by starting at 0,
115  * then incrementally increasing to be large enough for each supported
116  * signature mechanism.
117  *
118  * The resulting value can be 0, for example if MBEDTLS_ECDH_C is enabled
119  * (which allows the pk module to be included) but neither MBEDTLS_ECDSA_C
120  * nor MBEDTLS_RSA_C nor any opaque signature mechanism (PSA or RSA_ALT).
121  */
122 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE 0
123 
124 #if (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_RSA_ALT_SUPPORT)) && \
125  MBEDTLS_MPI_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
126 /* For RSA, the signature can be as large as the bignum module allows.
127  * For RSA_ALT, the signature size is not necessarily tied to what the
128  * bignum module can do, but in the absence of any specific setting,
129  * we use that (rsa_alt_sign_wrap in library/pk_wrap.h will check). */
130 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
131 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_MPI_MAX_SIZE
132 #endif
133 
134 #if defined(MBEDTLS_ECDSA_C) && \
135  MBEDTLS_ECDSA_MAX_LEN > MBEDTLS_PK_SIGNATURE_MAX_SIZE
136 /* For ECDSA, the ecdsa module exports a constant for the maximum
137  * signature size. */
138 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
139 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_ECDSA_MAX_LEN
140 #endif
141 
142 #if defined(MBEDTLS_USE_PSA_CRYPTO)
143 #if PSA_SIGNATURE_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
144 /* PSA_SIGNATURE_MAX_SIZE is the maximum size of a signature made
145  * through the PSA API in the PSA representation. */
146 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
147 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE PSA_SIGNATURE_MAX_SIZE
148 #endif
149 
150 #if PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11 > MBEDTLS_PK_SIGNATURE_MAX_SIZE
151 /* The Mbed TLS representation is different for ECDSA signatures:
152  * PSA uses the raw concatenation of r and s,
153  * whereas Mbed TLS uses the ASN.1 representation (SEQUENCE of two INTEGERs).
154  * Add the overhead of ASN.1: up to (1+2) + 2 * (1+2+1) for the
155  * types, lengths (represented by up to 2 bytes), and potential leading
156  * zeros of the INTEGERs and the SEQUENCE. */
157 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
158 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE (PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11)
159 #endif
160 #endif /* defined(MBEDTLS_USE_PSA_CRYPTO) */
161 
162 /* Internal helper to define which fields in the pk_context structure below
163  * should be used for EC keys: legacy ecp_keypair or the raw (PSA friendly)
164  * format. It should be noted that this only affects how data is stored, not
165  * which functions are used for various operations. The overall picture looks
166  * like this:
167  * - if USE_PSA is not defined and ECP_C is defined then use ecp_keypair data
168  * structure and legacy functions
169  * - if USE_PSA is defined and
170  * - if ECP_C then use ecp_keypair structure, convert data to a PSA friendly
171  * format and use PSA functions
172  * - if !ECP_C then use new raw data and PSA functions directly.
173  *
174  * The main reason for the "intermediate" (USE_PSA + ECP_C) above is that as long
175  * as ECP_C is defined mbedtls_pk_ec() gives the user a read/write access to the
176  * ecp_keypair structure inside the pk_context so they can modify it using
177  * ECP functions which are not under PK module's control.
178  */
179 #if defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) && \
180  !defined(MBEDTLS_ECP_C)
181 #define MBEDTLS_PK_USE_PSA_EC_DATA
182 #endif
183 
187 typedef enum {
193 
197 typedef struct mbedtls_pk_debug_item {
199  const char *MBEDTLS_PRIVATE(name);
200  void *MBEDTLS_PRIVATE(value);
202 
204 #define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
205 
214 
215 #define MBEDTLS_PK_MAX_EC_PUBKEY_RAW_LEN \
216  PSA_KEY_EXPORT_ECC_PUBLIC_KEY_MAX_SIZE(PSA_VENDOR_ECC_MAX_CURVE_BITS)
217 
220 typedef struct mbedtls_pk_context {
222  void *MBEDTLS_PRIVATE(pk_ctx);
223  /* The following field is used to store the ID of a private key in the
224  * following cases:
225  * - opaque key when MBEDTLS_USE_PSA_CRYPTO is defined
226  * - normal key when MBEDTLS_PK_USE_PSA_EC_DATA is defined. In this case:
227  * - the pk_ctx above is not not used to store the private key anymore.
228  * Actually that field not populated at all in this case because also
229  * the public key will be stored in raw format as explained below
230  * - this ID is used for all private key operations (ex: sign, check
231  * key pair, key write, etc) using PSA functions
232  *
233  * Note: this private key storing solution only affects EC keys, not the
234  * other ones. The latters still use the pk_ctx to store their own
235  * context. */
236 #if defined(MBEDTLS_USE_PSA_CRYPTO)
238 #endif /* MBEDTLS_USE_PSA_CRYPTO */
239  /* The following fields are meant for storing the public key in raw format
240  * which is handy for:
241  * - easily importing it into the PSA context
242  * - reducing the ECP module dependencies in the PK one.
243  *
244  * When MBEDTLS_PK_USE_PSA_EC_DATA is enabled:
245  * - the pk_ctx above is not used anymore for storing the public key
246  * inside the ecp_keypair structure
247  * - the following fields are used for all public key operations: signature
248  * verify, key pair check and key write.
249  * - For a key pair, priv_id contains the private key. For a public key,
250  * priv_id is null.
251  * Of course, when MBEDTLS_PK_USE_PSA_EC_DATA is not enabled, the legacy
252  * ecp_keypair structure is used for storing the public key and performing
253  * all the operations.
254  *
255  * Note: This new public key storing solution only works for EC keys, not
256  * other ones. The latters still use pk_ctx to store their own
257  * context.
258  */
259 #if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
261  size_t MBEDTLS_PRIVATE(pub_raw_len);
262  psa_ecc_family_t MBEDTLS_PRIVATE(ec_family);
263  size_t MBEDTLS_PRIVATE(ec_bits);
264 #endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
266 
267 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
268 
271 typedef struct {
272  const mbedtls_pk_info_t *MBEDTLS_PRIVATE(pk_info);
273  void *MBEDTLS_PRIVATE(rs_ctx);
275 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
276 /* Now we can declare functions that take a pointer to that */
278 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
279 
280 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
281 
284 typedef int (*mbedtls_pk_rsa_alt_decrypt_func)(void *ctx, size_t *olen,
285  const unsigned char *input, unsigned char *output,
286  size_t output_max_len);
287 typedef int (*mbedtls_pk_rsa_alt_sign_func)(void *ctx,
288  int (*f_rng)(void *, unsigned char *, size_t),
289  void *p_rng,
290  mbedtls_md_type_t md_alg, unsigned int hashlen,
291  const unsigned char *hash, unsigned char *sig);
292 typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)(void *ctx);
293 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
294 
303 
311 
324 
325 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
326 
332 void mbedtls_pk_restart_init(mbedtls_pk_restart_ctx *ctx);
333 
340 void mbedtls_pk_restart_free(mbedtls_pk_restart_ctx *ctx);
341 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
342 
359 
360 #if defined(MBEDTLS_USE_PSA_CRYPTO)
361 
397 int mbedtls_pk_setup_opaque(mbedtls_pk_context *ctx,
398  const mbedtls_svc_key_id_t key);
399 #endif /* MBEDTLS_USE_PSA_CRYPTO */
400 
401 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
402 
417 int mbedtls_pk_setup_rsa_alt(mbedtls_pk_context *ctx, void *key,
418  mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
420  mbedtls_pk_rsa_alt_key_len_func key_len_func);
421 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
422 
430 size_t mbedtls_pk_get_bitlen(const mbedtls_pk_context *ctx);
431 
439 static inline size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
440 {
441  return (mbedtls_pk_get_bitlen(ctx) + 7) / 8;
442 }
443 
457 
458 #if defined(MBEDTLS_USE_PSA_CRYPTO)
459 
486 int mbedtls_pk_can_do_ext(const mbedtls_pk_context *ctx, psa_algorithm_t alg,
487  psa_key_usage_t usage);
488 #endif /* MBEDTLS_USE_PSA_CRYPTO */
489 
490 #if defined(MBEDTLS_PSA_CRYPTO_CLIENT)
491 
601  psa_key_usage_t usage,
602  psa_key_attributes_t *attributes);
603 
648  const psa_key_attributes_t *attributes,
649  mbedtls_svc_key_id_t *key_id);
650 
686 
719 #endif /* MBEDTLS_PSA_CRYPTO_CLIENT */
720 
752  const unsigned char *hash, size_t hash_len,
753  const unsigned char *sig, size_t sig_len);
754 
776  mbedtls_md_type_t md_alg,
777  const unsigned char *hash, size_t hash_len,
778  const unsigned char *sig, size_t sig_len,
779  mbedtls_pk_restart_ctx *rs_ctx);
780 
812 int mbedtls_pk_verify_ext(mbedtls_pk_type_t type, const void *options,
814  const unsigned char *hash, size_t hash_len,
815  const unsigned char *sig, size_t sig_len);
816 
850  const unsigned char *hash, size_t hash_len,
851  unsigned char *sig, size_t sig_size, size_t *sig_len,
852  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
853 
884  mbedtls_pk_context *ctx,
885  mbedtls_md_type_t md_alg,
886  const unsigned char *hash, size_t hash_len,
887  unsigned char *sig, size_t sig_size, size_t *sig_len,
888  int (*f_rng)(void *, unsigned char *, size_t),
889  void *p_rng);
890 
921  mbedtls_md_type_t md_alg,
922  const unsigned char *hash, size_t hash_len,
923  unsigned char *sig, size_t sig_size, size_t *sig_len,
924  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
925  mbedtls_pk_restart_ctx *rs_ctx);
926 
948  const unsigned char *input, size_t ilen,
949  unsigned char *output, size_t *olen, size_t osize,
950  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
951 
974  const unsigned char *input, size_t ilen,
975  unsigned char *output, size_t *olen, size_t osize,
976  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
977 
993  const mbedtls_pk_context *prv,
994  int (*f_rng)(void *, unsigned char *, size_t),
995  void *p_rng);
996 
1006 
1014 const char *mbedtls_pk_get_name(const mbedtls_pk_context *ctx);
1015 
1025 
1026 #if defined(MBEDTLS_RSA_C)
1027 
1038 {
1039  switch (mbedtls_pk_get_type(&pk)) {
1040  case MBEDTLS_PK_RSA:
1041  return (mbedtls_rsa_context *) (pk).MBEDTLS_PRIVATE(pk_ctx);
1042  default:
1043  return NULL;
1044  }
1045 }
1046 #endif /* MBEDTLS_RSA_C */
1047 
1048 #if defined(MBEDTLS_ECP_C)
1049 
1061 {
1062  switch (mbedtls_pk_get_type(&pk)) {
1063  case MBEDTLS_PK_ECKEY:
1064  case MBEDTLS_PK_ECKEY_DH:
1065  case MBEDTLS_PK_ECDSA:
1066  return (mbedtls_ecp_keypair *) (pk).MBEDTLS_PRIVATE(pk_ctx);
1067  default:
1068  return NULL;
1069  }
1070 }
1071 #endif /* MBEDTLS_ECP_C */
1072 
1073 #if defined(MBEDTLS_PK_PARSE_C)
1074 
1110  const unsigned char *key, size_t keylen,
1111  const unsigned char *pwd, size_t pwdlen,
1112  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
1113 
1144  const unsigned char *key, size_t keylen);
1145 
1146 #if defined(MBEDTLS_FS_IO)
1147 
1175  const char *path, const char *password,
1176  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
1177 
1195 int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path);
1196 #endif /* MBEDTLS_FS_IO */
1197 #endif /* MBEDTLS_PK_PARSE_C */
1198 
1199 #if defined(MBEDTLS_PK_WRITE_C)
1200 
1213 int mbedtls_pk_write_key_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
1214 
1228 int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
1229 
1230 #if defined(MBEDTLS_PEM_WRITE_C)
1231 
1241 int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
1242 
1253 int mbedtls_pk_write_key_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size);
1254 #endif /* MBEDTLS_PEM_WRITE_C */
1255 #endif /* MBEDTLS_PK_WRITE_C */
1256 
1257 /*
1258  * WARNING: Low-level functions. You probably do not want to use these unless
1259  * you are certain you do ;)
1260  */
1261 
1262 #if defined(MBEDTLS_PK_PARSE_C)
1263 
1273 int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end,
1274  mbedtls_pk_context *pk);
1275 #endif /* MBEDTLS_PK_PARSE_C */
1276 
1277 #if defined(MBEDTLS_PK_WRITE_C)
1278 
1288 int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
1289  const mbedtls_pk_context *key);
1290 #endif /* MBEDTLS_PK_WRITE_C */
1291 
1292 #ifdef __cplusplus
1293 }
1294 #endif
1295 
1296 #endif /* MBEDTLS_PK_H */
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext() ...
Definition: pk.h:88
#define MBEDTLS_PK_MAX_EC_PUBKEY_RAW_LEN
Definition: pk.h:215
Public key container.
Definition: pk.h:220
int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a public key to a PEM string.
int mbedtls_pk_setup_rsa_alt(mbedtls_pk_context *ctx, void *key, mbedtls_pk_rsa_alt_decrypt_func decrypt_func, mbedtls_pk_rsa_alt_sign_func sign_func, mbedtls_pk_rsa_alt_key_len_func key_len_func)
Initialize an RSA-alt context.
int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end, mbedtls_pk_context *pk)
Parse a SubjectPublicKeyInfo DER structure.
void mbedtls_pk_init(mbedtls_pk_context *ctx)
Initialize a mbedtls_pk_context (as NONE).
static mbedtls_rsa_context * mbedtls_pk_rsa(const mbedtls_pk_context pk)
Definition: pk.h:1037
mbedtls_pk_debug_type
Types for interfacing with the debug module.
Definition: pk.h:187
struct mbedtls_pk_rsassa_pss_options mbedtls_pk_rsassa_pss_options
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext() ...
int mbedtls_pk_check_pair(const mbedtls_pk_context *pub, const mbedtls_pk_context *prv, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Check if a public-private pair of keys matches.
int mbedtls_pk_can_do(const mbedtls_pk_context *ctx, mbedtls_pk_type_t type)
Tell if a context can do the operation given by type.
int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start, const mbedtls_pk_context *key)
Write a subjectPublicKey to ASN.1 data Note: function works backwards in data buffer.
This file provides an API for Elliptic Curves over GF(P) (ECP).
int mbedtls_pk_verify_ext(mbedtls_pk_type_t type, const void *options, mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len)
Verify signature, with options. (Includes verification of the padding depending on type...
int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx, const char *path, const char *password, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Load and parse a private key.
The ECP key-pair structure.
Definition: ecp.h:428
This file contains ECDSA definitions and functions.
Platform Security Architecture cryptography module.
int mbedtls_pk_encrypt(mbedtls_pk_context *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, size_t osize, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Encrypt message (including padding if relevant).
int mbedtls_pk_sign_restartable(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, unsigned char *sig, size_t sig_size, size_t *sig_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, mbedtls_pk_restart_ctx *rs_ctx)
Restartable version of mbedtls_pk_sign()
int mbedtls_pk_verify_restartable(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len, mbedtls_pk_restart_ctx *rs_ctx)
Restartable version of mbedtls_pk_verify()
size_t mbedtls_pk_get_bitlen(const mbedtls_pk_context *ctx)
Get the size in bits of the underlying key.
#define MBEDTLS_PRIVATE(member)
mbedtls_pk_type_t
Public key types.
Definition: pk.h:73
int mbedtls_pk_parse_key(mbedtls_pk_context *ctx, const unsigned char *key, size_t keylen, const unsigned char *pwd, size_t pwdlen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Parse a private key in PEM or DER format.
int mbedtls_pk_import_into_psa(const mbedtls_pk_context *pk, const psa_key_attributes_t *attributes, mbedtls_svc_key_id_t *key_id)
Import a key into the PSA key store.
int(* mbedtls_pk_rsa_alt_sign_func)(void *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, mbedtls_md_type_t md_alg, unsigned int hashlen, const unsigned char *hash, unsigned char *sig)
Definition: pk.h:287
static size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Get the length in bytes of the underlying key.
Definition: pk.h:439
size_t(* mbedtls_pk_rsa_alt_key_len_func)(void *ctx)
Definition: pk.h:292
void mbedtls_pk_restart_ctx
Definition: pk.h:277
int(* mbedtls_pk_rsa_alt_decrypt_func)(void *ctx, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len)
Types for RSA-alt abstraction.
Definition: pk.h:284
int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items)
Export debug information.
int mbedtls_pk_parse_public_key(mbedtls_pk_context *ctx, const unsigned char *key, size_t keylen)
Parse a public key in PEM or DER format.
int mbedtls_pk_write_key_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a private key to a PKCS#1 or SEC1 DER structure Note: data is written at the end of the buffer!...
int mbedtls_pk_write_key_pem(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a private key to a PKCS#1 or SEC1 PEM string.
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: crypto_types.h:134
void mbedtls_pk_free(mbedtls_pk_context *ctx)
Free the components of a mbedtls_pk_context.
Macro wrapper for struct's members.
mbedtls_md_type_t mgf1_hash_id
Definition: pk.h:97
uint32_t psa_key_usage_t
Encoding of permitted usage on a key.
Definition: crypto_types.h:323
Build-time configuration info.
int mbedtls_pk_sign_ext(mbedtls_pk_type_t pk_type, mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, unsigned char *sig, size_t sig_size, size_t *sig_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Make signature given a signature type.
struct mbedtls_pk_info_t mbedtls_pk_info_t
Public key information and operations.
Definition: pk.h:213
This file contains the generic functions for message-digest (hashing) and HMAC.
This file provides an API for the RSA public-key cryptosystem.
psa_key_id_t mbedtls_svc_key_id_t
Definition: crypto_types.h:292
int mbedtls_pk_verify(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len)
Verify signature (including padding if relevant).
int mbedtls_pk_get_psa_attributes(const mbedtls_pk_context *pk, psa_key_usage_t usage, psa_key_attributes_t *attributes)
Determine valid PSA attributes that can be used to import a key into PSA.
mbedtls_pk_type_t mbedtls_pk_get_type(const mbedtls_pk_context *ctx)
Get the key type.
int mbedtls_pk_copy_public_from_psa(mbedtls_svc_key_id_t key_id, mbedtls_pk_context *pk)
Create a PK context for the public key of a PSA key.
int mbedtls_pk_copy_from_psa(mbedtls_svc_key_id_t key_id, mbedtls_pk_context *pk)
Create a PK context starting from a key stored in PSA. This key:
const char * mbedtls_pk_get_name(const mbedtls_pk_context *ctx)
Access the type name.
static mbedtls_ecp_keypair * mbedtls_pk_ec(const mbedtls_pk_context pk)
Definition: pk.h:1060
int mbedtls_pk_setup(mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info)
Initialize a PK context with the information given and allocates the type-specific PK subcontext...
int mbedtls_pk_sign(mbedtls_pk_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hash_len, unsigned char *sig, size_t sig_size, size_t *sig_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Make signature, including padding if relevant.
struct mbedtls_pk_context mbedtls_pk_context
Public key container.
uint8_t psa_ecc_family_t
Definition: crypto_types.h:97
mbedtls_md_type_t
Supported message digests.
Definition: md.h:47
struct mbedtls_pk_debug_item mbedtls_pk_debug_item
Item to send to the debug module.
The RSA context structure.
Definition: rsa.h:85
Item to send to the debug module.
Definition: pk.h:197
int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a public key to a SubjectPublicKeyInfo DER structure Note: data is written at the end of the bu...
int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path)
Load and parse a public key.
const mbedtls_pk_info_t * mbedtls_pk_info_from_type(mbedtls_pk_type_t pk_type)
Return information associated with the given PK type.
int mbedtls_pk_decrypt(mbedtls_pk_context *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, size_t osize, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Decrypt message (including padding if relevant).