| blob | 24c15934e0a991950d6a38127e3b95c78dbfd1de |
1 .\" $NetBSD: EVP_PKEY_encrypt.3,v 1.14 2015/06/12 17:01:13 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "EVP_PKEY_encrypt 3"
138 .TH EVP_PKEY_encrypt 3 "2015-01-13" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 EVP_PKEY_encrypt_init, EVP_PKEY_encrypt \- encrypt using a public key algorithm
145 .SH "LIBRARY"
146 libcrypto, -lcrypto
147 .SH "SYNOPSIS"
148 .IX Header "SYNOPSIS"
149 .Vb 1
150 \& #include <openssl/evp.h>
151 \&
152 \& int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
153 \& int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
154 \& unsigned char *out, size_t *outlen,
155 \& const unsigned char *in, size_t inlen);
156 .Ve
157 .SH "DESCRIPTION"
158 .IX Header "DESCRIPTION"
159 The \fIEVP_PKEY_encrypt_init()\fR function initializes a public key algorithm
160 context using key \fBpkey\fR for an encryption operation.
161 .PP
162 The \fIEVP_PKEY_encrypt()\fR function performs a public key encryption operation
163 using \fBctx\fR. The data to be encrypted is specified using the \fBin\fR and
164 \&\fBinlen\fR parameters. If \fBout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
165 buffer is written to the \fBoutlen\fR parameter. If \fBout\fR is not \fB\s-1NULL\s0\fR then
166 before the call the \fBoutlen\fR parameter should contain the length of the
167 \&\fBout\fR buffer, if the call is successful the encrypted data is written to
168 \&\fBout\fR and the amount of data written to \fBoutlen\fR.
169 .SH "NOTES"
170 .IX Header "NOTES"
171 After the call to \fIEVP_PKEY_encrypt_init()\fR algorithm specific control
172 operations can be performed to set any appropriate parameters for the
173 operation.
174 .PP
175 The function \fIEVP_PKEY_encrypt()\fR can be called more than once on the same
176 context if several operations are performed using the same parameters.
177 .SH "RETURN VALUES"
178 .IX Header "RETURN VALUES"
179 \&\fIEVP_PKEY_encrypt_init()\fR and \fIEVP_PKEY_encrypt()\fR return 1 for success and 0
180 or a negative value for failure. In particular a return value of \-2
181 indicates the operation is not supported by the public key algorithm.
182 .SH "EXAMPLE"
183 .IX Header "EXAMPLE"
184 Encrypt data using \s-1OAEP \s0(for \s-1RSA\s0 keys). See also \fIPEM_read_PUBKEY\fR\|(3) or
185 \&\fId2i_X509\fR\|(3) for means to load a public key. You may also simply
186 set 'eng = \s-1NULL\s0;' to start with the default OpenSSL \s-1RSA\s0 implementation:
187 .PP
188 .Vb 3
189 \& #include <openssl/evp.h>
190 \& #include <openssl/rsa.h>
191 \& #include <openssl/engine.h>
192 \&
193 \& EVP_PKEY_CTX *ctx;
194 \& ENGINE *eng;
195 \& unsigned char *out, *in;
196 \& size_t outlen, inlen;
197 \& EVP_PKEY *key;
198 \& /* NB: assumes eng, key, in, inlen are already set up,
199 \& * and that key is an RSA public key
200 \& */
201 \& ctx = EVP_PKEY_CTX_new(key,eng);
202 \& if (!ctx)
203 \& /* Error occurred */
204 \& if (EVP_PKEY_encrypt_init(ctx) <= 0)
205 \& /* Error */
206 \& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_OAEP_PADDING) <= 0)
207 \& /* Error */
208 \&
209 \& /* Determine buffer length */
210 \& if (EVP_PKEY_encrypt(ctx, NULL, &outlen, in, inlen) <= 0)
211 \& /* Error */
212 \&
213 \& out = OPENSSL_malloc(outlen);
214 \&
215 \& if (!out)
216 \& /* malloc failure */
217 \&
218 \& if (EVP_PKEY_encrypt(ctx, out, &outlen, in, inlen) <= 0)
219 \& /* Error */
220 \&
221 \& /* Encrypted data is outlen bytes written to buffer out */
222 .Ve
223 .SH "SEE ALSO"
224 .IX Header "SEE ALSO"
225 \&\fId2i_X509\fR\|(3),
226 \&\fIengine\fR\|(3),
227 \&\fIEVP_PKEY_CTX_new\fR\|(3),
228 \&\fIEVP_PKEY_decrypt\fR\|(3),
229 \&\fIEVP_PKEY_sign\fR\|(3),
230 \&\fIEVP_PKEY_verify\fR\|(3),
231 \&\fIEVP_PKEY_verify_recover\fR\|(3),
232 \&\fIEVP_PKEY_derive\fR\|(3)
233 .SH "HISTORY"
234 .IX Header "HISTORY"
235 These functions were first added to OpenSSL 1.0.0.