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