mbed TLS v2.3.0
rsa.h
Go to the documentation of this file.
1 
25 #ifndef MBEDTLS_RSA_H
26 #define MBEDTLS_RSA_H
27 
28 #if !defined(MBEDTLS_CONFIG_FILE)
29 #include "config.h"
30 #else
31 #include MBEDTLS_CONFIG_FILE
32 #endif
33 
34 #include "bignum.h"
35 #include "md.h"
36 
37 #if defined(MBEDTLS_THREADING_C)
38 #include "threading.h"
39 #endif
40 
41 /*
42  * RSA Error codes
43  */
44 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
45 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
46 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
47 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
48 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
49 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
50 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
51 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
52 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
54 /*
55  * RSA constants
56  */
57 #define MBEDTLS_RSA_PUBLIC 0
58 #define MBEDTLS_RSA_PRIVATE 1
59 
60 #define MBEDTLS_RSA_PKCS_V15 0
61 #define MBEDTLS_RSA_PKCS_V21 1
62 
63 #define MBEDTLS_RSA_SIGN 1
64 #define MBEDTLS_RSA_CRYPT 2
65 
66 #define MBEDTLS_RSA_SALT_LEN_ANY -1
67 
68 /*
69  * The above constants may be used even if the RSA module is compile out,
70  * eg for alternative (PKCS#11) RSA implemenations in the PK layers.
71  */
72 #if defined(MBEDTLS_RSA_C)
73 
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77 
81 typedef struct
82 {
83  int ver;
84  size_t len;
103  int padding;
105  int hash_id;
109 #if defined(MBEDTLS_THREADING_C)
110  mbedtls_threading_mutex_t mutex;
111 #endif
112 }
114 
140  int padding,
141  int hash_id);
142 
151 void mbedtls_rsa_set_padding( mbedtls_rsa_context *ctx, int padding, int hash_id);
152 
168  int (*f_rng)(void *, unsigned char *, size_t),
169  void *p_rng,
170  unsigned int nbits, int exponent );
171 
180 
189 
200 
218  const unsigned char *input,
219  unsigned char *output );
220 
236  int (*f_rng)(void *, unsigned char *, size_t),
237  void *p_rng,
238  const unsigned char *input,
239  unsigned char *output );
240 
261  int (*f_rng)(void *, unsigned char *, size_t),
262  void *p_rng,
263  int mode, size_t ilen,
264  const unsigned char *input,
265  unsigned char *output );
266 
284  int (*f_rng)(void *, unsigned char *, size_t),
285  void *p_rng,
286  int mode, size_t ilen,
287  const unsigned char *input,
288  unsigned char *output );
289 
310  int (*f_rng)(void *, unsigned char *, size_t),
311  void *p_rng,
312  int mode,
313  const unsigned char *label, size_t label_len,
314  size_t ilen,
315  const unsigned char *input,
316  unsigned char *output );
317 
339  int (*f_rng)(void *, unsigned char *, size_t),
340  void *p_rng,
341  int mode, size_t *olen,
342  const unsigned char *input,
343  unsigned char *output,
344  size_t output_max_len );
345 
365  int (*f_rng)(void *, unsigned char *, size_t),
366  void *p_rng,
367  int mode, size_t *olen,
368  const unsigned char *input,
369  unsigned char *output,
370  size_t output_max_len );
371 
393  int (*f_rng)(void *, unsigned char *, size_t),
394  void *p_rng,
395  int mode,
396  const unsigned char *label, size_t label_len,
397  size_t *olen,
398  const unsigned char *input,
399  unsigned char *output,
400  size_t output_max_len );
401 
427  int (*f_rng)(void *, unsigned char *, size_t),
428  void *p_rng,
429  int mode,
430  mbedtls_md_type_t md_alg,
431  unsigned int hashlen,
432  const unsigned char *hash,
433  unsigned char *sig );
434 
454  int (*f_rng)(void *, unsigned char *, size_t),
455  void *p_rng,
456  int mode,
457  mbedtls_md_type_t md_alg,
458  unsigned int hashlen,
459  const unsigned char *hash,
460  unsigned char *sig );
461 
487  int (*f_rng)(void *, unsigned char *, size_t),
488  void *p_rng,
489  int mode,
490  mbedtls_md_type_t md_alg,
491  unsigned int hashlen,
492  const unsigned char *hash,
493  unsigned char *sig );
494 
519  int (*f_rng)(void *, unsigned char *, size_t),
520  void *p_rng,
521  int mode,
522  mbedtls_md_type_t md_alg,
523  unsigned int hashlen,
524  const unsigned char *hash,
525  const unsigned char *sig );
526 
546  int (*f_rng)(void *, unsigned char *, size_t),
547  void *p_rng,
548  int mode,
549  mbedtls_md_type_t md_alg,
550  unsigned int hashlen,
551  const unsigned char *hash,
552  const unsigned char *sig );
553 
580  int (*f_rng)(void *, unsigned char *, size_t),
581  void *p_rng,
582  int mode,
583  mbedtls_md_type_t md_alg,
584  unsigned int hashlen,
585  const unsigned char *hash,
586  const unsigned char *sig );
587 
613  int (*f_rng)(void *, unsigned char *, size_t),
614  void *p_rng,
615  int mode,
616  mbedtls_md_type_t md_alg,
617  unsigned int hashlen,
618  const unsigned char *hash,
619  mbedtls_md_type_t mgf1_hash_id,
620  int expected_salt_len,
621  const unsigned char *sig );
622 
633 
640 
646 int mbedtls_rsa_self_test( int verbose );
647 
648 #ifdef __cplusplus
649 }
650 #endif
651 
652 #endif /* MBEDTLS_RSA_C */
653 
654 #endif /* rsa.h */
int mbedtls_rsa_self_test(int verbose)
Checkup routine.
mbedtls_mpi DP
Definition: rsa.h:92
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)
Perform a PKCS#1 v1.5 signature (RSASSA-PKCS1-v1_5-SIGN)
int mbedtls_rsa_public(mbedtls_rsa_context *ctx, const unsigned char *input, unsigned char *output)
Do 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)
Perform a PKCS#1 v2.1 OAEP decryption (RSAES-OAEP-DECRYPT)
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)
Generic wrapper to perform a PKCS#1 verification using the mode from the context. ...
Configuration options (set of defines)
mbedtls_mpi DQ
Definition: rsa.h:93
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)
Generic wrapper to perform a PKCS#1 signature using the mode from the context.
void mbedtls_rsa_set_padding(mbedtls_rsa_context *ctx, int padding, int hash_id)
Set 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)
Perform a PKCS#1 v2.1 PSS verification (RSASSA-PSS-VERIFY) (This is the version with "full" options...
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)
Generic wrapper to perform a PKCS#1 decryption using the mode from the context.
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)
Perform a PKCS#1 v2.1 PSS signature (RSASSA-PSS-SIGN)
mbedtls_mpi RP
Definition: rsa.h:97
int mbedtls_rsa_check_pub_priv(const mbedtls_rsa_context *pub, const mbedtls_rsa_context *prv)
Check a public-private RSA key pair.
Threading abstraction layer.
mbedtls_mpi P
Definition: rsa.h:90
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)
Do 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)
Perform a PKCS#1 v1.5 decryption (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)
Perform a PKCS#1 v1.5 verification (RSASSA-PKCS1-v1_5-VERIFY)
mbedtls_mpi E
Definition: rsa.h:87
size_t len
Definition: rsa.h:84
mbedtls_mpi Vf
Definition: rsa.h:101
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)
Generic wrapper to perform a PKCS#1 encryption using the mode from the context.
mbedtls_mpi QP
Definition: rsa.h:94
mbedtls_mpi D
Definition: rsa.h:89
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)
Perform a PKCS#1 v2.1 PSS verification (RSASSA-PSS-VERIFY) (This is the "simple" version.)
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)
Perform a PKCS#1 v1.5 encryption (RSAES-PKCS1-v1_5-ENCRYPT)
MPI structure.
Definition: bignum.h:146
mbedtls_mpi N
Definition: rsa.h:86
int mbedtls_rsa_check_pubkey(const mbedtls_rsa_context *ctx)
Check a public RSA key.
mbedtls_mpi RN
Definition: rsa.h:96
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
Free the components of an RSA key.
mbedtls_mpi RQ
Definition: rsa.h:98
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)
Generate an RSA keypair.
int mbedtls_rsa_copy(mbedtls_rsa_context *dst, const mbedtls_rsa_context *src)
Copy the components of an RSA context.
int mbedtls_rsa_check_privkey(const mbedtls_rsa_context *ctx)
Check a private RSA key.
mbedtls_mpi Vi
Definition: rsa.h:100
mbedtls_md_type_t
Definition: md.h:41
mbedtls_mpi Q
Definition: rsa.h:91
RSA context structure.
Definition: rsa.h:81
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)
Perform a PKCS#1 v2.1 OAEP encryption (RSAES-OAEP-ENCRYPT)
void mbedtls_rsa_init(mbedtls_rsa_context *ctx, int padding, int hash_id)
Initialize an RSA context.