mbed TLS v2.16.7
pk.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
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  * This file is part of mbed TLS (https://tls.mbed.org)
50  */
51 
52 #ifndef MBEDTLS_PK_H
53 #define MBEDTLS_PK_H
54 
55 #if !defined(MBEDTLS_CONFIG_FILE)
56 #include "config.h"
57 #else
58 #include MBEDTLS_CONFIG_FILE
59 #endif
60 
61 #include "md.h"
62 
63 #if defined(MBEDTLS_RSA_C)
64 #include "rsa.h"
65 #endif
66 
67 #if defined(MBEDTLS_ECP_C)
68 #include "ecp.h"
69 #endif
70 
71 #if defined(MBEDTLS_ECDSA_C)
72 #include "ecdsa.h"
73 #endif
74 
75 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
76  !defined(inline) && !defined(__cplusplus)
77 #define inline __inline
78 #endif
79 
80 #define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80
81 #define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00
82 #define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80
83 #define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00
84 #define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80
85 #define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00
86 #define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80
87 #define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00
88 #define MBEDTLS_ERR_PK_PASSWORD_MISMATCH -0x3B80
89 #define MBEDTLS_ERR_PK_INVALID_PUBKEY -0x3B00
90 #define MBEDTLS_ERR_PK_INVALID_ALG -0x3A80
91 #define MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE -0x3A00
92 #define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980
93 #define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900
95 /* MBEDTLS_ERR_PK_HW_ACCEL_FAILED is deprecated and should not be used. */
96 #define MBEDTLS_ERR_PK_HW_ACCEL_FAILED -0x3880
98 #ifdef __cplusplus
99 extern "C" {
100 #endif
101 
105 typedef enum {
114 
120 {
123 
125 
129 typedef enum
130 {
135 
139 typedef struct mbedtls_pk_debug_item
140 {
142  const char *name;
143  void *value;
145 
147 #define MBEDTLS_PK_DEBUG_MAX_ITEMS 3
148 
152 typedef struct mbedtls_pk_info_t mbedtls_pk_info_t;
153 
157 typedef struct mbedtls_pk_context
158 {
160  void * pk_ctx;
162 
163 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
164 
167 typedef struct
168 {
169  const mbedtls_pk_info_t * pk_info;
170  void * rs_ctx;
172 #else /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
173 /* Now we can declare functions that take a pointer to that */
175 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
176 
177 #if defined(MBEDTLS_RSA_C)
178 
185 {
186  return( (mbedtls_rsa_context *) (pk).pk_ctx );
187 }
188 #endif /* MBEDTLS_RSA_C */
189 
190 #if defined(MBEDTLS_ECP_C)
191 
198 {
199  return( (mbedtls_ecp_keypair *) (pk).pk_ctx );
200 }
201 #endif /* MBEDTLS_ECP_C */
202 
203 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
204 
207 typedef int (*mbedtls_pk_rsa_alt_decrypt_func)( void *ctx, int mode, size_t *olen,
208  const unsigned char *input, unsigned char *output,
209  size_t output_max_len );
210 typedef int (*mbedtls_pk_rsa_alt_sign_func)( void *ctx,
211  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
212  int mode, mbedtls_md_type_t md_alg, unsigned int hashlen,
213  const unsigned char *hash, unsigned char *sig );
214 typedef size_t (*mbedtls_pk_rsa_alt_key_len_func)( void *ctx );
215 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
216 
225 
233 
241 
242 #if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_ECP_RESTARTABLE)
243 
249 void mbedtls_pk_restart_init( mbedtls_pk_restart_ctx *ctx );
250 
257 void mbedtls_pk_restart_free( mbedtls_pk_restart_ctx *ctx );
258 #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
259 
276 
277 #if defined(MBEDTLS_PK_RSA_ALT_SUPPORT)
278 
294  mbedtls_pk_rsa_alt_decrypt_func decrypt_func,
296  mbedtls_pk_rsa_alt_key_len_func key_len_func );
297 #endif /* MBEDTLS_PK_RSA_ALT_SUPPORT */
298 
307 
315 static inline size_t mbedtls_pk_get_len( const mbedtls_pk_context *ctx )
316 {
317  return( ( mbedtls_pk_get_bitlen( ctx ) + 7 ) / 8 );
318 }
319 
333 
359  const unsigned char *hash, size_t hash_len,
360  const unsigned char *sig, size_t sig_len );
361 
383  mbedtls_md_type_t md_alg,
384  const unsigned char *hash, size_t hash_len,
385  const unsigned char *sig, size_t sig_len,
386  mbedtls_pk_restart_ctx *rs_ctx );
387 
417 int mbedtls_pk_verify_ext( mbedtls_pk_type_t type, const void *options,
419  const unsigned char *hash, size_t hash_len,
420  const unsigned char *sig, size_t sig_len );
421 
452  const unsigned char *hash, size_t hash_len,
453  unsigned char *sig, size_t *sig_len,
454  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
455 
484  mbedtls_md_type_t md_alg,
485  const unsigned char *hash, size_t hash_len,
486  unsigned char *sig, size_t *sig_len,
487  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
488  mbedtls_pk_restart_ctx *rs_ctx );
489 
508  const unsigned char *input, size_t ilen,
509  unsigned char *output, size_t *olen, size_t osize,
510  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
511 
529  const unsigned char *input, size_t ilen,
530  unsigned char *output, size_t *olen, size_t osize,
531  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
532 
542 
552 
560 const char * mbedtls_pk_get_name( const mbedtls_pk_context *ctx );
561 
571 
572 #if defined(MBEDTLS_PK_PARSE_C)
573 
603  const unsigned char *key, size_t keylen,
604  const unsigned char *pwd, size_t pwdlen );
605 
629  const unsigned char *key, size_t keylen );
630 
631 #if defined(MBEDTLS_FS_IO)
632 
654  const char *path, const char *password );
655 
674 #endif /* MBEDTLS_FS_IO */
675 #endif /* MBEDTLS_PK_PARSE_C */
676 
677 #if defined(MBEDTLS_PK_WRITE_C)
678 
691 int mbedtls_pk_write_key_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
692 
706 int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
707 
708 #if defined(MBEDTLS_PEM_WRITE_C)
709 
719 int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
720 
731 int mbedtls_pk_write_key_pem( mbedtls_pk_context *ctx, unsigned char *buf, size_t size );
732 #endif /* MBEDTLS_PEM_WRITE_C */
733 #endif /* MBEDTLS_PK_WRITE_C */
734 
735 /*
736  * WARNING: Low-level functions. You probably do not want to use these unless
737  * you are certain you do ;)
738  */
739 
740 #if defined(MBEDTLS_PK_PARSE_C)
741 
751 int mbedtls_pk_parse_subpubkey( unsigned char **p, const unsigned char *end,
752  mbedtls_pk_context *pk );
753 #endif /* MBEDTLS_PK_PARSE_C */
754 
755 #if defined(MBEDTLS_PK_WRITE_C)
756 
766 int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
767  const mbedtls_pk_context *key );
768 #endif /* MBEDTLS_PK_WRITE_C */
769 
770 /*
771  * Internal module functions. You probably do not want to use these unless you
772  * know you do.
773  */
774 #if defined(MBEDTLS_FS_IO)
775 int mbedtls_pk_load_file( const char *path, unsigned char **buf, size_t *n );
776 #endif
777 
778 #ifdef __cplusplus
779 }
780 #endif
781 
782 #endif /* MBEDTLS_PK_H */
mbedtls_pk_parse_public_keyfile
int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path)
Load and parse a public key.
MBEDTLS_PK_RSA_ALT
@ MBEDTLS_PK_RSA_ALT
Definition: pk.h:111
MBEDTLS_PK_ECKEY_DH
@ MBEDTLS_PK_ECKEY_DH
Definition: pk.h:109
mbedtls_pk_debug_item::name
const char * name
Definition: pk.h:142
mbedtls_pk_rsassa_pss_options
struct mbedtls_pk_rsassa_pss_options mbedtls_pk_rsassa_pss_options
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext()
mbedtls_pk_sign_restartable
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()
mbedtls_md_type_t
mbedtls_md_type_t
Supported message digests.
Definition: md.h:85
mbedtls_pk_verify_restartable
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()
ecp.h
This file provides an API for Elliptic Curves over GF(P) (ECP).
mbedtls_pk_debug_item::value
void * value
Definition: pk.h:143
MBEDTLS_PK_DEBUG_MPI
@ MBEDTLS_PK_DEBUG_MPI
Definition: pk.h:132
mbedtls_pk_parse_subpubkey
int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end, mbedtls_pk_context *pk)
Parse a SubjectPublicKeyInfo DER structure.
ecdsa.h
This file contains ECDSA definitions and functions.
mbedtls_pk_can_do
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.
mbedtls_pk_rsassa_pss_options
Options for RSASSA-PSS signature verification. See mbedtls_rsa_rsassa_pss_verify_ext()
Definition: pk.h:120
mbedtls_pk_verify
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).
md.h
This file contains the generic message-digest wrapper.
mbedtls_pk_context
Public key container.
Definition: pk.h:158
mbedtls_pk_write_pubkey
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.
mbedtls_pk_parse_keyfile
int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx, const char *path, const char *password)
Load and parse a private key.
mbedtls_pk_get_type
mbedtls_pk_type_t mbedtls_pk_get_type(const mbedtls_pk_context *ctx)
Get the key type.
mbedtls_pk_context::pk_ctx
void * pk_ctx
Definition: pk.h:160
mbedtls_pk_context::pk_info
const mbedtls_pk_info_t * pk_info
Definition: pk.h:159
mbedtls_pk_setup
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.
mbedtls_pk_ec
static mbedtls_ecp_keypair * mbedtls_pk_ec(const mbedtls_pk_context pk)
Definition: pk.h:197
MBEDTLS_PK_DEBUG_NONE
@ MBEDTLS_PK_DEBUG_NONE
Definition: pk.h:131
mbedtls_pk_parse_public_key
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.
mbedtls_pk_restart_ctx
void mbedtls_pk_restart_ctx
Definition: pk.h:174
mbedtls_pk_rsa_alt_key_len_func
size_t(* mbedtls_pk_rsa_alt_key_len_func)(void *ctx)
Definition: pk.h:214
mbedtls_pk_rsassa_pss_options::expected_salt_len
int expected_salt_len
Definition: pk.h:122
mbedtls_pk_debug
int mbedtls_pk_debug(const mbedtls_pk_context *ctx, mbedtls_pk_debug_item *items)
Export debug information.
mbedtls_pk_debug_item::type
mbedtls_pk_debug_type type
Definition: pk.h:141
mbedtls_ecp_keypair
The ECP key-pair structure.
Definition: ecp.h:360
rsa.h
This file provides an API for the RSA public-key cryptosystem.
mbedtls_pk_get_bitlen
size_t mbedtls_pk_get_bitlen(const mbedtls_pk_context *ctx)
Get the size in bits of the underlying key.
mbedtls_pk_get_len
static size_t mbedtls_pk_get_len(const mbedtls_pk_context *ctx)
Get the length in bytes of the underlying key.
Definition: pk.h:315
mbedtls_pk_debug_item
Item to send to the debug module.
Definition: pk.h:140
mbedtls_pk_parse_key
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.
mbedtls_pk_decrypt
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).
MBEDTLS_PK_NONE
@ MBEDTLS_PK_NONE
Definition: pk.h:106
mbedtls_pk_verify_ext
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....
mbedtls_pk_type_t
mbedtls_pk_type_t
Public key types.
Definition: pk.h:105
mbedtls_pk_setup_rsa_alt
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.
MBEDTLS_PK_RSASSA_PSS
@ MBEDTLS_PK_RSASSA_PSS
Definition: pk.h:112
mbedtls_rsa_context
The RSA context structure.
Definition: rsa.h:128
MBEDTLS_PK_ECDSA
@ MBEDTLS_PK_ECDSA
Definition: pk.h:110
mbedtls_pk_rsa_alt_decrypt_func
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:207
mbedtls_pk_rsassa_pss_options::mgf1_hash_id
mbedtls_md_type_t mgf1_hash_id
Definition: pk.h:121
mbedtls_pk_write_pubkey_der
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...
mbedtls_pk_write_key_der
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!...
mbedtls_pk_get_name
const char * mbedtls_pk_get_name(const mbedtls_pk_context *ctx)
Access the type name.
mbedtls_pk_debug_type
mbedtls_pk_debug_type
Types for interfacing with the debug module.
Definition: pk.h:130
mbedtls_pk_info_from_type
const mbedtls_pk_info_t * mbedtls_pk_info_from_type(mbedtls_pk_type_t pk_type)
Return information associated with the given PK type.
mbedtls_pk_info_t
struct mbedtls_pk_info_t mbedtls_pk_info_t
Public key information and operations.
Definition: pk.h:152
config.h
Configuration options (set of defines)
mbedtls_pk_debug_item
struct mbedtls_pk_debug_item mbedtls_pk_debug_item
Item to send to the debug module.
MBEDTLS_PK_ECKEY
@ MBEDTLS_PK_ECKEY
Definition: pk.h:108
mbedtls_pk_write_pubkey_pem
int mbedtls_pk_write_pubkey_pem(mbedtls_pk_context *ctx, unsigned char *buf, size_t size)
Write a public key to a PEM string.
MBEDTLS_PK_DEBUG_ECP
@ MBEDTLS_PK_DEBUG_ECP
Definition: pk.h:133
mbedtls_pk_sign
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.
mbedtls_pk_write_key_pem
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.
mbedtls_pk_encrypt
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).
mbedtls_pk_init
void mbedtls_pk_init(mbedtls_pk_context *ctx)
Initialize a mbedtls_pk_context (as NONE).
mbedtls_pk_check_pair
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_pk_rsa
static mbedtls_rsa_context * mbedtls_pk_rsa(const mbedtls_pk_context pk)
Definition: pk.h:184
MBEDTLS_PK_RSA
@ MBEDTLS_PK_RSA
Definition: pk.h:107
mbedtls_pk_free
void mbedtls_pk_free(mbedtls_pk_context *ctx)
Free the components of a mbedtls_pk_context.
mbedtls_pk_rsa_alt_sign_func
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:210
mbedtls_pk_load_file
int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n)
mbedtls_pk_context
struct mbedtls_pk_context mbedtls_pk_context
Public key container.