Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_meth_get_count.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_PKEY_METH_GET_COUNT 3SSL"
58 .TH EVP_PKEY_METH_GET_COUNT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_PKEY_meth_get_count, EVP_PKEY_meth_get0, EVP_PKEY_meth_get0_info \- enumerate public key methods
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/evp.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 4
76 \& size_t EVP_PKEY_meth_get_count(void);
77 \& const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx);
78 \& void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
79 \& const EVP_PKEY_METHOD *meth);
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 All of the functions described on this page are deprecated.
84 Applications should instead use the OSSL_PROVIDER APIs.
85 .PP
86 \&\fBEVP_PKEY_meth_count()\fR returns a count of the number of public key methods
87 available: it includes standard methods and any methods added by the
88 application.
89 .PP
90 \&\fBEVP_PKEY_meth_get0()\fR returns the public key method \fBidx\fR. The value of \fBidx\fR
91 must be between zero and \fBEVP_PKEY_meth_get_count()\fR \- 1.
92 .PP
93 \&\fBEVP_PKEY_meth_get0_info()\fR returns the public key ID (a NID) and any flags
94 associated with the public key method \fB*meth\fR.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 \&\fBEVP_PKEY_meth_count()\fR returns the number of available public key methods.
98 .PP
99 \&\fBEVP_PKEY_meth_get0()\fR return a public key method or \fBNULL\fR if \fBidx\fR is
100 out of range.
101 .PP
102 \&\fBEVP_PKEY_meth_get0_info()\fR does not return a value.
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBEVP_PKEY_new\fR\|(3)
106 .SH HISTORY
107 .IX Header "HISTORY"
108 All of these functions were deprecated in OpenSSL 3.0.
109 .SH COPYRIGHT
110 .IX Header "COPYRIGHT"
111 Copyright 2002\-2020 The OpenSSL Project Authors. All Rights Reserved.
112 .PP
113 Licensed under the Apache License 2.0 (the "License"). You may not use
114 this file except in compliance with the License. You can obtain a copy
115 in the file LICENSE in the source distribution or at
116 <https://www.openssl.org/source/license.html>.