blob: 61e1069ff56871ca0e2f56c7b19af607aae0a243 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.] */
56
57#ifndef OPENSSL_HEADER_RSA_H
58#define OPENSSL_HEADER_RSA_H
59
60#include <openssl/base.h>
61
62#include <openssl/engine.h>
63#include <openssl/ex_data.h>
Adam Langley683d7bd2015-04-13 11:04:14 -070064#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -070065
66#if defined(__cplusplus)
67extern "C" {
68#endif
69
70
71/* rsa.h contains functions for handling encryption and signature using RSA. */
72
73
74/* Allocation and destruction. */
75
76/* RSA_new returns a new, empty RSA object or NULL on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070077OPENSSL_EXPORT RSA *RSA_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -070078
Adam Langley389e3f02014-08-19 11:24:27 -070079/* RSA_new_method acts the same as |RSA_new| but takes an explicit |ENGINE|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070080OPENSSL_EXPORT RSA *RSA_new_method(const ENGINE *engine);
Adam Langley95c29f32014-06-20 12:00:00 -070081
82/* RSA_free decrements the reference count of |rsa| and frees it if the
83 * reference count drops to zero. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070084OPENSSL_EXPORT void RSA_free(RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -070085
86/* RSA_up_ref increments the reference count of |rsa|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070087OPENSSL_EXPORT int RSA_up_ref(RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -070088
89
90/* Key generation. */
91
92/* RSA_generate_key_ex generates a new RSA key where the modulus has size
93 * |bits| and the public exponent is |e|. If unsure, |RSA_F4| is a good value
94 * for |e|. If |cb| is not NULL then it is called during the key generation
95 * process. In addition to the calls documented for |BN_generate_prime_ex|, it
96 * is called with event=2 when the n'th prime is rejected as unsuitable and
Adam Langley5129e2d2014-07-25 10:06:44 -070097 * with event=3 when a suitable value for |p| is found.
98 *
99 * It returns one on success or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700100OPENSSL_EXPORT int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e,
101 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700102
Adam Langley839b8812015-05-26 11:36:46 -0700103/* RSA_generate_multi_prime_key acts like |RSA_generate_key_ex| but can
104 * generate an RSA private key with more than two primes. */
105OPENSSL_EXPORT int RSA_generate_multi_prime_key(RSA *rsa, int bits,
106 int num_primes, BIGNUM *e,
107 BN_GENCB *cb);
108
Adam Langley95c29f32014-06-20 12:00:00 -0700109
110/* Encryption / Decryption */
111
112/* Padding types for encryption. */
113#define RSA_PKCS1_PADDING 1
Adam Langley95c29f32014-06-20 12:00:00 -0700114#define RSA_NO_PADDING 3
115#define RSA_PKCS1_OAEP_PADDING 4
116/* RSA_PKCS1_PSS_PADDING can only be used via the EVP interface. */
117#define RSA_PKCS1_PSS_PADDING 6
118
119/* RSA_encrypt encrypts |in_len| bytes from |in| to the public key from |rsa|
120 * and writes, at most, |max_out| bytes of encrypted data to |out|. The
121 * |max_out| argument must be, at least, |RSA_size| in order to ensure success.
122 *
123 * It returns 1 on success or zero on error.
124 *
125 * The |padding| argument must be one of the |RSA_*_PADDING| values. If in
126 * doubt, |RSA_PKCS1_PADDING| is the most common but |RSA_PKCS1_OAEP_PADDING|
127 * is the most secure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700128OPENSSL_EXPORT int RSA_encrypt(RSA *rsa, size_t *out_len, uint8_t *out,
129 size_t max_out, const uint8_t *in, size_t in_len,
130 int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700131
132/* RSA_decrypt decrypts |in_len| bytes from |in| with the private key from
133 * |rsa| and writes, at most, |max_out| bytes of plaintext to |out|. The
134 * |max_out| argument must be, at least, |RSA_size| in order to ensure success.
135 *
136 * It returns 1 on success or zero on error.
137 *
138 * The |padding| argument must be one of the |RSA_*_PADDING| values. If in
139 * doubt, |RSA_PKCS1_PADDING| is the most common but |RSA_PKCS1_OAEP_PADDING|
140 * is the most secure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700141OPENSSL_EXPORT int RSA_decrypt(RSA *rsa, size_t *out_len, uint8_t *out,
142 size_t max_out, const uint8_t *in, size_t in_len,
143 int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700144
145/* RSA_public_encrypt encrypts |flen| bytes from |from| to the public key in
146 * |rsa| and writes the encrypted data to |to|. The |to| buffer must have at
147 * least |RSA_size| bytes of space. It returns the number of bytes written, or
148 * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING|
149 * values. If in doubt, |RSA_PKCS1_PADDING| is the most common but
150 * |RSA_PKCS1_OAEP_PADDING| is the most secure.
151 *
152 * WARNING: this function is dangerous because it breaks the usual return value
153 * convention. Use |RSA_encrypt| instead. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700154OPENSSL_EXPORT int RSA_public_encrypt(int flen, const uint8_t *from,
155 uint8_t *to, RSA *rsa, int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700156
157/* RSA_private_decrypt decrypts |flen| bytes from |from| with the public key in
158 * |rsa| and writes the plaintext to |to|. The |to| buffer must have at
159 * least |RSA_size| bytes of space. It returns the number of bytes written, or
160 * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING|
161 * values. If in doubt, |RSA_PKCS1_PADDING| is the most common but
162 * |RSA_PKCS1_OAEP_PADDING| is the most secure.
163 *
164 * WARNING: this function is dangerous because it breaks the usual return value
165 * convention. Use |RSA_decrypt| instead. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700166OPENSSL_EXPORT int RSA_private_decrypt(int flen, const uint8_t *from,
167 uint8_t *to, RSA *rsa, int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700168
David Benjamin0aa07672014-07-24 15:34:14 -0400169/* RSA_message_index_PKCS1_type_2 performs the first step of a PKCS #1 padding
170 * check for decryption. If the |from_len| bytes pointed to at |from| are a
171 * valid PKCS #1 message, it returns one and sets |*out_index| to the start of
172 * the unpadded message. The unpadded message is a suffix of the input and has
173 * length |from_len - *out_index|. Otherwise, it returns zero and sets
David Benjaminc61517c2014-12-29 18:41:09 -0500174 * |*out_index| to zero. This function runs in time independent of the input
175 * data and is intended to be used directly to avoid Bleichenbacher's attack.
David Benjamin0aa07672014-07-24 15:34:14 -0400176 *
177 * WARNING: This function behaves differently from the usual OpenSSL convention
178 * in that it does NOT put an error on the queue in the error case. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700179OPENSSL_EXPORT int RSA_message_index_PKCS1_type_2(const uint8_t *from,
180 size_t from_len,
181 size_t *out_index);
David Benjamin0aa07672014-07-24 15:34:14 -0400182
Adam Langley95c29f32014-06-20 12:00:00 -0700183
184/* Signing / Verification */
185
186/* RSA_sign signs |in_len| bytes of digest from |in| with |rsa| and writes, at
187 * most, |RSA_size(rsa)| bytes to |out|. On successful return, the actual
188 * number of bytes written is written to |*out_len|.
189 *
190 * The |hash_nid| argument identifies the hash function used to calculate |in|
191 * and is embedded in the resulting signature. For example, it might be
192 * |NID_sha256|.
193 *
194 * It returns 1 on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700195OPENSSL_EXPORT int RSA_sign(int hash_nid, const uint8_t *in,
196 unsigned int in_len, uint8_t *out,
197 unsigned int *out_len, RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -0700198
199/* RSA_sign_raw signs |in_len| bytes from |in| with the public key from |rsa|
Brian Smithb828cfd2015-03-29 16:51:14 -1000200 * and writes, at most, |max_out| bytes of signature data to |out|. The
Adam Langley95c29f32014-06-20 12:00:00 -0700201 * |max_out| argument must be, at least, |RSA_size| in order to ensure success.
202 *
203 * It returns 1 on success or zero on error.
204 *
205 * The |padding| argument must be one of the |RSA_*_PADDING| values. If in
206 * doubt, |RSA_PKCS1_PADDING| is the most common. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700207OPENSSL_EXPORT int RSA_sign_raw(RSA *rsa, size_t *out_len, uint8_t *out,
208 size_t max_out, const uint8_t *in,
209 size_t in_len, int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700210
211/* RSA_verify verifies that |sig_len| bytes from |sig| are a valid, PKCS#1
212 * signature of |msg_len| bytes at |msg| by |rsa|.
213 *
214 * The |hash_nid| argument identifies the hash function used to calculate |in|
215 * and is embedded in the resulting signature in order to prevent hash
216 * confusion attacks. For example, it might be |NID_sha256|.
217 *
218 * It returns one if the signature is valid and zero otherwise.
219 *
220 * WARNING: this differs from the original, OpenSSL function which additionally
221 * returned -1 on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700222OPENSSL_EXPORT int RSA_verify(int hash_nid, const uint8_t *msg, size_t msg_len,
223 const uint8_t *sig, size_t sig_len, RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -0700224
225/* RSA_verify_raw verifies |in_len| bytes of signature from |in| using the
226 * public key from |rsa| and writes, at most, |max_out| bytes of plaintext to
227 * |out|. The |max_out| argument must be, at least, |RSA_size| in order to
228 * ensure success.
229 *
230 * It returns 1 on success or zero on error.
231 *
232 * The |padding| argument must be one of the |RSA_*_PADDING| values. If in
233 * doubt, |RSA_PKCS1_PADDING| is the most common. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700234OPENSSL_EXPORT int RSA_verify_raw(RSA *rsa, size_t *out_len, uint8_t *out,
235 size_t max_out, const uint8_t *in,
236 size_t in_len, int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700237
238/* RSA_private_encrypt encrypts |flen| bytes from |from| with the private key in
239 * |rsa| and writes the encrypted data to |to|. The |to| buffer must have at
240 * least |RSA_size| bytes of space. It returns the number of bytes written, or
241 * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING|
242 * values. If in doubt, |RSA_PKCS1_PADDING| is the most common.
243 *
244 * WARNING: this function is dangerous because it breaks the usual return value
245 * convention. Use |RSA_sign_raw| instead. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700246OPENSSL_EXPORT int RSA_private_encrypt(int flen, const uint8_t *from,
247 uint8_t *to, RSA *rsa, int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700248
Kenny Root3a9e1fb2015-06-10 14:52:40 -0700249/* RSA_public_decrypt verifies |flen| bytes of signature from |from| using the
Adam Langley95c29f32014-06-20 12:00:00 -0700250 * public key in |rsa| and writes the plaintext to |to|. The |to| buffer must
251 * have at least |RSA_size| bytes of space. It returns the number of bytes
252 * written, or -1 on error. The |padding| argument must be one of the
253 * |RSA_*_PADDING| values. If in doubt, |RSA_PKCS1_PADDING| is the most common.
254 *
255 * WARNING: this function is dangerous because it breaks the usual return value
256 * convention. Use |RSA_verify_raw| instead. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700257OPENSSL_EXPORT int RSA_public_decrypt(int flen, const uint8_t *from,
258 uint8_t *to, RSA *rsa, int padding);
Adam Langley95c29f32014-06-20 12:00:00 -0700259
260
261/* Utility functions. */
262
263/* RSA_size returns the number of bytes in the modulus, which is also the size
Brian Smithb828cfd2015-03-29 16:51:14 -1000264 * of a signature or encrypted value using |rsa|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700265OPENSSL_EXPORT unsigned RSA_size(const RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -0700266
David Benjaminecc0ce72014-07-18 18:39:42 -0400267/* RSA_is_opaque returns one if |rsa| is opaque and doesn't expose its key
David Benjaminc20febe2014-11-11 23:47:50 -0500268 * material. Otherwise it returns zero. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700269OPENSSL_EXPORT int RSA_is_opaque(const RSA *rsa);
David Benjaminecc0ce72014-07-18 18:39:42 -0400270
David Benjaminc20febe2014-11-11 23:47:50 -0500271/* RSA_supports_digest returns one if |rsa| supports signing digests
272 * of type |md|. Otherwise it returns zero. */
273OPENSSL_EXPORT int RSA_supports_digest(const RSA *rsa, const EVP_MD *md);
274
Adam Langley95c29f32014-06-20 12:00:00 -0700275/* RSAPublicKey_dup allocates a fresh |RSA| and copies the private key from
276 * |rsa| into it. It returns the fresh |RSA| object, or NULL on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700277OPENSSL_EXPORT RSA *RSAPublicKey_dup(const RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -0700278
279/* RSAPrivateKey_dup allocates a fresh |RSA| and copies the private key from
280 * |rsa| into it. It returns the fresh |RSA| object, or NULL on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700281OPENSSL_EXPORT RSA *RSAPrivateKey_dup(const RSA *rsa);
Adam Langley95c29f32014-06-20 12:00:00 -0700282
Adam Langley05b73772014-07-25 12:03:51 -0700283/* RSA_check_key performs basic validatity tests on |rsa|. It returns one if
284 * they pass and zero otherwise. Opaque keys and public keys always pass. If it
285 * returns zero then a more detailed error is available on the error queue. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700286OPENSSL_EXPORT int RSA_check_key(const RSA *rsa);
Adam Langley05b73772014-07-25 12:03:51 -0700287
Adam Langley409766d2014-06-20 12:00:00 -0700288/* RSA_recover_crt_params uses |rsa->n|, |rsa->d| and |rsa->e| in order to
289 * calculate the two primes used and thus the precomputed, CRT values. These
290 * values are set in the |p|, |q|, |dmp1|, |dmq1| and |iqmp| members of |rsa|,
291 * which must be |NULL| on entry. It returns one on success and zero
292 * otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700293OPENSSL_EXPORT int RSA_recover_crt_params(RSA *rsa);
Adam Langley409766d2014-06-20 12:00:00 -0700294
Adam Langley20b64fd2015-03-20 16:39:54 -0700295/* RSA_verify_PKCS1_PSS_mgf1 verifies that |EM| is a correct PSS padding of
296 * |mHash|, where |mHash| is a digest produced by |Hash|. |EM| must point to
297 * exactly |RSA_size(rsa)| bytes of data. The |mgf1Hash| argument specifies the
298 * hash function for generating the mask. If NULL, |Hash| is used. The |sLen|
299 * argument specifies the expected salt length in bytes. If |sLen| is -1 then
300 * the salt length is the same as the hash length. If -2, then the salt length
301 * is maximal and is taken from the size of |EM|.
302 *
303 * It returns one on success or zero on error. */
304OPENSSL_EXPORT int RSA_verify_PKCS1_PSS_mgf1(RSA *rsa, const uint8_t *mHash,
305 const EVP_MD *Hash,
306 const EVP_MD *mgf1Hash,
307 const uint8_t *EM, int sLen);
308
309/* RSA_padding_add_PKCS1_PSS_mgf1 writes a PSS padding of |mHash| to |EM|,
310 * where |mHash| is a digest produced by |Hash|. |RSA_size(rsa)| bytes of
311 * output will be written to |EM|. The |mgf1Hash| argument specifies the hash
312 * function for generating the mask. If NULL, |Hash| is used. The |sLen|
313 * argument specifies the expected salt length in bytes. If |sLen| is -1 then
314 * the salt length is the same as the hash length. If -2, then the salt length
315 * is maximal given the space in |EM|.
316 *
317 * It returns one on success or zero on error. */
318OPENSSL_EXPORT int RSA_padding_add_PKCS1_PSS_mgf1(RSA *rsa, uint8_t *EM,
319 const uint8_t *mHash,
320 const EVP_MD *Hash,
321 const EVP_MD *mgf1Hash,
322 int sLen);
323
David Benjaminb0acb772015-05-28 16:53:31 -0400324/* RSA_add_pkcs1_prefix builds a version of |msg| prefixed with the DigestInfo
325 * header for the given hash function and sets |out_msg| to point to it. On
326 * successful return, |*out_msg| may be allocated memory and, if so,
327 * |*is_alloced| will be 1. */
328OPENSSL_EXPORT int RSA_add_pkcs1_prefix(uint8_t **out_msg, size_t *out_msg_len,
329 int *is_alloced, int hash_nid,
330 const uint8_t *msg, size_t msg_len);
331
Adam Langley20b64fd2015-03-20 16:39:54 -0700332
Adam Langley95c29f32014-06-20 12:00:00 -0700333/* ASN.1 functions. */
334
335/* d2i_RSAPublicKey parses an ASN.1, DER-encoded, RSA public key from |len|
336 * bytes at |*inp|. If |out| is not NULL then, on exit, a pointer to the result
337 * is in |*out|. If |*out| is already non-NULL on entry then the result is
338 * written directly into |*out|, otherwise a fresh |RSA| is allocated. On
339 * successful exit, |*inp| is advanced past the DER structure. It returns the
340 * result or NULL on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700341OPENSSL_EXPORT RSA *d2i_RSAPublicKey(RSA **out, const uint8_t **inp, long len);
Adam Langley95c29f32014-06-20 12:00:00 -0700342
343/* i2d_RSAPublicKey marshals |in| to an ASN.1, DER structure. If |outp| is not
344 * NULL then the result is written to |*outp| and |*outp| is advanced just past
345 * the output. It returns the number of bytes in the result, whether written or
346 * not, or a negative value on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700347OPENSSL_EXPORT int i2d_RSAPublicKey(const RSA *in, uint8_t **outp);
Adam Langley95c29f32014-06-20 12:00:00 -0700348
349/* d2i_RSAPrivateKey parses an ASN.1, DER-encoded, RSA private key from |len|
350 * bytes at |*inp|. If |out| is not NULL then, on exit, a pointer to the result
351 * is in |*out|. If |*out| is already non-NULL on entry then the result is
352 * written directly into |*out|, otherwise a fresh |RSA| is allocated. On
353 * successful exit, |*inp| is advanced past the DER structure. It returns the
354 * result or NULL on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700355OPENSSL_EXPORT RSA *d2i_RSAPrivateKey(RSA **out, const uint8_t **inp, long len);
Adam Langley95c29f32014-06-20 12:00:00 -0700356
357/* i2d_RSAPrivateKey marshals |in| to an ASN.1, DER structure. If |outp| is not
358 * NULL then the result is written to |*outp| and |*outp| is advanced just past
359 * the output. It returns the number of bytes in the result, whether written or
360 * not, or a negative value on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700361OPENSSL_EXPORT int i2d_RSAPrivateKey(const RSA *in, uint8_t **outp);
Adam Langley95c29f32014-06-20 12:00:00 -0700362
363
364/* ex_data functions.
365 *
David Benjamin546f1a52015-04-15 16:46:09 -0400366 * See |ex_data.h| for details. */
Adam Langley95c29f32014-06-20 12:00:00 -0700367
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700368OPENSSL_EXPORT int RSA_get_ex_new_index(long argl, void *argp,
369 CRYPTO_EX_new *new_func,
370 CRYPTO_EX_dup *dup_func,
371 CRYPTO_EX_free *free_func);
372OPENSSL_EXPORT int RSA_set_ex_data(RSA *r, int idx, void *arg);
373OPENSSL_EXPORT void *RSA_get_ex_data(const RSA *r, int idx);
Adam Langley95c29f32014-06-20 12:00:00 -0700374
David Benjaminecc0ce72014-07-18 18:39:42 -0400375/* RSA_FLAG_OPAQUE specifies that this RSA_METHOD does not expose its key
376 * material. This may be set if, for instance, it is wrapping some other crypto
377 * API, like a platform key store. */
378#define RSA_FLAG_OPAQUE 1
Adam Langley95c29f32014-06-20 12:00:00 -0700379
380/* RSA_FLAG_CACHE_PUBLIC causes a precomputed Montgomery context to be created,
381 * on demand, for the public key operations. */
382#define RSA_FLAG_CACHE_PUBLIC 2
383
384/* RSA_FLAG_CACHE_PRIVATE causes a precomputed Montgomery context to be
385 * created, on demand, for the private key operations. */
386#define RSA_FLAG_CACHE_PRIVATE 4
387
388/* RSA_FLAG_NO_BLINDING disables blinding of private operations. */
389#define RSA_FLAG_NO_BLINDING 8
390
391/* RSA_FLAG_EXT_PKEY means that private key operations will be handled by
392 * |mod_exp| and that they do not depend on the private key components being
393 * present: for example a key stored in external hardware. */
394#define RSA_FLAG_EXT_PKEY 0x20
395
396/* RSA_FLAG_SIGN_VER causes the |sign| and |verify| functions of |rsa_meth_st|
397 * to be called when set. */
398#define RSA_FLAG_SIGN_VER 0x40
399
400
401/* RSA public exponent values. */
402
403#define RSA_3 0x3
404#define RSA_F4 0x10001
405
406
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700407/* Deprecated functions. */
408
409/* RSA_blinding_on returns one. */
410OPENSSL_EXPORT int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
411
412
Adam Langley95c29f32014-06-20 12:00:00 -0700413struct rsa_meth_st {
414 struct openssl_method_common_st common;
415
416 void *app_data;
417
418 int (*init)(RSA *rsa);
419 int (*finish)(RSA *rsa);
420
David Benjamin925fee32014-07-11 14:14:08 -0400421 /* size returns the size of the RSA modulus in bytes. */
422 size_t (*size)(const RSA *rsa);
423
Adam Langley95c29f32014-06-20 12:00:00 -0700424 int (*sign)(int type, const uint8_t *m, unsigned int m_length,
425 uint8_t *sigret, unsigned int *siglen, const RSA *rsa);
426
427 int (*verify)(int dtype, const uint8_t *m, unsigned int m_length,
428 const uint8_t *sigbuf, unsigned int siglen, const RSA *rsa);
429
430
431 /* These functions mirror the |RSA_*| functions of the same name. */
432 int (*encrypt)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
433 const uint8_t *in, size_t in_len, int padding);
434 int (*sign_raw)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
435 const uint8_t *in, size_t in_len, int padding);
436
437 int (*decrypt)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
438 const uint8_t *in, size_t in_len, int padding);
439 int (*verify_raw)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
440 const uint8_t *in, size_t in_len, int padding);
441
Adam Langley6bc658d2014-08-18 13:29:45 -0700442 /* private_transform takes a big-endian integer from |in|, calculates the
443 * d'th power of it, modulo the RSA modulus and writes the result as a
444 * big-endian integer to |out|. Both |in| and |out| are |len| bytes long and
445 * |len| is always equal to |RSA_size(rsa)|. If the result of the transform
446 * can be represented in fewer than |len| bytes, then |out| must be zero
447 * padded on the left.
448 *
449 * It returns one on success and zero otherwise.
450 *
451 * RSA decrypt and sign operations will call this, thus an ENGINE might wish
452 * to override it in order to avoid having to implement the padding
453 * functionality demanded by those, higher level, operations. */
454 int (*private_transform)(RSA *rsa, uint8_t *out, const uint8_t *in,
455 size_t len);
456
Adam Langley95c29f32014-06-20 12:00:00 -0700457 int (*mod_exp)(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
458 BN_CTX *ctx); /* Can be null */
459 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
460 const BIGNUM *m, BN_CTX *ctx,
461 BN_MONT_CTX *m_ctx);
462
463 int flags;
464
465 int (*keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
David Benjaminc20febe2014-11-11 23:47:50 -0500466
Adam Langley839b8812015-05-26 11:36:46 -0700467 int (*multi_prime_keygen)(RSA *rsa, int bits, int num_primes, BIGNUM *e,
468 BN_GENCB *cb);
469
David Benjaminc20febe2014-11-11 23:47:50 -0500470 /* supports_digest returns one if |rsa| supports digests of type
471 * |md|. If null, it is assumed that all digests are supported. */
472 int (*supports_digest)(const RSA *rsa, const EVP_MD *md);
Adam Langley95c29f32014-06-20 12:00:00 -0700473};
474
475
476/* Private functions. */
477
478typedef struct bn_blinding_st BN_BLINDING;
479
480struct rsa_st {
481 /* version is only used during ASN.1 (de)serialisation. */
482 long version;
483 RSA_METHOD *meth;
484
485 BIGNUM *n;
486 BIGNUM *e;
487 BIGNUM *d;
488 BIGNUM *p;
489 BIGNUM *q;
490 BIGNUM *dmp1;
491 BIGNUM *dmq1;
492 BIGNUM *iqmp;
Adam Langley839b8812015-05-26 11:36:46 -0700493
494 STACK_OF(RSA_additional_prime) *additional_primes;
495
Adam Langley95c29f32014-06-20 12:00:00 -0700496 /* be careful using this if the RSA structure is shared */
497 CRYPTO_EX_DATA ex_data;
Adam Langley0da323a2015-05-15 12:49:30 -0700498 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -0700499 int flags;
500
Adam Langley683d7bd2015-04-13 11:04:14 -0700501 CRYPTO_MUTEX lock;
502
503 /* Used to cache montgomery values. The creation of these values is protected
504 * by |lock|. */
Adam Langley95c29f32014-06-20 12:00:00 -0700505 BN_MONT_CTX *_method_mod_n;
506 BN_MONT_CTX *_method_mod_p;
507 BN_MONT_CTX *_method_mod_q;
508
509 /* num_blindings contains the size of the |blindings| and |blindings_inuse|
510 * arrays. This member and the |blindings_inuse| array are protected by
Adam Langley683d7bd2015-04-13 11:04:14 -0700511 * |lock|. */
Adam Langley95c29f32014-06-20 12:00:00 -0700512 unsigned num_blindings;
513 /* blindings is an array of BN_BLINDING structures that can be reserved by a
Adam Langley683d7bd2015-04-13 11:04:14 -0700514 * thread by locking |lock| and changing the corresponding element in
515 * |blindings_inuse| from 0 to 1. */
Adam Langley95c29f32014-06-20 12:00:00 -0700516 BN_BLINDING **blindings;
517 unsigned char *blindings_inuse;
518};
519
520
521#if defined(__cplusplus)
522} /* extern C */
523#endif
524
David Benjamin689be0f2015-02-11 15:55:26 -0500525#define RSA_F_BN_BLINDING_convert_ex 100
526#define RSA_F_BN_BLINDING_create_param 101
527#define RSA_F_BN_BLINDING_invert_ex 102
528#define RSA_F_BN_BLINDING_new 103
529#define RSA_F_BN_BLINDING_update 104
530#define RSA_F_RSA_check_key 105
531#define RSA_F_RSA_new_method 106
532#define RSA_F_RSA_padding_add_PKCS1_OAEP_mgf1 107
533#define RSA_F_RSA_padding_add_PKCS1_PSS_mgf1 108
534#define RSA_F_RSA_padding_add_PKCS1_type_1 109
535#define RSA_F_RSA_padding_add_PKCS1_type_2 110
536#define RSA_F_RSA_padding_add_none 111
537#define RSA_F_RSA_padding_check_PKCS1_OAEP_mgf1 112
538#define RSA_F_RSA_padding_check_PKCS1_type_1 113
539#define RSA_F_RSA_padding_check_PKCS1_type_2 114
540#define RSA_F_RSA_padding_check_none 115
541#define RSA_F_RSA_recover_crt_params 116
542#define RSA_F_RSA_sign 117
543#define RSA_F_RSA_verify 118
544#define RSA_F_RSA_verify_PKCS1_PSS_mgf1 119
545#define RSA_F_decrypt 120
546#define RSA_F_encrypt 121
547#define RSA_F_keygen 122
David Benjaminb0acb772015-05-28 16:53:31 -0400548#define RSA_F_RSA_add_pkcs1_prefix 123
David Benjamin689be0f2015-02-11 15:55:26 -0500549#define RSA_F_private_transform 124
550#define RSA_F_rsa_setup_blinding 125
551#define RSA_F_sign_raw 126
552#define RSA_F_verify_raw 127
Adam Langley839b8812015-05-26 11:36:46 -0700553#define RSA_F_keygen_multiprime 128
David Benjamin689be0f2015-02-11 15:55:26 -0500554#define RSA_R_BAD_E_VALUE 100
555#define RSA_R_BAD_FIXED_HEADER_DECRYPT 101
556#define RSA_R_BAD_PAD_BYTE_COUNT 102
557#define RSA_R_BAD_RSA_PARAMETERS 103
558#define RSA_R_BAD_SIGNATURE 104
559#define RSA_R_BLOCK_TYPE_IS_NOT_01 105
560#define RSA_R_BN_NOT_INITIALIZED 106
561#define RSA_R_CRT_PARAMS_ALREADY_GIVEN 107
562#define RSA_R_CRT_VALUES_INCORRECT 108
563#define RSA_R_DATA_LEN_NOT_EQUAL_TO_MOD_LEN 109
564#define RSA_R_DATA_TOO_LARGE 110
565#define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 111
566#define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 112
567#define RSA_R_DATA_TOO_SMALL 113
568#define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 114
569#define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 115
570#define RSA_R_D_E_NOT_CONGRUENT_TO_1 116
571#define RSA_R_EMPTY_PUBLIC_KEY 117
572#define RSA_R_FIRST_OCTET_INVALID 118
573#define RSA_R_INCONSISTENT_SET_OF_CRT_VALUES 119
574#define RSA_R_INTERNAL_ERROR 120
575#define RSA_R_INVALID_MESSAGE_LENGTH 121
576#define RSA_R_KEY_SIZE_TOO_SMALL 122
577#define RSA_R_LAST_OCTET_INVALID 123
578#define RSA_R_MODULUS_TOO_LARGE 124
579#define RSA_R_NO_PUBLIC_EXPONENT 125
580#define RSA_R_NULL_BEFORE_BLOCK_MISSING 126
581#define RSA_R_N_NOT_EQUAL_P_Q 127
582#define RSA_R_OAEP_DECODING_ERROR 128
583#define RSA_R_ONLY_ONE_OF_P_Q_GIVEN 129
584#define RSA_R_OUTPUT_BUFFER_TOO_SMALL 130
585#define RSA_R_PADDING_CHECK_FAILED 131
586#define RSA_R_PKCS_DECODING_ERROR 132
587#define RSA_R_SLEN_CHECK_FAILED 133
588#define RSA_R_SLEN_RECOVERY_FAILED 134
589#define RSA_R_TOO_LONG 135
590#define RSA_R_TOO_MANY_ITERATIONS 136
591#define RSA_R_UNKNOWN_ALGORITHM_TYPE 137
592#define RSA_R_UNKNOWN_PADDING_TYPE 138
Adam Langley05b73772014-07-25 12:03:51 -0700593#define RSA_R_VALUE_MISSING 139
David Benjamin689be0f2015-02-11 15:55:26 -0500594#define RSA_R_WRONG_SIGNATURE_LENGTH 140
Adam Langley839b8812015-05-26 11:36:46 -0700595#define RSA_R_MUST_HAVE_AT_LEAST_TWO_PRIMES 141
596#define RSA_R_CANNOT_RECOVER_MULTI_PRIME_KEY 142
Adam Langley95c29f32014-06-20 12:00:00 -0700597
598#endif /* OPENSSL_HEADER_RSA_H */