diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-05-25 13:17:51 +0200 |
---|---|---|
committer | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-05-27 14:36:13 +0200 |
commit | c74aaa3920f116fe4c1003153838144c37d6e527 (patch) | |
tree | 47475bbd2b276e95dab977ff832d5405602ac2f8 /doc/man3 | |
parent | 9e3c510bde91350c5a40b7ba4e9e0945895e9368 (diff) | |
download | openssl-c74aaa3920f116fe4c1003153838144c37d6e527.tar.gz |
Rename EVP_PKEY_cmp() to EVP_PKEY_eq() and EVP_PKEY_cmp_parameters() to EVP_PKEY_parameters_eq()
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/11953)
Diffstat (limited to 'doc/man3')
-rw-r--r-- | doc/man3/EVP_PKEY_ASN1_METHOD.pod | 4 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_copy_parameters.pod (renamed from doc/man3/EVP_PKEY_cmp.pod) | 27 |
2 files changed, 21 insertions, 10 deletions
diff --git a/doc/man3/EVP_PKEY_ASN1_METHOD.pod b/doc/man3/EVP_PKEY_ASN1_METHOD.pod index 989008db07..bad9370867 100644 --- a/doc/man3/EVP_PKEY_ASN1_METHOD.pod +++ b/doc/man3/EVP_PKEY_ASN1_METHOD.pod @@ -170,7 +170,7 @@ They're called by L<X509_PUBKEY_get0(3)> and L<X509_PUBKEY_set(3)>. The pub_cmp() method is called when two public keys are to be compared. It MUST return 1 when the keys are equal, 0 otherwise. -It's called by L<EVP_PKEY_cmp(3)>. +It's called by L<EVP_PKEY_eq(3)>. The pub_print() method is called to print a public key in humanly readable text to B<out>, indented B<indent> spaces. @@ -228,7 +228,7 @@ It's called by L<EVP_PKEY_copy_parameters(3)>. The param_cmp() method compares the parameters of keys B<a> and B<b>. It MUST return 1 when the keys are equal, 0 when not equal, or a negative number on error. -It's called by L<EVP_PKEY_cmp_parameters(3)>. +It's called by L<EVP_PKEY_parameters_eq(3)>. The param_print() method prints the private key parameters in humanly readable text to B<out>, indented B<indent> spaces. diff --git a/doc/man3/EVP_PKEY_cmp.pod b/doc/man3/EVP_PKEY_copy_parameters.pod index f0008ec150..01fbb48109 100644 --- a/doc/man3/EVP_PKEY_cmp.pod +++ b/doc/man3/EVP_PKEY_copy_parameters.pod @@ -2,7 +2,8 @@ =head1 NAME -EVP_PKEY_copy_parameters, EVP_PKEY_missing_parameters, EVP_PKEY_cmp_parameters, +EVP_PKEY_missing_parameters, EVP_PKEY_copy_parameters, EVP_PKEY_parameters_eq, +EVP_PKEY_cmp_parameters, EVP_PKEY_eq, EVP_PKEY_cmp - public key parameter and comparison functions =head1 SYNOPSIS @@ -12,7 +13,9 @@ EVP_PKEY_cmp - public key parameter and comparison functions 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_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b); + int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b); int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b); =head1 DESCRIPTION @@ -26,11 +29,11 @@ B<from> to key B<to>. An error is returned if the parameters are missing in B<from> or present in both B<from> and B<to> and mismatch. If the parameters in B<from> and B<to> are both present and match this function has no effect. -The function EVP_PKEY_cmp_parameters() compares the parameters of keys -B<a> and B<b>. +The function EVP_PKEY_parameters_eq() checks the parameters of keys +B<a> and B<b> for equality. -The function EVP_PKEY_cmp() compares the public key components and parameters -(if present) of keys B<a> and B<b>. +The function EVP_PKEY_eq() checks the public key components and parameters +(if present) of keys B<a> and B<b> for equality. =head1 NOTES @@ -40,7 +43,7 @@ parameters are sometimes omitted from a public key if they are inherited from the CA that signed it. Since OpenSSL private keys contain public key components too the function -EVP_PKEY_cmp() can also be used to determine if a private key matches +EVP_PKEY_eq() can also be used to determine if a private key matches a public key. =head1 RETURN VALUES @@ -52,8 +55,8 @@ doesn't use parameters. These functions EVP_PKEY_copy_parameters() returns 1 for success and 0 for failure. -The function EVP_PKEY_cmp_parameters() and EVP_PKEY_cmp() return 1 if the -keys match, 0 if they don't match, -1 if the key types are different and +The function EVP_PKEY_parameters_eq() 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. =head1 SEE ALSO @@ -61,6 +64,14 @@ keys match, 0 if they don't match, -1 if the key types are different and L<EVP_PKEY_CTX_new(3)>, 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. + =head1 COPYRIGHT Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved. |