mbed TLS v2.16.9
rsa.h
Go to the documentation of this file.
1 
12 /*
13  * Copyright The Mbed TLS Contributors
14  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
15  *
16  * This file is provided under the Apache License 2.0, or the
17  * GNU General Public License v2.0 or later.
18  *
19  * **********
20  * Apache License 2.0:
21  *
22  * Licensed under the Apache License, Version 2.0 (the "License"); you may
23  * not use this file except in compliance with the License.
24  * You may obtain a copy of the License at
25  *
26  * http://www.apache.org/licenses/LICENSE-2.0
27  *
28  * Unless required by applicable law or agreed to in writing, software
29  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
30  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
31  * See the License for the specific language governing permissions and
32  * limitations under the License.
33  *
34  * **********
35  *
36  * **********
37  * GNU General Public License v2.0 or later:
38  *
39  * This program is free software; you can redistribute it and/or modify
40  * it under the terms of the GNU General Public License as published by
41  * the Free Software Foundation; either version 2 of the License, or
42  * (at your option) any later version.
43  *
44  * This program is distributed in the hope that it will be useful,
45  * but WITHOUT ANY WARRANTY; without even the implied warranty of
46  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
47  * GNU General Public License for more details.
48  *
49  * You should have received a copy of the GNU General Public License along
50  * with this program; if not, write to the Free Software Foundation, Inc.,
51  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
52  *
53  * **********
54  */
55 #ifndef MBEDTLS_RSA_H
56 #define MBEDTLS_RSA_H
57 
58 #if !defined(MBEDTLS_CONFIG_FILE)
59 #include "config.h"
60 #else
61 #include MBEDTLS_CONFIG_FILE
62 #endif
63 
64 #include "bignum.h"
65 #include "md.h"
66 
67 #if defined(MBEDTLS_THREADING_C)
68 #include "threading.h"
69 #endif
70 
71 /*
72  * RSA Error codes
73  */
74 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
75 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
76 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
77 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
78 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
79 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
80 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
81 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
82 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
84 /* MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION is deprecated and should not be used.
85  */
86 #define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
88 /* MBEDTLS_ERR_RSA_HW_ACCEL_FAILED is deprecated and should not be used. */
89 #define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
91 /*
92  * RSA constants
93  */
94 #define MBEDTLS_RSA_PUBLIC 0
95 #define MBEDTLS_RSA_PRIVATE 1
97 #define MBEDTLS_RSA_PKCS_V15 0
98 #define MBEDTLS_RSA_PKCS_V21 1
100 #define MBEDTLS_RSA_SIGN 1
101 #define MBEDTLS_RSA_CRYPT 2
103 #define MBEDTLS_RSA_SALT_LEN_ANY -1
104 
105 /*
106  * The above constants may be used even if the RSA module is compile out,
107  * eg for alternative (PKCS#11) RSA implemenations in the PK layers.
108  */
109 
110 #ifdef __cplusplus
111 extern "C" {
112 #endif
113 
114 #if !defined(MBEDTLS_RSA_ALT)
115 // Regular implementation
116 //
117 
125 typedef struct mbedtls_rsa_context
126 {
127  int ver;
128  size_t len;
149  int padding;
152  int hash_id;
156 #if defined(MBEDTLS_THREADING_C)
158 #endif
159 }
161 
162 #else /* MBEDTLS_RSA_ALT */
163 #include "rsa_alt.h"
164 #endif /* MBEDTLS_RSA_ALT */
165 
194  int padding,
195  int hash_id );
196 
227  const mbedtls_mpi *N,
228  const mbedtls_mpi *P, const mbedtls_mpi *Q,
229  const mbedtls_mpi *D, const mbedtls_mpi *E );
230 
266  unsigned char const *N, size_t N_len,
267  unsigned char const *P, size_t P_len,
268  unsigned char const *Q, size_t Q_len,
269  unsigned char const *D, size_t D_len,
270  unsigned char const *E, size_t E_len );
271 
305 
348  mbedtls_mpi *D, mbedtls_mpi *E );
349 
398  unsigned char *N, size_t N_len,
399  unsigned char *P, size_t P_len,
400  unsigned char *Q, size_t Q_len,
401  unsigned char *D, size_t D_len,
402  unsigned char *E, size_t E_len );
403 
424  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP );
425 
436  int hash_id );
437 
447 
467  int (*f_rng)(void *, unsigned char *, size_t),
468  void *p_rng,
469  unsigned int nbits, int exponent );
470 
486 
524 
537  const mbedtls_rsa_context *prv );
538 
559  const unsigned char *input,
560  unsigned char *output );
561 
594  int (*f_rng)(void *, unsigned char *, size_t),
595  void *p_rng,
596  const unsigned char *input,
597  unsigned char *output );
598 
638  int (*f_rng)(void *, unsigned char *, size_t),
639  void *p_rng,
640  int mode, size_t ilen,
641  const unsigned char *input,
642  unsigned char *output );
643 
678  int (*f_rng)(void *, unsigned char *, size_t),
679  void *p_rng,
680  int mode, size_t ilen,
681  const unsigned char *input,
682  unsigned char *output );
683 
722  int (*f_rng)(void *, unsigned char *, size_t),
723  void *p_rng,
724  int mode,
725  const unsigned char *label, size_t label_len,
726  size_t ilen,
727  const unsigned char *input,
728  unsigned char *output );
729 
775  int (*f_rng)(void *, unsigned char *, size_t),
776  void *p_rng,
777  int mode, size_t *olen,
778  const unsigned char *input,
779  unsigned char *output,
780  size_t output_max_len );
781 
825  int (*f_rng)(void *, unsigned char *, size_t),
826  void *p_rng,
827  int mode, size_t *olen,
828  const unsigned char *input,
829  unsigned char *output,
830  size_t output_max_len );
831 
879  int (*f_rng)(void *, unsigned char *, size_t),
880  void *p_rng,
881  int mode,
882  const unsigned char *label, size_t label_len,
883  size_t *olen,
884  const unsigned char *input,
885  unsigned char *output,
886  size_t output_max_len );
887 
939  int (*f_rng)(void *, unsigned char *, size_t),
940  void *p_rng,
941  int mode,
942  mbedtls_md_type_t md_alg,
943  unsigned int hashlen,
944  const unsigned char *hash,
945  unsigned char *sig );
946 
987  int (*f_rng)(void *, unsigned char *, size_t),
988  void *p_rng,
989  int mode,
990  mbedtls_md_type_t md_alg,
991  unsigned int hashlen,
992  const unsigned char *hash,
993  unsigned char *sig );
994 
1049  int (*f_rng)(void *, unsigned char *, size_t),
1050  void *p_rng,
1051  int mode,
1052  mbedtls_md_type_t md_alg,
1053  unsigned int hashlen,
1054  const unsigned char *hash,
1055  unsigned char *sig );
1056 
1102  int (*f_rng)(void *, unsigned char *, size_t),
1103  void *p_rng,
1104  int mode,
1105  mbedtls_md_type_t md_alg,
1106  unsigned int hashlen,
1107  const unsigned char *hash,
1108  const unsigned char *sig );
1109 
1148  int (*f_rng)(void *, unsigned char *, size_t),
1149  void *p_rng,
1150  int mode,
1151  mbedtls_md_type_t md_alg,
1152  unsigned int hashlen,
1153  const unsigned char *hash,
1154  const unsigned char *sig );
1155 
1205  int (*f_rng)(void *, unsigned char *, size_t),
1206  void *p_rng,
1207  int mode,
1208  mbedtls_md_type_t md_alg,
1209  unsigned int hashlen,
1210  const unsigned char *hash,
1211  const unsigned char *sig );
1212 
1253  int (*f_rng)(void *, unsigned char *, size_t),
1254  void *p_rng,
1255  int mode,
1256  mbedtls_md_type_t md_alg,
1257  unsigned int hashlen,
1258  const unsigned char *hash,
1259  mbedtls_md_type_t mgf1_hash_id,
1260  int expected_salt_len,
1261  const unsigned char *sig );
1262 
1273 
1282 
1283 #if defined(MBEDTLS_SELF_TEST)
1284 
1291 int mbedtls_rsa_self_test( int verbose );
1292 
1293 #endif /* MBEDTLS_SELF_TEST */
1294 
1295 #ifdef __cplusplus
1296 }
1297 #endif
1298 
1299 #endif /* rsa.h */
Multi-precision integer library.
Configuration options (set of defines)
This file contains the generic message-digest wrapper.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:83
int mbedtls_rsa_pkcs1_encrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t ilen, const unsigned char *input, unsigned char *output)
This function adds the message padding, then performs an RSA operation.
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
int mbedtls_rsa_pkcs1_verify(mbedtls_rsa_context *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, const unsigned char *sig)
This function performs a public RSA operation and checks the message digest.
void mbedtls_rsa_init(mbedtls_rsa_context *ctx, int padding, int hash_id)
This function initializes an RSA context.
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
int mbedtls_rsa_rsassa_pkcs1_v15_verify(mbedtls_rsa_context *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, const unsigned char *sig)
This function performs a PKCS#1 v1.5 verification operation (RSASSA-PKCS1-v1_5-VERIFY).
int mbedtls_rsa_import(mbedtls_rsa_context *ctx, const mbedtls_mpi *N, const mbedtls_mpi *P, const mbedtls_mpi *Q, const mbedtls_mpi *D, const mbedtls_mpi *E)
This function imports a set of core parameters into an RSA context.
int mbedtls_rsa_check_pub_priv(const mbedtls_rsa_context *pub, const mbedtls_rsa_context *prv)
This function checks a public-private RSA key pair.
int mbedtls_rsa_import_raw(mbedtls_rsa_context *ctx, unsigned char const *N, size_t N_len, unsigned char const *P, size_t P_len, unsigned char const *Q, size_t Q_len, unsigned char const *D, size_t D_len, unsigned char const *E, size_t E_len)
This function imports core RSA parameters, in raw big-endian binary format, into an RSA context.
int mbedtls_rsa_private(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, const unsigned char *input, unsigned char *output)
This function performs an RSA private key operation.
int mbedtls_rsa_gen_key(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, unsigned int nbits, int exponent)
This function generates an RSA keypair.
int mbedtls_rsa_pkcs1_sign(mbedtls_rsa_context *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)
This function performs a private RSA operation to sign a message digest using PKCS#1.
size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx)
This function retrieves the length of RSA modulus in Bytes.
int mbedtls_rsa_rsaes_pkcs1_v15_encrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t ilen, const unsigned char *input, unsigned char *output)
This function performs a PKCS#1 v1.5 encryption operation (RSAES-PKCS1-v1_5-ENCRYPT).
int mbedtls_rsa_rsaes_pkcs1_v15_decrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len)
This function performs a PKCS#1 v1.5 decryption operation (RSAES-PKCS1-v1_5-DECRYPT).
int mbedtls_rsa_pkcs1_decrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len)
This function performs an RSA operation, then removes the message padding.
struct mbedtls_rsa_context mbedtls_rsa_context
The RSA context structure.
int mbedtls_rsa_export(const mbedtls_rsa_context *ctx, mbedtls_mpi *N, mbedtls_mpi *P, mbedtls_mpi *Q, mbedtls_mpi *D, mbedtls_mpi *E)
This function exports the core parameters of an RSA key.
int mbedtls_rsa_export_raw(const mbedtls_rsa_context *ctx, unsigned char *N, size_t N_len, unsigned char *P, size_t P_len, unsigned char *Q, size_t Q_len, unsigned char *D, size_t D_len, unsigned char *E, size_t E_len)
This function exports core parameters of an RSA key in raw big-endian binary format.
int mbedtls_rsa_copy(mbedtls_rsa_context *dst, const mbedtls_rsa_context *src)
This function copies the components of an RSA context.
int mbedtls_rsa_rsassa_pss_verify(mbedtls_rsa_context *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, const unsigned char *sig)
This function performs a PKCS#1 v2.1 PSS verification operation (RSASSA-PSS-VERIFY).
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
int mbedtls_rsa_export_crt(const mbedtls_rsa_context *ctx, mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP)
This function exports CRT parameters of a private RSA key.
int mbedtls_rsa_public(mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output)
This function performs an RSA public key operation.
int mbedtls_rsa_check_privkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains an RSA private key and perform basic consistency checks.
int mbedtls_rsa_rsassa_pss_verify_ext(mbedtls_rsa_context *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, mbedtls_md_type_t mgf1_hash_id, int expected_salt_len, const unsigned char *sig)
This function performs a PKCS#1 v2.1 PSS verification operation (RSASSA-PSS-VERIFY).
int mbedtls_rsa_rsaes_oaep_encrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, const unsigned char *label, size_t label_len, size_t ilen, const unsigned char *input, unsigned char *output)
This function performs a PKCS#1 v2.1 OAEP encryption operation (RSAES-OAEP-ENCRYPT).
int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains at least an RSA public key.
void mbedtls_rsa_set_padding(mbedtls_rsa_context *ctx, int padding, int hash_id)
This function sets padding for an already initialized RSA context. See mbedtls_rsa_init() for details...
int mbedtls_rsa_rsassa_pss_sign(mbedtls_rsa_context *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)
This function performs a PKCS#1 v2.1 PSS signature operation (RSASSA-PSS-SIGN).
int mbedtls_rsa_rsassa_pkcs1_v15_sign(mbedtls_rsa_context *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)
This function performs a PKCS#1 v1.5 signature operation (RSASSA-PKCS1-v1_5-SIGN).
int mbedtls_rsa_rsaes_oaep_decrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, const unsigned char *label, size_t label_len, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len)
This function performs a PKCS#1 v2.1 OAEP decryption operation (RSAES-OAEP-DECRYPT).
MPI structure.
Definition: bignum.h:211
The RSA context structure.
Definition: rsa.h:126
size_t len
Definition: rsa.h:128
mbedtls_threading_mutex_t mutex
Definition: rsa.h:157
mbedtls_mpi N
Definition: rsa.h:130
mbedtls_mpi RQ
Definition: rsa.h:144
mbedtls_mpi Vf
Definition: rsa.h:147
mbedtls_mpi RN
Definition: rsa.h:141
mbedtls_mpi Q
Definition: rsa.h:135
mbedtls_mpi DQ
Definition: rsa.h:138
mbedtls_mpi E
Definition: rsa.h:131
mbedtls_mpi QP
Definition: rsa.h:139
mbedtls_mpi RP
Definition: rsa.h:143
mbedtls_mpi DP
Definition: rsa.h:137
mbedtls_mpi P
Definition: rsa.h:134
mbedtls_mpi D
Definition: rsa.h:133
mbedtls_mpi Vi
Definition: rsa.h:146
Threading abstraction layer.