[thirdparty/openssl.git] / crypto / rsa / rsa.h

/* crypto/rsa/rsa.h */
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 * 
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 * 
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from 
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 * 
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * 
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

#ifndef HEADER_RSA_H
#define HEADER_RSA_H

#include <openssl/asn1.h>

#ifndef OPENSSL_NO_BIO
#include <openssl/bio.h>
#endif
#include <openssl/crypto.h>
#include <openssl/ossl_typ.h>
#ifndef OPENSSL_NO_DEPRECATED
#include <openssl/bn.h>
#endif

#ifdef OPENSSL_NO_RSA
#error RSA is disabled.
#endif

#ifdef  __cplusplus
extern "C" {
#endif

/* Declared already in ossl_typ.h */
/* typedef struct rsa_st RSA; */
/* typedef struct rsa_meth_st RSA_METHOD; */

struct rsa_meth_st
	{
	const char *name;
	int (*rsa_pub_enc)(int flen,const unsigned char *from,
			   unsigned char *to,
			   RSA *rsa,int padding);
	int (*rsa_pub_dec)(int flen,const unsigned char *from,
			   unsigned char *to,
			   RSA *rsa,int padding);
	int (*rsa_priv_enc)(int flen,const unsigned char *from,
			    unsigned char *to,
			    RSA *rsa,int padding);
	int (*rsa_priv_dec)(int flen,const unsigned char *from,
			    unsigned char *to,
			    RSA *rsa,int padding);
	int (*rsa_mod_exp)(BIGNUM *r0,const BIGNUM *I,RSA *rsa,BN_CTX *ctx); /* Can be null */
	int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
			  const BIGNUM *m, BN_CTX *ctx,
			  BN_MONT_CTX *m_ctx); /* Can be null */
	int (*init)(RSA *rsa);		/* called at new */
	int (*finish)(RSA *rsa);	/* called at free */
	int flags;			/* RSA_METHOD_FLAG_* things */
	char *app_data;			/* may be needed! */
/* New sign and verify functions: some libraries don't allow arbitrary data
 * to be signed/verified: this allows them to be used. Note: for this to work
 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used
 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards
 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
 * option is set in 'flags'.
 */
	int (*rsa_sign)(int type,
		const unsigned char *m, unsigned int m_length,
		unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
	int (*rsa_verify)(int dtype,
		const unsigned char *m, unsigned int m_length,
		unsigned char *sigbuf, unsigned int siglen, const RSA *rsa);
/* If this callback is NULL, the builtin software RSA key-gen will be used. This
 * is for behavioural compatibility whilst the code gets rewired, but one day
 * it would be nice to assume there are no such things as "builtin software"
 * implementations. */
	int (*rsa_keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
	};

struct rsa_st
	{
	/* The first parameter is used to pickup errors where
	 * this is passed instead of aEVP_PKEY, it is set to 0 */
	int pad;
	long version;
	const RSA_METHOD *meth;
	/* functional reference if 'meth' is ENGINE-provided */
	ENGINE *engine;
	BIGNUM *n;
	BIGNUM *e;
	BIGNUM *d;
	BIGNUM *p;
	BIGNUM *q;
	BIGNUM *dmp1;
	BIGNUM *dmq1;
	BIGNUM *iqmp;
	/* be careful using this if the RSA structure is shared */
	CRYPTO_EX_DATA ex_data;
	int references;
	int flags;

	/* Used to cache montgomery values */
	BN_MONT_CTX *_method_mod_n;
	BN_MONT_CTX *_method_mod_p;
	BN_MONT_CTX *_method_mod_q;

	/* all BIGNUM values are actually in the following data, if it is not
	 * NULL */
	char *bignum_data;
	BN_BLINDING *blinding;
	BN_BLINDING *mt_blinding;
	};

#define RSA_3	0x3L
#define RSA_F4	0x10001L

#define RSA_METHOD_FLAG_NO_CHECK	0x0001 /* don't check pub/private match */

#define RSA_FLAG_CACHE_PUBLIC		0x0002
#define RSA_FLAG_CACHE_PRIVATE		0x0004
#define RSA_FLAG_BLINDING		0x0008
#define RSA_FLAG_THREAD_SAFE		0x0010
/* This flag means the private key operations will be handled by rsa_mod_exp
 * and that they do not depend on the private key components being present:
 * for example a key stored in external hardware. Without this flag bn_mod_exp
 * gets called when private key components are absent.
 */
#define RSA_FLAG_EXT_PKEY		0x0020

/* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
 */
#define RSA_FLAG_SIGN_VER		0x0040

#define RSA_FLAG_NO_BLINDING		0x0080 /* new with 0.9.6j and 0.9.7b; the built-in
                                                * RSA implementation now uses blinding by
                                                * default (ignoring RSA_FLAG_BLINDING),
                                                * but other engines might not need it
                                                */
#define RSA_FLAG_NO_EXP_CONSTTIME	0x0100 /* new with 0.9.7h; the built-in RSA
                                                * implementation now uses constant time
                                                * modular exponentiation for secret exponents
                                                * by default. This flag causes the
                                                * faster variable sliding window method to
                                                * be used for all exponents.
                                                */

#define RSA_PKCS1_PADDING	1
#define RSA_SSLV23_PADDING	2
#define RSA_NO_PADDING		3
#define RSA_PKCS1_OAEP_PADDING	4
#define RSA_X931_PADDING	5

#define RSA_PKCS1_PADDING_SIZE	11

#define RSA_set_app_data(s,arg)         RSA_set_ex_data(s,0,arg)
#define RSA_get_app_data(s)             RSA_get_ex_data(s,0)

RSA *	RSA_new(void);
RSA *	RSA_new_method(ENGINE *engine);
int	RSA_size(const RSA *);

/* Deprecated version */
#ifndef OPENSSL_NO_DEPRECATED
RSA *	RSA_generate_key(int bits, unsigned long e,void
		(*callback)(int,int,void *),void *cb_arg);
#endif /* !defined(OPENSSL_NO_DEPRECATED) */

/* New version */
int	RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);

int	RSA_check_key(const RSA *);
	/* next 4 return -1 on error */
int	RSA_public_encrypt(int flen, const unsigned char *from,
		unsigned char *to, RSA *rsa,int padding);
int	RSA_private_encrypt(int flen, const unsigned char *from,
		unsigned char *to, RSA *rsa,int padding);
int	RSA_public_decrypt(int flen, const unsigned char *from, 
		unsigned char *to, RSA *rsa,int padding);
int	RSA_private_decrypt(int flen, const unsigned char *from, 
		unsigned char *to, RSA *rsa,int padding);
void	RSA_free (RSA *r);
/* "up" the RSA object's reference count */
int	RSA_up_ref(RSA *r);

int	RSA_flags(const RSA *r);

void RSA_set_default_method(const RSA_METHOD *meth);
const RSA_METHOD *RSA_get_default_method(void);
const RSA_METHOD *RSA_get_method(const RSA *rsa);
int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);

/* This function needs the memory locking malloc callbacks to be installed */
int RSA_memory_lock(RSA *r);

/* these are the actual SSLeay RSA functions */
const RSA_METHOD *RSA_PKCS1_SSLeay(void);

const RSA_METHOD *RSA_null_method(void);

DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)

#ifndef OPENSSL_NO_FP_API
int	RSA_print_fp(FILE *fp, const RSA *r,int offset);
#endif

#ifndef OPENSSL_NO_BIO
int	RSA_print(BIO *bp, const RSA *r,int offset);
#endif

int i2d_RSA_NET(const RSA *a, unsigned char **pp,
		int (*cb)(char *buf, int len, const char *prompt, int verify),
		int sgckey);
RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length,
		 int (*cb)(char *buf, int len, const char *prompt, int verify),
		 int sgckey);

int i2d_Netscape_RSA(const RSA *a, unsigned char **pp,
		     int (*cb)(char *buf, int len, const char *prompt,
			       int verify));
RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length,
		      int (*cb)(char *buf, int len, const char *prompt,
				int verify));

/* The following 2 functions sign and verify a X509_SIG ASN1 object
 * inside PKCS#1 padded RSA encryption */
int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
	unsigned char *sigret, unsigned int *siglen, RSA *rsa);
int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
	unsigned char *sigbuf, unsigned int siglen, RSA *rsa);

/* The following 2 function sign and verify a ASN1_OCTET_STRING
 * object inside PKCS#1 padded RSA encryption */
int RSA_sign_ASN1_OCTET_STRING(int type,
	const unsigned char *m, unsigned int m_length,
	unsigned char *sigret, unsigned int *siglen, RSA *rsa);
int RSA_verify_ASN1_OCTET_STRING(int type,
	const unsigned char *m, unsigned int m_length,
	unsigned char *sigbuf, unsigned int siglen, RSA *rsa);

int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
void RSA_blinding_off(RSA *rsa);
BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);

int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
	const unsigned char *f,int fl);
int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
	const unsigned char *f,int fl,int rsa_len);
int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
	const unsigned char *f,int fl);
int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
	const unsigned char *f,int fl,int rsa_len);
int PKCS1_MGF1(unsigned char *mask, long len,
	const unsigned char *seed, long seedlen, const EVP_MD *dgst);
int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
	const unsigned char *f,int fl,
	const unsigned char *p,int pl);
int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
	const unsigned char *f,int fl,int rsa_len,
	const unsigned char *p,int pl);
int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
	const unsigned char *f,int fl);
int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
	const unsigned char *f,int fl,int rsa_len);
int RSA_padding_add_none(unsigned char *to,int tlen,
	const unsigned char *f,int fl);
int RSA_padding_check_none(unsigned char *to,int tlen,
	const unsigned char *f,int fl,int rsa_len);
int RSA_padding_add_X931(unsigned char *to,int tlen,
	const unsigned char *f,int fl);
int RSA_padding_check_X931(unsigned char *to,int tlen,
	const unsigned char *f,int fl,int rsa_len);
int RSA_X931_hash_id(int nid);

int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash,
			const EVP_MD *Hash, const unsigned char *EM, int sLen);
int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM,
			const unsigned char *mHash,
			const EVP_MD *Hash, int sLen);

int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
	CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
int RSA_set_ex_data(RSA *r,int idx,void *arg);
void *RSA_get_ex_data(const RSA *r, int idx);

RSA *RSAPublicKey_dup(RSA *rsa);
RSA *RSAPrivateKey_dup(RSA *rsa);

/* BEGIN ERROR CODES */
/* The following lines are auto generated by the script mkerr.pl. Any changes
 * made after this point may be overwritten when the script is next run.
 */
void ERR_load_RSA_strings(void);

/* Error codes for the RSA functions. */

/* Function codes. */
#define RSA_F_MEMORY_LOCK				 100
#define RSA_F_RSA_BUILTIN_KEYGEN			 129
#define RSA_F_RSA_CHECK_KEY				 123
#define RSA_F_RSA_EAY_PRIVATE_DECRYPT			 101
#define RSA_F_RSA_EAY_PRIVATE_ENCRYPT			 102
#define RSA_F_RSA_EAY_PUBLIC_DECRYPT			 103
#define RSA_F_RSA_EAY_PUBLIC_ENCRYPT			 104
#define RSA_F_RSA_GENERATE_KEY				 105
#define RSA_F_RSA_MEMORY_LOCK				 130
#define RSA_F_RSA_NEW_METHOD				 106
#define RSA_F_RSA_NULL					 124
#define RSA_F_RSA_NULL_MOD_EXP				 131
#define RSA_F_RSA_NULL_PRIVATE_DECRYPT			 132
#define RSA_F_RSA_NULL_PRIVATE_ENCRYPT			 133
#define RSA_F_RSA_NULL_PUBLIC_DECRYPT			 134
#define RSA_F_RSA_NULL_PUBLIC_ENCRYPT			 135
#define RSA_F_RSA_PADDING_ADD_NONE			 107
#define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP		 121
#define RSA_F_RSA_PADDING_ADD_PKCS1_PSS			 125
#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1		 108
#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2		 109
#define RSA_F_RSA_PADDING_ADD_SSLV23			 110
#define RSA_F_RSA_PADDING_ADD_X931			 127
#define RSA_F_RSA_PADDING_CHECK_NONE			 111
#define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP		 122
#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1		 112
#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2		 113
#define RSA_F_RSA_PADDING_CHECK_SSLV23			 114
#define RSA_F_RSA_PADDING_CHECK_X931			 128
#define RSA_F_RSA_PRINT					 115
#define RSA_F_RSA_PRINT_FP				 116
#define RSA_F_RSA_PRIV_DECODE				 137
#define RSA_F_RSA_PRIV_ENCODE				 138
#define RSA_F_RSA_PUB_DECODE				 139
#define RSA_F_RSA_SETUP_BLINDING			 136
#define RSA_F_RSA_SIGN					 117
#define RSA_F_RSA_SIGN_ASN1_OCTET_STRING		 118
#define RSA_F_RSA_VERIFY				 119
#define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING		 120
#define RSA_F_RSA_VERIFY_PKCS1_PSS			 126

/* Reason codes. */
#define RSA_R_ALGORITHM_MISMATCH			 100
#define RSA_R_BAD_E_VALUE				 101
#define RSA_R_BAD_FIXED_HEADER_DECRYPT			 102
#define RSA_R_BAD_PAD_BYTE_COUNT			 103
#define RSA_R_BAD_SIGNATURE				 104
#define RSA_R_BLOCK_TYPE_IS_NOT_01			 106
#define RSA_R_BLOCK_TYPE_IS_NOT_02			 107
#define RSA_R_DATA_GREATER_THAN_MOD_LEN			 108
#define RSA_R_DATA_TOO_LARGE				 109
#define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE		 110
#define RSA_R_DATA_TOO_LARGE_FOR_MODULUS		 132
#define RSA_R_DATA_TOO_SMALL				 111
#define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE		 122
#define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY		 112
#define RSA_R_DMP1_NOT_CONGRUENT_TO_D			 124
#define RSA_R_DMQ1_NOT_CONGRUENT_TO_D			 125
#define RSA_R_D_E_NOT_CONGRUENT_TO_1			 123
#define RSA_R_FIRST_OCTET_INVALID			 133
#define RSA_R_INVALID_HEADER				 137
#define RSA_R_INVALID_MESSAGE_LENGTH			 131
#define RSA_R_INVALID_PADDING				 138
#define RSA_R_INVALID_TRAILER				 139
#define RSA_R_IQMP_NOT_INVERSE_OF_Q			 126
#define RSA_R_KEY_SIZE_TOO_SMALL			 120
#define RSA_R_LAST_OCTET_INVALID			 134
#define RSA_R_NO_PUBLIC_EXPONENT			 140
#define RSA_R_NULL_BEFORE_BLOCK_MISSING			 113
#define RSA_R_N_DOES_NOT_EQUAL_P_Q			 127
#define RSA_R_OAEP_DECODING_ERROR			 121
#define RSA_R_PADDING_CHECK_FAILED			 114
#define RSA_R_P_NOT_PRIME				 128
#define RSA_R_Q_NOT_PRIME				 129
#define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED		 130
#define RSA_R_SLEN_CHECK_FAILED				 136
#define RSA_R_SLEN_RECOVERY_FAILED			 135
#define RSA_R_SSLV3_ROLLBACK_ATTACK			 115
#define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
#define RSA_R_UNKNOWN_ALGORITHM_TYPE			 117
#define RSA_R_UNKNOWN_PADDING_TYPE			 118
#define RSA_R_WRONG_SIGNATURE_LENGTH			 119

#ifdef  __cplusplus
}
#endif
#endif
Commit	Line	Data
d02b48c6	1	/* crypto/rsa/rsa.h */
58964a49	2	/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6 RE	3	* All rights reserved.
	4	*
	5	* This package is an SSL implementation written
	6	* by Eric Young (eay@cryptsoft.com).
	7	* The implementation was written so as to conform with Netscapes SSL.
	8	*
	9	* This library is free for commercial and non-commercial use as long as
	10	* the following conditions are aheared to. The following conditions
	11	* apply to all code found in this distribution, be it the RC4, RSA,
	12	* lhash, DES, etc., code; not just the SSL code. The SSL documentation
	13	* included with this distribution is covered by the same copyright terms
	14	* except that the holder is Tim Hudson (tjh@cryptsoft.com).
	15	*
	16	* Copyright remains Eric Young's, and as such any Copyright notices in
	17	* the code are not to be removed.
	18	* If this package is used in a product, Eric Young should be given attribution
	19	* as the author of the parts of the library used.
	20	* This can be in the form of a textual message at program startup or
	21	* in documentation (online or textual) provided with the package.
	22	*
	23	* Redistribution and use in source and binary forms, with or without
	24	* modification, are permitted provided that the following conditions
	25	* are met:
	26	* 1. Redistributions of source code must retain the copyright
	27	* notice, this list of conditions and the following disclaimer.
	28	* 2. Redistributions in binary form must reproduce the above copyright
	29	* notice, this list of conditions and the following disclaimer in the
	30	* documentation and/or other materials provided with the distribution.
	31	* 3. All advertising materials mentioning features or use of this software
	32	* must display the following acknowledgement:
	33	* "This product includes cryptographic software written by
	34	* Eric Young (eay@cryptsoft.com)"
	35	* The word 'cryptographic' can be left out if the rouines from the library
	36	* being used are not cryptographic related :-).
	37	* 4. If you include any Windows specific code (or a derivative thereof) from
	38	* the apps directory (application code) you must include an acknowledgement:
	39	* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
	40	*
	41	* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
	42	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	43	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	44	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	45	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	46	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	47	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	48	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	49	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	50	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	51	* SUCH DAMAGE.
	52	*
	53	* The licence and distribution terms for any publically available version or
	54	* derivative of this code cannot be changed. i.e. this code cannot simply be
	55	* copied and put under another distribution licence
	56	* [including the GNU Public Licence.]
	57	*/
	58
	59	#ifndef HEADER_RSA_H
	60	#define HEADER_RSA_H
	61
78d3b819 DSH	62	#include <openssl/asn1.h>
78d3b819 DSH	63
cf1b7d96	64	#ifndef OPENSSL_NO_BIO
ef33b970 RL	65	#include <openssl/bio.h>
ef33b970 RL	66	#endif
ec577822	67	#include <openssl/crypto.h>
2aa9043a	68	#include <openssl/ossl_typ.h>
0f814687 GT	69	#ifndef OPENSSL_NO_DEPRECATED
	70	#include <openssl/bn.h>
	71	#endif
d02b48c6	72
cf1b7d96	73	#ifdef OPENSSL_NO_RSA
f5d7a031 UM	74	#error RSA is disabled.
	75	#endif
	76
82271cee RL	77	#ifdef __cplusplus
	78	extern "C" {
	79	#endif
	80
3a87a9b9 GT	81	/* Declared already in ossl_typ.h */
	82	/* typedef struct rsa_st RSA; */
	83	/* typedef struct rsa_meth_st RSA_METHOD; */
03f8b042	84
3a87a9b9	85	struct rsa_meth_st
d02b48c6	86	{
e778802f	87	const char *name;
29c1f061 RL	88	int (rsa_pub_enc)(int flen,const unsigned char from,
29c1f061 RL	89	unsigned char *to,
03f8b042	90	RSA *rsa,int padding);
29c1f061 RL	91	int (rsa_pub_dec)(int flen,const unsigned char from,
29c1f061 RL	92	unsigned char *to,
03f8b042	93	RSA *rsa,int padding);
29c1f061 RL	94	int (rsa_priv_enc)(int flen,const unsigned char from,
29c1f061 RL	95	unsigned char *to,
03f8b042	96	RSA *rsa,int padding);
29c1f061 RL	97	int (rsa_priv_dec)(int flen,const unsigned char from,
29c1f061 RL	98	unsigned char *to,
03f8b042	99	RSA *rsa,int padding);
46ef873f	100	int (rsa_mod_exp)(BIGNUM r0,const BIGNUM I,RSA rsa,BN_CTX ctx); / Can be null */
29c1f061	101	int (bn_mod_exp)(BIGNUM r, const BIGNUM a, const BIGNUM p,
84c15db5 BL	102	const BIGNUM m, BN_CTX ctx,
84c15db5 BL	103	BN_MONT_CTX m_ctx); / Can be null */
03f8b042 BL	104	int (init)(RSA rsa); /* called at new */
03f8b042 BL	105	int (finish)(RSA rsa); /* called at free */
58964a49 RE	106	int flags; /* RSA_METHOD_FLAG_* things */
58964a49 RE	107	char app_data; / may be needed! */
1c80019a DSH	108	/* New sign and verify functions: some libraries don't allow arbitrary data
	109	* to be signed/verified: this allows them to be used. Note: for this to work
	110	* the RSA_public_decrypt() and RSA_private_encrypt() should NOT be used
	111	* RSA_sign(), RSA_verify() should be used instead. Note: for backwards
657e60fa	112	* compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
1c80019a DSH	113	* option is set in 'flags'.
1c80019a DSH	114	*/
29c1f061	115	int (*rsa_sign)(int type,
3e83e686	116	const unsigned char *m, unsigned int m_length,
29c1f061 RL	117	unsigned char sigret, unsigned int siglen, const RSA *rsa);
29c1f061 RL	118	int (*rsa_verify)(int dtype,
3e83e686	119	const unsigned char *m, unsigned int m_length,
29c1f061	120	unsigned char sigbuf, unsigned int siglen, const RSA rsa);
2814c629 GT	121	/* If this callback is NULL, the builtin software RSA key-gen will be used. This
	122	* is for behavioural compatibility whilst the code gets rewired, but one day
	123	* it would be nice to assume there are no such things as "builtin software"
	124	* implementations. */
bcfea9fb	125	int (rsa_keygen)(RSA rsa, int bits, BIGNUM e, BN_GENCB cb);
3a87a9b9	126	};
d02b48c6	127
03f8b042	128	struct rsa_st
d02b48c6 RE	129	{
	130	/* The first parameter is used to pickup errors where
	131	* this is passed instead of aEVP_PKEY, it is set to 0 */
	132	int pad;
9d6b1ce6	133	long version;
cb78486d GT	134	const RSA_METHOD *meth;
	135	/* functional reference if 'meth' is ENGINE-provided */
	136	ENGINE *engine;
d02b48c6 RE	137	BIGNUM *n;
	138	BIGNUM *e;
	139	BIGNUM *d;
	140	BIGNUM *p;
	141	BIGNUM *q;
	142	BIGNUM *dmp1;
	143	BIGNUM *dmq1;
	144	BIGNUM *iqmp;
770d19b8	145	/* be careful using this if the RSA structure is shared */
58964a49	146	CRYPTO_EX_DATA ex_data;
d02b48c6	147	int references;
58964a49 RE	148	int flags;
58964a49 RE	149
03f8b042 BL	150	/* Used to cache montgomery values */
	151	BN_MONT_CTX *_method_mod_n;
	152	BN_MONT_CTX *_method_mod_p;
	153	BN_MONT_CTX *_method_mod_q;
58964a49	154
dfeab068 RE	155	/* all BIGNUM values are actually in the following data, if it is not
	156	* NULL */
	157	char *bignum_data;
58964a49	158	BN_BLINDING *blinding;
800e400d	159	BN_BLINDING *mt_blinding;
03f8b042	160	};
d02b48c6 RE	161
	162	#define RSA_3 0x3L
	163	#define RSA_F4 0x10001L
	164
46a64376	165	#define RSA_METHOD_FLAG_NO_CHECK 0x0001 /* don't check pub/private match */
dfeab068	166
46a64376 BM	167	#define RSA_FLAG_CACHE_PUBLIC 0x0002
	168	#define RSA_FLAG_CACHE_PRIVATE 0x0004
	169	#define RSA_FLAG_BLINDING 0x0008
	170	#define RSA_FLAG_THREAD_SAFE 0x0010
770d19b8 DSH	171	/* This flag means the private key operations will be handled by rsa_mod_exp
	172	* and that they do not depend on the private key components being present:
	173	* for example a key stored in external hardware. Without this flag bn_mod_exp
	174	* gets called when private key components are absent.
	175	*/
46a64376	176	#define RSA_FLAG_EXT_PKEY 0x0020
58964a49	177
1c80019a DSH	178	/* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
1c80019a DSH	179	*/
46a64376 BM	180	#define RSA_FLAG_SIGN_VER 0x0040
	181
	182	#define RSA_FLAG_NO_BLINDING 0x0080 /* new with 0.9.6j and 0.9.7b; the built-in
	183	* RSA implementation now uses blinding by
	184	* default (ignoring RSA_FLAG_BLINDING),
	185	* but other engines might not need it
	186	*/
	187	#define RSA_FLAG_NO_EXP_CONSTTIME 0x0100 /* new with 0.9.7h; the built-in RSA
	188	* implementation now uses constant time
	189	* modular exponentiation for secret exponents
	190	* by default. This flag causes the
	191	* faster variable sliding window method to
	192	* be used for all exponents.
	193	*/
c554155b	194
58964a49 RE	195	#define RSA_PKCS1_PADDING 1
	196	#define RSA_SSLV23_PADDING 2
	197	#define RSA_NO_PADDING 3
a4949896	198	#define RSA_PKCS1_OAEP_PADDING 4
499fca2d	199	#define RSA_X931_PADDING 5
58964a49	200
ba8ad074 RL	201	#define RSA_PKCS1_PADDING_SIZE 11
ba8ad074 RL	202
dd9d233e	203	#define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
58964a49	204	#define RSA_get_app_data(s) RSA_get_ex_data(s,0)
d02b48c6	205
d02b48c6	206	RSA * RSA_new(void);
cb78486d	207	RSA * RSA_new_method(ENGINE *engine);
29c1f061	208	int RSA_size(const RSA *);
e9224c71 GT	209
	210	/* Deprecated version */
	211	#ifndef OPENSSL_NO_DEPRECATED
d02b48c6	212	RSA * RSA_generate_key(int bits, unsigned long e,void
b4f76582	213	(callback)(int,int,void ),void *cb_arg);
e9224c71 GT	214	#endif /* !defined(OPENSSL_NO_DEPRECATED) */
	215
	216	/* New version */
bcfea9fb	217	int RSA_generate_key_ex(RSA rsa, int bits, BIGNUM e, BN_GENCB *cb);
e9224c71	218
29c1f061	219	int RSA_check_key(const RSA *);
d02b48c6	220	/* next 4 return -1 on error */
29c1f061	221	int RSA_public_encrypt(int flen, const unsigned char *from,
d02b48c6	222	unsigned char to, RSA rsa,int padding);
29c1f061	223	int RSA_private_encrypt(int flen, const unsigned char *from,
d02b48c6	224	unsigned char to, RSA rsa,int padding);
29c1f061	225	int RSA_public_decrypt(int flen, const unsigned char *from,
d02b48c6	226	unsigned char to, RSA rsa,int padding);
29c1f061	227	int RSA_private_decrypt(int flen, const unsigned char *from,
d02b48c6 RE	228	unsigned char to, RSA rsa,int padding);
d02b48c6 RE	229	void RSA_free (RSA *r);
5cbc2e8b	230	/* "up" the RSA object's reference count */
6ac4e8bd	231	int RSA_up_ref(RSA *r);
d02b48c6	232
29c1f061	233	int RSA_flags(const RSA *r);
58964a49	234
cb78486d GT	235	void RSA_set_default_method(const RSA_METHOD *meth);
cb78486d GT	236	const RSA_METHOD *RSA_get_default_method(void);
29c1f061	237	const RSA_METHOD RSA_get_method(const RSA rsa);
cb78486d	238	int RSA_set_method(RSA rsa, const RSA_METHOD meth);
d02b48c6	239
dfeab068 RE	240	/* This function needs the memory locking malloc callbacks to be installed */
	241	int RSA_memory_lock(RSA *r);
	242
d02b48c6	243	/* these are the actual SSLeay RSA functions */
7be7c2ed	244	const RSA_METHOD *RSA_PKCS1_SSLeay(void);
d02b48c6	245
7be7c2ed	246	const RSA_METHOD *RSA_null_method(void);
c1cd88a0	247
78d3b819 DSH	248	DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
	249	DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)
	250
cf1b7d96	251	#ifndef OPENSSL_NO_FP_API
29c1f061	252	int RSA_print_fp(FILE fp, const RSA r,int offset);
d02b48c6 RE	253	#endif
d02b48c6 RE	254
cf1b7d96	255	#ifndef OPENSSL_NO_BIO
29c1f061	256	int RSA_print(BIO bp, const RSA r,int offset);
d02b48c6 RE	257	#endif
d02b48c6 RE	258
41a15c4f BL	259	int i2d_RSA_NET(const RSA a, unsigned char *pp,
	260	int (cb)(char buf, int len, const char *prompt, int verify),
	261	int sgckey);
	262	RSA d2i_RSA_NET(RSA a, const unsigned char *pp, long length,
	263	int (cb)(char buf, int len, const char *prompt, int verify),
	264	int sgckey);
	265
	266	int i2d_Netscape_RSA(const RSA a, unsigned char *pp,
	267	int (cb)(char buf, int len, const char *prompt,
	268	int verify));
	269	RSA d2i_Netscape_RSA(RSA a, const unsigned char *pp, long length,
	270	int (cb)(char buf, int len, const char *prompt,
	271	int verify));
d02b48c6 RE	272
	273	/* The following 2 functions sign and verify a X509_SIG ASN1 object
	274	* inside PKCS#1 padded RSA encryption */
3e83e686	275	int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
816d7857	276	unsigned char sigret, unsigned int siglen, RSA *rsa);
3e83e686	277	int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
816d7857	278	unsigned char sigbuf, unsigned int siglen, RSA rsa);
d02b48c6 RE	279
	280	/* The following 2 function sign and verify a ASN1_OCTET_STRING
	281	* object inside PKCS#1 padded RSA encryption */
29c1f061	282	int RSA_sign_ASN1_OCTET_STRING(int type,
3e83e686	283	const unsigned char *m, unsigned int m_length,
d02b48c6	284	unsigned char sigret, unsigned int siglen, RSA *rsa);
29c1f061	285	int RSA_verify_ASN1_OCTET_STRING(int type,
3e83e686	286	const unsigned char *m, unsigned int m_length,
d02b48c6 RE	287	unsigned char sigbuf, unsigned int siglen, RSA rsa);
d02b48c6 RE	288
58964a49 RE	289	int RSA_blinding_on(RSA rsa, BN_CTX ctx);
58964a49 RE	290	void RSA_blinding_off(RSA *rsa);
800e400d	291	BN_BLINDING RSA_setup_blinding(RSA rsa, BN_CTX *ctx);
58964a49 RE	292
58964a49 RE	293	int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
29c1f061	294	const unsigned char *f,int fl);
58964a49	295	int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
29c1f061	296	const unsigned char *f,int fl,int rsa_len);
58964a49	297	int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
29c1f061	298	const unsigned char *f,int fl);
58964a49	299	int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
29c1f061	300	const unsigned char *f,int fl,int rsa_len);
499fca2d DSH	301	int PKCS1_MGF1(unsigned char *mask, long len,
499fca2d DSH	302	const unsigned char seed, long seedlen, const EVP_MD dgst);
a4949896	303	int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
29c1f061 RL	304	const unsigned char *f,int fl,
29c1f061 RL	305	const unsigned char *p,int pl);
a4949896	306	int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
29c1f061 RL	307	const unsigned char *f,int fl,int rsa_len,
29c1f061 RL	308	const unsigned char *p,int pl);
58964a49	309	int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
29c1f061	310	const unsigned char *f,int fl);
58964a49	311	int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
29c1f061	312	const unsigned char *f,int fl,int rsa_len);
58964a49	313	int RSA_padding_add_none(unsigned char *to,int tlen,
29c1f061	314	const unsigned char *f,int fl);
58964a49	315	int RSA_padding_check_none(unsigned char *to,int tlen,
29c1f061	316	const unsigned char *f,int fl,int rsa_len);
499fca2d DSH	317	int RSA_padding_add_X931(unsigned char *to,int tlen,
	318	const unsigned char *f,int fl);
	319	int RSA_padding_check_X931(unsigned char *to,int tlen,
	320	const unsigned char *f,int fl,int rsa_len);
	321	int RSA_X931_hash_id(int nid);
58964a49	322
c7aaf391 AP	323	int RSA_verify_PKCS1_PSS(RSA rsa, const unsigned char mHash,
	324	const EVP_MD Hash, const unsigned char EM, int sLen);
	325	int RSA_padding_add_PKCS1_PSS(RSA rsa, unsigned char EM,
	326	const unsigned char *mHash,
	327	const EVP_MD *Hash, int sLen);
	328
dd9d233e DSH	329	int RSA_get_ex_new_index(long argl, void argp, CRYPTO_EX_new new_func,
	330	CRYPTO_EX_dup dup_func, CRYPTO_EX_free free_func);
	331	int RSA_set_ex_data(RSA r,int idx,void arg);
29c1f061	332	void RSA_get_ex_data(const RSA r, int idx);
58964a49	333
40889b9c LJ	334	RSA RSAPublicKey_dup(RSA rsa);
	335	RSA RSAPrivateKey_dup(RSA rsa);
	336
d02b48c6	337	/* BEGIN ERROR CODES */
6d311938 DSH	338	/* The following lines are auto generated by the script mkerr.pl. Any changes
	339	* made after this point may be overwritten when the script is next run.
	340	*/
24cff6ce	341	void ERR_load_RSA_strings(void);
6d311938	342
d02b48c6 RE	343	/* Error codes for the RSA functions. */
	344
	345	/* Function codes. */
499fca2d DSH	346	#define RSA_F_MEMORY_LOCK 100
499fca2d DSH	347	#define RSA_F_RSA_BUILTIN_KEYGEN 129
03cd4944	348	#define RSA_F_RSA_CHECK_KEY 123
dfeab068 RE	349	#define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
	350	#define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
	351	#define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
	352	#define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
499fca2d DSH	353	#define RSA_F_RSA_GENERATE_KEY 105
499fca2d DSH	354	#define RSA_F_RSA_MEMORY_LOCK 130
dfeab068	355	#define RSA_F_RSA_NEW_METHOD 106
c1cd88a0	356	#define RSA_F_RSA_NULL 124
499fca2d DSH	357	#define RSA_F_RSA_NULL_MOD_EXP 131
	358	#define RSA_F_RSA_NULL_PRIVATE_DECRYPT 132
	359	#define RSA_F_RSA_NULL_PRIVATE_ENCRYPT 133
	360	#define RSA_F_RSA_NULL_PUBLIC_DECRYPT 134
	361	#define RSA_F_RSA_NULL_PUBLIC_ENCRYPT 135
dfeab068	362	#define RSA_F_RSA_PADDING_ADD_NONE 107
a4949896	363	#define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
499fca2d	364	#define RSA_F_RSA_PADDING_ADD_PKCS1_PSS 125
dfeab068 RE	365	#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
	366	#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
	367	#define RSA_F_RSA_PADDING_ADD_SSLV23 110
499fca2d	368	#define RSA_F_RSA_PADDING_ADD_X931 127
dfeab068	369	#define RSA_F_RSA_PADDING_CHECK_NONE 111
a4949896	370	#define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
dfeab068 RE	371	#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
	372	#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
	373	#define RSA_F_RSA_PADDING_CHECK_SSLV23 114
499fca2d	374	#define RSA_F_RSA_PADDING_CHECK_X931 128
dfeab068 RE	375	#define RSA_F_RSA_PRINT 115
dfeab068 RE	376	#define RSA_F_RSA_PRINT_FP 116
448be743 DSH	377	#define RSA_F_RSA_PRIV_DECODE 137
	378	#define RSA_F_RSA_PRIV_ENCODE 138
	379	#define RSA_F_RSA_PUB_DECODE 139
499fca2d	380	#define RSA_F_RSA_SETUP_BLINDING 136
dfeab068 RE	381	#define RSA_F_RSA_SIGN 117
	382	#define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
	383	#define RSA_F_RSA_VERIFY 119
	384	#define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
499fca2d	385	#define RSA_F_RSA_VERIFY_PKCS1_PSS 126
d02b48c6 RE	386
	387	/* Reason codes. */
	388	#define RSA_R_ALGORITHM_MISMATCH 100
	389	#define RSA_R_BAD_E_VALUE 101
	390	#define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
	391	#define RSA_R_BAD_PAD_BYTE_COUNT 103
	392	#define RSA_R_BAD_SIGNATURE 104
58964a49 RE	393	#define RSA_R_BLOCK_TYPE_IS_NOT_01 106
	394	#define RSA_R_BLOCK_TYPE_IS_NOT_02 107
	395	#define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
	396	#define RSA_R_DATA_TOO_LARGE 109
	397	#define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
24cff6ce	398	#define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
58964a49	399	#define RSA_R_DATA_TOO_SMALL 111
0c8a1281	400	#define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
58964a49	401	#define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
03cd4944 BM	402	#define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
03cd4944 BM	403	#define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
c1cd88a0	404	#define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
499fca2d DSH	405	#define RSA_R_FIRST_OCTET_INVALID 133
499fca2d DSH	406	#define RSA_R_INVALID_HEADER 137
1c80019a	407	#define RSA_R_INVALID_MESSAGE_LENGTH 131
499fca2d DSH	408	#define RSA_R_INVALID_PADDING 138
499fca2d DSH	409	#define RSA_R_INVALID_TRAILER 139
03cd4944	410	#define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
a4949896	411	#define RSA_R_KEY_SIZE_TOO_SMALL 120
499fca2d DSH	412	#define RSA_R_LAST_OCTET_INVALID 134
499fca2d DSH	413	#define RSA_R_NO_PUBLIC_EXPONENT 140
58964a49	414	#define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
3a55fc1a	415	#define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
a4949896	416	#define RSA_R_OAEP_DECODING_ERROR 121
58964a49	417	#define RSA_R_PADDING_CHECK_FAILED 114
03cd4944 BM	418	#define RSA_R_P_NOT_PRIME 128
03cd4944 BM	419	#define RSA_R_Q_NOT_PRIME 129
c1cd88a0	420	#define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
739a543e BM	421	#define RSA_R_SLEN_CHECK_FAILED 136
739a543e BM	422	#define RSA_R_SLEN_RECOVERY_FAILED 135
58964a49 RE	423	#define RSA_R_SSLV3_ROLLBACK_ATTACK 115
	424	#define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
	425	#define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
	426	#define RSA_R_UNKNOWN_PADDING_TYPE 118
	427	#define RSA_R_WRONG_SIGNATURE_LENGTH 119
6d311938	428
d02b48c6 RE	429	#ifdef __cplusplus
	430	}
	431	#endif
	432	#endif