Go to the documentation of this file.
58 #if !defined(MBEDTLS_CONFIG_FILE)
61 #include MBEDTLS_CONFIG_FILE
67 #if defined(MBEDTLS_THREADING_C)
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
86 #define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
89 #define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
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
114 #if !defined(MBEDTLS_RSA_ALT)
156 #if defined(MBEDTLS_THREADING_C)
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 );
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 );
467 int (*f_rng)(
void *,
unsigned char *,
size_t),
469 unsigned int nbits,
int exponent );
559 const unsigned char *input,
560 unsigned char *output );
594 int (*f_rng)(
void *,
unsigned char *,
size_t),
596 const unsigned char *input,
597 unsigned char *output );
638 int (*f_rng)(
void *,
unsigned char *,
size_t),
640 int mode,
size_t ilen,
641 const unsigned char *input,
642 unsigned char *output );
678 int (*f_rng)(
void *,
unsigned char *,
size_t),
680 int mode,
size_t ilen,
681 const unsigned char *input,
682 unsigned char *output );
722 int (*f_rng)(
void *,
unsigned char *,
size_t),
725 const unsigned char *label,
size_t label_len,
727 const unsigned char *input,
728 unsigned char *output );
775 int (*f_rng)(
void *,
unsigned char *,
size_t),
777 int mode,
size_t *olen,
778 const unsigned char *input,
779 unsigned char *output,
780 size_t output_max_len );
825 int (*f_rng)(
void *,
unsigned char *,
size_t),
827 int mode,
size_t *olen,
828 const unsigned char *input,
829 unsigned char *output,
830 size_t output_max_len );
879 int (*f_rng)(
void *,
unsigned char *,
size_t),
882 const unsigned char *label,
size_t label_len,
884 const unsigned char *input,
885 unsigned char *output,
886 size_t output_max_len );
939 int (*f_rng)(
void *,
unsigned char *,
size_t),
943 unsigned int hashlen,
944 const unsigned char *hash,
945 unsigned char *sig );
987 int (*f_rng)(
void *,
unsigned char *,
size_t),
991 unsigned int hashlen,
992 const unsigned char *hash,
993 unsigned char *sig );
1049 int (*f_rng)(
void *,
unsigned char *,
size_t),
1053 unsigned int hashlen,
1054 const unsigned char *hash,
1055 unsigned char *sig );
1102 int (*f_rng)(
void *,
unsigned char *,
size_t),
1106 unsigned int hashlen,
1107 const unsigned char *hash,
1108 const unsigned char *sig );
1148 int (*f_rng)(
void *,
unsigned char *,
size_t),
1152 unsigned int hashlen,
1153 const unsigned char *hash,
1154 const unsigned char *sig );
1205 int (*f_rng)(
void *,
unsigned char *,
size_t),
1209 unsigned int hashlen,
1210 const unsigned char *hash,
1211 const unsigned char *sig );
1253 int (*f_rng)(
void *,
unsigned char *,
size_t),
1257 unsigned int hashlen,
1258 const unsigned char *hash,
1260 int expected_salt_len,
1261 const unsigned char *sig );
1283 #if defined(MBEDTLS_SELF_TEST)
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_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.
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).
mbedtls_md_type_t
Supported message digests.
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
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_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.
This file contains the generic message-digest wrapper.
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
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_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_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_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).
void mbedtls_rsa_init(mbedtls_rsa_context *ctx, int padding, int hash_id)
This function initializes an RSA context.
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.
Multi-precision integer library.
struct mbedtls_rsa_context mbedtls_rsa_context
The RSA context structure.
size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx)
This function retrieves the length of RSA modulus in Bytes.
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_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_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).
The RSA context structure.
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_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.
Threading abstraction layer.
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.
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_public(mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output)
This function performs an RSA public key operation.
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).
Configuration options (set of defines)
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_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_copy(mbedtls_rsa_context *dst, const mbedtls_rsa_context *src)
This function copies the components of an RSA context.
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_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_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_threading_mutex_t mutex
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.