1EVP_PKEY_COPY_PARAMETERS(3ossl)     OpenSSL    EVP_PKEY_COPY_PARAMETERS(3ossl)
2
3
4

NAME

6       EVP_PKEY_missing_parameters, EVP_PKEY_copy_parameters,
7       EVP_PKEY_parameters_eq, EVP_PKEY_cmp_parameters, EVP_PKEY_eq,
8       EVP_PKEY_cmp - public key parameter and comparison functions
9

SYNOPSIS

11        #include <openssl/evp.h>
12
13        int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey);
14        int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from);
15
16        int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b);
17        int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b);
18
19       The following functions have been deprecated since OpenSSL 3.0, and can
20       be hidden entirely by defining OPENSSL_API_COMPAT with a suitable
21       version value, see openssl_user_macros(7):
22
23        int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b);
24        int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b);
25

DESCRIPTION

27       The function EVP_PKEY_missing_parameters() returns 1 if the public key
28       parameters of pkey are missing and 0 if they are present or the
29       algorithm doesn't use parameters.
30
31       The function EVP_PKEY_copy_parameters() copies the parameters from key
32       from to key to. An error is returned if the parameters are missing in
33       from or present in both from and to and mismatch. If the parameters in
34       from and to are both present and match this function has no effect.
35
36       The function EVP_PKEY_parameters_eq() checks the parameters of keys a
37       and b for equality.
38
39       The function EVP_PKEY_eq() checks the keys a and b for equality,
40       including their parameters if they are available.
41

NOTES

43       The main purpose of the functions EVP_PKEY_missing_parameters() and
44       EVP_PKEY_copy_parameters() is to handle public keys in certificates
45       where the parameters are sometimes omitted from a public key if they
46       are inherited from the CA that signed it.
47
48       The deprecated functions EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters()
49       differ in their return values compared to other _cmp() functions. They
50       are aliases for EVP_PKEY_eq() and EVP_PKEY_parameters_eq().
51
52       The function EVP_PKEY_cmp() previously only checked the key parameters
53       (if there are any) and the public key, assuming that there always was a
54       public key and that private key equality could be derived from that.
55       Because it's no longer assumed that the private key in an EVP_PKEY(3)
56       is always accompanied by a public key, the comparison can not rely on
57       public key comparison alone.
58
59       Instead, EVP_PKEY_eq() (and therefore also EVP_PKEY_cmp()) now
60       compares:
61
62       1.  the key parameters (if there are any)
63
64       2.  the public keys or the private keys of the two EVP_PKEYs, depending
65           on what they both contain.
66

RETURN VALUES

68       The function EVP_PKEY_missing_parameters() returns 1 if the public key
69       parameters of pkey are missing and 0 if they are present or the
70       algorithm doesn't use parameters.
71
72       These functions EVP_PKEY_copy_parameters() returns 1 for success and 0
73       for failure.
74
75       The functions EVP_PKEY_cmp_parameters(), EVP_PKEY_parameters_eq(),
76       EVP_PKEY_cmp() and EVP_PKEY_eq() return 1 if their inputs match, 0 if
77       they don't match, -1 if the key types are different and -2 if the
78       operation is not supported.
79

SEE ALSO

81       EVP_PKEY_CTX_new(3), EVP_PKEY_keygen(3)
82

HISTORY

84       The EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters() functions were
85       deprecated in OpenSSL 3.0.
86
87       The EVP_PKEY_eq() and EVP_PKEY_parameters_eq() were added in OpenSSL
88       3.0 to replace EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters().
89

91       Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
92
93       Licensed under the Apache License 2.0 (the "License").  You may not use
94       this file except in compliance with the License.  You can obtain a copy
95       in the file LICENSE in the source distribution or at
96       <https://www.openssl.org/source/license.html>.
97
98
99
1003.0.9                             2023-07-27   EVP_PKEY_COPY_PARAMETERS(3ossl)
Impressum