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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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_IS_A 3ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
EVP_PKEY_is_a, EVP_PKEY_can_sign, EVP_PKEY_type_names_do_all, EVP_PKEY_get0_type_name, EVP_PKEY_get0_description, EVP_PKEY_get0_provider \- key type and capabilities functions Header "SYNOPSIS" .Vb 1 #include <openssl/evp.h> \& int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name); int EVP_PKEY_can_sign(const EVP_PKEY *pkey); int EVP_PKEY_type_names_do_all(const EVP_PKEY *pkey, void (*fn)(const char *name, void *data), void *data); const char *EVP_PKEY_get0_type_name(const EVP_PKEY *key); const char *EVP_PKEY_get0_description(const EVP_PKEY *key); const OSSL_PROVIDER *EVP_PKEY_get0_provider(const EVP_PKEY *key); .Ve Header "DESCRIPTION" \fBEVP_PKEY_is_a() checks if the key type of pkey is name.

\fBEVP_PKEY_can_sign() checks if the functionality for the key type of \fIpkey supports signing. No other check is done, such as whether \fIpkey contains a private key.

\fBEVP_PKEY_type_names_do_all() traverses all names for pkey's key type, and calls fn with each name and data. For example, an \s-1RSA\s0 \s-1EVP_PKEY\s0 may be named both \*(C`RSA\*(C' and \*(C`rsaEncryption\*(C'. The order of the names depends on the provider implementation that holds the key.

\fBEVP_PKEY_get0_type_name() returns the first key type name that is found for the given pkey. Note that the pkey may have multiple synonyms associated with it. In this case it depends on the provider implementation that holds the key which one will be returned. Ownership of the returned string is retained by the pkey object and should not be freed by the caller.

\fBEVP_PKEY_get0_description() returns a description of the type of \s-1EVP_PKEY\s0, meant for display and human consumption. The description is at the discretion of the key type implementation.

\fBEVP_PKEY_get0_provider() returns the provider of the \s-1EVP_PKEY\s0's \s-1EVP_KEYMGMT\s0\|(3).

Header "RETURN VALUES" \fBEVP_PKEY_is_a() returns 1 if pkey has the key type name, otherwise 0.

\fBEVP_PKEY_can_sign() returns 1 if the pkey key type functionality supports signing, otherwise 0.

\fBEVP_PKEY_get0_type_name() returns the name that is found or \s-1NULL\s0 on error.

\fBEVP_PKEY_get0_description() returns the description if found or \s-1NULL\s0 if not.

\fBEVP_PKEY_get0_provider() returns the provider if found or \s-1NULL\s0 if not.

\fBEVP_PKEY_type_names_do_all() returns 1 if the callback was called for all names. A return value of 0 means that the callback was not called for any names.

Header "EXAMPLES" Subsection "EVP_PKEY_is_a()" The loaded providers and what key types they support will ultimately determine what name is possible to use with EVP_PKEY_is_a(). We do know that the default provider supports \s-1RSA, DH, DSA\s0 and \s-1EC\s0 keys, so we can use this as an crude example:

.Vb 1 #include <openssl/evp.h> \& ... /* |pkey| is an EVP_PKEY* */ if (EVP_PKEY_is_a(pkey, "RSA")) { BIGNUM *modulus = NULL; if (EVP_PKEY_get_bn_param(pkey, "n", &modulus)) /* do whatever with the modulus */ BN_free(modulus); } .Ve

Subsection "EVP_PKEY_can_sign()" .Vb 1 #include <openssl/evp.h> \& ... /* |pkey| is an EVP_PKEY* */ if (!EVP_PKEY_can_sign(pkey)) { fprintf(stderr, "Not a signing key!"); exit(1); } /* Sign something... */ .Ve Header "HISTORY" The functions described here were added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2020-2021 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>.