mbed TLS v2.26.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 
31 #if !defined(MBEDTLS_CONFIG_FILE)
32 #include "mbedtls/config.h"
33 #else
34 #include MBEDTLS_CONFIG_FILE
35 #endif
36 
37 #include "mbedtls/bignum.h"
38 #include "mbedtls/md.h"
39 
40 #if defined(MBEDTLS_THREADING_C)
41 #include "mbedtls/threading.h"
42 #endif
43 
44 /*
45  * RSA Error codes
46  */
47 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
48 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
49 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
50 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
51 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
52 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
53 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
54 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
55 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
57 /* MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION is deprecated and should not be used.
58  */
59 #define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
61 /* MBEDTLS_ERR_RSA_HW_ACCEL_FAILED is deprecated and should not be used. */
62 #define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
64 /*
65  * RSA constants
66  */
67 #define MBEDTLS_RSA_PUBLIC 0
68 #define MBEDTLS_RSA_PRIVATE 1
70 #define MBEDTLS_RSA_PKCS_V15 0
71 #define MBEDTLS_RSA_PKCS_V21 1
73 #define MBEDTLS_RSA_SIGN 1
74 #define MBEDTLS_RSA_CRYPT 2
76 #define MBEDTLS_RSA_SALT_LEN_ANY -1
77 
78 /*
79  * The above constants may be used even if the RSA module is compile out,
80  * eg for alternative (PKCS#11) RSA implemenations in the PK layers.
81  */
82 
83 #ifdef __cplusplus
84 extern "C" {
85 #endif
86 
87 #if !defined(MBEDTLS_RSA_ALT)
88 // Regular implementation
89 //
90 
98 typedef struct mbedtls_rsa_context
99 {
100  int ver;
104  size_t len;
125  int padding;
128  int hash_id;
132 #if defined(MBEDTLS_THREADING_C)
133  /* Invariant: the mutex is initialized iff ver != 0. */
134  mbedtls_threading_mutex_t mutex;
135 #endif
136 }
138 
139 #else /* MBEDTLS_RSA_ALT */
140 #include "rsa_alt.h"
141 #endif /* MBEDTLS_RSA_ALT */
142 
171  int padding,
172  int hash_id );
173 
204  const mbedtls_mpi *N,
205  const mbedtls_mpi *P, const mbedtls_mpi *Q,
206  const mbedtls_mpi *D, const mbedtls_mpi *E );
207 
243  unsigned char const *N, size_t N_len,
244  unsigned char const *P, size_t P_len,
245  unsigned char const *Q, size_t Q_len,
246  unsigned char const *D, size_t D_len,
247  unsigned char const *E, size_t E_len );
248 
282 
325  mbedtls_mpi *D, mbedtls_mpi *E );
326 
375  unsigned char *N, size_t N_len,
376  unsigned char *P, size_t P_len,
377  unsigned char *Q, size_t Q_len,
378  unsigned char *D, size_t D_len,
379  unsigned char *E, size_t E_len );
380 
401  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP );
402 
412 void mbedtls_rsa_set_padding( mbedtls_rsa_context *ctx, int padding,
413  int hash_id );
414 
423 size_t mbedtls_rsa_get_len( const mbedtls_rsa_context *ctx );
424 
444  int (*f_rng)(void *, unsigned char *, size_t),
445  void *p_rng,
446  unsigned int nbits, int exponent );
447 
463 
501 
514  const mbedtls_rsa_context *prv );
515 
536  const unsigned char *input,
537  unsigned char *output );
538 
571  int (*f_rng)(void *, unsigned char *, size_t),
572  void *p_rng,
573  const unsigned char *input,
574  unsigned char *output );
575 
616  int (*f_rng)(void *, unsigned char *, size_t),
617  void *p_rng,
618  int mode, size_t ilen,
619  const unsigned char *input,
620  unsigned char *output );
621 
657  int (*f_rng)(void *, unsigned char *, size_t),
658  void *p_rng,
659  int mode, size_t ilen,
660  const unsigned char *input,
661  unsigned char *output );
662 
702  int (*f_rng)(void *, unsigned char *, size_t),
703  void *p_rng,
704  int mode,
705  const unsigned char *label, size_t label_len,
706  size_t ilen,
707  const unsigned char *input,
708  unsigned char *output );
709 
755  int (*f_rng)(void *, unsigned char *, size_t),
756  void *p_rng,
757  int mode, size_t *olen,
758  const unsigned char *input,
759  unsigned char *output,
760  size_t output_max_len );
761 
805  int (*f_rng)(void *, unsigned char *, size_t),
806  void *p_rng,
807  int mode, size_t *olen,
808  const unsigned char *input,
809  unsigned char *output,
810  size_t output_max_len );
811 
859  int (*f_rng)(void *, unsigned char *, size_t),
860  void *p_rng,
861  int mode,
862  const unsigned char *label, size_t label_len,
863  size_t *olen,
864  const unsigned char *input,
865  unsigned char *output,
866  size_t output_max_len );
867 
919  int (*f_rng)(void *, unsigned char *, size_t),
920  void *p_rng,
921  int mode,
922  mbedtls_md_type_t md_alg,
923  unsigned int hashlen,
924  const unsigned char *hash,
925  unsigned char *sig );
926 
967  int (*f_rng)(void *, unsigned char *, size_t),
968  void *p_rng,
969  int mode,
970  mbedtls_md_type_t md_alg,
971  unsigned int hashlen,
972  const unsigned char *hash,
973  unsigned char *sig );
974 
1029  int (*f_rng)(void *, unsigned char *, size_t),
1030  void *p_rng,
1031  int mode,
1032  mbedtls_md_type_t md_alg,
1033  unsigned int hashlen,
1034  const unsigned char *hash,
1035  unsigned char *sig );
1036 
1082  int (*f_rng)(void *, unsigned char *, size_t),
1083  void *p_rng,
1084  int mode,
1085  mbedtls_md_type_t md_alg,
1086  unsigned int hashlen,
1087  const unsigned char *hash,
1088  const unsigned char *sig );
1089 
1128  int (*f_rng)(void *, unsigned char *, size_t),
1129  void *p_rng,
1130  int mode,
1131  mbedtls_md_type_t md_alg,
1132  unsigned int hashlen,
1133  const unsigned char *hash,
1134  const unsigned char *sig );
1135 
1185  int (*f_rng)(void *, unsigned char *, size_t),
1186  void *p_rng,
1187  int mode,
1188  mbedtls_md_type_t md_alg,
1189  unsigned int hashlen,
1190  const unsigned char *hash,
1191  const unsigned char *sig );
1192 
1233  int (*f_rng)(void *, unsigned char *, size_t),
1234  void *p_rng,
1235  int mode,
1236  mbedtls_md_type_t md_alg,
1237  unsigned int hashlen,
1238  const unsigned char *hash,
1239  mbedtls_md_type_t mgf1_hash_id,
1240  int expected_salt_len,
1241  const unsigned char *sig );
1242 
1253 
1262 
1263 #if defined(MBEDTLS_SELF_TEST)
1264 
1271 int mbedtls_rsa_self_test( int verbose );
1272 
1273 #endif /* MBEDTLS_SELF_TEST */
1274 
1275 #ifdef __cplusplus
1276 }
1277 #endif
1278 
1279 #endif /* rsa.h */
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
mbedtls_mpi DP
Definition: rsa.h:113
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, 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_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_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).
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_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.
Configuration options (set of defines)
int mbedtls_rsa_complete(mbedtls_rsa_context *ctx)
This function completes an RSA context from a set of imported core parameters.
mbedtls_mpi DQ
Definition: rsa.h:114
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.
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...
Multi-precision integer library.
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_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_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_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...
mbedtls_mpi RP
Definition: rsa.h:119
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.
mbedtls_mpi P
Definition: rsa.h:110
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_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_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_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).
mbedtls_mpi E
Definition: rsa.h:107
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.
size_t len
Definition: rsa.h:104
mbedtls_mpi Vf
Definition: rsa.h:123
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_mpi QP
Definition: rsa.h:115
mbedtls_mpi D
Definition: rsa.h:109
This file contains the generic message-digest wrapper.
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_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).
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:184
mbedtls_mpi N
Definition: rsa.h:106
int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx)
This function checks if a context contains at least an RSA public key.
mbedtls_mpi RN
Definition: rsa.h:117
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
mbedtls_mpi RQ
Definition: rsa.h:120
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...
mbedtls_mpi Vi
Definition: rsa.h:122
mbedtls_md_type_t
Supported message digests.
Definition: md.h:56
mbedtls_mpi Q
Definition: rsa.h:111
The RSA context structure.
Definition: rsa.h:98
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).
void mbedtls_rsa_init(mbedtls_rsa_context *ctx, int padding, int hash_id)
This function initializes an RSA context.