EVP_PKEY_COPY_PARAMETERS(3ossl)

πŸ’… EVP_PKEY_COPY_PARAMETERS πŸ’… (3ossl)

okay bestie, welcome to the 3ossl girlies' corner of the OpenSSL manual, where we're talking public key parameter and comparison functions ✨ and honestly? they ate.

So like, the whole squad here is EVP_PKEY_missing_parameters, EVP_PKEY_copy_parameters, EVP_PKEY_parameters_eq, EVP_PKEY_cmp_parameters, EVP_PKEY_eq, and EVP_PKEY_cmp. Six icons, one page. Let's get into it 🫢


🌸 SYNOPSIS 🌸

#include <openssl/evp.h>

int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey);
int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from);

int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b);
int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b);

now. the following functions have been deprecated since OpenSSL 3.0 😭 and you can hide them entirely by defining OPENSSL_API_COMPAT with a suitable version value β€” see openssl_user_macros(7) for the deets:

int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b);
int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b);

πŸ’– DESCRIPTION πŸ’–

  • EVP_PKEY_missing_parameters() β€” returns 1 if the public key parameters of pkey are missing, and 0 if they're present or the algorithm just doesn't use parameters. simple as that, no notes πŸ’…
  • EVP_PKEY_copy_parameters() β€” copies the parameters from key from to key to. An error gets returned if the parameters are missing in from, or if they're present in both from and to and they mismatch. But if the parameters in from and to are both present and they match? this function literally does nothing. zero effect. it's giving "we already slayed" ✨
  • EVP_PKEY_parameters_eq() β€” checks the parameters of keys a and b for equality. πŸ”
  • EVP_PKEY_eq() β€” checks the keys a and b for equality, including their parameters if they're available. full vibe check on the whole key, periodt.

πŸ“ NOTES πŸ“

The main purpose of EVP_PKEY_missing_parameters() and EVP_PKEY_copy_parameters() is to handle public keys in certificates where the parameters are sometimes omitted from a public key if they're inherited from the CA that signed it. yes bestie, inheritance but for crypto parameters 🧬

The deprecated functions EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters() differ in their return values compared to other _cmp() functions. heads up! They are aliases for EVP_PKEY_eq() and EVP_PKEY_parameters_eq().

So EVP_PKEY_cmp() previously only checked the key parameters (if there are any) and the public key, assuming that there always was a public key and that private key equality could be derived from that. But because it's no longer assumed that the private key in an EVP_PKEY(3) is always accompanied by a public key, the comparison can not rely on public key comparison alone. glow-up era πŸ’…

Instead, EVP_PKEY_eq() (and therefore also EVP_PKEY_cmp()) now compares:

  1. the key parameters (if there are any)
  2. the public keys or the private keys of the two EVP_PKEYs, depending on what they both contain.

πŸŽ€ RETURN VALUES πŸŽ€

  • EVP_PKEY_missing_parameters() returns 1 if the public key parameters of pkey are missing and 0 if they're present or the algorithm doesn't use parameters.
  • EVP_PKEY_copy_parameters() returns 1 for success and 0 for failure. slay or flop, no in-between πŸ’€
  • EVP_PKEY_cmp_parameters(), EVP_PKEY_parameters_eq(), EVP_PKEY_cmp() and EVP_PKEY_eq() return:
    • 1 if their inputs match βœ…
    • 0 if they don't match ❌
    • -1 if the key types are different πŸ™ˆ
    • -2 if the operation is not supported 😭

πŸ‘€ SEE ALSO πŸ‘€

EVP_PKEY_CTX_new(3), EVP_PKEY_keygen(3)


πŸ•°οΈ HISTORY πŸ•°οΈ

The EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters() functions were deprecated in OpenSSL 3.0.

The EVP_PKEY_eq() and EVP_PKEY_parameters_eq() were added in OpenSSL 3.0 to replace EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters(). out with the old, in with the iconic ✨


Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.


and that's the whole page bestie, no cap 🫢 this was OpenSSL 3.5.9, dated 2026-09-29, and it lives in the manual as EVP_PKEY_COPY_PARAMETERS(3ossl). go forth and compare those keys πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…

πŸ“¦ where this page comes from