1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
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
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
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'
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 \
133 .\" ========================================================================
135 .IX Title "EVP_PKEY_ENCRYPT 3"
136 .TH EVP_PKEY_ENCRYPT 3 "2021-08-24" "1.1.1l" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 EVP_PKEY_encrypt_init, EVP_PKEY_encrypt \- encrypt using a public key algorithm
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/evp.h>
148 \& int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
149 \& int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
150 \& unsigned char *out, size_t *outlen,
151 \& const unsigned char *in, size_t inlen);
154 .IX Header "DESCRIPTION"
155 The \fBEVP_PKEY_encrypt_init()\fR function initializes a public key algorithm
156 context using key \fBpkey\fR for an encryption operation.
158 The \fBEVP_PKEY_encrypt()\fR function performs a public key encryption operation
159 using \fBctx\fR. The data to be encrypted 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 encrypted data is written to
164 \&\fBout\fR and the amount of data written to \fBoutlen\fR.
167 After the call to \fBEVP_PKEY_encrypt_init()\fR algorithm specific control
168 operations can be performed to set any appropriate parameters for the
171 The function \fBEVP_PKEY_encrypt()\fR can be called more than once on the same
172 context if several operations are performed using the same parameters.
174 .IX Header "RETURN VALUES"
175 \&\fBEVP_PKEY_encrypt_init()\fR and \fBEVP_PKEY_encrypt()\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.
179 .IX Header "EXAMPLES"
180 Encrypt data using \s-1OAEP\s0 (for \s-1RSA\s0 keys). See also \fBPEM_read_PUBKEY\fR\|(3) or
181 \&\fBd2i_X509\fR\|(3) for means to load a public key. You may also simply
182 set 'eng = \s-1NULL\s0;' to start with the default OpenSSL \s-1RSA\s0 implementation:
185 \& #include <openssl/evp.h>
186 \& #include <openssl/rsa.h>
187 \& #include <openssl/engine.h>
189 \& EVP_PKEY_CTX *ctx;
191 \& unsigned char *out, *in;
192 \& size_t outlen, inlen;
196 \& * NB: assumes eng, key, in, inlen are already set up,
197 \& * and that key is an RSA public key
199 \& ctx = EVP_PKEY_CTX_new(key, eng);
201 \& /* Error occurred */
202 \& if (EVP_PKEY_encrypt_init(ctx) <= 0)
204 \& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_OAEP_PADDING) <= 0)
207 \& /* Determine buffer length */
208 \& if (EVP_PKEY_encrypt(ctx, NULL, &outlen, in, inlen) <= 0)
211 \& out = OPENSSL_malloc(outlen);
214 \& /* malloc failure */
216 \& if (EVP_PKEY_encrypt(ctx, out, &outlen, in, inlen) <= 0)
219 \& /* Encrypted data is outlen bytes written to buffer out */
222 .IX Header "SEE ALSO"
223 \&\fBd2i_X509\fR\|(3),
224 \&\fBENGINE_by_id\fR\|(3),
225 \&\fBEVP_PKEY_CTX_new\fR\|(3),
226 \&\fBEVP_PKEY_decrypt\fR\|(3),
227 \&\fBEVP_PKEY_sign\fR\|(3),
228 \&\fBEVP_PKEY_verify\fR\|(3),
229 \&\fBEVP_PKEY_verify_recover\fR\|(3),
230 \&\fBEVP_PKEY_derive\fR\|(3)
233 These functions were added in OpenSSL 1.0.0.
235 .IX Header "COPYRIGHT"
236 Copyright 2006\-2019 The OpenSSL Project Authors. All Rights Reserved.
238 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
239 this file except in compliance with the License. You can obtain a copy
240 in the file \s-1LICENSE\s0 in the source distribution or at
241 <https://www.openssl.org/source/license.html>.