secure/lib/libcrypto/man/EVP_PKEY_decrypt.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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_DECRYPT 3"
 136 .TH EVP_PKEY_DECRYPT 3 "2019-09-10" "1.1.1d" "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_decrypt_init, EVP_PKEY_decrypt \- decrypt using a public key algorithm
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& int EVP_PKEY_decrypt_init(EVP_PKEY_CTX *ctx);
 149 \& int EVP_PKEY_decrypt(EVP_PKEY_CTX *ctx,
 150 \&                      unsigned char *out, size_t *outlen,
 151 \&                      const unsigned char *in, size_t inlen);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 The \fBEVP_PKEY_decrypt_init()\fR function initializes a public key algorithm
 156 context using key \fBpkey\fR for a decryption operation.
 157 .PP
 158 The \fBEVP_PKEY_decrypt()\fR function performs a public key decryption operation
 159 using \fBctx\fR. The data to be decrypted is specified using the \fBin\fR and
 160 \&\fBinlen\fR parameters. If \fBout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
 161 buffer is written to the \fBoutlen\fR parameter. If \fBout\fR is not \fB\s-1NULL\s0\fR then
 162 before the call the \fBoutlen\fR parameter should contain the length of the
 163 \&\fBout\fR buffer, if the call is successful the decrypted data is written to
 164 \&\fBout\fR and the amount of data written to \fBoutlen\fR.
 165 .SH "NOTES"
 166 .IX Header "NOTES"
 167 After the call to \fBEVP_PKEY_decrypt_init()\fR algorithm specific control
 168 operations can be performed to set any appropriate parameters for the
 169 operation.
 170 .PP
 171 The function \fBEVP_PKEY_decrypt()\fR can be called more than once on the same
 172 context if several operations are performed using the same parameters.
 173 .SH "RETURN VALUES"
 174 .IX Header "RETURN VALUES"
 175 \&\fBEVP_PKEY_decrypt_init()\fR and \fBEVP_PKEY_decrypt()\fR return 1 for success and 0
 176 or a negative value for failure. In particular a return value of \-2
 177 indicates the operation is not supported by the public key algorithm.
 178 .SH "EXAMPLES"
 179 .IX Header "EXAMPLES"
 180 Decrypt data using \s-1OAEP\s0 (for \s-1RSA\s0 keys):
 181 .PP
 182 .Vb 2
 183 \& #include <openssl/evp.h>
 184 \& #include <openssl/rsa.h>
 185 \&
 186 \& EVP_PKEY_CTX *ctx;
 187 \& ENGINE *eng;
 188 \& unsigned char *out, *in;
 189 \& size_t outlen, inlen;
 190 \& EVP_PKEY *key;
 191 \&
 192 \& /*
 193 \&  * NB: assumes key, eng, in, inlen are already set up
 194 \&  * and that key is an RSA private key
 195 \&  */
 196 \& ctx = EVP_PKEY_CTX_new(key, eng);
 197 \& if (!ctx)
 198 \&     /* Error occurred */
 199 \& if (EVP_PKEY_decrypt_init(ctx) <= 0)
 200 \&     /* Error */
 201 \& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_OAEP_PADDING) <= 0)
 202 \&     /* Error */
 203 \&
 204 \& /* Determine buffer length */
 205 \& if (EVP_PKEY_decrypt(ctx, NULL, &outlen, in, inlen) <= 0)
 206 \&     /* Error */
 207 \&
 208 \& out = OPENSSL_malloc(outlen);
 209 \&
 210 \& if (!out)
 211 \&     /* malloc failure */
 212 \&
 213 \& if (EVP_PKEY_decrypt(ctx, out, &outlen, in, inlen) <= 0)
 214 \&     /* Error */
 215 \&
 216 \& /* Decrypted data is outlen bytes written to buffer out */
 217 .Ve
 218 .SH "SEE ALSO"
 219 .IX Header "SEE ALSO"
 220 \&\fBEVP_PKEY_CTX_new\fR\|(3),
 221 \&\fBEVP_PKEY_encrypt\fR\|(3),
 222 \&\fBEVP_PKEY_sign\fR\|(3),
 223 \&\fBEVP_PKEY_verify\fR\|(3),
 224 \&\fBEVP_PKEY_verify_recover\fR\|(3),
 225 \&\fBEVP_PKEY_derive\fR\|(3)
 226 .SH "HISTORY"
 227 .IX Header "HISTORY"
 228 These functions were added in OpenSSL 1.0.0.
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2006\-2019 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.