mbed TLS v2.16.12
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  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 
50 #ifndef MBEDTLS_PK_H
51 #define MBEDTLS_PK_H
52 
53 #if !defined(MBEDTLS_CONFIG_FILE)
54 #include "config.h"
55 #else
56 #include MBEDTLS_CONFIG_FILE
57 #endif
58 
59 #include "md.h"
60 
61 #if defined(MBEDTLS_RSA_C)
62 #include "rsa.h"
63 #endif
64 
65 #if defined(MBEDTLS_ECP_C)
66 #include "ecp.h"
67 #endif
68 
69 #if defined(MBEDTLS_ECDSA_C)
70 #include "ecdsa.h"
71 #endif
72 
73 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
74  !defined(inline) && !defined(__cplusplus)
75 #define inline __inline
76 #endif
77 
79 #define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
80 
81 #define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
82 
83 #define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
84 
85 #define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
86 
87 #define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
88 
89 #define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
90 
91 #define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
92 
93 #define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
94 
95 #define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
96 
97 #define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
98 
99 #define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
100 
101 #define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
102 
103 #define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
104 
105 #define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
106 
107 /* MBEDTLS_ERR_PK_HW_ACCEL_FAILED is deprecated and should not be used. */
109 #define MBEDTLS_ERR_PK_HW_ACCEL_FAILED -0x3880
110 
111 #ifdef __cplusplus
112 extern "C" {
113 #endif
114 
118 typedef enum {
127 
133 {
136 
138 
142 typedef enum
143 {
148 
152 typedef struct mbedtls_pk_debug_item
153 {
155  const char *name;
156  void *value;
158 
160 #define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
161 
166 
170 typedef struct mbedtls_pk_context
171 {
173  void * pk_ctx;
175 
176 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
177 
180 typedef struct
181 {
182  const mbedtls_pk_info_t * pk_info;
183  void * rs_ctx;
185 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
186 /* Now we can declare functions that take a pointer to that */
188 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
189 
190 #if defined(MBEDTLS_RSA_C)
191 
198 {
199  return( (mbedtls_rsa_context *) (pk).pk_ctx );
200 }
201 #endif /* MBEDTLS_RSA_C */
202 
203 #if defined(MBEDTLS_ECP_C)
204 
211 {
212  return( (mbedtls_ecp_keypair *) (pk).pk_ctx );
213 }
214 #endif /* MBEDTLS_ECP_C */
215 
216 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
217 
220 typedef int (*mbedtls_pk_rsa_alt_decrypt_func)( void *ctx, int mode, size_t *olen,
221  const unsigned char *input, unsigned char *output,
222  size_t output_max_len );
223 typedef int (*mbedtls_pk_rsa_alt_sign_func)( void *ctx,
224  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
225  int mode, mbedtls_md_type_t md_alg, unsigned int hashlen,
226  const unsigned char *hash, unsigned char *sig );
227 typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)( void *ctx );
228 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
229 
238 
246 
254 
255 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
256 
262 void mbedtls_pk_restart_init( mbedtls_pk_restart_ctx *ctx );
263 
270 void mbedtls_pk_restart_free( mbedtls_pk_restart_ctx *ctx );
271 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
272 
288 int mbedtls_pk_setup( mbedtls_pk_context *ctx, const mbedtls_pk_info_t *info );
289 
290 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
291 
306 int mbedtls_pk_setup_rsa_alt( mbedtls_pk_context *ctx, void * key,
307  mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
309  mbedtls_pk_rsa_alt_key_len_func key_len_func );
310 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
311 
319 size_t mbedtls_pk_get_bitlen( const mbedtls_pk_context *ctx );
320 
328 static inline size_t mbedtls_pk_get_len( const mbedtls_pk_context *ctx )
329 {
330  return( ( mbedtls_pk_get_bitlen( ctx ) + 7 ) / 8 );
331 }
332 
346 
372  const unsigned char *hash, size_t hash_len,
373  const unsigned char *sig, size_t sig_len );
374 
396  mbedtls_md_type_t md_alg,
397  const unsigned char *hash, size_t hash_len,
398  const unsigned char *sig, size_t sig_len,
399  mbedtls_pk_restart_ctx *rs_ctx );
400 
430 int mbedtls_pk_verify_ext( mbedtls_pk_type_t type, const void *options,
432  const unsigned char *hash, size_t hash_len,
433  const unsigned char *sig, size_t sig_len );
434 
465  const unsigned char *hash, size_t hash_len,
466  unsigned char *sig, size_t *sig_len,
467  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
468 
497  mbedtls_md_type_t md_alg,
498  const unsigned char *hash, size_t hash_len,
499  unsigned char *sig, size_t *sig_len,
500  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
501  mbedtls_pk_restart_ctx *rs_ctx );
502 
521  const unsigned char *input, size_t ilen,
522  unsigned char *output, size_t *olen, size_t osize,
523  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
524 
542  const unsigned char *input, size_t ilen,
543  unsigned char *output, size_t *olen, size_t osize,
544  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
545 
554 int mbedtls_pk_check_pair( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv );
555 
565 
573 const char * mbedtls_pk_get_name( const mbedtls_pk_context *ctx );
574 
584 
585 #if defined(MBEDTLS_PK_PARSE_C)
586 
616  const unsigned char *key, size_t keylen,
617  const unsigned char *pwd, size_t pwdlen );
618 
642  const unsigned char *key, size_t keylen );
643 
644 #if defined(MBEDTLS_FS_IO)
645 
667  const char *path, const char *password );
668 
686 int mbedtls_pk_parse_public_keyfile( mbedtls_pk_context *ctx, const char *path );
687 #endif /* MBEDTLS_FS_IO */
688 #endif /* MBEDTLS_PK_PARSE_C */
689 
690 #if defined(MBEDTLS_PK_WRITE_C)
691 
704 int mbedtls_pk_write_key_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
705 
719 int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
720 
721 #if defined(MBEDTLS_PEM_WRITE_C)
722 
732 int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
733 
744 int mbedtls_pk_write_key_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
745 #endif /* MBEDTLS_PEM_WRITE_C */
746 #endif /* MBEDTLS_PK_WRITE_C */
747 
748 /*
749  * WARNING: Low-level functions. You probably do not want to use these unless
750  * you are certain you do ;)
751  */
752 
753 #if defined(MBEDTLS_PK_PARSE_C)
754 
764 int mbedtls_pk_parse_subpubkey( unsigned char **p, const unsigned char *end,
765  mbedtls_pk_context *pk );
766 #endif /* MBEDTLS_PK_PARSE_C */
767 
768 #if defined(MBEDTLS_PK_WRITE_C)
769 
779 int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
780  const mbedtls_pk_context *key );
781 #endif /* MBEDTLS_PK_WRITE_C */
782 
783 /*
784  * Internal module functions. You probably do not want to use these unless you
785  * know you do.
786  */
787 #if defined(MBEDTLS_FS_IO)
788 int mbedtls_pk_load_file( const char *path, unsigned char **buf, size_t *n );
789 #endif
790 
791 #ifdef __cplusplus
792 }
793 #endif
794 
795 #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:132
Public key container.
Definition: pk.h:170
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:197
mbedtls_pk_debug_type
Types for interfacing with the debug module.
Definition: pk.h:142
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:407
This file contains ECDSA definitions and functions.
const mbedtls_pk_info_t * pk_info
Definition: pk.h:172
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:118
Configuration options (set of defines)
void * value
Definition: pk.h:156
static size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Get the length in bytes of the underlying key.
Definition: pk.h:328
size_t(* mbedtls_pk_rsa_alt_key_len_func)(void *ctx)
Definition: pk.h:227
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:187
const char * name
Definition: pk.h:155
int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items)
Export debug information.
void * pk_ctx
Definition: pk.h:173
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.
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:134
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:165
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:223
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:220
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:210
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:154
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:88
struct mbedtls_pk_debug_item mbedtls_pk_debug_item
Item to send to the debug module.
The RSA context structure.
Definition: rsa.h:136
Item to send to the debug module.
Definition: pk.h:152
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).