Mbed TLS v3.6.7
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 #ifndef MBEDTLS_RSA_H
17 #define MBEDTLS_RSA_H
18 #include "mbedtls/private_access.h"
19 
20 #include "mbedtls/build_info.h"
21 
22 #include "mbedtls/bignum.h"
23 #include "mbedtls/md.h"
24 
25 #if defined(MBEDTLS_THREADING_C)
26 #include "mbedtls/threading.h"
27 #endif
28 
29 /*
30  * RSA Error codes
31  */
33 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
35 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
37 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
39 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
41 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
43 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
45 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
47 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
49 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
50 
51 /*
52  * RSA constants
53  */
54 
55 #define MBEDTLS_RSA_PKCS_V15 0
56 #define MBEDTLS_RSA_PKCS_V21 1
58 #define MBEDTLS_RSA_SIGN 1
59 #define MBEDTLS_RSA_CRYPT 2
61 #define MBEDTLS_RSA_SALT_LEN_ANY -1
62 
63 /*
64  * The above constants may be used even if the RSA module is compile out,
65  * eg for alternative (PKCS#11) RSA implementations in the PK layers.
66  */
67 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
72 #if !defined(MBEDTLS_RSA_ALT)
73 // Regular implementation
74 //
75 
76 #if !defined(MBEDTLS_RSA_GEN_KEY_MIN_BITS)
77 #define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024
78 #elif MBEDTLS_RSA_GEN_KEY_MIN_BITS < 128
79 #error "MBEDTLS_RSA_GEN_KEY_MIN_BITS must be at least 128 bits"
80 #endif
81 
85 typedef struct mbedtls_rsa_context {
86  int MBEDTLS_PRIVATE(ver);
90  size_t MBEDTLS_PRIVATE(len);
92  mbedtls_mpi MBEDTLS_PRIVATE(N);
93  mbedtls_mpi MBEDTLS_PRIVATE(E);
95  mbedtls_mpi MBEDTLS_PRIVATE(D);
96  mbedtls_mpi MBEDTLS_PRIVATE(P);
97  mbedtls_mpi MBEDTLS_PRIVATE(Q);
99  mbedtls_mpi MBEDTLS_PRIVATE(DP);
100  mbedtls_mpi MBEDTLS_PRIVATE(DQ);
101  mbedtls_mpi MBEDTLS_PRIVATE(QP);
103  mbedtls_mpi MBEDTLS_PRIVATE(RN);
105  mbedtls_mpi MBEDTLS_PRIVATE(RP);
106  mbedtls_mpi MBEDTLS_PRIVATE(RQ);
108  mbedtls_mpi MBEDTLS_PRIVATE(Vi);
109  mbedtls_mpi MBEDTLS_PRIVATE(Vf);
111  int MBEDTLS_PRIVATE(padding);
114  int MBEDTLS_PRIVATE(hash_id);
118 #if defined(MBEDTLS_THREADING_C)
119  /* Invariant: the mutex is initialized iff ver != 0. */
120  mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
121 #endif
122 }
123 mbedtls_rsa_context;
124 
125 #else /* MBEDTLS_RSA_ALT */
126 #include "rsa_alt.h"
127 #endif /* MBEDTLS_RSA_ALT */
128 
139 void mbedtls_rsa_init(mbedtls_rsa_context *ctx);
140 
175 int mbedtls_rsa_set_padding(mbedtls_rsa_context *ctx, int padding,
176  mbedtls_md_type_t hash_id);
177 
187 int mbedtls_rsa_get_padding_mode(const mbedtls_rsa_context *ctx);
188 
198 int mbedtls_rsa_get_md_alg(const mbedtls_rsa_context *ctx);
199 
229 int mbedtls_rsa_import(mbedtls_rsa_context *ctx,
230  const mbedtls_mpi *N,
231  const mbedtls_mpi *P, const mbedtls_mpi *Q,
232  const mbedtls_mpi *D, const mbedtls_mpi *E);
233 
268 int mbedtls_rsa_import_raw(mbedtls_rsa_context *ctx,
269  unsigned char const *N, size_t N_len,
270  unsigned char const *P, size_t P_len,
271  unsigned char const *Q, size_t Q_len,
272  unsigned char const *D, size_t D_len,
273  unsigned char const *E, size_t E_len);
274 
307 int mbedtls_rsa_complete(mbedtls_rsa_context *ctx);
308 
349 int mbedtls_rsa_export(const mbedtls_rsa_context *ctx,
350  mbedtls_mpi *N, mbedtls_mpi *P, mbedtls_mpi *Q,
351  mbedtls_mpi *D, mbedtls_mpi *E);
352 
400 int mbedtls_rsa_export_raw(const mbedtls_rsa_context *ctx,
401  unsigned char *N, size_t N_len,
402  unsigned char *P, size_t P_len,
403  unsigned char *Q, size_t Q_len,
404  unsigned char *D, size_t D_len,
405  unsigned char *E, size_t E_len);
406 
426 int mbedtls_rsa_export_crt(const mbedtls_rsa_context *ctx,
427  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP);
428 
437 size_t mbedtls_rsa_get_bitlen(const mbedtls_rsa_context *ctx);
438 
447 size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx);
448 
467 int mbedtls_rsa_gen_key(mbedtls_rsa_context *ctx,
468  mbedtls_f_rng_t *f_rng,
469  void *p_rng,
470  unsigned int nbits, int exponent);
471 
486 int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx);
487 
524 int mbedtls_rsa_check_privkey(const mbedtls_rsa_context *ctx);
525 
537 int mbedtls_rsa_check_pub_priv(const mbedtls_rsa_context *pub,
538  const mbedtls_rsa_context *prv);
539 
559 int mbedtls_rsa_public(mbedtls_rsa_context *ctx,
560  const unsigned char *input,
561  unsigned char *output);
562 
592 int mbedtls_rsa_private(mbedtls_rsa_context *ctx,
593  mbedtls_f_rng_t *f_rng,
594  void *p_rng,
595  const unsigned char *input,
596  unsigned char *output);
597 
621 int mbedtls_rsa_pkcs1_encrypt(mbedtls_rsa_context *ctx,
622  mbedtls_f_rng_t *f_rng,
623  void *p_rng,
624  size_t ilen,
625  const unsigned char *input,
626  unsigned char *output);
627 
648 int mbedtls_rsa_rsaes_pkcs1_v15_encrypt(mbedtls_rsa_context *ctx,
649  mbedtls_f_rng_t *f_rng,
650  void *p_rng,
651  size_t ilen,
652  const unsigned char *input,
653  unsigned char *output);
654 
682 int mbedtls_rsa_rsaes_oaep_encrypt(mbedtls_rsa_context *ctx,
683  mbedtls_f_rng_t *f_rng,
684  void *p_rng,
685  const unsigned char *label, size_t label_len,
686  size_t ilen,
687  const unsigned char *input,
688  unsigned char *output);
689 
727 int mbedtls_rsa_pkcs1_decrypt(mbedtls_rsa_context *ctx,
728  mbedtls_f_rng_t *f_rng,
729  void *p_rng,
730  size_t *olen,
731  const unsigned char *input,
732  unsigned char *output,
733  size_t output_max_len);
734 
773 int mbedtls_rsa_rsaes_pkcs1_v15_decrypt(mbedtls_rsa_context *ctx,
774  mbedtls_f_rng_t *f_rng,
775  void *p_rng,
776  size_t *olen,
777  const unsigned char *input,
778  unsigned char *output,
779  size_t output_max_len);
780 
814 int mbedtls_rsa_rsaes_oaep_decrypt(mbedtls_rsa_context *ctx,
815  mbedtls_f_rng_t *f_rng,
816  void *p_rng,
817  const unsigned char *label, size_t label_len,
818  size_t *olen,
819  const unsigned char *input,
820  unsigned char *output,
821  size_t output_max_len);
822 
857 int mbedtls_rsa_pkcs1_sign(mbedtls_rsa_context *ctx,
858  mbedtls_f_rng_t *f_rng,
859  void *p_rng,
860  mbedtls_md_type_t md_alg,
861  unsigned int hashlen,
862  const unsigned char *hash,
863  unsigned char *sig);
864 
889 int mbedtls_rsa_rsassa_pkcs1_v15_sign(mbedtls_rsa_context *ctx,
890  mbedtls_f_rng_t *f_rng,
891  void *p_rng,
892  mbedtls_md_type_t md_alg,
893  unsigned int hashlen,
894  const unsigned char *hash,
895  unsigned char *sig);
896 
897 #if defined(MBEDTLS_PKCS1_V21)
941 int mbedtls_rsa_rsassa_pss_sign_ext(mbedtls_rsa_context *ctx,
942  mbedtls_f_rng_t *f_rng,
943  void *p_rng,
944  mbedtls_md_type_t md_alg,
945  unsigned int hashlen,
946  const unsigned char *hash,
947  int saltlen,
948  unsigned char *sig);
949 
991 int mbedtls_rsa_rsassa_pss_sign(mbedtls_rsa_context *ctx,
992  mbedtls_f_rng_t *f_rng,
993  void *p_rng,
994  mbedtls_md_type_t md_alg,
995  unsigned int hashlen,
996  const unsigned char *hash,
997  unsigned char *sig);
998 #endif /* MBEDTLS_PKCS1_V21 */
999 
1026 int mbedtls_rsa_pkcs1_verify(mbedtls_rsa_context *ctx,
1027  mbedtls_md_type_t md_alg,
1028  unsigned int hashlen,
1029  const unsigned char *hash,
1030  const unsigned char *sig);
1031 
1051 int mbedtls_rsa_rsassa_pkcs1_v15_verify(mbedtls_rsa_context *ctx,
1052  mbedtls_md_type_t md_alg,
1053  unsigned int hashlen,
1054  const unsigned char *hash,
1055  const unsigned char *sig);
1056 
1086 int mbedtls_rsa_rsassa_pss_verify(mbedtls_rsa_context *ctx,
1087  mbedtls_md_type_t md_alg,
1088  unsigned int hashlen,
1089  const unsigned char *hash,
1090  const unsigned char *sig);
1091 
1126 int mbedtls_rsa_rsassa_pss_verify_ext(mbedtls_rsa_context *ctx,
1127  mbedtls_md_type_t md_alg,
1128  unsigned int hashlen,
1129  const unsigned char *hash,
1130  mbedtls_md_type_t mgf1_hash_id,
1131  int expected_salt_len,
1132  const unsigned char *sig);
1133 
1143 int mbedtls_rsa_copy(mbedtls_rsa_context *dst, const mbedtls_rsa_context *src);
1144 
1152 void mbedtls_rsa_free(mbedtls_rsa_context *ctx);
1153 
1154 #if defined(MBEDTLS_SELF_TEST)
1155 
1162 int mbedtls_rsa_self_test(int verbose);
1163 
1164 #endif /* MBEDTLS_SELF_TEST */
1165 
1166 #ifdef __cplusplus
1167 }
1168 #endif
1169 
1170 #endif /* rsa.h */
bignum.h
Multi-precision integer library.
build_info.h
Build-time configuration info.
md.h
This file contains the generic functions for message-digest (hashing) and HMAC.
mbedtls_md_type_t
mbedtls_md_type_t
Supported message digests.
Definition: md.h:47
mbedtls_f_rng_t
int mbedtls_f_rng_t(void *p_rng, unsigned char *output, size_t output_size)
The type of custom random generator (RNG) callbacks.
Definition: platform_util.h:209
private_access.h
Macro wrapper for struct's members.
MBEDTLS_PRIVATE
#define MBEDTLS_PRIVATE(member)
Definition: private_access.h:15
mbedtls_rsa_complete
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
mbedtls_rsa_pkcs1_encrypt
int mbedtls_rsa_pkcs1_encrypt(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, size_t ilen, const unsigned char *input, unsigned char *output)
This function adds the message padding, then performs an RSA operation.
mbedtls_rsa_gen_key
int mbedtls_rsa_gen_key(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, unsigned int nbits, int exponent)
This function generates an RSA keypair.
mbedtls_rsa_rsassa_pss_verify_ext
int mbedtls_rsa_rsassa_pss_verify_ext(mbedtls_rsa_context *ctx, 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_rsa_self_test
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
mbedtls_rsa_rsaes_oaep_encrypt
int mbedtls_rsa_rsaes_oaep_encrypt(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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).
mbedtls_rsa_import
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.
mbedtls_rsa_check_pub_priv
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.
mbedtls_rsa_pkcs1_decrypt
int mbedtls_rsa_pkcs1_decrypt(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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.
mbedtls_rsa_import_raw
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_rsa_rsaes_oaep_decrypt
int mbedtls_rsa_rsaes_oaep_decrypt(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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).
mbedtls_rsa_get_padding_mode
int mbedtls_rsa_get_padding_mode(const mbedtls_rsa_context *ctx)
This function retrieves padding mode of initialized RSA context.
mbedtls_rsa_get_len
size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx)
This function retrieves the length of RSA modulus in Bytes.
mbedtls_rsa_rsassa_pss_sign
int mbedtls_rsa_rsassa_pss_sign(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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).
mbedtls_rsa_set_padding
int mbedtls_rsa_set_padding(mbedtls_rsa_context *ctx, int padding, mbedtls_md_type_t hash_id)
This function sets padding for an already initialized RSA context.
mbedtls_rsa_context
struct mbedtls_rsa_context mbedtls_rsa_context
The RSA context structure.
mbedtls_rsa_get_bitlen
size_t mbedtls_rsa_get_bitlen(const mbedtls_rsa_context *ctx)
This function retrieves the length of the RSA modulus in bits.
mbedtls_rsa_get_md_alg
int mbedtls_rsa_get_md_alg(const mbedtls_rsa_context *ctx)
This function retrieves hash identifier of mbedtls_md_type_t type.
mbedtls_rsa_export
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.
mbedtls_rsa_export_raw
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.
mbedtls_rsa_rsaes_pkcs1_v15_encrypt
int mbedtls_rsa_rsaes_pkcs1_v15_encrypt(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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).
mbedtls_rsa_rsassa_pkcs1_v15_sign
int mbedtls_rsa_rsassa_pkcs1_v15_sign(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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).
mbedtls_rsa_copy
int mbedtls_rsa_copy(mbedtls_rsa_context *dst, const mbedtls_rsa_context *src)
This function copies the components of an RSA context.
mbedtls_rsa_rsassa_pss_verify
int mbedtls_rsa_rsassa_pss_verify(mbedtls_rsa_context *ctx, 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).
mbedtls_rsa_free
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
mbedtls_rsa_rsassa_pkcs1_v15_verify
int mbedtls_rsa_rsassa_pkcs1_v15_verify(mbedtls_rsa_context *ctx, 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_rsa_private
int mbedtls_rsa_private(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, const unsigned char *input, unsigned char *output)
This function performs an RSA private key operation.
mbedtls_rsa_pkcs1_sign
int mbedtls_rsa_pkcs1_sign(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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.
mbedtls_rsa_export_crt
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.
mbedtls_rsa_public
int mbedtls_rsa_public(mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output)
This function performs an RSA public key operation.
mbedtls_rsa_rsassa_pss_sign_ext
int mbedtls_rsa_rsassa_pss_sign_ext(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, mbedtls_md_type_t md_alg, unsigned int hashlen, const unsigned char *hash, int saltlen, unsigned char *sig)
This function performs a PKCS#1 v2.1 PSS signature operation (RSASSA-PSS-SIGN).
mbedtls_rsa_check_privkey
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_rsa_init
void mbedtls_rsa_init(mbedtls_rsa_context *ctx)
This function initializes an RSA context.
mbedtls_rsa_check_pubkey
int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains at least an RSA public key.
mbedtls_rsa_rsaes_pkcs1_v15_decrypt
int mbedtls_rsa_rsaes_pkcs1_v15_decrypt(mbedtls_rsa_context *ctx, mbedtls_f_rng_t *f_rng, void *p_rng, 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).
mbedtls_rsa_pkcs1_verify
int mbedtls_rsa_pkcs1_verify(mbedtls_rsa_context *ctx, 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.
rsa_alt.h
mbedtls_mpi
MPI structure.
Definition: bignum.h:208
mbedtls_rsa_context
The RSA context structure.
Definition: rsa.h:85
mbedtls_threading_mutex_t
Definition: threading.h:29
threading.h
Threading abstraction layer.
Generated on Wed Jul 8 2026 23:18:31 for Mbed TLS v3.6.7 by doxygen 1.9.1