ERR: Rebuild all generated error headers and source files
[openssl.git] / include / openssl / rsa.h
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef OPENSSL_RSA_H
11 # define OPENSSL_RSA_H
12 # pragma once
13
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
16 #  define HEADER_RSA_H
17 # endif
18
19 # include <openssl/opensslconf.h>
20
21 # ifndef OPENSSL_NO_RSA
22 #  include <openssl/asn1.h>
23 #  include <openssl/bio.h>
24 #  include <openssl/crypto.h>
25 #  include <openssl/types.h>
26 #  ifndef OPENSSL_NO_DEPRECATED_1_1_0
27 #   include <openssl/bn.h>
28 #  endif
29 #  include <openssl/rsaerr.h>
30 #  include <openssl/safestack.h>
31
32 #  ifdef  __cplusplus
33 extern "C" {
34 #  endif
35
36 #  ifndef OPENSSL_RSA_MAX_MODULUS_BITS
37 #   define OPENSSL_RSA_MAX_MODULUS_BITS   16384
38 #  endif
39
40 #  define RSA_3   0x3L
41 #  define RSA_F4  0x10001L
42
43 #  ifndef OPENSSL_NO_DEPRECATED_3_0
44 /* The types RSA and RSA_METHOD are defined in ossl_typ.h */
45
46 #   define OPENSSL_RSA_FIPS_MIN_MODULUS_BITS 2048
47
48 #   ifndef OPENSSL_RSA_SMALL_MODULUS_BITS
49 #    define OPENSSL_RSA_SMALL_MODULUS_BITS 3072
50 #   endif
51
52 /* exponent limit enforced for "large" modulus only */
53 #   ifndef OPENSSL_RSA_MAX_PUBEXP_BITS
54 #    define OPENSSL_RSA_MAX_PUBEXP_BITS    64
55 #   endif
56 /* based on RFC 8017 appendix A.1.2 */
57 #   define RSA_ASN1_VERSION_DEFAULT        0
58 #   define RSA_ASN1_VERSION_MULTI          1
59
60 #   define RSA_DEFAULT_PRIME_NUM           2
61
62 #   define RSA_METHOD_FLAG_NO_CHECK        0x0001
63 #   define RSA_FLAG_CACHE_PUBLIC           0x0002
64 #   define RSA_FLAG_CACHE_PRIVATE          0x0004
65 #   define RSA_FLAG_BLINDING               0x0008
66 #   define RSA_FLAG_THREAD_SAFE            0x0010
67 /*
68  * This flag means the private key operations will be handled by rsa_mod_exp
69  * and that they do not depend on the private key components being present:
70  * for example a key stored in external hardware. Without this flag
71  * bn_mod_exp gets called when private key components are absent.
72  */
73 #   define RSA_FLAG_EXT_PKEY               0x0020
74
75 /*
76  * new with 0.9.6j and 0.9.7b; the built-in
77  * RSA implementation now uses blinding by
78  * default (ignoring RSA_FLAG_BLINDING),
79  * but other engines might not need it
80  */
81 #   define RSA_FLAG_NO_BLINDING            0x0080
82 #  endif /* OPENSSL_NO_DEPRECATED_3_0 */
83 /*
84  * Does nothing. Previously this switched off constant time behaviour.
85  */
86 #  ifndef OPENSSL_NO_DEPRECATED_1_1_0
87 #   define RSA_FLAG_NO_CONSTTIME           0x0000
88 #  endif
89 /* deprecated name for the flag*/
90 /*
91  * new with 0.9.7h; the built-in RSA
92  * implementation now uses constant time
93  * modular exponentiation for secret exponents
94  * by default. This flag causes the
95  * faster variable sliding window method to
96  * be used for all exponents.
97  */
98 #  ifndef OPENSSL_NO_DEPRECATED_0_9_8
99 #   define RSA_FLAG_NO_EXP_CONSTTIME RSA_FLAG_NO_CONSTTIME
100 #  endif
101
102 /*-
103  * New with 3.0: use part of the flags to denote exact type of RSA key,
104  * some of which are limited to specific signature and encryption schemes.
105  * These different types share the same RSA structure, but indicate the
106  * use of certain fields in that structure.
107  * Currently known are:
108  * RSA          - this is the "normal" unlimited RSA structure (typenum 0)
109  * RSASSA-PSS   - indicates that the PSS parameters are used.
110  * RSAES-OAEP   - no specific field used for the moment, but OAEP padding
111  *                is expected.  (currently unused)
112  *
113  * 4 bits allow for 16 types
114  */
115 #  define RSA_FLAG_TYPE_MASK            0xF000
116 #  define RSA_FLAG_TYPE_RSA             0x0000
117 #  define RSA_FLAG_TYPE_RSASSAPSS       0x1000
118 #  define RSA_FLAG_TYPE_RSAESOAEP       0x2000
119
120 int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad_mode);
121 int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx, int *pad_mode);
122
123 int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int saltlen);
124 int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int *saltlen);
125
126 int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int bits);
127 int EVP_PKEY_CTX_set1_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp);
128 int EVP_PKEY_CTX_set_rsa_keygen_primes(EVP_PKEY_CTX *ctx, int primes);
129 int EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen(EVP_PKEY_CTX *ctx, int saltlen);
130 #  ifndef OPENSSL_NO_DEPRECATED_3_0
131 OSSL_DEPRECATEDIN_3_0
132 int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp);
133 #  endif
134
135 /* Salt length matches digest */
136 #  define RSA_PSS_SALTLEN_DIGEST -1
137 /* Verify only: auto detect salt length */
138 #  define RSA_PSS_SALTLEN_AUTO   -2
139 /* Set salt length to maximum possible */
140 #  define RSA_PSS_SALTLEN_MAX    -3
141 /* Old compatible max salt length for sign only */
142 #  define RSA_PSS_SALTLEN_MAX_SIGN    -2
143
144 int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
145 int EVP_PKEY_CTX_set_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
146                                       const char *mdprops);
147 int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
148 int EVP_PKEY_CTX_get_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, char *name,
149                                       size_t namelen);
150 int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
151 int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md_name(EVP_PKEY_CTX *ctx,
152                                                  const char *mdname);
153
154 int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
155 int EVP_PKEY_CTX_set_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
156                                       const char *mdprops);
157 int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
158 int EVP_PKEY_CTX_get_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, char *name,
159                                       size_t namelen);
160 int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx, void *label, int llen);
161 int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char **label);
162
163 #  define  EVP_PKEY_CTX_set_rsa_pss_keygen_md(ctx, md) \
164         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA_PSS,  \
165                           EVP_PKEY_OP_KEYGEN, EVP_PKEY_CTRL_MD,  \
166                           0, (void *)(md))
167
168
169 #  define EVP_PKEY_CTRL_RSA_PADDING       (EVP_PKEY_ALG_CTRL + 1)
170 #  define EVP_PKEY_CTRL_RSA_PSS_SALTLEN   (EVP_PKEY_ALG_CTRL + 2)
171
172 #  define EVP_PKEY_CTRL_RSA_KEYGEN_BITS   (EVP_PKEY_ALG_CTRL + 3)
173 #  define EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP (EVP_PKEY_ALG_CTRL + 4)
174 #  define EVP_PKEY_CTRL_RSA_MGF1_MD       (EVP_PKEY_ALG_CTRL + 5)
175
176 #  define EVP_PKEY_CTRL_GET_RSA_PADDING           (EVP_PKEY_ALG_CTRL + 6)
177 #  define EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN       (EVP_PKEY_ALG_CTRL + 7)
178 #  define EVP_PKEY_CTRL_GET_RSA_MGF1_MD           (EVP_PKEY_ALG_CTRL + 8)
179
180 #  define EVP_PKEY_CTRL_RSA_OAEP_MD       (EVP_PKEY_ALG_CTRL + 9)
181 #  define EVP_PKEY_CTRL_RSA_OAEP_LABEL    (EVP_PKEY_ALG_CTRL + 10)
182
183 #  define EVP_PKEY_CTRL_GET_RSA_OAEP_MD   (EVP_PKEY_ALG_CTRL + 11)
184 #  define EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 12)
185
186 #  define EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES  (EVP_PKEY_ALG_CTRL + 13)
187
188 #  define RSA_PKCS1_PADDING          1
189 #  define RSA_SSLV23_PADDING         2
190 #  define RSA_NO_PADDING             3
191 #  define RSA_PKCS1_OAEP_PADDING     4
192 #  define RSA_X931_PADDING           5
193
194 /* EVP_PKEY_ only */
195 #  define RSA_PKCS1_PSS_PADDING      6
196 #  define RSA_PKCS1_WITH_TLS_PADDING 7
197
198 #  define RSA_PKCS1_PADDING_SIZE    11
199
200 #  define RSA_set_app_data(s,arg)         RSA_set_ex_data(s,0,arg)
201 #  define RSA_get_app_data(s)             RSA_get_ex_data(s,0)
202
203 #  ifndef OPENSSL_NO_DEPRECATED_3_0
204 OSSL_DEPRECATEDIN_3_0 RSA *RSA_new(void);
205 OSSL_DEPRECATEDIN_3_0 RSA *RSA_new_method(ENGINE *engine);
206 OSSL_DEPRECATEDIN_3_0 int RSA_bits(const RSA *rsa);
207 OSSL_DEPRECATEDIN_3_0 int RSA_size(const RSA *rsa);
208 OSSL_DEPRECATEDIN_3_0 int RSA_security_bits(const RSA *rsa);
209
210 OSSL_DEPRECATEDIN_3_0 int RSA_set0_key(RSA *r, BIGNUM *n, BIGNUM *e, BIGNUM *d);
211 OSSL_DEPRECATEDIN_3_0 int RSA_set0_factors(RSA *r, BIGNUM *p, BIGNUM *q);
212 OSSL_DEPRECATEDIN_3_0 int RSA_set0_crt_params(RSA *r,
213                                               BIGNUM *dmp1, BIGNUM *dmq1,
214                                               BIGNUM *iqmp);
215 OSSL_DEPRECATEDIN_3_0 int RSA_set0_multi_prime_params(RSA *r,
216                                                       BIGNUM *primes[],
217                                                       BIGNUM *exps[],
218                                                       BIGNUM *coeffs[],
219                                                       int pnum);
220 OSSL_DEPRECATEDIN_3_0 void RSA_get0_key(const RSA *r,
221                                         const BIGNUM **n, const BIGNUM **e,
222                                         const BIGNUM **d);
223 OSSL_DEPRECATEDIN_3_0 void RSA_get0_factors(const RSA *r,
224                                             const BIGNUM **p, const BIGNUM **q);
225 OSSL_DEPRECATEDIN_3_0 int RSA_get_multi_prime_extra_count(const RSA *r);
226 OSSL_DEPRECATEDIN_3_0 int RSA_get0_multi_prime_factors(const RSA *r,
227                                                        const BIGNUM *primes[]);
228 OSSL_DEPRECATEDIN_3_0 void RSA_get0_crt_params(const RSA *r,
229                                                const BIGNUM **dmp1,
230                                                const BIGNUM **dmq1,
231                                                const BIGNUM **iqmp);
232 OSSL_DEPRECATEDIN_3_0
233 int RSA_get0_multi_prime_crt_params(const RSA *r, const BIGNUM *exps[],
234                                     const BIGNUM *coeffs[]);
235 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_n(const RSA *d);
236 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_e(const RSA *d);
237 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_d(const RSA *d);
238 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_p(const RSA *d);
239 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_q(const RSA *d);
240 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_dmp1(const RSA *r);
241 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_dmq1(const RSA *r);
242 OSSL_DEPRECATEDIN_3_0 const BIGNUM *RSA_get0_iqmp(const RSA *r);
243 OSSL_DEPRECATEDIN_3_0 const RSA_PSS_PARAMS *RSA_get0_pss_params(const RSA *r);
244 OSSL_DEPRECATEDIN_3_0 void RSA_clear_flags(RSA *r, int flags);
245 OSSL_DEPRECATEDIN_3_0 int RSA_test_flags(const RSA *r, int flags);
246 OSSL_DEPRECATEDIN_3_0 void RSA_set_flags(RSA *r, int flags);
247 OSSL_DEPRECATEDIN_3_0 int RSA_get_version(RSA *r);
248 OSSL_DEPRECATEDIN_3_0 ENGINE *RSA_get0_engine(const RSA *r);
249 #  endif  /* !OPENSSL_NO_DEPRECATED_3_0 */
250
251 /* Deprecated version */
252 #  ifndef OPENSSL_NO_DEPRECATED_0_9_8
253 OSSL_DEPRECATEDIN_0_9_8 RSA *RSA_generate_key(int bits, unsigned long e, void
254                                               (*callback) (int, int, void *),
255                                               void *cb_arg);
256 #  endif
257
258 /* New version */
259 #  ifndef OPENSSL_NO_DEPRECATED_3_0
260 OSSL_DEPRECATEDIN_3_0 int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e,
261                                               BN_GENCB *cb);
262 /* Multi-prime version */
263 OSSL_DEPRECATEDIN_3_0 int RSA_generate_multi_prime_key(RSA *rsa, int bits,
264                                                        int primes, BIGNUM *e,
265                                                        BN_GENCB *cb);
266
267 OSSL_DEPRECATEDIN_3_0
268 int RSA_X931_derive_ex(RSA *rsa, BIGNUM *p1, BIGNUM *p2,
269                        BIGNUM *q1, BIGNUM *q2,
270                        const BIGNUM *Xp1, const BIGNUM *Xp2,
271                        const BIGNUM *Xp, const BIGNUM *Xq1,
272                        const BIGNUM *Xq2, const BIGNUM *Xq,
273                        const BIGNUM *e, BN_GENCB *cb);
274 OSSL_DEPRECATEDIN_3_0 int RSA_X931_generate_key_ex(RSA *rsa, int bits,
275                                                    const BIGNUM *e,
276                                                    BN_GENCB *cb);
277
278 OSSL_DEPRECATEDIN_3_0 int RSA_check_key(const RSA *);
279 OSSL_DEPRECATEDIN_3_0 int RSA_check_key_ex(const RSA *, BN_GENCB *cb);
280         /* next 4 return -1 on error */
281 OSSL_DEPRECATEDIN_3_0
282 int RSA_public_encrypt(int flen, const unsigned char *from, unsigned char *to,
283                        RSA *rsa, int padding);
284 OSSL_DEPRECATEDIN_3_0
285 int RSA_private_encrypt(int flen, const unsigned char *from, unsigned char *to,
286                         RSA *rsa, int padding);
287 OSSL_DEPRECATEDIN_3_0
288 int RSA_public_decrypt(int flen, const unsigned char *from, unsigned char *to,
289                        RSA *rsa, int padding);
290 OSSL_DEPRECATEDIN_3_0
291 int RSA_private_decrypt(int flen, const unsigned char *from, unsigned char *to,
292                         RSA *rsa, int padding);
293 OSSL_DEPRECATEDIN_3_0 void RSA_free(RSA *r);
294 /* "up" the RSA object's reference count */
295 OSSL_DEPRECATEDIN_3_0 int RSA_up_ref(RSA *r);
296 OSSL_DEPRECATEDIN_3_0 int RSA_flags(const RSA *r);
297
298 OSSL_DEPRECATEDIN_3_0 void RSA_set_default_method(const RSA_METHOD *meth);
299 OSSL_DEPRECATEDIN_3_0 const RSA_METHOD *RSA_get_default_method(void);
300 OSSL_DEPRECATEDIN_3_0 const RSA_METHOD *RSA_null_method(void);
301 OSSL_DEPRECATEDIN_3_0 const RSA_METHOD *RSA_get_method(const RSA *rsa);
302 OSSL_DEPRECATEDIN_3_0 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
303
304 /* these are the actual RSA functions */
305 OSSL_DEPRECATEDIN_3_0 const RSA_METHOD *RSA_PKCS1_OpenSSL(void);
306
307 DECLARE_ASN1_ENCODE_FUNCTIONS_name_attr(OSSL_DEPRECATEDIN_3_0,
308                                         RSA, RSAPublicKey)
309 DECLARE_ASN1_ENCODE_FUNCTIONS_name_attr(OSSL_DEPRECATEDIN_3_0,
310                                         RSA, RSAPrivateKey)
311 #  endif  /* !OPENSSL_NO_DEPRECATED_3_0 */
312
313 int RSA_pkey_ctx_ctrl(EVP_PKEY_CTX *ctx, int optype, int cmd, int p1, void *p2);
314
315 struct rsa_pss_params_st {
316     X509_ALGOR *hashAlgorithm;
317     X509_ALGOR *maskGenAlgorithm;
318     ASN1_INTEGER *saltLength;
319     ASN1_INTEGER *trailerField;
320     /* Decoded hash algorithm from maskGenAlgorithm */
321     X509_ALGOR *maskHash;
322 };
323
324 DECLARE_ASN1_FUNCTIONS(RSA_PSS_PARAMS)
325
326 typedef struct rsa_oaep_params_st {
327     X509_ALGOR *hashFunc;
328     X509_ALGOR *maskGenFunc;
329     X509_ALGOR *pSourceFunc;
330     /* Decoded hash algorithm from maskGenFunc */
331     X509_ALGOR *maskHash;
332 } RSA_OAEP_PARAMS;
333
334 DECLARE_ASN1_FUNCTIONS(RSA_OAEP_PARAMS)
335
336 #  ifndef OPENSSL_NO_DEPRECATED_3_0
337 #   ifndef OPENSSL_NO_STDIO
338 OSSL_DEPRECATEDIN_3_0 int RSA_print_fp(FILE *fp, const RSA *r, int offset);
339 #   endif
340
341 OSSL_DEPRECATEDIN_3_0 int RSA_print(BIO *bp, const RSA *r, int offset);
342
343 /*
344  * The following 2 functions sign and verify a X509_SIG ASN1 object inside
345  * PKCS#1 padded RSA encryption
346  */
347 OSSL_DEPRECATEDIN_3_0 int RSA_sign(int type, const unsigned char *m,
348                                    unsigned int m_length, unsigned char *sigret,
349                                    unsigned int *siglen, RSA *rsa);
350 OSSL_DEPRECATEDIN_3_0 int RSA_verify(int type, const unsigned char *m,
351                                      unsigned int m_length,
352                                      const unsigned char *sigbuf,
353                                      unsigned int siglen, RSA *rsa);
354
355 /*
356  * The following 2 function sign and verify a ASN1_OCTET_STRING object inside
357  * PKCS#1 padded RSA encryption
358  */
359 OSSL_DEPRECATEDIN_3_0
360 int RSA_sign_ASN1_OCTET_STRING(int type,
361                                const unsigned char *m, unsigned int m_length,
362                                unsigned char *sigret, unsigned int *siglen,
363                                RSA *rsa);
364 OSSL_DEPRECATEDIN_3_0
365 int RSA_verify_ASN1_OCTET_STRING(int type,
366                                  const unsigned char *m, unsigned int m_length,
367                                  unsigned char *sigbuf, unsigned int siglen,
368                                  RSA *rsa);
369
370 OSSL_DEPRECATEDIN_3_0 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
371 OSSL_DEPRECATEDIN_3_0 void RSA_blinding_off(RSA *rsa);
372 OSSL_DEPRECATEDIN_3_0 BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);
373
374 OSSL_DEPRECATEDIN_3_0
375 int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
376                                  const unsigned char *f, int fl);
377 OSSL_DEPRECATEDIN_3_0
378 int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
379                                    const unsigned char *f, int fl,
380                                    int rsa_len);
381 OSSL_DEPRECATEDIN_3_0
382 int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
383                                  const unsigned char *f, int fl);
384 OSSL_DEPRECATEDIN_3_0
385 int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
386                                    const unsigned char *f, int fl,
387                                    int rsa_len);
388 OSSL_DEPRECATEDIN_3_0 int PKCS1_MGF1(unsigned char *mask, long len,
389                                      const unsigned char *seed, long seedlen,
390                                      const EVP_MD *dgst);
391 OSSL_DEPRECATEDIN_3_0
392 int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
393                                const unsigned char *f, int fl,
394                                const unsigned char *p, int pl);
395 OSSL_DEPRECATEDIN_3_0
396 int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
397                                  const unsigned char *f, int fl, int rsa_len,
398                                  const unsigned char *p, int pl);
399 OSSL_DEPRECATEDIN_3_0
400 int RSA_padding_add_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
401                                     const unsigned char *from, int flen,
402                                     const unsigned char *param, int plen,
403                                     const EVP_MD *md, const EVP_MD *mgf1md);
404 OSSL_DEPRECATEDIN_3_0
405 int RSA_padding_check_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
406                                       const unsigned char *from, int flen,
407                                       int num,
408                                       const unsigned char *param, int plen,
409                                       const EVP_MD *md, const EVP_MD *mgf1md);
410 OSSL_DEPRECATEDIN_3_0
411 int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
412                            const unsigned char *f, int fl);
413 OSSL_DEPRECATEDIN_3_0
414 int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
415                              const unsigned char *f, int fl,
416                              int rsa_len);
417 OSSL_DEPRECATEDIN_3_0 int RSA_padding_add_none(unsigned char *to, int tlen,
418                                                const unsigned char *f, int fl);
419 OSSL_DEPRECATEDIN_3_0 int RSA_padding_check_none(unsigned char *to, int tlen,
420                                                  const unsigned char *f, int fl,
421                                                  int rsa_len);
422 OSSL_DEPRECATEDIN_3_0 int RSA_padding_add_X931(unsigned char *to, int tlen,
423                                                const unsigned char *f, int fl);
424 OSSL_DEPRECATEDIN_3_0 int RSA_padding_check_X931(unsigned char *to, int tlen,
425                                                  const unsigned char *f, int fl,
426                                                  int rsa_len);
427 OSSL_DEPRECATEDIN_3_0 int RSA_X931_hash_id(int nid);
428
429 OSSL_DEPRECATEDIN_3_0
430 int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash,
431                          const EVP_MD *Hash, const unsigned char *EM,
432                          int sLen);
433 OSSL_DEPRECATEDIN_3_0
434 int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM,
435                               const unsigned char *mHash, const EVP_MD *Hash,
436                               int sLen);
437
438 OSSL_DEPRECATEDIN_3_0
439 int RSA_verify_PKCS1_PSS_mgf1(RSA *rsa, const unsigned char *mHash,
440                               const EVP_MD *Hash, const EVP_MD *mgf1Hash,
441                               const unsigned char *EM, int sLen);
442
443 OSSL_DEPRECATEDIN_3_0
444 int RSA_padding_add_PKCS1_PSS_mgf1(RSA *rsa, unsigned char *EM,
445                                    const unsigned char *mHash,
446                                    const EVP_MD *Hash, const EVP_MD *mgf1Hash,
447                                    int sLen);
448
449 #  define RSA_get_ex_new_index(l, p, newf, dupf, freef) \
450     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_RSA, l, p, newf, dupf, freef)
451 OSSL_DEPRECATEDIN_3_0 int RSA_set_ex_data(RSA *r, int idx, void *arg);
452 OSSL_DEPRECATEDIN_3_0 void *RSA_get_ex_data(const RSA *r, int idx);
453
454 DECLARE_ASN1_DUP_FUNCTION_name_attr(OSSL_DEPRECATEDIN_3_0, RSA, RSAPublicKey)
455 DECLARE_ASN1_DUP_FUNCTION_name_attr(OSSL_DEPRECATEDIN_3_0, RSA, RSAPrivateKey)
456
457 /*
458  * If this flag is set the RSA method is FIPS compliant and can be used in
459  * FIPS mode. This is set in the validated module method. If an application
460  * sets this flag in its own methods it is its responsibility to ensure the
461  * result is compliant.
462  */
463
464 #   define RSA_FLAG_FIPS_METHOD                    0x0400
465
466 /*
467  * If this flag is set the operations normally disabled in FIPS mode are
468  * permitted it is then the applications responsibility to ensure that the
469  * usage is compliant.
470  */
471
472 #   define RSA_FLAG_NON_FIPS_ALLOW                 0x0400
473 /*
474  * Application has decided PRNG is good enough to generate a key: don't
475  * check.
476  */
477 #   define RSA_FLAG_CHECKED                        0x0800
478
479 OSSL_DEPRECATEDIN_3_0 RSA_METHOD *RSA_meth_new(const char *name, int flags);
480 OSSL_DEPRECATEDIN_3_0 void RSA_meth_free(RSA_METHOD *meth);
481 OSSL_DEPRECATEDIN_3_0 RSA_METHOD *RSA_meth_dup(const RSA_METHOD *meth);
482 OSSL_DEPRECATEDIN_3_0 const char *RSA_meth_get0_name(const RSA_METHOD *meth);
483 OSSL_DEPRECATEDIN_3_0 int RSA_meth_set1_name(RSA_METHOD *meth,
484                                              const char *name);
485 OSSL_DEPRECATEDIN_3_0 int RSA_meth_get_flags(const RSA_METHOD *meth);
486 OSSL_DEPRECATEDIN_3_0 int RSA_meth_set_flags(RSA_METHOD *meth, int flags);
487 OSSL_DEPRECATEDIN_3_0 void *RSA_meth_get0_app_data(const RSA_METHOD *meth);
488 OSSL_DEPRECATEDIN_3_0 int RSA_meth_set0_app_data(RSA_METHOD *meth,
489                                                  void *app_data);
490 OSSL_DEPRECATEDIN_3_0
491 int (*RSA_meth_get_pub_enc(const RSA_METHOD *meth)) (int flen,
492                                                      const unsigned char *from,
493                                                      unsigned char *to,
494                                                      RSA *rsa, int padding);
495 OSSL_DEPRECATEDIN_3_0
496 int RSA_meth_set_pub_enc(RSA_METHOD *rsa,
497                          int (*pub_enc) (int flen, const unsigned char *from,
498                                          unsigned char *to, RSA *rsa,
499                                          int padding));
500 OSSL_DEPRECATEDIN_3_0
501 int (*RSA_meth_get_pub_dec(const RSA_METHOD *meth)) (int flen,
502                                                      const unsigned char *from,
503                                                      unsigned char *to,
504                                                      RSA *rsa, int padding);
505 OSSL_DEPRECATEDIN_3_0
506 int RSA_meth_set_pub_dec(RSA_METHOD *rsa,
507                          int (*pub_dec) (int flen, const unsigned char *from,
508                                          unsigned char *to, RSA *rsa,
509                                          int padding));
510 OSSL_DEPRECATEDIN_3_0
511 int (*RSA_meth_get_priv_enc(const RSA_METHOD *meth)) (int flen,
512                                                       const unsigned char *from,
513                                                       unsigned char *to,
514                                                       RSA *rsa, int padding);
515 OSSL_DEPRECATEDIN_3_0
516 int RSA_meth_set_priv_enc(RSA_METHOD *rsa,
517                           int (*priv_enc) (int flen, const unsigned char *from,
518                                            unsigned char *to, RSA *rsa,
519                                            int padding));
520 OSSL_DEPRECATEDIN_3_0
521 int (*RSA_meth_get_priv_dec(const RSA_METHOD *meth)) (int flen,
522                                                       const unsigned char *from,
523                                                       unsigned char *to,
524                                                       RSA *rsa, int padding);
525 OSSL_DEPRECATEDIN_3_0
526 int RSA_meth_set_priv_dec(RSA_METHOD *rsa,
527                           int (*priv_dec) (int flen, const unsigned char *from,
528                                            unsigned char *to, RSA *rsa,
529                                            int padding));
530 OSSL_DEPRECATEDIN_3_0
531 int (*RSA_meth_get_mod_exp(const RSA_METHOD *meth)) (BIGNUM *r0,
532                                                      const BIGNUM *i,
533                                                      RSA *rsa, BN_CTX *ctx);
534 OSSL_DEPRECATEDIN_3_0
535 int RSA_meth_set_mod_exp(RSA_METHOD *rsa,
536                          int (*mod_exp) (BIGNUM *r0, const BIGNUM *i, RSA *rsa,
537                                          BN_CTX *ctx));
538 OSSL_DEPRECATEDIN_3_0
539 int (*RSA_meth_get_bn_mod_exp(const RSA_METHOD *meth)) (BIGNUM *r,
540                                                         const BIGNUM *a,
541                                                         const BIGNUM *p,
542                                                         const BIGNUM *m,
543                                                         BN_CTX *ctx,
544                                                         BN_MONT_CTX *m_ctx);
545 OSSL_DEPRECATEDIN_3_0
546 int RSA_meth_set_bn_mod_exp(RSA_METHOD *rsa,
547                             int (*bn_mod_exp) (BIGNUM *r,
548                                                const BIGNUM *a,
549                                                const BIGNUM *p,
550                                                const BIGNUM *m,
551                                                BN_CTX *ctx,
552                                                BN_MONT_CTX *m_ctx));
553 OSSL_DEPRECATEDIN_3_0
554 int (*RSA_meth_get_init(const RSA_METHOD *meth)) (RSA *rsa);
555 OSSL_DEPRECATEDIN_3_0
556 int RSA_meth_set_init(RSA_METHOD *rsa, int (*init) (RSA *rsa));
557 OSSL_DEPRECATEDIN_3_0
558 int (*RSA_meth_get_finish(const RSA_METHOD *meth)) (RSA *rsa);
559 OSSL_DEPRECATEDIN_3_0
560 int RSA_meth_set_finish(RSA_METHOD *rsa, int (*finish) (RSA *rsa));
561 OSSL_DEPRECATEDIN_3_0
562 int (*RSA_meth_get_sign(const RSA_METHOD *meth)) (int type,
563                                                   const unsigned char *m,
564                                                   unsigned int m_length,
565                                                   unsigned char *sigret,
566                                                   unsigned int *siglen,
567                                                   const RSA *rsa);
568 OSSL_DEPRECATEDIN_3_0
569 int RSA_meth_set_sign(RSA_METHOD *rsa,
570                       int (*sign) (int type, const unsigned char *m,
571                                    unsigned int m_length,
572                                    unsigned char *sigret, unsigned int *siglen,
573                                    const RSA *rsa));
574 OSSL_DEPRECATEDIN_3_0
575 int (*RSA_meth_get_verify(const RSA_METHOD *meth)) (int dtype,
576                                                     const unsigned char *m,
577                                                     unsigned int m_length,
578                                                     const unsigned char *sigbuf,
579                                                     unsigned int siglen,
580                                                     const RSA *rsa);
581 OSSL_DEPRECATEDIN_3_0
582 int RSA_meth_set_verify(RSA_METHOD *rsa,
583                         int (*verify) (int dtype, const unsigned char *m,
584                                        unsigned int m_length,
585                                        const unsigned char *sigbuf,
586                                        unsigned int siglen, const RSA *rsa));
587 OSSL_DEPRECATEDIN_3_0
588 int (*RSA_meth_get_keygen(const RSA_METHOD *meth)) (RSA *rsa, int bits,
589                                                     BIGNUM *e, BN_GENCB *cb);
590 OSSL_DEPRECATEDIN_3_0
591 int RSA_meth_set_keygen(RSA_METHOD *rsa,
592                         int (*keygen) (RSA *rsa, int bits, BIGNUM *e,
593                                        BN_GENCB *cb));
594 OSSL_DEPRECATEDIN_3_0
595 int (*RSA_meth_get_multi_prime_keygen(const RSA_METHOD *meth)) (RSA *rsa,
596                                                                 int bits,
597                                                                 int primes,
598                                                                 BIGNUM *e,
599                                                                 BN_GENCB *cb);
600 OSSL_DEPRECATEDIN_3_0
601 int RSA_meth_set_multi_prime_keygen(RSA_METHOD *meth,
602                                     int (*keygen) (RSA *rsa, int bits,
603                                                    int primes, BIGNUM *e,
604                                                    BN_GENCB *cb));
605 #endif  /* !OPENSSL_NO_DEPRECATED_3_0 */
606
607 #  ifdef  __cplusplus
608 }
609 #  endif
610 # endif
611 #endif