Debian Codegraph @

external/boringssl/include/openssl/rsa.h

raw
1 /* Copyright (C) 1995-1998 Eric Young ([email protected])
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young ([email protected]).
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 ([email protected]).
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 ([email protected])"
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 ([email protected])"
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>
64 #include <openssl/thread.h>
65
66 #if defined(__cplusplus)
67 extern "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. */
77 OPENSSL_EXPORT RSA *RSA_new(void);
78
79 /* RSA_new_method acts the same as |RSA_new| but takes an explicit |ENGINE|. */
80 OPENSSL_EXPORT RSA *RSA_new_method(const ENGINE *engine);
81
82 /* RSA_free decrements the reference count of |rsa| and frees it if the
83 * reference count drops to zero. */
84 OPENSSL_EXPORT void RSA_free(RSA *rsa);
85
86 /* RSA_up_ref increments the reference count of |rsa|. */
87 OPENSSL_EXPORT int RSA_up_ref(RSA *rsa);
88
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
97 * with event=3 when a suitable value for |p| is found.
98 *
99 * It returns one on success or zero on error. */
100 OPENSSL_EXPORT int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e,
101 BN_GENCB *cb);
102
103 /* RSA_generate_multi_prime_key acts like |RSA_generate_key_ex| but can
104 * generate an RSA private key with more than two primes. */
105 OPENSSL_EXPORT int RSA_generate_multi_prime_key(RSA *rsa, int bits,
106 int num_primes, BIGNUM *e,
107 BN_GENCB *cb);
108
109
110 /* Encryption / Decryption */
111
112 /* Padding types for encryption. */
113 #define RSA_PKCS1_PADDING 1
114 #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, use |RSA_PKCS1_OAEP_PADDING| for new protocols but
127 * |RSA_PKCS1_PADDING| is most common. */
128 OPENSSL_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);
131
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, use |RSA_PKCS1_OAEP_PADDING| for new protocols.
140 *
141 * Passing |RSA_PKCS1_PADDING| into this function is deprecated and insecure. If
142 * implementing a protocol using RSAES-PKCS1-V1_5, use |RSA_NO_PADDING| and then
143 * check padding in constant-time combined with a swap to a random session key
144 * or other mitigation. See "Chosen Ciphertext Attacks Against Protocols Based
145 * on the RSA Encryption Standard PKCS #1", Daniel Bleichenbacher, Advances in
146 * Cryptology (Crypto '98). */
147 OPENSSL_EXPORT int RSA_decrypt(RSA *rsa, size_t *out_len, uint8_t *out,
148 size_t max_out, const uint8_t *in, size_t in_len,
149 int padding);
150
151 /* RSA_public_encrypt encrypts |flen| bytes from |from| to the public key in
152 * |rsa| and writes the encrypted data to |to|. The |to| buffer must have at
153 * least |RSA_size| bytes of space. It returns the number of bytes written, or
154 * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING|
155 * values. If in doubt, use |RSA_PKCS1_OAEP_PADDING| for new protocols but
156 * |RSA_PKCS1_PADDING| is most common.
157 *
158 * WARNING: this function is dangerous because it breaks the usual return value
159 * convention. Use |RSA_encrypt| instead. */
160 OPENSSL_EXPORT int RSA_public_encrypt(size_t flen, const uint8_t *from,
161 uint8_t *to, RSA *rsa, int padding);
162
163 /* RSA_private_decrypt decrypts |flen| bytes from |from| with the public key in
164 * |rsa| and writes the plaintext to |to|. The |to| buffer must have at least
165 * |RSA_size| bytes of space. It returns the number of bytes written, or -1 on
166 * error. The |padding| argument must be one of the |RSA_*_PADDING| values. If
167 * in doubt, use |RSA_PKCS1_OAEP_PADDING| for new protocols. Passing
168 * |RSA_PKCS1_PADDING| into this function is deprecated and insecure. See
169 * |RSA_decrypt|.
170 *
171 * WARNING: this function is dangerous because it breaks the usual return value
172 * convention. Use |RSA_decrypt| instead. */
173 OPENSSL_EXPORT int RSA_private_decrypt(size_t flen, const uint8_t *from,
174 uint8_t *to, RSA *rsa, int padding);
175
176
177 /* Signing / Verification */
178
179 /* RSA_sign signs |in_len| bytes of digest from |in| with |rsa| using
180 * RSASSA-PKCS1-v1_5. It writes, at most, |RSA_size(rsa)| bytes to |out|. On
181 * successful return, the actual number of bytes written is written to
182 * |*out_len|.
183 *
184 * The |hash_nid| argument identifies the hash function used to calculate |in|
185 * and is embedded in the resulting signature. For example, it might be
186 * |NID_sha256|.
187 *
188 * It returns 1 on success and zero on error. */
189 OPENSSL_EXPORT int RSA_sign(int hash_nid, const uint8_t *in,
190 unsigned int in_len, uint8_t *out,
191 unsigned int *out_len, RSA *rsa);
192
193 /* RSA_sign_raw signs |in_len| bytes from |in| with the public key from |rsa|
194 * and writes, at most, |max_out| bytes of signature data to |out|. The
195 * |max_out| argument must be, at least, |RSA_size| in order to ensure success.
196 *
197 * It returns 1 on success or zero on error.
198 *
199 * The |padding| argument must be one of the |RSA_*_PADDING| values. If in
200 * doubt, |RSA_PKCS1_PADDING| is the most common but |RSA_PKCS1_PSS_PADDING|
201 * (via the |EVP_PKEY| interface) is preferred for new protocols. */
202 OPENSSL_EXPORT int RSA_sign_raw(RSA *rsa, size_t *out_len, uint8_t *out,
203 size_t max_out, const uint8_t *in,
204 size_t in_len, int padding);
205
206 /* RSA_verify verifies that |sig_len| bytes from |sig| are a valid,
207 * RSASSA-PKCS1-v1_5 signature of |msg_len| bytes at |msg| by |rsa|.
208 *
209 * The |hash_nid| argument identifies the hash function used to calculate |in|
210 * and is embedded in the resulting signature in order to prevent hash
211 * confusion attacks. For example, it might be |NID_sha256|.
212 *
213 * It returns one if the signature is valid and zero otherwise.
214 *
215 * WARNING: this differs from the original, OpenSSL function which additionally
216 * returned -1 on error. */
217 OPENSSL_EXPORT int RSA_verify(int hash_nid, const uint8_t *msg, size_t msg_len,
218 const uint8_t *sig, size_t sig_len, RSA *rsa);
219
220 /* RSA_verify_raw verifies |in_len| bytes of signature from |in| using the
221 * public key from |rsa| and writes, at most, |max_out| bytes of plaintext to
222 * |out|. The |max_out| argument must be, at least, |RSA_size| in order to
223 * ensure success.
224 *
225 * It returns 1 on success or zero on error.
226 *
227 * The |padding| argument must be one of the |RSA_*_PADDING| values. If in
228 * doubt, |RSA_PKCS1_PADDING| is the most common but |RSA_PKCS1_PSS_PADDING|
229 * (via the |EVP_PKEY| interface) is preferred for new protocols. */
230 OPENSSL_EXPORT int RSA_verify_raw(RSA *rsa, size_t *out_len, uint8_t *out,
231 size_t max_out, const uint8_t *in,
232 size_t in_len, int padding);
233
234 /* RSA_private_encrypt encrypts |flen| bytes from |from| with the private key in
235 * |rsa| and writes the encrypted data to |to|. The |to| buffer must have at
236 * least |RSA_size| bytes of space. It returns the number of bytes written, or
237 * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING|
238 * values. If in doubt, |RSA_PKCS1_PADDING| is the most common but
239 * |RSA_PKCS1_PSS_PADDING| (via the |EVP_PKEY| interface) is preferred for new
240 * protocols.
241 *
242 * WARNING: this function is dangerous because it breaks the usual return value
243 * convention. Use |RSA_sign_raw| instead. */
244 OPENSSL_EXPORT int RSA_private_encrypt(size_t flen, const uint8_t *from,
245 uint8_t *to, RSA *rsa, int padding);
246
247 /* RSA_public_decrypt verifies |flen| bytes of signature from |from| using the
248 * public key in |rsa| and writes the plaintext to |to|. The |to| buffer must
249 * have at least |RSA_size| bytes of space. It returns the number of bytes
250 * written, or -1 on error. The |padding| argument must be one of the
251 * |RSA_*_PADDING| values. If in doubt, |RSA_PKCS1_PADDING| is the most common
252 * but |RSA_PKCS1_PSS_PADDING| (via the |EVP_PKEY| interface) is preferred for
253 * new protocols.
254 *
255 * WARNING: this function is dangerous because it breaks the usual return value
256 * convention. Use |RSA_verify_raw| instead. */
257 OPENSSL_EXPORT int RSA_public_decrypt(size_t flen, const uint8_t *from,
258 uint8_t *to, RSA *rsa, int padding);
259
260
261 /* Utility functions. */
262
263 /* RSA_size returns the number of bytes in the modulus, which is also the size
264 * of a signature or encrypted value using |rsa|. */
265 OPENSSL_EXPORT unsigned RSA_size(const RSA *rsa);
266
267 /* RSA_is_opaque returns one if |rsa| is opaque and doesn't expose its key
268 * material. Otherwise it returns zero. */
269 OPENSSL_EXPORT int RSA_is_opaque(const RSA *rsa);
270
271 /* RSA_supports_digest returns one if |rsa| supports signing digests
272 * of type |md|. Otherwise it returns zero. */
273 OPENSSL_EXPORT int RSA_supports_digest(const RSA *rsa, const EVP_MD *md);
274
275 /* RSAPublicKey_dup allocates a fresh |RSA| and copies the public key from
276 * |rsa| into it. It returns the fresh |RSA| object, or NULL on error. */
277 OPENSSL_EXPORT RSA *RSAPublicKey_dup(const RSA *rsa);
278
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. */
281 OPENSSL_EXPORT RSA *RSAPrivateKey_dup(const RSA *rsa);
282
283 /* 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. */
286 OPENSSL_EXPORT int RSA_check_key(const RSA *rsa);
287
288 /* 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. */
293 OPENSSL_EXPORT int RSA_recover_crt_params(RSA *rsa);
294
295 /* 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. */
304 OPENSSL_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. */
318 OPENSSL_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
324 /* RSA_padding_add_PKCS1_OAEP_mgf1 writes an OAEP padding of |from| to |to|
325 * with the given parameters and hash functions. If |md| is NULL then SHA-1 is
326 * used. If |mgf1md| is NULL then the value of |md| is used (which means SHA-1
327 * if that, in turn, is NULL).
328 *
329 * It returns one on success or zero on error. */
330 OPENSSL_EXPORT int RSA_padding_add_PKCS1_OAEP_mgf1(
331 uint8_t *to, unsigned to_len, const uint8_t *from, unsigned from_len,
332 const uint8_t *param, unsigned param_len, const EVP_MD *md,
333 const EVP_MD *mgf1md);
334
335 /* RSA_add_pkcs1_prefix builds a version of |msg| prefixed with the DigestInfo
336 * header for the given hash function and sets |out_msg| to point to it. On
337 * successful return, |*out_msg| may be allocated memory and, if so,
338 * |*is_alloced| will be 1. */
339 OPENSSL_EXPORT int RSA_add_pkcs1_prefix(uint8_t **out_msg, size_t *out_msg_len,
340 int *is_alloced, int hash_nid,
341 const uint8_t *msg, size_t msg_len);
342
343
344 /* ASN.1 functions. */
345
346 /* RSA_parse_public_key parses a DER-encoded RSAPublicKey structure (RFC 3447)
347 * from |cbs| and advances |cbs|. It returns a newly-allocated |RSA| or NULL on
348 * error. */
349 OPENSSL_EXPORT RSA *RSA_parse_public_key(CBS *cbs);
350
351 /* RSA_parse_public_key_buggy behaves like |RSA_parse_public_key|, but it
352 * tolerates some invalid encodings. Do not use this function. */
353 OPENSSL_EXPORT RSA *RSA_parse_public_key_buggy(CBS *cbs);
354
355 /* RSA_public_key_from_bytes parses |in| as a DER-encoded RSAPublicKey structure
356 * (RFC 3447). It returns a newly-allocated |RSA| or NULL on error. */
357 OPENSSL_EXPORT RSA *RSA_public_key_from_bytes(const uint8_t *in, size_t in_len);
358
359 /* RSA_marshal_public_key marshals |rsa| as a DER-encoded RSAPublicKey structure
360 * (RFC 3447) and appends the result to |cbb|. It returns one on success and
361 * zero on failure. */
362 OPENSSL_EXPORT int RSA_marshal_public_key(CBB *cbb, const RSA *rsa);
363
364 /* RSA_public_key_to_bytes marshals |rsa| as a DER-encoded RSAPublicKey
365 * structure (RFC 3447) and, on success, sets |*out_bytes| to a newly allocated
366 * buffer containing the result and returns one. Otherwise, it returns zero. The
367 * result should be freed with |OPENSSL_free|. */
368 OPENSSL_EXPORT int RSA_public_key_to_bytes(uint8_t **out_bytes, size_t *out_len,
369 const RSA *rsa);
370
371 /* RSA_parse_private_key parses a DER-encoded RSAPrivateKey structure (RFC 3447)
372 * from |cbs| and advances |cbs|. It returns a newly-allocated |RSA| or NULL on
373 * error. */
374 OPENSSL_EXPORT RSA *RSA_parse_private_key(CBS *cbs);
375
376 /* RSA_private_key_from_bytes parses |in| as a DER-encoded RSAPrivateKey
377 * structure (RFC 3447). It returns a newly-allocated |RSA| or NULL on error. */
378 OPENSSL_EXPORT RSA *RSA_private_key_from_bytes(const uint8_t *in,
379 size_t in_len);
380
381 /* RSA_marshal_private_key marshals |rsa| as a DER-encoded RSAPrivateKey
382 * structure (RFC 3447) and appends the result to |cbb|. It returns one on
383 * success and zero on failure. */
384 OPENSSL_EXPORT int RSA_marshal_private_key(CBB *cbb, const RSA *rsa);
385
386 /* RSA_private_key_to_bytes marshals |rsa| as a DER-encoded RSAPrivateKey
387 * structure (RFC 3447) and, on success, sets |*out_bytes| to a newly allocated
388 * buffer containing the result and returns one. Otherwise, it returns zero. The
389 * result should be freed with |OPENSSL_free|. */
390 OPENSSL_EXPORT int RSA_private_key_to_bytes(uint8_t **out_bytes,
391 size_t *out_len, const RSA *rsa);
392
393
394 /* ex_data functions.
395 *
396 * See |ex_data.h| for details. */
397
398 OPENSSL_EXPORT int RSA_get_ex_new_index(long argl, void *argp,
399 CRYPTO_EX_unused *unused,
400 CRYPTO_EX_dup *dup_func,
401 CRYPTO_EX_free *free_func);
402 OPENSSL_EXPORT int RSA_set_ex_data(RSA *r, int idx, void *arg);
403 OPENSSL_EXPORT void *RSA_get_ex_data(const RSA *r, int idx);
404
405
406 /* Flags. */
407
408 /* RSA_FLAG_OPAQUE specifies that this RSA_METHOD does not expose its key
409 * material. This may be set if, for instance, it is wrapping some other crypto
410 * API, like a platform key store. */
411 #define RSA_FLAG_OPAQUE 1
412
413 /* Deprecated and ignored. */
414 #define RSA_FLAG_CACHE_PUBLIC 2
415
416 /* Deprecated and ignored. */
417 #define RSA_FLAG_CACHE_PRIVATE 4
418
419 /* RSA_FLAG_NO_BLINDING disables blinding of private operations, which is a
420 * dangerous thing to do. It is deprecated and should not be used. It will
421 * be ignored whenever possible.
422 *
423 * This flag must be used if a key without the public exponent |e| is used for
424 * private key operations; avoid using such keys whenever possible. */
425 #define RSA_FLAG_NO_BLINDING 8
426
427 /* RSA_FLAG_EXT_PKEY is deprecated and ignored. */
428 #define RSA_FLAG_EXT_PKEY 0x20
429
430 /* RSA_FLAG_SIGN_VER causes the |sign| and |verify| functions of |rsa_meth_st|
431 * to be called when set. */
432 #define RSA_FLAG_SIGN_VER 0x40
433
434
435 /* RSA public exponent values. */
436
437 #define RSA_3 0x3
438 #define RSA_F4 0x10001
439
440
441 /* Deprecated functions. */
442
443 /* RSA_blinding_on returns one. */
444 OPENSSL_EXPORT int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
445
446 /* RSA_generate_key behaves like |RSA_generate_key_ex|, which is what you
447 * should use instead. It returns NULL on error, or a newly-allocated |RSA| on
448 * success. This function is provided for compatibility only. The |callback|
449 * and |cb_arg| parameters must be NULL. */
450 OPENSSL_EXPORT RSA *RSA_generate_key(int bits, unsigned long e, void *callback,
451 void *cb_arg);
452
453 /* d2i_RSAPublicKey parses an ASN.1, DER-encoded, RSA public key from |len|
454 * bytes at |*inp|. If |out| is not NULL then, on exit, a pointer to the result
455 * is in |*out|. Note that, even if |*out| is already non-NULL on entry, it
456 * will not be written to. Rather, a fresh |RSA| is allocated and the previous
457 * one is freed. On successful exit, |*inp| is advanced past the DER structure.
458 * It returns the result or NULL on error. */
459 OPENSSL_EXPORT RSA *d2i_RSAPublicKey(RSA **out, const uint8_t **inp, long len);
460
461 /* i2d_RSAPublicKey marshals |in| to an ASN.1, DER structure. If |outp| is not
462 * NULL then the result is written to |*outp| and |*outp| is advanced just past
463 * the output. It returns the number of bytes in the result, whether written or
464 * not, or a negative value on error. */
465 OPENSSL_EXPORT int i2d_RSAPublicKey(const RSA *in, uint8_t **outp);
466
467 /* d2i_RSAPrivateKey parses an ASN.1, DER-encoded, RSA private key from |len|
468 * bytes at |*inp|. If |out| is not NULL then, on exit, a pointer to the result
469 * is in |*out|. Note that, even if |*out| is already non-NULL on entry, it
470 * will not be written to. Rather, a fresh |RSA| is allocated and the previous
471 * one is freed. On successful exit, |*inp| is advanced past the DER structure.
472 * It returns the result or NULL on error. */
473 OPENSSL_EXPORT RSA *d2i_RSAPrivateKey(RSA **out, const uint8_t **inp, long len);
474
475 /* i2d_RSAPrivateKey marshals |in| to an ASN.1, DER structure. If |outp| is not
476 * NULL then the result is written to |*outp| and |*outp| is advanced just past
477 * the output. It returns the number of bytes in the result, whether written or
478 * not, or a negative value on error. */
479 OPENSSL_EXPORT int i2d_RSAPrivateKey(const RSA *in, uint8_t **outp);
480
481 /* RSA_padding_add_PKCS1_PSS acts like |RSA_padding_add_PKCS1_PSS_mgf1| but the
482 * |mgf1Hash| parameter of the latter is implicitly set to |Hash|. */
483 OPENSSL_EXPORT int RSA_padding_add_PKCS1_PSS(RSA *rsa, uint8_t *EM,
484 const uint8_t *mHash,
485 const EVP_MD *Hash, int sLen);
486
487 /* RSA_verify_PKCS1_PSS acts like |RSA_verify_PKCS1_PSS_mgf1| but the
488 * |mgf1Hash| parameter of the latter is implicitly set to |Hash|. */
489 OPENSSL_EXPORT int RSA_verify_PKCS1_PSS(RSA *rsa, const uint8_t *mHash,
490 const EVP_MD *Hash, const uint8_t *EM,
491 int sLen);
492
493 /* RSA_padding_add_PKCS1_OAEP acts like |RSA_padding_add_PKCS1_OAEP_mgf1| but
494 * the |md| and |mgf1md| paramaters of the latter are implicitly set to NULL,
495 * which means SHA-1. */
496 OPENSSL_EXPORT int RSA_padding_add_PKCS1_OAEP(uint8_t *to, unsigned to_len,
497 const uint8_t *from,
498 unsigned from_len,
499 const uint8_t *param,
500 unsigned param_len);
501
502
503 struct rsa_meth_st {
504 struct openssl_method_common_st common;
505
506 void *app_data;
507
508 int (*init)(RSA *rsa);
509 int (*finish)(RSA *rsa);
510
511 /* size returns the size of the RSA modulus in bytes. */
512 size_t (*size)(const RSA *rsa);
513
514 int (*sign)(int type, const uint8_t *m, unsigned int m_length,
515 uint8_t *sigret, unsigned int *siglen, const RSA *rsa);
516
517 /* Ignored. Set this to NULL. */
518 int (*verify)(int dtype, const uint8_t *m, unsigned int m_length,
519 const uint8_t *sigbuf, unsigned int siglen, const RSA *rsa);
520
521
522 /* These functions mirror the |RSA_*| functions of the same name. */
523 int (*encrypt)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
524 const uint8_t *in, size_t in_len, int padding);
525 int (*sign_raw)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
526 const uint8_t *in, size_t in_len, int padding);
527
528 int (*decrypt)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
529 const uint8_t *in, size_t in_len, int padding);
530 /* Ignored. Set this to NULL. */
531 int (*verify_raw)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out,
532 const uint8_t *in, size_t in_len, int padding);
533
534 /* private_transform takes a big-endian integer from |in|, calculates the
535 * d'th power of it, modulo the RSA modulus and writes the result as a
536 * big-endian integer to |out|. Both |in| and |out| are |len| bytes long and
537 * |len| is always equal to |RSA_size(rsa)|. If the result of the transform
538 * can be represented in fewer than |len| bytes, then |out| must be zero
539 * padded on the left.
540 *
541 * It returns one on success and zero otherwise.
542 *
543 * RSA decrypt and sign operations will call this, thus an ENGINE might wish
544 * to override it in order to avoid having to implement the padding
545 * functionality demanded by those, higher level, operations. */
546 int (*private_transform)(RSA *rsa, uint8_t *out, const uint8_t *in,
547 size_t len);
548
549 /* mod_exp is deprecated and ignored. Set it to NULL. */
550 int (*mod_exp)(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
551
552 /* bn_mod_exp is deprecated and ignored. Set it to NULL. */
553 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
554 const BIGNUM *m, BN_CTX *ctx,
555 const BN_MONT_CTX *mont);
556
557 int flags;
558
559 int (*keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
560
561 int (*multi_prime_keygen)(RSA *rsa, int bits, int num_primes, BIGNUM *e,
562 BN_GENCB *cb);
563
564 /* supports_digest returns one if |rsa| supports digests of type
565 * |md|. If null, it is assumed that all digests are supported. */
566 int (*supports_digest)(const RSA *rsa, const EVP_MD *md);
567 };
568
569
570 /* Private functions. */
571
572 typedef struct bn_blinding_st BN_BLINDING;
573
574 struct rsa_st {
575 RSA_METHOD *meth;
576
577 BIGNUM *n;
578 BIGNUM *e;
579 BIGNUM *d;
580 BIGNUM *p;
581 BIGNUM *q;
582 BIGNUM *dmp1;
583 BIGNUM *dmq1;
584 BIGNUM *iqmp;
585
586 STACK_OF(RSA_additional_prime) *additional_primes;
587
588 /* be careful using this if the RSA structure is shared */
589 CRYPTO_EX_DATA ex_data;
590 CRYPTO_refcount_t references;
591 int flags;
592
593 CRYPTO_MUTEX lock;
594
595 /* Used to cache montgomery values. The creation of these values is protected
596 * by |lock|. */
597 BN_MONT_CTX *mont_n;
598 BN_MONT_CTX *mont_p;
599 BN_MONT_CTX *mont_q;
600
601 /* num_blindings contains the size of the |blindings| and |blindings_inuse|
602 * arrays. This member and the |blindings_inuse| array are protected by
603 * |lock|. */
604 unsigned num_blindings;
605 /* blindings is an array of BN_BLINDING structures that can be reserved by a
606 * thread by locking |lock| and changing the corresponding element in
607 * |blindings_inuse| from 0 to 1. */
608 BN_BLINDING **blindings;
609 unsigned char *blindings_inuse;
610 };
611
612
613 #if defined(__cplusplus)
614 } /* extern C */
615 #endif
616
617 #define RSA_R_BAD_ENCODING 100
618 #define RSA_R_BAD_E_VALUE 101
619 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
620 #define RSA_R_BAD_PAD_BYTE_COUNT 103
621 #define RSA_R_BAD_RSA_PARAMETERS 104
622 #define RSA_R_BAD_SIGNATURE 105
623 #define RSA_R_BAD_VERSION 106
624 #define RSA_R_BLOCK_TYPE_IS_NOT_01 107
625 #define RSA_R_BN_NOT_INITIALIZED 108
626 #define RSA_R_CANNOT_RECOVER_MULTI_PRIME_KEY 109
627 #define RSA_R_CRT_PARAMS_ALREADY_GIVEN 110
628 #define RSA_R_CRT_VALUES_INCORRECT 111
629 #define RSA_R_DATA_LEN_NOT_EQUAL_TO_MOD_LEN 112
630 #define RSA_R_DATA_TOO_LARGE 113
631 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 114
632 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 115
633 #define RSA_R_DATA_TOO_SMALL 116
634 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 117
635 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 118
636 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 119
637 #define RSA_R_EMPTY_PUBLIC_KEY 120
638 #define RSA_R_ENCODE_ERROR 121
639 #define RSA_R_FIRST_OCTET_INVALID 122
640 #define RSA_R_INCONSISTENT_SET_OF_CRT_VALUES 123
641 #define RSA_R_INTERNAL_ERROR 124
642 #define RSA_R_INVALID_MESSAGE_LENGTH 125
643 #define RSA_R_KEY_SIZE_TOO_SMALL 126
644 #define RSA_R_LAST_OCTET_INVALID 127
645 #define RSA_R_MODULUS_TOO_LARGE 128
646 #define RSA_R_MUST_HAVE_AT_LEAST_TWO_PRIMES 129
647 #define RSA_R_NO_PUBLIC_EXPONENT 130
648 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 131
649 #define RSA_R_N_NOT_EQUAL_P_Q 132
650 #define RSA_R_OAEP_DECODING_ERROR 133
651 #define RSA_R_ONLY_ONE_OF_P_Q_GIVEN 134
652 #define RSA_R_OUTPUT_BUFFER_TOO_SMALL 135
653 #define RSA_R_PADDING_CHECK_FAILED 136
654 #define RSA_R_PKCS_DECODING_ERROR 137
655 #define RSA_R_SLEN_CHECK_FAILED 138
656 #define RSA_R_SLEN_RECOVERY_FAILED 139
657 #define RSA_R_TOO_LONG 140
658 #define RSA_R_TOO_MANY_ITERATIONS 141
659 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 142
660 #define RSA_R_UNKNOWN_PADDING_TYPE 143
661 #define RSA_R_VALUE_MISSING 144
662 #define RSA_R_WRONG_SIGNATURE_LENGTH 145
663
664 #endif /* OPENSSL_HEADER_RSA_H */