mbed TLS v2.7.17
rsa.h
Go to the documentation of this file.
1 
11 /*
12  * Copyright The Mbed TLS Contributors
13  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
14  *
15  * This file is provided under the Apache License 2.0, or the
16  * GNU General Public License v2.0 or later.
17  *
18  * **********
19  * Apache License 2.0:
20  *
21  * Licensed under the Apache License, Version 2.0 (the "License"); you may
22  * not use this file except in compliance with the License.
23  * You may obtain a copy of the License at
24  *
25  * http://www.apache.org/licenses/LICENSE-2.0
26  *
27  * Unless required by applicable law or agreed to in writing, software
28  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
29  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
30  * See the License for the specific language governing permissions and
31  * limitations under the License.
32  *
33  * **********
34  *
35  * **********
36  * GNU General Public License v2.0 or later:
37  *
38  * This program is free software; you can redistribute it and/or modify
39  * it under the terms of the GNU General Public License as published by
40  * the Free Software Foundation; either version 2 of the License, or
41  * (at your option) any later version.
42  *
43  * This program is distributed in the hope that it will be useful,
44  * but WITHOUT ANY WARRANTY; without even the implied warranty of
45  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
46  * GNU General Public License for more details.
47  *
48  * You should have received a copy of the GNU General Public License along
49  * with this program; if not, write to the Free Software Foundation, Inc.,
50  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
51  *
52  * **********
53  */
54 #ifndef MBEDTLS_RSA_H
55 #define MBEDTLS_RSA_H
56 
57 #if !defined(MBEDTLS_CONFIG_FILE)
58 #include "config.h"
59 #else
60 #include MBEDTLS_CONFIG_FILE
61 #endif
62 
63 #include "bignum.h"
64 #include "md.h"
65 
66 #if defined(MBEDTLS_THREADING_C)
67 #include "threading.h"
68 #endif
69 
70 /*
71  * RSA Error codes
72  */
73 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
74 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
75 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
76 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
77 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
78 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
79 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
80 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
81 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
82 #define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
83 #define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
85 /*
86  * RSA constants
87  */
88 #define MBEDTLS_RSA_PUBLIC 0
89 #define MBEDTLS_RSA_PRIVATE 1
91 #define MBEDTLS_RSA_PKCS_V15 0
92 #define MBEDTLS_RSA_PKCS_V21 1
94 #define MBEDTLS_RSA_SIGN 1
95 #define MBEDTLS_RSA_CRYPT 2
97 #define MBEDTLS_RSA_SALT_LEN_ANY -1
98 
99 /*
100  * The above constants may be used even if the RSA module is compile out,
101  * eg for alternative (PKCS#11) RSA implemenations in the PK layers.
102  */
103 
104 #if !defined(MBEDTLS_RSA_ALT)
105 // Regular implementation
106 //
107 
108 #ifdef __cplusplus
109 extern "C" {
110 #endif
111 
119 typedef struct
120 {
121  int ver;
122  size_t len;
143  int padding;
146  int hash_id;
150 #if defined(MBEDTLS_THREADING_C)
152 #endif
153 }
155 
183  int padding,
184  int hash_id);
185 
215  const mbedtls_mpi *N,
216  const mbedtls_mpi *P, const mbedtls_mpi *Q,
217  const mbedtls_mpi *D, const mbedtls_mpi *E );
218 
253  unsigned char const *N, size_t N_len,
254  unsigned char const *P, size_t P_len,
255  unsigned char const *Q, size_t Q_len,
256  unsigned char const *D, size_t D_len,
257  unsigned char const *E, size_t E_len );
258 
291 
329  mbedtls_mpi *D, mbedtls_mpi *E );
330 
376  unsigned char *N, size_t N_len,
377  unsigned char *P, size_t P_len,
378  unsigned char *Q, size_t Q_len,
379  unsigned char *D, size_t D_len,
380  unsigned char *E, size_t E_len );
381 
398  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP );
399 
409 void mbedtls_rsa_set_padding( mbedtls_rsa_context *ctx, int padding,
410  int hash_id);
411 
420 size_t mbedtls_rsa_get_len( const mbedtls_rsa_context *ctx );
421 
438  int (*f_rng)(void *, unsigned char *, size_t),
439  void *p_rng,
440  unsigned int nbits, int exponent );
441 
457 
495 
508  const mbedtls_rsa_context *prv );
509 
529  const unsigned char *input,
530  unsigned char *output );
531 
560  int (*f_rng)(void *, unsigned char *, size_t),
561  void *p_rng,
562  const unsigned char *input,
563  unsigned char *output );
564 
598  int (*f_rng)(void *, unsigned char *, size_t),
599  void *p_rng,
600  int mode, size_t ilen,
601  const unsigned char *input,
602  unsigned char *output );
603 
633  int (*f_rng)(void *, unsigned char *, size_t),
634  void *p_rng,
635  int mode, size_t ilen,
636  const unsigned char *input,
637  unsigned char *output );
638 
670  int (*f_rng)(void *, unsigned char *, size_t),
671  void *p_rng,
672  int mode,
673  const unsigned char *label, size_t label_len,
674  size_t ilen,
675  const unsigned char *input,
676  unsigned char *output );
677 
717  int (*f_rng)(void *, unsigned char *, size_t),
718  void *p_rng,
719  int mode, size_t *olen,
720  const unsigned char *input,
721  unsigned char *output,
722  size_t output_max_len );
723 
760  int (*f_rng)(void *, unsigned char *, size_t),
761  void *p_rng,
762  int mode, size_t *olen,
763  const unsigned char *input,
764  unsigned char *output,
765  size_t output_max_len );
766 
806  int (*f_rng)(void *, unsigned char *, size_t),
807  void *p_rng,
808  int mode,
809  const unsigned char *label, size_t label_len,
810  size_t *olen,
811  const unsigned char *input,
812  unsigned char *output,
813  size_t output_max_len );
814 
854  int (*f_rng)(void *, unsigned char *, size_t),
855  void *p_rng,
856  int mode,
857  mbedtls_md_type_t md_alg,
858  unsigned int hashlen,
859  const unsigned char *hash,
860  unsigned char *sig );
861 
894  int (*f_rng)(void *, unsigned char *, size_t),
895  void *p_rng,
896  int mode,
897  mbedtls_md_type_t md_alg,
898  unsigned int hashlen,
899  const unsigned char *hash,
900  unsigned char *sig );
901 
942  int (*f_rng)(void *, unsigned char *, size_t),
943  void *p_rng,
944  int mode,
945  mbedtls_md_type_t md_alg,
946  unsigned int hashlen,
947  const unsigned char *hash,
948  unsigned char *sig );
949 
988  int (*f_rng)(void *, unsigned char *, size_t),
989  void *p_rng,
990  int mode,
991  mbedtls_md_type_t md_alg,
992  unsigned int hashlen,
993  const unsigned char *hash,
994  const unsigned char *sig );
995 
1027  int (*f_rng)(void *, unsigned char *, size_t),
1028  void *p_rng,
1029  int mode,
1030  mbedtls_md_type_t md_alg,
1031  unsigned int hashlen,
1032  const unsigned char *hash,
1033  const unsigned char *sig );
1034 
1077  int (*f_rng)(void *, unsigned char *, size_t),
1078  void *p_rng,
1079  int mode,
1080  mbedtls_md_type_t md_alg,
1081  unsigned int hashlen,
1082  const unsigned char *hash,
1083  const unsigned char *sig );
1084 
1115  int (*f_rng)(void *, unsigned char *, size_t),
1116  void *p_rng,
1117  int mode,
1118  mbedtls_md_type_t md_alg,
1119  unsigned int hashlen,
1120  const unsigned char *hash,
1121  mbedtls_md_type_t mgf1_hash_id,
1122  int expected_salt_len,
1123  const unsigned char *sig );
1124 
1135 
1142 
1143 #ifdef __cplusplus
1144 }
1145 #endif
1146 
1147 #else /* MBEDTLS_RSA_ALT */
1148 #include "rsa_alt.h"
1149 #endif /* MBEDTLS_RSA_ALT */
1150 
1151 #ifdef __cplusplus
1152 extern "C" {
1153 #endif
1154 
1160 int mbedtls_rsa_self_test( int verbose );
1161 
1162 #ifdef __cplusplus
1163 }
1164 #endif
1165 
1166 #endif /* rsa.h */
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
mbedtls_mpi DP
Definition: rsa.h:131
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_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_public(mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output)
This function performs an RSA public key operation.
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).
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_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.
Configuration options (set of defines)
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
mbedtls_mpi DQ
Definition: rsa.h:132
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.
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...
Multi-precision integer library.
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).
mbedtls_threading_mutex_t mutex
Definition: rsa.h:151
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.
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_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...
mbedtls_mpi RP
Definition: rsa.h:137
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.
Threading abstraction layer.
mbedtls_mpi P
Definition: rsa.h:128
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_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_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_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).
mbedtls_mpi E
Definition: rsa.h:125
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.
size_t len
Definition: rsa.h:122
mbedtls_mpi Vf
Definition: rsa.h:141
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.
mbedtls_mpi QP
Definition: rsa.h:133
mbedtls_mpi D
Definition: rsa.h:127
The generic message-digest wrapper.
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).
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).
size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx)
This function retrieves the length of RSA modulus in Bytes.
MPI structure.
Definition: bignum.h:205
mbedtls_mpi N
Definition: rsa.h:124
int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains at least an RSA public key.
mbedtls_mpi RN
Definition: rsa.h:135
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
mbedtls_mpi RQ
Definition: rsa.h:138
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_copy(mbedtls_rsa_context *dst, const mbedtls_rsa_context *src)
This function copies the components of an RSA context.
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...
mbedtls_mpi Vi
Definition: rsa.h:140
mbedtls_md_type_t
Enumeration of supported message digests.
Definition: md.h:81
mbedtls_mpi Q
Definition: rsa.h:129
The RSA context structure.
Definition: rsa.h:119
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).
void mbedtls_rsa_init(mbedtls_rsa_context *ctx, int padding, int hash_id)
This function initializes an RSA context.