5 EVP_PKEY_missing_parameters, EVP_PKEY_copy_parameters, EVP_PKEY_parameters_eq,
6 EVP_PKEY_cmp_parameters, EVP_PKEY_eq,
7 EVP_PKEY_cmp - public key parameter and comparison functions
11 #include <openssl/evp.h>
13 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey);
14 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from);
16 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b);
17 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b);
18 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b);
19 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b);
23 The function EVP_PKEY_missing_parameters() returns 1 if the public key
24 parameters of B<pkey> are missing and 0 if they are present or the algorithm
25 doesn't use parameters.
27 The function EVP_PKEY_copy_parameters() copies the parameters from key
28 B<from> to key B<to>. An error is returned if the parameters are missing in
29 B<from> or present in both B<from> and B<to> and mismatch. If the parameters
30 in B<from> and B<to> are both present and match this function has no effect.
32 The function EVP_PKEY_parameters_eq() checks the parameters of keys
33 B<a> and B<b> for equality.
35 The function EVP_PKEY_eq() checks the public key components and parameters
36 (if present) of keys B<a> and B<b> for equality.
40 The main purpose of the functions EVP_PKEY_missing_parameters() and
41 EVP_PKEY_copy_parameters() is to handle public keys in certificates where the
42 parameters are sometimes omitted from a public key if they are inherited from
43 the CA that signed it.
45 Since OpenSSL private keys contain public key components too the function
46 EVP_PKEY_eq() can also be used to determine if a private key matches
49 EVP_PKEY_cmp() and EVP_PKEY_cmp_parameters() differ in their return values
50 compared to other _cmp() functions. They are aliases for EVP_PKEY_eq() and
51 EVP_PKEY_parameters_eq() functions provided for backwards compatibility
52 with existing applications.
56 The function EVP_PKEY_missing_parameters() returns 1 if the public key
57 parameters of B<pkey> are missing and 0 if they are present or the algorithm
58 doesn't use parameters.
60 These functions EVP_PKEY_copy_parameters() returns 1 for success and 0 for
63 The functions EVP_PKEY_cmp_parameters(), EVP_PKEY_parameters_eq(),
64 EVP_PKEY_cmp() and EVP_PKEY_eq() return 1 if their
65 inputs match, 0 if they don't match, -1 if the key types are different and
66 -2 if the operation is not supported.
70 L<EVP_PKEY_CTX_new(3)>,
75 EVP_PKEY_eq() and EVP_PKEY_parameters_eq() were added in OpenSSL 3.0 to
76 avoid confusion on the return values of EVP_PKEY_cmp() and
77 EVP_PKEY_cmp_parameters() which unlike other _cmp()
78 functions do not return 0 in case their arguments are equal.
82 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
84 Licensed under the Apache License 2.0 (the "License"). You may not use
85 this file except in compliance with the License. You can obtain a copy
86 in the file LICENSE in the source distribution or at
87 L<https://www.openssl.org/source/license.html>.