mbed TLS v2.28.0
pk.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  */
22 
23 #ifndef MBEDTLS_PK_H
24 #define MBEDTLS_PK_H
25 
26 #if !defined(MBEDTLS_CONFIG_FILE)
27 #include "mbedtls/config.h"
28 #else
29 #include MBEDTLS_CONFIG_FILE
30 #endif
31 
32 #include "mbedtls/md.h"
33 
34 #if defined(MBEDTLS_RSA_C)
35 #include "mbedtls/rsa.h"
36 #endif
37 
38 #if defined(MBEDTLS_ECP_C)
39 #include "mbedtls/ecp.h"
40 #endif
41 
42 #if defined(MBEDTLS_ECDSA_C)
43 #include "mbedtls/ecdsa.h"
44 #endif
45 
46 #if defined(MBEDTLS_USE_PSA_CRYPTO)
47 #include "psa/crypto.h"
48 #endif
49 
50 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
51  !defined(inline) && !defined(__cplusplus)
52 #define inline __inline
53 #endif
54 
56 #define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
57 
58 #define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
59 
60 #define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
61 
62 #define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
63 
64 #define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
65 
66 #define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
67 
68 #define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
69 
70 #define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
71 
72 #define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
73 
74 #define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
75 
76 #define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
77 
78 #define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
79 
80 #define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
81 
82 #define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
83 
84 /* MBEDTLS_ERR_PK_HW_ACCEL_FAILED is deprecated and should not be used. */
86 #define MBEDTLS_ERR_PK_HW_ACCEL_FAILED -0x3880
87 
88 #ifdef __cplusplus
89 extern "C" {
90 #endif
91 
95 typedef enum {
105 
111 {
114 
116 
120 /* We need to set MBEDTLS_PK_SIGNATURE_MAX_SIZE to the maximum signature
121  * size among the supported signature types. Do it by starting at 0,
122  * then incrementally increasing to be large enough for each supported
123  * signature mechanism.
124  *
125  * The resulting value can be 0, for example if MBEDTLS_ECDH_C is enabled
126  * (which allows the pk module to be included) but neither MBEDTLS_ECDSA_C
127  * nor MBEDTLS_RSA_C nor any opaque signature mechanism (PSA or RSA_ALT).
128  */
129 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE 0
130 
131 #if ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_RSA_ALT_SUPPORT) ) && \
132  MBEDTLS_MPI_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
133 /* For RSA, the signature can be as large as the bignum module allows.
134  * For RSA_ALT, the signature size is not necessarily tied to what the
135  * bignum module can do, but in the absence of any specific setting,
136  * we use that (rsa_alt_sign_wrap in pk_wrap will check). */
137 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
138 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_MPI_MAX_SIZE
139 #endif
140 
141 #if defined(MBEDTLS_ECDSA_C) && \
142  MBEDTLS_ECDSA_MAX_LEN > MBEDTLS_PK_SIGNATURE_MAX_SIZE
143 /* For ECDSA, the ecdsa module exports a constant for the maximum
144  * signature size. */
145 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
146 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_ECDSA_MAX_LEN
147 #endif
148 
149 #if defined(MBEDTLS_USE_PSA_CRYPTO)
150 #if PSA_SIGNATURE_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
151 /* PSA_SIGNATURE_MAX_SIZE is the maximum size of a signature made
152  * through the PSA API in the PSA representation. */
153 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
154 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE PSA_SIGNATURE_MAX_SIZE
155 #endif
156 
157 #if PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11 > MBEDTLS_PK_SIGNATURE_MAX_SIZE
158 /* The Mbed TLS representation is different for ECDSA signatures:
159  * PSA uses the raw concatenation of r and s,
160  * whereas Mbed TLS uses the ASN.1 representation (SEQUENCE of two INTEGERs).
161  * Add the overhead of ASN.1: up to (1+2) + 2 * (1+2+1) for the
162  * types, lengths (represented by up to 2 bytes), and potential leading
163  * zeros of the INTEGERs and the SEQUENCE. */
164 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
165 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE ( PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11 )
166 #endif
167 #endif /* defined(MBEDTLS_USE_PSA_CRYPTO) */
168 
172 typedef enum
173 {
178 
182 typedef struct mbedtls_pk_debug_item
183 {
185  const char *name;
186  void *value;
188 
190 #define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
191 
196 
200 typedef struct mbedtls_pk_context
201 {
203  void * pk_ctx;
205 
206 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
207 
210 typedef struct
211 {
212  const mbedtls_pk_info_t * pk_info;
213  void * rs_ctx;
215 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
216 /* Now we can declare functions that take a pointer to that */
218 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
219 
220 #if defined(MBEDTLS_RSA_C)
221 
228 {
229  return( (mbedtls_rsa_context *) (pk).pk_ctx );
230 }
231 #endif /* MBEDTLS_RSA_C */
232 
233 #if defined(MBEDTLS_ECP_C)
234 
241 {
242  return( (mbedtls_ecp_keypair *) (pk).pk_ctx );
243 }
244 #endif /* MBEDTLS_ECP_C */
245 
246 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
247 
250 typedef int (*mbedtls_pk_rsa_alt_decrypt_func)( void *ctx, int mode, size_t *olen,
251  const unsigned char *input, unsigned char *output,
252  size_t output_max_len );
253 typedef int (*mbedtls_pk_rsa_alt_sign_func)( void *ctx,
254  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
255  int mode, mbedtls_md_type_t md_alg, unsigned int hashlen,
256  const unsigned char *hash, unsigned char *sig );
257 typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)( void *ctx );
258 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
259 
268 
276 
289 
290 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
291 
297 void mbedtls_pk_restart_init( mbedtls_pk_restart_ctx *ctx );
298 
305 void mbedtls_pk_restart_free( mbedtls_pk_restart_ctx *ctx );
306 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
307 
323 int mbedtls_pk_setup( mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info );
324 
325 #if defined(MBEDTLS_USE_PSA_CRYPTO)
326 
354 int mbedtls_pk_setup_opaque( mbedtls_pk_context *ctx,
355  const psa_key_id_t key );
356 #endif /* MBEDTLS_USE_PSA_CRYPTO */
357 
358 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
359 
374 int mbedtls_pk_setup_rsa_alt( mbedtls_pk_context *ctx, void * key,
375  mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
377  mbedtls_pk_rsa_alt_key_len_func key_len_func );
378 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
379 
387 size_t mbedtls_pk_get_bitlen( const mbedtls_pk_context *ctx );
388 
396 static inline size_t mbedtls_pk_get_len( const mbedtls_pk_context *ctx )
397 {
398  return( ( mbedtls_pk_get_bitlen( ctx ) + 7 ) / 8 );
399 }
400 
414 
440  const unsigned char *hash, size_t hash_len,
441  const unsigned char *sig, size_t sig_len );
442 
464  mbedtls_md_type_t md_alg,
465  const unsigned char *hash, size_t hash_len,
466  const unsigned char *sig, size_t sig_len,
467  mbedtls_pk_restart_ctx *rs_ctx );
468 
498 int mbedtls_pk_verify_ext( mbedtls_pk_type_t type, const void *options,
500  const unsigned char *hash, size_t hash_len,
501  const unsigned char *sig, size_t sig_len );
502 
534  const unsigned char *hash, size_t hash_len,
535  unsigned char *sig, size_t *sig_len,
536  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
537 
567  mbedtls_md_type_t md_alg,
568  const unsigned char *hash, size_t hash_len,
569  unsigned char *sig, size_t *sig_len,
570  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
571  mbedtls_pk_restart_ctx *rs_ctx );
572 
591  const unsigned char *input, size_t ilen,
592  unsigned char *output, size_t *olen, size_t osize,
593  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
594 
612  const unsigned char *input, size_t ilen,
613  unsigned char *output, size_t *olen, size_t osize,
614  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
615 
628 int mbedtls_pk_check_pair( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv );
629 
639 
647 const char * mbedtls_pk_get_name( const mbedtls_pk_context *ctx );
648 
658 
659 #if defined(MBEDTLS_PK_PARSE_C)
660 
690  const unsigned char *key, size_t keylen,
691  const unsigned char *pwd, size_t pwdlen );
692 
716  const unsigned char *key, size_t keylen );
717 
718 #if defined(MBEDTLS_FS_IO)
719 
741  const char *path, const char *password );
742 
760 int mbedtls_pk_parse_public_keyfile( mbedtls_pk_context *ctx, const char *path );
761 #endif /* MBEDTLS_FS_IO */
762 #endif /* MBEDTLS_PK_PARSE_C */
763 
764 #if defined(MBEDTLS_PK_WRITE_C)
765 
778 int mbedtls_pk_write_key_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
779 
793 int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
794 
795 #if defined(MBEDTLS_PEM_WRITE_C)
796 
806 int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
807 
818 int mbedtls_pk_write_key_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
819 #endif /* MBEDTLS_PEM_WRITE_C */
820 #endif /* MBEDTLS_PK_WRITE_C */
821 
822 /*
823  * WARNING: Low-level functions. You probably do not want to use these unless
824  * you are certain you do ;)
825  */
826 
827 #if defined(MBEDTLS_PK_PARSE_C)
828 
838 int mbedtls_pk_parse_subpubkey( unsigned char **p, const unsigned char *end,
839  mbedtls_pk_context *pk );
840 #endif /* MBEDTLS_PK_PARSE_C */
841 
842 #if defined(MBEDTLS_PK_WRITE_C)
843 
853 int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
854  const mbedtls_pk_context *key );
855 #endif /* MBEDTLS_PK_WRITE_C */
856 
857 /*
858  * Internal module functions. You probably do not want to use these unless you
859  * know you do.
860  */
861 #if defined(MBEDTLS_FS_IO)
862 int mbedtls_pk_load_file( const char *path, unsigned char **buf, size_t *n );
863 #endif
864 
865 #if defined(MBEDTLS_USE_PSA_CRYPTO)
866 
886 int mbedtls_pk_wrap_as_opaque( mbedtls_pk_context *pk,
887  psa_key_id_t *key,
888  psa_algorithm_t hash_alg );
889 #endif /* MBEDTLS_USE_PSA_CRYPTO */
890 
891 #ifdef __cplusplus
892 }
893 #endif
894 
895 #endif /* MBEDTLS_PK_H */
int mbedtls_pk_write_pubkey_pem(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a public key to a PEM string.
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext() ...
Definition: pk.h:110
Public key container.
Definition: pk.h:200
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:227
mbedtls_pk_debug_type
Types for interfacing with the debug module.
Definition: pk.h:172
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_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, mbedtls_pk_restart_ctx *rs_ctx)
Restartable version of mbedtls_pk_sign()
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_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_der(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_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...
The ECP key-pair structure.
Definition: ecp.h:432
This file contains ECDSA definitions and functions.
const mbedtls_pk_info_t * pk_info
Definition: pk.h:202
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_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.
mbedtls_pk_type_t
Public key types.
Definition: pk.h:95
Configuration options (set of defines)
uint32_t psa_key_id_t
Definition: crypto_types.h:224
void * value
Definition: pk.h:186
static size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Get the length in bytes of the underlying key.
Definition: pk.h:396
size_t(* mbedtls_pk_rsa_alt_key_len_func)(void *ctx)
Definition: pk.h:257
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_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Make signature, including padding if relevant.
void mbedtls_pk_restart_ctx
Definition: pk.h:217
const char * name
Definition: pk.h:185
int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items)
Export debug information.
void * pk_ctx
Definition: pk.h:203
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_parse_key(mbedtls_pk_context *ctx, const unsigned char *key, size_t keylen, const unsigned char *pwd, size_t pwdlen)
Parse a private key in PEM or DER format.
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: crypto_types.h:105
void mbedtls_pk_free(mbedtls_pk_context *ctx)
Free the components of a mbedtls_pk_context.
mbedtls_md_type_t mgf1_hash_id
Definition: pk.h:112
int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx, const char *path, const char *password)
Load and parse a private key.
struct mbedtls_pk_info_t mbedtls_pk_info_t
Public key information and operations.
Definition: pk.h:195
This file contains the generic message-digest wrapper.
This file provides an API for the RSA public-key cryptosystem.
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).
mbedtls_pk_type_t mbedtls_pk_get_type(const mbedtls_pk_context *ctx)
Get the key type.
int mbedtls_pk_write_key_pem(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a private key to a PKCS#1 or SEC1 PEM string.
int mbedtls_pk_write_key_der(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!...
const char * mbedtls_pk_get_name(const mbedtls_pk_context *ctx)
Access the type name.
int(* mbedtls_pk_rsa_alt_sign_func)(void *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, mbedtls_md_type_t md_alg, unsigned int hashlen, const unsigned char *hash, unsigned char *sig)
Definition: pk.h:253
int(* mbedtls_pk_rsa_alt_decrypt_func)(void *ctx, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len)
Types for RSA-alt abstraction.
Definition: pk.h:250
int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n)
static mbedtls_ecp_keypair * mbedtls_pk_ec(const mbedtls_pk_context pk)
Definition: pk.h:240
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...
struct mbedtls_pk_context mbedtls_pk_context
Public key container.
mbedtls_pk_debug_type type
Definition: pk.h:184
int mbedtls_pk_check_pair(const mbedtls_pk_context *pub, const mbedtls_pk_context *prv)
Check if a public-private pair of keys matches.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:62
struct mbedtls_pk_debug_item mbedtls_pk_debug_item
Item to send to the debug module.
The RSA context structure.
Definition: rsa.h:109
Item to send to the debug module.
Definition: pk.h:182
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).