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