xref: /freebsd/secure/lib/libcrypto/man/man3/EVP_PKEY_asn1_get_count.3 (revision 174c0ac687ec4ccb0b56ee30d48c0a7b8b9c4e15)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "EVP_PKEY_ASN1_GET_COUNT 3ossl"
EVP_PKEY_ASN1_GET_COUNT 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
EVP_PKEY_asn1_find, EVP_PKEY_asn1_find_str, EVP_PKEY_asn1_get_count, EVP_PKEY_asn1_get0, EVP_PKEY_asn1_get0_info \- enumerate public key ASN.1 methods
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/evp.h> \& int EVP_PKEY_asn1_get_count(void); const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx); const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type); const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe, const char *str, int len); int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *pkey_base_id, int *ppkey_flags, const char **pinfo, const char **ppem_str, const EVP_PKEY_ASN1_METHOD *ameth); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBEVP_PKEY_asn1_count() returns a count of the number of public key \s-1ASN.1\s0 methods available: it includes standard methods and any methods added by the application.

\fBEVP_PKEY_asn1_get0() returns the public key \s-1ASN.1\s0 method idx. The value of idx must be between zero and EVP_PKEY_asn1_get_count() \- 1.

\fBEVP_PKEY_asn1_find() looks up the \s-1EVP_PKEY_ASN1_METHOD\s0 with \s-1NID\s0 \fBtype. If pe isn't \s-1NULL\s0, then it will look up an engine implementing a \fB\s-1EVP_PKEY_ASN1_METHOD\s0 for the \s-1NID\s0 type and return that instead, and also set *pe to point at the engine that implements it.

\fBEVP_PKEY_asn1_find_str() looks up the \s-1EVP_PKEY_ASN1_METHOD\s0 with \s-1PEM\s0 type string str. Just like EVP_PKEY_asn1_find(), if pe isn't \s-1NULL\s0, then it will look up an engine implementing a \s-1EVP_PKEY_ASN1_METHOD\s0 for the \s-1NID\s0 \fBtype and return that instead, and also set *pe to point at the engine that implements it.

\fBEVP_PKEY_asn1_get0_info() returns the public key \s-1ID,\s0 base public key \s-1ID\s0 (both NIDs), any flags, the method description and \s-1PEM\s0 type string associated with the public key \s-1ASN.1\s0 method *ameth.

\fBEVP_PKEY_asn1_count(), EVP_PKEY_asn1_get0(), EVP_PKEY_asn1_find() and \fBEVP_PKEY_asn1_find_str() are not thread safe, but as long as all \fB\s-1EVP_PKEY_ASN1_METHOD\s0 objects are added before the application gets threaded, using them is safe. See EVP_PKEY_asn1_add0\|(3).

"RETURN VALUES"
Header "RETURN VALUES" \fBEVP_PKEY_asn1_count() returns the number of available public key methods.

\fBEVP_PKEY_asn1_get0() return a public key method or \s-1NULL\s0 if idx is out of range.

\fBEVP_PKEY_asn1_get0_info() returns 0 on failure, 1 on success.

"SEE ALSO"
Header "SEE ALSO" \fBEVP_PKEY_asn1_new\|(3), EVP_PKEY_asn1_add0\|(3)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.