secure/lib/libcrypto/man/EVP_PKEY_encrypt.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "EVP_PKEY_ENCRYPT 3"
 132 .TH EVP_PKEY_ENCRYPT 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 EVP_PKEY_encrypt_init, EVP_PKEY_encrypt \- encrypt using a public key algorithm
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/evp.h>
 143 \&
 144 \& int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
 145 \& int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
 146 \&                      unsigned char *out, size_t *outlen,
 147 \&                      const unsigned char *in, size_t inlen);
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 The \fIEVP_PKEY_encrypt_init()\fR function initializes a public key algorithm
 152 context using key \fBpkey\fR for an encryption operation.
 153 .PP
 154 The \fIEVP_PKEY_encrypt()\fR function performs a public key encryption operation
 155 using \fBctx\fR. The data to be encrypted is specified using the \fBin\fR and
 156 \&\fBinlen\fR parameters. If \fBout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
 157 buffer is written to the \fBoutlen\fR parameter. If \fBout\fR is not \fB\s-1NULL\s0\fR then
 158 before the call the \fBoutlen\fR parameter should contain the length of the
 159 \&\fBout\fR buffer, if the call is successful the encrypted data is written to
 160 \&\fBout\fR and the amount of data written to \fBoutlen\fR.
 161 .SH "NOTES"
 162 .IX Header "NOTES"
 163 After the call to \fIEVP_PKEY_encrypt_init()\fR algorithm specific control
 164 operations can be performed to set any appropriate parameters for the
 165 operation.
 166 .PP
 167 The function \fIEVP_PKEY_encrypt()\fR can be called more than once on the same
 168 context if several operations are performed using the same parameters.
 169 .SH "RETURN VALUES"
 170 .IX Header "RETURN VALUES"
 171 \&\fIEVP_PKEY_encrypt_init()\fR and \fIEVP_PKEY_encrypt()\fR return 1 for success and 0
 172 or a negative value for failure. In particular a return value of \-2
 173 indicates the operation is not supported by the public key algorithm.
 174 .SH "EXAMPLE"
 175 .IX Header "EXAMPLE"
 176 Encrypt data using \s-1OAEP\s0 (for \s-1RSA\s0 keys). See also \fIPEM_read_PUBKEY\fR\|(3) or
 177 \&\fId2i_X509\fR\|(3) for means to load a public key. You may also simply
 178 set 'eng = \s-1NULL\s0;' to start with the default OpenSSL \s-1RSA\s0 implementation:
 179 .PP
 180 .Vb 3
 181 \& #include <openssl/evp.h>
 182 \& #include <openssl/rsa.h>
 183 \& #include <openssl/engine.h>
 184 \&
 185 \& EVP_PKEY_CTX *ctx;
 186 \& ENGINE *eng;
 187 \& unsigned char *out, *in;
 188 \& size_t outlen, inlen;
 189 \& EVP_PKEY *key;
 190 \&
 191 \& /*
 192 \&  * NB: assumes eng, key, in, inlen are already set up,
 193 \&  * and that key is an RSA public key
 194 \&  */
 195 \& ctx = EVP_PKEY_CTX_new(key, eng);
 196 \& if (!ctx)
 197 \&     /* Error occurred */
 198 \& if (EVP_PKEY_encrypt_init(ctx) <= 0)
 199 \&     /* Error */
 200 \& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_OAEP_PADDING) <= 0)
 201 \&     /* Error */
 202 \&
 203 \& /* Determine buffer length */
 204 \& if (EVP_PKEY_encrypt(ctx, NULL, &outlen, in, inlen) <= 0)
 205 \&     /* Error */
 206 \&
 207 \& out = OPENSSL_malloc(outlen);
 208 \&
 209 \& if (!out)
 210 \&     /* malloc failure */
 211 \&
 212 \& if (EVP_PKEY_encrypt(ctx, out, &outlen, in, inlen) <= 0)
 213 \&     /* Error */
 214 \&
 215 \& /* Encrypted data is outlen bytes written to buffer out */
 216 .Ve
 217 .SH "SEE ALSO"
 218 .IX Header "SEE ALSO"
 219 \&\fId2i_X509\fR\|(3),
 220 \&\fIENGINE_by_id\fR\|(3),
 221 \&\fIEVP_PKEY_CTX_new\fR\|(3),
 222 \&\fIEVP_PKEY_decrypt\fR\|(3),
 223 \&\fIEVP_PKEY_sign\fR\|(3),
 224 \&\fIEVP_PKEY_verify\fR\|(3),
 225 \&\fIEVP_PKEY_verify_recover\fR\|(3),
 226 \&\fIEVP_PKEY_derive\fR\|(3)
 227 .SH "HISTORY"
 228 .IX Header "HISTORY"
 229 These functions were first added to OpenSSL 1.0.0.
 230 .SH "COPYRIGHT"
 231 .IX Header "COPYRIGHT"
 232 Copyright 2006\-2016 The OpenSSL Project Authors. All Rights Reserved.
 233 .PP
 234 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 235 this file except in compliance with the License.  You can obtain a copy
 236 in the file \s-1LICENSE\s0 in the source distribution or at
 237 <https://www.openssl.org/source/license.html>.