Debian Codegraph @

external/boringssl/include/openssl/evp.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_EVP_H
58 #define OPENSSL_HEADER_EVP_H
59
60 #include <openssl/base.h>
61
62 #include <openssl/thread.h>
63
64 /* OpenSSL included digest and cipher functions in this header so we include
65 * them for users that still expect that.
66 *
67 * TODO(fork): clean up callers so that they include what they use. */
68 #include <openssl/aead.h>
69 #include <openssl/base64.h>
70 #include <openssl/cipher.h>
71 #include <openssl/digest.h>
72 #include <openssl/nid.h>
73
74 #if defined(__cplusplus)
75 extern "C" {
76 #endif
77
78
79 /* EVP abstracts over public/private key algorithms. */
80
81
82 /* Public key objects. */
83
84 /* EVP_PKEY_new creates a new, empty public-key object and returns it or NULL
85 * on allocation failure. */
86 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_new(void);
87
88 /* EVP_PKEY_free frees all data referenced by |pkey| and then frees |pkey|
89 * itself. */
90 OPENSSL_EXPORT void EVP_PKEY_free(EVP_PKEY *pkey);
91
92 /* EVP_PKEY_up_ref increments the reference count of |pkey| and returns it. */
93 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_up_ref(EVP_PKEY *pkey);
94
95 /* EVP_PKEY_is_opaque returns one if |pkey| is opaque. Opaque keys are backed by
96 * custom implementations which do not expose key material and parameters. It is
97 * an error to attempt to duplicate, export, or compare an opaque key. */
98 OPENSSL_EXPORT int EVP_PKEY_is_opaque(const EVP_PKEY *pkey);
99
100 /* EVP_PKEY_supports_digest returns one if |pkey| supports digests of
101 * type |md|. This is intended for use with EVP_PKEYs backing custom
102 * implementations which can't sign all digests. */
103 OPENSSL_EXPORT int EVP_PKEY_supports_digest(const EVP_PKEY *pkey,
104 const EVP_MD *md);
105
106 /* EVP_PKEY_cmp compares |a| and |b| and returns one if they are equal, zero if
107 * not and a negative number on error.
108 *
109 * WARNING: this differs from the traditional return value of a "cmp"
110 * function. */
111 OPENSSL_EXPORT int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b);
112
113 /* EVP_PKEY_copy_parameters sets the parameters of |to| to equal the parameters
114 * of |from|. It returns one on success and zero on error. */
115 OPENSSL_EXPORT int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from);
116
117 /* EVP_PKEY_missing_parameters returns one if |pkey| is missing needed
118 * parameters or zero if not, or if the algorithm doesn't take parameters. */
119 OPENSSL_EXPORT int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey);
120
121 /* EVP_PKEY_size returns the maximum size, in bytes, of a signature signed by
122 * |pkey|. For an RSA key, this returns the number of bytes needed to represent
123 * the modulus. For an EC key, this returns the maximum size of a DER-encoded
124 * ECDSA signature. */
125 OPENSSL_EXPORT int EVP_PKEY_size(const EVP_PKEY *pkey);
126
127 /* EVP_PKEY_bits returns the "size", in bits, of |pkey|. For an RSA key, this
128 * returns the bit length of the modulus. For an EC key, this returns the bit
129 * length of the group order. */
130 OPENSSL_EXPORT int EVP_PKEY_bits(EVP_PKEY *pkey);
131
132 /* EVP_PKEY_id returns the type of |pkey|, which is one of the |EVP_PKEY_*|
133 * values. */
134 OPENSSL_EXPORT int EVP_PKEY_id(const EVP_PKEY *pkey);
135
136 /* EVP_PKEY_type returns |nid| if |nid| is a known key type and |NID_undef|
137 * otherwise. */
138 OPENSSL_EXPORT int EVP_PKEY_type(int nid);
139
140
141 /* Getting and setting concrete public key types.
142 *
143 * The following functions get and set the underlying public key in an
144 * |EVP_PKEY| object. The |set1| functions take an additional reference to the
145 * underlying key and return one on success or zero on error. The |assign|
146 * functions adopt the caller's reference. The |get1| functions return a fresh
147 * reference to the underlying object or NULL if |pkey| is not of the correct
148 * type. The |get0| functions behave the same but return a non-owning
149 * pointer. */
150
151 OPENSSL_EXPORT int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key);
152 OPENSSL_EXPORT int EVP_PKEY_assign_RSA(EVP_PKEY *pkey, RSA *key);
153 OPENSSL_EXPORT RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey);
154 OPENSSL_EXPORT RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey);
155
156 OPENSSL_EXPORT int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key);
157 OPENSSL_EXPORT int EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key);
158 OPENSSL_EXPORT DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey);
159 OPENSSL_EXPORT DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey);
160
161 OPENSSL_EXPORT int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
162 OPENSSL_EXPORT int EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
163 OPENSSL_EXPORT EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey);
164 OPENSSL_EXPORT EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey);
165
166 #define EVP_PKEY_NONE NID_undef
167 #define EVP_PKEY_RSA NID_rsaEncryption
168 #define EVP_PKEY_DSA NID_dsa
169 #define EVP_PKEY_EC NID_X9_62_id_ecPublicKey
170
171 /* EVP_PKEY_assign sets the underlying key of |pkey| to |key|, which must be of
172 * the given type. The |type| argument should be one of the |EVP_PKEY_*|
173 * values. */
174 OPENSSL_EXPORT int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key);
175
176 /* EVP_PKEY_set_type sets the type of |pkey| to |type|, which should be one of
177 * the |EVP_PKEY_*| values. It returns one if sucessful or zero otherwise. If
178 * |pkey| is NULL, it simply reports whether the type is known. */
179 OPENSSL_EXPORT int EVP_PKEY_set_type(EVP_PKEY *pkey, int type);
180
181 /* EVP_PKEY_cmp_parameters compares the parameters of |a| and |b|. It returns
182 * one if they match, zero if not, or a negative number of on error.
183 *
184 * WARNING: the return value differs from the usual return value convention. */
185 OPENSSL_EXPORT int EVP_PKEY_cmp_parameters(const EVP_PKEY *a,
186 const EVP_PKEY *b);
187
188
189 /* ASN.1 functions */
190
191 /* EVP_parse_public_key decodes a DER-encoded SubjectPublicKeyInfo structure
192 * (RFC 5280) from |cbs| and advances |cbs|. It returns a newly-allocated
193 * |EVP_PKEY| or NULL on error.
194 *
195 * The caller must check the type of the parsed public key to ensure it is
196 * suitable and validate other desired key properties such as RSA modulus size
197 * or EC curve. */
198 OPENSSL_EXPORT EVP_PKEY *EVP_parse_public_key(CBS *cbs);
199
200 /* EVP_marshal_public_key marshals |key| as a DER-encoded SubjectPublicKeyInfo
201 * structure (RFC 5280) and appends the result to |cbb|. It returns one on
202 * success and zero on error. */
203 OPENSSL_EXPORT int EVP_marshal_public_key(CBB *cbb, const EVP_PKEY *key);
204
205 /* EVP_parse_private_key decodes a DER-encoded PrivateKeyInfo structure (RFC
206 * 5208) from |cbs| and advances |cbs|. It returns a newly-allocated |EVP_PKEY|
207 * or NULL on error.
208 *
209 * The caller must check the type of the parsed private key to ensure it is
210 * suitable and validate other desired key properties such as RSA modulus size
211 * or EC curve.
212 *
213 * A PrivateKeyInfo ends with an optional set of attributes. These are not
214 * processed and so this function will silently ignore any trailing data in the
215 * structure. */
216 OPENSSL_EXPORT EVP_PKEY *EVP_parse_private_key(CBS *cbs);
217
218 /* EVP_marshal_private_key marshals |key| as a DER-encoded PrivateKeyInfo
219 * structure (RFC 5208) and appends the result to |cbb|. It returns one on
220 * success and zero on error. */
221 OPENSSL_EXPORT int EVP_marshal_private_key(CBB *cbb, const EVP_PKEY *key);
222
223
224 /* Signing */
225
226 /* EVP_DigestSignInit sets up |ctx| for a signing operation with |type| and
227 * |pkey|. The |ctx| argument must have been initialised with
228 * |EVP_MD_CTX_init|. If |pctx| is not NULL, the |EVP_PKEY_CTX| of the signing
229 * operation will be written to |*pctx|; this can be used to set alternative
230 * signing options.
231 *
232 * It returns one on success, or zero on error. */
233 OPENSSL_EXPORT int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
234 const EVP_MD *type, ENGINE *e,
235 EVP_PKEY *pkey);
236
237 /* EVP_DigestSignUpdate appends |len| bytes from |data| to the data which will
238 * be signed in |EVP_DigestSignFinal|. It returns one. */
239 OPENSSL_EXPORT int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data,
240 size_t len);
241
242 /* EVP_DigestSignFinal signs the data that has been included by one or more
243 * calls to |EVP_DigestSignUpdate|. If |out_sig| is NULL then |*out_sig_len| is
244 * set to the maximum number of output bytes. Otherwise, on entry,
245 * |*out_sig_len| must contain the length of the |out_sig| buffer. If the call
246 * is successful, the signature is written to |out_sig| and |*out_sig_len| is
247 * set to its length.
248 *
249 * It returns one on success, or zero on error. */
250 OPENSSL_EXPORT int EVP_DigestSignFinal(EVP_MD_CTX *ctx, uint8_t *out_sig,
251 size_t *out_sig_len);
252
253
254 /* Verifying */
255
256 /* EVP_DigestVerifyInit sets up |ctx| for a signature verification operation
257 * with |type| and |pkey|. The |ctx| argument must have been initialised with
258 * |EVP_MD_CTX_init|. If |pctx| is not NULL, the |EVP_PKEY_CTX| of the signing
259 * operation will be written to |*pctx|; this can be used to set alternative
260 * signing options.
261 *
262 * It returns one on success, or zero on error. */
263 OPENSSL_EXPORT int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
264 const EVP_MD *type, ENGINE *e,
265 EVP_PKEY *pkey);
266
267 /* EVP_DigestVerifyUpdate appends |len| bytes from |data| to the data which
268 * will be verified by |EVP_DigestVerifyFinal|. It returns one. */
269 OPENSSL_EXPORT int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data,
270 size_t len);
271
272 /* EVP_DigestVerifyFinal verifies that |sig_len| bytes of |sig| are a valid
273 * signature for the data that has been included by one or more calls to
274 * |EVP_DigestVerifyUpdate|. It returns one on success and zero otherwise. */
275 OPENSSL_EXPORT int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const uint8_t *sig,
276 size_t sig_len);
277
278
279 /* Signing (old functions) */
280
281 /* EVP_SignInit_ex configures |ctx|, which must already have been initialised,
282 * for a fresh signing operation using the hash function |type|. It returns one
283 * on success and zero otherwise.
284 *
285 * (In order to initialise |ctx|, either obtain it initialised with
286 * |EVP_MD_CTX_create|, or use |EVP_MD_CTX_init|.) */
287 OPENSSL_EXPORT int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type,
288 ENGINE *impl);
289
290 /* EVP_SignInit is a deprecated version of |EVP_SignInit_ex|.
291 *
292 * TODO(fork): remove. */
293 OPENSSL_EXPORT int EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type);
294
295 /* EVP_SignUpdate appends |len| bytes from |data| to the data which will be
296 * signed in |EVP_SignFinal|. */
297 OPENSSL_EXPORT int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *data,
298 size_t len);
299
300 /* EVP_SignFinal signs the data that has been included by one or more calls to
301 * |EVP_SignUpdate|, using the key |pkey|, and writes it to |sig|. On entry,
302 * |sig| must point to at least |EVP_PKEY_size(pkey)| bytes of space. The
303 * actual size of the signature is written to |*out_sig_len|.
304 *
305 * It returns one on success and zero otherwise.
306 *
307 * It does not modify |ctx|, thus it's possible to continue to use |ctx| in
308 * order to sign a longer message. */
309 OPENSSL_EXPORT int EVP_SignFinal(const EVP_MD_CTX *ctx, uint8_t *sig,
310 unsigned int *out_sig_len, EVP_PKEY *pkey);
311
312
313 /* Verifying (old functions) */
314
315 /* EVP_VerifyInit_ex configures |ctx|, which must already have been
316 * initialised, for a fresh signature verification operation using the hash
317 * function |type|. It returns one on success and zero otherwise.
318 *
319 * (In order to initialise |ctx|, either obtain it initialised with
320 * |EVP_MD_CTX_create|, or use |EVP_MD_CTX_init|.) */
321 OPENSSL_EXPORT int EVP_VerifyInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type,
322 ENGINE *impl);
323
324 /* EVP_VerifyInit is a deprecated version of |EVP_VerifyInit_ex|.
325 *
326 * TODO(fork): remove. */
327 OPENSSL_EXPORT int EVP_VerifyInit(EVP_MD_CTX *ctx, const EVP_MD *type);
328
329 /* EVP_VerifyUpdate appends |len| bytes from |data| to the data which will be
330 * signed in |EVP_VerifyFinal|. */
331 OPENSSL_EXPORT int EVP_VerifyUpdate(EVP_MD_CTX *ctx, const void *data,
332 size_t len);
333
334 /* EVP_VerifyFinal verifies that |sig_len| bytes of |sig| are a valid
335 * signature, by |pkey|, for the data that has been included by one or more
336 * calls to |EVP_VerifyUpdate|.
337 *
338 * It returns one on success and zero otherwise.
339 *
340 * It does not modify |ctx|, thus it's possible to continue to use |ctx| in
341 * order to sign a longer message. */
342 OPENSSL_EXPORT int EVP_VerifyFinal(EVP_MD_CTX *ctx, const uint8_t *sig,
343 size_t sig_len, EVP_PKEY *pkey);
344
345
346 /* Printing */
347
348 /* EVP_PKEY_print_public prints a textual representation of the public key in
349 * |pkey| to |out|. Returns one on success or zero otherwise. */
350 OPENSSL_EXPORT int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
351 int indent, ASN1_PCTX *pctx);
352
353 /* EVP_PKEY_print_private prints a textual representation of the private key in
354 * |pkey| to |out|. Returns one on success or zero otherwise. */
355 OPENSSL_EXPORT int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
356 int indent, ASN1_PCTX *pctx);
357
358 /* EVP_PKEY_print_params prints a textual representation of the parameters in
359 * |pkey| to |out|. Returns one on success or zero otherwise. */
360 OPENSSL_EXPORT int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
361 int indent, ASN1_PCTX *pctx);
362
363
364 /* Password stretching.
365 *
366 * Password stretching functions take a low-entropy password and apply a slow
367 * function that results in a key suitable for use in symmetric
368 * cryptography. */
369
370 /* PKCS5_PBKDF2_HMAC computes |iterations| iterations of PBKDF2 of |password|
371 * and |salt|, using |digest|, and outputs |key_len| bytes to |out_key|. It
372 * returns one on success and zero on error. */
373 OPENSSL_EXPORT int PKCS5_PBKDF2_HMAC(const char *password, size_t password_len,
374 const uint8_t *salt, size_t salt_len,
375 unsigned iterations, const EVP_MD *digest,
376 size_t key_len, uint8_t *out_key);
377
378 /* PKCS5_PBKDF2_HMAC_SHA1 is the same as PKCS5_PBKDF2_HMAC, but with |digest|
379 * fixed to |EVP_sha1|. */
380 OPENSSL_EXPORT int PKCS5_PBKDF2_HMAC_SHA1(const char *password,
381 size_t password_len, const uint8_t *salt,
382 size_t salt_len, unsigned iterations,
383 size_t key_len, uint8_t *out_key);
384
385
386 /* Public key contexts.
387 *
388 * |EVP_PKEY_CTX| objects hold the context of an operation (e.g. signing or
389 * encrypting) that uses a public key. */
390
391 /* EVP_PKEY_CTX_new allocates a fresh |EVP_PKEY_CTX| for use with |pkey|. It
392 * returns the context or NULL on error. */
393 OPENSSL_EXPORT EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e);
394
395 /* EVP_PKEY_CTX_new_id allocates a fresh |EVP_PKEY_CTX| for a key of type |id|
396 * (e.g. |EVP_PKEY_HMAC|). This can be used for key generation where
397 * |EVP_PKEY_CTX_new| can't be used because there isn't an |EVP_PKEY| to pass
398 * it. It returns the context or NULL on error. */
399 OPENSSL_EXPORT EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e);
400
401 /* EVP_PKEY_CTX_free frees |ctx| and the data it owns. */
402 OPENSSL_EXPORT void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx);
403
404 /* EVP_PKEY_CTX_dup allocates a fresh |EVP_PKEY_CTX| and sets it equal to the
405 * state of |ctx|. It returns the fresh |EVP_PKEY_CTX| or NULL on error. */
406 OPENSSL_EXPORT EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *ctx);
407
408 /* EVP_PKEY_CTX_get0_pkey returns the |EVP_PKEY| associated with |ctx|. */
409 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx);
410
411 /* EVP_PKEY_sign_init initialises an |EVP_PKEY_CTX| for a signing operation. It
412 * should be called before |EVP_PKEY_sign|.
413 *
414 * It returns one on success or zero on error. */
415 OPENSSL_EXPORT int EVP_PKEY_sign_init(EVP_PKEY_CTX *ctx);
416
417 /* EVP_PKEY_sign signs |data_len| bytes from |data| using |ctx|. If |sig| is
418 * NULL, the maximum size of the signature is written to
419 * |out_sig_len|. Otherwise, |*sig_len| must contain the number of bytes of
420 * space available at |sig|. If sufficient, the signature will be written to
421 * |sig| and |*sig_len| updated with the true length.
422 *
423 * WARNING: Setting |sig| to NULL only gives the maximum size of the
424 * signature. The actual signature may be smaller.
425 *
426 * It returns one on success or zero on error. (Note: this differs from
427 * OpenSSL, which can also return negative values to indicate an error. ) */
428 OPENSSL_EXPORT int EVP_PKEY_sign(EVP_PKEY_CTX *ctx, uint8_t *sig,
429 size_t *sig_len, const uint8_t *data,
430 size_t data_len);
431
432 /* EVP_PKEY_verify_init initialises an |EVP_PKEY_CTX| for a signature
433 * verification operation. It should be called before |EVP_PKEY_verify|.
434 *
435 * It returns one on success or zero on error. */
436 OPENSSL_EXPORT int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx);
437
438 /* EVP_PKEY_verify verifies that |sig_len| bytes from |sig| are a valid signature
439 * for |data|.
440 *
441 * It returns one on success or zero on error. */
442 OPENSSL_EXPORT int EVP_PKEY_verify(EVP_PKEY_CTX *ctx, const uint8_t *sig,
443 size_t sig_len, const uint8_t *data,
444 size_t data_len);
445
446 /* EVP_PKEY_encrypt_init initialises an |EVP_PKEY_CTX| for an encryption
447 * operation. It should be called before |EVP_PKEY_encrypt|.
448 *
449 * It returns one on success or zero on error. */
450 OPENSSL_EXPORT int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
451
452 /* EVP_PKEY_encrypt encrypts |in_len| bytes from |in|. If |out| is NULL, the
453 * maximum size of the ciphertext is written to |out_len|. Otherwise, |*out_len|
454 * must contain the number of bytes of space available at |out|. If sufficient,
455 * the ciphertext will be written to |out| and |*out_len| updated with the true
456 * length.
457 *
458 * WARNING: Setting |out| to NULL only gives the maximum size of the
459 * ciphertext. The actual ciphertext may be smaller.
460 *
461 * It returns one on success or zero on error. */
462 OPENSSL_EXPORT int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx, uint8_t *out,
463 size_t *out_len, const uint8_t *in,
464 size_t in_len);
465
466 /* EVP_PKEY_decrypt_init initialises an |EVP_PKEY_CTX| for a decryption
467 * operation. It should be called before |EVP_PKEY_decrypt|.
468 *
469 * It returns one on success or zero on error. */
470 OPENSSL_EXPORT int EVP_PKEY_decrypt_init(EVP_PKEY_CTX *ctx);
471
472 /* EVP_PKEY_decrypt decrypts |in_len| bytes from |in|. If |out| is NULL, the
473 * maximum size of the plaintext is written to |out_len|. Otherwise, |*out_len|
474 * must contain the number of bytes of space available at |out|. If sufficient,
475 * the ciphertext will be written to |out| and |*out_len| updated with the true
476 * length.
477 *
478 * WARNING: Setting |out| to NULL only gives the maximum size of the
479 * plaintext. The actual plaintext may be smaller.
480 *
481 * It returns one on success or zero on error. */
482 OPENSSL_EXPORT int EVP_PKEY_decrypt(EVP_PKEY_CTX *ctx, uint8_t *out,
483 size_t *out_len, const uint8_t *in,
484 size_t in_len);
485
486 /* EVP_PKEY_verify_recover_init initialises an |EVP_PKEY_CTX| for a public-key
487 * decryption operation. It should be called before |EVP_PKEY_verify_recover|.
488 *
489 * Public-key decryption is a very obscure operation that is only implemented
490 * by RSA keys. It is effectively a signature verification operation that
491 * returns the signed message directly. It is almost certainly not what you
492 * want.
493 *
494 * It returns one on success or zero on error. */
495 OPENSSL_EXPORT int EVP_PKEY_verify_recover_init(EVP_PKEY_CTX *ctx);
496
497 /* EVP_PKEY_verify_recover decrypts |sig_len| bytes from |sig|. If |out| is
498 * NULL, the maximum size of the plaintext is written to |out_len|. Otherwise,
499 * |*out_len| must contain the number of bytes of space available at |out|. If
500 * sufficient, the ciphertext will be written to |out| and |*out_len| updated
501 * with the true length.
502 *
503 * WARNING: Setting |out| to NULL only gives the maximum size of the
504 * plaintext. The actual plaintext may be smaller.
505 *
506 * See the warning about this operation in |EVP_PKEY_verify_recover_init|. It
507 * is probably not what you want.
508 *
509 * It returns one on success or zero on error. */
510 OPENSSL_EXPORT int EVP_PKEY_verify_recover(EVP_PKEY_CTX *ctx, uint8_t *out,
511 size_t *out_len, const uint8_t *sig,
512 size_t siglen);
513
514 /* EVP_PKEY_derive_init initialises an |EVP_PKEY_CTX| for a key derivation
515 * operation. It should be called before |EVP_PKEY_derive_set_peer| and
516 * |EVP_PKEY_derive|.
517 *
518 * It returns one on success or zero on error. */
519 OPENSSL_EXPORT int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx);
520
521 /* EVP_PKEY_derive_set_peer sets the peer's key to be used for key derivation
522 * by |ctx| to |peer|. It should be called after |EVP_PKEY_derive_init|. (For
523 * example, this is used to set the peer's key in (EC)DH.) It returns one on
524 * success and zero on error. */
525 OPENSSL_EXPORT int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer);
526
527 /* EVP_PKEY_derive derives a shared key between the two keys configured in
528 * |ctx|. If |key| is non-NULL then, on entry, |out_key_len| must contain the
529 * amount of space at |key|. If sufficient then the shared key will be written
530 * to |key| and |*out_key_len| will be set to the length. If |key| is NULL then
531 * |out_key_len| will be set to the maximum length.
532 *
533 * WARNING: Setting |out| to NULL only gives the maximum size of the key. The
534 * actual key may be smaller.
535 *
536 * It returns one on success and zero on error. */
537 OPENSSL_EXPORT int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, uint8_t *key,
538 size_t *out_key_len);
539
540 /* EVP_PKEY_keygen_init initialises an |EVP_PKEY_CTX| for a key generation
541 * operation. It should be called before |EVP_PKEY_keygen|.
542 *
543 * It returns one on success or zero on error. */
544 OPENSSL_EXPORT int EVP_PKEY_keygen_init(EVP_PKEY_CTX *ctx);
545
546 /* EVP_PKEY_keygen performs a key generation operation using the values from
547 * |ctx| and sets |*ppkey| to a fresh |EVP_PKEY| containing the resulting key.
548 * It returns one on success or zero on error. */
549 OPENSSL_EXPORT int EVP_PKEY_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
550
551
552 /* Generic control functions. */
553
554 /* EVP_PKEY_CTX_set_signature_md sets |md| as the digest to be used in a
555 * signature operation. It returns one on success or zero on error. */
556 OPENSSL_EXPORT int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx,
557 const EVP_MD *md);
558
559 /* EVP_PKEY_CTX_get_signature_md sets |*out_md| to the digest to be used in a
560 * signature operation. It returns one on success or zero on error. */
561 OPENSSL_EXPORT int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx,
562 const EVP_MD **out_md);
563
564
565 /* RSA specific control functions. */
566
567 /* EVP_PKEY_CTX_set_rsa_padding sets the padding type to use. It should be one
568 * of the |RSA_*_PADDING| values. Returns one on success or zero on error. */
569 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int padding);
570
571 /* EVP_PKEY_CTX_get_rsa_padding sets |*out_padding| to the current padding
572 * value, which is one of the |RSA_*_PADDING| values. Returns one on success or
573 * zero on error. */
574 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx,
575 int *out_padding);
576
577 /* EVP_PKEY_CTX_set_rsa_pss_saltlen sets the length of the salt in a PSS-padded
578 * signature. A value of -1 cause the salt to be the same length as the digest
579 * in the signature. A value of -2 causes the salt to be the maximum length
580 * that will fit. Otherwise the value gives the size of the salt in bytes.
581 *
582 * Returns one on success or zero on error. */
583 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx,
584 int salt_len);
585
586 /* EVP_PKEY_CTX_get_rsa_pss_saltlen sets |*out_salt_len| to the salt length of
587 * a PSS-padded signature. See the documentation for
588 * |EVP_PKEY_CTX_set_rsa_pss_saltlen| for details of the special values that it
589 * can take.
590 *
591 * Returns one on success or zero on error. */
592 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX *ctx,
593 int *out_salt_len);
594
595 /* EVP_PKEY_CTX_set_rsa_keygen_bits sets the size of the desired RSA modulus,
596 * in bits, for key generation. Returns one on success or zero on
597 * error. */
598 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx,
599 int bits);
600
601 /* EVP_PKEY_CTX_set_rsa_keygen_pubexp sets |e| as the public exponent for key
602 * generation. Returns one on success or zero on error. */
603 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx,
604 BIGNUM *e);
605
606 /* EVP_PKEY_CTX_set_rsa_oaep_md sets |md| as the digest used in OAEP padding.
607 * Returns one on success or zero on error. */
608 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx,
609 const EVP_MD *md);
610
611 /* EVP_PKEY_CTX_get_rsa_oaep_md sets |*out_md| to the digest function used in
612 * OAEP padding. Returns one on success or zero on error. */
613 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx,
614 const EVP_MD **out_md);
615
616 /* EVP_PKEY_CTX_set_rsa_mgf1_md sets |md| as the digest used in MGF1. Returns
617 * one on success or zero on error. */
618 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx,
619 const EVP_MD *md);
620
621 /* EVP_PKEY_CTX_get_rsa_mgf1_md sets |*out_md| to the digest function used in
622 * MGF1. Returns one on success or zero on error. */
623 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx,
624 const EVP_MD **out_md);
625
626 /* EVP_PKEY_CTX_set0_rsa_oaep_label sets |label_len| bytes from |label| as the
627 * label used in OAEP. DANGER: On success, this call takes ownership of |label|
628 * and will call |OPENSSL_free| on it when |ctx| is destroyed.
629 *
630 * Returns one on success or zero on error. */
631 OPENSSL_EXPORT int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx,
632 uint8_t *label,
633 size_t label_len);
634
635 /* EVP_PKEY_CTX_get0_rsa_oaep_label sets |*out_label| to point to the internal
636 * buffer containing the OAEP label (which may be NULL) and returns the length
637 * of the label or a negative value on error.
638 *
639 * WARNING: the return value differs from the usual return value convention. */
640 OPENSSL_EXPORT int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx,
641 const uint8_t **out_label);
642
643
644 /* Deprecated functions. */
645
646 /* EVP_PKEY_DH is defined for compatibility, but it is impossible to create an
647 * |EVP_PKEY| of that type. */
648 #define EVP_PKEY_DH NID_dhKeyAgreement
649
650 /* EVP_PKEY_RSA2 was historically an alternate form for RSA public keys (OID
651 * 2.5.8.1.1), but is no longer accepted. */
652 #define EVP_PKEY_RSA2 NID_rsa
653
654 /* OpenSSL_add_all_algorithms does nothing. */
655 OPENSSL_EXPORT void OpenSSL_add_all_algorithms(void);
656
657 /* OPENSSL_add_all_algorithms_conf does nothing. */
658 OPENSSL_EXPORT void OPENSSL_add_all_algorithms_conf(void);
659
660 /* OpenSSL_add_all_ciphers does nothing. */
661 OPENSSL_EXPORT void OpenSSL_add_all_ciphers(void);
662
663 /* OpenSSL_add_all_digests does nothing. */
664 OPENSSL_EXPORT void OpenSSL_add_all_digests(void);
665
666 /* EVP_cleanup does nothing. */
667 OPENSSL_EXPORT void EVP_cleanup(void);
668
669 OPENSSL_EXPORT void EVP_CIPHER_do_all_sorted(
670 void (*callback)(const EVP_CIPHER *cipher, const char *name,
671 const char *unused, void *arg),
672 void *arg);
673
674 OPENSSL_EXPORT void EVP_MD_do_all_sorted(void (*callback)(const EVP_MD *cipher,
675 const char *name,
676 const char *unused,
677 void *arg),
678 void *arg);
679
680 /* i2d_PrivateKey marshals a private key from |key| to an ASN.1, DER
681 * structure. If |outp| is not NULL then the result is written to |*outp| and
682 * |*outp| is advanced just past the output. It returns the number of bytes in
683 * the result, whether written or not, or a negative value on error.
684 *
685 * RSA keys are serialized as a DER-encoded RSAPublicKey (RFC 3447) structure.
686 * EC keys are serialized as a DER-encoded ECPrivateKey (RFC 5915) structure.
687 *
688 * Use |RSA_marshal_private_key| or |EC_marshal_private_key| instead. */
689 OPENSSL_EXPORT int i2d_PrivateKey(const EVP_PKEY *key, uint8_t **outp);
690
691 /* i2d_PublicKey marshals a public key from |key| to a type-specific format.
692 * If |outp| is not NULL then the result is written to |*outp| and
693 * |*outp| is advanced just past the output. It returns the number of bytes in
694 * the result, whether written or not, or a negative value on error.
695 *
696 * RSA keys are serialized as a DER-encoded RSAPublicKey (RFC 3447) structure.
697 * EC keys are serialized as an EC point per SEC 1.
698 *
699 * Use |RSA_marshal_public_key| or |EC_POINT_point2cbb| instead. */
700 OPENSSL_EXPORT int i2d_PublicKey(EVP_PKEY *key, uint8_t **outp);
701
702 /* d2i_PrivateKey parses an ASN.1, DER-encoded, private key from |len| bytes at
703 * |*inp|. If |out| is not NULL then, on exit, a pointer to the result is in
704 * |*out|. Note that, even if |*out| is already non-NULL on entry, it will not
705 * be written to. Rather, a fresh |EVP_PKEY| is allocated and the previous one
706 * is freed. On successful exit, |*inp| is advanced past the DER structure. It
707 * returns the result or NULL on error.
708 *
709 * This function tries to detect one of several formats. Instead, use
710 * |EVP_parse_private_key| for a PrivateKeyInfo, |RSA_parse_private_key| for an
711 * RSAPrivateKey, and |EC_parse_private_key| for an ECPrivateKey. */
712 OPENSSL_EXPORT EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **out,
713 const uint8_t **inp, long len);
714
715 /* d2i_AutoPrivateKey acts the same as |d2i_PrivateKey|, but detects the type
716 * of the private key.
717 *
718 * This function tries to detect one of several formats. Instead, use
719 * |EVP_parse_private_key| for a PrivateKeyInfo, |RSA_parse_private_key| for an
720 * RSAPrivateKey, and |EC_parse_private_key| for an ECPrivateKey. */
721 OPENSSL_EXPORT EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **out, const uint8_t **inp,
722 long len);
723
724
725 /* Private structures. */
726
727 struct evp_pkey_st {
728 CRYPTO_refcount_t references;
729
730 /* type contains one of the EVP_PKEY_* values or NID_undef and determines
731 * which element (if any) of the |pkey| union is valid. */
732 int type;
733
734 union {
735 char *ptr;
736 RSA *rsa;
737 DSA *dsa;
738 DH *dh;
739 EC_KEY *ec;
740 } pkey;
741
742 /* ameth contains a pointer to a method table that contains many ASN.1
743 * methods for the key type. */
744 const EVP_PKEY_ASN1_METHOD *ameth;
745 } /* EVP_PKEY */;
746
747
748 #if defined(__cplusplus)
749 } /* extern C */
750 #endif
751
752 #define EVP_R_BUFFER_TOO_SMALL 100
753 #define EVP_R_COMMAND_NOT_SUPPORTED 101
754 #define EVP_R_DECODE_ERROR 102
755 #define EVP_R_DIFFERENT_KEY_TYPES 103
756 #define EVP_R_DIFFERENT_PARAMETERS 104
757 #define EVP_R_ENCODE_ERROR 105
758 #define EVP_R_EXPECTING_AN_EC_KEY_KEY 106
759 #define EVP_R_EXPECTING_AN_RSA_KEY 107
760 #define EVP_R_EXPECTING_A_DSA_KEY 108
761 #define EVP_R_ILLEGAL_OR_UNSUPPORTED_PADDING_MODE 109
762 #define EVP_R_INVALID_DIGEST_LENGTH 110
763 #define EVP_R_INVALID_DIGEST_TYPE 111
764 #define EVP_R_INVALID_KEYBITS 112
765 #define EVP_R_INVALID_MGF1_MD 113
766 #define EVP_R_INVALID_OPERATION 114
767 #define EVP_R_INVALID_PADDING_MODE 115
768 #define EVP_R_INVALID_PSS_SALTLEN 116
769 #define EVP_R_KEYS_NOT_SET 117
770 #define EVP_R_MISSING_PARAMETERS 118
771 #define EVP_R_NO_DEFAULT_DIGEST 119
772 #define EVP_R_NO_KEY_SET 120
773 #define EVP_R_NO_MDC2_SUPPORT 121
774 #define EVP_R_NO_NID_FOR_CURVE 122
775 #define EVP_R_NO_OPERATION_SET 123
776 #define EVP_R_NO_PARAMETERS_SET 124
777 #define EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE 125
778 #define EVP_R_OPERATON_NOT_INITIALIZED 126
779 #define EVP_R_UNKNOWN_PUBLIC_KEY_TYPE 127
780 #define EVP_R_UNSUPPORTED_ALGORITHM 128
781 #define EVP_R_UNSUPPORTED_PUBLIC_KEY_TYPE 129
782
783 #endif /* OPENSSL_HEADER_EVP_H */