mbed TLS v3.4.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
46 
47 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
48 
49 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
50 
51 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
52 
53 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
54 
55 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
56 
57 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
58 
59 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
60 
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 
91 typedef struct mbedtls_rsa_context {
92  int MBEDTLS_PRIVATE(ver);
96  size_t MBEDTLS_PRIVATE(len);
117  int MBEDTLS_PRIVATE(padding);
120  int MBEDTLS_PRIVATE(hash_id);
124 #if defined(MBEDTLS_THREADING_C)
125  /* Invariant: the mutex is initialized iff ver != 0. */
126  mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
127 #endif
128 }
130 
131 #else /* MBEDTLS_RSA_ALT */
132 #include "rsa_alt.h"
133 #endif /* MBEDTLS_RSA_ALT */
134 
146 
181 int mbedtls_rsa_set_padding(mbedtls_rsa_context *ctx, int padding,
182  mbedtls_md_type_t hash_id);
183 
194 
205 
236  const mbedtls_mpi *N,
237  const mbedtls_mpi *P, const mbedtls_mpi *Q,
238  const mbedtls_mpi *D, const mbedtls_mpi *E);
239 
275  unsigned char const *N, size_t N_len,
276  unsigned char const *P, size_t P_len,
277  unsigned char const *Q, size_t Q_len,
278  unsigned char const *D, size_t D_len,
279  unsigned char const *E, size_t E_len);
280 
314 
357  mbedtls_mpi *D, mbedtls_mpi *E);
358 
407  unsigned char *N, size_t N_len,
408  unsigned char *P, size_t P_len,
409  unsigned char *Q, size_t Q_len,
410  unsigned char *D, size_t D_len,
411  unsigned char *E, size_t E_len);
412 
433  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP);
434 
443 size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx);
444 
464  int (*f_rng)(void *, unsigned char *, size_t),
465  void *p_rng,
466  unsigned int nbits, int exponent);
467 
483 
521 
534  const mbedtls_rsa_context *prv);
535 
556  const unsigned char *input,
557  unsigned char *output);
558 
589  int (*f_rng)(void *, unsigned char *, size_t),
590  void *p_rng,
591  const unsigned char *input,
592  unsigned char *output);
593 
618  int (*f_rng)(void *, unsigned char *, size_t),
619  void *p_rng,
620  size_t ilen,
621  const unsigned char *input,
622  unsigned char *output);
623 
645  int (*f_rng)(void *, unsigned char *, size_t),
646  void *p_rng,
647  size_t ilen,
648  const unsigned char *input,
649  unsigned char *output);
650 
679  int (*f_rng)(void *, unsigned char *, size_t),
680  void *p_rng,
681  const unsigned char *label, size_t label_len,
682  size_t ilen,
683  const unsigned char *input,
684  unsigned char *output);
685 
718  int (*f_rng)(void *, unsigned char *, size_t),
719  void *p_rng,
720  size_t *olen,
721  const unsigned char *input,
722  unsigned char *output,
723  size_t output_max_len);
724 
755  int (*f_rng)(void *, unsigned char *, size_t),
756  void *p_rng,
757  size_t *olen,
758  const unsigned char *input,
759  unsigned char *output,
760  size_t output_max_len);
761 
796  int (*f_rng)(void *, unsigned char *, size_t),
797  void *p_rng,
798  const unsigned char *label, size_t label_len,
799  size_t *olen,
800  const unsigned char *input,
801  unsigned char *output,
802  size_t output_max_len);
803 
839  int (*f_rng)(void *, unsigned char *, size_t),
840  void *p_rng,
841  mbedtls_md_type_t md_alg,
842  unsigned int hashlen,
843  const unsigned char *hash,
844  unsigned char *sig);
845 
871  int (*f_rng)(void *, unsigned char *, size_t),
872  void *p_rng,
873  mbedtls_md_type_t md_alg,
874  unsigned int hashlen,
875  const unsigned char *hash,
876  unsigned char *sig);
877 
922  int (*f_rng)(void *, unsigned char *, size_t),
923  void *p_rng,
924  mbedtls_md_type_t md_alg,
925  unsigned int hashlen,
926  const unsigned char *hash,
927  int saltlen,
928  unsigned char *sig);
929 
972  int (*f_rng)(void *, unsigned char *, size_t),
973  void *p_rng,
974  mbedtls_md_type_t md_alg,
975  unsigned int hashlen,
976  const unsigned char *hash,
977  unsigned char *sig);
978 
1006  mbedtls_md_type_t md_alg,
1007  unsigned int hashlen,
1008  const unsigned char *hash,
1009  const unsigned char *sig);
1010 
1031  mbedtls_md_type_t md_alg,
1032  unsigned int hashlen,
1033  const unsigned char *hash,
1034  const unsigned char *sig);
1035 
1066  mbedtls_md_type_t md_alg,
1067  unsigned int hashlen,
1068  const unsigned char *hash,
1069  const unsigned char *sig);
1070 
1106  mbedtls_md_type_t md_alg,
1107  unsigned int hashlen,
1108  const unsigned char *hash,
1109  mbedtls_md_type_t mgf1_hash_id,
1110  int expected_salt_len,
1111  const unsigned char *sig);
1112 
1123 
1132 
1133 #if defined(MBEDTLS_SELF_TEST)
1134 
1141 int mbedtls_rsa_self_test(int verbose);
1142 
1143 #endif /* MBEDTLS_SELF_TEST */
1144 
1145 #ifdef __cplusplus
1146 }
1147 #endif
1148 
1149 #endif /* rsa.h */
void mbedtls_rsa_init(mbedtls_rsa_context *ctx)
This function initializes an RSA context.
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
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, 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_get_md_alg(const mbedtls_rsa_context *ctx)
This function retrieves hash identifier of mbedtls_md_type_t type.
int mbedtls_rsa_get_padding_mode(const mbedtls_rsa_context *ctx)
This function retrieves padding mode of initialized RSA context.
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_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.
#define MBEDTLS_PRIVATE(member)
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_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_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_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
Multi-precision integer library.
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_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_pub_priv(const mbedtls_rsa_context *pub, const mbedtls_rsa_context *prv)
This function checks a public-private RSA key pair.
Threading abstraction layer.
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).
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_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_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_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).
Macro wrapper for struct's members.
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_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_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_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).
Build-time configuration info.
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).
This file contains the generic functions for message-digest (hashing) and HMAC.
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
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_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
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...
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_md_type_t
Supported message digests.
Definition: md.h:143
The RSA context structure.
Definition: rsa.h:91
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.