Mbed TLS v2.28.8
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
18
19#if !defined(MBEDTLS_CONFIG_FILE)
20#include "mbedtls/config.h"
21#else
22#include MBEDTLS_CONFIG_FILE
23#endif
24
25#include "mbedtls/bignum.h"
26#include "mbedtls/md.h"
27
28#if defined(MBEDTLS_THREADING_C)
29#include "mbedtls/threading.h"
30#endif
31
32/*
33 * RSA Error codes
34 */
36#define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
38#define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
40#define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
42#define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
44#define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
46#define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
48#define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
50#define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
52#define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
53
54/* MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION is deprecated and should not be used.
55 */
57#define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
58
59/* MBEDTLS_ERR_RSA_HW_ACCEL_FAILED is deprecated and should not be used. */
61#define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
62
63/*
64 * RSA constants
65 */
66#define MBEDTLS_RSA_PUBLIC 0
67#define MBEDTLS_RSA_PRIVATE 1
69#define MBEDTLS_RSA_PKCS_V15 0
70#define MBEDTLS_RSA_PKCS_V21 1
72#define MBEDTLS_RSA_SIGN 1
73#define MBEDTLS_RSA_CRYPT 2
75#define MBEDTLS_RSA_SALT_LEN_ANY -1
76
77/*
78 * The above constants may be used even if the RSA module is compile out,
79 * eg for alternative (PKCS#11) RSA implementations in the PK layers.
80 */
81
82#ifdef __cplusplus
83extern "C" {
84#endif
85
86#if !defined(MBEDTLS_RSA_ALT)
87// Regular implementation
88//
89
136
137#else /* MBEDTLS_RSA_ALT */
138#include "rsa_alt.h"
139#endif /* MBEDTLS_RSA_ALT */
140
169 int padding,
170 int hash_id);
171
202 const mbedtls_mpi *N,
203 const mbedtls_mpi *P, const mbedtls_mpi *Q,
204 const mbedtls_mpi *D, const mbedtls_mpi *E);
205
241 unsigned char const *N, size_t N_len,
242 unsigned char const *P, size_t P_len,
243 unsigned char const *Q, size_t Q_len,
244 unsigned char const *D, size_t D_len,
245 unsigned char const *E, size_t E_len);
246
280
323 mbedtls_mpi *D, mbedtls_mpi *E);
324
373 unsigned char *N, size_t N_len,
374 unsigned char *P, size_t P_len,
375 unsigned char *Q, size_t Q_len,
376 unsigned char *D, size_t D_len,
377 unsigned char *E, size_t E_len);
378
399 mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP);
400
411 int hash_id);
412
422
442 int (*f_rng)(void *, unsigned char *, size_t),
443 void *p_rng,
444 unsigned int nbits, int exponent);
445
461
499
512 const mbedtls_rsa_context *prv);
513
534 const unsigned char *input,
535 unsigned char *output);
536
569 int (*f_rng)(void *, unsigned char *, size_t),
570 void *p_rng,
571 const unsigned char *input,
572 unsigned char *output);
573
614 int (*f_rng)(void *, unsigned char *, size_t),
615 void *p_rng,
616 int mode, size_t ilen,
617 const unsigned char *input,
618 unsigned char *output);
619
655 int (*f_rng)(void *, unsigned char *, size_t),
656 void *p_rng,
657 int mode, size_t ilen,
658 const unsigned char *input,
659 unsigned char *output);
660
700 int (*f_rng)(void *, unsigned char *, size_t),
701 void *p_rng,
702 int mode,
703 const unsigned char *label, size_t label_len,
704 size_t ilen,
705 const unsigned char *input,
706 unsigned char *output);
707
757 int (*f_rng)(void *, unsigned char *, size_t),
758 void *p_rng,
759 int mode, size_t *olen,
760 const unsigned char *input,
761 unsigned char *output,
762 size_t output_max_len);
763
812 int (*f_rng)(void *, unsigned char *, size_t),
813 void *p_rng,
814 int mode, size_t *olen,
815 const unsigned char *input,
816 unsigned char *output,
817 size_t output_max_len);
818
866 int (*f_rng)(void *, unsigned char *, size_t),
867 void *p_rng,
868 int mode,
869 const unsigned char *label, size_t label_len,
870 size_t *olen,
871 const unsigned char *input,
872 unsigned char *output,
873 size_t output_max_len);
874
926 int (*f_rng)(void *, unsigned char *, size_t),
927 void *p_rng,
928 int mode,
929 mbedtls_md_type_t md_alg,
930 unsigned int hashlen,
931 const unsigned char *hash,
932 unsigned char *sig);
933
974 int (*f_rng)(void *, unsigned char *, size_t),
975 void *p_rng,
976 int mode,
977 mbedtls_md_type_t md_alg,
978 unsigned int hashlen,
979 const unsigned char *hash,
980 unsigned char *sig);
981
1029 int (*f_rng)(void *, unsigned char *, size_t),
1030 void *p_rng,
1031 mbedtls_md_type_t md_alg,
1032 unsigned int hashlen,
1033 const unsigned char *hash,
1034 int saltlen,
1035 unsigned char *sig);
1036
1093 int (*f_rng)(void *, unsigned char *, size_t),
1094 void *p_rng,
1095 int mode,
1096 mbedtls_md_type_t md_alg,
1097 unsigned int hashlen,
1098 const unsigned char *hash,
1099 unsigned char *sig);
1100
1146 int (*f_rng)(void *, unsigned char *, size_t),
1147 void *p_rng,
1148 int mode,
1149 mbedtls_md_type_t md_alg,
1150 unsigned int hashlen,
1151 const unsigned char *hash,
1152 const unsigned char *sig);
1153
1192 int (*f_rng)(void *, unsigned char *, size_t),
1193 void *p_rng,
1194 int mode,
1195 mbedtls_md_type_t md_alg,
1196 unsigned int hashlen,
1197 const unsigned char *hash,
1198 const unsigned char *sig);
1199
1248 int (*f_rng)(void *, unsigned char *, size_t),
1249 void *p_rng,
1250 int mode,
1251 mbedtls_md_type_t md_alg,
1252 unsigned int hashlen,
1253 const unsigned char *hash,
1254 const unsigned char *sig);
1255
1301 int (*f_rng)(void *, unsigned char *, size_t),
1302 void *p_rng,
1303 int mode,
1304 mbedtls_md_type_t md_alg,
1305 unsigned int hashlen,
1306 const unsigned char *hash,
1307 mbedtls_md_type_t mgf1_hash_id,
1308 int expected_salt_len,
1309 const unsigned char *sig);
1310
1321
1330
1331#if defined(MBEDTLS_SELF_TEST)
1332
1339int mbedtls_rsa_self_test(int verbose);
1340
1341#endif /* MBEDTLS_SELF_TEST */
1342
1343#ifdef __cplusplus
1344}
1345#endif
1346
1347#endif /* rsa.h */
Multi-precision integer library.
Configuration options (set of defines)
This file contains the generic message-digest wrapper.
mbedtls_md_type_t
Supported message digests.
Definition md.h:50
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.
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
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.
void mbedtls_rsa_init(mbedtls_rsa_context *ctx, int padding, int hash_id)
This function initializes an RSA context.
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
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).
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_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.
size_t mbedtls_rsa_get_len(const mbedtls_rsa_context *ctx)
This function retrieves the length of RSA modulus in Bytes.
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_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_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.
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_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, 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).
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
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_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_public(mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output)
This function performs an RSA public key operation.
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, 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_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_check_pubkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains at least an RSA public key.
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_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).
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).
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).
MPI structure.
Definition bignum.h:196
The RSA context structure.
Definition rsa.h:97
mbedtls_threading_mutex_t mutex
Definition rsa.h:132
mbedtls_mpi N
Definition rsa.h:104
mbedtls_mpi RQ
Definition rsa.h:118
mbedtls_mpi Vf
Definition rsa.h:121
mbedtls_mpi RN
Definition rsa.h:115
mbedtls_mpi Q
Definition rsa.h:109
mbedtls_mpi DQ
Definition rsa.h:112
mbedtls_mpi E
Definition rsa.h:105
mbedtls_mpi QP
Definition rsa.h:113
mbedtls_mpi RP
Definition rsa.h:117
mbedtls_mpi DP
Definition rsa.h:111
mbedtls_mpi P
Definition rsa.h:108
mbedtls_mpi D
Definition rsa.h:107
mbedtls_mpi Vi
Definition rsa.h:120
Threading abstraction layer.