95b57a3fb8efce2a5b6bae7d59eb801d2acf8648
[openssl.git] / doc / man3 / EVP_PKEY_check.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_PKEY_check, EVP_PKEY_param_check, EVP_PKEY_public_check,
6 EVP_PKEY_private_check, EVP_PKEY_pairwise_check
7 - key and parameter validation functions
8
9 =head1 SYNOPSIS
10
11  #include <openssl/evp.h>
12
13  int EVP_PKEY_check(EVP_PKEY_CTX *ctx);
14  int EVP_PKEY_param_check(EVP_PKEY_CTX *ctx);
15  int EVP_PKEY_public_check(EVP_PKEY_CTX *ctx);
16  int EVP_PKEY_private_check(EVP_PKEY_CTX *ctx);
17  int EVP_PKEY_pairwise_check(EVP_PKEY_CTX *ctx);
18
19 =head1 DESCRIPTION
20
21 EVP_PKEY_param_check() validates the domain parameters component of the key
22 given by B<ctx>.
23
24 EVP_PKEY_public_check() validates the public component of the key given by B<ctx>.
25
26 EVP_PKEY_private_check() validates the private component of the key given by B<ctx>.
27
28 EVP_PKEY_pairwise_check() validates that the public and private components have
29 the correct mathematical relationship to each other for the key given by B<ctx>.
30
31 EVP_PKEY_check() validates all components of a key given by B<ctx>.
32
33 =head1 NOTES
34
35 Refer to SP800-56A and SP800-56B for rules relating to when these functions
36 should be called during key establishment.
37 It is not necessary to call these functions after locally calling an approved key
38 generation method, but may be required for assurance purposes when receiving
39 keys from a third party.
40
41 In OpenSSL an EVP_PKEY structure containing a private key also contains the
42 public key components and parameters (if any). An OpenSSL private key is
43 equivalent to what some libraries call a "key pair". A private key can be used
44 in functions which require the use of a public key or parameters.
45
46 =head1 RETURN VALUES
47
48 All functions return 1 for success or others for failure.
49 They return -2 if the operation is not supported for the specific algorithm.
50
51 =head1 SEE ALSO
52
53 L<EVP_PKEY_CTX_new(3)>,
54 L<EVP_PKEY_fromdata(3)>,
55
56 =head1 HISTORY
57
58 EVP_PKEY_check(), EVP_PKEY_public_check() and EVP_PKEY_param_check() were added
59 in OpenSSL 1.1.1.
60
61 EVP_PKEY_private_check() and EVP_PKEY_pairwise_check() were added
62 in OpenSSL 3.0.
63
64 =head1 COPYRIGHT
65
66 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
67
68 Licensed under the Apache License 2.0 (the "License").  You may not use
69 this file except in compliance with the License.  You can obtain a copy
70 in the file LICENSE in the source distribution or at
71 L<https://www.openssl.org/source/license.html>.
72
73 =cut