]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/rsa.h
PROV SERIALIZER: add common functionality to serialize keys
[thirdparty/openssl.git] / include / openssl / rsa.h
CommitLineData
21dcbebc 1/*
6738bf14 2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
d02b48c6 3 *
48f4ad77 4 * Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc
RS
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
d02b48c6
RE
8 */
9
ae4186b0
DMSP
10#ifndef OPENSSL_RSA_H
11# define OPENSSL_RSA_H
d86167ec
DMSP
12# pragma once
13
14# include <openssl/macros.h>
936c2b9e 15# ifndef OPENSSL_NO_DEPRECATED_3_0
d86167ec
DMSP
16# define HEADER_RSA_H
17# endif
d02b48c6 18
98186eb4 19# include <openssl/opensslconf.h>
78d3b819 20
3c27208f
RS
21# ifndef OPENSSL_NO_RSA
22# include <openssl/asn1.h>
a00ae6c4 23# include <openssl/bio.h>
0f113f3e 24# include <openssl/crypto.h>
50cd4768 25# include <openssl/types.h>
00db8c60 26# ifndef OPENSSL_NO_DEPRECATED_1_1_0
0f113f3e
MC
27# include <openssl/bn.h>
28# endif
52df25cf 29# include <openssl/rsaerr.h>
c3a4fa4c
RL
30# include <openssl/safestack.h>
31
3c27208f 32# ifdef __cplusplus
82271cee 33extern "C" {
3c27208f 34# endif
03f8b042 35
b72c9121 36/* The types RSA and RSA_METHOD are defined in ossl_typ.h */
0f113f3e 37
0f113f3e
MC
38# ifndef OPENSSL_RSA_MAX_MODULUS_BITS
39# define OPENSSL_RSA_MAX_MODULUS_BITS 16384
40# endif
41
42# define OPENSSL_RSA_FIPS_MIN_MODULUS_BITS 1024
43
44# ifndef OPENSSL_RSA_SMALL_MODULUS_BITS
45# define OPENSSL_RSA_SMALL_MODULUS_BITS 3072
46# endif
47# ifndef OPENSSL_RSA_MAX_PUBEXP_BITS
dbd87ffc
MC
48
49/* exponent limit enforced for "large" modulus only */
0f113f3e
MC
50# define OPENSSL_RSA_MAX_PUBEXP_BITS 64
51# endif
5e3225cc 52
0f113f3e
MC
53# define RSA_3 0x3L
54# define RSA_F4 0x10001L
d02b48c6 55
665d899f
PY
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
0f113f3e
MC
62# define RSA_METHOD_FLAG_NO_CHECK 0x0001/* don't check pub/private
63 * match */
dfeab068 64
0f113f3e
MC
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
770d19b8 71 * and that they do not depend on the private key components being present:
0f113f3e
MC
72 * for example a key stored in external hardware. Without this flag
73 * bn_mod_exp gets called when private key components are absent.
770d19b8 74 */
0f113f3e 75# define RSA_FLAG_EXT_PKEY 0x0020
58964a49 76
dbd87ffc
MC
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 */
0f113f3e 83# define RSA_FLAG_NO_BLINDING 0x0080
00db8c60 84# ifndef OPENSSL_NO_DEPRECATED_1_1_0
dbd87ffc 85/*
5584f65a 86 * Does nothing. Previously this switched off constant time behaviour.
0f113f3e 87 */
5584f65a
MC
88# define RSA_FLAG_NO_CONSTTIME 0x0000
89# endif
00db8c60 90# ifndef OPENSSL_NO_DEPRECATED_0_9_8
dbd87ffc
MC
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 */
0f113f3e
MC
100# define RSA_FLAG_NO_EXP_CONSTTIME RSA_FLAG_NO_CONSTTIME
101# endif
102
89abd1b6
MC
103int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad_mode);
104int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx, int *pad_mode);
0f113f3e
MC
105
106# define EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, len) \
e5e04ee3
DSH
107 RSA_pkey_ctx_ctrl(ctx, (EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY), \
108 EVP_PKEY_CTRL_RSA_PSS_SALTLEN, len, NULL)
137096a7
DSH
109/* Salt length matches digest */
110# define RSA_PSS_SALTLEN_DIGEST -1
111/* Verify only: auto detect salt length */
112# define RSA_PSS_SALTLEN_AUTO -2
113/* Set salt length to maximum possible */
114# define RSA_PSS_SALTLEN_MAX -3
115/* Old compatible max salt length for sign only */
116# define RSA_PSS_SALTLEN_MAX_SIGN -2
0f113f3e 117
e64b2b5c
DSH
118# define EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen(ctx, len) \
119 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN, \
120 EVP_PKEY_CTRL_RSA_PSS_SALTLEN, len, NULL)
121
0f113f3e 122# define EVP_PKEY_CTX_get_rsa_pss_saltlen(ctx, plen) \
e5e04ee3
DSH
123 RSA_pkey_ctx_ctrl(ctx, (EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY), \
124 EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN, 0, plen)
0f113f3e
MC
125
126# define EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, bits) \
e5e04ee3
DSH
127 RSA_pkey_ctx_ctrl(ctx, EVP_PKEY_OP_KEYGEN, \
128 EVP_PKEY_CTRL_RSA_KEYGEN_BITS, bits, NULL)
0f113f3e
MC
129
130# define EVP_PKEY_CTX_set_rsa_keygen_pubexp(ctx, pubexp) \
e5e04ee3
DSH
131 RSA_pkey_ctx_ctrl(ctx, EVP_PKEY_OP_KEYGEN, \
132 EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, 0, pubexp)
0f113f3e 133
665d899f
PY
134# define EVP_PKEY_CTX_set_rsa_keygen_primes(ctx, primes) \
135 RSA_pkey_ctx_ctrl(ctx, EVP_PKEY_OP_KEYGEN, \
136 EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES, primes, NULL)
137
89abd1b6
MC
138int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
139int EVP_PKEY_CTX_set_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
140 const char *mdprops);
141int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
142int EVP_PKEY_CTX_get_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, char *name,
143 size_t namelen);
144
0f113f3e 145
37659ea4 146# define EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md(ctx, md) \
e64b2b5c 147 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN, \
37659ea4 148 EVP_PKEY_CTRL_RSA_MGF1_MD, 0, (void *)(md))
e64b2b5c 149
89abd1b6
MC
150int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
151int EVP_PKEY_CTX_set_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
152 const char *mdprops);
153int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
154int EVP_PKEY_CTX_get_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, char *name,
155 size_t namelen);
156int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx, void *label,
157 int llen);
158int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char **label);
0f113f3e 159
ccd0aeac 160# define EVP_PKEY_CTX_set_rsa_pss_keygen_md(ctx, md) \
37659ea4 161 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA_PSS, \
990fe909 162 EVP_PKEY_OP_KEYGEN, EVP_PKEY_CTRL_MD, \
37659ea4 163 0, (void *)(md))
e64b2b5c 164
89abd1b6 165
0f113f3e
MC
166# define EVP_PKEY_CTRL_RSA_PADDING (EVP_PKEY_ALG_CTRL + 1)
167# define EVP_PKEY_CTRL_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 2)
168
169# define EVP_PKEY_CTRL_RSA_KEYGEN_BITS (EVP_PKEY_ALG_CTRL + 3)
170# define EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP (EVP_PKEY_ALG_CTRL + 4)
171# define EVP_PKEY_CTRL_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 5)
172
173# define EVP_PKEY_CTRL_GET_RSA_PADDING (EVP_PKEY_ALG_CTRL + 6)
174# define EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 7)
175# define EVP_PKEY_CTRL_GET_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 8)
176
177# define EVP_PKEY_CTRL_RSA_OAEP_MD (EVP_PKEY_ALG_CTRL + 9)
178# define EVP_PKEY_CTRL_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 10)
179
180# define EVP_PKEY_CTRL_GET_RSA_OAEP_MD (EVP_PKEY_ALG_CTRL + 11)
181# define EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 12)
182
665d899f
PY
183# define EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES (EVP_PKEY_ALG_CTRL + 13)
184
0f113f3e
MC
185# define RSA_PKCS1_PADDING 1
186# define RSA_SSLV23_PADDING 2
187# define RSA_NO_PADDING 3
188# define RSA_PKCS1_OAEP_PADDING 4
189# define RSA_X931_PADDING 5
29db322e 190/* EVP_PKEY_ only */
0f113f3e 191# define RSA_PKCS1_PSS_PADDING 6
58964a49 192
0f113f3e 193# define RSA_PKCS1_PADDING_SIZE 11
ba8ad074 194
0f113f3e
MC
195# define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
196# define RSA_get_app_data(s) RSA_get_ex_data(s,0)
d02b48c6 197
0f113f3e
MC
198RSA *RSA_new(void);
199RSA *RSA_new_method(ENGINE *engine);
26c79d56 200int RSA_bits(const RSA *rsa);
0f113f3e
MC
201int RSA_size(const RSA *rsa);
202int RSA_security_bits(const RSA *rsa);
e9224c71 203
9862e9aa
RL
204int RSA_set0_key(RSA *r, BIGNUM *n, BIGNUM *e, BIGNUM *d);
205int RSA_set0_factors(RSA *r, BIGNUM *p, BIGNUM *q);
206int RSA_set0_crt_params(RSA *r,BIGNUM *dmp1, BIGNUM *dmq1, BIGNUM *iqmp);
665d899f
PY
207int RSA_set0_multi_prime_params(RSA *r, BIGNUM *primes[], BIGNUM *exps[],
208 BIGNUM *coeffs[], int pnum);
fd809cfd
RL
209void RSA_get0_key(const RSA *r,
210 const BIGNUM **n, const BIGNUM **e, const BIGNUM **d);
211void RSA_get0_factors(const RSA *r, const BIGNUM **p, const BIGNUM **q);
665d899f
PY
212int RSA_get_multi_prime_extra_count(const RSA *r);
213int RSA_get0_multi_prime_factors(const RSA *r, const BIGNUM *primes[]);
9862e9aa 214void RSA_get0_crt_params(const RSA *r,
fd809cfd
RL
215 const BIGNUM **dmp1, const BIGNUM **dmq1,
216 const BIGNUM **iqmp);
665d899f
PY
217int RSA_get0_multi_prime_crt_params(const RSA *r, const BIGNUM *exps[],
218 const BIGNUM *coeffs[]);
6692ff77
DMSP
219const BIGNUM *RSA_get0_n(const RSA *d);
220const BIGNUM *RSA_get0_e(const RSA *d);
221const BIGNUM *RSA_get0_d(const RSA *d);
222const BIGNUM *RSA_get0_p(const RSA *d);
223const BIGNUM *RSA_get0_q(const RSA *d);
224const BIGNUM *RSA_get0_dmp1(const RSA *r);
225const BIGNUM *RSA_get0_dmq1(const RSA *r);
226const BIGNUM *RSA_get0_iqmp(const RSA *r);
9862e9aa
RL
227void RSA_clear_flags(RSA *r, int flags);
228int RSA_test_flags(const RSA *r, int flags);
229void RSA_set_flags(RSA *r, int flags);
665d899f 230int RSA_get_version(RSA *r);
e0685d24 231ENGINE *RSA_get0_engine(const RSA *r);
9862e9aa 232
e9224c71 233/* Deprecated version */
98186eb4
VD
234DEPRECATEDIN_0_9_8(RSA *RSA_generate_key(int bits, unsigned long e, void
235 (*callback) (int, int, void *),
236 void *cb_arg))
e9224c71
GT
237
238/* New version */
0f113f3e 239int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
665d899f
PY
240/* Multi-prime version */
241int RSA_generate_multi_prime_key(RSA *rsa, int bits, int primes,
242 BIGNUM *e, BN_GENCB *cb);
0f113f3e
MC
243
244int RSA_X931_derive_ex(RSA *rsa, BIGNUM *p1, BIGNUM *p2, BIGNUM *q1,
245 BIGNUM *q2, const BIGNUM *Xp1, const BIGNUM *Xp2,
246 const BIGNUM *Xp, const BIGNUM *Xq1, const BIGNUM *Xq2,
247 const BIGNUM *Xq, const BIGNUM *e, BN_GENCB *cb);
248int RSA_X931_generate_key_ex(RSA *rsa, int bits, const BIGNUM *e,
249 BN_GENCB *cb);
250
251int RSA_check_key(const RSA *);
252int RSA_check_key_ex(const RSA *, BN_GENCB *cb);
253 /* next 4 return -1 on error */
254int RSA_public_encrypt(int flen, const unsigned char *from,
255 unsigned char *to, RSA *rsa, int padding);
256int RSA_private_encrypt(int flen, const unsigned char *from,
257 unsigned char *to, RSA *rsa, int padding);
258int RSA_public_decrypt(int flen, const unsigned char *from,
259 unsigned char *to, RSA *rsa, int padding);
260int RSA_private_decrypt(int flen, const unsigned char *from,
261 unsigned char *to, RSA *rsa, int padding);
262void RSA_free(RSA *r);
5cbc2e8b 263/* "up" the RSA object's reference count */
0f113f3e 264int RSA_up_ref(RSA *r);
d02b48c6 265
0f113f3e 266int RSA_flags(const RSA *r);
58964a49 267
cb78486d
GT
268void RSA_set_default_method(const RSA_METHOD *meth);
269const RSA_METHOD *RSA_get_default_method(void);
076fc555 270const RSA_METHOD *RSA_null_method(void);
29c1f061 271const RSA_METHOD *RSA_get_method(const RSA *rsa);
cb78486d 272int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
d02b48c6 273
b0700d2c
RS
274/* these are the actual RSA functions */
275const RSA_METHOD *RSA_PKCS1_OpenSSL(void);
d02b48c6 276
e5e04ee3
DSH
277int RSA_pkey_ctx_ctrl(EVP_PKEY_CTX *ctx, int optype, int cmd, int p1, void *p2);
278
9fdcc21f
DO
279DECLARE_ASN1_ENCODE_FUNCTIONS_name(RSA, RSAPublicKey)
280DECLARE_ASN1_ENCODE_FUNCTIONS_name(RSA, RSAPrivateKey)
78d3b819 281
0f113f3e
MC
282typedef struct rsa_pss_params_st {
283 X509_ALGOR *hashAlgorithm;
284 X509_ALGOR *maskGenAlgorithm;
285 ASN1_INTEGER *saltLength;
286 ASN1_INTEGER *trailerField;
6745a1ff
DSH
287 /* Decoded hash algorithm from maskGenAlgorithm */
288 X509_ALGOR *maskHash;
0f113f3e 289} RSA_PSS_PARAMS;
ff04bbe3 290
63b825c9 291DECLARE_ASN1_FUNCTIONS(RSA_PSS_PARAMS)
ff04bbe3 292
0f113f3e
MC
293typedef struct rsa_oaep_params_st {
294 X509_ALGOR *hashFunc;
295 X509_ALGOR *maskGenFunc;
296 X509_ALGOR *pSourceFunc;
6745a1ff
DSH
297 /* Decoded hash algorithm from maskGenFunc */
298 X509_ALGOR *maskHash;
0f113f3e 299} RSA_OAEP_PARAMS;
0574cadf
DSH
300
301DECLARE_ASN1_FUNCTIONS(RSA_OAEP_PARAMS)
302
0f113f3e
MC
303# ifndef OPENSSL_NO_STDIO
304int RSA_print_fp(FILE *fp, const RSA *r, int offset);
305# endif
d02b48c6 306
0f113f3e 307int RSA_print(BIO *bp, const RSA *r, int offset);
d02b48c6 308
0f113f3e
MC
309/*
310 * The following 2 functions sign and verify a X509_SIG ASN1 object inside
311 * PKCS#1 padded RSA encryption
312 */
3e83e686 313int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
0f113f3e 314 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
3e83e686 315int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
0f113f3e 316 const unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
d02b48c6 317
0f113f3e
MC
318/*
319 * The following 2 function sign and verify a ASN1_OCTET_STRING object inside
320 * PKCS#1 padded RSA encryption
321 */
29c1f061 322int RSA_sign_ASN1_OCTET_STRING(int type,
0f113f3e
MC
323 const unsigned char *m, unsigned int m_length,
324 unsigned char *sigret, unsigned int *siglen,
325 RSA *rsa);
326int RSA_verify_ASN1_OCTET_STRING(int type, const unsigned char *m,
327 unsigned int m_length, unsigned char *sigbuf,
328 unsigned int siglen, RSA *rsa);
d02b48c6 329
58964a49
RE
330int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
331void RSA_blinding_off(RSA *rsa);
800e400d 332BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);
58964a49 333
0f113f3e
MC
334int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
335 const unsigned char *f, int fl);
336int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
337 const unsigned char *f, int fl,
338 int rsa_len);
339int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
340 const unsigned char *f, int fl);
341int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
342 const unsigned char *f, int fl,
343 int rsa_len);
344int PKCS1_MGF1(unsigned char *mask, long len, const unsigned char *seed,
345 long seedlen, const EVP_MD *dgst);
346int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
347 const unsigned char *f, int fl,
348 const unsigned char *p, int pl);
349int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
350 const unsigned char *f, int fl, int rsa_len,
351 const unsigned char *p, int pl);
271fef0e 352int RSA_padding_add_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
0f113f3e
MC
353 const unsigned char *from, int flen,
354 const unsigned char *param, int plen,
355 const EVP_MD *md, const EVP_MD *mgf1md);
271fef0e 356int RSA_padding_check_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
0f113f3e
MC
357 const unsigned char *from, int flen,
358 int num, const unsigned char *param,
359 int plen, const EVP_MD *md,
360 const EVP_MD *mgf1md);
361int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
362 const unsigned char *f, int fl);
363int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
364 const unsigned char *f, int fl, int rsa_len);
365int RSA_padding_add_none(unsigned char *to, int tlen, const unsigned char *f,
366 int fl);
367int RSA_padding_check_none(unsigned char *to, int tlen,
368 const unsigned char *f, int fl, int rsa_len);
369int RSA_padding_add_X931(unsigned char *to, int tlen, const unsigned char *f,
370 int fl);
371int RSA_padding_check_X931(unsigned char *to, int tlen,
372 const unsigned char *f, int fl, int rsa_len);
499fca2d 373int RSA_X931_hash_id(int nid);
58964a49 374
c7aaf391 375int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash,
0f113f3e
MC
376 const EVP_MD *Hash, const unsigned char *EM,
377 int sLen);
c7aaf391 378int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM,
0f113f3e
MC
379 const unsigned char *mHash, const EVP_MD *Hash,
380 int sLen);
c7aaf391 381
c553721e 382int RSA_verify_PKCS1_PSS_mgf1(RSA *rsa, const unsigned char *mHash,
0f113f3e
MC
383 const EVP_MD *Hash, const EVP_MD *mgf1Hash,
384 const unsigned char *EM, int sLen);
c553721e
DSH
385
386int RSA_padding_add_PKCS1_PSS_mgf1(RSA *rsa, unsigned char *EM,
0f113f3e
MC
387 const unsigned char *mHash,
388 const EVP_MD *Hash, const EVP_MD *mgf1Hash,
389 int sLen);
c553721e 390
e6390aca
RS
391#define RSA_get_ex_new_index(l, p, newf, dupf, freef) \
392 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_RSA, l, p, newf, dupf, freef)
0f113f3e 393int RSA_set_ex_data(RSA *r, int idx, void *arg);
29c1f061 394void *RSA_get_ex_data(const RSA *r, int idx);
58964a49 395
9fdcc21f
DO
396DECLARE_ASN1_DUP_FUNCTION_name(RSA, RSAPublicKey)
397DECLARE_ASN1_DUP_FUNCTION_name(RSA, RSAPrivateKey)
40889b9c 398
0f113f3e
MC
399/*
400 * If this flag is set the RSA method is FIPS compliant and can be used in
401 * FIPS mode. This is set in the validated module method. If an application
402 * sets this flag in its own methods it is its responsibility to ensure the
403 * result is compliant.
c553721e
DSH
404 */
405
0f113f3e 406# define RSA_FLAG_FIPS_METHOD 0x0400
c553721e 407
0f113f3e
MC
408/*
409 * If this flag is set the operations normally disabled in FIPS mode are
c553721e
DSH
410 * permitted it is then the applications responsibility to ensure that the
411 * usage is compliant.
412 */
413
0f113f3e
MC
414# define RSA_FLAG_NON_FIPS_ALLOW 0x0400
415/*
416 * Application has decided PRNG is good enough to generate a key: don't
cac4fb58
DSH
417 * check.
418 */
0f113f3e 419# define RSA_FLAG_CHECKED 0x0800
c553721e 420
b72c9121
RL
421RSA_METHOD *RSA_meth_new(const char *name, int flags);
422void RSA_meth_free(RSA_METHOD *meth);
423RSA_METHOD *RSA_meth_dup(const RSA_METHOD *meth);
424const char *RSA_meth_get0_name(const RSA_METHOD *meth);
425int RSA_meth_set1_name(RSA_METHOD *meth, const char *name);
693be9a2 426int RSA_meth_get_flags(const RSA_METHOD *meth);
b72c9121
RL
427int RSA_meth_set_flags(RSA_METHOD *meth, int flags);
428void *RSA_meth_get0_app_data(const RSA_METHOD *meth);
429int RSA_meth_set0_app_data(RSA_METHOD *meth, void *app_data);
430int (*RSA_meth_get_pub_enc(const RSA_METHOD *meth))
431 (int flen, const unsigned char *from,
432 unsigned char *to, RSA *rsa, int padding);
433int RSA_meth_set_pub_enc(RSA_METHOD *rsa,
434 int (*pub_enc) (int flen, const unsigned char *from,
435 unsigned char *to, RSA *rsa,
436 int padding));
437int (*RSA_meth_get_pub_dec(const RSA_METHOD *meth))
438 (int flen, const unsigned char *from,
439 unsigned char *to, RSA *rsa, int padding);
440int RSA_meth_set_pub_dec(RSA_METHOD *rsa,
441 int (*pub_dec) (int flen, const unsigned char *from,
442 unsigned char *to, RSA *rsa,
443 int padding));
444int (*RSA_meth_get_priv_enc(const RSA_METHOD *meth))
445 (int flen, const unsigned char *from,
446 unsigned char *to, RSA *rsa, int padding);
447int RSA_meth_set_priv_enc(RSA_METHOD *rsa,
448 int (*priv_enc) (int flen, const unsigned char *from,
449 unsigned char *to, RSA *rsa,
450 int padding));
451int (*RSA_meth_get_priv_dec(const RSA_METHOD *meth))
452 (int flen, const unsigned char *from,
453 unsigned char *to, RSA *rsa, int padding);
454int RSA_meth_set_priv_dec(RSA_METHOD *rsa,
455 int (*priv_dec) (int flen, const unsigned char *from,
456 unsigned char *to, RSA *rsa,
457 int padding));
458int (*RSA_meth_get_mod_exp(const RSA_METHOD *meth))
972f6788 459 (BIGNUM *r0, const BIGNUM *i, RSA *rsa, BN_CTX *ctx);
b72c9121 460int RSA_meth_set_mod_exp(RSA_METHOD *rsa,
972f6788 461 int (*mod_exp) (BIGNUM *r0, const BIGNUM *i, RSA *rsa,
b72c9121
RL
462 BN_CTX *ctx));
463int (*RSA_meth_get_bn_mod_exp(const RSA_METHOD *meth))
464 (BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
465 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
466int RSA_meth_set_bn_mod_exp(RSA_METHOD *rsa,
467 int (*bn_mod_exp) (BIGNUM *r,
468 const BIGNUM *a,
469 const BIGNUM *p,
470 const BIGNUM *m,
471 BN_CTX *ctx,
472 BN_MONT_CTX *m_ctx));
473int (*RSA_meth_get_init(const RSA_METHOD *meth)) (RSA *rsa);
474int RSA_meth_set_init(RSA_METHOD *rsa, int (*init) (RSA *rsa));
475int (*RSA_meth_get_finish(const RSA_METHOD *meth)) (RSA *rsa);
476int RSA_meth_set_finish(RSA_METHOD *rsa, int (*finish) (RSA *rsa));
477int (*RSA_meth_get_sign(const RSA_METHOD *meth))
478 (int type,
479 const unsigned char *m, unsigned int m_length,
480 unsigned char *sigret, unsigned int *siglen,
481 const RSA *rsa);
482int RSA_meth_set_sign(RSA_METHOD *rsa,
483 int (*sign) (int type, const unsigned char *m,
484 unsigned int m_length,
485 unsigned char *sigret, unsigned int *siglen,
486 const RSA *rsa));
487int (*RSA_meth_get_verify(const RSA_METHOD *meth))
488 (int dtype, const unsigned char *m,
489 unsigned int m_length, const unsigned char *sigbuf,
490 unsigned int siglen, const RSA *rsa);
491int RSA_meth_set_verify(RSA_METHOD *rsa,
492 int (*verify) (int dtype, const unsigned char *m,
493 unsigned int m_length,
494 const unsigned char *sigbuf,
495 unsigned int siglen, const RSA *rsa));
496int (*RSA_meth_get_keygen(const RSA_METHOD *meth))
497 (RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
498int RSA_meth_set_keygen(RSA_METHOD *rsa,
499 int (*keygen) (RSA *rsa, int bits, BIGNUM *e,
500 BN_GENCB *cb));
665d899f
PY
501int (*RSA_meth_get_multi_prime_keygen(const RSA_METHOD *meth))
502 (RSA *rsa, int bits, int primes, BIGNUM *e, BN_GENCB *cb);
503int RSA_meth_set_multi_prime_keygen(RSA_METHOD *meth,
504 int (*keygen) (RSA *rsa, int bits,
505 int primes, BIGNUM *e,
506 BN_GENCB *cb));
6d311938 507
0cd0a820 508# ifdef __cplusplus
d02b48c6 509}
0cd0a820 510# endif
3c27208f 511# endif
d02b48c6 512#endif