diff options
author | Tim Hudson <tjh@cryptsoft.com> | 2020-06-02 11:16:14 +1000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2020-09-16 21:38:45 +0200 |
commit | eb750219f2ab7886f174a071f880b31cedeeb0a8 (patch) | |
tree | 6a4b6f7884bbc8ff0870223b0fc12916547b2608 /doc | |
parent | 5d942028845b69d761116bb6dfdbee6e095c0d17 (diff) |
undeprecate EVP_PKEY_cmp and EVP_PKEY_cmp_parameters
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12013)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_PKEY_copy_parameters.pod | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/man3/EVP_PKEY_copy_parameters.pod b/doc/man3/EVP_PKEY_copy_parameters.pod index a3879c4e01..742418cf10 100644 --- a/doc/man3/EVP_PKEY_copy_parameters.pod +++ b/doc/man3/EVP_PKEY_copy_parameters.pod @@ -46,6 +46,11 @@ Since OpenSSL private keys contain public key components too the function EVP_PKEY_eq() can also be used to determine if a private key matches a public key. +EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters() differ in their return values +compared to other _cmp() functions. They are aliases for EVP_PKEY_eq() and +EVP_PKEY_parameters_eq() functions provided for backwards compatibility +with existing applications. + =head1 RETURN VALUES The function EVP_PKEY_missing_parameters() returns 1 if the public key @@ -55,7 +60,8 @@ doesn't use parameters. These functions EVP_PKEY_copy_parameters() returns 1 for success and 0 for failure. -The function EVP_PKEY_parameters_eq() and EVP_PKEY_eq() return 1 if their +The functions 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 and -2 if the operation is not supported. @@ -66,11 +72,10 @@ L<EVP_PKEY_keygen(3)> =head1 HISTORY -The function EVP_PKEY_cmp was deprecated and renamed to B<EVP_PKEY_eq> and -EVP_PKEY_cmp_parameters was deprecated and renamed to B<EVP_PKEY_parameters_eq> -(without changing semantics) in OpenSSL 3.0. -This was done to avoid confusion on their return values with other _cmp() -functions that return 0 in case their arguments are equal. +EVP_PKEY_eq() and EVP_PKEY_parameters_eq() were added in OpenSSL 3.0 to +avoid confusion on the return values of EVP_PKEY_cmp() and +EVP_PKEY_cmp_parameters() which unlike other _cmp() +functions do not return 0 in case their arguments are equal. =head1 COPYRIGHT |