openssl: Adjust manual pages for 1.0.1n.
[dragonfly.git] / secure / lib / libcrypto / man / EVP_EncryptInit.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 turned on, 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_EncryptInit 3"
136 .TH EVP_EncryptInit 3 "2015-06-11" "1.0.1n" "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_CIPHER_CTX_init, EVP_EncryptInit_ex, EVP_EncryptUpdate,
143 EVP_EncryptFinal_ex, EVP_DecryptInit_ex, EVP_DecryptUpdate,
144 EVP_DecryptFinal_ex, EVP_CipherInit_ex, EVP_CipherUpdate,
145 EVP_CipherFinal_ex, EVP_CIPHER_CTX_set_key_length,
146 EVP_CIPHER_CTX_ctrl, EVP_CIPHER_CTX_cleanup, EVP_EncryptInit,
147 EVP_EncryptFinal, EVP_DecryptInit, EVP_DecryptFinal,
148 EVP_CipherInit, EVP_CipherFinal, EVP_get_cipherbyname,
149 EVP_get_cipherbynid, EVP_get_cipherbyobj, EVP_CIPHER_nid,
150 EVP_CIPHER_block_size, EVP_CIPHER_key_length, EVP_CIPHER_iv_length,
151 EVP_CIPHER_flags, EVP_CIPHER_mode, EVP_CIPHER_type, EVP_CIPHER_CTX_cipher,
152 EVP_CIPHER_CTX_nid, EVP_CIPHER_CTX_block_size, EVP_CIPHER_CTX_key_length,
153 EVP_CIPHER_CTX_iv_length, EVP_CIPHER_CTX_get_app_data,
154 EVP_CIPHER_CTX_set_app_data, EVP_CIPHER_CTX_type, EVP_CIPHER_CTX_flags,
155 EVP_CIPHER_CTX_mode, EVP_CIPHER_param_to_asn1, EVP_CIPHER_asn1_to_param,
156 EVP_CIPHER_CTX_set_padding \- EVP cipher routines
157 .SH "SYNOPSIS"
158 .IX Header "SYNOPSIS"
159 .Vb 1
160 \& #include <openssl/evp.h>
161 \&
162 \& void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *a);
163 \&
164 \& int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
165 \&         ENGINE *impl, unsigned char *key, unsigned char *iv);
166 \& int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
167 \&         int *outl, unsigned char *in, int inl);
168 \& int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out,
169 \&         int *outl);
170 \&
171 \& int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
172 \&         ENGINE *impl, unsigned char *key, unsigned char *iv);
173 \& int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
174 \&         int *outl, unsigned char *in, int inl);
175 \& int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm,
176 \&         int *outl);
177 \&
178 \& int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
179 \&         ENGINE *impl, unsigned char *key, unsigned char *iv, int enc);
180 \& int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
181 \&         int *outl, unsigned char *in, int inl);
182 \& int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm,
183 \&         int *outl);
184 \&
185 \& int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
186 \&         unsigned char *key, unsigned char *iv);
187 \& int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
188 \&         int *outl);
189 \&
190 \& int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
191 \&         unsigned char *key, unsigned char *iv);
192 \& int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm,
193 \&         int *outl);
194 \&
195 \& int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
196 \&         unsigned char *key, unsigned char *iv, int enc);
197 \& int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm,
198 \&         int *outl);
199 \&
200 \& int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *x, int padding);
201 \& int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *x, int keylen);
202 \& int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr);
203 \& int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *a);
204 \&
205 \& const EVP_CIPHER *EVP_get_cipherbyname(const char *name);
206 \& #define EVP_get_cipherbynid(a) EVP_get_cipherbyname(OBJ_nid2sn(a))
207 \& #define EVP_get_cipherbyobj(a) EVP_get_cipherbynid(OBJ_obj2nid(a))
208 \&
209 \& #define EVP_CIPHER_nid(e)              ((e)\->nid)
210 \& #define EVP_CIPHER_block_size(e)       ((e)\->block_size)
211 \& #define EVP_CIPHER_key_length(e)       ((e)\->key_len)
212 \& #define EVP_CIPHER_iv_length(e)                ((e)\->iv_len)
213 \& #define EVP_CIPHER_flags(e)            ((e)\->flags)
214 \& #define EVP_CIPHER_mode(e)             ((e)\->flags) & EVP_CIPH_MODE)
215 \& int EVP_CIPHER_type(const EVP_CIPHER *ctx);
216 \&
217 \& #define EVP_CIPHER_CTX_cipher(e)       ((e)\->cipher)
218 \& #define EVP_CIPHER_CTX_nid(e)          ((e)\->cipher\->nid)
219 \& #define EVP_CIPHER_CTX_block_size(e)   ((e)\->cipher\->block_size)
220 \& #define EVP_CIPHER_CTX_key_length(e)   ((e)\->key_len)
221 \& #define EVP_CIPHER_CTX_iv_length(e)    ((e)\->cipher\->iv_len)
222 \& #define EVP_CIPHER_CTX_get_app_data(e) ((e)\->app_data)
223 \& #define EVP_CIPHER_CTX_set_app_data(e,d) ((e)\->app_data=(char *)(d))
224 \& #define EVP_CIPHER_CTX_type(c)         EVP_CIPHER_type(EVP_CIPHER_CTX_cipher(c))
225 \& #define EVP_CIPHER_CTX_flags(e)                ((e)\->cipher\->flags)
226 \& #define EVP_CIPHER_CTX_mode(e)         ((e)\->cipher\->flags & EVP_CIPH_MODE)
227 \&
228 \& int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
229 \& int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
230 .Ve
231 .SH "DESCRIPTION"
232 .IX Header "DESCRIPTION"
233 The \s-1EVP\s0 cipher routines are a high level interface to certain
234 symmetric ciphers.
235 .PP
236 \&\fIEVP_CIPHER_CTX_init()\fR initializes cipher contex \fBctx\fR.
237 .PP
238 \&\fIEVP_EncryptInit_ex()\fR sets up cipher context \fBctx\fR for encryption
239 with cipher \fBtype\fR from \s-1ENGINE \s0\fBimpl\fR. \fBctx\fR must be initialized
240 before calling this function. \fBtype\fR is normally supplied
241 by a function such as \fIEVP_des_cbc()\fR. If \fBimpl\fR is \s-1NULL\s0 then the
242 default implementation is used. \fBkey\fR is the symmetric key to use
243 and \fBiv\fR is the \s-1IV\s0 to use (if necessary), the actual number of bytes
244 used for the key and \s-1IV\s0 depends on the cipher. It is possible to set
245 all parameters to \s-1NULL\s0 except \fBtype\fR in an initial call and supply
246 the remaining parameters in subsequent calls, all of which have \fBtype\fR
247 set to \s-1NULL.\s0 This is done when the default cipher parameters are not
248 appropriate.
249 .PP
250 \&\fIEVP_EncryptUpdate()\fR encrypts \fBinl\fR bytes from the buffer \fBin\fR and
251 writes the encrypted version to \fBout\fR. This function can be called
252 multiple times to encrypt successive blocks of data. The amount
253 of data written depends on the block alignment of the encrypted data:
254 as a result the amount of data written may be anything from zero bytes
255 to (inl + cipher_block_size \- 1) so \fBout\fR should contain sufficient
256 room. The actual number of bytes written is placed in \fBoutl\fR.
257 .PP
258 If padding is enabled (the default) then \fIEVP_EncryptFinal_ex()\fR encrypts
259 the \*(L"final\*(R" data, that is any data that remains in a partial block.
260 It uses standard block padding (aka \s-1PKCS\s0 padding). The encrypted
261 final data is written to \fBout\fR which should have sufficient space for
262 one cipher block. The number of bytes written is placed in \fBoutl\fR. After
263 this function is called the encryption operation is finished and no further
264 calls to \fIEVP_EncryptUpdate()\fR should be made.
265 .PP
266 If padding is disabled then \fIEVP_EncryptFinal_ex()\fR will not encrypt any more
267 data and it will return an error if any data remains in a partial block:
268 that is if the total data length is not a multiple of the block size.
269 .PP
270 \&\fIEVP_DecryptInit_ex()\fR, \fIEVP_DecryptUpdate()\fR and \fIEVP_DecryptFinal_ex()\fR are the
271 corresponding decryption operations. \fIEVP_DecryptFinal()\fR will return an
272 error code if padding is enabled and the final block is not correctly
273 formatted. The parameters and restrictions are identical to the encryption
274 operations except that if padding is enabled the decrypted data buffer \fBout\fR
275 passed to \fIEVP_DecryptUpdate()\fR should have sufficient room for
276 (\fBinl\fR + cipher_block_size) bytes unless the cipher block size is 1 in
277 which case \fBinl\fR bytes is sufficient.
278 .PP
279 \&\fIEVP_CipherInit_ex()\fR, \fIEVP_CipherUpdate()\fR and \fIEVP_CipherFinal_ex()\fR are
280 functions that can be used for decryption or encryption. The operation
281 performed depends on the value of the \fBenc\fR parameter. It should be set
282 to 1 for encryption, 0 for decryption and \-1 to leave the value unchanged
283 (the actual value of 'enc' being supplied in a previous call).
284 .PP
285 \&\fIEVP_CIPHER_CTX_cleanup()\fR clears all information from a cipher context
286 and free up any allocated memory associate with it. It should be called
287 after all operations using a cipher are complete so sensitive information
288 does not remain in memory.
289 .PP
290 \&\fIEVP_EncryptInit()\fR, \fIEVP_DecryptInit()\fR and \fIEVP_CipherInit()\fR behave in a
291 similar way to \fIEVP_EncryptInit_ex()\fR, EVP_DecryptInit_ex and
292 \&\fIEVP_CipherInit_ex()\fR except the \fBctx\fR parameter does not need to be
293 initialized and they always use the default cipher implementation.
294 .PP
295 \&\fIEVP_EncryptFinal()\fR, \fIEVP_DecryptFinal()\fR and \fIEVP_CipherFinal()\fR behave in a
296 similar way to \fIEVP_EncryptFinal_ex()\fR, \fIEVP_DecryptFinal_ex()\fR and
297 \&\fIEVP_CipherFinal_ex()\fR except \fBctx\fR is automatically cleaned up 
298 after the call.
299 .PP
300 \&\fIEVP_get_cipherbyname()\fR, \fIEVP_get_cipherbynid()\fR and \fIEVP_get_cipherbyobj()\fR
301 return an \s-1EVP_CIPHER\s0 structure when passed a cipher name, a \s-1NID\s0 or an
302 \&\s-1ASN1_OBJECT\s0 structure.
303 .PP
304 \&\fIEVP_CIPHER_nid()\fR and \fIEVP_CIPHER_CTX_nid()\fR return the \s-1NID\s0 of a cipher when
305 passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR structure.  The actual \s-1NID\s0
306 value is an internal value which may not have a corresponding \s-1OBJECT
307 IDENTIFIER.\s0
308 .PP
309 \&\fIEVP_CIPHER_CTX_set_padding()\fR enables or disables padding. By default
310 encryption operations are padded using standard block padding and the
311 padding is checked and removed when decrypting. If the \fBpad\fR parameter
312 is zero then no padding is performed, the total amount of data encrypted
313 or decrypted must then be a multiple of the block size or an error will
314 occur.
315 .PP
316 \&\fIEVP_CIPHER_key_length()\fR and \fIEVP_CIPHER_CTX_key_length()\fR return the key
317 length of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR
318 structure. The constant \fB\s-1EVP_MAX_KEY_LENGTH\s0\fR is the maximum key length
319 for all ciphers. Note: although \fIEVP_CIPHER_key_length()\fR is fixed for a
320 given cipher, the value of \fIEVP_CIPHER_CTX_key_length()\fR may be different
321 for variable key length ciphers.
322 .PP
323 \&\fIEVP_CIPHER_CTX_set_key_length()\fR sets the key length of the cipher ctx.
324 If the cipher is a fixed length cipher then attempting to set the key
325 length to any value other than the fixed value is an error.
326 .PP
327 \&\fIEVP_CIPHER_iv_length()\fR and \fIEVP_CIPHER_CTX_iv_length()\fR return the \s-1IV\s0
328 length of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR.
329 It will return zero if the cipher does not use an \s-1IV. \s0 The constant
330 \&\fB\s-1EVP_MAX_IV_LENGTH\s0\fR is the maximum \s-1IV\s0 length for all ciphers.
331 .PP
332 \&\fIEVP_CIPHER_block_size()\fR and \fIEVP_CIPHER_CTX_block_size()\fR return the block
333 size of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR
334 structure. The constant \fB\s-1EVP_MAX_IV_LENGTH\s0\fR is also the maximum block
335 length for all ciphers.
336 .PP
337 \&\fIEVP_CIPHER_type()\fR and \fIEVP_CIPHER_CTX_type()\fR return the type of the passed
338 cipher or context. This \*(L"type\*(R" is the actual \s-1NID\s0 of the cipher \s-1OBJECT
339 IDENTIFIER\s0 as such it ignores the cipher parameters and 40 bit \s-1RC2\s0 and
340 128 bit \s-1RC2\s0 have the same \s-1NID.\s0 If the cipher does not have an object
341 identifier or does not have \s-1ASN1\s0 support this function will return
342 \&\fBNID_undef\fR.
343 .PP
344 \&\fIEVP_CIPHER_CTX_cipher()\fR returns the \fB\s-1EVP_CIPHER\s0\fR structure when passed
345 an \fB\s-1EVP_CIPHER_CTX\s0\fR structure.
346 .PP
347 \&\fIEVP_CIPHER_mode()\fR and \fIEVP_CIPHER_CTX_mode()\fR return the block cipher mode:
348 \&\s-1EVP_CIPH_ECB_MODE, EVP_CIPH_CBC_MODE, EVP_CIPH_CFB_MODE\s0 or
349 \&\s-1EVP_CIPH_OFB_MODE.\s0 If the cipher is a stream cipher then
350 \&\s-1EVP_CIPH_STREAM_CIPHER\s0 is returned.
351 .PP
352 \&\fIEVP_CIPHER_param_to_asn1()\fR sets the AlgorithmIdentifier \*(L"parameter\*(R" based
353 on the passed cipher. This will typically include any parameters and an
354 \&\s-1IV.\s0 The cipher \s-1IV \s0(if any) must be set when this call is made. This call
355 should be made before the cipher is actually \*(L"used\*(R" (before any
356 \&\fIEVP_EncryptUpdate()\fR, \fIEVP_DecryptUpdate()\fR calls for example). This function
357 may fail if the cipher does not have any \s-1ASN1\s0 support.
358 .PP
359 \&\fIEVP_CIPHER_asn1_to_param()\fR sets the cipher parameters based on an \s-1ASN1\s0
360 AlgorithmIdentifier \*(L"parameter\*(R". The precise effect depends on the cipher
361 In the case of \s-1RC2,\s0 for example, it will set the \s-1IV\s0 and effective key length.
362 This function should be called after the base cipher type is set but before
363 the key is set. For example \fIEVP_CipherInit()\fR will be called with the \s-1IV\s0 and
364 key set to \s-1NULL,\s0 \fIEVP_CIPHER_asn1_to_param()\fR will be called and finally
365 \&\fIEVP_CipherInit()\fR again with all parameters except the key set to \s-1NULL.\s0 It is
366 possible for this function to fail if the cipher does not have any \s-1ASN1\s0 support
367 or the parameters cannot be set (for example the \s-1RC2\s0 effective key length
368 is not supported.
369 .PP
370 \&\fIEVP_CIPHER_CTX_ctrl()\fR allows various cipher specific parameters to be determined
371 and set. Currently only the \s-1RC2\s0 effective key length and the number of rounds of
372 \&\s-1RC5\s0 can be set.
373 .SH "RETURN VALUES"
374 .IX Header "RETURN VALUES"
375 \&\fIEVP_EncryptInit_ex()\fR, \fIEVP_EncryptUpdate()\fR and \fIEVP_EncryptFinal_ex()\fR
376 return 1 for success and 0 for failure.
377 .PP
378 \&\fIEVP_DecryptInit_ex()\fR and \fIEVP_DecryptUpdate()\fR return 1 for success and 0 for failure.
379 \&\fIEVP_DecryptFinal_ex()\fR returns 0 if the decrypt failed or 1 for success.
380 .PP
381 \&\fIEVP_CipherInit_ex()\fR and \fIEVP_CipherUpdate()\fR return 1 for success and 0 for failure.
382 \&\fIEVP_CipherFinal_ex()\fR returns 0 for a decryption failure or 1 for success.
383 .PP
384 \&\fIEVP_CIPHER_CTX_cleanup()\fR returns 1 for success and 0 for failure.
385 .PP
386 \&\fIEVP_get_cipherbyname()\fR, \fIEVP_get_cipherbynid()\fR and \fIEVP_get_cipherbyobj()\fR
387 return an \fB\s-1EVP_CIPHER\s0\fR structure or \s-1NULL\s0 on error.
388 .PP
389 \&\fIEVP_CIPHER_nid()\fR and \fIEVP_CIPHER_CTX_nid()\fR return a \s-1NID.\s0
390 .PP
391 \&\fIEVP_CIPHER_block_size()\fR and \fIEVP_CIPHER_CTX_block_size()\fR return the block
392 size.
393 .PP
394 \&\fIEVP_CIPHER_key_length()\fR and \fIEVP_CIPHER_CTX_key_length()\fR return the key
395 length.
396 .PP
397 \&\fIEVP_CIPHER_CTX_set_padding()\fR always returns 1.
398 .PP
399 \&\fIEVP_CIPHER_iv_length()\fR and \fIEVP_CIPHER_CTX_iv_length()\fR return the \s-1IV\s0
400 length or zero if the cipher does not use an \s-1IV.\s0
401 .PP
402 \&\fIEVP_CIPHER_type()\fR and \fIEVP_CIPHER_CTX_type()\fR return the \s-1NID\s0 of the cipher's
403 \&\s-1OBJECT IDENTIFIER\s0 or NID_undef if it has no defined \s-1OBJECT IDENTIFIER.\s0
404 .PP
405 \&\fIEVP_CIPHER_CTX_cipher()\fR returns an \fB\s-1EVP_CIPHER\s0\fR structure.
406 .PP
407 \&\fIEVP_CIPHER_param_to_asn1()\fR and \fIEVP_CIPHER_asn1_to_param()\fR return 1 for 
408 success or zero for failure.
409 .SH "CIPHER LISTING"
410 .IX Header "CIPHER LISTING"
411 All algorithms have a fixed key length unless otherwise stated.
412 .IP "\fIEVP_enc_null()\fR" 4
413 .IX Item "EVP_enc_null()"
414 Null cipher: does nothing.
415 .IP "EVP_des_cbc(void), EVP_des_ecb(void), EVP_des_cfb(void), EVP_des_ofb(void)" 4
416 .IX Item "EVP_des_cbc(void), EVP_des_ecb(void), EVP_des_cfb(void), EVP_des_ofb(void)"
417 \&\s-1DES\s0 in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
418 .IP "EVP_des_ede_cbc(void), \fIEVP_des_ede()\fR, EVP_des_ede_ofb(void),  EVP_des_ede_cfb(void)" 4
419 .IX Item "EVP_des_ede_cbc(void), EVP_des_ede(), EVP_des_ede_ofb(void), EVP_des_ede_cfb(void)"
420 Two key triple \s-1DES\s0 in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
421 .IP "EVP_des_ede3_cbc(void), \fIEVP_des_ede3()\fR, EVP_des_ede3_ofb(void),  EVP_des_ede3_cfb(void)" 4
422 .IX Item "EVP_des_ede3_cbc(void), EVP_des_ede3(), EVP_des_ede3_ofb(void), EVP_des_ede3_cfb(void)"
423 Three key triple \s-1DES\s0 in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
424 .IP "EVP_desx_cbc(void)" 4
425 .IX Item "EVP_desx_cbc(void)"
426 \&\s-1DESX\s0 algorithm in \s-1CBC\s0 mode.
427 .IP "EVP_rc4(void)" 4
428 .IX Item "EVP_rc4(void)"
429 \&\s-1RC4\s0 stream cipher. This is a variable key length cipher with default key length 128 bits.
430 .IP "EVP_rc4_40(void)" 4
431 .IX Item "EVP_rc4_40(void)"
432 \&\s-1RC4\s0 stream cipher with 40 bit key length. This is obsolete and new code should use \fIEVP_rc4()\fR
433 and the \fIEVP_CIPHER_CTX_set_key_length()\fR function.
434 .IP "\fIEVP_idea_cbc()\fR EVP_idea_ecb(void), EVP_idea_cfb(void), EVP_idea_ofb(void), EVP_idea_cbc(void)" 4
435 .IX Item "EVP_idea_cbc() EVP_idea_ecb(void), EVP_idea_cfb(void), EVP_idea_ofb(void), EVP_idea_cbc(void)"
436 \&\s-1IDEA\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively.
437 .IP "EVP_rc2_cbc(void), EVP_rc2_ecb(void), EVP_rc2_cfb(void), EVP_rc2_ofb(void)" 4
438 .IX Item "EVP_rc2_cbc(void), EVP_rc2_ecb(void), EVP_rc2_cfb(void), EVP_rc2_ofb(void)"
439 \&\s-1RC2\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key
440 length cipher with an additional parameter called \*(L"effective key bits\*(R" or \*(L"effective key length\*(R".
441 By default both are set to 128 bits.
442 .IP "EVP_rc2_40_cbc(void), EVP_rc2_64_cbc(void)" 4
443 .IX Item "EVP_rc2_40_cbc(void), EVP_rc2_64_cbc(void)"
444 \&\s-1RC2\s0 algorithm in \s-1CBC\s0 mode with a default key length and effective key length of 40 and 64 bits.
445 These are obsolete and new code should use \fIEVP_rc2_cbc()\fR, \fIEVP_CIPHER_CTX_set_key_length()\fR and
446 \&\fIEVP_CIPHER_CTX_ctrl()\fR to set the key length and effective key length.
447 .IP "EVP_bf_cbc(void), EVP_bf_ecb(void), EVP_bf_cfb(void), EVP_bf_ofb(void);" 4
448 .IX Item "EVP_bf_cbc(void), EVP_bf_ecb(void), EVP_bf_cfb(void), EVP_bf_ofb(void);"
449 Blowfish encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key
450 length cipher.
451 .IP "EVP_cast5_cbc(void), EVP_cast5_ecb(void), EVP_cast5_cfb(void), EVP_cast5_ofb(void)" 4
452 .IX Item "EVP_cast5_cbc(void), EVP_cast5_ecb(void), EVP_cast5_cfb(void), EVP_cast5_ofb(void)"
453 \&\s-1CAST\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key
454 length cipher.
455 .IP "EVP_rc5_32_12_16_cbc(void), EVP_rc5_32_12_16_ecb(void), EVP_rc5_32_12_16_cfb(void), EVP_rc5_32_12_16_ofb(void)" 4
456 .IX Item "EVP_rc5_32_12_16_cbc(void), EVP_rc5_32_12_16_ecb(void), EVP_rc5_32_12_16_cfb(void), EVP_rc5_32_12_16_ofb(void)"
457 \&\s-1RC5\s0 encryption algorithm in \s-1CBC, ECB, CFB\s0 and \s-1OFB\s0 modes respectively. This is a variable key length
458 cipher with an additional \*(L"number of rounds\*(R" parameter. By default the key length is set to 128
459 bits and 12 rounds.
460 .SH "NOTES"
461 .IX Header "NOTES"
462 Where possible the \fB\s-1EVP\s0\fR interface to symmetric ciphers should be used in
463 preference to the low level interfaces. This is because the code then becomes
464 transparent to the cipher used and much more flexible. Additionally, the
465 \&\fB\s-1EVP\s0\fR interface will ensure the use of platform specific cryptographic
466 acceleration such as AES-NI (the low level interfaces do not provide the
467 guarantee).
468 .PP
469 \&\s-1PKCS\s0 padding works by adding \fBn\fR padding bytes of value \fBn\fR to make the total 
470 length of the encrypted data a multiple of the block size. Padding is always
471 added so if the data is already a multiple of the block size \fBn\fR will equal
472 the block size. For example if the block size is 8 and 11 bytes are to be
473 encrypted then 5 padding bytes of value 5 will be added.
474 .PP
475 When decrypting the final block is checked to see if it has the correct form.
476 .PP
477 Although the decryption operation can produce an error if padding is enabled,
478 it is not a strong test that the input data or key is correct. A random block
479 has better than 1 in 256 chance of being of the correct format and problems with
480 the input data earlier on will not produce a final decrypt error.
481 .PP
482 If padding is disabled then the decryption operation will always succeed if
483 the total amount of data decrypted is a multiple of the block size.
484 .PP
485 The functions \fIEVP_EncryptInit()\fR, \fIEVP_EncryptFinal()\fR, \fIEVP_DecryptInit()\fR,
486 \&\fIEVP_CipherInit()\fR and \fIEVP_CipherFinal()\fR are obsolete but are retained for
487 compatibility with existing code. New code should use \fIEVP_EncryptInit_ex()\fR,
488 \&\fIEVP_EncryptFinal_ex()\fR, \fIEVP_DecryptInit_ex()\fR, \fIEVP_DecryptFinal_ex()\fR,
489 \&\fIEVP_CipherInit_ex()\fR and \fIEVP_CipherFinal_ex()\fR because they can reuse an
490 existing context without allocating and freeing it up on each call.
491 .SH "BUGS"
492 .IX Header "BUGS"
493 For \s-1RC5\s0 the number of rounds can currently only be set to 8, 12 or 16. This is
494 a limitation of the current \s-1RC5\s0 code rather than the \s-1EVP\s0 interface.
495 .PP
496 \&\s-1EVP_MAX_KEY_LENGTH\s0 and \s-1EVP_MAX_IV_LENGTH\s0 only refer to the internal ciphers with
497 default key lengths. If custom ciphers exceed these values the results are
498 unpredictable. This is because it has become standard practice to define a 
499 generic key as a fixed unsigned char array containing \s-1EVP_MAX_KEY_LENGTH\s0 bytes.
500 .PP
501 The \s-1ASN1\s0 code is incomplete (and sometimes inaccurate) it has only been tested
502 for certain common S/MIME ciphers (\s-1RC2, DES,\s0 triple \s-1DES\s0) in \s-1CBC\s0 mode.
503 .SH "EXAMPLES"
504 .IX Header "EXAMPLES"
505 Encrypt a string using \s-1IDEA:\s0
506 .PP
507 .Vb 12
508 \& int do_crypt(char *outfile)
509 \&        {
510 \&        unsigned char outbuf[1024];
511 \&        int outlen, tmplen;
512 \&        /* Bogus key and IV: we\*(Aqd normally set these from
513 \&         * another source.
514 \&         */
515 \&        unsigned char key[] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
516 \&        unsigned char iv[] = {1,2,3,4,5,6,7,8};
517 \&        char intext[] = "Some Crypto Text";
518 \&        EVP_CIPHER_CTX ctx;
519 \&        FILE *out;
520 \&
521 \&        EVP_CIPHER_CTX_init(&ctx);
522 \&        EVP_EncryptInit_ex(&ctx, EVP_idea_cbc(), NULL, key, iv);
523 \&
524 \&        if(!EVP_EncryptUpdate(&ctx, outbuf, &outlen, intext, strlen(intext)))
525 \&                {
526 \&                /* Error */
527 \&                return 0;
528 \&                }
529 \&        /* Buffer passed to EVP_EncryptFinal() must be after data just
530 \&         * encrypted to avoid overwriting it.
531 \&         */
532 \&        if(!EVP_EncryptFinal_ex(&ctx, outbuf + outlen, &tmplen))
533 \&                {
534 \&                /* Error */
535 \&                return 0;
536 \&                }
537 \&        outlen += tmplen;
538 \&        EVP_CIPHER_CTX_cleanup(&ctx);
539 \&        /* Need binary mode for fopen because encrypted data is
540 \&         * binary data. Also cannot use strlen() on it because
541 \&         * it wont be null terminated and may contain embedded
542 \&         * nulls.
543 \&         */
544 \&        out = fopen(outfile, "wb");
545 \&        fwrite(outbuf, 1, outlen, out);
546 \&        fclose(out);
547 \&        return 1;
548 \&        }
549 .Ve
550 .PP
551 The ciphertext from the above example can be decrypted using the \fBopenssl\fR
552 utility with the command line (shown on two lines for clarity):
553 .PP
554 .Vb 2
555 \& openssl idea \-d <filename
556 \&          \-K 000102030405060708090A0B0C0D0E0F \-iv 0102030405060708
557 .Ve
558 .PP
559 General encryption and decryption function example using \s-1FILE I/O\s0 and \s-1AES128\s0
560 with a 128\-bit key:
561 .PP
562 .Vb 11
563 \& int do_crypt(FILE *in, FILE *out, int do_encrypt)
564 \&        {
565 \&        /* Allow enough space in output buffer for additional block */
566 \&        unsigned char inbuf[1024], outbuf[1024 + EVP_MAX_BLOCK_LENGTH];
567 \&        int inlen, outlen;
568 \&        EVP_CIPHER_CTX ctx;
569 \&        /* Bogus key and IV: we\*(Aqd normally set these from
570 \&         * another source.
571 \&         */
572 \&        unsigned char key[] = "0123456789abcdeF";
573 \&        unsigned char iv[] = "1234567887654321";
574 \&
575 \&        /* Don\*(Aqt set key or IV right away; we want to check lengths */
576 \&        EVP_CIPHER_CTX_init(&ctx);
577 \&        EVP_CipherInit_ex(&ctx, EVP_aes_128_cbc(), NULL, NULL, NULL,
578 \&                do_encrypt);
579 \&        OPENSSL_assert(EVP_CIPHER_CTX_key_length(&ctx) == 16);
580 \&        OPENSSL_assert(EVP_CIPHER_CTX_iv_length(&ctx) == 16);
581 \&
582 \&        /* Now we can set key and IV */
583 \&        EVP_CipherInit_ex(&ctx, NULL, NULL, key, iv, do_encrypt);
584 \&
585 \&        for(;;) 
586 \&                {
587 \&                inlen = fread(inbuf, 1, 1024, in);
588 \&                if(inlen <= 0) break;
589 \&                if(!EVP_CipherUpdate(&ctx, outbuf, &outlen, inbuf, inlen))
590 \&                        {
591 \&                        /* Error */
592 \&                        EVP_CIPHER_CTX_cleanup(&ctx);
593 \&                        return 0;
594 \&                        }
595 \&                fwrite(outbuf, 1, outlen, out);
596 \&                }
597 \&        if(!EVP_CipherFinal_ex(&ctx, outbuf, &outlen))
598 \&                {
599 \&                /* Error */
600 \&                EVP_CIPHER_CTX_cleanup(&ctx);
601 \&                return 0;
602 \&                }
603 \&        fwrite(outbuf, 1, outlen, out);
604 \&
605 \&        EVP_CIPHER_CTX_cleanup(&ctx);
606 \&        return 1;
607 \&        }
608 .Ve
609 .SH "SEE ALSO"
610 .IX Header "SEE ALSO"
611 \&\fIevp\fR\|(3)
612 .SH "HISTORY"
613 .IX Header "HISTORY"
614 \&\fIEVP_CIPHER_CTX_init()\fR, \fIEVP_EncryptInit_ex()\fR, \fIEVP_EncryptFinal_ex()\fR,
615 \&\fIEVP_DecryptInit_ex()\fR, \fIEVP_DecryptFinal_ex()\fR, \fIEVP_CipherInit_ex()\fR,
616 \&\fIEVP_CipherFinal_ex()\fR and \fIEVP_CIPHER_CTX_set_padding()\fR appeared in
617 OpenSSL 0.9.7.
618 .PP
619 \&\s-1IDEA\s0 appeared in OpenSSL 0.9.7 but was often disabled due to
620 patent concerns; the last patents expired in 2012.