diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_PKEY_is_a.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_PKEY_is_a.3 | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_PKEY_is_a.3 b/secure/lib/libcrypto/man/man3/EVP_PKEY_is_a.3 new file mode 100644 index 000000000000..ea5cab554ab5 --- /dev/null +++ b/secure/lib/libcrypto/man/man3/EVP_PKEY_is_a.3 @@ -0,0 +1,245 @@ +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. 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\} +.el\{\ +. 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. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" 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'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==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 +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. 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 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. 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 +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "EVP_PKEY_IS_A 3ossl" +.TH EVP_PKEY_IS_A 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. +.if n .ad l +.nh +.SH "NAME" +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 +.SH "SYNOPSIS" +.IX 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 +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBEVP_PKEY_is_a()\fR checks if the key type of \fIpkey\fR is \fIname\fR. +.PP +\&\fBEVP_PKEY_can_sign()\fR checks if the functionality for the key type of +\&\fIpkey\fR supports signing. No other check is done, such as whether +\&\fIpkey\fR contains a private key. +.PP +\&\fBEVP_PKEY_type_names_do_all()\fR traverses all names for \fIpkey\fR's key type, and +calls \fIfn\fR with each name and \fIdata\fR. For example, an \s-1RSA\s0 \fB\s-1EVP_PKEY\s0\fR may +be named both \f(CW\*(C`RSA\*(C'\fR and \f(CW\*(C`rsaEncryption\*(C'\fR. +The order of the names depends on the provider implementation that holds +the key. +.PP +\&\fBEVP_PKEY_get0_type_name()\fR returns the first key type name that is found +for the given \fIpkey\fR. Note that the \fIpkey\fR 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 \fIpkey\fR object and should +not be freed by the caller. +.PP +\&\fBEVP_PKEY_get0_description()\fR returns a description of the type of \fB\s-1EVP_PKEY\s0\fR, +meant for display and human consumption. The description is at the +discretion of the key type implementation. +.PP +\&\fBEVP_PKEY_get0_provider()\fR returns the provider of the \fB\s-1EVP_PKEY\s0\fR's +\&\s-1\fBEVP_KEYMGMT\s0\fR\|(3). +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBEVP_PKEY_is_a()\fR returns 1 if \fIpkey\fR has the key type \fIname\fR, +otherwise 0. +.PP +\&\fBEVP_PKEY_can_sign()\fR returns 1 if the \fIpkey\fR key type functionality +supports signing, otherwise 0. +.PP +\&\fBEVP_PKEY_get0_type_name()\fR returns the name that is found or \s-1NULL\s0 on error. +.PP +\&\fBEVP_PKEY_get0_description()\fR returns the description if found or \s-1NULL\s0 if not. +.PP +\&\fBEVP_PKEY_get0_provider()\fR returns the provider if found or \s-1NULL\s0 if not. +.PP +\&\fBEVP_PKEY_type_names_do_all()\fR 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. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +.SS "\fBEVP_PKEY_is_a()\fP" +.IX Subsection "EVP_PKEY_is_a()" +The loaded providers and what key types they support will ultimately +determine what \fIname\fR is possible to use with \fBEVP_PKEY_is_a()\fR. 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: +.PP +.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 +.SS "\fBEVP_PKEY_can_sign()\fP" +.IX 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 +.SH "HISTORY" +.IX Header "HISTORY" +The functions described here were added in OpenSSL 3.0. +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved. +.PP +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>. |