xref: /freebsd/crypto/openssl/doc/man3/EVP_PKEY_meth_get_count.pod (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1=pod
2
3=head1 NAME
4
5EVP_PKEY_meth_get_count, EVP_PKEY_meth_get0, EVP_PKEY_meth_get0_info - enumerate public key methods
6
7=head1 SYNOPSIS
8
9 #include <openssl/evp.h>
10
11The following functions have been deprecated since OpenSSL 3.0, and can be
12hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
13see L<openssl_user_macros(7)>:
14
15 size_t EVP_PKEY_meth_get_count(void);
16 const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx);
17 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
18                              const EVP_PKEY_METHOD *meth);
19
20=head1 DESCRIPTION
21
22All of the functions described on this page are deprecated.
23Applications should instead use the OSSL_PROVIDER APIs.
24
25EVP_PKEY_meth_count() returns a count of the number of public key methods
26available: it includes standard methods and any methods added by the
27application.
28
29EVP_PKEY_meth_get0() returns the public key method B<idx>. The value of B<idx>
30must be between zero and EVP_PKEY_meth_get_count() - 1.
31
32EVP_PKEY_meth_get0_info() returns the public key ID (a NID) and any flags
33associated with the public key method B<*meth>.
34
35=head1 RETURN VALUES
36
37EVP_PKEY_meth_count() returns the number of available public key methods.
38
39EVP_PKEY_meth_get0() return a public key method or B<NULL> if B<idx> is
40out of range.
41
42EVP_PKEY_meth_get0_info() does not return a value.
43
44=head1 SEE ALSO
45
46L<EVP_PKEY_new(3)>
47
48=head1 HISTORY
49
50All of these functions were deprecated in OpenSSL 3.0.
51
52=head1 COPYRIGHT
53
54Copyright 2002-2021 The OpenSSL Project Authors. All Rights Reserved.
55
56Licensed under the Apache License 2.0 (the "License").  You may not use
57this file except in compliance with the License.  You can obtain a copy
58in the file LICENSE in the source distribution or at
59L<https://www.openssl.org/source/license.html>.
60
61=cut
62