mbed TLS v2.7.6
rsa.h
Go to the documentation of this file.
1 
11 /*
12  * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
13  * SPDX-License-Identifier: Apache-2.0
14  *
15  * Licensed under the Apache License, Version 2.0 (the "License"); you may
16  * not use this file except in compliance with the License.
17  * You may obtain a copy of the License at
18  *
19  * http://www.apache.org/licenses/LICENSE-2.0
20  *
21  * Unless required by applicable law or agreed to in writing, software
22  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
23  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24  * See the License for the specific language governing permissions and
25  * limitations under the License.
26  *
27  * This file is part of Mbed TLS (https://tls.mbed.org)
28  */
29 #ifndef MBEDTLS_RSA_H
30 #define MBEDTLS_RSA_H
31 
32 #if !defined(MBEDTLS_CONFIG_FILE)
33 #include "config.h"
34 #else
35 #include MBEDTLS_CONFIG_FILE
36 #endif
37 
38 #include "bignum.h"
39 #include "md.h"
40 
41 #if defined(MBEDTLS_THREADING_C)
42 #include "threading.h"
43 #endif
44 
45 /*
46  * RSA Error codes
47  */
48 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
49 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
50 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
51 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
52 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
53 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
54 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
55 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
56 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
57 #define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
58 #define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
60 /*
61  * RSA constants
62  */
63 #define MBEDTLS_RSA_PUBLIC 0
64 #define MBEDTLS_RSA_PRIVATE 1
66 #define MBEDTLS_RSA_PKCS_V15 0
67 #define MBEDTLS_RSA_PKCS_V21 1
69 #define MBEDTLS_RSA_SIGN 1
70 #define MBEDTLS_RSA_CRYPT 2
72 #define MBEDTLS_RSA_SALT_LEN_ANY -1
73 
74 /*
75  * The above constants may be used even if the RSA module is compile out,
76  * eg for alternative (PKCS#11) RSA implemenations in the PK layers.
77  */
78 
79 #if !defined(MBEDTLS_RSA_ALT)
80 // Regular implementation
81 //
82 
83 #ifdef __cplusplus
84 extern "C" {
85 #endif
86 
94 typedef struct
95 {
96  int ver;
97  size_t len;
118  int padding;
121  int hash_id;
125 #if defined(MBEDTLS_THREADING_C)
127 #endif
128 }
130 
158  int padding,
159  int hash_id);
160 
190  const mbedtls_mpi *N,
191  const mbedtls_mpi *P, const mbedtls_mpi *Q,
192  const mbedtls_mpi *D, const mbedtls_mpi *E );
193 
228  unsigned char const *N, size_t N_len,
229  unsigned char const *P, size_t P_len,
230  unsigned char const *Q, size_t Q_len,
231  unsigned char const *D, size_t D_len,
232  unsigned char const *E, size_t E_len );
233 
266 
304  mbedtls_mpi *D, mbedtls_mpi *E );
305 
351  unsigned char *N, size_t N_len,
352  unsigned char *P, size_t P_len,
353  unsigned char *Q, size_t Q_len,
354  unsigned char *D, size_t D_len,
355  unsigned char *E, size_t E_len );
356 
373  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP );
374 
384 void mbedtls_rsa_set_padding( mbedtls_rsa_context *ctx, int padding,
385  int hash_id);
386 
395 size_t mbedtls_rsa_get_len( const mbedtls_rsa_context *ctx );
396 
413  int (*f_rng)(void *, unsigned char *, size_t),
414  void *p_rng,
415  unsigned int nbits, int exponent );
416 
432 
470 
483  const mbedtls_rsa_context *prv );
484 
504  const unsigned char *input,
505  unsigned char *output );
506 
535  int (*f_rng)(void *, unsigned char *, size_t),
536  void *p_rng,
537  const unsigned char *input,
538  unsigned char *output );
539 
573  int (*f_rng)(void *, unsigned char *, size_t),
574  void *p_rng,
575  int mode, size_t ilen,
576  const unsigned char *input,
577  unsigned char *output );
578 
608  int (*f_rng)(void *, unsigned char *, size_t),
609  void *p_rng,
610  int mode, size_t ilen,
611  const unsigned char *input,
612  unsigned char *output );
613 
645  int (*f_rng)(void *, unsigned char *, size_t),
646  void *p_rng,
647  int mode,
648  const unsigned char *label, size_t label_len,
649  size_t ilen,
650  const unsigned char *input,
651  unsigned char *output );
652 
692  int (*f_rng)(void *, unsigned char *, size_t),
693  void *p_rng,
694  int mode, size_t *olen,
695  const unsigned char *input,
696  unsigned char *output,
697  size_t output_max_len );
698 
735  int (*f_rng)(void *, unsigned char *, size_t),
736  void *p_rng,
737  int mode, size_t *olen,
738  const unsigned char *input,
739  unsigned char *output,
740  size_t output_max_len );
741 
781  int (*f_rng)(void *, unsigned char *, size_t),
782  void *p_rng,
783  int mode,
784  const unsigned char *label, size_t label_len,
785  size_t *olen,
786  const unsigned char *input,
787  unsigned char *output,
788  size_t output_max_len );
789 
828  int (*f_rng)(void *, unsigned char *, size_t),
829  void *p_rng,
830  int mode,
831  mbedtls_md_type_t md_alg,
832  unsigned int hashlen,
833  const unsigned char *hash,
834  unsigned char *sig );
835 
867  int (*f_rng)(void *, unsigned char *, size_t),
868  void *p_rng,
869  int mode,
870  mbedtls_md_type_t md_alg,
871  unsigned int hashlen,
872  const unsigned char *hash,
873  unsigned char *sig );
874 
914  int (*f_rng)(void *, unsigned char *, size_t),
915  void *p_rng,
916  int mode,
917  mbedtls_md_type_t md_alg,
918  unsigned int hashlen,
919  const unsigned char *hash,
920  unsigned char *sig );
921 
960  int (*f_rng)(void *, unsigned char *, size_t),
961  void *p_rng,
962  int mode,
963  mbedtls_md_type_t md_alg,
964  unsigned int hashlen,
965  const unsigned char *hash,
966  const unsigned char *sig );
967 
999  int (*f_rng)(void *, unsigned char *, size_t),
1000  void *p_rng,
1001  int mode,
1002  mbedtls_md_type_t md_alg,
1003  unsigned int hashlen,
1004  const unsigned char *hash,
1005  const unsigned char *sig );
1006 
1049  int (*f_rng)(void *, unsigned char *, size_t),
1050  void *p_rng,
1051  int mode,
1052  mbedtls_md_type_t md_alg,
1053  unsigned int hashlen,
1054  const unsigned char *hash,
1055  const unsigned char *sig );
1056 
1087  int (*f_rng)(void *, unsigned char *, size_t),
1088  void *p_rng,
1089  int mode,
1090  mbedtls_md_type_t md_alg,
1091  unsigned int hashlen,
1092  const unsigned char *hash,
1093  mbedtls_md_type_t mgf1_hash_id,
1094  int expected_salt_len,
1095  const unsigned char *sig );
1096 
1107 
1114 
1115 #ifdef __cplusplus
1116 }
1117 #endif
1118 
1119 #else /* MBEDTLS_RSA_ALT */
1120 #include "rsa_alt.h"
1121 #endif /* MBEDTLS_RSA_ALT */
1122 
1123 #ifdef __cplusplus
1124 extern "C" {
1125 #endif
1126 
1132 int mbedtls_rsa_self_test( int verbose );
1133 
1134 #ifdef __cplusplus
1135 }
1136 #endif
1137 
1138 #endif /* rsa.h */
int mbedtls_rsa_self_test(int verbose)
The RSA checkup routine.
mbedtls_mpi DP
Definition: rsa.h:106
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:107
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).
mbedtls_threading_mutex_t mutex
Definition: rsa.h:126
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:112
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:103
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:100
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:97
mbedtls_mpi Vf
Definition: rsa.h:116
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:108
mbedtls_mpi D
Definition: rsa.h:102
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:180
mbedtls_mpi N
Definition: rsa.h:99
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:110
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
mbedtls_mpi RQ
Definition: rsa.h:113
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:115
mbedtls_md_type_t
Enumeration of supported message digests.
Definition: md.h:56
mbedtls_mpi Q
Definition: rsa.h:104
The RSA context structure.
Definition: rsa.h:94
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.