mbed TLS v2.26.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 
55 #define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
56 #define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
57 #define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
58 #define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
59 #define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
60 #define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
61 #define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
62 #define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
63 #define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
64 #define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
65 #define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
66 #define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
67 #define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
68 #define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
70 /* MBEDTLS_ERR_PK_HW_ACCEL_FAILED is deprecated and should not be used. */
71 #define MBEDTLS_ERR_PK_HW_ACCEL_FAILED -0x3880
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76 
80 typedef enum {
90 
96 {
99 
101 
105 /* We need to set MBEDTLS_PK_SIGNATURE_MAX_SIZE to the maximum signature
106  * size among the supported signature types. Do it by starting at 0,
107  * then incrementally increasing to be large enough for each supported
108  * signature mechanism.
109  *
110  * The resulting value can be 0, for example if MBEDTLS_ECDH_C is enabled
111  * (which allows the pk module to be included) but neither MBEDTLS_ECDSA_C
112  * nor MBEDTLS_RSA_C nor any opaque signature mechanism (PSA or RSA_ALT).
113  */
114 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE 0
115 
116 #if ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_RSA_ALT_SUPPORT) ) && \
117  MBEDTLS_MPI_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
118 /* For RSA, the signature can be as large as the bignum module allows.
119  * For RSA_ALT, the signature size is not necessarily tied to what the
120  * bignum module can do, but in the absence of any specific setting,
121  * we use that (rsa_alt_sign_wrap in pk_wrap will check). */
122 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
123 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_MPI_MAX_SIZE
124 #endif
125 
126 #if defined(MBEDTLS_ECDSA_C) && \
127  MBEDTLS_ECDSA_MAX_LEN > MBEDTLS_PK_SIGNATURE_MAX_SIZE
128 /* For ECDSA, the ecdsa module exports a constant for the maximum
129  * signature size. */
130 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
131 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE MBEDTLS_ECDSA_MAX_LEN
132 #endif
133 
134 #if defined(MBEDTLS_USE_PSA_CRYPTO)
135 #if PSA_SIGNATURE_MAX_SIZE > MBEDTLS_PK_SIGNATURE_MAX_SIZE
136 /* PSA_SIGNATURE_MAX_SIZE is the maximum size of a signature made
137  * through the PSA API in the PSA representation. */
138 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
139 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE PSA_SIGNATURE_MAX_SIZE
140 #endif
141 
142 #if PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11 > MBEDTLS_PK_SIGNATURE_MAX_SIZE
143 /* The Mbed TLS representation is different for ECDSA signatures:
144  * PSA uses the raw concatenation of r and s,
145  * whereas Mbed TLS uses the ASN.1 representation (SEQUENCE of two INTEGERs).
146  * Add the overhead of ASN.1: up to (1+2) + 2 * (1+2+1) for the
147  * types, lengths (represented by up to 2 bytes), and potential leading
148  * zeros of the INTEGERs and the SEQUENCE. */
149 #undef MBEDTLS_PK_SIGNATURE_MAX_SIZE
150 #define MBEDTLS_PK_SIGNATURE_MAX_SIZE ( PSA_VENDOR_ECDSA_SIGNATURE_MAX_SIZE + 11 )
151 #endif
152 #endif /* defined(MBEDTLS_USE_PSA_CRYPTO) */
153 
157 typedef enum
158 {
163 
167 typedef struct mbedtls_pk_debug_item
168 {
170  const char *name;
171  void *value;
173 
175 #define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
176 
181 
185 typedef struct mbedtls_pk_context
186 {
188  void * pk_ctx;
190 
191 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
192 
195 typedef struct
196 {
197  const mbedtls_pk_info_t * pk_info;
198  void * rs_ctx;
200 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
201 /* Now we can declare functions that take a pointer to that */
203 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
204 
205 #if defined(MBEDTLS_RSA_C)
206 
213 {
214  return( (mbedtls_rsa_context *) (pk).pk_ctx );
215 }
216 #endif /* MBEDTLS_RSA_C */
217 
218 #if defined(MBEDTLS_ECP_C)
219 
226 {
227  return( (mbedtls_ecp_keypair *) (pk).pk_ctx );
228 }
229 #endif /* MBEDTLS_ECP_C */
230 
231 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
232 
235 typedef int (*mbedtls_pk_rsa_alt_decrypt_func)( void *ctx, int mode, size_t *olen,
236  const unsigned char *input, unsigned char *output,
237  size_t output_max_len );
238 typedef int (*mbedtls_pk_rsa_alt_sign_func)( void *ctx,
239  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
240  int mode, mbedtls_md_type_t md_alg, unsigned int hashlen,
241  const unsigned char *hash, unsigned char *sig );
242 typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)( void *ctx );
243 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
244 
253 
261 
274 
275 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
276 
282 void mbedtls_pk_restart_init( mbedtls_pk_restart_ctx *ctx );
283 
290 void mbedtls_pk_restart_free( mbedtls_pk_restart_ctx *ctx );
291 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
292 
308 int mbedtls_pk_setup( mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info );
309 
310 #if defined(MBEDTLS_USE_PSA_CRYPTO)
311 
339 int mbedtls_pk_setup_opaque( mbedtls_pk_context *ctx,
340  const psa_key_id_t key );
341 #endif /* MBEDTLS_USE_PSA_CRYPTO */
342 
343 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
344 
359 int mbedtls_pk_setup_rsa_alt( mbedtls_pk_context *ctx, void * key,
360  mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
362  mbedtls_pk_rsa_alt_key_len_func key_len_func );
363 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
364 
372 size_t mbedtls_pk_get_bitlen( const mbedtls_pk_context *ctx );
373 
381 static inline size_t mbedtls_pk_get_len( const mbedtls_pk_context *ctx )
382 {
383  return( ( mbedtls_pk_get_bitlen( ctx ) + 7 ) / 8 );
384 }
385 
399 
425  const unsigned char *hash, size_t hash_len,
426  const unsigned char *sig, size_t sig_len );
427 
449  mbedtls_md_type_t md_alg,
450  const unsigned char *hash, size_t hash_len,
451  const unsigned char *sig, size_t sig_len,
452  mbedtls_pk_restart_ctx *rs_ctx );
453 
483 int mbedtls_pk_verify_ext( mbedtls_pk_type_t type, const void *options,
485  const unsigned char *hash, size_t hash_len,
486  const unsigned char *sig, size_t sig_len );
487 
519  const unsigned char *hash, size_t hash_len,
520  unsigned char *sig, size_t *sig_len,
521  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
522 
552  mbedtls_md_type_t md_alg,
553  const unsigned char *hash, size_t hash_len,
554  unsigned char *sig, size_t *sig_len,
555  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
556  mbedtls_pk_restart_ctx *rs_ctx );
557 
576  const unsigned char *input, size_t ilen,
577  unsigned char *output, size_t *olen, size_t osize,
578  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
579 
597  const unsigned char *input, size_t ilen,
598  unsigned char *output, size_t *olen, size_t osize,
599  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
600 
613 int mbedtls_pk_check_pair( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv );
614 
624 
632 const char * mbedtls_pk_get_name( const mbedtls_pk_context *ctx );
633 
643 
644 #if defined(MBEDTLS_PK_PARSE_C)
645 
675  const unsigned char *key, size_t keylen,
676  const unsigned char *pwd, size_t pwdlen );
677 
701  const unsigned char *key, size_t keylen );
702 
703 #if defined(MBEDTLS_FS_IO)
704 
726  const char *path, const char *password );
727 
745 int mbedtls_pk_parse_public_keyfile( mbedtls_pk_context *ctx, const char *path );
746 #endif /* MBEDTLS_FS_IO */
747 #endif /* MBEDTLS_PK_PARSE_C */
748 
749 #if defined(MBEDTLS_PK_WRITE_C)
750 
763 int mbedtls_pk_write_key_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
764 
778 int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
779 
780 #if defined(MBEDTLS_PEM_WRITE_C)
781 
791 int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
792 
803 int mbedtls_pk_write_key_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
804 #endif /* MBEDTLS_PEM_WRITE_C */
805 #endif /* MBEDTLS_PK_WRITE_C */
806 
807 /*
808  * WARNING: Low-level functions. You probably do not want to use these unless
809  * you are certain you do ;)
810  */
811 
812 #if defined(MBEDTLS_PK_PARSE_C)
813 
823 int mbedtls_pk_parse_subpubkey( unsigned char **p, const unsigned char *end,
824  mbedtls_pk_context *pk );
825 #endif /* MBEDTLS_PK_PARSE_C */
826 
827 #if defined(MBEDTLS_PK_WRITE_C)
828 
838 int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
839  const mbedtls_pk_context *key );
840 #endif /* MBEDTLS_PK_WRITE_C */
841 
842 /*
843  * Internal module functions. You probably do not want to use these unless you
844  * know you do.
845  */
846 #if defined(MBEDTLS_FS_IO)
847 int mbedtls_pk_load_file( const char *path, unsigned char **buf, size_t *n );
848 #endif
849 
850 #if defined(MBEDTLS_USE_PSA_CRYPTO)
851 
871 int mbedtls_pk_wrap_as_opaque( mbedtls_pk_context *pk,
872  psa_key_id_t *key,
873  psa_algorithm_t hash_alg );
874 #endif /* MBEDTLS_USE_PSA_CRYPTO */
875 
876 #ifdef __cplusplus
877 }
878 #endif
879 
880 #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:95
Public key container.
Definition: pk.h:185
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:212
mbedtls_pk_debug_type
Types for interfacing with the debug module.
Definition: pk.h:157
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:374
This file contains ECDSA definitions and functions.
const mbedtls_pk_info_t * pk_info
Definition: pk.h:187
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:80
Configuration options (set of defines)
uint32_t psa_key_id_t
Definition: crypto_types.h:224
void * value
Definition: pk.h:171
static size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Get the length in bytes of the underlying key.
Definition: pk.h:381
size_t(* mbedtls_pk_rsa_alt_key_len_func)(void *ctx)
Definition: pk.h:242
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:202
const char * name
Definition: pk.h:170
int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items)
Export debug information.
void * pk_ctx
Definition: pk.h:188
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:97
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:180
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:238
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:235
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:225
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:169
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:56
struct mbedtls_pk_debug_item mbedtls_pk_debug_item
Item to send to the debug module.
The RSA context structure.
Definition: rsa.h:98
Item to send to the debug module.
Definition: pk.h:167
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).