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