Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1 | /* 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> |
| 64 | |
| 65 | #if defined(__cplusplus) |
| 66 | extern "C" { |
| 67 | #endif |
| 68 | |
| 69 | |
| 70 | /* rsa.h contains functions for handling encryption and signature using RSA. */ |
| 71 | |
| 72 | |
| 73 | /* Allocation and destruction. */ |
| 74 | |
| 75 | /* RSA_new returns a new, empty RSA object or NULL on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 76 | OPENSSL_EXPORT RSA *RSA_new(void); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 77 | |
Adam Langley | 389e3f0 | 2014-08-19 11:24:27 -0700 | [diff] [blame] | 78 | /* RSA_new_method acts the same as |RSA_new| but takes an explicit |ENGINE|. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 79 | OPENSSL_EXPORT RSA *RSA_new_method(const ENGINE *engine); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 80 | |
| 81 | /* RSA_free decrements the reference count of |rsa| and frees it if the |
| 82 | * reference count drops to zero. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 83 | OPENSSL_EXPORT void RSA_free(RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 84 | |
| 85 | /* RSA_up_ref increments the reference count of |rsa|. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 86 | OPENSSL_EXPORT int RSA_up_ref(RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 87 | |
| 88 | |
| 89 | /* Key generation. */ |
| 90 | |
| 91 | /* RSA_generate_key_ex generates a new RSA key where the modulus has size |
| 92 | * |bits| and the public exponent is |e|. If unsure, |RSA_F4| is a good value |
| 93 | * for |e|. If |cb| is not NULL then it is called during the key generation |
| 94 | * process. In addition to the calls documented for |BN_generate_prime_ex|, it |
| 95 | * is called with event=2 when the n'th prime is rejected as unsuitable and |
Adam Langley | 5129e2d | 2014-07-25 10:06:44 -0700 | [diff] [blame] | 96 | * with event=3 when a suitable value for |p| is found. |
| 97 | * |
| 98 | * It returns one on success or zero on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 99 | OPENSSL_EXPORT int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, |
| 100 | BN_GENCB *cb); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 101 | |
| 102 | |
| 103 | /* Encryption / Decryption */ |
| 104 | |
| 105 | /* Padding types for encryption. */ |
| 106 | #define RSA_PKCS1_PADDING 1 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 107 | #define RSA_NO_PADDING 3 |
| 108 | #define RSA_PKCS1_OAEP_PADDING 4 |
| 109 | /* RSA_PKCS1_PSS_PADDING can only be used via the EVP interface. */ |
| 110 | #define RSA_PKCS1_PSS_PADDING 6 |
| 111 | |
| 112 | /* RSA_encrypt encrypts |in_len| bytes from |in| to the public key from |rsa| |
| 113 | * and writes, at most, |max_out| bytes of encrypted data to |out|. The |
| 114 | * |max_out| argument must be, at least, |RSA_size| in order to ensure success. |
| 115 | * |
| 116 | * It returns 1 on success or zero on error. |
| 117 | * |
| 118 | * The |padding| argument must be one of the |RSA_*_PADDING| values. If in |
| 119 | * doubt, |RSA_PKCS1_PADDING| is the most common but |RSA_PKCS1_OAEP_PADDING| |
| 120 | * is the most secure. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 121 | OPENSSL_EXPORT int RSA_encrypt(RSA *rsa, size_t *out_len, uint8_t *out, |
| 122 | size_t max_out, const uint8_t *in, size_t in_len, |
| 123 | int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 124 | |
| 125 | /* RSA_decrypt decrypts |in_len| bytes from |in| with the private key from |
| 126 | * |rsa| and writes, at most, |max_out| bytes of plaintext to |out|. The |
| 127 | * |max_out| argument must be, at least, |RSA_size| in order to ensure success. |
| 128 | * |
| 129 | * It returns 1 on success or zero on error. |
| 130 | * |
| 131 | * The |padding| argument must be one of the |RSA_*_PADDING| values. If in |
| 132 | * doubt, |RSA_PKCS1_PADDING| is the most common but |RSA_PKCS1_OAEP_PADDING| |
| 133 | * is the most secure. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 134 | OPENSSL_EXPORT int RSA_decrypt(RSA *rsa, size_t *out_len, uint8_t *out, |
| 135 | size_t max_out, const uint8_t *in, size_t in_len, |
| 136 | int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 137 | |
| 138 | /* RSA_public_encrypt encrypts |flen| bytes from |from| to the public key in |
| 139 | * |rsa| and writes the encrypted data to |to|. The |to| buffer must have at |
| 140 | * least |RSA_size| bytes of space. It returns the number of bytes written, or |
| 141 | * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING| |
| 142 | * values. If in doubt, |RSA_PKCS1_PADDING| is the most common but |
| 143 | * |RSA_PKCS1_OAEP_PADDING| is the most secure. |
| 144 | * |
| 145 | * WARNING: this function is dangerous because it breaks the usual return value |
| 146 | * convention. Use |RSA_encrypt| instead. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 147 | OPENSSL_EXPORT int RSA_public_encrypt(int flen, const uint8_t *from, |
| 148 | uint8_t *to, RSA *rsa, int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 149 | |
| 150 | /* RSA_private_decrypt decrypts |flen| bytes from |from| with the public key in |
| 151 | * |rsa| and writes the plaintext to |to|. The |to| buffer must have at |
| 152 | * least |RSA_size| bytes of space. It returns the number of bytes written, or |
| 153 | * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING| |
| 154 | * values. If in doubt, |RSA_PKCS1_PADDING| is the most common but |
| 155 | * |RSA_PKCS1_OAEP_PADDING| is the most secure. |
| 156 | * |
| 157 | * WARNING: this function is dangerous because it breaks the usual return value |
| 158 | * convention. Use |RSA_decrypt| instead. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 159 | OPENSSL_EXPORT int RSA_private_decrypt(int flen, const uint8_t *from, |
| 160 | uint8_t *to, RSA *rsa, int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 161 | |
David Benjamin | 0aa0767 | 2014-07-24 15:34:14 -0400 | [diff] [blame] | 162 | /* RSA_message_index_PKCS1_type_2 performs the first step of a PKCS #1 padding |
| 163 | * check for decryption. If the |from_len| bytes pointed to at |from| are a |
| 164 | * valid PKCS #1 message, it returns one and sets |*out_index| to the start of |
| 165 | * the unpadded message. The unpadded message is a suffix of the input and has |
| 166 | * length |from_len - *out_index|. Otherwise, it returns zero and sets |
David Benjamin | c61517c | 2014-12-29 18:41:09 -0500 | [diff] [blame] | 167 | * |*out_index| to zero. This function runs in time independent of the input |
| 168 | * data and is intended to be used directly to avoid Bleichenbacher's attack. |
David Benjamin | 0aa0767 | 2014-07-24 15:34:14 -0400 | [diff] [blame] | 169 | * |
| 170 | * WARNING: This function behaves differently from the usual OpenSSL convention |
| 171 | * in that it does NOT put an error on the queue in the error case. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 172 | OPENSSL_EXPORT int RSA_message_index_PKCS1_type_2(const uint8_t *from, |
| 173 | size_t from_len, |
| 174 | size_t *out_index); |
David Benjamin | 0aa0767 | 2014-07-24 15:34:14 -0400 | [diff] [blame] | 175 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 176 | |
| 177 | /* Signing / Verification */ |
| 178 | |
| 179 | /* RSA_sign signs |in_len| bytes of digest from |in| with |rsa| and writes, at |
| 180 | * most, |RSA_size(rsa)| bytes to |out|. On successful return, the actual |
| 181 | * number of bytes written is written to |*out_len|. |
| 182 | * |
| 183 | * The |hash_nid| argument identifies the hash function used to calculate |in| |
| 184 | * and is embedded in the resulting signature. For example, it might be |
| 185 | * |NID_sha256|. |
| 186 | * |
| 187 | * It returns 1 on success and zero on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 188 | OPENSSL_EXPORT int RSA_sign(int hash_nid, const uint8_t *in, |
| 189 | unsigned int in_len, uint8_t *out, |
| 190 | unsigned int *out_len, RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 191 | |
| 192 | /* RSA_sign_raw signs |in_len| bytes from |in| with the public key from |rsa| |
| 193 | * and writes, at most, |max_out| bytes of encrypted data to |out|. The |
| 194 | * |max_out| argument must be, at least, |RSA_size| in order to ensure success. |
| 195 | * |
| 196 | * It returns 1 on success or zero on error. |
| 197 | * |
| 198 | * The |padding| argument must be one of the |RSA_*_PADDING| values. If in |
| 199 | * doubt, |RSA_PKCS1_PADDING| is the most common. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 200 | OPENSSL_EXPORT int RSA_sign_raw(RSA *rsa, size_t *out_len, uint8_t *out, |
| 201 | size_t max_out, const uint8_t *in, |
| 202 | size_t in_len, int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 203 | |
| 204 | /* RSA_verify verifies that |sig_len| bytes from |sig| are a valid, PKCS#1 |
| 205 | * signature of |msg_len| bytes at |msg| by |rsa|. |
| 206 | * |
| 207 | * The |hash_nid| argument identifies the hash function used to calculate |in| |
| 208 | * and is embedded in the resulting signature in order to prevent hash |
| 209 | * confusion attacks. For example, it might be |NID_sha256|. |
| 210 | * |
| 211 | * It returns one if the signature is valid and zero otherwise. |
| 212 | * |
| 213 | * WARNING: this differs from the original, OpenSSL function which additionally |
| 214 | * returned -1 on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 215 | OPENSSL_EXPORT int RSA_verify(int hash_nid, const uint8_t *msg, size_t msg_len, |
| 216 | const uint8_t *sig, size_t sig_len, RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 217 | |
| 218 | /* RSA_verify_raw verifies |in_len| bytes of signature from |in| using the |
| 219 | * public key from |rsa| and writes, at most, |max_out| bytes of plaintext to |
| 220 | * |out|. The |max_out| argument must be, at least, |RSA_size| in order to |
| 221 | * ensure success. |
| 222 | * |
| 223 | * It returns 1 on success or zero on error. |
| 224 | * |
| 225 | * The |padding| argument must be one of the |RSA_*_PADDING| values. If in |
| 226 | * doubt, |RSA_PKCS1_PADDING| is the most common. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 227 | OPENSSL_EXPORT int RSA_verify_raw(RSA *rsa, size_t *out_len, uint8_t *out, |
| 228 | size_t max_out, const uint8_t *in, |
| 229 | size_t in_len, int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 230 | |
| 231 | /* RSA_private_encrypt encrypts |flen| bytes from |from| with the private key in |
| 232 | * |rsa| and writes the encrypted data to |to|. The |to| buffer must have at |
| 233 | * least |RSA_size| bytes of space. It returns the number of bytes written, or |
| 234 | * -1 on error. The |padding| argument must be one of the |RSA_*_PADDING| |
| 235 | * values. If in doubt, |RSA_PKCS1_PADDING| is the most common. |
| 236 | * |
| 237 | * WARNING: this function is dangerous because it breaks the usual return value |
| 238 | * convention. Use |RSA_sign_raw| instead. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 239 | OPENSSL_EXPORT int RSA_private_encrypt(int flen, const uint8_t *from, |
| 240 | uint8_t *to, RSA *rsa, int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 241 | |
| 242 | /* RSA_private_encrypt verifies |flen| bytes of signature from |from| using the |
| 243 | * public key in |rsa| and writes the plaintext to |to|. The |to| buffer must |
| 244 | * have at least |RSA_size| bytes of space. It returns the number of bytes |
| 245 | * written, or -1 on error. The |padding| argument must be one of the |
| 246 | * |RSA_*_PADDING| values. If in doubt, |RSA_PKCS1_PADDING| is the most common. |
| 247 | * |
| 248 | * WARNING: this function is dangerous because it breaks the usual return value |
| 249 | * convention. Use |RSA_verify_raw| instead. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 250 | OPENSSL_EXPORT int RSA_public_decrypt(int flen, const uint8_t *from, |
| 251 | uint8_t *to, RSA *rsa, int padding); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 252 | |
| 253 | |
| 254 | /* Utility functions. */ |
| 255 | |
| 256 | /* RSA_size returns the number of bytes in the modulus, which is also the size |
| 257 | * of a signature of encrypted value using |rsa|. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 258 | OPENSSL_EXPORT unsigned RSA_size(const RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 259 | |
David Benjamin | ecc0ce7 | 2014-07-18 18:39:42 -0400 | [diff] [blame] | 260 | /* RSA_is_opaque returns one if |rsa| is opaque and doesn't expose its key |
David Benjamin | c20febe | 2014-11-11 23:47:50 -0500 | [diff] [blame] | 261 | * material. Otherwise it returns zero. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 262 | OPENSSL_EXPORT int RSA_is_opaque(const RSA *rsa); |
David Benjamin | ecc0ce7 | 2014-07-18 18:39:42 -0400 | [diff] [blame] | 263 | |
David Benjamin | c20febe | 2014-11-11 23:47:50 -0500 | [diff] [blame] | 264 | /* RSA_supports_digest returns one if |rsa| supports signing digests |
| 265 | * of type |md|. Otherwise it returns zero. */ |
| 266 | OPENSSL_EXPORT int RSA_supports_digest(const RSA *rsa, const EVP_MD *md); |
| 267 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 268 | /* RSAPublicKey_dup allocates a fresh |RSA| and copies the private key from |
| 269 | * |rsa| into it. It returns the fresh |RSA| object, or NULL on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 270 | OPENSSL_EXPORT RSA *RSAPublicKey_dup(const RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 271 | |
| 272 | /* RSAPrivateKey_dup allocates a fresh |RSA| and copies the private key from |
| 273 | * |rsa| into it. It returns the fresh |RSA| object, or NULL on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 274 | OPENSSL_EXPORT RSA *RSAPrivateKey_dup(const RSA *rsa); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 275 | |
Adam Langley | 05b7377 | 2014-07-25 12:03:51 -0700 | [diff] [blame] | 276 | /* RSA_check_key performs basic validatity tests on |rsa|. It returns one if |
| 277 | * they pass and zero otherwise. Opaque keys and public keys always pass. If it |
| 278 | * returns zero then a more detailed error is available on the error queue. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 279 | OPENSSL_EXPORT int RSA_check_key(const RSA *rsa); |
Adam Langley | 05b7377 | 2014-07-25 12:03:51 -0700 | [diff] [blame] | 280 | |
Adam Langley | 409766d | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 281 | /* RSA_recover_crt_params uses |rsa->n|, |rsa->d| and |rsa->e| in order to |
| 282 | * calculate the two primes used and thus the precomputed, CRT values. These |
| 283 | * values are set in the |p|, |q|, |dmp1|, |dmq1| and |iqmp| members of |rsa|, |
| 284 | * which must be |NULL| on entry. It returns one on success and zero |
| 285 | * otherwise. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 286 | OPENSSL_EXPORT int RSA_recover_crt_params(RSA *rsa); |
Adam Langley | 409766d | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 287 | |
Adam Langley | 20b64fd | 2015-03-20 16:39:54 -0700 | [diff] [blame^] | 288 | /* RSA_verify_PKCS1_PSS_mgf1 verifies that |EM| is a correct PSS padding of |
| 289 | * |mHash|, where |mHash| is a digest produced by |Hash|. |EM| must point to |
| 290 | * exactly |RSA_size(rsa)| bytes of data. The |mgf1Hash| argument specifies the |
| 291 | * hash function for generating the mask. If NULL, |Hash| is used. The |sLen| |
| 292 | * argument specifies the expected salt length in bytes. If |sLen| is -1 then |
| 293 | * the salt length is the same as the hash length. If -2, then the salt length |
| 294 | * is maximal and is taken from the size of |EM|. |
| 295 | * |
| 296 | * It returns one on success or zero on error. */ |
| 297 | OPENSSL_EXPORT int RSA_verify_PKCS1_PSS_mgf1(RSA *rsa, const uint8_t *mHash, |
| 298 | const EVP_MD *Hash, |
| 299 | const EVP_MD *mgf1Hash, |
| 300 | const uint8_t *EM, int sLen); |
| 301 | |
| 302 | /* RSA_padding_add_PKCS1_PSS_mgf1 writes a PSS padding of |mHash| to |EM|, |
| 303 | * where |mHash| is a digest produced by |Hash|. |RSA_size(rsa)| bytes of |
| 304 | * output will be written to |EM|. The |mgf1Hash| argument specifies the hash |
| 305 | * function for generating the mask. If NULL, |Hash| is used. The |sLen| |
| 306 | * argument specifies the expected salt length in bytes. If |sLen| is -1 then |
| 307 | * the salt length is the same as the hash length. If -2, then the salt length |
| 308 | * is maximal given the space in |EM|. |
| 309 | * |
| 310 | * It returns one on success or zero on error. */ |
| 311 | OPENSSL_EXPORT int RSA_padding_add_PKCS1_PSS_mgf1(RSA *rsa, uint8_t *EM, |
| 312 | const uint8_t *mHash, |
| 313 | const EVP_MD *Hash, |
| 314 | const EVP_MD *mgf1Hash, |
| 315 | int sLen); |
| 316 | |
| 317 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 318 | |
| 319 | /* ASN.1 functions. */ |
| 320 | |
| 321 | /* d2i_RSAPublicKey parses an ASN.1, DER-encoded, RSA public key from |len| |
| 322 | * bytes at |*inp|. If |out| is not NULL then, on exit, a pointer to the result |
| 323 | * is in |*out|. If |*out| is already non-NULL on entry then the result is |
| 324 | * written directly into |*out|, otherwise a fresh |RSA| is allocated. On |
| 325 | * successful exit, |*inp| is advanced past the DER structure. It returns the |
| 326 | * result or NULL on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 327 | OPENSSL_EXPORT RSA *d2i_RSAPublicKey(RSA **out, const uint8_t **inp, long len); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 328 | |
| 329 | /* i2d_RSAPublicKey marshals |in| to an ASN.1, DER structure. If |outp| is not |
| 330 | * NULL then the result is written to |*outp| and |*outp| is advanced just past |
| 331 | * the output. It returns the number of bytes in the result, whether written or |
| 332 | * not, or a negative value on error. */ |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 333 | OPENSSL_EXPORT int i2d_RSAPublicKey(const RSA *in, uint8_t **outp); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 334 | |
| 335 | /* d2i_RSAPrivateKey parses an ASN.1, DER-encoded, RSA private 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 Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 341 | OPENSSL_EXPORT RSA *d2i_RSAPrivateKey(RSA **out, const uint8_t **inp, long len); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 342 | |
| 343 | /* i2d_RSAPrivateKey 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 Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 347 | OPENSSL_EXPORT int i2d_RSAPrivateKey(const RSA *in, uint8_t **outp); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 348 | |
| 349 | |
| 350 | /* ex_data functions. |
| 351 | * |
| 352 | * These functions are wrappers. See |ex_data.h| for details. */ |
| 353 | |
Adam Langley | eb7d2ed | 2014-07-30 16:02:14 -0700 | [diff] [blame] | 354 | OPENSSL_EXPORT int RSA_get_ex_new_index(long argl, void *argp, |
| 355 | CRYPTO_EX_new *new_func, |
| 356 | CRYPTO_EX_dup *dup_func, |
| 357 | CRYPTO_EX_free *free_func); |
| 358 | OPENSSL_EXPORT int RSA_set_ex_data(RSA *r, int idx, void *arg); |
| 359 | OPENSSL_EXPORT void *RSA_get_ex_data(const RSA *r, int idx); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 360 | |
David Benjamin | ecc0ce7 | 2014-07-18 18:39:42 -0400 | [diff] [blame] | 361 | /* RSA_FLAG_OPAQUE specifies that this RSA_METHOD does not expose its key |
| 362 | * material. This may be set if, for instance, it is wrapping some other crypto |
| 363 | * API, like a platform key store. */ |
| 364 | #define RSA_FLAG_OPAQUE 1 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 365 | |
| 366 | /* RSA_FLAG_CACHE_PUBLIC causes a precomputed Montgomery context to be created, |
| 367 | * on demand, for the public key operations. */ |
| 368 | #define RSA_FLAG_CACHE_PUBLIC 2 |
| 369 | |
| 370 | /* RSA_FLAG_CACHE_PRIVATE causes a precomputed Montgomery context to be |
| 371 | * created, on demand, for the private key operations. */ |
| 372 | #define RSA_FLAG_CACHE_PRIVATE 4 |
| 373 | |
| 374 | /* RSA_FLAG_NO_BLINDING disables blinding of private operations. */ |
| 375 | #define RSA_FLAG_NO_BLINDING 8 |
| 376 | |
| 377 | /* RSA_FLAG_EXT_PKEY means that private key operations will be handled by |
| 378 | * |mod_exp| and that they do not depend on the private key components being |
| 379 | * present: for example a key stored in external hardware. */ |
| 380 | #define RSA_FLAG_EXT_PKEY 0x20 |
| 381 | |
| 382 | /* RSA_FLAG_SIGN_VER causes the |sign| and |verify| functions of |rsa_meth_st| |
| 383 | * to be called when set. */ |
| 384 | #define RSA_FLAG_SIGN_VER 0x40 |
| 385 | |
| 386 | |
| 387 | /* RSA public exponent values. */ |
| 388 | |
| 389 | #define RSA_3 0x3 |
| 390 | #define RSA_F4 0x10001 |
| 391 | |
| 392 | |
| 393 | struct rsa_meth_st { |
| 394 | struct openssl_method_common_st common; |
| 395 | |
| 396 | void *app_data; |
| 397 | |
| 398 | int (*init)(RSA *rsa); |
| 399 | int (*finish)(RSA *rsa); |
| 400 | |
David Benjamin | 925fee3 | 2014-07-11 14:14:08 -0400 | [diff] [blame] | 401 | /* size returns the size of the RSA modulus in bytes. */ |
| 402 | size_t (*size)(const RSA *rsa); |
| 403 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 404 | int (*sign)(int type, const uint8_t *m, unsigned int m_length, |
| 405 | uint8_t *sigret, unsigned int *siglen, const RSA *rsa); |
| 406 | |
| 407 | int (*verify)(int dtype, const uint8_t *m, unsigned int m_length, |
| 408 | const uint8_t *sigbuf, unsigned int siglen, const RSA *rsa); |
| 409 | |
| 410 | |
| 411 | /* These functions mirror the |RSA_*| functions of the same name. */ |
| 412 | int (*encrypt)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out, |
| 413 | const uint8_t *in, size_t in_len, int padding); |
| 414 | int (*sign_raw)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out, |
| 415 | const uint8_t *in, size_t in_len, int padding); |
| 416 | |
| 417 | int (*decrypt)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out, |
| 418 | const uint8_t *in, size_t in_len, int padding); |
| 419 | int (*verify_raw)(RSA *rsa, size_t *out_len, uint8_t *out, size_t max_out, |
| 420 | const uint8_t *in, size_t in_len, int padding); |
| 421 | |
Adam Langley | 6bc658d | 2014-08-18 13:29:45 -0700 | [diff] [blame] | 422 | /* private_transform takes a big-endian integer from |in|, calculates the |
| 423 | * d'th power of it, modulo the RSA modulus and writes the result as a |
| 424 | * big-endian integer to |out|. Both |in| and |out| are |len| bytes long and |
| 425 | * |len| is always equal to |RSA_size(rsa)|. If the result of the transform |
| 426 | * can be represented in fewer than |len| bytes, then |out| must be zero |
| 427 | * padded on the left. |
| 428 | * |
| 429 | * It returns one on success and zero otherwise. |
| 430 | * |
| 431 | * RSA decrypt and sign operations will call this, thus an ENGINE might wish |
| 432 | * to override it in order to avoid having to implement the padding |
| 433 | * functionality demanded by those, higher level, operations. */ |
| 434 | int (*private_transform)(RSA *rsa, uint8_t *out, const uint8_t *in, |
| 435 | size_t len); |
| 436 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 437 | int (*mod_exp)(BIGNUM *r0, const BIGNUM *I, RSA *rsa, |
| 438 | BN_CTX *ctx); /* Can be null */ |
| 439 | int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, |
| 440 | const BIGNUM *m, BN_CTX *ctx, |
| 441 | BN_MONT_CTX *m_ctx); |
| 442 | |
| 443 | int flags; |
| 444 | |
| 445 | int (*keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb); |
David Benjamin | c20febe | 2014-11-11 23:47:50 -0500 | [diff] [blame] | 446 | |
| 447 | /* supports_digest returns one if |rsa| supports digests of type |
| 448 | * |md|. If null, it is assumed that all digests are supported. */ |
| 449 | int (*supports_digest)(const RSA *rsa, const EVP_MD *md); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 450 | }; |
| 451 | |
| 452 | |
| 453 | /* Private functions. */ |
| 454 | |
| 455 | typedef struct bn_blinding_st BN_BLINDING; |
| 456 | |
| 457 | struct rsa_st { |
| 458 | /* version is only used during ASN.1 (de)serialisation. */ |
| 459 | long version; |
| 460 | RSA_METHOD *meth; |
| 461 | |
| 462 | BIGNUM *n; |
| 463 | BIGNUM *e; |
| 464 | BIGNUM *d; |
| 465 | BIGNUM *p; |
| 466 | BIGNUM *q; |
| 467 | BIGNUM *dmp1; |
| 468 | BIGNUM *dmq1; |
| 469 | BIGNUM *iqmp; |
| 470 | /* be careful using this if the RSA structure is shared */ |
| 471 | CRYPTO_EX_DATA ex_data; |
| 472 | int references; |
| 473 | int flags; |
| 474 | |
| 475 | /* Used to cache montgomery values */ |
| 476 | BN_MONT_CTX *_method_mod_n; |
| 477 | BN_MONT_CTX *_method_mod_p; |
| 478 | BN_MONT_CTX *_method_mod_q; |
| 479 | |
| 480 | /* num_blindings contains the size of the |blindings| and |blindings_inuse| |
| 481 | * arrays. This member and the |blindings_inuse| array are protected by |
| 482 | * CRYPTO_LOCK_RSA_BLINDING. */ |
| 483 | unsigned num_blindings; |
| 484 | /* blindings is an array of BN_BLINDING structures that can be reserved by a |
| 485 | * thread by locking CRYPTO_LOCK_RSA_BLINDING and changing the corresponding |
| 486 | * element in |blindings_inuse| from 0 to 1. */ |
| 487 | BN_BLINDING **blindings; |
| 488 | unsigned char *blindings_inuse; |
| 489 | }; |
| 490 | |
| 491 | |
| 492 | #if defined(__cplusplus) |
| 493 | } /* extern C */ |
| 494 | #endif |
| 495 | |
David Benjamin | 689be0f | 2015-02-11 15:55:26 -0500 | [diff] [blame] | 496 | #define RSA_F_BN_BLINDING_convert_ex 100 |
| 497 | #define RSA_F_BN_BLINDING_create_param 101 |
| 498 | #define RSA_F_BN_BLINDING_invert_ex 102 |
| 499 | #define RSA_F_BN_BLINDING_new 103 |
| 500 | #define RSA_F_BN_BLINDING_update 104 |
| 501 | #define RSA_F_RSA_check_key 105 |
| 502 | #define RSA_F_RSA_new_method 106 |
| 503 | #define RSA_F_RSA_padding_add_PKCS1_OAEP_mgf1 107 |
| 504 | #define RSA_F_RSA_padding_add_PKCS1_PSS_mgf1 108 |
| 505 | #define RSA_F_RSA_padding_add_PKCS1_type_1 109 |
| 506 | #define RSA_F_RSA_padding_add_PKCS1_type_2 110 |
| 507 | #define RSA_F_RSA_padding_add_none 111 |
| 508 | #define RSA_F_RSA_padding_check_PKCS1_OAEP_mgf1 112 |
| 509 | #define RSA_F_RSA_padding_check_PKCS1_type_1 113 |
| 510 | #define RSA_F_RSA_padding_check_PKCS1_type_2 114 |
| 511 | #define RSA_F_RSA_padding_check_none 115 |
| 512 | #define RSA_F_RSA_recover_crt_params 116 |
| 513 | #define RSA_F_RSA_sign 117 |
| 514 | #define RSA_F_RSA_verify 118 |
| 515 | #define RSA_F_RSA_verify_PKCS1_PSS_mgf1 119 |
| 516 | #define RSA_F_decrypt 120 |
| 517 | #define RSA_F_encrypt 121 |
| 518 | #define RSA_F_keygen 122 |
| 519 | #define RSA_F_pkcs1_prefixed_msg 123 |
| 520 | #define RSA_F_private_transform 124 |
| 521 | #define RSA_F_rsa_setup_blinding 125 |
| 522 | #define RSA_F_sign_raw 126 |
| 523 | #define RSA_F_verify_raw 127 |
| 524 | #define RSA_R_BAD_E_VALUE 100 |
| 525 | #define RSA_R_BAD_FIXED_HEADER_DECRYPT 101 |
| 526 | #define RSA_R_BAD_PAD_BYTE_COUNT 102 |
| 527 | #define RSA_R_BAD_RSA_PARAMETERS 103 |
| 528 | #define RSA_R_BAD_SIGNATURE 104 |
| 529 | #define RSA_R_BLOCK_TYPE_IS_NOT_01 105 |
| 530 | #define RSA_R_BN_NOT_INITIALIZED 106 |
| 531 | #define RSA_R_CRT_PARAMS_ALREADY_GIVEN 107 |
| 532 | #define RSA_R_CRT_VALUES_INCORRECT 108 |
| 533 | #define RSA_R_DATA_LEN_NOT_EQUAL_TO_MOD_LEN 109 |
| 534 | #define RSA_R_DATA_TOO_LARGE 110 |
| 535 | #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 111 |
| 536 | #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 112 |
| 537 | #define RSA_R_DATA_TOO_SMALL 113 |
| 538 | #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 114 |
| 539 | #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 115 |
| 540 | #define RSA_R_D_E_NOT_CONGRUENT_TO_1 116 |
| 541 | #define RSA_R_EMPTY_PUBLIC_KEY 117 |
| 542 | #define RSA_R_FIRST_OCTET_INVALID 118 |
| 543 | #define RSA_R_INCONSISTENT_SET_OF_CRT_VALUES 119 |
| 544 | #define RSA_R_INTERNAL_ERROR 120 |
| 545 | #define RSA_R_INVALID_MESSAGE_LENGTH 121 |
| 546 | #define RSA_R_KEY_SIZE_TOO_SMALL 122 |
| 547 | #define RSA_R_LAST_OCTET_INVALID 123 |
| 548 | #define RSA_R_MODULUS_TOO_LARGE 124 |
| 549 | #define RSA_R_NO_PUBLIC_EXPONENT 125 |
| 550 | #define RSA_R_NULL_BEFORE_BLOCK_MISSING 126 |
| 551 | #define RSA_R_N_NOT_EQUAL_P_Q 127 |
| 552 | #define RSA_R_OAEP_DECODING_ERROR 128 |
| 553 | #define RSA_R_ONLY_ONE_OF_P_Q_GIVEN 129 |
| 554 | #define RSA_R_OUTPUT_BUFFER_TOO_SMALL 130 |
| 555 | #define RSA_R_PADDING_CHECK_FAILED 131 |
| 556 | #define RSA_R_PKCS_DECODING_ERROR 132 |
| 557 | #define RSA_R_SLEN_CHECK_FAILED 133 |
| 558 | #define RSA_R_SLEN_RECOVERY_FAILED 134 |
| 559 | #define RSA_R_TOO_LONG 135 |
| 560 | #define RSA_R_TOO_MANY_ITERATIONS 136 |
| 561 | #define RSA_R_UNKNOWN_ALGORITHM_TYPE 137 |
| 562 | #define RSA_R_UNKNOWN_PADDING_TYPE 138 |
Adam Langley | 05b7377 | 2014-07-25 12:03:51 -0700 | [diff] [blame] | 563 | #define RSA_R_VALUE_MISSING 139 |
David Benjamin | 689be0f | 2015-02-11 15:55:26 -0500 | [diff] [blame] | 564 | #define RSA_R_WRONG_SIGNATURE_LENGTH 140 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 565 | |
| 566 | #endif /* OPENSSL_HEADER_RSA_H */ |