ReactOS  0.4.15-dev-3442-gc05a45e
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  * This file is provided under the Apache License 2.0, or the
17  * GNU General Public License v2.0 or later.
18  *
19  * **********
20  * Apache License 2.0:
21  *
22  * Licensed under the Apache License, Version 2.0 (the "License"); you may
23  * not use this file except in compliance with the License.
24  * You may obtain a copy of the License at
25  *
26  * http://www.apache.org/licenses/LICENSE-2.0
27  *
28  * Unless required by applicable law or agreed to in writing, software
29  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
30  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
31  * See the License for the specific language governing permissions and
32  * limitations under the License.
33  *
34  * **********
35  *
36  * **********
37  * GNU General Public License v2.0 or later:
38  *
39  * This program is free software; you can redistribute it and/or modify
40  * it under the terms of the GNU General Public License as published by
41  * the Free Software Foundation; either version 2 of the License, or
42  * (at your option) any later version.
43  *
44  * This program is distributed in the hope that it will be useful,
45  * but WITHOUT ANY WARRANTY; without even the implied warranty of
46  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
47  * GNU General Public License for more details.
48  *
49  * You should have received a copy of the GNU General Public License along
50  * with this program; if not, write to the Free Software Foundation, Inc.,
51  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
52  *
53  * **********
54  */
55 #ifndef MBEDTLS_RSA_H
56 #define MBEDTLS_RSA_H
57 
58 #if !defined(MBEDTLS_CONFIG_FILE)
59 #include "config.h"
60 #else
61 #include MBEDTLS_CONFIG_FILE
62 #endif
63 
64 #include "bignum.h"
65 #include "md.h"
66 
67 #if defined(MBEDTLS_THREADING_C)
68 #include "threading.h"
69 #endif
70 
71 /*
72  * RSA Error codes
73  */
74 #define MBEDTLS_ERR_RSA_BAD_INPUT_DATA -0x4080
75 #define MBEDTLS_ERR_RSA_INVALID_PADDING -0x4100
76 #define MBEDTLS_ERR_RSA_KEY_GEN_FAILED -0x4180
77 #define MBEDTLS_ERR_RSA_KEY_CHECK_FAILED -0x4200
78 #define MBEDTLS_ERR_RSA_PUBLIC_FAILED -0x4280
79 #define MBEDTLS_ERR_RSA_PRIVATE_FAILED -0x4300
80 #define MBEDTLS_ERR_RSA_VERIFY_FAILED -0x4380
81 #define MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE -0x4400
82 #define MBEDTLS_ERR_RSA_RNG_FAILED -0x4480
84 /* MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION is deprecated and should not be used.
85  */
86 #define MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION -0x4500
88 /* MBEDTLS_ERR_RSA_HW_ACCEL_FAILED is deprecated and should not be used. */
89 #define MBEDTLS_ERR_RSA_HW_ACCEL_FAILED -0x4580
91 /*
92  * RSA constants
93  */
94 #define MBEDTLS_RSA_PUBLIC 0
95 #define MBEDTLS_RSA_PRIVATE 1
97 #define MBEDTLS_RSA_PKCS_V15 0
98 #define MBEDTLS_RSA_PKCS_V21 1
100 #define MBEDTLS_RSA_SIGN 1
101 #define MBEDTLS_RSA_CRYPT 2
103 #define MBEDTLS_RSA_SALT_LEN_ANY -1
104 
105 /*
106  * The above constants may be used even if the RSA module is compile out,
107  * eg for alternative (PKCS#11) RSA implemenations in the PK layers.
108  */
109 
110 #ifdef __cplusplus
111 extern "C" {
112 #endif
113 
114 #if !defined(MBEDTLS_RSA_ALT)
115 // Regular implementation
116 //
117 
125 typedef struct mbedtls_rsa_context
126 {
127  int ver;
131  size_t len;
152  int padding;
155  int hash_id;
159 #if defined(MBEDTLS_THREADING_C)
160  /* Invariant: the mutex is initialized iff ver != 0. */
161  mbedtls_threading_mutex_t mutex;
162 #endif
163 }
165 
166 #else /* MBEDTLS_RSA_ALT */
167 #include "rsa_alt.h"
168 #endif /* MBEDTLS_RSA_ALT */
169 
198  int padding,
199  int hash_id );
200 
231  const mbedtls_mpi *N,
232  const mbedtls_mpi *P, const mbedtls_mpi *Q,
233  const mbedtls_mpi *D, const mbedtls_mpi *E );
234 
270  unsigned char const *N, size_t N_len,
271  unsigned char const *P, size_t P_len,
272  unsigned char const *Q, size_t Q_len,
273  unsigned char const *D, size_t D_len,
274  unsigned char const *E, size_t E_len );
275 
309 
352  mbedtls_mpi *D, mbedtls_mpi *E );
353 
402  unsigned char *N, size_t N_len,
403  unsigned char *P, size_t P_len,
404  unsigned char *Q, size_t Q_len,
405  unsigned char *D, size_t D_len,
406  unsigned char *E, size_t E_len );
407 
428  mbedtls_mpi *DP, mbedtls_mpi *DQ, mbedtls_mpi *QP );
429 
440  int hash_id );
441 
451 
471  int (*f_rng)(void *, unsigned char *, size_t),
472  void *p_rng,
473  unsigned int nbits, int exponent );
474 
490 
528 
541  const mbedtls_rsa_context *prv );
542 
563  const unsigned char *input,
564  unsigned char *output );
565 
598  int (*f_rng)(void *, unsigned char *, size_t),
599  void *p_rng,
600  const unsigned char *input,
601  unsigned char *output );
602 
642  int (*f_rng)(void *, unsigned char *, size_t),
643  void *p_rng,
644  int mode, size_t ilen,
645  const unsigned char *input,
646  unsigned char *output );
647 
682  int (*f_rng)(void *, unsigned char *, size_t),
683  void *p_rng,
684  int mode, size_t ilen,
685  const unsigned char *input,
686  unsigned char *output );
687 
726  int (*f_rng)(void *, unsigned char *, size_t),
727  void *p_rng,
728  int mode,
729  const unsigned char *label, size_t label_len,
730  size_t ilen,
731  const unsigned char *input,
732  unsigned char *output );
733 
779  int (*f_rng)(void *, unsigned char *, size_t),
780  void *p_rng,
781  int mode, size_t *olen,
782  const unsigned char *input,
783  unsigned char *output,
784  size_t output_max_len );
785 
829  int (*f_rng)(void *, unsigned char *, size_t),
830  void *p_rng,
831  int mode, size_t *olen,
832  const unsigned char *input,
833  unsigned char *output,
834  size_t output_max_len );
835 
883  int (*f_rng)(void *, unsigned char *, size_t),
884  void *p_rng,
885  int mode,
886  const unsigned char *label, size_t label_len,
887  size_t *olen,
888  const unsigned char *input,
889  unsigned char *output,
890  size_t output_max_len );
891 
943  int (*f_rng)(void *, unsigned char *, size_t),
944  void *p_rng,
945  int mode,
946  mbedtls_md_type_t md_alg,
947  unsigned int hashlen,
948  const unsigned char *hash,
949  unsigned char *sig );
950 
991  int (*f_rng)(void *, unsigned char *, size_t),
992  void *p_rng,
993  int mode,
994  mbedtls_md_type_t md_alg,
995  unsigned int hashlen,
996  const unsigned char *hash,
997  unsigned char *sig );
998 
1053  int (*f_rng)(void *, unsigned char *, size_t),
1054  void *p_rng,
1055  int mode,
1056  mbedtls_md_type_t md_alg,
1057  unsigned int hashlen,
1058  const unsigned char *hash,
1059  unsigned char *sig );
1060 
1106  int (*f_rng)(void *, unsigned char *, size_t),
1107  void *p_rng,
1108  int mode,
1109  mbedtls_md_type_t md_alg,
1110  unsigned int hashlen,
1111  const unsigned char *hash,
1112  const unsigned char *sig );
1113 
1152  int (*f_rng)(void *, unsigned char *, size_t),
1153  void *p_rng,
1154  int mode,
1155  mbedtls_md_type_t md_alg,
1156  unsigned int hashlen,
1157  const unsigned char *hash,
1158  const unsigned char *sig );
1159 
1209  int (*f_rng)(void *, unsigned char *, size_t),
1210  void *p_rng,
1211  int mode,
1212  mbedtls_md_type_t md_alg,
1213  unsigned int hashlen,
1214  const unsigned char *hash,
1215  const unsigned char *sig );
1216 
1257  int (*f_rng)(void *, unsigned char *, size_t),
1258  void *p_rng,
1259  int mode,
1260  mbedtls_md_type_t md_alg,
1261  unsigned int hashlen,
1262  const unsigned char *hash,
1263  mbedtls_md_type_t mgf1_hash_id,
1264  int expected_salt_len,
1265  const unsigned char *sig );
1266 
1277 
1286 
1287 #if defined(MBEDTLS_SELF_TEST)
1288 
1295 int mbedtls_rsa_self_test( int verbose );
1296 
1297 #endif /* MBEDTLS_SELF_TEST */
1298 
1299 #ifdef __cplusplus
1300 }
1301 #endif
1302 
1303 #endif /* rsa.h */
mbedtls_mpi DP
Definition: rsa.h:140
static UCHAR ULONG UCHAR ULONG UCHAR * output
Definition: bcrypt.c:29
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.
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:141
HANDLE mutex
Definition: loader.c:2140
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.
#define verbose
Definition: rosglue.h:36
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:146
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:137
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.
unsigned int padding
Definition: isohybrid.c:50
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.
#define D(d)
Definition: builtin.c:4557
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:134
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:131
mbedtls_mpi Vf
Definition: rsa.h:150
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:142
GLenum src
Definition: glext.h:6340
GLenum mode
Definition: glext.h:6217
uint8_t label[11]
Definition: fsck.fat.h:65
mbedtls_mpi D
Definition: rsa.h:136
#define P(row, col)
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.
static const WCHAR E[]
Definition: oid.c:1253
GLenum GLenum GLenum input
Definition: glext.h:9031
MPI structure.
Definition: bignum.h:210
mbedtls_mpi N
Definition: rsa.h:133
GLenum GLenum dst
Definition: glext.h:6340
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:144
void mbedtls_rsa_free(mbedtls_rsa_context *ctx)
This function frees the components of an RSA key.
mbedtls_mpi RQ
Definition: rsa.h:147
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:149
mbedtls_md_type_t
Supported message digests.
Definition: md.h:83
mbedtls_mpi Q
Definition: rsa.h:138
The RSA context structure.
Definition: rsa.h:125
Definition: _hash_fun.h:40
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.