1/*
2 * Copyright (c) 2000-2001,2011,2014 Apple Inc. All Rights Reserved.
3 *
4 * The contents of this file constitute Original Code as defined in and are
5 * subject to the Apple Public Source License Version 1.2 (the 'License').
6 * You may not use this file except in compliance with the License. Please obtain
7 * a copy of the License at http://www.apple.com/publicsource and read it before
8 * using this file.
9 *
10 * This Original Code and all software distributed under the License are
11 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
12 * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
13 * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14 * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
15 * specific language governing rights and limitations under the License.
16 */
17
18
19/* crypto/rsa/rsa.h */
20/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
21 * All rights reserved.
22 *
23 * This package is an SSL implementation written
24 * by Eric Young (eay@cryptsoft.com).
25 * The implementation was written so as to conform with Netscapes SSL.
26 *
27 * This library is free for commercial and non-commercial use as long as
28 * the following conditions are aheared to.  The following conditions
29 * apply to all code found in this distribution, be it the RC4, RSA,
30 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
31 * included with this distribution is covered by the same copyright terms
32 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
33 *
34 * Copyright remains Eric Young's, and as such any Copyright notices in
35 * the code are not to be removed.
36 * If this package is used in a product, Eric Young should be given attribution
37 * as the author of the parts of the library used.
38 * This can be in the form of a textual message at program startup or
39 * in documentation (online or textual) provided with the package.
40 *
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
43 * are met:
44 * 1. Redistributions of source code must retain the copyright
45 *    notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 *    notice, this list of conditions and the following disclaimer in the
48 *    documentation and/or other materials provided with the distribution.
49 * 3. All advertising materials mentioning features or use of this software
50 *    must display the following acknowledgement:
51 *    "This product includes cryptographic software written by
52 *     Eric Young (eay@cryptsoft.com)"
53 *    The word 'cryptographic' can be left out if the rouines from the library
54 *    being used are not cryptographic related :-).
55 * 4. If you include any Windows specific code (or a derivative thereof) from
56 *    the apps directory (application code) you must include an acknowledgement:
57 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
58 *
59 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 *
71 * The licence and distribution terms for any publically available version or
72 * derivative of this code cannot be changed.  i.e. this code cannot simply be
73 * copied and put under another distribution licence
74 * [including the GNU Public Licence.]
75 */
76
77#ifndef HEADER_RSA_H
78#define HEADER_RSA_H
79
80#ifdef  __cplusplus
81extern "C" {
82#endif
83
84#include <openssl/bn.h>
85#include <openssl/crypto.h>
86
87#ifdef NO_RSA
88#error RSA is disabled.
89#endif
90
91typedef struct rsa_st RSA;
92
93typedef struct rsa_meth_st
94	{
95	const char *name;
96	int (*rsa_pub_enc)(int flen,unsigned char *from,unsigned char *to,
97			   RSA *rsa,int padding);
98	int (*rsa_pub_dec)(int flen,unsigned char *from,unsigned char *to,
99			   RSA *rsa,int padding);
100	int (*rsa_priv_enc)(int flen,unsigned char *from,unsigned char *to,
101			    RSA *rsa,int padding);
102	int (*rsa_priv_dec)(int flen,unsigned char *from,unsigned char *to,
103			    RSA *rsa,int padding);
104	int (*rsa_mod_exp)(BIGNUM *r0,BIGNUM *I,RSA *rsa); /* Can be null */
105	int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
106			  const BIGNUM *m, BN_CTX *ctx,
107			  BN_MONT_CTX *m_ctx); /* Can be null */
108	int (*init)(RSA *rsa);		/* called at new */
109	int (*finish)(RSA *rsa);	/* called at free */
110	int flags;			/* RSA_METHOD_FLAG_* things */
111	char *app_data;			/* may be needed! */
112/* New sign and verify functions: some libraries don't allow arbitrary data
113 * to be signed/verified: this allows them to be used. Note: for this to work
114 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used
115 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards
116 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
117 * option is set in 'flags'.
118 */
119	int (*rsa_sign)(int type, unsigned char *m, unsigned int m_len,
120             unsigned char *sigret, unsigned int *siglen, RSA *rsa);
121	int (*rsa_verify)(int dtype, unsigned char *m, unsigned int m_len,
122             unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
123
124	} RSA_METHOD;
125
126struct BN_BLINDING_STRUCT;
127
128struct rsa_st
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;
133	int version;
134	const RSA_METHOD *meth;
135	BIGNUM *n;
136	BIGNUM *e;
137	BIGNUM *d;
138	BIGNUM *p;
139	BIGNUM *q;
140	BIGNUM *dmp1;
141	BIGNUM *dmq1;
142	BIGNUM *iqmp;
143	/* be careful using this if the RSA structure is shared */
144	CRYPTO_EX_DATA ex_data;
145	int references;
146	int flags;
147
148	/* Used to cache montgomery values */
149	BN_MONT_CTX *_method_mod_n;
150	BN_MONT_CTX *_method_mod_p;
151	BN_MONT_CTX *_method_mod_q;
152
153	/* all BIGNUM values are actually in the following data, if it is not
154	 * NULL */
155	char *bignum_data;
156	int num_blinding_threads;
157	pthread_mutex_t blinding_mutex;
158	struct BN_BLINDING_STRUCT *blinding_array;
159	};
160
161#define RSA_3	0x3L
162#define RSA_F4	0x10001L
163
164#define RSA_METHOD_FLAG_NO_CHECK	0x01 /* don't check pub/private match */
165
166#define RSA_FLAG_CACHE_PUBLIC		0x02
167#define RSA_FLAG_CACHE_PRIVATE		0x04
168#define RSA_FLAG_BLINDING		0x08
169#define RSA_FLAG_THREAD_SAFE		0x10
170/* This flag means the private key operations will be handled by rsa_mod_exp
171 * and that they do not depend on the private key components being present:
172 * for example a key stored in external hardware. Without this flag bn_mod_exp
173 * gets called when private key components are absent.
174 */
175#define RSA_FLAG_EXT_PKEY		0x20
176
177/* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
178 */
179#define RSA_FLAG_SIGN_VER		0x40
180
181#define RSA_PKCS1_PADDING	1
182#define RSA_SSLV23_PADDING	2
183#define RSA_NO_PADDING		3
184#define RSA_PKCS1_OAEP_PADDING	4
185
186#define RSA_set_app_data(s,arg)         RSA_set_ex_data(s,0,arg)
187#define RSA_get_app_data(s)             RSA_get_ex_data(s,0)
188
189RSA *	RSA_new(void);
190RSA *	RSA_new_method(const RSA_METHOD *method);
191int	RSA_size(RSA *);
192RSA *	RSA_generate_key(int bits, unsigned long e,void
193		(*callback)(int,int,void *),void *cb_arg);
194int	RSA_check_key(RSA *);
195	/* next 4 return -1 on error */
196int	RSA_public_encrypt(int flen, unsigned char *from,
197		unsigned char *to, RSA *rsa,int padding);
198int	RSA_private_encrypt(int flen, unsigned char *from,
199		unsigned char *to, RSA *rsa,int padding);
200int	RSA_public_decrypt(int flen, unsigned char *from,
201		unsigned char *to, RSA *rsa,int padding);
202int	RSA_private_decrypt(int flen, unsigned char *from,
203		unsigned char *to, RSA *rsa,int padding);
204void	RSA_free (RSA *r);
205
206int	RSA_flags(RSA *r);
207
208void RSA_set_default_method(const RSA_METHOD *meth);
209const RSA_METHOD *RSA_get_default_method(void);
210const RSA_METHOD *RSA_get_method(RSA *rsa);
211const RSA_METHOD *RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
212
213/* This function needs the memory locking malloc callbacks to be installed */
214int RSA_memory_lock(RSA *r);
215
216/* If you have RSAref compiled in. */
217const RSA_METHOD *RSA_PKCS1_RSAref(void);
218
219/* these are the actual SSLeay RSA functions */
220const RSA_METHOD *RSA_PKCS1_SSLeay(void);
221
222const RSA_METHOD *RSA_null_method(void);
223
224void	ERR_load_RSA_strings(void );
225
226RSA *	d2i_RSAPublicKey(RSA **a, unsigned char **pp, long length);
227int	i2d_RSAPublicKey(RSA *a, unsigned char **pp);
228RSA *	d2i_RSAPrivateKey(RSA **a, unsigned char **pp, long length);
229int 	i2d_RSAPrivateKey(RSA *a, unsigned char **pp);
230#ifndef NO_FP_API
231int	RSA_print_fp(FILE *fp, RSA *r,int offset);
232#endif
233
234#ifdef HEADER_BIO_H
235int	RSA_print(BIO *bp, RSA *r,int offset);
236#endif
237
238int i2d_Netscape_RSA(RSA *a, unsigned char **pp, int (*cb)());
239RSA *d2i_Netscape_RSA(RSA **a, unsigned char **pp, long length, int (*cb)());
240/* Naughty internal function required elsewhere, to handle a MS structure
241 * that is the same as the netscape one :-) */
242RSA *d2i_Netscape_RSA_2(RSA **a, unsigned char **pp, long length, int (*cb)());
243
244/* The following 2 functions sign and verify a X509_SIG ASN1 object
245 * inside PKCS#1 padded RSA encryption */
246int RSA_sign(int type, unsigned char *m, unsigned int m_len,
247	unsigned char *sigret, unsigned int *siglen, RSA *rsa);
248int RSA_verify(int type, unsigned char *m, unsigned int m_len,
249	unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
250
251/* The following 2 function sign and verify a ASN1_OCTET_STRING
252 * object inside PKCS#1 padded RSA encryption */
253int RSA_sign_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len,
254	unsigned char *sigret, unsigned int *siglen, RSA *rsa);
255int RSA_verify_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len,
256	unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
257
258int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
259void RSA_blinding_off(RSA *rsa);
260
261int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
262	unsigned char *f,int fl);
263int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
264	unsigned char *f,int fl,int rsa_len);
265int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
266	unsigned char *f,int fl);
267int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
268	unsigned char *f,int fl,int rsa_len);
269int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
270			       unsigned char *f,int fl,unsigned char *p,
271			       int pl);
272int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
273				 unsigned char *f,int fl,int rsa_len,
274				 unsigned char *p,int pl);
275int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
276	unsigned char *f,int fl);
277int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
278	unsigned char *f,int fl,int rsa_len);
279int RSA_padding_add_none(unsigned char *to,int tlen,
280	unsigned char *f,int fl);
281int RSA_padding_check_none(unsigned char *to,int tlen,
282	unsigned char *f,int fl,int rsa_len);
283
284int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
285	CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
286int RSA_set_ex_data(RSA *r,int idx,void *arg);
287void *RSA_get_ex_data(RSA *r, int idx);
288
289BN_BLINDING* RSA_get_thread_blinding_ptr(RSA *r);
290void RSA_set_thread_blinding_ptr(RSA *r, BN_BLINDING* bnb);
291void RSA_free_thread_blinding_ptr(RSA* r);
292
293/* BEGIN ERROR CODES */
294/* The following lines are auto generated by the script mkerr.pl. Any changes
295 * made after this point may be overwritten when the script is next run.
296 */
297
298/* Error codes for the RSA functions. */
299
300/* Function codes. */
301#define RSA_F_MEMORY_LOCK				 100
302#define RSA_F_RSA_CHECK_KEY				 123
303#define RSA_F_RSA_EAY_PRIVATE_DECRYPT			 101
304#define RSA_F_RSA_EAY_PRIVATE_ENCRYPT			 102
305#define RSA_F_RSA_EAY_PUBLIC_DECRYPT			 103
306#define RSA_F_RSA_EAY_PUBLIC_ENCRYPT			 104
307#define RSA_F_RSA_GENERATE_KEY				 105
308#define RSA_F_RSA_NEW_METHOD				 106
309#define RSA_F_RSA_NULL					 124
310#define RSA_F_RSA_PADDING_ADD_NONE			 107
311#define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP		 121
312#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1		 108
313#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2		 109
314#define RSA_F_RSA_PADDING_ADD_SSLV23			 110
315#define RSA_F_RSA_PADDING_CHECK_NONE			 111
316#define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP		 122
317#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1		 112
318#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2		 113
319#define RSA_F_RSA_PADDING_CHECK_SSLV23			 114
320#define RSA_F_RSA_PRINT					 115
321#define RSA_F_RSA_PRINT_FP				 116
322#define RSA_F_RSA_SIGN					 117
323#define RSA_F_RSA_SIGN_ASN1_OCTET_STRING		 118
324#define RSA_F_RSA_VERIFY				 119
325#define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING		 120
326
327/* Reason codes. */
328#define RSA_R_ALGORITHM_MISMATCH			 100
329#define RSA_R_BAD_E_VALUE				 101
330#define RSA_R_BAD_FIXED_HEADER_DECRYPT			 102
331#define RSA_R_BAD_PAD_BYTE_COUNT			 103
332#define RSA_R_BAD_SIGNATURE				 104
333#define RSA_R_BLOCK_TYPE_IS_NOT_01			 106
334#define RSA_R_BLOCK_TYPE_IS_NOT_02			 107
335#define RSA_R_DATA_GREATER_THAN_MOD_LEN			 108
336#define RSA_R_DATA_TOO_LARGE				 109
337#define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE		 110
338#define RSA_R_DATA_TOO_SMALL				 111
339#define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE		 122
340#define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY		 112
341#define RSA_R_DMP1_NOT_CONGRUENT_TO_D			 124
342#define RSA_R_DMQ1_NOT_CONGRUENT_TO_D			 125
343#define RSA_R_D_E_NOT_CONGRUENT_TO_1			 123
344#define RSA_R_INVALID_MESSAGE_LENGTH			 131
345#define RSA_R_IQMP_NOT_INVERSE_OF_Q			 126
346#define RSA_R_KEY_SIZE_TOO_SMALL			 120
347#define RSA_R_NULL_BEFORE_BLOCK_MISSING			 113
348#define RSA_R_N_DOES_NOT_EQUAL_P_Q			 127
349#define RSA_R_OAEP_DECODING_ERROR			 121
350#define RSA_R_PADDING_CHECK_FAILED			 114
351#define RSA_R_P_NOT_PRIME				 128
352#define RSA_R_Q_NOT_PRIME				 129
353#define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED		 130
354#define RSA_R_SSLV3_ROLLBACK_ATTACK			 115
355#define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
356#define RSA_R_UNKNOWN_ALGORITHM_TYPE			 117
357#define RSA_R_UNKNOWN_PADDING_TYPE			 118
358#define RSA_R_WRONG_SIGNATURE_LENGTH			 119
359
360#ifdef  __cplusplus
361}
362#endif
363#endif
364
365