Mbed TLS v3.5.2
Loading...
Searching...
No Matches
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
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
69extern "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
124
125#else /* MBEDTLS_RSA_ALT */
126#include "rsa_alt.h"
127#endif /* MBEDTLS_RSA_ALT */
128
140
176 mbedtls_md_type_t hash_id);
177
188
199
230 const mbedtls_mpi *N,
231 const mbedtls_mpi *P, const mbedtls_mpi *Q,
232 const mbedtls_mpi *D, const mbedtls_mpi *E);
233
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
308
351 mbedtls_mpi *D, mbedtls_mpi *E);
352
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
427 mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP);
428
438
458 int (*f_rng)(void *, unsigned char *, size_t),
459 void *p_rng,
460 unsigned int nbits, int exponent);
461
477
515
528 const mbedtls_rsa_context *prv);
529
550 const unsigned char *input,
551 unsigned char *output);
552
583 int (*f_rng)(void *, unsigned char *, size_t),
584 void *p_rng,
585 const unsigned char *input,
586 unsigned char *output);
587
612 int (*f_rng)(void *, unsigned char *, size_t),
613 void *p_rng,
614 size_t ilen,
615 const unsigned char *input,
616 unsigned char *output);
617
639 int (*f_rng)(void *, unsigned char *, size_t),
640 void *p_rng,
641 size_t ilen,
642 const unsigned char *input,
643 unsigned char *output);
644
673 int (*f_rng)(void *, unsigned char *, size_t),
674 void *p_rng,
675 const unsigned char *label, size_t label_len,
676 size_t ilen,
677 const unsigned char *input,
678 unsigned char *output);
679
716 int (*f_rng)(void *, unsigned char *, size_t),
717 void *p_rng,
718 size_t *olen,
719 const unsigned char *input,
720 unsigned char *output,
721 size_t output_max_len);
722
758 int (*f_rng)(void *, unsigned char *, size_t),
759 void *p_rng,
760 size_t *olen,
761 const unsigned char *input,
762 unsigned char *output,
763 size_t output_max_len);
764
799 int (*f_rng)(void *, unsigned char *, size_t),
800 void *p_rng,
801 const unsigned char *label, size_t label_len,
802 size_t *olen,
803 const unsigned char *input,
804 unsigned char *output,
805 size_t output_max_len);
806
842 int (*f_rng)(void *, unsigned char *, size_t),
843 void *p_rng,
844 mbedtls_md_type_t md_alg,
845 unsigned int hashlen,
846 const unsigned char *hash,
847 unsigned char *sig);
848
874 int (*f_rng)(void *, unsigned char *, size_t),
875 void *p_rng,
876 mbedtls_md_type_t md_alg,
877 unsigned int hashlen,
878 const unsigned char *hash,
879 unsigned char *sig);
880
925 int (*f_rng)(void *, unsigned char *, size_t),
926 void *p_rng,
927 mbedtls_md_type_t md_alg,
928 unsigned int hashlen,
929 const unsigned char *hash,
930 int saltlen,
931 unsigned char *sig);
932
975 int (*f_rng)(void *, unsigned char *, size_t),
976 void *p_rng,
977 mbedtls_md_type_t md_alg,
978 unsigned int hashlen,
979 const unsigned char *hash,
980 unsigned char *sig);
981
1009 mbedtls_md_type_t md_alg,
1010 unsigned int hashlen,
1011 const unsigned char *hash,
1012 const unsigned char *sig);
1013
1034 mbedtls_md_type_t md_alg,
1035 unsigned int hashlen,
1036 const unsigned char *hash,
1037 const unsigned char *sig);
1038
1069 mbedtls_md_type_t md_alg,
1070 unsigned int hashlen,
1071 const unsigned char *hash,
1072 const unsigned char *sig);
1073
1109 mbedtls_md_type_t md_alg,
1110 unsigned int hashlen,
1111 const unsigned char *hash,
1112 mbedtls_md_type_t mgf1_hash_id,
1113 int expected_salt_len,
1114 const unsigned char *sig);
1115
1126
1135
1136#if defined(MBEDTLS_SELF_TEST)
1137
1144int mbedtls_rsa_self_test(int verbose);
1145
1146#endif /* MBEDTLS_SELF_TEST */
1147
1148#ifdef __cplusplus
1149}
1150#endif
1151
1152#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:161
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:207
The RSA context structure.
Definition rsa.h:85
Threading abstraction layer.