Debian Codegraph @

upstream/debian-trixie/man3/EVP_PKEY_asn1_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_ASN1_GET_COUNT 3SSL"
58 .TH EVP_PKEY_ASN1_GET_COUNT 3SSL 2026-04-07 3.5.6 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_asn1_find,
65 EVP_PKEY_asn1_find_str,
66 EVP_PKEY_asn1_get_count,
67 EVP_PKEY_asn1_get0,
68 EVP_PKEY_asn1_get0_info
69 \&\- enumerate public key ASN.1 methods
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 1
73 \& #include <openssl/evp.h>
74 \&
75 \& int EVP_PKEY_asn1_get_count(void);
76 \& const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx);
77 \& const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type);
78 \& const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe,
79 \& const char *str, int len);
80 \& int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *pkey_base_id,
81 \& int *ppkey_flags, const char **pinfo,
82 \& const char **ppem_str,
83 \& const EVP_PKEY_ASN1_METHOD *ameth);
84 .Ve
85 .SH DESCRIPTION
86 .IX Header "DESCRIPTION"
87 \&\fBEVP_PKEY_asn1_count()\fR returns a count of the number of public key
88 ASN.1 methods available: it includes standard methods and any methods
89 added by the application.
90 .PP
91 \&\fBEVP_PKEY_asn1_get0()\fR returns the public key ASN.1 method \fBidx\fR.
92 The value of \fBidx\fR must be between zero and \fBEVP_PKEY_asn1_get_count()\fR
93 \&\- 1.
94 .PP
95 \&\fBEVP_PKEY_asn1_find()\fR looks up the \fBEVP_PKEY_ASN1_METHOD\fR with NID
96 \&\fBtype\fR.
97 If \fBpe\fR isn't \fBNULL\fR, then it will look up an engine implementing a
98 \&\fBEVP_PKEY_ASN1_METHOD\fR for the NID \fBtype\fR and return that instead,
99 and also set \fB*pe\fR to point at the engine that implements it.
100 .PP
101 \&\fBEVP_PKEY_asn1_find_str()\fR looks up the \fBEVP_PKEY_ASN1_METHOD\fR with PEM
102 type string \fBstr\fR.
103 Just like \fBEVP_PKEY_asn1_find()\fR, if \fBpe\fR isn't \fBNULL\fR, then it will
104 look up an engine implementing a \fBEVP_PKEY_ASN1_METHOD\fR for the NID
105 \&\fBtype\fR and return that instead, and also set \fB*pe\fR to point at the
106 engine that implements it.
107 .PP
108 \&\fBEVP_PKEY_asn1_get0_info()\fR returns the public key ID, base public key
109 ID (both NIDs), any flags, the method description and PEM type string
110 associated with the public key ASN.1 method \fB*ameth\fR.
111 .PP
112 \&\fBEVP_PKEY_asn1_count()\fR, \fBEVP_PKEY_asn1_get0()\fR, \fBEVP_PKEY_asn1_find()\fR and
113 \&\fBEVP_PKEY_asn1_find_str()\fR are not thread safe, but as long as all
114 \&\fBEVP_PKEY_ASN1_METHOD\fR objects are added before the application gets
115 threaded, using them is safe. See \fBEVP_PKEY_asn1_add0\fR\|(3).
116 .SH "RETURN VALUES"
117 .IX Header "RETURN VALUES"
118 \&\fBEVP_PKEY_asn1_count()\fR returns the number of available public key methods.
119 .PP
120 \&\fBEVP_PKEY_asn1_get0()\fR return a public key method or \fBNULL\fR if \fBidx\fR is
121 out of range.
122 .PP
123 \&\fBEVP_PKEY_asn1_get0_info()\fR returns 0 on failure, 1 on success.
124 .SH "SEE ALSO"
125 .IX Header "SEE ALSO"
126 \&\fBEVP_PKEY_asn1_new\fR\|(3), \fBEVP_PKEY_asn1_add0\fR\|(3)
127 .SH COPYRIGHT
128 .IX Header "COPYRIGHT"
129 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
130 .PP
131 Licensed under the Apache License 2.0 (the "License"). You may not use
132 this file except in compliance with the License. You can obtain a copy
133 in the file LICENSE in the source distribution or at
134 <https://www.openssl.org/source/license.html>.