secure/lib/libcrypto/man/man3/EVP_PKEY_size.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "EVP_PKEY_SIZE 3"
 136 .TH EVP_PKEY_SIZE 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 EVP_PKEY_size, EVP_PKEY_bits, EVP_PKEY_security_bits \&\- EVP_PKEY information functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& int EVP_PKEY_size(const EVP_PKEY *pkey);
 149 \& int EVP_PKEY_bits(const EVP_PKEY *pkey);
 150 \& int EVP_PKEY_security_bits(const EVP_PKEY *pkey);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fBEVP_PKEY_size()\fR returns the maximum suitable size for the output
 155 buffers for almost all operations that can be done with \fIpkey\fR.
 156 The primary documented use is with \fBEVP_SignFinal\fR\|(3) and
 157 \&\fBEVP_SealInit\fR\|(3), but it isn't limited there.  The returned size is
 158 also large enough for the output buffer of \fBEVP_PKEY_sign\fR\|(3),
 159 \&\fBEVP_PKEY_encrypt\fR\|(3), \fBEVP_PKEY_decrypt\fR\|(3), \fBEVP_PKEY_derive\fR\|(3).
 160 .PP
 161 It must be stressed that, unless the documentation for the operation
 162 that's being performed says otherwise, the size returned by
 163 \&\fBEVP_PKEY_size()\fR is only preliminary and not exact, so the final
 164 contents of the target buffer may be smaller.  It is therefore crucial
 165 to take note of the size given back by the function that performs the
 166 operation, such as \fBEVP_PKEY_sign\fR\|(3) (the \fIsiglen\fR argument will
 167 receive that length), to avoid bugs.
 168 .PP
 169 \&\fBEVP_PKEY_bits()\fR returns the cryptographic length of the cryptosystem
 170 to which the key in \fIpkey\fR belongs, in bits.  Note that the definition
 171 of cryptographic length is specific to the key cryptosystem.
 172 .PP
 173 \&\fBEVP_PKEY_security_bits()\fR returns the number of security bits of the given
 174 \&\fIpkey\fR, bits of security is defined in \s-1NIST SP800\-57.\s0
 175 .SH "RETURN VALUES"
 176 .IX Header "RETURN VALUES"
 177 \&\fBEVP_PKEY_size()\fR, \fBEVP_PKEY_bits()\fR and \fBEVP_PKEY_security_bits()\fR return a
 178 positive number, or 0 if this size isn't available.
 179 .SH "NOTES"
 180 .IX Header "NOTES"
 181 Most functions that have an output buffer and are mentioned with
 182 \&\fBEVP_PKEY_size()\fR have a functionality where you can pass \s-1NULL\s0 for the
 183 buffer and still pass a pointer to an integer and get the exact size
 184 that this function call delivers in the context that it's called in.
 185 This allows those functions to be called twice, once to find out the
 186 exact buffer size, then allocate the buffer in between, and call that
 187 function again actually output the data.  For those functions, it
 188 isn't strictly necessary to call \fBEVP_PKEY_size()\fR to find out the
 189 buffer size, but may be useful in cases where it's desirable to know
 190 the upper limit in advance.
 191 .PP
 192 It should also be especially noted that \fBEVP_PKEY_size()\fR shouldn't be
 193 used to get the output size for \fBEVP_DigestSignFinal()\fR, according to
 194 \&\*(L"\s-1NOTES\*(R"\s0 in \fBEVP_DigestSignFinal\fR\|(3).
 195 .SH "SEE ALSO"
 196 .IX Header "SEE ALSO"
 197 \&\fBEVP_SignFinal\fR\|(3),
 198 \&\fBEVP_SealInit\fR\|(3),
 199 \&\fBEVP_PKEY_sign\fR\|(3),
 200 \&\fBEVP_PKEY_encrypt\fR\|(3),
 201 \&\fBEVP_PKEY_decrypt\fR\|(3),
 202 \&\fBEVP_PKEY_derive\fR\|(3)
 203 .SH "COPYRIGHT"
 204 .IX Header "COPYRIGHT"
 205 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
 206 .PP
 207 Licensed under the Apache License 2.0 (the \*(L"License\*(R").  You may not use
 208 this file except in compliance with the License.  You can obtain a copy
 209 in the file \s-1LICENSE\s0 in the source distribution or at
 210 <https://www.openssl.org/source/license.html>.