Mbed TLS v3.5.0
rsa.h
Go to the documentation of this file.
1 
12 /*
13  * Copyright The Mbed TLS Contributors
14  * SPDX-License-Identifier: Apache-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 #ifndef MBEDTLS_RSA_H
29 #define MBEDTLS_RSA_H
30 #include "mbedtls/private_access.h"
31 
32 #include "mbedtls/build_info.h"
33 
34 #include "mbedtls/bignum.h"
35 #include "mbedtls/md.h"
36 
37 #if defined(MBEDTLS_THREADING_C)
38 #include "mbedtls/threading.h"
39 #endif
40 
41 /*
42  * RSA Error codes
43  */
45 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
47 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
49 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
51 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
53 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
55 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
57 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
59 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
61 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
62 
63 /*
64  * RSA constants
65  */
66 
67 #define MBEDTLS_RSA_PKCS_V15 0
68 #define MBEDTLS_RSA_PKCS_V21 1
70 #define MBEDTLS_RSA_SIGN 1
71 #define MBEDTLS_RSA_CRYPT 2
73 #define MBEDTLS_RSA_SALT_LEN_ANY -1
74 
75 /*
76  * The above constants may be used even if the RSA module is compile out,
77  * eg for alternative (PKCS#11) RSA implementations in the PK layers.
78  */
79 
80 #ifdef __cplusplus
81 extern "C" {
82 #endif
83 
84 #if !defined(MBEDTLS_RSA_ALT)
85 // Regular implementation
86 //
87 
88 #if !defined(MBEDTLS_RSA_GEN_KEY_MIN_BITS)
89 #define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024
90 #elif MBEDTLS_RSA_GEN_KEY_MIN_BITS < 128
91 #error "MBEDTLS_RSA_GEN_KEY_MIN_BITS must be at least 128 bits"
92 #endif
93 
97 typedef struct mbedtls_rsa_context {
98  int MBEDTLS_PRIVATE(ver);
102  size_t MBEDTLS_PRIVATE(len);
123  int MBEDTLS_PRIVATE(padding);
126  int MBEDTLS_PRIVATE(hash_id);
130 #if defined(MBEDTLS_THREADING_C)
131  /* Invariant: the mutex is initialized iff ver != 0. */
133 #endif
134 }
136 
137 #else /* MBEDTLS_RSA_ALT */
138 #include "rsa_alt.h"
139 #endif /* MBEDTLS_RSA_ALT */
140 
152 
188  mbedtls_md_type_t hash_id);
189 
200 
211 
242  const mbedtls_mpi *N,
243  const mbedtls_mpi *P, const mbedtls_mpi *Q,
244  const mbedtls_mpi *D, const mbedtls_mpi *E);
245 
281  unsigned char const *N, size_t N_len,
282  unsigned char const *P, size_t P_len,
283  unsigned char const *Q, size_t Q_len,
284  unsigned char const *D, size_t D_len,
285  unsigned char const *E, size_t E_len);
286 
320 
363  mbedtls_mpi *D, mbedtls_mpi *E);
364 
413  unsigned char *N, size_t N_len,
414  unsigned char *P, size_t P_len,
415  unsigned char *Q, size_t Q_len,
416  unsigned char *D, size_t D_len,
417  unsigned char *E, size_t E_len);
418 
439  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP);
440 
450 
470  int (*f_rng)(void *, unsigned char *, size_t),
471  void *p_rng,
472  unsigned int nbits, int exponent);
473 
489 
527 
540  const mbedtls_rsa_context *prv);
541 
562  const unsigned char *input,
563  unsigned char *output);
564 
595  int (*f_rng)(void *, unsigned char *, size_t),
596  void *p_rng,
597  const unsigned char *input,
598  unsigned char *output);
599 
624  int (*f_rng)(void *, unsigned char *, size_t),
625  void *p_rng,
626  size_t ilen,
627  const unsigned char *input,
628  unsigned char *output);
629 
651  int (*f_rng)(void *, unsigned char *, size_t),
652  void *p_rng,
653  size_t ilen,
654  const unsigned char *input,
655  unsigned char *output);
656 
685  int (*f_rng)(void *, unsigned char *, size_t),
686  void *p_rng,
687  const unsigned char *label, size_t label_len,
688  size_t ilen,
689  const unsigned char *input,
690  unsigned char *output);
691 
724  int (*f_rng)(void *, unsigned char *, size_t),
725  void *p_rng,
726  size_t *olen,
727  const unsigned char *input,
728  unsigned char *output,
729  size_t output_max_len);
730 
761  int (*f_rng)(void *, unsigned char *, size_t),
762  void *p_rng,
763  size_t *olen,
764  const unsigned char *input,
765  unsigned char *output,
766  size_t output_max_len);
767 
802  int (*f_rng)(void *, unsigned char *, size_t),
803  void *p_rng,
804  const unsigned char *label, size_t label_len,
805  size_t *olen,
806  const unsigned char *input,
807  unsigned char *output,
808  size_t output_max_len);
809 
845  int (*f_rng)(void *, unsigned char *, size_t),
846  void *p_rng,
847  mbedtls_md_type_t md_alg,
848  unsigned int hashlen,
849  const unsigned char *hash,
850  unsigned char *sig);
851 
877  int (*f_rng)(void *, unsigned char *, size_t),
878  void *p_rng,
879  mbedtls_md_type_t md_alg,
880  unsigned int hashlen,
881  const unsigned char *hash,
882  unsigned char *sig);
883 
928  int (*f_rng)(void *, unsigned char *, size_t),
929  void *p_rng,
930  mbedtls_md_type_t md_alg,
931  unsigned int hashlen,
932  const unsigned char *hash,
933  int saltlen,
934  unsigned char *sig);
935 
978  int (*f_rng)(void *, unsigned char *, size_t),
979  void *p_rng,
980  mbedtls_md_type_t md_alg,
981  unsigned int hashlen,
982  const unsigned char *hash,
983  unsigned char *sig);
984 
1012  mbedtls_md_type_t md_alg,
1013  unsigned int hashlen,
1014  const unsigned char *hash,
1015  const unsigned char *sig);
1016 
1037  mbedtls_md_type_t md_alg,
1038  unsigned int hashlen,
1039  const unsigned char *hash,
1040  const unsigned char *sig);
1041 
1072  mbedtls_md_type_t md_alg,
1073  unsigned int hashlen,
1074  const unsigned char *hash,
1075  const unsigned char *sig);
1076 
1112  mbedtls_md_type_t md_alg,
1113  unsigned int hashlen,
1114  const unsigned char *hash,
1115  mbedtls_md_type_t mgf1_hash_id,
1116  int expected_salt_len,
1117  const unsigned char *sig);
1118 
1129 
1138 
1139 #if defined(MBEDTLS_SELF_TEST)
1140 
1147 int mbedtls_rsa_self_test(int verbose);
1148 
1149 #endif /* MBEDTLS_SELF_TEST */
1150 
1151 #ifdef __cplusplus
1152 }
1153 #endif
1154 
1155 #endif /* rsa.h */
Multi-precision integer library.
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:173
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
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).
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
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_get_padding_mode(const mbedtls_rsa_context *ctx)
This function retrieves padding mode of initialized RSA context.
size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx)
This function retrieves the length of RSA modulus in Bytes.
int mbedtls_rsa_rsassa_pkcs1_v15_sign(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
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.
int mbedtls_rsa_pkcs1_decrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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.
struct mbedtls_rsa_context mbedtls_rsa_context
The RSA context structure.
int mbedtls_rsa_get_md_alg(const mbedtls_rsa_context *ctx)
This function retrieves hash identifier of mbedtls_md_type_t type.
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_pkcs1_encrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, size_t ilen, const unsigned char *input, unsigned char *output)
This function adds the message padding, then performs an RSA operation.
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, 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_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).
int mbedtls_rsa_rsassa_pss_sign_ext(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
int mbedtls_rsa_rsaes_pkcs1_v15_decrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
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_rsassa_pss_sign(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
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_encrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
int mbedtls_rsa_pkcs1_sign(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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.
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.
void mbedtls_rsa_init(mbedtls_rsa_context *ctx)
This function initializes an RSA context.
int mbedtls_rsa_rsaes_oaep_decrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains at least an RSA public key.
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.
int mbedtls_rsa_rsaes_pkcs1_v15_encrypt(mbedtls_rsa_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), 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).
MPI structure.
Definition: bignum.h:219
The RSA context structure.
Definition: rsa.h:97
Threading abstraction layer.