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_EVP_H 58 #define OPENSSL_HEADER_EVP_H 59 60 #include <openssl/base.h> 61 62 #include <openssl/evp_errors.h> 63 #include <openssl/thread.h> 64 65 // OpenSSL included digest and cipher functions in this header so we include 66 // them for users that still expect that. 67 // 68 // TODO(fork): clean up callers so that they include what they use. 69 #include <openssl/aead.h> 70 #include <openssl/base64.h> 71 #include <openssl/cipher.h> 72 #include <openssl/digest.h> 73 #include <openssl/nid.h> 74 75 #if defined(__cplusplus) 76 extern "C" { 77 #endif 78 79 80 // EVP abstracts over public/private key algorithms. 81 82 83 // Public key objects. 84 // 85 // An |EVP_PKEY| object represents a public or private key. A given object may 86 // be used concurrently on multiple threads by non-mutating functions, provided 87 // no other thread is concurrently calling a mutating function. Unless otherwise 88 // documented, functions which take a |const| pointer are non-mutating and 89 // functions which take a non-|const| pointer are mutating. 90 91 // EVP_PKEY_new creates a new, empty public-key object and returns it or NULL 92 // on allocation failure. 93 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_new(void); 94 95 // EVP_PKEY_free frees all data referenced by |pkey| and then frees |pkey| 96 // itself. 97 OPENSSL_EXPORT void EVP_PKEY_free(EVP_PKEY *pkey); 98 99 // EVP_PKEY_up_ref increments the reference count of |pkey| and returns one. It 100 // does not mutate |pkey| for thread-safety purposes and may be used 101 // concurrently. 102 OPENSSL_EXPORT int EVP_PKEY_up_ref(EVP_PKEY *pkey); 103 104 // EVP_PKEY_is_opaque returns one if |pkey| is opaque. Opaque keys are backed by 105 // custom implementations which do not expose key material and parameters. It is 106 // an error to attempt to duplicate, export, or compare an opaque key. 107 OPENSSL_EXPORT int EVP_PKEY_is_opaque(const EVP_PKEY *pkey); 108 109 // EVP_PKEY_cmp compares |a| and |b| and returns one if they are equal, zero if 110 // not and a negative number on error. 111 // 112 // WARNING: this differs from the traditional return value of a "cmp" 113 // function. 114 OPENSSL_EXPORT int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b); 115 116 // EVP_PKEY_copy_parameters sets the parameters of |to| to equal the parameters 117 // of |from|. It returns one on success and zero on error. 118 OPENSSL_EXPORT int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from); 119 120 // EVP_PKEY_missing_parameters returns one if |pkey| is missing needed 121 // parameters or zero if not, or if the algorithm doesn't take parameters. 122 OPENSSL_EXPORT int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey); 123 124 // EVP_PKEY_size returns the maximum size, in bytes, of a signature signed by 125 // |pkey|. For an RSA key, this returns the number of bytes needed to represent 126 // the modulus. For an EC key, this returns the maximum size of a DER-encoded 127 // ECDSA signature. 128 OPENSSL_EXPORT int EVP_PKEY_size(const EVP_PKEY *pkey); 129 130 // EVP_PKEY_bits returns the "size", in bits, of |pkey|. For an RSA key, this 131 // returns the bit length of the modulus. For an EC key, this returns the bit 132 // length of the group order. 133 OPENSSL_EXPORT int EVP_PKEY_bits(const EVP_PKEY *pkey); 134 135 // EVP_PKEY_id returns the type of |pkey|, which is one of the |EVP_PKEY_*| 136 // values. 137 OPENSSL_EXPORT int EVP_PKEY_id(const EVP_PKEY *pkey); 138 139 // EVP_PKEY_type returns |nid| if |nid| is a known key type and |NID_undef| 140 // otherwise. 141 OPENSSL_EXPORT int EVP_PKEY_type(int nid); 142 143 144 // Getting and setting concrete public key types. 145 // 146 // The following functions get and set the underlying public key in an 147 // |EVP_PKEY| object. The |set1| functions take an additional reference to the 148 // underlying key and return one on success or zero if |key| is NULL. The 149 // |assign| functions adopt the caller's reference and return one on success or 150 // zero if |key| is NULL. The |get1| functions return a fresh reference to the 151 // underlying object or NULL if |pkey| is not of the correct type. The |get0| 152 // functions behave the same but return a non-owning pointer. 153 // 154 // The |get0| and |get1| functions take |const| pointers and are thus 155 // non-mutating for thread-safety purposes, but mutating functions on the 156 // returned lower-level objects are considered to also mutate the |EVP_PKEY| and 157 // may not be called concurrently with other operations on the |EVP_PKEY|. 158 159 OPENSSL_EXPORT int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key); 160 OPENSSL_EXPORT int EVP_PKEY_assign_RSA(EVP_PKEY *pkey, RSA *key); 161 OPENSSL_EXPORT RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey); 162 OPENSSL_EXPORT RSA *EVP_PKEY_get1_RSA(const EVP_PKEY *pkey); 163 164 OPENSSL_EXPORT int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key); 165 OPENSSL_EXPORT int EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key); 166 OPENSSL_EXPORT DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey); 167 OPENSSL_EXPORT DSA *EVP_PKEY_get1_DSA(const EVP_PKEY *pkey); 168 169 OPENSSL_EXPORT int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key); 170 OPENSSL_EXPORT int EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey, EC_KEY *key); 171 OPENSSL_EXPORT EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey); 172 OPENSSL_EXPORT EC_KEY *EVP_PKEY_get1_EC_KEY(const EVP_PKEY *pkey); 173 174 #define EVP_PKEY_NONE NID_undef 175 #define EVP_PKEY_RSA NID_rsaEncryption 176 #define EVP_PKEY_RSA_PSS NID_rsassaPss 177 #define EVP_PKEY_DSA NID_dsa 178 #define EVP_PKEY_EC NID_X9_62_id_ecPublicKey 179 #define EVP_PKEY_ED25519 NID_ED25519 180 #define EVP_PKEY_X25519 NID_X25519 181 182 // EVP_PKEY_assign sets the underlying key of |pkey| to |key|, which must be of 183 // the given type. It returns one if successful or zero if the |type| argument 184 // is not one of the |EVP_PKEY_*| values or if |key| is NULL. 185 OPENSSL_EXPORT int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key); 186 187 // EVP_PKEY_set_type sets the type of |pkey| to |type|. It returns one if 188 // successful or zero if the |type| argument is not one of the |EVP_PKEY_*| 189 // values. If |pkey| is NULL, it simply reports whether the type is known. 190 OPENSSL_EXPORT int EVP_PKEY_set_type(EVP_PKEY *pkey, int type); 191 192 // EVP_PKEY_cmp_parameters compares the parameters of |a| and |b|. It returns 193 // one if they match, zero if not, or a negative number of on error. 194 // 195 // WARNING: the return value differs from the usual return value convention. 196 OPENSSL_EXPORT int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, 197 const EVP_PKEY *b); 198 199 200 // ASN.1 functions 201 202 // EVP_parse_public_key decodes a DER-encoded SubjectPublicKeyInfo structure 203 // (RFC 5280) from |cbs| and advances |cbs|. It returns a newly-allocated 204 // |EVP_PKEY| or NULL on error. If the key is an EC key, the curve is guaranteed 205 // to be set. 206 // 207 // The caller must check the type of the parsed public key to ensure it is 208 // suitable and validate other desired key properties such as RSA modulus size 209 // or EC curve. 210 OPENSSL_EXPORT EVP_PKEY *EVP_parse_public_key(CBS *cbs); 211 212 // EVP_marshal_public_key marshals |key| as a DER-encoded SubjectPublicKeyInfo 213 // structure (RFC 5280) and appends the result to |cbb|. It returns one on 214 // success and zero on error. 215 OPENSSL_EXPORT int EVP_marshal_public_key(CBB *cbb, const EVP_PKEY *key); 216 217 // EVP_parse_private_key decodes a DER-encoded PrivateKeyInfo structure (RFC 218 // 5208) from |cbs| and advances |cbs|. It returns a newly-allocated |EVP_PKEY| 219 // or NULL on error. 220 // 221 // The caller must check the type of the parsed private key to ensure it is 222 // suitable and validate other desired key properties such as RSA modulus size 223 // or EC curve. In particular, RSA private key operations scale cubicly, so 224 // applications accepting RSA private keys from external sources may need to 225 // bound key sizes (use |EVP_PKEY_bits| or |RSA_bits|) to avoid a DoS vector. 226 // 227 // A PrivateKeyInfo ends with an optional set of attributes. These are not 228 // processed and so this function will silently ignore any trailing data in the 229 // structure. 230 OPENSSL_EXPORT EVP_PKEY *EVP_parse_private_key(CBS *cbs); 231 232 // EVP_marshal_private_key marshals |key| as a DER-encoded PrivateKeyInfo 233 // structure (RFC 5208) and appends the result to |cbb|. It returns one on 234 // success and zero on error. 235 OPENSSL_EXPORT int EVP_marshal_private_key(CBB *cbb, const EVP_PKEY *key); 236 237 238 // Raw keys 239 // 240 // Some keys types support a "raw" serialization. Currently the only supported 241 // raw format is Ed25519, where the public key and private key formats are those 242 // specified in RFC 8032. Note the RFC 8032 private key format is the 32-byte 243 // prefix of |ED25519_sign|'s 64-byte private key. 244 245 // EVP_PKEY_new_raw_private_key returns a newly allocated |EVP_PKEY| wrapping a 246 // private key of the specified type. It returns one on success and zero on 247 // error. 248 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *unused, 249 const uint8_t *in, 250 size_t len); 251 252 // EVP_PKEY_new_raw_public_key returns a newly allocated |EVP_PKEY| wrapping a 253 // public key of the specified type. It returns one on success and zero on 254 // error. 255 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *unused, 256 const uint8_t *in, 257 size_t len); 258 259 // EVP_PKEY_get_raw_private_key outputs the private key for |pkey| in raw form. 260 // If |out| is NULL, it sets |*out_len| to the size of the raw private key. 261 // Otherwise, it writes at most |*out_len| bytes to |out| and sets |*out_len| to 262 // the number of bytes written. 263 // 264 // It returns one on success and zero if |pkey| has no private key, the key 265 // type does not support a raw format, or the buffer is too small. 266 OPENSSL_EXPORT int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, 267 uint8_t *out, size_t *out_len); 268 269 // EVP_PKEY_get_raw_public_key outputs the public key for |pkey| in raw form. 270 // If |out| is NULL, it sets |*out_len| to the size of the raw public key. 271 // Otherwise, it writes at most |*out_len| bytes to |out| and sets |*out_len| to 272 // the number of bytes written. 273 // 274 // It returns one on success and zero if |pkey| has no public key, the key 275 // type does not support a raw format, or the buffer is too small. 276 OPENSSL_EXPORT int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, 277 uint8_t *out, size_t *out_len); 278 279 280 // Signing 281 282 // EVP_DigestSignInit sets up |ctx| for a signing operation with |type| and 283 // |pkey|. The |ctx| argument must have been initialised with 284 // |EVP_MD_CTX_init|. If |pctx| is not NULL, the |EVP_PKEY_CTX| of the signing 285 // operation will be written to |*pctx|; this can be used to set alternative 286 // signing options. 287 // 288 // For single-shot signing algorithms which do not use a pre-hash, such as 289 // Ed25519, |type| should be NULL. The |EVP_MD_CTX| itself is unused but is 290 // present so the API is uniform. See |EVP_DigestSign|. 291 // 292 // This function does not mutate |pkey| for thread-safety purposes and may be 293 // used concurrently with other non-mutating functions on |pkey|. 294 // 295 // It returns one on success, or zero on error. 296 OPENSSL_EXPORT int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, 297 const EVP_MD *type, ENGINE *e, 298 EVP_PKEY *pkey); 299 300 // EVP_DigestSignUpdate appends |len| bytes from |data| to the data which will 301 // be signed in |EVP_DigestSignFinal|. It returns one. 302 // 303 // This function performs a streaming signing operation and will fail for 304 // signature algorithms which do not support this. Use |EVP_DigestSign| for a 305 // single-shot operation. 306 OPENSSL_EXPORT int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, 307 size_t len); 308 309 // EVP_DigestSignFinal signs the data that has been included by one or more 310 // calls to |EVP_DigestSignUpdate|. If |out_sig| is NULL then |*out_sig_len| is 311 // set to the maximum number of output bytes. Otherwise, on entry, 312 // |*out_sig_len| must contain the length of the |out_sig| buffer. If the call 313 // is successful, the signature is written to |out_sig| and |*out_sig_len| is 314 // set to its length. 315 // 316 // This function performs a streaming signing operation and will fail for 317 // signature algorithms which do not support this. Use |EVP_DigestSign| for a 318 // single-shot operation. 319 // 320 // It returns one on success, or zero on error. 321 OPENSSL_EXPORT int EVP_DigestSignFinal(EVP_MD_CTX *ctx, uint8_t *out_sig, 322 size_t *out_sig_len); 323 324 // EVP_DigestSign signs |data_len| bytes from |data| using |ctx|. If |out_sig| 325 // is NULL then |*out_sig_len| is set to the maximum number of output 326 // bytes. Otherwise, on entry, |*out_sig_len| must contain the length of the 327 // |out_sig| buffer. If the call is successful, the signature is written to 328 // |out_sig| and |*out_sig_len| is set to its length. 329 // 330 // It returns one on success and zero on error. 331 OPENSSL_EXPORT int EVP_DigestSign(EVP_MD_CTX *ctx, uint8_t *out_sig, 332 size_t *out_sig_len, const uint8_t *data, 333 size_t data_len); 334 335 336 // Verifying 337 338 // EVP_DigestVerifyInit sets up |ctx| for a signature verification operation 339 // with |type| and |pkey|. The |ctx| argument must have been initialised with 340 // |EVP_MD_CTX_init|. If |pctx| is not NULL, the |EVP_PKEY_CTX| of the signing 341 // operation will be written to |*pctx|; this can be used to set alternative 342 // signing options. 343 // 344 // For single-shot signing algorithms which do not use a pre-hash, such as 345 // Ed25519, |type| should be NULL. The |EVP_MD_CTX| itself is unused but is 346 // present so the API is uniform. See |EVP_DigestVerify|. 347 // 348 // This function does not mutate |pkey| for thread-safety purposes and may be 349 // used concurrently with other non-mutating functions on |pkey|. 350 // 351 // It returns one on success, or zero on error. 352 OPENSSL_EXPORT int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, 353 const EVP_MD *type, ENGINE *e, 354 EVP_PKEY *pkey); 355 356 // EVP_DigestVerifyUpdate appends |len| bytes from |data| to the data which 357 // will be verified by |EVP_DigestVerifyFinal|. It returns one. 358 // 359 // This function performs streaming signature verification and will fail for 360 // signature algorithms which do not support this. Use |EVP_PKEY_verify_message| 361 // for a single-shot verification. 362 OPENSSL_EXPORT int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, 363 size_t len); 364 365 // EVP_DigestVerifyFinal verifies that |sig_len| bytes of |sig| are a valid 366 // signature for the data that has been included by one or more calls to 367 // |EVP_DigestVerifyUpdate|. It returns one on success and zero otherwise. 368 // 369 // This function performs streaming signature verification and will fail for 370 // signature algorithms which do not support this. Use |EVP_PKEY_verify_message| 371 // for a single-shot verification. 372 OPENSSL_EXPORT int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const uint8_t *sig, 373 size_t sig_len); 374 375 // EVP_DigestVerify verifies that |sig_len| bytes from |sig| are a valid 376 // signature for |data|. It returns one on success or zero on error. 377 OPENSSL_EXPORT int EVP_DigestVerify(EVP_MD_CTX *ctx, const uint8_t *sig, 378 size_t sig_len, const uint8_t *data, 379 size_t len); 380 381 382 // Signing (old functions) 383 384 // EVP_SignInit_ex configures |ctx|, which must already have been initialised, 385 // for a fresh signing operation using the hash function |type|. It returns one 386 // on success and zero otherwise. 387 // 388 // (In order to initialise |ctx|, either obtain it initialised with 389 // |EVP_MD_CTX_create|, or use |EVP_MD_CTX_init|.) 390 OPENSSL_EXPORT int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, 391 ENGINE *impl); 392 393 // EVP_SignInit is a deprecated version of |EVP_SignInit_ex|. 394 // 395 // TODO(fork): remove. 396 OPENSSL_EXPORT int EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type); 397 398 // EVP_SignUpdate appends |len| bytes from |data| to the data which will be 399 // signed in |EVP_SignFinal|. 400 OPENSSL_EXPORT int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *data, 401 size_t len); 402 403 // EVP_SignFinal signs the data that has been included by one or more calls to 404 // |EVP_SignUpdate|, using the key |pkey|, and writes it to |sig|. On entry, 405 // |sig| must point to at least |EVP_PKEY_size(pkey)| bytes of space. The 406 // actual size of the signature is written to |*out_sig_len|. 407 // 408 // It returns one on success and zero otherwise. 409 // 410 // It does not modify |ctx|, thus it's possible to continue to use |ctx| in 411 // order to sign a longer message. It also does not mutate |pkey| for 412 // thread-safety purposes and may be used concurrently with other non-mutating 413 // functions on |pkey|. 414 OPENSSL_EXPORT int EVP_SignFinal(const EVP_MD_CTX *ctx, uint8_t *sig, 415 unsigned int *out_sig_len, EVP_PKEY *pkey); 416 417 418 // Verifying (old functions) 419 420 // EVP_VerifyInit_ex configures |ctx|, which must already have been 421 // initialised, for a fresh signature verification operation using the hash 422 // function |type|. It returns one on success and zero otherwise. 423 // 424 // (In order to initialise |ctx|, either obtain it initialised with 425 // |EVP_MD_CTX_create|, or use |EVP_MD_CTX_init|.) 426 OPENSSL_EXPORT int EVP_VerifyInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, 427 ENGINE *impl); 428 429 // EVP_VerifyInit is a deprecated version of |EVP_VerifyInit_ex|. 430 // 431 // TODO(fork): remove. 432 OPENSSL_EXPORT int EVP_VerifyInit(EVP_MD_CTX *ctx, const EVP_MD *type); 433 434 // EVP_VerifyUpdate appends |len| bytes from |data| to the data which will be 435 // signed in |EVP_VerifyFinal|. 436 OPENSSL_EXPORT int EVP_VerifyUpdate(EVP_MD_CTX *ctx, const void *data, 437 size_t len); 438 439 // EVP_VerifyFinal verifies that |sig_len| bytes of |sig| are a valid 440 // signature, by |pkey|, for the data that has been included by one or more 441 // calls to |EVP_VerifyUpdate|. 442 // 443 // It returns one on success and zero otherwise. 444 // 445 // It does not modify |ctx|, thus it's possible to continue to use |ctx| in 446 // order to verify a longer message. It also does not mutate |pkey| for 447 // thread-safety purposes and may be used concurrently with other non-mutating 448 // functions on |pkey|. 449 OPENSSL_EXPORT int EVP_VerifyFinal(EVP_MD_CTX *ctx, const uint8_t *sig, 450 size_t sig_len, EVP_PKEY *pkey); 451 452 453 // Printing 454 455 // EVP_PKEY_print_public prints a textual representation of the public key in 456 // |pkey| to |out|. Returns one on success or zero otherwise. 457 OPENSSL_EXPORT int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey, 458 int indent, ASN1_PCTX *pctx); 459 460 // EVP_PKEY_print_private prints a textual representation of the private key in 461 // |pkey| to |out|. Returns one on success or zero otherwise. 462 OPENSSL_EXPORT int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey, 463 int indent, ASN1_PCTX *pctx); 464 465 // EVP_PKEY_print_params prints a textual representation of the parameters in 466 // |pkey| to |out|. Returns one on success or zero otherwise. 467 OPENSSL_EXPORT int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey, 468 int indent, ASN1_PCTX *pctx); 469 470 471 // Password stretching. 472 // 473 // Password stretching functions take a low-entropy password and apply a slow 474 // function that results in a key suitable for use in symmetric 475 // cryptography. 476 477 // PKCS5_PBKDF2_HMAC computes |iterations| iterations of PBKDF2 of |password| 478 // and |salt|, using |digest|, and outputs |key_len| bytes to |out_key|. It 479 // returns one on success and zero on allocation failure or if iterations is 0. 480 OPENSSL_EXPORT int PKCS5_PBKDF2_HMAC(const char *password, size_t password_len, 481 const uint8_t *salt, size_t salt_len, 482 unsigned iterations, const EVP_MD *digest, 483 size_t key_len, uint8_t *out_key); 484 485 // PKCS5_PBKDF2_HMAC_SHA1 is the same as PKCS5_PBKDF2_HMAC, but with |digest| 486 // fixed to |EVP_sha1|. 487 OPENSSL_EXPORT int PKCS5_PBKDF2_HMAC_SHA1(const char *password, 488 size_t password_len, 489 const uint8_t *salt, size_t salt_len, 490 unsigned iterations, size_t key_len, 491 uint8_t *out_key); 492 493 // EVP_PBE_scrypt expands |password| into a secret key of length |key_len| using 494 // scrypt, as described in RFC 7914, and writes the result to |out_key|. It 495 // returns one on success and zero on allocation failure, if the memory required 496 // for the operation exceeds |max_mem|, or if any of the parameters are invalid 497 // as described below. 498 // 499 // |N|, |r|, and |p| are as described in RFC 7914 section 6. They determine the 500 // cost of the operation. If |max_mem| is zero, a defult limit of 32MiB will be 501 // used. 502 // 503 // The parameters are considered invalid under any of the following conditions: 504 // - |r| or |p| are zero 505 // - |p| > (2^30 - 1) / |r| 506 // - |N| is not a power of two 507 // - |N| > 2^32 508 // - |N| > 2^(128 * |r| / 8) 509 OPENSSL_EXPORT int EVP_PBE_scrypt(const char *password, size_t password_len, 510 const uint8_t *salt, size_t salt_len, 511 uint64_t N, uint64_t r, uint64_t p, 512 size_t max_mem, uint8_t *out_key, 513 size_t key_len); 514 515 516 // Public key contexts. 517 // 518 // |EVP_PKEY_CTX| objects hold the context of an operation (e.g. signing or 519 // encrypting) that uses a public key. 520 521 // EVP_PKEY_CTX_new allocates a fresh |EVP_PKEY_CTX| for use with |pkey|. It 522 // returns the context or NULL on error. 523 OPENSSL_EXPORT EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e); 524 525 // EVP_PKEY_CTX_new_id allocates a fresh |EVP_PKEY_CTX| for a key of type |id| 526 // (e.g. |EVP_PKEY_HMAC|). This can be used for key generation where 527 // |EVP_PKEY_CTX_new| can't be used because there isn't an |EVP_PKEY| to pass 528 // it. It returns the context or NULL on error. 529 OPENSSL_EXPORT EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e); 530 531 // EVP_PKEY_CTX_free frees |ctx| and the data it owns. 532 OPENSSL_EXPORT void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx); 533 534 // EVP_PKEY_CTX_dup allocates a fresh |EVP_PKEY_CTX| and sets it equal to the 535 // state of |ctx|. It returns the fresh |EVP_PKEY_CTX| or NULL on error. 536 OPENSSL_EXPORT EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *ctx); 537 538 // EVP_PKEY_CTX_get0_pkey returns the |EVP_PKEY| associated with |ctx|. 539 OPENSSL_EXPORT EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx); 540 541 // EVP_PKEY_sign_init initialises an |EVP_PKEY_CTX| for a signing operation. It 542 // should be called before |EVP_PKEY_sign|. 543 // 544 // It returns one on success or zero on error. 545 OPENSSL_EXPORT int EVP_PKEY_sign_init(EVP_PKEY_CTX *ctx); 546 547 // EVP_PKEY_sign signs |digest_len| bytes from |digest| using |ctx|. If |sig| is 548 // NULL, the maximum size of the signature is written to |out_sig_len|. 549 // Otherwise, |*sig_len| must contain the number of bytes of space available at 550 // |sig|. If sufficient, the signature will be written to |sig| and |*sig_len| 551 // updated with the true length. This function will fail for signature 552 // algorithms like Ed25519 that do not support signing pre-hashed inputs. 553 // 554 // WARNING: |digest| must be the output of some hash function on the data to be 555 // signed. Passing unhashed inputs will not result in a secure signature scheme. 556 // Use |EVP_DigestSignInit| to sign an unhashed input. 557 // 558 // WARNING: Setting |sig| to NULL only gives the maximum size of the 559 // signature. The actual signature may be smaller. 560 // 561 // It returns one on success or zero on error. (Note: this differs from 562 // OpenSSL, which can also return negative values to indicate an error. ) 563 OPENSSL_EXPORT int EVP_PKEY_sign(EVP_PKEY_CTX *ctx, uint8_t *sig, 564 size_t *sig_len, const uint8_t *digest, 565 size_t digest_len); 566 567 // EVP_PKEY_verify_init initialises an |EVP_PKEY_CTX| for a signature 568 // verification operation. It should be called before |EVP_PKEY_verify|. 569 // 570 // It returns one on success or zero on error. 571 OPENSSL_EXPORT int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx); 572 573 // EVP_PKEY_verify verifies that |sig_len| bytes from |sig| are a valid 574 // signature for |digest|. This function will fail for signature 575 // algorithms like Ed25519 that do not support signing pre-hashed inputs. 576 // 577 // WARNING: |digest| must be the output of some hash function on the data to be 578 // verified. Passing unhashed inputs will not result in a secure signature 579 // scheme. Use |EVP_DigestVerifyInit| to verify a signature given the unhashed 580 // input. 581 // 582 // It returns one on success or zero on error. 583 OPENSSL_EXPORT int EVP_PKEY_verify(EVP_PKEY_CTX *ctx, const uint8_t *sig, 584 size_t sig_len, const uint8_t *digest, 585 size_t digest_len); 586 587 // EVP_PKEY_encrypt_init initialises an |EVP_PKEY_CTX| for an encryption 588 // operation. It should be called before |EVP_PKEY_encrypt|. 589 // 590 // It returns one on success or zero on error. 591 OPENSSL_EXPORT int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx); 592 593 // EVP_PKEY_encrypt encrypts |in_len| bytes from |in|. If |out| is NULL, the 594 // maximum size of the ciphertext is written to |out_len|. Otherwise, |*out_len| 595 // must contain the number of bytes of space available at |out|. If sufficient, 596 // the ciphertext will be written to |out| and |*out_len| updated with the true 597 // length. 598 // 599 // WARNING: Setting |out| to NULL only gives the maximum size of the 600 // ciphertext. The actual ciphertext may be smaller. 601 // 602 // It returns one on success or zero on error. 603 OPENSSL_EXPORT int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx, uint8_t *out, 604 size_t *out_len, const uint8_t *in, 605 size_t in_len); 606 607 // EVP_PKEY_decrypt_init initialises an |EVP_PKEY_CTX| for a decryption 608 // operation. It should be called before |EVP_PKEY_decrypt|. 609 // 610 // It returns one on success or zero on error. 611 OPENSSL_EXPORT int EVP_PKEY_decrypt_init(EVP_PKEY_CTX *ctx); 612 613 // EVP_PKEY_decrypt decrypts |in_len| bytes from |in|. If |out| is NULL, the 614 // maximum size of the plaintext is written to |out_len|. Otherwise, |*out_len| 615 // must contain the number of bytes of space available at |out|. If sufficient, 616 // the ciphertext will be written to |out| and |*out_len| updated with the true 617 // length. 618 // 619 // WARNING: Setting |out| to NULL only gives the maximum size of the 620 // plaintext. The actual plaintext may be smaller. 621 // 622 // It returns one on success or zero on error. 623 OPENSSL_EXPORT int EVP_PKEY_decrypt(EVP_PKEY_CTX *ctx, uint8_t *out, 624 size_t *out_len, const uint8_t *in, 625 size_t in_len); 626 627 // EVP_PKEY_verify_recover_init initialises an |EVP_PKEY_CTX| for a public-key 628 // decryption operation. It should be called before |EVP_PKEY_verify_recover|. 629 // 630 // Public-key decryption is a very obscure operation that is only implemented 631 // by RSA keys. It is effectively a signature verification operation that 632 // returns the signed message directly. It is almost certainly not what you 633 // want. 634 // 635 // It returns one on success or zero on error. 636 OPENSSL_EXPORT int EVP_PKEY_verify_recover_init(EVP_PKEY_CTX *ctx); 637 638 // EVP_PKEY_verify_recover decrypts |sig_len| bytes from |sig|. If |out| is 639 // NULL, the maximum size of the plaintext is written to |out_len|. Otherwise, 640 // |*out_len| must contain the number of bytes of space available at |out|. If 641 // sufficient, the ciphertext will be written to |out| and |*out_len| updated 642 // with the true length. 643 // 644 // WARNING: Setting |out| to NULL only gives the maximum size of the 645 // plaintext. The actual plaintext may be smaller. 646 // 647 // See the warning about this operation in |EVP_PKEY_verify_recover_init|. It 648 // is probably not what you want. 649 // 650 // It returns one on success or zero on error. 651 OPENSSL_EXPORT int EVP_PKEY_verify_recover(EVP_PKEY_CTX *ctx, uint8_t *out, 652 size_t *out_len, const uint8_t *sig, 653 size_t siglen); 654 655 // EVP_PKEY_derive_init initialises an |EVP_PKEY_CTX| for a key derivation 656 // operation. It should be called before |EVP_PKEY_derive_set_peer| and 657 // |EVP_PKEY_derive|. 658 // 659 // It returns one on success or zero on error. 660 OPENSSL_EXPORT int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx); 661 662 // EVP_PKEY_derive_set_peer sets the peer's key to be used for key derivation 663 // by |ctx| to |peer|. It should be called after |EVP_PKEY_derive_init|. (For 664 // example, this is used to set the peer's key in (EC)DH.) It returns one on 665 // success and zero on error. 666 OPENSSL_EXPORT int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer); 667 668 // EVP_PKEY_derive derives a shared key between the two keys configured in 669 // |ctx|. If |key| is non-NULL then, on entry, |out_key_len| must contain the 670 // amount of space at |key|. If sufficient then the shared key will be written 671 // to |key| and |*out_key_len| will be set to the length. If |key| is NULL then 672 // |out_key_len| will be set to the maximum length. 673 // 674 // WARNING: Setting |out| to NULL only gives the maximum size of the key. The 675 // actual key may be smaller. 676 // 677 // It returns one on success and zero on error. 678 OPENSSL_EXPORT int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, uint8_t *key, 679 size_t *out_key_len); 680 681 // EVP_PKEY_keygen_init initialises an |EVP_PKEY_CTX| for a key generation 682 // operation. It should be called before |EVP_PKEY_keygen|. 683 // 684 // It returns one on success or zero on error. 685 OPENSSL_EXPORT int EVP_PKEY_keygen_init(EVP_PKEY_CTX *ctx); 686 687 // EVP_PKEY_keygen performs a key generation operation using the values from 688 // |ctx|. If |*out_pkey| is non-NULL, it overwrites |*out_pkey| with the 689 // resulting key. Otherwise, it sets |*out_pkey| to a newly-allocated |EVP_PKEY| 690 // containing the result. It returns one on success or zero on error. 691 OPENSSL_EXPORT int EVP_PKEY_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY **out_pkey); 692 693 // EVP_PKEY_paramgen_init initialises an |EVP_PKEY_CTX| for a parameter 694 // generation operation. It should be called before |EVP_PKEY_paramgen|. 695 // 696 // It returns one on success or zero on error. 697 OPENSSL_EXPORT int EVP_PKEY_paramgen_init(EVP_PKEY_CTX *ctx); 698 699 // EVP_PKEY_paramgen performs a parameter generation using the values from 700 // |ctx|. If |*out_pkey| is non-NULL, it overwrites |*out_pkey| with the 701 // resulting parameters, but no key. Otherwise, it sets |*out_pkey| to a 702 // newly-allocated |EVP_PKEY| containing the result. It returns one on success 703 // or zero on error. 704 OPENSSL_EXPORT int EVP_PKEY_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY **out_pkey); 705 706 707 // Generic control functions. 708 709 // EVP_PKEY_CTX_set_signature_md sets |md| as the digest to be used in a 710 // signature operation. It returns one on success or zero on error. 711 OPENSSL_EXPORT int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, 712 const EVP_MD *md); 713 714 // EVP_PKEY_CTX_get_signature_md sets |*out_md| to the digest to be used in a 715 // signature operation. It returns one on success or zero on error. 716 OPENSSL_EXPORT int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, 717 const EVP_MD **out_md); 718 719 720 // RSA specific control functions. 721 722 // EVP_PKEY_CTX_set_rsa_padding sets the padding type to use. It should be one 723 // of the |RSA_*_PADDING| values. Returns one on success or zero on error. By 724 // default, the padding is |RSA_PKCS1_PADDING|. 725 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int padding); 726 727 // EVP_PKEY_CTX_get_rsa_padding sets |*out_padding| to the current padding 728 // value, which is one of the |RSA_*_PADDING| values. Returns one on success or 729 // zero on error. 730 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx, 731 int *out_padding); 732 733 // EVP_PKEY_CTX_set_rsa_pss_saltlen sets the length of the salt in a PSS-padded 734 // signature. A value of -1 cause the salt to be the same length as the digest 735 // in the signature. A value of -2 causes the salt to be the maximum length 736 // that will fit when signing and recovered from the signature when verifying. 737 // Otherwise the value gives the size of the salt in bytes. 738 // 739 // If unsure, use -1. 740 // 741 // Returns one on success or zero on error. 742 // 743 // TODO(davidben): The default is currently -2. Switch it to -1. 744 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, 745 int salt_len); 746 747 // EVP_PKEY_CTX_get_rsa_pss_saltlen sets |*out_salt_len| to the salt length of 748 // a PSS-padded signature. See the documentation for 749 // |EVP_PKEY_CTX_set_rsa_pss_saltlen| for details of the special values that it 750 // can take. 751 // 752 // Returns one on success or zero on error. 753 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, 754 int *out_salt_len); 755 756 // EVP_PKEY_CTX_set_rsa_keygen_bits sets the size of the desired RSA modulus, 757 // in bits, for key generation. Returns one on success or zero on 758 // error. 759 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx, 760 int bits); 761 762 // EVP_PKEY_CTX_set_rsa_keygen_pubexp sets |e| as the public exponent for key 763 // generation. Returns one on success or zero on error. 764 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, 765 BIGNUM *e); 766 767 // EVP_PKEY_CTX_set_rsa_oaep_md sets |md| as the digest used in OAEP padding. 768 // Returns one on success or zero on error. If unset, the default is SHA-1. 769 // Callers are recommended to overwrite this default. 770 // 771 // TODO(davidben): Remove the default and require callers specify this. 772 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx, 773 const EVP_MD *md); 774 775 // EVP_PKEY_CTX_get_rsa_oaep_md sets |*out_md| to the digest function used in 776 // OAEP padding. Returns one on success or zero on error. 777 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx, 778 const EVP_MD **out_md); 779 780 // EVP_PKEY_CTX_set_rsa_mgf1_md sets |md| as the digest used in MGF1. Returns 781 // one on success or zero on error. 782 // 783 // If unset, the default is the signing hash for |RSA_PKCS1_PSS_PADDING| and the 784 // OAEP hash for |RSA_PKCS1_OAEP_PADDING|. Callers are recommended to use this 785 // default and not call this function. 786 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx, 787 const EVP_MD *md); 788 789 // EVP_PKEY_CTX_get_rsa_mgf1_md sets |*out_md| to the digest function used in 790 // MGF1. Returns one on success or zero on error. 791 OPENSSL_EXPORT int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx, 792 const EVP_MD **out_md); 793 794 // EVP_PKEY_CTX_set0_rsa_oaep_label sets |label_len| bytes from |label| as the 795 // label used in OAEP. DANGER: On success, this call takes ownership of |label| 796 // and will call |OPENSSL_free| on it when |ctx| is destroyed. 797 // 798 // Returns one on success or zero on error. 799 OPENSSL_EXPORT int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx, 800 uint8_t *label, 801 size_t label_len); 802 803 // EVP_PKEY_CTX_get0_rsa_oaep_label sets |*out_label| to point to the internal 804 // buffer containing the OAEP label (which may be NULL) and returns the length 805 // of the label or a negative value on error. 806 // 807 // WARNING: the return value differs from the usual return value convention. 808 OPENSSL_EXPORT int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx, 809 const uint8_t **out_label); 810 811 812 // EC specific control functions. 813 814 // EVP_PKEY_CTX_set_ec_paramgen_curve_nid sets the curve used for 815 // |EVP_PKEY_keygen| or |EVP_PKEY_paramgen| operations to |nid|. It returns one 816 // on success and zero on error. 817 OPENSSL_EXPORT int EVP_PKEY_CTX_set_ec_paramgen_curve_nid(EVP_PKEY_CTX *ctx, 818 int nid); 819 820 821 // Deprecated functions. 822 823 // EVP_PKEY_DH is defined for compatibility, but it is impossible to create an 824 // |EVP_PKEY| of that type. 825 #define EVP_PKEY_DH NID_dhKeyAgreement 826 827 // EVP_PKEY_RSA2 was historically an alternate form for RSA public keys (OID 828 // 2.5.8.1.1), but is no longer accepted. 829 #define EVP_PKEY_RSA2 NID_rsa 830 831 // EVP_PKEY_X448 is defined for OpenSSL compatibility, but we do not support 832 // X448 and attempts to create keys will fail. 833 #define EVP_PKEY_X448 NID_X448 834 835 // EVP_PKEY_ED448 is defined for OpenSSL compatibility, but we do not support 836 // Ed448 and attempts to create keys will fail. 837 #define EVP_PKEY_ED448 NID_ED448 838 839 // EVP_PKEY_get0 returns NULL. This function is provided for compatibility with 840 // OpenSSL but does not return anything. Use the typed |EVP_PKEY_get0_*| 841 // functions instead. 842 OPENSSL_EXPORT void *EVP_PKEY_get0(const EVP_PKEY *pkey); 843 844 // OpenSSL_add_all_algorithms does nothing. 845 OPENSSL_EXPORT void OpenSSL_add_all_algorithms(void); 846 847 // OPENSSL_add_all_algorithms_conf does nothing. 848 OPENSSL_EXPORT void OPENSSL_add_all_algorithms_conf(void); 849 850 // OpenSSL_add_all_ciphers does nothing. 851 OPENSSL_EXPORT void OpenSSL_add_all_ciphers(void); 852 853 // OpenSSL_add_all_digests does nothing. 854 OPENSSL_EXPORT void OpenSSL_add_all_digests(void); 855 856 // EVP_cleanup does nothing. 857 OPENSSL_EXPORT void EVP_cleanup(void); 858 859 OPENSSL_EXPORT void EVP_CIPHER_do_all_sorted( 860 void (*callback)(const EVP_CIPHER *cipher, const char *name, 861 const char *unused, void *arg), 862 void *arg); 863 864 OPENSSL_EXPORT void EVP_MD_do_all_sorted(void (*callback)(const EVP_MD *cipher, 865 const char *name, 866 const char *unused, 867 void *arg), 868 void *arg); 869 870 OPENSSL_EXPORT void EVP_MD_do_all(void (*callback)(const EVP_MD *cipher, 871 const char *name, 872 const char *unused, 873 void *arg), 874 void *arg); 875 876 // i2d_PrivateKey marshals a private key from |key| to type-specific format, as 877 // described in |i2d_SAMPLE|. 878 // 879 // RSA keys are serialized as a DER-encoded RSAPublicKey (RFC 8017) structure. 880 // EC keys are serialized as a DER-encoded ECPrivateKey (RFC 5915) structure. 881 // 882 // Use |RSA_marshal_private_key| or |EC_KEY_marshal_private_key| instead. 883 OPENSSL_EXPORT int i2d_PrivateKey(const EVP_PKEY *key, uint8_t **outp); 884 885 // i2d_PublicKey marshals a public key from |key| to a type-specific format, as 886 // described in |i2d_SAMPLE|. 887 // 888 // RSA keys are serialized as a DER-encoded RSAPublicKey (RFC 8017) structure. 889 // EC keys are serialized as an EC point per SEC 1. 890 // 891 // Use |RSA_marshal_public_key| or |EC_POINT_point2cbb| instead. 892 OPENSSL_EXPORT int i2d_PublicKey(const EVP_PKEY *key, uint8_t **outp); 893 894 // d2i_PrivateKey parses a DER-encoded private key from |len| bytes at |*inp|, 895 // as described in |d2i_SAMPLE|. The private key must have type |type|, 896 // otherwise it will be rejected. 897 // 898 // This function tries to detect one of several formats. Instead, use 899 // |EVP_parse_private_key| for a PrivateKeyInfo, |RSA_parse_private_key| for an 900 // RSAPrivateKey, and |EC_parse_private_key| for an ECPrivateKey. 901 OPENSSL_EXPORT EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **out, 902 const uint8_t **inp, long len); 903 904 // d2i_AutoPrivateKey acts the same as |d2i_PrivateKey|, but detects the type 905 // of the private key. 906 // 907 // This function tries to detect one of several formats. Instead, use 908 // |EVP_parse_private_key| for a PrivateKeyInfo, |RSA_parse_private_key| for an 909 // RSAPrivateKey, and |EC_parse_private_key| for an ECPrivateKey. 910 OPENSSL_EXPORT EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **out, const uint8_t **inp, 911 long len); 912 913 // d2i_PublicKey parses a public key from |len| bytes at |*inp| in a type- 914 // specific format specified by |type|, as described in |d2i_SAMPLE|. 915 // 916 // The only supported value for |type| is |EVP_PKEY_RSA|, which parses a 917 // DER-encoded RSAPublicKey (RFC 8017) structure. Parsing EC keys is not 918 // supported by this function. 919 // 920 // Use |RSA_parse_public_key| instead. 921 OPENSSL_EXPORT EVP_PKEY *d2i_PublicKey(int type, EVP_PKEY **out, 922 const uint8_t **inp, long len); 923 924 // EVP_PKEY_get0_DH returns NULL. 925 OPENSSL_EXPORT DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey); 926 927 // EVP_PKEY_get1_DH returns NULL. 928 OPENSSL_EXPORT DH *EVP_PKEY_get1_DH(const EVP_PKEY *pkey); 929 930 // EVP_PKEY_CTX_set_ec_param_enc returns one if |encoding| is 931 // |OPENSSL_EC_NAMED_CURVE| or zero with an error otherwise. 932 OPENSSL_EXPORT int EVP_PKEY_CTX_set_ec_param_enc(EVP_PKEY_CTX *ctx, 933 int encoding); 934 935 // EVP_PKEY_set1_tls_encodedpoint replaces |pkey| with a public key encoded by 936 // |in|. It returns one on success and zero on error. 937 // 938 // This function only works on X25519 keys. 939 OPENSSL_EXPORT int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey, 940 const uint8_t *in, 941 size_t len); 942 943 // EVP_PKEY_get1_tls_encodedpoint sets |*out_ptr| to a newly-allocated buffer 944 // containing the raw encoded public key for |pkey|. The caller must call 945 // |OPENSSL_free| to release this buffer. The function returns the length of the 946 // buffer on success and zero on error. 947 // 948 // This function only works on X25519 keys. 949 OPENSSL_EXPORT size_t EVP_PKEY_get1_tls_encodedpoint(const EVP_PKEY *pkey, 950 uint8_t **out_ptr); 951 952 // EVP_PKEY_base_id calls |EVP_PKEY_id|. 953 OPENSSL_EXPORT int EVP_PKEY_base_id(const EVP_PKEY *pkey); 954 955 // EVP_PKEY_CTX_set_rsa_pss_keygen_md returns 0. 956 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_pss_keygen_md(EVP_PKEY_CTX *ctx, 957 const EVP_MD *md); 958 959 // EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen returns 0. 960 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen(EVP_PKEY_CTX *ctx, 961 int salt_len); 962 963 // EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md returns 0. 964 OPENSSL_EXPORT int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md(EVP_PKEY_CTX *ctx, 965 const EVP_MD *md); 966 967 // i2d_PUBKEY marshals |pkey| as a DER-encoded SubjectPublicKeyInfo, as 968 // described in |i2d_SAMPLE|. 969 // 970 // Use |EVP_marshal_public_key| instead. 971 OPENSSL_EXPORT int i2d_PUBKEY(const EVP_PKEY *pkey, uint8_t **outp); 972 973 // d2i_PUBKEY parses a DER-encoded SubjectPublicKeyInfo from |len| bytes at 974 // |*inp|, as described in |d2i_SAMPLE|. 975 // 976 // Use |EVP_parse_public_key| instead. 977 OPENSSL_EXPORT EVP_PKEY *d2i_PUBKEY(EVP_PKEY **out, const uint8_t **inp, 978 long len); 979 980 // i2d_RSA_PUBKEY marshals |rsa| as a DER-encoded SubjectPublicKeyInfo 981 // structure, as described in |i2d_SAMPLE|. 982 // 983 // Use |EVP_marshal_public_key| instead. 984 OPENSSL_EXPORT int i2d_RSA_PUBKEY(const RSA *rsa, uint8_t **outp); 985 986 // d2i_RSA_PUBKEY parses an RSA public key as a DER-encoded SubjectPublicKeyInfo 987 // from |len| bytes at |*inp|, as described in |d2i_SAMPLE|. 988 // SubjectPublicKeyInfo structures containing other key types are rejected. 989 // 990 // Use |EVP_parse_public_key| instead. 991 OPENSSL_EXPORT RSA *d2i_RSA_PUBKEY(RSA **out, const uint8_t **inp, long len); 992 993 // i2d_DSA_PUBKEY marshals |dsa| as a DER-encoded SubjectPublicKeyInfo, as 994 // described in |i2d_SAMPLE|. 995 // 996 // Use |EVP_marshal_public_key| instead. 997 OPENSSL_EXPORT int i2d_DSA_PUBKEY(const DSA *dsa, uint8_t **outp); 998 999 // d2i_DSA_PUBKEY parses a DSA public key as a DER-encoded SubjectPublicKeyInfo 1000 // from |len| bytes at |*inp|, as described in |d2i_SAMPLE|. 1001 // SubjectPublicKeyInfo structures containing other key types are rejected. 1002 // 1003 // Use |EVP_parse_public_key| instead. 1004 OPENSSL_EXPORT DSA *d2i_DSA_PUBKEY(DSA **out, const uint8_t **inp, long len); 1005 1006 // i2d_EC_PUBKEY marshals |ec_key| as a DER-encoded SubjectPublicKeyInfo, as 1007 // described in |i2d_SAMPLE|. 1008 // 1009 // Use |EVP_marshal_public_key| instead. 1010 OPENSSL_EXPORT int i2d_EC_PUBKEY(const EC_KEY *ec_key, uint8_t **outp); 1011 1012 // d2i_EC_PUBKEY parses an EC public key as a DER-encoded SubjectPublicKeyInfo 1013 // from |len| bytes at |*inp|, as described in |d2i_SAMPLE|. 1014 // SubjectPublicKeyInfo structures containing other key types are rejected. 1015 // 1016 // Use |EVP_parse_public_key| instead. 1017 OPENSSL_EXPORT EC_KEY *d2i_EC_PUBKEY(EC_KEY **out, const uint8_t **inp, 1018 long len); 1019 1020 1021 // Preprocessor compatibility section (hidden). 1022 // 1023 // Historically, a number of APIs were implemented in OpenSSL as macros and 1024 // constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this 1025 // section defines a number of legacy macros. 1026 1027 // |BORINGSSL_PREFIX| already makes each of these symbols into macros, so there 1028 // is no need to define conflicting macros. 1029 #if !defined(BORINGSSL_PREFIX) 1030 #define EVP_PKEY_CTX_set_rsa_oaep_md EVP_PKEY_CTX_set_rsa_oaep_md 1031 #define EVP_PKEY_CTX_set0_rsa_oaep_label EVP_PKEY_CTX_set0_rsa_oaep_label 1032 #endif 1033 1034 1035 // Nodejs compatibility section (hidden). 1036 // 1037 // These defines exist for node.js, with the hope that we can eliminate the 1038 // need for them over time. 1039 1040 #define EVPerr(function, reason) \ 1041 ERR_put_error(ERR_LIB_EVP, 0, reason, __FILE__, __LINE__) 1042 1043 1044 // Private structures. 1045 1046 struct evp_pkey_st { 1047 CRYPTO_refcount_t references; 1048 1049 // type contains one of the EVP_PKEY_* values or NID_undef and determines 1050 // which element (if any) of the |pkey| union is valid. 1051 int type; 1052 1053 union { 1054 void *ptr; 1055 RSA *rsa; 1056 DSA *dsa; 1057 DH *dh; 1058 EC_KEY *ec; 1059 } pkey; 1060 1061 // ameth contains a pointer to a method table that contains many ASN.1 1062 // methods for the key type. 1063 const EVP_PKEY_ASN1_METHOD *ameth; 1064 } /* EVP_PKEY */; 1065 1066 1067 #if defined(__cplusplus) 1068 } // extern C 1069 1070 extern "C++" { 1071 BSSL_NAMESPACE_BEGIN 1072 1073 BORINGSSL_MAKE_DELETER(EVP_PKEY, EVP_PKEY_free) 1074 BORINGSSL_MAKE_UP_REF(EVP_PKEY, EVP_PKEY_up_ref) 1075 BORINGSSL_MAKE_DELETER(EVP_PKEY_CTX, EVP_PKEY_CTX_free) 1076 1077 BSSL_NAMESPACE_END 1078 1079 } // extern C++ 1080 1081 #endif 1082 1083 #endif // OPENSSL_HEADER_EVP_H 1084